@botpress/sdk 3.1.0 → 3.2.0

package/dist/integration/client/index.d.ts

@@ -1,5 +1,5 @@
 import * as client from '@botpress/client';
-import * as common from '../types';
+import * as common from '../common';
 import * as types from './types';
 export * from './types';
 /**

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

@@ -1,6 +1,6 @@
 import * as client from '@botpress/client';
 import * as utils from '../../utils/type-utils';
-import * as common from '../types';
+import * as common from '../common';
 type BaseChannelDefinition = common.BaseIntegration['channels'][string];
 type GetChannelByName<TIntegration extends common.BaseIntegration, TChannelName extends keyof TIntegration['channels']> = utils.Cast<TIntegration['channels'][TChannelName], BaseChannelDefinition>;
 /**

package/dist/integration/{types → common}/index.d.ts

@@ -1,2 +1,2 @@
 export * from './generic';
-export * from './common';
+export * from './types';

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 { BaseIntegration } from './types';
 export type IntegrationImplementationProps<TIntegration extends BaseIntegration = BaseIntegration> = {
     register: RegisterFunction<TIntegration>;
     unregister: UnregisterFunction<TIntegration>;

package/dist/integration/index.d.ts

@@ -2,4 +2,4 @@ export * from './definition';
 export * from './implementation';
 export * from './client';
 export * from './server';
-export * from './types';
+export * from './common';

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

@@ -1,5 +1,5 @@
 import { Request, Response } from '../../serve';
-import { BaseIntegration } from '../types';
+import { BaseIntegration } from '../common';
 import { IntegrationHandlers } from './types';
 export * from './types';
 export * from './integration-logger';

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

@@ -2,7 +2,7 @@ import { type Conversation, type Message, type User } from '@botpress/client';
 import { Request, Response } from '../../serve';
 import { Cast, Merge, ValueOf } from '../../utils/type-utils';
 import { IntegrationSpecificClient } from '../client';
-import { BaseIntegration, ToTags } from '../types';
+import { BaseIntegration, ToTags } from '../common';
 import { type IntegrationLogger } from './integration-logger';
 type IntegrationOperation = 'webhook_received' | 'message_created' | 'action_triggered' | 'register' | 'unregister' | 'ping' | 'create_user' | 'create_conversation';
 type IntegrationContextConfig<TIntegration extends BaseIntegration> = {

package/dist/interface/index.d.ts

@@ -1,2 +1,2 @@
 export * from './definition';
-export * from './types';
+export * from './common';

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

@@ -1,5 +1,5 @@
 import { Client } from '@botpress/client';
 import { BotSpecificClient } from '../../bot';
-import { BasePlugin, PluginInterfaceExtensions } from '../types';
+import { BasePlugin, PluginInterfaceExtensions } from '../common';
 import { ActionProxy } from './types';
 export declare const proxyActions: <TPlugin extends BasePlugin>(client: BotSpecificClient<TPlugin> | Client, interfaces: PluginInterfaceExtensions<TPlugin>) => ActionProxy<TPlugin>;

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

@@ -1,5 +1,5 @@
 import * as utils from '../../utils/type-utils';
-import { BasePlugin } from '../types';
+import { BasePlugin } from '../common';
 type IntegrationActionProxy<TPlugin extends BasePlugin> = {
     [TIntegrationName in keyof TPlugin['integrations']]: {
         [TActionName in keyof TPlugin['integrations'][TIntegrationName]['actions']]: (input: TPlugin['integrations'][TIntegrationName]['actions'][TActionName]['input']) => Promise<TPlugin['integrations'][TIntegrationName]['actions'][TActionName]['output']>;

package/dist/plugin/{types → common}/generic.d.ts

@@ -1,5 +1,5 @@
-import { BaseIntegration, DefaultIntegration, InputBaseIntegration } from '../../integration/types/generic';
-import { BaseInterface, InputBaseInterface, DefaultInterface } from '../../interface/types/generic';
+import { BaseIntegration, DefaultIntegration, InputBaseIntegration } from '../../integration/common/generic';
+import { BaseInterface, InputBaseInterface, DefaultInterface } from '../../interface/common/generic';
 import * as utils from '../../utils/type-utils';
 export type BaseAction = {
     input: any;

package/dist/plugin/{types → common}/index.d.ts

@@ -1,2 +1,2 @@
-export * from './common';
+export * from './types';
 export * from './generic';

package/dist/plugin/definition.d.ts

@@ -12,6 +12,10 @@ type BaseTables = Record<string, ZuiObjectSchema>;
 export type PluginDefinitionProps<TName extends string = string, TVersion extends string = string, TConfig extends BaseConfig = BaseConfig, TStates extends BaseStates = BaseStates, TEvents extends BaseEvents = BaseEvents, TActions extends BaseActions = BaseActions, TInterfaces extends BaseInterfaces = BaseInterfaces, TIntegrations extends BaseIntegrations = BaseIntegrations, TTables extends BaseTables = BaseTables> = {
     name: TName;
     version: TVersion;
+    title?: string;
+    description?: string;
+    icon?: string;
+    readme?: string;
     integrations?: {
         [K in keyof TIntegrations]: IntegrationPackage;
     };
@@ -40,6 +44,10 @@ export declare class PluginDefinition<TName extends string = string, TVersion ex
     readonly props: PluginDefinitionProps<TName, TVersion, TConfig, TStates, TEvents, TActions, TInterfaces, TIntegrations, TTables>;
     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 integrations: this['props']['integrations'];
     readonly interfaces: this['props']['interfaces'];
     readonly user: this['props']['user'];

package/dist/plugin/implementation.d.ts

@@ -1,6 +1,6 @@
 import { MessageHandlersMap as BotMessageHandlersMap, EventHandlersMap as BotEventHandlersMap, StateExpiredHandlersMap as BotStateExpiredHandlersMap, HookHandlersMap as BotHookHandlersMap, ActionHandlers as BotActionHandlers, BotHandlers } from '../bot';
+import { BasePlugin, PluginInterfaceExtensions } from './common';
 import { MessageHandlersMap, MessageHandlers, EventHandlersMap, EventHandlers, StateExpiredHandlersMap, StateExpiredHandlers, HookData, HookHandlers, ActionHandlers, PluginConfiguration } from './server/types';
-import { BasePlugin, PluginInterfaceExtensions } from './types';
 export type PluginImplementationProps<TPlugin extends BasePlugin = BasePlugin> = {
     actions: ActionHandlers<TPlugin>;
 };

package/dist/plugin/index.d.ts

@@ -1,4 +1,4 @@
 export * from './definition';
 export * from './implementation';
 export * from './server';
-export * from './types';
+export * from './common';

package/dist/plugin/interface-resolution.d.ts

@@ -1,4 +1,4 @@
-import { PluginInterfaceExtensions } from './types';
+import { PluginInterfaceExtensions } from './common';
 export type ParsedActionRef = {
     namespace: string;
     actionName: string;

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

@@ -2,33 +2,33 @@ import * as client from '@botpress/client';
 import * as bot from '../../bot';
 import * as utils from '../../utils/type-utils';
 import * as proxy from '../action-proxy';
-import * as types from '../types';
-type EnumeratePluginEvents<TPlugin extends types.BasePlugin> = bot.EnumerateEvents<TPlugin> & types.EnumerateInterfaceEvents<TPlugin>;
-type _IncomingEvents<TPlugin extends types.BasePlugin> = {
+import * as common from '../common';
+type EnumeratePluginEvents<TPlugin extends common.BasePlugin> = bot.EnumerateEvents<TPlugin> & common.EnumerateInterfaceEvents<TPlugin>;
+type _IncomingEvents<TPlugin extends common.BasePlugin> = {
     [K in keyof EnumeratePluginEvents<TPlugin>]: utils.Merge<client.Event, {
         type: K;
         payload: EnumeratePluginEvents<TPlugin>[K];
     }>;
 };
-type _IncomingMessages<TPlugin extends types.BasePlugin> = {
+type _IncomingMessages<TPlugin extends common.BasePlugin> = {
     [K in keyof bot.GetMessages<TPlugin>]: utils.Merge<client.Message, {
         type: K;
         payload: bot.GetMessages<TPlugin>[K];
     }>;
 };
-type _IncomingStates<TPlugin extends types.BasePlugin> = {
+type _IncomingStates<TPlugin extends common.BasePlugin> = {
     [K in keyof bot.EnumerateStates<TPlugin>]: utils.Merge<client.State, {
         name: K;
         payload: bot.EnumerateStates<TPlugin>[K];
     }>;
 };
-type _OutgoingMessageRequests<TPlugin extends types.BasePlugin> = {
+type _OutgoingMessageRequests<TPlugin extends common.BasePlugin> = {
     [K in keyof bot.GetMessages<TPlugin>]: utils.Merge<client.ClientInputs['createMessage'], {
         type: K;
         payload: bot.GetMessages<TPlugin>[K];
     }>;
 };
-type _OutgoingMessageResponses<TPlugin extends types.BasePlugin> = {
+type _OutgoingMessageResponses<TPlugin extends common.BasePlugin> = {
     [K in keyof bot.GetMessages<TPlugin>]: utils.Merge<client.ClientOutputs['createMessage'], {
         message: utils.Merge<client.Message, {
             type: K;
@@ -36,55 +36,55 @@ type _OutgoingMessageResponses<TPlugin extends types.BasePlugin> = {
         }>;
     }>;
 };
-type _OutgoingCallActionRequests<TPlugin extends types.BasePlugin> = {
+type _OutgoingCallActionRequests<TPlugin extends common.BasePlugin> = {
     [K in keyof bot.EnumerateActionInputs<TPlugin>]: utils.Merge<client.ClientInputs['callAction'], {
         type: K;
         input: bot.EnumerateActionInputs<TPlugin>[K];
     }>;
 };
-type _OutgoingCallActionResponses<TPlugin extends types.BasePlugin> = {
+type _OutgoingCallActionResponses<TPlugin extends common.BasePlugin> = {
     [K in keyof bot.EnumerateActionOutputs<TPlugin>]: utils.Merge<client.ClientOutputs['callAction'], {
         output: bot.EnumerateActionOutputs<TPlugin>[K];
     }>;
 };
-export type AnyIncomingEvent<_TPlugin extends types.BasePlugin> = client.Event;
-export type AnyIncomingMessage<_TPlugin extends types.BasePlugin> = client.Message;
-export type AnyOutgoingMessageRequest<_TPlugin extends types.BasePlugin> = client.ClientInputs['createMessage'];
-export type AnyOutgoingMessageResponse<_TPlugin extends types.BasePlugin> = client.ClientOutputs['createMessage'];
-export type AnyOutgoingCallActionRequest<_TPlugin extends types.BasePlugin> = client.ClientInputs['callAction'];
-export type AnyOutgoingCallActionResponse<_TPlugin extends types.BasePlugin> = client.ClientOutputs['callAction'];
-export type IncomingEvents<TPlugin extends types.BasePlugin> = _IncomingEvents<TPlugin> & {
+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 IncomingEvents<TPlugin extends common.BasePlugin> = _IncomingEvents<TPlugin> & {
     '*': AnyIncomingEvent<TPlugin>;
 };
-export type IncomingMessages<TPlugin extends types.BasePlugin> = _IncomingMessages<TPlugin> & {
+export type IncomingMessages<TPlugin extends common.BasePlugin> = _IncomingMessages<TPlugin> & {
     '*': AnyIncomingMessage<TPlugin>;
 };
-export type IncomingStates<_TPlugin extends types.BasePlugin> = _IncomingStates<_TPlugin> & {
+export type IncomingStates<_TPlugin extends common.BasePlugin> = _IncomingStates<_TPlugin> & {
     '*': client.State;
 };
-export type OutgoingMessageRequests<TPlugin extends types.BasePlugin> = _OutgoingMessageRequests<TPlugin> & {
+export type OutgoingMessageRequests<TPlugin extends common.BasePlugin> = _OutgoingMessageRequests<TPlugin> & {
     '*': AnyOutgoingMessageRequest<TPlugin>;
 };
-export type OutgoingMessageResponses<TPlugin extends types.BasePlugin> = _OutgoingMessageResponses<TPlugin> & {
+export type OutgoingMessageResponses<TPlugin extends common.BasePlugin> = _OutgoingMessageResponses<TPlugin> & {
     '*': AnyOutgoingMessageResponse<TPlugin>;
 };
-export type OutgoingCallActionRequests<TPlugin extends types.BasePlugin> = _OutgoingCallActionRequests<TPlugin> & {
+export type OutgoingCallActionRequests<TPlugin extends common.BasePlugin> = _OutgoingCallActionRequests<TPlugin> & {
     '*': AnyOutgoingCallActionRequest<TPlugin>;
 };
-export type OutgoingCallActionResponses<TPlugin extends types.BasePlugin> = _OutgoingCallActionResponses<TPlugin> & {
+export type OutgoingCallActionResponses<TPlugin extends common.BasePlugin> = _OutgoingCallActionResponses<TPlugin> & {
     '*': AnyOutgoingCallActionResponse<TPlugin>;
 };
-export type PluginClient<_TPlugin extends types.BasePlugin> = bot.BotSpecificClient<types.BasePlugin>;
-export type PluginConfiguration<TPlugin extends types.BasePlugin> = TPlugin['configuration'];
-export type CommonHandlerProps<TPlugin extends types.BasePlugin> = {
+export type PluginClient<_TPlugin extends common.BasePlugin> = bot.BotSpecificClient<common.BasePlugin>;
+export type PluginConfiguration<TPlugin extends common.BasePlugin> = TPlugin['configuration'];
+export type CommonHandlerProps<TPlugin extends common.BasePlugin> = {
     ctx: bot.BotContext;
     logger: bot.BotLogger;
     client: PluginClient<TPlugin>;
     configuration: PluginConfiguration<TPlugin>;
-    interfaces: types.PluginInterfaceExtensions<TPlugin>;
+    interfaces: common.PluginInterfaceExtensions<TPlugin>;
     actions: proxy.ActionProxy<TPlugin>;
 };
-export type MessagePayloads<TPlugin extends types.BasePlugin> = {
+export type MessagePayloads<TPlugin extends common.BasePlugin> = {
     [K in keyof IncomingMessages<TPlugin>]: CommonHandlerProps<TPlugin> & {
         message: IncomingMessages<TPlugin>[K];
         user: client.User;
@@ -98,32 +98,32 @@ export type MessagePayloads<TPlugin extends types.BasePlugin> = {
         };
     };
 };
-export type MessageHandlers<TPlugin extends types.BasePlugin> = {
+export type MessageHandlers<TPlugin extends common.BasePlugin> = {
     [K in keyof IncomingMessages<TPlugin>]: (args: MessagePayloads<TPlugin>[K]) => Promise<void>;
 };
-export type EventPayloads<TPlugin extends types.BasePlugin> = {
+export type EventPayloads<TPlugin extends common.BasePlugin> = {
     [K in keyof IncomingEvents<TPlugin>]: CommonHandlerProps<TPlugin> & {
         event: IncomingEvents<TPlugin>[K];
     };
 };
-export type EventHandlers<TPlugin extends types.BasePlugin> = {
+export type EventHandlers<TPlugin extends common.BasePlugin> = {
     [K in keyof IncomingEvents<TPlugin>]: (args: EventPayloads<TPlugin>[K]) => Promise<void>;
 };
-export type StateExpiredPayloads<TPlugin extends types.BasePlugin> = {
+export type StateExpiredPayloads<TPlugin extends common.BasePlugin> = {
     [K in keyof IncomingStates<TPlugin>]: CommonHandlerProps<TPlugin> & {
         state: IncomingStates<TPlugin>[K];
     };
 };
-export type StateExpiredHandlers<TPlugin extends types.BasePlugin> = {
+export type StateExpiredHandlers<TPlugin extends common.BasePlugin> = {
     [K in keyof IncomingStates<TPlugin>]: (args: StateExpiredPayloads<TPlugin>[K]) => Promise<void>;
 };
-export type ActionHandlerPayloads<TPlugin extends types.BasePlugin> = {
+export type ActionHandlerPayloads<TPlugin extends common.BasePlugin> = {
     [K in keyof TPlugin['actions']]: CommonHandlerProps<TPlugin> & {
         type?: K;
         input: TPlugin['actions'][K]['input'];
     };
 };
-export type ActionHandlers<TPlugin extends types.BasePlugin> = {
+export type ActionHandlers<TPlugin extends common.BasePlugin> = {
     [K in keyof TPlugin['actions']]: (props: ActionHandlerPayloads<TPlugin>[K]) => Promise<TPlugin['actions'][K]['output']>;
 };
 type BaseHookDefinition = {
@@ -140,8 +140,8 @@ type HookDefinition<THookDef extends BaseHookDefinition = BaseHookDefinition> =
  *   - before_incoming_call_action
  *   - after_incoming_call_action
  */
