@donggui/core 1.5.4-donggui.4 → 1.5.6

package/dist/types/agent/cache-adapter.d.ts

@@ -0,0 +1,32 @@
+import type { CacheFileContent } from './task-cache';
+/**
+ * 缓存适配器接口
+ * 支持多种存储后端：本地文件、Redis、OSS、数据库等
+ */
+export interface CacheAdapter {
+    /**
+     * 获取缓存
+     * @param cacheId 缓存ID
+     * @param prompt 提示词（可选，用于细粒度缓存）
+     * @returns 缓存内容，如果不存在返回 null
+     */
+    get(cacheId: string, prompt?: string): Promise<CacheFileContent | null>;
+    /**
+     * 设置缓存
+     * @param cacheId 缓存ID
+     * @param content 缓存内容
+     * @param prompt 提示词（可选）
+     * @param ttl 缓存过期时间（秒，可选）
+     */
+    set(cacheId: string, content: CacheFileContent, prompt?: string, ttl?: number): Promise<void>;
+    /**
+     * 删除缓存
+     * @param cacheId 缓存ID
+     */
+    delete(cacheId: string): Promise<void>;
+    /**
+     * 检查缓存是否存在
+     * @param cacheId 缓存ID
+     */
+    exists(cacheId: string): Promise<boolean>;
+}

package/dist/types/agent/index.d.ts

@@ -4,6 +4,8 @@ export { getReportFileName, printReportMsg, } from './utils';
 export { extractInsightParam, locateParamStr, paramStr, taskTitleStr, typeStr, } from './ui-utils';
 export { type LocateCache, type PlanningCache, TaskCache } from './task-cache';
 export { cacheFileExt } from './task-cache';
+export type { CacheFileContent } from './task-cache';
+export type { CacheAdapter } from './cache-adapter';
 export { TaskExecutor } from './tasks';
 export { getCurrentExecutionFile } from './utils';
 export type { AgentOpt } from '../types';

package/dist/types/agent/task-cache.d.ts

@@ -1,5 +1,6 @@
 import type { TUserPrompt } from '../ai-model';
 import type { ElementCacheFeature } from '../types';
