@botpress/sdk 3.2.0 → 3.3.0

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

@@ -0,0 +1,30 @@
+import * as utils from '../../utils/type-utils';
+import * as common from '../common';
+export type EnumerateMessages<TIntegration extends common.BaseIntegration> = utils.UnionToIntersection<utils.ValueOf<{
+    [TChannelName in keyof TIntegration['channels']]: {
+        [TMessageName in keyof TIntegration['channels'][TChannelName]['messages']]: {
+            tags: TIntegration['channels'][TChannelName]['message']['tags'];
+            payload: TIntegration['channels'][TChannelName]['messages'][TMessageName];
+        };
+    };
+}>>;
+export type GetChannelByName<TIntegration extends common.BaseIntegration, TChannelName extends keyof TIntegration['channels']> = utils.Cast<TIntegration['channels'][TChannelName], common.BaseChannel>;
+export type GetMessageByName<TIntegration extends common.BaseIntegration, TMessageName extends keyof EnumerateMessages<TIntegration>> = utils.Cast<EnumerateMessages<TIntegration>[TMessageName], {
+    tags: Record<string, any>;
+    payload: any;
+}>;
+export type ConversationTags<TIntegration extends common.BaseIntegration> = keyof utils.UnionToIntersection<utils.ValueOf<{
+    [TChannelName in keyof TIntegration['channels']]: TIntegration['channels'][TChannelName]['conversation']['tags'];
+}>>;
+export type MessageTags<TIntegration extends common.BaseIntegration> = keyof utils.UnionToIntersection<utils.ValueOf<{
+    [TChannelName in keyof TIntegration['channels']]: TIntegration['channels'][TChannelName]['message']['tags'];
+}>>;
+export type TagsOfMessage<TIntegration extends common.BaseIntegration, TMessageName extends keyof EnumerateMessages<TIntegration>> = keyof utils.UnionToIntersection<GetMessageByName<TIntegration, TMessageName>['tags']>;
+/**
+ * @deprecated Integration's should no longer use their name as prefix for event types or tags.
+ */
+export type WithRequiredPrefix<TTags extends string, TPrefix extends string> = string extends TTags ? string : utils.Join<[TPrefix, ':', TTags]>;
+/**
+ * @deprecated Integration's should no longer use their name as prefix for event types or tags.
+ */
+export type WithOptionalPrefix<TTags extends string, TPrefix extends string> = TTags | WithRequiredPrefix<TTags, TPrefix>;

package/dist/integration/client/sub-types.test.d.ts

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

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

@@ -1,19 +1,9 @@
 import * as client from '@botpress/client';
 import * as utils from '../../utils/type-utils';
 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>;
-/**
- * @deprecated Integration's should no longer use their name as prefix for event types or tags.
- */
-type WithRequiredPrefix<TTags extends string, TPrefix extends string> = string extends TTags ? string : utils.Join<[TPrefix, ':', TTags]>;
-/**
- * @deprecated Integration's should no longer use their name as prefix for event types or tags.
- */
-type WithOptionalPrefix<TTags extends string, TPrefix extends string> = TTags | WithRequiredPrefix<TTags, TPrefix>;
+import { EnumerateMessages, ConversationTags, GetChannelByName, GetMessageByName, MessageTags, WithOptionalPrefix, WithRequiredPrefix, TagsOfMessage } from './sub-types';
 type Arg<F extends (...args: any[]) => any> = Parameters<F>[number];
 type Res<F extends (...args: any[]) => any> = ReturnType<F>;
-type AllChannels<TIntegration extends common.BaseIntegration> = utils.ValueOf<TIntegration['channels']>;
 type ConversationResponse<TIntegration extends common.BaseIntegration, ChannelName extends keyof TIntegration['channels'] = keyof TIntegration['channels']> = {
     conversation: utils.Merge<Awaited<Res<client.Client['getConversation']>>['conversation'], {
         channel: ChannelName;
@@ -29,12 +19,13 @@ export type ListConversations<TIntegration extends common.BaseIntegration> = <Ch
     channel?: utils.Cast<ChannelName, string>;
     tags?: common.ToTags<keyof GetChannelByName<TIntegration, ChannelName>['conversation']['tags']>;
 }>) => Res<client.Client['listConversations']>;
