@voiceflow/base-types 2.25.3 → 2.28.0

package/build/esm/runtimeLogs/index.d.ts

@@ -0,0 +1,3 @@
+export * from './logs';
+export * from './runtime';
+export { Iso8601Timestamp, PathReference } from './utils';

package/build/esm/runtimeLogs/index.js

@@ -0,0 +1,2 @@
+export * from './logs';
+export * from './runtime';

package/build/esm/runtimeLogs/logs/base.d.ts

@@ -0,0 +1,22 @@
+import { EmptyObject } from '@voiceflow/common';
+import { Iso8601Timestamp, PathReference } from '../utils';
+import { GlobalLogKind, StepLogKind } from './kinds';
+import { LogLevel } from './levels';
+/** The base log interface. This should not be used directly, use one of the subtypes instead. */
+interface BaseLog {
+    kind: string;
+    timestamp: Iso8601Timestamp;
+    message: EmptyObject;
+    level: LogLevel;
+}
+export interface BaseGlobalLog<Kind extends GlobalLogKind, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
+    kind: `global.${Kind}`;
+    level: Level;
+    message: Message;
+}
+export interface BaseStepLog<Kind extends StepLogKind, Message extends EmptyObject, Level extends LogLevel = LogLevel.INFO> extends BaseLog {
+    kind: `step.${Kind}`;
+    level: Level;
+    message: PathReference & Message;
+}
+export {};

package/build/esm/runtimeLogs/logs/base.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/global/conversationStart.d.ts

@@ -0,0 +1,6 @@
+import { BaseGlobalLog } from '../base';
+import { GlobalLogKind } from '../kinds';
+export declare type ConversationStartLog = BaseGlobalLog<GlobalLogKind.CONVERSATION_START, {
+    versionID: string;
+    userID: string;
+}>;

package/build/esm/runtimeLogs/logs/global/conversationStart.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/index.d.ts

@@ -0,0 +1,6 @@
+import * as Logs from './logs';
+export * as Kinds from './kinds';
+export { Logs };
+export { LogLevel } from './levels';
+/** All possible runtime logs. */
+export declare type Log = Logs.GlobalLog | Logs.StepLog;

package/build/esm/runtimeLogs/logs/index.js

@@ -0,0 +1,4 @@
+import * as Logs from './logs';
+export * as Kinds from './kinds';
+export { Logs };
+export { LogLevel } from './levels';

package/build/esm/runtimeLogs/logs/kinds.d.ts

@@ -0,0 +1,26 @@
+/** Similar to {@link NodeType}, but for runtime logging */
+export declare enum StepLogKind {
+    TEXT = "text",
+    SPEAK = "speak",
+    AUDIO = "audio",
+    VISUALS = "visuals",
+    BUTTONS = "buttons",
+    CHOICE = "choice",
+    CAPTURE = "capture",
+    PROMPT = "prompt",
+    INTENT = "intent",
+    CONDITION = "condition",
+    SET = "set",
+    RANDOM = "random",
+    FLOW = "flow",
+    EXIT = "exit",
+    API = "api",
+    /** @deprecated Will be removed soon */
+    GOOGLE_SHEETS = "google_sheets",
+    CUSTOM_CODE = "custom_code",
+    CUSTOM_ACTION = "custom_action",
+    START = "start"
+}
+export declare enum GlobalLogKind {
+    CONVERSATION_START = "conversation_start"
+}

package/build/esm/runtimeLogs/logs/kinds.js

@@ -0,0 +1,33 @@
+/** Similar to {@link NodeType}, but for runtime logging */
+export var StepLogKind;
+(function (StepLogKind) {
+    // Response
+    StepLogKind["TEXT"] = "text";
+    StepLogKind["SPEAK"] = "speak";
+    StepLogKind["AUDIO"] = "audio";
+    StepLogKind["VISUALS"] = "visuals";
+    // User input
+    StepLogKind["BUTTONS"] = "buttons";
+    StepLogKind["CHOICE"] = "choice";
+    StepLogKind["CAPTURE"] = "capture";
+    StepLogKind["PROMPT"] = "prompt";
+    StepLogKind["INTENT"] = "intent";
+    // Logic
+    StepLogKind["CONDITION"] = "condition";
+    StepLogKind["SET"] = "set";
+    StepLogKind["RANDOM"] = "random";
+    StepLogKind["FLOW"] = "flow";
+    StepLogKind["EXIT"] = "exit";
+    // Integration
+    StepLogKind["API"] = "api";
+    /** @deprecated Will be removed soon */
+    StepLogKind["GOOGLE_SHEETS"] = "google_sheets";
+    StepLogKind["CUSTOM_CODE"] = "custom_code";
+    StepLogKind["CUSTOM_ACTION"] = "custom_action";
+    // Special
+    StepLogKind["START"] = "start";
+})(StepLogKind || (StepLogKind = {}));
+export var GlobalLogKind;
+(function (GlobalLogKind) {
+    GlobalLogKind["CONVERSATION_START"] = "conversation_start";
+})(GlobalLogKind || (GlobalLogKind = {}));

