@electron-forge/shared-types 6.0.0-beta.6 → 6.0.0-beta.63

package/dist/index.d.ts

@@ -1,38 +1,42 @@
 /// <reference types="node" />
-/// <reference types="electron-packager" />
 import { ChildProcess } from 'child_process';
-import { Options } from 'electron-packager';
-import { RebuildOptions } from 'electron-rebuild/lib/src/rebuild';
-export declare type ForgePlatform = 'darwin' | 'mas' | 'win32' | 'linux';
-export declare type ForgeArch = 'ia32' | 'x64' | 'armv7l' | 'arm';
-export declare type ForgeHookFn = (forgeConfig: ForgeConfig, ...args: any[]) => Promise<void>;
+import { ArchOption, Options, TargetPlatform } from 'electron-packager';
+import { RebuildOptions } from 'electron-rebuild';
+export declare type ElectronProcess = ChildProcess & {
+    restarted: boolean;
+};
+export declare type ForgePlatform = TargetPlatform;
+export declare type ForgeArch = ArchOption;
+export declare type ForgeHookFn = (forgeConfig: ForgeConfig, ...args: any[]) => Promise<any>;
+export declare type ForgeConfigPublisher = IForgeResolvablePublisher | IForgePublisher | string;
 export interface IForgePluginInterface {
     triggerHook(hookName: string, hookArgs: any[]): Promise<void>;
-    overrideStartLogic(opts: any): Promise<ChildProcess | false>;
+    triggerMutatingHook<T>(hookName: string, item: T): Promise<any>;
+    overrideStartLogic(opts: StartOptions): Promise<StartResult>;
 }
 export interface ForgeConfig {
     /**
      * A string to uniquely identify artifacts of this build, will be appended
      * to the out dir to generate a nested directory.  E.g. out/current-timestamp
      *
-     * If a function is provided it must syncronously return the buildIdentifier
+     * If a function is provided, it must synchronously return the buildIdentifier
      */
     buildIdentifier?: string | (() => string);
     hooks?: {
         [hookName: string]: ForgeHookFn;
     };
     /**
-     * @generated
+     * @internal
      */
     pluginInterface: IForgePluginInterface;
     /**
-     * An array of forge plugins or a tuple consisting of [pluginName, pluginOptions]
+     * An array of Forge plugins or a tuple consisting of [pluginName, pluginOptions]
      */
-    plugins: (IForgePlugin | [string, any])[];
-    electronRebuildConfig: RebuildOptions;
-    packagerConfig: Options;
+    plugins: (IForgePlugin | [string, Record<string, unknown>])[];
+    electronRebuildConfig: Partial<RebuildOptions>;
+    packagerConfig: Partial<Options>;
     makers: (IForgeResolvableMaker | IForgeMaker)[];
-    publishers: (IForgeResolvablePublisher | IForgePublisher | string)[];
+    publishers: ForgeConfigPublisher[];
 }
 export interface ForgeMakeResult {
     /**
@@ -57,7 +61,7 @@ export interface IForgePlugin {
     name: string;
     init(dir: string, forgeConfig: ForgeConfig): void;
     getHook?(hookName: string): ForgeHookFn | null;
-    startLogic?(opts: StartOptions): Promise<ChildProcess | false>;
+    startLogic?(opts: StartOptions): Promise<StartResult>;
 }
 export interface IForgeResolvableMaker {
     name: string;
@@ -66,7 +70,7 @@ export interface IForgeResolvableMaker {
 }
 export interface IForgeMaker {
     __isElectronForgeMaker: boolean;
-    platforms?: undefined;
+    readonly platforms?: ForgePlatform[];
 }
 export interface IForgeResolvablePublisher {
     name: string;
@@ -75,7 +79,7 @@ export interface IForgeResolvablePublisher {
 }
 export interface IForgePublisher {
     __isElectronForgePublisher: boolean;
-    platforms?: undefined;
+    readonly platforms?: ForgePlatform[];
 }
 export interface StartOptions {
     /**
@@ -107,3 +111,18 @@ export interface StartOptions {
      */
     inspect?: boolean;
 }
+export declare type StartResult = ElectronProcess | string | string[] | false;
+export interface InitTemplateOptions {
+    copyCIFiles?: boolean;
+}
+export interface ForgeTemplate {
+    requiredForgeVersion?: string;
+    dependencies?: string[];
+    devDependencies?: string[];
+    initializeTemplate?: (dir: string, options: InitTemplateOptions) => Promise<void>;
+}
+export declare type PackagePerson = undefined | string | {
+    name: string;
+    email?: string;
+    url?: string;
+};

package/index.d.ts

@@ -1,119 +1,145 @@
-/* tslint:disable ter-indent */
-
 import { ChildProcess } from 'child_process';
-import { Options } from 'electron-packager';
-import { RebuildOptions } from 'electron-rebuild/lib/src/rebuild';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { ArchOption, Options, TargetPlatform } from 'electron-packager';
+import { RebuildOptions } from 'electron-rebuild';
 
