@midscene/core 0.26.2 → 0.26.3-beta-20250813075706.0

package/dist/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["webpack://@midscene/core/webpack/runtime/define_property_getters","webpack://@midscene/core/webpack/runtime/has_own_property","webpack://@midscene/core/webpack/runtime/make_namespace_object","webpack://@midscene/core/./src/utils.ts"],"sourcesContent":["__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n        if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n            Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n        }\n    }\n};","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","// define __esModule on exports\n__webpack_require__.r = (exports) => {\n\tif(typeof Symbol !== 'undefined' && Symbol.toStringTag) {\n\t\tObject.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });\n\t}\n\tObject.defineProperty(exports, '__esModule', { value: true });\n};","import { execSync } from 'node:child_process';\nimport * as fs from 'node:fs';\nimport { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';\nimport { tmpdir } from 'node:os';\nimport * as path from 'node:path';\nimport { dirname } from 'node:path';\nimport {\n  defaultRunDirName,\n  getMidsceneRunSubDir,\n} from '@midscene/shared/common';\nimport {\n  MIDSCENE_DEBUG_MODE,\n  MIDSCENE_OPENAI_INIT_CONFIG_JSON,\n  getAIConfig,\n  getAIConfigInJson,\n} from '@midscene/shared/env';\nimport { getRunningPkgInfo } from '@midscene/shared/node';\nimport { assert, logMsg } from '@midscene/shared/utils';\nimport {\n  escapeScriptTag,\n  ifInBrowser,\n  ifInWorker,\n  uuid,\n} from '@midscene/shared/utils';\nimport type { Rect, ReportDumpWithAttributes } from './types';\n\nlet logEnvReady = false;\n\nexport const groupedActionDumpFileExt = 'web-dump.json';\n\nconst reportInitializedMap = new Map<string, boolean>();\n\ndeclare const __DEV_REPORT_PATH__: string;\n\nfunction getReportTpl() {\n  if (__DEV_REPORT_PATH__) {\n    return fs.readFileSync(__DEV_REPORT_PATH__, 'utf-8');\n  }\n  const reportTpl = 'REPLACE_ME_WITH_REPORT_HTML';\n\n  return reportTpl;\n}\n\n/**\n * high performance, insert script before </html> in HTML file\n * only truncate and append, no temporary file\n */\nexport function insertScriptBeforeClosingHtml(\n  filePath: string,\n  scriptContent: string,\n): void {\n  const htmlEndTag = '</html>';\n  const stat = fs.statSync(filePath);\n\n  const readSize = Math.min(stat.size, 4096);\n  const start = Math.max(0, stat.size - readSize);\n  const buffer = Buffer.alloc(stat.size - start);\n  const fd = fs.openSync(filePath, 'r');\n  fs.readSync(fd, buffer, 0, buffer.length, start);\n  fs.closeSync(fd);\n\n  const tailStr = buffer.toString('utf8');\n  const htmlEndIdx = tailStr.lastIndexOf(htmlEndTag);\n  if (htmlEndIdx === -1) {\n    throw new Error(`No </html> found in file：${filePath}`);\n  }\n\n  // calculate the correct byte position: char position to byte position\n  const beforeHtmlInTail = tailStr.slice(0, htmlEndIdx);\n  const htmlEndPos = start + Buffer.byteLength(beforeHtmlInTail, 'utf8');\n\n  // truncate to </html> before\n  fs.truncateSync(filePath, htmlEndPos);\n  // append script and </html>\n  fs.appendFileSync(filePath, `${scriptContent}\\n${htmlEndTag}\\n`);\n}\n\nexport function reportHTMLContent(\n  dumpData: string | ReportDumpWithAttributes,\n  reportPath?: string,\n  appendReport?: boolean,\n): string {\n  const tpl = getReportTpl();\n\n  if (!tpl) {\n    console.warn('reportTpl is not set, will not write report');\n    return '';\n  }\n\n  // if reportPath is set, it means we are in write to file mode\n  const writeToFile = reportPath && !ifInBrowser;\n  let dumpContent = '';\n\n  if (typeof dumpData === 'string') {\n    // do not use template string here, will cause bundle error\n    dumpContent =\n      // biome-ignore lint/style/useTemplate: <explanation>\n      '<script type=\"midscene_web_dump\" type=\"application/json\">\\n' +\n      escapeScriptTag(dumpData) +\n      '\\n</script>';\n  } else {\n    const { dumpString, attributes } = dumpData;\n    const attributesArr = Object.keys(attributes || {}).map((key) => {\n      return `${key}=\"${encodeURIComponent(attributes![key])}\"`;\n    });\n\n    dumpContent =\n      // do not use template string here, will cause bundle error\n      // biome-ignore lint/style/useTemplate: <explanation>\n      '<script type=\"midscene_web_dump\" type=\"application/json\" ' +\n      attributesArr.join(' ') +\n      '>\\n' +\n      escapeScriptTag(dumpString) +\n      '\\n</script>';\n  }\n\n  if (writeToFile) {\n    if (!appendReport) {\n      writeFileSync(reportPath!, tpl + dumpContent, { flag: 'w' });\n      return reportPath!;\n    }\n\n    if (!reportInitializedMap.get(reportPath!)) {\n      writeFileSync(reportPath!, tpl, { flag: 'w' });\n      reportInitializedMap.set(reportPath!, true);\n    }\n\n    insertScriptBeforeClosingHtml(reportPath!, dumpContent);\n    return reportPath!;\n  }\n\n  return tpl + dumpContent;\n}\n\nexport function writeDumpReport(\n  fileName: string,\n  dumpData: string | ReportDumpWithAttributes,\n  appendReport?: boolean,\n): string | null {\n  if (ifInBrowser || ifInWorker) {\n    console.log('will not write report in browser');\n    return null;\n  }\n\n  const __dirname = dirname(__filename);\n  const midscenePkgInfo = getRunningPkgInfo(__dirname);\n  if (!midscenePkgInfo) {\n    console.warn('midscenePkgInfo not found, will not write report');\n    return null;\n  }\n\n  const reportPath = path.join(\n    getMidsceneRunSubDir('report'),\n    `${fileName}.html`,\n  );\n\n  reportHTMLContent(dumpData, reportPath, appendReport);\n\n  if (process.env.MIDSCENE_DEBUG_LOG_JSON) {\n    const jsonPath = `${reportPath}.json`;\n    let data;\n\n    if (typeof dumpData === 'string') {\n      data = JSON.parse(dumpData) as ReportDumpWithAttributes;\n    } else {\n      data = dumpData;\n    }\n\n    writeFileSync(jsonPath, JSON.stringify(data, null, 2), {\n      flag: appendReport ? 'a' : 'w',\n    });\n\n    logMsg(`Midscene - dump file written: ${jsonPath}`);\n  }\n\n  return reportPath;\n}\n\nexport function writeLogFile(opts: {\n  fileName: string;\n  fileExt: string;\n  fileContent: string;\n  type: 'dump' | 'cache' | 'report' | 'tmp';\n  generateReport?: boolean;\n  appendReport?: boolean;\n}) {\n  if (ifInBrowser || ifInWorker) {\n    return '/mock/report.html';\n  }\n  const { fileName, fileExt, fileContent, type = 'dump' } = opts;\n  const targetDir = getMidsceneRunSubDir(type);\n  // Ensure directory exists\n  if (!logEnvReady) {\n    assert(targetDir, 'logDir should be set before writing dump file');\n\n    // gitIgnore in the parent directory\n    const gitIgnorePath = path.join(targetDir, '../../.gitignore');\n    const gitPath = path.join(targetDir, '../../.git');\n    let gitIgnoreContent = '';\n\n    if (existsSync(gitPath)) {\n      // if the git path exists, we need to add the log folder to the git ignore file\n      if (existsSync(gitIgnorePath)) {\n        gitIgnoreContent = readFileSync(gitIgnorePath, 'utf-8');\n      }\n\n      // ignore the log folder\n      if (!gitIgnoreContent.includes(`${defaultRunDirName}/`)) {\n        writeFileSync(\n          gitIgnorePath,\n          `${gitIgnoreContent}\\n# Midscene.js dump files\\n${defaultRunDirName}/dump\\n${defaultRunDirName}/report\\n${defaultRunDirName}/tmp\\n${defaultRunDirName}/log\\n`,\n          'utf-8',\n        );\n      }\n    }\n\n    logEnvReady = true;\n  }\n\n  const filePath = path.join(targetDir, `${fileName}.${fileExt}`);\n\n  if (type !== 'dump') {\n    // do not write dump file any more\n    writeFileSync(filePath, fileContent);\n  }\n\n  if (opts?.generateReport) {\n    return writeDumpReport(fileName, fileContent, opts.appendReport);\n  }\n\n  return filePath;\n}\n\nexport function getTmpDir(): string | null {\n  try {\n    const runningPkgInfo = getRunningPkgInfo();\n    if (!runningPkgInfo) {\n      return null;\n    }\n    const { name } = runningPkgInfo;\n    const tmpPath = path.join(tmpdir(), name);\n    mkdirSync(tmpPath, { recursive: true });\n    return tmpPath;\n  } catch (e) {\n    return null;\n  }\n}\n\nexport function getTmpFile(fileExtWithoutDot: string): string | null {\n  if (ifInBrowser || ifInWorker) {\n    return null;\n  }\n  const tmpDir = getTmpDir();\n  const filename = `${uuid()}.${fileExtWithoutDot}`;\n  return path.join(tmpDir!, filename);\n}\n\nexport function overlapped(container: Rect, target: Rect) {\n  // container and the target have some part overlapped\n  return (\n    container.left < target.left + target.width &&\n    container.left + container.width > target.left &&\n    container.top < target.top + target.height &&\n    container.top + container.height > target.top\n  );\n}\n\nexport async function sleep(ms: number) {\n  return new Promise((resolve) => setTimeout(resolve, ms));\n}\n\nexport function replacerForPageObject(key: string, value: any) {\n  if (value && value.constructor?.name === 'Page') {\n    return '[Page object]';\n  }\n  if (value && value.constructor?.name === 'Browser') {\n    return '[Browser object]';\n  }\n  return value;\n}\n\nexport function stringifyDumpData(data: any, indents?: number) {\n  return JSON.stringify(data, replacerForPageObject, indents);\n}\n\ndeclare const __VERSION__: string;\n\nexport function getVersion() {\n  return __VERSION__;\n}\n\nfunction debugLog(...message: any[]) {\n  const debugMode = getAIConfig(MIDSCENE_DEBUG_MODE);\n  if (debugMode) {\n    console.log('[Midscene]', ...message);\n  }\n}\n\nlet lastReportedRepoUrl = '';\nexport function uploadTestInfoToServer({ testUrl }: { testUrl: string }) {\n  let repoUrl = '';\n  let userEmail = '';\n\n  const extraConfig = getAIConfigInJson(MIDSCENE_OPENAI_INIT_CONFIG_JSON);\n  const serverUrl = extraConfig?.REPORT_SERVER_URL;\n\n  try {\n    repoUrl = execSync('git config --get remote.origin.url').toString().trim();\n    userEmail = execSync('git config --get user.email').toString().trim();\n  } catch (error) {\n    debugLog('Failed to get git info:', error);\n  }\n\n  // Only upload test info if:\n  // 1. Server URL is configured AND\n  // 2. Either:\n  //    - We have a repo URL that's different from last reported one (to avoid duplicate reports)\n  //    - OR we don't have a repo URL but have a test URL (for non-git environments)\n  if (\n    serverUrl &&\n    ((repoUrl && repoUrl !== lastReportedRepoUrl) || (!repoUrl && testUrl))\n  ) {\n    debugLog('Uploading test info to server', {\n      serverUrl,\n      repoUrl,\n      testUrl,\n      userEmail,\n    });\n\n    fetch(serverUrl, {\n      method: 'POST',\n      headers: {\n        'Content-Type': 'application/json',\n      },\n      body: JSON.stringify({\n        repo_url: repoUrl,\n        test_url: testUrl,\n        user_email: userEmail,\n      }),\n    })\n      .then((response) => response.json())\n      .then((data) => {\n        debugLog('Successfully uploaded test info to server:', data);\n      })\n      .catch((error) =>\n        debugLog('Failed to upload test info to server:', error),\n      );\n    lastReportedRepoUrl = repoUrl;\n  }\n}\n"],"names":["__webpack_require__","definition","key","Object","obj","prop","Symbol","logEnvReady","groupedActionDumpFileExt","reportInitializedMap","Map","getReportTpl","reportTpl","insertScriptBeforeClosingHtml","filePath","scriptContent","htmlEndTag","stat","fs","readSize","Math","start","buffer","Buffer","fd","tailStr","htmlEndIdx","Error","beforeHtmlInTail","htmlEndPos","reportHTMLContent","dumpData","reportPath","appendReport","tpl","console","writeToFile","ifInBrowser","dumpContent","escapeScriptTag","dumpString","attributes","attributesArr","encodeURIComponent","writeFileSync","writeDumpReport","fileName","ifInWorker","__dirname","dirname","__filename","midscenePkgInfo","getRunningPkgInfo","path","getMidsceneRunSubDir","process","jsonPath","data","JSON","logMsg","writeLogFile","opts","fileExt","fileContent","type","targetDir","assert","gitIgnorePath","gitPath","gitIgnoreContent","existsSync","readFileSync","defaultRunDirName","getTmpDir","runningPkgInfo","name","tmpPath","tmpdir","mkdirSync","e","getTmpFile","fileExtWithoutDot","tmpDir","filename","uuid","overlapped","container","target","sleep","ms","Promise","resolve","setTimeout","replacerForPageObject","value","_value_constructor","_value_constructor1","stringifyDumpData","indents","getVersion","__VERSION__","debugLog","message","debugMode","getAIConfig","MIDSCENE_DEBUG_MODE","lastReportedRepoUrl","uploadTestInfoToServer","testUrl","repoUrl","userEmail","extraConfig","getAIConfigInJson","MIDSCENE_OPENAI_INIT_CONFIG_JSON","serverUrl","execSync","error","fetch","response"],"mappings":";;;IAAAA,oBAAoB,CAAC,GAAG,CAAC,UAASC;QACjC,IAAI,IAAIC,OAAOD,WACR,IAAGD,oBAAoB,CAAC,CAACC,YAAYC,QAAQ,CAACF,oBAAoB,CAAC,CAAC,UAASE,MACzEC,OAAO,cAAc,CAAC,UAASD,KAAK;YAAE,YAAY;YAAM,KAAKD,UAAU,CAACC,IAAI;QAAC;IAGzF;;;ICNAF,oBAAoB,CAAC,GAAG,CAACI,KAAKC,OAAUF,OAAO,SAAS,CAAC,cAAc,CAAC,IAAI,CAACC,KAAKC;;;ICClFL,oBAAoB,CAAC,GAAG,CAAC;QACxB,IAAG,AAAkB,eAAlB,OAAOM,UAA0BA,OAAO,WAAW,EACrDH,OAAO,cAAc,CAAC,UAASG,OAAO,WAAW,EAAE;YAAE,OAAO;QAAS;QAEtEH,OAAO,cAAc,CAAC,UAAS,cAAc;YAAE,OAAO;QAAK;IAC5D;;;;;;;;;;;;;;;;;;;;;;;;;;;ACoBA,IAAII,cAAc;AAEX,MAAMC,2BAA2B;AAExC,MAAMC,uBAAuB,IAAIC;AAIjC,SAASC;IAIP,MAAMC,YAAY;IAElB,OAAOA;AACT;AAMO,SAASC,8BACdC,QAAgB,EAChBC,aAAqB;IAErB,MAAMC,aAAa;IACnB,MAAMC,OAAOC,iCAAAA,QAAW,CAACJ;IAEzB,MAAMK,WAAWC,KAAK,GAAG,CAACH,KAAK,IAAI,EAAE;IACrC,MAAMI,QAAQD,KAAK,GAAG,CAAC,GAAGH,KAAK,IAAI,GAAGE;IACtC,MAAMG,SAASC,OAAO,KAAK,CAACN,KAAK,IAAI,GAAGI;IACxC,MAAMG,KAAKN,iCAAAA,QAAW,CAACJ,UAAU;IACjCI,iCAAAA,QAAW,CAACM,IAAIF,QAAQ,GAAGA,OAAO,MAAM,EAAED;IAC1CH,iCAAAA,SAAY,CAACM;IAEb,MAAMC,UAAUH,OAAO,QAAQ,CAAC;IAChC,MAAMI,aAAaD,QAAQ,WAAW,CAACT;IACvC,IAAIU,AAAe,OAAfA,YACF,MAAM,IAAIC,MAAM,CAAC,gCAAyB,EAAEb,UAAU;IAIxD,MAAMc,mBAAmBH,QAAQ,KAAK,CAAC,GAAGC;IAC1C,MAAMG,aAAaR,QAAQE,OAAO,UAAU,CAACK,kBAAkB;IAG/DV,iCAAAA,YAAe,CAACJ,UAAUe;IAE1BX,iCAAAA,cAAiB,CAACJ,UAAU,GAAGC,cAAc,EAAE,EAAEC,WAAW,EAAE,CAAC;AACjE;AAEO,SAASc,kBACdC,QAA2C,EAC3CC,UAAmB,EACnBC,YAAsB;IAEtB,MAAMC,MAAMvB;IAEZ,IAAI,CAACuB,KAAK;QACRC,QAAQ,IAAI,CAAC;QACb,OAAO;IACT;IAGA,MAAMC,cAAcJ,cAAc,CAACK,sBAAAA,WAAWA;IAC9C,IAAIC,cAAc;IAElB,IAAI,AAAoB,YAApB,OAAOP,UAETO,cAEE,gEACAC,AAAAA,IAAAA,sBAAAA,eAAAA,AAAAA,EAAgBR,YAChB;SACG;QACL,MAAM,EAAES,UAAU,EAAEC,UAAU,EAAE,GAAGV;QACnC,MAAMW,gBAAgBvC,OAAO,IAAI,CAACsC,cAAc,CAAC,GAAG,GAAG,CAAC,CAACvC,MAChD,GAAGA,IAAI,EAAE,EAAEyC,mBAAmBF,UAAW,CAACvC,IAAI,EAAE,CAAC,CAAC;QAG3DoC,cAGE,8DACAI,cAAc,IAAI,CAAC,OACnB,QACAH,AAAAA,IAAAA,sBAAAA,eAAAA,AAAAA,EAAgBC,cAChB;IACJ;IAEA,IAAIJ,aAAa;QACf,IAAI,CAACH,cAAc;YACjBW,IAAAA,iCAAAA,aAAAA,AAAAA,EAAcZ,YAAaE,MAAMI,aAAa;gBAAE,MAAM;YAAI;YAC1D,OAAON;QACT;QAEA,IAAI,CAACvB,qBAAqB,GAAG,CAACuB,aAAc;YAC1CY,IAAAA,iCAAAA,aAAAA,AAAAA,EAAcZ,YAAaE,KAAK;gBAAE,MAAM;YAAI;YAC5CzB,qBAAqB,GAAG,CAACuB,YAAa;QACxC;QAEAnB,8BAA8BmB,YAAaM;QAC3C,OAAON;IACT;IAEA,OAAOE,MAAMI;AACf;AAEO,SAASO,gBACdC,QAAgB,EAChBf,QAA2C,EAC3CE,YAAsB;IAEtB,IAAII,sBAAAA,WAAWA,IAAIU,sBAAAA,UAAUA,EAAE;QAC7BZ,QAAQ,GAAG,CAAC;QACZ,OAAO;IACT;IAEA,MAAMa,YAAYC,AAAAA,IAAAA,mCAAAA,OAAAA,AAAAA,EAAQC;IAC1B,MAAMC,kBAAkBC,AAAAA,IAAAA,qBAAAA,iBAAAA,AAAAA,EAAkBJ;IAC1C,IAAI,CAACG,iBAAiB;QACpBhB,QAAQ,IAAI,CAAC;QACb,OAAO;IACT;IAEA,MAAMH,aAAaqB,mCAAAA,IAAS,CAC1BC,AAAAA,IAAAA,uBAAAA,oBAAAA,AAAAA,EAAqB,WACrB,GAAGR,SAAS,KAAK,CAAC;IAGpBhB,kBAAkBC,UAAUC,YAAYC;IAExC,IAAIsB,QAAQ,GAAG,CAAC,uBAAuB,EAAE;QACvC,MAAMC,WAAW,GAAGxB,WAAW,KAAK,CAAC;QACrC,IAAIyB;QAGFA,OADE,AAAoB,YAApB,OAAO1B,WACF2B,KAAK,KAAK,CAAC3B,YAEXA;QAGTa,IAAAA,iCAAAA,aAAAA,AAAAA,EAAcY,UAAUE,KAAK,SAAS,CAACD,MAAM,MAAM,IAAI;YACrD,MAAMxB,eAAe,MAAM;QAC7B;QAEA0B,IAAAA,sBAAAA,MAAAA,AAAAA,EAAO,CAAC,8BAA8B,EAAEH,UAAU;IACpD;IAEA,OAAOxB;AACT;AAEO,SAAS4B,aAAaC,IAO5B;IACC,IAAIxB,sBAAAA,WAAWA,IAAIU,sBAAAA,UAAUA,EAC3B,OAAO;IAET,MAAM,EAAED,QAAQ,EAAEgB,OAAO,EAAEC,WAAW,EAAEC,OAAO,MAAM,EAAE,GAAGH;IAC1D,MAAMI,YAAYX,AAAAA,IAAAA,uBAAAA,oBAAAA,AAAAA,EAAqBU;IAEvC,IAAI,CAACzD,aAAa;QAChB2D,IAAAA,sBAAAA,MAAAA,AAAAA,EAAOD,WAAW;QAGlB,MAAME,gBAAgBd,mCAAAA,IAAS,CAACY,WAAW;QAC3C,MAAMG,UAAUf,mCAAAA,IAAS,CAACY,WAAW;QACrC,IAAII,mBAAmB;QAEvB,IAAIC,AAAAA,IAAAA,iCAAAA,UAAAA,AAAAA,EAAWF,UAAU;YAEvB,IAAIE,AAAAA,IAAAA,iCAAAA,UAAAA,AAAAA,EAAWH,gBACbE,mBAAmBE,AAAAA,IAAAA,iCAAAA,YAAAA,AAAAA,EAAaJ,eAAe;YAIjD,IAAI,CAACE,iBAAiB,QAAQ,CAAC,GAAGG,uBAAAA,iBAAiBA,CAAC,CAAC,CAAC,GACpD5B,AAAAA,IAAAA,iCAAAA,aAAAA,AAAAA,EACEuB,eACA,GAAGE,iBAAiB,4BAA4B,EAAEG,uBAAAA,iBAAiBA,CAAC,OAAO,EAAEA,uBAAAA,iBAAiBA,CAAC,SAAS,EAAEA,uBAAAA,iBAAiBA,CAAC,MAAM,EAAEA,uBAAAA,iBAAiBA,CAAC,MAAM,CAAC,EAC7J;QAGN;QAEAjE,cAAc;IAChB;IAEA,MAAMO,WAAWuC,mCAAAA,IAAS,CAACY,WAAW,GAAGnB,SAAS,CAAC,EAAEgB,SAAS;IAE9D,IAAIE,AAAS,WAATA,MAEFpB,AAAAA,IAAAA,iCAAAA,aAAAA,AAAAA,EAAc9B,UAAUiD;IAG1B,IAAIF,QAAAA,OAAAA,KAAAA,IAAAA,KAAM,cAAc,EACtB,OAAOhB,gBAAgBC,UAAUiB,aAAaF,KAAK,YAAY;IAGjE,OAAO/C;AACT;AAEO,SAAS2D;IACd,IAAI;QACF,MAAMC,iBAAiBtB,AAAAA,IAAAA,qBAAAA,iBAAAA,AAAAA;QACvB,IAAI,CAACsB,gBACH,OAAO;QAET,MAAM,EAAEC,IAAI,EAAE,GAAGD;QACjB,MAAME,UAAUvB,mCAAAA,IAAS,CAACwB,AAAAA,IAAAA,iCAAAA,MAAAA,AAAAA,KAAUF;QACpCG,IAAAA,iCAAAA,SAAAA,AAAAA,EAAUF,SAAS;YAAE,WAAW;QAAK;QACrC,OAAOA;IACT,EAAE,OAAOG,GAAG;QACV,OAAO;IACT;AACF;AAEO,SAASC,WAAWC,iBAAyB;IAClD,IAAI5C,sBAAAA,WAAWA,IAAIU,sBAAAA,UAAUA,EAC3B,OAAO;IAET,MAAMmC,SAAST;IACf,MAAMU,WAAW,GAAGC,AAAAA,IAAAA,sBAAAA,IAAAA,AAAAA,IAAO,CAAC,EAAEH,mBAAmB;IACjD,OAAO5B,mCAAAA,IAAS,CAAC6B,QAASC;AAC5B;AAEO,SAASE,WAAWC,SAAe,EAAEC,MAAY;IAEtD,OACED,UAAU,IAAI,GAAGC,OAAO,IAAI,GAAGA,OAAO,KAAK,IAC3CD,UAAU,IAAI,GAAGA,UAAU,KAAK,GAAGC,OAAO,IAAI,IAC9CD,UAAU,GAAG,GAAGC,OAAO,GAAG,GAAGA,OAAO,MAAM,IAC1CD,UAAU,GAAG,GAAGA,UAAU,MAAM,GAAGC,OAAO,GAAG;AAEjD;AAEO,eAAeC,MAAMC,EAAU;IACpC,OAAO,IAAIC,QAAQ,CAACC,UAAYC,WAAWD,SAASF;AACtD;AAEO,SAASI,sBAAsB3F,GAAW,EAAE4F,KAAU;QAC9CC,oBAGAC;IAHb,IAAIF,SAASC,AAAAA,SAAAA,CAAAA,qBAAAA,MAAM,WAAW,AAAD,IAAhBA,KAAAA,IAAAA,mBAAmB,IAAI,AAAD,MAAM,QACvC,OAAO;IAET,IAAID,SAASE,AAAAA,SAAAA,CAAAA,sBAAAA,MAAM,WAAW,AAAD,IAAhBA,KAAAA,IAAAA,oBAAmB,IAAI,AAAD,MAAM,WACvC,OAAO;IAET,OAAOF;AACT;AAEO,SAASG,kBAAkBxC,IAAS,EAAEyC,OAAgB;IAC3D,OAAOxC,KAAK,SAAS,CAACD,MAAMoC,uBAAuBK;AACrD;AAIO,SAASC;IACd,OAAOC;AACT;AAEA,SAASC,SAAS,GAAGC,OAAc;IACjC,MAAMC,YAAYC,AAAAA,IAAAA,oBAAAA,WAAAA,AAAAA,EAAYC,oBAAAA,mBAAmBA;IACjD,IAAIF,WACFpE,QAAQ,GAAG,CAAC,iBAAiBmE;AAEjC;AAEA,IAAII,sBAAsB;AACnB,SAASC,uBAAuB,EAAEC,OAAO,EAAuB;IACrE,IAAIC,UAAU;IACd,IAAIC,YAAY;IAEhB,MAAMC,cAAcC,AAAAA,IAAAA,oBAAAA,iBAAAA,AAAAA,EAAkBC,oBAAAA,gCAAgCA;IACtE,MAAMC,YAAYH,QAAAA,cAAAA,KAAAA,IAAAA,YAAa,iBAAiB;IAEhD,IAAI;QACFF,UAAUM,AAAAA,IAAAA,4CAAAA,QAAAA,AAAAA,EAAS,sCAAsC,QAAQ,GAAG,IAAI;QACxEL,YAAYK,AAAAA,IAAAA,4CAAAA,QAAAA,AAAAA,EAAS,+BAA+B,QAAQ,GAAG,IAAI;IACrE,EAAE,OAAOC,OAAO;QACdf,SAAS,2BAA2Be;IACtC;IAOA,IACEF,aACEL,CAAAA,WAAWA,YAAYH,uBAAyB,CAACG,WAAWD,OAAM,GACpE;QACAP,SAAS,iCAAiC;YACxCa;YACAL;YACAD;YACAE;QACF;QAEAO,MAAMH,WAAW;YACf,QAAQ;YACR,SAAS;gBACP,gBAAgB;YAClB;YACA,MAAMxD,KAAK,SAAS,CAAC;gBACnB,UAAUmD;gBACV,UAAUD;gBACV,YAAYE;YACd;QACF,GACG,IAAI,CAAC,CAACQ,WAAaA,SAAS,IAAI,IAChC,IAAI,CAAC,CAAC7D;YACL4C,SAAS,8CAA8C5C;QACzD,GACC,KAAK,CAAC,CAAC2D,QACNf,SAAS,yCAAyCe;QAEtDV,sBAAsBG;IACxB;AACF"}

