@botpress/sdk 1.2.1 → 1.2.2

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

@@ -1,128 +0,0 @@
-import { Client } from '@botpress/client';
-import { Merge, Cast, ValueOf } from '../../utils/type-utils';
-import { BaseIntegration } from '../generic';
-import { GetChannelByName, ToTags, WithPrefix } from './types';
-type Arg<F extends (...args: any[]) => any> = Parameters<F>[number];
-type Res<F extends (...args: any[]) => any> = ReturnType<F>;
-type AllChannels<TIntegration extends BaseIntegration> = ValueOf<TIntegration['channels']>;
-type ConversationResponse<TIntegration extends BaseIntegration, ChannelName extends keyof TIntegration['channels'] = keyof TIntegration['channels']> = {
-    conversation: Merge<Awaited<Res<Client['getConversation']>>['conversation'], {
-        channel: ChannelName;
-        tags: ToTags<keyof TIntegration['channels'][ChannelName]['conversation']['tags']>;
-    }>;
-};
-export type CreateConversation<TIntegration extends BaseIntegration> = <ChannelName extends keyof TIntegration['channels']>(x: {
-    channel: Cast<ChannelName, string>;
-    tags: ToTags<keyof GetChannelByName<TIntegration, ChannelName>['conversation']['tags']>;
-}) => Promise<ConversationResponse<TIntegration, ChannelName>>;
-export type GetConversation<TIntegration extends BaseIntegration> = (x: Arg<Client['getConversation']>) => Promise<ConversationResponse<TIntegration>>;
-export type ListConversations<TIntegration extends BaseIntegration> = <ChannelName extends keyof TIntegration['channels']>(x: Merge<Arg<Client['listConversations']>, {
-    channel?: Cast<ChannelName, string>;
-    tags?: ToTags<keyof GetChannelByName<TIntegration, ChannelName>['conversation']['tags']>;
-}>) => Res<Client['listConversations']>;
-export type GetOrCreateConversation<TIntegration extends BaseIntegration> = <ChannelName extends keyof TIntegration['channels']>(x: {
-    channel: Cast<ChannelName, string>;
-    tags: ToTags<keyof GetChannelByName<TIntegration, ChannelName>['conversation']['tags']>;
-}) => Promise<ConversationResponse<TIntegration, ChannelName>>;
-export type UpdateConversation<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['updateConversation']>, {
-    tags: ToTags<keyof AllChannels<TIntegration>['conversation']['tags']>;
-}>) => Promise<ConversationResponse<TIntegration>>;
-export type DeleteConversation<_TIntegration extends BaseIntegration> = Client['deleteConversation'];
-export type ListParticipants<_TIntegration extends BaseIntegration> = Client['listParticipants'];
-export type AddParticipant<_TIntegration extends BaseIntegration> = Client['addParticipant'];
-export type GetParticipant<_TIntegration extends BaseIntegration> = Client['getParticipant'];
-export type RemoveParticipant<_TIntegration extends BaseIntegration> = Client['removeParticipant'];
-type EventResponse<TIntegration extends BaseIntegration, TEvent extends keyof TIntegration['events']> = {
-    event: Merge<Awaited<Res<Client['getEvent']>>['event'], {
-        type: TEvent;
-        payload: TIntegration['events'][TEvent];
-    }>;
-};
-export type CreateEvent<TIntegration extends BaseIntegration> = <TEvent extends keyof TIntegration['events']>(x: Merge<Arg<Client['createEvent']>, {
-    type: WithPrefix<Cast<TEvent, string>, {
-        allowPrefix: TIntegration['name'];
-    }>;
-    payload: TIntegration['events'][TEvent];
-}>) => Promise<EventResponse<TIntegration, TEvent>>;
-export type GetEvent<TIntegration extends BaseIntegration> = (x: Arg<Client['getEvent']>) => Promise<ValueOf<{
-    [K in keyof TIntegration['events']]: EventResponse<TIntegration, K>;
-}>>;
-export type ListEvents<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['listEvents']>, {
-    type: WithPrefix<Cast<keyof TIntegration['events'], string>, {
-        allowPrefix: TIntegration['name'];
-    }>;
-}>) => Res<Client['listEvents']>;
-type MessageResponse<TIntegration extends BaseIntegration, TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']> = {
-    message: Merge<Awaited<Res<Client['createMessage']>>['message'], {
-        payload: TIntegration['channels'][TChannel]['messages'][TMessage];
-        tags: ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
-    }>;
-};
-export type CreateMessage<TIntegration extends BaseIntegration> = <TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']>(x: Merge<Arg<Client['createMessage']>, {
-    type: Cast<TMessage, string>;
-    payload: TIntegration['channels'][TChannel]['messages'][TMessage];
-    tags: ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
-}>) => Promise<MessageResponse<TIntegration, TChannel, TMessage>>;
-export type GetOrCreateMessage<TIntegration extends BaseIntegration> = <TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']>(x: Merge<Arg<Client['getOrCreateMessage']>, {
-    type: Cast<TMessage, string>;
-    payload: TIntegration['channels'][TChannel]['messages'][TMessage];
-    tags: ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
-}>) => Promise<MessageResponse<TIntegration, TChannel, TMessage>>;
-export type GetMessage<TIntegration extends BaseIntegration> = (x: Arg<Client['getMessage']>) => Promise<MessageResponse<TIntegration, keyof TIntegration['channels'], keyof ValueOf<TIntegration['channels']>['messages']>>;
-export type UpdateMessage<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['updateMessage']>, {
-    tags: ToTags<keyof AllChannels<TIntegration>['message']['tags']>;
-}>) => Promise<MessageResponse<TIntegration, keyof TIntegration['channels'], keyof ValueOf<TIntegration['channels']>['messages']>>;
-export type ListMessages<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['listMessages']>, {
-    tags: ToTags<keyof AllChannels<TIntegration>['message']['tags']>;
-}>) => Res<Client['listMessages']>;
-export type DeleteMessage<_TIntegration extends BaseIntegration> = Client['deleteMessage'];
-type UserResponse<TIntegration extends BaseIntegration> = {
-    user: Merge<Awaited<Res<Client['getUser']>>['user'], {
-        tags: ToTags<keyof TIntegration['user']['tags']>;
-    }>;
-};
-export type CreateUser<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['createUser']>, {
-    tags: ToTags<keyof TIntegration['user']['tags']>;
-}>) => Promise<UserResponse<TIntegration>>;
-export type GetUser<TIntegration extends BaseIntegration> = (x: Arg<Client['getUser']>) => Promise<UserResponse<TIntegration>>;
-export type ListUsers<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['listUsers']>, {
-    tags: ToTags<keyof TIntegration['user']['tags']>;
-}>) => Res<Client['listUsers']>;
-export type GetOrCreateUser<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['getOrCreateUser']>, {
-    tags: ToTags<keyof TIntegration['user']['tags']>;
-}>) => Promise<UserResponse<TIntegration>>;
-export type UpdateUser<TIntegration extends BaseIntegration> = (x: Merge<Arg<Client['updateUser']>, {
-    tags: ToTags<keyof TIntegration['user']['tags']>;
-}>) => Promise<UserResponse<TIntegration>>;
-export type DeleteUser<_TIntegration extends BaseIntegration> = Client['deleteUser'];
-type StateResponse<TIntegration extends BaseIntegration, TState extends keyof TIntegration['states']> = {
-    state: Merge<Awaited<Res<Client['getState']>>['state'], {
-        payload: TIntegration['states'][TState];
-    }>;
-    meta: {
-        cached: boolean;
-    };
-};
-export type GetState<TIntegration extends BaseIntegration> = <TState extends keyof TIntegration['states']>(x: Merge<Arg<Client['getState']>, {
-    name: Cast<TState, string>;
-}>) => Promise<StateResponse<TIntegration, TState>>;
-export type SetState<TIntegration extends BaseIntegration> = <TState extends keyof TIntegration['states']>(x: Merge<Arg<Client['setState']>, {
-    name: Cast<TState, string>;
-    payload: TIntegration['states'][TState] | null;
-}>) => Promise<StateResponse<TIntegration, TState>>;
-export type GetOrSetState<TIntegration extends BaseIntegration> = <TState extends keyof TIntegration['states']>(x: Merge<Arg<Client['getOrSetState']>, {
-    name: Cast<TState, string>;
-    payload: TIntegration['states'][TState];
-}>) => Promise<StateResponse<TIntegration, TState>>;
-export type PatchState<TIntegration extends BaseIntegration> = <TState extends keyof TIntegration['states']>(x: Merge<Arg<Client['patchState']>, {
-    name: Cast<TState, string>;
-    payload: Partial<TIntegration['states'][TState]>;
-}>) => Promise<StateResponse<TIntegration, TState>>;
-export type ConfigureIntegration<_TIntegration extends BaseIntegration> = Client['configureIntegration'];
-export type UploadFile<_TIntegration extends BaseIntegration> = Client['uploadFile'];
-export type UpsertFile<_TIntegration extends BaseIntegration> = Client['upsertFile'];
-export type DeleteFile<_TIntegration extends BaseIntegration> = Client['deleteFile'];
-export type ListFiles<_TIntegration extends BaseIntegration> = Client['listFiles'];
-export type GetFile<_TIntegration extends BaseIntegration> = Client['getFile'];
-export type UpdateFileMetadata<_TIntegration extends BaseIntegration> = Client['updateFileMetadata'];
-export {};