-declare module '@electron-forge/shared-types' {
-  export type ForgePlatform = 'darwin' | 'mas' | 'win32' | 'linux';
-  export type ForgeArch = 'ia32' | 'x64' | 'armv7l' | 'arm'; 
-  export type ForgeHookFn = (forgeConfig: ForgeConfig, ...args: any[]) => Promise<void>;
-  export interface IForgePluginInterface {
-    triggerHook(hookName: string, hookArgs: any[]): Promise<void>;
-    overrideStartLogic(opts: any): Promise<ChildProcess | false>;
-  }
-  export interface ForgeConfig {
-    /**
-     * A string to uniquely identify artifacts of this build, will be appended
-     * to the out dir to generate a nested directory.  E.g. out/current-timestamp
-     * 
-     * If a function is provided it must syncronously return the buildIdentifier
-     */
-    buildIdentifier?: string | (() => string);
-    hooks?: {
-      [hookName: string]: ForgeHookFn;
-    };
-    /**
-     * @generated
-     */
-    pluginInterface: IForgePluginInterface;
-    /**
-     * An array of forge plugins or a tuple consisting of [pluginName, pluginOptions]
-     */
-    plugins: (IForgePlugin | [string, any])[];
-    electronRebuildConfig: RebuildOptions;
-    packagerConfig: Options;
-    makers: (IForgeResolvableMaker | IForgeMaker)[];
-    publishers: (IForgeResolvablePublisher | IForgePublisher | string)[];
-  }
-  export interface ForgeMakeResult {
-    /**
-     * An array of paths to artifacts generated for this make run
-     */
-    artifacts: string[];
-    /**
-     * The state of the package.json file when the make happened
-     */
-    packageJSON: any;
-    /**
-     * The platform this make run was for
-     */
-    platform: ForgePlatform;
-    /**
-     * The arch this make run was for
-     */
-    arch: ForgeArch;
-  }
+export type ElectronProcess = ChildProcess & { restarted: boolean };
+
+export type ForgePlatform = TargetPlatform;
+export type ForgeArch = ArchOption;
+// Why: hooks have any number/kind of args/return values
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export type ForgeHookFn = (forgeConfig: ForgeConfig, ...args: any[]) => Promise<any>;
+export type ForgeConfigPublisher = IForgeResolvablePublisher | IForgePublisher | string;
+export interface IForgePluginInterface {
+  triggerHook(hookName: string, hookArgs: any[]): Promise<void>;
+  triggerMutatingHook<T>(hookName: string, item: T): Promise<any>;
+  overrideStartLogic(opts: StartOptions): Promise<StartResult>;
+}
+/* eslint-enable @typescript-eslint/no-explicit-any */
+export interface ForgeConfig {
+  /**
+   * A string to uniquely identify artifacts of this build, will be appended
+   * to the out dir to generate a nested directory.  E.g. out/current-timestamp
+   *
+   * If a function is provided, it must synchronously return the buildIdentifier
+   */
+  buildIdentifier?: string | (() => string);
+  hooks?: {
+    [hookName: string]: ForgeHookFn;
+  };
+  /**
+   * @internal
+   */
+  pluginInterface: IForgePluginInterface;
+  /**
+   * An array of Forge plugins or a tuple consisting of [pluginName, pluginOptions]
+   */
+  plugins: (IForgePlugin | [string, Record<string, unknown>])[];
+  electronRebuildConfig: Partial<RebuildOptions>;
+  packagerConfig: Partial<Options>;
+  makers: (IForgeResolvableMaker | IForgeMaker)[];
+  publishers: ForgeConfigPublisher[];
+}
+export interface ForgeMakeResult {
+  /**
+   * An array of paths to artifacts generated for this make run
+   */
+  artifacts: string[];
+  /**
+   * The state of the package.json file when the make happened
+   */
+  packageJSON: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+  /**
+   * The platform this make run was for
+   */
+  platform: ForgePlatform;
+  /**
+   * The arch this make run was for
+   */
+  arch: ForgeArch;
+}
+
+export interface IForgePlugin {
+  __isElectronForgePlugin: boolean;
+  name: string;
+
+  init(dir: string, forgeConfig: ForgeConfig): void;
+  getHook?(hookName: string): ForgeHookFn | null;
+  startLogic?(opts: StartOptions): Promise<StartResult>;
+}
 
-  export interface IForgePlugin {
-    __isElectronForgePlugin: boolean;
-    name: string;
+export interface IForgeResolvableMaker {
+  name: string;
+  platforms: ForgePlatform[] | null;
+  config: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+}
 
-    init(dir: string, forgeConfig: ForgeConfig): void;
-    getHook?(hookName: string): ForgeHookFn | null;
-    startLogic?(opts: StartOptions): Promise<ChildProcess | false>;
-  }
+export interface IForgeMaker {
+  __isElectronForgeMaker: boolean;
+  readonly platforms?: ForgePlatform[];
+}
 
-  export interface IForgeResolvableMaker {
-    name: string;
-    platforms: ForgePlatform[] | null;
-    config: any;
-  }
+export interface IForgeResolvablePublisher {
+  name: string;
+  platforms?: ForgePlatform[] | null;
+  config?: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+}
 
-  export interface IForgeMaker {
-    __isElectronForgeMaker: boolean;
-    platforms?: undefined;
-  }
+export interface IForgePublisher {
+  __isElectronForgePublisher: boolean;
+  readonly platforms?: ForgePlatform[];
+}
 
-  export interface IForgeResolvablePublisher {
-    name: string;
-    platforms?: ForgePlatform[] | null;
-    config?: any;
-  }
+export interface StartOptions {
+  /**
+   * The path to the electron forge project to run
+   */
+  dir?: string;
+  /**
+   * The path (relative to dir) to the electron app to run relative to the project directory
+   */
+  appPath?: string;
+  /**
+   * Whether to use sensible defaults or prompt the user visually
+   */
+  interactive?: boolean;
+  /**
+   * Enables advanced internal Electron debug calls
+   */
+  enableLogging?: boolean;
+  /**
+   * Arguments to pass through to the launched Electron application
+   */
+  args?: (string | number)[];
+  /**
+   * Runs the Electron process as if it were node, disables all Electron API's
+   */
+  runAsNode?: boolean;
+  /**
+   * Enables the node inspector, you can connect to this from chrome://inspect
+   */
+  inspect?: boolean;
+}
 
-  export interface IForgePublisher {
-    __isElectronForgePublisher: boolean;
-    platforms?: undefined;
-  }
+export type StartResult = ElectronProcess | string | string[] | false;
 
-  export interface StartOptions {
-    /**
-     * The path to the electron forge project to run
-     */
-    dir?: string;
-    /**
-     * The path (relative to dir) to the electron app to run relative to the project directory
-     */
-    appPath?: string;
-    /**
-     * Whether to use sensible defaults or prompt the user visually
-     */
-    interactive?: boolean;
-    /**
-     * Enables advanced internal Electron debug calls
-     */
-    enableLogging?: boolean;
-    /**
-     * Arguments to pass through to the launched Electron application
-     */
-    args?: (string | number)[];
-    /**
-     * Runs the Electron process as if it were node, disables all Electron API's
-     */
-    runAsNode?: boolean;
-    /**
-     * Enables the node inspector, you can connect to this from chrome://inspect
-     */
-    inspect?: boolean;
-  }
+export interface InitTemplateOptions {
+  copyCIFiles?: boolean;
 }
+
+export interface ForgeTemplate {
+  requiredForgeVersion?: string;
+  dependencies?: string[];
+  devDependencies?: string[];
+  initializeTemplate?: (dir: string, options: InitTemplateOptions) => Promise<void>;
+}
+
+export type PackagePerson =
+  | undefined
+  | string
+  | {
+      name: string;
+      email?: string;
+      url?: string;
+    };

package/package.json

@@ -1,21 +1,19 @@
 {
   "name": "@electron-forge/shared-types",
-  "version": "6.0.0-beta.6",
-  "description": "Shared types across forge",
+  "version": "6.0.0-beta.63",
+  "description": "Shared types across Electron Forge",
   "repository": "https://github.com/electron-userland/electron-forge",
   "author": "Samuel Attard",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "index.d.ts",
-  "scripts": {
-    "test": "echo No Tests For Shared Types"
-  },
   "dependencies": {
-    "@types/electron-packager": "^10.1.0",
-    "electron-rebuild": "^1.6.0",
-    "ora": "^2.0.0"
+    "@electron-forge/async-ora": "6.0.0-beta.63",
+    "electron-packager": "^15.4.0",
+    "electron-rebuild": "^3.2.6",
+    "ora": "^5.0.0"
   },
   "engines": {
-    "node": ">= 6.0"
+    "node": ">= 12.13.0"
   }
 }

package/tsconfig.json

@@ -1,23 +1,27 @@
 {
-	"compilerOptions": {
-		"module": "commonjs",
-		"target": "es6",
-		"outDir": "dist",
-		"lib": [
-			"es6",
-			"dom",
-			"es7"
-		],
-		"sourceMap": true,
-		"rootDir": "src",
-		"experimentalDecorators": true,
-		"strict": true,
-		"esModuleInterop": true,
-		"declaration": true
-	},
-	"exclude": [
-		"node_modules",
-		"dist",
-		"test"
-	]
-}
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2019",
+    "outDir": "dist",
+    "lib": [
+      "dom",
+      "es2019"
+    ],
+    "sourceMap": true,
+    "rootDir": ".",
+    "experimentalDecorators": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "typeRoots": [
+      "../../../node_modules/@types",
+      "../../../typings"
+    ]
+  },
+  "exclude": [
+    "node_modules",
+    "dist",
+    "test",
+    "index.ts"
+  ]
+}