@aiscene/core 1.1.1

package/dist/es/report-cli.mjs

@@ -0,0 +1,151 @@
+import { copyFileSync, existsSync, mkdirSync, statSync, writeFileSync } from "node:fs";
+import { join, resolve } from "node:path";
+import { z } from "zod";
+import { resolveScreenshotSource } from "./dump/screenshot-store.mjs";
+import { collectDedupedExecutions, splitReportHtmlByExecution } from "./report.mjs";
+import { reportToMarkdown } from "./report-markdown.mjs";
+import { ReportActionDump } from "./types.mjs";
+function writeAttachmentFromReport(attachment, opts) {
+    const { suggestedFileName, id, mimeType } = attachment;
+    if (opts.writtenFiles.has(suggestedFileName)) return;
+    const absolutePath = join(opts.screenshotsDir, suggestedFileName);
+    const outputRelativePath = `./screenshots/${suggestedFileName}`;
+    const sourceRef = attachment.filePath !== outputRelativePath ? {
+        type: 'midscene_screenshot_ref',
+        id,
+        capturedAt: 0,
+        mimeType: mimeType || 'image/png',
+        storage: 'file',
+        path: attachment.filePath
+    } : null;
+    const resolved = resolveScreenshotSource(sourceRef, {
+        reportPath: opts.htmlPath,
+        fallbackId: id,
+        fallbackMimeType: mimeType || 'image/png'
+    });
+    if ('data-uri' === resolved.type) {
+        const rawBase64 = resolved.dataUri.replace(/^data:image\/[a-zA-Z+]+;base64,/, '');
+        writeFileSync(absolutePath, Buffer.from(rawBase64, 'base64'));
+        opts.writtenFiles.add(suggestedFileName);
+        return;
+    }
+    if (!existsSync(resolved.filePath)) throw new Error(`Cannot resolve screenshot "${id}" for markdown attachment from ${opts.htmlPath}`);
+    copyFileSync(resolved.filePath, absolutePath);
+    opts.writtenFiles.add(suggestedFileName);
+}
+async function markdownFromReport(htmlPath, outputDir) {
+    const screenshotsDir = join(outputDir, 'screenshots');
+    mkdirSync(outputDir, {
+        recursive: true
+    });
+    mkdirSync(screenshotsDir, {
+        recursive: true
+    });
+    const { baseDump, executions } = collectDedupedExecutions(htmlPath);
+    const mergedReport = new ReportActionDump({
+        sdkVersion: baseDump.sdkVersion,
+        groupName: baseDump.groupName,
+        groupDescription: baseDump.groupDescription,
+        modelBriefs: baseDump.modelBriefs,
+        deviceType: baseDump.deviceType,
+        executions
+    });
+    const result = reportToMarkdown(mergedReport);
+    const markdownFiles = [];
+    const writtenScreenshots = new Set();
+    const mdPath = join(outputDir, 'report.md');
+    writeFileSync(mdPath, result.markdown, 'utf-8');
+    markdownFiles.push(mdPath);
+    for (const attachment of result.attachments)writeAttachmentFromReport(attachment, {
+        htmlPath,
+        screenshotsDir,
+        writtenFiles: writtenScreenshots
+    });
+    return {
+        markdownFiles,
+        screenshotFiles: Array.from(writtenScreenshots).sort().map((f)=>join(screenshotsDir, f))
+    };
+}
+function resolveReportHtmlPath(htmlPath) {
+    const normalizedPath = resolve(htmlPath);
+    if (!existsSync(normalizedPath)) throw new Error(`report-tool: --htmlPath does not exist: ${htmlPath}`);
+    const stats = statSync(normalizedPath);
+    if (!stats.isDirectory()) return normalizedPath;
+    const indexHtmlPath = join(normalizedPath, 'index.html');
+    if (!existsSync(indexHtmlPath)) throw new Error(`report-tool: "${htmlPath}" is not an HTML report file, and no index.html was found under this directory.`);
+    return indexHtmlPath;
+}
+function splitReportFile(options) {
+    const { htmlPath, outputDir } = options;
+    if (!htmlPath) throw new Error('splitReportFile: htmlPath is required');
+    if (!outputDir) throw new Error('splitReportFile: outputDir is required');
+    const resolvedHtmlPath = resolveReportHtmlPath(htmlPath);
+    return splitReportHtmlByExecution({
+        htmlPath: resolvedHtmlPath,
+        outputDir
+    });
+}
+async function reportFileToMarkdown(options) {
+    const { htmlPath, outputDir } = options;
+    if (!htmlPath) throw new Error('reportFileToMarkdown: htmlPath is required');
+    if (!outputDir) throw new Error('reportFileToMarkdown: outputDir is required');
+    const resolvedHtmlPath = resolveReportHtmlPath(htmlPath);
+    return markdownFromReport(resolvedHtmlPath, outputDir);
+}
+const reportCommandDefinition = {
+    name: 'report-tool',
+    description: 'Transform Midscene report artifacts, including splitting executions and converting to markdown.',
+    schema: {
+        action: z["enum"]([
+            'split',
+            'to-markdown'
+        ]).optional().describe('Report action to run. Supports: split, to-markdown. Defaults to split.'),
+        htmlPath: z.string().optional().describe('Input report HTML path (e.g. ./report/index.html)'),
+        outputDir: z.string().optional().describe('Output directory for generated report artifacts')
+    },
+    handler: async (args)=>{
+        const { action = 'split', htmlPath, outputDir } = args;
+        if ('split' !== action && 'to-markdown' !== action) throw new Error(`report-tool: unsupported --action value "${action}". Currently supported: split, to-markdown`);
+        if (!htmlPath) throw new Error('report-tool: --htmlPath is required');
+        if (!outputDir) throw new Error('report-tool: --outputDir is required');
+        if ('to-markdown' === action) {
+            const result = await reportFileToMarkdown({
+                htmlPath,
+                outputDir
+            });
+            return {
+                isError: false,
+                content: [
+                    {
+                        type: 'text',
+                        text: `Markdown export completed. Generated ${result.markdownFiles.length} markdown file(s) and ${result.screenshotFiles.length} screenshot(s). Output path: ${outputDir}`
+                    }
+                ]
+            };
+        }
+        const result = splitReportFile({
+            htmlPath,
+            outputDir
+        });
+        return {
+            isError: false,
+            content: [
+                {
+                    type: 'text',
+                    text: `Report split completed. Generated ${result.executionJsonFiles.length} execution JSON files and ${result.screenshotFiles.length} screenshots. Output path: ${outputDir}`
+                }
+            ]
+        };
+    }
+};
+function createReportCliCommands() {
+    return [
+        {
+            name: 'report-tool',
+            def: reportCommandDefinition
+        }
+    ];
+}
+export { createReportCliCommands, reportFileToMarkdown, splitReportFile };
+
+//# sourceMappingURL=report-cli.mjs.map

