@glodon-aiot/bot-client-sdk 3.3.0-beta.13

package/dist/src/Session.d.ts

@@ -0,0 +1,222 @@
+import { ChatMessageRole, IApplication, IChatMessage, ICommentParam, ISession, ISessionPrompt, CVForceApi, ChatHistoryParams, IKnowledge } from '@glodon-aiot/apis';
+import { MCPConfig } from './Config';
+import { Socket } from 'socket.io-client';
+import { default as EventBus } from './EventBus';
+import { ActionPayload, PluginFunctionBasic, Thought } from './PayloadTypes';
+import { default as BotClient } from './BotClient';
+export declare enum NetOpen {
+    enable = 1,
+    disable = 2
+}
+export interface QuestionBody {
+    content: string;
+    stream: boolean;
+    requestId?: string;
+    fileIds?: string[];
+    oldMessageId?: string;
+    referenceFirst?: boolean;
+}
+export interface QuestionConfig {
+    stream?: boolean;
+    referenceFirst?: boolean;
+    formatValues?: any;
+    oldMessageId?: string;
+}
+type ActionPayloadBasic = ActionPayload<PluginFunctionBasic & Thought>;
+export type SessionEventName = 'init' | 'ready' | 'activated' | 'inactivated' | 'frozen' | 'data:loading' | 'data:loaded' | 'data:updating' | 'data:updated' | 'data:updated:promptVariables' | 'data:updated:knowledges' | 'data:creating' | 'data:created' | 'data:deleting' | 'data:deleted' | 'socket:connect' | 'socket:disconnect' | 'error' | 'destroy' | 'history:loading' | 'history:loaded' | 'history:moreloading' | 'history:moreloaded' | 'history:add' | 'message:new' | 'message:updated' | 'message:action' | 'message:content' | 'message:reference' | 'message:relatedQuesion:loading' | 'message:relatedQuesion:loaded' | 'message:comment' | 'message:error' | 'answer:finish';
+export declare enum SessionErrors {
+    DataRequestFailed = "data request error",
+    SocketConnectionFailed = "socket error",
+    IdUndefined = "session id is not defined",
+    SendingEmptyContent = "failed at sending empty content",
+    Frozen = "session is frozen",
+    UserModeError = "failed at setting socket user mode",
+    Inactive = "session is inactive"
+}
+export declare const SESSION_ERROR_CAUSE: {
+    "session id is not defined": {
+        code: number;
+        message: string;
+    };
+    "failed at sending empty content": {
+        code: number;
+        message: string;
+    };
+    "session is frozen": {
+        code: number;
+        message: string;
+    };
+};
+export default abstract class Session {
+    protected token: string;
+    protected lazyload?: boolean | undefined;
+    protected _id?: string;
+    protected _frozen: boolean;
+    protected inactivating: boolean;
+    protected _ready: boolean;
+    protected event: EventBus;
+    _applicationId: string;
+    _application: IApplication | null;
+    data: ISession | null;
+    readonly client: BotClient | null;
+    messages: IChatMessage[];
+    protected _loadingMessages: boolean;
+    protected _loadingMessagesSize: number;
+    cvforceApi: CVForceApi;
+    socket: Socket | null;
+    protected _promptVariables: ISessionPrompt[];
+    protected active: boolean;
+    protected activing: boolean;
+    protected _stopAnswer: boolean;
+    private _dataLoading;
+    private _dataLoaded;
+    protected _mcpServers: MCPConfig | null;
+    /**
+     * Session 类的构造函数，用于初始化会话实例。
+     * @param token - 用户的身份验证令牌，用于解析应用 ID。
+     * @param _id - 会话的 ID，可选参数，默认为空字符串。
+     * @param _data - 会话的初始数据，可选参数，包含提示变量、知识库等信息。
+     * @param lazyload - 是否懒加载数据，可选参数，默认为 undefined。
+     * @param _application - 应用信息，可选参数。
+     * @param client - Bot 客户端实例，可选参数。
+     */
+    constructor(token: string, _id?: string, _data?: Partial<ISession & {
+        promptVariables?: Partial<ISessionPrompt>[];
+    }>, lazyload?: boolean | undefined, _application?: IApplication, client?: BotClient);
+    fetchData(): Promise<ISession>;
+    get id(): string;
+    get applicationId(): string;
+    get application(): IApplication | null;
+    set application(v: IApplication | null);
+    loadApplicationInfo(): Promise<IApplication>;
+    get ready(): boolean;
+    get frozen(): boolean;
+    protected set frozen(v: boolean);
+    get knowledges(): IKnowledge[] | undefined;
+    setKnowledges(knowledges?: IKnowledge[]): Promise<IKnowledge[] | undefined>;
+    validateConfigs(): void;
+    get promptVariables(): ISessionPrompt[];
+    setPromptVariables(v: ISessionPrompt[]): Promise<ISessionPrompt[]>;
+    get netOpen(): boolean;
+    /**
+     * 异步设置会话的网络访问开关状态
+     * @param v - 布尔值，表示是否开启网络访问，true 为开启，false 为关闭
+     * @returns 如果设置成功，返回最终的网络访问开关状态；若不满足设置条件，则提前返回 undefined
+     */
+    setNetOpen(v: boolean): Promise<boolean | undefined>;
+    private getService;
+    addEventListener(eventName: SessionEventName, callback: any, once?: boolean): void;
+    removeEventListener(eventName: SessionEventName, callback: any): void;
+    /**
+     * 获取对话记录
+     * @param params ChatHistoryParams
+     * @returns Promise<false|Message[]>
+     */
+    fetchMessages(params?: ChatHistoryParams): Promise<false | {
+        actions: ActionPayloadBasic[][];
+        relatedQuesion: string[] | undefined;
+        ts?: string;
+        messageId: string;
+        content: string;
+        role: ChatMessageRole;
+        userId?: string;
+        sessionId: string;
+        reference: import('@glodon-aiot/apis').IReference[];
+        searchReference: import('@glodon-aiot/apis').ISearchRefernce[];
+        comment?: import('@glodon-aiot/apis/dist/src/cvforce').ICommentParam;
+        knowledges?: IKnowledge[];
+        isLoading?: boolean;
+        messageTime: string;
+        fileId?: string;
+        file?: import('@glodon-aiot/apis/dist/src/cvforce').KnowledgeFileMetadata;
+        chatMode?: import('@glodon-aiot/apis').ChatMode;
+        llmModel?: string;
+        isContext?: boolean;
+        index?: number;
+        agentHistoryList?: {
+            agentList: string;
+            createdAt: string;
+            creator: string;
+            deletedAt: string;
+            id: string;
+            updatedAt: string;
+        };
+        finish?: boolean;
+        code?: number;
+        isSensitive?: boolean;
+        message?: string;
+        stream?: boolean;
+        fileIds?: string[];
+        isReplying?: boolean;
+        files?: import('@glodon-aiot/apis').ChatMessageFile[];
+        thinkingSecs?: number;
+        thinkingStatus?: "end" | "start";
+        reasoningContent?: string;
+        searchingStatus?: "start" | "end";
+    }[]>;
+    rename(name: string): Promise<boolean>;
+    protected pushMessage(message: IChatMessage): Promise<void>;
+    reloadSessionInfo(): Promise<this>;
+    reload(): Promise<unknown>;
+    delete(): Promise<string | false>;
+    activate(): Promise<unknown>;
+    inactivate(immediately?: boolean): boolean;
+    abstract prepareConnection(): Promise<boolean>;
+    abstract sendQuestion(params: QuestionBody, configs: QuestionConfig): any;
+    abstract stopAnswer(): any;
+    abstract registerMcpFromClientConfig(): Promise<boolean>;
+    abstract addMcpServers(mcpServers: MCPConfig): Promise<boolean>;
+    abstract listMcpServers(): Promise<MCPConfig>;
+    get dataLoaded(): boolean;
+    get messagesLoading(): boolean;
+    send(params: {
+        text?: string;
+        uuid?: string;
+        fileIds?: string[];
+    }, configs?: QuestionConfig): Promise<false | {
+        sessionId: string;
+        role: number;
+        content: string;
+        messageId: string;
+        reference: never[];
+        searchReference: never[];
+        messageTime: string;
+    }>;
+    protected getRelatedQuesion(message: IChatMessage): Promise<IChatMessage>;
+    protected fillMessageReference(message: IChatMessage): Promise<IChatMessage>;
+    answerAgain(configs?: QuestionConfig): Promise<void>;
+    setTop(top: boolean): Promise<void>;
+    /**
+     * 暂停当前会话的回答过程
+     * 该方法会停止当前回答，标记回答停止状态，处理正在进行的消息和操作，
+     * 并根据情况更新消息内容或添加新的系统消息。
+     * @returns 返回当前会话实例
+     */
+    suspend(): this | undefined;
+    /**
+     * 异步提交评论信息
+     * @param params - 评论参数，包含评论相关的信息，如消息 ID 等
+     * @returns 返回调用 API 提交评论后的响应结果
+     */
+    postMessageComment(params: ICommentParam): Promise<string>;
+    /**
+     * 清除当前会话的上下文信息
+     * 该方法会调用 API 清除指定会话的上下文，并在操作成功后触发相应事件
+     * @returns 如果会话 ID 存在且清除操作成功，返回一个解析为 true 的 Promise；若会话 ID 不存在，抛出错误
+     */
+    clear(): Promise<boolean>;
+    /**
+     * 销毁当前会话实例，执行清理操作并触发销毁事件
+     * @returns 返回当前会话的 ID，如果会话 ID 不存在则返回空字符串
+     */
+    destroy(): string;
+}
+export declare class DialogSession extends Session {
+    prepareConnection(): Promise<boolean>;
+    sendQuestion(params: QuestionBody, configs: QuestionConfig): Promise<void>;
+    stopAnswer(): void;
+    registerMcpFromClientConfig(): Promise<boolean>;
+    addMcpServers(mcpServers: MCPConfig): Promise<boolean>;
+    listMcpServers(): Promise<MCPConfig>;
+}
+export {};

