@botpress/sdk 1.2.1 → 1.2.2

package/.turbo/turbo-build.log

@@ -1,12 +1,12 @@
 
-> @botpress/sdk@1.2.1 build /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@1.2.2 build /home/runner/work/botpress/botpress/packages/sdk
 > pnpm build:type && pnpm build:node
 
 
-> @botpress/sdk@1.2.1 build:type /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@1.2.2 build:type /home/runner/work/botpress/botpress/packages/sdk
 > tsc --emitDeclarationOnly --declaration
 
 
-> @botpress/sdk@1.2.1 build:node /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@1.2.2 build:node /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T build.ts
 

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

@@ -1,58 +1,59 @@
-import { Client } from '@botpress/client';
-import { BaseBot } from '../generic';
-import * as routes from './routes';
+import * as client from '@botpress/client';
+import * as common from '../types';
+import * as types from './types';
+export * from './types';
 /**
  * Just like the regular botpress client, but typed with the bot's properties.
  */
-export declare class BotSpecificClient<TBot extends BaseBot> {
+export declare class BotSpecificClient<TBot extends common.BaseBot> implements types.ClientOperations<TBot> {
     private readonly _client;
-    constructor(_client: Client);
-    getConversation: routes.GetConversation<TBot>;
-    listConversations: routes.ListConversations<TBot>;
-    updateConversation: routes.UpdateConversation<TBot>;
-    deleteConversation: routes.DeleteConversation<TBot>;
-    listParticipants: routes.ListParticipants<TBot>;
-    addParticipant: routes.AddParticipant<TBot>;
-    getParticipant: routes.GetParticipant<TBot>;
-    removeParticipant: routes.RemoveParticipant<TBot>;
-    getEvent: routes.GetEvent<TBot>;
-    listEvents: routes.ListEvents<TBot>;
-    createMessage: routes.CreateMessage<TBot>;
-    getOrCreateMessage: routes.GetOrCreateMessage<TBot>;
-    getMessage: routes.GetMessage<TBot>;
-    updateMessage: routes.UpdateMessage<TBot>;
-    listMessages: routes.ListMessages<TBot>;
-    deleteMessage: routes.DeleteMessage<TBot>;
-    getUser: routes.GetUser<TBot>;
-    listUsers: routes.ListUsers<TBot>;
-    updateUser: routes.UpdateUser<TBot>;
-    deleteUser: routes.DeleteUser<TBot>;
-    getState: routes.GetState<TBot>;
-    setState: routes.SetState<TBot>;
-    getOrSetState: routes.GetOrSetState<TBot>;
-    patchState: routes.PatchState<TBot>;
-    callAction: routes.CallAction<TBot>;
-    uploadFile: routes.UploadFile<TBot>;
-    upsertFile: routes.UpsertFile<TBot>;
-    deleteFile: routes.DeleteFile<TBot>;
-    listFiles: routes.ListFiles<TBot>;
-    getFile: routes.GetFile<TBot>;
-    updateFileMetadata: routes.UpdateFileMetadata<TBot>;
-    searchFiles: routes.SearchFiles<TBot>;
+    constructor(_client: client.Client);
+    getConversation: types.GetConversation<TBot>;
+    listConversations: types.ListConversations<TBot>;
+    updateConversation: types.UpdateConversation<TBot>;
+    deleteConversation: types.DeleteConversation<TBot>;
+    listParticipants: types.ListParticipants<TBot>;
+    addParticipant: types.AddParticipant<TBot>;
+    getParticipant: types.GetParticipant<TBot>;
+    removeParticipant: types.RemoveParticipant<TBot>;
+    getEvent: types.GetEvent<TBot>;
+    listEvents: types.ListEvents<TBot>;
+    createMessage: types.CreateMessage<TBot>;
+    getOrCreateMessage: types.GetOrCreateMessage<TBot>;
+    getMessage: types.GetMessage<TBot>;
+    updateMessage: types.UpdateMessage<TBot>;
+    listMessages: types.ListMessages<TBot>;
+    deleteMessage: types.DeleteMessage<TBot>;
+    getUser: types.GetUser<TBot>;
+    listUsers: types.ListUsers<TBot>;
+    updateUser: types.UpdateUser<TBot>;
+    deleteUser: types.DeleteUser<TBot>;
+    getState: types.GetState<TBot>;
+    setState: types.SetState<TBot>;
+    getOrSetState: types.GetOrSetState<TBot>;
+    patchState: types.PatchState<TBot>;
+    callAction: types.CallAction<TBot>;
+    uploadFile: types.UploadFile<TBot>;
+    upsertFile: types.UpsertFile<TBot>;
+    deleteFile: types.DeleteFile<TBot>;
+    listFiles: types.ListFiles<TBot>;
+    getFile: types.GetFile<TBot>;
+    updateFileMetadata: types.UpdateFileMetadata<TBot>;
+    searchFiles: types.SearchFiles<TBot>;
     /**
      * @deprecated Use `callAction` to delegate the conversation creation to an integration.
      */
-    createConversation: routes.CreateConversation<TBot>;
+    createConversation: types.CreateConversation<TBot>;
     /**
      * @deprecated Use `callAction` to delegate the conversation creation to an integration.
      */
-    getOrCreateConversation: routes.GetOrCreateConversation<TBot>;
+    getOrCreateConversation: types.GetOrCreateConversation<TBot>;
     /**
      * @deprecated Use `callAction` to delegate the user creation to an integration.
      */
-    createUser: routes.CreateUser<TBot>;
+    createUser: types.CreateUser<TBot>;
     /**
      * @deprecated Use `callAction` to delegate the user creation to an integration.
      */
-    getOrCreateUser: routes.GetOrCreateUser<TBot>;
+    getOrCreateUser: types.GetOrCreateUser<TBot>;
 }

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

@@ -1,70 +1,136 @@
 import * as client from '@botpress/client';
-import { Join, UnionToIntersection, Merge, ValueOf, Split, Cast, ToSealedRecord } from '../../utils/type-utils';
-import { BaseBot } from '../generic';
-/**
- * 0. Definitions
- */
-export type EventDefinition = BaseBot['events'][string];
-export type StateDefinition = BaseBot['states'][string];
-export type IntegrationInstanceDefinition = BaseBot['integrations'][string];
-export type IntegrationInstanceConfigurationDefinition = IntegrationInstanceDefinition['configuration'];
-export type IntegrationInstanceActionDefinition = IntegrationInstanceDefinition['actions'][string];
-export type IntegrationInstanceChannelDefinition = IntegrationInstanceDefinition['channels'][string];
-export type IntegrationInstanceMessageDefinition = IntegrationInstanceChannelDefinition['messages'][string];
-export type IntegrationInstanceEventDefinition = IntegrationInstanceDefinition['events'][string];
-export type IntegrationInstanceStateDefinition = IntegrationInstanceDefinition['states'][string];
-export type IntegrationInstanceUserDefinition = IntegrationInstanceDefinition['user'];
-/**
- * 1. Enumerations
- */
-type ActionKey<TIntegrationName extends string, TActionName extends string> = string extends TIntegrationName ? string : string extends TActionName ? string : Join<[TIntegrationName, ':', TActionName]>;
-export type EnumerateActions<TBot extends BaseBot> = ToSealedRecord<UnionToIntersection<{
-    [TIntegrationName in keyof TBot['integrations']]: {
-        [TActionName in keyof TBot['integrations'][TIntegrationName]['actions'] as ActionKey<Cast<TIntegrationName, string>, Cast<TActionName, string>>]: TBot['integrations'][TIntegrationName]['actions'][TActionName];
-    };
-}[keyof TBot['integrations']]> & {}>;
-type EventKey<TIntegrationName extends string, TEventName extends string> = string extends TIntegrationName ? string : string extends TEventName ? string : Join<[TIntegrationName, ':', TEventName]>;
-export type EnumerateEvents<TBot extends BaseBot> = ToSealedRecord<UnionToIntersection<{
-    [TIntegrationName in keyof TBot['integrations']]: {
-        [TEventName in keyof TBot['integrations'][TIntegrationName]['events'] as EventKey<Cast<TIntegrationName, string>, Cast<TEventName, string>>]: TBot['integrations'][TIntegrationName]['events'][TEventName];
-    };
-}[keyof TBot['integrations']]> & {
-    [TEventName in keyof TBot['events']]: TBot['events'][TEventName];
-}>;
-type ChannelKey<TIntegrationName extends string, TChannelName extends string> = string extends TIntegrationName ? string : string extends TChannelName ? string : Join<[TIntegrationName, ':', TChannelName]>;
-export type EnumerateChannels<TBot extends BaseBot> = ToSealedRecord<UnionToIntersection<{
-    [TIntegrationName in keyof TBot['integrations']]: {
-        [TChannelName in keyof TBot['integrations'][TIntegrationName]['channels'] as ChannelKey<Cast<TIntegrationName, string>, Cast<TChannelName, string>>]: TBot['integrations'][TIntegrationName]['channels'][TChannelName];
-    };
-}[keyof TBot['integrations']]> & {}>;
-type MessageKey<TIntegrationName extends string, TChannelName extends string, TMessageName extends string> = string extends TIntegrationName ? string : string extends TChannelName ? string : string extends TMessageName ? string : Join<[TIntegrationName, ':', TChannelName, ':', TMessageName]>;
-export type EnumerateMessages<TBot extends BaseBot> = ToSealedRecord<UnionToIntersection<{
-    [TIntegrationName in keyof TBot['integrations']]: {
-        [TChannelName in keyof TBot['integrations'][TIntegrationName]['channels']]: {
-            [TMessageName in keyof TBot['integrations'][TIntegrationName]['channels'][TChannelName]['messages'] as MessageKey<Cast<TIntegrationName, string>, Cast<TChannelName, string>, Cast<TMessageName, string>>]: TBot['integrations'][TIntegrationName]['channels'][TChannelName]['messages'][TMessageName];
-        };
-    }[keyof TBot['integrations'][TIntegrationName]['channels']];
-}[keyof TBot['integrations']]> & {}>;
-export type GetMessages<TBot extends BaseBot> = {
-    [K in keyof EnumerateMessages<TBot> as Cast<Split<K, ':'>[2], string>]: EnumerateMessages<TBot>[K];
-};
-/**
- * 2. Responses
- */
-export type EventResponse<TBot extends BaseBot> = {
+import * as utils from '../../utils/type-utils';
+import * as common from '../types';
+type Arg<F extends (...args: any[]) => any> = Parameters<F>[number];
+type Res<F extends (...args: any[]) => any> = ReturnType<F>;
+type EventResponse<TBot extends common.BaseBot> = {
     event: {
-        [K in keyof EnumerateEvents<TBot>]: Merge<client.Event, {
+        [K in keyof common.EnumerateEvents<TBot>]: utils.Merge<client.Event, {
             type: K;
-            payload: EnumerateEvents<TBot>[K];
+            payload: common.EnumerateEvents<TBot>[K];
         }>;
-    }[keyof EnumerateEvents<TBot>];
+    }[keyof common.EnumerateEvents<TBot>];
 };
-export type MessageResponse<TBot extends BaseBot, TMessage extends keyof GetMessages<TBot> = keyof GetMessages<TBot>> = {
-    message: ValueOf<{
-        [K in keyof GetMessages<TBot> as K extends TMessage ? K : never]: Merge<client.Message, {
+type MessageResponse<TBot extends common.BaseBot, TMessage extends keyof common.GetMessages<TBot> = keyof common.GetMessages<TBot>> = {
+    message: utils.ValueOf<{
+        [K in keyof common.GetMessages<TBot> as K extends TMessage ? K : never]: utils.Merge<client.Message, {
             type: K;
-            payload: GetMessages<TBot>[K];
+            payload: common.GetMessages<TBot>[K];
         }>;
     }>;
 };
+export type CreateConversation<_TBot extends common.BaseBot> = client.Client['createConversation'];
+export type GetConversation<_TBot extends common.BaseBot> = client.Client['getConversation'];
+export type ListConversations<_TBot extends common.BaseBot> = client.Client['listConversations'];
+export type GetOrCreateConversation<_TBot extends common.BaseBot> = client.Client['getOrCreateConversation'];
+export type UpdateConversation<_TBot extends common.BaseBot> = client.Client['updateConversation'];
+export type DeleteConversation<_TBot extends common.BaseBot> = client.Client['deleteConversation'];
+export type ListParticipants<_TBot extends common.BaseBot> = client.Client['listParticipants'];
+export type AddParticipant<_TBot extends common.BaseBot> = client.Client['addParticipant'];
+export type GetParticipant<_TBot extends common.BaseBot> = client.Client['getParticipant'];
+export type RemoveParticipant<_TBot extends common.BaseBot> = client.Client['removeParticipant'];
+export type GetEvent<TBot extends common.BaseBot> = (x: Arg<client.Client['getEvent']>) => Promise<EventResponse<TBot>>;
+export type ListEvents<_TBot extends common.BaseBot> = client.Client['listEvents'];
+export type CreateMessage<TBot extends common.BaseBot> = <TMessage extends keyof common.GetMessages<TBot>>(x: utils.Merge<Arg<client.Client['createMessage']>, {
+    type: utils.Cast<TMessage, string>;
+    payload: utils.Cast<common.GetMessages<TBot>[TMessage], Record<string, any>>;
+}>) => Promise<MessageResponse<TBot, TMessage>>;
+export type GetOrCreateMessage<TBot extends common.BaseBot> = <TMessage extends keyof common.GetMessages<TBot>>(x: utils.Merge<Arg<client.Client['getOrCreateMessage']>, {
+    type: utils.Cast<TMessage, string>;
+    payload: utils.Cast<common.GetMessages<TBot>[TMessage], Record<string, any>>;
+}>) => Promise<MessageResponse<TBot, TMessage>>;
+export type GetMessage<TBot extends common.BaseBot> = (x: Arg<client.Client['getMessage']>) => Promise<MessageResponse<TBot>>;
+export type UpdateMessage<TBot extends common.BaseBot> = (x: Arg<client.Client['updateMessage']>) => Promise<MessageResponse<TBot>>;
+export type ListMessages<_TBot extends common.BaseBot> = client.Client['listMessages'];
+export type DeleteMessage<_TBot extends common.BaseBot> = client.Client['deleteMessage'];
+export type CreateUser<_TBot extends common.BaseBot> = client.Client['createUser'];
+export type GetUser<_TBot extends common.BaseBot> = client.Client['getUser'];
+export type ListUsers<_TBot extends common.BaseBot> = client.Client['listUsers'];
+export type GetOrCreateUser<_TBot extends common.BaseBot> = client.Client['getOrCreateUser'];
+export type UpdateUser<_TBot extends common.BaseBot> = client.Client['updateUser'];
+export type DeleteUser<_TBot extends common.BaseBot> = client.Client['deleteUser'];
+export type GetState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['getState']>, {
+    name: utils.Cast<TState, string>;
+}>) => Promise<{
+    state: utils.Merge<Awaited<Res<client.Client['getState']>>['state'], {
+        payload: TBot['states'][TState];
+    }>;
+}>;
+export type SetState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['setState']>, {
+    name: utils.Cast<TState, string>;
+    payload: TBot['states'][TState] | null;
+}>) => Promise<{
+    state: utils.Merge<Awaited<Res<client.Client['setState']>>['state'], {
+        payload: TBot['states'][TState];
+    }>;
+}>;
+export type GetOrSetState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['getOrSetState']>, {
+    name: utils.Cast<TState, string>;
+    payload: TBot['states'][TState];
+}>) => Promise<{
+    state: utils.Merge<Awaited<Res<client.Client['getOrSetState']>>['state'], {
+        payload: TBot['states'][TState];
+    }>;
+}>;
+export type PatchState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['patchState']>, {
+    name: utils.Cast<TState, string>;
+    payload: Partial<TBot['states'][TState]>;
+}>) => Promise<{
+    state: utils.Merge<Awaited<Res<client.Client['patchState']>>['state'], {
+        payload: TBot['states'][TState];
+    }>;
+}>;
+export type CallAction<TBot extends common.BaseBot> = <ActionType extends keyof common.EnumerateActions<TBot>>(x: utils.Merge<Arg<client.Client['callAction']>, {
+    type: utils.Cast<ActionType, string>;
+    input: utils.Cast<common.EnumerateActions<TBot>[ActionType], common.IntegrationInstanceActionDefinition>['input'];
+}>) => Promise<{
+    output: utils.Cast<common.EnumerateActions<TBot>[ActionType], common.IntegrationInstanceActionDefinition>['output'];
+}>;
+export type UploadFile<_TBot extends common.BaseBot> = client.Client['uploadFile'];
+export type UpsertFile<_TBot extends common.BaseBot> = client.Client['upsertFile'];
+export type DeleteFile<_TBot extends common.BaseBot> = client.Client['deleteFile'];
+export type ListFiles<_TBot extends common.BaseBot> = client.Client['listFiles'];
+export type GetFile<_TBot extends common.BaseBot> = client.Client['getFile'];
+export type UpdateFileMetadata<_TBot extends common.BaseBot> = client.Client['updateFileMetadata'];
+export type SearchFiles<_TBot extends common.BaseBot> = client.Client['searchFiles'];
+export type ClientOperations<TBot extends common.BaseBot> = {
+    getConversation: GetConversation<TBot>;
+    listConversations: ListConversations<TBot>;
+    updateConversation: UpdateConversation<TBot>;
+    deleteConversation: DeleteConversation<TBot>;
+    listParticipants: ListParticipants<TBot>;
+    addParticipant: AddParticipant<TBot>;
+    getParticipant: GetParticipant<TBot>;
+    removeParticipant: RemoveParticipant<TBot>;
+    getEvent: GetEvent<TBot>;
+    listEvents: ListEvents<TBot>;
+    createMessage: CreateMessage<TBot>;
+    getOrCreateMessage: GetOrCreateMessage<TBot>;
+    getMessage: GetMessage<TBot>;
+    updateMessage: UpdateMessage<TBot>;
+    listMessages: ListMessages<TBot>;
+    deleteMessage: DeleteMessage<TBot>;
+    getUser: GetUser<TBot>;
+    listUsers: ListUsers<TBot>;
+    updateUser: UpdateUser<TBot>;
+    deleteUser: DeleteUser<TBot>;
+    getState: GetState<TBot>;
+    setState: SetState<TBot>;
+    getOrSetState: GetOrSetState<TBot>;
+    patchState: PatchState<TBot>;
+    callAction: CallAction<TBot>;
+    uploadFile: UploadFile<TBot>;
+    upsertFile: UpsertFile<TBot>;
+    deleteFile: DeleteFile<TBot>;
+    listFiles: ListFiles<TBot>;
+    getFile: GetFile<TBot>;
+    updateFileMetadata: UpdateFileMetadata<TBot>;
+    searchFiles: SearchFiles<TBot>;
+};
+export type ClientInputs<TBot extends common.BaseBot> = {
+    [K in keyof ClientOperations<TBot>]: Arg<ClientOperations<TBot>[K]>;
+};
+export type ClientOutputs<TBot extends common.BaseBot> = {
+    [K in keyof ClientOperations<TBot>]: Awaited<Res<ClientOperations<TBot>[K]>>;
+};
 export {};

package/dist/bot/implementation.d.ts

@@ -1,6 +1,6 @@
 import type { Server } from 'node:http';
-import { BaseBot } from './generic';
 import { MessageHandler, EventHandler, StateExpiredHandler } from './server';
+import { BaseBot } from './types';
 export type BotImplementationProps<_TBot extends BaseBot = BaseBot> = {};
 export declare class BotImplementation<TBot extends BaseBot = BaseBot> {
     readonly props: BotImplementationProps<TBot>;

package/dist/bot/index.d.ts

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

package/dist/bot/server/context.d.ts

@@ -0,0 +1,2 @@
+import { BotContext } from './types';
+export declare const extractContext: (headers: Record<string, string | undefined>) => BotContext;

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

@@ -0,0 +1,5 @@
+import { Request, Response } from '../../serve';
+import * as common from '../types';
+import * as types from './types';
+export * from './types';
+export declare const botHandler: <TBot extends common.BaseBot>(instance: types.BotHandlers<TBot>) => (req: Request) => Promise<Response | void>;

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

@@ -0,0 +1,59 @@
+import * as client from '@botpress/client';
+import * as utils from '../../utils/type-utils';
+import { BotSpecificClient } from '../client';
+import * as types from '../types';
+export type BotOperation = 'event_received' | 'register' | 'unregister' | 'ping' | 'action_triggered';
+export type BotContext = {
+    botId: string;
+    type: string;
+    operation: BotOperation;
+    configuration: {
+        payload: string;
+    };
+};
+export type EventRequest<TBot extends types.BaseBot> = {
+    event: {
+        [K in keyof types.EnumerateEvents<TBot>]: utils.Merge<client.Event, {
+            type: K;
+            payload: types.EnumerateEvents<TBot>[K];
+        }>;
+    }[keyof types.EnumerateEvents<TBot>];
+};
+export type MessageRequest<TBot extends types.BaseBot, TMessage extends keyof types.GetMessages<TBot> = keyof types.GetMessages<TBot>> = {
+    message: utils.ValueOf<{
+        [K in keyof types.GetMessages<TBot> as K extends TMessage ? K : never]: utils.Merge<client.Message, {
+            type: K;
+            payload: types.GetMessages<TBot>[K];
+        }>;
+    }>;
+};
+export type CommonHandlerProps<TBot extends types.BaseBot> = {
+    ctx: BotContext;
+    client: BotSpecificClient<TBot>;
+};
+export type MessagePayload<TBot extends types.BaseBot> = MessageRequest<TBot> & {
+    user: client.User;
+    conversation: client.Conversation;
+    event: client.Event;
+    states: {
+        [TState in keyof TBot['states']]: {
+            type: 'user' | 'conversation' | 'bot';
+            payload: TBot['states'][TState];
+        };
+    };
+};
+export type MessageHandlerProps<TBot extends types.BaseBot> = CommonHandlerProps<TBot> & MessagePayload<TBot>;
+export type MessageHandler<TBot extends types.BaseBot> = (args: MessageHandlerProps<TBot>) => Promise<void>;
+export type EventPayload<TBot extends types.BaseBot> = EventRequest<TBot>;
+export type EventHandlerProps<TBot extends types.BaseBot> = CommonHandlerProps<TBot> & EventPayload<TBot>;
+export type EventHandler<TBot extends types.BaseBot> = (args: EventHandlerProps<TBot>) => Promise<void>;
+export type StateExpiredPayload<_TBot extends types.BaseBot> = {
+    state: client.State;
+};
+export type StateExpiredHandlerProps<TBot extends types.BaseBot> = CommonHandlerProps<TBot> & StateExpiredPayload<TBot>;
+export type StateExpiredHandler<TBot extends types.BaseBot> = (args: StateExpiredHandlerProps<TBot>) => Promise<void>;
+export type BotHandlers<TBot extends types.BaseBot> = {
+    messageHandlers: MessageHandler<TBot>[];
+    eventHandlers: EventHandler<TBot>[];
+    stateExpiredHandlers: StateExpiredHandler<TBot>[];
+};

package/dist/bot/types/common.d.ts

@@ -0,0 +1,56 @@
+import { Join, UnionToIntersection, Split, Cast } from '../../utils/type-utils';
+import { BaseBot } from './generic';
+/**
+ * 0. Definitions
+ */
+export type EventDefinition = BaseBot['events'][string];
+export type StateDefinition = BaseBot['states'][string];
+export type IntegrationInstanceDefinition = BaseBot['integrations'][string];
+export type IntegrationInstanceConfigurationDefinition = IntegrationInstanceDefinition['configuration'];
+export type IntegrationInstanceActionDefinition = IntegrationInstanceDefinition['actions'][string];
+export type IntegrationInstanceChannelDefinition = IntegrationInstanceDefinition['channels'][string];
+export type IntegrationInstanceMessageDefinition = IntegrationInstanceChannelDefinition['messages'][string];
+export type IntegrationInstanceEventDefinition = IntegrationInstanceDefinition['events'][string];
+export type IntegrationInstanceStateDefinition = IntegrationInstanceDefinition['states'][string];
+export type IntegrationInstanceUserDefinition = IntegrationInstanceDefinition['user'];
+/**
+ * 1. Enumerations
+ */
+type ActionKey<TIntegrationName extends string, TActionName extends string> = string extends TIntegrationName ? string : string extends TActionName ? string : Join<[TIntegrationName, ':', TActionName]>;
+export type EnumerateActions<TBot extends BaseBot> = UnionToIntersection<{
+    [TIntegrationName in keyof TBot['integrations']]: {
+        [TActionName in keyof TBot['integrations'][TIntegrationName]['actions'] as ActionKey<Cast<TIntegrationName, string>, Cast<TActionName, string>>]: TBot['integrations'][TIntegrationName]['actions'][TActionName];
+    };
+}[keyof TBot['integrations']]> & {};
+export type EnumerateActionInputs<TBot extends BaseBot> = {
+    [K in keyof EnumerateActions<TBot>]: Cast<EnumerateActions<TBot>[K], IntegrationInstanceActionDefinition>['input'];
+};
+export type EnumerateActionOutputs<TBot extends BaseBot> = {
+    [K in keyof EnumerateActions<TBot>]: Cast<EnumerateActions<TBot>[K], IntegrationInstanceActionDefinition>['output'];
+};
+type EventKey<TIntegrationName extends string, TEventName extends string> = string extends TIntegrationName ? string : string extends TEventName ? string : Join<[TIntegrationName, ':', TEventName]>;
+export type EnumerateEvents<TBot extends BaseBot> = UnionToIntersection<{
+    [TIntegrationName in keyof TBot['integrations']]: {
+        [TEventName in keyof TBot['integrations'][TIntegrationName]['events'] as EventKey<Cast<TIntegrationName, string>, Cast<TEventName, string>>]: TBot['integrations'][TIntegrationName]['events'][TEventName];
+    };
+}[keyof TBot['integrations']]> & {
+    [TEventName in keyof TBot['events']]: TBot['events'][TEventName];
+};
+type ChannelKey<TIntegrationName extends string, TChannelName extends string> = string extends TIntegrationName ? string : string extends TChannelName ? string : Join<[TIntegrationName, ':', TChannelName]>;
+export type EnumerateChannels<TBot extends BaseBot> = UnionToIntersection<{
+    [TIntegrationName in keyof TBot['integrations']]: {
+        [TChannelName in keyof TBot['integrations'][TIntegrationName]['channels'] as ChannelKey<Cast<TIntegrationName, string>, Cast<TChannelName, string>>]: TBot['integrations'][TIntegrationName]['channels'][TChannelName];
+    };
+}[keyof TBot['integrations']]> & {};
+type MessageKey<TIntegrationName extends string, TChannelName extends string, TMessageName extends string> = string extends TIntegrationName ? string : string extends TChannelName ? string : string extends TMessageName ? string : Join<[TIntegrationName, ':', TChannelName, ':', TMessageName]>;
+export type EnumerateMessages<TBot extends BaseBot> = UnionToIntersection<{
+    [TIntegrationName in keyof TBot['integrations']]: {
+        [TChannelName in keyof TBot['integrations'][TIntegrationName]['channels']]: {
+            [TMessageName in keyof TBot['integrations'][TIntegrationName]['channels'][TChannelName]['messages'] as MessageKey<Cast<TIntegrationName, string>, Cast<TChannelName, string>, Cast<TMessageName, string>>]: TBot['integrations'][TIntegrationName]['channels'][TChannelName]['messages'][TMessageName];
+        };
+    }[keyof TBot['integrations'][TIntegrationName]['channels']];
+}[keyof TBot['integrations']]> & {};
+export type GetMessages<TBot extends BaseBot> = {
+    [K in keyof EnumerateMessages<TBot> as Cast<Split<K, ':'>[2], string>]: EnumerateMessages<TBot>[K];
+};
+export {};

package/dist/bot/types/common.test.d.ts

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

package/dist/bot/{generic.d.ts → types/generic.d.ts}

@@ -1,11 +1,13 @@
-import { BaseIntegration } from '../integration/generic';
-import * as utils from '../utils/type-utils';
-export type BaseIntegrations = Record<string, BaseIntegration>;
+import { BaseIntegration } from '../../integration/types';
+import * as utils from '../../utils/type-utils';
 export type BaseBot = {
-    integrations: BaseIntegrations;
+    integrations: Record<string, BaseIntegration>;
     events: Record<string, any>;
     states: Record<string, any>;
 };
+/**
+ * Usefull for tests, allows to create a bot with only the properties you want to override
+ */
 export type MakeBot<B extends Partial<BaseBot>> = {
     integrations: utils.Default<B['integrations'], BaseBot['integrations']>;
     events: utils.Default<B['events'], BaseBot['events']>;

package/dist/bot/types/index.d.ts

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

package/dist/index.d.ts

@@ -3,7 +3,12 @@ export * from './const';
 export * from './serve';
 export * from './zui';
 export { isApiError, RuntimeError, } from '@botpress/client';
-export { IntegrationDefinition, IntegrationDefinitionProps, IntegrationImplementation as Integration, IntegrationImplementationProps as IntegrationProps, IntegrationContext, IntegrationLogger, IntegrationSpecificClient, TagDefinition, ConfigurationDefinition, AdditionalConfigurationDefinition, EventDefinition, ChannelDefinition, MessageDefinition, ActionDefinition, StateDefinition, UserDefinition, SecretDefinition, EntityDefinition, } from './integration';
+export { IntegrationDefinition, IntegrationDefinitionProps, IntegrationImplementation as Integration, IntegrationImplementationProps as IntegrationProps, IntegrationLogger, IntegrationSpecificClient, TagDefinition, ConfigurationDefinition, AdditionalConfigurationDefinition, EventDefinition, ChannelDefinition, MessageDefinition, ActionDefinition, StateDefinition, UserDefinition, SecretDefinition, EntityDefinition, } from './integration';
+export { 
+/**
+ * @deprecated use Context exported from '.botpress' instead
+ */
+IntegrationContext, } from './integration/server';
 export { BotDefinition, BotDefinitionProps, BotImplementation as Bot, BotImplementationProps as BotProps, BotSpecificClient, TagDefinition as BotTagDefinition, StateType as BotStateType, StateDefinition as BotStateDefinition, RecurringEventDefinition as BotRecurringEventDefinition, EventDefinition as BotEventDefinition, ConfigurationDefinition as BotConfigurationDefinition, UserDefinition as BotUserDefinition, ConversationDefinition as BotConversationDefinition, MessageDefinition as BotMessageDefinition, } from './bot';
 export { InterfaceDeclaration, InterfaceDeclarationProps, } from './interface';
 export { IntegrationPackage, InterfacePackage, } from './package';

package/dist/index.js

@@ -1,2 +1,2 @@
-"use strict";var Be=Object.create;var S=Object.defineProperty;var ve=Object.getOwnPropertyDescriptor;var be=Object.getOwnPropertyNames;var Ce=Object.getPrototypeOf,xe=Object.prototype.hasOwnProperty;var P=(t,e)=>{for(var n in e)S(t,n,{get:e[n],enumerable:!0})},E=(t,e,n,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of be(e))!xe.call(t,r)&&r!==n&&S(t,r,{get:()=>e[r],enumerable:!(o=ve(e,r))||o.enumerable});return t},p=(t,e,n)=>(E(t,e,"default"),n&&E(n,e,"default")),W=(t,e,n)=>(n=t!=null?Be(Ce(t)):{},E(e||!t||!t.__esModule?S(n,"default",{value:t,enumerable:!0}):n,t)),Ee=t=>E(S({},"__esModule",{value:!0}),t);var m={};P(m,{Bot:()=>O,BotDefinition:()=>R,BotSpecificClient:()=>B,Integration:()=>_,IntegrationDefinition:()=>A,IntegrationSpecificClient:()=>I,InterfaceDeclaration:()=>H,RuntimeError:()=>F.RuntimeError,botIdHeader:()=>v,botUserIdHeader:()=>j,configurationHeader:()=>b,configurationTypeHeader:()=>Z,integrationIdHeader:()=>N,isApiError:()=>F.isApiError,messages:()=>G,operationHeader:()=>C,parseBody:()=>T,serve:()=>x,typeHeader:()=>z,webhookIdHeader:()=>L});module.exports=Ee(m);var G={};P(G,{defaults:()=>Ae});var i={};P(i,{default:()=>K});var J=require("@bpinternal/zui");p(i,require("@bpinternal/zui"));var K=J.z;var l=i.z.string().min(1),X=i.z.object({text:l}),Y=i.z.object({markdown:l}),ee=i.z.object({imageUrl:l}),te=i.z.object({audioUrl:l}),ne=i.z.object({videoUrl:l}),ie=i.z.object({fileUrl:l,title:l.optional()}),oe=i.z.object({latitude:i.z.number(),longitude:i.z.number(),address:i.z.string().optional(),title:i.z.string().optional()}),se=i.z.object({title:l,subtitle:l.optional(),imageUrl:l.optional(),actions:i.z.array(i.z.object({action:i.z.enum(["postback","url","say"]),label:l,value:l}))}),Q=i.z.object({text:l,options:i.z.array(i.z.object({label:l,value:l}))}),Se=i.z.object({items:i.z.array(se)}),Pe=i.z.discriminatedUnion("type",[i.z.object({type:i.z.literal("text"),payload:X}),i.z.object({type:i.z.literal("markdown"),payload:Y}),i.z.object({type:i.z.literal("image"),payload:ee}),i.z.object({type:i.z.literal("audio"),payload:te}),i.z.object({type:i.z.literal("video"),payload:ne}),i.z.object({type:i.z.literal("file"),payload:ie}),i.z.object({type:i.z.literal("location"),payload:oe})]),Me=i.z.object({items:i.z.array(Pe)}),Ae={text:{schema:X},markdown:{schema:Y},image:{schema:ee},audio:{schema:te},video:{schema:ne},file:{schema:ie},location:{schema:oe},carousel:{schema:Se},card:{schema:se},dropdown:{schema:Q},choice:{schema:Q},bloc:{schema:Me}};var v="x-bot-id",j="x-bot-user-id",N="x-integration-id",L="x-webhook-id",Z="x-bp-configuration-type",b="x-bp-configuration",C="x-bp-operation",z="x-bp-type";var re=require("node:http");var y=console;function T(t){if(!t.body)throw new Error("Missing body");return JSON.parse(t.body)}async function x(t,e=8072,n=De){let o=(0,re.createServer)(async(r,a)=>{try{let s=await we(r);if(s.path==="/health"){a.writeHead(200).end("ok");return}let c=await t(s);a.writeHead(c?.status??200,c?.headers??{}).end(c?.body??"{}")}catch(s){y.error("Error while handling request",{error:s?.message??"Internal error occured"}),a.writeHead(500).end(JSON.stringify({error:s?.message??"Internal error occured"}))}});return o.listen(e,()=>n(e)),o}async function we(t){let e=await Ue(t),n={};for(let r=0;r<t.rawHeaders.length;r+=2){let a=t.rawHeaders[r].toLowerCase(),s=t.rawHeaders[r+1];n[a]=s}let o=new URL(t.url??"",t.headers.host?`http://${t.headers.host}`:"http://botpress.cloud");return{body:e,path:o.pathname,query:ke(o.search,"?"),headers:n,method:t.method?.toUpperCase()??"GET"}}function ke(t,e){return t.indexOf(e)===0?t.slice(e.length):t}async function Ue(t){return new Promise((e,n)=>{if(t.method!=="POST"&&t.method!=="PUT"&&t.method!=="PATCH")return e(void 0);let o="";t.on("data",r=>o+=r.toString()),t.on("error",r=>n(r)),t.on("end",()=>e(o))})}function De(t){y.info(`Listening on port ${t}`)}p(m,i,module.exports);var F=require("@botpress/client");var ae=require("@bpinternal/zui");var _e=ae.z.enum(["webhook_received","message_created","action_triggered","register","unregister","ping","create_user","create_conversation"]),ce=t=>{let e=t[v],n=t[j],o=t[N],r=t[L],a=t[Z],s=t[b],c=_e.parse(t[C]);if(!e)throw new Error("Missing bot headers");if(!n)throw new Error("Missing bot user headers");if(!o)throw new Error("Missing integration headers");if(!r)throw new Error("Missing webhook headers");if(!s)throw new Error("Missing configuration headers");if(!c)throw new Error("Missing operation headers");return{botId:e,botUserId:n,integrationId:o,webhookId:r,operation:c,configurationType:a??null,configuration:s?JSON.parse(Buffer.from(s,"base64").toString("utf-8")):{}}};var u={};P(u,{mapValues:()=>Re,pairs:()=>ge});var ge=t=>Object.entries(t),Re=(t,e)=>Object.fromEntries(ge(t).map(([n,o])=>[n,e(o,n)]));var M=Symbol("schemaName"),le=t=>t?u.mapValues(t,(n,o)=>({...n,[M]:o})):{},pe=t=>M in t&&t[M]!==void 0,de=t=>t[M];var A=class{constructor(e){this.props=e;this.name=e.name,this.version=e.version,this.icon=e.icon,this.readme=e.readme,this.title=e.title,this.identifier=e.identifier,this.description=e.description,this.configuration=e.configuration,this.configurations=e.configurations,this.events=e.events,this.actions=e.actions,this.channels=e.channels,this.states=e.states,this.user=e.user,this.secrets=e.secrets,this.entities=e.entities,this.interfaces=e.interfaces}name;version;title;description;icon;readme;configuration;configurations;events;actions;channels;states;user;secrets;identifier;entities;interfaces;extend(e,n){let o=n(le(this.entities)),r=u.pairs(o).find(([g,h])=>!pe(h));if(r)throw new Error(`Cannot extend interface "${e.definition.name}" with entity "${r[0]}"; the provided schema is not part of the integration's entities.`);let a=this;a.interfaces??={};let s=u.mapValues(o,g=>({name:de(g),schema:g.schema})),c=Object.values(s).map(g=>g.name),d=c.length===0?e.definition.name:`${e.definition.name}<${c.join(",")}>`;return a.interfaces[d]={...e,entities:s},this}};var f=require("@botpress/client");var ue=require("@botpress/client"),w={retries:3,retryCondition:t=>ue.axiosRetry.isNetworkOrIdempotentRequestError(t)||[429,502].includes(t.response?.status??0),retryDelay:t=>t*1e3};var k=class{_cost=0;get cost(){return this._cost}setCost(e){this._cost=e}toJSON(){return{cost:this.cost}}};var I=class{constructor(e){this._client=e}createConversation=e=>this._client.createConversation(e);getConversation=e=>this._client.getConversation(e);listConversations=e=>this._client.listConversations(e);getOrCreateConversation=e=>this._client.getOrCreateConversation(e);updateConversation=e=>this._client.updateConversation(e);deleteConversation=e=>this._client.deleteConversation(e);listParticipants=e=>this._client.listParticipants(e);addParticipant=e=>this._client.addParticipant(e);getParticipant=e=>this._client.getParticipant(e);removeParticipant=e=>this._client.removeParticipant(e);createEvent=e=>this._client.createEvent(e);getEvent=e=>this._client.getEvent(e);listEvents=e=>this._client.listEvents(e);createMessage=e=>this._client.createMessage(e);getOrCreateMessage=e=>this._client.getOrCreateMessage(e);getMessage=e=>this._client.getMessage(e);updateMessage=e=>this._client.updateMessage(e);listMessages=e=>this._client.listMessages(e);deleteMessage=e=>this._client.deleteMessage(e);createUser=e=>this._client.createUser(e);getUser=e=>this._client.getUser(e);listUsers=e=>this._client.listUsers(e);getOrCreateUser=e=>this._client.getOrCreateUser(e);updateUser=e=>this._client.updateUser(e);deleteUser=e=>this._client.deleteUser(e);getState=e=>this._client.getState(e);setState=e=>this._client.setState(e);getOrSetState=e=>this._client.getOrSetState(e);patchState=e=>this._client.patchState(e);configureIntegration=e=>this._client.configureIntegration(e);uploadFile=e=>this._client.uploadFile(e);upsertFile=e=>this._client.upsertFile(e);deleteFile=e=>this._client.deleteFile(e);listFiles=e=>this._client.listFiles(e);getFile=e=>this._client.getFile(e);updateFileMetadata=e=>this._client.updateFileMetadata(e)};var $=W(require("util")),U=t=>{if(process.env.BP_LOG_FORMAT==="json")return JSON.stringify({msg:$.default.format(...t),visible_to_bot_owner:!0});{let[e,...n]=t;return $.default.format(`[For Bot Owner] ${e}`,...n)}},D={forBot:()=>({info:(...t)=>{console.info(U(t))},warn:(...t)=>{console.warn(U(t))},error:(...t)=>{console.error(U(t))},debug:(...t)=>{console.debug(U(t))}})};var Te=t=>async e=>{let n=ce(e.headers),o=new f.Client({botId:n.botId,integrationId:n.integrationId,retry:w}),r=new I(o),a={ctx:n,req:e,client:r,logger:D,instance:t};try{let s;switch(n.operation){case"webhook_received":s=await He(a);break;case"register":s=await Fe(a);break;case"unregister":s=await Ke(a);break;case"message_created":s=await Ne(a);break;case"action_triggered":s=await Le(a);break;case"ping":s=await Oe(a);break;case"create_user":s=await Ge(a);break;case"create_conversation":s=await je(a);break;default:throw new Error(`Unknown operation ${n.operation}`)}return s?{...s,status:s.status??200}:{status:200}}catch(s){if((0,f.isApiError)(s)){let d=new f.RuntimeError(s.message,s);return D.forBot().error(d.message),{status:d.code,body:JSON.stringify(d.toJSON())}}console.error(s);let c=new f.RuntimeError("An unexpected error occurred in the integration. Bot owners: Check logs for more informations. Integration owners: throw a RuntimeError to return a custom error message instead.");return D.forBot().error(c.message),{status:c.code,body:JSON.stringify(c.toJSON())}}},Oe=async t=>{},He=async({client:t,ctx:e,req:n,logger:o,instance:r})=>{let{req:a}=T(n);return r.webhook({client:t,ctx:e,req:a,logger:o})},Fe=async({client:t,ctx:e,req:n,logger:o,instance:r})=>{if(!r.register)return;let{webhookUrl:a}=T(n);await r.register({client:t,ctx:e,webhookUrl:a,logger:o})},Ke=async({client:t,ctx:e,req:n,logger:o,instance:r})=>{if(!r.unregister)return;let{webhookUrl:a}=T(n);await r.unregister({ctx:e,webhookUrl:a,client:t,logger:o})},Ge=async({client:t,ctx:e,req:n,logger:o,instance:r})=>{if(!r.createUser)return;let{tags:a}=T(n);return await r.createUser({ctx:e,client:t,tags:a,logger:o})},je=async({client:t,ctx:e,req:n,logger:o,instance:r})=>{if(!r.createConversation)return;let{channel:a,tags:s}=T(n);return await r.createConversation({ctx:e,client:t,channel:a,tags:s,logger:o})},Ne=async({ctx:t,req:e,client:n,logger:o,instance:r})=>{let{conversation:a,user:s,type:c,payload:d,message:g}=T(e),h=r.channels[a.channel];if(!h)throw new Error(`Channel ${a.channel} not found`);let V=h.messages[c];if(!V)throw new Error(`Message of type ${c} not found in channel ${a.channel}`);await V({ctx:t,conversation:a,message:g,user:s,type:c,client:n,payload:d,ack:async({tags:Ie})=>{await n.updateMessage({id:g.id,tags:Ie})},logger:o})},Le=async({req:t,ctx:e,client:n,logger:o,instance:r})=>{let{input:a,type:s}=T(t);if(!s)throw new Error("Missing action type");let c=r.actions[s];if(!c)throw new Error(`Action ${s} not found`);let d=new k,h={output:await c({ctx:e,input:a,client:n,type:s,logger:o,metadata:d}),meta:d.toJSON()};return{body:JSON.stringify(h)}};var _=class{constructor(e){this.props=e;this.actions=e.actions,this.channels=e.channels,this.register=e.register,this.unregister=e.unregister,this.createUser=e.createUser,this.createConversation=e.createConversation,this.webhook=e.handler}actions;channels;register;unregister;createUser;createConversation;webhook;handler=Te(this);start=e=>x(this.handler,e)};var R=class{constructor(e){this.props=e;this.integrations=e.integrations,this.user=e.user,this.conversation=e.conversation,this.message=e.message,this.states=e.states,this.configuration=e.configuration,this.events=e.events,this.recurringEvents=e.recurringEvents}integrations;user;conversation;message;states;configuration;events;recurringEvents;add(e,n){let o=this;return o.integrations||(o.integrations={}),o.integrations[e.definition.name]={enabled:n.enabled,...e,configurationType:n.configurationType,configuration:n.configuration},this}};var he=W(require("@botpress/client"));var B=class{constructor(e){this._client=e}getConversation=e=>this._client.getConversation(e);listConversations=e=>this._client.listConversations(e);updateConversation=e=>this._client.updateConversation(e);deleteConversation=e=>this._client.deleteConversation(e);listParticipants=e=>this._client.listParticipants(e);addParticipant=e=>this._client.addParticipant(e);getParticipant=e=>this._client.getParticipant(e);removeParticipant=e=>this._client.removeParticipant(e);getEvent=e=>this._client.getEvent(e);listEvents=e=>this._client.listEvents(e);createMessage=e=>this._client.createMessage(e);getOrCreateMessage=e=>this._client.getOrCreateMessage(e);getMessage=e=>this._client.getMessage(e);updateMessage=e=>this._client.updateMessage(e);listMessages=e=>this._client.listMessages(e);deleteMessage=e=>this._client.deleteMessage(e);getUser=e=>this._client.getUser(e);listUsers=e=>this._client.listUsers(e);updateUser=e=>this._client.updateUser(e);deleteUser=e=>this._client.deleteUser(e);getState=e=>this._client.getState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));setState=e=>this._client.setState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));getOrSetState=e=>this._client.getOrSetState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));patchState=e=>this._client.patchState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));callAction=e=>this._client.callAction(e);uploadFile=e=>this._client.uploadFile(e);upsertFile=e=>this._client.upsertFile(e);deleteFile=e=>this._client.deleteFile(e);listFiles=e=>this._client.listFiles(e);getFile=e=>this._client.getFile(e);updateFileMetadata=e=>this._client.updateFileMetadata(e);searchFiles=e=>this._client.searchFiles(e);createConversation=e=>this._client.createConversation(e);getOrCreateConversation=e=>this._client.getOrCreateConversation(e);createUser=e=>this._client.createUser(e);getOrCreateUser=e=>this._client.getOrCreateUser(e)};var me=require("@bpinternal/zui");var Ze=me.z.enum(["event_received","register","unregister","ping","action_triggered"]),fe=t=>{let e=t[v],n=t[b],o=t[z],r=Ze.parse(t[C]);if(!e)throw new Error("Missing bot headers");if(!o)throw new Error("Missing type headers");if(!n)throw new Error("Missing configuration headers");if(!r)throw new Error("Missing operation headers");return{botId:e,operation:r,type:o,configuration:n?JSON.parse(Buffer.from(n,"base64").toString("utf-8")):{}}};var ye=t=>async e=>{let n=fe(e.headers);n.operation!=="ping"&&y.info(`Received ${n.operation} operation for bot ${n.botId} of type ${n.type}`);let o=new he.Client({botId:n.botId,retry:w}),r=new B(o),a={req:e,ctx:n,client:r,instance:t};switch(n.operation){case"action_triggered":throw new Error(`Operation ${n.operation} not supported yet`);case"event_received":await Ve(a);break;case"register":await qe(a);break;case"unregister":await $e(a);break;case"ping":await ze(a);break;default:throw new Error(`Unknown operation ${n.operation}`)}return{status:200}},ze=async t=>{},qe=async t=>{},$e=async t=>{},Ve=async({ctx:t,req:e,client:n,instance:o})=>{y.debug(`Received event ${t.type}`);let r=T(e),a=r.event;switch(t.type){case"message_created":let s={user:a.payload.user,conversation:a.payload.conversation,message:a.payload.message,states:a.payload.states,event:a};await Promise.all(o.messageHandlers.map(g=>g({client:n,ctx:t,...s})));break;case"state_expired":let c={state:a.payload.state};await Promise.all(o.stateExpiredHandlers.map(g=>g({client:n,ctx:t,...c})));break;default:let d={event:r.event};await Promise.all(o.eventHandlers.map(g=>g({client:n,ctx:t,...d})))}};var O=class{constructor(e){this.props=e}_state={messageHandlers:[],eventHandlers:[],stateExpiredHandlers:[]};message=e=>{this._state.messageHandlers.push(e)};event=e=>{this._state.eventHandlers.push(e)};stateExpired=e=>{this._state.stateExpiredHandlers.push(e)};handler=ye(this._state);start=e=>x(this.handler,e)};var H=class{constructor(e){this.props=e;this.name=e.name,this.version=e.version,this.entities=e.entities??{},this.templateName=e.templateName;let n=this._getEntityReference(this.entities),o=e.events===void 0?{}:u.mapValues(e.events,s=>({...s,schema:s.schema(n)})),r=e.actions===void 0?{}:u.mapValues(e.actions,s=>({...s,input:{...s.input,schema:s.input.schema(n)},output:{...s.output,schema:s.output.schema(n)}})),a=e.channels===void 0?{}:u.mapValues(e.channels,s=>({...s,messages:u.mapValues(s.messages,c=>({...c,schema:c.schema(n)}))}));this.events=o,this.actions=r,this.channels=a}name;version;entities;events;actions;channels;templateName;_getEntityReference=e=>{let n={};for(let o of Object.keys(e))n[o]=K.ref(o);return n}};0&&(module.exports={Bot,BotDefinition,BotSpecificClient,Integration,IntegrationDefinition,IntegrationSpecificClient,InterfaceDeclaration,RuntimeError,botIdHeader,botUserIdHeader,configurationHeader,configurationTypeHeader,integrationIdHeader,isApiError,messages,operationHeader,parseBody,serve,typeHeader,webhookIdHeader});
+"use strict";var Be=Object.create;var S=Object.defineProperty;var ve=Object.getOwnPropertyDescriptor;var Ie=Object.getOwnPropertyNames;var Ce=Object.getPrototypeOf,Ee=Object.prototype.hasOwnProperty;var P=(t,e)=>{for(var n in e)S(t,n,{get:e[n],enumerable:!0})},x=(t,e,n,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let a of Ie(e))!Ee.call(t,a)&&a!==n&&S(t,a,{get:()=>e[a],enumerable:!(s=ve(e,a))||s.enumerable});return t},l=(t,e,n)=>(x(t,e,"default"),n&&x(n,e,"default")),J=(t,e,n)=>(n=t!=null?Be(Ce(t)):{},x(e||!t||!t.__esModule?S(n,"default",{value:t,enumerable:!0}):n,t)),xe=t=>x(S({},"__esModule",{value:!0}),t);var m={};P(m,{Bot:()=>O,BotDefinition:()=>A,BotSpecificClient:()=>B,Integration:()=>k,IntegrationDefinition:()=>D,IntegrationSpecificClient:()=>b,InterfaceDeclaration:()=>H,RuntimeError:()=>K.RuntimeError,botIdHeader:()=>v,botUserIdHeader:()=>j,configurationHeader:()=>I,configurationTypeHeader:()=>Z,integrationIdHeader:()=>N,isApiError:()=>K.isApiError,messages:()=>G,operationHeader:()=>C,parseBody:()=>f,serve:()=>E,typeHeader:()=>z,webhookIdHeader:()=>L});module.exports=xe(m);var G={};P(G,{defaults:()=>De});var i={};P(i,{default:()=>F});var W=require("@bpinternal/zui");l(i,require("@bpinternal/zui"));var F=W.z;var g=i.z.string().min(1),X=i.z.object({text:g}),Y=i.z.object({markdown:g}),ee=i.z.object({imageUrl:g}),te=i.z.object({audioUrl:g}),ne=i.z.object({videoUrl:g}),ie=i.z.object({fileUrl:g,title:g.optional()}),se=i.z.object({latitude:i.z.number(),longitude:i.z.number(),address:i.z.string().optional(),title:i.z.string().optional()}),oe=i.z.object({title:g,subtitle:g.optional(),imageUrl:g.optional(),actions:i.z.array(i.z.object({action:i.z.enum(["postback","url","say"]),label:g,value:g}))}),Q=i.z.object({text:g,options:i.z.array(i.z.object({label:g,value:g}))}),Se=i.z.object({items:i.z.array(oe)}),Pe=i.z.union([i.z.object({type:i.z.literal("text"),payload:X}),i.z.object({type:i.z.literal("markdown"),payload:Y}),i.z.object({type:i.z.literal("image"),payload:ee}),i.z.object({type:i.z.literal("audio"),payload:te}),i.z.object({type:i.z.literal("video"),payload:ne}),i.z.object({type:i.z.literal("file"),payload:ie}),i.z.object({type:i.z.literal("location"),payload:se})]),we=i.z.object({items:i.z.array(Pe)}),De={text:{schema:X},markdown:{schema:Y},image:{schema:ee},audio:{schema:te},video:{schema:ne},file:{schema:ie},location:{schema:se},carousel:{schema:Se},card:{schema:oe},dropdown:{schema:Q},choice:{schema:Q},bloc:{schema:we}};var v="x-bot-id",j="x-bot-user-id",N="x-integration-id",L="x-webhook-id",Z="x-bp-configuration-type",I="x-bp-configuration",C="x-bp-operation",z="x-bp-type";var ae=require("node:http");var T=console;function f(t){if(!t.body)throw new Error("Missing body");return JSON.parse(t.body)}async function E(t,e=8072,n=Re){let s=(0,ae.createServer)(async(a,r)=>{try{let o=await _e(a);if(o.path==="/health"){r.writeHead(200).end("ok");return}let c=await t(o);r.writeHead(c?.status??200,c?.headers??{}).end(c?.body??"{}")}catch(o){T.error("Error while handling request",{error:o?.message??"Internal error occured"}),r.writeHead(500).end(JSON.stringify({error:o?.message??"Internal error occured"}))}});return s.listen(e,()=>n(e)),s}async function _e(t){let e=await Ue(t),n={};for(let a=0;a<t.rawHeaders.length;a+=2){let r=t.rawHeaders[a].toLowerCase(),o=t.rawHeaders[a+1];n[r]=o}let s=new URL(t.url??"",t.headers.host?`http://${t.headers.host}`:"http://botpress.cloud");return{body:e,path:s.pathname,query:Me(s.search,"?"),headers:n,method:t.method?.toUpperCase()??"GET"}}function Me(t,e){return t.indexOf(e)===0?t.slice(e.length):t}async function Ue(t){return new Promise((e,n)=>{if(t.method!=="POST"&&t.method!=="PUT"&&t.method!=="PATCH")return e(void 0);let s="";t.on("data",a=>s+=a.toString()),t.on("error",a=>n(a)),t.on("end",()=>e(s))})}function Re(t){T.info(`Listening on port ${t}`)}l(m,i,module.exports);var K=require("@botpress/client");var u={};P(u,{mapValues:()=>ke,pairs:()=>re});var re=t=>Object.entries(t),ke=(t,e)=>Object.fromEntries(re(t).map(([n,s])=>[n,e(s,n)]));var w=Symbol("schemaName"),ce=t=>t?u.mapValues(t,(n,s)=>({...n,[w]:s})):{},pe=t=>w in t&&t[w]!==void 0,le=t=>t[w];var D=class{constructor(e){this.props=e;this.name=e.name,this.version=e.version,this.icon=e.icon,this.readme=e.readme,this.title=e.title,this.identifier=e.identifier,this.description=e.description,this.configuration=e.configuration,this.configurations=e.configurations,this.events=e.events,this.actions=e.actions,this.channels=e.channels,this.states=e.states,this.user=e.user,this.secrets=e.secrets,this.entities=e.entities,this.interfaces=e.interfaces}name;version;title;description;icon;readme;configuration;configurations;events;actions;channels;states;user;secrets;identifier;entities;interfaces;extend(e,n){let s=n(ce(this.entities)),a=u.pairs(s).find(([p,h])=>!pe(h));if(a)throw new Error(`Cannot extend interface "${e.definition.name}" with entity "${a[0]}"; the provided schema is not part of the integration's entities.`);let r=this;r.interfaces??={};let o=u.mapValues(s,p=>({name:le(p),schema:p.schema})),c=Object.values(o).map(p=>p.name),d=c.length===0?e.definition.name:`${e.definition.name}<${c.join(",")}>`;return r.interfaces[d]={...e,entities:o},this}};var y=require("@botpress/client");var ge=require("@botpress/client"),_={retries:3,retryCondition:t=>ge.axiosRetry.isNetworkOrIdempotentRequestError(t)||[429,502].includes(t.response?.status??0),retryDelay:t=>t*1e3};var b=class{constructor(e){this._client=e}createConversation=e=>this._client.createConversation(e);getConversation=e=>this._client.getConversation(e);listConversations=e=>this._client.listConversations(e);getOrCreateConversation=e=>this._client.getOrCreateConversation(e);updateConversation=e=>this._client.updateConversation(e);deleteConversation=e=>this._client.deleteConversation(e);listParticipants=e=>this._client.listParticipants(e);addParticipant=e=>this._client.addParticipant(e);getParticipant=e=>this._client.getParticipant(e);removeParticipant=e=>this._client.removeParticipant(e);createEvent=e=>this._client.createEvent(e);getEvent=e=>this._client.getEvent(e);listEvents=e=>this._client.listEvents(e);createMessage=e=>this._client.createMessage(e);getOrCreateMessage=e=>this._client.getOrCreateMessage(e);getMessage=e=>this._client.getMessage(e);updateMessage=e=>this._client.updateMessage(e);listMessages=e=>this._client.listMessages(e);deleteMessage=e=>this._client.deleteMessage(e);createUser=e=>this._client.createUser(e);getUser=e=>this._client.getUser(e);listUsers=e=>this._client.listUsers(e);getOrCreateUser=e=>this._client.getOrCreateUser(e);updateUser=e=>this._client.updateUser(e);deleteUser=e=>this._client.deleteUser(e);getState=e=>this._client.getState(e);setState=e=>this._client.setState(e);getOrSetState=e=>this._client.getOrSetState(e);patchState=e=>this._client.patchState(e);configureIntegration=e=>this._client.configureIntegration(e);uploadFile=e=>this._client.uploadFile(e);upsertFile=e=>this._client.upsertFile(e);deleteFile=e=>this._client.deleteFile(e);listFiles=e=>this._client.listFiles(e);getFile=e=>this._client.getFile(e);updateFileMetadata=e=>this._client.updateFileMetadata(e)};var M=class{_cost=0;get cost(){return this._cost}setCost(e){this._cost=e}toJSON(){return{cost:this.cost}}};var de=require("@bpinternal/zui");var Ae=de.z.enum(["webhook_received","message_created","action_triggered","register","unregister","ping","create_user","create_conversation"]),ue=t=>{let e=t[v],n=t[j],s=t[N],a=t[L],r=t[Z],o=t[I],c=Ae.parse(t[C]);if(!e)throw new Error("Missing bot headers");if(!n)throw new Error("Missing bot user headers");if(!s)throw new Error("Missing integration headers");if(!a)throw new Error("Missing webhook headers");if(!o)throw new Error("Missing configuration headers");if(!c)throw new Error("Missing operation headers");return{botId:e,botUserId:n,integrationId:s,webhookId:a,operation:c,configurationType:r??null,configuration:o?JSON.parse(Buffer.from(o,"base64").toString("utf-8")):{}}};var $=J(require("util")),U=t=>{if(process.env.BP_LOG_FORMAT==="json")return JSON.stringify({msg:$.default.format(...t),visible_to_bot_owner:!0});{let[e,...n]=t;return $.default.format(`[For Bot Owner] ${e}`,...n)}},R={forBot:()=>({info:(...t)=>{console.info(U(t))},warn:(...t)=>{console.warn(U(t))},error:(...t)=>{console.error(U(t))},debug:(...t)=>{console.debug(U(t))}})};var me=t=>async e=>{let n=ue(e.headers),s=new y.Client({botId:n.botId,integrationId:n.integrationId,retry:_}),a=new b(s),r={ctx:n,req:e,client:a,logger:R,instance:t};try{let o;switch(n.operation){case"webhook_received":o=await He(r);break;case"register":o=await Ke(r);break;case"unregister":o=await Fe(r);break;case"message_created":o=await Ne(r);break;case"action_triggered":o=await Le(r);break;case"ping":o=await Oe(r);break;case"create_user":o=await Ge(r);break;case"create_conversation":o=await je(r);break;default:throw new Error(`Unknown operation ${n.operation}`)}return o?{...o,status:o.status??200}:{status:200}}catch(o){if((0,y.isApiError)(o)){let d=new y.RuntimeError(o.message,o);return R.forBot().error(d.message),{status:d.code,body:JSON.stringify(d.toJSON())}}console.error(o);let c=new y.RuntimeError("An unexpected error occurred in the integration. Bot owners: Check logs for more informations. Integration owners: throw a RuntimeError to return a custom error message instead.");return R.forBot().error(c.message),{status:c.code,body:JSON.stringify(c.toJSON())}}},Oe=async t=>{},He=async({client:t,ctx:e,req:n,logger:s,instance:a})=>{let{req:r}=f(n);return a.webhook({client:t,ctx:e,req:r,logger:s})},Ke=async({client:t,ctx:e,req:n,logger:s,instance:a})=>{if(!a.register)return;let{webhookUrl:r}=f(n);await a.register({client:t,ctx:e,webhookUrl:r,logger:s})},Fe=async({client:t,ctx:e,req:n,logger:s,instance:a})=>{if(!a.unregister)return;let{webhookUrl:r}=f(n);await a.unregister({ctx:e,webhookUrl:r,client:t,logger:s})},Ge=async({client:t,ctx:e,req:n,logger:s,instance:a})=>{if(!a.createUser)return;let{tags:r}=f(n);return await a.createUser({ctx:e,client:t,tags:r,logger:s})},je=async({client:t,ctx:e,req:n,logger:s,instance:a})=>{if(!a.createConversation)return;let{channel:r,tags:o}=f(n);return await a.createConversation({ctx:e,client:t,channel:r,tags:o,logger:s})},Ne=async({ctx:t,req:e,client:n,logger:s,instance:a})=>{let{conversation:r,user:o,type:c,payload:d,message:p}=f(e),h=a.channels[r.channel];if(!h)throw new Error(`Channel ${r.channel} not found`);let V=h.messages[c];if(!V)throw new Error(`Message of type ${c} not found in channel ${r.channel}`);await V({ctx:t,conversation:r,message:p,user:o,type:c,client:n,payload:d,ack:async({tags:be})=>{await n.updateMessage({id:p.id,tags:be})},logger:s})},Le=async({req:t,ctx:e,client:n,logger:s,instance:a})=>{let{input:r,type:o}=f(t);if(!o)throw new Error("Missing action type");let c=a.actions[o];if(!c)throw new Error(`Action ${o} not found`);let d=new M,h={output:await c({ctx:e,input:r,client:n,type:o,logger:s,metadata:d}),meta:d.toJSON()};return{body:JSON.stringify(h)}};var k=class{constructor(e){this.props=e;this.actions=e.actions,this.channels=e.channels,this.register=e.register,this.unregister=e.unregister,this.createUser=e.createUser,this.createConversation=e.createConversation,this.webhook=e.handler}actions;channels;register;unregister;createUser;createConversation;webhook;handler=me(this);start=e=>E(this.handler,e)};var A=class{constructor(e){this.props=e;this.integrations=e.integrations,this.user=e.user,this.conversation=e.conversation,this.message=e.message,this.states=e.states,this.configuration=e.configuration,this.events=e.events,this.recurringEvents=e.recurringEvents}integrations;user;conversation;message;states;configuration;events;recurringEvents;add(e,n){let s=this;return s.integrations||(s.integrations={}),s.integrations[e.definition.name]={enabled:n.enabled,...e,configurationType:n.configurationType,configuration:n.configuration},this}};var he=J(require("@botpress/client"));var B=class{constructor(e){this._client=e}getConversation=e=>this._client.getConversation(e);listConversations=e=>this._client.listConversations(e);updateConversation=e=>this._client.updateConversation(e);deleteConversation=e=>this._client.deleteConversation(e);listParticipants=e=>this._client.listParticipants(e);addParticipant=e=>this._client.addParticipant(e);getParticipant=e=>this._client.getParticipant(e);removeParticipant=e=>this._client.removeParticipant(e);getEvent=e=>this._client.getEvent(e);listEvents=e=>this._client.listEvents(e);createMessage=e=>this._client.createMessage(e);getOrCreateMessage=e=>this._client.getOrCreateMessage(e);getMessage=e=>this._client.getMessage(e);updateMessage=e=>this._client.updateMessage(e);listMessages=e=>this._client.listMessages(e);deleteMessage=e=>this._client.deleteMessage(e);getUser=e=>this._client.getUser(e);listUsers=e=>this._client.listUsers(e);updateUser=e=>this._client.updateUser(e);deleteUser=e=>this._client.deleteUser(e);getState=e=>this._client.getState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));setState=e=>this._client.setState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));getOrSetState=e=>this._client.getOrSetState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));patchState=e=>this._client.patchState(e).then(n=>({state:{...n.state,payload:n.state.payload}}));callAction=e=>this._client.callAction(e);uploadFile=e=>this._client.uploadFile(e);upsertFile=e=>this._client.upsertFile(e);deleteFile=e=>this._client.deleteFile(e);listFiles=e=>this._client.listFiles(e);getFile=e=>this._client.getFile(e);updateFileMetadata=e=>this._client.updateFileMetadata(e);searchFiles=e=>this._client.searchFiles(e);createConversation=e=>this._client.createConversation(e);getOrCreateConversation=e=>this._client.getOrCreateConversation(e);createUser=e=>this._client.createUser(e);getOrCreateUser=e=>this._client.getOrCreateUser(e)};var fe=require("@bpinternal/zui");var Ze=fe.z.enum(["event_received","register","unregister","ping","action_triggered"]),ye=t=>{let e=t[v],n=t[I],s=t[z],a=Ze.parse(t[C]);if(!e)throw new Error("Missing bot headers");if(!s)throw new Error("Missing type headers");if(!n)throw new Error("Missing configuration headers");if(!a)throw new Error("Missing operation headers");return{botId:e,operation:a,type:s,configuration:n?JSON.parse(Buffer.from(n,"base64").toString("utf-8")):{}}};var Te=t=>async e=>{let n=ye(e.headers);n.operation!=="ping"&&T.info(`Received ${n.operation} operation for bot ${n.botId} of type ${n.type}`);let s=new he.Client({botId:n.botId,retry:_}),a=new B(s),r={req:e,ctx:n,client:a,instance:t};switch(n.operation){case"action_triggered":throw new Error(`Operation ${n.operation} not supported yet`);case"event_received":await Ve(r);break;case"register":await qe(r);break;case"unregister":await $e(r);break;case"ping":await ze(r);break;default:throw new Error(`Unknown operation ${n.operation}`)}return{status:200}},ze=async t=>{},qe=async t=>{},$e=async t=>{},Ve=async({ctx:t,req:e,client:n,instance:s})=>{T.debug(`Received event ${t.type}`);let a=f(e),r=a.event;switch(t.type){case"message_created":let o={user:r.payload.user,conversation:r.payload.conversation,message:r.payload.message,states:r.payload.states,event:r};await Promise.all(s.messageHandlers.map(p=>p({client:n,ctx:t,...o})));break;case"state_expired":let c={state:r.payload.state};await Promise.all(s.stateExpiredHandlers.map(p=>p({client:n,ctx:t,...c})));break;default:let d={event:a.event};await Promise.all(s.eventHandlers.map(p=>p({client:n,ctx:t,...d})))}};var O=class{constructor(e){this.props=e}_state={messageHandlers:[],eventHandlers:[],stateExpiredHandlers:[]};message=e=>{this._state.messageHandlers.push(e)};event=e=>{this._state.eventHandlers.push(e)};stateExpired=e=>{this._state.stateExpiredHandlers.push(e)};handler=Te(this._state);start=e=>E(this.handler,e)};var H=class{constructor(e){this.props=e;this.name=e.name,this.version=e.version,this.entities=e.entities??{},this.templateName=e.templateName;let n=this._getEntityReference(this.entities),s=e.events===void 0?{}:u.mapValues(e.events,o=>({...o,schema:o.schema(n)})),a=e.actions===void 0?{}:u.mapValues(e.actions,o=>({...o,input:{...o.input,schema:o.input.schema(n)},output:{...o.output,schema:o.output.schema(n)}})),r=e.channels===void 0?{}:u.mapValues(e.channels,o=>({...o,messages:u.mapValues(o.messages,c=>({...c,schema:c.schema(n)}))}));this.events=s,this.actions=a,this.channels=r}name;version;entities;events;actions;channels;templateName;_getEntityReference=e=>{let n={};for(let s of Object.keys(e))n[s]=F.ref(s);return n}};0&&(module.exports={Bot,BotDefinition,BotSpecificClient,Integration,IntegrationDefinition,IntegrationSpecificClient,InterfaceDeclaration,RuntimeError,botIdHeader,botUserIdHeader,configurationHeader,configurationTypeHeader,integrationIdHeader,isApiError,messages,operationHeader,parseBody,serve,typeHeader,webhookIdHeader});
 //# sourceMappingURL=index.js.map