extension 3.2.0-next.2 → 3.2.0-next.5

package/dist/cli-lib/telemetry.d.ts

@@ -12,6 +12,7 @@ export declare class Telemetry {
     private disabled;
     private apiKey?;
     private host?;
+    private storage;
     private buffer;
     private timer;
     constructor(init: TelemetryInit);

package/dist/cli.js

@@ -361,30 +361,76 @@ function configDir() {
     if ('win32' === process.platform && process.env.APPDATA) return external_node_path_default().join(process.env.APPDATA, 'extensionjs');
     return external_node_path_default().join(external_node_os_default().homedir(), '.config', 'extensionjs');
 }
+function telemetry_cacheDir() {
+    const xdg = process.env.XDG_CACHE_HOME;
+    if (xdg) return external_node_path_default().join(xdg, 'extensionjs');
+    if ('win32' === process.platform) {
+        const base = process.env.LOCALAPPDATA || process.env.APPDATA;
+        if (base) return external_node_path_default().join(base, 'extensionjs', 'Cache');
+    }
+    if ('darwin' === process.platform) return external_node_path_default().join(external_node_os_default().homedir(), 'Library', 'Caches', 'extensionjs');
+    return null;
+}
 function ensureDir(p) {
-    if (external_node_fs_default().existsSync(p)) return;
-    external_node_fs_default().mkdirSync(p, {
-        recursive: true
-    });
+    try {
+        if (external_node_fs_default().existsSync(p)) return true;
+        external_node_fs_default().mkdirSync(p, {
+            recursive: true
+        });
+        return true;
+    } catch  {
+        return false;
+    }
+}
+function ensureWritableDir(p) {
+    if (!ensureDir(p)) return false;
+    try {
+        external_node_fs_default().accessSync(p, external_node_fs_default().constants.W_OK);
+        const probe = external_node_path_default().join(p, `.write-test-${process.pid}-${Date.now()}`);
+        external_node_fs_default().writeFileSync(probe, 'ok', 'utf8');
+        external_node_fs_default().unlinkSync(probe);
+        return true;
+    } catch  {
+        return false;
+    }
 }
 function loadOrCreateId(file) {
-    if (external_node_fs_default().existsSync(file)) return external_node_fs_default().readFileSync(file, 'utf8').trim();
+    try {
+        if (external_node_fs_default().existsSync(file)) return external_node_fs_default().readFileSync(file, 'utf8').trim();
+    } catch  {}
     const id = external_node_crypto_default().randomUUID();
-    ensureDir(external_node_path_default().dirname(file));
-    external_node_fs_default().writeFileSync(file, id, 'utf8');
+    if (ensureDir(external_node_path_default().dirname(file))) try {
+        external_node_fs_default().writeFileSync(file, id, 'utf8');
+    } catch  {}
     return id;
 }
-function auditFilePath() {
-    const dir = external_node_path_default().join(configDir(), 'telemetry');
-    ensureDir(dir);
-    return external_node_path_default().join(dir, 'events.jsonl');
+function telemetryCandidates() {
+    const candidates = [
+        configDir(),
+        telemetry_cacheDir(),
+        external_node_path_default().join(external_node_os_default().tmpdir(), 'extensionjs'),
+        external_node_path_default().join(process.cwd(), '.cache', 'extensionjs')
+    ].filter(Boolean);
+    return Array.from(new Set(candidates));
+}
+function resolveTelemetryStorage() {
+    for (const base of telemetryCandidates()){
+        const telemetryDir = external_node_path_default().join(base, 'telemetry');
+        if (ensureWritableDir(telemetryDir)) return {
+            telemetryDir,
+            auditFile: external_node_path_default().join(telemetryDir, 'events.jsonl'),
+            idFile: external_node_path_default().join(telemetryDir, 'anonymous-id'),
+            consentFile: external_node_path_default().join(telemetryDir, 'consent')
+        };
+    }
+    return null;
 }
 const DEFAULT_FLUSH_AT = Number(process.env.EXTENSION_TELEMETRY_FLUSH_AT || 10);
 const DEFAULT_FLUSH_INTERVAL = Number(process.env.EXTENSION_TELEMETRY_FLUSH_INTERVAL || 2000);
 const DEFAULT_TIMEOUT_MS = Number(process.env.EXTENSION_TELEMETRY_TIMEOUT_MS || 200);
 class Telemetry {
     track(event, props = {}) {
-        if (this.disabled) return;
+        if (this.disabled || !this.storage) return;
         const payload = {
             event,
             properties: {
@@ -394,7 +440,12 @@ class Telemetry {
             },
             distinct_id: this.anonId
         };
-        external_node_fs_default().appendFileSync(auditFilePath(), JSON.stringify(payload) + '\n');
+        try {
+            external_node_fs_default().appendFileSync(this.storage.auditFile, JSON.stringify(payload) + '\n');
+        } catch  {
+            this.disabled = true;
+            return;
+        }
         if (this.debug) console.error('[telemetry]', JSON.stringify(payload));
         if (!this.apiKey || !this.host) return;
         this.buffer.push(payload);
@@ -439,14 +490,16 @@ class Telemetry {
         _define_property(this, "disabled", void 0);
         _define_property(this, "apiKey", void 0);
         _define_property(this, "host", void 0);
+        _define_property(this, "storage", null);
         _define_property(this, "buffer", []);
         _define_property(this, "timer", null);
         this.debug = '1' === process.env.EXTENSION_TELEMETRY_DEBUG;
         this.disabled = Boolean(init.disabled);
         this.anonId = 'disabled';
         if (!this.disabled) {
-            const idFile = external_node_path_default().join(configDir(), 'telemetry', 'anonymous-id');
-            this.anonId = loadOrCreateId(idFile);
+            this.storage = resolveTelemetryStorage();
+            if (this.storage) this.anonId = loadOrCreateId(this.storage.idFile);
+            else this.disabled = true;
         }
         this.common = {
             app: init.app,
@@ -459,15 +512,17 @@ class Telemetry {
         };
         this.apiKey = init.apiKey || process.env.EXTENSION_PUBLIC_POSTHOG_KEY;
         this.host = init.host || process.env.EXTENSION_PUBLIC_POSTHOG_HOST;
-        if (!this.disabled) {
-            const consentPath = external_node_path_default().join(configDir(), 'telemetry', 'consent');
-            if (!external_node_fs_default().existsSync(consentPath)) {
-                external_node_fs_default().writeFileSync(consentPath, 'ok', 'utf8');
-                this.track('cli_telemetry_consent', {
-                    value: 'implicit_opt_in'
-                });
-                console.log(`${external_pintor_default().gray('►►►')} Telemetry is enabled for Extension.js. To opt out, run with --no-telemetry. Learn more in TELEMETRY.md.`);
-            }
+        if (!this.disabled && this.storage) {
+            const consentPath = this.storage.consentFile;
+            try {
+                if (!external_node_fs_default().existsSync(consentPath)) {
+                    external_node_fs_default().writeFileSync(consentPath, 'ok', 'utf8');
+                    this.track('cli_telemetry_consent', {
+                        value: 'implicit_opt_in'
+                    });
+                    console.log(`${external_pintor_default().gray('►►►')} Telemetry is enabled for Extension.js. To opt out, run with --no-telemetry. Learn more in TELEMETRY.md.`);
+                }
+            } catch  {}
         }
     }
 }
@@ -669,7 +724,7 @@ function parseLogContexts(raw) {
     return values.length > 0 ? values : void 0;
 }
 function registerDevCommand(program, telemetry) {
-    program.command('dev').arguments('[project-path|remote-url]').usage('dev [project-path|remote-url] [options]').description(commandDescriptions.dev).option('--profile <path-to-file | boolean>', 'what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile').option('--browser <chrome | chromium | edge | firefox | chromium-based | gecko-based | firefox-based>', 'specify a browser/engine to run. Defaults to `chromium`').option('--chromium-binary <path-to-binary>', 'specify a path to the Chromium binary. This option overrides the --browser setting. Defaults to the system default').option('--gecko-binary, --firefox-binary <path-to-binary>', 'specify a path to the Gecko binary. This option overrides the --browser setting. Defaults to the system default').option('--polyfill [boolean]', 'whether or not to apply the cross-browser polyfill. Defaults to `false`').option('--no-open', 'do not open the browser automatically (default: open)').option('--starting-url <url>', 'specify the starting URL for the browser. Defaults to `undefined`').option('--port <port>', 'specify the port to use for the development server. Defaults to `8080`').option('--log-context <list>', '[experimental] comma-separated contexts to include (background,content,page,sidebar,popup,options,devtools). Use `all` to include all contexts (default)').option('--logs <off|error|warn|info|debug|trace|all>', '[experimental] minimum centralized logger level to display in terminal (default: off)').option('--log-format <pretty|json>', '[experimental] output format for logger events. Defaults to `pretty`').option('--no-log-timestamps', 'disable ISO timestamps in pretty output').option('--no-log-color', 'disable color in pretty output').option('--log-url <pattern>', '[experimental] only show logs where event.url matches this substring or regex (/re/i)').option('--log-tab <id>', 'only show logs for a specific tabId (number)').option('--source [url]', "[experimental] opens the provided URL in Chrome and prints the full, live HTML of the page after content scripts are injected").option('--author, --author-mode', '[internal] enable maintainer diagnostics (does not affect user runtime logs)').action(async function(pathOrRemoteUrl, { browser = 'chromium', ...devOptions }) {
+    program.command('dev').arguments('[project-path|remote-url]').usage('dev [project-path|remote-url] [options]').description(commandDescriptions.dev).option('--profile <path-to-file | boolean>', 'what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile').option('--browser <chrome | chromium | edge | firefox | chromium-based | gecko-based | firefox-based>', 'specify a browser/engine to run. Defaults to `chromium`').option('--chromium-binary <path-to-binary>', 'specify a path to the Chromium binary. This option overrides the --browser setting. Defaults to the system default').option('--gecko-binary, --firefox-binary <path-to-binary>', 'specify a path to the Gecko binary. This option overrides the --browser setting. Defaults to the system default').option('--polyfill [boolean]', 'whether or not to apply the cross-browser polyfill. Defaults to `false`').option('--no-open', 'do not open the browser automatically (default: open)').option('--starting-url <url>', 'specify the starting URL for the browser. Defaults to `undefined`').option('--port <port>', 'specify the port to use for the development server. Defaults to `8080`').option('--log-context <list>', '[experimental] comma-separated contexts to include (background,content,page,sidebar,popup,options,devtools). Use `all` to include all contexts (default)').option('--logs <off|error|warn|info|debug|trace|all>', '[experimental] minimum centralized logger level to display in terminal (default: off)').option('--log-format <pretty|json>', '[experimental] output format for logger events. Defaults to `pretty`').option('--no-log-timestamps', 'disable ISO timestamps in pretty output').option('--no-log-color', 'disable color in pretty output').option('--log-url <pattern>', '[experimental] only show logs where event.url matches this substring or regex (/re/i)').option('--log-tab <id>', 'only show logs for a specific tabId (number)').option('--source [url]', "[experimental] opens the provided URL in Chrome and prints the full, live HTML of the page after content scripts are injected").option('--install [boolean]', '[internal] install project dependencies when missing', parseOptionalBoolean).option('--author, --author-mode', '[internal] enable maintainer diagnostics (does not affect user runtime logs)').action(async function(pathOrRemoteUrl, { browser = 'chromium', ...devOptions }) {
         if (devOptions.author || devOptions['authorMode']) {
             process.env.EXTENSION_AUTHOR_MODE = 'true';
             if (!process.env.EXTENSION_VERBOSE) process.env.EXTENSION_VERBOSE = '1';
@@ -712,6 +767,7 @@ function registerDevCommand(program, telemetry) {
                 startingUrl: devOptions.startingUrl,
                 source: devOptions.source,
                 watchSource: devOptions.watchSource,
+                install: devOptions.install,
                 logLevel: logsOption || devOptions.logLevel || 'off',
                 logContexts: parseLogContexts(logContextOption),
                 logFormat: devOptions.logFormat || 'pretty',
@@ -736,7 +792,7 @@ function registerDevCommand(program, telemetry) {
     });
 }
 function registerStartCommand(program, telemetry) {
-    program.command('start').arguments('[project-path|remote-url]').usage('start [project-path|remote-url] [options]').description(commandDescriptions.start).option('--profile <path-to-file | boolean>', 'what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile').option('--browser <chrome | chromium | edge | firefox | chromium-based | gecko-based | firefox-based>', 'specify a browser/engine to run. Defaults to `chromium`').option('--polyfill [boolean]', 'whether or not to apply the cross-browser polyfill. Defaults to `true`').option('--chromium-binary <path-to-binary>', 'specify a path to the Chromium binary. This option overrides the --browser setting. Defaults to the system default').option('--gecko-binary, --firefox-binary <path-to-binary>', 'specify a path to the Gecko binary. This option overrides the --browser setting. Defaults to the system default').option('--starting-url <url>', 'specify the starting URL for the browser. Defaults to `undefined`').option('--port <port>', 'specify the port to use for the development server. Defaults to `8080`').option('--log-context <list>', '[experimental] comma-separated contexts to include (background,content,page,sidebar,popup,options,devtools). Use `all` to include all contexts (default)').option('--logs <off|error|warn|info|debug|trace|all>', '[experimental] minimum centralized logger level to display in terminal (default: off)').option('--log-format <pretty|json>', '[experimental] output format for logger events. Defaults to `pretty`').option('--no-log-timestamps', 'disable ISO timestamps in pretty output').option('--no-log-color', 'disable color in pretty output').option('--log-url <pattern>', '[experimental] only show logs where event.url matches this substring or regex (/re/i)').option('--log-tab <id>', 'only show logs for a specific tabId (number)').option('--source [url]', "[experimental] opens the provided URL in Chrome and prints the full, live HTML of the page after content scripts are injected").option('--author, --author-mode', '[internal] enable maintainer diagnostics (does not affect user runtime logs)').action(async function(pathOrRemoteUrl, { browser = 'chromium', ...startOptions }) {
+    program.command('start').arguments('[project-path|remote-url]').usage('start [project-path|remote-url] [options]').description(commandDescriptions.start).option('--profile <path-to-file | boolean>', 'what path to use for the browser profile. A boolean value of false sets the profile to the default user profile. Defaults to a fresh profile').option('--browser <chrome | chromium | edge | firefox | chromium-based | gecko-based | firefox-based>', 'specify a browser/engine to run. Defaults to `chromium`').option('--polyfill [boolean]', 'whether or not to apply the cross-browser polyfill. Defaults to `true`').option('--chromium-binary <path-to-binary>', 'specify a path to the Chromium binary. This option overrides the --browser setting. Defaults to the system default').option('--gecko-binary, --firefox-binary <path-to-binary>', 'specify a path to the Gecko binary. This option overrides the --browser setting. Defaults to the system default').option('--starting-url <url>', 'specify the starting URL for the browser. Defaults to `undefined`').option('--port <port>', 'specify the port to use for the development server. Defaults to `8080`').option('--log-context <list>', '[experimental] comma-separated contexts to include (background,content,page,sidebar,popup,options,devtools). Use `all` to include all contexts (default)').option('--logs <off|error|warn|info|debug|trace|all>', '[experimental] minimum centralized logger level to display in terminal (default: off)').option('--log-format <pretty|json>', '[experimental] output format for logger events. Defaults to `pretty`').option('--no-log-timestamps', 'disable ISO timestamps in pretty output').option('--no-log-color', 'disable color in pretty output').option('--log-url <pattern>', '[experimental] only show logs where event.url matches this substring or regex (/re/i)').option('--log-tab <id>', 'only show logs for a specific tabId (number)').option('--source [url]', "[experimental] opens the provided URL in Chrome and prints the full, live HTML of the page after content scripts are injected").option('--install [boolean]', '[experimental] install project dependencies when missing', parseOptionalBoolean).option('--author, --author-mode', '[experimental] enable maintainer diagnostics (does not affect user runtime logs)').action(async function(pathOrRemoteUrl, { browser = 'chromium', ...startOptions }) {
         if (startOptions.author || startOptions.authorMode) {
             process.env.EXTENSION_AUTHOR_MODE = 'true';
             if (!process.env.EXTENSION_VERBOSE) process.env.EXTENSION_VERBOSE = '1';
@@ -769,6 +825,7 @@ function registerStartCommand(program, telemetry) {
                 geckoBinary: startOptions.geckoBinary,
                 startingUrl: startOptions.startingUrl,
                 port: startOptions.port,
+                install: startOptions.install,
                 source: 'string' == typeof startOptions.source ? startOptions.source : startOptions.source,
                 watchSource: startOptions.watchSource,
                 logLevel: logsOption || startOptions.logLevel || 'off',
@@ -855,7 +912,7 @@ function registerPreviewCommand(program, telemetry) {
     });
 }
 function registerBuildCommand(program, telemetry) {
-    program.command('build').arguments('[project-name]').usage('build [path-to-remote-extension] [options]').description(commandDescriptions.build).option('--browser <chrome | chromium | edge | firefox | chromium-based | gecko-based | firefox-based>', 'specify a browser/engine to run. Defaults to `chromium`').option('--polyfill [boolean]', 'whether or not to apply the cross-browser polyfill. Defaults to `false`').option('--zip [boolean]', 'whether or not to compress the extension into a ZIP file. Defaults to `false`').option('--zip-source [boolean]', 'whether or not to include the source files in the ZIP file. Defaults to `false`').option('--zip-filename <string>', 'specify the name of the ZIP file. Defaults to the extension name and version').option('--silent [boolean]', 'whether or not to open the browser automatically. Defaults to `false`').option('--author, --author-mode', '[internal] enable maintainer diagnostics (does not affect user runtime logs)').action(async function(pathOrRemoteUrl, { browser = 'chromium', ...buildOptions }) {
+    program.command('build').arguments('[project-name]').usage('build [path-to-remote-extension] [options]').description(commandDescriptions.build).option('--browser <chrome | chromium | edge | firefox | chromium-based | gecko-based | firefox-based>', 'specify a browser/engine to run. Defaults to `chromium`').option('--polyfill [boolean]', 'whether or not to apply the cross-browser polyfill. Defaults to `false`').option('--zip [boolean]', 'whether or not to compress the extension into a ZIP file. Defaults to `false`').option('--zip-source [boolean]', 'whether or not to include the source files in the ZIP file. Defaults to `false`').option('--zip-filename <string>', 'specify the name of the ZIP file. Defaults to the extension name and version').option('--silent [boolean]', 'whether or not to open the browser automatically. Defaults to `false`').option('--install [boolean]', '[internal] install project dependencies when missing', parseOptionalBoolean).option('--author, --author-mode', '[internal] enable maintainer diagnostics (does not affect user runtime logs)').action(async function(pathOrRemoteUrl, { browser = 'chromium', ...buildOptions }) {
         if (buildOptions.author || buildOptions['authorMode']) {
             process.env.EXTENSION_AUTHOR_MODE = 'true';
             if (!process.env.EXTENSION_VERBOSE) process.env.EXTENSION_VERBOSE = '1';
@@ -885,7 +942,8 @@ function registerBuildCommand(program, telemetry) {
                 zip: buildOptions.zip,
                 zipSource: buildOptions.zipSource,
                 zipFilename: buildOptions.zipFilename,
-                silent: buildOptions.silent
+                silent: buildOptions.silent,
+                install: buildOptions.install
             });
             telemetry.track('cli_build_summary', {
                 ...buildSummary

package/package.json

@@ -35,7 +35,7 @@
     "extension": "./dist/cli.js"
   },
   "name": "extension",
-  "version": "3.2.0-next.2",
+  "version": "3.2.0-next.5",
   "description": "Create cross-browser extensions with no build configuration.",
   "homepage": "https://extension.js.org/",
   "bugs": {
@@ -51,6 +51,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "scripts": {
+    "pretest": "pnpm run compile",
     "prepublishOnly": "pnpm run compile",
     "compile": "rslib build",
     "watch": "rslib build --watch",
@@ -88,8 +89,8 @@
     "cli"
   ],
   "dependencies": {
-    "extension-create": "^3.2.0-next.2",
-    "extension-develop": "^3.2.0-next.2",
+    "extension-create": "^3.2.0-next.5",
+    "extension-develop": "^3.2.0-next.5",
     "commander": "^14.0.2",
     "pintor": "0.3.0",
     "semver": "^7.7.3",

package/types/extension-develop-shim.d.ts

@@ -30,6 +30,7 @@ declare module 'extension-develop' {
     zipSource?: boolean
     zipFilename?: string
     silent?: boolean
+    install?: boolean
   }
 
   export interface DevOptions {
@@ -49,6 +50,7 @@ declare module 'extension-develop' {
     logColor?: boolean
     logUrl?: string
     logTab?: string | number
+    install?: boolean
   }
 
   export interface PreviewOptions extends DevOptions {}