feat(integrations/sdk): add bot secrets support and bump @botpress/api to 1.82.0

admin-openapi.json

@@ -8,7 +8,7 @@
   "info": {
     "title": "Botpress Admin API",
     "description": "API for Botpress Cloud Manager",
-    "version": "1.80.0"
+    "version": "1.82.0"
   },
   "paths": {
     "/v1/admin/helper/vrl": {
@@ -2860,6 +2860,52 @@
         ]
       }
     },
+    "/v1/admin/workspaces/{id}/migrate-to-v4": {
+      "post": {
+        "operationId": "migrateWorkspaceToV4",
+        "description": "Migrate a workspace from v3 to v4 billing. Not meant for public use.",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Workspace ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "x-multiple-integrations",
+            "in": "header",
+            "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/migrateWorkspaceToV4Response"
+          },
+          "default": {
+            "$ref": "#/components/responses/migrateWorkspaceToV4Response"
+          }
+        },
+        "requestBody": {
+          "$ref": "#/components/requestBodies/migrateWorkspaceToV4Body"
+        },
+        "x-mint": {
+          "metadata": {
+            "title": "migrateWorkspaceToV4"
+          }
+        },
+        "x-hidden": true,
+        "tags": [
+          "Endpoints"
+        ]
+      }
+    },
     "/v1/admin/workspaces/{id}/billing/invoices": {
       "get": {
         "operationId": "listWorkspaceInvoices",
@@ -6965,6 +7011,13 @@
             "type": "boolean",
             "description": "Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations"
           },
+          "secrets": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "List of secret names configured for this [Bot](#schema_bot)"
+          },
           "createdBy": {
             "type": "string",
             "description": "Id of the user that created the bot"
@@ -7023,6 +7076,7 @@
           "tags",
           "name",
           "dev",
+          "secrets",
           "alwaysAlive",
           "status",
           "medias"
@@ -13965,6 +14019,18 @@
           }
         }
       },
+      "migrateWorkspaceToV4Response": {
+        "description": "Success",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "title": "migrateWorkspaceToV4Response",
+              "additionalProperties": false
+            }
+          }
+        }
+      },
       "listWorkspaceInvoicesResponse": {
         "description": "Success",
         "content": {
@@ -17022,6 +17088,14 @@
                   "type": "string",
                   "description": "URL of the [Bot](#schema_bot)"
                 },
+                "secrets": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 20000
+                  },
+                  "description": "Secrets are 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."
+                },
                 "dev": {
                   "type": "boolean",
                   "description": "Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations"
@@ -17492,6 +17566,15 @@
                   },
                   "description": "Media files associated with the [Bot](#schema_bot)"
                 },
+                "secrets": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 20000,
+                    "nullable": true
+                  },
+                  "description": "Secrets are 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."
+                },
                 "layers": {
                   "type": "array",
                   "items": {
@@ -17671,6 +17754,18 @@
           }
         }
       },
+      "migrateWorkspaceToV4Body": {
+        "description": "No body required; migration uses workspace id only.",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "title": "migrateWorkspaceToV4Body",
+              "additionalProperties": false
+            }
+          }
+        }
+      },
       "chargeWorkspaceUnpaidInvoicesBody": {
         "description": "",
         "content": {

files-openapi.json

@@ -8,7 +8,7 @@
   "info": {
     "title": "Botpress Files API",
     "description": "API for Botpress Files",
-    "version": "1.80.0"
+    "version": "1.82.0"
   },
   "paths": {
     "/v1/files": {

integrations/sdk/cli-reference.mdx

@@ -148,7 +148,7 @@ bp serve --port 8080 --secrets SECRET1=value1 SECRET2=value2
 |------|-------------|---------|
 | `--work-dir` | Path to the project | current directory |
 | `--port` | Port to use | |
-| `--secrets` | Values for integration secrets (array) | |
+| `--secrets` | Values for bot and integration secrets (array) | |
 
 ---
 
@@ -170,7 +170,7 @@ bp dev --port 3000 --secrets API_KEY=secret123
 | `--api-url` | Botpress server URL | |
 | `--workspace-id` | Workspace ID | |
 | `--token` | Personal Access Token | |
-| `--secrets` | Values for integration secrets (array) | |
+| `--secrets` | Values for bot and integration secrets (array) | |
 | `--source-map` | Generate sourcemaps | false |
 | `--minify` | Minify the bundled code | true |
 | `--port` | Port to use | |
@@ -197,7 +197,7 @@ bp deploy --create-new-bot --no-build
 | `--api-url` | Botpress server URL | |
 | `--workspace-id` | Workspace ID | |
 | `--token` | Personal Access Token | |
-| `--secrets` | Values for integration secrets (array) | |
+| `--secrets` | Values for bot and integration secrets (array) | |
 | `--bot-id` | Bot ID to deploy (only for bots) | |
 | `--no-build` | Skip the build step | false |
 | `--dry-run` | Ask API not to perform actual operation | false |

package.json

@@ -8,7 +8,7 @@
     "generate-api-reference": "ts-node generate-api-reference.ts"
   },
   "dependencies": {
-    "@botpress/api": "1.80.0",
+    "@botpress/api": "1.82.0",
     "glob": "11.0.1",
     "mintlify": "^4.0.461",
     "optional": "^0.1.4"

runtime-openapi.json

@@ -8,7 +8,7 @@
   "info": {
     "title": "Botpress Runtime API",
     "description": "API for Botpress Runtime",
-    "version": "1.80.0"
+    "version": "1.82.0"
   },
   "paths": {
     "/v1/chat/conversations": {

tables-openapi.json

@@ -8,7 +8,7 @@
   "info": {
     "title": "Botpress Tables API",
     "description": "API for Botpress Tables",
-    "version": "1.80.0"
+    "version": "1.82.0"
   },
   "paths": {
     "/v1/tables": {