@voiceflow/sdk-runtime 1.3.3 → 1.4.0

package/src/runtime/runtime.interface.ts

@@ -1,4 +1,6 @@
-import { BaseRequest } from '@voiceflow/base-types';
+import { BaseRequest, Trace } from '@voiceflow/base-types';
+
+export { Trace } from '@voiceflow/base-types';
 
 // Super broad type so that differing fetch types (ex. builtin, node-fetch, etc.) don't conflict with it
 type FetchFn = (...parameters: any[]) => Promise<any>;
@@ -44,7 +46,7 @@ export interface RuntimeInteractRequest {
 export interface RuntimeInteractResponse {
   state: RuntimeState;
   request: RuntimeAction;
-  trace: RuntimeTrace[];
+  trace: Trace.AnyTrace[];
 }
 
 export type RuntimeAction =
@@ -79,111 +81,14 @@ export interface RuntimeState {
   variables: Record<string, any>;
 }
 
-export const RuntimeTraceTypeSet = new Set([
-  'speak',
-  'text',
-  'choice',
-  'card',
-  'visual',
-  'audio',
-  'payload',
-  'stream',
-  'end',
-] as const);
-
-export type RuntimeTraceType = typeof RuntimeTraceTypeSet extends Set<infer K> ? K : never;
-
-export const isRuntimeTraceType = (value: unknown): value is RuntimeTraceType =>
-  typeof value === 'string' && RuntimeTraceTypeSet.has(value as any);
-
-export interface RuntimeTrace<T extends RuntimeTraceType = RuntimeTraceType, P = unknown> {
-  type: T;
-  payload: P;
-}
+export const isRuntimeTraceType = (value: unknown): value is Trace.TraceType =>
+  typeof value === 'string' && Object.values<string>(Trace.TraceType).includes(value);
 
-export const isRuntimeTrace = (value: unknown): value is RuntimeTrace =>
+export const isRuntimeTrace = (value: unknown): value is Trace.BaseTraceFrame =>
   typeof value === 'object' &&
   Object.prototype.hasOwnProperty.call(value, 'type') &&
   isRuntimeTraceType((value as any).type);
 
-export interface CardTracePayload {
-  card: {
-    type: string;
-    title: string;
-    text: string;
-    image?: {
-      largeImageUrl: string;
-      alt: string;
-    };
-  };
-}
-
-export type CardTrace = RuntimeTrace<'card', CardTracePayload>;
-
-export const isCardTrace = (value: unknown): value is CardTrace => isRuntimeTrace(value) && value.type === 'card';
-
-export type ChoiceTrace = RuntimeTrace<'choice', ChoiceTracePayload>;
-
-export interface ChoiceTracePayload {
-  buttons: { name: string }[];
-}
-
-export const isChoiceTrace = (value: unknown): value is ChoiceTrace => isRuntimeTrace(value) && value.type === 'choice';
-
-export interface PayloadTracePayload {
-  data: any;
-}
-
-export type EndTrace = RuntimeTrace<'end'>;
-
-export const isEndTrace = (value: unknown): value is EndTrace => isRuntimeTrace(value) && value.type === 'end';
-
-export type PayloadTrace = RuntimeTrace<'payload', PayloadTracePayload>;
-
-export const isPayloadTrace = (value: unknown): value is PayloadTrace =>
-  isRuntimeTrace(value) && value.type === 'payload';
-
-export interface SpeakTracePayload {
-  voice?: string;
-  src?: string;
-  message: string;
-  type: 'speak' | 'audio';
-}
-
-export type SpeakTrace = RuntimeTrace<'speak', SpeakTracePayload>;
-
-export const isSpeakTrace = (value: unknown): value is SpeakTrace => isRuntimeTrace(value) && value.type === 'speak';
-
-export interface TextTracePayload {
-  message: string;
-}
-
-export type TextTrace = RuntimeTrace<'text', TextTracePayload>;
-
-export const isTextTrace = (value: unknown): value is TextTrace => isRuntimeTrace(value) && value.type === 'text';
-
-export interface VisualTracePayload {
-  image: string;
-}
-
-export type VisualTrace = RuntimeTrace<'visual', VisualTracePayload>;
-
-export const isVisualTrace = (value: unknown): value is VisualTrace => isRuntimeTrace(value) && value.type === 'visual';
-
-export interface StreamTracePayload {
-  src: string;
-  loop: boolean;
-  description?: string;
-  title?: string;
-  iconImage?: string;
-  backgroundImage?: string;
-  action: string;
-}
-
-export type StreamTrace = RuntimeTrace<'stream', StreamTracePayload>;
-
-export const isStreamTrace = (value: unknown): value is StreamTrace => isRuntimeTrace(value) && value.type === 'stream';
-
 export interface RuntimeHttpRequest {
   method?: string;
   params?: URLSearchParams;

package/src/runtime/runtime.service.auth.ts

@@ -28,4 +28,9 @@ export class AuthRuntimeService extends RuntimeService {
       params: new URLSearchParams({ verbose: 'true' }),
     });
   }
