wtfai 1.0.0 → 1.0.1

package/README.md

@@ -10,6 +10,16 @@ npm install wtfai
 pnpm add wtfai
 ```
 
+## 使用前准备
+
+- 前往 `https://www.ourteacher.cc/` 联系客服申请开通 API 访问权限，获取 API Key；
+
+- 您的后端需要代理 `https://llm-api.ourschool.cc/workflows/` 开头的接口，在代理过程中需要给请求头添加 `x-tenant-secret`，值为 API Key；
+
+- 后续将 `baseUrl` 改为您的后端代理地址即可；
+
+- 为方便开发调试，前端可以在创建 Wtfai 实例时传入 `tenantSecret`，值为 API Key，切记不要在生产环境使用。
+
 ## 快速开始
 
 ```typescript
@@ -232,16 +242,20 @@ const url = await client.upload.uploadFile({
 })
 ```
 
-##### `uploadImage(file, resourceType, onProgress?)`
+##### `uploadImage(params)`
 
 上传图片（自动压缩）。
 
 ```typescript
-const url = await client.upload.uploadImage(
-  imageFile,
-  'conversation',
-  (percent) => console.log(`${percent * 100}%`),
-)
+const url = await client.upload.uploadImage({
+  file: imageFile,
+  resourceType: 'conversation',
+  onProgress: (percent) => console.log(`${percent * 100}%`),
+  compressOptions: {         // 可选
+    quality: 0.8,
+    maxWidth: 1920,
+  },
+})
 ```
 
 ---