package/dist/src/__ tests __/AgentClient.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/__ tests __/AgentSession.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/__ tests __/DialogClient.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/api/fetchEventSource/fetch.d.ts

@@ -0,0 +1,44 @@
+import { EventSourceMessage } from './parse';
+export declare const EventStreamContentType = "text/event-stream";
+export interface FetchEventSourceInit extends RequestInit {
+    /**
+     * The request headers. FetchEventSource only supports the Record<string,string> format.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Called when a response is received. Use this to validate that the response
+     * actually matches what you expect (and throw if it doesn't.) If not provided,
+     * will default to a basic validation to ensure the content-type is text/event-stream.
+     */
+    onopen?: (response: Response) => Promise<void>;
+    /**
+     * Called when a message is received. NOTE: Unlike the default browser
+     * EventSource.onmessage, this callback is called for _all_ events,
+     * even ones with a custom `event` field.
+     */
+    onmessage?: (ev: EventSourceMessage) => void;
+    /**
+     * Called when a response finishes. If you don't expect the server to kill
+     * the connection, you can throw an exception here and retry using onerror.
+     */
+    onclose?: () => void;
+    /**
+     * Called when there is any error making the request / processing messages /
+     * handling callbacks etc. Use this to control the retry strategy: if the
+     * error is fatal, rethrow the error inside the callback to stop the entire
+     * operation. Otherwise, you can return an interval (in milliseconds) after
+     * which the request will automatically retry (with the last-event-id).
+     * If this callback is not specified, or it returns undefined, fetchEventSource
+     * will treat every error as retriable and will try again after 1 second.
+     */
+    onerror?: (err: any) => number | null | undefined | void;
+    /**
+     * If true, will keep the request open even if the document is hidden.
+     * By default, fetchEventSource will close the request and reopen it
+     * automatically when the document becomes visible again.
+     */
+    openWhenHidden?: boolean;
+    /** The Fetch function to use. Defaults to window.fetch */
+    fetch?: typeof fetch;
+}
+export declare function fetchEventSource(input: RequestInfo, { signal: inputSignal, headers: inputHeaders, onopen: inputOnOpen, onmessage, onclose, onerror, openWhenHidden, fetch: inputFetch, ...rest }: FetchEventSourceInit): Promise<void>;

