@rpascene/shared 0.30.8

package/dist/types/env/types.d.ts

@@ -0,0 +1,295 @@
+export declare const RPASCENE_OPENAI_INIT_CONFIG_JSON = "RPASCENE_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_MODEL_NAME = "RPASCENE_MODEL_NAME";
+export declare const RPASCENE_LANGSMITH_DEBUG = "RPASCENE_LANGSMITH_DEBUG";
+export declare const RPASCENE_DEBUG_AI_PROFILE = "RPASCENE_DEBUG_AI_PROFILE";
+export declare const RPASCENE_DEBUG_AI_RESPONSE = "RPASCENE_DEBUG_AI_RESPONSE";
+export declare const RPASCENE_DANGEROUSLY_PRINT_ALL_CONFIG = "RPASCENE_DANGEROUSLY_PRINT_ALL_CONFIG";
+export declare const RPASCENE_DEBUG_MODE = "RPASCENE_DEBUG_MODE";
+export declare const RPASCENE_MCP_USE_PUPPETEER_MODE = "RPASCENE_MCP_USE_PUPPETEER_MODE";
+export declare const RPASCENE_MCP_CHROME_PATH = "RPASCENE_MCP_CHROME_PATH";
+export declare const RPASCENE_MCP_ANDROID_MODE = "RPASCENE_MCP_ANDROID_MODE";
+export declare const DOCKER_CONTAINER = "DOCKER_CONTAINER";
+export declare const RPASCENE_FORCE_DEEP_THINK = "RPASCENE_FORCE_DEEP_THINK";
+export declare const RPASCENE_OPENAI_SOCKS_PROXY = "RPASCENE_OPENAI_SOCKS_PROXY";
+export declare const RPASCENE_OPENAI_HTTP_PROXY = "RPASCENE_OPENAI_HTTP_PROXY";
+export declare const OPENAI_API_KEY = "OPENAI_API_KEY";
+export declare const OPENAI_BASE_URL = "OPENAI_BASE_URL";
+export declare const OPENAI_MAX_TOKENS = "OPENAI_MAX_TOKENS";
+export declare const RPASCENE_ADB_PATH = "RPASCENE_ADB_PATH";
+export declare const RPASCENE_ADB_REMOTE_HOST = "RPASCENE_ADB_REMOTE_HOST";
+export declare const RPASCENE_ADB_REMOTE_PORT = "RPASCENE_ADB_REMOTE_PORT";
+export declare const RPASCENE_ANDROID_IME_STRATEGY = "RPASCENE_ANDROID_IME_STRATEGY";
+export declare const RPASCENE_IOS_DEVICE_UDID = "RPASCENE_IOS_DEVICE_UDID";
+export declare const RPASCENE_IOS_SIMULATOR_UDID = "RPASCENE_IOS_SIMULATOR_UDID";
+export declare const RPASCENE_CACHE = "RPASCENE_CACHE";
+export declare const RPASCENE_USE_VLM_UI_TARS = "RPASCENE_USE_VLM_UI_TARS";
+export declare const RPASCENE_USE_QWEN_VL = "RPASCENE_USE_QWEN_VL";
+export declare const RPASCENE_USE_QWEN3_VL = "RPASCENE_USE_QWEN3_VL";
+export declare const RPASCENE_USE_DOUBAO_VISION = "RPASCENE_USE_DOUBAO_VISION";
+export declare const RPASCENE_USE_GEMINI = "RPASCENE_USE_GEMINI";
+export declare const RPASCENE_USE_VL_MODEL = "RPASCENE_USE_VL_MODEL";
+export declare const MATCH_BY_POSITION = "MATCH_BY_POSITION";
+export declare const RPASCENE_API_TYPE = "RPASCENE-API-TYPE";
+export declare const RPASCENE_REPORT_TAG_NAME = "RPASCENE_REPORT_TAG_NAME";
+export declare const RPASCENE_REPLANNING_CYCLE_LIMIT = "RPASCENE_REPLANNING_CYCLE_LIMIT";
+export declare const RPASCENE_PREFERRED_LANGUAGE = "RPASCENE_PREFERRED_LANGUAGE";
+export declare const RPASCENE_USE_AZURE_OPENAI = "RPASCENE_USE_AZURE_OPENAI";
+export declare const RPASCENE_AZURE_OPENAI_SCOPE = "RPASCENE_AZURE_OPENAI_SCOPE";
+export declare const RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON = "RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_CACHE_MAX_FILENAME_LENGTH = "RPASCENE_CACHE_MAX_FILENAME_LENGTH";
+export declare const AZURE_OPENAI_ENDPOINT = "AZURE_OPENAI_ENDPOINT";
+export declare const AZURE_OPENAI_KEY = "AZURE_OPENAI_KEY";
+export declare const AZURE_OPENAI_API_VERSION = "AZURE_OPENAI_API_VERSION";
+export declare const AZURE_OPENAI_DEPLOYMENT = "AZURE_OPENAI_DEPLOYMENT";
+export declare const RPASCENE_USE_ANTHROPIC_SDK = "RPASCENE_USE_ANTHROPIC_SDK";
+export declare const ANTHROPIC_API_KEY = "ANTHROPIC_API_KEY";
+export declare const RPASCENE_RUN_DIR = "RPASCENE_RUN_DIR";
+export declare const RPASCENE_OPENAI_BASE_URL = "RPASCENE_OPENAI_BASE_URL";
+export declare const RPASCENE_OPENAI_API_KEY = "RPASCENE_OPENAI_API_KEY";
+export declare const RPASCENE_OPENAI_USE_AZURE = "RPASCENE_OPENAI_USE_AZURE";
+export declare const RPASCENE_AZURE_OPENAI_KEY = "RPASCENE_AZURE_OPENAI_KEY";
+export declare const RPASCENE_AZURE_OPENAI_ENDPOINT = "RPASCENE_AZURE_OPENAI_ENDPOINT";
+export declare const RPASCENE_AZURE_OPENAI_API_VERSION = "RPASCENE_AZURE_OPENAI_API_VERSION";
+export declare const RPASCENE_AZURE_OPENAI_DEPLOYMENT = "RPASCENE_AZURE_OPENAI_DEPLOYMENT";
+export declare const RPASCENE_ANTHROPIC_API_KEY = "RPASCENE_ANTHROPIC_API_KEY";
+export declare const RPASCENE_VL_MODE = "RPASCENE_VL_MODE";
+export declare const RPASCENE_VQA_MODEL_NAME = "RPASCENE_VQA_MODEL_NAME";
+export declare const RPASCENE_VQA_OPENAI_SOCKS_PROXY = "RPASCENE_VQA_OPENAI_SOCKS_PROXY";
+export declare const RPASCENE_VQA_OPENAI_HTTP_PROXY = "RPASCENE_VQA_OPENAI_HTTP_PROXY";
+export declare const RPASCENE_VQA_OPENAI_BASE_URL = "RPASCENE_VQA_OPENAI_BASE_URL";
+export declare const RPASCENE_VQA_OPENAI_API_KEY = "RPASCENE_VQA_OPENAI_API_KEY";
+export declare const RPASCENE_VQA_OPENAI_INIT_CONFIG_JSON = "RPASCENE_VQA_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_VQA_OPENAI_USE_AZURE = "RPASCENE_VQA_OPENAI_USE_AZURE";
+export declare const RPASCENE_VQA_USE_AZURE_OPENAI = "RPASCENE_VQA_USE_AZURE_OPENAI";
+export declare const RPASCENE_VQA_AZURE_OPENAI_SCOPE = "RPASCENE_VQA_AZURE_OPENAI_SCOPE";
+export declare const RPASCENE_VQA_AZURE_OPENAI_KEY = "RPASCENE_VQA_AZURE_OPENAI_KEY";
+export declare const RPASCENE_VQA_AZURE_OPENAI_ENDPOINT = "RPASCENE_VQA_AZURE_OPENAI_ENDPOINT";
+export declare const RPASCENE_VQA_AZURE_OPENAI_API_VERSION = "RPASCENE_VQA_AZURE_OPENAI_API_VERSION";
+export declare const RPASCENE_VQA_AZURE_OPENAI_DEPLOYMENT = "RPASCENE_VQA_AZURE_OPENAI_DEPLOYMENT";
+export declare const RPASCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON = "RPASCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_VQA_USE_ANTHROPIC_SDK = "RPASCENE_VQA_USE_ANTHROPIC_SDK";
+export declare const RPASCENE_VQA_ANTHROPIC_API_KEY = "RPASCENE_VQA_ANTHROPIC_API_KEY";
+export declare const RPASCENE_VQA_VL_MODE = "RPASCENE_VQA_VL_MODE";
+export declare const RPASCENE_PLANNING_MODEL_NAME = "RPASCENE_PLANNING_MODEL_NAME";
+export declare const RPASCENE_PLANNING_OPENAI_SOCKS_PROXY = "RPASCENE_PLANNING_OPENAI_SOCKS_PROXY";
+export declare const RPASCENE_PLANNING_OPENAI_HTTP_PROXY = "RPASCENE_PLANNING_OPENAI_HTTP_PROXY";
+export declare const RPASCENE_PLANNING_OPENAI_BASE_URL = "RPASCENE_PLANNING_OPENAI_BASE_URL";
+export declare const RPASCENE_PLANNING_OPENAI_API_KEY = "RPASCENE_PLANNING_OPENAI_API_KEY";
+export declare const RPASCENE_PLANNING_OPENAI_INIT_CONFIG_JSON = "RPASCENE_PLANNING_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_PLANNING_OPENAI_USE_AZURE = "RPASCENE_PLANNING_OPENAI_USE_AZURE";
+export declare const RPASCENE_PLANNING_USE_AZURE_OPENAI = "RPASCENE_PLANNING_USE_AZURE_OPENAI";
+export declare const RPASCENE_PLANNING_AZURE_OPENAI_SCOPE = "RPASCENE_PLANNING_AZURE_OPENAI_SCOPE";
+export declare const RPASCENE_PLANNING_AZURE_OPENAI_KEY = "RPASCENE_PLANNING_AZURE_OPENAI_KEY";
+export declare const RPASCENE_PLANNING_AZURE_OPENAI_ENDPOINT = "RPASCENE_PLANNING_AZURE_OPENAI_ENDPOINT";
+export declare const RPASCENE_PLANNING_AZURE_OPENAI_API_VERSION = "RPASCENE_PLANNING_AZURE_OPENAI_API_VERSION";
+export declare const RPASCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT = "RPASCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT";
+export declare const RPASCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON = "RPASCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_PLANNING_USE_ANTHROPIC_SDK = "RPASCENE_PLANNING_USE_ANTHROPIC_SDK";
+export declare const RPASCENE_PLANNING_ANTHROPIC_API_KEY = "RPASCENE_PLANNING_ANTHROPIC_API_KEY";
+export declare const RPASCENE_PLANNING_VL_MODE = "RPASCENE_PLANNING_VL_MODE";
+export declare const RPASCENE_GROUNDING_MODEL_NAME = "RPASCENE_GROUNDING_MODEL_NAME";
+export declare const RPASCENE_GROUNDING_OPENAI_SOCKS_PROXY = "RPASCENE_GROUNDING_OPENAI_SOCKS_PROXY";
+export declare const RPASCENE_GROUNDING_OPENAI_HTTP_PROXY = "RPASCENE_GROUNDING_OPENAI_HTTP_PROXY";
+export declare const RPASCENE_GROUNDING_OPENAI_BASE_URL = "RPASCENE_GROUNDING_OPENAI_BASE_URL";
+export declare const RPASCENE_GROUNDING_OPENAI_API_KEY = "RPASCENE_GROUNDING_OPENAI_API_KEY";
+export declare const RPASCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON = "RPASCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_GROUNDING_OPENAI_USE_AZURE = "RPASCENE_GROUNDING_OPENAI_USE_AZURE";
+export declare const RPASCENE_GROUNDING_USE_AZURE_OPENAI = "RPASCENE_GROUNDING_USE_AZURE_OPENAI";
+export declare const RPASCENE_GROUNDING_AZURE_OPENAI_SCOPE = "RPASCENE_GROUNDING_AZURE_OPENAI_SCOPE";
+export declare const RPASCENE_GROUNDING_AZURE_OPENAI_KEY = "RPASCENE_GROUNDING_AZURE_OPENAI_KEY";
+export declare const RPASCENE_GROUNDING_AZURE_OPENAI_ENDPOINT = "RPASCENE_GROUNDING_AZURE_OPENAI_ENDPOINT";
+export declare const RPASCENE_GROUNDING_AZURE_OPENAI_API_VERSION = "RPASCENE_GROUNDING_AZURE_OPENAI_API_VERSION";
+export declare const RPASCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT = "RPASCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT";
+export declare const RPASCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON = "RPASCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON";
+export declare const RPASCENE_GROUNDING_USE_ANTHROPIC_SDK = "RPASCENE_GROUNDING_USE_ANTHROPIC_SDK";
+export declare const RPASCENE_GROUNDING_ANTHROPIC_API_KEY = "RPASCENE_GROUNDING_ANTHROPIC_API_KEY";
+export declare const RPASCENE_GROUNDING_VL_MODE = "RPASCENE_GROUNDING_VL_MODE";
+export declare const OPENAI_USE_AZURE = "OPENAI_USE_AZURE";
+/**
+ * env keys declared but unused
+ */
+export declare const UNUSED_ENV_KEYS: string[];
+/**
+ * env keys for debug or basic run
+ * can not be override by overrideAIConfig
+ */
+export declare const BASIC_ENV_KEYS: readonly ["RPASCENE_DEBUG_MODE", "RPASCENE_DEBUG_AI_PROFILE", "RPASCENE_DEBUG_AI_RESPONSE", "RPASCENE_RUN_DIR"];
+export declare const BOOLEAN_ENV_KEYS: readonly ["RPASCENE_CACHE", "RPASCENE_LANGSMITH_DEBUG", "RPASCENE_FORCE_DEEP_THINK", "RPASCENE_MCP_USE_PUPPETEER_MODE", "RPASCENE_MCP_ANDROID_MODE"];
+export declare const NUMBER_ENV_KEYS: readonly ["RPASCENE_CACHE_MAX_FILENAME_LENGTH", "RPASCENE_REPLANNING_CYCLE_LIMIT"];
+export declare const STRING_ENV_KEYS: readonly ["OPENAI_MAX_TOKENS", "RPASCENE_ADB_PATH", "RPASCENE_ADB_REMOTE_HOST", "RPASCENE_ADB_REMOTE_PORT", "RPASCENE_ANDROID_IME_STRATEGY", "RPASCENE_IOS_DEVICE_UDID", "RPASCENE_IOS_SIMULATOR_UDID", "RPASCENE_REPORT_TAG_NAME", "RPASCENE_PREFERRED_LANGUAGE", "MATCH_BY_POSITION", "RPASCENE_MCP_CHROME_PATH", "DOCKER_CONTAINER"];
+/**
+ * Non model related env keys, used for globally controlling the behavior of rpascene
+ * Can not be override by agent.modelConfig but can be override by overrideAIConfig
+ * Can be access at any time
+ */
+export declare const GLOBAL_ENV_KEYS: readonly ["RPASCENE_CACHE", "RPASCENE_LANGSMITH_DEBUG", "RPASCENE_FORCE_DEEP_THINK", "RPASCENE_MCP_USE_PUPPETEER_MODE", "RPASCENE_MCP_ANDROID_MODE", "RPASCENE_CACHE_MAX_FILENAME_LENGTH", "RPASCENE_REPLANNING_CYCLE_LIMIT", "OPENAI_MAX_TOKENS", "RPASCENE_ADB_PATH", "RPASCENE_ADB_REMOTE_HOST", "RPASCENE_ADB_REMOTE_PORT", "RPASCENE_ANDROID_IME_STRATEGY", "RPASCENE_IOS_DEVICE_UDID", "RPASCENE_IOS_SIMULATOR_UDID", "RPASCENE_REPORT_TAG_NAME", "RPASCENE_PREFERRED_LANGUAGE", "MATCH_BY_POSITION", "RPASCENE_MCP_CHROME_PATH", "DOCKER_CONTAINER"];
+/**
+ * Model related eve keys, used for declare which model to use.
+ * Can be override by both agent.modelConfig and overrideAIConfig
+ * Can only be access after agent.constructor
+ */
+export declare const MODEL_ENV_KEYS: readonly ["RPASCENE_MODEL_NAME", "RPASCENE_OPENAI_INIT_CONFIG_JSON", "RPASCENE_OPENAI_API_KEY", "RPASCENE_OPENAI_BASE_URL", "RPASCENE_OPENAI_USE_AZURE", "RPASCENE_OPENAI_SOCKS_PROXY", "RPASCENE_OPENAI_HTTP_PROXY", "RPASCENE_USE_AZURE_OPENAI", "RPASCENE_AZURE_OPENAI_SCOPE", "RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON", "RPASCENE_USE_ANTHROPIC_SDK", "RPASCENE_USE_VLM_UI_TARS", "RPASCENE_USE_QWEN_VL", "RPASCENE_USE_QWEN3_VL", "RPASCENE_USE_DOUBAO_VISION", "RPASCENE_USE_GEMINI", "RPASCENE_USE_VL_MODEL", "ANTHROPIC_API_KEY", "RPASCENE_AZURE_OPENAI_ENDPOINT", "RPASCENE_AZURE_OPENAI_KEY", "RPASCENE_AZURE_OPENAI_API_VERSION", "RPASCENE_AZURE_OPENAI_DEPLOYMENT", "RPASCENE_VL_MODE", "OPENAI_API_KEY", "OPENAI_BASE_URL", "OPENAI_USE_AZURE", "ANTHROPIC_API_KEY", "AZURE_OPENAI_ENDPOINT", "AZURE_OPENAI_KEY", "AZURE_OPENAI_API_VERSION", "AZURE_OPENAI_DEPLOYMENT", "RPASCENE_VQA_MODEL_NAME", "RPASCENE_VQA_OPENAI_SOCKS_PROXY", "RPASCENE_VQA_OPENAI_HTTP_PROXY", "RPASCENE_VQA_OPENAI_BASE_URL", "RPASCENE_VQA_OPENAI_API_KEY", "RPASCENE_VQA_OPENAI_INIT_CONFIG_JSON", "RPASCENE_VQA_OPENAI_USE_AZURE", "RPASCENE_VQA_USE_AZURE_OPENAI", "RPASCENE_VQA_AZURE_OPENAI_SCOPE", "RPASCENE_VQA_AZURE_OPENAI_KEY", "RPASCENE_VQA_AZURE_OPENAI_ENDPOINT", "RPASCENE_VQA_AZURE_OPENAI_API_VERSION", "RPASCENE_VQA_AZURE_OPENAI_DEPLOYMENT", "RPASCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON", "RPASCENE_VQA_USE_ANTHROPIC_SDK", "RPASCENE_VQA_ANTHROPIC_API_KEY", "RPASCENE_VQA_VL_MODE", "RPASCENE_PLANNING_MODEL_NAME", "RPASCENE_PLANNING_OPENAI_SOCKS_PROXY", "RPASCENE_PLANNING_OPENAI_HTTP_PROXY", "RPASCENE_PLANNING_OPENAI_BASE_URL", "RPASCENE_PLANNING_OPENAI_API_KEY", "RPASCENE_PLANNING_OPENAI_INIT_CONFIG_JSON", "RPASCENE_PLANNING_OPENAI_USE_AZURE", "RPASCENE_PLANNING_USE_AZURE_OPENAI", "RPASCENE_PLANNING_AZURE_OPENAI_SCOPE", "RPASCENE_PLANNING_AZURE_OPENAI_KEY", "RPASCENE_PLANNING_AZURE_OPENAI_ENDPOINT", "RPASCENE_PLANNING_AZURE_OPENAI_API_VERSION", "RPASCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT", "RPASCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON", "RPASCENE_PLANNING_USE_ANTHROPIC_SDK", "RPASCENE_PLANNING_ANTHROPIC_API_KEY", "RPASCENE_PLANNING_VL_MODE", "RPASCENE_GROUNDING_MODEL_NAME", "RPASCENE_GROUNDING_OPENAI_SOCKS_PROXY", "RPASCENE_GROUNDING_OPENAI_HTTP_PROXY", "RPASCENE_GROUNDING_OPENAI_BASE_URL", "RPASCENE_GROUNDING_OPENAI_API_KEY", "RPASCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON", "RPASCENE_GROUNDING_OPENAI_USE_AZURE", "RPASCENE_GROUNDING_USE_AZURE_OPENAI", "RPASCENE_GROUNDING_AZURE_OPENAI_SCOPE", "RPASCENE_GROUNDING_AZURE_OPENAI_KEY", "RPASCENE_GROUNDING_AZURE_OPENAI_ENDPOINT", "RPASCENE_GROUNDING_AZURE_OPENAI_API_VERSION", "RPASCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT", "RPASCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON", "RPASCENE_GROUNDING_USE_ANTHROPIC_SDK", "RPASCENE_GROUNDING_ANTHROPIC_API_KEY", "RPASCENE_GROUNDING_VL_MODE"];
+export declare const Yht_ENV_KEYS: string[];
+export declare const ALL_ENV_KEYS: readonly string[];
+export type TEnvKeys = (typeof ALL_ENV_KEYS)[number];
+export type TGlobalConfig = Record<TEnvKeys, string | undefined>;
+export type TVlModeValues = 'qwen-vl' | 'qwen3-vl' | 'doubao-vision' | 'gemini' | 'vlm-ui-tars' | 'vlm-ui-tars-doubao' | 'vlm-ui-tars-doubao-1.5';
+export type TVlModeTypes = 'qwen-vl' | 'qwen3-vl' | 'doubao-vision' | 'gemini' | 'vlm-ui-tars';
+export interface IModelConfigForVQA {
+    [RPASCENE_VQA_MODEL_NAME]: string;
+    [RPASCENE_VQA_OPENAI_SOCKS_PROXY]?: string;
+    [RPASCENE_VQA_OPENAI_HTTP_PROXY]?: string;
+    [RPASCENE_VQA_OPENAI_BASE_URL]?: string;
+    [RPASCENE_VQA_OPENAI_API_KEY]?: string;
+    [RPASCENE_VQA_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_VQA_OPENAI_USE_AZURE]?: string;
+    [RPASCENE_VQA_USE_AZURE_OPENAI]?: string;
+    [RPASCENE_VQA_AZURE_OPENAI_SCOPE]?: string;
+    [RPASCENE_VQA_AZURE_OPENAI_KEY]?: string;
+    [RPASCENE_VQA_AZURE_OPENAI_ENDPOINT]?: string;
+    [RPASCENE_VQA_AZURE_OPENAI_API_VERSION]?: string;
+    [RPASCENE_VQA_AZURE_OPENAI_DEPLOYMENT]?: string;
+    [RPASCENE_VQA_AZURE_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_VQA_USE_ANTHROPIC_SDK]?: string;
+    [RPASCENE_VQA_ANTHROPIC_API_KEY]?: string;
+    [RPASCENE_VQA_VL_MODE]?: TVlModeValues;
+}
+export interface IModelConfigForPlanning {
+    [RPASCENE_PLANNING_MODEL_NAME]: string;
+    [RPASCENE_PLANNING_OPENAI_SOCKS_PROXY]?: string;
+    [RPASCENE_PLANNING_OPENAI_HTTP_PROXY]?: string;
+    [RPASCENE_PLANNING_OPENAI_BASE_URL]?: string;
+    [RPASCENE_PLANNING_OPENAI_API_KEY]?: string;
+    [RPASCENE_PLANNING_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_PLANNING_OPENAI_USE_AZURE]?: string;
+    [RPASCENE_PLANNING_USE_AZURE_OPENAI]?: string;
+    [RPASCENE_PLANNING_AZURE_OPENAI_SCOPE]?: string;
+    [RPASCENE_PLANNING_AZURE_OPENAI_KEY]?: string;
+    [RPASCENE_PLANNING_AZURE_OPENAI_ENDPOINT]?: string;
+    [RPASCENE_PLANNING_AZURE_OPENAI_API_VERSION]?: string;
+    [RPASCENE_PLANNING_AZURE_OPENAI_DEPLOYMENT]?: string;
+    [RPASCENE_PLANNING_AZURE_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_PLANNING_USE_ANTHROPIC_SDK]?: string;
+    [RPASCENE_PLANNING_ANTHROPIC_API_KEY]?: string;
+    [RPASCENE_PLANNING_VL_MODE]?: TVlModeValues;
+}
+export interface IModeConfigForGrounding {
+    [RPASCENE_GROUNDING_MODEL_NAME]: string;
+    [RPASCENE_GROUNDING_OPENAI_SOCKS_PROXY]?: string;
+    [RPASCENE_GROUNDING_OPENAI_HTTP_PROXY]?: string;
+    [RPASCENE_GROUNDING_OPENAI_BASE_URL]?: string;
+    [RPASCENE_GROUNDING_OPENAI_API_KEY]?: string;
+    [RPASCENE_GROUNDING_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_GROUNDING_OPENAI_USE_AZURE]?: string;
+    [RPASCENE_GROUNDING_USE_AZURE_OPENAI]?: string;
+    [RPASCENE_GROUNDING_AZURE_OPENAI_SCOPE]?: string;
+    [RPASCENE_GROUNDING_AZURE_OPENAI_KEY]?: string;
+    [RPASCENE_GROUNDING_AZURE_OPENAI_ENDPOINT]?: string;
+    [RPASCENE_GROUNDING_AZURE_OPENAI_API_VERSION]?: string;
+    [RPASCENE_GROUNDING_AZURE_OPENAI_DEPLOYMENT]?: string;
+    [RPASCENE_GROUNDING_AZURE_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_GROUNDING_USE_ANTHROPIC_SDK]?: string;
+    [RPASCENE_GROUNDING_ANTHROPIC_API_KEY]?: string;
+    [RPASCENE_GROUNDING_VL_MODE]?: TVlModeValues;
+}
+export interface IModelConfigForDefault {
+    [RPASCENE_MODEL_NAME]: string;
+    [RPASCENE_OPENAI_SOCKS_PROXY]?: string;
+    [RPASCENE_OPENAI_HTTP_PROXY]?: string;
+    [RPASCENE_OPENAI_BASE_URL]?: string;
+    [RPASCENE_OPENAI_API_KEY]?: string;
+    [RPASCENE_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_OPENAI_USE_AZURE]?: string;
+    [RPASCENE_USE_AZURE_OPENAI]?: string;
+    [RPASCENE_AZURE_OPENAI_SCOPE]?: string;
+    [RPASCENE_AZURE_OPENAI_KEY]?: string;
+    [RPASCENE_AZURE_OPENAI_ENDPOINT]?: string;
+    [RPASCENE_AZURE_OPENAI_API_VERSION]?: string;
+    [RPASCENE_AZURE_OPENAI_DEPLOYMENT]?: string;
+    [RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_USE_ANTHROPIC_SDK]?: string;
+    [RPASCENE_ANTHROPIC_API_KEY]?: string;
+    [RPASCENE_VL_MODE]?: TVlModeValues;
+}
+export interface IModelConfigForDefaultLegacy {
+    [RPASCENE_MODEL_NAME]: string;
+    [RPASCENE_OPENAI_SOCKS_PROXY]?: string;
+    [RPASCENE_OPENAI_HTTP_PROXY]?: string;
+    [OPENAI_BASE_URL]?: string;
+    [OPENAI_API_KEY]?: string;
+    [RPASCENE_OPENAI_INIT_CONFIG_JSON]?: string;
+    [OPENAI_USE_AZURE]?: string;
+    [RPASCENE_USE_AZURE_OPENAI]?: string;
+    [RPASCENE_AZURE_OPENAI_SCOPE]?: string;
+    [AZURE_OPENAI_KEY]?: string;
+    [AZURE_OPENAI_ENDPOINT]?: string;
+    [AZURE_OPENAI_API_VERSION]?: string;
+    [AZURE_OPENAI_DEPLOYMENT]?: string;
+    [RPASCENE_AZURE_OPENAI_INIT_CONFIG_JSON]?: string;
+    [RPASCENE_USE_ANTHROPIC_SDK]?: string;
+    [ANTHROPIC_API_KEY]?: string;
+    [RPASCENE_VL_MODE]?: TVlModeValues;
+}
+/**
+ * - VQA: Visual Question Answering
+ * - grounding：short for Visual Grounding
+ * - planning: planning
+ * - default: all except VQA、grounding、planning
+ */
+export type TIntent = 'VQA' | 'planning' | 'grounding' | 'default';
+export type TModelConfigFn = (options: {
+    intent: TIntent;
+}) => IModelConfigForVQA | IModelConfigForPlanning | IModeConfigForGrounding | IModelConfigForDefault;
+export declare enum UITarsModelVersion {
+    V1_0 = "1.0",
+    V1_5 = "1.5",
+    DOUBAO_1_5_15B = "doubao-1.5-15B",
+    DOUBAO_1_5_20B = "doubao-1.5-20B"
+}
+export declare const VL_MODE_RAW_VALID_VALUES: TVlModeValues[];
+export interface IModelConfig {
+    /**
+     * proxy
+     */
+    socksProxy?: string;
+    httpProxy?: string;
+    /**
+     * model
+     */
+    modelName: string;
+    /**
+     * OpenAI
+     */
+    openaiBaseURL?: string;
+    openaiApiKey?: string;
+    openaiExtraConfig?: Record<string, unknown>;
+    /**
+     * Azure
+     */
+    openaiUseAzureDeprecated?: boolean;
+    useAzureOpenai?: boolean;
+    azureOpenaiScope?: string;
+    azureOpenaiKey?: string;
+    azureOpenaiEndpoint?: string;
+    azureOpenaiApiVersion?: string;
+    azureOpenaiDeployment?: string;
+    azureExtraConfig?: Record<string, unknown>;
+    /**
+     * Anthropic
+     */
+    useAnthropicSdk?: boolean;
+    anthropicApiKey?: string;
+    /**
+     * - vlModeRaw: exists only in non-legacy logic. value can be 'doubao-vision', 'gemini', 'qwen-vl', 'vlm-ui-tars', 'vlm-ui-tars-doubao', 'vlm-ui-tars-doubao-1.5'
+     * - vlMode: based on the results of the vlModoRaw classification，value can be 'doubao-vision', 'gemini', 'qwen-vl', 'vlm-ui-tars'
+     */
+    vlModeRaw?: string;
+    vlMode?: TVlModeTypes;
+    uiTarsModelVersion?: UITarsModelVersion;
+    modelDescription: string;
+    /**
+     * for debug
+     */
+    intent: TIntent;
+    from: 'modelConfig' | 'env' | 'legacy-env';
+}

