@botpress/api 0.29.1 → 0.29.3

package/dist/index.js

@@ -251507,7 +251507,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.15_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.17_openapi-types@12.1.3/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_path = __toESM(require("path"), 1);
@@ -251553,7 +251553,7 @@ var title = (str2) => {
   return str2.split(/(?=[A-Z])|[\.\-\s_]/).map((s2) => s2.trim()).filter((s2) => !!s2).map((s2) => capitalize(s2.toLowerCase())).join(" ");
 };
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.15_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.17_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_decompress = __toESM(require_decompress(), 1);
 var import_fs3 = __toESM(require("fs"), 1);
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -254470,7 +254470,7 @@ var {
   mergeConfig: mergeConfig2
 } = axios_default;
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.15_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.17_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_json_schema_to_typescript = __toESM(require_src3(), 1);
 var import_fs4 = __toESM(require("fs"), 1);
 var import_path3 = __toESM(require("path"), 1);
@@ -258806,7 +258806,7 @@ async function openapiTS(schema3, options = {}) {
 }
 var dist_default = openapiTS;
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.15_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.17_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_openapi3_ts = __toESM(require_dist3(), 1);
 var import_verror2 = __toESM(require_verror(), 1);
 var import_verror3 = __toESM(require_verror(), 1);
@@ -262447,7 +262447,7 @@ var z = /* @__PURE__ */ Object.freeze({
   ZodError
 });
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.15_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.10.17_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_openapi_parser = __toESM(require_lib10(), 1);
 var import_json_schema_to_typescript2 = __toESM(require_src3(), 1);
 var import_zod_openapi4 = __toESM(require_src(), 1);
@@ -262904,7 +262904,8 @@ var client_node_exports = {};
 __export2(client_node_exports, {
   generateIndex: () => generateIndex,
   generateModels: () => generateModels,
-  generateOperations: () => generateOperations
+  generateOperations: () => generateOperations,
+  generateToAxios: () => generateToAxios
 });
 var entries = (obj) => Object.entries(obj);
 function filterObject(obj, fn) {
@@ -263239,16 +263240,18 @@ function getError(err: Error) {
   return errorFrom(err)
 }
 `;
-var GET_AXIOS_REQ_FUNCTION = `// ensures axios request is properly formatted
-type Primitive = string | number | boolean
-type Value<P extends Primitive> = P | P[] | Record<string, P>
-type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined
-type AnyQueryParams = Record<string, QueryValue>
-type HeaderValue = string | undefined
-type AnyHeaderParams = Record<string, HeaderValue>
-type AnyBodyParams = Record<string, any>
+var GET_AXIOS_REQ_FUNCTION = `
+import { AxiosRequestConfig } from "axios"
+import qs from "qs"
 
-type ParsedRequest = {
+export type Primitive = string | number | boolean
+export type Value<P extends Primitive> = P | P[] | Record<string, P>
+export type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined
+export type AnyQueryParams = Record<string, QueryValue>
+export type HeaderValue = string | undefined
+export type AnyHeaderParams = Record<string, HeaderValue>
+export type AnyBodyParams = Record<string, any>
+export type ParsedRequest = {
   method: string
   path: string
   query: AnyQueryParams
@@ -263259,7 +263262,7 @@ type ParsedRequest = {
 const isDefined = <T>(pair: [string, T | undefined]): pair is [string, T] => pair[1] !== undefined
 
 export const toAxiosRequest = (req: ParsedRequest): AxiosRequestConfig => {
-  const { method, path: url, query, headers: headerParams, body: data } = req
+  const { method, path, query, headers: headerParams, body: data } = req
 
   // prepare headers
   const headerEntries: [string, string][] = Object.entries(headerParams).filter(isDefined)
@@ -263267,13 +263270,13 @@ export const toAxiosRequest = (req: ParsedRequest): AxiosRequestConfig => {
 
   // prepare query params
   const queryString = qs.stringify(query, { encode: true, arrayFormat: 'repeat', allowDots: true })
-  const params = new URLSearchParams(queryString)
+
+  const url = queryString ? [path, queryString].join('?') : path
 
   return {
     method,
     url,
     headers,
-    params,
     data,
   }
 }
@@ -263389,13 +263392,16 @@ ${responseCode}`;
     await writeTs(file, code);
   }
 };
