@botpress/client 0.19.0 → 0.20.1

package/dist/types.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import { Client as AutoGeneratedClient } from './gen';
+import { CreateFileInput } from './gen/operations/createFile';
+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'> & {
+    content?: Buffer | string;
+    url?: string;
+};
+type CreateAndUploadFileOutput = 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>;
+}>;
+export type Operation = Simplify<keyof {
+    [K in keyof IClient as IClient[K] extends AsyncFunc ? K : never]: IClient[K];
+}>;
+/**
+ * @deprecated Use ClientInputs instead
+ */
+export type ClientParams<T extends Operation> = Simplify<Parameters<IClient[T]>[0]>;
+/**
+ * @deprecated Use ClientOutputs instead
+ */
+export type ClientReturn<T extends Operation> = Simplify<Awaited<ReturnType<IClient[T]>>>;
+export type ClientInputs = Simplify<{
+    [T in Operation]: Parameters<IClient[T]>[0];
+}>;
+export type ClientOutputs = Simplify<{
+    [T in Operation]: Awaited<ReturnType<IClient[T]>>;
+}>;
+type Headers = Record<string, string | string[]>;
+export type ClientProps = {
+    integrationId?: string;
+    workspaceId?: string;
+    botId?: string;
+    token?: string;
+    apiUrl?: string;
+    timeout?: number;
+    headers?: Headers;
+};
+export type ClientConfig = {
+    apiUrl: string;
+    headers: Headers;
+    withCredentials: boolean;
+    timeout: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/client",
-  "version": "0.19.0",
+  "version": "0.20.1",
   "description": "Botpress Client",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/readme.md

@@ -13,9 +13,9 @@ pnpm add @botpress/client # for pnpm
 ## Usage
 
 ```ts
-import { Client, ClientReturn } from '@botpress/client'
+import { Client, ClientOutputs } from '@botpress/client'
 
-type Bot = ClientReturn<'listBots'>['bots'][number]
+type Bot = ClientOutputs['listBots']['bots'][number]
 
 const main = async () => {
   const token = 'your-token'

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

@@ -19,7 +19,7 @@ describe('createAndUploadFile', () => {
   it('works with a buffer', async () => {
     const response = await client.createAndUploadFile({
       name: 'test.txt',
-      data: Buffer.from('aaa'),
+      content: Buffer.from('aaa'),
     })
 
     expect(response.file.name).toBe('test.txt')
@@ -30,7 +30,7 @@ describe('createAndUploadFile', () => {
   it('works with plain text', async () => {
     const response = await client.createAndUploadFile({
       name: 'test.txt',
-      data: 'aaa',
+      content: 'aaa',
     })
 
     expect(response.file.name).toBe('test.txt')