keepwork-sdk 1.0.0

package/dist-npm/types/src/tools/WebTool.d.ts

@@ -0,0 +1,106 @@
+/**
+ * WebTool.ts — 网页内容抓取工具
+ *
+ * 通过 `fetch_webpage` 工具获取一个或多个 URL 的页面文本，
+ * 提取正文并按 `query` 关键词定位相关片段，供 AI 分析使用。
+ *
+ * LLM 工具定义：`fetch_webpage`
+ */
+/** 工具函数定义（OpenAI Function Calling 格式） */
+export interface ToolDefinition {
+    type: 'function';
+    function: {
+        name: string;
+        description: string;
+        parameters: Record<string, unknown>;
+    };
+}
+/** WebTool 运行时配置 */
+export interface WebToolConfig {
+    /** 单个 URL 返回的最大字符数（默认 6000） */
+    maxContentLength?: number;
+    /** 请求超时毫秒数（默认 15000） */
+    timeoutMs?: number;
+    [key: string]: unknown;
+}
+/** 单个 URL 的抓取结果 */
+export interface FetchResult {
+    url: string;
+    title?: string;
+    contentType?: string;
+    matchedQuery?: boolean;
+    truncated?: boolean;
+    content?: string;
+    error?: string;
+}
+/** fetch_webpage 工具返回值 */
+export interface FetchWebpageResult {
+    query: string;
+    results: FetchResult[];
+}
+/** parseWebpageContent 返回值 */
+interface ParsedContent {
+    title: string;
+    content: string;
+}
+declare class WebTool {
+    /** LLM 可见的工具定义列表 */
+    static readonly definitions: ToolDefinition[];
+    private config;
+    /** 更新工具运行时配置（由 CopilotTools.setToolConfig 调用）。 */
+    setConfig(config: WebToolConfig): void;
+    /**
+     * 执行指定工具函数。
+     *
+     * @param name   - 工具名（目前仅支持 'fetch_webpage'）
+     * @param args   - 工具参数（urls 数组 + query 字符串）
+     * @param config - 运行时配置
+     */
+    execute(name: string, args: {
+        urls?: string[];
+        query?: string;
+    } | unknown, config?: WebToolConfig): Promise<string | FetchWebpageResult>;
+    /**
+     * 抓取单个 URL 的页面内容，按 query 提取相关片段。
+     *
+     * @param url     - 目标 URL
+     * @param query   - 用于定位相关内容的查询词
+     * @param options - 配置（maxContentLength / timeoutMs）
+     */
+    fetchWebpageContent(url: string, query: string, options?: {
+        maxContentLength?: number;
+        timeoutMs?: number;
+    }): Promise<FetchResult>;
+    /**
+     * 判断是否应直接返回原始内容（Markdown / JSON / 非 HTML）。
+     */
+    shouldReturnRawContent(url: string, contentType?: string): boolean;
+    /**
+     * 解析原始 HTML / 文本，提取标题和正文。
+     * 浏览器环境使用 DOMParser；SSR 环境使用正则兜底。
+     *
+     * @param rawText     - 原始页面文本
+     * @param contentType - HTTP Content-Type 响应头
+     */
+    parseWebpageContent(rawText: string, contentType?: string): ParsedContent;
+    /**
+     * 从 document 中选取主内容节点（main / article / [role="main"] 等优先）。
+     * 回退到 document.body。
+     */
+    selectMainContentNode(doc: Document): Element | null;
+    /** 从原始 HTML 字符串提取 `<title>` 内容（DOMParser 不可用时兜底）。 */
+    extractTitleFromHtml(rawText: string): string;
+    /** 压缩多余空白字符，返回干净的单行文本。 */
+    normalizeWebpageText(text: string): string;
+    /**
+     * 在正文中找到 query 词汇最早出现位置，提取上下文片段。
+     * 未匹配时返回空字符串。
+     *
+     * @param content   - 已规范化的正文文本
+     * @param query     - 查询关键词（空格分隔）
+     * @param maxLength - 返回片段最大字符数（默认 1800）
+     */
+    buildQuerySnippet(content: string, query: string, maxLength?: number): string;
+}
+export default WebTool;
+//# sourceMappingURL=WebTool.d.ts.map

