@botpress/cognitive 0.1.29 → 0.1.30

package/.turbo/turbo-build.log

@@ -1,19 +1,19 @@
 
-> @botpress/cognitive@0.1.29 build /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.1.30 build /home/runner/work/botpress/botpress/packages/cognitive
 > pnpm build:type && pnpm build:neutral && size-limit
 
 
-> @botpress/cognitive@0.1.29 build:type /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.1.30 build:type /home/runner/work/botpress/botpress/packages/cognitive
 > tsup --tsconfig tsconfig.build.json ./src/index.ts --dts-resolve --dts-only --clean
 
 CLI Building entry: ./src/index.ts
 CLI Using tsconfig: tsconfig.build.json
 CLI tsup v8.0.2
 DTS Build start
-DTS ⚡️ Build success in 15211ms
-DTS dist/index.d.ts 588.36 KB
+DTS ⚡️ Build success in 11594ms
+DTS dist/index.d.ts 603.20 KB
 
-> @botpress/cognitive@0.1.29 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
+> @botpress/cognitive@0.1.30 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
 > ts-node -T ./build.ts --neutral
 
 Done

package/dist/index.d.ts

@@ -4360,6 +4360,10 @@ interface GetPublicIntegrationByIdResponse {
              */
             messageExtractScript?: string;
         };
+        /**
+         * Maximum execution time of the integration (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -4763,6 +4767,10 @@ interface GetPublicIntegrationResponse {
              */
             messageExtractScript?: string;
         };
+        /**
+         * Maximum execution time of the integration (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -5392,6 +5400,226 @@ interface GetPublicPluginByIdResponse {
     };
 }
 
+interface GetDereferencedPublicPluginByIdRequestHeaders {
+}
+interface GetDereferencedPublicPluginByIdRequestQuery {
+    /**
+     * Mapping of interface aliases to integration IDs
+     */
+    interfaces: {
+        /**
+         * integration id
+         */
+        [k: string]: string;
+    };
+}
+interface GetDereferencedPublicPluginByIdRequestParams {
+    id: string;
+}
+interface GetDereferencedPublicPluginByIdRequestBody {
+}
+type GetDereferencedPublicPluginByIdInput = GetDereferencedPublicPluginByIdRequestBody & GetDereferencedPublicPluginByIdRequestHeaders & GetDereferencedPublicPluginByIdRequestQuery & GetDereferencedPublicPluginByIdRequestParams;
+interface GetDereferencedPublicPluginByIdResponse {
+    plugin: {
+        /**
+         * ID of the [Plugin](#schema_plugin)
+         */
+        id: string;
+        /**
+         * Name of the [Plugin](#schema_plugin)
+         */
+        name: string;
+        /**
+         * Version of the [Plugin](#schema_plugin)
+         */
+        version: string;
+        /**
+         * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * Configuration definition
+         */
+        configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
+            /**
+             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+             */
+            schema: {
+                [k: string]: any;
+            };
+        };
+        states: {
+            [k: string]: {
+                /**
+                 * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
+                 */
+                type: "conversation" | "user" | "bot" | "task";
+                /**
+                 * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
+                 */
+                schema: {
+                    [k: string]: any;
+                };
+                /**
+                 * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
+                 */
+                expiry?: number;
+            };
+        };
+        events: {
+            /**
+             * Event Definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the event
+                 */
+                title?: string;
+                /**
+                 * Description of the event
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+                /**
+                 * Optional attributes
+                 */
+                attributes?: {
+                    [k: string]: string;
+                };
+            };
+        };
+        actions: {
+            /**
+             * Action definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the action
+                 */
+                title?: string;
+                /**
+                 * Description of the action
+                 */
+                description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
+                input: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
+                output: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
+                /**
+                 * Optional attributes
+                 */
+                attributes?: {
+                    [k: string]: string;
+                };
+            };
+        };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
+        /**
+         * User object configuration
+         */
+        user: {
+            tags: {
+                /**
+                 * Definition of a tag that can be provided on the object
+                 */
+                [k: string]: {
+                    /**
+                     * Title of the tag
+                     */
+                    title?: string;
+                    /**
+                     * Description of the tag
+                     */
+                    description?: string;
+                };
+            };
+        };
+        /**
+         * Conversation object configuration
+         */
+        conversation: {
+            tags: {
+                /**
+                 * Definition of a tag that can be provided on the object
+                 */
+                [k: string]: {
+                    /**
+                     * Title of the tag
+                     */
+                    title?: string;
+                    /**
+                     * Description of the tag
+                     */
+                    description?: string;
+                };
+            };
+        };
+        /**
+         * Optional attributes
+         */
+        attributes?: {
+            [k: string]: string;
+        };
+        /**
+         * Title of the plugin. This is the name that will be displayed in the UI
+         */
+        title: string;
+        /**
+         * Description of the plugin. This is the description that will be displayed in the UI
+         */
+        description: string;
+        /**
+         * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+         */
+        iconUrl: string;
+        /**
+         * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+         */
+        readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
+    };
+}
+
 interface GetPublicPluginRequestHeaders {
 }
 interface GetPublicPluginRequestQuery {
@@ -6360,6 +6588,10 @@ interface CreateBotResponse {
                 public: boolean;
             };
         };