package/dist/types/env/utils.d.ts

@@ -0,0 +1,7 @@
+import { GlobalConfigManager } from './global-config-manager';
+import { ModelConfigManager } from './model-config-manager';
+import { type GLOBAL_ENV_KEYS, type MODEL_ENV_KEYS } from './types';
+export declare const globalModelConfigManager: ModelConfigManager;
+export declare const globalConfigManager: GlobalConfigManager;
+export declare const getPreferredLanguage: () => string;
+export declare const overrideAIConfig: (newConfig: Partial<Record<(typeof GLOBAL_ENV_KEYS)[number] | (typeof MODEL_ENV_KEYS)[number], string>>, extendMode?: boolean) => void;

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

@@ -0,0 +1 @@
+export { NodeType, TEXT_MAX_SIZE, TEXT_SIZE_THRESHOLD, } from '../constants/index';

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

@@ -0,0 +1,2 @@
+export declare const postWindowMessage: (targetWin: any, sourceWin: any, payload: any, targetOrigin?: any, timeout?: any) => Promise<any>;
+export declare const onWindowMessage: (win: any, fn: any) => () => any;

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

@@ -0,0 +1,69 @@
+/**
+ *
+ * 直到遇到fieldid或id为止
+ * @param {*} dom
+ * @param {*} onece
+ * @returns
+ */
+declare const getLocatorUntilFieldid: (dom: any, type?: string) => {
+    type: string;
+    value: any;
+};
+/**
+ * 全路径，适用于静态元素，当元素动态改变，而节点位置不变，可能不准确，比如百度的搜索结果，位置可能发生改变，指向一个固定的项
+ * 实现浏览器自带的Copy fullXPath方法
+ * 一直递归到 /html
+ * 忽略id
+ * 其他同上XPath
+ * @param {*} dom
+ * @returns string
+ */
+declare const getFullLocator: (dom: any, type?: string) => {
+    type: string;
+    value: any;
+};
+/**
+ * 对外的方法，依次调用上面的方法，生成可以的列表
+ * return []
+ * */
+declare const getLocators: (dom: any) => any[];
+/**
+ * 对外的方法，iframe在页面数量少，不需要全路径，要简洁
+ * @param {*} dom
+ */
+declare const getContainerLocatorData: (dom: any) => {
+    containerAllPaths: any[];
+    containerType: string;
+    containerPathType: any;
+    containerPathValue: any;
+    containerPathIndex: any;
+};
+/**
+ * 获取多个元素
+ * @param {*} locators
+ * @param {*} docOrHost
+ * @param {*} selected
+ * @returns
+ */
+declare const getManyElementByLocators: (docOrHost: Document | undefined, locators: any[], selected?: boolean) => unknown[];
+/**
+ * 获取单个元素
+ * @param {*} locators
+ * @param {*} docOrHost
+ * @returns
+ */
+declare const getOneElementByLocators: (docOrHost: any, locators: any[], selected?: boolean) => {} | null;
+/**
+ * 录制时先获取shadowRoot的容器树，再添加frame的容器树
+ * 获取shadowRoot的容器树
+ * @param {*} dom
+ * @returns
+ */
+declare const getShadowRootContainerStack: (dom: any) => {
+    containerAllPaths: any[];
+    containerType: string;
+    containerPathType: any;
+    containerPathValue: any;
+    containerPathIndex: any;
+}[];
+export { getLocators, getShadowRootContainerStack, getFullLocator, getLocatorUntilFieldid, getContainerLocatorData as getContainerPath, getManyElementByLocators as getElements, getOneElementByLocators as getUniqueElement, };

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,26 @@
+import { NodeType } from '../constants';
+export declare function isFormElement(node: globalThis.Node, currentWindow?: typeof globalThis): boolean;
+export declare function isButtonElement(node: globalThis.Node, currentWindow?: typeof globalThis): node is globalThis.HTMLButtonElement;
+export declare function isAElement(node: globalThis.Node, currentWindow?: typeof globalThis): node is globalThis.HTMLButtonElement;
+export declare function isSvgElement(node: globalThis.Node, currentWindow?: typeof globalThis): node is globalThis.SVGSVGElement;
+export declare function isImgElement(node: globalThis.Node, currentWindow?: typeof globalThis): node is globalThis.HTMLImageElement;
+export declare function isNotContainerElement(node: globalThis.Node, currentWindow?: typeof globalThis): boolean;
+export declare function isTextElement(node: globalThis.Node, currentWindow?: typeof globalThis): node is globalThis.HTMLTextAreaElement;
+export declare function isContainerElement(node: globalThis.Node, currentWindow?: typeof globalThis): node is globalThis.HTMLElement;
+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[];
+};

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

