feat(client): bump api version and support get or set state operation (botpress#13011)

Author: franklevasseur

.gitignore

@@ -8,4 +8,5 @@ __snapshots__
 .ignore.me.*
 .env
 .botpress
-.botpresshome
+.botpresshome
+.botpresshome.*

.prettierignore

@@ -21,3 +21,4 @@ gen
 dist
 .botpress
 .botpresshome
+.botpresshome.*

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/cli",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Botpress CLI",
   "scripts": {
     "build": "pnpm run bundle && pnpm run template:gen",
@@ -20,7 +20,7 @@
   },
   "main": "dist/index.js",
   "dependencies": {
-    "@botpress/client": "0.11.4",
+    "@botpress/client": "0.11.5",
     "@bpinternal/const": "^0.0.20",
     "@bpinternal/tunnel": "^0.1.1",
     "@bpinternal/yargs-extra": "^0.0.3",
@@ -49,7 +49,7 @@
     "zod": "^3.20.6"
   },
   "devDependencies": {
-    "@botpress/sdk": "0.6.0",
+    "@botpress/sdk": "0.6.1",
     "@bpinternal/log4bot": "^0.0.4",
     "@types/bluebird": "^3.5.38",
     "@types/json-schema": "^7.0.11",

packages/cli/templates/echo-bot/package.json

@@ -8,8 +8,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.11.4",
-    "@botpress/sdk": "0.6.0",
+    "@botpress/client": "0.11.5",
+    "@botpress/sdk": "0.6.1",
     "zod": "^3.20.6"
   },
   "devDependencies": {

packages/cli/templates/empty-integration/package.json

@@ -8,8 +8,8 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.11.4",
-    "@botpress/sdk": "0.6.0",
+    "@botpress/client": "0.11.5",
+    "@botpress/sdk": "0.6.1",
     "zod": "^3.20.6"
   },
   "devDependencies": {

packages/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/client",
-  "version": "0.11.4",
+  "version": "0.11.5",
   "description": "Botpress Client",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -21,7 +21,7 @@
     "type-fest": "^3.4.0"
   },
   "devDependencies": {
-    "@botpress/api": "0.17.0",
+    "@botpress/api": "0.18.0",
     "esbuild": "^0.16.12"
   }
 }

packages/sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Botpress SDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -14,7 +14,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.11.4",
+    "@botpress/client": "0.11.5",
     "zod": "^3.20.6"
   },
   "devDependencies": {

packages/sdk/src/bot/client/index.ts

@@ -34,12 +34,18 @@ export class BotSpecificClient<TBot extends BaseBot> {
   public updateUser: routes.UpdateUser<TBot> = (x) => this.client.updateUser(x)
   public deleteUser: routes.DeleteUser<TBot> = (x) => this.client.deleteUser(x)
 
-  public getState: routes.GetState<TBot> = (x) =>
-    this.client.getState(x).then((y) => ({ state: { ...y.state, payload: y.state.payload as any } }))
-  public setState: routes.SetState<TBot> = (x) =>
-    this.client.setState(x).then((y) => ({ state: { ...y.state, payload: y.state.payload as any } }))
-  public patchState: routes.PatchState<TBot> = (x) =>
-    this.client.patchState(x).then((y) => ({ state: { ...y.state, payload: y.state.payload as any } }))
+  public getState: routes.GetState<TBot> = ((x) =>
+    this.client.getState(x).then((y) => ({ state: { ...y.state, payload: y.state.payload } }))) as routes.GetState<TBot>
+  public setState: routes.SetState<TBot> = ((x) =>
+    this.client.setState(x).then((y) => ({ state: { ...y.state, payload: y.state.payload } }))) as routes.SetState<TBot>
+  public getOrSetState: routes.GetOrSetState<TBot> = ((x) =>
+    this.client
+      .getOrSetState(x)
+      .then((y) => ({ state: { ...y.state, payload: y.state.payload } }))) as routes.GetOrSetState<TBot>
+  public patchState: routes.PatchState<TBot> = ((x) =>
+    this.client
+      .patchState(x)
+      .then((y) => ({ state: { ...y.state, payload: y.state.payload } }))) as routes.PatchState<TBot>
 
   public callAction: routes.CallAction<TBot> = (x) => this.client.callAction(x)
 

packages/sdk/src/bot/client/routes.ts

@@ -90,6 +90,23 @@ export type SetState<TBot extends BaseBot> = <TState extends keyof TBot['states'
   >
 }>
 
+export type GetOrSetState<TBot extends BaseBot> = <TState extends keyof TBot['states']>(
+  x: Merge<
+    Arg<Client['getOrSetState']>,
+    {
+      name: Cast<TState, string> // TODO: use state name to infer state type (cannot be done until there is a bot.definition.ts file)
+      payload: TBot['states'][TState]
+    }
+  >
+) => Promise<{
+  state: Merge<
+    Awaited<Res<Client['getOrSetState']>>['state'],
+    {
+      payload: TBot['states'][TState]
+    }
+  >
+}>
+
 export type PatchState<TBot extends BaseBot> = <TState extends keyof TBot['states']>(
   x: Merge<
     Arg<Client['patchState']>,

packages/sdk/src/integration/client/index.ts

@@ -55,6 +55,8 @@ export class IntegrationSpecificClient<TIntegration extends BaseIntegration> {
 
   public getState: routes.GetState<TIntegration> = ((x) => this.client.getState(x)) as routes.GetState<TIntegration>
   public setState: routes.SetState<TIntegration> = ((x) => this.client.setState(x)) as routes.SetState<TIntegration>
+  public getOrSetState: routes.GetOrSetState<TIntegration> = ((x) =>
+    this.client.getOrSetState(x)) as routes.GetOrSetState<TIntegration>
   public patchState: routes.PatchState<TIntegration> = ((x) =>
     this.client.patchState(x)) as routes.PatchState<TIntegration>
 

packages/sdk/src/integration/client/routes.ts

@@ -235,6 +235,16 @@ export type SetState<TIntegration extends BaseIntegration> = <TState extends key
   >
 ) => Promise<StateResponse<TIntegration, TState>>
 
+export type GetOrSetState<TIntegration extends BaseIntegration> = <TState extends keyof TIntegration['states']>(
+  x: Merge<
+    Arg<Client['getOrSetState']>,
+    {
+      name: Cast<TState, string> // TODO: use state name to infer state type
+      payload: TIntegration['states'][TState]
+    }
+  >
+) => Promise<StateResponse<TIntegration, TState>>
+
 export type PatchState<TIntegration extends BaseIntegration> = <TState extends keyof TIntegration['states']>(
   x: Merge<
     Arg<Client['patchState']>,