package/build/esm/runtimeLogs/logs/levels.d.ts

@@ -0,0 +1,6 @@
+export declare enum LogLevel {
+    ERROR = "error",
+    WARN = "warn",
+    INFO = "info",
+    VERBOSE = "verbose"
+}

package/build/esm/runtimeLogs/logs/levels.js

@@ -0,0 +1,7 @@
+export var LogLevel;
+(function (LogLevel) {
+    LogLevel["ERROR"] = "error";
+    LogLevel["WARN"] = "warn";
+    LogLevel["INFO"] = "info";
+    LogLevel["VERBOSE"] = "verbose";
+})(LogLevel || (LogLevel = {}));

package/build/esm/runtimeLogs/logs/logs.d.ts

@@ -0,0 +1,20 @@
+import { ConversationStartLog } from './global/conversationStart';
+import { ApiStepLog } from './steps/api';
+import { ButtonsStepLog } from './steps/buttons';
+import { CaptureStepLog } from './steps/capture';
+import { CodeStepLog } from './steps/code';
+import { ConditionStepLog } from './steps/condition';
+import { CustomActionStepLog } from './steps/customAction';
+import { ExitStepLog } from './steps/exit';
+import { FlowStepLog } from './steps/flow';
+import { IntentStepLog } from './steps/intent';
+import { RandomStepLog } from './steps/random';
+import { SetStepLog } from './steps/set';
+import { SpeakStepLog } from './steps/speak';
+import { StartStepLog } from './steps/start';
+import { TextStepLog } from './steps/text';
+export { ApiStepLog, ButtonsStepLog, CaptureStepLog, CodeStepLog, ConditionStepLog, ConversationStartLog, CustomActionStepLog, ExitStepLog, FlowStepLog, IntentStepLog, RandomStepLog, SetStepLog, SpeakStepLog, StartStepLog, TextStepLog, };
+/** All possible runtime logs for global events. */
+export declare type GlobalLog = ConversationStartLog;
+/** All possible runtime logs for steps. */
+export declare type StepLog = ApiStepLog | ButtonsStepLog | CaptureStepLog | CodeStepLog | ConditionStepLog | CustomActionStepLog | ExitStepLog | FlowStepLog | IntentStepLog | RandomStepLog | SetStepLog | SpeakStepLog | StartStepLog | TextStepLog;

package/build/esm/runtimeLogs/logs/logs.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/api.d.ts

@@ -0,0 +1,34 @@
+import { APIBodyType, APIMethod } from "../../../node/api";
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+import { LogLevel } from '../levels';
+interface ApiLogMessage {
+    request: {
+        method: APIMethod;
+        url: string;
+    };
+    response: {
+        statusCode: number;
+        statusMessage: string;
+    };
+}
+interface VerboseApiLogMessage {
+    request: {
+        headers: Record<string, string>;
+        query: Record<string, string>;
+    } & ({
+        method: Exclude<APIMethod, APIMethod.GET>;
+        bodyType: APIBodyType;
+        body: string;
+    } | {
+        method: APIMethod.GET;
+        bodyType: null;
+        body: null;
+    });
+    response: {
+        headers: Record<string, string>;
+        body: string;
+    };
+}
+export declare type ApiStepLog = BaseStepLog<StepLogKind.API, ApiLogMessage, LogLevel.INFO | LogLevel.ERROR> | BaseStepLog<StepLogKind.API, ApiLogMessage & VerboseApiLogMessage, LogLevel.VERBOSE | LogLevel.ERROR>;
+export {};

package/build/esm/runtimeLogs/logs/steps/api.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/buttons.d.ts

@@ -0,0 +1,17 @@
+import { Nullable } from '@voiceflow/common';
+import { PathReference } from '../../utils';
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+interface UrlButtonLogMessage {
+    url: Nullable<string>;
+}
+interface FollowPathButtonLogMessage extends UrlButtonLogMessage {
+    intent: null;
+    path: PathReference;
+}
+interface GoToIntentButtonLogMessage extends UrlButtonLogMessage {
+    intent: string;
+    path: null;
+}
+export declare type ButtonsStepLog = BaseStepLog<StepLogKind.BUTTONS, FollowPathButtonLogMessage | GoToIntentButtonLogMessage>;
+export {};