+
+  // TODO: expose authenticated publishing
+  public async getPublishing() {
+    return {};
+  }
 }

package/src/runtime/runtime.service.public.ts

@@ -29,4 +29,15 @@ export class PublicRuntimeService extends RuntimeService {
       }
     );
   }
+
+  public async getPublishing(request: { versionID?: string }): Promise<Record<string, unknown>> {
+    const { versionID } = request;
+
+    return this.send<Record<string, unknown>>(`public/${this.projectID}/publishing`, {
+      method: 'GET',
+      headers: {
+        ...(versionID ? { versionID } : {}),
+      },
+    });
+  }
 }

package/src/runtime/runtime.service.ts

@@ -17,6 +17,8 @@ export abstract class RuntimeService {
     }
   }
 
+  public abstract getPublishing(request: { versionID?: string }): Promise<Record<string, unknown>>;
+
   public abstract interact(
     request: RuntimeInteractRequest
   ): Promise<Partial<RuntimeInteractResponse> & Pick<RuntimeInteractResponse, 'trace'>>;

package/src/sdk/sdk.service.ts

@@ -1,11 +1,5 @@
-import type { IntentActionPayload, RuntimeInteractRequest, RuntimeService } from '@/runtime';
-import {
-  AuthRuntimeService,
-  createIntentAction,
-  isAuthRuntimeOptions,
-  isPublicRuntimeOptions,
-  PublicRuntimeService,
-} from '@/runtime';
+import type { RuntimeInteractRequest, RuntimeService } from '@/runtime';
+import { AuthRuntimeService, isAuthRuntimeOptions, isPublicRuntimeOptions, PublicRuntimeService } from '@/runtime';
 import type { TraceDeclaration } from '@/trace/trace.interface.js';
 import { TraceService } from '@/trace/trace.service.js';
 
@@ -38,10 +32,7 @@ export class VoiceflowRuntime<T> {
     return this.trace.processTrace(context, response);
   }
 
-  public intent(request: { context: T; sessionID: string; payload: IntentActionPayload }): Promise<T> {
-    return this.interact(request.context, {
-      action: createIntentAction(request.payload),
-      sessionID: request.sessionID,
-    });
+  public async getPublishing(...options: Parameters<RuntimeService['getPublishing']>) {
+    return this.runtime.getPublishing(...options);
   }
 }

package/src/trace/components/card.component.ts

@@ -1,5 +1,5 @@
-import type { CardTrace } from '@/runtime/runtime.interface.js';
+import type { BaseNode } from '@voiceflow/base-types';
 
 import { createTraceComponent } from '../trace.component.js';
 
-export const CardTraceComponent = createTraceComponent<CardTrace>('card');
+export const CardTraceComponent = createTraceComponent<{ type: 'card'; payload: { card: BaseNode.Card.Card } }>('card');

package/src/trace/components/cardV2.component.ts

@@ -0,0 +1,5 @@
+import { Trace } from '@/runtime/runtime.interface.js';
+
+import { createTraceComponent } from '../trace.component.js';
+
+export const CardV2TraceComponent = createTraceComponent<Trace.CardV2>(Trace.TraceType.CARD_V2);