@@ -0,0 +1,36 @@
+import type { NodeType } from '../constants/index';
+export interface ElementInfo {
+    id: string;
+    indexId: number;
+    nodeHashId: string;
+    xpaths?: string[];
+    attributes: {
+        nodeType: NodeType;
+        [key: string]: string;
+    };
+    nodeType: NodeType;
+    content: string;
+    rect: {
+        left: number;
+        top: number;
+        width: number;
+        height: number;
+    };
+    center: [number, number];
+    isVisible: boolean;
+    allPaths?: any;
+    containerPaths?: any;
+}
+export interface ElementNode {
+    node: ElementInfo | null;
+    children: ElementNode[];
+}
+export { descriptionOfTree, traverseTree, treeToList, truncateText, trimAttributes, } from './tree';
+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 { getXpathsById, getXpathsByPoint, getNodeInfoByXpath, getElementInfoByXpath, getElementXpath, } from './locator';
+export { generateElementByPosition } from './dom-util';
+export { isNotContainerElement } from './dom-util';
+export * from './customLocator';

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

@@ -0,0 +1,7 @@
+import type { ElementInfo } from '.';
+import type { Point } from '../types';
+export declare const getElementXpath: (element: Node, isOrderSensitive?: boolean, isLeafElement?: boolean) => string;
+export declare function getXpathsById(id: string): string[] | null;
+export declare function getXpathsByPoint(point: Point, isOrderSensitive: boolean): string[] | null;
+export declare function getNodeInfoByXpath(xpath: string): Node | null;
+export declare function getElementInfoByXpath(xpath: string): ElementInfo | null;

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

