@botpress/sdk 4.15.11 → 4.15.12

package/dist/plugin/implementation.d.ts

@@ -1,4 +1,4 @@
-import type { MessageHandlersMap as BotMessageHandlersMap, EventHandlersMap as BotEventHandlersMap, StateExpiredHandlersMap as BotStateExpiredHandlersMap, HookHandlersMap as BotHookHandlersMap, WorkflowHandlersMap as BotWorkflowHandlersMap, ActionHandlers as BotActionHandlers, BotHandlers } from '../bot';
+import type { MessageHandlersMap as BotMessageHandlersMap, EventHandlersMap as BotEventHandlersMap, StateExpiredHandlersMap as BotStateExpiredHandlersMap, HookHandlersMap as BotHookHandlersMap, WorkflowHandlersMap as BotWorkflowHandlersMap, ActionHandlersMap as BotActionHandlersMap, BotHandlers } from '../bot';
 import * as utils from '../utils';
 import { BasePlugin, PluginRuntimeProps } from './common';
 import { ActionHandlers, MessageHandlers, EventHandlers, StateExpiredHandlers, HookHandlers, WorkflowHandlers, MessageHandlersMap, EventHandlersMap, StateExpiredHandlersMap, HookHandlersMap, WorkflowHandlersMap } from './server/types';
@@ -19,7 +19,7 @@ export declare class PluginImplementation<TPlugin extends BasePlugin = BasePlugi
     initialize(props: PluginRuntimeProps<TPlugin>): this;
     private get _runtime();
     private _getTools;
-    get actionHandlers(): BotActionHandlers<TPlugin>;
+    get actionHandlers(): BotActionHandlersMap<TPlugin>;
     get messageHandlers(): BotMessageHandlersMap<TPlugin>;
     get eventHandlers(): BotEventHandlersMap<TPlugin>;
     get stateExpiredHandlers(): BotStateExpiredHandlersMap<TPlugin>;

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

@@ -111,20 +111,23 @@ export type CommonHandlerProps<TPlugin extends common.BasePlugin> = {
     ctx: bot.BotContext;
     logger: bot.BotLogger;
     client: PluginClient<TPlugin>;
+};
+export type InjectedHandlerProps<TPlugin extends common.BasePlugin> = {
     configuration: common.PluginConfiguration<TPlugin>;
     interfaces: common.PluginInterfaceExtensions<TPlugin>;
+    alias?: string;
     actions: actionProxy.ActionProxy<TPlugin>;
     states: stateProxy.StateProxy<TPlugin>;
     events: eventProxy.EventProxy<TPlugin>;
-    alias?: string;
     /**
      * # EXPERIMENTAL
      * This API is experimental and may change in the future.
      */
     workflows: workflowProxy.WorkflowProxy<TPlugin>;
 };
