@midscene/shared 1.0.1-beta-20251024063839.0 → 1.0.1-beta-20251024064637.0

package/dist/types/extractor/dom-util.d.ts

@@ -1,4 +1,4 @@
-import { NodeType } from '../constants';
+import type { LocateResultElement } from '../types';
 export declare function isFormElement(node: globalThis.Node): boolean;
 export declare function isButtonElement(node: globalThis.Node): node is globalThis.HTMLButtonElement;
 export declare function isAElement(node: globalThis.Node): node is globalThis.HTMLButtonElement;
@@ -10,17 +10,4 @@ export declare function isContainerElement(node: globalThis.Node): node is globa
 export declare function generateElementByPosition(position: {
     x: number;
     y: number;
-}): {
-    id: string;
-    attributes: {
-        nodeType: NodeType;
-    };
-    rect: {
-        left: number;
-        top: number;
-        width: number;
-        height: number;
-    };
-    content: string;
-    center: number[];
-};
+}): LocateResultElement;

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

@@ -27,7 +27,6 @@ export { descriptionOfTree, traverseTree, treeToList, truncateText, trimAttribut
 export { extractTextWithPosition as webExtractTextWithPosition } from './web-extractor';
 export { extractTreeNode as webExtractNodeTree } from './web-extractor';
 export { extractTreeNodeAsString as webExtractNodeTreeAsString } from './web-extractor';
-export { setNodeHashCacheListOnWindow, getNodeFromCacheList } from './util';
 export { getXpathsByPoint, getNodeInfoByXpath, getElementInfoByXpath, getElementXpath, } from './locator';
 export { generateElementByPosition } from './dom-util';
 export { isNotContainerElement } from './dom-util';

package/dist/types/extractor/tree.d.ts

@@ -1,9 +1,6 @@
 import type { BaseElement, ElementTreeNode } from '../types';
 export declare function truncateText(text: string | number | object | undefined, maxLength?: number): string;
-export declare function trimAttributes(attributes: Record<string, any>, truncateTextLength?: number): {
-    [key: string]: string;
-    nodeType: import("./constants").NodeType;
-};
+export declare function trimAttributes(attributes: Record<string, any>, truncateTextLength?: number): Record<string, string>;
 export declare function descriptionOfTree<ElementType extends BaseElement = BaseElement>(tree: ElementTreeNode<ElementType>, truncateTextLength?: number, filterNonTextContent?: boolean, visibleOnly?: boolean): string;
 export declare function treeToList<T extends BaseElement>(tree: ElementTreeNode<T>): T[];
 export declare function traverseTree<T extends BaseElement, ReturnNodeType extends BaseElement>(tree: ElementTreeNode<T>, onNode: (node: T) => ReturnNodeType): ElementTreeNode<ReturnNodeType>;

package/dist/types/extractor/util.d.ts

@@ -33,9 +33,6 @@ export declare function elementRect(el: globalThis.HTMLElement | globalThis.Node
 export declare function validTextNodeContent(node: globalThis.Node): string | false;
 export declare function getNodeAttributes(node: globalThis.HTMLElement | globalThis.Node, currentWindow: typeof globalThis.window): Record<string, string>;
 export declare function midsceneGenerateHash(node: globalThis.Node | null, content: string, rect: Rect): string;
-export declare function setNodeHashCacheListOnWindow(): void;
-export declare function setNodeToCacheList(node: globalThis.Node, id: string): void;
-export declare function getNodeFromCacheList(id: string): any;
 export declare function generateId(numberId: number): string;
 export declare function setGenerateHashOnWindow(): void;
 export declare function setMidsceneVisibleRectOnWindow(): void;

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

@@ -14,7 +14,6 @@ export type Rect = Point & Size & {
 };
 export declare abstract class BaseElement {
     abstract id: string;
-    abstract indexId?: number;
     abstract attributes: {
         nodeType: NodeType;
         [key: string]: string;
@@ -22,7 +21,6 @@ export declare abstract class BaseElement {
     abstract content: string;
     abstract rect: Rect;
     abstract center: [number, number];
-    abstract xpaths?: string[];
     abstract isVisible: boolean;
 }
 export interface ElementTreeNode<ElementType extends BaseElement = BaseElement> {
@@ -32,3 +30,9 @@ export interface ElementTreeNode<ElementType extends BaseElement = BaseElement>
 export interface WebElementInfo extends ElementInfo {
     zoom: number;
 }
+export type LocateResultElement = {
+    center: [number, number];
+    rect: Rect;
+    id: string;
+    isOrderSensitive?: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midscene/shared",
-  "version": "1.0.1-beta-20251024063839.0",
+  "version": "1.0.1-beta-20251024064637.0",
   "repository": "https://github.com/web-infra-dev/midscene",
   "homepage": "https://midscenejs.com/",
   "types": "./dist/types/index.d.ts",

package/src/env/constants.ts

@@ -1,35 +1,33 @@
 import {
-  MIDSCENE_GROUNDING_LOCATOR_MODE,
-  MIDSCENE_GROUNDING_MODEL_API_KEY,
-  MIDSCENE_GROUNDING_MODEL_BASE_URL,
-  MIDSCENE_GROUNDING_MODEL_HTTP_PROXY,
-  MIDSCENE_GROUNDING_MODEL_INIT_CONFIG_JSON,
   MIDSCENE_GROUNDING_MODEL_NAME,
-  MIDSCENE_GROUNDING_MODEL_SOCKS_PROXY,
-  MIDSCENE_LOCATOR_MODE,
-  MIDSCENE_MODEL_API_KEY,
-  MIDSCENE_MODEL_BASE_URL,
-  MIDSCENE_MODEL_HTTP_PROXY,
-  MIDSCENE_MODEL_INIT_CONFIG_JSON,
+  MIDSCENE_GROUNDING_OPENAI_API_KEY,
+  MIDSCENE_GROUNDING_OPENAI_BASE_URL,
+  MIDSCENE_GROUNDING_OPENAI_HTTP_PROXY,
+  MIDSCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON,
+  MIDSCENE_GROUNDING_OPENAI_SOCKS_PROXY,
+  MIDSCENE_GROUNDING_VL_MODE,
   MIDSCENE_MODEL_NAME,
-  MIDSCENE_MODEL_SOCKS_PROXY,
-  MIDSCENE_PLANNING_LOCATOR_MODE,
-  MIDSCENE_PLANNING_MODEL_API_KEY,
-  MIDSCENE_PLANNING_MODEL_BASE_URL,
-  MIDSCENE_PLANNING_MODEL_HTTP_PROXY,
-  MIDSCENE_PLANNING_MODEL_INIT_CONFIG_JSON,
+  MIDSCENE_OPENAI_API_KEY,
+  MIDSCENE_OPENAI_BASE_URL,
+  MIDSCENE_OPENAI_HTTP_PROXY,
+  MIDSCENE_OPENAI_INIT_CONFIG_JSON,
+  MIDSCENE_OPENAI_SOCKS_PROXY,
   MIDSCENE_PLANNING_MODEL_NAME,
-  MIDSCENE_PLANNING_MODEL_SOCKS_PROXY,
-  MIDSCENE_VQA_LOCATOR_MODE,
-  MIDSCENE_VQA_MODEL_API_KEY,
-  MIDSCENE_VQA_MODEL_BASE_URL,
-  MIDSCENE_VQA_MODEL_HTTP_PROXY,
-  MIDSCENE_VQA_MODEL_INIT_CONFIG_JSON,
+  MIDSCENE_PLANNING_OPENAI_API_KEY,
+  MIDSCENE_PLANNING_OPENAI_BASE_URL,
+  MIDSCENE_PLANNING_OPENAI_HTTP_PROXY,
+  MIDSCENE_PLANNING_OPENAI_INIT_CONFIG_JSON,
+  MIDSCENE_PLANNING_OPENAI_SOCKS_PROXY,
+  MIDSCENE_PLANNING_VL_MODE,
+  MIDSCENE_VL_MODE,
   // VQA
   MIDSCENE_VQA_MODEL_NAME,
-  MIDSCENE_VQA_MODEL_SOCKS_PROXY,
-  MODEL_API_KEY,
-  MODEL_BASE_URL,
+  MIDSCENE_VQA_OPENAI_API_KEY,
+  MIDSCENE_VQA_OPENAI_BASE_URL,
+  MIDSCENE_VQA_OPENAI_HTTP_PROXY,
+  MIDSCENE_VQA_OPENAI_INIT_CONFIG_JSON,
+  MIDSCENE_VQA_OPENAI_SOCKS_PROXY,
+  MIDSCENE_VQA_VL_MODE,
   OPENAI_API_KEY,
   OPENAI_BASE_URL,
 } from './types';
@@ -58,18 +56,18 @@ export const VQA_MODEL_CONFIG_KEYS: IModelConfigKeys = {
   /**
    * proxy
    */
-  socksProxy: MIDSCENE_VQA_MODEL_SOCKS_PROXY,
-  httpProxy: MIDSCENE_VQA_MODEL_HTTP_PROXY,
+  socksProxy: MIDSCENE_VQA_OPENAI_SOCKS_PROXY,
+  httpProxy: MIDSCENE_VQA_OPENAI_HTTP_PROXY,
   /**
    * OpenAI
    */
-  openaiBaseURL: MIDSCENE_VQA_MODEL_BASE_URL,
-  openaiApiKey: MIDSCENE_VQA_MODEL_API_KEY,
-  openaiExtraConfig: MIDSCENE_VQA_MODEL_INIT_CONFIG_JSON,
+  openaiBaseURL: MIDSCENE_VQA_OPENAI_BASE_URL,
+  openaiApiKey: MIDSCENE_VQA_OPENAI_API_KEY,
+  openaiExtraConfig: MIDSCENE_VQA_OPENAI_INIT_CONFIG_JSON,
   /**
    * Extra
    */
-  vlMode: MIDSCENE_VQA_LOCATOR_MODE,
+  vlMode: MIDSCENE_VQA_VL_MODE,
 } as const;
 
 export const GROUNDING_MODEL_CONFIG_KEYS: IModelConfigKeys = {
@@ -77,18 +75,18 @@ export const GROUNDING_MODEL_CONFIG_KEYS: IModelConfigKeys = {
   /**
    * proxy
    */
-  socksProxy: MIDSCENE_GROUNDING_MODEL_SOCKS_PROXY,
-  httpProxy: MIDSCENE_GROUNDING_MODEL_HTTP_PROXY,
+  socksProxy: MIDSCENE_GROUNDING_OPENAI_SOCKS_PROXY,
+  httpProxy: MIDSCENE_GROUNDING_OPENAI_HTTP_PROXY,
   /**
    * OpenAI
    */
-  openaiBaseURL: MIDSCENE_GROUNDING_MODEL_BASE_URL,
-  openaiApiKey: MIDSCENE_GROUNDING_MODEL_API_KEY,
-  openaiExtraConfig: MIDSCENE_GROUNDING_MODEL_INIT_CONFIG_JSON,
+  openaiBaseURL: MIDSCENE_GROUNDING_OPENAI_BASE_URL,
+  openaiApiKey: MIDSCENE_GROUNDING_OPENAI_API_KEY,
+  openaiExtraConfig: MIDSCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON,
   /**
    * Extra
    */
-  vlMode: MIDSCENE_GROUNDING_LOCATOR_MODE,
+  vlMode: MIDSCENE_GROUNDING_VL_MODE,
 } as const;
 
 export const PLANNING_MODEL_CONFIG_KEYS: IModelConfigKeys = {
@@ -96,18 +94,18 @@ export const PLANNING_MODEL_CONFIG_KEYS: IModelConfigKeys = {
   /**
    * proxy
    */
-  socksProxy: MIDSCENE_PLANNING_MODEL_SOCKS_PROXY,
-  httpProxy: MIDSCENE_PLANNING_MODEL_HTTP_PROXY,
+  socksProxy: MIDSCENE_PLANNING_OPENAI_SOCKS_PROXY,
+  httpProxy: MIDSCENE_PLANNING_OPENAI_HTTP_PROXY,
   /**
    * OpenAI
    */
-  openaiBaseURL: MIDSCENE_PLANNING_MODEL_BASE_URL,
-  openaiApiKey: MIDSCENE_PLANNING_MODEL_API_KEY,
-  openaiExtraConfig: MIDSCENE_PLANNING_MODEL_INIT_CONFIG_JSON,
+  openaiBaseURL: MIDSCENE_PLANNING_OPENAI_BASE_URL,
+  openaiApiKey: MIDSCENE_PLANNING_OPENAI_API_KEY,
+  openaiExtraConfig: MIDSCENE_PLANNING_OPENAI_INIT_CONFIG_JSON,
   /**
    * Extra
    */
-  vlMode: MIDSCENE_PLANNING_LOCATOR_MODE,
+  vlMode: MIDSCENE_PLANNING_VL_MODE,
 } as const;
 
 // modelConfig return default
@@ -116,18 +114,18 @@ export const DEFAULT_MODEL_CONFIG_KEYS: IModelConfigKeys = {
   /**
    * proxy
    */
-  socksProxy: MIDSCENE_MODEL_SOCKS_PROXY,
-  httpProxy: MIDSCENE_MODEL_HTTP_PROXY,
+  socksProxy: MIDSCENE_OPENAI_SOCKS_PROXY,
+  httpProxy: MIDSCENE_OPENAI_HTTP_PROXY,
   /**
    * OpenAI
    */
-  openaiBaseURL: MIDSCENE_MODEL_BASE_URL,
-  openaiApiKey: MIDSCENE_MODEL_API_KEY,
-  openaiExtraConfig: MIDSCENE_MODEL_INIT_CONFIG_JSON,
+  openaiBaseURL: MIDSCENE_OPENAI_BASE_URL,
+  openaiApiKey: MIDSCENE_OPENAI_API_KEY,
+  openaiExtraConfig: MIDSCENE_OPENAI_INIT_CONFIG_JSON,
   /**
    * Extra
    */
-  vlMode: MIDSCENE_LOCATOR_MODE,
+  vlMode: MIDSCENE_VL_MODE,
 } as const;
 
 // read from process.env
@@ -136,14 +134,14 @@ export const DEFAULT_MODEL_CONFIG_KEYS_LEGACY: IModelConfigKeys = {
   /**
    * proxy
    */
-  socksProxy: MIDSCENE_MODEL_SOCKS_PROXY,
-  httpProxy: MIDSCENE_MODEL_HTTP_PROXY,
+  socksProxy: MIDSCENE_OPENAI_SOCKS_PROXY,
+  httpProxy: MIDSCENE_OPENAI_HTTP_PROXY,
   /**
-   * Model API - Uses legacy OPENAI_* variables for backward compatibility
+   * OpenAI
    */
   openaiBaseURL: OPENAI_BASE_URL,
   openaiApiKey: OPENAI_API_KEY,
-  openaiExtraConfig: MIDSCENE_MODEL_INIT_CONFIG_JSON,
+  openaiExtraConfig: MIDSCENE_OPENAI_INIT_CONFIG_JSON,
   /**
    * Extra
    */

package/src/env/decide-model-config.ts

@@ -12,7 +12,6 @@ import {
   PLANNING_MODEL_CONFIG_KEYS,
   VQA_MODEL_CONFIG_KEYS,
 } from './constants';
-import { MODEL_API_KEY, MODEL_BASE_URL } from './types';
 
 import { getDebug } from '../logger';
 import { assert } from '../utils';
@@ -70,25 +69,8 @@ export const decideOpenaiSdkConfig = ({
 
   debugLog('enter decideOpenaiSdkConfig with keys:', keys);
 
-  // Implement compatibility logic: prefer new variable names (MODEL_*), fallback to old ones (OPENAI_*)
-  let openaiBaseURL: string | undefined;
-  let openaiApiKey: string | undefined;
-
-  // When using legacy keys (OPENAI_BASE_URL, OPENAI_API_KEY), check for new names first
-  if (keys.openaiBaseURL === 'OPENAI_BASE_URL') {
-    // Priority: MODEL_BASE_URL > OPENAI_BASE_URL
-    openaiBaseURL = provider[MODEL_BASE_URL] || provider[keys.openaiBaseURL];
-  } else {
-    openaiBaseURL = provider[keys.openaiBaseURL];
-  }
-
-  if (keys.openaiApiKey === 'OPENAI_API_KEY') {
-    // Priority: MODEL_API_KEY > OPENAI_API_KEY
-    openaiApiKey = provider[MODEL_API_KEY] || provider[keys.openaiApiKey];
-  } else {
-    openaiApiKey = provider[keys.openaiApiKey];
-  }
-
+  const openaiBaseURL = provider[keys.openaiBaseURL];
+  const openaiApiKey = provider[keys.openaiApiKey];
   const openaiExtraConfig = parseJson(
     keys.openaiExtraConfig,
     provider[keys.openaiExtraConfig],

package/src/env/init-debug.ts

@@ -1,26 +1,21 @@
 import { enableDebug } from '../logger';
 import { getBasicEnvValue } from './basic';
-import {
-  MIDSCENE_DEBUG_MODEL_PROFILE,
-  MIDSCENE_DEBUG_MODEL_RESPONSE,
-} from './types';
+import { MIDSCENE_DEBUG_AI_PROFILE, MIDSCENE_DEBUG_AI_RESPONSE } from './types';
 
 export const initDebugConfig = () => {
-  const shouldPrintTiming = getBasicEnvValue(MIDSCENE_DEBUG_MODEL_PROFILE);
+  const shouldPrintTiming = getBasicEnvValue(MIDSCENE_DEBUG_AI_PROFILE);
   let debugConfig = '';
   if (shouldPrintTiming) {
     console.warn(
-      'MIDSCENE_DEBUG_MODEL_PROFILE is deprecated, use DEBUG=midscene:ai:profile instead',
+      'MIDSCENE_DEBUG_AI_PROFILE is deprecated, use DEBUG=midscene:ai:profile instead',
     );
     debugConfig = 'ai:profile';
   }
-  const shouldPrintModelResponse = getBasicEnvValue(
-    MIDSCENE_DEBUG_MODEL_RESPONSE,
-  );
+  const shouldPrintAIResponse = getBasicEnvValue(MIDSCENE_DEBUG_AI_RESPONSE);
 
-  if (shouldPrintModelResponse) {
+  if (shouldPrintAIResponse) {
     console.warn(
-      'MIDSCENE_DEBUG_MODEL_RESPONSE is deprecated, use DEBUG=midscene:ai:response instead',
+      'MIDSCENE_DEBUG_AI_RESPONSE is deprecated, use DEBUG=midscene:ai:response instead',
     );
     if (debugConfig) {
       debugConfig = 'ai:*';

package/src/env/model-config-manager.ts

@@ -9,7 +9,6 @@ import type {
   IModelConfig,
   TIntent,
   TModelConfigFn,
-  TModelConfigFnInternal,
 } from './types';
 import { VL_MODE_RAW_VALID_VALUES as VL_MODES } from './types';
 
@@ -17,7 +16,7 @@ const ALL_INTENTS: TIntent[] = ['VQA', 'default', 'grounding', 'planning'];
 
 export type TIntentConfigMap = Record<
   TIntent,
-  ReturnType<TModelConfigFnInternal> | undefined
+  ReturnType<TModelConfigFn> | undefined
 >;
 
 export class ModelConfigManager {
@@ -38,18 +37,13 @@ export class ModelConfigManager {
     this.createOpenAIClientFn = createOpenAIClientFn;
     if (modelConfigFn) {
       this.isolatedMode = true;
-      // Cast to internal type - user function can optionally use intent parameter
-      // even though it's not shown in the type definition
-      const internalFn = modelConfigFn as unknown as TModelConfigFnInternal;
-      const intentConfigMap = this.calcIntentConfigMap(internalFn);
+      const intentConfigMap = this.calcIntentConfigMap(modelConfigFn);
       this.modelConfigMap =
         this.calcModelConfigMapBaseOnIntent(intentConfigMap);
     }
   }
 
-  private calcIntentConfigMap(
-    modelConfigFn: TModelConfigFnInternal,
-  ): TIntentConfigMap {
+  private calcIntentConfigMap(modelConfigFn: TModelConfigFn): TIntentConfigMap {
     const intentConfigMap: TIntentConfigMap = {
       VQA: undefined,
       default: undefined,