@midscene/shared 0.13.1 → 0.13.2-beta-20250401015137.0

package/dist/script/htmlElementDebug.js

@@ -570,472 +570,6 @@ var midscene_element_inspector = (() => {
     }
   });
 
-  // ../../node_modules/.pnpm/ms@2.1.3/node_modules/ms/index.js
-  var require_ms = __commonJS({
-    "../../node_modules/.pnpm/ms@2.1.3/node_modules/ms/index.js"(exports, module) {
-      "use strict";
-      var s = 1e3;
-      var m = s * 60;
-      var h = m * 60;
-      var d = h * 24;
-      var w = d * 7;
-      var y = d * 365.25;
-      module.exports = function(val, options) {
-        options = options || {};
-        var type = typeof val;
-        if (type === "string" && val.length > 0) {
-          return parse(val);
-        } else if (type === "number" && isFinite(val)) {
-          return options.long ? fmtLong(val) : fmtShort(val);
-        }
-        throw new Error(
-          "val is not a non-empty string or a valid number. val=" + JSON.stringify(val)
-        );
-      };
-      function parse(str) {
-        str = String(str);
-        if (str.length > 100) {
-          return;
-        }
-        var match = /^(-?(?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec(
-          str
-        );
-        if (!match) {
-          return;
-        }
-        var n = parseFloat(match[1]);
-        var type = (match[2] || "ms").toLowerCase();
-        switch (type) {
-          case "years":
-          case "year":
-          case "yrs":
-          case "yr":
-          case "y":
-            return n * y;
-          case "weeks":
-          case "week":
-          case "w":
-            return n * w;
-          case "days":
-          case "day":
-          case "d":
-            return n * d;
-          case "hours":
-          case "hour":
-          case "hrs":
-          case "hr":
-          case "h":
-            return n * h;
-          case "minutes":
-          case "minute":
-          case "mins":
-          case "min":
-          case "m":
-            return n * m;
-          case "seconds":
-          case "second":
-          case "secs":
-          case "sec":
-          case "s":
-            return n * s;
-          case "milliseconds":
-          case "millisecond":
-          case "msecs":
-          case "msec":
-          case "ms":
-            return n;
-          default:
-            return void 0;
-        }
-      }
-      function fmtShort(ms) {
-        var msAbs = Math.abs(ms);
-        if (msAbs >= d) {
-          return Math.round(ms / d) + "d";
-        }
-        if (msAbs >= h) {
-          return Math.round(ms / h) + "h";
-        }
-        if (msAbs >= m) {
-          return Math.round(ms / m) + "m";
-        }
-        if (msAbs >= s) {
-          return Math.round(ms / s) + "s";
-        }
-        return ms + "ms";
-      }
-      function fmtLong(ms) {
-        var msAbs = Math.abs(ms);
-        if (msAbs >= d) {
-          return plural(ms, msAbs, d, "day");
-        }
-        if (msAbs >= h) {
-          return plural(ms, msAbs, h, "hour");
-        }
-        if (msAbs >= m) {
-          return plural(ms, msAbs, m, "minute");
-        }
-        if (msAbs >= s) {
-          return plural(ms, msAbs, s, "second");
-        }
-        return ms + " ms";
-      }
-      function plural(ms, msAbs, n, name) {
-        var isPlural = msAbs >= n * 1.5;
-        return Math.round(ms / n) + " " + name + (isPlural ? "s" : "");
-      }
-    }
-  });
-
-  // ../../node_modules/.pnpm/debug@4.4.0_supports-color@5.5.0/node_modules/debug/src/common.js
-  var require_common = __commonJS({
-    "../../node_modules/.pnpm/debug@4.4.0_supports-color@5.5.0/node_modules/debug/src/common.js"(exports, module) {
-      "use strict";
-      function setup(env) {
-        createDebug.debug = createDebug;
-        createDebug.default = createDebug;
-        createDebug.coerce = coerce;
-        createDebug.disable = disable;
-        createDebug.enable = enable;
-        createDebug.enabled = enabled;
-        createDebug.humanize = require_ms();
-        createDebug.destroy = destroy;
-        Object.keys(env).forEach((key) => {
-          createDebug[key] = env[key];
-        });
-        createDebug.names = [];
-        createDebug.skips = [];
-        createDebug.formatters = {};
-        function selectColor(namespace) {
-          let hash = 0;
-          for (let i = 0; i < namespace.length; i++) {
-            hash = (hash << 5) - hash + namespace.charCodeAt(i);
-            hash |= 0;
-          }
-          return createDebug.colors[Math.abs(hash) % createDebug.colors.length];
-        }
-        createDebug.selectColor = selectColor;
-        function createDebug(namespace) {
-          let prevTime;
-          let enableOverride = null;
-          let namespacesCache;
-          let enabledCache;
-          function debug2(...args) {
-            if (!debug2.enabled) {
-              return;
-            }
-            const self2 = debug2;
-            const curr = Number(/* @__PURE__ */ new Date());
-            const ms = curr - (prevTime || curr);
-            self2.diff = ms;
-            self2.prev = prevTime;
-            self2.curr = curr;
-            prevTime = curr;
-            args[0] = createDebug.coerce(args[0]);
-            if (typeof args[0] !== "string") {
-              args.unshift("%O");
-            }
-            let index = 0;
-            args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {
-              if (match === "%%") {
-                return "%";
-              }
-              index++;
-              const formatter = createDebug.formatters[format];
-              if (typeof formatter === "function") {
-                const val = args[index];
-                match = formatter.call(self2, val);
-                args.splice(index, 1);
-                index--;
-              }
-              return match;
-            });
-            createDebug.formatArgs.call(self2, args);
-            const logFn = self2.log || createDebug.log;
-            logFn.apply(self2, args);
-          }
-          debug2.namespace = namespace;
-          debug2.useColors = createDebug.useColors();
-          debug2.color = createDebug.selectColor(namespace);
-          debug2.extend = extend;
-          debug2.destroy = createDebug.destroy;
-          Object.defineProperty(debug2, "enabled", {
-            enumerable: true,
-            configurable: false,
-            get: () => {
-              if (enableOverride !== null) {
-                return enableOverride;
-              }
-              if (namespacesCache !== createDebug.namespaces) {
-                namespacesCache = createDebug.namespaces;
-                enabledCache = createDebug.enabled(namespace);
-              }
-              return enabledCache;
-            },
-            set: (v) => {
-              enableOverride = v;
-            }
-          });
-          if (typeof createDebug.init === "function") {
-            createDebug.init(debug2);
-          }
-          return debug2;
-        }
-        function extend(namespace, delimiter) {
-          const newDebug = createDebug(this.namespace + (typeof delimiter === "undefined" ? ":" : delimiter) + namespace);
-          newDebug.log = this.log;
-          return newDebug;
-        }
-        function enable(namespaces) {
-          createDebug.save(namespaces);
-          createDebug.namespaces = namespaces;
-          createDebug.names = [];
-          createDebug.skips = [];
-          const split = (typeof namespaces === "string" ? namespaces : "").trim().replace(" ", ",").split(",").filter(Boolean);
-          for (const ns of split) {
-            if (ns[0] === "-") {
-              createDebug.skips.push(ns.slice(1));
-            } else {
-              createDebug.names.push(ns);
-            }
-          }
-        }
-        function matchesTemplate(search, template) {
-          let searchIndex = 0;
-          let templateIndex = 0;
-          let starIndex = -1;
-          let matchIndex = 0;
-          while (searchIndex < search.length) {
-            if (templateIndex < template.length && (template[templateIndex] === search[searchIndex] || template[templateIndex] === "*")) {
-              if (template[templateIndex] === "*") {
-                starIndex = templateIndex;
-                matchIndex = searchIndex;
-                templateIndex++;
-              } else {
-                searchIndex++;
-                templateIndex++;
-              }
-            } else if (starIndex !== -1) {
-              templateIndex = starIndex + 1;
-              matchIndex++;
-              searchIndex = matchIndex;
-            } else {
-              return false;
-            }
-          }
-          while (templateIndex < template.length && template[templateIndex] === "*") {
-            templateIndex++;
-          }
-          return templateIndex === template.length;
-        }
-        function disable() {
-          const namespaces = [
-            ...createDebug.names,
-            ...createDebug.skips.map((namespace) => "-" + namespace)
-          ].join(",");
-          createDebug.enable("");
-          return namespaces;
-        }
-        function enabled(name) {
-          for (const skip of createDebug.skips) {
-            if (matchesTemplate(name, skip)) {
-              return false;
-            }
-          }
-          for (const ns of createDebug.names) {
-            if (matchesTemplate(name, ns)) {
-              return true;
-            }
-          }
-          return false;
-        }
-        function coerce(val) {
-          if (val instanceof Error) {
-            return val.stack || val.message;
-          }
-          return val;
-        }
-        function destroy() {
-          console.warn("Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.");
-        }
-        createDebug.enable(createDebug.load());
-        return createDebug;
-      }
-      module.exports = setup;
-    }
-  });
-
-  // ../../node_modules/.pnpm/debug@4.4.0_supports-color@5.5.0/node_modules/debug/src/browser.js
-  var require_browser = __commonJS({
-    "../../node_modules/.pnpm/debug@4.4.0_supports-color@5.5.0/node_modules/debug/src/browser.js"(exports, module) {
-      "use strict";
-      exports.formatArgs = formatArgs;
-      exports.save = save;
-      exports.load = load;
-      exports.useColors = useColors;
-      exports.storage = localstorage();
-      exports.destroy = (() => {
-        let warned = false;
-        return () => {
-          if (!warned) {
-            warned = true;
-            console.warn("Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.");
-          }
-        };
-      })();
-      exports.colors = [
-        "#0000CC",
-        "#0000FF",
-        "#0033CC",
-        "#0033FF",
-        "#0066CC",
-        "#0066FF",
-        "#0099CC",
-        "#0099FF",
-        "#00CC00",
-        "#00CC33",
-        "#00CC66",
-        "#00CC99",
-        "#00CCCC",
-        "#00CCFF",
-        "#3300CC",
-        "#3300FF",
-        "#3333CC",
-        "#3333FF",
-        "#3366CC",
-        "#3366FF",
-        "#3399CC",
-        "#3399FF",
-        "#33CC00",
-        "#33CC33",
-        "#33CC66",
-        "#33CC99",
-        "#33CCCC",
-        "#33CCFF",
-        "#6600CC",
-        "#6600FF",
-        "#6633CC",
-        "#6633FF",
-        "#66CC00",
-        "#66CC33",
-        "#9900CC",
-        "#9900FF",
-        "#9933CC",
-        "#9933FF",
-        "#99CC00",
-        "#99CC33",
-        "#CC0000",
-        "#CC0033",
-        "#CC0066",
-        "#CC0099",
-        "#CC00CC",
-        "#CC00FF",
-        "#CC3300",
-        "#CC3333",
-        "#CC3366",
-        "#CC3399",
-        "#CC33CC",
-        "#CC33FF",
-        "#CC6600",
-        "#CC6633",
-        "#CC9900",
-        "#CC9933",
-        "#CCCC00",
-        "#CCCC33",
-        "#FF0000",
-        "#FF0033",
-        "#FF0066",
-        "#FF0099",
-        "#FF00CC",
-        "#FF00FF",
-        "#FF3300",
-        "#FF3333",
-        "#FF3366",
-        "#FF3399",
-        "#FF33CC",
-        "#FF33FF",
-        "#FF6600",
-        "#FF6633",
-        "#FF9900",
-        "#FF9933",
-        "#FFCC00",
-        "#FFCC33"
-      ];
-      function useColors() {
-        if (typeof window !== "undefined" && window.process && (window.process.type === "renderer" || window.process.__nwjs)) {
-          return true;
-        }
-        if (typeof navigator !== "undefined" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\/(\d+)/)) {
-          return false;
-        }
-        let m;
-        return typeof document !== "undefined" && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance || // Is firebug? http://stackoverflow.com/a/398120/376773
-        typeof window !== "undefined" && window.console && (window.console.firebug || window.console.exception && window.console.table) || // Is firefox >= v31?
-        // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
-        typeof navigator !== "undefined" && navigator.userAgent && (m = navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/)) && parseInt(m[1], 10) >= 31 || // Double check webkit in userAgent just in case we are in a worker
-        typeof navigator !== "undefined" && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/);
-      }
-      function formatArgs(args) {
-        args[0] = (this.useColors ? "%c" : "") + this.namespace + (this.useColors ? " %c" : " ") + args[0] + (this.useColors ? "%c " : " ") + "+" + module.exports.humanize(this.diff);
-        if (!this.useColors) {
-          return;
-        }
-        const c = "color: " + this.color;
-        args.splice(1, 0, c, "color: inherit");
-        let index = 0;
-        let lastC = 0;
-        args[0].replace(/%[a-zA-Z%]/g, (match) => {
-          if (match === "%%") {
-            return;
-          }
-          index++;
-          if (match === "%c") {
-            lastC = index;
-          }
-        });
-        args.splice(lastC, 0, c);
-      }
-      exports.log = console.debug || console.log || (() => {
-      });
-      function save(namespaces) {
-        try {
-          if (namespaces) {
-            exports.storage.setItem("debug", namespaces);
-          } else {
-            exports.storage.removeItem("debug");
-          }
-        } catch (error) {
-        }
-      }
-      function load() {
-        let r;
-        try {
-          r = exports.storage.getItem("debug");
-        } catch (error) {
-        }
-        if (!r && typeof process !== "undefined" && "env" in process) {
-          r = process.env.DEBUG;
-        }
-        return r;
-      }
-      function localstorage() {
-        try {
-          return localStorage;
-        } catch (error) {
-        }
-      }
-      module.exports = require_common()(exports);
-      var { formatters } = module.exports;
-      formatters.j = function(v) {
-        try {
-          return JSON.stringify(v);
-        } catch (error) {
-          return "[UnexpectedJSONParseError]: " + error.message;
-        }
-      };
-    }
-  });
-
   // src/constants/index.ts
   var CONTAINER_MINI_HEIGHT = 3;
   var CONTAINER_MINI_WIDTH = 3;
