@electron-forge/maker-base 7.10.1 → 8.0.0-alpha.1

package/dist/Maker.d.ts

@@ -0,0 +1,102 @@
+import { ForgeArch, ForgePlatform, IForgeMaker, ResolvedForgeConfig } from '@electron-forge/shared-types';
+export type EmptyConfig = Record<string, never>;
+export interface MakerOptions {
+    /**
+     * The directory containing the packaged Electron application
+     */
+    dir: string;
+    /**
+     * The directory you should put all your artifacts in (potentially in sub folders)
+     * NOTE: this directory is not guarunteed to already exist
+     */
+    makeDir: string;
+    /**
+     * The resolved human friendly name of the project
+     */
+    appName: string;
+    /**
+     * The target platform you should make for
+     */
+    targetPlatform: ForgePlatform;
+    /**
+     * The target architecture you should make for
+     */
+    targetArch: ForgeArch;
+    /**
+     * Fully resolved forge configuration, you shouldn't really need this
+     */
+    forgeConfig: ResolvedForgeConfig;
+    /**
+     * The application's package.json file
+     */
+    packageJSON: any;
+}
+export default abstract class Maker<C> implements IForgeMaker {
+    private configOrConfigFetcher;
+    protected platformsToMakeOn?: string[] | undefined;
+    config: C;
+    abstract name: string;
+    abstract defaultPlatforms: ForgePlatform[];
+    requiredExternalBinaries: string[];
+    /** @internal */
+    __isElectronForgeMaker: true;
+    /**
+     * @param configOrConfigFetcher - Either a configuration object for this maker or a simple method that returns such a configuration for a given target architecture
+     * @param platformsToMakeOn - If you want this maker to run on platforms different from `defaultPlatforms` you can provide those platforms here
+     */
+    constructor(configOrConfigFetcher?: C | ((arch: ForgeArch) => C), platformsToMakeOn?: string[] | undefined);
+    get platforms(): ForgePlatform[];
+    prepareConfig(targetArch: ForgeArch): Promise<void>;
+    /**
+     * Makers must implement this method and return true or false indicating whether
+     * this maker can be run on the current platform.  Normally this is just a process.platform
+     * check but it can be a deeper check for dependencies like fake-root or other
+     * required external build tools.
+     *
+     * If the issue is a missing dependency you should log out a HELPFUL error message
+     * telling the developer exactly what is missing and if possible how to get it.
+     */
+    isSupportedOnCurrentPlatform(): boolean;
+    clone(): Maker<C>;
+    /**
+     * Makers must implement this method and return an array of absolute paths
+     * to the artifacts generated by your maker
+     */
+    make(opts: MakerOptions): Promise<string[]>;
+    /**
+     * Helpers
+     */
+    /**
+     * Ensures the directory exists and is forced to be empty.
+     *
+     * I.e. If the directory already exists it is deleted and recreated, this
+     * is a destructive operation
+     */
+    ensureDirectory(dir: string): Promise<void>;
+    /**
+     * Ensures the path to the file exists and the file does not exist
+     *
+     * I.e. If the file already exists it is deleted and the path created
+     */
+    ensureFile(file: string): Promise<void>;
+    /**
+     * Checks if the specified binaries exist, which are required for the maker to be used.
+     */
+    externalBinariesExist(): boolean;
+    /**
+     * Throws an error if any of the binaries don't exist.
+     */
+    ensureExternalBinariesExist(): void;
+    /**
+     * Checks if the given module is installed, used for testing if optional dependencies
+     * are installed or not
+     */
+    isInstalled(module: string): boolean;
+    /**
+     * Normalize the given semver-formatted version to a 4-part dot delimited version number without
+     * prerelease information for use in Windows apps.
+     */
+    normalizeWindowsVersion(version: string): string;
+}
+export { Maker as MakerBase };
+//# sourceMappingURL=Maker.d.ts.map