package/dist/es/report-cli.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-cli.mjs","sources":["../../src/report-cli.ts"],"sourcesContent":["import {\n  copyFileSync,\n  existsSync,\n  mkdirSync,\n  statSync,\n  writeFileSync,\n} from 'node:fs';\nimport * as path from 'node:path';\nimport { z } from 'zod';\nimport { resolveScreenshotSource } from './dump/screenshot-store';\nimport { collectDedupedExecutions, splitReportHtmlByExecution } from './report';\nimport { reportToMarkdown } from './report-markdown';\nimport type { MarkdownAttachment } from './report-markdown';\nimport { ReportActionDump } from './types';\n\ntype ReportCliToolResult = {\n  isError: boolean;\n  content: Array<{\n    type: 'text';\n    text: string;\n  }>;\n};\n\ntype ReportCliSchema = Record<string, z.ZodTypeAny>;\n\nexport interface ReportCliCommandDefinition {\n  name: string;\n  description: string;\n  schema: ReportCliSchema;\n  handler: (args: Record<string, unknown>) => Promise<ReportCliToolResult>;\n}\n\nexport interface ReportCliCommandEntry {\n  name: string;\n  def: ReportCliCommandDefinition;\n}\n\nexport type ConsumeReportFileAction = 'split' | 'to-markdown';\n\nexport interface ConsumeReportFileOptions {\n  htmlPath: string;\n  outputDir: string;\n}\n\nexport type SplitReportFileOptions = ConsumeReportFileOptions;\nexport type ReportFileToMarkdownOptions = ConsumeReportFileOptions;\n\nfunction writeAttachmentFromReport(\n  attachment: MarkdownAttachment,\n  opts: {\n    htmlPath: string;\n    screenshotsDir: string;\n    writtenFiles: Set<string>;\n  },\n): void {\n  const { suggestedFileName, id, mimeType } = attachment;\n  if (opts.writtenFiles.has(suggestedFileName)) return;\n\n  const absolutePath = path.join(opts.screenshotsDir, suggestedFileName);\n\n  const outputRelativePath = `./screenshots/${suggestedFileName}`;\n  const sourceRef =\n    attachment.filePath !== outputRelativePath\n      ? {\n          type: 'midscene_screenshot_ref' as const,\n          id,\n          capturedAt: 0,\n          mimeType: (mimeType || 'image/png') as 'image/png' | 'image/jpeg',\n          storage: 'file' as const,\n          path: attachment.filePath,\n        }\n      : null;\n\n  const resolved = resolveScreenshotSource(sourceRef, {\n    reportPath: opts.htmlPath,\n    fallbackId: id,\n    fallbackMimeType: (mimeType || 'image/png') as 'image/png' | 'image/jpeg',\n  });\n\n  if (resolved.type === 'data-uri') {\n    const rawBase64 = resolved.dataUri.replace(\n      /^data:image\\/[a-zA-Z+]+;base64,/,\n      '',\n    );\n    writeFileSync(absolutePath, Buffer.from(rawBase64, 'base64'));\n    opts.writtenFiles.add(suggestedFileName);\n    return;\n  }\n\n  if (!existsSync(resolved.filePath)) {\n    throw new Error(\n      `Cannot resolve screenshot \"${id}\" for markdown attachment from ${opts.htmlPath}`,\n    );\n  }\n\n  copyFileSync(resolved.filePath, absolutePath);\n  opts.writtenFiles.add(suggestedFileName);\n}\n\nasync function markdownFromReport(\n  htmlPath: string,\n  outputDir: string,\n): Promise<{ markdownFiles: string[]; screenshotFiles: string[] }> {\n  const screenshotsDir = path.join(outputDir, 'screenshots');\n\n  mkdirSync(outputDir, { recursive: true });\n  mkdirSync(screenshotsDir, { recursive: true });\n\n  const { baseDump, executions } = collectDedupedExecutions(htmlPath);\n\n  const mergedReport = new ReportActionDump({\n    sdkVersion: baseDump.sdkVersion,\n    groupName: baseDump.groupName,\n    groupDescription: baseDump.groupDescription,\n    modelBriefs: baseDump.modelBriefs,\n    deviceType: baseDump.deviceType,\n    executions,\n  });\n\n  const result = reportToMarkdown(mergedReport);\n\n  const markdownFiles: string[] = [];\n  const writtenScreenshots = new Set<string>();\n\n  const mdPath = path.join(outputDir, 'report.md');\n  writeFileSync(mdPath, result.markdown, 'utf-8');\n  markdownFiles.push(mdPath);\n\n  for (const attachment of result.attachments) {\n    writeAttachmentFromReport(attachment, {\n      htmlPath,\n      screenshotsDir,\n      writtenFiles: writtenScreenshots,\n    });\n  }\n\n  return {\n    markdownFiles,\n    screenshotFiles: Array.from(writtenScreenshots)\n      .sort()\n      .map((f) => path.join(screenshotsDir, f)),\n  };\n}\n\nfunction resolveReportHtmlPath(htmlPath: string): string {\n  const normalizedPath = path.resolve(htmlPath);\n\n  if (!existsSync(normalizedPath)) {\n    throw new Error(`report-tool: --htmlPath does not exist: ${htmlPath}`);\n  }\n\n  const stats = statSync(normalizedPath);\n  if (!stats.isDirectory()) {\n    return normalizedPath;\n  }\n\n  const indexHtmlPath = path.join(normalizedPath, 'index.html');\n  if (!existsSync(indexHtmlPath)) {\n    throw new Error(\n      `report-tool: \"${htmlPath}\" is not an HTML report file, and no index.html was found under this directory.`,\n    );\n  }\n\n  return indexHtmlPath;\n}\n\nexport function splitReportFile(options: SplitReportFileOptions): {\n  executionJsonFiles: string[];\n  screenshotFiles: string[];\n} {\n  const { htmlPath, outputDir } = options;\n  if (!htmlPath) {\n    throw new Error('splitReportFile: htmlPath is required');\n  }\n\n  if (!outputDir) {\n    throw new Error('splitReportFile: outputDir is required');\n  }\n\n  const resolvedHtmlPath = resolveReportHtmlPath(htmlPath);\n  return splitReportHtmlByExecution({\n    htmlPath: resolvedHtmlPath,\n    outputDir,\n  });\n}\n\nexport async function reportFileToMarkdown(\n  options: ReportFileToMarkdownOptions,\n): Promise<{ markdownFiles: string[]; screenshotFiles: string[] }> {\n  const { htmlPath, outputDir } = options;\n  if (!htmlPath) {\n    throw new Error('reportFileToMarkdown: htmlPath is required');\n  }\n\n  if (!outputDir) {\n    throw new Error('reportFileToMarkdown: outputDir is required');\n  }\n\n  const resolvedHtmlPath = resolveReportHtmlPath(htmlPath);\n  return markdownFromReport(resolvedHtmlPath, outputDir);\n}\n\nconst reportCommandDefinition: ReportCliCommandDefinition = {\n  name: 'report-tool',\n  description:\n    'Transform Midscene report artifacts, including splitting executions and converting to markdown.',\n  schema: {\n    action: z\n      .enum(['split', 'to-markdown'])\n      .optional()\n      .describe(\n        'Report action to run. Supports: split, to-markdown. Defaults to split.',\n      ),\n    htmlPath: z\n      .string()\n      .optional()\n      .describe('Input report HTML path (e.g. ./report/index.html)'),\n    outputDir: z\n      .string()\n      .optional()\n      .describe('Output directory for generated report artifacts'),\n  },\n  handler: async (args) => {\n    const {\n      action = 'split',\n      htmlPath,\n      outputDir,\n    } = args as {\n      action?: string;\n      htmlPath?: string;\n      outputDir?: string;\n    };\n    if (action !== 'split' && action !== 'to-markdown') {\n      throw new Error(\n        `report-tool: unsupported --action value \"${action}\". Currently supported: split, to-markdown`,\n      );\n    }\n\n    if (!htmlPath) {\n      throw new Error('report-tool: --htmlPath is required');\n    }\n\n    if (!outputDir) {\n      throw new Error('report-tool: --outputDir is required');\n    }\n\n    if (action === 'to-markdown') {\n      const result = await reportFileToMarkdown({\n        htmlPath,\n        outputDir,\n      });\n      return {\n        isError: false,\n        content: [\n          {\n            type: 'text',\n            text: `Markdown export completed. Generated ${result.markdownFiles.length} markdown file(s) and ${result.screenshotFiles.length} screenshot(s). Output path: ${outputDir}`,\n          },\n        ],\n      };\n    }\n\n    const result = splitReportFile({\n      htmlPath,\n      outputDir,\n    });\n\n    return {\n      isError: false,\n      content: [\n        {\n          type: 'text',\n          text: `Report split completed. Generated ${result.executionJsonFiles.length} execution JSON files and ${result.screenshotFiles.length} screenshots. Output path: ${outputDir}`,\n        },\n      ],\n    };\n  },\n};\n\nexport function createReportCliCommands(): ReportCliCommandEntry[] {\n  return [\n    {\n      name: 'report-tool',\n      def: reportCommandDefinition,\n    },\n  ];\n}\n"],"names":["writeAttachmentFromReport","attachment","opts","suggestedFileName","id","mimeType","absolutePath","path","outputRelativePath","sourceRef","resolved","resolveScreenshotSource","rawBase64","writeFileSync","Buffer","existsSync","Error","copyFileSync","markdownFromReport","htmlPath","outputDir","screenshotsDir","mkdirSync","baseDump","executions","collectDedupedExecutions","mergedReport","ReportActionDump","result","reportToMarkdown","markdownFiles","writtenScreenshots","Set","mdPath","Array","f","resolveReportHtmlPath","normalizedPath","stats","statSync","indexHtmlPath","splitReportFile","options","resolvedHtmlPath","splitReportHtmlByExecution","reportFileToMarkdown","reportCommandDefinition","z","args","action","createReportCliCommands"],"mappings":";;;;;;;AA+CA,SAASA,0BACPC,UAA8B,EAC9BC,IAIC;IAED,MAAM,EAAEC,iBAAiB,EAAEC,EAAE,EAAEC,QAAQ,EAAE,GAAGJ;IAC5C,IAAIC,KAAK,YAAY,CAAC,GAAG,CAACC,oBAAoB;IAE9C,MAAMG,eAAeC,KAAUL,KAAK,cAAc,EAAEC;IAEpD,MAAMK,qBAAqB,CAAC,cAAc,EAAEL,mBAAmB;IAC/D,MAAMM,YACJR,WAAW,QAAQ,KAAKO,qBACpB;QACE,MAAM;QACNJ;QACA,YAAY;QACZ,UAAWC,YAAY;QACvB,SAAS;QACT,MAAMJ,WAAW,QAAQ;IAC3B,IACA;IAEN,MAAMS,WAAWC,wBAAwBF,WAAW;QAClD,YAAYP,KAAK,QAAQ;QACzB,YAAYE;QACZ,kBAAmBC,YAAY;IACjC;IAEA,IAAIK,AAAkB,eAAlBA,SAAS,IAAI,EAAiB;QAChC,MAAME,YAAYF,SAAS,OAAO,CAAC,OAAO,CACxC,mCACA;QAEFG,cAAcP,cAAcQ,OAAO,IAAI,CAACF,WAAW;QACnDV,KAAK,YAAY,CAAC,GAAG,CAACC;QACtB;IACF;IAEA,IAAI,CAACY,WAAWL,SAAS,QAAQ,GAC/B,MAAM,IAAIM,MACR,CAAC,2BAA2B,EAAEZ,GAAG,+BAA+B,EAAEF,KAAK,QAAQ,EAAE;IAIrFe,aAAaP,SAAS,QAAQ,EAAEJ;IAChCJ,KAAK,YAAY,CAAC,GAAG,CAACC;AACxB;AAEA,eAAee,mBACbC,QAAgB,EAChBC,SAAiB;IAEjB,MAAMC,iBAAiBd,KAAUa,WAAW;IAE5CE,UAAUF,WAAW;QAAE,WAAW;IAAK;IACvCE,UAAUD,gBAAgB;QAAE,WAAW;IAAK;IAE5C,MAAM,EAAEE,QAAQ,EAAEC,UAAU,EAAE,GAAGC,yBAAyBN;IAE1D,MAAMO,eAAe,IAAIC,iBAAiB;QACxC,YAAYJ,SAAS,UAAU;QAC/B,WAAWA,SAAS,SAAS;QAC7B,kBAAkBA,SAAS,gBAAgB;QAC3C,aAAaA,SAAS,WAAW;QACjC,YAAYA,SAAS,UAAU;QAC/BC;IACF;IAEA,MAAMI,SAASC,iBAAiBH;IAEhC,MAAMI,gBAA0B,EAAE;IAClC,MAAMC,qBAAqB,IAAIC;IAE/B,MAAMC,SAAS1B,KAAUa,WAAW;IACpCP,cAAcoB,QAAQL,OAAO,QAAQ,EAAE;IACvCE,cAAc,IAAI,CAACG;IAEnB,KAAK,MAAMhC,cAAc2B,OAAO,WAAW,CACzC5B,0BAA0BC,YAAY;QACpCkB;QACAE;QACA,cAAcU;IAChB;IAGF,OAAO;QACLD;QACA,iBAAiBI,MAAM,IAAI,CAACH,oBACzB,IAAI,GACJ,GAAG,CAAC,CAACI,IAAM5B,KAAUc,gBAAgBc;IAC1C;AACF;AAEA,SAASC,sBAAsBjB,QAAgB;IAC7C,MAAMkB,iBAAiB9B,QAAaY;IAEpC,IAAI,CAACJ,WAAWsB,iBACd,MAAM,IAAIrB,MAAM,CAAC,wCAAwC,EAAEG,UAAU;IAGvE,MAAMmB,QAAQC,SAASF;IACvB,IAAI,CAACC,MAAM,WAAW,IACpB,OAAOD;IAGT,MAAMG,gBAAgBjC,KAAU8B,gBAAgB;IAChD,IAAI,CAACtB,WAAWyB,gBACd,MAAM,IAAIxB,MACR,CAAC,cAAc,EAAEG,SAAS,+EAA+E,CAAC;IAI9G,OAAOqB;AACT;AAEO,SAASC,gBAAgBC,OAA+B;IAI7D,MAAM,EAAEvB,QAAQ,EAAEC,SAAS,EAAE,GAAGsB;IAChC,IAAI,CAACvB,UACH,MAAM,IAAIH,MAAM;IAGlB,IAAI,CAACI,WACH,MAAM,IAAIJ,MAAM;IAGlB,MAAM2B,mBAAmBP,sBAAsBjB;IAC/C,OAAOyB,2BAA2B;QAChC,UAAUD;QACVvB;IACF;AACF;AAEO,eAAeyB,qBACpBH,OAAoC;IAEpC,MAAM,EAAEvB,QAAQ,EAAEC,SAAS,EAAE,GAAGsB;IAChC,IAAI,CAACvB,UACH,MAAM,IAAIH,MAAM;IAGlB,IAAI,CAACI,WACH,MAAM,IAAIJ,MAAM;IAGlB,MAAM2B,mBAAmBP,sBAAsBjB;IAC/C,OAAOD,mBAAmByB,kBAAkBvB;AAC9C;AAEA,MAAM0B,0BAAsD;IAC1D,MAAM;IACN,aACE;IACF,QAAQ;QACN,QAAQC,CAAC,CAADA,OACD,CAAC;YAAC;YAAS;SAAc,EAC7B,QAAQ,GACR,QAAQ,CACP;QAEJ,UAAUA,EAAAA,MACD,GACN,QAAQ,GACR,QAAQ,CAAC;QACZ,WAAWA,EAAAA,MACF,GACN,QAAQ,GACR,QAAQ,CAAC;IACd;IACA,SAAS,OAAOC;QACd,MAAM,EACJC,SAAS,OAAO,EAChB9B,QAAQ,EACRC,SAAS,EACV,GAAG4B;QAKJ,IAAIC,AAAW,YAAXA,UAAsBA,AAAW,kBAAXA,QACxB,MAAM,IAAIjC,MACR,CAAC,yCAAyC,EAAEiC,OAAO,0CAA0C,CAAC;QAIlG,IAAI,CAAC9B,UACH,MAAM,IAAIH,MAAM;QAGlB,IAAI,CAACI,WACH,MAAM,IAAIJ,MAAM;QAGlB,IAAIiC,AAAW,kBAAXA,QAA0B;YAC5B,MAAMrB,SAAS,MAAMiB,qBAAqB;gBACxC1B;gBACAC;YACF;YACA,OAAO;gBACL,SAAS;gBACT,SAAS;oBACP;wBACE,MAAM;wBACN,MAAM,CAAC,qCAAqC,EAAEQ,OAAO,aAAa,CAAC,MAAM,CAAC,sBAAsB,EAAEA,OAAO,eAAe,CAAC,MAAM,CAAC,6BAA6B,EAAER,WAAW;oBAC5K;iBACD;YACH;QACF;QAEA,MAAMQ,SAASa,gBAAgB;YAC7BtB;YACAC;QACF;QAEA,OAAO;YACL,SAAS;YACT,SAAS;gBACP;oBACE,MAAM;oBACN,MAAM,CAAC,kCAAkC,EAAEQ,OAAO,kBAAkB,CAAC,MAAM,CAAC,0BAA0B,EAAEA,OAAO,eAAe,CAAC,MAAM,CAAC,2BAA2B,EAAER,WAAW;gBAChL;aACD;QACH;IACF;AACF;AAEO,SAAS8B;IACd,OAAO;QACL;YACE,MAAM;YACN,KAAKJ;QACP;KACD;AACH"}

