@botpress/api 0.7.1 → 0.7.3

package/dist/index.js

@@ -68575,7 +68575,7 @@ var require_api2 = __commonJS({
     var QUOTE$1 = '"';
     var SLASH = "/";
     var STAR = "*";
-    var DEFAULT_OPTIONS = {
+    var DEFAULT_OPTIONS2 = {
       comments: false,
       ranges: false
     };
@@ -68599,7 +68599,7 @@ var require_api2 = __commonJS({
     }
     function tokenize(text, options) {
       options = Object.freeze({
-        ...DEFAULT_OPTIONS,
+        ...DEFAULT_OPTIONS2,
         ...options
       });
       let offset = -1;
@@ -258872,7 +258872,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.5.1_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_zod_openapi = __toESM(require_src(), 1);
 var import_zod_openapi2 = __toESM(require_src(), 1);
 var import_chalk = __toESM(require_source(), 1);
@@ -258916,7 +258916,7 @@ var title = (str2) => {
   return str2.split(/(?=[A-Z])|[\.\-\s_]/).map((s) => s.trim()).filter((s) => !!s).map((s) => capitalize(s.toLowerCase())).join(" ");
 };
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.5.1_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_decompress = __toESM(require_decompress(), 1);
 var import_fs2 = __toESM(require("fs"), 1);
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -265905,7 +265905,7 @@ async function openapiTS(schema3, options = {}) {
 }
 var dist_default = openapiTS;
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.5.1_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_zod_openapi3 = __toESM(require_src(), 1);
 var import_openapi3_ts = __toESM(require_dist3(), 1);
 var import_verror2 = __toESM(require_verror(), 1);
@@ -269500,7 +269500,7 @@ var z = /* @__PURE__ */ Object.freeze({
   ZodError
 });
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.5.1_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_openapi_parser = __toESM(require_lib11(), 1);
 var import_json_schema_to_typescript = __toESM(require_src3(), 1);
 var import_zod_openapi4 = __toESM(require_src(), 1);
@@ -424918,7 +424918,7 @@ function generateErrors(errors) {
   const types2 = errors.map((error2) => error2.type);
   return `
 import crypto from 'crypto'
-  
+
 const codes = {
 ${Object.entries(codes).map(([name, code]) => `  ${name}: ${code},`).join("\n")}
 } as const
@@ -424961,6 +424961,10 @@ abstract class BaseApiError<Code extends ErrorCode, Type extends string, Descrip
     }
   }
 
+  format() {
+    return \`[\${this.type}] \${this.message} (Error ID: \${this.id})\`
+  }
+
   toJSON() {
     return {
       id: this.id,
@@ -424969,7 +424973,7 @@ abstract class BaseApiError<Code extends ErrorCode, Type extends string, Descrip
       message: this.message,
     }
   }
-  
+
   static generateId() {
     const randomSuffixByteLength = 4
     const randomHexSuffix = Array.from(cryptoLib.getRandomValues(new Uint8Array(randomSuffixByteLength)))
@@ -425012,7 +425016,7 @@ function getApiErrorFromObject(err: any) {
     if (!ErrorClass) {
       return new UnknownError(\`An unclassified API error occurred: \${err.message} (Type: \${err.type}, Code: \${err.code})\`)
     }
-    
+
     return new ErrorClass(err.message, undefined, <string>err.id || 'UNKNOWN') // If error ID was not received do not pass undefined to generate a new one, flag it as UNKNOWN so we can fix the issue.
   }
 
@@ -425077,12 +425081,23 @@ function removeFromArray(array, item) {
     array.splice(index, 1);
   }
 }
-var generateSchemaFromZod = (zodRef, useOutput) => {
-  const jsonSchema = (0, import_zod_openapi3.generateSchema)(zodRef, useOutput);
-  formatJsonSchema(jsonSchema);
+function uniqueBy(array, k) {
+  const seen = /* @__PURE__ */ new Set();
+  return array.filter((item) => {
+    const v = item[k];
+    if (seen.has(v)) {
+      return false;
+    }
+    seen.add(v);
+    return true;
+  });
+}
+var generateSchemaFromZod = (zodRef, opts) => {
+  const jsonSchema = (0, import_zod_openapi3.generateSchema)(zodRef, opts == null ? void 0 : opts.useOutput);
+  formatJsonSchema(jsonSchema, (opts == null ? void 0 : opts.allowUnions) ?? false);
   return jsonSchema;
 };
-var formatJsonSchema = (jsonSchema) => {
+var formatJsonSchema = (jsonSchema, allowUnions) => {
   if (jsonSchema.type === "object") {
     if (jsonSchema.additionalProperties === void 0) {
       jsonSchema.additionalProperties = false;
@@ -425094,11 +425109,11 @@ var formatJsonSchema = (jsonSchema) => {
       delete jsonSchema.required;
     }
     if (typeof jsonSchema.additionalProperties === "object") {
-      formatJsonSchema(jsonSchema.additionalProperties);
+      formatJsonSchema(jsonSchema.additionalProperties, allowUnions);
     }
-    Object.entries(jsonSchema.properties ?? {}).forEach(([_, value]) => formatJsonSchema(value));
+    Object.entries(jsonSchema.properties ?? {}).forEach(([_, value]) => formatJsonSchema(value, allowUnions));
   }
-  if (jsonSchema.allOf || jsonSchema.anyOf || jsonSchema.oneOf) {
+  if (!allowUnions && (jsonSchema.allOf || jsonSchema.anyOf || jsonSchema.oneOf)) {
     throw new Error("allOf, anyOf and oneOf are not supported");
   }
 };
@@ -425125,6 +425140,7 @@ var objects;
     return result;
   };
 })(objects || (objects = {}));
+var DEFAULT_OPTIONS = { allowUnions: false };
 var unknownError = {
   status: 500,
   type: "Unknown",
@@ -425142,7 +425158,8 @@ function isOperationWithBodyProps(operation) {
   } else
     return false;
 }
-function createState(props) {
+function createState(props, opts = {}) {
+  const options = { ...DEFAULT_OPTIONS, ...opts };
   const schemaEntries = props.schemas ? Object.entries(props.schemas).map(([name, data]) => ({
     name,
     schema: data.schema,
@@ -425175,17 +425192,14 @@ function createState(props) {
     }
     schemas[name] = {
       section: schemaEntry.section,
-      schema: generateSchemaFromZod(schemaEntry.schema)
+      schema: generateSchemaFromZod(schemaEntry.schema, options)
     };
     refs.schemas[name] = true;
   });
-  const errors = [unknownError, internalError, ...props.errors ?? []];
-  const existingErrors = /* @__PURE__ */ new Set();
+  const userErrors = props.errors ?? [];
+  const defaultErrors = [unknownError, internalError];
+  const errors = uniqueBy([...defaultErrors, ...userErrors], "type");
   errors.forEach((error2) => {
-    if (existingErrors.has(error2.type)) {
-      throw new import_verror3.VError(`Error ${error2.type} already exists`);
-    }
-    existingErrors.add(error2.type);
     if (!isCapitalAlphabetical(error2.type)) {
       throw new import_verror3.VError(`Invalid error type ${error2.type}. It must be alphabetical and start with a capital letter`);
     }
@@ -425204,7 +425218,8 @@ function createState(props) {
     errors,
     refs,
     schemas,
-    sections
+    sections,
+    options
   };
 }
 function getRef(state2, type2, name) {
@@ -425397,6 +425412,16 @@ var composeFilesFromBlocks = (blocks, targetDirectory) => {
     }
   });
 };
+var generateSectionsFile = (state2, targetDirectory) => {
+  log_default.info("Generating sections file");
+  const sections = state2.sections.map((section) => section.name);
+  saveFile(
+    targetDirectory,
+    "sections.ts",
+    `export const sections = ${JSON.stringify(sections)} as const;
+ export type Sections = typeof sections[number];`
+  );
+};
 var getImportsForDependencies = (block, blocks) => {
   let content = "";
   if (Boolean(block.dependencies.length)) {
@@ -425574,6 +425599,7 @@ async function generateTypesBySection(state2, targetDirectory) {
     allBlocks.push(...blocks);
   }
   composeFilesFromBlocks(allBlocks, targetDirectory);
+  generateSectionsFile(state2, targetDirectory);
 }
 var generateServer = async (state2, dir, useExpressTypes) => {
   initDirectory(dir);
@@ -425740,7 +425766,7 @@ var addOperation = (state2, operationProps) => {
   const response = {
     description: operationProps.response.description,
     status: operationProps.response.status,
-    schema: generateSchemaFromZod((0, import_zod_openapi4.extendApi)(operationProps.response.schema, { title: responseName }))
+    schema: generateSchemaFromZod((0, import_zod_openapi4.extendApi)(operationProps.response.schema, { title: responseName }), state2.options)
   };
   let operation;
   if (isOperationWithBodyProps(operationProps)) {
@@ -425752,7 +425778,7 @@ var addOperation = (state2, operationProps) => {
       response,
       requestBody: {
         description: operationProps.requestBody.description,
-        schema: generateSchemaFromZod((0, import_zod_openapi4.extendApi)(operationProps.requestBody.schema, { title: bodyName }))
+        schema: generateSchemaFromZod((0, import_zod_openapi4.extendApi)(operationProps.requestBody.schema, { title: bodyName }), state2.options)
       }
     };
   } else {
@@ -425836,6 +425862,7 @@ var exportStateAsTypescript = (state2, dir) => {
 var schema2 = import_zod_openapi2.extendApi;
 var createOpapiFromState = (state2) => {
   return {
+    getState: () => state2,
     getModelRef: (name) => getRef(state2, "schemas", name),
     addOperation: (operationProps) => addOperation(state2, operationProps),
     exportClient: (dir = ".", openapiGeneratorEndpoint, postProcessors) => generateClient(state2, dir, openapiGeneratorEndpoint, postProcessors),
@@ -425846,8 +425873,8 @@ var createOpapiFromState = (state2) => {
     exportErrors: (dir = ".") => generateErrorsFile(state2.errors ?? [], dir)
   };
 };
-function OpenApi(props) {
-  const state2 = createState(props);
+function OpenApi(props, opts = {}) {
+  const state2 = createState(props, opts);
   return createOpapiFromState(state2);
 }
 ((OpenApi2) => {
@@ -428322,6 +428349,206 @@ var state = {
         }
       }
     },
+    listWorkspaceUsages: {
+      name: "listWorkspaceUsages",
+      description: "List workspace usages",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/usages",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        },
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usages: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Usage"
+              }
+            }
+          },
+          required: ["usages"],
+          title: "listWorkspaceUsagesResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    getWorkspaceQuota: {
+      name: "getWorkspaceQuota",
+      description: "Get workspace quota",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/quota",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        },
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            quota: {
+              type: "object",
+              properties: {
+                period: {
+                  type: "string",
+                  description: "Period of the quota that it is applied to"
+                },
+                value: {
+                  type: "number",
+                  description: "Value of the quota that is used"
+                },
+                type: {
+                  type: "string",
+                  enum: [
+                    "invocation_timeout",
+                    "invocation_calls",
+                    "storage_count",
+                    "bot_count",
+                    "knowledgebase_vector_count",
+                    "bot_ratelimit",
+                    "table_row_count",
+                    "workspace_member_count"
+                  ],
+                  description: "Usage type that can be used"
+                }
+              },
+              required: ["period", "value", "type"],
+              additionalProperties: false
+            }
+          },
+          required: ["quota"],
+          title: "getWorkspaceQuotaResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listWorkspaceQuotas: {
+      name: "listWorkspaceQuotas",
+      description: "List workspace quotas",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/quotas",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            quotas: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  period: {
+                    type: "string",
+                    description: "Period of the quota that it is applied to"
+                  },
+                  value: {
+                    type: "number",
+                    description: "Value of the quota that is used"
+                  },
+                  type: {
+                    type: "string",
+                    enum: [
+                      "invocation_timeout",
+                      "invocation_calls",
+                      "storage_count",
+                      "bot_count",
+                      "knowledgebase_vector_count",
+                      "bot_ratelimit",
+                      "table_row_count",
+                      "workspace_member_count"
+                    ],
+                    description: "Usage type that can be used"
+                  }
+                },
+                required: ["period", "value", "type"]
+              }
+            }
+          },
+          required: ["quotas"],
+          title: "listWorkspaceQuotasResponse",
+          additionalProperties: false
+        }
+      }
+    },
     updateWorkspace: {
       name: "updateWorkspace",
       description: "Update workspace",
@@ -429825,6 +430052,102 @@ var state = {
         }
       }
     },
+    getUsage: {
+      name: "getUsage",
+      path: "/v1/admin/usages/{id}",
+      description: "Get usage",
+      method: "get",
+      section: "usage",
+      parameters: {
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        },
+        id: {
+          type: "string",
+          description: "id of a bot or a workspace depending on the usage type",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usage: {
+              $ref: "#/components/schemas/Usage"
+            }
+          },
+          required: ["usage"],
+          title: "getUsageResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listUsageHistory: {
+      name: "listUsageHistory",
+      path: "/v1/admin/usages/{id}/history",
+      method: "get",
+      description: "Get usage history",
+      parameters: {
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        id: {
+          type: "string",
+          description: "id of a bot or a workspace depending on the usage type",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usages: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Usage"
+              }
+            }
+          },
+          required: ["usages"],
+          title: "listUsageHistoryResponse",
+          additionalProperties: false
+        }
+      }
+    },
     introspect: {
       name: "introspect",
       description: "Introspect the API",
@@ -430043,7 +430366,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.7.1",
+    version: "0.7.3",
     prefix: "v1"
   },
   errors: [
@@ -430143,7 +430466,7 @@ var state = {
       description: "A payment is required to perform this request."
     },
     {
-      status: 429,
+      status: 403,
       type: "QuotaExceeded",
       description: "The request exceeds the allowed quota. Quotas are a soft limit that can be increased."
     },
@@ -430229,6 +430552,9 @@ var state = {
       getBotAnalyticsResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
+      listWorkspaceUsagesResponse: true,
+      getWorkspaceQuotaResponse: true,
+      listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
       listWorkspacesResponse: true,
       changeWorkspacePlanResponse: true,
@@ -430245,6 +430571,8 @@ var state = {
       getIntegrationLogsResponse: true,
       getIntegrationByNameResponse: true,
       deleteIntegrationResponse: true,
+      getUsageResponse: true,
+      listUsageHistoryResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -430258,6 +430586,7 @@ var state = {
       Workspace: true,
       WorkspaceMember: true,
       Account: true,
+      Usage: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -431048,6 +431377,46 @@ var state = {
         additionalProperties: false
       }
     },
+    Usage: {
+      section: "usage",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+            description: "Id of the usage that it is linked to. It can either be a workspace id or a bot id"
+          },
+          period: {
+            type: "string",
+            description: "Period of the quota that it is applied to"
+          },
+          value: {
+            type: "number",
+            description: "Value of the current usage"
+          },
+          quota: {
+            type: "number",
+            description: "Quota of the current usage"
+          },
+          type: {
+            type: "string",
+            enum: [
+              "invocation_timeout",
+              "invocation_calls",
+              "storage_count",
+              "bot_count",
+              "knowledgebase_vector_count",
+              "bot_ratelimit",
+              "table_row_count",
+              "workspace_member_count"
+            ],
+            description: "Usage type that can be used"
+          }
+        },
+        required: ["id", "period", "value", "quota", "type"],
+        additionalProperties: false
+      }
+    },
     User: {
       section: "user",
       schema: {
@@ -431439,6 +431808,9 @@ var state = {
       operations: [
         "createWorkspace",
         "getWorkspace",
+        "listWorkspaceUsages",
+        "getWorkspaceQuota",
+        "listWorkspaceQuotas",
         "updateWorkspace",
         "listWorkspaces",
         "changeWorkspacePlan",
@@ -431470,8 +431842,18 @@ var state = {
         "deletePersonalAccessToken"
       ],
       schema: "Account"
+    },
+    {
+      description: "",
+      title: "Usage",
+      name: "usage",
+      operations: ["getUsage"],
+      schema: "Usage"
     }
-  ]
+  ],
+  options: {
+    allowUnions: false
+  }
 };
 
 // src/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -22,6 +22,6 @@
     "zod": "^3.20.6"
   },
   "dependencies": {
-    "@bpinternal/opapi": "0.3.4"
+    "@bpinternal/opapi": "^0.5.1"
   }
 }