package/build/esm/runtimeLogs/logs/steps/buttons.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/capture.d.ts

@@ -0,0 +1,8 @@
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type CaptureStepLog = BaseStepLog<StepLogKind.CAPTURE, {
+    slots: Array<{
+        utteredValue: string;
+        canonicalValue: string;
+    }>;
+}>;

package/build/esm/runtimeLogs/logs/steps/capture.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/code.d.ts

@@ -0,0 +1,10 @@
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+import { LogLevel } from '../levels';
+export declare type CodeStepLog = BaseStepLog<StepLogKind.CUSTOM_CODE, {
+    data: any;
+    error: null;
+}, LogLevel.INFO> | BaseStepLog<StepLogKind.CUSTOM_CODE, {
+    data: null;
+    error: any;
+}, LogLevel.ERROR>;

package/build/esm/runtimeLogs/logs/steps/code.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/condition.d.ts

@@ -0,0 +1,6 @@
+import { PathReference } from '../../utils';
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type ConditionStepLog = BaseStepLog<StepLogKind.CONDITION, {
+    path: PathReference;
+}>;

package/build/esm/runtimeLogs/logs/steps/condition.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/customAction.d.ts

@@ -0,0 +1,8 @@
+import { Nullable } from '@voiceflow/common';
+import { PathReference } from '../../utils';
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type CustomActionStepLog = BaseStepLog<StepLogKind.CUSTOM_ACTION, {
+    actionBody: Nullable<string>;
+    path: PathReference;
+}>;

package/build/esm/runtimeLogs/logs/steps/customAction.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/exit.d.ts

@@ -0,0 +1,10 @@
+import { EmptyObject } from '@voiceflow/common';
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+import { LogLevel } from '../levels';
+export declare type ExitStepLog = BaseStepLog<StepLogKind.EXIT, {
+    state: null;
+}, LogLevel.INFO> | BaseStepLog<StepLogKind.EXIT, {
+    /** The state of the program on exit. */
+    state: EmptyObject;
+}, LogLevel.VERBOSE>;

package/build/esm/runtimeLogs/logs/steps/exit.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/flow.d.ts

@@ -0,0 +1,6 @@
+import { PathReference } from '../../utils';
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type FlowStepLog = BaseStepLog<StepLogKind.FLOW, {
+    path: PathReference;
+}>;

package/build/esm/runtimeLogs/logs/steps/flow.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/intent.d.ts

@@ -0,0 +1,11 @@
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type IntentStepLog = BaseStepLog<StepLogKind.INTENT, {
+    intentName: string;
+    utterance: string;
+    confidence: number;
+    slots: Array<{
+        utteredValue: string;
+        canonicalValue: string;
+    }>;
+}>;

package/build/esm/runtimeLogs/logs/steps/intent.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/random.d.ts

@@ -0,0 +1,6 @@
+import { PathReference } from '../../utils';
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type RandomStepLog = BaseStepLog<StepLogKind.RANDOM, {
+    path: PathReference;
+}>;

package/build/esm/runtimeLogs/logs/steps/random.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/set.d.ts

@@ -0,0 +1,6 @@
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type SetStepLog = BaseStepLog<StepLogKind.SET, {
+    variableName: string;
+    expression: string;
+}>;

package/build/esm/runtimeLogs/logs/steps/set.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/speak.d.ts

@@ -0,0 +1,5 @@
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type SpeakStepLog = BaseStepLog<StepLogKind.SPEAK, {
+    text: string;
+}>;

package/build/esm/runtimeLogs/logs/steps/speak.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/start.d.ts

@@ -0,0 +1,4 @@
+import { EmptyObject } from '@voiceflow/common';
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type StartStepLog = BaseStepLog<StepLogKind.START, EmptyObject>;

package/build/esm/runtimeLogs/logs/steps/start.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/logs/steps/text.d.ts

@@ -0,0 +1,5 @@
+import { BaseStepLog } from '../base';
+import { StepLogKind } from '../kinds';
+export declare type TextStepLog = BaseStepLog<StepLogKind.TEXT, {
+    text: string;
+}>;

package/build/esm/runtimeLogs/logs/steps/text.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/runtime/index.d.ts

@@ -0,0 +1 @@
+export * from './logBuffer';

package/build/esm/runtimeLogs/runtime/index.js

@@ -0,0 +1 @@
+export * from './logBuffer';

package/build/esm/runtimeLogs/runtime/logBuffer.d.ts

