app-builder-lib 26.1.0 → 26.3.0

package/out/node-module-collector/yarnBerryNodeModulesCollector.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YarnBerryNodeModulesCollector = void 0;
+const builder_util_1 = require("builder-util");
+const lazy_val_1 = require("lazy-val");
+const npmNodeModulesCollector_1 = require("./npmNodeModulesCollector");
+const packageManager_1 = require("./packageManager");
+// Only Yarn v1 uses CLI. We should use pnp.cjs for PnP, but we can't access the files due to virtual file paths within zipped modules.
+// We fallback to npm node module collection (since Yarn Berry could have npm-like structure OR pnpm-like structure, depending on `nmHoistingLimits` configuration).
+// In the latter case, we still can't assume `pnpm` is installed, so we still try to use npm collection as a best-effort attempt.
+// If those fail, such as if using corepack, we attempt to manually build the tree.
+class YarnBerryNodeModulesCollector extends npmNodeModulesCollector_1.NpmNodeModulesCollector {
+    constructor() {
+        super(...arguments);
+        this.installOptions = {
+            manager: packageManager_1.PM.YARN_BERRY,
+            lockfile: "yarn.lock",
+        };
+        this.yarnSetupInfo = new lazy_val_1.Lazy(async () => this.detectYarnSetup(this.rootDir));
+        this.isHoisted = new lazy_val_1.Lazy(async () => this.yarnSetupInfo.value.then(info => info.isHoisted));
+    }
+    async getDependenciesTree(_pm) {
+        const isPnp = await this.yarnSetupInfo.value.then(info => !!info.isPnP);
+        if (isPnp) {
+            builder_util_1.log.warn(null, "Yarn PnP extraction not supported directly due to virtual file paths (<package_name>.zip/<file_path>), falling back to NPM node module collector");
+        }
+        return super.getDependenciesTree(packageManager_1.PM.NPM);
+    }
+    isProdDependency(packageName, tree) {
+        var _a, _b;
+        return ((_a = tree.dependencies) === null || _a === void 0 ? void 0 : _a[packageName]) != null || ((_b = tree.optionalDependencies) === null || _b === void 0 ? void 0 : _b[packageName]) != null;
+    }
+    async detectYarnSetup(rootDir) {
+        var _a, _b, _c, _d, _e, _f;
+        let yarnVersion = null;
+        let nodeLinker = null;
+        let nmHoistingLimits = null;
+        const output = await this.asyncExec("yarn", ["config", "list", "--json"], rootDir);
+        if (output.stdout == null) {
+            builder_util_1.log.debug({ stderr: output.stderr }, "there was no config output, falling back to hoisted mode");
+            return {
+                yarnVersion,
+                nodeLinker,
+                nmHoistingLimits,
+                isPnP: false,
+                isHoisted: true,
+            };
+        }
+        // Yarn prints multiple JSON lines; find the one with type: 'inspect'
+        const parsed = output.stdout
+            .split("\n")
+            .map(l => l.trim())
+            .filter(Boolean)
+            .map(l => {
+            try {
+                return JSON.parse(l);
+            }
+            catch {
+                return undefined;
+            }
+        })
+            .filter(Boolean)
+            .find(l => l.type === "inspect");
+        if (parsed) {
+            const data = ((_a = parsed.data) === null || _a === void 0 ? void 0 : _a["rc"]) || parsed.data || {};
+            yarnVersion = (_d = (_c = (_b = parsed.data) === null || _b === void 0 ? void 0 : _b["manifest"]) === null || _c === void 0 ? void 0 : _c.version) !== null && _d !== void 0 ? _d : null;
+            nodeLinker = (_e = data["nodeLinker"]) !== null && _e !== void 0 ? _e : null;
+            nmHoistingLimits = (_f = data["nmHoistingLimits"]) !== null && _f !== void 0 ? _f : null;
+        }
+        // Determine if using PnP
+        const isPnP = nodeLinker === "pnp";
+        const isHoisted = isPnP ? false : nmHoistingLimits === "dependencies" || nmHoistingLimits === "workspaces";
+        return {
+            yarnVersion,
+            nodeLinker,
+            nmHoistingLimits,
+            isPnP,
+            isHoisted,
+        };
+    }
+}
+exports.YarnBerryNodeModulesCollector = YarnBerryNodeModulesCollector;
+//# sourceMappingURL=yarnBerryNodeModulesCollector.js.map

package/out/node-module-collector/yarnBerryNodeModulesCollector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yarnBerryNodeModulesCollector.js","sourceRoot":"","sources":["../../src/node-module-collector/yarnBerryNodeModulesCollector.ts"],"names":[],"mappings":";;;AAAA,+CAAkC;AAClC,uCAA+B;AAC/B,uEAAmE;AACnE,qDAAqC;AAWrC,uIAAuI;AACvI,oKAAoK;AACpK,iIAAiI;AACjI,mFAAmF;AACnF,MAAa,6BAA8B,SAAQ,iDAAuB;IAA1E;;QACkB,mBAAc,GAAG;YAC/B,OAAO,EAAE,mBAAE,CAAC,UAAU;YACtB,QAAQ,EAAE,WAAW;SACtB,CAAA;QAEO,kBAAa,GAAwB,IAAI,eAAI,CAAgB,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QAE1G,cAAS,GAAkB,IAAI,eAAI,CAAU,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;IAoE3H,CAAC;IAlEW,KAAK,CAAC,mBAAmB,CAAC,GAAO;QACzC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACvE,IAAI,KAAK,EAAE,CAAC;YACV,kBAAG,CAAC,IAAI,CAAC,IAAI,EAAE,kJAAkJ,CAAC,CAAA;QACpK,CAAC;QAED,OAAO,KAAK,CAAC,mBAAmB,CAAC,mBAAE,CAAC,GAAG,CAAC,CAAA;IAC1C,CAAC;IAES,gBAAgB,CAAC,WAAmB,EAAE,IAAmB;;QACjE,OAAO,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAG,WAAW,CAAC,KAAI,IAAI,IAAI,CAAA,MAAA,IAAI,CAAC,oBAAoB,0CAAG,WAAW,CAAC,KAAI,IAAI,CAAA;IACrG,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,OAAe;;QAC3C,IAAI,WAAW,GAAiC,IAAI,CAAA;QACpD,IAAI,UAAU,GAAgC,IAAI,CAAA;QAClD,IAAI,gBAAgB,GAAsC,IAAI,CAAA;QAE9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAA;QAElF,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAC1B,kBAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,0DAA0D,CAAC,CAAA;YAChG,OAAO;gBACL,WAAW;gBACX,UAAU;gBACV,gBAAgB;gBAChB,KAAK,EAAE,KAAK;gBACZ,SAAS,EAAE,IAAI;aAChB,CAAA;QACH,CAAC;QAED,qEAAqE;QACrE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM;aACzB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAClB,MAAM,CAAC,OAAO,CAAC;aACf,GAAG,CAAC,CAAC,CAAC,EAAE;YACP,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACtB,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,SAAS,CAAA;YAClB,CAAC;QACH,CAAC,CAAC;aACD,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAA;QAElC,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,GAAG,CAAA,MAAA,MAAM,CAAC,IAAI,0CAAG,IAAI,CAAC,KAAI,MAAM,CAAC,IAAI,IAAI,EAAE,CAAA;YAErD,WAAW,GAAG,MAAA,MAAA,MAAA,MAAM,CAAC,IAAI,0CAAG,UAAU,CAAC,0CAAE,OAAO,mCAAI,IAAI,CAAA;YACxD,UAAU,GAAG,MAAA,IAAI,CAAC,YAAY,CAAC,mCAAI,IAAI,CAAA;YACvC,gBAAgB,GAAG,MAAA,IAAI,CAAC,kBAAkB,CAAC,mCAAI,IAAI,CAAA;QACrD,CAAC;QAED,yBAAyB;QACzB,MAAM,KAAK,GAAG,UAAU,KAAK,KAAK,CAAA;QAClC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,gBAAgB,KAAK,cAAc,IAAI,gBAAgB,KAAK,YAAY,CAAA;QAE1G,OAAO;YACL,WAAW;YACX,UAAU;YACV,gBAAgB;YAChB,KAAK;YACL,SAAS;SACV,CAAA;IACH,CAAC;CACF;AA5ED,sEA4EC","sourcesContent":["import { log } from \"builder-util\"\nimport { Lazy } from \"lazy-val\"\nimport { NpmNodeModulesCollector } from \"./npmNodeModulesCollector\"\nimport { PM } from \"./packageManager\"\nimport { NpmDependency } from \"./types\"\n\ntype YarnSetupInfo = {\n  yarnVersion: string | null\n  nodeLinker: \"pnp\" | \"node-modules\" | null\n  nmHoistingLimits: \"workspaces\" | \"dependencies\" | \"none\" | null\n  isPnP: boolean\n  isHoisted: boolean\n}\n\n// Only Yarn v1 uses CLI. We should use pnp.cjs for PnP, but we can't access the files due to virtual file paths within zipped modules.\n// We fallback to npm node module collection (since Yarn Berry could have npm-like structure OR pnpm-like structure, depending on `nmHoistingLimits` configuration).\n// In the latter case, we still can't assume `pnpm` is installed, so we still try to use npm collection as a best-effort attempt.\n// If those fail, such as if using corepack, we attempt to manually build the tree.\nexport class YarnBerryNodeModulesCollector extends NpmNodeModulesCollector {\n  public readonly installOptions = {\n    manager: PM.YARN_BERRY,\n    lockfile: \"yarn.lock\",\n  }\n\n  private yarnSetupInfo: Lazy<YarnSetupInfo> = new Lazy<YarnSetupInfo>(async () => this.detectYarnSetup(this.rootDir))\n\n  protected isHoisted: Lazy<boolean> = new Lazy<boolean>(async () => this.yarnSetupInfo.value.then(info => info.isHoisted))\n\n  protected async getDependenciesTree(_pm: PM): Promise<NpmDependency> {\n    const isPnp = await this.yarnSetupInfo.value.then(info => !!info.isPnP)\n    if (isPnp) {\n      log.warn(null, \"Yarn PnP extraction not supported directly due to virtual file paths (<package_name>.zip/<file_path>), falling back to NPM node module collector\")\n    }\n\n    return super.getDependenciesTree(PM.NPM)\n  }\n\n  protected isProdDependency(packageName: string, tree: NpmDependency): boolean {\n    return tree.dependencies?.[packageName] != null || tree.optionalDependencies?.[packageName] != null\n  }\n\n  private async detectYarnSetup(rootDir: string): Promise<YarnSetupInfo> {\n    let yarnVersion: YarnSetupInfo[\"yarnVersion\"] = null\n    let nodeLinker: YarnSetupInfo[\"nodeLinker\"] = null\n    let nmHoistingLimits: YarnSetupInfo[\"nmHoistingLimits\"] = null\n\n    const output = await this.asyncExec(\"yarn\", [\"config\", \"list\", \"--json\"], rootDir)\n\n    if (output.stdout == null) {\n      log.debug({ stderr: output.stderr }, \"there was no config output, falling back to hoisted mode\")\n      return {\n        yarnVersion,\n        nodeLinker,\n        nmHoistingLimits,\n        isPnP: false,\n        isHoisted: true,\n      }\n    }\n\n    // Yarn prints multiple JSON lines; find the one with type: 'inspect'\n    const parsed = output.stdout\n      .split(\"\\n\")\n      .map(l => l.trim())\n      .filter(Boolean)\n      .map(l => {\n        try {\n          return JSON.parse(l)\n        } catch {\n          return undefined\n        }\n      })\n      .filter(Boolean)\n      .find(l => l.type === \"inspect\")\n\n    if (parsed) {\n      const data = parsed.data?.[\"rc\"] || parsed.data || {}\n\n      yarnVersion = parsed.data?.[\"manifest\"]?.version ?? null\n      nodeLinker = data[\"nodeLinker\"] ?? null\n      nmHoistingLimits = data[\"nmHoistingLimits\"] ?? null\n    }\n\n    // Determine if using PnP\n    const isPnP = nodeLinker === \"pnp\"\n    const isHoisted = isPnP ? false : nmHoistingLimits === \"dependencies\" || nmHoistingLimits === \"workspaces\"\n\n    return {\n      yarnVersion,\n      nodeLinker,\n      nmHoistingLimits,\n      isPnP,\n      isHoisted,\n    }\n  }\n}\n"]}

