refactor: converting trace types into v3 traces and adding markup type

voiceflow · Jul 19, 2023 · 6c50516 · 6c50516
1 parent 679fae8
commit 6c50516
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 19 deletions.
diff --git a/packages/base-types/src/index.ts b/packages/base-types/src/index.ts
@@ -1,5 +1,7 @@
 export * as Button from './button';
 export * as BaseButton from './button';
+export * as Markup from './markup';
+export * as BaseMarkup from './markup';
 export * as Models from './models';
 export * as BaseModels from './models';
 export * as Node from './node';

diff --git a/packages/base-types/src/markup/index.ts b/packages/base-types/src/markup/index.ts
@@ -0,0 +1,3 @@
+export type MarkupNode = string | { attributes: Record<string, unknown>; text: Markup };
+
+export type Markup = Array<MarkupNode>;
diff --git a/packages/base-types/src/node/index.ts b/packages/base-types/src/node/index.ts
@@ -71,9 +71,8 @@ export * as Visual from './visual';
 export * as Zapier from './zapier';
 
 // Voiceflow V3
-export * as Image from './image';
-export * as JSON from './json';
-export * as Video from './video';
+export * as Image from '../trace/v3/image';
+export * as Video from '../trace/v3/video';
 
 export interface NextOnlyNode extends BaseNode, NodeNextID {
   type: '_next';

diff --git a/packages/base-types/src/trace/index.ts b/packages/base-types/src/trace/index.ts
@@ -2,20 +2,18 @@ import { TraceFrame as CardV2Trace } from '@base-types/node/cardV2';
 import { TraceFrame as CarouselTrace } from '@base-types/node/carousel';
 import { TraceFrame as ExitTrace } from '@base-types/node/exit';
 import { TraceFrame as FlowTrace } from '@base-types/node/flow';
-// Voiceflow V3
-import { TraceFrame as ImageTrace } from '@base-types/node/image';
 import { TraceFrame as ChoiceTrace } from '@base-types/node/interaction';
-import { TraceFrame as JSONTrace } from '@base-types/node/json';
 import { TraceFrame as SpeakTrace } from '@base-types/node/speak';
 import { TraceFrame as StreamTrace } from '@base-types/node/stream';
 import { TraceFrame as TextTrace } from '@base-types/node/text';
 import { BaseTraceFrame, TraceType } from '@base-types/node/utils';
-import { TraceFrame as VideoTrace } from '@base-types/node/video';
 import { TraceFrame as VisualTrace } from '@base-types/node/visual';
 import { IntentRequest } from '@base-types/request';
 import { Log as RuntimeLog } from '@base-types/runtimeLogs';
 import { AnyRecord } from '@voiceflow/common';
 
+import * as V3 from './v3';
+
 export { TraceFrame as CardV2 } from '@base-types/node/cardV2';
 export { TraceFrame as Carousel } from '@base-types/node/carousel';
 export { TraceFrame as End } from '@base-types/node/exit';
@@ -28,12 +26,7 @@ export { BaseTraceFrame, TraceType } from '@base-types/node/utils/trace';
 export { TraceFrame as Visual } from '@base-types/node/visual';
 
 // Voiceflow V3
-export { TraceFrame as ImageTrace } from '@base-types/node/image';
-export { TraceFrame as Image } from '@base-types/node/image';
-export { TraceFrame as JSONTrace } from '@base-types/node/json';
-export { TraceFrame as JSON } from '@base-types/node/json';
-export { TraceFrame as VideoTrace } from '@base-types/node/video';
-export { TraceFrame as Video } from '@base-types/node/video';
+export * as V3 from './v3';
 
 /** @deprecated */
 export { TraceFrame as CarouselTrace } from '@base-types/node/carousel';
@@ -134,6 +127,7 @@ export type AnyTrace =
   | EntityFillingTrace
   | ChannelActionTrace
   // V3 traces
-  | ImageTrace
-  | JSONTrace
-  | VideoTrace;
+  | V3.ImageTrace
+  | V3.JSONTrace
+  | V3.VideoTrace
+  | V3.TextTrace;
diff --git a/packages/base-types/src/node/image.ts → packages/base-types/src/trace/v3/image.ts b/packages/base-types/src/node/image.ts → packages/base-types/src/trace/v3/image.ts
@@ -1,4 +1,4 @@
-import { BaseTraceFrame, TraceType } from './utils';
+import { BaseTraceFrame, TraceType } from '../../node/utils';
 
 interface StepData {
   url: string;

diff --git a/packages/base-types/src/trace/v3/index.ts b/packages/base-types/src/trace/v3/index.ts
@@ -0,0 +1,4 @@
+export { TraceFrame as ImageTrace } from './image';
+export { TraceFrame as JSONTrace } from './json';
+export { TraceFrame as TextTrace } from './text';
+export { TraceFrame as VideoTrace } from './video';
diff --git a/packages/base-types/src/node/json.ts → packages/base-types/src/trace/v3/json.ts b/packages/base-types/src/node/json.ts → packages/base-types/src/trace/v3/json.ts
@@ -1,4 +1,4 @@
-import { BaseTraceFrame, TraceType } from './utils';
+import { BaseTraceFrame, TraceType } from '../../node/utils';
 
 interface StepData {
   json: unknown;

diff --git a/packages/base-types/src/trace/v3/text.ts b/packages/base-types/src/trace/v3/text.ts
@@ -0,0 +1,11 @@
+import { Markup } from '@base-types/markup';
+
+import { BaseTraceFrame, TraceType } from '../../node/utils';
+
+interface StepData {
+  content: Markup;
+}
+
+export interface TraceFrame extends BaseTraceFrame<StepData> {
+  type: TraceType.TEXT;
+}
diff --git a/packages/base-types/src/node/video.ts → packages/base-types/src/trace/v3/video.ts b/packages/base-types/src/node/video.ts → packages/base-types/src/trace/v3/video.ts
@@ -1,4 +1,4 @@
-import { BaseTraceFrame, TraceType } from './utils';
+import { BaseTraceFrame, TraceType } from '../../node/utils';
 
 interface StepData {
   url: string;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		export type MarkupNode = string \| { attributes: Record<string, unknown>; text: Markup };

		export type Markup = Array<MarkupNode>;