package/src/trace/components/choice.component.ts

@@ -1,5 +1,5 @@
-import type { ChoiceTrace } from '@/runtime/runtime.interface.js';
+import { Trace } from '@/runtime/runtime.interface.js';
 
 import { createTraceComponent } from '../trace.component.js';
 
-export const ChoiceTraceComponent = createTraceComponent<ChoiceTrace>('choice');
+export const ChoiceTraceComponent = createTraceComponent<Trace.Choice>(Trace.TraceType.CHOICE);

package/src/trace/components/end.component.ts

@@ -1,5 +1,5 @@
-import type { EndTrace } from '@/runtime/runtime.interface.js';
+import { Trace } from '@/runtime/runtime.interface.js';
 
 import { createTraceComponent } from '../trace.component.js';
 
-export const EndTraceComponent = createTraceComponent<EndTrace>('end');
+export const EndTraceComponent = createTraceComponent<Trace.End>(Trace.TraceType.END);

package/src/trace/components/index.ts

@@ -1,7 +1,7 @@
 export * from './card.component.js';
+export * from './cardV2.component.js';
 export * from './choice.component.js';
 export * from './end.component.js';
-export * from './payload.component.js';
 export * from './speak.component.js';
 export * from './stream.component.js';
 export * from './text.component.js';

package/src/trace/components/speak.component.ts

@@ -1,5 +1,5 @@
-import type { SpeakTrace } from '@/runtime/runtime.interface.js';
+import { Trace } from '@/runtime/runtime.interface.js';
 
 import { createTraceComponent } from '../trace.component.js';
 
-export const SpeakTraceComponent = createTraceComponent<SpeakTrace>('speak');
+export const SpeakTraceComponent = createTraceComponent<Trace.Speak>(Trace.TraceType.SPEAK);

package/src/trace/components/stream.component.ts

@@ -1,5 +1,5 @@
-import type { StreamTrace } from '@/runtime/runtime.interface.js';
+import { Trace } from '@/runtime/runtime.interface.js';
 
 import { createTraceComponent } from '../trace.component.js';
 
-export const StreamTraceComponent = createTraceComponent<StreamTrace>('stream');
+export const StreamTraceComponent = createTraceComponent<Trace.Stream>(Trace.TraceType.STREAM);

package/src/trace/components/text.component.ts

@@ -1,5 +1,5 @@
-import type { TextTrace } from '@/runtime/runtime.interface.js';
+import { Trace } from '@/runtime/runtime.interface.js';
 
 import { createTraceComponent } from '../trace.component.js';
 
-export const TextTraceComponent = createTraceComponent<TextTrace>('text');
+export const TextTraceComponent = createTraceComponent<Trace.Text>(Trace.TraceType.TEXT);

package/src/trace/components/visual.component.ts

@@ -1,5 +1,9 @@
-import type { VisualTrace } from '@/runtime/runtime.interface.js';
+import type { BaseNode } from '@voiceflow/base-types';
+
+import { Trace } from '@/runtime/runtime.interface.js';
 
 import { createTraceComponent } from '../trace.component.js';
 
-export const VisualTraceComponent = createTraceComponent<VisualTrace>('visual');
+export const VisualTraceComponent = createTraceComponent<Trace.Visual & { payload: BaseNode.Visual.ImageStepData }>(
+  Trace.TraceType.VISUAL
+);

package/src/trace/trace.component.ts

@@ -1,17 +1,15 @@
-import type { RuntimeTrace } from '@/runtime/runtime.interface.js';
+import type { Trace } from '@/runtime/runtime.interface.js';
 
 import type { TraceAccumulator, TraceDeclaration } from './trace.interface.js';
 