@@ -0,0 +1,9 @@
+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 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

@@ -0,0 +1,43 @@
+import type { Rect } from '../types';
+export declare function setDebugMode(mode: boolean): void;
+export declare function getDebugMode(): boolean;
+export declare function logger(..._msg: any[]): void;
+export declare function isElementPartiallyInViewport(rect: ReturnType<typeof getRect>, currentWindow: typeof window, currentDocument: typeof document, visibleAreaRatio?: number): boolean;
+export declare function getPseudoElementContent(element: globalThis.Node, currentWindow: typeof globalThis.window): {
+    before: string;
+    after: string;
+};
+export declare function hasOverflowY(element: globalThis.HTMLElement, currentWindow: typeof globalThis.window): boolean;
+export interface ExtractedRect {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    x: number;
+    y: number;
+    zoom: number;
+}
+export declare function overlappedRect(rect1: ExtractedRect, rect2: ExtractedRect): ExtractedRect | null;
+export declare function getRect(el: globalThis.HTMLElement | globalThis.Node, baseZoom: number, // base zoom
+currentWindow: typeof globalThis.window): ExtractedRect;
+export declare function elementRect(el: globalThis.HTMLElement | globalThis.Node | null, currentWindow: typeof globalThis.window, currentDocument: typeof globalThis.document, baseZoom?: number): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    zoom: number;
+    isVisible: boolean;
+} | false;
+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 rpasceneGenerateHash(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 setRpasceneVisibleRectOnWindow(): void;
+export declare function setExtractTextWithPositionOnWindow(): void;
+export declare function getTopDocument(): globalThis.HTMLElement;

package/dist/types/extractor/web-extractor.d.ts

@@ -0,0 +1,19 @@
+import type { WebElementInfo } from '../types';
+import type { Point } from '../types';
+export declare function collectElementInfo(node: Node, currentWindow: typeof window, currentDocument: typeof document, baseZoom?: number, basePoint?: Point, isContainer?: boolean): WebElementInfo | null | any;
+interface WebElementNode {
+    node: WebElementInfo | null;
+    children: WebElementNode[];
+}
+export declare function extractTextWithPosition(initNode: globalThis.Node, debugMode?: boolean): Promise<WebElementInfo[]>;
+export declare function extractTreeNodeAsString(initNode: globalThis.Node, visibleOnly?: boolean, debugMode?: boolean): Promise<string>;
+export declare function extractTreeNode(initNode: globalThis.Node, debugMode?: boolean, basePoint?: Point, baseZoom?: number, containerPaths?: any[]): Promise<WebElementNode>;
+export declare function mergeElementAndChildrenRects(node: Node, currentWindow: typeof window, currentDocument: typeof document, baseZoom?: number): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    zoom: number;
+    isVisible: boolean;
+} | null;
+export {};