+export type ExtendedHandlerProps<TPlugin extends common.BasePlugin> = CommonHandlerProps<TPlugin> & InjectedHandlerProps<TPlugin>;
 export type MessagePayloads<TPlugin extends common.BasePlugin> = {
-    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: CommonHandlerProps<TPlugin> & {
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: ExtendedHandlerProps<TPlugin> & {
         message: IncomingMessages<TPlugin>[TMessageName];
         user: client.User;
         conversation: client.Conversation;
@@ -135,7 +138,7 @@ export type MessageHandlers<TPlugin extends common.BasePlugin> = {
     [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: (args: MessagePayloads<TPlugin>[TMessageName]) => Promise<void>;
 };
 export type EventPayloads<TPlugin extends common.BasePlugin> = {
-    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: CommonHandlerProps<TPlugin> & {
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: ExtendedHandlerProps<TPlugin> & {
         event: IncomingEvents<TPlugin>[TEventName];
     };
 };
@@ -143,7 +146,7 @@ export type EventHandlers<TPlugin extends common.BasePlugin> = {
     [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: (args: EventPayloads<TPlugin>[TEventName]) => Promise<void>;
 };
 export type StateExpiredPayloads<TPlugin extends common.BasePlugin> = {
-    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: CommonHandlerProps<TPlugin> & {
+    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: ExtendedHandlerProps<TPlugin> & {
         state: IncomingStates<TPlugin>[TSateName];
     };
 };
@@ -151,7 +154,7 @@ export type StateExpiredHandlers<TPlugin extends common.BasePlugin> = {
     [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: (args: StateExpiredPayloads<TPlugin>[TSateName]) => Promise<void>;
 };
 export type ActionHandlerPayloads<TPlugin extends common.BasePlugin> = {
-    [TActionName in utils.StringKeys<TPlugin['actions']>]: CommonHandlerProps<TPlugin> & {
+    [TActionName in utils.StringKeys<TPlugin['actions']>]: ExtendedHandlerProps<TPlugin> & {
         type?: TActionName;
         input: TPlugin['actions'][TActionName]['input'];
     };
@@ -160,7 +163,7 @@ export type ActionHandlers<TPlugin extends common.BasePlugin> = {
     [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> & {
+    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: ExtendedHandlerProps<TPlugin> & {
         conversation?: client.Conversation;
         user?: client.User;
         event: bot.WorkflowUpdateEvent;
@@ -258,7 +261,7 @@ export type HookData<TPlugin extends common.BasePlugin> = {
 };
 export type HookInputs<TPlugin extends common.BasePlugin> = {
     [THookType in utils.StringKeys<HookData<TPlugin>>]: {
-        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: CommonHandlerProps<TPlugin> & {
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: ExtendedHandlerProps<TPlugin> & {
             data: HookData<TPlugin>[THookType][THookDataName];
         };
     };
@@ -277,24 +280,29 @@ export type HookHandlers<TPlugin extends common.BasePlugin> = {
         [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: (input: HookInputs<TPlugin>[THookType][THookDataName]) => Promise<HookOutputs<TPlugin>[THookType][THookDataName] | undefined>;
     };
 };
+export type ActionHandlersMap<TPlugin extends common.BasePlugin> = {
+    [TActionName in utils.StringKeys<TPlugin['actions']>]?: (props: Omit<Parameters<ActionHandlers<TPlugin>[TActionName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<Awaited<ReturnType<ActionHandlers<TPlugin>[TActionName]>>>;
+};
 export type MessageHandlersMap<TPlugin extends common.BasePlugin> = {
-    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]?: MessageHandlers<TPlugin>[TMessageName][];
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]?: ((props: Omit<Parameters<MessageHandlers<TPlugin>[TMessageName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<void>)[];
 };
 export type EventHandlersMap<TPlugin extends common.BasePlugin> = {
-    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]?: EventHandlers<TPlugin>[TEventName][];
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]?: ((props: Omit<Parameters<EventHandlers<TPlugin>[TEventName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<void>)[];
 };
 export type StateExpiredHandlersMap<TPlugin extends common.BasePlugin> = {
-    [TStateName in utils.StringKeys<IncomingStates<TPlugin>>]?: StateExpiredHandlers<TPlugin>[TStateName][];
+    [TStateName in utils.StringKeys<IncomingStates<TPlugin>>]?: ((props: Omit<Parameters<StateExpiredHandlers<TPlugin>[TStateName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<void>)[];
 };
 export type HookHandlersMap<TPlugin extends common.BasePlugin> = {
     [THookType in utils.StringKeys<HookData<TPlugin>>]: {
-        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: HookHandlers<TPlugin>[THookType][THookDataName][];
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: ((props: Omit<Parameters<HookHandlers<TPlugin>[THookType][THookDataName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<Awaited<ReturnType<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];
+            handler: (props: Omit<Parameters<WorkflowHandlers<TPlugin>[TWorkflowName]>[0], keyof InjectedHandlerProps<TPlugin> | 'workflow'> & {
+                workflow: client.Workflow;
+            }) => Promise<client.Workflow>;
             order: number;
         }[];
     };
@@ -333,12 +341,39 @@ export type OrderedWorkflowHandlersMap<TPlugin extends common.BasePlugin> = {
         }[];
     };
 };
+/** Plugin handlers without InjectedHandlerProps */
 export type PluginHandlers<TPlugin extends common.BasePlugin> = {
-    actionHandlers: ActionHandlers<TPlugin>;
+    actionHandlers: ActionHandlersMap<TPlugin>;
     messageHandlers: MessageHandlersMap<TPlugin>;
     eventHandlers: EventHandlersMap<TPlugin>;
     stateExpiredHandlers: StateExpiredHandlersMap<TPlugin>;
     hookHandlers: HookHandlersMap<TPlugin>;
     workflowHandlers: WorkflowHandlersMap<TPlugin>;
 };
+/** identical to PluginHandlers, but contains the injected properties */
+export type InjectedPluginHandlers<TPlugin extends common.BasePlugin> = {
+    actionHandlers: ActionHandlers<TPlugin>;
+    messageHandlers: {
+        [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]?: MessageHandlers<TPlugin>[TMessageName][];
+    };
+    eventHandlers: {
+        [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]?: EventHandlers<TPlugin>[TEventName][];
+    };
+    stateExpiredHandlers: {
+        [TStateName in utils.StringKeys<IncomingStates<TPlugin>>]?: StateExpiredHandlers<TPlugin>[TStateName][];
+    };
+    hookHandlers: {
+        [THookType in utils.StringKeys<HookData<TPlugin>>]: {
+            [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: HookHandlers<TPlugin>[THookType][THookDataName][];
+        };
+    };
+    workflowHandlers: {
+        [TWorkflowUpdateType in bot.WorkflowUpdateType]: {
+            [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]?: {
+                handler: WorkflowHandlers<TPlugin>[TWorkflowName];
+                order: number;
+            }[];
+        };
+    };
+};
 export {};

package/package.json

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