package/dist/es/report-generator.mjs

@@ -0,0 +1,205 @@
+import { existsSync, mkdirSync, readdirSync, writeFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { getMidsceneRunSubDir } from "@midscene/shared/common";
+import { MIDSCENE_REPORT_QUIET, globalConfigManager } from "@midscene/shared/env";
+import { ifInBrowser, logMsg, uuid } from "@midscene/shared/utils";
+import { generateDumpScriptTag, generateImageScriptTag, getBaseUrlFixScript } from "./dump/html-utils.mjs";
+import { ScreenshotStore } from "./dump/screenshot-store.mjs";
+import { ReportActionDump } from "./types.mjs";
+import { appendFileSync, getReportTpl } from "./utils.mjs";
+function _define_property(obj, key, value) {
+    if (key in obj) Object.defineProperty(obj, key, {
+        value: value,
+        enumerable: true,
+        configurable: true,
+        writable: true
+    });
+    else obj[key] = value;
+    return obj;
+}
+const nullReportGenerator = {
+    onExecutionUpdate: ()=>{},
+    flush: async ()=>{},
+    finalize: async ()=>void 0,
+    getReportPath: ()=>void 0
+};
+function assertReportGenerationOptions(opts) {
+    if (false === opts.generateReport && true === opts.persistExecutionDump) throw new Error('persistExecutionDump cannot be true when generateReport is false');
+}
+class ReportGenerator {
+    static create(reportFileName, opts) {
+        assertReportGenerationOptions(opts);
+        if (false === opts.generateReport) return nullReportGenerator;
+        if (ifInBrowser) return nullReportGenerator;
+        validateReportFileName(reportFileName);
+        const reportRootDir = getMidsceneRunSubDir('report');
+        const outputDir = join(reportRootDir, reportFileName);
+        const reportPath = 'html-and-external-assets' === opts.outputFormat ? join(outputDir, 'index.html') : join(reportRootDir, ensureHtmlFileName(reportFileName));
+        return new ReportGenerator({
+            reportPath,
+            screenshotMode: 'html-and-external-assets' === opts.outputFormat ? 'directory' : 'inline',
+            persistExecutionDump: opts.persistExecutionDump,
+            autoPrint: opts.autoPrintReportMsg
+        });
+    }
+    onExecutionUpdate(execution, reportMeta, attributes) {
+        this.lastExecution = execution;
+        this.lastReportMeta = reportMeta;
+        this.mergeReportAttributes(attributes);
+        this.writeQueue = this.writeQueue.then(()=>{
+            if (this.destroyed) return;
+            this.doWriteExecution(execution, reportMeta);
+        });
+    }
+    async flush() {
+        await this.writeQueue;
+    }
+    async finalize() {
+        if (this.lastExecution && this.lastReportMeta) this.onExecutionUpdate(this.lastExecution, this.lastReportMeta);
+        await this.flush();
+        this.destroyed = true;
+        if (!this.initialized) return;
+        this.printReportPath('finalized');
+        return this.reportPath;
+    }
+    getReportPath() {
+        return this.reportPath;
+    }
+    printReportPath(verb) {
+        if (!this.autoPrint || !this.reportPath) return;
+        if (globalConfigManager.getEnvConfigInBoolean(MIDSCENE_REPORT_QUIET)) return;
+        'directory' === this.screenshotMode ? logMsg(`Midscene - report ${verb}: npx serve ${dirname(this.reportPath)}`) : logMsg(`Midscene - report ${verb}: ${this.reportPath}`);
+    }
+    doWriteExecution(execution, reportMeta) {
+        const singleDump = this.wrapAsReportDump(execution, reportMeta);
+        if ('inline' === this.screenshotMode) this.writeInlineExecution(execution, singleDump);
+        else this.writeDirectoryExecution(execution, singleDump);
+        if (this.shouldPersistExecutionDump) this.persistExecutionDumpToFile(execution, singleDump);
+        if (!this.firstWriteDone) {
+            this.firstWriteDone = true;
+            this.printReportPath('generated');
+        }
+    }
+    mergeReportAttributes(attributes) {
+        if (!attributes) return;
+        for (const [key, value] of Object.entries(attributes))if (null != value) {
+            if ('data-group-id' !== key) this.reportAttributes[key] = String(value);
+        }
+    }
+    hydrateStateFromExistingReport() {
+        if (!existsSync(this.reportPath)) return;
+        this.initialized = true;
+        if (!this.shouldPersistExecutionDump) return;
+        const reportDir = dirname(this.reportPath);
+        const existingExecutionIndices = readdirSync(reportDir).map((name)=>/^(\d+)\.execution\.json$/.exec(name)?.[1]).filter((index)=>Boolean(index)).map((index)=>Number.parseInt(index, 10)).filter((index)=>Number.isFinite(index));
+        if (existingExecutionIndices.length > 0) this.executionLogIndex = Math.max(...existingExecutionIndices);
+    }
+    getDumpScriptAttributes() {
+        return {
+            'data-group-id': this.reportStreamId,
+            ...this.reportAttributes
+        };
+    }
+    wrapAsReportDump(execution, reportMeta) {
+        return new ReportActionDump({
+            sdkVersion: reportMeta.sdkVersion,
+            groupName: reportMeta.groupName,
+            groupDescription: reportMeta.groupDescription,
+            modelBriefs: reportMeta.modelBriefs,
+            deviceType: reportMeta.deviceType,
+            executions: [
+                execution
+            ]
+        });
+    }
+    writeInlineExecution(execution, singleDump) {
+        const dir = dirname(this.reportPath);
+        if (!existsSync(dir)) mkdirSync(dir, {
+            recursive: true
+        });
+        if (!this.initialized) {
+            writeFileSync(this.reportPath, getReportTpl());
+            this.initialized = true;
+        }
+        for (const screenshot of execution.collectScreenshots())this.screenshotStore.persist(screenshot);
+        const serialized = singleDump.serialize();
+        appendFileSync(this.reportPath, `\n${generateDumpScriptTag(serialized, this.getDumpScriptAttributes())}`);
+    }
+    writeDirectoryExecution(execution, singleDump) {
+        const dir = dirname(this.reportPath);
+        if (!existsSync(dir)) mkdirSync(dir, {
+            recursive: true
+        });
+        for (const screenshot of execution.collectScreenshots())this.screenshotStore.persist(screenshot);
+        const serialized = singleDump.serialize();
+        if (!this.initialized) {
+            writeFileSync(this.reportPath, `${getReportTpl()}${getBaseUrlFixScript()}`);
+            this.initialized = true;
+        }
+        appendFileSync(this.reportPath, `\n${generateDumpScriptTag(serialized, this.getDumpScriptAttributes())}`);
+    }
+    getExecutionLogKey(execution) {
+        if (!execution.id) throw new Error('ReportGenerator: execution.id is required for persisting execution dumps');
+        return `id:${execution.id}`;
+    }
+    persistExecutionDumpToFile(execution, singleDump) {
+        const dir = dirname(this.reportPath);
+        if (!existsSync(dir)) mkdirSync(dir, {
+            recursive: true
+        });
+        const executionLogKey = this.getExecutionLogKey(execution);
+        let fileIndex = this.executionLogFileIndexByExecutionKey.get(executionLogKey);
+        if (!fileIndex) {
+            this.executionLogIndex += 1;
+            fileIndex = this.executionLogIndex;
+            this.executionLogFileIndexByExecutionKey.set(executionLogKey, fileIndex);
+        }
+        const fileName = `${fileIndex}.execution.json`;
+        const filePath = join(dirname(this.reportPath), fileName);
+        writeFileSync(filePath, singleDump.serialize(2), 'utf-8');
+    }
+    constructor(options){
+        _define_property(this, "reportPath", void 0);
+        _define_property(this, "screenshotMode", void 0);
+        _define_property(this, "shouldPersistExecutionDump", void 0);
+        _define_property(this, "autoPrint", void 0);
+        _define_property(this, "firstWriteDone", false);
+        _define_property(this, "executionLogIndex", 0);
+        _define_property(this, "executionLogFileIndexByExecutionKey", new Map());
+        _define_property(this, "reportStreamId", void 0);
+        _define_property(this, "screenshotStore", void 0);
+        _define_property(this, "initialized", false);
+        _define_property(this, "lastExecution", void 0);
+        _define_property(this, "lastReportMeta", void 0);
+        _define_property(this, "reportAttributes", {});
+        _define_property(this, "writeQueue", Promise.resolve());
+        _define_property(this, "destroyed", false);
+        this.reportPath = options.reportPath;
+        this.screenshotMode = options.screenshotMode;
+        this.shouldPersistExecutionDump = options.persistExecutionDump ?? false;
+        this.autoPrint = options.autoPrint ?? true;
+        this.reportStreamId = uuid();
+        this.screenshotStore = new ScreenshotStore({
+            mode: 'inline' === this.screenshotMode ? 'inline' : 'directory',
+            reportPath: this.reportPath,
+            screenshotsDir: join(dirname(this.reportPath), 'screenshots'),
+            writeInlineImage: (id, base64)=>{
+                appendFileSync(this.reportPath, `\n${generateImageScriptTag(id, base64)}`);
+            },
+            alsoWriteFileCopy: this.shouldPersistExecutionDump
+        });
+        this.hydrateStateFromExistingReport();
+        this.printReportPath('will be generated at');
+    }
+}
+function ensureHtmlFileName(reportFileName) {
+    return reportFileName.endsWith('.html') ? reportFileName : `${reportFileName}.html`;
+}
+function validateReportFileName(reportFileName) {
+    if (!reportFileName?.trim()) throw new Error('reportFileName must be a non-empty string');
+    if (/[\\/]/.test(reportFileName)) throw new Error('reportFileName must not contain path separators (`/` or `\\\\`)');
+    if (/[:*?"<>|]/.test(reportFileName)) throw new Error('reportFileName contains illegal filename characters: : * ? " < > |');
+}
+export { ReportGenerator, assertReportGenerationOptions, nullReportGenerator };
+
+//# sourceMappingURL=report-generator.mjs.map

package/dist/es/report-generator.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-generator.mjs","sources":["../../src/report-generator.ts"],"sourcesContent":["import { existsSync, mkdirSync, readdirSync, writeFileSync } from 'node:fs';\nimport { dirname, join } from 'node:path';\nimport { getMidsceneRunSubDir } from '@midscene/shared/common';\nimport {\n  MIDSCENE_REPORT_QUIET,\n  globalConfigManager,\n} from '@midscene/shared/env';\nimport { ifInBrowser, logMsg, uuid } from '@midscene/shared/utils';\nimport {\n  generateDumpScriptTag,\n  generateImageScriptTag,\n  getBaseUrlFixScript,\n} from './dump/html-utils';\nimport { ScreenshotStore } from './dump/screenshot-store';\nimport {\n  type ExecutionDump,\n  ReportActionDump,\n  type ReportAttributes,\n  type ReportMeta,\n} from './types';\nimport { appendFileSync, getReportTpl } from './utils';\n\nexport interface IReportGenerator {\n  /**\n   * Write or update a single execution.\n   * Each call appends a new dump script tag. The frontend deduplicates\n   * executions with the same id/name, keeping only the last one.\n   *\n   * @param execution  Current execution's full data\n   * @param reportMeta  Report-level metadata (groupName, sdkVersion, etc.)\n   */\n  onExecutionUpdate(\n    execution: ExecutionDump,\n    reportMeta: ReportMeta,\n    attributes?: ReportAttributes,\n  ): void;\n\n  /**\n   * @deprecated Use onExecutionUpdate instead. Kept for backward compatibility.\n   */\n  onDumpUpdate?(dump: ReportActionDump): void;\n\n  /**\n   * Wait for all queued write operations to complete.\n   */\n  flush(): Promise<void>;\n\n  /**\n   * Finalize the report. Calls flush() internally.\n   */\n  finalize(): Promise<string | undefined>;\n\n  getReportPath(): string | undefined;\n}\n\nexport const nullReportGenerator: IReportGenerator = {\n  onExecutionUpdate: () => {},\n  flush: async () => {},\n  finalize: async () => undefined,\n  getReportPath: () => undefined,\n};\n\nexport function assertReportGenerationOptions(opts: {\n  generateReport?: boolean;\n  persistExecutionDump?: boolean;\n}): void {\n  if (opts.generateReport === false && opts.persistExecutionDump === true) {\n    throw new Error(\n      'persistExecutionDump cannot be true when generateReport is false',\n    );\n  }\n}\n\nexport class ReportGenerator implements IReportGenerator {\n  private reportPath: string;\n  private screenshotMode: 'inline' | 'directory';\n  private shouldPersistExecutionDump: boolean;\n  private autoPrint: boolean;\n  private firstWriteDone = false;\n  private executionLogIndex = 0;\n  private executionLogFileIndexByExecutionKey = new Map<string, number>();\n\n  // Unique identifier for this report stream — used as data-group-id\n  private readonly reportStreamId: string;\n\n  // Tracks screenshots already written to disk (by id) to avoid duplicates\n  private screenshotStore: ScreenshotStore;\n  private initialized = false;\n\n  // Tracks the last execution + groupMeta for re-writing on finalize\n  private lastExecution?: ExecutionDump;\n  private lastReportMeta?: ReportMeta;\n  private reportAttributes: Record<string, string> = {};\n\n  // write queue for serial execution\n  private writeQueue: Promise<void> = Promise.resolve();\n  private destroyed = false;\n\n  constructor(options: {\n    reportPath: string;\n    screenshotMode: 'inline' | 'directory';\n    persistExecutionDump?: boolean;\n    autoPrint?: boolean;\n  }) {\n    this.reportPath = options.reportPath;\n    this.screenshotMode = options.screenshotMode;\n    this.shouldPersistExecutionDump = options.persistExecutionDump ?? false;\n    this.autoPrint = options.autoPrint ?? true;\n    this.reportStreamId = uuid();\n    this.screenshotStore = new ScreenshotStore({\n      mode: this.screenshotMode === 'inline' ? 'inline' : 'directory',\n      reportPath: this.reportPath,\n      screenshotsDir: join(dirname(this.reportPath), 'screenshots'),\n      writeInlineImage: (id, base64) => {\n        appendFileSync(\n          this.reportPath,\n          `\\n${generateImageScriptTag(id, base64)}`,\n        );\n      },\n      alsoWriteFileCopy: this.shouldPersistExecutionDump,\n    });\n    this.hydrateStateFromExistingReport();\n    this.printReportPath('will be generated at');\n  }\n\n  static create(\n    reportFileName: string,\n    opts: {\n      generateReport?: boolean;\n      persistExecutionDump?: boolean;\n      outputFormat?: 'single-html' | 'html-and-external-assets';\n      autoPrintReportMsg?: boolean;\n    },\n  ): IReportGenerator {\n    assertReportGenerationOptions(opts);\n    if (opts.generateReport === false) return nullReportGenerator;\n\n    // In browser environment, file system is not available\n    if (ifInBrowser) return nullReportGenerator;\n    validateReportFileName(reportFileName);\n\n    const reportRootDir = getMidsceneRunSubDir('report');\n    const outputDir = join(reportRootDir, reportFileName);\n    const reportPath =\n      opts.outputFormat === 'html-and-external-assets'\n        ? join(outputDir, 'index.html')\n        : join(reportRootDir, ensureHtmlFileName(reportFileName));\n    return new ReportGenerator({\n      reportPath,\n      screenshotMode:\n        opts.outputFormat === 'html-and-external-assets'\n          ? 'directory'\n          : 'inline',\n      persistExecutionDump: opts.persistExecutionDump,\n      autoPrint: opts.autoPrintReportMsg,\n    });\n  }\n\n  onExecutionUpdate(\n    execution: ExecutionDump,\n    reportMeta: ReportMeta,\n    attributes?: ReportAttributes,\n  ): void {\n    this.lastExecution = execution;\n    this.lastReportMeta = reportMeta;\n    this.mergeReportAttributes(attributes);\n    this.writeQueue = this.writeQueue.then(() => {\n      if (this.destroyed) return;\n      this.doWriteExecution(execution, reportMeta);\n    });\n  }\n\n  async flush(): Promise<void> {\n    await this.writeQueue;\n  }\n\n  async finalize(): Promise<string | undefined> {\n    // Re-write the last execution to capture any final state changes\n    if (this.lastExecution && this.lastReportMeta) {\n      this.onExecutionUpdate(this.lastExecution, this.lastReportMeta);\n    }\n    await this.flush();\n    this.destroyed = true;\n\n    if (!this.initialized) {\n      // No executions were ever written — no file exists\n      return undefined;\n    }\n\n    this.printReportPath('finalized');\n    return this.reportPath;\n  }\n\n  getReportPath(): string | undefined {\n    return this.reportPath;\n  }\n\n  private printReportPath(verb: string): void {\n    if (!this.autoPrint || !this.reportPath) return;\n    if (globalConfigManager.getEnvConfigInBoolean(MIDSCENE_REPORT_QUIET))\n      return;\n\n    if (this.screenshotMode === 'directory') {\n      logMsg(\n        `Midscene - report ${verb}: npx serve ${dirname(this.reportPath)}`,\n      );\n    } else {\n      logMsg(`Midscene - report ${verb}: ${this.reportPath}`);\n    }\n  }\n\n  private doWriteExecution(\n    execution: ExecutionDump,\n    reportMeta: ReportMeta,\n  ): void {\n    const singleDump = this.wrapAsReportDump(execution, reportMeta);\n\n    if (this.screenshotMode === 'inline') {\n      this.writeInlineExecution(execution, singleDump);\n    } else {\n      this.writeDirectoryExecution(execution, singleDump);\n    }\n\n    if (this.shouldPersistExecutionDump) {\n      this.persistExecutionDumpToFile(execution, singleDump);\n    }\n\n    if (!this.firstWriteDone) {\n      this.firstWriteDone = true;\n      this.printReportPath('generated');\n    }\n  }\n\n  private mergeReportAttributes(attributes?: ReportAttributes): void {\n    if (!attributes) {\n      return;\n    }\n\n    for (const [key, value] of Object.entries(attributes)) {\n      if (value === undefined || value === null) {\n        continue;\n      }\n      if (key === 'data-group-id') {\n        continue;\n      }\n      this.reportAttributes[key] = String(value);\n    }\n  }\n\n  private hydrateStateFromExistingReport(): void {\n    if (!existsSync(this.reportPath)) {\n      return;\n    }\n\n    // Reuse existing report file and append new updates instead of rewriting.\n    this.initialized = true;\n\n    if (!this.shouldPersistExecutionDump) {\n      return;\n    }\n\n    const reportDir = dirname(this.reportPath);\n    const existingExecutionIndices = readdirSync(reportDir)\n      .map((name) => /^(\\d+)\\.execution\\.json$/.exec(name)?.[1])\n      .filter((index): index is string => Boolean(index))\n      .map((index) => Number.parseInt(index, 10))\n      .filter((index) => Number.isFinite(index));\n\n    if (existingExecutionIndices.length > 0) {\n      this.executionLogIndex = Math.max(...existingExecutionIndices);\n    }\n  }\n\n  private getDumpScriptAttributes(): Record<string, string> {\n    return {\n      'data-group-id': this.reportStreamId,\n      ...this.reportAttributes,\n    };\n  }\n\n  /**\n   * Wrap an ExecutionDump + ReportMeta into a single-execution ReportActionDump.\n   */\n  private wrapAsReportDump(\n    execution: ExecutionDump,\n    reportMeta: ReportMeta,\n  ): ReportActionDump {\n    return new ReportActionDump({\n      sdkVersion: reportMeta.sdkVersion,\n      groupName: reportMeta.groupName,\n      groupDescription: reportMeta.groupDescription,\n      modelBriefs: reportMeta.modelBriefs,\n      deviceType: reportMeta.deviceType,\n      executions: [execution],\n    });\n  }\n\n  /**\n   * Append-only inline mode: write new screenshots and a dump tag on every call.\n   * The frontend deduplicates executions with the same id/name (keeps last).\n   * Duplicate dump JSON is acceptable; only screenshots are deduplicated.\n   */\n  private writeInlineExecution(\n    execution: ExecutionDump,\n    singleDump: ReportActionDump,\n  ): void {\n    const dir = dirname(this.reportPath);\n    if (!existsSync(dir)) {\n      mkdirSync(dir, { recursive: true });\n    }\n\n    // Initialize: write HTML template once\n    if (!this.initialized) {\n      writeFileSync(this.reportPath, getReportTpl());\n      this.initialized = true;\n    }\n\n    // Append new screenshots (skip already-written ones)\n    for (const screenshot of execution.collectScreenshots()) {\n      this.screenshotStore.persist(screenshot);\n    }\n\n    // Append dump tag (always — frontend keeps only last per execution id)\n    const serialized = singleDump.serialize();\n    appendFileSync(\n      this.reportPath,\n      `\\n${generateDumpScriptTag(serialized, this.getDumpScriptAttributes())}`,\n    );\n  }\n\n  private writeDirectoryExecution(\n    execution: ExecutionDump,\n    singleDump: ReportActionDump,\n  ): void {\n    const dir = dirname(this.reportPath);\n    if (!existsSync(dir)) {\n      mkdirSync(dir, { recursive: true });\n    }\n\n    for (const screenshot of execution.collectScreenshots()) {\n      this.screenshotStore.persist(screenshot);\n    }\n\n    // 2. Append dump tag (always — frontend keeps only last per execution id)\n    const serialized = singleDump.serialize();\n\n    if (!this.initialized) {\n      writeFileSync(\n        this.reportPath,\n        `${getReportTpl()}${getBaseUrlFixScript()}`,\n      );\n      this.initialized = true;\n    }\n\n    appendFileSync(\n      this.reportPath,\n      `\\n${generateDumpScriptTag(serialized, this.getDumpScriptAttributes())}`,\n    );\n  }\n\n  private getExecutionLogKey(execution: ExecutionDump): string {\n    if (!execution.id) {\n      throw new Error(\n        'ReportGenerator: execution.id is required for persisting execution dumps',\n      );\n    }\n    return `id:${execution.id}`;\n  }\n\n  private persistExecutionDumpToFile(\n    execution: ExecutionDump,\n    singleDump: ReportActionDump,\n  ): void {\n    const dir = dirname(this.reportPath);\n    if (!existsSync(dir)) {\n      mkdirSync(dir, { recursive: true });\n    }\n\n    const executionLogKey = this.getExecutionLogKey(execution);\n    let fileIndex =\n      this.executionLogFileIndexByExecutionKey.get(executionLogKey);\n    if (!fileIndex) {\n      this.executionLogIndex += 1;\n      fileIndex = this.executionLogIndex;\n      this.executionLogFileIndexByExecutionKey.set(executionLogKey, fileIndex);\n    }\n\n    const fileName = `${fileIndex}.execution.json`;\n    const filePath = join(dirname(this.reportPath), fileName);\n    writeFileSync(filePath, singleDump.serialize(2), 'utf-8');\n  }\n}\n\nfunction ensureHtmlFileName(reportFileName: string): string {\n  return reportFileName.endsWith('.html')\n    ? reportFileName\n    : `${reportFileName}.html`;\n}\n\nfunction validateReportFileName(reportFileName: string): void {\n  if (!reportFileName?.trim()) {\n    throw new Error('reportFileName must be a non-empty string');\n  }\n\n  if (/[\\\\/]/.test(reportFileName)) {\n    throw new Error(\n      'reportFileName must not contain path separators (`/` or `\\\\\\\\`)',\n    );\n  }\n\n  if (/[:*?\"<>|]/.test(reportFileName)) {\n    throw new Error(\n      'reportFileName contains illegal filename characters: : * ? \" < > |',\n    );\n  }\n}\n"],"names":["nullReportGenerator","undefined","assertReportGenerationOptions","opts","Error","ReportGenerator","reportFileName","ifInBrowser","validateReportFileName","reportRootDir","getMidsceneRunSubDir","outputDir","join","reportPath","ensureHtmlFileName","execution","reportMeta","attributes","verb","globalConfigManager","MIDSCENE_REPORT_QUIET","logMsg","dirname","singleDump","key","value","Object","String","existsSync","reportDir","existingExecutionIndices","readdirSync","name","index","Boolean","Number","Math","ReportActionDump","dir","mkdirSync","writeFileSync","getReportTpl","screenshot","serialized","appendFileSync","generateDumpScriptTag","getBaseUrlFixScript","executionLogKey","fileIndex","fileName","filePath","options","Map","Promise","uuid","ScreenshotStore","id","base64","generateImageScriptTag"],"mappings":";;;;;;;;;;;;;;;;;;;AAuDO,MAAMA,sBAAwC;IACnD,mBAAmB,KAAO;IAC1B,OAAO,WAAa;IACpB,UAAU,UAAYC;IACtB,eAAe,IAAMA;AACvB;AAEO,SAASC,8BAA8BC,IAG7C;IACC,IAAIA,AAAwB,UAAxBA,KAAK,cAAc,IAAcA,AAA8B,SAA9BA,KAAK,oBAAoB,EAC5D,MAAM,IAAIC,MACR;AAGN;AAEO,MAAMC;IAoDX,OAAO,OACLC,cAAsB,EACtBH,IAKC,EACiB;QAClBD,8BAA8BC;QAC9B,IAAIA,AAAwB,UAAxBA,KAAK,cAAc,EAAY,OAAOH;QAG1C,IAAIO,aAAa,OAAOP;QACxBQ,uBAAuBF;QAEvB,MAAMG,gBAAgBC,qBAAqB;QAC3C,MAAMC,YAAYC,KAAKH,eAAeH;QACtC,MAAMO,aACJV,AAAsB,+BAAtBA,KAAK,YAAY,GACbS,KAAKD,WAAW,gBAChBC,KAAKH,eAAeK,mBAAmBR;QAC7C,OAAO,IAAID,gBAAgB;YACzBQ;YACA,gBACEV,AAAsB,+BAAtBA,KAAK,YAAY,GACb,cACA;YACN,sBAAsBA,KAAK,oBAAoB;YAC/C,WAAWA,KAAK,kBAAkB;QACpC;IACF;IAEA,kBACEY,SAAwB,EACxBC,UAAsB,EACtBC,UAA6B,EACvB;QACN,IAAI,CAAC,aAAa,GAAGF;QACrB,IAAI,CAAC,cAAc,GAAGC;QACtB,IAAI,CAAC,qBAAqB,CAACC;QAC3B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACrC,IAAI,IAAI,CAAC,SAAS,EAAE;YACpB,IAAI,CAAC,gBAAgB,CAACF,WAAWC;QACnC;IACF;IAEA,MAAM,QAAuB;QAC3B,MAAM,IAAI,CAAC,UAAU;IACvB;IAEA,MAAM,WAAwC;QAE5C,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc,EAC3C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,cAAc;QAEhE,MAAM,IAAI,CAAC,KAAK;QAChB,IAAI,CAAC,SAAS,GAAG;QAEjB,IAAI,CAAC,IAAI,CAAC,WAAW,EAEnB;QAGF,IAAI,CAAC,eAAe,CAAC;QACrB,OAAO,IAAI,CAAC,UAAU;IACxB;IAEA,gBAAoC;QAClC,OAAO,IAAI,CAAC,UAAU;IACxB;IAEQ,gBAAgBE,IAAY,EAAQ;QAC1C,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;QACzC,IAAIC,oBAAoB,qBAAqB,CAACC,wBAC5C;QAE0B,gBAAxB,IAAI,CAAC,cAAc,GACrBC,OACE,CAAC,kBAAkB,EAAEH,KAAK,YAAY,EAAEI,QAAQ,IAAI,CAAC,UAAU,GAAG,IAGpED,OAAO,CAAC,kBAAkB,EAAEH,KAAK,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE;IAE1D;IAEQ,iBACNH,SAAwB,EACxBC,UAAsB,EAChB;QACN,MAAMO,aAAa,IAAI,CAAC,gBAAgB,CAACR,WAAWC;QAEpD,IAAI,AAAwB,aAAxB,IAAI,CAAC,cAAc,EACrB,IAAI,CAAC,oBAAoB,CAACD,WAAWQ;aAErC,IAAI,CAAC,uBAAuB,CAACR,WAAWQ;QAG1C,IAAI,IAAI,CAAC,0BAA0B,EACjC,IAAI,CAAC,0BAA0B,CAACR,WAAWQ;QAG7C,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACxB,IAAI,CAAC,cAAc,GAAG;YACtB,IAAI,CAAC,eAAe,CAAC;QACvB;IACF;IAEQ,sBAAsBN,UAA6B,EAAQ;QACjE,IAAI,CAACA,YACH;QAGF,KAAK,MAAM,CAACO,KAAKC,MAAM,IAAIC,OAAO,OAAO,CAACT,YACxC,IAAIQ,QAAAA,OAGJ;YAAA,IAAID,AAAQ,oBAARA,KAGJ,IAAI,CAAC,gBAAgB,CAACA,IAAI,GAAGG,OAAOF;QADpC;IAGJ;IAEQ,iCAAuC;QAC7C,IAAI,CAACG,WAAW,IAAI,CAAC,UAAU,GAC7B;QAIF,IAAI,CAAC,WAAW,GAAG;QAEnB,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAClC;QAGF,MAAMC,YAAYP,QAAQ,IAAI,CAAC,UAAU;QACzC,MAAMQ,2BAA2BC,YAAYF,WAC1C,GAAG,CAAC,CAACG,OAAS,2BAA2B,IAAI,CAACA,OAAO,CAAC,EAAE,EACxD,MAAM,CAAC,CAACC,QAA2BC,QAAQD,QAC3C,GAAG,CAAC,CAACA,QAAUE,OAAO,QAAQ,CAACF,OAAO,KACtC,MAAM,CAAC,CAACA,QAAUE,OAAO,QAAQ,CAACF;QAErC,IAAIH,yBAAyB,MAAM,GAAG,GACpC,IAAI,CAAC,iBAAiB,GAAGM,KAAK,GAAG,IAAIN;IAEzC;IAEQ,0BAAkD;QACxD,OAAO;YACL,iBAAiB,IAAI,CAAC,cAAc;YACpC,GAAG,IAAI,CAAC,gBAAgB;QAC1B;IACF;IAKQ,iBACNf,SAAwB,EACxBC,UAAsB,EACJ;QAClB,OAAO,IAAIqB,iBAAiB;YAC1B,YAAYrB,WAAW,UAAU;YACjC,WAAWA,WAAW,SAAS;YAC/B,kBAAkBA,WAAW,gBAAgB;YAC7C,aAAaA,WAAW,WAAW;YACnC,YAAYA,WAAW,UAAU;YACjC,YAAY;gBAACD;aAAU;QACzB;IACF;IAOQ,qBACNA,SAAwB,EACxBQ,UAA4B,EACtB;QACN,MAAMe,MAAMhB,QAAQ,IAAI,CAAC,UAAU;QACnC,IAAI,CAACM,WAAWU,MACdC,UAAUD,KAAK;YAAE,WAAW;QAAK;QAInC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrBE,cAAc,IAAI,CAAC,UAAU,EAAEC;YAC/B,IAAI,CAAC,WAAW,GAAG;QACrB;QAGA,KAAK,MAAMC,cAAc3B,UAAU,kBAAkB,GACnD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC2B;QAI/B,MAAMC,aAAapB,WAAW,SAAS;QACvCqB,eACE,IAAI,CAAC,UAAU,EACf,CAAC,EAAE,EAAEC,sBAAsBF,YAAY,IAAI,CAAC,uBAAuB,KAAK;IAE5E;IAEQ,wBACN5B,SAAwB,EACxBQ,UAA4B,EACtB;QACN,MAAMe,MAAMhB,QAAQ,IAAI,CAAC,UAAU;QACnC,IAAI,CAACM,WAAWU,MACdC,UAAUD,KAAK;YAAE,WAAW;QAAK;QAGnC,KAAK,MAAMI,cAAc3B,UAAU,kBAAkB,GACnD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC2B;QAI/B,MAAMC,aAAapB,WAAW,SAAS;QAEvC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrBiB,cACE,IAAI,CAAC,UAAU,EACf,GAAGC,iBAAiBK,uBAAuB;YAE7C,IAAI,CAAC,WAAW,GAAG;QACrB;QAEAF,eACE,IAAI,CAAC,UAAU,EACf,CAAC,EAAE,EAAEC,sBAAsBF,YAAY,IAAI,CAAC,uBAAuB,KAAK;IAE5E;IAEQ,mBAAmB5B,SAAwB,EAAU;QAC3D,IAAI,CAACA,UAAU,EAAE,EACf,MAAM,IAAIX,MACR;QAGJ,OAAO,CAAC,GAAG,EAAEW,UAAU,EAAE,EAAE;IAC7B;IAEQ,2BACNA,SAAwB,EACxBQ,UAA4B,EACtB;QACN,MAAMe,MAAMhB,QAAQ,IAAI,CAAC,UAAU;QACnC,IAAI,CAACM,WAAWU,MACdC,UAAUD,KAAK;YAAE,WAAW;QAAK;QAGnC,MAAMS,kBAAkB,IAAI,CAAC,kBAAkB,CAAChC;QAChD,IAAIiC,YACF,IAAI,CAAC,mCAAmC,CAAC,GAAG,CAACD;QAC/C,IAAI,CAACC,WAAW;YACd,IAAI,CAAC,iBAAiB,IAAI;YAC1BA,YAAY,IAAI,CAAC,iBAAiB;YAClC,IAAI,CAAC,mCAAmC,CAAC,GAAG,CAACD,iBAAiBC;QAChE;QAEA,MAAMC,WAAW,GAAGD,UAAU,eAAe,CAAC;QAC9C,MAAME,WAAWtC,KAAKU,QAAQ,IAAI,CAAC,UAAU,GAAG2B;QAChDT,cAAcU,UAAU3B,WAAW,SAAS,CAAC,IAAI;IACnD;IApSA,YAAY4B,OAKX,CAAE;QA7BH,uBAAQ,cAAR;QACA,uBAAQ,kBAAR;QACA,uBAAQ,8BAAR;QACA,uBAAQ,aAAR;QACA,uBAAQ,kBAAiB;QACzB,uBAAQ,qBAAoB;QAC5B,uBAAQ,uCAAsC,IAAIC;QAGlD,uBAAiB,kBAAjB;QAGA,uBAAQ,mBAAR;QACA,uBAAQ,eAAc;QAGtB,uBAAQ,iBAAR;QACA,uBAAQ,kBAAR;QACA,uBAAQ,oBAA2C,CAAC;QAGpD,uBAAQ,cAA4BC,QAAQ,OAAO;QACnD,uBAAQ,aAAY;QAQlB,IAAI,CAAC,UAAU,GAAGF,QAAQ,UAAU;QACpC,IAAI,CAAC,cAAc,GAAGA,QAAQ,cAAc;QAC5C,IAAI,CAAC,0BAA0B,GAAGA,QAAQ,oBAAoB,IAAI;QAClE,IAAI,CAAC,SAAS,GAAGA,QAAQ,SAAS,IAAI;QACtC,IAAI,CAAC,cAAc,GAAGG;QACtB,IAAI,CAAC,eAAe,GAAG,IAAIC,gBAAgB;YACzC,MAAM,AAAwB,aAAxB,IAAI,CAAC,cAAc,GAAgB,WAAW;YACpD,YAAY,IAAI,CAAC,UAAU;YAC3B,gBAAgB3C,KAAKU,QAAQ,IAAI,CAAC,UAAU,GAAG;YAC/C,kBAAkB,CAACkC,IAAIC;gBACrBb,eACE,IAAI,CAAC,UAAU,EACf,CAAC,EAAE,EAAEc,uBAAuBF,IAAIC,SAAS;YAE7C;YACA,mBAAmB,IAAI,CAAC,0BAA0B;QACpD;QACA,IAAI,CAAC,8BAA8B;QACnC,IAAI,CAAC,eAAe,CAAC;IACvB;AA4QF;AAEA,SAAS3C,mBAAmBR,cAAsB;IAChD,OAAOA,eAAe,QAAQ,CAAC,WAC3BA,iBACA,GAAGA,eAAe,KAAK,CAAC;AAC9B;AAEA,SAASE,uBAAuBF,cAAsB;IACpD,IAAI,CAACA,gBAAgB,QACnB,MAAM,IAAIF,MAAM;IAGlB,IAAI,QAAQ,IAAI,CAACE,iBACf,MAAM,IAAIF,MACR;IAIJ,IAAI,YAAY,IAAI,CAACE,iBACnB,MAAM,IAAIF,MACR;AAGN"}

package/dist/es/report-markdown.mjs

@@ -0,0 +1,218 @@
+import { basename } from "node:path";
+import { extractInsightParam, paramStr, typeStr } from "./agent/ui-utils.mjs";
+import { ScreenshotItem } from "./screenshot-item.mjs";
+import { normalizeScreenshotRef } from "./dump/screenshot-store.mjs";
+function toExecutionDump(execution) {
+    if (!execution || 'object' != typeof execution) throw new Error('executionToMarkdown: execution is required');
+    if (!Array.isArray(execution.tasks)) throw new Error('executionToMarkdown: execution.tasks must be an array');
+    if (!execution.name) throw new Error('executionToMarkdown: execution.name is required');
+    return execution;
+}
+function toReportDump(report) {
+    if (!report || 'object' != typeof report) throw new Error('reportToMarkdown: report is required');
+    if (!Array.isArray(report.executions)) throw new Error('reportToMarkdown: report.executions must be an array');
+    return report;
+}
+function formatTime(ts) {
+    if ('number' != typeof ts || Number.isNaN(ts)) return 'N/A';
+    return new Date(ts).toISOString();
+}
+function resolveTaskTiming(task) {
+    const timing = task.timing;
+    if (!timing) return {};
+    const start = timing.start ?? timing.callAiStart ?? timing.callActionStart;
+    const end = timing.end ?? timing.callAiEnd ?? timing.callActionEnd ?? timing.captureAfterCallingSnapshotEnd;
+    const cost = timing.cost ?? ('number' == typeof start && 'number' == typeof end ? end - start : void 0);
+    return {
+        start,
+        end,
+        cost
+    };
+}
+function safeTaskParam(task) {
+    const readable = paramStr(task);
+    if (readable) return readable;
+    if ('Insight' === task.type) return extractInsightParam(task.param).content;
+    return '';
+}
+function formatSize(size) {
+    if (!size || 'number' != typeof size.width || 'number' != typeof size.height || Number.isNaN(size.width) || Number.isNaN(size.height)) return;
+    return `${size.width} x ${size.height}`;
+}
+function extractLocateCenter(task) {
+    const outputCenter = task.output?.element?.center;
+    if (Array.isArray(outputCenter) && outputCenter.length >= 2 && 'number' == typeof outputCenter[0] && 'number' == typeof outputCenter[1]) return [
+        outputCenter[0],
+        outputCenter[1]
+    ];
+    const paramLocateCenter = task.param?.locate?.center;
+    if (Array.isArray(paramLocateCenter) && paramLocateCenter.length >= 2 && 'number' == typeof paramLocateCenter[0] && 'number' == typeof paramLocateCenter[1]) return [
+        paramLocateCenter[0],
+        paramLocateCenter[1]
+    ];
+    const paramCenter = task.param?.center;
+    if (Array.isArray(paramCenter) && paramCenter.length >= 2 && 'number' == typeof paramCenter[0] && 'number' == typeof paramCenter[1]) return [
+        paramCenter[0],
+        paramCenter[1]
+    ];
+}
+function tryExtractBase64(screenshot) {
+    if (!screenshot || 'object' != typeof screenshot) return;
+    const s = screenshot;
+    if ('string' == typeof s.base64 && s.base64.length > 0) return s.base64;
+}
+function screenshotAttachment(screenshot, screenshotBaseDir, executionIndex, taskIndex) {
+    if (screenshot instanceof ScreenshotItem) {
+        const ext = screenshot.extension;
+        const suggestedFileName = `execution-${executionIndex + 1}-task-${taskIndex + 1}-${screenshot.id}.${ext}`;
+        const filePath = `${screenshotBaseDir}/${suggestedFileName}`;
+        return {
+            markdown: `\n![task-${taskIndex + 1}](${filePath})`,
+            attachment: {
+                id: screenshot.id,
+                suggestedFileName,
+                filePath,
+                mimeType: `image/${'jpeg' === ext ? 'jpeg' : 'png'}`,
+                executionIndex,
+                taskIndex,
+                base64Data: tryExtractBase64(screenshot)
+            }
+        };
+    }
+    const ref = normalizeScreenshotRef(screenshot);
+    if (ref) {
+        const ext = 'image/jpeg' === ref.mimeType ? 'jpeg' : 'png';
+        const suggestedFileName = `execution-${executionIndex + 1}-task-${taskIndex + 1}-${ref.id}.${ext}`;
+        const filePath = ref.path || `${screenshotBaseDir}/${suggestedFileName}`;
+        return {
+            markdown: `\n![task-${taskIndex + 1}](${filePath})`,
+            attachment: {
+                id: ref.id,
+                suggestedFileName,
+                filePath,
+                mimeType: ref.mimeType,
+                executionIndex,
+                taskIndex,
+                base64Data: tryExtractBase64(screenshot)
+            }
+        };
+    }
+    const base64 = tryExtractBase64(screenshot);
+    if (base64) {
+        const ext = base64.startsWith('data:image/jpeg') ? 'jpeg' : 'png';
+        const id = `restored-${executionIndex + 1}-${taskIndex + 1}`;
+        const suggestedFileName = `execution-${executionIndex + 1}-task-${taskIndex + 1}-${id}.${ext}`;
+        const filePath = `${screenshotBaseDir}/${suggestedFileName}`;
+        return {
+            markdown: `\n![task-${taskIndex + 1}](${filePath})`,
+            attachment: {
+                id,
+                suggestedFileName,
+                filePath,
+                mimeType: `image/${ext}`,
+                executionIndex,
+                taskIndex,
+                base64Data: base64
+            }
+        };
+    }
+    throw new Error(`executionToMarkdown: missing screenshot for execution #${executionIndex + 1} task #${taskIndex + 1}`);
+}
+function recorderMarkdownSection(recorder, screenshotBaseDir, executionIndex, taskIndex) {
+    if (!recorder?.length) return {
+        lines: [],
+        attachments: []
+    };
+    const lines = [
+        '',
+        '### Recorder'
+    ];
+    const attachments = [];
+    recorder.forEach((item, recorderIndex)=>{
+        lines.push(`- #${recorderIndex + 1} type=${item.type}, ts=${formatTime(item.ts)}, timing=${item.timing || 'N/A'}`);
+        if (!item.screenshot) return;
+        const imageResult = screenshotAttachment(item.screenshot, screenshotBaseDir, executionIndex, taskIndex);
+        lines.push(imageResult.markdown);
+        attachments.push(imageResult.attachment);
+    });
+    return {
+        lines,
+        attachments
+    };
+}
+function renderExecution(executionRaw, executionIndex, options) {
+    const execution = toExecutionDump(executionRaw);
+    const screenshotBaseDir = options?.screenshotBaseDir ?? './screenshots';
+    const lines = [];
+    const attachments = [];
+    lines.push(`# ${execution.name}`);
+    if (execution.description) lines.push('', execution.description);
+    lines.push('', `- Execution start: ${formatTime(execution.logTime)}`);
+    lines.push(`- Task count: ${execution.tasks.length}`);
+    execution.tasks.forEach((task, taskIndex)=>{
+        const title = typeStr(task);
+        const detail = safeTaskParam(task);
+        const time = resolveTaskTiming(task);
+        lines.push('', `## ${taskIndex + 1}. ${title}${detail ? ` - ${detail}` : ''}`);
+        lines.push(`- Status: ${task.status || 'unknown'}`);
+        lines.push(`- Start: ${formatTime(time.start)}`);
+        lines.push(`- End: ${formatTime(time.end)}`);
+        lines.push(`- Cost(ms): ${'number' == typeof time.cost ? time.cost : 'N/A'}`);
+        lines.push(`- Screen size: ${formatSize(task.uiContext?.shotSize) || 'N/A'}`);
+        if ('Locate' === task.subType) {
+            const locateCenter = extractLocateCenter(task);
+            if (locateCenter) lines.push(`- Locate center: (${locateCenter[0]}, ${locateCenter[1]})`);
+        }
+        if (task.errorMessage) lines.push(`- Error: ${task.errorMessage}`);
+        if (task.uiContext?.screenshot) {
+            const imageResult = screenshotAttachment(task.uiContext.screenshot, screenshotBaseDir, executionIndex, taskIndex);
+            lines.push(imageResult.markdown);
+            attachments.push(imageResult.attachment);
+        }
+        const recorderSection = recorderMarkdownSection(task.recorder, screenshotBaseDir, executionIndex, taskIndex);
+        if (recorderSection.lines.length) {
+            lines.push(...recorderSection.lines);
+            attachments.push(...recorderSection.attachments);
+        }
+    });
+    return {
+        markdown: lines.join('\n'),
+        attachments
+    };
+}
+function reportFileName(execution, executionIndex) {
+    const safeName = execution.name.trim().replace(/\s+/g, '-').replace(/[^a-zA-Z0-9-_]/g, '') || `execution-${executionIndex + 1}`;
+    return `${executionIndex + 1}-${basename(safeName)}.md`;
+}
+function executionToMarkdown(execution, options) {
+    return renderExecution(execution, 0, options);
+}
+function reportToMarkdown(report) {
+    const reportDump = toReportDump(report);
+    const executionResults = reportDump.executions.map((execution, index)=>{
+        const rendered = renderExecution(execution, index);
+        return {
+            executionIndex: index,
+            executionName: execution.name,
+            markdown: rendered.markdown,
+            attachments: rendered.attachments,
+            suggestedFileName: reportFileName(execution, index)
+        };
+    });
+    const attachments = executionResults.flatMap((item)=>item.attachments);
+    const header = [
+        `# ${reportDump.groupName}`,
+        reportDump.groupDescription ? `\n${reportDump.groupDescription}` : '',
+        `\n- SDK Version: ${reportDump.sdkVersion}`,
+        `- Execution count: ${reportDump.executions.length}`,
+        '\n## Suggested execution markdown files',
+        ...executionResults.map((item)=>`- ${item.suggestedFileName} (${item.executionName})`)
+    ].filter(Boolean).join('\n');
+    return {
+        markdown: `${header}\n\n${executionResults.map((item)=>item.markdown).join('\n\n---\n\n')}`,
+        attachments
+    };
+}
+export { executionToMarkdown, reportToMarkdown };
+
+//# sourceMappingURL=report-markdown.mjs.map