feat: channel action trace (PL-41) (#360)

**Fixes or implements PL-41** ### Brief description. What is this change?  Co-authored-by: Tyler Stewart <tyler.stewart@voiceflow.com>
voiceflow · Aug 29, 2022 · 4175b88 · 4175b88
1 parent f2e38a8
commit 4175b88
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/packages/base-types/src/node/channelAction.ts b/packages/base-types/src/node/channelAction.ts
@@ -1,9 +1,9 @@
-import { Nullable } from '@voiceflow/common';
+import { AnyRecord, Nullable } from '@voiceflow/common';
 
 import { NodeType } from './constants';
 import { BaseEvent, BaseNode, BasePort, BasePortList, BaseStep, BaseStepPorts, NodeID } from './utils';
 
-interface StepData<Payload = unknown> {
+interface StepData<Payload = AnyRecord> {
   stop?: boolean;
   payload: Payload;
   defaultPath?: number;
@@ -15,7 +15,7 @@ export interface StepPort<Event = BaseEvent> extends BasePort {
 
 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>>> {
+export interface Step<Payload = AnyRecord, Event = BaseEvent> extends BaseStep<StepData<Payload>, StepPorts<Event>, BasePortList<StepPort<Event>>> {
   type: NodeType.CHANNEL_ACTION;
 }
 
@@ -29,7 +29,7 @@ export interface Node<Event = BaseEvent> extends BaseNode {
   type: NodeType.CHANNEL_ACTION;
   data: {
     name: string;
-    payload: unknown;
+    payload: AnyRecord;
   };
   stop: boolean;
   defaultPath?: number; // index starting from 0

diff --git a/packages/base-types/src/node/utils/trace.ts b/packages/base-types/src/node/utils/trace.ts
@@ -17,6 +17,7 @@ export enum TraceType {
   CAROUSEL = 'carousel',
   NO_REPLY = 'no-reply',
   ENTITY_FILLING = 'entity-filling',
+  CHANNEL_ACTION = 'channel-action',
 }
 
 export interface BaseTraceFramePath<Event extends BaseEvent = BaseEvent> {

diff --git a/packages/base-types/src/trace/index.ts b/packages/base-types/src/trace/index.ts
@@ -10,8 +10,8 @@ import { BaseTraceFrame, TraceType } from '@base-types/node/utils';
 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';
 
-export { TraceFrame as CardV2Trace } from '@base-types/node/cardV2';
 export { TraceFrame as CarouselTrace } from '@base-types/node/carousel';
 export { TraceFrame as ExitTrace } from '@base-types/node/exit';
 export { TraceFrame as FlowTrace } from '@base-types/node/flow';
@@ -77,6 +77,15 @@ export interface LogTrace extends BaseTraceFrame<LogTracePayload> {
   type: TraceType.LOG;
 }
 
+export interface ChannelActionTracePayload {
+  name: string;
+  data: AnyRecord;
+}
+
+export interface ChannelActionTrace extends BaseTraceFrame<ChannelActionTracePayload> {
+  type: TraceType.CHANNEL_ACTION;
+}
+
 export type AnyTrace =
   | LogTrace
   | ExitTrace
@@ -92,4 +101,5 @@ export type AnyTrace =
   | NoReplyTrace
   | CarouselTrace
   | CardV2Trace
-  | EntityFillingTrace;
+  | EntityFillingTrace
+  | ChannelActionTrace;