package/dist-npm/types/src/tools/WebTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebTool.d.ts","sourceRoot":"","sources":["../../../../src/tools/WebTool.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH,yCAAyC;AACzC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;CACtF;AAED,oBAAoB;AACpB,MAAM,WAAW,aAAa;IAC5B,+BAA+B;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,mBAAmB;AACnB,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,0BAA0B;AAC1B,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,WAAW,EAAE,CAAC;CACxB;AAED,8BAA8B;AAC9B,UAAU,aAAa;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,cAAM,OAAO;IACX,oBAAoB;IACpB,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,cAAc,EAAE,CAyB3C;IAEF,OAAO,CAAC,MAAM,CAAqB;IAEnC,kDAAkD;IAClD,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAMtC;;;;;;OAMG;IACG,OAAO,CACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,EACnD,MAAM,GAAE,aAAkB,GACzB,OAAO,CAAC,MAAM,GAAG,kBAAkB,CAAC;IAwBvC;;;;;;OAMG;IACG,mBAAmB,CACvB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAC9D,OAAO,CAAC,WAAW,CAAC;IAoDvB;;OAEG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,SAAK,GAAG,OAAO;IAO9D;;;;;;OAMG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,SAAK,GAAG,aAAa;IA4BrE;;;OAGG;IACH,qBAAqB,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,GAAG,IAAI;IAWpD,qDAAqD;IACrD,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAK7C,0BAA0B;IAC1B,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI1C;;;;;;;OAOG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,MAAM;CAyB5E;AAED,eAAe,OAAO,CAAC"}

package/dist-npm/types/src/types/common.d.ts

@@ -0,0 +1,164 @@
+/**
+ * common.ts — KeepworkSDK 跨模块共享类型定义
+ *
+ * 收录在多个模块中重复出现的数据结构、联合类型和工具类型。
+ * 各模块直接 import type { ... } from './types/common' 使用。
+ */
+/** 任意普通对象（比 object 更具体，比 Record<string,unknown> 更宽松） */
+export type PlainObject = Record<string, unknown>;
+/** 异步或同步的函数 */
+export type MaybeAsyncFn<T = void> = (() => T) | (() => Promise<T>);
+/** 可为 null 的值 */
+export type Nullable<T> = T | null;
+/** 可为 undefined 的值 */
+export type Optional<T> = T | undefined;
+/** Keepwork 核心 API 的标准响应包装（大部分接口遵循此格式） */
+export interface KwApiResponse<T = unknown> {
+    code: number;
+    message?: string;
+    data?: T;
+    [key: string]: unknown;
+}
+/** 用户信息（来自 /user/getCurrentUser 等接口） */
+export interface KwUser {
+    id: number;
+    username: string;
+    nickname?: string;
+    portrait?: string;
+    email?: string;
+    mobile?: string;
+    vip?: number;
+    [key: string]: unknown;
+}
+/** 页面（PersonalPage）基础信息 */
+export interface KwPage {
+    id?: number;
+    username: string;
+    sitename: string;
+    pagename: string;
+    content?: string;
+    version?: number;
+    updatedAt?: string;
+    [key: string]: unknown;
+}
+/** 站点基础信息 */
+export interface KwSite {
+    id?: number;
+    username: string;
+    sitename: string;
+    displayName?: string;
+    visibility?: string;
+    [key: string]: unknown;
+}
+/** LLM 工具（Function Calling）定义 */
+export interface LLMTool {
+    type: 'function';
+    function: {
+        name: string;
+        description?: string;
+        parameters?: {
+            type: 'object';
+            properties: Record<string, LLMToolParameterSchema>;
+            required?: string[];
+        };
+    };
+}
+/** LLM 工具参数 Schema */
+export interface LLMToolParameterSchema {
+    type: 'string' | 'number' | 'boolean' | 'array' | 'object' | 'null';
+    description?: string;
+    enum?: unknown[];
+    items?: LLMToolParameterSchema;
+    properties?: Record<string, LLMToolParameterSchema>;
+    [key: string]: unknown;
+}
+/** LLM 工具调用请求（来自模型响应） */
+export interface LLMToolCall {
+    id: string;
+    type: 'function';
+    function: {
+        name: string;
+        arguments: string;
+    };
+}
+/** 聊天消息角色 */
+export type ChatRole = 'system' | 'user' | 'assistant' | 'tool';
+/** 单条聊天消息 */
+export interface ChatMessage {
+    role: ChatRole;
+    content: string | null;
+    tool_calls?: LLMToolCall[];
+    tool_call_id?: string;
+    name?: string;
+}
+/** AI 流式响应事件回调 */
+export interface StreamCallbacks {
+    /** 收到文本片段 */
+    onText?: (delta: string, fullText: string) => void;
+    /** 收到工具调用结果 */
+    onToolResult?: (toolName: string, result: unknown) => void;
+    /** 流结束（正常或被中断） */
+    onEnd?: (finalText: string) => void;
+    /** 发生错误 */
+    onError?: (error: Error) => void;
+}
+/** AgentRouter postMessage 信封（is_agent_router: true） */
+export interface AgentRouterMessage {
+    is_agent_router: true;
+    agentName?: string;
+    taskId?: string;
+    /** 任务发布载荷 */
+    payload?: {
+        task?: string;
+        tools?: LLMTool[];
+        maxIterations?: number;
+        systemPrompt?: string;
+        model?: string;
+        [key: string]: unknown;
+    };
+    /** 流式事件片段 */
+    stream?: {
+        eventName: string;
+        eventData: unknown;
+        taskId: string;
+    };
+    /** 任务最终结果 */
+    result?: unknown;
+    /** 错误信息 */
+    error?: string;
+    /** 发现/注册消息 */
+    type?: 'register' | 'discover' | 'discoverReply' | 'task' | 'taskResult' | 'streamEvent';
+    [key: string]: unknown;
+}
+/** NPL/Paracraft 消息信封（is_paracraft_message: true） */
+export interface ParacraftMessage {
+    is_paracraft_message: true;
+    [key: string]: unknown;
+}
+/** CopilotTools 工具分类名称 */
+export type ToolCategory = 'mqtt' | 'fileOps' | 'execute' | 'web' | 'personalPage' | 'agent' | 'digitalhuman' | string;
+/** SandboxToolEnv / CopilotTools 工具调用请求 */
+export interface ToolCallRequest {
+    name: string;
+    arguments: PlainObject;
+    id?: string;
+}
+/** 工具执行结果 */
+export type ToolCallResult = string | PlainObject | unknown;
+/** PersonalPageStore 写操作选项 */
+export interface WriteOptions {
+    /** 是否跳过远程同步 */
+    noRemote?: boolean;
+    /** 是否跳过 localStorage 层 */
+    noLocal?: boolean;
+    /** 自定义版本号 */
+    version?: number;
+}
+/** 文件操作路径信息 */
+export interface FilePath {
+    /** 工作空间（对应 PersonalPage 的 sitename） */
+    workspace: string;
+    /** 文件相对路径 */
+    path: string;
+}
+//# sourceMappingURL=common.d.ts.map

