@botpress/sdk 4.15.11 → 4.15.12

package/.turbo/turbo-build.log

@@ -1,20 +1,20 @@
 
-> @botpress/sdk@4.15.11 build /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.12 build /home/runner/work/botpress/botpress/packages/sdk
 > pnpm build:type && pnpm build:node && pnpm build:browser
 
 
-> @botpress/sdk@4.15.11 build:type /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.12 build:type /home/runner/work/botpress/botpress/packages/sdk
 > tsc -p ./tsconfig.package.json --emitDeclarationOnly --declaration
 
 
-> @botpress/sdk@4.15.11 build:node /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.12 build:node /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --node
 
 Done
 
-> @botpress/sdk@4.15.11 build:browser /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.12 build:browser /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --browser
 
-(node:3706) [DEP0180] DeprecationWarning: fs.Stats constructor is deprecated.
+(node:3727) [DEP0180] DeprecationWarning: fs.Stats constructor is deprecated.
 (Use `node --trace-deprecation ...` to show where the warning was created)
 Done

package/dist/bot/implementation.d.ts

@@ -2,14 +2,14 @@ import type { Server } from 'node:http';
 import { BasePlugin, PluginImplementation } from '../plugin';
 import * as utils from '../utils';
 import { BaseBot } from './common';
-import { ActionHandlers, MessageHandlers, EventHandlers, StateExpiredHandlers, HookHandlers, WorkflowHandlers, MessageHandlersMap, EventHandlersMap, StateExpiredHandlersMap, HookHandlersMap, WorkflowHandlersMap, BotHandlers, UnimplementedActionHandlers } from './server';
+import { MessageHandlers, EventHandlers, StateExpiredHandlers, HookHandlers, WorkflowHandlers, MessageHandlersMap, EventHandlersMap, StateExpiredHandlersMap, HookHandlersMap, WorkflowHandlersMap, UnimplementedActionHandlers, InjectedBotHandlers } from './server';
 export type BotImplementationProps<TBot extends BaseBot = BaseBot, TPlugins extends Record<string, BasePlugin> = {}> = {
     actions: UnimplementedActionHandlers<TBot, TPlugins>;
     plugins: {
         [K in utils.types.StringKeys<TPlugins>]: PluginImplementation<TPlugins[K]>;
     };
 };