-export type HookDefinitionType = keyof HookDefinitions<types.BasePlugin>;
-export type HookDefinitions<TPlugin extends types.BasePlugin> = {
+export type HookDefinitionType = keyof HookDefinitions<common.BasePlugin>;
+export type HookDefinitions<TPlugin extends common.BasePlugin> = {
     before_incoming_event: HookDefinition<{
         stoppable: true;
         data: _IncomingEvents<TPlugin> & {
@@ -191,19 +191,19 @@ export type HookDefinitions<TPlugin extends types.BasePlugin> = {
         };
     }>;
 };
-export type HookData<TPlugin extends types.BasePlugin> = {
+export type HookData<TPlugin extends common.BasePlugin> = {
     [H in keyof HookDefinitions<TPlugin>]: {
         [T in keyof HookDefinitions<TPlugin>[H]['data']]: HookDefinitions<TPlugin>[H]['data'][T];
     };
 };
-export type HookInputs<TPlugin extends types.BasePlugin> = {
+export type HookInputs<TPlugin extends common.BasePlugin> = {
     [H in keyof HookData<TPlugin>]: {
         [T in keyof HookData<TPlugin>[H]]: CommonHandlerProps<TPlugin> & {
             data: HookData<TPlugin>[H][T];
         };
     };
 };
-export type HookOutputs<TPlugin extends types.BasePlugin> = {
+export type HookOutputs<TPlugin extends common.BasePlugin> = {
     [H in keyof HookData<TPlugin>]: {
         [T in keyof HookData<TPlugin>[H]]: {
             data?: HookData<TPlugin>[H][T];
@@ -212,26 +212,26 @@ export type HookOutputs<TPlugin extends types.BasePlugin> = {
         } : {});
     };
 };
-export type HookHandlers<TPlugin extends types.BasePlugin> = {
+export type HookHandlers<TPlugin extends common.BasePlugin> = {
     [H in keyof HookData<TPlugin>]: {
         [T in keyof HookData<TPlugin>[H]]: (input: HookInputs<TPlugin>[H][T]) => Promise<HookOutputs<TPlugin>[H][T] | undefined>;
     };
 };
-export type MessageHandlersMap<TPlugin extends types.BasePlugin> = {
+export type MessageHandlersMap<TPlugin extends common.BasePlugin> = {
     [T in keyof IncomingMessages<TPlugin>]?: MessageHandlers<TPlugin>[T][];
 };
-export type EventHandlersMap<TPlugin extends types.BasePlugin> = {
+export type EventHandlersMap<TPlugin extends common.BasePlugin> = {
     [T in keyof IncomingEvents<TPlugin>]?: EventHandlers<TPlugin>[T][];
 };
-export type StateExpiredHandlersMap<TPlugin extends types.BasePlugin> = {
+export type StateExpiredHandlersMap<TPlugin extends common.BasePlugin> = {
     [T in keyof IncomingStates<TPlugin>]?: StateExpiredHandlers<TPlugin>[T][];
 };
-export type HookHandlersMap<TPlugin extends types.BasePlugin> = {
+export type HookHandlersMap<TPlugin extends common.BasePlugin> = {
     [H in keyof HookData<TPlugin>]: {
         [T in keyof HookData<TPlugin>[H]]?: HookHandlers<TPlugin>[H][T][];
     };
 };
-export type PluginHandlers<TPlugin extends types.BasePlugin> = {
+export type PluginHandlers<TPlugin extends common.BasePlugin> = {
     actionHandlers: ActionHandlers<TPlugin>;
     messageHandlers: MessageHandlersMap<TPlugin>;
     eventHandlers: EventHandlersMap<TPlugin>;

package/package.json

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