+import type { CacheAdapter } from './cache-adapter';
 export declare const debug: import("@midscene/shared/logger").DebugFunction;
 export interface PlanningCache {
     type: 'plan';
@@ -15,7 +16,9 @@ export interface LocateCache {
 }
 export interface MatchCacheResult<T extends PlanningCache | LocateCache> {
     cacheContent: T;
-    updateFn: (cb: (cache: T) => void) => void;
+    updateFn: (cb: (cache: T) => void, options?: {
+        ttl?: number;
+    }) => Promise<void>;
 }
 export type CacheFileContent = {
     midsceneVersion: string;
@@ -32,17 +35,23 @@ export declare class TaskCache {
     readOnlyMode: boolean;
     writeOnlyMode: boolean;
     private matchedCacheIndices;
-    constructor(cacheId: string, isCacheResultUsed: boolean, cacheFilePath?: string, options?: {
+    private cacheAdapter?;
+    constructor(cacheId: string, isCacheResultUsed: boolean, cacheAdapterOrPath?: CacheAdapter | string, options?: {
         readOnly?: boolean;
         writeOnly?: boolean;
     });
-    matchCache(prompt: TUserPrompt, type: 'plan' | 'locate'): MatchCacheResult<PlanningCache | LocateCache> | undefined;
-    matchPlanCache(prompt: string): MatchCacheResult<PlanningCache> | undefined;
-    matchLocateCache(prompt: TUserPrompt): MatchCacheResult<LocateCache> | undefined;
-    appendCache(cache: PlanningCache | LocateCache): void;
+    matchCache(prompt: TUserPrompt, type: 'plan' | 'locate'): Promise<MatchCacheResult<PlanningCache | LocateCache> | undefined>;
+    matchPlanCache(prompt: string): Promise<MatchCacheResult<PlanningCache> | undefined>;
+    matchLocateCache(prompt: TUserPrompt): Promise<MatchCacheResult<LocateCache> | undefined>;
+    appendCache(cache: PlanningCache | LocateCache): Promise<void>;
+    private loadCache;
+    private loadCacheFromAdapter;
     loadCacheFromFile(): CacheFileContent | undefined;
+    private flushCache;
+    private flushCacheToAdapter;
     flushCacheToFile(options?: {
         cleanUnused?: boolean;
     }): void;
-    updateOrAppendCacheRecord(newRecord: PlanningCache | LocateCache, cachedRecord?: MatchCacheResult<PlanningCache | LocateCache>): void;
+    private prepareCacheToWrite;
+    updateOrAppendCacheRecord(newRecord: PlanningCache | LocateCache, cachedRecord?: MatchCacheResult<PlanningCache | LocateCache>): Promise<void>;
 }

package/dist/types/ai-model/service-caller/codex-app-server.d.ts

@@ -0,0 +1,46 @@
+import type { AIUsageInfo, DeepThinkOption, StreamingCallback } from '../../types';
+import type { IModelConfig } from '@midscene/shared/env';
+import type { ChatCompletionMessageParam } from 'openai/resources/index';
+type CodexReasoningEffort = 'low' | 'medium' | 'high' | 'xhigh';
+type CodexTextInput = {
+    type: 'text';
+    text: string;
+    text_elements: any[];
+};
+type CodexImageInput = {
+    type: 'image';
+    url: string;
+    detail?: string;
+};
+type CodexLocalImageInput = {
+    type: 'localImage';
+    path: string;
+    detail?: string;
+};
+type CodexTurnInput = CodexTextInput | CodexImageInput | CodexLocalImageInput;
+type CodexTurnResult = {
+    content: string;
+    reasoning_content?: string;
+    usage?: AIUsageInfo;
+    isStreamed: boolean;
+};
+export declare const isCodexAppServerProvider: (baseURL?: string) => boolean;
+export declare const normalizeCodexLocalImagePath: (imageUrl: string, platform?: NodeJS.Platform) => string;
+export declare const resolveCodexReasoningEffort: ({ deepThink, modelConfig, }: {
+    deepThink?: DeepThinkOption;
+    modelConfig: IModelConfig;
+}) => CodexReasoningEffort | undefined;
+export declare const buildCodexTurnPayloadFromMessages: (messages: ChatCompletionMessageParam[], options?: {
+    imageDetailOverride?: string;
+}) => {
+    developerInstructions?: string;
+    input: CodexTurnInput[];
+};
+export declare function callAIWithCodexAppServer(messages: ChatCompletionMessageParam[], modelConfig: IModelConfig, options?: {
+    stream?: boolean;
+    onChunk?: StreamingCallback;
+    deepThink?: DeepThinkOption;
+    abortSignal?: AbortSignal;
+}): Promise<CodexTurnResult>;
+export declare function __shutdownCodexAppServerForTests(): Promise<void>;
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@donggui/core",
-  "description": "Automate browser actions, extract data, and perform assertions using AI. It offers JavaScript SDK, Chrome extension, and support for scripting in YAML. See https://midscenejs.com/ for details.",
-  "version": "1.5.4-donggui.4",
+  "description": "DongGUI Core - Automate browser actions, extract data, and perform assertions using AI.",
+  "version": "1.5.6",
   "repository": "https://github.com/web-infra-dev/midscene",
   "homepage": "https://midscenejs.com/",
   "main": "./dist/lib/index.js",
@@ -78,7 +78,7 @@
     "test:parse-action": "npm run test:ai -- tests/ai/parse-action.test.ts"
   },
   "dependencies": {
-    "@midscene/shared": "1.5.4",
+    "@midscene/shared": "workspace:*",
     "@ui-tars/action-parser": "1.2.3",
     "dayjs": "^1.11.11",
     "dotenv": "^16.4.5",