-export interface TraceComponentOverload<Trace extends RuntimeTrace> {
-  <Context>(declaration: TraceDeclaration<Context, Trace>): Required<TraceDeclaration<Context, Trace>>;
-  <Context>(handle: TraceAccumulator<Context, Trace>): Required<TraceDeclaration<Context, Trace>>;
+export interface TraceComponentOverload<T extends Trace.BaseTraceFrame> {
+  <Context>(declaration: TraceDeclaration<Context, T>): Required<TraceDeclaration<Context, T>>;
+  <Context>(handle: TraceAccumulator<Context, T>): Required<TraceDeclaration<Context, T>>;
 }
 
 export const createTraceComponent =
-  <Trace extends RuntimeTrace>(type: Trace['type']): TraceComponentOverload<Trace> =>
-  <Context>(
-    handle: TraceDeclaration<Context, Trace> | TraceAccumulator<Context, Trace>
-  ): TraceDeclaration<Context, Trace> => {
+  <T extends Trace.BaseTraceFrame>(type: T['type']): TraceComponentOverload<T> =>
+  <Context>(handle: TraceDeclaration<Context, T> | TraceAccumulator<Context, T>): TraceDeclaration<Context, T> => {
     if (typeof handle === 'function') {
       return {
         canHandle: (trace) => trace.type === type,

package/src/trace/trace.interface.ts

@@ -1,21 +1,21 @@
-import type { RuntimeTrace } from '@/runtime/runtime.interface';
+import type { Trace } from '@/runtime/runtime.interface';
 
 export interface TraceOptions<T> {
   traces?: TraceDeclaration<T, any>[];
 }
 
-export interface TraceDeclaration<Context, Trace extends RuntimeTrace> {
-  canHandle: TraceCanHandle<Trace>;
-  handle: TraceAccumulator<Context, Trace>;
+export interface TraceDeclaration<Context, T extends Trace.BaseTraceFrame> {
+  canHandle: TraceCanHandle<T>;
+  handle: TraceAccumulator<Context, T>;
 }
 
-export type TraceCanHandle<Trace extends RuntimeTrace> = (trace: Trace) => boolean;
+export type TraceCanHandle<T extends Trace.BaseTraceFrame> = (trace: T) => boolean;
 
 export interface TraceHandlerMeta<Context> {
   context: Context;
 }
 
-export type TraceAccumulator<Context, Trace extends RuntimeTrace> = (
+export type TraceAccumulator<Context, T extends Trace.BaseTraceFrame> = (
   meta: TraceHandlerMeta<Context>,
-  trace: Trace
+  trace: T
 ) => Context;

package/build/cjs/trace/components/payload.component.d.ts

@@ -1,3 +0,0 @@
-import type { PayloadTrace } from '../../runtime/runtime.interface.js';
-export declare const PayloadTraceComponent: import("../trace.component.js").TraceComponentOverload<PayloadTrace>;
-//# sourceMappingURL=payload.component.d.ts.map

package/build/cjs/trace/components/payload.component.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"payload.component.d.ts","sourceRoot":"","sources":["../../../../src/trace/components/payload.component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAInE,eAAO,MAAM,qBAAqB,sEAAgD,CAAC"}

package/build/cjs/trace/components/payload.component.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayloadTraceComponent = void 0;
-const trace_component_js_1 = require("../trace.component.js");
-exports.PayloadTraceComponent = (0, trace_component_js_1.createTraceComponent)('payload');

package/build/esm/trace/components/payload.component.d.ts

@@ -1,3 +0,0 @@
-import type { PayloadTrace } from '../../runtime/runtime.interface.js';
-export declare const PayloadTraceComponent: import("../trace.component.js").TraceComponentOverload<PayloadTrace>;
-//# sourceMappingURL=payload.component.d.ts.map

package/build/esm/trace/components/payload.component.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"payload.component.d.ts","sourceRoot":"","sources":["../../../../src/trace/components/payload.component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAInE,eAAO,MAAM,qBAAqB,sEAAgD,CAAC"}

package/build/esm/trace/components/payload.component.js

@@ -1,2 +0,0 @@
-import { createTraceComponent } from '../trace.component.js';
-export const PayloadTraceComponent = createTraceComponent('payload');

package/src/trace/components/payload.component.ts

@@ -1,5 +0,0 @@
-import type { PayloadTrace } from '@/runtime/runtime.interface.js';
-
-import { createTraceComponent } from '../trace.component.js';
-
-export const PayloadTraceComponent = createTraceComponent<PayloadTrace>('payload');