package/dist/types/ai-model.d.ts

@@ -1,99 +1,505 @@
-import { aD as StreamingCallback, A as AIUsageInfo, aC as StreamingCodeGenerationOptions, aF as StreamingAIResponse, Y as PlanningAction, m as MidsceneYamlFlowItem } from './types-8a6be57c.js';
-import OpenAI from 'openai';
-import { ChatCompletionMessageParam } from 'openai/resources';
-export { ChatCompletionMessageParam } from 'openai/resources';
-import { b as AIActionType, e as AIArgs } from './llm-planning-4e0c16fe.js';
-export { a as AiAssert, g as AiExtractElementInfo, A as AiLocateElement, h as AiLocateSection, i as adaptBboxToRect, c as callAiFn, d as describeUserPage, f as elementByPositionWithElementInfo, p as plan } from './llm-planning-4e0c16fe.js';
-import { vlLocateMode } from '@midscene/shared/env';
-import { actionParser } from '@ui-tars/action-parser';
-import { Size } from '@midscene/shared/types';
-import '@midscene/shared/constants';
-
-declare function call(messages: ChatCompletionMessageParam[], AIActionTypeValue: AIActionType, responseFormat?: OpenAI.ChatCompletionCreateParams['response_format'] | OpenAI.ResponseFormatJSONObject, options?: {
-    stream?: boolean;
-    onChunk?: StreamingCallback;
-}): Promise<{
-    content: string;
-    usage?: AIUsageInfo;
-    isStreamed: boolean;
-}>;
-declare function callToGetJSONObject<T>(messages: ChatCompletionMessageParam[], AIActionTypeValue: AIActionType): Promise<{
-    content: T;
-    usage?: AIUsageInfo;
-}>;
-declare function callAiFnWithStringResponse<T>(msgs: AIArgs, AIActionTypeValue: AIActionType): Promise<{
-    content: string;
-    usage?: AIUsageInfo;
-}>;
-
-declare function systemPromptToLocateElement(vlMode: ReturnType<typeof vlLocateMode>): string;
-
-interface ChromeRecordedEvent {
-    type: string;
-    timestamp: number;
-    url?: string;
-    title?: string;
-    elementDescription?: string;
-    value?: string;
-    pageInfo?: any;
-    elementRect?: any;
-    screenshotBefore?: string;
-    screenshotAfter?: string;
-    screenshotWithBox?: string;
-}
-interface YamlGenerationOptions {
-    testName?: string;
-    includeTimestamps?: boolean;
-    maxScreenshots?: number;
-    description?: string;
-}
-/**
- * Generates YAML test configuration from recorded events using AI
- */
-declare const generateYamlTest: (events: ChromeRecordedEvent[], options?: YamlGenerationOptions) => Promise<string>;
-/**
- * Generates YAML test configuration from recorded events using AI with streaming support
- */
-declare const generateYamlTestStream: (events: ChromeRecordedEvent[], options?: YamlGenerationOptions & StreamingCodeGenerationOptions) => Promise<StreamingAIResponse>;
-
-interface PlaywrightGenerationOptions {
-    testName?: string;
-    includeScreenshots?: boolean;
-    includeTimestamps?: boolean;
-    maxScreenshots?: number;
-    description?: string;
-    viewportSize?: {
-        width: number;
-        height: number;
-    };
-    waitForNetworkIdle?: boolean;
-    waitForNetworkIdleTimeout?: number;
-}
-
-/**
- * Generates Playwright test code from recorded events
- */
-declare const generatePlaywrightTest: (events: ChromeRecordedEvent[], options?: PlaywrightGenerationOptions) => Promise<string>;
-/**
- * Generates Playwright test code from recorded events with streaming support
- */
-declare const generatePlaywrightTestStream: (events: ChromeRecordedEvent[], options?: PlaywrightGenerationOptions & StreamingCodeGenerationOptions) => Promise<StreamingAIResponse>;
-
-declare function vlmPlanning(options: {
-    userInstruction: string;
-    conversationHistory: ChatCompletionMessageParam[];
-    size: {
-        width: number;
-        height: number;
-    };
-}): Promise<{
-    actions: PlanningAction<any>[];
-    actionsFromModel: ReturnType<typeof actionParser>['parsed'];
-    action_summary: string;
-    yamlFlow?: MidsceneYamlFlowItem[];
-    usage?: AIUsageInfo;
-    rawResponse?: string;
-}>;
-declare function resizeImageForUiTars(imageBase64: string, size: Size): Promise<string>;
-
-export { AIActionType, AIArgs, call as callAi, callAiFnWithStringResponse, callToGetJSONObject, generatePlaywrightTest, generatePlaywrightTestStream, generateYamlTest, generateYamlTestStream, resizeImageForUiTars, systemPromptToLocateElement, vlmPlanning };
+import { actionParser } from '@ui-tars/action-parser';
+import { BaseElement } from '@midscene/shared/types';
+import { ChatCompletionMessageParam } from 'openai/resources/index';
+import type { ChatCompletionSystemMessageParam } from 'openai/resources/index';
+import type { ChatCompletionUserMessageParam } from 'openai/resources/index';
+import { ElementTreeNode } from '@midscene/shared/types';
+import OpenAI from 'openai';
+import { Rect } from '@midscene/shared/types';
+import { Size } from '@midscene/shared/types';
+import type { vlLocateMode } from '@midscene/shared/env';
+
+export declare function adaptBboxToRect(bbox: number[], width: number, height: number, offsetX?: number, offsetY?: number): Rect;
+
+export declare enum AIActionType {
+    ASSERT = 0,
+    INSPECT_ELEMENT = 1,
+    EXTRACT_DATA = 2,
+    PLAN = 3,
+    DESCRIBE_ELEMENT = 4
+}
+
+export declare type AIArgs = [
+ChatCompletionSystemMessageParam,
+...ChatCompletionUserMessageParam[]
+];
+
+export declare function AiAssert<ElementType extends BaseElement = BaseElement>(options: {
+    assertion: TUserPrompt;
+    context: UIContext<ElementType>;
+}): Promise<{
+    content: AIAssertionResponse;
+    usage: AIUsageInfo | undefined;
+}>;
+
+declare interface AIAssertionResponse {
+    pass: boolean;
+    thought: string;
+}
+
+declare interface AIDataExtractionResponse<DataDemand> {
+    data: DataDemand;
+    errors?: string[];
+    thought?: string;
+}
+
+declare interface AIElementCoordinatesResponse {
+    bbox: [number, number, number, number];
+    isOrderSensitive?: boolean;
+    errors?: string[];
+}
+
+declare interface AIElementLocatorResponse {
+    elements: {
+        id: string;
+        reason?: string;
+        text?: string;
+        xpaths?: string[];
+    }[];
+    bbox?: [number, number, number, number];
+    isOrderSensitive?: boolean;
+    errors?: string[];
+}
+
+declare type AIElementResponse =
+| AIElementLocatorResponse
+| AIElementCoordinatesResponse;
+
+export declare function AiExtractElementInfo<T, ElementType extends BaseElement = BaseElement>(options: {
+    dataQuery: string | Record<string, string>;
+    multimodalPrompt?: TMultimodalPrompt;
+    context: UIContext<ElementType>;
+    extractOption?: InsightExtractOption;
+}): Promise<{
+    parseResult: AIDataExtractionResponse<T>;
+    elementById: (idOrIndexId: string) => ElementType;
+    usage: AIUsageInfo | undefined;
+}>;
+
+export declare function AiLocateElement<ElementType extends BaseElement = BaseElement>(options: {
+    context: UIContext<ElementType>;
+    targetElementDescription: TUserPrompt;
+    referenceImage?: ReferenceImage;
+    callAI?: typeof callAiFn<AIElementResponse | [number, number]>;
+    searchConfig?: Awaited<ReturnType<typeof AiLocateSection>>;
+}): Promise<{
+    parseResult: AIElementLocatorResponse;
+    rect?: Rect;
+    rawResponse: string;
+    elementById: ElementById;
+    usage?: AIUsageInfo;
+    isOrderSensitive?: boolean;
+}>;
+
+export declare function AiLocateSection(options: {
+    context: UIContext<BaseElement>;
+    sectionDescription: TUserPrompt;
+    callAI?: typeof callAiFn<AISectionLocatorResponse>;
+}): Promise<{
+    rect?: Rect;
+    imageBase64?: string;
+    error?: string;
+    rawResponse: string;
+    usage?: AIUsageInfo;
+}>;
+
+declare interface AISectionLocatorResponse {
+    bbox: [number, number, number, number];
+    references_bbox?: [number, number, number, number][];
+    error?: string;
+}
+
+declare type AIUsageInfo = Record<string, any> & {
+    prompt_tokens: number | undefined;
+    completion_tokens: number | undefined;
+    total_tokens: number | undefined;
+    time_cost: number | undefined;
+};
+
+export declare function callAi(messages: ChatCompletionMessageParam[], AIActionTypeValue: AIActionType, responseFormat?: OpenAI.ChatCompletionCreateParams['response_format'] | OpenAI.ResponseFormatJSONObject, options?: {
+    stream?: boolean;
+    onChunk?: StreamingCallback;
+}): Promise<{
+    content: string;
+    usage?: AIUsageInfo;
+    isStreamed: boolean;
+}>;
+
+export declare function callAiFn<T>(msgs: AIArgs, AIActionTypeValue: AIActionType): Promise<{
+    content: T;
+    usage?: AIUsageInfo;
+}>;
+
+export declare function callAiFnWithStringResponse<T>(msgs: AIArgs, AIActionTypeValue: AIActionType): Promise<{
+    content: string;
+    usage?: AIUsageInfo;
+}>;
+
+export declare function callToGetJSONObject<T>(messages: ChatCompletionMessageParam[], AIActionTypeValue: AIActionType): Promise<{
+    content: T;
+    usage?: AIUsageInfo;
+}>;
+
+export { ChatCompletionMessageParam }
+
+declare interface ChromeRecordedEvent {
+    type: string;
+    timestamp: number;
+    url?: string;
+    title?: string;
+    elementDescription?: string;
+    value?: string;
+    pageInfo?: any;
+    elementRect?: any;
+    screenshotBefore?: string;
+    screenshotAfter?: string;
+    screenshotWithBox?: string;
+}
+
+declare interface CodeGenerationChunk {
+    /** The incremental content chunk */
+    content: string;
+    /** The reasoning content */
+    reasoning_content: string;
+    /** The accumulated content so far */
+    accumulated: string;
+    /** Whether this is the final chunk */
+    isComplete: boolean;
+    /** Token usage information if available */
+    usage?: AIUsageInfo;
+}
+
+export declare function describeUserPage<ElementType extends BaseElement = BaseElement>(context: Omit<UIContext<ElementType>, 'describer'>, opt?: {
+    truncateTextLength?: number;
+    filterNonTextContent?: boolean;
+    domIncluded?: boolean | 'visible-only';
+    visibleOnly?: boolean;
+}): Promise<{
+    description: string;
+    elementById(idOrIndexId: string): ElementType;
+    elementByPosition(position: {
+        x: number;
+        y: number;
+    }, size: {
+        width: number;
+        height: number;
+    }): BaseElement | undefined;
+    insertElementByPosition(position: {
+        x: number;
+        y: number;
+    }): ElementType;
+    size: {
+        width: number;
+        height: number;
+    };
+}>;
+
+declare interface DetailedLocateParam extends LocateOption {
+    prompt: TUserPrompt;
+    referenceImage?: ReferenceImage;
+}
+
+declare interface DeviceAction<ParamType = any> {
+    name: string;
+    description?: string;
+    paramSchema?: string;
+    paramDescription?: string;
+    location?: 'required' | 'optional' | false;
+    whatToLocate?: string; // what to locate if location is required or optional
+    call: (param: ParamType) => Promise<void> | void;
+}
+
+declare type ElementById = (id: string) => BaseElement | null;
+
+export declare function elementByPositionWithElementInfo(treeRoot: ElementTreeNode<BaseElement>, position: {
+    x: number;
+    y: number;
+}, options?: {
+    requireStrictDistance?: boolean;
+    filterPositionElements?: boolean;
+}): BaseElement | undefined;
+
+/**
+ * Generates Playwright test code from recorded events
+ */
+export declare const generatePlaywrightTest: (events: ChromeRecordedEvent[], options?: PlaywrightGenerationOptions) => Promise<string>;
+
+/**
+ * Generates Playwright test code from recorded events with streaming support
+ */
+export declare const generatePlaywrightTestStream: (events: ChromeRecordedEvent[], options?: PlaywrightGenerationOptions & StreamingCodeGenerationOptions) => Promise<StreamingAIResponse>;
+
+/**
+ * Generates YAML test configuration from recorded events using AI
+ */
+export declare const generateYamlTest: (events: ChromeRecordedEvent[], options?: YamlGenerationOptions) => Promise<string>;
+
+/**
+ * Generates YAML test configuration from recorded events using AI with streaming support
+ */
+export declare const generateYamlTestStream: (events: ChromeRecordedEvent[], options?: YamlGenerationOptions & StreamingCodeGenerationOptions) => Promise<StreamingAIResponse>;
+
+declare interface InsightExtractOption {
+    domIncluded?: boolean | 'visible-only';
+    screenshotIncluded?: boolean;
+    returnThought?: boolean;
+}
+
+declare interface LocateOption {
+    deepThink?: boolean; // only available in vl model
+    cacheable?: boolean; // user can set this param to false to disable the cache for a single agent api
+    xpath?: string; // only available in web
+    pageContext?: UIContext<BaseElement>;
+}
+
+declare type MidsceneYamlFlowItem =
+| MidsceneYamlFlowItemAIAction
+| MidsceneYamlFlowItemAIAssert
+| MidsceneYamlFlowItemAIQuery
+| MidsceneYamlFlowItemAIWaitFor
+| MidsceneYamlFlowItemAITap
+| MidsceneYamlFlowItemAIRightClick
+| MidsceneYamlFlowItemAIHover
+| MidsceneYamlFlowItemAIInput
+| MidsceneYamlFlowItemAIKeyboardPress
+| MidsceneYamlFlowItemAIScroll
+| MidsceneYamlFlowItemSleep
+| MidsceneYamlFlowItemLogScreenshot;
+
+declare interface MidsceneYamlFlowItemAIAction {
+    ai?: string; // this is the shortcut for aiAction
+    aiAction?: string;
+    aiActionProgressTips?: string[];
+    cacheable?: boolean;
+}
+
+declare interface MidsceneYamlFlowItemAIAssert {
+    aiAssert: string;
+    errorMessage?: string;
+}
+
+declare interface MidsceneYamlFlowItemAIHover extends LocateOption {
+    aiHover: TUserPrompt;
+}
+
+declare interface MidsceneYamlFlowItemAIInput extends LocateOption {
+    aiInput: string; // value to input
+    locate: TUserPrompt; // where to input
+}
+
+declare interface MidsceneYamlFlowItemAIKeyboardPress extends LocateOption {
+    aiKeyboardPress: string;
+    locate?: TUserPrompt; // where to press, optional
+}
+
+declare interface MidsceneYamlFlowItemAIQuery extends InsightExtractOption {
+    aiQuery: string;
+    name?: string;
+}
+
+declare interface MidsceneYamlFlowItemAIRightClick extends LocateOption {
+    aiRightClick: TUserPrompt;
+}
+
+declare interface MidsceneYamlFlowItemAIScroll
+extends LocateOption,
+PlanningActionParamScroll {
+    aiScroll: null;
+    locate?: TUserPrompt; // which area to scroll, optional
+}
+
+declare interface MidsceneYamlFlowItemAITap extends LocateOption {
+    aiTap: TUserPrompt;
+}
+
+declare interface MidsceneYamlFlowItemAIWaitFor {
+    aiWaitFor: string;
+    timeout?: number;
+}
+
+declare interface MidsceneYamlFlowItemLogScreenshot {
+    logScreenshot?: string; // optional, the title of the screenshot
+    content?: string;
+}
+
+declare interface MidsceneYamlFlowItemSleep {
+    sleep: number;
+}
+
+declare type PageType =
+| 'puppeteer'
+| 'playwright'
+| 'static'
+| 'chrome-extension-proxy'
+| 'android';
+
+export declare function plan(userInstruction: string, opts: {
+    context: UIContext;
+    pageType: PageType;
+    actionSpace: DeviceAction[];
+    callAI?: typeof callAiFn<PlanningAIResponse>;
+    log?: string;
+    actionContext?: string;
+}): Promise<PlanningAIResponse>;
+
+declare interface PlanningAction<ParamType = any> {
+    thought?: string;
+    type:
+    | 'Locate'
+    | 'Tap'
+    | 'RightClick'
+    | 'Hover'
+    | 'Drag'
+    | 'Input'
+    | 'KeyboardPress'
+    | 'Scroll'
+    | 'Error'
+    | 'Assert'
+    | 'AssertWithoutThrow'
+    | 'Sleep'
+    | 'Finished'
+    | 'AndroidBackButton'
+    | 'AndroidHomeButton'
+    | 'AndroidRecentAppsButton'
+    | 'AndroidLongPress'
+    | 'AndroidPull';
+    param: ParamType;
+    locate?: PlanningLocateParam | null;
+}
+
+declare type PlanningActionParamScroll = scrollParam;
+
+declare interface PlanningAIResponse {
+    action?: PlanningAction; // this is the qwen mode
+    actions?: PlanningAction[];
+    more_actions_needed_by_instruction: boolean;
+    log: string;
+    sleep?: number;
+    error?: string;
+    usage?: AIUsageInfo;
+    rawResponse?: string;
+    yamlFlow?: MidsceneYamlFlowItem[];
+    yamlString?: string;
+}
+
+/**
+ * planning
+ *
+ */
+
+declare interface PlanningLocateParam extends DetailedLocateParam {
+    id?: string;
+    bbox?: [number, number, number, number];
+}
+
+declare interface PlaywrightGenerationOptions {
+    testName?: string;
+    includeScreenshots?: boolean;
+    includeTimestamps?: boolean;
+    maxScreenshots?: number;
+    description?: string;
+    viewportSize?: {
+        width: number;
+        height: number;
+    };
+    waitForNetworkIdle?: boolean;
+    waitForNetworkIdleTimeout?: number;
+}
+
+declare interface ReferenceImage {
+    base64: string;
+    rect?: Rect;
+}
+
+export declare function resizeImageForUiTars(imageBase64: string, size: Size): Promise<string>;
+
+declare interface scrollParam {
+    direction: 'down' | 'up' | 'right' | 'left';
+    scrollType: 'once' | 'untilBottom' | 'untilTop' | 'untilRight' | 'untilLeft';
+    distance?: null | number; // distance in px
+}
+
+declare interface StreamingAIResponse {
+    /** The final accumulated content */
+    content: string;
+    /** Token usage information */
+    usage?: AIUsageInfo;
+    /** Whether the response was streamed */
+    isStreamed: boolean;
+}
+
+declare type StreamingCallback = (chunk: CodeGenerationChunk) => void;
+
+declare interface StreamingCodeGenerationOptions {
+    /** Whether to enable streaming output */
+    stream?: boolean;
+    /** Callback function to handle streaming chunks */
+    onChunk?: StreamingCallback;
+    /** Callback function to handle streaming completion */
+    onComplete?: (finalCode: string) => void;
+    /** Callback function to handle streaming errors */
+    onError?: (error: Error) => void;
+}
+
+export declare function systemPromptToLocateElement(vlMode: ReturnType<typeof vlLocateMode>): string;
+
+declare type TMultimodalPrompt = {
+    /**
+     * Support use image to inspect elements.
+     * The "images" field is an object that uses image name as key and image url as value.
+     * The image url can be a local path, a http link , or a base64 string.
+     */
+    images?: {
+        name: string;
+        url: string;
+    }[];
+    /**
+     * By default, the image url in the "images" filed starts with `https://` or `http://` will be directly sent to the LLM.
+     * In case the images are not accessible to the LLM (One common case is that image url is internal network only.), you can enable this option.
+     * Then image will be download and convert to base64 format.
+     */
+    convertHttpImage2Base64?: boolean;
+};
+
+declare type TUserPrompt =
+| string
+| ({
+    prompt: string;
+} & Partial<TMultimodalPrompt>);
+
+/**
+ * context
+ */
+
+declare abstract class UIContext<ElementType extends BaseElement = BaseElement> {
+    abstract screenshotBase64: string;
+
+    abstract tree: ElementTreeNode<ElementType>;
+
+    abstract size: Size;
+}
+
+export declare function vlmPlanning(options: {
+    userInstruction: string;
+    conversationHistory: ChatCompletionMessageParam[];
+    size: {
+        width: number;
+        height: number;
+    };
+}): Promise<{
+    actions: PlanningAction<any>[];
+    actionsFromModel: ReturnType<typeof actionParser>['parsed'];
+    action_summary: string;
+    yamlFlow?: MidsceneYamlFlowItem[];
+    usage?: AIUsageInfo;
+    rawResponse?: string;
+}>;
+
+declare interface YamlGenerationOptions {
+    testName?: string;
+    includeTimestamps?: boolean;
+    maxScreenshots?: number;
+    description?: string;
+}
+
+export { }