@botpress/sdk 1.2.0 → 1.2.1

package/.turbo/turbo-build.log

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

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

@@ -1,5 +1,5 @@
 import * as client from '@botpress/client';
-import { Join, UnionToIntersection, Merge, ValueOf, Split, Cast } from '../../utils/type-utils';
+import { Join, UnionToIntersection, Merge, ValueOf, Split, Cast, ToSealedRecord } from '../../utils/type-utils';
 import { BaseBot } from '../generic';
 /**
  * 0. Definitions
@@ -17,48 +17,34 @@ export type IntegrationInstanceUserDefinition = IntegrationInstanceDefinition['u
 /**
  * 1. Enumerations
  */
-export type EnumerateActions<TBot extends BaseBot> = UnionToIntersection<{
+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 Join<[
-            TIntegrationName,
-            ':',
-            TActionName
-        ]>]: TBot['integrations'][TIntegrationName]['actions'][TActionName];
+        [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 EnumerateEvents<TBot extends BaseBot> = UnionToIntersection<{
+}[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 Join<[
-            TIntegrationName,
-            ':',
-            TEventName
-        ]>]: TBot['integrations'][TIntegrationName]['events'][TEventName];
+        [TEventName in keyof TBot['integrations'][TIntegrationName]['events'] as EventKey<Cast<TIntegrationName, string>, Cast<TEventName, string>>]: TBot['integrations'][TIntegrationName]['events'][TEventName];
     };
-}[keyof TBot['integrations']]> & (string extends keyof TBot['events'] ? {} : {
+}[keyof TBot['integrations']]> & {
     [TEventName in keyof TBot['events']]: TBot['events'][TEventName];
-});
-export type EnumerateChannels<TBot extends BaseBot> = UnionToIntersection<{
+}>;
+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 Join<[
-            TIntegrationName,
-            ':',
-            TChannelName
-        ]>]: TBot['integrations'][TIntegrationName]['channels'][TChannelName];
+        [TChannelName in keyof TBot['integrations'][TIntegrationName]['channels'] as ChannelKey<Cast<TIntegrationName, string>, Cast<TChannelName, string>>]: TBot['integrations'][TIntegrationName]['channels'][TChannelName];
     };
-}[keyof TBot['integrations']]>;
-export type EnumerateMessages<TBot extends BaseBot> = UnionToIntersection<{
+}[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 Join<[
-                TIntegrationName,
-                ':',
-                TChannelName,
-                ':',
-                TMessageName
-            ]>]: TBot['integrations'][TIntegrationName]['channels'][TChannelName]['messages'][TMessageName];
+            [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']]>;
+}[keyof TBot['integrations']]> & {}>;
 export type GetMessages<TBot extends BaseBot> = {
     [K in keyof EnumerateMessages<TBot> as Cast<Split<K, ':'>[2], string>]: EnumerateMessages<TBot>[K];
 };
@@ -81,3 +67,4 @@ export type MessageResponse<TBot extends BaseBot, TMessage extends keyof GetMess
         }>;
     }>;
 };
+export {};

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

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

package/dist/bot/generic.d.ts

@@ -1,7 +1,13 @@
 import { BaseIntegration } from '../integration/generic';
+import * as utils from '../utils/type-utils';
 export type BaseIntegrations = Record<string, BaseIntegration>;
 export type BaseBot = {
     integrations: BaseIntegrations;
     events: Record<string, any>;
     states: Record<string, any>;
 };
+export type MakeBot<B extends Partial<BaseBot>> = {
+    integrations: utils.Default<B['integrations'], BaseBot['integrations']>;
+    events: utils.Default<B['events'], BaseBot['events']>;
+    states: utils.Default<B['states'], BaseBot['states']>;
+};

package/dist/integration/generic.d.ts

@@ -1,3 +1,4 @@
+import * as utils from '../utils/type-utils';
 export type BaseIntegration = {
     name: string;
     version: string;
@@ -28,3 +29,20 @@ export type BaseIntegration = {
     };
     entities: Record<string, any>;
 };
+export type MakeChannel<C extends Partial<BaseIntegration['channels'][string]>> = {
+    messages: utils.Default<C['messages'], BaseIntegration['channels'][string]['messages']>;
+    message: utils.Default<C['message'], BaseIntegration['channels'][string]['message']>;
+    conversation: utils.Default<C['conversation'], BaseIntegration['channels'][string]['conversation']>;
+};
+export type MakeIntegration<I extends Partial<BaseIntegration>> = {
+    name: utils.Default<I['name'], BaseIntegration['name']>;
+    version: utils.Default<I['version'], BaseIntegration['version']>;
+    configuration: utils.Default<I['configuration'], BaseIntegration['configuration']>;
+    configurations: utils.Default<I['configurations'], BaseIntegration['configurations']>;
+    actions: utils.Default<I['actions'], BaseIntegration['actions']>;
+    channels: utils.Default<I['channels'], BaseIntegration['channels']>;
+    events: utils.Default<I['events'], BaseIntegration['events']>;
+    states: utils.Default<I['states'], BaseIntegration['states']>;
+    user: utils.Default<I['user'], BaseIntegration['user']>;
+    entities: utils.Default<I['entities'], BaseIntegration['entities']>;
+};

package/dist/utils/type-utils.d.ts

@@ -4,9 +4,18 @@ export type Cast<T, U> = T extends U ? T : U;
 export type Writable<T> = {
     -readonly [K in keyof T]: T[K];
 };
-export type Extends<T, U> = T extends U ? true : false;
+export type Default<T, U> = undefined extends T ? U : T;
+export type IsExtend<T, U> = T extends U ? true : false;
 export type IsEqual<T, U> = T extends U ? (U extends T ? true : false) : false;
-export type Expect<T extends true> = T;
+export type AssertExtends<A, _B extends A> = true;
+export type AssertTrue<_T extends true> = true;
+export type AssertAll<_T extends true[]> = true;
 export type Join<S extends (string | number | symbol)[]> = S extends [infer H, ...infer T] ? `${Cast<H, string>}${Join<Cast<T, string[]>>}` : S extends [infer H] ? Cast<H, string> : '';
 export type Split<S extends string | number | symbol, D extends string> = S extends `${infer H}${D}${infer T}` ? [H, ...Split<Cast<T, string>, D>] : [S];
 export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+/**
+ * removes string index signature from Record
+ */
+export type ToSealedRecord<R extends Record<string, any>> = {
+    [K in keyof R as string extends K ? never : K]: R[K];
+};

package/dist/utils/type-utils.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Botpress SDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",