-export declare class BotImplementation<TBot extends BaseBot = BaseBot, TPlugins extends Record<string, BasePlugin> = {}> implements BotHandlers<TBot> {
+export declare class BotImplementation<TBot extends BaseBot = BaseBot, TPlugins extends Record<string, BasePlugin> = {}> implements InjectedBotHandlers<TBot> {
     readonly props: BotImplementationProps<TBot, TPlugins>;
     private _actionHandlers;
     private _messageHandlers;
@@ -20,12 +20,12 @@ export declare class BotImplementation<TBot extends BaseBot = BaseBot, TPlugins
     private _plugins;
     private _registerOrder;
     constructor(props: BotImplementationProps<TBot, TPlugins>);
-    get actionHandlers(): ActionHandlers<TBot>;
-    get messageHandlers(): MessageHandlersMap<TBot>;
-    get eventHandlers(): EventHandlersMap<TBot>;
-    get stateExpiredHandlers(): StateExpiredHandlersMap<TBot>;
-    get hookHandlers(): HookHandlersMap<TBot>;
-    get workflowHandlers(): WorkflowHandlersMap<TBot>;
+    get actionHandlers(): InjectedBotHandlers<TBot>['actionHandlers'];
+    get messageHandlers(): InjectedBotHandlers<TBot>['messageHandlers'];
+    get eventHandlers(): InjectedBotHandlers<TBot>['eventHandlers'];
+    get stateExpiredHandlers(): InjectedBotHandlers<TBot>['stateExpiredHandlers'];
+    get hookHandlers(): InjectedBotHandlers<TBot>['hookHandlers'];
+    get workflowHandlers(): InjectedBotHandlers<TBot>['workflowHandlers'];
     readonly on: {
         message: <T extends utils.types.StringKeys<MessageHandlersMap<TBot>>>(type: T, handler: MessageHandlers<TBot>[T]) => void;
         event: <T extends utils.types.StringKeys<EventHandlersMap<TBot>>>(type: T, handler: EventHandlers<TBot>[T]) => void;

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

@@ -112,14 +112,17 @@ export type CommonHandlerProps<TBot extends common.BaseBot> = {
     ctx: BotContext;
     logger: BotLogger;
     client: BotClient<TBot>;
+};
+export type InjectedHandlerProps<TBot extends common.BaseBot> = {
     /**
      * # EXPERIMENTAL
      * This API is experimental and may change in the future.
      */
     workflows: workflowProxy.WorkflowProxy<TBot>;
 };
+export type ExtendedHandlerProps<TBot extends common.BaseBot> = CommonHandlerProps<TBot> & InjectedHandlerProps<TBot>;
 export type MessagePayloads<TBot extends common.BaseBot> = {
-    [TMessageName in utils.StringKeys<IncomingMessages<TBot>>]: CommonHandlerProps<TBot> & {
+    [TMessageName in utils.StringKeys<IncomingMessages<TBot>>]: ExtendedHandlerProps<TBot> & {
         message: IncomingMessages<TBot>[TMessageName];
         user: client.User;
         conversation: client.Conversation;
@@ -130,7 +133,7 @@ export type MessageHandlers<TBot extends common.BaseBot> = {
     [TMessageName in utils.StringKeys<IncomingMessages<TBot>>]: (args: MessagePayloads<TBot>[TMessageName]) => Promise<void>;
 };
 export type EventPayloads<TBot extends common.BaseBot> = {
-    [TEventName in utils.StringKeys<IncomingEvents<TBot>>]: CommonHandlerProps<TBot> & {
+    [TEventName in utils.StringKeys<IncomingEvents<TBot>>]: ExtendedHandlerProps<TBot> & {
         event: IncomingEvents<TBot>[TEventName];
     };
 };
@@ -138,7 +141,7 @@ export type EventHandlers<TBot extends common.BaseBot> = {
     [TEventName in utils.StringKeys<IncomingEvents<TBot>>]: (args: EventPayloads<TBot>[TEventName]) => Promise<void>;
 };
 export type StateExpiredPayloads<TBot extends common.BaseBot> = {
-    [TSateName in utils.StringKeys<IncomingStates<TBot>>]: CommonHandlerProps<TBot> & {
+    [TSateName in utils.StringKeys<IncomingStates<TBot>>]: ExtendedHandlerProps<TBot> & {
         state: IncomingStates<TBot>[TSateName];
     };
 };
@@ -146,7 +149,7 @@ export type StateExpiredHandlers<TBot extends common.BaseBot> = {
     [TSateName in utils.StringKeys<IncomingStates<TBot>>]: (args: StateExpiredPayloads<TBot>[TSateName]) => Promise<void>;
 };
 export type ActionHandlerPayloads<TBot extends common.BaseBot> = {
-    [TActionName in utils.StringKeys<TBot['actions']>]: CommonHandlerProps<TBot> & {
+    [TActionName in utils.StringKeys<TBot['actions']>]: ExtendedHandlerProps<TBot> & {
         type?: TActionName;
         input: TBot['actions'][TActionName]['input'];
     };
@@ -154,6 +157,9 @@ export type ActionHandlerPayloads<TBot extends common.BaseBot> = {
 export type ActionHandlers<TBot extends common.BaseBot> = {
     [TActionName in utils.StringKeys<TBot['actions']>]: (props: ActionHandlerPayloads<TBot>[TActionName]) => Promise<TBot['actions'][TActionName]['output']>;
 };
+export type ActionHandlersMap<TBot extends common.BaseBot> = {
+    [TActionName in utils.StringKeys<TBot['actions']>]?: (props: Omit<Parameters<ActionHandlers<TBot>[TActionName]>[0], keyof InjectedHandlerProps<TBot>>) => Promise<Awaited<ReturnType<ActionHandlers<TBot>[TActionName]>>>;
+};
 export type BridgeWorkflowUpdateType = 'child_workflow_deleted' | 'child_workflow_finished' | 'workflow_timedout' | 'workflow_started' | 'workflow_continued';
 export type WorkflowUpdateEventPayload = {
     type: BridgeWorkflowUpdateType;
@@ -167,7 +173,7 @@ export type WorkflowUpdateEvent = utils.Merge<client.Event, {
     payload: WorkflowUpdateEventPayload;
 }>;
 export type WorkflowPayloads<TBot extends common.BaseBot> = {
-    [TWorkflowName in utils.StringKeys<TBot['workflows']>]: CommonHandlerProps<TBot> & {
+    [TWorkflowName in utils.StringKeys<TBot['workflows']>]: ExtendedHandlerProps<TBot> & {
         conversation?: client.Conversation;
         user?: client.User;
         event: WorkflowUpdateEvent;
@@ -262,7 +268,7 @@ export type HookData<TBot extends common.BaseBot> = {
 };
 export type HookInputs<TBot extends common.BaseBot> = {
     [THookType in utils.StringKeys<HookData<TBot>>]: {
-        [THookDataName in utils.StringKeys<HookData<TBot>[THookType]>]: CommonHandlerProps<TBot> & {
+        [THookDataName in utils.StringKeys<HookData<TBot>[THookType]>]: ExtendedHandlerProps<TBot> & {
             data: HookData<TBot>[THookType][THookDataName];
         };
     };
@@ -282,23 +288,25 @@ export type HookHandlers<TBot extends common.BaseBot> = {
     };
 };
 export type MessageHandlersMap<TBot extends common.BaseBot> = {
-    [TMessageName in utils.StringKeys<IncomingMessages<TBot>>]?: MessageHandlers<TBot>[TMessageName][];
+    [TMessageName in utils.StringKeys<IncomingMessages<TBot>>]?: ((props: Omit<Parameters<MessageHandlers<TBot>[TMessageName]>[0], keyof InjectedHandlerProps<TBot>>) => Promise<void>)[];
 };
 export type EventHandlersMap<TBot extends common.BaseBot> = {
-    [TEventName in utils.StringKeys<IncomingEvents<TBot>>]?: EventHandlers<TBot>[TEventName][];
+    [TEventName in utils.StringKeys<IncomingEvents<TBot>>]?: ((props: Omit<Parameters<EventHandlers<TBot>[TEventName]>[0], keyof InjectedHandlerProps<TBot>>) => Promise<void>)[];
 };
 export type StateExpiredHandlersMap<TBot extends common.BaseBot> = {
-    [TStateName in utils.StringKeys<IncomingStates<TBot>>]?: StateExpiredHandlers<TBot>[TStateName][];
+    [TStateName in utils.StringKeys<IncomingStates<TBot>>]?: ((props: Omit<Parameters<StateExpiredHandlers<TBot>[TStateName]>[0], keyof InjectedHandlerProps<TBot>>) => Promise<void>)[];
 };
 export type HookHandlersMap<TBot extends common.BaseBot> = {
     [THookType in utils.StringKeys<HookData<TBot>>]: {
-        [THookDataName in utils.StringKeys<HookData<TBot>[THookType]>]?: HookHandlers<TBot>[THookType][THookDataName][];
+        [THookDataName in utils.StringKeys<HookData<TBot>[THookType]>]?: ((props: Omit<Parameters<HookHandlers<TBot>[THookType][THookDataName]>[0], keyof InjectedHandlerProps<TBot>>) => Promise<Awaited<ReturnType<HookHandlers<TBot>[THookType][THookDataName]>>>)[];
     };
 };
 export type WorkflowUpdateType = 'started' | 'continued' | 'timed_out';
 export type WorkflowHandlersMap<TBot extends common.BaseBot> = {
     [TWorkflowUpdateType in WorkflowUpdateType]: {
-        [TWorkflowName in utils.StringKeys<TBot['workflows']>]?: WorkflowHandlers<TBot>[TWorkflowName][];
+        [TWorkflowName in utils.StringKeys<TBot['workflows']>]?: ((props: Omit<Parameters<WorkflowHandlers<TBot>[TWorkflowName]>[0], keyof InjectedHandlerProps<TBot> | 'workflow'> & {
+            workflow: client.Workflow;
+        }) => Promise<client.Workflow>)[];
     };
 };
 export type OrderedMessageHandlersMap<TBot extends common.BaseBot> = {
@@ -336,18 +344,46 @@ export type OrderedWorkflowHandlersMap<TBot extends common.BaseBot> = {
     };
 };
 /**
+ * Bot handlers without InjectedHandlerProps
+ *
  * TODO:
  * the consumer of this type shouldnt be able to access "*" directly;
  * "*" is meant the user who registers an handler, not for the user who calls the handler
  */
 export type BotHandlers<TBot extends common.BaseBot> = {
-    actionHandlers: ActionHandlers<TBot>;
+    actionHandlers: ActionHandlersMap<TBot>;
     messageHandlers: MessageHandlersMap<TBot>;
     eventHandlers: EventHandlersMap<TBot>;
     stateExpiredHandlers: StateExpiredHandlersMap<TBot>;
     hookHandlers: HookHandlersMap<TBot>;
     workflowHandlers: WorkflowHandlersMap<TBot>;
 };
+/** identical to BotHandlers, but contains the injected properties */
+export type InjectedBotHandlers<TBot extends common.BaseBot> = {
+    actionHandlers: ActionHandlers<TBot>;
+    messageHandlers: {
+        [TMessageName in utils.StringKeys<IncomingMessages<TBot>>]?: MessageHandlers<TBot>[TMessageName][];
+    };
+    eventHandlers: {
+        [TEventName in utils.StringKeys<IncomingEvents<TBot>>]?: EventHandlers<TBot>[TEventName][];
+    };
+    stateExpiredHandlers: {
+        [TStateName in utils.StringKeys<IncomingStates<TBot>>]?: StateExpiredHandlers<TBot>[TStateName][];
+    };
+    hookHandlers: {
+        [THookType in utils.StringKeys<HookData<TBot>>]: {
+            [THookDataName in utils.StringKeys<HookData<TBot>[THookType]>]?: HookHandlers<TBot>[THookType][THookDataName][];
+        };
+    };
+    workflowHandlers: {
+        [TWorkflowUpdateType in WorkflowUpdateType]: {
+            [TWorkflowName in utils.StringKeys<TBot['workflows']>]?: {
+                handler: WorkflowHandlers<TBot>[TWorkflowName];
+                order: number;
+            }[];
+        };
+    };
+};
 type _GetPluginPrefix<TKey extends string> = `${TKey}#`;
 type ImplementedActions<_TBot extends common.BaseBot, TPlugins extends Record<string, plugin.BasePlugin>> = utils.UnionToIntersection<utils.ValueOf<{
     [TPlugin in utils.StringKeys<TPlugins>]: {
@@ -361,7 +397,7 @@ export type ImplementedActionHandlers<TBot extends common.BaseBot, TPlugins exte
 export type UnimplementedActionHandlers<TBot extends common.BaseBot, TPlugins extends Record<string, plugin.BasePlugin>> = {
     [K in utils.StringKeys<UnimplementedActions<TBot, TPlugins>>]: ActionHandlers<TBot>[utils.Cast<K, keyof ActionHandlers<TBot>>];
 };
-export type ServerProps = Omit<CommonHandlerProps<common.BaseBot>, 'workflows'> & {
+export type ServerProps = CommonHandlerProps<common.BaseBot> & {
     req: Request;
     self: BotHandlers<common.BaseBot>;
 };