package/dist/src/api/fetchEventSource/index.d.ts

@@ -0,0 +1 @@
+export * from './fetch';

package/dist/src/api/fetchEventSource/parse.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Represents a message sent in an event stream
+ * https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format
+ */
+export interface EventSourceMessage {
+    /** The event ID to set the EventSource object's last event ID value. */
+    id: string;
+    /** A string identifying the type of event described. */
+    event: string;
+    /** The event data */
+    data: string;
+    /** The reconnection interval (in milliseconds) to wait before retrying the connection */
+    retry?: number;
+}
+/**
+ * Converts a ReadableStream into a callback pattern.
+ * @param stream The input ReadableStream.
+ * @param onChunk A function that will be called on each new byte chunk in the stream.
+ * @returns {Promise<void>} A promise that will be resolved when the stream closes.
+ */
+export declare function getBytes(stream: ReadableStream<Uint8Array>, onChunk: (arr: Uint8Array) => void): Promise<void>;
+/**
+ * Parses arbitary byte chunks into EventSource line buffers.
+ * Each line should be of the format "field: value" and ends with \r, \n, or \r\n.
+ * @param onLine A function that will be called on each new EventSource line.
+ * @returns A function that should be called for each incoming byte chunk.
+ */
+export declare function getLines(onLine: (line: Uint8Array, fieldLength: number, isWrap: boolean) => void): (arr: Uint8Array) => void;
+/**
+ * Parses line buffers into EventSourceMessages.
+ * @param onId A function that will be called on each `id` field.
+ * @param onRetry A function that will be called on each `retry` field.
+ * @param onMessage A function that will be called on each message.
+ * @returns A function that should be called for each incoming line buffer.
+ */
+export declare function getMessages(onId: (id: string) => void, onRetry: (retry: number) => void, onMessage?: (msg: EventSourceMessage) => void): (line: Uint8Array, fieldLength: number, isWrap: boolean) => void;

