@botpress/sdk 3.5.0 → 3.6.0

package/dist/plugin/implementation.d.ts

@@ -1,8 +1,7 @@
-import type { MessageHandlersMap as BotMessageHandlersMap, EventHandlersMap as BotEventHandlersMap, StateExpiredHandlersMap as BotStateExpiredHandlersMap, HookHandlersMap as BotHookHandlersMap, ActionHandlers as BotActionHandlers, BotHandlers, WorkflowHandlersMap as BotWorkflowHandlersMap, WorkflowHandlersFnMap as BotWorkflowHandlersFnMap } from '../bot';
-import { WorkflowProxy } from '../bot/workflow-proxy';
-import { ActionProxy } from './action-proxy';
+import type { MessageHandlersMap as BotMessageHandlersMap, EventHandlersMap as BotEventHandlersMap, StateExpiredHandlersMap as BotStateExpiredHandlersMap, HookHandlersMap as BotHookHandlersMap, WorkflowHandlersMap as BotWorkflowHandlersMap, ActionHandlers as BotActionHandlers, BotHandlers } from '../bot';
+import * as utils from '../utils';
 import { BasePlugin, PluginInterfaceExtensions } from './common';
-import { MessageHandlersMap, MessageHandlers, EventHandlersMap, EventHandlers, StateExpiredHandlersMap, StateExpiredHandlers, HookData, HookHandlers, ActionHandlers, PluginConfiguration } from './server/types';
+import { ActionHandlers, MessageHandlers, EventHandlers, StateExpiredHandlers, HookHandlers, WorkflowHandlers, MessageHandlersMap, EventHandlersMap, StateExpiredHandlersMap, HookHandlersMap, WorkflowHandlersMap, PluginConfiguration } from './server/types';
 export type PluginImplementationProps<TPlugin extends BasePlugin = BasePlugin> = {
     actions: ActionHandlers<TPlugin>;
 };
@@ -11,13 +10,6 @@ export type PluginRuntimeProps<TPlugin extends BasePlugin = BasePlugin> = {
     configuration: PluginConfiguration<TPlugin>;
     interfaces: PluginInterfaceExtensions<TPlugin>;
 };