package/dist-npm/types/src/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../../src/types/common.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,wDAAwD;AACxD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAElD,eAAe;AACf,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpE,iBAAiB;AACjB,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEnC,sBAAsB;AACtB,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;AAMxC,0CAA0C;AAC1C,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,wCAAwC;AACxC,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,2BAA2B;AAC3B,MAAM,WAAW,MAAM;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,aAAa;AACb,MAAM,WAAW,MAAM;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAMD,iCAAiC;AACjC,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE;YACX,IAAI,EAAE,QAAQ,CAAC;YACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;YACnD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;SACrB,CAAC;KACH,CAAC;CACH;AAED,sBAAsB;AACtB,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IACpD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,yBAAyB;AACzB,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED,aAAa;AACb,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;AAEhE,aAAa;AACb,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,kBAAkB;AAClB,MAAM,WAAW,eAAe;IAC9B,aAAa;IACb,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACnD,eAAe;IACf,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3D,kBAAkB;IAClB,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,WAAW;IACX,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAMD,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa;IACb,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,aAAa;IACb,MAAM,CAAC,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,OAAO,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,aAAa;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc;IACd,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,eAAe,GAAG,MAAM,GAAG,YAAY,GAAG,aAAa,CAAC;IACzF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,qDAAqD;AACrD,MAAM,WAAW,gBAAgB;IAC/B,oBAAoB,EAAE,IAAI,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAMD,0BAA0B;AAC1B,MAAM,MAAM,YAAY,GACpB,MAAM,GACN,SAAS,GACT,SAAS,GACT,KAAK,GACL,cAAc,GACd,OAAO,GACP,cAAc,GACd,MAAM,CAAC;AAEX,2CAA2C;AAC3C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,WAAW,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,aAAa;AACb,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC;AAM5D,8BAA8B;AAC9B,MAAM,WAAW,YAAY;IAC3B,eAAe;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0BAA0B;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,eAAe;AACf,MAAM,WAAW,QAAQ;IACvB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa;IACb,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist-npm/types/src/ui/LocalAPIKeySettings.d.ts