package/dist/src/api/index.d.ts

@@ -0,0 +1,2 @@
+import { CVForceApi } from '@glodon-aiot/apis';
+export declare function getCVForceService(apiBase: string, token: string, errorHandler: (status: number, message: string) => void): CVForceApi;

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+export type { AgentPluginRegistor, AgentPluginMap, MCPConfig, McpServer } from './Config';
+export { configure, configuration } from './Config';
+export { default as BotClient } from './BotClient';
+export { default as Session } from './Session';
+export { default as AgentPlugin } from './AgentPlugin';

package/dist/src/utils.d.ts

@@ -0,0 +1,4 @@
+export declare const parseJWT: (token: string) => any;
+export declare const isExpired: (token: string) => boolean;
+export declare const removeNewlines: (str: string) => string;
+export declare const removeLeadingAndTrailingBackslashes: (str: string) => string;

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@glodon-aiot/bot-client-sdk",
+  "version": "3.3.0-beta.13",
+  "author": "glodoncv",
+  "description": "aiot bot client js sdk",
+  "type": "module",
+  "sideEffects": false,
+  "keywords": [
+    "aiot",
+    "bot",
+    "bot client",
+    "sdk"
+  ],
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/es/index.mjs",
+  "main": "./dist/lib/index.js",
+  "typings": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/es/index.mjs",
+      "require": "./dist/lib/index.js",
+      "types": "./dist/src/index.d.ts"
+    }
+  },
+  "license": "MIT",
+  "scripts": {
+    "watch": "yarn build --watch",
+    "example": "node ./example/server.js",
+    "dev": "npm-run-all -p watch example",
+    "start": "vite",
+    "build": "tsc && vite build --mode prod && yarn build:cdn",
+    "build:npm": "tsc && vite build --mode prod",
+    "build:cdn": "tsc && vite build --mode prod --config ./vite.config.cdn.ts",
+    "preview": "vite preview",
+    "check": "yarn prettier --check .",
+    "write": "yarn prettier --write .",
+    "lint": "eslint --ext .tsx,.ts --fix ./example -c .eslintrc.js"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/express": "^4",
+    "@types/identity-obj-proxy": "^3",
+    "@typescript-eslint/eslint-plugin": "^5.35.1",
+    "@typescript-eslint/parser": "^5.35.1",
+    "babel-loader": "^8.3.0",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard-with-typescript": "^22.0.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-react": "^7.31.0",
+    "eslint-plugin-storybook": "^0.6.10",
+    "express": "4",
+    "http-proxy-middleware": "^3.0.0",
+    "identity-obj-proxy": "^3.0.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "2.7.1",
+    "rollup-plugin-visualizer": "^6.0.1",
+    "socket.io": "^4.7.5",
+    "ts-node": "^10.9.2",
+    "typescript": "*",
+    "vite": "^4.1.1",
+    "vite-plugin-dts": "^4.3.0",
+    "vite-plugin-externalize-deps": "^0.9.0",
+    "vite-tsconfig-paths": "^5.1.4"
+  },
+  "lint-staged": {
+    "*.{js,css,md,jsx,less,ts,tsx,json}": "prettier --write"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@glodon-aiot/apis": "^3.3.0-beta.13",
+    "axios": "0.24.0",
+    "buffer": "^6.0.3",
+    "dayjs": "^1.11.13",
+    "js-base64": "^3.7.7",
+    "socket.io-client": "^4.7.5",
+    "uuid": "^11.1.0"
+  }
+}