chore: add onOpenDialog api to support dialog jump (#4542)

* impl onOpenDialog as DialogEditingContext * add missing api in stub Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com> Co-authored-by: Dong Lei <donglei@microsoft.com>
microsoft · Nov 30, 2020 · e4c6c71 · e4c6c71
1 parent 6ad4945
commit e4c6c71
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/Composer/packages/adaptive-flow/__tests__/adaptive-flow-editor/stubs/ShellApiStub.ts b/Composer/packages/adaptive-flow/__tests__/adaptive-flow-editor/stubs/ShellApiStub.ts
@@ -12,6 +12,8 @@ export const ShellApiStub: ShellApi = {
   saveDialog: fn,
   saveData: fnPromise,
   navTo: fn,
+  onOpenDialog: fnPromise,
+  createQnATrigger: fn,
   onFocusSteps: fn,
   onFocusEvent: fn,
   onSelect: fn,

diff --git a/Composer/packages/adaptive-flow/src/adaptive-flow-editor/hooks/useEditorEventApi.ts b/Composer/packages/adaptive-flow/src/adaptive-flow-editor/hooks/useEditorEventApi.ts
@@ -48,10 +48,10 @@ export const useEditorEventApi = (
   const { selectedIds, setSelectedIds, selectableElements } = selectionContext;
 
   const {
+    onOpenDialog,
     onFocusSteps,
     onFocusEvent,
     onCopy: onClipboardChange,
-    navTo,
     saveData: onChange,
     undo,
     redo,
@@ -158,7 +158,7 @@ export const useEditorEventApi = (
         break;
       case NodeEventTypes.OpenDialog:
         handler = ({ callee }) => {
-          navTo(callee);
+          onOpenDialog(callee);
           announce(ScreenReaderMessage.DialogOpened);
         };
         break;

diff --git a/Composer/packages/client/src/shell/useShell.ts b/Composer/packages/client/src/shell/useShell.ts
@@ -147,6 +147,10 @@ export function useShell(source: EventSource, projectId: string): Shell {
     await navTo(projectId, path, rest);
   }
 
+  async function openDialog(dialogId: string) {
+    await navTo(projectId, dialogId, '"beginDialog"');
+  }
+
   async function focusEvent(subPath) {
     if (rootBotProjectId == null) return;
     await selectTo(projectId, dialogId, subPath);
@@ -209,6 +213,7 @@ export function useShell(source: EventSource, projectId: string): Shell {
     renameRegExIntent: renameRegExIntentHandler,
     updateIntentTrigger: updateIntentTriggerHandler,
     navTo: navigationTo,
+    onOpenDialog: openDialog,
     onFocusEvent: focusEvent,
     onFocusSteps: focusSteps,
     onSelect: setVisualEditorSelection,

diff --git a/Composer/packages/types/src/shell.ts b/Composer/packages/types/src/shell.ts
@@ -146,6 +146,7 @@ export type ActionContextApi = {
 
 export type DialogEditingContextApi = {
   saveData: <T = any>(newData: T, updatePath?: string, callback?: () => void | Promise<void>) => Promise<void>;
+  onOpenDialog: (dialogId: string) => Promise<void>;
   onFocusSteps: (stepIds: string[], focusedTab?: string) => Promise<void>;
   onFocusEvent: (eventId: string) => Promise<void>;
   onSelect: (ids: string[]) => void;