extension-install 4.0.16 → 4.0.17

package/dist/lib/messaging.d.ts

@@ -0,0 +1,180 @@
+export type Channel = 'info' | 'success' | 'warn' | 'error' | 'debug';
+export declare function isDebug(): boolean;
+export declare function prefix(type: Channel): string;
+export declare const fmt: {
+    heading: (title: string) => string;
+    label: (key: string) => string;
+    val: (value: string) => string;
+    code: (value: string) => string;
+    bullet: (value: string) => string;
+    block(title: string, rows: Array<[string, string]>): string;
+    truncate(input: unknown, max?: number): string;
+};
+export interface CardRow {
+    label: string;
+    value?: string;
+}
+export interface CardInput {
+    version?: string;
+    suffix?: string;
+    rows?: CardRow[];
+}
+export declare function card(input?: CardInput): string;
+export declare function isCardKeyClaimed(key: string): boolean;
+export declare function claimCardKey(key: string): boolean;
+export declare function artifactNoun(browser: string): 'Add-on' | 'Extension';
+export declare const ENVELOPE_SCHEMA = 1;
+export declare const CODES: {
+    readonly E_ARGS: 'E_ARGS';
+    readonly E_PROJECT_NOT_FOUND: 'E_PROJECT_NOT_FOUND';
+    readonly E_MANIFEST_NOT_FOUND: 'E_MANIFEST_NOT_FOUND';
+    readonly E_MANIFEST_INVALID: 'E_MANIFEST_INVALID';
+    readonly E_FIRST_COMPILE: 'E_FIRST_COMPILE';
+    readonly E_COMPILE: 'E_COMPILE';
+    readonly E_BROWSER_NOT_FOUND: 'E_BROWSER_NOT_FOUND';
+    readonly E_BROWSER_LAUNCH: 'E_BROWSER_LAUNCH';
+    readonly E_PROFILE_LOCKED: 'E_PROFILE_LOCKED';
+    readonly E_READY_TIMEOUT: 'E_READY_TIMEOUT';
+    readonly E_SESSION_EXISTS: 'E_SESSION_EXISTS';
+    readonly E_CONTROL_DENIED: 'E_CONTROL_DENIED';
+    readonly E_CONTROL_UNAVAILABLE: 'E_CONTROL_UNAVAILABLE';
+    readonly E_TOKEN_MISSING: 'E_TOKEN_MISSING';
+    readonly E_NETWORK: 'E_NETWORK';
+    readonly E_INTERRUPTED: 'E_INTERRUPTED';
+    readonly E_NOT_IMPLEMENTED: 'E_NOT_IMPLEMENTED';
+    readonly E_INTERNAL: 'E_INTERNAL';
+    readonly E_UNSUPPORTED_BROWSER: 'E_UNSUPPORTED_BROWSER';
+    readonly E_INVALID_OPTION: 'E_INVALID_OPTION';
+    readonly E_PORT_UNAVAILABLE: 'E_PORT_UNAVAILABLE';
+    readonly E_DEPENDENCY_INSTALL: 'E_DEPENDENCY_INSTALL';
+    readonly E_TEMPLATE_NOT_FOUND: 'E_TEMPLATE_NOT_FOUND';
+    readonly E_DESTINATION_NOT_EMPTY: 'E_DESTINATION_NOT_EMPTY';
+    readonly E_DESTINATION_NOT_WRITABLE: 'E_DESTINATION_NOT_WRITABLE';
+    readonly E_BROWSER_DOWNLOAD: 'E_BROWSER_DOWNLOAD';
+    readonly E_SESSION_NOT_FOUND: 'E_SESSION_NOT_FOUND';
+    readonly E_EVAL_REFUSED: 'E_EVAL_REFUSED';
+    readonly E_TARGET_NOT_FOUND: 'E_TARGET_NOT_FOUND';
+    readonly E_TIMEOUT: 'E_TIMEOUT';
+    readonly E_PUBLISH_REJECTED: 'E_PUBLISH_REJECTED';
+    readonly E_AUTH_REQUIRED: 'E_AUTH_REQUIRED';
+    readonly E_SAFARI_TOOLCHAIN: 'E_SAFARI_TOOLCHAIN';
+    readonly E_EVAL: 'E_EVAL';
+    readonly E_INSPECT: 'E_INSPECT';
+    readonly E_STORAGE: 'E_STORAGE';
+    readonly E_LOGS_NOT_FOUND: 'E_LOGS_NOT_FOUND';
+    readonly E_READY_ERROR_STATUS: 'E_READY_ERROR_STATUS';
+    readonly E_COMMAND_UNSUPPORTED_FOR_TARGET: 'E_COMMAND_UNSUPPORTED_FOR_TARGET';
+    readonly E_FLAG_VALUE_INVALID: 'E_FLAG_VALUE_INVALID';
+    readonly E_FLAG_NOT_SUPPORTED_HERE: 'E_FLAG_NOT_SUPPORTED_HERE';
+    readonly E_DEV_SERVER_START: 'E_DEV_SERVER_START';
+    readonly E_DOCTOR_CHECKS_FAILED: 'E_DOCTOR_CHECKS_FAILED';
+    readonly E_TELEMETRY_WRITE: 'E_TELEMETRY_WRITE';
+    readonly E_PREVIEW_NO_DIST: 'E_PREVIEW_NO_DIST';
+    readonly E_BROWSER_UNINSTALL: 'E_BROWSER_UNINSTALL';
+    readonly E_NODE_VERSION: 'E_NODE_VERSION';
+    readonly E_UNKNOWN_COMMAND: 'E_UNKNOWN_COMMAND';
+    readonly E_REMOVED_FLAG: 'E_REMOVED_FLAG';
+    readonly E_BROWSER_NOT_INSTALLABLE: 'E_BROWSER_NOT_INSTALLABLE';
+    readonly E_PARENT_GONE: 'E_PARENT_GONE';
+    readonly E_REMOTE_URL_UNSUPPORTED: 'E_REMOTE_URL_UNSUPPORTED';
+    readonly E_CONFIG_LOAD: 'E_CONFIG_LOAD';
+    readonly E_MANAGED_DEP_CONFLICT: 'E_MANAGED_DEP_CONFLICT';
+    readonly E_TYPES_EMIT: 'E_TYPES_EMIT';
+    readonly E_TSCONFIG_MISSING: 'E_TSCONFIG_MISSING';
+    readonly E_OPTIONAL_DEP_UNRESOLVED: 'E_OPTIONAL_DEP_UNRESOLVED';
+    readonly E_OPTIONAL_DEP_LOAD: 'E_OPTIONAL_DEP_LOAD';
+    readonly E_OPTIONAL_DEP_UNKNOWN: 'E_OPTIONAL_DEP_UNKNOWN';
+    readonly E_COMPANION_EXTENSION_PATH: 'E_COMPANION_EXTENSION_PATH';
+    readonly E_MANIFEST_IN_PUBLIC: 'E_MANIFEST_IN_PUBLIC';
+    readonly E_RUNTIME_NOT_FOUND: 'E_RUNTIME_NOT_FOUND';
+    readonly E_MANIFEST_SHAPE: 'E_MANIFEST_SHAPE';
+    readonly E_MANIFEST_PAGE_MISSING: 'E_MANIFEST_PAGE_MISSING';
+    readonly E_MANIFEST_VERSION_UNSUPPORTED: 'E_MANIFEST_VERSION_UNSUPPORTED';
+    readonly E_MANIFEST_LOAD_BLOCKERS: 'E_MANIFEST_LOAD_BLOCKERS';
+    readonly E_MANIFEST_PERMISSION_MISSING: 'E_MANIFEST_PERMISSION_MISSING';
+    readonly E_MANIFEST_MSG_KEY_MISSING: 'E_MANIFEST_MSG_KEY_MISSING';
+    readonly E_MANIFEST_EMIT: 'E_MANIFEST_EMIT';
+    readonly E_RESTART_REQUIRED: 'E_RESTART_REQUIRED';
+    readonly E_COMPILE_FATAL: 'E_COMPILE_FATAL';
+    readonly E_MODULE_NOT_FOUND: 'E_MODULE_NOT_FOUND';
+    readonly E_ENTRY_NOT_FOUND: 'E_ENTRY_NOT_FOUND';
+    readonly E_ASSET_MISSING: 'E_ASSET_MISSING';
+    readonly E_SCRIPT_DEP_MISSING: 'E_SCRIPT_DEP_MISSING';
+    readonly E_RESERVED_FOLDER: 'E_RESERVED_FOLDER';
+    readonly E_CSS_PARSE: 'E_CSS_PARSE';
+    readonly E_CSS_PREPROCESSOR_MISSING: 'E_CSS_PREPROCESSOR_MISSING';
+    readonly E_CSS_DEAD_REF: 'E_CSS_DEAD_REF';
+    readonly E_INTEGRATION_INSTALL: 'E_INTEGRATION_INSTALL';
+    readonly E_POLYFILL_NOT_FOUND: 'E_POLYFILL_NOT_FOUND';
+    readonly E_LOCALES_LAYOUT: 'E_LOCALES_LAYOUT';
+    readonly E_WAR_INVALID: 'E_WAR_INVALID';
+    readonly E_MATCH_PATTERN_INVALID: 'E_MATCH_PATTERN_INVALID';
+    readonly E_BACKGROUND_REQUIRED: 'E_BACKGROUND_REQUIRED';
+    readonly E_CONTENT_SCRIPT_SYNTAX: 'E_CONTENT_SCRIPT_SYNTAX';
+    readonly E_NO_ENTRYPOINTS: 'E_NO_ENTRYPOINTS';
+    readonly E_REMOTE_RESOURCE_BLOCKED: 'E_REMOTE_RESOURCE_BLOCKED';
+    readonly E_PERF_BUDGET: 'E_PERF_BUDGET';
+    readonly E_ZIP_SKIPPED: 'E_ZIP_SKIPPED';
+    readonly E_ENV_NO_MATCH: 'E_ENV_NO_MATCH';
+    readonly E_REMOTE_FETCH_TIMEOUT: 'E_REMOTE_FETCH_TIMEOUT';
+    readonly E_REMOTE_DOWNLOAD: 'E_REMOTE_DOWNLOAD';
+    readonly E_REMOTE_ZIP_INVALID: 'E_REMOTE_ZIP_INVALID';
+    readonly E_LOCAL_ZIP_NOT_FOUND: 'E_LOCAL_ZIP_NOT_FOUND';
+    readonly E_PROJECT_DOWNLOAD_EMPTY: 'E_PROJECT_DOWNLOAD_EMPTY';
+    readonly E_BROWSER_BINARY_REQUIRED: 'E_BROWSER_BINARY_REQUIRED';
+    readonly E_BROWSER_BINARY_INVALID: 'E_BROWSER_BINARY_INVALID';
+    readonly E_BROWSER_EXITED: 'E_BROWSER_EXITED';
+    readonly E_BROWSER_START_TIMEOUT: 'E_BROWSER_START_TIMEOUT';
+    readonly E_LAUNCH_SKIPPED_COMPILE_ERRORS: 'E_LAUNCH_SKIPPED_COMPILE_ERRORS';
+    readonly E_INSTANCE_AMBIGUOUS: 'E_INSTANCE_AMBIGUOUS';
+    readonly E_WSL_INTEROP: 'E_WSL_INTEROP';
+    readonly E_EXTENSION_LOAD_REFUSED: 'E_EXTENSION_LOAD_REFUSED';
+    readonly E_ADDON_INSTALL: 'E_ADDON_INSTALL';
+    readonly E_BROWSER_CONNECT: 'E_BROWSER_CONNECT';
+    readonly E_BROWSER_CONNECTION_CLOSED: 'E_BROWSER_CONNECTION_CLOSED';
+    readonly E_CDP_NOT_CONNECTED: 'E_CDP_NOT_CONNECTED';
+    readonly E_CDP_TIMEOUT: 'E_CDP_TIMEOUT';
+    readonly E_CDP_OP_FAILED: 'E_CDP_OP_FAILED';
+    readonly E_EXTENSION_ID_UNKNOWN: 'E_EXTENSION_ID_UNKNOWN';
+    readonly E_RDP_PROTOCOL: 'E_RDP_PROTOCOL';
+    readonly E_DEV_SERVER_TIMEOUT: 'E_DEV_SERVER_TIMEOUT';
+    readonly E_PORT_IN_USE: 'E_PORT_IN_USE';
+    readonly E_SESSION_STOPPED: 'E_SESSION_STOPPED';
+    readonly E_LOGS_STREAM_GAP: 'E_LOGS_STREAM_GAP';
+    readonly E_CREATE_DIR: 'E_CREATE_DIR';
+    readonly E_CREATE_WRITE: 'E_CREATE_WRITE';
+    readonly E_CREATE_TESTS_SETUP: 'E_CREATE_TESTS_SETUP';
+    readonly E_GIT_SKIPPED: 'E_GIT_SKIPPED';
+    readonly E_BROWSER_INSTALL_PRIVILEGE: 'E_BROWSER_INSTALL_PRIVILEGE';
+    readonly E_UNINSTALL_NOOP: 'E_UNINSTALL_NOOP';
+};
+export type ErrorCode = (typeof CODES)[keyof typeof CODES];
+export interface EnvelopeError {
+    code: ErrorCode;
+    message: string;
+    name?: string;
+    engine?: string;
+    hint?: string;
+}
+export interface Envelope<T = unknown> {
+    schema: typeof ENVELOPE_SCHEMA;
+    ok: boolean;
+    command: string;
+    status: string;
+    value: T | null;
+    error: EnvelopeError | null;
+    truncated?: boolean;
+    hint?: string;
+    warnings: string[];
+}
+export interface EnvelopeExtras {
+    hint?: string;
+    warnings?: string[];
+    truncated?: boolean;
+    value?: unknown;
+}
+export declare const ENVELOPE: {
+    schema: number;
+    ok<T>(command: string, status: string, value: T, extras?: EnvelopeExtras): Envelope<T>;
+    fail(command: string, status: string, error: EnvelopeError, extras?: EnvelopeExtras): Envelope;
+};