package/dist/integration/context.d.ts

@@ -1,23 +0,0 @@
-import { z } from '@bpinternal/zui';
-import { ValueOf } from '../utils/type-utils';
-import { BaseIntegration } from './generic';
-export declare const integrationOperationSchema: import("@bpinternal/zui").ZodEnum<["webhook_received", "message_created", "action_triggered", "register", "unregister", "ping", "create_user", "create_conversation"]>;
-export type IntegrationOperation = z.infer<typeof integrationOperationSchema>;
-type IntegrationContextConfig<TIntegration extends BaseIntegration> = {
-    configurationType: null;
-    configuration: TIntegration['configuration'];
-} | ValueOf<{
-    [TConfigType in keyof TIntegration['configurations']]: {
-        configurationType: TConfigType;
-        configuration: TIntegration['configurations'][TConfigType];
-    };
-}>;
-export type IntegrationContext<TIntegration extends BaseIntegration = BaseIntegration> = {
-    botId: string;
-    botUserId: string;
-    integrationId: string;
-    webhookId: string;
-    operation: IntegrationOperation;
-} & IntegrationContextConfig<TIntegration>;
-export declare const extractContext: <TIntegration extends BaseIntegration>(headers: Record<string, string | undefined>) => IntegrationContext<TIntegration>;
-export {};