+var generateToAxios = async (toAxiosFile) => {
+  await writeTs(toAxiosFile, GET_AXIOS_REQ_FUNCTION);
+};
 var generateIndex = async (state2, indexFile) => {
   const operationsByName = import_lodash.default.mapKeys(state2.operations, (v) => v.name);
   let indexCode = [
     `${HEADER}`,
-    "import qs from 'qs'",
-    "import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'",
+    "import axios, { AxiosInstance } from 'axios'",
     "import { errorFrom } from './errors'",
+    "import { toAxiosRequest } from './to-axios'",
     ""
   ].join("\n");
   for (const [name] of Object.entries(operationsByName)) {
@@ -263409,14 +263415,21 @@ var generateIndex = async (state2, indexFile) => {
 `;
   }
   indexCode += "\n";
+  indexCode += [
+    "export type ClientProps = {",
+    "  toAxiosRequest: typeof toAxiosRequest",
+    "}"
+  ].join("\n");
+  indexCode += "\n\n";
   indexCode += "export class Client {\n\n";
-  indexCode += "constructor(private axiosInstance: AxiosInstance) {}\n\n";
+  indexCode += "  public constructor(private axiosInstance: AxiosInstance, private props: Partial<ClientProps> = {}) {}\n\n";
   for (const [name, operation] of Object.entries(operationsByName)) {
     const { inputName, resName } = Names.of(name);
     indexCode += [
       `  public readonly ${name} = async (input: ${name}.${inputName}): Promise<${name}.${resName}> => {`,
       `    const { path, headers, query, body } = ${name}.parseReq(input)`,
-      `    const axiosReq = toAxiosRequest({`,
+      `    const mapper = this.props.toAxiosRequest ?? toAxiosRequest`,
+      `    const axiosReq = mapper({`,
       `        method: "${operation.method}",`,
       "        path,",
       "        headers: { ...headers },",
@@ -263431,8 +263444,6 @@ var generateIndex = async (state2, indexFile) => {
   }
   indexCode += "}\n\n";
   indexCode += `${GET_ERROR_FUNCTION}
-`;
-  indexCode += `${GET_AXIOS_REQ_FUNCTION}
 `;
   await writeTs(indexFile, indexCode);
 };
@@ -264208,14 +264219,17 @@ var generateClientWithOpapi = async (state2, dir) => {
   const errorsFile = import_path.default.join(dir, "errors.ts");
   const indexFile = import_path.default.join(dir, "index.ts");
   const operationsDir = import_path.default.join(dir, "operations");
+  const toAxiosFile = import_path.default.join(dir, "to-axios.ts");
   import_fs.default.mkdirSync(operationsDir, { recursive: true });
   log_default.info("Generating models");
   await client_node_exports.generateModels(state2, modelsFile);
   log_default.info("Generating operations");
   await client_node_exports.generateOperations(state2, operationsDir);
-  log_default.info("generating errors file");
+  log_default.info("Generating errors file");
   const errorsFileContent = generateErrors(state2.errors ?? []);
   await import_fs.default.promises.writeFile(errorsFile, errorsFileContent);
+  log_default.info("Generating to-axios file");
+  await client_node_exports.generateToAxios(toAxiosFile);
   log_default.info("Generating index file");
   await client_node_exports.generateIndex(state2, indexFile);
 };
@@ -273085,7 +273099,7 @@ var state = {
     "createFile": {
       "name": "createFile",
       "path": "/v1/files",
-      "description": "Creates a file.",
+      "description": "Creates a file. Once the file is created, use the uploadUrl from the response body to upload the file content, using a PUT request.",
       "method": "post",
       "requestBody": {
         "description": "The file to upload.",
@@ -273202,18 +273216,18 @@ var state = {
                 "status": {
                   "type": "string",
                   "enum": [
-                    "UPLOAD_PENDING",
-                    "UPLOAD_FAILED",
-                    "UPLOAD_COMPLETED",
-                    "INDEXING_PENDING",
-                    "INDEXING_FAILED",
-                    "INDEXING_COMPLETED"
+                    "upload_pending",
+                    "upload_failed",
+                    "upload_completed",
+                    "indexing_pending",
+                    "indexing_failed",
+                    "indexing_completed"
                   ],
-                  "description": 'Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.'
+                  "description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
                 },
                 "failedStatusReason": {
                   "type": "string",
-                  "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
+                  "description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
                 },
                 "uploadUrl": {
                   "type": "string",
@@ -273363,18 +273377,18 @@ var state = {
                   "status": {
                     "type": "string",
                     "enum": [
-                      "UPLOAD_PENDING",
-                      "UPLOAD_FAILED",
-                      "UPLOAD_COMPLETED",
-                      "INDEXING_PENDING",
-                      "INDEXING_FAILED",
-                      "INDEXING_COMPLETED"
+                      "upload_pending",
+                      "upload_failed",
+                      "upload_completed",
+                      "indexing_pending",
+                      "indexing_failed",
+                      "indexing_completed"
                     ],
-                    "description": 'Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.'
+                    "description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
                   },
                   "failedStatusReason": {
                     "type": "string",
-                    "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
+                    "description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
                   }
                 },
                 "required": [
@@ -273495,18 +273509,18 @@ var state = {
                 "status": {
                   "type": "string",
                   "enum": [
-                    "UPLOAD_PENDING",
-                    "UPLOAD_FAILED",
-                    "UPLOAD_COMPLETED",
-                    "INDEXING_PENDING",
-                    "INDEXING_FAILED",
-                    "INDEXING_COMPLETED"
+                    "upload_pending",
+                    "upload_failed",
+                    "upload_completed",
+                    "indexing_pending",
+                    "indexing_failed",
+                    "indexing_completed"
                   ],
-                  "description": 'Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.'
+                  "description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
                 },
                 "failedStatusReason": {
                   "type": "string",
-                  "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
+                  "description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
                 }
               },
               "required": [
@@ -273646,18 +273660,18 @@ var state = {
                 "status": {
                   "type": "string",
                   "enum": [
-                    "UPLOAD_PENDING",
-                    "UPLOAD_FAILED",
-                    "UPLOAD_COMPLETED",
-                    "INDEXING_PENDING",
-                    "INDEXING_FAILED",
-                    "INDEXING_COMPLETED"
+                    "upload_pending",
+                    "upload_failed",
+                    "upload_completed",
+                    "indexing_pending",
+                    "indexing_failed",
+                    "indexing_completed"
                   ],
-                  "description": 'Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.'
+                  "description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
                 },
                 "failedStatusReason": {
                   "type": "string",
-                  "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
+                  "description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
                 }
               },
               "required": [
@@ -274693,7 +274707,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.29.1",
+    "version": "0.29.3",
     "prefix": "v1"
   },
   "errors": [
@@ -277210,18 +277224,18 @@ var state = {
           "status": {
             "type": "string",
             "enum": [
-              "UPLOAD_PENDING",
-              "UPLOAD_FAILED",
-              "UPLOAD_COMPLETED",
-              "INDEXING_PENDING",
-              "INDEXING_FAILED",
-              "INDEXING_COMPLETED"
+              "upload_pending",
+              "upload_failed",
+              "upload_completed",
+              "indexing_pending",
+              "indexing_failed",
+              "indexing_completed"
             ],
-            "description": 'Status of the file. If the status is "UPLOAD_PENDING", the file content has not been uploaded yet. The status will be set to "UPLOAD_COMPLETED" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "UPLOAD_FAILED" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "INDEXING_PENDING" status (the "UPLOAD_COMPLETED" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "INDEXING_COMPLETED". If the indexing failed the status will be set to "INDEXING_FAILED" and the reason for the failure will be available in the `failedStatusReason` field.'
+            "description": 'Status of the file. If the status is "upload_pending", the file content has not been uploaded yet. The status will be set to "upload_completed" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to "upload_failed" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the "indexing_pending" status (the "upload_completed" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to "indexing_completed". If the indexing failed the status will be set to "indexing_failed" and the reason for the failure will be available in the `failedStatusReason` field.'
           },
           "failedStatusReason": {
             "type": "string",
-            "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
+            "description": 'If the file status is "upload_failed" or "indexing_failed" this will contain the reason of the failure.'
           }
         },
         "required": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.29.1",
+  "version": "0.29.3",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {
@@ -23,6 +23,6 @@
     "zod": "^3.22.4"
   },
   "dependencies": {
-    "@bpinternal/opapi": "0.10.15"
+    "@bpinternal/opapi": "0.10.17"
   }
 }