@@ -304,7 +318,7 @@ interface SendInput {
 import { useState, useEffect, useRef } from 'react'
 import Wtfai, { type SimpleMessage, type WorkflowSession } from 'wtfai'
 
-const client = new W't'fa'i({
+const client = new Wtfai({
   baseUrl: 'https://api.example.com',
 })
 

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import type { Workflow, WorkflowListResponse } from '@our-llm/shared/workflow.types';
-import type { OurLLMClientConfig, SessionOptions } from './types';
+import type { ClientConfig, SessionOptions } from './types';
 import { WorkflowSession } from './session';
 import { UploadService } from './upload';
 /**
@@ -39,7 +39,7 @@ export declare class Wtfai {
      */
     readonly upload: UploadService;
     private readonly headers;
-    constructor(config: OurLLMClientConfig);
+    constructor(config: ClientConfig);
     /**
      * 获取工作流列表
      */

package/dist/client.js

@@ -1,23 +1,16 @@
 import { WorkflowSession } from "./session.js";
 import { UploadService } from "./upload.js";
+function _define_property(obj, key, value) {
+    if (key in obj) Object.defineProperty(obj, key, {
+        value: value,
+        enumerable: true,
+        configurable: true,
+        writable: true
+    });
+    else obj[key] = value;
+    return obj;
+}
 class Wtfai {
-    baseUrl;
-    uploadService;
-    upload;
-    headers;
-    constructor(config){
-        this.baseUrl = config.baseUrl.replace(/\/$/, '');
-        const headers = {
-            ...config.headers
-        };
-        if (config.tenantSecret) {
-            console.warn('%c[OurLLM SDK] ⚠️ Warning: tenantSecret is provided. This should ONLY be used for debugging purposes. DO NOT use in production.', 'color: red; font-weight: bold; font-size: 14px;');
-            headers['x-tenant-secret'] = config.tenantSecret;
-        }
-        this.headers = headers;
-        this.uploadService = new UploadService(this.baseUrl, this.headers);
-        this.upload = this.uploadService;
-    }
     async getWorkflows(page = 1, pageSize = 10) {
         const params = new URLSearchParams({
             current: String(page),
@@ -39,5 +32,22 @@ class Wtfai {
     createSession(workflowId, options) {
         return new WorkflowSession(workflowId, this.baseUrl, this.uploadService, this.headers, options);
     }
+    constructor(config){
+        _define_property(this, "baseUrl", void 0);
+        _define_property(this, "uploadService", void 0);
+        _define_property(this, "upload", void 0);
+        _define_property(this, "headers", void 0);
+        this.baseUrl = config.baseUrl.replace(/\/$/, '');
+        const headers = {
+            ...config.headers
+        };
+        if (config.tenantSecret) {
+            console.warn('%c[OurLLM SDK] ⚠️ Warning: tenantSecret is provided. This should ONLY be used for debugging purposes. DO NOT use in production.', 'color: red; font-weight: bold; font-size: 14px;');
+            headers['x-tenant-secret'] = config.tenantSecret;
+        }
+        this.headers = headers;
+        this.uploadService = new UploadService(this.baseUrl, this.headers);
+        this.upload = this.uploadService;
+    }
 }
 export { Wtfai };

package/dist/index.d.ts

@@ -2,6 +2,6 @@ import { Wtfai } from './client';
 export default Wtfai;
 export { WorkflowSession } from './session';
 export { UploadService } from './upload';
-export type { OurLLMClientConfig, SessionOptions, SessionState, SessionEventListeners, SendInput, UploadParams, CompressOptions, WorkflowInfo, } from './types';
+export type { ClientConfig, SessionOptions, SessionState, SessionEventListeners, SendInput, UploadParams, UploadImageParams, CompressOptions, WorkflowInfo, } from './types';
 export type { SimpleMessage } from '@our-llm/shared/workflow-events';
 export type { Workflow, WorkflowConfig } from '@our-llm/shared/workflow.types';

package/dist/session.js

@@ -1,31 +1,24 @@
 import { executeWorkflowSSE } from "./sse.js";
 import { v7 } from "uuid";
+function _define_property(obj, key, value) {
+    if (key in obj) Object.defineProperty(obj, key, {
+        value: value,
+        enumerable: true,
+        configurable: true,
+        writable: true
+    });
+    else obj[key] = value;
+    return obj;
+}
 class WorkflowSession {
-    workflowId;
-    baseUrl;
-    uploadService;
-    headers;
-    state = {
-        messages: [],
-        isExecuting: false
-    };
-    listeners = new Map();
-    abortController;
-    constructor(workflowId, baseUrl, uploadService, headers = {}, options = {}){
-        this.workflowId = workflowId;
-        this.baseUrl = baseUrl;
-        this.uploadService = uploadService;
-        this.headers = headers;
-        if (options.threadId) this.state.threadId = options.threadId;
-        else this.state.threadId = v7();
-    }
     on(event, listener) {
         if (!this.listeners.has(event)) this.listeners.set(event, new Set());
         this.listeners.get(event).add(listener);
         return this;
     }
     off(event, listener) {
-        this.listeners.get(event)?.delete(listener);
+        var _this_listeners_get;
+        null == (_this_listeners_get = this.listeners.get(event)) || _this_listeners_get.delete(listener);
         return this;
     }
     emit(event, ...args) {
@@ -72,7 +65,10 @@ class WorkflowSession {
                 text: input.content
             });
             if (input.images && input.images.length > 0) {
-                const imageUrls = await Promise.all(input.images.map((file)=>this.uploadService.uploadImage(file, 'conversation')));
+                const imageUrls = await Promise.all(input.images.map((file)=>this.uploadService.uploadImage({
+                        file,
+                        resourceType: 'conversation'
+                    })));
                 for (const url of imageUrls)contentParts.push({
                     type: 'image',
                     url
@@ -241,5 +237,25 @@ class WorkflowSession {
             });
         }
     }
+    constructor(workflowId, baseUrl, uploadService, headers = {}, options = {}){
+        _define_property(this, "workflowId", void 0);
+        _define_property(this, "baseUrl", void 0);
+        _define_property(this, "uploadService", void 0);
+        _define_property(this, "headers", void 0);
+        _define_property(this, "state", void 0);
+        _define_property(this, "listeners", void 0);
+        _define_property(this, "abortController", void 0);
+        this.workflowId = workflowId;
+        this.baseUrl = baseUrl;
+        this.uploadService = uploadService;
+        this.headers = headers;
+        this.state = {
+            messages: [],
+            isExecuting: false
+        };
+        this.listeners = new Map();
+        if (options.threadId) this.state.threadId = options.threadId;
+        else this.state.threadId = v7();
+    }
 }
 export { WorkflowSession };

package/dist/sse.js

@@ -12,11 +12,13 @@ async function executeWorkflowSSE(url, body, callbacks, headers = {}) {
         onmessage (msg) {
             const eventType = msg.event;
             if ('ok' === eventType) {
-                callbacks.onComplete?.();
+                var _callbacks_onComplete;
+                null == (_callbacks_onComplete = callbacks.onComplete) || _callbacks_onComplete.call(callbacks);
                 ctrl.abort();
             } else if ('err' === eventType) {
+                var _callbacks_onError;
                 const data = JSON.parse(msg.data);
-                callbacks.onError?.({
+                null == (_callbacks_onError = callbacks.onError) || _callbacks_onError.call(callbacks, {
                     message: data.m
                 });
                 ctrl.abort();
@@ -24,19 +26,24 @@ async function executeWorkflowSSE(url, body, callbacks, headers = {}) {
                 const data = JSON.parse(msg.data);
                 switch(eventType){
                     case 'ws':
-                        callbacks.onWorkflowStart?.(data);
+                        var _callbacks_onWorkflowStart;
+                        null == (_callbacks_onWorkflowStart = callbacks.onWorkflowStart) || _callbacks_onWorkflowStart.call(callbacks, data);
                         break;
                     case 'ns':
-                        callbacks.onNodeStart?.(data);
+                        var _callbacks_onNodeStart;
+                        null == (_callbacks_onNodeStart = callbacks.onNodeStart) || _callbacks_onNodeStart.call(callbacks, data);
                         break;
                     case 'ne':
-                        callbacks.onNodeEnd?.(data);
+                        var _callbacks_onNodeEnd;
+                        null == (_callbacks_onNodeEnd = callbacks.onNodeEnd) || _callbacks_onNodeEnd.call(callbacks, data);
                         break;
                     case 'tk':
-                        callbacks.onToken?.(data);
+                        var _callbacks_onToken;
+                        null == (_callbacks_onToken = callbacks.onToken) || _callbacks_onToken.call(callbacks, data);
                         break;
                     case 'l':
-                        callbacks.onLoading?.(data);
+                        var _callbacks_onLoading;
+                        null == (_callbacks_onLoading = callbacks.onLoading) || _callbacks_onLoading.call(callbacks, data);
                         break;
                 }
             } catch (e) {
@@ -44,14 +51,16 @@ async function executeWorkflowSSE(url, body, callbacks, headers = {}) {
             }
         },
         onerror (err) {
-            callbacks.onError?.({
+            var _callbacks_onError;
+            null == (_callbacks_onError = callbacks.onError) || _callbacks_onError.call(callbacks, {
                 message: String(err)
             });
             ctrl.abort();
             throw err;
         },
         onclose () {
-            callbacks.onComplete?.();
+            var _callbacks_onComplete;
+            null == (_callbacks_onComplete = callbacks.onComplete) || _callbacks_onComplete.call(callbacks);
             ctrl.abort();
         }
     });

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 /**
  * SDK 配置类型
  */
-export interface OurLLMClientConfig {
+export interface ClientConfig {
     /** API 服务器地址 */
     baseUrl: string;
     /** 请求超时时间（毫秒） */
@@ -29,6 +29,13 @@ export interface UploadParams {
     /** 上传进度回调 */
     onProgress?: (percent: number) => void;
 }
+/**
+ * 上传图片参数
+ */
+export interface UploadImageParams extends UploadParams {
+    /** 压缩选项 */
+    compressOptions?: CompressOptions;
+}
 /**
  * 图片压缩选项
  */

package/dist/upload.d.ts

@@ -1,4 +1,4 @@
-import type { UploadParams } from './types';
+import type { UploadParams, UploadImageParams } from './types';
 /**
  * 文件上传服务
  */
@@ -21,5 +21,5 @@ export declare class UploadService {
     /**
      * 上传图片（自动压缩）
      */
-    uploadImage(file: File, resourceType: 'conversation' | 'workflow' | 'knowledge-base', onProgress?: (percent: number) => void): Promise<string>;
+    uploadImage(params: UploadImageParams): Promise<string>;
 }

package/dist/upload.js

@@ -1,12 +1,16 @@
 import cos_js_sdk_v5 from "cos-js-sdk-v5";
 import compressorjs from "compressorjs";
+function _define_property(obj, key, value) {
+    if (key in obj) Object.defineProperty(obj, key, {
+        value: value,
+        enumerable: true,
+        configurable: true,
+        writable: true
+    });
+    else obj[key] = value;
+    return obj;
+}
 class UploadService {
-    baseUrl;
-    headers;
-    constructor(baseUrl, headers = {}){
-        this.baseUrl = baseUrl;
-        this.headers = headers;
-    }
     compressImage(file, options = {}) {
         const { quality = 0.8, maxWidth = 1920, maxHeight = 1920, convertSize = 1000000 } = options;
         return new Promise((resolve)=>{
@@ -91,13 +95,20 @@ class UploadService {
             });
         });
     }
-    async uploadImage(file, resourceType, onProgress) {
-        const compressedFile = await this.compressImage(file);
+    async uploadImage(params) {
+        const { file, resourceType, onProgress, compressOptions } = params;
+        const compressedFile = await this.compressImage(file, compressOptions);
         return this.uploadFile({
             file: compressedFile,
             resourceType,
             onProgress
         });
     }
+    constructor(baseUrl, headers = {}){
+        _define_property(this, "baseUrl", void 0);
+        _define_property(this, "headers", void 0);
+        this.baseUrl = baseUrl;
+        this.headers = headers;
+    }
 }
 export { UploadService };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wtfai",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "exports": {
     ".": {