@botpress/sdk 4.8.5 → 4.10.0

package/dist/integration/implementation.d.ts

@@ -1,6 +1,6 @@
 import type { Server } from 'node:http';
 import { BaseIntegration } from './common';
-import { RegisterHandler as RegisterFunction, UnregisterHandler as UnregisterFunction, WebhookHandler as WebhookFunction, CreateUserHandler as CreateUserFunction, CreateConversationHandler as CreateConversationFunction, ActionHandlers as ActionFunctions, ChannelHandlers as ChannelFunctions } from './server';
+import { RegisterHandler as RegisterFunction, UnregisterHandler as UnregisterFunction, WebhookHandler as WebhookFunction, CreateUserHandler as CreateUserFunction, CreateConversationHandler as CreateConversationFunction, ActionHandlers as ActionFunctions, ChannelHandlers as ChannelFunctions, IntegrationOperationHandler as IntegrationOperationFunction } from './server';
 export type IntegrationImplementationProps<TIntegration extends BaseIntegration = BaseIntegration> = {
     register: RegisterFunction<TIntegration>;
     unregister: UnregisterFunction<TIntegration>;
@@ -15,6 +15,9 @@ export type IntegrationImplementationProps<TIntegration extends BaseIntegration
     createConversation?: CreateConversationFunction<TIntegration>;
     actions: ActionFunctions<TIntegration>;
     channels: ChannelFunctions<TIntegration>;
+    __advanced?: {
+        integrationOperationHandler?: IntegrationOperationFunction<TIntegration>;
+    };
 };
 export declare class IntegrationImplementation<TIntegration extends BaseIntegration = BaseIntegration> {
     readonly props: IntegrationImplementationProps<TIntegration>;
@@ -25,6 +28,7 @@ export declare class IntegrationImplementation<TIntegration extends BaseIntegrat
     readonly createUser: IntegrationImplementationProps<TIntegration>['createUser'];
     readonly createConversation: IntegrationImplementationProps<TIntegration>['createConversation'];
     readonly webhook: IntegrationImplementationProps<TIntegration>['handler'];
+    readonly integrationOperationHandler: NonNullable<IntegrationImplementationProps<TIntegration>['__advanced']>['integrationOperationHandler'];
     constructor(props: IntegrationImplementationProps<TIntegration>);
     readonly handler: (req: import("../serve").Request) => Promise<import("../serve").Response | void>;
     readonly start: (port?: number) => Promise<Server>;

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

@@ -90,6 +90,9 @@ export type ChannelHandlers<TIntegration extends BaseIntegration> = {
         };
     };
 };
+export type IntegrationOperationHandler<TIntegration extends BaseIntegration> = (props: CommonHandlerProps<TIntegration> & {
+    req: Request;
+}) => Promise<Response | void>;
 export type IntegrationHandlers<TIntegration extends BaseIntegration> = {
     register: RegisterHandler<TIntegration>;
     unregister: UnregisterHandler<TIntegration>;
@@ -98,5 +101,6 @@ export type IntegrationHandlers<TIntegration extends BaseIntegration> = {
     createConversation?: CreateConversationHandler<TIntegration>;
     actions: ActionHandlers<TIntegration>;
     channels: ChannelHandlers<TIntegration>;
+    integrationOperationHandler?: IntegrationOperationHandler<TIntegration>;
 };
 export {};

package/dist/plugin/event-proxy/index.d.ts

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

package/dist/plugin/event-proxy/proxy.d.ts

@@ -0,0 +1,5 @@
+import { Client } from '@botpress/client';
+import { BotSpecificClient } from '../../bot';
+import { BasePlugin, PluginRuntimeProps } from '../common';
+import { EventProxy } from './types';
+export declare const proxyEvents: <TPlugin extends BasePlugin>(client: BotSpecificClient<TPlugin> | Client, props: PluginRuntimeProps<TPlugin>) => EventProxy<TPlugin>;

package/dist/plugin/event-proxy/types.d.ts

@@ -0,0 +1,14 @@
+import { ClientInputs } from '@botpress/client';
+import * as utils from '../../utils/type-utils';
+import { BasePlugin } from '../common';
+export type EventSchedule = NonNullable<ClientInputs['createEvent']['schedule']>;
+export type EventSender<TPayload> = {
+    emit: (event: TPayload) => Promise<void>;
+    schedule: (event: TPayload, schedule: EventSchedule) => Promise<void>;
+    withConversationId: (conversationId: string) => EventSender<TPayload>;
+    withUserId: (userId: string) => EventSender<TPayload>;
+    withMessageId: (messageId: string) => EventSender<TPayload>;
+};
+export type EventProxy<TPlugin extends BasePlugin> = utils.Normalize<{
+    [TEventName in keyof TPlugin['events']]: EventSender<TPlugin['events'][TEventName]>;
+}>;

package/dist/plugin/event-proxy/types.test.d.ts

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

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

@@ -4,6 +4,7 @@ import * as workflowProxy from '../../bot/workflow-proxy';
 import * as utils from '../../utils/type-utils';
 import * as actionProxy from '../action-proxy';
 import * as common from '../common';
+import * as eventProxy from '../event-proxy';
 import * as stateProxy from '../state-proxy';
 type EnumeratePluginEvents<TPlugin extends common.BasePlugin> = bot.EnumerateEvents<TPlugin> & common.EnumerateInterfaceEvents<TPlugin>;
 type _IncomingEvents<TPlugin extends common.BasePlugin> = {
@@ -114,6 +115,7 @@ export type CommonHandlerProps<TPlugin extends common.BasePlugin> = {
     interfaces: common.PluginInterfaceExtensions<TPlugin>;
     actions: actionProxy.ActionProxy<TPlugin>;
     states: stateProxy.StateProxy<TPlugin>;
+    events: eventProxy.EventProxy<TPlugin>;
     alias?: string;
     /**
      * # EXPERIMENTAL

package/package.json

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