@botpress/client 0.14.2 → 0.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/client",
-  "version": "0.14.2",
+  "version": "0.16.0",
   "description": "Botpress Client",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -20,7 +20,8 @@
     "build": "pnpm build:type && pnpm build:node && pnpm build:browser && pnpm build:bundle",
     "generate": "ts-node ./openapi.ts",
     "test": "pnpm run e2e:test",
-    "e2e:test": "ts-node -T ./e2e/node.ts && ts-node -T ./e2e/browser"
+    "test:manual": "vitest tests/manual/file-upload",
+    "e2e:test": "ts-node -T ./tests/e2e/node.ts && ts-node -T ./tests/e2e/browser"
   },
   "dependencies": {
     "axios": "^1.6.1",
@@ -28,11 +29,12 @@
     "type-fest": "^3.4.0"
   },
   "devDependencies": {
-    "@botpress/api": "0.26.2",
+    "@botpress/api": "0.27.7",
     "esbuild": "^0.16.12",
     "lodash": "^4.17.21",
     "puppeteer": "^22.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.4",
+    "vitest": "^0.33.0"
   }
 }

package/{e2e → tests/e2e}/browser/script.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import { Client, errorFrom } from '../../src'
+import { Client, errorFrom } from '../../../src'
 import * as consts from '../consts'
 
 const exit = (code: 0 | 1) => {

package/{e2e → tests/e2e}/node.ts

@@ -1,4 +1,4 @@
-import { Client, errorFrom } from '../src'
+import { Client, errorFrom } from '../../src'
 
 const main = async () => {
   const client = new Client()

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

@@ -0,0 +1,29 @@
+import { describe, expect, it } from 'vitest'
+
+/**
+ * This a test to be run manually to test the custom file creation/upload method added in the client.
+ *
+ * Follow these steps to run it:
+ *   1. Run Tilt on the Skynet repository using the `files-api` mode and make sure a "DEV_BYPASS_USAGE_CHECKS" env var with a string value of "true" is passed to the `files-api` Tilt resource so that we can use the predefined bot ID below.
+ *   2. Then run `pnpm test:manual` in the terminal to run this test.
+ */
+import { Client } from '../../src'
+
+describe('createAndUploadFile', () => {
+  it('works as expected', async () => {
+    const client = new Client({
+      apiUrl: 'http://localhost:5986',
+      botId: '87e67c78-e5d3-4cf7-97de-82b1f3907879',
+      token: 'bp_pat_abcdefghijklmnopqrstuvwxyz0123456789',
+    })
+
+    const response = await client.createAndUploadFile({
+      name: 'test.txt',
+      data: Buffer.from('aaa'),
+    })
+
+    expect(response.file.name).toBe('test.txt')
+    expect(response.file.status).toBe('UPLOAD_COMPLETED')
+    expect(response.file.url, 'File URL should have been returned').toBeTruthy()
+  })
+})