package/dist/types/img/box-select.d.ts

@@ -0,0 +1,25 @@
+import type { BaseElement, Rect } from '../types';
+interface ElementForOverlay {
+    rect: Rect;
+    indexId?: number;
+}
+export declare const compositeElementInfoImg: (options: {
+    inputImgBase64: string;
+    elementsPositionInfo: Array<ElementForOverlay>;
+    size?: {
+        width: number;
+        height: number;
+    };
+    annotationPadding?: number;
+    borderThickness?: number;
+    prompt?: string;
+}) => Promise<string>;
+export declare const processImageElementInfo: (options: {
+    inputImgBase64: string;
+    elementsPositionInfo: Array<BaseElement>;
+    elementsPositionInfoWithoutText: Array<BaseElement>;
+}) => Promise<{
+    compositeElementInfoImgBase64: string;
+    compositeElementInfoImgWithoutTextBase64: string;
+}>;
+export {};

package/dist/types/img/draw-box.d.ts

@@ -0,0 +1,15 @@
+export declare function drawBoxOnImage(options: {
+    inputImgBase64: string;
+    rect: {
+        x: number;
+        y: number;
+    };
+}): Promise<string>;
+export declare function savePositionImg(options: {
+    inputImgBase64: string;
+    rect: {
+        x: number;
+        y: number;
+    };
+    outputPath: string;
+}): Promise<void>;

