@botpress/sdk 4.8.4 → 4.9.0

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.4",
+  "version": "4.9.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.2",
     "browser-or-node": "^2.1.1"
   },
   "devDependencies": {