package/dist/Maker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Maker.d.ts","sourceRoot":"","sources":["../src/Maker.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,SAAS,EACT,aAAa,EACb,WAAW,EACX,mBAAmB,EACpB,MAAM,8BAA8B,CAAC;AAItC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEhD,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,mBAAmB,CAAC;IACjC;;OAEG;IACH,WAAW,EAAE,GAAG,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,KAAK,CAAC,CAAC,CAAE,YAAW,WAAW;IAiBzD,OAAO,CAAC,qBAAqB;IAC7B,SAAS,CAAC,iBAAiB,CAAC;IAjBvB,MAAM,EAAG,CAAC,CAAC;IAElB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,SAAgB,gBAAgB,EAAE,aAAa,EAAE,CAAC;IAE3C,wBAAwB,EAAE,MAAM,EAAE,CAAM;IAE/C,gBAAgB;IAChB,sBAAsB,EAAG,IAAI,CAAC;IAE9B;;;OAGG;gBAEO,qBAAqB,GAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,SAAS,KAAK,CAAC,CAAW,EAC3D,iBAAiB,CAAC,sBAAiB;IAS/C,IAAI,SAAS,IAAI,aAAa,EAAE,CAG/B;IAIK,aAAa,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAUzD;;;;;;;;OAQG;IACH,4BAA4B,IAAI,OAAO;IAYvC,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC;IAKjB;;;OAGG;IAEG,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAOjD;;OAEG;IAEH;;;;;OAKG;IACG,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjD;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7C;;OAEG;IACH,qBAAqB,IAAI,OAAO;IAMhC;;OAEG;IACH,2BAA2B,IAAI,IAAI;IAQnC;;;OAGG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAUpC;;;OAGG;IACH,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAIjD;AAED,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,CAAC"}

package/dist/Maker.js