@@ -0,0 +1,19 @@
+import { Log } from '../logs';
+/**
+ * It acts as a buffer in between the runtime which produces the logs and the service/datastore which consumes the logs.
+ * In practice, this will almost always be implemented as part of the runtime itself.
+ */
+export interface LogBuffer {
+    /** The number of {@link Log} in this {@link LogBuffer}'s buffer. */
+    readonly bufferSize: number;
+    /** Add {@link Log} to this {@link LogBuffer}'s buffer. */
+    push(...logs: Log[]): void;
+    /** Dispatch all {@link Log} from this {@link LogBuffer}'s buffer and then remove them. */
+    flush(): void;
+    /** Remove all {@link Log} from this {@link LogBuffer}'s buffer. */
+    clear(): void;
+}
+export interface AsyncLogBuffer extends LogBuffer {
+    flush(): void | Promise<void>;
+    clear(): void | Promise<void>;
+}

package/build/esm/runtimeLogs/runtime/logBuffer.js

@@ -0,0 +1 @@
+export {};

package/build/esm/runtimeLogs/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './logs';
+export * from './types';

package/build/esm/runtimeLogs/utils/index.js

@@ -0,0 +1,2 @@
+export * from './logs';
+export * from './types';

package/build/esm/runtimeLogs/utils/logs.d.ts

@@ -0,0 +1,3 @@
+import { LogLevel } from '../logs/levels';
+/** Returns the number (non-negative integer) value of `level`. A higher number is more verbose. `0` is the least verbose and most "important". */
+export declare const getValueForLogLevel: (level: LogLevel) => number;

package/build/esm/runtimeLogs/utils/logs.js

@@ -0,0 +1,9 @@
+import { LogLevel } from '../logs/levels';
+const logLevelValues = {
+    [LogLevel.ERROR]: 0,
+    [LogLevel.WARN]: 1,
+    [LogLevel.INFO]: 2,
+    [LogLevel.VERBOSE]: 3,
+};
+/** Returns the number (non-negative integer) value of `level`. A higher number is more verbose. `0` is the least verbose and most "important". */
+export const getValueForLogLevel = (level) => logLevelValues[level];

package/build/esm/runtimeLogs/utils/types.d.ts

@@ -0,0 +1,7 @@
+import { StepLogKind } from '../logs/kinds';
+export declare type Iso8601Timestamp = string;
+/** A reference to a path on the canvas. */
+export interface PathReference {
+    componentName: StepLogKind;
+    stepID: string;
+}

package/build/esm/runtimeLogs/utils/types.js

@@ -0,0 +1 @@
+export {};

package/build/esm/trace/index.d.ts

@@ -7,6 +7,7 @@ import { TraceFrame as TextTrace } from "../node/text";
 import { BaseTraceFrame, TraceType } from "../node/utils";
 import { TraceFrame as VisualTrace } from "../node/visual";
 import { IntentRequest } from "../request";
+import { Log as RuntimeLog } from "../runtimeLogs";
 export { TraceFrame as ExitTrace } from "../node/exit";
 export { TraceFrame as FlowTrace } from "../node/flow";
 export { TraceFrame as ChoiceTrace } from "../node/interaction";
@@ -53,4 +54,8 @@ export interface EntityFillingTracePayload {
 export interface EntityFillingTrace extends BaseTraceFrame<EntityFillingTracePayload> {
     type: TraceType.ENTITY_FILLING;
 }
-export declare type AnyTrace = ExitTrace | TextTrace | GoToTrace | FlowTrace | SpeakTrace | BlockTrace | DebugTrace | ChoiceTrace | StreamTrace | VisualTrace | NoReplyTrace | EntityFillingTrace;
+export declare type LogTracePayload = RuntimeLog;
+export interface LogTrace extends BaseTraceFrame<LogTracePayload> {
+    type: TraceType.LOG;
+}
+export declare type AnyTrace = ExitTrace | TextTrace | GoToTrace | FlowTrace | SpeakTrace | BlockTrace | DebugTrace | ChoiceTrace | StreamTrace | VisualTrace | NoReplyTrace | EntityFillingTrace | LogTrace;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@voiceflow/base-types",
   "description": "Voiceflow base project types",
-  "version": "2.25.3",
+  "version": "2.28.0",
   "author": "Voiceflow",
   "bugs": {
     "url": "https://github.com/voiceflow/libs/issues"
@@ -43,5 +43,5 @@
     "test:smoke": "exit 0",
     "test:unit": "exit 0"
   },
-  "gitHead": "cb4e203e5c4c1d59d74b959ab313afe595a81d2f"
+  "gitHead": "0a48c64c043e751a19513d08baf53caed731fcd5"
 }