-export type GetOrCreateConversation<TIntegration extends common.BaseIntegration> = <ChannelName extends keyof TIntegration['channels']>(x: {
+export type GetOrCreateConversation<TIntegration extends common.BaseIntegration> = <ChannelName extends keyof TIntegration['channels'], TTags extends keyof GetChannelByName<TIntegration, ChannelName>['conversation']['tags']>(x: utils.Merge<Arg<client.Client['getOrCreateConversation']>, {
     channel: utils.Cast<ChannelName, string>;
-    tags: common.ToTags<keyof GetChannelByName<TIntegration, ChannelName>['conversation']['tags']>;
-}) => Promise<ConversationResponse<TIntegration, ChannelName>>;
+    tags: common.ToTags<TTags>;
+    discriminateByTags?: NoInfer<utils.Cast<TTags[], string[]>>;
+}>) => Promise<ConversationResponse<TIntegration, ChannelName>>;
 export type UpdateConversation<TIntegration extends common.BaseIntegration> = (x: utils.Merge<Arg<client.Client['updateConversation']>, {
-    tags?: common.ToTags<keyof AllChannels<TIntegration>['conversation']['tags']>;
+    tags?: common.ToTags<ConversationTags<TIntegration>>;
 }>) => Promise<ConversationResponse<TIntegration>>;
 export type DeleteConversation<_TIntegration extends common.BaseIntegration> = client.Client['deleteConversation'];
 export type ListParticipants<_TIntegration extends common.BaseIntegration> = client.Client['listParticipants'];