package/dist/integration/server.d.ts

@@ -1,88 +0,0 @@
-import { type Conversation, type Message, type User } from '@botpress/client';
-import { Request, Response } from '../serve';
-import { Cast, Merge } from '../utils/type-utils';
-import { IntegrationSpecificClient } from './client';
-import { ToTags } from './client/types';
-import { type IntegrationContext } from './context';
-import { BaseIntegration } from './generic';
-import { IntegrationLogger } from './logger';
-type CommonArgs<TIntegration extends BaseIntegration> = {
-    ctx: IntegrationContext<TIntegration>;
-    client: IntegrationSpecificClient<TIntegration>;
-    logger: IntegrationLogger;
-};
-type RegisterPayload = {
-    webhookUrl: string;
-};
-type RegisterArgs<TIntegration extends BaseIntegration> = CommonArgs<TIntegration> & RegisterPayload;
-type UnregisterPayload = {
-    webhookUrl: string;
-};
-type UnregisterArgs<TIntegration extends BaseIntegration> = CommonArgs<TIntegration> & UnregisterPayload;
-type WebhookPayload = {
-    req: Request;
-};
-type WebhookArgs<TIntegration extends BaseIntegration> = CommonArgs<TIntegration> & WebhookPayload;
-type ActionMetadata = {
-    setCost: (cost: number) => void;
-};
-type ActionPayload<T extends string, I> = {
-    type: T;
-    input: I;
-    metadata: ActionMetadata;
-};
-type ActionArgs<TIntegration extends BaseIntegration, T extends string, I> = CommonArgs<TIntegration> & ActionPayload<T, I>;
-type CreateUserPayload<TIntegration extends BaseIntegration> = {
-    tags: ToTags<keyof TIntegration['user']['tags']>;
-};
-type CreateUserArgs<TIntegration extends BaseIntegration> = CommonArgs<TIntegration> & CreateUserPayload<TIntegration>;
-type CreateConversationPayload<TIntegration extends BaseIntegration, TChannel extends keyof TIntegration['channels'] = keyof TIntegration['channels']> = {
-    channel: TChannel;
-    tags: ToTags<keyof TIntegration['channels'][TChannel]['conversation']['tags']>;
-};
-type CreateConversationArgs<TIntegration extends BaseIntegration> = CommonArgs<TIntegration> & CreateConversationPayload<TIntegration>;
-type MessagePayload<TIntegration extends BaseIntegration, TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']> = {
-    type: TMessage;
-    payload: TIntegration['channels'][TChannel]['messages'][TMessage];
-    conversation: Merge<Conversation, {
-        channel: TChannel;
-        tags: ToTags<keyof TIntegration['channels'][TChannel]['conversation']['tags']>;
-    }>;
-    message: Merge<Message, {
-        tags: ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
-    }>;
-    user: Merge<User, {
-        tags: ToTags<keyof TIntegration['user']['tags']>;
-    }>;
-};
-type MessageArgs<TIntegration extends BaseIntegration, TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']> = CommonArgs<TIntegration> & MessagePayload<TIntegration, TChannel, TMessage> & {
-    ack: (props: {
-        tags: ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
-    }) => Promise<void>;
-};
-export type RegisterFunction<TIntegration extends BaseIntegration> = (props: RegisterArgs<TIntegration>) => Promise<void>;
-export type UnregisterFunction<TIntegration extends BaseIntegration> = (props: UnregisterArgs<TIntegration>) => Promise<void>;
-export type WebhookFunction<TIntegration extends BaseIntegration> = (props: WebhookArgs<TIntegration>) => Promise<Response | void>;
-export type ActionFunctions<TIntegration extends BaseIntegration> = {
-    [ActionType in keyof TIntegration['actions']]: (props: ActionArgs<TIntegration, Cast<ActionType, string>, TIntegration['actions'][ActionType]['input']>) => Promise<TIntegration['actions'][ActionType]['output']>;
-};
-export type CreateUserFunction<TIntegration extends BaseIntegration> = (props: CreateUserArgs<TIntegration>) => Promise<Response | void>;
-export type CreateConversationFunction<TIntegration extends BaseIntegration> = (props: CreateConversationArgs<TIntegration>) => Promise<Response | void>;
-export type ChannelFunctions<TIntegration extends BaseIntegration> = {
-    [ChannelName in keyof TIntegration['channels']]: {
-        messages: {
-            [MessageType in keyof TIntegration['channels'][ChannelName]['messages']]: (props: CommonArgs<TIntegration> & MessageArgs<TIntegration, ChannelName, MessageType>) => Promise<void>;
-        };
-    };
-};
-export type IntegrationHandlers<TIntegration extends BaseIntegration> = {
-    register: RegisterFunction<TIntegration>;
-    unregister: UnregisterFunction<TIntegration>;
-    webhook: WebhookFunction<TIntegration>;
-    createUser?: CreateUserFunction<TIntegration>;
-    createConversation?: CreateConversationFunction<TIntegration>;
-    actions: ActionFunctions<TIntegration>;
-    channels: ChannelFunctions<TIntegration>;
-};
-export declare const integrationHandler: <TIntegration extends BaseIntegration>(instance: IntegrationHandlers<TIntegration>) => (req: Request) => Promise<Response | void>;
-export {};