@@ -0,0 +1,136 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MakerBase = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const which_1 = __importDefault(require("which"));
+class Maker {
+    /**
+     * @param configOrConfigFetcher - Either a configuration object for this maker or a simple method that returns such a configuration for a given target architecture
+     * @param platformsToMakeOn - If you want this maker to run on platforms different from `defaultPlatforms` you can provide those platforms here
+     */
+    constructor(configOrConfigFetcher = {}, platformsToMakeOn) {
+        this.configOrConfigFetcher = configOrConfigFetcher;
+        this.platformsToMakeOn = platformsToMakeOn;
+        this.requiredExternalBinaries = [];
+        Object.defineProperty(this, '__isElectronForgeMaker', {
+            value: true,
+            enumerable: false,
+            configurable: false,
+        });
+    }
+    get platforms() {
+        if (this.platformsToMakeOn)
+            return this.platformsToMakeOn;
+        return this.defaultPlatforms;
+    }
+    // TODO: Remove this, it is an eye-sore and is a nasty hack to provide forge
+    //       v5 style functionality in the new API
+    async prepareConfig(targetArch) {
+        if (typeof this.configOrConfigFetcher === 'function') {
+            this.config = await Promise.resolve(this.configOrConfigFetcher(targetArch));
+        }
+        else {
+            this.config = this.configOrConfigFetcher;
+        }
+    }
+    /**
+     * Makers must implement this method and return true or false indicating whether
+     * this maker can be run on the current platform.  Normally this is just a process.platform
+     * check but it can be a deeper check for dependencies like fake-root or other
+     * required external build tools.
+     *
+     * If the issue is a missing dependency you should log out a HELPFUL error message
+     * telling the developer exactly what is missing and if possible how to get it.
+     */
+    isSupportedOnCurrentPlatform() {
+        if (this.isSupportedOnCurrentPlatform ===
+            Maker.prototype.isSupportedOnCurrentPlatform) {
+            throw new Error(`Maker ${this.name} did not implement the isSupportedOnCurrentPlatform method`);
+        }
+        return true;
+    }
+    clone() {
+        const MakerClass = this.constructor;
+        return new MakerClass(this.configOrConfigFetcher, this.platformsToMakeOn);
+    }
+    /**
+     * Makers must implement this method and return an array of absolute paths
+     * to the artifacts generated by your maker
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async make(opts) {
+        if (this.make === Maker.prototype.make) {
+            throw new Error(`Maker ${this.name} did not implement the make method`);
+        }
+        return [];
+    }
+    /**
+     * Helpers
+     */
+    /**
+     * Ensures the directory exists and is forced to be empty.
+     *
+     * I.e. If the directory already exists it is deleted and recreated, this
+     * is a destructive operation
+     */
+    async ensureDirectory(dir) {
+        if (await fs_extra_1.default.pathExists(dir)) {
+            await fs_extra_1.default.remove(dir);
+        }
+        return fs_extra_1.default.mkdirs(dir);
+    }
+    /**
+     * Ensures the path to the file exists and the file does not exist
+     *
+     * I.e. If the file already exists it is deleted and the path created
+     */
+    async ensureFile(file) {
+        if (await fs_extra_1.default.pathExists(file)) {
+            await fs_extra_1.default.remove(file);
+        }
+        await fs_extra_1.default.mkdirs(node_path_1.default.dirname(file));
+    }
+    /**
+     * Checks if the specified binaries exist, which are required for the maker to be used.
+     */
+    externalBinariesExist() {
+        return this.requiredExternalBinaries.every((binary) => which_1.default.sync(binary, { nothrow: true }) !== null);
+    }
+    /**
+     * Throws an error if any of the binaries don't exist.
+     */
+    ensureExternalBinariesExist() {
+        if (!this.externalBinariesExist()) {
+            throw new Error(`Cannot make for ${this.name}, the following external binaries need to be installed: ${this.requiredExternalBinaries.join(', ')}`);
+        }
+    }
+    /**
+     * Checks if the given module is installed, used for testing if optional dependencies
+     * are installed or not
+     */
+    isInstalled(module) {
+        try {
+            require(module);
+            return true;
+        }
+        catch {
+            // Package doesn't exist -- must not be installable on this platform
+            return false;
+        }
+    }
+    /**
+     * Normalize the given semver-formatted version to a 4-part dot delimited version number without
+     * prerelease information for use in Windows apps.
+     */
+    normalizeWindowsVersion(version) {
+        const noPrerelease = version.replace(/[-+].*/, '');
+        return `${noPrerelease}.0`;
+    }
+}
+exports.default = Maker;
+exports.MakerBase = Maker;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiTWFrZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvTWFrZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsMERBQTZCO0FBUTdCLHdEQUEwQjtBQUMxQixrREFBMEI7QUFvQzFCLE1BQThCLEtBQUs7SUFZakM7OztPQUdHO0lBQ0gsWUFDVSx3QkFBc0QsRUFBTyxFQUMzRCxpQkFBbUM7UUFEckMsMEJBQXFCLEdBQXJCLHFCQUFxQixDQUF3QztRQUMzRCxzQkFBaUIsR0FBakIsaUJBQWlCLENBQWtCO1FBWHhDLDZCQUF3QixHQUFhLEVBQUUsQ0FBQztRQWE3QyxNQUFNLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSx3QkFBd0IsRUFBRTtZQUNwRCxLQUFLLEVBQUUsSUFBSTtZQUNYLFVBQVUsRUFBRSxLQUFLO1lBQ2pCLFlBQVksRUFBRSxLQUFLO1NBQ3BCLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRCxJQUFJLFNBQVM7UUFDWCxJQUFJLElBQUksQ0FBQyxpQkFBaUI7WUFBRSxPQUFPLElBQUksQ0FBQyxpQkFBaUIsQ0FBQztRQUMxRCxPQUFPLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQztJQUMvQixDQUFDO0lBRUQsNEVBQTRFO0lBQzVFLDhDQUE4QztJQUM5QyxLQUFLLENBQUMsYUFBYSxDQUFDLFVBQXFCO1FBQ3ZDLElBQUksT0FBTyxJQUFJLENBQUMscUJBQXFCLEtBQUssVUFBVSxFQUFFLENBQUM7WUFDckQsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLE9BQU8sQ0FBQyxPQUFPLENBQ2hDLElBQUksQ0FBQyxxQkFBZ0QsQ0FBQyxVQUFVLENBQUMsQ0FDbkUsQ0FBQztRQUNKLENBQUM7YUFBTSxDQUFDO1lBQ04sSUFBSSxDQUFDLE1BQU0sR0FBRyxJQUFJLENBQUMscUJBQTBCLENBQUM7UUFDaEQsQ0FBQztJQUNILENBQUM7SUFFRDs7Ozs7Ozs7T0FRRztJQUNILDRCQUE0QjtRQUMxQixJQUNFLElBQUksQ0FBQyw0QkFBNEI7WUFDakMsS0FBSyxDQUFDLFNBQVMsQ0FBQyw0QkFBNEIsRUFDNUMsQ0FBQztZQUNELE1BQU0sSUFBSSxLQUFLLENBQ2IsU0FBUyxJQUFJLENBQUMsSUFBSSw0REFBNEQsQ0FDL0UsQ0FBQztRQUNKLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRCxLQUFLO1FBQ0gsTUFBTSxVQUFVLEdBQUksSUFBWSxDQUFDLFdBQVcsQ0FBQztRQUM3QyxPQUFPLElBQUksVUFBVSxDQUFDLElBQUksQ0FBQyxxQkFBcUIsRUFBRSxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUM1RSxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsNkRBQTZEO0lBQzdELEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBa0I7UUFDM0IsSUFBSSxJQUFJLENBQUMsSUFBSSxLQUFLLEtBQUssQ0FBQyxTQUFTLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDdkMsTUFBTSxJQUFJLEtBQUssQ0FBQyxTQUFTLElBQUksQ0FBQyxJQUFJLG9DQUFvQyxDQUFDLENBQUM7UUFDMUUsQ0FBQztRQUNELE9BQU8sRUFBRSxDQUFDO0lBQ1osQ0FBQztJQUVEOztPQUVHO0lBRUg7Ozs7O09BS0c7SUFDSCxLQUFLLENBQUMsZUFBZSxDQUFDLEdBQVc7UUFDL0IsSUFBSSxNQUFNLGtCQUFFLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDN0IsTUFBTSxrQkFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUN2QixDQUFDO1FBQ0QsT0FBTyxrQkFBRSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUN4QixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILEtBQUssQ0FBQyxVQUFVLENBQUMsSUFBWTtRQUMzQixJQUFJLE1BQU0sa0JBQUUsQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUM5QixNQUFNLGtCQUFFLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3hCLENBQUM7UUFDRCxNQUFNLGtCQUFFLENBQUMsTUFBTSxDQUFDLG1CQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQUVEOztPQUVHO0lBQ0gscUJBQXFCO1FBQ25CLE9BQU8sSUFBSSxDQUFDLHdCQUF3QixDQUFDLEtBQUssQ0FDeEMsQ0FBQyxNQUFNLEVBQUUsRUFBRSxDQUFDLGVBQUssQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLEVBQUUsT0FBTyxFQUFFLElBQUksRUFBRSxDQUFDLEtBQUssSUFBSSxDQUMzRCxDQUFDO0lBQ0osQ0FBQztJQUVEOztPQUVHO0lBQ0gsMkJBQTJCO1FBQ3pCLElBQUksQ0FBQyxJQUFJLENBQUMscUJBQXFCLEVBQUUsRUFBRSxDQUFDO1lBQ2xDLE1BQU0sSUFBSSxLQUFLLENBQ2IsbUJBQW1CLElBQUksQ0FBQyxJQUFJLDJEQUEyRCxJQUFJLENBQUMsd0JBQXdCLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQ2xJLENBQUM7UUFDSixDQUFDO0lBQ0gsQ0FBQztJQUVEOzs7T0FHRztJQUNILFdBQVcsQ0FBQyxNQUFjO1FBQ3hCLElBQUksQ0FBQztZQUNILE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUNoQixPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7UUFBQyxNQUFNLENBQUM7WUFDUCxvRUFBb0U7WUFDcEUsT0FBTyxLQUFLLENBQUM7UUFDZixDQUFDO0lBQ0gsQ0FBQztJQUVEOzs7T0FHRztJQUNILHVCQUF1QixDQUFDLE9BQWU7UUFDckMsTUFBTSxZQUFZLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDbkQsT0FBTyxHQUFHLFlBQVksSUFBSSxDQUFDO0lBQzdCLENBQUM7Q0FDRjtBQXpKRCx3QkF5SkM7QUFFaUIsMEJBQVMifQ==

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@electron-forge/maker-base",
-  "version": "7.10.1",
+  "version": "8.0.0-alpha.1",
   "description": "Base maker for Electron Forge",
   "repository": "https://github.com/electron/forge",
   "author": "Samuel Attard",
@@ -14,7 +14,7 @@
     "node": ">= 16.4.0"
   },
   "dependencies": {
-    "@electron-forge/shared-types": "7.10.1",
+    "@electron-forge/shared-types": "8.0.0-alpha.1",
     "fs-extra": "^10.0.0",
     "which": "^2.0.2"
   },
@@ -25,5 +25,5 @@
     "dist",
     "src"
   ],
-  "gitHead": "a9c9eb7b8476e9c4bbcc4ef80f0ac16166effe94"
+  "gitHead": "b9e0db1e38fafbeace24f539be01e32a4aeed258"
 }