@@ -57,29 +48,30 @@ export type GetEvent<TIntegration extends common.BaseIntegration> = (x: Arg<clie
 export type ListEvents<TIntegration extends common.BaseIntegration> = (x: utils.Merge<Arg<client.Client['listEvents']>, {
     type?: WithRequiredPrefix<utils.Cast<keyof TIntegration['events'], string>, TIntegration['name']>;
 }>) => Res<client.Client['listEvents']>;
-type MessageResponse<TIntegration extends common.BaseIntegration, TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']> = {
+type MessageResponse<TIntegration extends common.BaseIntegration, TMessage extends keyof EnumerateMessages<TIntegration> = keyof EnumerateMessages<TIntegration>> = {
     message: utils.Merge<Awaited<Res<client.Client['createMessage']>>['message'], {
         type: utils.Cast<TMessage, string>;
-        payload: TIntegration['channels'][TChannel]['messages'][TMessage];
-        tags: common.ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
+        payload: GetMessageByName<TIntegration, TMessage>['payload'];
+        tags: common.ToTags<TagsOfMessage<TIntegration, TMessage>>;
     }>;
 };
-export type CreateMessage<TIntegration extends common.BaseIntegration> = <TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']>(x: utils.Merge<Arg<client.Client['createMessage']>, {
+export type CreateMessage<TIntegration extends common.BaseIntegration> = <TMessage extends keyof EnumerateMessages<TIntegration>>(x: utils.Merge<Arg<client.Client['createMessage']>, {
     type: utils.Cast<TMessage, string>;
-    payload: TIntegration['channels'][TChannel]['messages'][TMessage];
-    tags: common.ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
-}>) => Promise<MessageResponse<TIntegration, TChannel, TMessage>>;
-export type GetOrCreateMessage<TIntegration extends common.BaseIntegration> = <TChannel extends keyof TIntegration['channels'], TMessage extends keyof TIntegration['channels'][TChannel]['messages']>(x: utils.Merge<Arg<client.Client['getOrCreateMessage']>, {
+    payload: GetMessageByName<TIntegration, TMessage>['payload'];
+    tags: common.ToTags<keyof GetMessageByName<TIntegration, TMessage>['tags']>;
+}>) => Promise<MessageResponse<TIntegration, TMessage>>;
+export type GetOrCreateMessage<TIntegration extends common.BaseIntegration> = <TMessage extends keyof EnumerateMessages<TIntegration>, TTags extends keyof GetMessageByName<TIntegration, TMessage>['tags']>(x: utils.Merge<Arg<client.Client['getOrCreateMessage']>, {
     type: utils.Cast<TMessage, string>;
-    payload: TIntegration['channels'][TChannel]['messages'][TMessage];
-    tags: common.ToTags<keyof TIntegration['channels'][TChannel]['message']['tags']>;
-}>) => Promise<MessageResponse<TIntegration, TChannel, TMessage>>;
-export type GetMessage<TIntegration extends common.BaseIntegration> = (x: Arg<client.Client['getMessage']>) => Promise<MessageResponse<TIntegration, keyof TIntegration['channels'], keyof utils.ValueOf<TIntegration['channels']>['messages']>>;
+    payload: GetMessageByName<TIntegration, TMessage>['payload'];
+    tags: common.ToTags<TTags>;
+    discriminateByTags?: NoInfer<utils.Cast<TTags[], string[]>>;
+}>) => Promise<MessageResponse<TIntegration, TMessage>>;
+export type GetMessage<TIntegration extends common.BaseIntegration> = (x: Arg<client.Client['getMessage']>) => Promise<MessageResponse<TIntegration>>;
 export type UpdateMessage<TIntegration extends common.BaseIntegration> = (x: utils.Merge<Arg<client.Client['updateMessage']>, {
-    tags: common.ToTags<keyof AllChannels<TIntegration>['message']['tags']>;
-}>) => Promise<MessageResponse<TIntegration, keyof TIntegration['channels'], keyof utils.ValueOf<TIntegration['channels']>['messages']>>;
+    tags: common.ToTags<MessageTags<TIntegration>>;
+}>) => Promise<MessageResponse<TIntegration>>;
 export type ListMessages<TIntegration extends common.BaseIntegration> = (x: utils.Merge<Arg<client.Client['listMessages']>, {
-    tags?: common.ToTags<keyof AllChannels<TIntegration>['message']['tags']>;
+    tags?: common.ToTags<MessageTags<TIntegration>>;
 }>) => Res<client.Client['listMessages']>;
 export type DeleteMessage<_TIntegration extends common.BaseIntegration> = client.Client['deleteMessage'];
 type UserResponse<TIntegration extends common.BaseIntegration> = {
@@ -94,8 +86,9 @@ export type GetUser<TIntegration extends common.BaseIntegration> = (x: Arg<clien
 export type ListUsers<TIntegration extends common.BaseIntegration> = (x: utils.Merge<Arg<client.Client['listUsers']>, {
     tags?: common.ToTags<keyof TIntegration['user']['tags']>;
 }>) => Res<client.Client['listUsers']>;
-export type GetOrCreateUser<TIntegration extends common.BaseIntegration> = (x: utils.Merge<Arg<client.Client['getOrCreateUser']>, {
-    tags: common.ToTags<keyof TIntegration['user']['tags']>;
+export type GetOrCreateUser<TIntegration extends common.BaseIntegration> = <TTags extends keyof TIntegration['user']['tags']>(x: utils.Merge<Arg<client.Client['getOrCreateUser']>, {
+    tags: common.ToTags<TTags>;
+    discriminateByTags?: NoInfer<utils.Cast<TTags[], string[]>>;
 }>) => Promise<UserResponse<TIntegration>>;
 export type UpdateUser<TIntegration extends common.BaseIntegration> = (x: utils.Merge<Arg<client.Client['updateUser']>, {
     tags?: common.ToTags<keyof TIntegration['user']['tags']>;

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

@@ -1,4 +1,2 @@
 import * as utils from '../../utils/type-utils';
-type AsTags<T extends Record<string, string | undefined>> = utils.Cast<T, Record<string, string>>;
-export type ToTags<TTags extends string | number | symbol> = AsTags<Partial<Record<utils.Cast<TTags, string>, string>>>;
-export {};
+export type ToTags<TTags extends string | number | symbol> = utils.Cast<Partial<Record<TTags, string>>, Record<string, string>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Botpress SDK",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -16,7 +16,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.45.0",
+    "@botpress/client": "0.47.0",
     "browser-or-node": "^2.1.1"
   },
   "devDependencies": {
@@ -32,5 +32,9 @@
     "esbuild": {
       "optional": true
     }
-  }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "packageManager": "pnpm@8.6.2"
 }