@@ -0,0 +1,229 @@
+/**
+ * LocalAPIKeySettings — per-model LLM API key and endpoint configuration
+ * with a self-contained settings modal UI.
+ *
+ * Stores per-model overrides (modelId, apiKey, category).
+ * When the SDK makes an LLM request
+ * for a model that has local settings, those settings take priority over
+ * the server-side defaults.
+ *
+ * Persistence is pluggable: pass `storage: 'personalPageStore'` to use
+ * Keepwork cloud storage, or `storage: 'localStorage'` (default) for
+ * browser-local persistence.
+ *
+ * Usage:
+ *   const settings = sdk.localAPIKeySettings;
+ *   await settings.load();
+ *   settings.show();           // opens the config modal
+ *   settings.show({ onClose: () => console.log('closed') });
+ */
+type LAKStrings = Record<string, string>;
+/** 单个模型配置 */
+interface ModelConfig {
+    modelId: string;
+    endpointId: string;
+    apiKey: string;
+    category: string;
+    enabled: boolean;
+    preferDirect: boolean;
+    [key: string]: unknown;
+}
+/** 单 provider 设置 */
+interface ProviderSetting {
+    enabled: boolean;
+    apiKey: string;
+    preferDirect: boolean;
+    [key: string]: unknown;
+}
+/** 构造选项 */
+export interface LocalAPIKeySettingsOptions {
+    storage?: 'personalPageStore' | 'localStorage';
+    workspace?: string;
+    /** 'zhCN' | 'enUS'，缺省时按系统语言自动检测 */
+    lang?: string;
+    [key: string]: unknown;
+}
+/** LocalAPIKeySettings 依赖的 SDK 表面 */
+interface LAKStore {
+    readFile(path: string): Promise<string>;
+    createFile(path: string, content: string): Promise<unknown>;
+    [key: string]: unknown;
+}
+interface LAKSdk {
+    personalPageStore?: {
+        withWorkspace(workspace: string, mountFolder?: string | null): LAKStore;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+export default class LocalAPIKeySettings {
+    sdk: LAKSdk;
+    storageMode: string;
+    workspace: string;
+    _enabled: boolean;
+    _models: Map<string, ModelConfig>;
+    _providerSettings: Record<string, ProviderSetting>;
+    _abstractModelMap: Record<string, string>;
+    _loaded: boolean;
+    _loadPromise: Promise<void> | null;
+    _saveTimer?: ReturnType<typeof setTimeout> | null;
+    _overlay: HTMLElement | null;
+    _activeCategory: string;
+    _activePresetTab: boolean;
+    _styleInjected: boolean;
+    _showOptions?: Record<string, unknown>;
+    _presetClickHandler?: (e: Event) => void;
+    _lang: string;
+    _strings: LAKStrings;
+    [key: string]: unknown;
+    /**
+     * @param {object} sdk  - KeepworkSDK instance
+     * @param {object} [options]
+     * @param {'personalPageStore'|'localStorage'} [options.storage='localStorage']
+     * @param {string} [options.workspace]
+     */
+    constructor(sdk: unknown, options?: LocalAPIKeySettingsOptions);
+    /** Translate a key, optionally interpolating {placeholders}. */
+    _t(key: string, vars?: Record<string, string>): string;
+    get enabled(): boolean;
+    set enabled(val: boolean);
+    setModel(name: string, config?: Record<string, unknown>): void;
+    removeModel(name: string): void;
+    getModel(name: string): ModelConfig | undefined;
+    listModels(category?: string): Array<ModelConfig & {
+        name: string;
+    }>;
+    setAllModels(models: Array<Record<string, unknown>>): void;
+    /**
+     * Resolve a model ID (possibly abstract like 'keepwork-pro') to
+     * { apiKey, realModelId }.
+     * Resolution chain:
+     *   1. If modelId is an abstract name, map it to a real model ID.
+     *   2. Look up the real model ID in per-model settings.
+     *   3. Fall back to provider-level defaults, using an explicit provider hint when supplied.
+     */
+    resolve(modelId: string, options?: Record<string, unknown>): Record<string, unknown> | null;
+    _resolveAbstractTarget(abstractName: string, mappedModelId: string): string;
+    _getAbstractDisplayValue(abstractName: string, mappedModelId: string): string;
+    _getDropdownOptions(category: string): Array<{
+        name: string;
+        modelId: string;
+    }>;
+    /**
+     * Resolve settings for requests that must remain on Keepwork's `/gpt/*`
+     * endpoints. This intentionally strips any direct provider baseURL.
+     * @param {string} modelId
+     * @returns {{apiKey:string, realModelId?:string}|null}
+     */
+    resolveProxyConfig(modelId: string): Record<string, unknown> | null;
+    /**
+     * Resolve settings for direct provider compatibility checks.
+     * @param {string} modelId
+     * @returns {{apiKey:string, realModelId?:string}|null}
+     */
+    resolveDirectConfig(modelId: string, options?: Record<string, unknown>): Record<string, unknown> | null;
+    /**
+     * Set whether a provider should prefer direct browser calls over Keepwork proxy calls.
+     * Defaults to false for every provider to preserve existing behavior.
+     */
+    setProviderPreferDirect(providerKey: string, preferDirect: boolean): void;
+    /** Get the saved API key for a provider preset. */
+    getProviderApiKey(providerKey: string): string;
+    /**
+     * Detect which service provider a model ID belongs to.
+     * @param {string} modelId
+     * @returns {string|null} provider key (e.g. 'doubao', 'openai') or null
+     */
+    detectProvider(modelId: string): string | null;
+    /** Get the full abstract model map. */
+    get abstractModelMap(): {
+        [x: string]: string;
+    };
+    /** Set a single abstract mapping: keepwork-pro → real-model-id */
+    setAbstractMapping(abstractName: string, realModelId: string): void;
+    /** Remove an abstract mapping. */
+    removeAbstractMapping(abstractName: string): void;
+    /**
+     * Reset all settings except API keys (per-provider + per-model) and the
+     * abstract model mapping. Useful when the user wants to restore default
+     * model lists / enabled flags / direct-call preferences without losing
+     * the API keys they have already entered.
+     */
+    resetExceptApiKeysAndAbstractMap(): void;
+    /** Get the real model ID for an abstract name (or return the name unchanged). */
+    resolveAbstractName(name: string): string;
+    /**
+     * Resolve a display name (e.g. "Doubao Seedance 2.0 fast") to its modelId
+     * (e.g. "seedance-2.0-fast").  Returns the input unchanged if no match found.
+     * @param {string} name
+     * @returns {string}
+     */
+    resolveModelName(name: string): string;
+    get hasSettings(): boolean;
+    /**
+     * Resolve a model name/ID to { model, apiKey } for use by AIChat / AIChatRTC / AIGenerators.
+     * Handles display-name resolution, abstract-name mapping, and enabled checks.
+     * @param {string} model
+     * @param {object|string} [options] - Optional { provider } hint, or provider key string.
+     * @returns {{model: string, apiKey: string, provider?: string, preferDirect?: boolean}}
+     */
+    resolveModelSettings(model: string, options?: Record<string, unknown> | string): Record<string, unknown>;
+    load(): Promise<void>;
+    _getStore(): LAKStore | null;
+    _doLoad(): Promise<void>;
+    save(): Promise<void>;
+    clear(): Promise<void>;
+    _serializeData(): Record<string, unknown>;
+    /**
+     * Build a one-shot map of legacy Volcano Endpoint IDs to friendly model names.
+     * Older builds persisted `modelId: 'ep-...'`; we transparently rewrite them.
+     */
+    _endpointIdToFriendlyName(endpointId: string): string | null;
+    _applyData(data: Record<string, unknown>): void;
+    /** Ensure _providerSettings has an entry for every SERVICE_PRESETS key. */
+    _initProviderSettings(): void;
+    _ensureDefaultServicePresets(): boolean;
+    _getPresetProviderByModelName(name: string | undefined): string | null;
+    _scheduleSave(): void;
+    toJSON(): Record<string, unknown>;
+    fromJSON(data: Record<string, unknown>): void;
+    /**
+     * Open the settings modal.
+     * @param {object} [options]
+     * @param {Function} [options.onClose]  - Called when the modal is dismissed.
+     * @param {Function} [options.onSave]   - Called after settings are saved.
+     * @param {string}   [options.title]    - Modal title override.
+     * @param {string}   [options.lang]     - 'zhCN' | 'enUS' (auto-detected if omitted).
+     * @param {boolean}  [options.fullscreen=false] - Use the full viewport instead of a centered dialog.
+     */
+    show(options?: Record<string, unknown>): void;
+    /** Close the modal. */
+    hide(): void;
+    /** Toggle: show if hidden, hide if shown. */
+    toggle(options?: Record<string, unknown>): void;
+    _buildHTML(options?: Record<string, unknown>): string;
+    _populateFields(): void;
+    _renderModels(): void;
+    /**
+     * Return the "canonical" API key for a provider preset — the first
+     * configured preset model's apiKey (matches what Presets tab shows).
+     * Returns '' when no preset model for this provider is configured.
+     */
+    _getProviderPresetKey(providerKey: string | null): string;
+    /** Set provider-level API key and propagate to models whose key matched the old value. */
+    setProviderApiKey(providerKey: string, newApiKey: string): void;
+    _updateCounts(): void;
+    _renderActivePanel(): void;
+    _switchToPresets(): void;
+    _switchToCategory(cat: string): void;
+    _renderPresets(): void;
+    _bindPresetEvents(container: HTMLElement): void;
+    _providerLabel(modelId: string): string;
+    _bindEvents(): void;
+    _injectStyles(): void;
+    _esc(s: unknown): string;
+    _attr(s: unknown): string;
+    _eyeIcon(open: boolean): string;
+}
+export {};
+//# sourceMappingURL=LocalAPIKeySettings.d.ts.map

package/dist-npm/types/src/ui/LocalAPIKeySettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalAPIKeySettings.d.ts","sourceRoot":"","sources":["../../../../src/ui/LocalAPIKeySettings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAOH,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AA8MzC,aAAa;AACb,UAAU,WAAW;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,oBAAoB;AACpB,UAAU,eAAe;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,WAAW;AACX,MAAM,WAAW,0BAA0B;IACzC,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,qCAAqC;AACrC,UAAU,QAAQ;IAChB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5D,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AACD,UAAU,MAAM;IACd,iBAAiB,CAAC,EAAE;QAClB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC;QACxE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACnD,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACnC,UAAU,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC;IAClD,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,mBAAmB,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,UAAU,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAEvB;;;;;OAKG;gBACS,GAAG,EAAE,OAAO,EAAE,OAAO,GAAE,0BAA+B;IA8BlE,gEAAgE;IAChE,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM;IAYtD,IAAI,OAAO,IAAI,OAAO,CAA0B;IAChD,IAAI,OAAO,CAAC,GAAG,EAAE,OAAO,EAGvB;IAID,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,IAAI;IAYlE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK/B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAI/C,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,WAAW,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAUpE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,IAAI;IAS1D;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAuD/F,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAO3E,wBAAwB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAe7E,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAyB/E;;;;;OAKG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAWnE;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI3G;;;OAGG;IACH,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,IAAI;IAMzE,mDAAmD;IACnD,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAI9C;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAU9C,uCAAuC;IACvC,IAAI,gBAAgB;;MAA4C;IAEhE,kEAAkE;IAClE,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAKnE,kCAAkC;IAClC,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAKjD;;;;;OAKG;IACH,gCAAgC,IAAI,IAAI;IAkDxC,iFAAiF;IACjF,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIzC;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAiBtC,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;;;OAMG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAwDtG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAS3B,SAAS,IAAI,QAAQ,GAAG,IAAI;IAKtB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBxB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB5B,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAiBzC;;;OAGG;IACH,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAU5D,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAgE/C,2EAA2E;IAC3E,qBAAqB,IAAI,IAAI;IAU7B,4BAA4B,IAAI,OAAO;IAyBvC,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI;IAOtE,aAAa,IAAI,IAAI;IAKrB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAU7C;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,IAAI;IAwBjD,uBAAuB;IACvB,IAAI;IAWJ,6CAA6C;IAC7C,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAM/C,UAAU,CAAC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,MAAM;IAuDzD,eAAe;IAIf,aAAa;IA8Cb;;;;OAIG;IACH,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM;IAoBzD,0FAA0F;IAC1F,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAgB/D,aAAa,IAAI,IAAI;IASrB,kBAAkB;IAUlB,gBAAgB,IAAI,IAAI;IAaxB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAcpC,cAAc,IAAI,IAAI;IA4GtB,iBAAiB,CAAC,SAAS,EAAE,WAAW,GAAG,IAAI;IAqH/C,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAOvC,WAAW,IAAI,IAAI;IAyLnB,aAAa,IAAI,IAAI;IA0VrB,IAAI,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM;IACxB,KAAK,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM;IAEzB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM;CAMhC"}