package/dist/module.cjs

@@ -105,38 +105,84 @@ function removeBrowserDir(browser) {
 }
 const external_pintor_namespaceObject = require("pintor");
 var external_pintor_default = /*#__PURE__*/ __webpack_require__.n(external_pintor_namespaceObject);
-const statusPrefix = external_pintor_default().brightBlue('⏵⏵⏵');
+const GLYPH = '⏵⏵⏵';
+const DEBUG_GLYPH = '···';
+new Set([
+    '1',
+    'true',
+    'yes',
+    'on',
+    'debug',
+    'dev',
+    'development'
+]);
+function prefix(type) {
+    if ('error' === type) return external_pintor_default().red(GLYPH);
+    if ('warn' === type) return external_pintor_default().brightYellow(GLYPH);
+    if ('success' === type) return external_pintor_default().green(GLYPH);
+    if ('debug' === type) return external_pintor_default().dim(external_pintor_default().gray(DEBUG_GLYPH));
+    return external_pintor_default().gray(GLYPH);
+}
+const fmt = {
+    heading: (title)=>external_pintor_default().underline(external_pintor_default().blue(title)),
+    label: (key)=>external_pintor_default().gray(key.toUpperCase()),
+    val: (value)=>external_pintor_default().underline(value),
+    code: (value)=>external_pintor_default().blue(value),
+    bullet: (value)=>`- ${value}`,
+    block (title, rows) {
+        const head = fmt.heading(title);
+        const body = rows.map(([key, value])=>`${fmt.label(key)} ${value}`).join('\n');
+        return `${head}\n${body}`;
+    },
+    truncate (input, max = 800) {
+        const s = (()=>{
+            try {
+                return 'string' == typeof input ? input : JSON.stringify(input);
+            } catch  {
+                return String(input);
+            }
+        })();
+        return s.length > max ? `${s.slice(0, max)}…` : s;
+    }
+};
+new Set([
+    'firefox',
+    'firefox-based',
+    'gecko-based',
+    'librewolf',
+    'waterfox'
+]);
 function titleCase(value) {
     return value.length ? value[0].toUpperCase() + value.slice(1) : value;
 }
 function installingBrowser(browser, destination) {
-    return `${statusPrefix} Installing ${external_pintor_default().blue(titleCase(browser))} into ${external_pintor_default().underline(destination)}...`;
+    return `${prefix('info')} Install ${external_pintor_default().blue(titleCase(browser))}.\n${fmt.label('PATH')} ${fmt.val(destination)}`;
 }
 function installSucceeded(browser, destination) {
-    return `${statusPrefix} ${external_pintor_default().green('Installed')} ${external_pintor_default().blue(titleCase(browser))} in ${external_pintor_default().underline(destination)}`;
+    return `${prefix('success')} ${external_pintor_default().blue(titleCase(browser))} is installed.\n${fmt.label('PATH')} ${fmt.val(destination)}`;
 }
 function installFailed(browser, command, args, code, stderr) {
     const details = String(stderr || '').trim();
     const detailSuffix = details ? `\n${external_pintor_default().red(details)}` : '';
-    return `${external_pintor_default().red('Error')} Failed to install ${external_pintor_default().blue(titleCase(browser))}.\nCommand: ${external_pintor_default().yellow(command)} ${external_pintor_default().yellow(args.join(' '))}\nExit code: ${external_pintor_default().yellow(String(code))}` + detailSuffix;
+    return `${prefix('error')} Couldn't install ${external_pintor_default().blue(titleCase(browser))}.\n${external_pintor_default().red('The command')} ${external_pintor_default().yellow(command)} ${external_pintor_default().yellow(args.join(' '))} ${external_pintor_default().red(`failed with exit code ${external_pintor_default().yellow(String(code))}`)}${external_pintor_default().red('.')}\n${external_pintor_default().red('Run it yourself to see the full error.')}` + detailSuffix;
 }
 function edgeInstallNeedsInteractivePrivilegedSession() {
-    return `${external_pintor_default().red('Error')} Edge installation on Linux requires a privileged interactive session.\nRun this command in a terminal session where sudo can prompt for credentials, or install Edge system-wide with your package manager.\nExamples:\n- Ubuntu/Debian: ${external_pintor_default().blue('sudo apt install microsoft-edge-stable')}\n- Fedora: ${external_pintor_default().blue('sudo dnf install microsoft-edge-stable')}\nThen run Extension.js with ${external_pintor_default().blue('--browser=edge')} (or use ${external_pintor_default().blue('chromium')} when privileged install is unavailable).`;
+    return `${prefix('error')} Edge needs a privileged interactive session on Linux.\n${external_pintor_default().red('Run this command in a terminal where sudo can prompt for credentials.')}\n${external_pintor_default().red('Or install Edge system-wide with your package manager.')}\n  ${external_pintor_default().gray('-')} Ubuntu/Debian: ${external_pintor_default().blue('sudo apt install microsoft-edge-stable')}\n  ${external_pintor_default().gray('-')} Fedora: ${external_pintor_default().blue('sudo dnf install microsoft-edge-stable')}\n${external_pintor_default().red('Then run Extension.js with')} ${external_pintor_default().blue('--browser=edge')}${external_pintor_default().red('.')}\n${external_pintor_default().red('Use')} ${external_pintor_default().blue('--browser=chromium')} ${external_pintor_default().red('when a privileged install is unavailable.')}`;
 }
 function edgeInstallUsingSystemBinary(path) {
-    return `${statusPrefix} ${external_pintor_default().yellow('Edge channel install was skipped due privilege requirements.')}\n${statusPrefix} Using existing system Edge binary at ${external_pintor_default().underline(path)}.`;
+    return `${prefix('warn')} Skip the Edge channel install because it needs elevated privileges.\n${external_pintor_default().yellow('Use the Edge binary already on this system instead.')}\n${fmt.label('PATH')} ${fmt.val(path)}`;
 }
 function uninstallRequiresTarget() {
-    return `${external_pintor_default().red('Error')} Missing browser target. Use --browser <name> or --all.`;
+    return `${prefix('error')} A browser target is required.\n${external_pintor_default().red('Pass')} ${external_pintor_default().blue('--browser <name>')}${external_pintor_default().red(', or')} ${external_pintor_default().blue('--all')} ${external_pintor_default().red('to remove every browser.')}`;
 }
 function uninstallingBrowsers(cacheRoot, browsers) {
-    return `${statusPrefix} Removing browser binaries (${browsers.join(', ')}) from ${external_pintor_default().underline(cacheRoot)}...`;
+    return `${prefix('info')} Remove the browser binaries for ${external_pintor_default().blue(browsers.join(', '))}.\n${fmt.label('PATH')} ${fmt.val(cacheRoot)}`;
 }
 function uninstallSucceeded(browser, removedPath) {
-    return `${statusPrefix} ${external_pintor_default().green('Removed')} ${external_pintor_default().blue(titleCase(browser))} from ${external_pintor_default().underline(removedPath)}`;
+    return `${prefix('success')} ${external_pintor_default().blue(titleCase(browser))} is removed.\n${fmt.label('PATH')} ${fmt.val(removedPath)}`;
 }
 function uninstallNoop(browser, checkedPath) {
-    return `${statusPrefix} ${external_pintor_default().gray(`${titleCase(browser)} is already absent`)} (${external_pintor_default().underline(checkedPath)})`;
+    return `${prefix('info')} ${external_pintor_default().blue(titleCase(browser))} is already absent.\n${fmt.label('PATH')} ${fmt.val(checkedPath)}`;
 }
 const external_node_child_process_namespaceObject = require("node:child_process");
 const external_cross_spawn_namespaceObject = require("cross-spawn");

package/package.json

@@ -23,7 +23,7 @@
     "dist"
   ],
   "name": "extension-install",
-  "version": "4.0.16",
+  "version": "4.0.17",
   "description": "Managed browser installer/uninstaller for Extension.js",
   "author": {
     "name": "Cezar Augusto",