refactor: add types for custom trace (VF-3846)

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

@@ -25,6 +25,7 @@ export enum NodeType {
   ZAPIER = 'zapier',
   INTEGRATIONS = 'integrations',
   GOOGLE_SHEETS = 'google_sheets',
+  CUSTOM = 'custom',
 
   // advanced
   INTENT = 'intent',

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

@@ -0,0 +1,38 @@
+import { Nullable } from '@voiceflow/common';
+
+import { NodeType } from './constants';
+import { BaseEvent, BaseNode, BasePort, BasePortList, BaseStep, BaseStepPorts, NodeID } from './utils';
+
+export interface StepData<Payload = unknown> {
+  stop?: boolean;
+  payload: Payload;
+  defaultPath?: number;
+}
+
+export interface StepPort<Event = BaseEvent> extends BasePort {
+  data: { event?: Event };
+}
+
+export interface StepPorts<Event> extends BaseStepPorts<Record<string, StepPort<Event>>, StepPort<Event>[]> {}
+
+export interface Step<Payload = unknown, Event = BaseEvent> extends BaseStep<StepData<Payload>, StepPorts<Event>, BasePortList<StepPort<Event>>> {
+  type: NodeType.CUSTOM;
+}
+
+export interface NodePath<Event = BaseEvent> {
+  label?: string;
+  event?: Event;
+  nextID: Nullable<NodeID>;
+}
+
+export interface NodePayload {
+  name: string;
+  body: unknown;
+}
+
+export interface Node<Event = BaseEvent> extends BaseNode {
+  stop: boolean;
+  paths: Array<NodePath<Event>>;
+  payload: NodePayload;
+  defaultPath?: number; // index starting from 0
+}

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

@@ -2,6 +2,7 @@ import * as _v1 from './_v1';
 import * as Api from './api';
 import * as Code from './code';
 import * as Component from './component';
+import * as Custom from './custom';
 import * as Exit from './exit';
 import * as Flow from './flow';
 import * as General from './general';
@@ -30,6 +31,7 @@ export * as Carousel from './carousel';
 export * as Code from './code';
 export * as Component from './component';
 export * from './constants';
+export * as Custom from './custom';
 export * as Directive from './directive';
 export * as Exit from './exit';
 export * as Flow from './flow';
@@ -76,7 +78,8 @@ export type AnyCommonStep =
   | GoTo.Step
   | GoToNode.Step
   | Url.Step
-  | _v1.Step;
+  | _v1.Step
+  | Custom.Step;
 
 export type AnyCommonNode =
   | Set.Node
@@ -93,6 +96,7 @@ export type AnyCommonNode =
   | GoTo.Node
   | Url.Node
   | GoToNode.Node
-  | _v1.Node;
+  | _v1.Node
+  | Custom.Node;
 
 export type AnyCommonCommand = Intent.Command | Command.Command;

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

@@ -16,6 +16,7 @@ export enum TraceType {
   CAROUSEL = 'carousel',
   NO_REPLY = 'no-reply',
   ENTITY_FILLING = 'entity-filling',
+  CUSTOM = 'custom',
 }
 
 export interface BaseTraceFramePath<Event extends BaseEvent = BaseEvent> {