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

package/dist/Publisher.d.ts

@@ -0,0 +1,51 @@
+import { ForgeListrTaskDefinition, ForgeMakeResult, ForgePlatform, IForgePublisher, ResolvedForgeConfig } from '@electron-forge/shared-types';
+export interface PublisherOptions {
+    /**
+     * The base directory of the apps source code
+     */
+    dir: string;
+    /**
+     * The results from running the make command
+     */
+    makeResults: ForgeMakeResult[];
+    /**
+     * The raw forgeConfig this app is using.
+     *
+     * You probably shouldn't use this
+     */
+    forgeConfig: ResolvedForgeConfig;
+    /**
+     * A method that allows the publisher to provide status / progress updates
+     * to the user. This method currently maps to setting the "output" line
+     * in the publisher listr task.
+     */
+    setStatusLine: (statusLine: string) => void;
+}
+export default abstract class Publisher<C> implements IForgePublisher {
+    config: C;
+    protected platformsToPublishOn?: string[] | undefined;
+    abstract name: string;
+    defaultPlatforms?: ForgePlatform[];
+    /** @internal */
+    __isElectronForgePublisher: true;
+    /**
+     * @param config - A configuration object for this publisher
+     * @param platformsToPublishOn - If you want this maker to run on platforms different from `defaultPlatforms` you can provide those platforms here
+     */
+    constructor(config: C, platformsToPublishOn?: string[] | undefined);
+    get platforms(): ForgePlatform[];
+    /**
+     * Publishers must implement this method to publish the artifacts returned from
+     * make calls.  If any errors occur you must throw them, failing silently or simply
+     * logging will not propagate issues up to forge.
+     *
+     * Please note for a given version publish will be called multiple times, once
+     * for each set of "platform" and "arch".  This means if you are publishing
+     * darwin and win32 artifacts to somewhere like GitHub on the first publish call
+     * you will have to create the version on GitHub and the second call will just
+     * be appending files to the existing version.
+     */
+    publish(_opts: PublisherOptions): Promise<ForgeListrTaskDefinition[] | void>;
+}
+export { Publisher as PublisherBase };
+//# sourceMappingURL=Publisher.d.ts.map

package/dist/Publisher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Publisher.d.ts","sourceRoot":"","sources":["../src/Publisher.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,eAAe,EACf,aAAa,EACb,eAAe,EACf,mBAAmB,EACpB,MAAM,8BAA8B,CAAC;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B;;;;OAIG;IACH,WAAW,EAAE,mBAAmB,CAAC;IACjC;;;;OAIG;IACH,aAAa,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7C;AAED,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,SAAS,CAAC,CAAC,CAAE,YAAW,eAAe;IAa1D,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,oBAAoB,CAAC;IAbjC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAEtB,gBAAgB,CAAC,EAAE,aAAa,EAAE,CAAC;IAE1C,gBAAgB;IAChB,0BAA0B,EAAG,IAAI,CAAC;IAElC;;;OAGG;gBAEM,MAAM,EAAE,CAAC,EACN,oBAAoB,CAAC,sBAAiB;IAUlD,IAAI,SAAS,IAAI,aAAa,EAAE,CAI/B;IAED;;;;;;;;;;OAUG;IACG,OAAO,CACX,KAAK,EAAE,gBAAgB,GACtB,OAAO,CAAC,wBAAwB,EAAE,GAAG,IAAI,CAAC;CAK9C;AAED,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,CAAC"}

package/dist/Publisher.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublisherBase = void 0;
+class Publisher {
+    /**
+     * @param config - A configuration object for this publisher
+     * @param platformsToPublishOn - If you want this maker to run on platforms different from `defaultPlatforms` you can provide those platforms here
+     */
+    constructor(config, platformsToPublishOn) {
+        this.config = config;
+        this.platformsToPublishOn = platformsToPublishOn;
+        this.config = config;
+        Object.defineProperty(this, '__isElectronForgePublisher', {
+            value: true,
+            enumerable: false,
+            configurable: false,
+        });
+    }
+    get platforms() {
+        if (this.platformsToPublishOn)
+            return this.platformsToPublishOn;
+        if (this.defaultPlatforms)
+            return this.defaultPlatforms;
+        return ['win32', 'linux', 'darwin', 'mas'];
+    }
+    /**
+     * Publishers must implement this method to publish the artifacts returned from
+     * make calls.  If any errors occur you must throw them, failing silently or simply
+     * logging will not propagate issues up to forge.
+     *
+     * Please note for a given version publish will be called multiple times, once
+     * for each set of "platform" and "arch".  This means if you are publishing
+     * darwin and win32 artifacts to somewhere like GitHub on the first publish call
+     * you will have to create the version on GitHub and the second call will just
+     * be appending files to the existing version.
+     */
+    async publish(_opts) {
+        throw new Error(`Publisher ${this.name} did not implement the publish method`);
+    }
+}
+exports.default = Publisher;
+exports.PublisherBase = Publisher;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUHVibGlzaGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL1B1Ymxpc2hlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUErQkEsTUFBOEIsU0FBUztJQVFyQzs7O09BR0c7SUFDSCxZQUNTLE1BQVMsRUFDTixvQkFBc0M7UUFEekMsV0FBTSxHQUFOLE1BQU0sQ0FBRztRQUNOLHlCQUFvQixHQUFwQixvQkFBb0IsQ0FBa0I7UUFFaEQsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7UUFDckIsTUFBTSxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUUsNEJBQTRCLEVBQUU7WUFDeEQsS0FBSyxFQUFFLElBQUk7WUFDWCxVQUFVLEVBQUUsS0FBSztZQUNqQixZQUFZLEVBQUUsS0FBSztTQUNwQixDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQsSUFBSSxTQUFTO1FBQ1gsSUFBSSxJQUFJLENBQUMsb0JBQW9CO1lBQUUsT0FBTyxJQUFJLENBQUMsb0JBQW9CLENBQUM7UUFDaEUsSUFBSSxJQUFJLENBQUMsZ0JBQWdCO1lBQUUsT0FBTyxJQUFJLENBQUMsZ0JBQWdCLENBQUM7UUFDeEQsT0FBTyxDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsUUFBUSxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQzdDLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0gsS0FBSyxDQUFDLE9BQU8sQ0FDWCxLQUF1QjtRQUV2QixNQUFNLElBQUksS0FBSyxDQUNiLGFBQWEsSUFBSSxDQUFDLElBQUksdUNBQXVDLENBQzlELENBQUM7SUFDSixDQUFDO0NBQ0Y7QUFoREQsNEJBZ0RDO0FBRXFCLGtDQUFhIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@electron-forge/publisher-base",
-  "version": "7.10.1",
+  "version": "8.0.0-alpha.1",
   "description": "Base publisher for Electron Forge",
   "repository": "https://github.com/electron/forge",
   "author": "Samuel Attard",
@@ -8,7 +8,7 @@
   "main": "dist/Publisher.js",
   "typings": "dist/Publisher.d.ts",
   "dependencies": {
-    "@electron-forge/shared-types": "7.10.1"
+    "@electron-forge/shared-types": "8.0.0-alpha.1"
   },
   "devDependencies": {
     "vitest": "^3.1.3"
@@ -23,5 +23,5 @@
     "dist",
     "src"
   ],
-  "gitHead": "a9c9eb7b8476e9c4bbcc4ef80f0ac16166effe94"
+  "gitHead": "b9e0db1e38fafbeace24f539be01e32a4aeed258"
 }