package/dist/types/img/get-jimp.d.ts

@@ -0,0 +1,2 @@
+import Jimp from 'jimp';
+export default function getJimp(): Promise<typeof Jimp>;

package/dist/types/img/get-photon.d.ts

@@ -0,0 +1,8 @@
+export default function getPhoton(): Promise<{
+    PhotonImage: typeof import('@silvia-odwyer/photon-node').PhotonImage;
+    SamplingFilter: typeof import('@silvia-odwyer/photon-node').SamplingFilter;
+    resize: typeof import('@silvia-odwyer/photon-node').resize;
+    crop: typeof import('@silvia-odwyer/photon-node').crop;
+    open_image: typeof import('@silvia-odwyer/photon-node').open_image;
+    base64_to_image: typeof import('@silvia-odwyer/photon-node').base64_to_image;
+}>;

package/dist/types/img/get-sharp.d.ts

@@ -0,0 +1,3 @@
+type TSharpModule = typeof import('sharp');
+export default function getSharp(): Promise<TSharpModule>;
+export {};

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

@@ -0,0 +1,4 @@
+export { imageInfo, imageInfoOfBase64, bufferFromBase64, isValidPNGImageBuffer, } from './info';
+export { resizeAndConvertImgBuffer, resizeImgBase64, zoomForGPT4o, saveBase64Image, paddingToMatchBlock, paddingToMatchBlockByBase64, cropByRect, jimpFromBase64, jimpToBase64, localImg2Base64, httpImg2Base64, preProcessImageUrl, parseBase64, createImgBase64ByFormat, } from './transform';
+export { processImageElementInfo, compositeElementInfoImg } from './box-select';
+export { drawBoxOnImage, savePositionImg } from './draw-box';

