@electron-forge/shared-types 7.6.0 → 7.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +24 -24
- package/dist/index.d.ts.map +1 -1
- package/package.json +3 -3
- package/src/index.ts +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { ChildProcess } from 'child_process';
|
|
3
|
-
import { autoTrace } from '@electron-forge/tracer';
|
|
2
|
+
import { ChildProcess } from 'node:child_process';
|
|
4
3
|
import { ArchOption, Options as ElectronPackagerOptions, TargetPlatform } from '@electron/packager';
|
|
5
4
|
import { RebuildOptions } from '@electron/rebuild';
|
|
5
|
+
import { autoTrace } from '@electron-forge/tracer';
|
|
6
6
|
import { ListrBaseClassOptions, ListrDefaultRenderer, ListrDefaultRendererValue, ListrSimpleRenderer, ListrSimpleRendererValue, ListrTask, ListrTaskWrapper } from 'listr2';
|
|
7
|
-
export
|
|
8
|
-
export
|
|
9
|
-
export
|
|
10
|
-
export
|
|
7
|
+
export type ForgeListrOptions<T> = ListrBaseClassOptions<T, ListrDefaultRendererValue, ListrSimpleRendererValue>;
|
|
8
|
+
export type ForgeListrTask<T> = ListrTaskWrapper<T, ListrDefaultRenderer, ListrDefaultRenderer | ListrSimpleRenderer>;
|
|
9
|
+
export type ForgeListrTaskFn<Ctx = any> = ListrTask<Ctx, ListrDefaultRenderer>['task'];
|
|
10
|
+
export type ElectronProcess = ChildProcess & {
|
|
11
11
|
restarted: boolean;
|
|
12
12
|
};
|
|
13
|
-
export
|
|
14
|
-
export
|
|
15
|
-
export
|
|
16
|
-
export
|
|
17
|
-
export
|
|
13
|
+
export type ForgePlatform = TargetPlatform;
|
|
14
|
+
export type ForgeArch = ArchOption;
|
|
15
|
+
export type ForgeConfigPublisher = IForgeResolvablePublisher | IForgePublisher;
|
|
16
|
+
export type ForgeConfigMaker = IForgeResolvableMaker | IForgeMaker;
|
|
17
|
+
export type ForgeConfigPlugin = IForgeResolvablePlugin | IForgePlugin;
|
|
18
18
|
export interface ForgeSimpleHookSignatures {
|
|
19
19
|
generateAssets: [platform: ForgePlatform, version: ForgeArch];
|
|
20
20
|
preStart: [];
|
|
@@ -37,14 +37,14 @@ export interface ForgeMutatingHookSignatures {
|
|
|
37
37
|
resolveForgeConfig: [currentConfig: ResolvedForgeConfig];
|
|
38
38
|
readPackageJson: [packageJson: Record<string, any>];
|
|
39
39
|
}
|
|
40
|
-
export
|
|
41
|
-
export
|
|
42
|
-
export
|
|
43
|
-
export
|
|
44
|
-
export
|
|
40
|
+
export type ForgeHookName = keyof (ForgeSimpleHookSignatures & ForgeMutatingHookSignatures);
|
|
41
|
+
export type ForgeSimpleHookFn<Hook extends keyof ForgeSimpleHookSignatures> = (forgeConfig: ResolvedForgeConfig, ...args: ForgeSimpleHookSignatures[Hook]) => Promise<void>;
|
|
42
|
+
export type ForgeMutatingHookFn<Hook extends keyof ForgeMutatingHookSignatures> = (forgeConfig: ResolvedForgeConfig, ...args: ForgeMutatingHookSignatures[Hook]) => Promise<ForgeMutatingHookSignatures[Hook][0] | void>;
|
|
43
|
+
export type ForgeHookFn<Hook extends ForgeHookName> = Hook extends keyof ForgeSimpleHookSignatures ? ForgeSimpleHookFn<Hook> : Hook extends keyof ForgeMutatingHookSignatures ? ForgeMutatingHookFn<Hook> : never;
|
|
44
|
+
export type ForgeHookMap = {
|
|
45
45
|
[S in ForgeHookName]?: ForgeHookFn<S>;
|
|
46
46
|
};
|
|
47
|
-
export
|
|
47
|
+
export type ForgeMultiHookMap = {
|
|
48
48
|
[S in ForgeHookName]?: ForgeHookFn<S> | ForgeHookFn<S>[];
|
|
49
49
|
};
|
|
50
50
|
export interface IForgePluginInterface {
|
|
@@ -53,8 +53,8 @@ export interface IForgePluginInterface {
|
|
|
53
53
|
triggerMutatingHook<Hook extends keyof ForgeMutatingHookSignatures>(hookName: Hook, item: ForgeMutatingHookSignatures[Hook][0]): Promise<ForgeMutatingHookSignatures[Hook][0]>;
|
|
54
54
|
overrideStartLogic(opts: StartOptions): Promise<StartResult>;
|
|
55
55
|
}
|
|
56
|
-
export
|
|
57
|
-
export
|
|
56
|
+
export type ForgeRebuildOptions = Omit<RebuildOptions, 'buildPath' | 'electronVersion' | 'arch'>;
|
|
57
|
+
export type ForgePackagerOptions = Omit<ElectronPackagerOptions, 'dir' | 'arch' | 'platform' | 'out' | 'electronVersion'>;
|
|
58
58
|
export interface ResolvedForgeConfig {
|
|
59
59
|
/**
|
|
60
60
|
* A string to uniquely identify artifacts of this build, will be appended
|
|
@@ -81,7 +81,7 @@ export interface ResolvedForgeConfig {
|
|
|
81
81
|
makers: ForgeConfigMaker[];
|
|
82
82
|
publishers: ForgeConfigPublisher[];
|
|
83
83
|
}
|
|
84
|
-
export
|
|
84
|
+
export type ForgeConfig = Partial<Omit<ResolvedForgeConfig, 'pluginInterface'>>;
|
|
85
85
|
export interface ForgeMakeResult {
|
|
86
86
|
/**
|
|
87
87
|
* An array of paths to artifacts generated for this make run
|
|
@@ -168,15 +168,15 @@ export interface StartOptions {
|
|
|
168
168
|
*/
|
|
169
169
|
inspectBrk?: boolean;
|
|
170
170
|
}
|
|
171
|
-
export
|
|
172
|
-
export
|
|
171
|
+
export type InnerStartResult = ElectronProcess | string | string[] | false;
|
|
172
|
+
export type StartResult = InnerStartResult | {
|
|
173
173
|
tasks: ForgeListrTaskDefinition[];
|
|
174
174
|
result: InnerStartResult;
|
|
175
175
|
};
|
|
176
176
|
export interface InitTemplateOptions {
|
|
177
177
|
copyCIFiles?: boolean;
|
|
178
178
|
}
|
|
179
|
-
export
|
|
179
|
+
export type ForgeListrTaskDefinition = ListrTask<never>;
|
|
180
180
|
export { ListrTask };
|
|
181
181
|
export interface ForgeTemplate {
|
|
182
182
|
requiredForgeVersion?: string;
|
|
@@ -184,7 +184,7 @@ export interface ForgeTemplate {
|
|
|
184
184
|
devDependencies?: string[];
|
|
185
185
|
initializeTemplate?: (dir: string, options: InitTemplateOptions) => Promise<void | ForgeListrTaskDefinition[]>;
|
|
186
186
|
}
|
|
187
|
-
export
|
|
187
|
+
export type PackagePerson = undefined | string | {
|
|
188
188
|
name: string;
|
|
189
189
|
email?: string;
|
|
190
190
|
url?: string;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,UAAU,EAAE,OAAO,IAAI,uBAAuB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpG,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EACxB,SAAS,EACT,gBAAgB,EACjB,MAAM,QAAQ,CAAC;AAEhB,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,qBAAqB,CAAC,CAAC,EAAE,yBAAyB,EAAE,wBAAwB,CAAC,CAAC;AACjH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,gBAAgB,CAAC,CAAC,EAAE,oBAAoB,EAAE,oBAAoB,GAAG,mBAAmB,CAAC,CAAC;AACtH,MAAM,MAAM,gBAAgB,CAAC,GAAG,GAAG,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AACvF,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC;AAEpE,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;AAC3C,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC;AACnC,MAAM,MAAM,oBAAoB,GAAG,yBAAyB,GAAG,eAAe,CAAC;AAC/E,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,GAAG,WAAW,CAAC;AACnE,MAAM,MAAM,iBAAiB,GAAG,sBAAsB,GAAG,YAAY,CAAC;AAEtE,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC9D,QAAQ,EAAE,EAAE,CAAC;IACb,SAAS,EAAE,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IACzC,UAAU,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC1D,gBAAgB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACzG,iBAAiB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1G,mBAAmB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5G,WAAW,EAAE;QACX,aAAa,EAAE;YACb,QAAQ,EAAE,aAAa,CAAC;YACxB,IAAI,EAAE,SAAS,CAAC;YAChB,WAAW,EAAE,MAAM,EAAE,CAAC;SACvB;KACF,CAAC;IACF,OAAO,EAAE,EAAE,CAAC;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAC3C,kBAAkB,EAAE,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAEzD,eAAe,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,yBAAyB,GAAG,2BAA2B,CAAC,CAAC;AAC5F,MAAM,MAAM,iBAAiB,CAAC,IAAI,SAAS,MAAM,yBAAyB,IAAI,CAC5E,WAAW,EAAE,mBAAmB,EAChC,GAAG,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC,KACrC,OAAO,CAAC,IAAI,CAAC,CAAC;AACnB,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,MAAM,2BAA2B,IAAI,CAChF,WAAW,EAAE,mBAAmB,EAChC,GAAG,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC,KACvC,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AAC1D,MAAM,MAAM,WAAW,CAAC,IAAI,SAAS,aAAa,IAAI,IAAI,SAAS,MAAM,yBAAyB,GAC9F,iBAAiB,CAAC,IAAI,CAAC,GACvB,IAAI,SAAS,MAAM,2BAA2B,GAC9C,mBAAmB,CAAC,IAAI,CAAC,GACzB,KAAK,CAAC;AACV,MAAM,MAAM,YAAY,GAAG;KACxB,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;CACtC,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG;KAC7B,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE;CACzD,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,WAAW,CAAC,IAAI,SAAS,MAAM,yBAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpI,iBAAiB,CAAC,IAAI,SAAS,MAAM,yBAAyB,EAC5D,UAAU,EAAE,OAAO,SAAS,EAC5B,QAAQ,EAAE,IAAI,EACd,QAAQ,EAAE,yBAAyB,CAAC,IAAI,CAAC,GACxC,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IACvC,mBAAmB,CAAC,IAAI,SAAS,MAAM,2BAA2B,EAChE,QAAQ,EAAE,IAAI,EACd,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GACzC,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACjD,kBAAkB,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC9D;AAGD,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,GAAG,iBAAiB,GAAG,MAAM,CAAC,CAAC;AACjG,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,uBAAuB,EAAE,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,GAAG,iBAAiB,CAAC,CAAC;AAC1H,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,qBAAqB,CAAC;IACvC;;OAEG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAC7B,aAAa,EAAE,mBAAmB,CAAC;IACnC,cAAc,EAAE,oBAAoB,CAAC;IACrC,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,UAAU,EAAE,oBAAoB,EAAE,CAAC;CACpC;AACD,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAChF,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,GAAG,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,gBAAgB;IAChB,uBAAuB,EAAE,OAAO,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC1D,QAAQ,CAAC,IAAI,iBAAiB,CAAC;IAC/B,UAAU,CAAC,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,GAAG,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,sBAAsB,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;IACnC,MAAM,CAAC,EAAE,GAAG,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,0BAA0B,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC;AAC3E,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG;IAAE,KAAK,EAAE,wBAAwB,EAAE,CAAC;IAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE,CAAC;AAE7G,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAGD,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,CAAC;AAErB,MAAM,WAAW,aAAa;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,GAAG,wBAAwB,EAAE,CAAC,CAAC;CAChH;AAED,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,MAAM,GACN;IACE,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@electron-forge/shared-types",
|
|
3
|
-
"version": "7.6.
|
|
3
|
+
"version": "7.6.1",
|
|
4
4
|
"description": "Shared types across Electron Forge",
|
|
5
5
|
"repository": "https://github.com/electron/forge",
|
|
6
6
|
"author": "Samuel Attard",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"main": "dist/index.js",
|
|
9
9
|
"typings": "dist/index.d.ts",
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"@electron-forge/tracer": "7.6.
|
|
11
|
+
"@electron-forge/tracer": "7.6.1",
|
|
12
12
|
"@electron/packager": "^18.3.5",
|
|
13
13
|
"@electron/rebuild": "^3.7.0",
|
|
14
14
|
"listr2": "^7.0.2"
|
|
@@ -23,5 +23,5 @@
|
|
|
23
23
|
"dist",
|
|
24
24
|
"src"
|
|
25
25
|
],
|
|
26
|
-
"gitHead": "
|
|
26
|
+
"gitHead": "a9cac9ad3df1e936bde020f68870b6ed6ffbd282"
|
|
27
27
|
}
|
package/src/index.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { ChildProcess } from 'child_process';
|
|
1
|
+
import { ChildProcess } from 'node:child_process';
|
|
2
2
|
|
|
3
|
-
import { autoTrace } from '@electron-forge/tracer';
|
|
4
3
|
import { ArchOption, Options as ElectronPackagerOptions, TargetPlatform } from '@electron/packager';
|
|
5
4
|
import { RebuildOptions } from '@electron/rebuild';
|
|
5
|
+
import { autoTrace } from '@electron-forge/tracer';
|
|
6
6
|
import {
|
|
7
7
|
ListrBaseClassOptions,
|
|
8
8
|
ListrDefaultRenderer,
|