package/out/node-module-collector/yarnNodeModulesCollector.d.ts

@@ -1,8 +1,18 @@
-import { NpmNodeModulesCollector } from "./npmNodeModulesCollector";
+import { Lazy } from "lazy-val";
+import { NodeModulesCollector } from "./nodeModulesCollector";
 import { PM } from "./packageManager";
-export declare class YarnNodeModulesCollector extends NpmNodeModulesCollector {
+import { PackageJson, YarnDependency } from "./types";
+export declare class YarnNodeModulesCollector extends NodeModulesCollector<YarnDependency, YarnDependency> {
     readonly installOptions: {
         manager: PM;
         lockfile: string;
     };
+    protected isHoisted: Lazy<boolean>;
+    protected getArgs(): string[];
+    protected getTreeFromWorkspaces(tree: YarnDependency): Promise<YarnDependency>;
+    protected extractProductionDependencyGraph(tree: YarnDependency, dependencyId: string): Promise<void>;
+    protected getDependencyType(pkgName: string, parentPkgJson: PackageJson): "prod" | "dev" | "optional";
+    protected parseDependenciesTree(jsonBlob: string): Promise<YarnDependency>;
+    private normalizeTree;
+    protected collectAllDependencies(tree: YarnDependency, packageToExclude: string): Promise<void>;
 }

package/out/node-module-collector/yarnNodeModulesCollector.js

@@ -1,14 +1,243 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.YarnNodeModulesCollector = void 0;
-const npmNodeModulesCollector_1 = require("./npmNodeModulesCollector");
+const builder_util_1 = require("builder-util");
+const lazy_val_1 = require("lazy-val");
+const path = require("path");
+const nodeModulesCollector_1 = require("./nodeModulesCollector");
 const packageManager_1 = require("./packageManager");
-class YarnNodeModulesCollector extends npmNodeModulesCollector_1.NpmNodeModulesCollector {
+class YarnNodeModulesCollector extends nodeModulesCollector_1.NodeModulesCollector {
     constructor() {
         super(...arguments);
-        // note: do not override instance-var `pmCommand`. We explicitly use npm for the json payload
-        // yarn list cannot get the detailed dependencies path info, But we can use npm to get all dependencies path info
-        this.installOptions = { manager: packageManager_1.PM.NPM, lockfile: "yarn.lock" };
+        this.installOptions = {
+            manager: packageManager_1.PM.YARN,
+            lockfile: "yarn.lock",
+        };
+        this.isHoisted = new lazy_val_1.Lazy(async () => {
+            return Promise.resolve(true); // Yarn Classic always hoists
+        });
+    }
+    getArgs() {
+        return ["list", "--production", "--json", "--depth=Infinity", "--no-progress"];
+    }
+    async getTreeFromWorkspaces(tree) {
+        var _a;
+        if (!tree.workspaces || !tree.dependencies) {
+            return tree;
+        }
+        const appName = this.packageVersionString(tree);
+        if ((_a = tree.dependencies) === null || _a === void 0 ? void 0 : _a[appName]) {
+            const { name, path } = tree.dependencies[appName];
+            builder_util_1.log.debug({ name, path }, "pruning root app/self package from workspace tree");
+            delete tree.dependencies[appName];
+        }
+        return Promise.resolve(tree);
+    }
+    async extractProductionDependencyGraph(tree, dependencyId) {
+        if (this.productionGraph[dependencyId]) {
+            return;
+        }
+        const productionDeps = Object.entries(tree.dependencies || {}).map(async ([, dependency]) => {
+            const dep = {
+                ...dependency,
+                path: await this.resolvePath(dependency.path),
+            };
+            const childDependencyId = this.packageVersionString(dep);
+            await this.extractProductionDependencyGraph(dep, childDependencyId);
+            return childDependencyId;
+        });
+        this.productionGraph[dependencyId] = { dependencies: await Promise.all(productionDeps) };
+    }
+    getDependencyType(pkgName, parentPkgJson) {
+        var _a, _b, _c;
+        if ((_a = parentPkgJson.optionalDependencies) === null || _a === void 0 ? void 0 : _a[pkgName]) {
+            return "optional";
+        }
+        if ((_b = parentPkgJson.devDependencies) === null || _b === void 0 ? void 0 : _b[pkgName]) {
+            return "dev";
+        }
+        if ((_c = parentPkgJson.dependencies) === null || _c === void 0 ? void 0 : _c[pkgName]) {
+            return "prod";
+        }
+        return "prod";
+    }
+    async parseDependenciesTree(jsonBlob) {
+        const lines = jsonBlob
+            .split("\n")
+            .map(l => l.trim())
+            .filter(Boolean)
+            .map(l => {
+            try {
+                return JSON.parse(l);
+            }
+            catch {
+                return undefined;
+            }
+        })
+            .filter(Boolean);
+        const parsedTree = lines
+            .filter(l => l.type === "tree")
+            .map(l => l.data.trees)
+            .shift();
+        if (!parsedTree) {
+            throw new Error('Failed to extract Yarn tree: no "type":"tree" line found in console output');
+        }
+        const normalizedTree = await this.normalizeTree(parsedTree, new Set(), undefined);
+        const dependencies = {};
+        for (const [name, dep] of Object.entries(normalizedTree)) {
+            dependencies[name] = dep;
+        }
+        const rootPkgJson = await this.appPkgJson.value;
+        return Promise.resolve({
+            name: (rootPkgJson === null || rootPkgJson === void 0 ? void 0 : rootPkgJson.name) || ".",
+            version: (rootPkgJson === null || rootPkgJson === void 0 ? void 0 : rootPkgJson.version) || "unknown",
+            path: this.rootDir,
+            dependencies,
+            workspaces: rootPkgJson === null || rootPkgJson === void 0 ? void 0 : rootPkgJson.workspaces,
+        });
+    }
+    async normalizeTree(tree, seen = new Set(), appName) {
+        const normalized = {};
+        for (const node of tree) {
+            const match = node.name.match(/^(.*)@([^@]+)$/);
+            if (!match) {
+                builder_util_1.log.debug({ name: node.name }, "invalid node name format");
+                continue;
+            }
+            const [, pkgName, version] = match;
+            const id = `${pkgName}@${version}`;
+            const isShadow = node.shadow && node.color === "dim";
+            if (isShadow) {
+                builder_util_1.log.debug({ pkgName, version }, "skipping shadow node");
+                continue;
+            }
+            if (seen.has(id)) {
+                continue;
+            }
+            seen.add(id);
+            // Build the expected path - yarn classic hoists to root node_modules
+            const pkgPath = path.join(this.rootDir, "node_modules", pkgName);
+            const normalizedDep = {
+                name: pkgName,
+                version,
+                path: pkgPath, // Will be resolved later in collectAllDependencies
+                dependencies: {},
+                optionalDependencies: {},
+            };
+            builder_util_1.log.debug({ name: pkgName, version }, "+ normalize");
+            if (node.children && node.children.length > 0) {
+                for (const child of node.children) {
+                    const childMatch = child.name.match(/^(.*)@([^@]+)$/);
+                    if (!childMatch) {
+                        continue;
+                    }
+                    const [, childName, childVersion] = childMatch;
+                    if (child.shadow && child.color === "dim") {
+                        continue;
+                    }
+                    builder_util_1.log.debug({ parent: pkgName, childName, childVersion }, "  + normalize child");
+                    const childDeps = await this.normalizeTree([child], seen, appName);
+                    for (const [childDepName, childDep] of Object.entries(childDeps)) {
+                        normalizedDep.dependencies[childDepName] = childDep;
+                    }
+                }
+            }
+            normalized[pkgName] = normalizedDep;
+        }
+        return normalized;
+    }
+    async collectAllDependencies(tree, packageToExclude) {
+        const rootPkgJson = await this.appPkgJson.value;
+        const failedPackages = new Set();
+        builder_util_1.log.debug({ packageToExclude, hasWorkspaces: !!tree.workspaces }, "collectAllDependencies starting");
+        const collect = async (deps = {}, isOptionalDependency, parentIsOptional = false) => {
+            var _a, _b, _c, _d;
+            for (const [, value] of Object.entries(deps)) {
+                // Skip the app package if provided
+                if (packageToExclude && value.name === packageToExclude) {
+                    builder_util_1.log.debug({ name: value.name }, "skipping app package in collectAllDependencies");
+                    continue;
+                }
+                const isRootOptional = !!((_a = rootPkgJson.optionalDependencies) === null || _a === void 0 ? void 0 : _a[value.name]);
+                const isDirectRootDep = ((_b = rootPkgJson.dependencies) === null || _b === void 0 ? void 0 : _b[value.name]) || ((_c = rootPkgJson.optionalDependencies) === null || _c === void 0 ? void 0 : _c[value.name]) || ((_d = rootPkgJson.devDependencies) === null || _d === void 0 ? void 0 : _d[value.name]);
+                const treatAsOptional = isOptionalDependency || parentIsOptional || isRootOptional;
+                let p;
+                try {
+                    p = await this.resolvePath(value.path);
+                }
+                catch (e) {
+                    if (treatAsOptional) {
+                        builder_util_1.log.debug({ pkg: this.cacheKey(value), name: value.name }, "failed to resolve optional dependency, skipping");
+                        failedPackages.add(value.name);
+                        continue;
+                    }
+                    if (!isDirectRootDep) {
+                        builder_util_1.log.debug({ pkg: this.cacheKey(value), name: value.name }, "failed to resolve transitive dependency, treating as optional");
+                        failedPackages.add(value.name);
+                        continue;
+                    }
+                    builder_util_1.log.error({ pkg: this.cacheKey(value) }, "failed to resolve module directory");
+                    throw e;
+                }
+                if (!p) {
+                    builder_util_1.log.debug({ pkg: this.cacheKey(value), name: value.name }, "optional dependency not found, skipping");
+                    failedPackages.add(value.name);
+                    continue;
+                }
+                let resolvedVersion = value.version;
+                const versionMatch = p.match(/[/\\]node_modules[/\\][^@]+@([^/\\]+)[/\\]/);
+                if (versionMatch) {
+                    resolvedVersion = versionMatch[1];
+                    if (resolvedVersion !== value.version) {
+                        builder_util_1.log.debug({ name: value.name, declared: value.version, resolved: resolvedVersion }, "resolved actual version from path");
+                    }
+                }
+                const m = {
+                    ...value,
+                    version: resolvedVersion,
+                    path: p,
+                };
+                const moduleKey = this.packageVersionString(m);
+                if (this.allDependencies.has(moduleKey)) {
+                    continue;
+                }
+                this.allDependencies.set(moduleKey, m);
+                const childIsOptional = treatAsOptional;
+                await collect(m.dependencies, false, childIsOptional);
+                await collect(m.optionalDependencies, true, true);
+            }
+        };
+        await collect(tree.dependencies, false, false);
+        await collect(tree.optionalDependencies, true, true);
+        // Final cleanup: remove the app package from allDependencies
+        if (packageToExclude) {
+            for (const [key, dep] of this.allDependencies.entries()) {
+                if (dep.name === packageToExclude) {
+                    builder_util_1.log.debug({ key, name: dep.name }, "removing app package from allDependencies");
+                    this.allDependencies.delete(key);
+                }
+            }
+        }
+        if (failedPackages.size > 0) {
+            const cleanDependencies = (deps = {}) => {
+                for (const [key, dep] of Object.entries(deps)) {
+                    if (failedPackages.has(dep.name)) {
+                        builder_util_1.log.debug({ name: dep.name }, "removing failed package from tree");
+                        delete deps[key];
+                    }
+                    else {
+                        if (dep.dependencies) {
+                            cleanDependencies(dep.dependencies);
+                        }
+                        if (dep.optionalDependencies) {
+                            cleanDependencies(dep.optionalDependencies);
+                        }
+                    }
+                }
+            };
+            cleanDependencies(tree.dependencies);
+            cleanDependencies(tree.optionalDependencies);
+        }
     }
 }
 exports.YarnNodeModulesCollector = YarnNodeModulesCollector;

package/out/node-module-collector/yarnNodeModulesCollector.js.map

@@ -1 +1 @@
-{"version":3,"file":"yarnNodeModulesCollector.js","sourceRoot":"","sources":["../../src/node-module-collector/yarnNodeModulesCollector.ts"],"names":[],"mappings":";;;AAAA,uEAAmE;AACnE,qDAAqC;AAErC,MAAa,wBAAyB,SAAQ,iDAAuB;IAArE;;QACE,6FAA6F;QAC7F,iHAAiH;QACjG,mBAAc,GAAG,EAAE,OAAO,EAAE,mBAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAA;IAC7E,CAAC;CAAA;AAJD,4DAIC","sourcesContent":["import { NpmNodeModulesCollector } from \"./npmNodeModulesCollector\"\nimport { PM } from \"./packageManager\"\n\nexport class YarnNodeModulesCollector extends NpmNodeModulesCollector {\n  // note: do not override instance-var `pmCommand`. We explicitly use npm for the json payload\n  // yarn list cannot get the detailed dependencies path info, But we can use npm to get all dependencies path info\n  public readonly installOptions = { manager: PM.NPM, lockfile: \"yarn.lock\" }\n}\n"]}
+{"version":3,"file":"yarnNodeModulesCollector.js","sourceRoot":"","sources":["../../src/node-module-collector/yarnNodeModulesCollector.ts"],"names":[],"mappings":";;;AAAA,+CAAkC;AAClC,uCAA+B;AAC/B,6BAA4B;AAC5B,iEAA6D;AAC7D,qDAAqC;AAyBrC,MAAa,wBAAyB,SAAQ,2CAAoD;IAAlG;;QACkB,mBAAc,GAAG;YAC/B,OAAO,EAAE,mBAAE,CAAC,IAAI;YAChB,QAAQ,EAAE,WAAW;SACtB,CAAA;QAES,cAAS,GAAkB,IAAI,eAAI,CAAU,KAAK,IAAI,EAAE;YAChE,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA,CAAC,6BAA6B;QAC5D,CAAC,CAAC,CAAA;IAgRJ,CAAC;IA9QW,OAAO;QACf,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAA;IAChF,CAAC;IAES,KAAK,CAAC,qBAAqB,CAAC,IAAoB;;QACxD,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3C,OAAO,IAAI,CAAA;QACb,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAA;QAE/C,IAAI,MAAA,IAAI,CAAC,YAAY,0CAAG,OAAO,CAAC,EAAE,CAAC;YACjC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;YACjD,kBAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,mDAAmD,CAAC,CAAA;YAC9E,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QACnC,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAES,KAAK,CAAC,gCAAgC,CAAC,IAAoB,EAAE,YAAoB;QACzF,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;YACvC,OAAM;QACR,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,EAAE;YAC1F,MAAM,GAAG,GAAG;gBACV,GAAG,UAAU;gBACb,IAAI,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC;aAC9C,CAAA;YAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAA;YACxD,MAAM,IAAI,CAAC,gCAAgC,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAA;YACnE,OAAO,iBAAiB,CAAA;QAC1B,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAA;IAC1F,CAAC;IAES,iBAAiB,CAAC,OAAe,EAAE,aAA0B;;QACrE,IAAI,MAAA,aAAa,CAAC,oBAAoB,0CAAG,OAAO,CAAC,EAAE,CAAC;YAClD,OAAO,UAAU,CAAA;QACnB,CAAC;QAED,IAAI,MAAA,aAAa,CAAC,eAAe,0CAAG,OAAO,CAAC,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,MAAA,aAAa,CAAC,YAAY,0CAAG,OAAO,CAAC,EAAE,CAAC;YAC1C,OAAO,MAAM,CAAA;QACf,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAES,KAAK,CAAC,qBAAqB,CAAC,QAAgB;QACpD,MAAM,KAAK,GAAG,QAAQ;aACnB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAClB,MAAM,CAAC,OAAO,CAAC;aACf,GAAG,CAAC,CAAC,CAAC,EAAE;YACP,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACtB,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,SAAS,CAAA;YAClB,CAAC;QACH,CAAC,CAAC;aACD,MAAM,CAAC,OAAO,CAAuB,CAAA;QAExC,MAAM,UAAU,GAA+B,KAAK;aACjD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC;aAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE,CAAC,CAAC,IAAY,CAAC,KAAK,CAAC;aAC/B,KAAK,EAAE,CAAA;QAEV,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAA;QAC/F,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,IAAI,GAAG,EAAU,EAAE,SAAS,CAAC,CAAA;QAEzF,MAAM,YAAY,GAAmC,EAAE,CAAA;QACvD,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACzD,YAAY,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;QAC1B,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAA;QAC/C,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,IAAI,EAAE,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,KAAI,GAAG;YAC9B,OAAO,EAAE,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,KAAI,SAAS;YAC1C,IAAI,EAAE,IAAI,CAAC,OAAO;YAClB,YAAY;YACZ,UAAU,EAAE,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU;SACpC,CAAC,CAAA;IACJ,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,IAAoB,EAAE,OAAO,IAAI,GAAG,EAAU,EAAE,OAAgB;QAC1F,MAAM,UAAU,GAAmC,EAAE,CAAA;QAErD,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;YAC/C,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,kBAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,0BAA0B,CAAC,CAAA;gBAC1D,SAAQ;YACV,CAAC;YAED,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,KAAK,CAAA;YAClC,MAAM,EAAE,GAAG,GAAG,OAAO,IAAI,OAAO,EAAE,CAAA;YAElC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAA;YACpD,IAAI,QAAQ,EAAE,CAAC;gBACb,kBAAG,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,sBAAsB,CAAC,CAAA;gBACvD,SAAQ;YACV,CAAC;YAED,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACjB,SAAQ;YACV,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAEZ,qEAAqE;YACrE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,CAAA;YAEhE,MAAM,aAAa,GAAmB;gBACpC,IAAI,EAAE,OAAO;gBACb,OAAO;gBACP,IAAI,EAAE,OAAO,EAAE,mDAAmD;gBAClE,YAAY,EAAE,EAAE;gBAChB,oBAAoB,EAAE,EAAE;aACzB,CAAA;YAED,kBAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,aAAa,CAAC,CAAA;YAEpD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;oBACrD,IAAI,CAAC,UAAU,EAAE,CAAC;wBAChB,SAAQ;oBACV,CAAC;oBAED,MAAM,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,GAAG,UAAU,CAAA;oBAC9C,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;wBAC1C,SAAQ;oBACV,CAAC;oBAED,kBAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,qBAAqB,CAAC,CAAA;oBAC9E,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;oBAElE,KAAK,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;wBACjE,aAAa,CAAC,YAAa,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAA;oBACtD,CAAC;gBACH,CAAC;YACH,CAAC;YAED,UAAU,CAAC,OAAO,CAAC,GAAG,aAAa,CAAA;QACrC,CAAC;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;IAES,KAAK,CAAC,sBAAsB,CAAC,IAAoB,EAAE,gBAAwB;QACnF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAA;QAC/C,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAA;QAExC,kBAAG,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,iCAAiC,CAAC,CAAA;QAEpG,MAAM,OAAO,GAAG,KAAK,EACnB,OAAgF,EAAE,EAClF,oBAA6B,EAC7B,mBAA4B,KAAK,EACjC,EAAE;;YACF,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7C,mCAAmC;gBACnC,IAAI,gBAAgB,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;oBACxD,kBAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,gDAAgD,CAAC,CAAA;oBACjF,SAAQ;gBACV,CAAC;gBAED,MAAM,cAAc,GAAG,CAAC,CAAC,CAAA,MAAA,WAAW,CAAC,oBAAoB,0CAAG,KAAK,CAAC,IAAI,CAAC,CAAA,CAAA;gBACvE,MAAM,eAAe,GAAG,CAAA,MAAA,WAAW,CAAC,YAAY,0CAAG,KAAK,CAAC,IAAI,CAAC,MAAI,MAAA,WAAW,CAAC,oBAAoB,0CAAG,KAAK,CAAC,IAAI,CAAC,CAAA,KAAI,MAAA,WAAW,CAAC,eAAe,0CAAG,KAAK,CAAC,IAAI,CAAC,CAAA,CAAA;gBAC7J,MAAM,eAAe,GAAG,oBAAoB,IAAI,gBAAgB,IAAI,cAAc,CAAA;gBAElF,IAAI,CAAgB,CAAA;gBAEpB,IAAI,CAAC;oBACH,CAAC,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBACxC,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,IAAI,eAAe,EAAE,CAAC;wBACpB,kBAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,iDAAiD,CAAC,CAAA;wBAC7G,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;wBAC9B,SAAQ;oBACV,CAAC;oBAED,IAAI,CAAC,eAAe,EAAE,CAAC;wBACrB,kBAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,+DAA+D,CAAC,CAAA;wBAC3H,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;wBAC9B,SAAQ;oBACV,CAAC;oBAED,kBAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,oCAAoC,CAAC,CAAA;oBAC9E,MAAM,CAAC,CAAA;gBACT,CAAC;gBAED,IAAI,CAAC,CAAC,EAAE,CAAC;oBACP,kBAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,yCAAyC,CAAC,CAAA;oBACrG,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;oBAC9B,SAAQ;gBACV,CAAC;gBAED,IAAI,eAAe,GAAG,KAAK,CAAC,OAAO,CAAA;gBACnC,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAA;gBAC1E,IAAI,YAAY,EAAE,CAAC;oBACjB,eAAe,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;oBACjC,IAAI,eAAe,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;wBACtC,kBAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,EAAE,mCAAmC,CAAC,CAAA;oBAC1H,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,GAAmB;oBACxB,GAAG,KAAK;oBACR,OAAO,EAAE,eAAe;oBACxB,IAAI,EAAE,CAAC;iBACR,CAAA;gBAED,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAA;gBAC9C,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;oBACxC,SAAQ;gBACV,CAAC;gBAED,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;gBAEtC,MAAM,eAAe,GAAG,eAAe,CAAA;gBACvC,MAAM,OAAO,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,eAAe,CAAC,CAAA;gBACrD,MAAM,OAAO,CAAC,CAAC,CAAC,oBAAoB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;YACnD,CAAC;QACH,CAAC,CAAA;QAED,MAAM,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;QAC9C,MAAM,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAEpD,6DAA6D;QAC7D,IAAI,gBAAgB,EAAE,CAAC;YACrB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,CAAC;gBACxD,IAAI,GAAG,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;oBAClC,kBAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,EAAE,2CAA2C,CAAC,CAAA;oBAC/E,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,cAAc,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,iBAAiB,GAAG,CAAC,OAAuC,EAAE,EAAE,EAAE;gBACtE,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9C,IAAI,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;wBACjC,kBAAG,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,EAAE,mCAAmC,CAAC,CAAA;wBAClE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAA;oBAClB,CAAC;yBAAM,CAAC;wBACN,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;4BACrB,iBAAiB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;wBACrC,CAAC;wBACD,IAAI,GAAG,CAAC,oBAAoB,EAAE,CAAC;4BAC7B,iBAAiB,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;wBAC7C,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC,CAAA;YAED,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YACpC,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;CACF;AAxRD,4DAwRC","sourcesContent":["import { log } from \"builder-util\"\nimport { Lazy } from \"lazy-val\"\nimport * as path from \"path\"\nimport { NodeModulesCollector } from \"./nodeModulesCollector\"\nimport { PM } from \"./packageManager\"\nimport { PackageJson, YarnDependency } from \"./types\"\n\ntype YarnListJsonLine =\n  | {\n      type: \"tree\"\n      data: {\n        type: \"list\"\n        trees: YarnListTree[]\n      }\n    }\n  | {\n      type: \"info\" | \"warning\" | \"error\"\n      data: string\n    }\n\ninterface YarnListTree {\n  name: string // e.g. \"lodash@4.17.21\"\n  children: YarnListTree[]\n  shadow?: boolean\n  color?: string\n  hint?: any\n  depth?: number\n}\n\nexport class YarnNodeModulesCollector extends NodeModulesCollector<YarnDependency, YarnDependency> {\n  public readonly installOptions = {\n    manager: PM.YARN,\n    lockfile: \"yarn.lock\",\n  }\n\n  protected isHoisted: Lazy<boolean> = new Lazy<boolean>(async () => {\n    return Promise.resolve(true) // Yarn Classic always hoists\n  })\n\n  protected getArgs(): string[] {\n    return [\"list\", \"--production\", \"--json\", \"--depth=Infinity\", \"--no-progress\"]\n  }\n\n  protected async getTreeFromWorkspaces(tree: YarnDependency): Promise<YarnDependency> {\n    if (!tree.workspaces || !tree.dependencies) {\n      return tree\n    }\n\n    const appName = this.packageVersionString(tree)\n\n    if (tree.dependencies?.[appName]) {\n      const { name, path } = tree.dependencies[appName]\n      log.debug({ name, path }, \"pruning root app/self package from workspace tree\")\n      delete tree.dependencies[appName]\n    }\n    return Promise.resolve(tree)\n  }\n\n  protected async extractProductionDependencyGraph(tree: YarnDependency, dependencyId: string): Promise<void> {\n    if (this.productionGraph[dependencyId]) {\n      return\n    }\n\n    const productionDeps = Object.entries(tree.dependencies || {}).map(async ([, dependency]) => {\n      const dep = {\n        ...dependency,\n        path: await this.resolvePath(dependency.path),\n      }\n\n      const childDependencyId = this.packageVersionString(dep)\n      await this.extractProductionDependencyGraph(dep, childDependencyId)\n      return childDependencyId\n    })\n\n    this.productionGraph[dependencyId] = { dependencies: await Promise.all(productionDeps) }\n  }\n\n  protected getDependencyType(pkgName: string, parentPkgJson: PackageJson): \"prod\" | \"dev\" | \"optional\" {\n    if (parentPkgJson.optionalDependencies?.[pkgName]) {\n      return \"optional\"\n    }\n\n    if (parentPkgJson.devDependencies?.[pkgName]) {\n      return \"dev\"\n    }\n\n    if (parentPkgJson.dependencies?.[pkgName]) {\n      return \"prod\"\n    }\n\n    return \"prod\"\n  }\n\n  protected async parseDependenciesTree(jsonBlob: string): Promise<YarnDependency> {\n    const lines = jsonBlob\n      .split(\"\\n\")\n      .map(l => l.trim())\n      .filter(Boolean)\n      .map(l => {\n        try {\n          return JSON.parse(l)\n        } catch {\n          return undefined\n        }\n      })\n      .filter(Boolean) as YarnListJsonLine[]\n\n    const parsedTree: YarnListTree[] | undefined = lines\n      .filter(l => l.type === \"tree\")\n      .map(l => (l.data as any).trees)\n      .shift()\n\n    if (!parsedTree) {\n      throw new Error('Failed to extract Yarn tree: no \"type\":\"tree\" line found in console output')\n    }\n\n    const normalizedTree = await this.normalizeTree(parsedTree, new Set<string>(), undefined)\n\n    const dependencies: Record<string, YarnDependency> = {}\n    for (const [name, dep] of Object.entries(normalizedTree)) {\n      dependencies[name] = dep\n    }\n\n    const rootPkgJson = await this.appPkgJson.value\n    return Promise.resolve({\n      name: rootPkgJson?.name || \".\",\n      version: rootPkgJson?.version || \"unknown\",\n      path: this.rootDir,\n      dependencies,\n      workspaces: rootPkgJson?.workspaces,\n    })\n  }\n\n  private async normalizeTree(tree: YarnListTree[], seen = new Set<string>(), appName?: string): Promise<Record<string, YarnDependency>> {\n    const normalized: Record<string, YarnDependency> = {}\n\n    for (const node of tree) {\n      const match = node.name.match(/^(.*)@([^@]+)$/)\n      if (!match) {\n        log.debug({ name: node.name }, \"invalid node name format\")\n        continue\n      }\n\n      const [, pkgName, version] = match\n      const id = `${pkgName}@${version}`\n\n      const isShadow = node.shadow && node.color === \"dim\"\n      if (isShadow) {\n        log.debug({ pkgName, version }, \"skipping shadow node\")\n        continue\n      }\n\n      if (seen.has(id)) {\n        continue\n      }\n\n      seen.add(id)\n\n      // Build the expected path - yarn classic hoists to root node_modules\n      const pkgPath = path.join(this.rootDir, \"node_modules\", pkgName)\n\n      const normalizedDep: YarnDependency = {\n        name: pkgName,\n        version,\n        path: pkgPath, // Will be resolved later in collectAllDependencies\n        dependencies: {},\n        optionalDependencies: {},\n      }\n\n      log.debug({ name: pkgName, version }, \"+ normalize\")\n\n      if (node.children && node.children.length > 0) {\n        for (const child of node.children) {\n          const childMatch = child.name.match(/^(.*)@([^@]+)$/)\n          if (!childMatch) {\n            continue\n          }\n\n          const [, childName, childVersion] = childMatch\n          if (child.shadow && child.color === \"dim\") {\n            continue\n          }\n\n          log.debug({ parent: pkgName, childName, childVersion }, \"  + normalize child\")\n          const childDeps = await this.normalizeTree([child], seen, appName)\n\n          for (const [childDepName, childDep] of Object.entries(childDeps)) {\n            normalizedDep.dependencies![childDepName] = childDep\n          }\n        }\n      }\n\n      normalized[pkgName] = normalizedDep\n    }\n\n    return normalized\n  }\n\n  protected async collectAllDependencies(tree: YarnDependency, packageToExclude: string) {\n    const rootPkgJson = await this.appPkgJson.value\n    const failedPackages = new Set<string>()\n\n    log.debug({ packageToExclude, hasWorkspaces: !!tree.workspaces }, \"collectAllDependencies starting\")\n\n    const collect = async (\n      deps: YarnDependency[\"dependencies\"] | YarnDependency[\"optionalDependencies\"] = {},\n      isOptionalDependency: boolean,\n      parentIsOptional: boolean = false\n    ) => {\n      for (const [, value] of Object.entries(deps)) {\n        // Skip the app package if provided\n        if (packageToExclude && value.name === packageToExclude) {\n          log.debug({ name: value.name }, \"skipping app package in collectAllDependencies\")\n          continue\n        }\n\n        const isRootOptional = !!rootPkgJson.optionalDependencies?.[value.name]\n        const isDirectRootDep = rootPkgJson.dependencies?.[value.name] || rootPkgJson.optionalDependencies?.[value.name] || rootPkgJson.devDependencies?.[value.name]\n        const treatAsOptional = isOptionalDependency || parentIsOptional || isRootOptional\n\n        let p: string | null\n\n        try {\n          p = await this.resolvePath(value.path)\n        } catch (e) {\n          if (treatAsOptional) {\n            log.debug({ pkg: this.cacheKey(value), name: value.name }, \"failed to resolve optional dependency, skipping\")\n            failedPackages.add(value.name)\n            continue\n          }\n\n          if (!isDirectRootDep) {\n            log.debug({ pkg: this.cacheKey(value), name: value.name }, \"failed to resolve transitive dependency, treating as optional\")\n            failedPackages.add(value.name)\n            continue\n          }\n\n          log.error({ pkg: this.cacheKey(value) }, \"failed to resolve module directory\")\n          throw e\n        }\n\n        if (!p) {\n          log.debug({ pkg: this.cacheKey(value), name: value.name }, \"optional dependency not found, skipping\")\n          failedPackages.add(value.name)\n          continue\n        }\n\n        let resolvedVersion = value.version\n        const versionMatch = p.match(/[/\\\\]node_modules[/\\\\][^@]+@([^/\\\\]+)[/\\\\]/)\n        if (versionMatch) {\n          resolvedVersion = versionMatch[1]\n          if (resolvedVersion !== value.version) {\n            log.debug({ name: value.name, declared: value.version, resolved: resolvedVersion }, \"resolved actual version from path\")\n          }\n        }\n\n        const m: YarnDependency = {\n          ...value,\n          version: resolvedVersion,\n          path: p,\n        }\n\n        const moduleKey = this.packageVersionString(m)\n        if (this.allDependencies.has(moduleKey)) {\n          continue\n        }\n\n        this.allDependencies.set(moduleKey, m)\n\n        const childIsOptional = treatAsOptional\n        await collect(m.dependencies, false, childIsOptional)\n        await collect(m.optionalDependencies, true, true)\n      }\n    }\n\n    await collect(tree.dependencies, false, false)\n    await collect(tree.optionalDependencies, true, true)\n\n    // Final cleanup: remove the app package from allDependencies\n    if (packageToExclude) {\n      for (const [key, dep] of this.allDependencies.entries()) {\n        if (dep.name === packageToExclude) {\n          log.debug({ key, name: dep.name }, \"removing app package from allDependencies\")\n          this.allDependencies.delete(key)\n        }\n      }\n    }\n\n    if (failedPackages.size > 0) {\n      const cleanDependencies = (deps: Record<string, YarnDependency> = {}) => {\n        for (const [key, dep] of Object.entries(deps)) {\n          if (failedPackages.has(dep.name)) {\n            log.debug({ name: dep.name }, \"removing failed package from tree\")\n            delete deps[key]\n          } else {\n            if (dep.dependencies) {\n              cleanDependencies(dep.dependencies)\n            }\n            if (dep.optionalDependencies) {\n              cleanDependencies(dep.optionalDependencies)\n            }\n          }\n        }\n      }\n\n      cleanDependencies(tree.dependencies)\n      cleanDependencies(tree.optionalDependencies)\n    }\n  }\n}\n"]}

package/out/options/PlatformSpecificBuildOptions.d.ts

@@ -97,7 +97,8 @@ export interface PlatformSpecificBuildOptions extends TargetSpecificOptions, Fil
      */
     readonly artifactName?: string | null;
     /**
-     * The executable name. Defaults to `productName`.
+     * The executable name. Defaults to `productName`
+     * Note: Except for Linux, where this would constitute a breaking change in previous behavior and lead to both invalid executable names and Desktop files. Ref comments in: https://github.com/electron-userland/electron-builder/pull/9068
      */
     readonly executableName?: string | null;
     /**

package/out/options/PlatformSpecificBuildOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlatformSpecificBuildOptions.js","sourceRoot":"","sources":["../../src/options/PlatformSpecificBuildOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { CompressionLevel, Publish, TargetConfiguration, TargetSpecificOptions } from \"../core\"\nimport { FileAssociation } from \"./FileAssociation\"\n\nexport interface FileSet {\n  /**\n   * The source path relative to and defaults to:\n   *\n   *  - the [app directory](configuration.md#directories) for `files`,\n   *  - the project directory for `extraResources` and `extraFiles`.\n   * If you don't use two-package.json structure and don't set custom app directory, app directory equals to project directory.\n   */\n  from?: string\n  /**\n   * The destination path relative to and defaults to:\n   *\n   *  - the asar archive root for `files`,\n   *  - the app's content directory for `extraFiles`,\n   *  - the app's resource directory for `extraResources`.\n   */\n  to?: string\n  /**\n   * The [glob patterns](./file-patterns.md). Defaults to \"**\\/*\"\n   */\n  filter?: Array<string> | string\n}\n\nexport interface AsarOptions {\n  /**\n   * Whether to automatically unpack executables files.\n   * @default true\n   */\n  smartUnpack?: boolean\n\n  ordering?: string | null\n}\n\nexport interface FilesBuildOptions {\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](configuration.md#directories), which specifies which files to include when copying files to create the package.\n\nDefaults to:\n```json\n[\n  \"**\\/*\",\n  \"!**\\/node_modules/*\\/{CHANGELOG.md,README.md,README,readme.md,readme}\",\n  \"!**\\/node_modules/*\\/{test,__tests__,tests,powered-test,example,examples}\",\n  \"!**\\/node_modules/*.d.ts\",\n  \"!**\\/node_modules/.bin\",\n  \"!**\\/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}\",\n  \"!.editorconfig\",\n  \"!**\\/._*\",\n  \"!**\\/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}\",\n  \"!**\\/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}\",\n  \"!**\\/{appveyor.yml,.travis.yml,circle.yml}\",\n  \"!**\\/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}\"\n]\n```\n\nDevelopment dependencies are never copied in any case. You don't need to ignore it explicitly. Hidden files are not ignored by default, but all files that should be ignored, are ignored by default.\n\nDefault pattern \\`**\\/*\\` **is not added to your custom** if some of your patterns is not ignore (i.e. not starts with `!`). `package.json` and \\`**\\/node_modules/**\\/*` (only production dependencies will be copied) is added to your custom in any case. All default ignores are added in any case — you don't need to repeat it if you configure own patterns.\n\nMay be specified in the platform options (e.g. in the [mac](mac.md)).\n\nYou may also specify custom source and destination directories by using `FileSet` objects instead of simple glob patterns.\n\n```json\n[\n  {\n    \"from\": \"path/to/source\",\n    \"to\": \"path/to/destination\",\n    \"filter\": [\"**\\/*\", \"!foo/*.js\"]\n  }\n]\n```\n\nYou can use [file macros](./file-patterns.md#file-macros) in the `from` and `to` fields as well. `from` and `to` can be files and you can use this to [rename](https://github.com/electron-userland/electron-builder/issues/1119) a file while packaging.\n   */\n  files?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the project directory, when specified, copy the file or directory with matching names directly into the app's resources directory (`Contents/Resources` for MacOS, `resources` for Linux and Windows).\n   *\n   * File patterns (and support for `from` and `to` fields) the same as for [files](#files).\n   *\n   */\n  extraResources?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * The same as [extraResources](#extraresources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux and Windows).\n   */\n  extraFiles?: Array<FileSet | string> | FileSet | string | null\n}\n\nexport interface PlatformSpecificBuildOptions extends TargetSpecificOptions, FilesBuildOptions {\n  /**\n   * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n   * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\n   * @default com.electron.${name}\n   */\n  readonly appId?: string | null\n\n  /**\n   * The [artifact file name template](./configuration.md#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\n   */\n  readonly artifactName?: string | null\n\n  /**\n   * The executable name. Defaults to `productName`.\n   */\n  readonly executableName?: string | null\n\n  /**\n   * The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\n   * @default normal\n   */\n  readonly compression?: CompressionLevel | null\n\n  /**\n   * Whether to exclude all default ignored files(https://www.electron.build/contents#files) and options. Defaults to `false`.\n   *\n   * @default false\n   */\n  disableDefaultIgnoredFiles?: boolean | null\n\n  /**\n   * Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n   *\n   * Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#asarUnpack) - please file an issue if this doesn't work.\n   * @default true\n   */\n  readonly asar?: AsarOptions | boolean | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](#directories), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\n   */\n  readonly asarUnpack?: Array<string> | string | null\n\n  /*  - @private */\n  readonly icon?: string | null\n\n  /**\n   * The file associations.\n   */\n  readonly fileAssociations?: Array<FileAssociation> | FileAssociation\n  /**\n   * The URL protocol schemes.\n   */\n  readonly protocols?: Array<Protocol> | Protocol\n\n  /**\n   * The electron locales to keep. By default, all Electron locales used as-is.\n   */\n  readonly electronLanguages?: Array<string> | string\n\n  /**\n   * Whether to fail if app will be not code signed.\n   */\n  readonly forceCodeSigning?: boolean\n\n  /**\n   * The [electron-updater compatibility](./auto-update.md#compatibility) semver range.\n   */\n  readonly electronUpdaterCompatibility?: string | null\n\n  /**\n   * Publisher configuration. See [Auto Update](./publish.md) for more information.\n   */\n  publish?: Publish\n\n  /**\n   * Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\n   * This does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).\n   * @default true\n   */\n  readonly detectUpdateChannel?: boolean\n\n  /**\n   * Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\n   * @default false\n   */\n  readonly generateUpdatesFilesForAllChannels?: boolean\n\n  /**\n   * The release info. Intended for command line usage:\n   *\n   * ```\n   * -c.releaseInfo.releaseNotes=\"new features\"\n   * ```\n   */\n  readonly releaseInfo?: ReleaseInfo\n\n  readonly target?: Array<string | TargetConfiguration> | string | TargetConfiguration | null\n\n  /*  - @private */\n  cscLink?: string | null\n\n  /*  - @private */\n  cscKeyPassword?: string | null\n\n  readonly defaultArch?: string\n}\n\nexport interface ReleaseInfo {\n  /**\n   * The release name.\n   */\n  releaseName?: string | null\n\n  /**\n   * The release notes.\n   */\n  releaseNotes?: string | null\n\n  /**\n   * The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](./contents.md#extraresources).\n   */\n  releaseNotesFile?: string | null\n\n  /**\n   * The release date.\n   */\n  releaseDate?: string\n\n  /**\n   * Vendor specific information.\n   */\n  vendor?: { [key: string]: any } | null\n}\n\n/**\n * URL Protocol Schemes. Protocols to associate the app with. macOS only.\n *\n * Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).\n */\nexport interface Protocol {\n  /**\n   * The name. e.g. `IRC server URL`.\n   */\n  readonly name: string\n\n  /**\n   * The schemes. e.g. `[\"irc\", \"ircs\"]`.\n   */\n  readonly schemes: Array<string>\n\n  /**\n   * *macOS-only* The app’s role with respect to the type.\n   * @default Editor\n   */\n  readonly role?: \"Editor\" | \"Viewer\" | \"Shell\" | \"None\"\n}\n"]}
+{"version":3,"file":"PlatformSpecificBuildOptions.js","sourceRoot":"","sources":["../../src/options/PlatformSpecificBuildOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { CompressionLevel, Publish, TargetConfiguration, TargetSpecificOptions } from \"../core\"\nimport { FileAssociation } from \"./FileAssociation\"\n\nexport interface FileSet {\n  /**\n   * The source path relative to and defaults to:\n   *\n   *  - the [app directory](configuration.md#directories) for `files`,\n   *  - the project directory for `extraResources` and `extraFiles`.\n   * If you don't use two-package.json structure and don't set custom app directory, app directory equals to project directory.\n   */\n  from?: string\n  /**\n   * The destination path relative to and defaults to:\n   *\n   *  - the asar archive root for `files`,\n   *  - the app's content directory for `extraFiles`,\n   *  - the app's resource directory for `extraResources`.\n   */\n  to?: string\n  /**\n   * The [glob patterns](./file-patterns.md). Defaults to \"**\\/*\"\n   */\n  filter?: Array<string> | string\n}\n\nexport interface AsarOptions {\n  /**\n   * Whether to automatically unpack executables files.\n   * @default true\n   */\n  smartUnpack?: boolean\n\n  ordering?: string | null\n}\n\nexport interface FilesBuildOptions {\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](configuration.md#directories), which specifies which files to include when copying files to create the package.\n\nDefaults to:\n```json\n[\n  \"**\\/*\",\n  \"!**\\/node_modules/*\\/{CHANGELOG.md,README.md,README,readme.md,readme}\",\n  \"!**\\/node_modules/*\\/{test,__tests__,tests,powered-test,example,examples}\",\n  \"!**\\/node_modules/*.d.ts\",\n  \"!**\\/node_modules/.bin\",\n  \"!**\\/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}\",\n  \"!.editorconfig\",\n  \"!**\\/._*\",\n  \"!**\\/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}\",\n  \"!**\\/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}\",\n  \"!**\\/{appveyor.yml,.travis.yml,circle.yml}\",\n  \"!**\\/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}\"\n]\n```\n\nDevelopment dependencies are never copied in any case. You don't need to ignore it explicitly. Hidden files are not ignored by default, but all files that should be ignored, are ignored by default.\n\nDefault pattern \\`**\\/*\\` **is not added to your custom** if some of your patterns is not ignore (i.e. not starts with `!`). `package.json` and \\`**\\/node_modules/**\\/*` (only production dependencies will be copied) is added to your custom in any case. All default ignores are added in any case — you don't need to repeat it if you configure own patterns.\n\nMay be specified in the platform options (e.g. in the [mac](mac.md)).\n\nYou may also specify custom source and destination directories by using `FileSet` objects instead of simple glob patterns.\n\n```json\n[\n  {\n    \"from\": \"path/to/source\",\n    \"to\": \"path/to/destination\",\n    \"filter\": [\"**\\/*\", \"!foo/*.js\"]\n  }\n]\n```\n\nYou can use [file macros](./file-patterns.md#file-macros) in the `from` and `to` fields as well. `from` and `to` can be files and you can use this to [rename](https://github.com/electron-userland/electron-builder/issues/1119) a file while packaging.\n   */\n  files?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the project directory, when specified, copy the file or directory with matching names directly into the app's resources directory (`Contents/Resources` for MacOS, `resources` for Linux and Windows).\n   *\n   * File patterns (and support for `from` and `to` fields) the same as for [files](#files).\n   *\n   */\n  extraResources?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * The same as [extraResources](#extraresources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux and Windows).\n   */\n  extraFiles?: Array<FileSet | string> | FileSet | string | null\n}\n\nexport interface PlatformSpecificBuildOptions extends TargetSpecificOptions, FilesBuildOptions {\n  /**\n   * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n   * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\n   * @default com.electron.${name}\n   */\n  readonly appId?: string | null\n\n  /**\n   * The [artifact file name template](./configuration.md#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\n   */\n  readonly artifactName?: string | null\n\n  /**\n   * The executable name. Defaults to `productName`\n   * Note: Except for Linux, where this would constitute a breaking change in previous behavior and lead to both invalid executable names and Desktop files. Ref comments in: https://github.com/electron-userland/electron-builder/pull/9068\n   */\n  readonly executableName?: string | null\n\n  /**\n   * The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\n   * @default normal\n   */\n  readonly compression?: CompressionLevel | null\n\n  /**\n   * Whether to exclude all default ignored files(https://www.electron.build/contents#files) and options. Defaults to `false`.\n   *\n   * @default false\n   */\n  disableDefaultIgnoredFiles?: boolean | null\n\n  /**\n   * Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n   *\n   * Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#asarUnpack) - please file an issue if this doesn't work.\n   * @default true\n   */\n  readonly asar?: AsarOptions | boolean | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](#directories), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\n   */\n  readonly asarUnpack?: Array<string> | string | null\n\n  /*  - @private */\n  readonly icon?: string | null\n\n  /**\n   * The file associations.\n   */\n  readonly fileAssociations?: Array<FileAssociation> | FileAssociation\n  /**\n   * The URL protocol schemes.\n   */\n  readonly protocols?: Array<Protocol> | Protocol\n\n  /**\n   * The electron locales to keep. By default, all Electron locales used as-is.\n   */\n  readonly electronLanguages?: Array<string> | string\n\n  /**\n   * Whether to fail if app will be not code signed.\n   */\n  readonly forceCodeSigning?: boolean\n\n  /**\n   * The [electron-updater compatibility](./auto-update.md#compatibility) semver range.\n   */\n  readonly electronUpdaterCompatibility?: string | null\n\n  /**\n   * Publisher configuration. See [Auto Update](./publish.md) for more information.\n   */\n  publish?: Publish\n\n  /**\n   * Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\n   * This does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).\n   * @default true\n   */\n  readonly detectUpdateChannel?: boolean\n\n  /**\n   * Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\n   * @default false\n   */\n  readonly generateUpdatesFilesForAllChannels?: boolean\n\n  /**\n   * The release info. Intended for command line usage:\n   *\n   * ```\n   * -c.releaseInfo.releaseNotes=\"new features\"\n   * ```\n   */\n  readonly releaseInfo?: ReleaseInfo\n\n  readonly target?: Array<string | TargetConfiguration> | string | TargetConfiguration | null\n\n  /*  - @private */\n  cscLink?: string | null\n\n  /*  - @private */\n  cscKeyPassword?: string | null\n\n  readonly defaultArch?: string\n}\n\nexport interface ReleaseInfo {\n  /**\n   * The release name.\n   */\n  releaseName?: string | null\n\n  /**\n   * The release notes.\n   */\n  releaseNotes?: string | null\n\n  /**\n   * The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](./contents.md#extraresources).\n   */\n  releaseNotesFile?: string | null\n\n  /**\n   * The release date.\n   */\n  releaseDate?: string\n\n  /**\n   * Vendor specific information.\n   */\n  vendor?: { [key: string]: any } | null\n}\n\n/**\n * URL Protocol Schemes. Protocols to associate the app with. macOS only.\n *\n * Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).\n */\nexport interface Protocol {\n  /**\n   * The name. e.g. `IRC server URL`.\n   */\n  readonly name: string\n\n  /**\n   * The schemes. e.g. `[\"irc\", \"ircs\"]`.\n   */\n  readonly schemes: Array<string>\n\n  /**\n   * *macOS-only* The app’s role with respect to the type.\n   * @default Editor\n   */\n  readonly role?: \"Editor\" | \"Viewer\" | \"Shell\" | \"None\"\n}\n"]}

package/out/options/macOptions.d.ts

@@ -23,6 +23,8 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions {
     readonly identity?: string | null;
     /**
      * The path to application icon.
+     * Accepts `.icns` (legacy) or `.icon` (Icon Composer asset).
+     * If a `.icon` asset is provided, it will be preferred and compiled to an asset catalog.
      * @default build/icon.icns
      */
     readonly icon?: string | null;

package/out/options/macOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"macOptions.js","sourceRoot":"","sources":["../../src/options/macOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { PlatformSpecificBuildOptions, TargetConfiguration, TargetSpecificOptions } from \"../index\"\nimport { CustomMacSign } from \"../macPackager\"\n\nexport type MacOsTargetName = \"default\" | \"dmg\" | \"mas\" | \"mas-dev\" | \"pkg\" | \"7z\" | \"zip\" | \"tar.xz\" | \"tar.lz\" | \"tar.gz\" | \"tar.bz2\" | \"dir\"\n\nexport interface MacConfiguration extends PlatformSpecificBuildOptions {\n  /**\n   * The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\n   *\n   * For example, `\"category\": \"public.app-category.developer-tools\"` will set the application category to *Developer Tools*.\n   *\n   * Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).\n   */\n  readonly category?: string | null\n\n  /**\n   * The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (`dmg` and `zip` for Squirrel.Mac). Note: Squirrel.Mac auto update mechanism requires both `dmg` and `zip` to be enabled, even when only `dmg` is used. Disabling `zip` will break auto update in `dmg` packages.\n   */\n  readonly target?: Array<MacOsTargetName | TargetConfiguration> | MacOsTargetName | TargetConfiguration | null\n\n  /**\n   * The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](./code-signing.md) instead of specifying this option.\n   * MAS installer identity is specified in the [mas](./mas.md).\n   *\n   * Set to `-` to use an ad-hoc identity for signing. Set to `null` to skip signing entirely.\n   */\n  readonly identity?: string | null\n\n  /**\n   * The path to application icon.\n   * @default build/icon.icns\n   */\n  readonly icon?: string | null\n\n  /**\n   * The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set).\n   * MAS entitlements is specified in the [mas](./mas.md).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   * Be aware that your app may crash if the right entitlements are not set like `com.apple.security.cs.allow-jit` for example on arm64 builds with Electron 20+.\n   * See [Signing and Notarizing macOS Builds from the Electron documentation](https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds) for more information.\n   */\n  readonly entitlements?: string | null\n\n  /**\n   * The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   *\n   * This option only applies when signing with `entitlements` provided.\n   */\n  readonly entitlementsInherit?: string | null\n\n  /**\n   * Path to login helper entitlement file.\n   * When using App Sandbox, the the `com.apple.security.inherit` key that is normally in the inherited entitlements cannot be inherited since the login helper is a standalone executable.\n   * Defaults to the value provided for `entitlements`. This option only applies when signing with `entitlements` provided.\n   */\n  readonly entitlementsLoginHelper?: string | null\n\n  /**\n   * The path to the provisioning profile to use when signing, absolute or relative to the app root.\n   */\n  readonly provisioningProfile?: string | null\n\n  /**\n   * The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).\n   */\n  readonly bundleVersion?: string | null\n\n  /**\n   * The `CFBundleShortVersionString`. Do not use it unless you need to.\n   */\n  readonly bundleShortVersion?: string | null\n\n  /**\n   * Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.\n   * @default false\n   */\n  readonly darkModeSupport?: boolean\n\n  /**\n   * The bundle identifier to use in the application helper's plist.\n   * @default ${appBundleIdentifier}.helper\n   */\n  readonly helperBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the Renderer helper's plist.\n   * @default ${appBundleIdentifier}.helper.Renderer\n   */\n  readonly helperRendererBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the Plugin helper's plist.\n   * @default ${appBundleIdentifier}.helper.Plugin\n   */\n  readonly helperPluginBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the GPU helper's plist.\n   * @default ${appBundleIdentifier}.helper.GPU\n   */\n  readonly helperGPUBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the EH helper's plist.\n   * @default ${appBundleIdentifier}.helper.EH\n   */\n  readonly helperEHBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the NP helper's plist.\n   * @default ${appBundleIdentifier}.helper.NP\n   */\n  readonly helperNPBundleId?: string | null\n\n  /**\n   * Whether to sign app for development or for distribution.\n   * @default distribution\n   */\n  readonly type?: \"distribution\" | \"development\" | null\n\n  /**\n   * The extra entries for `Info.plist`.\n   */\n  readonly extendInfo?: any\n\n  /**\n   * Paths of any extra binaries that need to be signed.\n   */\n  readonly binaries?: Array<string> | null\n\n  /**\n   * The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.\n   */\n  readonly minimumSystemVersion?: string | null\n\n  /**\n   * Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.\n   */\n  readonly requirements?: string | null\n\n  /** @private */\n  readonly cscInstallerLink?: string | null\n  /** @private */\n  readonly cscInstallerKeyPassword?: string | null\n\n  /**\n   * Extra files to put in archive. Not applicable for `tar.*`.\n   */\n  readonly extraDistFiles?: Array<string> | string | null\n\n  /**\n   * Whether your app has to be signed with hardened runtime.\n   * @default true\n   */\n  readonly hardenedRuntime?: boolean\n\n  /**\n   * Whether to let `@electron/osx-sign` validate the signing or not.\n   * @default false\n   */\n  readonly gatekeeperAssess?: boolean\n\n  /**\n   * Whether to let `@electron/osx-sign` verify the contents or not.\n   * @default true\n   */\n  readonly strictVerify?: boolean\n\n  /**\n   * Whether to enable entitlements automation from `@electron/osx-sign`.\n   * @default true\n   */\n  readonly preAutoEntitlements?: boolean\n\n  /**\n   * Regex or an array of regex's that signal skipping signing a file.\n   */\n  readonly signIgnore?: Array<string> | string | null\n\n  /**\n   * The custom function (or path to file or module id) to sign an app bundle.\n   */\n  readonly sign?: CustomMacSign | string | null\n\n  /**\n   * Specify the URL of the timestamp authority server\n   */\n  readonly timestamp?: string | null\n\n  /**\n   * Whether to merge ASAR files for different architectures or not.\n   *\n   * This option has no effect unless building for \"universal\" arch.\n   * @default true\n   */\n  readonly mergeASARs?: boolean\n\n  /**\n   * Minimatch pattern of paths that are allowed to be present in one of the\n   * ASAR files, but not in the other.\n   *\n   * This option has no effect unless building for \"universal\" arch and applies\n   * only if `mergeASARs` is `true`.\n   */\n  readonly singleArchFiles?: string | null\n\n  /**\n   * Minimatch pattern of paths that are allowed to be x64 binaries in both\n   * ASAR files\n   *\n   * This option has no effect unless building for \"universal\" arch and applies\n   * only if `mergeASARs` is `true`.\n   */\n  readonly x64ArchFiles?: string | null\n\n  /**\n   * Array of strings specifying additional arguments to pass to the `codesign` command used to sign a specific file.\n   *\n   * Some subresources that you may include in your Electron app may need to be signed with --deep, this is not typically safe to apply to the entire Electron app and therefore should be applied to just your file.\n   * Usage Example: `['--deep']`\n   */\n  readonly additionalArguments?: Array<string> | null\n\n  /**\n   * Whether to disable electron-builder's [@electron/notarize](https://github.com/electron/notarize) integration.\n   *\n   * Note: In order to activate the notarization step You MUST specify one of the following via environment variables:\n   *\n   * 1. `APPLE_API_KEY`, `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`.\n   * 2. `APPLE_ID`, `APPLE_APP_SPECIFIC_PASSWORD`, and `APPLE_TEAM_ID`\n   * 3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\n   *\n   * For security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)\n   */\n  readonly notarize?: boolean\n}\n\nexport interface DmgOptions extends TargetSpecificOptions {\n  /**\n   * The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.\n   * If background is not specified, use `window.size`. Default locations expected background size to be 540x380.\n   * @see [DMG with Retina background support](http://stackoverflow.com/a/11204769/1910191).\n   */\n  background?: string | null\n\n  /**\n   * The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image.\n   */\n  backgroundColor?: string | null\n\n  /**\n   * The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](./contents.md#extraresources) or to the project directory.\n   * Defaults to the application icon (`build/icon.icns`).\n   */\n  icon?: string | null\n\n  /**\n   * The size of all the icons inside the DMG.\n   * @default 80\n   */\n  readonly iconSize?: number | null\n\n  /**\n   * The size of all the icon texts inside the DMG.\n   * @default 12\n   */\n  readonly iconTextSize?: number | null\n\n  /**\n   * The title of the produced DMG, which will be shown when mounted (volume name).\n   *\n   * Macro `${productName}`, `${version}` and `${name}` are supported.\n   * @default ${productName} ${version}\n   */\n  readonly title?: string | null\n\n  /**\n   * The content — to customize icon locations. The x and y coordinates refer to the position of the **center** of the icon (at 1x scale), and do not take the label into account.\n   */\n  contents?: Array<DmgContent>\n\n  /**\n   * The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).\n   * @default UDZO\n   */\n  format?: \"UDRW\" | \"UDRO\" | \"UDCO\" | \"UDZO\" | \"UDBZ\" | \"ULFO\"\n\n  /**\n   * The DMG window position and size. With y co-ordinates running from bottom to top.\n   *\n   * The Finder makes sure that the window will be on the user’s display, so if you want your window at the top left of the display you could use `\"x\": 0, \"y\": 100000` as the x, y co-ordinates.\n   * It is not to be possible to position the window relative to the [top left](https://github.com/electron-userland/electron-builder/issues/3990#issuecomment-512960957) or relative to the center of the user’s screen.\n   */\n  window?: DmgWindow\n\n  /**\n   * Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).\n   * @default false\n   */\n  readonly internetEnabled?: boolean\n\n  /**\n   * Whether to sign the DMG or not. Signing is not required and will lead to unwanted errors in combination with notarization requirements.\n   * @default false\n   */\n  readonly sign?: boolean\n\n  /**\n   * @private\n   * @default true\n   */\n  writeUpdateInfo?: boolean\n}\n\nexport interface DmgWindow {\n  /**\n   * The X position relative to left of the screen.\n   * @default 400\n   */\n  x?: number\n\n  /**\n   * The Y position relative to bottom of the screen.\n   * @default 100\n   */\n  y?: number\n\n  /**\n   * The width. Defaults to background image width or 540.\n   */\n  width?: number\n\n  /**\n   * The height. Defaults to background image height or 380.\n   */\n  height?: number\n}\n\nexport interface DmgContent {\n  /**\n   * The device-independent pixel offset from the left of the window to the **center** of the icon.\n   */\n  x: number\n  /**\n   * The device-independent pixel offset from the top of the window to the **center** of the icon.\n   */\n  y: number\n  type?: \"link\" | \"file\" | \"dir\"\n\n  /**\n   * The name of the file within the DMG. Defaults to basename of `path`.\n   */\n  name?: string\n\n  /**\n   * The path of the file within the DMG.\n   */\n  path?: string\n}\n\nexport interface MasConfiguration extends MacConfiguration {\n  /**\n   * The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   * Be aware that your app may crash if the right entitlements are not set like `com.apple.security.cs.allow-jit` for example on arm64 builds with Electron 20+.\n   * See [Signing and Notarizing macOS Builds from the Electron documentation](https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds) for more information.\n   */\n  readonly entitlements?: string | null\n\n  /**\n   * The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   */\n  readonly entitlementsInherit?: string | null\n\n  /**\n   * Paths of any extra binaries that need to be signed.\n   */\n  readonly binaries?: Array<string> | null\n}\n"]}
+{"version":3,"file":"macOptions.js","sourceRoot":"","sources":["../../src/options/macOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { PlatformSpecificBuildOptions, TargetConfiguration, TargetSpecificOptions } from \"../index\"\nimport { CustomMacSign } from \"../macPackager\"\n\nexport type MacOsTargetName = \"default\" | \"dmg\" | \"mas\" | \"mas-dev\" | \"pkg\" | \"7z\" | \"zip\" | \"tar.xz\" | \"tar.lz\" | \"tar.gz\" | \"tar.bz2\" | \"dir\"\n\nexport interface MacConfiguration extends PlatformSpecificBuildOptions {\n  /**\n   * The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.\n   *\n   * For example, `\"category\": \"public.app-category.developer-tools\"` will set the application category to *Developer Tools*.\n   *\n   * Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).\n   */\n  readonly category?: string | null\n\n  /**\n   * The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (`dmg` and `zip` for Squirrel.Mac). Note: Squirrel.Mac auto update mechanism requires both `dmg` and `zip` to be enabled, even when only `dmg` is used. Disabling `zip` will break auto update in `dmg` packages.\n   */\n  readonly target?: Array<MacOsTargetName | TargetConfiguration> | MacOsTargetName | TargetConfiguration | null\n\n  /**\n   * The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](./code-signing.md) instead of specifying this option.\n   * MAS installer identity is specified in the [mas](./mas.md).\n   *\n   * Set to `-` to use an ad-hoc identity for signing. Set to `null` to skip signing entirely.\n   */\n  readonly identity?: string | null\n\n  /**\n   * The path to application icon.\n   * Accepts `.icns` (legacy) or `.icon` (Icon Composer asset).\n   * If a `.icon` asset is provided, it will be preferred and compiled to an asset catalog.\n   * @default build/icon.icns\n   */\n  readonly icon?: string | null\n\n  /**\n   * The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set).\n   * MAS entitlements is specified in the [mas](./mas.md).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   * Be aware that your app may crash if the right entitlements are not set like `com.apple.security.cs.allow-jit` for example on arm64 builds with Electron 20+.\n   * See [Signing and Notarizing macOS Builds from the Electron documentation](https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds) for more information.\n   */\n  readonly entitlements?: string | null\n\n  /**\n   * The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   *\n   * This option only applies when signing with `entitlements` provided.\n   */\n  readonly entitlementsInherit?: string | null\n\n  /**\n   * Path to login helper entitlement file.\n   * When using App Sandbox, the the `com.apple.security.inherit` key that is normally in the inherited entitlements cannot be inherited since the login helper is a standalone executable.\n   * Defaults to the value provided for `entitlements`. This option only applies when signing with `entitlements` provided.\n   */\n  readonly entitlementsLoginHelper?: string | null\n\n  /**\n   * The path to the provisioning profile to use when signing, absolute or relative to the app root.\n   */\n  readonly provisioningProfile?: string | null\n\n  /**\n   * The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).\n   */\n  readonly bundleVersion?: string | null\n\n  /**\n   * The `CFBundleShortVersionString`. Do not use it unless you need to.\n   */\n  readonly bundleShortVersion?: string | null\n\n  /**\n   * Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.\n   * @default false\n   */\n  readonly darkModeSupport?: boolean\n\n  /**\n   * The bundle identifier to use in the application helper's plist.\n   * @default ${appBundleIdentifier}.helper\n   */\n  readonly helperBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the Renderer helper's plist.\n   * @default ${appBundleIdentifier}.helper.Renderer\n   */\n  readonly helperRendererBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the Plugin helper's plist.\n   * @default ${appBundleIdentifier}.helper.Plugin\n   */\n  readonly helperPluginBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the GPU helper's plist.\n   * @default ${appBundleIdentifier}.helper.GPU\n   */\n  readonly helperGPUBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the EH helper's plist.\n   * @default ${appBundleIdentifier}.helper.EH\n   */\n  readonly helperEHBundleId?: string | null\n\n  /**\n   * The bundle identifier to use in the NP helper's plist.\n   * @default ${appBundleIdentifier}.helper.NP\n   */\n  readonly helperNPBundleId?: string | null\n\n  /**\n   * Whether to sign app for development or for distribution.\n   * @default distribution\n   */\n  readonly type?: \"distribution\" | \"development\" | null\n\n  /**\n   * The extra entries for `Info.plist`.\n   */\n  readonly extendInfo?: any\n\n  /**\n   * Paths of any extra binaries that need to be signed.\n   */\n  readonly binaries?: Array<string> | null\n\n  /**\n   * The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.\n   */\n  readonly minimumSystemVersion?: string | null\n\n  /**\n   * Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.\n   */\n  readonly requirements?: string | null\n\n  /** @private */\n  readonly cscInstallerLink?: string | null\n  /** @private */\n  readonly cscInstallerKeyPassword?: string | null\n\n  /**\n   * Extra files to put in archive. Not applicable for `tar.*`.\n   */\n  readonly extraDistFiles?: Array<string> | string | null\n\n  /**\n   * Whether your app has to be signed with hardened runtime.\n   * @default true\n   */\n  readonly hardenedRuntime?: boolean\n\n  /**\n   * Whether to let `@electron/osx-sign` validate the signing or not.\n   * @default false\n   */\n  readonly gatekeeperAssess?: boolean\n\n  /**\n   * Whether to let `@electron/osx-sign` verify the contents or not.\n   * @default true\n   */\n  readonly strictVerify?: boolean\n\n  /**\n   * Whether to enable entitlements automation from `@electron/osx-sign`.\n   * @default true\n   */\n  readonly preAutoEntitlements?: boolean\n\n  /**\n   * Regex or an array of regex's that signal skipping signing a file.\n   */\n  readonly signIgnore?: Array<string> | string | null\n\n  /**\n   * The custom function (or path to file or module id) to sign an app bundle.\n   */\n  readonly sign?: CustomMacSign | string | null\n\n  /**\n   * Specify the URL of the timestamp authority server\n   */\n  readonly timestamp?: string | null\n\n  /**\n   * Whether to merge ASAR files for different architectures or not.\n   *\n   * This option has no effect unless building for \"universal\" arch.\n   * @default true\n   */\n  readonly mergeASARs?: boolean\n\n  /**\n   * Minimatch pattern of paths that are allowed to be present in one of the\n   * ASAR files, but not in the other.\n   *\n   * This option has no effect unless building for \"universal\" arch and applies\n   * only if `mergeASARs` is `true`.\n   */\n  readonly singleArchFiles?: string | null\n\n  /**\n   * Minimatch pattern of paths that are allowed to be x64 binaries in both\n   * ASAR files\n   *\n   * This option has no effect unless building for \"universal\" arch and applies\n   * only if `mergeASARs` is `true`.\n   */\n  readonly x64ArchFiles?: string | null\n\n  /**\n   * Array of strings specifying additional arguments to pass to the `codesign` command used to sign a specific file.\n   *\n   * Some subresources that you may include in your Electron app may need to be signed with --deep, this is not typically safe to apply to the entire Electron app and therefore should be applied to just your file.\n   * Usage Example: `['--deep']`\n   */\n  readonly additionalArguments?: Array<string> | null\n\n  /**\n   * Whether to disable electron-builder's [@electron/notarize](https://github.com/electron/notarize) integration.\n   *\n   * Note: In order to activate the notarization step You MUST specify one of the following via environment variables:\n   *\n   * 1. `APPLE_API_KEY`, `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`.\n   * 2. `APPLE_ID`, `APPLE_APP_SPECIFIC_PASSWORD`, and `APPLE_TEAM_ID`\n   * 3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\n   *\n   * For security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)\n   */\n  readonly notarize?: boolean\n}\n\nexport interface DmgOptions extends TargetSpecificOptions {\n  /**\n   * The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.\n   * If background is not specified, use `window.size`. Default locations expected background size to be 540x380.\n   * @see [DMG with Retina background support](http://stackoverflow.com/a/11204769/1910191).\n   */\n  background?: string | null\n\n  /**\n   * The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image.\n   */\n  backgroundColor?: string | null\n\n  /**\n   * The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](./contents.md#extraresources) or to the project directory.\n   * Defaults to the application icon (`build/icon.icns`).\n   */\n  icon?: string | null\n\n  /**\n   * The size of all the icons inside the DMG.\n   * @default 80\n   */\n  readonly iconSize?: number | null\n\n  /**\n   * The size of all the icon texts inside the DMG.\n   * @default 12\n   */\n  readonly iconTextSize?: number | null\n\n  /**\n   * The title of the produced DMG, which will be shown when mounted (volume name).\n   *\n   * Macro `${productName}`, `${version}` and `${name}` are supported.\n   * @default ${productName} ${version}\n   */\n  readonly title?: string | null\n\n  /**\n   * The content — to customize icon locations. The x and y coordinates refer to the position of the **center** of the icon (at 1x scale), and do not take the label into account.\n   */\n  contents?: Array<DmgContent>\n\n  /**\n   * The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).\n   * @default UDZO\n   */\n  format?: \"UDRW\" | \"UDRO\" | \"UDCO\" | \"UDZO\" | \"UDBZ\" | \"ULFO\"\n\n  /**\n   * The DMG window position and size. With y co-ordinates running from bottom to top.\n   *\n   * The Finder makes sure that the window will be on the user’s display, so if you want your window at the top left of the display you could use `\"x\": 0, \"y\": 100000` as the x, y co-ordinates.\n   * It is not to be possible to position the window relative to the [top left](https://github.com/electron-userland/electron-builder/issues/3990#issuecomment-512960957) or relative to the center of the user’s screen.\n   */\n  window?: DmgWindow\n\n  /**\n   * Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).\n   * @default false\n   */\n  readonly internetEnabled?: boolean\n\n  /**\n   * Whether to sign the DMG or not. Signing is not required and will lead to unwanted errors in combination with notarization requirements.\n   * @default false\n   */\n  readonly sign?: boolean\n\n  /**\n   * @private\n   * @default true\n   */\n  writeUpdateInfo?: boolean\n}\n\nexport interface DmgWindow {\n  /**\n   * The X position relative to left of the screen.\n   * @default 400\n   */\n  x?: number\n\n  /**\n   * The Y position relative to bottom of the screen.\n   * @default 100\n   */\n  y?: number\n\n  /**\n   * The width. Defaults to background image width or 540.\n   */\n  width?: number\n\n  /**\n   * The height. Defaults to background image height or 380.\n   */\n  height?: number\n}\n\nexport interface DmgContent {\n  /**\n   * The device-independent pixel offset from the left of the window to the **center** of the icon.\n   */\n  x: number\n  /**\n   * The device-independent pixel offset from the top of the window to the **center** of the icon.\n   */\n  y: number\n  type?: \"link\" | \"file\" | \"dir\"\n\n  /**\n   * The name of the file within the DMG. Defaults to basename of `path`.\n   */\n  name?: string\n\n  /**\n   * The path of the file within the DMG.\n   */\n  path?: string\n}\n\nexport interface MasConfiguration extends MacConfiguration {\n  /**\n   * The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   * Be aware that your app may crash if the right entitlements are not set like `com.apple.security.cs.allow-jit` for example on arm64 builds with Electron 20+.\n   * See [Signing and Notarizing macOS Builds from the Electron documentation](https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds) for more information.\n   */\n  readonly entitlements?: string | null\n\n  /**\n   * The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set).\n   * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n   */\n  readonly entitlementsInherit?: string | null\n\n  /**\n   * Paths of any extra binaries that need to be signed.\n   */\n  readonly binaries?: Array<string> | null\n}\n"]}

package/out/options/winOptions.d.ts

@@ -26,7 +26,7 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {
      */
     readonly signtoolOptions?: WindowsSigntoolConfiguration | null;
     /**
-     * Options for usage of Azure Trusted Signing (beta)
+     * Options for usage of Azure Trusted Signing service
      * Cannot be used in conjunction with `signtoolOptions`, signing will default to Azure Trusted Signing
      */
     readonly azureSignOptions?: WindowsAzureSigningConfiguration | null;
@@ -52,7 +52,8 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {
      */
     readonly signAndEditExecutable?: boolean;
     /**
-     * Explicit file extensions to also sign. Advanced option.
+     * Explicit file name/extensions (`str.endsWith`) to also sign. Advanced option.
+     * Supports negative patterns, e.g. example that excludes `.appx` files: `["somefilename", ".dll", "!.appx"]`.
      * @see https://github.com/electron-userland/electron-builder/issues/7329
      * @default null
      */