package/dist/types/img/info.d.ts

@@ -0,0 +1,29 @@
+import { Buffer } from 'node:buffer';
+import type Jimp from 'jimp';
+import type { Size } from '../types';
+export interface ImageInfo extends Size {
+    jimpImage: Jimp;
+}
+/**
+ * Retrieves the dimensions of an image asynchronously
+ *
+ * @param image - The image data, which can be a string path or a buffer
+ * @returns A Promise that resolves to an object containing the width and height of the image
+ * @throws Error if the image data is invalid
+ */
+export declare function imageInfo(image: string | Buffer | Jimp): Promise<ImageInfo>;
+/**
+ * Retrieves the dimensions of an image from a base64-encoded string
+ *
+ * @param imageBase64 - The base64-encoded image data
+ * @returns A Promise that resolves to an object containing the width and height of the image
+ * @throws Error if the image data is invalid
+ */
+export declare function imageInfoOfBase64(imageBase64: string): Promise<ImageInfo>;
+export declare function bufferFromBase64(imageBase64: string): Promise<Buffer>;
+/**
+ * Check if the Buffer is a valid PNG image
+ * @param buffer The Buffer to check
+ * @returns true if the Buffer is a valid PNG image, otherwise false
+ */
+export declare function isValidPNGImageBuffer(buffer: Buffer): boolean;