@botpress/sdk 4.0.7 → 4.2.0

package/dist/integration/definition/index.d.ts

@@ -57,7 +57,7 @@ type ChannelsOfPackage<TPackage extends InterfacePackage> = {
         [M in keyof NonNullable<TPackage['definition']['channels']>[K]['messages']]: NonNullable<NonNullable<TPackage['definition']['channels']>[K]['messages']>[M]['schema'];
     };
 };
-export type ActionOverrideProps = utils.types.AtLeastOneProperty<Pick<Required<ActionDefinition>, 'title' | 'description' | 'billable' | 'cacheable'> & {
+export type ActionOverrideProps = utils.types.AtLeastOneProperty<Pick<Required<ActionDefinition>, 'title' | 'description' | 'billable' | 'cacheable' | 'attributes'> & {
     name: string;
 }>;
 export type EventOverrideProps = utils.types.AtLeastOneProperty<Pick<Required<EventDefinition>, 'title' | 'description'> & {

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

@@ -47,6 +47,7 @@ export type ActionDefinition<TAction extends BaseActions[string] = BaseActions[s
     output: SchemaDefinition<ZuiObjectSchema>;
     billable?: boolean;
     cacheable?: boolean;
+    attributes?: Record<string, string>;
 };
 export type StateType = 'integration' | 'conversation' | 'user';
 export type StateDefinition<TState extends BaseStates[string] = BaseStates[string]> = SchemaDefinition<TState> & {

package/dist/interface/definition.d.ts

@@ -29,10 +29,15 @@ type GenericActionDefinition<TEntities extends BaseEntities, TAction extends Bas
     output: {
         schema: GenericZuiSchema<EntityReferences<TEntities>, ZuiObjectSchema>;
     };
+    attributes?: Record<string, string>;
 };
 export type InterfaceDefinitionProps<TName extends string = string, TVersion extends string = string, TEntities extends BaseEntities = BaseEntities, TActions extends BaseActions = BaseActions, TEvents extends BaseEntities = BaseEntities, TChannels extends BaseChannels = BaseChannels> = {
     name: TName;
     version: TVersion;
+    title?: string;
+    description?: string;
+    icon?: string;
+    readme?: string;
     entities?: {
         [K in keyof TEntities]: EntityDefinition<TEntities[K]>;
     };
@@ -50,6 +55,10 @@ export declare class InterfaceDefinition<TName extends string = string, TVersion
     readonly props: InterfaceDefinitionProps<TName, TVersion, TEntities, TActions, TEvents, TChannels>;
     readonly name: this['props']['name'];
     readonly version: this['props']['version'];
+    readonly title: this['props']['title'];
+    readonly description: this['props']['description'];
+    readonly icon: this['props']['icon'];
+    readonly readme: this['props']['readme'];
     readonly entities: {
         [K in keyof TEntities]: EntityDefinition<TEntities[K]>;
     };

package/dist/{const.d.ts → public-consts.d.ts}

@@ -6,3 +6,11 @@ export declare const configurationTypeHeader = "x-bp-configuration-type";
 export declare const configurationHeader = "x-bp-configuration";
 export declare const operationHeader = "x-bp-operation";
 export declare const typeHeader = "x-bp-type";
+export declare const WELL_KNOWN_ATTRIBUTES: {
+    readonly HIDDEN_IN_STUDIO: {
+        readonly bpActionHiddenInStudio: "true";
+    };
+    readonly AWAIT_RETURN: {
+        readonly bpActionAwaitReturn: "true";
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "4.0.7",
+  "version": "4.2.0",
   "description": "Botpress SDK",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -16,7 +16,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "1.5.0",
+    "@botpress/client": "1.7.0",
     "browser-or-node": "^2.1.1"
   },
   "devDependencies": {