feat: added new trace types for Response step (PL3-54)

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';

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>;

packages/base-types/src/node/index.ts

@@ -70,6 +70,10 @@ export * as Utils from './utils';
 export * as Visual from './visual';
 export * as Zapier from './zapier';
 
+// Voiceflow V3
+export * as Image from '../trace/v3/image';
+export * as Video from '../trace/v3/video';
+
 export interface NextOnlyNode extends BaseNode, NodeNextID {
   type: '_next';
 }

packages/base-types/src/node/utils/trace.ts

@@ -18,6 +18,13 @@ export enum TraceType {
   NO_REPLY = 'no-reply',
   ENTITY_FILLING = 'entity-filling',
   CHANNEL_ACTION = 'channel-action',
+
+  // Voiceflow V3
+  V3_TEXT = 'v3.text',
+  V3_IMAGE = 'v3.image',
+  V3_JSON = 'v3.json',
+  V3_VIDEO = 'v3.video',
+  V3_DEBUG = 'v3.debug',
 }
 
 export interface BaseTraceFramePath<Event extends BaseEvent = BaseEvent> {
@@ -30,6 +37,9 @@ export interface BaseTraceFrame<Payload = any, TracePath extends BaseTraceFrameP
   paths?: TracePath[];
   payload: Payload;
   defaultPath?: number;
+  style?: {
+    delay?: number;
+  };
 }
 
 export interface BaseResponseTrace {

packages/base-types/src/trace/index.ts

@@ -12,6 +12,8 @@ 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';
@@ -23,6 +25,9 @@ export { TraceFrame as Text } from '@base-types/node/text';
 export { BaseTraceFrame, TraceType } from '@base-types/node/utils/trace';
 export { TraceFrame as Visual } from '@base-types/node/visual';
 
+// Voiceflow V3
+export * as V3 from './v3';
+
 /** @deprecated */
 export { TraceFrame as CarouselTrace } from '@base-types/node/carousel';
 /** @deprecated */
@@ -120,4 +125,10 @@ export type AnyTrace =
   | CarouselTrace
   | CardV2Trace
   | EntityFillingTrace
-  | ChannelActionTrace;
+  | ChannelActionTrace
+  // V3 traces
+  | V3.ImageTrace
+  | V3.JSONTrace
+  | V3.VideoTrace
+  | V3.TextTrace
+  | V3.DebugTrace;

packages/base-types/src/trace/v3/debug.ts

@@ -0,0 +1,76 @@
+import { BaseTraceFrame, TraceType } from '../../node/utils';
+
+/**
+ * The logging level of the debug trace. This property can be used to
+ * filter for particular debug messages
+ *
+ * Definition of error levels is based on this article: https://sematext.com/blog/logging-levels/
+ */
+export enum DebugInfoLevel {
+  /**
+   * Used for finely detailed information to gain full visibility into the
+   * `general-runtime` and debug a Voiceflow porgram.
+   *
+   * Messages of this nature can be extremely verbose, e.g, may annotate each
+   * step of an algorithm.
+   */
+  Trace = 'trace',
+
+  /**
+   * Less granular, but still detailed information compared to `Trace`.
+   * Used for troubleshooting and diagnosing issues or running an application
+   * in a dev environment.
+   */
+  Debug = 'debug',
+
+  /**
+   * Standard log level indicating an event occurred in the `general-runtime`.
+   *
+   * Should not contain important debugging information, as this setting should not
+   * be enabled on a regular basis.
+   */
+  Info = 'info',
+
+  /**
+   * Indicates an unexpected event that does NOT impede code execution. This
+   * may not necessarily be an error.
+   */
+  Warn = 'warn',
+
+  /**
+   * Indicates an error that impedes code execution and causes non-business-logic
+   * to break, e.g, payment API call did not go through.
+   */
+  Error = 'error',
+
+  /**
+   * Indicates a critical error that impedes critical business functionality, e.g,
+   * could not start the Voiceflow program because it was not compiled.
+   */
+  Fatal = 'fatal',
+}
+
+/**
+ * Indicates the concern or component that spawned this particular debug message.
+ */
+export enum DebugCode {
+  /**
+   * Debug information that is not pinned down to any particular component.
+   */
+  General = 'general',
+
+  /**
+   * Debug information arises from the knowledge base.
+   */
+  KnowledgeBase = 'knowledge_base',
+}
+
+interface StepData {
+  code: DebugCode;
+  level: DebugInfoLevel;
+  details: Record<string, any>;
+}
+
+export interface TraceFrame extends BaseTraceFrame<StepData> {
+  type: TraceType.V3_DEBUG;
+}

packages/base-types/src/trace/v3/image.ts

@@ -0,0 +1,9 @@
+import { BaseTraceFrame, TraceType } from '../../node/utils';
+
+interface StepData {
+  url: string;
+}
+
+export interface TraceFrame extends BaseTraceFrame<StepData> {
+  type: TraceType.V3_IMAGE;
+}

packages/base-types/src/trace/v3/index.ts

@@ -0,0 +1,10 @@
+export { TraceFrame as DebugTrace } from './debug';
+export * as Debug from './debug';
+export { TraceFrame as ImageTrace } from './image';
+export * as Image from './image';
+export { TraceFrame as JSONTrace } from './json';
+export * as JSON from './json';
+export { TraceFrame as TextTrace } from './text';
+export * as Text from './text';
+export { TraceFrame as VideoTrace } from './video';
+export * as Video from './video';

packages/base-types/src/trace/v3/json.ts

@@ -0,0 +1,9 @@
+import { BaseTraceFrame, TraceType } from '../../node/utils';
+
+interface StepData {
+  json: unknown;
+}
+
+export interface TraceFrame extends BaseTraceFrame<StepData> {
+  type: TraceType.V3_JSON;
+}

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.V3_TEXT;
+}

packages/base-types/src/trace/v3/video.ts

@@ -0,0 +1,9 @@
+import { BaseTraceFrame, TraceType } from '../../node/utils';
+
+interface StepData {
+  url: string;
+}
+
+export interface TraceFrame extends BaseTraceFrame<StepData> {
+  type: TraceType.V3_VIDEO;
+}