@electron-forge/shared-types 6.0.0-beta.59 → 6.0.0-beta.62

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { ChildProcess } from 'child_process';
 import { ArchOption, Options, TargetPlatform } from 'electron-packager';
-import { RebuildOptions } from 'electron-rebuild/lib/src/rebuild';
+import { RebuildOptions } from 'electron-rebuild';
 export declare type ElectronProcess = ChildProcess & {
     restarted: boolean;
 };
@@ -12,27 +12,27 @@ export declare type ForgeConfigPublisher = IForgeResolvablePublisher | IForgePub
 export interface IForgePluginInterface {
     triggerHook(hookName: string, hookArgs: any[]): Promise<void>;
     triggerMutatingHook<T>(hookName: string, item: T): Promise<any>;
-    overrideStartLogic(opts: any): Promise<ElectronProcess | string | string[] | false>;
+    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]
      */
-    plugins: (IForgePlugin | [string, any])[];
+    plugins: (IForgePlugin | [string, Record<string, unknown>])[];
     electronRebuildConfig: Partial<RebuildOptions>;
     packagerConfig: Partial<Options>;
     makers: (IForgeResolvableMaker | IForgeMaker)[];
@@ -61,7 +61,7 @@ export interface IForgePlugin {
     name: string;
     init(dir: string, forgeConfig: ForgeConfig): void;
     getHook?(hookName: string): ForgeHookFn | null;
-    startLogic?(opts: StartOptions): Promise<ElectronProcess | string | string[] | false>;
+    startLogic?(opts: StartOptions): Promise<StartResult>;
 }
 export interface IForgeResolvableMaker {
     name: string;
@@ -111,13 +111,15 @@ 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) => void;
+    initializeTemplate?: (dir: string, options: InitTemplateOptions) => Promise<void>;
 }
 export declare type PackagePerson = undefined | string | {
     name: string;

package/index.d.ts

@@ -1,38 +1,41 @@
 import { ChildProcess } from 'child_process';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { ArchOption, Options, TargetPlatform } from 'electron-packager';
-import { RebuildOptions } from 'electron-rebuild/lib/src/rebuild';
+import { RebuildOptions } from 'electron-rebuild';
 
 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: any): Promise<ElectronProcess | string | string[] | false>;
+  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 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]
    */
-  plugins: (IForgePlugin | [string, any])[];
+  plugins: (IForgePlugin | [string, Record<string, unknown>])[];
   electronRebuildConfig: Partial<RebuildOptions>;
   packagerConfig: Partial<Options>;
   makers: (IForgeResolvableMaker | IForgeMaker)[];
@@ -46,7 +49,7 @@ export interface ForgeMakeResult {
   /**
    * The state of the package.json file when the make happened
    */
-  packageJSON: any;
+  packageJSON: any; // eslint-disable-line @typescript-eslint/no-explicit-any
   /**
    * The platform this make run was for
    */
@@ -63,13 +66,13 @@ export interface IForgePlugin {
 
   init(dir: string, forgeConfig: ForgeConfig): void;
   getHook?(hookName: string): ForgeHookFn | null;
-  startLogic?(opts: StartOptions): Promise<ElectronProcess | string | string[] | false>;
+  startLogic?(opts: StartOptions): Promise<StartResult>;
 }
 
 export interface IForgeResolvableMaker {
   name: string;
   platforms: ForgePlatform[] | null;
-  config: any;
+  config: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 }
 
 export interface IForgeMaker {
@@ -80,7 +83,7 @@ export interface IForgeMaker {
 export interface IForgeResolvablePublisher {
   name: string;
   platforms?: ForgePlatform[] | null;
-  config?: any;
+  config?: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 }
 
 export interface IForgePublisher {
@@ -119,18 +122,24 @@ export interface StartOptions {
   inspect?: boolean;
 }
 
+export 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) => void;
+  initializeTemplate?: (dir: string, options: InitTemplateOptions) => Promise<void>;
 }
 
-export type PackagePerson = undefined | string | {
-  name: string;
-  email?: string;
-  url?: string;
-};
+export type PackagePerson =
+  | undefined
+  | string
+  | {
+      name: string;
+      email?: string;
+      url?: string;
+    };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@electron-forge/shared-types",
-  "version": "6.0.0-beta.59",
+  "version": "6.0.0-beta.62",
   "description": "Shared types across Electron Forge",
   "repository": "https://github.com/electron-userland/electron-forge",
   "author": "Samuel Attard",
@@ -8,9 +8,9 @@
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "dependencies": {
-    "@electron-forge/async-ora": "6.0.0-beta.59",
-    "electron-packager": "^15.0.0",
-    "electron-rebuild": "^2.3.2",
+    "@electron-forge/async-ora": "6.0.0-beta.62",
+    "electron-packager": "^15.4.0",
+    "electron-rebuild": "^3.2.6",
     "ora": "^5.0.0"
   },
   "engines": {