@glodon-aiot/agent-cli-sdk 2.4.7 → 3.0.4

package/dist/src/AgentSession.d.ts

@@ -1,7 +1,8 @@
-import { ISession } from '@glodon-aiot/apis';
-import { default as Session, QuestionBody, QuestionConfig } from './Session';
+import { IApplication, ISession } from '@glodon-aiot/apis';
+import Session, { QuestionBody, QuestionConfig } from './Session';
+import BotClient from './BotClient';
 export default class AgentSession extends Session {
-    constructor(token: string, _id?: string, _data?: Partial<ISession>, lazyload?: boolean);
+    constructor(token: string, _id?: string, _data?: Partial<ISession>, lazyload?: boolean, application?: IApplication, client?: BotClient);
     prepareConnection(): Promise<boolean>;
     sendQuestion(questionBody: QuestionBody, configs: QuestionConfig): Promise<false | undefined>;
     stopAnswer(): void;

package/dist/src/BotClient.d.ts

@@ -1,7 +1,7 @@
-import { default as Session } from './Session';
+import Session from './Session';
 import { BotClientConfig } from './Config';
-import { IApplication, IPrompt, ISession, SessionQueryParams } from '@glodon-aiot/apis';
-import { default as EventBus } from './EventBus';
+import { IApplication, IPrompt, ISession, ISessionPrompt, SessionQueryParams } from '@glodon-aiot/apis';
+import EventBus from './EventBus';
 export type ClientEventName = 'ready' | 'application:loaded';
 export default class BotClient {
     private _token;
@@ -35,8 +35,10 @@ export default class BotClient {
     set activeSession(sessionId: string);
     private createSession;
     getSessions(queryParams?: SessionQueryParams): Promise<Session[]>;
-    loadSession(sessionId?: string, sessionParams?: Partial<ISession>): Promise<Session>;
-    reload(): Promise<void>;
+    loadSession(sessionId?: string, sessionParams?: Partial<ISession & {
+        promptVariables?: ISessionPrompt[];
+    }>): Promise<Session>;
+    reload(): Promise<this>;
     reloadSession(sessionId?: string): Promise<Session | undefined>;
     setTop(sessionId: string, top: boolean, order?: string): Promise<Session[] | undefined>;
     addEventListener(eventName: ClientEventName, callback: any, once?: boolean): void;

package/dist/src/DialogSession.d.ts

@@ -1,8 +1,9 @@
-import { ISession } from '@glodon-aiot/apis';
-import { default as Session, QuestionBody, QuestionConfig } from './Session';
+import { IApplication, ISession } from '@glodon-aiot/apis';
+import Session, { QuestionBody, QuestionConfig } from './Session';
+import BotClient from './BotClient';
 export default class DialogSession extends Session {
     private ctrl;
-    constructor(token: string, _id?: string, _data?: Partial<ISession>, lazyload?: boolean);
+    constructor(token: string, _id?: string, _data?: Partial<ISession>, lazyload?: boolean, application?: IApplication, client?: BotClient);
     prepareConnection(): Promise<boolean>;
     postChatV2EventSource(applicationId: string, sessionId: string, params: any, signal: AbortSignal, options: {
         onopen?: any;

package/dist/src/Session.d.ts

@@ -1,8 +1,14 @@
-import { ChatMessageRole, IChatMessage, ISession, ISessionPrompt, CVForceApi } from '@glodon-aiot/apis';
+import { ChatMessageRole, IApplication, IChatMessage, ICommentParam, ISession, ISessionPrompt } from '@glodon-aiot/apis';
 import { Socket } from 'socket.io-client';
-import { default as EventBus } from './EventBus';
+import EventBus from './EventBus';
 import { ActionPayload, PluginFunctionBasic, Thought } from './PayloadTypes';
-import { ChatHistoryParams, IKnowledge } from '@glodon-aiot/apis/dist/src/cvforce/model';
+import { CVForceApi } from '@glodon-aiot/apis';
+import { ChatHistoryParams, IKnowledge } from '@glodon-aiot/apis';
+import BotClient from './BotClient';
+export declare enum NetOpen {
+    enable = 1,
+    disable = 2
+}
 export interface QuestionBody {
     content: string;
     stream: boolean;
@@ -18,7 +24,7 @@ export interface QuestionConfig {
     oldMessageId?: string;
 }
 type ActionPayloadBasic = ActionPayload<PluginFunctionBasic & Thought>;
-export type SessionEventName = 'init' | 'data:loading' | 'data:loaded' | 'data:updating' | 'data:updated' | 'data:creating' | 'data:created' | 'data:deleting' | 'data:deleted' | 'activated' | 'inactivated' | 'frozen' | 'history:loading' | 'history:loaded' | 'history:moreloading' | 'history:moreloaded' | 'history:add' | 'socket:connect' | 'socket:disconnect' | 'ready' | 'message:updated' | 'message:action' | 'message:content' | 'message:reference' | 'answer:finish' | 'error' | 'destroy';
+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",
@@ -51,27 +57,53 @@ export default abstract class Session {
     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 _netOpen: boolean;
     protected active: boolean;
+    protected activing: boolean;
     protected _stopAnswer: boolean;
     private _dataLoading;
     private _dataLoaded;
-    constructor(token: string, _id?: string, _data?: Partial<ISession>, lazyload?: boolean | undefined);
+    /**
+     * 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 | undefined;
     get applicationId(): string;
+    get application(): IApplication | null;
+    loadApplicationInfo(): Promise<IApplication>;
     get ready(): boolean;
     get frozen(): boolean;
     protected set frozen(v: boolean);
-    get knowledges(): IKnowledge[];
+    get knowledges(): IKnowledge[] | undefined;
     setKnowledges(knowledges?: IKnowledge[]): Promise<IKnowledge[] | undefined>;
+    validateConfigs(): void;
     get promptVariables(): ISessionPrompt[];
-    setPromptVariables(v: ISessionPrompt[]): Promise<boolean>;
+    setPromptVariables(v: ISessionPrompt[]): Promise<ISessionPrompt[] | undefined>;
+    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;
@@ -89,15 +121,15 @@ export default abstract class Session {
         role: ChatMessageRole;
         userId?: string | undefined;
         sessionId: string;
-        reference: import('@glodon-aiot/apis').IReference[];
-        searchReference: import('@glodon-aiot/apis').ISearchRefernce[];
-        comment?: import('@glodon-aiot/apis/dist/src/cvforce/model').ICommentParam | undefined;
+        reference: import("@glodon-aiot/apis").IReference[];
+        searchReference: import("@glodon-aiot/apis").ISearchRefernce[];
+        comment?: import("@glodon-aiot/apis/dist/src/cvforce").ICommentParam | undefined;
         knowledges?: IKnowledge[] | undefined;
         isLoading?: boolean | undefined;
         messageTime: string;
         fileId?: string | undefined;
-        file?: import('@glodon-aiot/apis/dist/src/cvforce/model').KnowledgeFileMetadata | undefined;
-        chatMode?: import('@glodon-aiot/apis').ChatMode | undefined;
+        file?: import("@glodon-aiot/apis/dist/src/cvforce").KnowledgeFileMetadata | undefined;
+        chatMode?: import("@glodon-aiot/apis").ChatMode | undefined;
         llmModel?: string | undefined;
         isContext?: boolean | undefined;
         index?: number | undefined;
@@ -116,21 +148,22 @@ export default abstract class Session {
         stream?: boolean | undefined;
         fileIds?: string[] | undefined;
         isReplying?: boolean | undefined;
-        files?: import('@glodon-aiot/apis').ChatMessageFile[] | undefined;
+        files?: import("@glodon-aiot/apis").ChatMessageFile[] | undefined;
         thinkingSecs?: number | undefined;
         thinkingStatus?: "end" | "start" | undefined;
         reasoningContent?: string | undefined;
     }[]>;
     rename(name: string): Promise<boolean>;
     protected pushMessage(message: IChatMessage): Promise<void>;
-    reloadSessionInfo(): Promise<void>;
-    reload(): Promise<void>;
+    reloadSessionInfo(): Promise<this>;
+    reload(): Promise<unknown>;
     delete(): Promise<string | false>;
-    activate(): Promise<void>;
+    activate(): Promise<unknown>;
     inactivate(immediately?: boolean): boolean;
     abstract prepareConnection(): Promise<boolean>;
     abstract sendQuestion(params: QuestionBody, configs: QuestionConfig): any;
     abstract stopAnswer(): any;
+    get dataLoaded(): boolean;
     send(params: {
         text?: string;
         uuid?: string;
@@ -148,8 +181,29 @@ export default abstract class Session {
     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 {};

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

@@ -1,4 +1,4 @@
-import { EventSourceMessage } from './parse';
+import { EventSourceMessage } from "./parse";
 export declare const EventStreamContentType = "text/event-stream";
 export interface FetchEventSourceInit extends RequestInit {
     /**

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

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

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@glodon-aiot/agent-cli-sdk",
-  "version": "2.4.7",
+  "version": "3.0.4",
   "author": "glodoncv",
   "description": "aiot agent client js sdk",
-  "publishConfig": {
-    "access": "public"
-  },
   "type": "module",
   "keywords": [
     "aiot",
@@ -18,11 +15,11 @@
   ],
   "module": "./dist/agent-cli-sdk.js",
   "main": "./dist/agent-cli-sdk.umd.cjs",
-  "typings": "./src/index.ts",
+  "typings": "./dist/src/index.d.ts",
   "exports": {
-    "import": "./src/index.ts",
-    "require": "./src/index.ts",
-    "type": "./src/index.ts"
+    "import": "./dist/agent-cli-sdk.js",
+    "require": "./dist/agent-cli-sdk.umd.cjs",
+    "types": "./dist/src/index.d.ts"
   },
   "license": "MIT",
   "scripts": {
@@ -30,30 +27,20 @@
     "example": "node ./example/server.js",
     "dev": "npm-run-all -p watch example",
     "start": "vite",
-    "build": "yarn build:npm && yarn build:cdn",
+    "build": "tsc && vite build --mode prod",
     "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",
-    "test": "yarn dev && yarn jest",
-    "storybook": "start-storybook -p 6006",
-    "docs": "start-storybook -p 6006",
-    "build-storybook": "build-storybook",
-    "vpublish:major": "sh ./publish.sh major",
-    "vpublish:minor": "sh ./publish.sh minor",
-    "vpublish:patch": "sh ./publish.sh patch",
-    "vpublish:premajor": "sh ./publish.sh premajor",
-    "vpublish:preminor": "sh ./publish.sh preminor",
-    "vpublish:prepatch": "sh ./publish.sh prepatch",
-    "vpublish:prerelease": "sh ./publish.sh prerelease",
-    "vpublish": "npm publish --registry=https://packages.glodon.com/artifactory/api/npm/npm-GGM-releases/"
+    "test": "yarn dev && yarn jest"
   },
   "devDependencies": {
     "@babel/core": "^7.20.12",
     "@commitlint/cli": "^17.0.3",
     "@commitlint/config-conventional": "^17.0.3",
+    "@jest/globals": "^29.7.0",
     "@rollup/plugin-typescript": "^11.1.6",
     "@testing-library/jest-dom": "^6.6.3",
     "@types/express": "^4",
@@ -89,8 +76,12 @@
   "lint-staged": {
     "*.{js,css,md,jsx,less,ts,tsx,json}": "prettier --write"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
   "dependencies": {
-    "@glodon-aiot/apis": "^2.4.7",
+    "@glodon-aiot/apis": "^3.0.4",
     "axios": "0.24.0",
     "buffer": "^6.0.3",
     "dayjs": "^1.11.13",