+        /**
+         * Maximum execution time of the bot (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * User object configuration
          */
@@ -6637,6 +6869,10 @@ interface UpdateBotRequestBody {
         [k: string]: string;
     };
     blocked?: boolean;
+    /**
+     * Maximum execution time (in seconds).
+     */
+    maxExecutionTime?: number;
     /**
      * Indicates if the [Bot](#schema_bot) should be in always alive mode
      */
@@ -6775,6 +7011,10 @@ interface UpdateBotRequestBody {
     integrations?: {
         [k: string]: {
             enabled?: boolean;
+            /**
+             * Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance.
+             */
+            integrationId?: string;
             /**
              * Integration's configuration type. Set to default if null.
              */
@@ -6973,6 +7213,10 @@ interface UpdateBotResponse {
                 public: boolean;
             };
         };
+        /**
+         * Maximum execution time of the bot (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * User object configuration
          */
@@ -7280,6 +7524,7 @@ interface ListBotsResponse {
 interface GetBotRequestHeaders {
 }
 interface GetBotRequestQuery {
+    shouldMergePlugins?: boolean;
 }
 interface GetBotRequestParams {
     id: string;
@@ -7425,6 +7670,10 @@ interface GetBotResponse {
                 public: boolean;
             };
         };
+        /**
+         * Maximum execution time of the bot (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * User object configuration
          */
@@ -9128,9 +9377,13 @@ interface CreateIntegrationRequestBody {
         };
     };
     /**
-     * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
+     * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
      */
-    messageStatusChangeNotificationsEnabled?: boolean;
+    extraOperations?: {
+        [k: string]: {
+            enabled: boolean;
+        };
+    };
     /**
      * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
      */
@@ -9209,6 +9462,10 @@ interface CreateIntegrationResponse {
              */
             messageExtractScript?: string;
         };
+        /**
+         * Maximum execution time of the integration (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -9848,9 +10105,13 @@ interface ValidateIntegrationCreationRequestBody {
         };
     };
     /**
-     * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
+     * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
      */
-    messageStatusChangeNotificationsEnabled?: boolean;
+    extraOperations?: {
+        [k: string]: {
+            enabled: boolean;
+        };
+    };
     /**
      * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
      */
@@ -9952,9 +10213,13 @@ interface UpdateIntegrationRequestBody {
         } | null;
     };
     /**
-     * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
+     * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
      */
-    messageStatusChangeNotificationsEnabled?: boolean;
+    extraOperations?: {
+        [k: string]: {
+            enabled: boolean;
+        };
+    };
     channels?: {
         [k: string]: {
             /**
@@ -10024,6 +10289,10 @@ interface UpdateIntegrationRequestBody {
             };
         } | null;
     };
+    /**
+     * Maximum execution time of the integration (in seconds).
+     */
+    maxExecutionTime?: number;
     identifier?: {
         extractScript?: string | null;
         fallbackHandlerScript?: string | null;
@@ -10252,6 +10521,10 @@ interface UpdateIntegrationResponse {
              */
             messageExtractScript?: string;
         };
+        /**
+         * Maximum execution time of the integration (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -10655,9 +10928,13 @@ interface ValidateIntegrationUpdateRequestBody {
         } | null;
     };
     /**
-     * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
+     * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
      */
-    messageStatusChangeNotificationsEnabled?: boolean;
+    extraOperations?: {
+        [k: string]: {
+            enabled: boolean;
+        };
+    };
     channels?: {
         [k: string]: {
             /**
@@ -10727,6 +11004,10 @@ interface ValidateIntegrationUpdateRequestBody {
             };
         } | null;
     };
+    /**
+     * Maximum execution time of the integration (in seconds).
+     */
+    maxExecutionTime?: number;
     identifier?: {
         extractScript?: string | null;
         fallbackHandlerScript?: string | null;
@@ -11071,6 +11352,10 @@ interface GetIntegrationResponse {
              */
             messageExtractScript?: string;
         };
+        /**
+         * Maximum execution time of the integration (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -11494,6 +11779,10 @@ interface GetIntegrationByNameResponse {
              */
             messageExtractScript?: string;
         };
+        /**
+         * Maximum execution time of the integration (in seconds).
+         */
+        maxExecutionTime?: number;
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -13475,6 +13764,226 @@ interface GetPluginResponse {
     };
 }
 
+interface GetDereferencedPluginRequestHeaders {
+}
+interface GetDereferencedPluginRequestQuery {
+    /**
+     * Mapping of interface aliases to integration IDs
+     */
+    interfaces: {
+        /**
+         * integration id
+         */
+        [k: string]: string;
+    };
+}
+interface GetDereferencedPluginRequestParams {
+    id: string;
+}
+interface GetDereferencedPluginRequestBody {
+}
+type GetDereferencedPluginInput = GetDereferencedPluginRequestBody & GetDereferencedPluginRequestHeaders & GetDereferencedPluginRequestQuery & GetDereferencedPluginRequestParams;
+interface GetDereferencedPluginResponse {
+    plugin: {
+        /**
+         * ID of the [Plugin](#schema_plugin)
+         */
+        id: string;
+        /**
+         * Name of the [Plugin](#schema_plugin)
+         */
+        name: string;
+        /**
+         * Version of the [Plugin](#schema_plugin)
+         */
+        version: string;
+        /**
+         * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * Configuration definition
+         */
+        configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
+            /**
+             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+             */
+            schema: {
+                [k: string]: any;
+            };
+        };
+        states: {
+            [k: string]: {
+                /**
+                 * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
+                 */
+                type: "conversation" | "user" | "bot" | "task";
+                /**
+                 * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
+                 */
+                schema: {
+                    [k: string]: any;
+                };
+                /**
+                 * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
+                 */
+                expiry?: number;
+            };
+        };
+        events: {
+            /**
+             * Event Definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the event
+                 */
+                title?: string;
+                /**
+                 * Description of the event
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+                /**
+                 * Optional attributes
+                 */
+                attributes?: {
+                    [k: string]: string;
+                };
+            };
+        };
+        actions: {
+            /**
+             * Action definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the action
+                 */
+                title?: string;
+                /**
+                 * Description of the action
+                 */
+                description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
+                input: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
+                output: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
+                /**
+                 * Optional attributes
+                 */
+                attributes?: {
+                    [k: string]: string;
+                };
+            };
+        };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
+        /**
+         * User object configuration
+         */
+        user: {
+            tags: {
+                /**
+                 * Definition of a tag that can be provided on the object
+                 */
+                [k: string]: {
+                    /**
+                     * Title of the tag
+                     */
+                    title?: string;
+                    /**
+                     * Description of the tag
+                     */
+                    description?: string;
+                };
+            };
+        };
+        /**
+         * Conversation object configuration
+         */
+        conversation: {
+            tags: {
+                /**
+                 * Definition of a tag that can be provided on the object
+                 */
+                [k: string]: {
+                    /**
+                     * Title of the tag
+                     */
+                    title?: string;
+                    /**
+                     * Description of the tag
+                     */
+                    description?: string;
+                };
+            };
+        };
+        /**
+         * Optional attributes
+         */
+        attributes?: {
+            [k: string]: string;
+        };
+        /**
+         * Title of the plugin. This is the name that will be displayed in the UI
+         */
+        title: string;
+        /**
+         * Description of the plugin. This is the description that will be displayed in the UI
+         */
+        description: string;
+        /**
+         * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+         */
+        iconUrl: string;
+        /**
+         * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+         */
+        readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
+    };
+}
+
 interface GetPluginByNameRequestHeaders {
 }
 interface GetPluginByNameRequestQuery {
@@ -17093,6 +17602,7 @@ declare class Client$1 {
     readonly getPublicIntegration: (input: GetPublicIntegrationInput) => Promise<GetPublicIntegrationResponse>;
     readonly listPublicPlugins: (input: ListPublicPluginsInput) => Promise<ListPublicPluginsResponse>;
     readonly getPublicPluginById: (input: GetPublicPluginByIdInput) => Promise<GetPublicPluginByIdResponse>;
+    readonly getDereferencedPublicPluginById: (input: GetDereferencedPublicPluginByIdInput) => Promise<GetDereferencedPublicPluginByIdResponse>;
     readonly getPublicPlugin: (input: GetPublicPluginInput) => Promise<GetPublicPluginResponse>;
     readonly getPublicPluginCode: (input: GetPublicPluginCodeInput) => Promise<GetPublicPluginCodeResponse>;
     readonly listPublicInterfaces: (input: ListPublicInterfacesInput) => Promise<ListPublicInterfacesResponse>;
@@ -17168,6 +17678,7 @@ declare class Client$1 {
     readonly listInterfaces: (input: ListInterfacesInput) => Promise<ListInterfacesResponse>;
     readonly createPlugin: (input: CreatePluginInput) => Promise<CreatePluginResponse>;
     readonly getPlugin: (input: GetPluginInput) => Promise<GetPluginResponse>;
+    readonly getDereferencedPlugin: (input: GetDereferencedPluginInput) => Promise<GetDereferencedPluginResponse>;
     readonly getPluginByName: (input: GetPluginByNameInput) => Promise<GetPluginByNameResponse>;
     readonly updatePlugin: (input: UpdatePluginInput) => Promise<UpdatePluginResponse>;
     readonly deletePlugin: (input: DeletePluginInput) => Promise<DeletePluginResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cognitive",
-  "version": "0.1.29",
+  "version": "0.1.30",
   "description": "Wrapper around the Botpress Client to call LLMs",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",