@botpress/client 0.20.1 → 0.22.0

package/dist/types.d.ts

@@ -1,19 +1,19 @@
 /// <reference types="node" />
 import { Client as AutoGeneratedClient } from './gen';
-import { CreateFileInput } from './gen/operations/createFile';
+import { UpsertFileInput } from './gen/operations/upsertFile';
 import { GetFileResponse } from './gen/operations/getFile';
 export type { Message, Conversation, User, State, Event, File, Bot, Integration, Issue, IssueEvent, Account, Workspace, Usage, } from './gen/models';
-type CreateAndUploadFileInput = Omit<CreateFileInput, 'size'> & {
+type UploadFileInput = Omit<UpsertFileInput, 'size'> & {
     content?: Buffer | string;
     url?: string;
 };
-type CreateAndUploadFileOutput = GetFileResponse;
+type UploadFileOutput = GetFileResponse;
 type Simplify<T> = T extends (...args: infer A) => infer R ? (...args: Simplify<A>) => Simplify<R> : T extends Promise<infer R> ? Promise<Simplify<R>> : T extends Buffer ? Buffer : T extends object ? T extends infer O ? {
     [K in keyof O]: Simplify<O[K]>;
 } : never : T;
 type AsyncFunc = (...args: any[]) => Promise<any>;
 export type IClient = Simplify<AutoGeneratedClient & {
-    createAndUploadFile: (input: CreateAndUploadFileInput) => Promise<CreateAndUploadFileOutput>;
+    uploadFile: (input: UploadFileInput) => Promise<UploadFileOutput>;
 }>;
 export type Operation = Simplify<keyof {
     [K in keyof IClient as IClient[K] extends AsyncFunc ? K : never]: IClient[K];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/client",
-  "version": "0.20.1",
+  "version": "0.22.0",
   "description": "Botpress Client",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -30,7 +30,7 @@
     "type-fest": "^3.4.0"
   },
   "devDependencies": {
-    "@botpress/api": "0.29.3",
+    "@botpress/api": "0.31.0",
     "@types/qs": "^6.9.7",
     "esbuild": "^0.16.12",
     "lodash": "^4.17.21",

package/tests/manual/file-upload.test.ts

@@ -9,7 +9,7 @@ import { describe, expect, it } from 'vitest'
  */
 import { Client } from '../../src'
 
-describe('createAndUploadFile', () => {
+describe('uploadFile', () => {
   const client = new Client({
     apiUrl: 'http://localhost:5986',
     botId: '87e67c78-e5d3-4cf7-97de-82b1f3907879',
@@ -17,34 +17,34 @@ describe('createAndUploadFile', () => {
   })
 
   it('works with a buffer', async () => {
-    const response = await client.createAndUploadFile({
-      name: 'test.txt',
+    const response = await client.uploadFile({
+      key: 'test.txt',
       content: Buffer.from('aaa'),
     })
 
-    expect(response.file.name).toBe('test.txt')
+    expect(response.file.key).toBe('test.txt')
     expect(response.file.status).toBe('upload_completed')
     expect(response.file.url, 'File URL should have been returned').toBeTruthy()
   })
 
   it('works with plain text', async () => {
-    const response = await client.createAndUploadFile({
-      name: 'test.txt',
+    const response = await client.uploadFile({
+      key: 'test.txt',
       content: 'aaa',
     })
 
-    expect(response.file.name).toBe('test.txt')
+    expect(response.file.key).toBe('test.txt')
     expect(response.file.status).toBe('upload_completed')
     expect(response.file.url, 'File URL should have been returned').toBeTruthy()
   })
 
   it('works with a URL', async () => {
-    const response = await client.createAndUploadFile({
-      name: 'whatsapp-banner.png',
+    const response = await client.uploadFile({
+      key: 'whatsapp-banner.png',
       url: 'https://docs.botpress.cloud/docs/content/whatsapp-banner.png',
     })
 
-    expect(response.file.name).toBe('whatsapp-banner.png')
+    expect(response.file.key).toBe('whatsapp-banner.png')
     expect(response.file.status).toBe('upload_completed')
     expect(response.file.url, 'File URL should have been returned').toBeTruthy()
   })