@@ -1110,7 +644,6 @@ var midscene_element_inspector = (() => {
 
   // src/utils.ts
   var import_js_sha256 = __toESM(require_sha256());
-  var import_debug = __toESM(require_browser());
   var hashMap = {};
   function generateHashId(rect, content = "") {
     const combined = JSON.stringify({

package/dist/types/logger.d.ts

@@ -0,0 +1,6 @@
+type DebugFunction = (...args: unknown[]) => void;
+declare function getDebug(topic: string): DebugFunction;
+declare function enableDebug(topic: string): void;
+declare function cleanupLogStreams(): void;
+
+export { type DebugFunction, cleanupLogStreams, enableDebug, getDebug };

package/dist/types/utils.d.ts

@@ -1,9 +1,5 @@
-import debug from 'debug';
-
 declare const ifInBrowser: boolean;
 declare function uuid(): string;
-declare function getDebug(topic: string): debug.Debugger;
-declare function enableDebug(topic: string): void;
 declare function generateHashId(rect: any, content?: string): string;
 /**
  * A utility function that asserts a condition and throws an error with a message if the condition is false.
@@ -13,6 +9,7 @@ declare function generateHashId(rect: any, content?: string): string;
  * @throws Error with the provided message if the condition is false
  */
 declare function assert(condition: any, message?: string): asserts condition;
-declare function getGlobalScope(): typeof globalThis | undefined;
+type GlobalScope = typeof window | typeof globalThis | typeof self | undefined;
+declare function getGlobalScope(): GlobalScope;
 
-export { assert, enableDebug, generateHashId, getDebug, getGlobalScope, ifInBrowser, uuid };
+export { assert, generateHashId, getGlobalScope, ifInBrowser, uuid };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midscene/shared",
-  "version": "0.13.1",
+  "version": "0.13.2-beta-20250401015137.0",
   "repository": "https://github.com/web-infra-dev/midscene",
   "homepage": "https://midscenejs.com/",
   "types": "./dist/types/index.d.ts",
@@ -14,7 +14,8 @@
     "./utils": "./dist/lib/utils.js",
     "./extractor": "./dist/lib/extractor.js",
     "./extractor-debug": "./dist/lib/extractor-debug.js",
-    "./keyboard-layout": "./dist/lib/us-keyboard-layout.js"
+    "./keyboard-layout": "./dist/lib/us-keyboard-layout.js",
+    "./logger": "./dist/lib/logger.js"
   },
   "typesVersions": {
     "*": {
@@ -41,6 +42,9 @@
       ],
       "keyboard-layout": [
         "./dist/types/us-keyboard-layout.d.ts"
+      ],
+      "logger": [
+        "./dist/types/logger.d.ts"
       ]
     }
   },
@@ -58,6 +62,7 @@
     "@modern-js/module-tools": "2.60.6",
     "@types/debug": "4.1.12",
     "@types/node": "^18.0.0",
+    "dotenv": "16.4.5",
     "rimraf": "~3.0.2",
     "typescript": "^5.8.2",
     "vitest": "3.0.5"

package/src/common.ts

@@ -0,0 +1,34 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+// Define locally for now to avoid import issues
+export const isNodeEnv =
+  typeof process !== 'undefined' &&
+  process.versions != null &&
+  process.versions.node != null;
+
+/**
+ * Get the path to the midscene_run directory or a subdirectory within it.
+ * Creates the directory if it doesn't exist.
+ *
+ * @param subdir - Optional subdirectory name (e.g., 'log', 'report')
+ * @returns The absolute path to the requested directory
+ */
+export const getMidsceneRunLogPath = (): string => {
+  const basePath = path.join(process.cwd(), 'midscene_run');
+
+  // Create a base directory
+  if (!fs.existsSync(basePath)) {
+    fs.mkdirSync(basePath, { recursive: true });
+  }
+
+  // Create a log directory
+  const logPath = path.join(basePath, 'log');
+  if (!fs.existsSync(logPath)) {
+    fs.mkdirSync(logPath, { recursive: true });
+  }
+
+  return logPath;
+};
+
+export const logDir = isNodeEnv ? getMidsceneRunLogPath() : '';

package/src/logger.ts

@@ -0,0 +1,65 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import debug from 'debug';
+import { isNodeEnv, logDir } from './common';
+
+const topicPrefix = 'midscene';
+// Map to store file streams
+const logStreams = new Map<string, fs.WriteStream>();
+
+// Function to get or create a log stream
+function getLogStream(topic: string): fs.WriteStream {
+  if (!logStreams.has(topic)) {
+    const logFile = path.join(logDir, `${topic}.log`);
+    const stream = fs.createWriteStream(logFile, { flags: 'a' });
+    logStreams.set(topic, stream);
+  }
+  return logStreams.get(topic)!;
+}
+
+// Function to write log to file
+function writeLogToFile(topic: string, message: string): void {
+  if (!isNodeEnv) return;
+
+  const stream = getLogStream(topic);
+  const timestamp = new Date().toISOString();
+  stream.write(`[${timestamp}] ${message}\n`);
+}
+
+export type DebugFunction = (...args: unknown[]) => void;
+
+export function getDebug(topic: string): DebugFunction {
+  // Create a wrapper function that handles both file logging and debug output
+  return (...args: unknown[]): void => {
+    const message = args
+      .map((arg) =>
+        typeof arg === 'object' ? JSON.stringify(arg) : String(arg),
+      )
+      .join(' ');
+
+    if (isNodeEnv) {
+      writeLogToFile(topic, message);
+    }
+
+    const debugFn = debug(`${topicPrefix}:${topic}`) as DebugFunction;
+    debugFn(...args);
+  };
+}
+
+export function enableDebug(topic: string): void {
+  if (isNodeEnv) {
+    // In Node.js, we don't need to enable debug as we're using file logging
+    return;
+  }
+  debug.enable(`${topicPrefix}:${topic}`);
+}
+
+// Cleanup function to close all log streams
+export function cleanupLogStreams(): void {
+  if (!isNodeEnv) return;
+
+  for (const stream of logStreams.values()) {
+    stream.end();
+  }
+  logStreams.clear();
+}

package/src/utils.ts

@@ -1,25 +1,14 @@
 import { sha256 } from 'js-sha256';
 
-import debug from 'debug';
-
 export const ifInBrowser = typeof window !== 'undefined';
 
-export function uuid() {
+export function uuid(): string {
   return Math.random().toString(36).substring(2, 15);
 }
 
 const hashMap: Record<string, string> = {}; // id - combined
 
-const topicPrefix = 'midscene';
-export function getDebug(topic: string) {
-  return debug(`${topicPrefix}:${topic}`);
-}
-
-export function enableDebug(topic: string) {
-  debug.enable(`${topicPrefix}:${topic}`);
-}
-
-export function generateHashId(rect: any, content = '') {
+export function generateHashId(rect: any, content = ''): string {
   // Combine the input into a string
   const combined = JSON.stringify({
     content,
@@ -32,7 +21,7 @@ export function generateHashId(rect: any, content = '') {
   const hashHex = sha256.create().update(combined).hex();
 
   // Convert hex to a-z by mapping each hex char to a letter
-  const toLetters = (hex: string) => {
+  const toLetters = (hex: string): string => {
     return hex
       .split('')
       .map((char) => {
@@ -69,13 +58,15 @@ export function assert(condition: any, message?: string): asserts condition {
   }
 }
 
-export function getGlobalScope() {
+type GlobalScope = typeof window | typeof globalThis | typeof self | undefined;
+
+export function getGlobalScope(): GlobalScope {
   if (typeof window !== 'undefined') {
     return window;
   }
 
-  if (typeof global !== 'undefined') {
-    return global;
+  if (typeof globalThis !== 'undefined') {
+    return globalThis;
   }
 
   if (typeof self !== 'undefined') {