@voiceflow/sdk-runtime 1.7.0 → 1.8.0

package/src/runtime/index.ts

@@ -1,4 +0,0 @@
-export * from './runtime.interface.js';
-export * from './runtime.service.auth.js';
-export * from './runtime.service.js';
-export * from './runtime.service.public.js';

package/src/runtime/runtime.interface.ts

@@ -1,105 +0,0 @@
-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>;
-
-export interface RuntimeOptions<V = AuthVerify | PublicVerify> {
-  url: string;
-  verify: V;
-
-  /**
-   * A ponyfill to use for `fetch()`.
-   * Defaults to the global `fetch()`.
-   */
-  fetchPonyfill?: FetchFn;
-}
-
-export interface AuthVerify {
-  authorization: string;
-}
-
-export interface PublicVerify {
-  projectID: string;
-}
-
-export const isAuthRuntimeOptions = (
-  options: RuntimeOptions<Partial<AuthVerify & PublicVerify>>
-): options is RuntimeOptions<AuthVerify> => {
-  return !!options?.verify?.authorization;
-};
-
-export const isPublicRuntimeOptions = (
-  options: RuntimeOptions<Partial<AuthVerify & PublicVerify>>
-): options is RuntimeOptions<PublicVerify> => {
-  return typeof options?.verify?.projectID === 'string';
-};
-
-export interface RuntimeInteractRequest {
-  action: RuntimeAction;
-  sessionID: string;
-  versionID?: string;
-  config?: any;
-}
-
-export interface RuntimeFeedbackRequest {
-  name: string;
-  sessionID: string;
-  versionID?: string;
-
-  [key: string]: any;
-}
-
-export interface RuntimeInteractResponse {
-  state: RuntimeState;
-  request: RuntimeAction;
-  trace: Trace.AnyTrace[];
-}
-
-export type RuntimeAction =
-  | BaseRequest.TextRequest
-  | BaseRequest.LaunchRequest
-  | BaseRequest.IntentRequest
-  | BaseRequest.ActionRequest
-  | BaseRequest.GeneralRequest
-  | BaseRequest.BaseRequest<unknown>;
-
-export const isRuntimeAction = (value: unknown): value is RuntimeAction =>
-  typeof value === 'object' && Object.prototype.hasOwnProperty.call(value, 'type');
-
-export interface IntentActionPayload {
-  query: string;
-  intent: { name: string };
-  entities: { name: string; value: string }[];
-  confidence?: number;
-}
-
-export type IntentAction = BaseRequest.IntentRequest;
-export type ActionType = BaseRequest.RequestType;
-export const ActionType = BaseRequest.RequestType;
-
-export const createIntentAction = (payload: BaseRequest.IntentRequestPayload): BaseRequest.IntentRequest => ({
-  type: ActionType.INTENT,
-  payload,
-});
-
-export interface RuntimeState {
-  storage: Record<string, any>;
-  variables: Record<string, any>;
-}
-
-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 Trace.BaseTraceFrame =>
-  typeof value === 'object' &&
-  Object.prototype.hasOwnProperty.call(value, 'type') &&
-  isRuntimeTraceType((value as any).type);
-
-export interface RuntimeHttpRequest {
-  method?: string;
-  params?: URLSearchParams;
-  body?: any;
-  headers?: HeadersInit;
-}

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

@@ -1,46 +0,0 @@
-import type {
-  AuthVerify,
-  RuntimeInteractRequest,
-  RuntimeInteractResponse,
-  RuntimeOptions,
-} from '@/runtime/runtime.interface.js';
-import { RuntimeService } from '@/runtime/runtime.service';
-
-export class AuthRuntimeService extends RuntimeService {
-  private readonly authorization: string;
-
-  public constructor(options: RuntimeOptions<AuthVerify>) {
-    super(options);
-
-    this.authorization = options.verify.authorization;
-  }
-
-  public async interact(request: RuntimeInteractRequest): Promise<RuntimeInteractResponse> {
-    const { action, config, sessionID, versionID } = request;
-
-    return this.send<RuntimeInteractResponse>(`state/user/${sessionID}/interact`, {
-      method: 'POST',
-      body: { action, config },
-      headers: {
-        authorization: this.authorization,
-        sessionID,
-        ...(versionID ? { versionID } : {}),
-      },
-      params: new URLSearchParams({ verbose: 'true' }),
-    });
-  }
-
-  public async feedback() {
-    return Promise.reject(new Error('not implemented'));
-  }
-
-  // TODO: expose authenticated publishing
-  public getPublishing() {
-    return Promise.reject(new Error('not implemented'));
-  }
-
-  // TODO: expose authenticated createTranscript
-  public createTranscript() {
-    return Promise.reject(new Error('not implemented'));
-  }
-}

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

