@botpress/sdk 4.1.0 → 4.3.0

package/dist/interface/definition.d.ts

@@ -34,6 +34,10 @@ type GenericActionDefinition<TEntities extends BaseEntities, TAction extends Bas
 export type InterfaceDefinitionProps<TName extends string = string, TVersion extends string = string, TEntities extends BaseEntities = BaseEntities, TActions extends BaseActions = BaseActions, TEvents extends BaseEntities = BaseEntities, TChannels extends BaseChannels = BaseChannels> = {
     name: TName;
     version: TVersion;
+    title?: string;
+    description?: string;
+    icon?: string;
+    readme?: string;
     entities?: {
         [K in keyof TEntities]: EntityDefinition<TEntities[K]>;
     };
@@ -51,6 +55,10 @@ export declare class InterfaceDefinition<TName extends string = string, TVersion
     readonly props: InterfaceDefinitionProps<TName, TVersion, TEntities, TActions, TEvents, TChannels>;
     readonly name: this['props']['name'];
     readonly version: this['props']['version'];
+    readonly title: this['props']['title'];
+    readonly description: this['props']['description'];
+    readonly icon: this['props']['icon'];
+    readonly readme: this['props']['readme'];
     readonly entities: {
         [K in keyof TEntities]: EntityDefinition<TEntities[K]>;
     };

package/dist/plugin/implementation.d.ts

@@ -33,10 +33,20 @@ export declare class PluginImplementation<TPlugin extends BasePlugin = BasePlugi
         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;
+        /**
+         * # EXPERIMENTAL
+         * This API is experimental and may change in the future.
+         */
+        beforeIncomingCallAction: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["before_incoming_call_action"]>>(type: T, handler: HookHandlers<TPlugin>["before_incoming_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.
+         */
+        afterIncomingCallAction: <T extends utils.types.StringKeys<HookHandlersMap<TPlugin>["after_incoming_call_action"]>>(type: T, handler: HookHandlers<TPlugin>["after_incoming_call_action"][T]) => void;
         /**
          * # EXPERIMENTAL
          * This API is experimental and may change in the future.

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

@@ -46,15 +46,38 @@ type _OutgoingCallActionRequests<TPlugin extends common.BasePlugin> = {
 };
 type _OutgoingCallActionResponses<TPlugin extends common.BasePlugin> = {
     [K in utils.StringKeys<bot.EnumerateActionOutputs<TPlugin>>]: utils.Merge<client.ClientOutputs['callAction'], {
+        type: K;
         output: bot.EnumerateActionOutputs<TPlugin>[K];
     }>;
 };
+type _IncomingCallActionRequests<TPlugin extends common.BasePlugin> = {
+    [K in utils.StringKeys<TPlugin['actions']>]: {
+        type: K;
+        input: TPlugin['actions'][K]['input'];
+    };
+};
+type _IncomingCallActionResponses<TPlugin extends common.BasePlugin> = {
+    [K in utils.StringKeys<TPlugin['actions']>]: {
+        type: K;
+        output: TPlugin['actions'][K]['output'];
+    };
+};
 export type AnyIncomingEvent<_TPlugin extends common.BasePlugin> = client.Event;
 export type AnyIncomingMessage<_TPlugin extends common.BasePlugin> = client.Message;
 export type AnyOutgoingMessageRequest<_TPlugin extends common.BasePlugin> = client.ClientInputs['createMessage'];
 export type AnyOutgoingMessageResponse<_TPlugin extends common.BasePlugin> = client.ClientOutputs['createMessage'];
 export type AnyOutgoingCallActionRequest<_TPlugin extends common.BasePlugin> = client.ClientInputs['callAction'];
-export type AnyOutgoingCallActionResponse<_TPlugin extends common.BasePlugin> = client.ClientOutputs['callAction'];
+export type AnyOutgoingCallActionResponse<_TPlugin extends common.BasePlugin> = client.ClientOutputs['callAction'] & {
+    type: string;
+};
+export type AnyIncomingCallActionRequest<_TPlugin extends common.BasePlugin> = {
+    type: string;
+    input: Record<string, unknown>;
+};
+export type AnyIncomingCallActionResponse<_TPlugin extends common.BasePlugin> = {
+    type: string;
+    output: Record<string, unknown>;
+};
 export type IncomingEvents<TPlugin extends common.BasePlugin> = _IncomingEvents<TPlugin> & {
     '*': AnyIncomingEvent<TPlugin>;
 };
@@ -76,6 +99,12 @@ export type OutgoingCallActionRequests<TPlugin extends common.BasePlugin> = _Out
 export type OutgoingCallActionResponses<TPlugin extends common.BasePlugin> = _OutgoingCallActionResponses<TPlugin> & {
     '*': AnyOutgoingCallActionResponse<TPlugin>;
 };
+export type IncomingCallActionRequest<TPlugin extends common.BasePlugin> = _IncomingCallActionRequests<TPlugin> & {
+    '*': AnyIncomingCallActionRequest<TPlugin>;
+};
+export type IncomingCallActionResponse<TPlugin extends common.BasePlugin> = _IncomingCallActionResponses<TPlugin> & {
+    '*': AnyIncomingCallActionResponse<TPlugin>;
+};
 export type PluginClient<_TPlugin extends common.BasePlugin> = bot.BotSpecificClient<common.BasePlugin>;
 export type CommonHandlerProps<TPlugin extends common.BasePlugin> = {
     ctx: bot.BotContext;
@@ -181,6 +210,12 @@ export type HookDefinitions<TPlugin extends common.BasePlugin> = {
             '*': AnyOutgoingCallActionRequest<TPlugin>;
         };
     }>;
+    before_incoming_call_action: HookDefinition<{
+        stoppable: true;
+        data: _IncomingCallActionRequests<TPlugin> & {
+            '*': AnyIncomingCallActionRequest<TPlugin>;
+        };
+    }>;
     after_incoming_event: HookDefinition<{
         stoppable: true;
         data: _IncomingEvents<TPlugin> & {
@@ -205,6 +240,12 @@ export type HookDefinitions<TPlugin extends common.BasePlugin> = {
             '*': AnyOutgoingCallActionResponse<TPlugin>;
         };
     }>;
+    after_incoming_call_action: HookDefinition<{
+        stoppable: true;
+        data: _IncomingCallActionResponses<TPlugin> & {
+            '*': AnyIncomingCallActionResponse<TPlugin>;
+        };
+    }>;
 };
 export type HookData<TPlugin extends common.BasePlugin> = {
     [THookType in utils.StringKeys<HookDefinitions<TPlugin>>]: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "Botpress SDK",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -16,7 +16,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "1.6.0",
+    "@botpress/client": "1.7.0",
     "browser-or-node": "^2.1.1"
   },
   "devDependencies": {