@midscene/shared 0.27.3-beta-20250825120123.0 → 0.27.3

package/dist/es/common.mjs

@@ -1,12 +1,13 @@
 import { existsSync, mkdirSync } from "node:fs";
 import { tmpdir } from "node:os";
 import node_path from "node:path";
-import { MIDSCENE_RUN_DIR, getAIConfig } from "./env/index.mjs";
+import { getBasicEnvValue } from "./env/basic.mjs";
+import { MIDSCENE_RUN_DIR } from "./env/types.mjs";
 import { ifInNode } from "./utils.mjs";
 const defaultRunDirName = 'midscene_run';
 const getMidsceneRunDir = ()=>{
     if (!ifInNode) return '';
-    return getAIConfig(MIDSCENE_RUN_DIR) || defaultRunDirName;
+    return getBasicEnvValue(MIDSCENE_RUN_DIR) || defaultRunDirName;
 };
 const getMidsceneRunBaseDir = ()=>{
     if (!ifInNode) return '';

package/dist/es/env/basic.mjs

@@ -0,0 +1,6 @@
+import { BASIC_ENV_KEYS } from "./types.mjs";
+const getBasicEnvValue = (key)=>{
+    if (!BASIC_ENV_KEYS.includes(key)) throw new Error(`getBasicEnvValue with key ${key} is not supported.`);
+    return process.env[key];
+};
+export { getBasicEnvValue };

package/dist/es/env/global-config.mjs

@@ -1,4 +1,7 @@
-import { ENV_KEYS, MATCH_BY_POSITION } from "./types.mjs";
+import { getDebug } from "../logger.mjs";
+import { initDebugConfig } from "./init-debug.mjs";
+import { decideModelConfig } from "./model-config.mjs";
+import { ALL_ENV_KEYS, BOOLEAN_ENV_KEYS, GLOBAL_ENV_KEYS, MATCH_BY_POSITION, MODEL_ENV_KEYS, NUMBER_ENV_KEYS, STRING_ENV_KEYS } from "./types.mjs";
 function _define_property(obj, key, value) {
     if (key in obj) Object.defineProperty(obj, key, {
         value: value,
@@ -9,13 +12,45 @@ function _define_property(obj, key, value) {
     else obj[key] = value;
     return obj;
 }
-const allConfigFromEnv = ()=>ENV_KEYS.reduce((p, name)=>({
+const allConfigFromEnv = ()=>ALL_ENV_KEYS.reduce((p, name)=>({
             ...p,
             [name]: process.env[name]
         }), Object.create(null));
+const GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG = 'GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG';
 class GlobalConfigManager {
+    initAllEnvConfig() {
+        const envConfig = allConfigFromEnv();
+        this.allConfig = (()=>{
+            if (this.override) {
+                this.debugLog('initAllConfig with override from overrideAIConfig');
+                const { newConfig, extendMode } = this.override;
+                if (extendMode) {
+                    this.debugLog('initAllConfig with extend mode from overrideAIConfig');
+                    return {
+                        ...envConfig,
+                        ...newConfig
+                    };
+                }
+                this.debugLog('initAllConfig without override mode from overrideAIConfig');
+                return {
+                    ...newConfig
+                };
+            }
+            this.debugLog('initAllConfig without override from overrideAIConfig');
+            return envConfig;
+        })();
+    }
+    createUninitializedError(message) {
+        const error = new Error(message);
+        error[GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG] = true;
+        return error;
+    }
     reset() {
+        console.warn('globalConfigManager.reset should only be called in Midscene owner unit test');
+        this.initialized = false;
         this.override = void 0;
+        this.allConfig = void 0;
+        this.keysHaveBeenRead = {};
         this.modelConfigByIntent = {
             VQA: void 0,
             default: void 0,
@@ -23,86 +58,102 @@ class GlobalConfigManager {
             planning: void 0
         };
     }
-    getAllConfig() {
-        const envConfig = allConfigFromEnv();
-        if (!this.override) return envConfig;
-        {
-            const { newConfig, extendMode } = this.override;
-            return extendMode ? {
-                ...envConfig,
-                ...newConfig
-            } : {
-                ...newConfig
-            };
+    init(modelConfigFn) {
+        if (this.initialized) throw new Error('GlobalConfigManager.init should be called only once');
+        const intents = [
+            'VQA',
+            'default',
+            'grounding',
+            'planning'
+        ];
+        this.initAllEnvConfig();
+        const intentConfigFromFn = {
+            VQA: void 0,
+            default: void 0,
+            grounding: void 0,
+            planning: void 0
+        };
+        if (modelConfigFn) for (const i of intents){
+            const result = modelConfigFn({
+                intent: i
+            });
+            if (!result) throw new Error(`The agent has an option named modelConfig is a function, but it return ${result} when call with intent ${i}, which should be a object.`);
+            intentConfigFromFn[i] = result;
         }
+        for (const i of intents){
+            const result = decideModelConfig({
+                intent: i,
+                allConfig: this.allConfig,
+                modelConfigFromFn: intentConfigFromFn[i]
+            });
+            this.modelConfigByIntent[i] = result;
+        }
+        this.initialized = true;
+    }
+    getModelConfigByIntent(intent) {
+        if (!this.initialized) throw this.createUninitializedError(`globalConfigManager is not initialized when call getModelConfigByIntent with intent ${intent}`);
+        return this.modelConfigByIntent[intent];
     }
-    getConfigValue(key) {
+    getEnvConfigValue(key) {
+        const allConfig = this.allConfig || process.env;
+        if (!STRING_ENV_KEYS.includes(key)) throw new Error(`getEnvConfigValue with key ${key} is not supported.`);
         if (key === MATCH_BY_POSITION) throw new Error('MATCH_BY_POSITION is deprecated, use MIDSCENE_USE_VL_MODEL instead');
-        const value = this.getAllConfig()[key];
+        const value = allConfig[key];
+        this.keysHaveBeenRead[key] = true;
         if ('string' == typeof value) return value.trim();
         return value;
     }
-    getConfigValueInBoolean(key) {
-        const value = this.getAllConfig()[key];
+    getEnvConfigInNumber(key) {
+        const allConfig = this.allConfig || process.env;
+        if (!NUMBER_ENV_KEYS.includes(key)) throw new Error(`getEnvConfigInNumber with key ${key} is not supported`);
+        const value = allConfig[key];
+        this.keysHaveBeenRead[key] = true;
+        return Number(value || '');
+    }
+    getEnvConfigInBoolean(key) {
+        const allConfig = this.allConfig || process.env;
+        if (!BOOLEAN_ENV_KEYS.includes(key)) throw new Error(`getEnvConfigInBoolean with key ${key} is not supported`);
+        const value = allConfig[key];
+        this.keysHaveBeenRead[key] = true;
         if (!value) return false;
         if (/^(true|1)$/i.test(value)) return true;
         if (/^(false|0)$/i.test(value)) return false;
         return !!value.trim();
     }
-    getConfigValueInNumber(key) {
-        const value = this.getAllConfig()[key];
-        return Number(value || '');
-    }
-    getConfigValueInJson(key) {
-        const config = this.getConfigValue(key);
-        try {
-            return config ? JSON.parse(config) : void 0;
-        } catch (error) {
-            throw new Error(`Failed to parse json config: ${key}. ${error.message}`, {
-                cause: error
-            });
-        }
-    }
     registerOverride(newConfig, extendMode = false) {
-        var _this_override;
-        const savedNewConfig = extendMode ? {
-            ...null == (_this_override = this.override) ? void 0 : _this_override.newConfig,
-            ...newConfig
-        } : newConfig;
+        if (this.initialized) throw new Error('overrideAIConfig must be called before Agent.constructor');
+        for(const key in newConfig){
+            if (![
+                ...GLOBAL_ENV_KEYS,
+                ...MODEL_ENV_KEYS
+            ].includes(key)) throw new Error(`Failed to override AI config, invalid key: ${key}`);
+            const value = newConfig[key];
+            if ('string' != typeof value) throw new Error(`Failed to override AI config, value for key ${key} must be a string, but got with type ${typeof value}`);
+            if (this.keysHaveBeenRead[key]) console.warn(`Warning: try to override AI config with key ${key} ,but it has been read.`);
+        }
         this.override = {
-            newConfig: savedNewConfig,
+            newConfig: {
+                ...newConfig
+            },
             extendMode
         };
-    }
-    getModelConfigFromFn(intent) {
-        return this.modelConfigByIntent[intent];
-    }
-    registerModelConfigFn(modelConfigFn) {
-        if ('function' != typeof modelConfigFn) throw new Error(`modelConfigFn must be a function when registerModelConfigFn, but got with type ${typeof modelConfigFn}`);
-        const intents = [
-            'VQA',
-            'default',
-            'grounding',
-            'planning'
-        ];
-        for (const i of intents){
-            const result = modelConfigFn({
-                intent: i
-            });
-            if (!result) throw new Error(`The agent has an option named modelConfig is a function, but it return ${result} when call with intent ${i}, which should be a object.`);
-            this.modelConfigByIntent[i] = result;
-        }
+        this.initAllEnvConfig();
     }
     constructor(){
         _define_property(this, "override", void 0);
-        _define_property(this, "modelConfigByIntent", void 0);
-        this.modelConfigByIntent = {
+        _define_property(this, "initialized", false);
+        _define_property(this, "debugLog", void 0);
+        _define_property(this, "modelConfigByIntent", {
             VQA: void 0,
             default: void 0,
             grounding: void 0,
             planning: void 0
-        };
+        });
+        _define_property(this, "allConfig", void 0);
+        _define_property(this, "keysHaveBeenRead", {});
+        initDebugConfig();
+        const debugLog = getDebug('ai:global-config');
+        this.debugLog = debugLog;
     }
 }
-const globalConfigManger = new GlobalConfigManager();
-export { globalConfigManger };
+export { GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG, GlobalConfigManager };

package/dist/es/env/helper.mjs

@@ -1,7 +1,4 @@
-import { enableDebug } from "../logger.mjs";
 import { assert } from "../utils.mjs";
-import { globalConfigManger } from "./global-config.mjs";
-import { MIDSCENE_DEBUG_AI_PROFILE, MIDSCENE_DEBUG_AI_RESPONSE } from "./types.mjs";
 const maskKey = (key, maskChar = '*')=>{
     if ('string' != typeof key || 0 === key.length) return key;
     const prefixLen = 3;
@@ -35,20 +32,6 @@ const maskConfig = (config)=>Object.fromEntries(Object.entries(config).map(([key
             value
         ];
     }));
-const initDebugConfig = ()=>{
-    const shouldPrintTiming = globalConfigManger.getConfigValueInBoolean(MIDSCENE_DEBUG_AI_PROFILE);
-    let debugConfig = '';
-    if (shouldPrintTiming) {
-        console.warn('MIDSCENE_DEBUG_AI_PROFILE is deprecated, use DEBUG=midscene:ai:profile instead');
-        debugConfig = 'ai:profile';
-    }
-    const shouldPrintAIResponse = globalConfigManger.getConfigValueInBoolean(MIDSCENE_DEBUG_AI_RESPONSE);
-    if (shouldPrintAIResponse) {
-        console.warn('MIDSCENE_DEBUG_AI_RESPONSE is deprecated, use DEBUG=midscene:ai:response instead');
-        debugConfig = debugConfig ? 'ai:*' : 'ai:call';
-    }
-    if (debugConfig) enableDebug(debugConfig);
-};
 const parseJson = (key, value)=>{
     if (value) try {
         return JSON.parse(value);
@@ -62,4 +45,4 @@ const createAssert = (modelNameKey, provider, modelName)=>(value, key, modelVend
         if (modelName) modelVendorFlag ? assert(value, `The ${key} must be a non-empty string because of the ${modelNameKey} is declared as ${modelName} and ${modelVendorFlag} has also been specified in ${provider}, but got: ${value}. Please check your config.`) : assert(value, `The ${key} must be a non-empty string because of the ${modelNameKey} is declared as ${modelName} in ${provider}, but got: ${value}. Please check your config.`);
         else assert(value, `The ${key} must be a non-empty string, but got: ${value}. Please check your config.`);
     };
-export { createAssert, initDebugConfig, maskConfig, parseJson };
+export { createAssert, maskConfig, parseJson };

package/dist/es/env/index.mjs

@@ -1,6 +1,4 @@
-import { globalConfigManger } from "./global-config.mjs";
-import { decideModelConfig } from "./model-config.mjs";
 import { UITarsModelVersion } from "./parse.mjs";
 export * from "./utils.mjs";
 export * from "./types.mjs";
-export { UITarsModelVersion, decideModelConfig, globalConfigManger };
+export { UITarsModelVersion };

package/dist/es/env/init-debug.mjs

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

package/dist/es/env/model-config.mjs

@@ -1,8 +1,8 @@
-import { globalConfigManger } from "./global-config.mjs";
 import { DEFAULT_MODEL_CONFIG_KEYS, DEFAULT_MODEL_CONFIG_KEYS_LEGACY, GROUNDING_MODEL_CONFIG_KEYS, PLANNING_MODEL_CONFIG_KEYS, VQA_MODEL_CONFIG_KEYS } from "./constants.mjs";
 import { getDebug } from "../logger.mjs";
 import { assert } from "../utils.mjs";
-import { createAssert, initDebugConfig, maskConfig, parseJson } from "./helper.mjs";
+import { createAssert, maskConfig, parseJson } from "./helper.mjs";
+import { initDebugConfig } from "./init-debug.mjs";
 import { parseVlModeAndUiTarsFromGlobalConfig, parseVlModeAndUiTarsFromRaw } from "./parse.mjs";
 const KEYS_MAP = {
     VQA: VQA_MODEL_CONFIG_KEYS,
@@ -12,7 +12,7 @@ const KEYS_MAP = {
 };
 const decideOpenaiSdkConfig = ({ keys, provider, valueAssert })=>{
     initDebugConfig();
-    const debugLog = getDebug('ai:decideModel');
+    const debugLog = getDebug('ai:globalConfig');
     const socksProxy = provider[keys.socksProxy];
     const httpProxy = provider[keys.httpProxy];
     const vlMode = provider[keys.vlMode];
@@ -91,12 +91,9 @@ const getModelDescription = (vlMode, uiTarsVersion)=>{
     else return `${vlMode} mode`;
     return '';
 };
-const decideModelConfig = (modelPreferences, withAssert)=>{
+const decideModelConfig = ({ intent, modelConfigFromFn, allConfig })=>{
     initDebugConfig();
-    const debugLog = getDebug('ai:decideModel');
-    debugLog('modelPreferences', modelPreferences);
-    const { intent } = modelPreferences;
-    const modelConfigFromFn = globalConfigManger.getModelConfigFromFn(intent);
+    const debugLog = getDebug('ai:globalConfig');
     if (modelConfigFromFn) {
         debugLog('decideModelConfig base on agent.modelConfig()');
         const keysForFn = KEYS_MAP[intent];
@@ -108,13 +105,13 @@ const decideModelConfig = (modelPreferences, withAssert)=>{
                 return keysForFn;
             }
             debugLog('query modelConfig from fn by intent got no corresponding modelName, will get other keys by default');
-            if (withAssert) assert(modelConfigFromFn[DEFAULT_MODEL_CONFIG_KEYS.modelName], `The return value of agent.modelConfig do not have a valid value with key ${DEFAULT_MODEL_CONFIG_KEYS.modelName}.`);
+            assert(modelConfigFromFn[DEFAULT_MODEL_CONFIG_KEYS.modelName], `The return value of agent.modelConfig do not have a valid value with key ${DEFAULT_MODEL_CONFIG_KEYS.modelName}.`);
             return DEFAULT_MODEL_CONFIG_KEYS;
         })();
         const result = decideOpenaiSdkConfig({
             keys: chosenKeys,
             provider: modelConfigFromFn,
-            valueAssert: withAssert ? createAssert(chosenKeys.modelName, 'modelConfig', candidateModelNameFromConfig) : ()=>{}
+            valueAssert: createAssert(chosenKeys.modelName, 'modelConfig', candidateModelNameFromConfig)
         });
         const { vlMode, uiTarsVersion } = parseVlModeAndUiTarsFromRaw(result.vlModeRaw);
         const modelDescription = getModelDescription(vlMode, uiTarsVersion);
@@ -126,10 +123,9 @@ const decideModelConfig = (modelPreferences, withAssert)=>{
             modelDescription,
             from: 'modelConfig'
         };
-        debugLog('decideModelConfig result by agent.modelConfig():', maskConfig(finalResult));
+        debugLog(`decideModelConfig result by agent.modelConfig() with intent ${intent}:`, maskConfig(finalResult));
         return finalResult;
     }
-    const allConfig = globalConfigManger.getAllConfig();
     const keysForEnv = 'default' === intent ? DEFAULT_MODEL_CONFIG_KEYS_LEGACY : KEYS_MAP[intent];
     const candidateModelNameFromEnv = allConfig[keysForEnv.modelName];
     debugLog(`Get value of ${keysForEnv.modelName} from globalConfig`, candidateModelNameFromEnv);
@@ -139,7 +135,7 @@ const decideModelConfig = (modelPreferences, withAssert)=>{
         const result = decideOpenaiSdkConfig({
             keys: keysForEnv,
             provider: allConfig,
-            valueAssert: withAssert ? createAssert(keysForEnv.modelName, 'process.env', modelName) : ()=>{}
+            valueAssert: createAssert(keysForEnv.modelName, 'process.env', modelName)
         });
         const { vlMode, uiTarsVersion } = parseVlModeAndUiTarsFromRaw(result.vlModeRaw);
         const modelDescription = getModelDescription(vlMode, uiTarsVersion);
@@ -151,14 +147,14 @@ const decideModelConfig = (modelPreferences, withAssert)=>{
             modelDescription,
             from: 'env'
         };
-        debugLog('decideModelConfig result by process.env with intent:', maskConfig(finalResult));
+        debugLog(`decideModelConfig result by process.env with intent ${intent}:`, maskConfig(finalResult));
         return finalResult;
     }
     debugLog(`decideModelConfig as legacy logic with intent ${intent}.`);
     const result = decideOpenaiSdkConfig({
         keys: DEFAULT_MODEL_CONFIG_KEYS_LEGACY,
         provider: allConfig,
-        valueAssert: withAssert ? createAssert(DEFAULT_MODEL_CONFIG_KEYS_LEGACY.modelName, 'process.env') : ()=>{}
+        valueAssert: createAssert(DEFAULT_MODEL_CONFIG_KEYS_LEGACY.modelName, 'process.env')
     });
     const { vlMode, uiTarsVersion } = parseVlModeAndUiTarsFromGlobalConfig(allConfig);
     const modelDescription = getModelDescription(vlMode, uiTarsVersion);
@@ -170,7 +166,7 @@ const decideModelConfig = (modelPreferences, withAssert)=>{
         modelDescription,
         from: 'legacy-env'
     };
-    debugLog('decideModelConfig result by legacy logic:', maskConfig(finalResult));
+    debugLog(`decideModelConfig result by legacy logic with intent ${intent}:`, maskConfig(finalResult));
     return finalResult;
 };
 export { decideModelConfig, decideOpenaiSdkConfig };

package/dist/es/env/types.mjs

@@ -102,29 +102,44 @@ const MIDSCENE_GROUNDING_USE_ANTHROPIC_SDK = 'MIDSCENE_GROUNDING_USE_ANTHROPIC_S
 const MIDSCENE_GROUNDING_ANTHROPIC_API_KEY = 'MIDSCENE_GROUNDING_ANTHROPIC_API_KEY';
 const MIDSCENE_GROUNDING_VL_MODE = 'MIDSCENE_GROUNDING_VL_MODE';
 const OPENAI_USE_AZURE = 'OPENAI_USE_AZURE';
-const ENV_KEYS = [
-    MIDSCENE_MCP_ANDROID_MODE,
-    DOCKER_CONTAINER,
+const UNUSED_ENV_KEYS = [
+    MIDSCENE_DANGEROUSLY_PRINT_ALL_CONFIG
+];
+const BASIC_ENV_KEYS = [
     MIDSCENE_DEBUG_MODE,
-    MIDSCENE_FORCE_DEEP_THINK,
-    MIDSCENE_LANGSMITH_DEBUG,
     MIDSCENE_DEBUG_AI_PROFILE,
     MIDSCENE_DEBUG_AI_RESPONSE,
-    MIDSCENE_DANGEROUSLY_PRINT_ALL_CONFIG,
+    MIDSCENE_RUN_DIR
+];
+const BOOLEAN_ENV_KEYS = [
+    MIDSCENE_CACHE,
+    MIDSCENE_LANGSMITH_DEBUG,
+    MIDSCENE_FORCE_DEEP_THINK,
+    MIDSCENE_MCP_USE_PUPPETEER_MODE,
+    MIDSCENE_MCP_ANDROID_MODE
+];
+const NUMBER_ENV_KEYS = [
     OPENAI_MAX_TOKENS,
+    MIDSCENE_CACHE_MAX_FILENAME_LENGTH,
+    MIDSCENE_REPLANNING_CYCLE_LIMIT
+];
+const STRING_ENV_KEYS = [
     MIDSCENE_ADB_PATH,
     MIDSCENE_ADB_REMOTE_HOST,
     MIDSCENE_ADB_REMOTE_PORT,
     MIDSCENE_ANDROID_IME_STRATEGY,
-    MIDSCENE_CACHE,
-    MATCH_BY_POSITION,
     MIDSCENE_REPORT_TAG_NAME,
-    MIDSCENE_MCP_USE_PUPPETEER_MODE,
-    MIDSCENE_MCP_CHROME_PATH,
-    MIDSCENE_RUN_DIR,
     MIDSCENE_PREFERRED_LANGUAGE,
-    MIDSCENE_REPLANNING_CYCLE_LIMIT,
-    MIDSCENE_CACHE_MAX_FILENAME_LENGTH,
+    MATCH_BY_POSITION,
+    MIDSCENE_MCP_CHROME_PATH,
+    DOCKER_CONTAINER
+];
+const GLOBAL_ENV_KEYS = [
+    ...BOOLEAN_ENV_KEYS,
+    ...NUMBER_ENV_KEYS,
+    ...STRING_ENV_KEYS
+];
+const MODEL_ENV_KEYS = [
     MIDSCENE_MODEL_NAME,
     MIDSCENE_OPENAI_INIT_CONFIG_JSON,
     MIDSCENE_OPENAI_API_KEY,
@@ -207,4 +222,10 @@ const ENV_KEYS = [
     MIDSCENE_GROUNDING_ANTHROPIC_API_KEY,
     MIDSCENE_GROUNDING_VL_MODE
 ];
-export { ANTHROPIC_API_KEY, AZURE_OPENAI_API_VERSION, AZURE_OPENAI_DEPLOYMENT, AZURE_OPENAI_ENDPOINT, AZURE_OPENAI_KEY, DOCKER_CONTAINER, ENV_KEYS, MATCH_BY_POSITION, MIDSCENE_ADB_PATH, MIDSCENE_ADB_REMOTE_HOST, MIDSCENE_ADB_REMOTE_PORT, MIDSCENE_ANDROID_IME_STRATEGY, MIDSCENE_ANTHROPIC_API_KEY, MIDSCENE_API_TYPE, MIDSCENE_AZURE_OPENAI_API_VERSION, MIDSCENE_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_AZURE_OPENAI_ENDPOINT, MIDSCENE_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_AZURE_OPENAI_KEY, MIDSCENE_AZURE_OPENAI_SCOPE, MIDSCENE_CACHE, MIDSCENE_CACHE_MAX_FILENAME_LENGTH, MIDSCENE_DANGEROUSLY_PRINT_ALL_CONFIG, MIDSCENE_DEBUG_AI_PROFILE, MIDSCENE_DEBUG_AI_RESPONSE, MIDSCENE_DEBUG_MODE, MIDSCENE_FORCE_DEEP_THINK, MIDSCENE_GROUNDING_ANTHROPIC_API_KEY, MIDSCENE_GROUNDING_AZURE_OPENAI_API_VERSION, MIDSCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_GROUNDING_AZURE_OPENAI_ENDPOINT, MIDSCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_GROUNDING_AZURE_OPENAI_KEY, MIDSCENE_GROUNDING_AZURE_OPENAI_SCOPE, MIDSCENE_GROUNDING_MODEL_NAME, 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_OPENAI_USE_AZURE, MIDSCENE_GROUNDING_USE_ANTHROPIC_SDK, MIDSCENE_GROUNDING_USE_AZURE_OPENAI, MIDSCENE_GROUNDING_VL_MODE, MIDSCENE_LANGSMITH_DEBUG, MIDSCENE_MCP_ANDROID_MODE, MIDSCENE_MCP_CHROME_PATH, MIDSCENE_MCP_USE_PUPPETEER_MODE, MIDSCENE_MODEL_NAME, MIDSCENE_OPENAI_API_KEY, MIDSCENE_OPENAI_BASE_URL, MIDSCENE_OPENAI_HTTP_PROXY, MIDSCENE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_OPENAI_SOCKS_PROXY, MIDSCENE_OPENAI_USE_AZURE, MIDSCENE_PLANNING_ANTHROPIC_API_KEY, MIDSCENE_PLANNING_AZURE_OPENAI_API_VERSION, MIDSCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_PLANNING_AZURE_OPENAI_ENDPOINT, MIDSCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_PLANNING_AZURE_OPENAI_KEY, MIDSCENE_PLANNING_AZURE_OPENAI_SCOPE, MIDSCENE_PLANNING_MODEL_NAME, 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_OPENAI_USE_AZURE, MIDSCENE_PLANNING_USE_ANTHROPIC_SDK, MIDSCENE_PLANNING_USE_AZURE_OPENAI, MIDSCENE_PLANNING_VL_MODE, MIDSCENE_PREFERRED_LANGUAGE, MIDSCENE_REPLANNING_CYCLE_LIMIT, MIDSCENE_REPORT_TAG_NAME, MIDSCENE_RUN_DIR, MIDSCENE_USE_ANTHROPIC_SDK, MIDSCENE_USE_AZURE_OPENAI, MIDSCENE_USE_DOUBAO_VISION, MIDSCENE_USE_GEMINI, MIDSCENE_USE_QWEN_VL, MIDSCENE_USE_VLM_UI_TARS, MIDSCENE_USE_VL_MODEL, MIDSCENE_VL_MODE, MIDSCENE_VQA_ANTHROPIC_API_KEY, MIDSCENE_VQA_AZURE_OPENAI_API_VERSION, MIDSCENE_VQA_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_VQA_AZURE_OPENAI_ENDPOINT, MIDSCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_VQA_AZURE_OPENAI_KEY, MIDSCENE_VQA_AZURE_OPENAI_SCOPE, MIDSCENE_VQA_MODEL_NAME, 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_OPENAI_USE_AZURE, MIDSCENE_VQA_USE_ANTHROPIC_SDK, MIDSCENE_VQA_USE_AZURE_OPENAI, MIDSCENE_VQA_VL_MODE, OPENAI_API_KEY, OPENAI_BASE_URL, OPENAI_MAX_TOKENS, OPENAI_USE_AZURE };
+const ALL_ENV_KEYS = [
+    ...UNUSED_ENV_KEYS,
+    ...BASIC_ENV_KEYS,
+    ...GLOBAL_ENV_KEYS,
+    ...MODEL_ENV_KEYS
+];
+export { ALL_ENV_KEYS, ANTHROPIC_API_KEY, AZURE_OPENAI_API_VERSION, AZURE_OPENAI_DEPLOYMENT, AZURE_OPENAI_ENDPOINT, AZURE_OPENAI_KEY, BASIC_ENV_KEYS, BOOLEAN_ENV_KEYS, DOCKER_CONTAINER, GLOBAL_ENV_KEYS, MATCH_BY_POSITION, MIDSCENE_ADB_PATH, MIDSCENE_ADB_REMOTE_HOST, MIDSCENE_ADB_REMOTE_PORT, MIDSCENE_ANDROID_IME_STRATEGY, MIDSCENE_ANTHROPIC_API_KEY, MIDSCENE_API_TYPE, MIDSCENE_AZURE_OPENAI_API_VERSION, MIDSCENE_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_AZURE_OPENAI_ENDPOINT, MIDSCENE_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_AZURE_OPENAI_KEY, MIDSCENE_AZURE_OPENAI_SCOPE, MIDSCENE_CACHE, MIDSCENE_CACHE_MAX_FILENAME_LENGTH, MIDSCENE_DANGEROUSLY_PRINT_ALL_CONFIG, MIDSCENE_DEBUG_AI_PROFILE, MIDSCENE_DEBUG_AI_RESPONSE, MIDSCENE_DEBUG_MODE, MIDSCENE_FORCE_DEEP_THINK, MIDSCENE_GROUNDING_ANTHROPIC_API_KEY, MIDSCENE_GROUNDING_AZURE_OPENAI_API_VERSION, MIDSCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_GROUNDING_AZURE_OPENAI_ENDPOINT, MIDSCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_GROUNDING_AZURE_OPENAI_KEY, MIDSCENE_GROUNDING_AZURE_OPENAI_SCOPE, MIDSCENE_GROUNDING_MODEL_NAME, 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_OPENAI_USE_AZURE, MIDSCENE_GROUNDING_USE_ANTHROPIC_SDK, MIDSCENE_GROUNDING_USE_AZURE_OPENAI, MIDSCENE_GROUNDING_VL_MODE, MIDSCENE_LANGSMITH_DEBUG, MIDSCENE_MCP_ANDROID_MODE, MIDSCENE_MCP_CHROME_PATH, MIDSCENE_MCP_USE_PUPPETEER_MODE, MIDSCENE_MODEL_NAME, MIDSCENE_OPENAI_API_KEY, MIDSCENE_OPENAI_BASE_URL, MIDSCENE_OPENAI_HTTP_PROXY, MIDSCENE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_OPENAI_SOCKS_PROXY, MIDSCENE_OPENAI_USE_AZURE, MIDSCENE_PLANNING_ANTHROPIC_API_KEY, MIDSCENE_PLANNING_AZURE_OPENAI_API_VERSION, MIDSCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_PLANNING_AZURE_OPENAI_ENDPOINT, MIDSCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_PLANNING_AZURE_OPENAI_KEY, MIDSCENE_PLANNING_AZURE_OPENAI_SCOPE, MIDSCENE_PLANNING_MODEL_NAME, 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_OPENAI_USE_AZURE, MIDSCENE_PLANNING_USE_ANTHROPIC_SDK, MIDSCENE_PLANNING_USE_AZURE_OPENAI, MIDSCENE_PLANNING_VL_MODE, MIDSCENE_PREFERRED_LANGUAGE, MIDSCENE_REPLANNING_CYCLE_LIMIT, MIDSCENE_REPORT_TAG_NAME, MIDSCENE_RUN_DIR, MIDSCENE_USE_ANTHROPIC_SDK, MIDSCENE_USE_AZURE_OPENAI, MIDSCENE_USE_DOUBAO_VISION, MIDSCENE_USE_GEMINI, MIDSCENE_USE_QWEN_VL, MIDSCENE_USE_VLM_UI_TARS, MIDSCENE_USE_VL_MODEL, MIDSCENE_VL_MODE, MIDSCENE_VQA_ANTHROPIC_API_KEY, MIDSCENE_VQA_AZURE_OPENAI_API_VERSION, MIDSCENE_VQA_AZURE_OPENAI_DEPLOYMENT, MIDSCENE_VQA_AZURE_OPENAI_ENDPOINT, MIDSCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_VQA_AZURE_OPENAI_KEY, MIDSCENE_VQA_AZURE_OPENAI_SCOPE, MIDSCENE_VQA_MODEL_NAME, 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_OPENAI_USE_AZURE, MIDSCENE_VQA_USE_ANTHROPIC_SDK, MIDSCENE_VQA_USE_AZURE_OPENAI, MIDSCENE_VQA_VL_MODE, MODEL_ENV_KEYS, NUMBER_ENV_KEYS, OPENAI_API_KEY, OPENAI_BASE_URL, OPENAI_MAX_TOKENS, OPENAI_USE_AZURE, STRING_ENV_KEYS, UNUSED_ENV_KEYS };

package/dist/es/env/utils.mjs

@@ -1,43 +1,53 @@
-import { globalConfigManger } from "./global-config.mjs";
-import { decideModelConfig } from "./model-config.mjs";
-import { MIDSCENE_OPENAI_INIT_CONFIG_JSON, MIDSCENE_PREFERRED_LANGUAGE } from "./types.mjs";
+import { GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG, GlobalConfigManager } from "./global-config.mjs";
+import { MIDSCENE_PREFERRED_LANGUAGE } from "./types.mjs";
+const globalConfigManager = new GlobalConfigManager();
 const uiTarsModelVersion = (modelPreferences)=>{
-    const { uiTarsVersion } = decideModelConfig(modelPreferences, false);
-    return uiTarsVersion;
+    try {
+        const result = globalConfigManager.getModelConfigByIntent(modelPreferences.intent);
+        return result.uiTarsVersion;
+    } catch (e) {
+        if (null == e ? void 0 : e[GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG]) return void console.warn("Call uiTarsModelVersion before globalConfig init, will return undefined. This warning should only appear in midscene's own unit tests.");
+        throw e;
+    }
 };
 const vlLocateMode = (modelPreferences)=>{
-    const { vlMode } = decideModelConfig(modelPreferences, false);
-    return vlMode;
+    try {
+        const result = globalConfigManager.getModelConfigByIntent(modelPreferences.intent);
+        return result.vlMode;
+    } catch (e) {
+        if (null == e ? void 0 : e[GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG]) return void console.warn("Call vlLocateMode before globalConfig init, will return undefined. This warning should only appear in midscene's own unit tests.");
+        throw e;
+    }
 };
 const getIsUseQwenVl = (modelPreferences)=>{
-    const modelConfig = decideModelConfig(modelPreferences, false);
-    return 'qwen-vl' === modelConfig.vlMode;
+    try {
+        const result = globalConfigManager.getModelConfigByIntent(modelPreferences.intent);
+        return 'qwen-vl' === result.vlMode;
+    } catch (e) {
+        if (null == e ? void 0 : e[GLOBAL_CONFIG_MANAGER_UNINITIALIZED_FLAG]) {
+            console.warn("Call getIsUseQwenVl before globalConfig init, will return false. This warning should only appear in midscene's own unit tests.");
+            return false;
+        }
+        throw e;
+    }
 };
 function getModelName(modelPreferences) {
-    const modelConfig = decideModelConfig(modelPreferences, false);
-    return modelConfig.modelName;
+    const result = globalConfigManager.getModelConfigByIntent(modelPreferences.intent);
+    return null == result ? void 0 : result.modelName;
 }
 const getPreferredLanguage = ()=>{
-    const prefer = globalConfigManger.getConfigValue(MIDSCENE_PREFERRED_LANGUAGE);
+    const prefer = globalConfigManager.getEnvConfigValue(MIDSCENE_PREFERRED_LANGUAGE);
     if (prefer) return prefer;
     const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
     const isChina = 'Asia/Shanghai' === timeZone;
     return isChina ? 'Chinese' : 'English';
 };
 const getUploadTestServerUrl = ()=>{
-    const extraConfig = globalConfigManger.getConfigValueInJson(MIDSCENE_OPENAI_INIT_CONFIG_JSON);
-    const serverUrl = null == extraConfig ? void 0 : extraConfig.REPORT_SERVER_URL;
+    const { openaiExtraConfig } = globalConfigManager.getModelConfigByIntent('default');
+    const serverUrl = null == openaiExtraConfig ? void 0 : openaiExtraConfig.REPORT_SERVER_URL;
     return serverUrl;
 };
-const getAIConfig = (configKey)=>globalConfigManger.getConfigValue(configKey);
-const getAIConfigInBoolean = (configKey)=>globalConfigManger.getConfigValueInBoolean(configKey);
-const getAIConfigInNumber = (configKey)=>globalConfigManger.getConfigValueInNumber(configKey);
 const overrideAIConfig = (newConfig, extendMode = false)=>{
-    for(const key in newConfig){
-        if ('string' != typeof key) throw new Error(`Failed to override AI config, invalid key: ${key}`);
-        const value = newConfig[key];
-        if ('string' != typeof value) throw new Error(`Failed to override AI config, value for key ${key} must be a string, but got with type ${typeof value}`);
-    }
-    globalConfigManger.registerOverride(newConfig, extendMode);
+    globalConfigManager.registerOverride(newConfig, extendMode);
 };
-export { getAIConfig, getAIConfigInBoolean, getAIConfigInNumber, getIsUseQwenVl, getModelName, getPreferredLanguage, getUploadTestServerUrl, overrideAIConfig, uiTarsModelVersion, vlLocateMode };
+export { getIsUseQwenVl, getModelName, getPreferredLanguage, getUploadTestServerUrl, globalConfigManager, overrideAIConfig, uiTarsModelVersion, vlLocateMode };

package/dist/lib/common.js

@@ -43,12 +43,13 @@ const external_node_fs_namespaceObject = require("node:fs");
 const external_node_os_namespaceObject = require("node:os");
 const external_node_path_namespaceObject = require("node:path");
 var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
-const index_js_namespaceObject = require("./env/index.js");
+const basic_js_namespaceObject = require("./env/basic.js");
+const types_js_namespaceObject = require("./env/types.js");
 const external_utils_js_namespaceObject = require("./utils.js");
 const defaultRunDirName = 'midscene_run';
 const getMidsceneRunDir = ()=>{
     if (!external_utils_js_namespaceObject.ifInNode) return '';
-    return (0, index_js_namespaceObject.getAIConfig)(index_js_namespaceObject.MIDSCENE_RUN_DIR) || defaultRunDirName;
+    return (0, basic_js_namespaceObject.getBasicEnvValue)(types_js_namespaceObject.MIDSCENE_RUN_DIR) || defaultRunDirName;
 };
 const getMidsceneRunBaseDir = ()=>{
     if (!external_utils_js_namespaceObject.ifInNode) return '';

package/dist/lib/env/basic.js

@@ -0,0 +1,40 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    getBasicEnvValue: ()=>getBasicEnvValue
+});
+const external_types_js_namespaceObject = require("./types.js");
+const getBasicEnvValue = (key)=>{
+    if (!external_types_js_namespaceObject.BASIC_ENV_KEYS.includes(key)) throw new Error(`getBasicEnvValue with key ${key} is not supported.`);
+    return process.env[key];
+};
+exports.getBasicEnvValue = __webpack_exports__.getBasicEnvValue;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "getBasicEnvValue"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});