-type Tools<TPlugin extends BasePlugin = BasePlugin> = {
-    configuration: PluginConfiguration<TPlugin>;
-    interfaces: PluginInterfaceExtensions<TPlugin>;
-    actions: ActionProxy<TPlugin>;
-    workflows: WorkflowProxy<TPlugin>;
-    alias?: string;
-};
 export declare class PluginImplementation<TPlugin extends BasePlugin = BasePlugin> implements BotHandlers<TPlugin> {
     readonly props: PluginImplementationProps<TPlugin>;
     private _runtimeProps;
@@ -27,6 +19,7 @@ export declare class PluginImplementation<TPlugin extends BasePlugin = BasePlugi
     private _stateExpiredHandlers;
     private _hookHandlers;
     private _workflowHandlers;
+    private _registerOrder;
     constructor(props: PluginImplementationProps<TPlugin>);
     initialize(props: PluginRuntimeProps<TPlugin>): this;
     private get _runtime();
@@ -38,22 +31,32 @@ export declare class PluginImplementation<TPlugin extends BasePlugin = BasePlugi
     get hookHandlers(): BotHookHandlersMap<TPlugin>;
     get workflowHandlers(): BotWorkflowHandlersMap<TPlugin>;
     readonly on: {
-        message: <T extends keyof MessageHandlersMap<TPlugin>>(type: T, handler: MessageHandlers<TPlugin>[T]) => void;
+        message: <T extends utils.types.StringKeys<MessageHandlersMap<TPlugin>>>(type: T, handler: MessageHandlers<TPlugin>[T]) => void;
+        event: <T extends utils.types.StringKeys<EventHandlersMap<TPlugin>>>(type: T, handler: EventHandlers<TPlugin>[T]) => void;
+        stateExpired: <T extends utils.types.StringKeys<StateExpiredHandlersMap<TPlugin>>>(type: T, handler: StateExpiredHandlers<TPlugin>[T]) => void;
+        beforeIncomingEvent: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["before_incoming_event"]>>(type: T, handler: HookHandlers<TPlugin>["before_incoming_event"][T]) => void;
+        beforeIncomingMessage: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["before_incoming_message"]>>(type: T, handler: HookHandlers<TPlugin>["before_incoming_message"][T]) => void;
+        beforeOutgoingMessage: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["before_outgoing_message"]>>(type: T, handler: HookHandlers<TPlugin>["before_outgoing_message"][T]) => void;
+        beforeOutgoingCallAction: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["before_outgoing_call_action"]>>(type: T, handler: HookHandlers<TPlugin>["before_outgoing_call_action"][T]) => void;
+        afterIncomingEvent: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["after_incoming_event"]>>(type: T, handler: HookHandlers<TPlugin>["after_incoming_event"][T]) => void;
+        afterIncomingMessage: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["after_incoming_message"]>>(type: T, handler: HookHandlers<TPlugin>["after_incoming_message"][T]) => void;
+        afterOutgoingMessage: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["after_outgoing_message"]>>(type: T, handler: HookHandlers<TPlugin>["after_outgoing_message"][T]) => void;
+        afterOutgoingCallAction: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["after_outgoing_call_action"]>>(type: T, handler: HookHandlers<TPlugin>["after_outgoing_call_action"][T]) => void;
+        /**
+         * # EXPERIMENTAL
+         * This API is experimental and may change in the future.
+         */
+        workflowStart: <T extends utils.types.StringKeys<WorkflowHandlersMap<TPlugin>["started"]>>(type: T, handler: WorkflowHandlers<TPlugin>[T]) => void;
+        /**
+         * # EXPERIMENTAL
+         * This API is experimental and may change in the future.
+         */
+        workflowContinue: <T extends utils.types.StringKeys<WorkflowHandlersMap<TPlugin>["continued"]>>(type: T, handler: WorkflowHandlers<TPlugin>[T]) => void;
         /**
          * # EXPERIMENTAL
          * This API is experimental and may change in the future.
          */
-        workflows: BotWorkflowHandlersFnMap<TPlugin, Tools<TPlugin>>;
-        event: <T extends keyof EventHandlersMap<TPlugin>>(type: T, handler: EventHandlers<TPlugin>[T]) => void;
-        stateExpired: <T extends keyof StateExpiredHandlersMap<TPlugin>>(type: T, handler: StateExpiredHandlers<TPlugin>[T]) => void;
-        beforeIncomingEvent: <T extends keyof HookData<TPlugin>["before_incoming_event"]>(type: T, handler: HookHandlers<TPlugin>["before_incoming_event"][T]) => void;
-        beforeIncomingMessage: <T extends keyof HookData<TPlugin>["before_incoming_message"]>(type: T, handler: HookHandlers<TPlugin>["before_incoming_message"][T]) => void;
-        beforeOutgoingMessage: <T extends keyof HookData<TPlugin>["before_outgoing_message"]>(type: T, handler: HookHandlers<TPlugin>["before_outgoing_message"][T]) => void;
-        beforeOutgoingCallAction: <T extends keyof HookData<TPlugin>["before_outgoing_call_action"]>(type: T, handler: HookHandlers<TPlugin>["before_outgoing_call_action"][T]) => void;
-        afterIncomingEvent: <T extends keyof HookData<TPlugin>["after_incoming_event"]>(type: T, handler: HookHandlers<TPlugin>["after_incoming_event"][T]) => void;
-        afterIncomingMessage: <T extends keyof HookData<TPlugin>["after_incoming_message"]>(type: T, handler: HookHandlers<TPlugin>["after_incoming_message"][T]) => void;
-        afterOutgoingMessage: <T extends keyof HookData<TPlugin>["after_outgoing_message"]>(type: T, handler: HookHandlers<TPlugin>["after_outgoing_message"][T]) => void;
-        afterOutgoingCallAction: <T extends keyof HookData<TPlugin>["after_outgoing_call_action"]>(type: T, handler: HookHandlers<TPlugin>["after_outgoing_call_action"][T]) => void;
+        workflowTimeout: <T extends utils.types.StringKeys<WorkflowHandlersMap<TPlugin>["timed_out"]>>(type: T, handler: WorkflowHandlers<TPlugin>[T]) => void;
     };
     /**
      * checks if the actual event resolves to the target event
@@ -61,4 +64,3 @@ export declare class PluginImplementation<TPlugin extends BasePlugin = BasePlugi
     private _eventResolvesTo;
     private _stripAliasPrefix;
 }
-export {};

package/dist/plugin/server/types.d.ts

@@ -6,31 +6,31 @@ import * as actionProxy from '../action-proxy';
 import * as common from '../common';
 type EnumeratePluginEvents<TPlugin extends common.BasePlugin> = bot.EnumerateEvents<TPlugin> & common.EnumerateInterfaceEvents<TPlugin>;
 type _IncomingEvents<TPlugin extends common.BasePlugin> = {
-    [K in keyof EnumeratePluginEvents<TPlugin>]: utils.Merge<client.Event, {
+    [K in utils.StringKeys<EnumeratePluginEvents<TPlugin>>]: utils.Merge<client.Event, {
         type: K;
         payload: EnumeratePluginEvents<TPlugin>[K];
     }>;
 };
 type _IncomingMessages<TPlugin extends common.BasePlugin> = {
-    [K in keyof bot.GetMessages<TPlugin>]: utils.Merge<client.Message, {
+    [K in utils.StringKeys<bot.GetMessages<TPlugin>>]: utils.Merge<client.Message, {
         type: K;
         payload: bot.GetMessages<TPlugin>[K];
     }>;
 };
 type _IncomingStates<TPlugin extends common.BasePlugin> = {
-    [K in keyof bot.EnumerateStates<TPlugin>]: utils.Merge<client.State, {
+    [K in utils.StringKeys<bot.EnumerateStates<TPlugin>>]: utils.Merge<client.State, {
         name: K;
         payload: bot.EnumerateStates<TPlugin>[K];
     }>;
 };
 type _OutgoingMessageRequests<TPlugin extends common.BasePlugin> = {
-    [K in keyof bot.GetMessages<TPlugin>]: utils.Merge<client.ClientInputs['createMessage'], {
+    [K in utils.StringKeys<bot.GetMessages<TPlugin>>]: utils.Merge<client.ClientInputs['createMessage'], {
         type: K;
         payload: bot.GetMessages<TPlugin>[K];
     }>;
 };
 type _OutgoingMessageResponses<TPlugin extends common.BasePlugin> = {
-    [K in keyof bot.GetMessages<TPlugin>]: utils.Merge<client.ClientOutputs['createMessage'], {
+    [K in utils.StringKeys<bot.GetMessages<TPlugin>>]: utils.Merge<client.ClientOutputs['createMessage'], {
         message: utils.Merge<client.Message, {
             type: K;
             payload: bot.GetMessages<TPlugin>[K];
@@ -38,13 +38,13 @@ type _OutgoingMessageResponses<TPlugin extends common.BasePlugin> = {
     }>;
 };
 type _OutgoingCallActionRequests<TPlugin extends common.BasePlugin> = {
-    [K in keyof bot.EnumerateActionInputs<TPlugin>]: utils.Merge<client.ClientInputs['callAction'], {
+    [K in utils.StringKeys<bot.EnumerateActionInputs<TPlugin>>]: utils.Merge<client.ClientInputs['callAction'], {
         type: K;
         input: bot.EnumerateActionInputs<TPlugin>[K];
     }>;
 };
 type _OutgoingCallActionResponses<TPlugin extends common.BasePlugin> = {
-    [K in keyof bot.EnumerateActionOutputs<TPlugin>]: utils.Merge<client.ClientOutputs['callAction'], {
+    [K in utils.StringKeys<bot.EnumerateActionOutputs<TPlugin>>]: utils.Merge<client.ClientOutputs['callAction'], {
         output: bot.EnumerateActionOutputs<TPlugin>[K];
     }>;
 };
@@ -89,16 +89,15 @@ export type CommonHandlerProps<TPlugin extends common.BasePlugin> = {
      * This API is experimental and may change in the future.
      */
     workflows: workflowProxy.WorkflowProxy<TPlugin>;
-    alias: string;
 };
 export type MessagePayloads<TPlugin extends common.BasePlugin> = {
-    [K in keyof IncomingMessages<TPlugin>]: CommonHandlerProps<TPlugin> & {
-        message: IncomingMessages<TPlugin>[K];
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: CommonHandlerProps<TPlugin> & {
+        message: IncomingMessages<TPlugin>[TMessageName];
         user: client.User;
         conversation: client.Conversation;
         event: client.Event;
         states: {
-            [TState in keyof TPlugin['states']]: {
+            [TState in utils.StringKeys<TPlugin['states']>]: {
                 type: 'user' | 'conversation' | 'bot';
                 payload: TPlugin['states'][TState];
             };
@@ -106,32 +105,46 @@ export type MessagePayloads<TPlugin extends common.BasePlugin> = {
     };
 };
 export type MessageHandlers<TPlugin extends common.BasePlugin> = {
-    [K in keyof IncomingMessages<TPlugin>]: (args: MessagePayloads<TPlugin>[K]) => Promise<void>;
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: (args: MessagePayloads<TPlugin>[TMessageName]) => Promise<void>;
 };
 export type EventPayloads<TPlugin extends common.BasePlugin> = {
-    [K in keyof IncomingEvents<TPlugin>]: CommonHandlerProps<TPlugin> & {
-        event: IncomingEvents<TPlugin>[K];
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: CommonHandlerProps<TPlugin> & {
+        event: IncomingEvents<TPlugin>[TEventName];
     };
 };
 export type EventHandlers<TPlugin extends common.BasePlugin> = {
-    [K in keyof IncomingEvents<TPlugin>]: (args: EventPayloads<TPlugin>[K]) => Promise<void>;
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: (args: EventPayloads<TPlugin>[TEventName]) => Promise<void>;
 };
 export type StateExpiredPayloads<TPlugin extends common.BasePlugin> = {
-    [K in keyof IncomingStates<TPlugin>]: CommonHandlerProps<TPlugin> & {
-        state: IncomingStates<TPlugin>[K];
+    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: CommonHandlerProps<TPlugin> & {
+        state: IncomingStates<TPlugin>[TSateName];
     };
 };
 export type StateExpiredHandlers<TPlugin extends common.BasePlugin> = {
-    [K in keyof IncomingStates<TPlugin>]: (args: StateExpiredPayloads<TPlugin>[K]) => Promise<void>;
+    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: (args: StateExpiredPayloads<TPlugin>[TSateName]) => Promise<void>;
 };
 export type ActionHandlerPayloads<TPlugin extends common.BasePlugin> = {
-    [K in keyof TPlugin['actions']]: CommonHandlerProps<TPlugin> & {
-        type?: K;
-        input: TPlugin['actions'][K]['input'];
+    [TActionName in utils.StringKeys<TPlugin['actions']>]: CommonHandlerProps<TPlugin> & {
+        type?: TActionName;
+        input: TPlugin['actions'][TActionName]['input'];
     };
 };
 export type ActionHandlers<TPlugin extends common.BasePlugin> = {
-    [K in keyof TPlugin['actions']]: (props: ActionHandlerPayloads<TPlugin>[K]) => Promise<TPlugin['actions'][K]['output']>;
+    [TActionName in utils.StringKeys<TPlugin['actions']>]: (props: ActionHandlerPayloads<TPlugin>[TActionName]) => Promise<TPlugin['actions'][TActionName]['output']>;
+};
+export type WorkflowPayloads<TPlugin extends common.BasePlugin> = {
+    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: CommonHandlerProps<TPlugin> & {
+        conversation?: client.Conversation;
+        user?: client.User;
+        /**
+         * # EXPERIMENTAL
+         * This API is experimental and may change in the future.
+         */
+        workflow: workflowProxy.WorkflowWithUtilities<TPlugin, TWorkflowName>;
+    };
+};
+export type WorkflowHandlers<TPlugin extends common.BasePlugin> = {
+    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: (props: WorkflowPayloads<TPlugin>[TWorkflowName]) => Promise<void>;
 };
 type BaseHookDefinition = {
     stoppable?: boolean;
@@ -199,43 +212,85 @@ export type HookDefinitions<TPlugin extends common.BasePlugin> = {
     }>;
 };
 export type HookData<TPlugin extends common.BasePlugin> = {
-    [H in keyof HookDefinitions<TPlugin>]: {
-        [T in keyof HookDefinitions<TPlugin>[H]['data']]: HookDefinitions<TPlugin>[H]['data'][T];
+    [THookType in utils.StringKeys<HookDefinitions<TPlugin>>]: {
+        [THookDataName in utils.StringKeys<HookDefinitions<TPlugin>[THookType]['data']>]: HookDefinitions<TPlugin>[THookType]['data'][THookDataName];
     };
 };
 export type HookInputs<TPlugin extends common.BasePlugin> = {
-    [H in keyof HookData<TPlugin>]: {
-        [T in keyof HookData<TPlugin>[H]]: CommonHandlerProps<TPlugin> & {
-            data: HookData<TPlugin>[H][T];
+    [THookType in utils.StringKeys<HookData<TPlugin>>]: {
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: CommonHandlerProps<TPlugin> & {
+            data: HookData<TPlugin>[THookType][THookDataName];
         };
     };
 };
 export type HookOutputs<TPlugin extends common.BasePlugin> = {
-    [H in keyof HookData<TPlugin>]: {
-        [T in keyof HookData<TPlugin>[H]]: {
-            data?: HookData<TPlugin>[H][T];
-        } & (HookDefinitions<TPlugin>[H]['stoppable'] extends true ? {
+    [THookType in utils.StringKeys<HookData<TPlugin>>]: {
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: {
+            data?: HookData<TPlugin>[THookType][THookDataName];
+        } & (HookDefinitions<TPlugin>[THookType]['stoppable'] extends true ? {
             stop?: boolean;
         } : {});
     };
 };
 export type HookHandlers<TPlugin extends common.BasePlugin> = {
-    [H in keyof HookData<TPlugin>]: {
-        [T in keyof HookData<TPlugin>[H]]: (input: HookInputs<TPlugin>[H][T]) => Promise<HookOutputs<TPlugin>[H][T] | undefined>;
+    [THookType in utils.StringKeys<HookData<TPlugin>>]: {
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: (input: HookInputs<TPlugin>[THookType][THookDataName]) => Promise<HookOutputs<TPlugin>[THookType][THookDataName] | undefined>;
     };
 };
 export type MessageHandlersMap<TPlugin extends common.BasePlugin> = {
-    [T in keyof IncomingMessages<TPlugin>]?: MessageHandlers<TPlugin>[T][];
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]?: MessageHandlers<TPlugin>[TMessageName][];
 };
 export type EventHandlersMap<TPlugin extends common.BasePlugin> = {
-    [T in keyof IncomingEvents<TPlugin>]?: EventHandlers<TPlugin>[T][];
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]?: EventHandlers<TPlugin>[TEventName][];
 };
 export type StateExpiredHandlersMap<TPlugin extends common.BasePlugin> = {
-    [T in keyof IncomingStates<TPlugin>]?: StateExpiredHandlers<TPlugin>[T][];
+    [TStateName in utils.StringKeys<IncomingStates<TPlugin>>]?: StateExpiredHandlers<TPlugin>[TStateName][];
 };
 export type HookHandlersMap<TPlugin extends common.BasePlugin> = {
-    [H in keyof HookData<TPlugin>]: {
-        [T in keyof HookData<TPlugin>[H]]?: HookHandlers<TPlugin>[H][T][];
+    [THookType in utils.StringKeys<HookData<TPlugin>>]: {
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: HookHandlers<TPlugin>[THookType][THookDataName][];
+    };
+};
+export type WorkflowHandlersMap<TPlugin extends common.BasePlugin> = {
+    [TWorkflowUpdateType in bot.WorkflowUpdateType]: {
+        [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]?: {
+            handler: WorkflowHandlers<TPlugin>[TWorkflowName];
+            order: number;
+        }[];
+    };
+};
+export type OrderedMessageHandlersMap<TPlugin extends common.BasePlugin> = {
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]?: {
+        handler: MessageHandlers<TPlugin>[TMessageName];
+        order: number;
+    }[];
+};
+export type OrderedEventHandlersMap<TPlugin extends common.BasePlugin> = {
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]?: {
+        handler: EventHandlers<TPlugin>[TEventName];
+        order: number;
+    }[];
+};
+export type OrderedStateExpiredHandlersMap<TPlugin extends common.BasePlugin> = {
+    [TStateName in utils.StringKeys<IncomingStates<TPlugin>>]?: {
+        handler: StateExpiredHandlers<TPlugin>[TStateName];
+        order: number;
+    }[];
+};
+export type OrderedHookHandlersMap<TPlugin extends common.BasePlugin> = {
+    [THookType in utils.StringKeys<HookData<TPlugin>>]: {
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: {
+            handler: HookHandlers<TPlugin>[THookType][THookDataName];
+            order: number;
+        }[];
+    };
+};
+export type OrderedWorkflowHandlersMap<TPlugin extends common.BasePlugin> = {
+    [TWorkflowUpdateType in bot.WorkflowUpdateType]: {
+        [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]?: {
+            handler: WorkflowHandlers<TPlugin>[TWorkflowName];
+            order: number;
+        }[];
     };
 };
 export type PluginHandlers<TPlugin extends common.BasePlugin> = {
@@ -244,5 +299,6 @@ export type PluginHandlers<TPlugin extends common.BasePlugin> = {
     eventHandlers: EventHandlersMap<TPlugin>;
     stateExpiredHandlers: StateExpiredHandlersMap<TPlugin>;
     hookHandlers: HookHandlersMap<TPlugin>;
+    workflowHandlers: WorkflowHandlersMap<TPlugin>;
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "Botpress SDK",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",