@@ -1,67 +0,0 @@
-import type { BaseModels } from '@voiceflow/base-types';
-
-import type {
-  PublicVerify,
-  RuntimeFeedbackRequest,
-  RuntimeInteractRequest,
-  RuntimeInteractResponse,
-  RuntimeOptions,
-} from '@/runtime/runtime.interface.js';
-import { RuntimeService } from '@/runtime/runtime.service';
-
-export class PublicRuntimeService extends RuntimeService {
-  private readonly projectID: string;
-
-  public constructor(options: RuntimeOptions<PublicVerify>) {
-    super(options);
-
-    this.projectID = options.verify.projectID;
-  }
-
-  public async interact(request: RuntimeInteractRequest): Promise<Pick<RuntimeInteractResponse, 'trace'>> {
-    const { action, config, sessionID, versionID } = request;
-
-    return this.send<Pick<RuntimeInteractResponse, 'trace'>>(
-      `public/${this.projectID}/state/user/${sessionID}/interact`,
-      {
-        method: 'POST',
-        body: { action, config },
-        headers: {
-          sessionID,
-          ...(versionID && { versionID }),
-        },
-      }
-    );
-  }
-
-  public async feedback(request: RuntimeFeedbackRequest): Promise<void> {
-    const { versionID, sessionID, ...body } = request;
-
-    await this.send(`feedback/${this.projectID}/user/${sessionID}`, {
-      method: 'POST',
-      body,
-      headers: {
-        sessionID,
-        ...(versionID && { versionID }),
-      },
-    });
-  }
-
-  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 } : {}),
-      },
-    });
-  }
-
-  public async createTranscript(sessionID: string, metadata: { os?: string; device?: string; browser?: string }) {
-    return this.send<BaseModels.Transcript.Model>(`public/${this.projectID}/transcripts`, {
-      method: 'POST',
-      body: { ...metadata, sessionID },
-    });
-  }
-}

package/src/runtime/runtime.service.ts

@@ -1,63 +0,0 @@
-import type { BaseModels } from '@voiceflow/base-types';
-import createHTTPError from 'http-errors';
-
-import type {
-  RuntimeFeedbackRequest,
-  RuntimeHttpRequest,
-  RuntimeInteractRequest,
-  RuntimeInteractResponse,
-  RuntimeOptions,
-} from './runtime.interface';
-
-export abstract class RuntimeService {
-  private readonly fetch: typeof globalThis.fetch;
-
-  public constructor(private readonly options: RuntimeOptions) {
-    this.fetch = options.fetchPonyfill ?? globalThis.fetch?.bind(globalThis);
-    if (!this.fetch) {
-      throw new TypeError('fetch implementation was not provided and a global fetch was not available');
-    }
-  }
-
-  public abstract getPublishing(request: { versionID?: string }): Promise<Record<string, unknown>>;
-
-  public abstract createTranscript(
-    sessionID: string,
-    metadata: {
-      os?: string;
-      user?: {
-        name?: string;
-        image?: string;
-      };
-      device?: string;
-      browser?: string;
-    }
-  ): Promise<BaseModels.Transcript.Model>;
-
-  public abstract interact(
-    request: RuntimeInteractRequest
-  ): Promise<Partial<RuntimeInteractResponse> & Pick<RuntimeInteractResponse, 'trace'>>;
-
-  public abstract feedback(request: RuntimeFeedbackRequest): Promise<void>;
-
-  protected async send<T>(path: string, args: RuntimeHttpRequest = {}): Promise<T> {
-    const url = new URL(path, this.options.url);
-    if (args.params) url.search = args.params.toString();
-
-    const result = await this.fetch(url, {
-      method: args.method ?? 'GET',
-      body: args.body ? JSON.stringify(args.body) : undefined,
-      headers: {
-        'content-type': 'application/json',
-        ...(args.headers ?? {}),
-      },
-    });
-
-    const json = (await result.json().catch(() => null)) as any;
-    if (!result.ok) {
-      throw createHTTPError(result.status, result.statusText, json);
-    }
-
-    return json;
-  }
-}

package/src/sdk/index.ts

@@ -1,2 +0,0 @@
-export * from './sdk.interface.js';
-export * from './sdk.service.js';

package/src/sdk/sdk.interface.ts

@@ -1,4 +0,0 @@
-import type { RuntimeOptions } from '@/runtime/runtime.interface.js';
-import type { TraceOptions } from '@/trace/trace.interface.js';
-
-export type VoiceflowRuntimeOptions<T> = RuntimeOptions & TraceOptions<T>;

package/src/sdk/sdk.service.ts

@@ -1,46 +0,0 @@
-import type { RuntimeFeedbackRequest, 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';
-
-import type { VoiceflowRuntimeOptions } from './sdk.interface.js';
-
-export class VoiceflowRuntime<T> {
-  private readonly runtime: RuntimeService;
-
-  private readonly trace: TraceService<T>;
-
-  public constructor(options: VoiceflowRuntimeOptions<T>) {
-    this.trace = new TraceService(options);
-
-    if (isAuthRuntimeOptions(options)) {
-      this.runtime = new AuthRuntimeService(options);
-    } else if (isPublicRuntimeOptions(options)) {
-      this.runtime = new PublicRuntimeService(options);
-    } else {
-      throw new Error('invalid runtime options');
-    }
-  }
-
-  public registerStep(step: TraceDeclaration<T, any>) {
-    this.trace.registerTrace(step);
-    return this;
-  }
-
-  public async interact(context: T, request: RuntimeInteractRequest): Promise<T> {
-    const response = await this.runtime.interact(request);
-    return this.trace.processTrace(context, response);
-  }
-
-  public async feedback(request: RuntimeFeedbackRequest) {
-    return this.runtime.feedback(request);
-  }
-
-  public async getPublishing(...options: Parameters<RuntimeService['getPublishing']>) {
-    return this.runtime.getPublishing(...options);
-  }
-
-  public async createTranscript(...options: Parameters<RuntimeService['createTranscript']>) {
-    return this.runtime.createTranscript(...options);
-  }
-}

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

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

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

@@ -1,5 +0,0 @@
-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 +0,0 @@
-import { Trace } from '@/runtime/runtime.interface.js';
-
-import { createTraceComponent } from '../trace.component.js';
-
-export const ChoiceTraceComponent = createTraceComponent<Trace.Choice>(Trace.TraceType.CHOICE);

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

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

package/src/trace/components/index.ts

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

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

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

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

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

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

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

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

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

package/src/trace/index.ts

@@ -1,4 +0,0 @@
-export * from './components/index.js';
-export * from './trace.component.js';
-export * from './trace.interface.js';
-export * from './trace.service.js';

package/src/trace/trace.component.ts

@@ -1,21 +0,0 @@
-import type { Trace } from '@/runtime/runtime.interface.js';
-
-import type { TraceAccumulator, TraceDeclaration } from './trace.interface.js';
-
-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 =
-  <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,
-        handle,
-      };
-    }
-
-    return handle;
-  };

package/src/trace/trace.interface.ts

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

package/src/trace/trace.service.ts

@@ -1,34 +0,0 @@
-import type { RuntimeInteractResponse } from '@/runtime/runtime.interface.js';
-
-import type { TraceDeclaration, TraceHandlerMeta, TraceOptions } from './trace.interface';
-
-export class TraceService<T = unknown> {
-  private readonly traces: TraceDeclaration<T, any>[] = [];
-
-  public constructor(options: TraceOptions<T> = {}) {
-    this.registerTraces(options.traces ?? []);
-  }
-
-  public registerTrace(step: TraceDeclaration<T, any>): this {
-    this.traces.push(step);
-    return this;
-  }
-
-  public registerTraces(steps: TraceDeclaration<T, any>[]): this {
-    steps.forEach((step) => this.registerTrace(step));
-    return this;
-  }
-
-  public async processTrace(context: T, response: Pick<RuntimeInteractResponse, 'trace'>): Promise<T> {
-    const meta: TraceHandlerMeta<T> = { context };
-
-    for (const trace of response.trace) {
-      const step = this.traces.find((step) => step.canHandle(trace));
-      if (step) {
-        // eslint-disable-next-line no-await-in-loop
-        meta.context = await step.handle(meta, trace);
-      }
-    }
-    return meta.context;
-  }
-}

package/tsconfig.build.cjs.json

@@ -1,9 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "module": "CommonJS",
-    "moduleResolution": "Node",
-    "outDir": "build/cjs"
-  }
-}

package/tsconfig.build.esm.json

@@ -1,12 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "outDir": "build/esm"
-  },
-  "tsc-alias": {
-    "resolveFullPaths": true
-  }
-}

package/tsconfig.build.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "build", "test", "**/*test.ts", "**/*test-d.ts"]
-}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "@voiceflow-meta/typescript-config/base.json",
-  "compilerOptions": {
-    "baseUrl": "./",
-    "outDir": "./build",
-    "stripInternal": true
-  },
-  "include": ["src/**/*", "test"],
-  "exclude": ["node_modules", "build", "src/**/*.test-d.ts"]
-}