app-builder-lib 25.1.3 → 25.1.4

package/out/configuration.d.ts

@@ -19,7 +19,7 @@ import { NsisOptions, NsisWebOptions, PortableOptions } from "./targets/nsis/nsi
 /**
  * Configuration Options
  */
-export interface Configuration extends PlatformSpecificBuildOptions {
+export interface CommonConfiguration {
     /**
      * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as
      * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.
@@ -27,7 +27,7 @@ export interface Configuration extends PlatformSpecificBuildOptions {
      */
     readonly appId?: string | null;
     /**
-     * As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).
+     * As [name](#metadata), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).
      * If not specified inside of the `build` configuration, `productName` property defined at the top level of `package.json` is used. If not specified at the top level of `package.json`, [name property](https://docs.npmjs.com/files/package.json#name) is used.
      */
     readonly productName?: string | null;
@@ -36,6 +36,9 @@ export interface Configuration extends PlatformSpecificBuildOptions {
      * @default Copyright © year ${author}
      */
     readonly copyright?: string | null;
+    /**
+     * Directories for build resources
+     */
     readonly directories?: MetadataDirectories | null;
     /**
      * Options related to how build macOS targets.
@@ -95,11 +98,6 @@ export interface Configuration extends PlatformSpecificBuildOptions {
     readonly freebsd?: LinuxTargetSpecificOptions | null;
     readonly p5p?: LinuxTargetSpecificOptions | null;
     readonly apk?: LinuxTargetSpecificOptions | null;
-    /**
-     * Whether to include *all* of the submodules node_modules directories
-     * @default false
-     */
-    includeSubNodeModules?: boolean;
     /**
      * Whether to build the application native dependencies from source.
      * @default false
@@ -140,6 +138,39 @@ export interface Configuration extends PlatformSpecificBuildOptions {
      * Whether to download the alternate FFmpeg library from Electron's release assets and replace the default FFmpeg library prior to signing
      */
     readonly downloadAlternateFFmpeg?: boolean;
+    /**
+     * Inject properties to `package.json`.
+     */
+    readonly extraMetadata?: any;
+    /**
+     * Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).
+     * @default false
+     */
+    readonly forceCodeSigning?: boolean;
+    /**
+     * Whether to include PDB files.
+     * @default false
+     */
+    readonly includePdb?: boolean;
+    /**
+     * Whether to remove `scripts` field from `package.json` files.
+     *
+     * @default true
+     */
+    readonly removePackageScripts?: boolean;
+    /**
+     * Whether to remove `keywords` field from `package.json` files.
+     *
+     * @default true
+     */
+    readonly removePackageKeywords?: boolean;
+}
+export interface Configuration extends CommonConfiguration, PlatformSpecificBuildOptions, Hooks {
+    /**
+     * Whether to include *all* of the submodules node_modules directories
+     * @default false
+     */
+    includeSubNodeModules?: boolean;
     /**
      * Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.
      */
@@ -168,15 +199,6 @@ export interface Configuration extends PlatformSpecificBuildOptions {
      * If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.
      */
     extends?: Array<string> | string | null;
-    /**
-     * Inject properties to `package.json`.
-     */
-    readonly extraMetadata?: any;
-    /**
-     * Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).
-     * @default false
-     */
-    readonly forceCodeSigning?: boolean;
     /**
      * *libui-based frameworks only* The version of NodeJS you are packaging for.
      * You can set it to `current` to set the Node.js version that you use to run.
@@ -191,31 +213,99 @@ export interface Configuration extends PlatformSpecificBuildOptions {
      */
     readonly framework?: string | null;
     /**
-     * The function (or path to file or module id) to be [run before pack](#beforepack)
+     * Whether to disable sanity check asar package (useful for custom electron forks that implement their own encrypted integrity validation)
+     * @default false
+     */
+    readonly disableSanityCheckAsar?: boolean;
+}
+export type CustomElectronDistributable = (options: PrepareApplicationStageDirectoryOptions) => string;
+export type Hook<T, V> = (contextOrPath: T) => Promise<V> | V;
+export interface PackContext {
+    readonly outDir: string;
+    readonly appOutDir: string;
+    readonly packager: PlatformPackager<any>;
+    readonly electronPlatformName: string;
+    readonly arch: Arch;
+    readonly targets: Array<Target>;
+}
+export type AfterPackContext = PackContext;
+export type BeforePackContext = PackContext;
+export type AfterExtractContext = PackContext;
+export interface Hooks {
+    /**
+  The function (or path to file or module id) to be run before pack.
+  
+  ```typescript
+  (context: BeforePackContext): Promise<any> | any
+  ```
+  
+  !!! example "As function"
+  
+      ```js
+      beforePack: async (context) => {
+        // your code
+      }
+      ```
+  
+  Because in a configuration file you cannot use JavaScript, can be specified as a path to file or module id. Function must be exported as default export.
+  
+  ```json
+  "build": {
+    "beforePack": "./myBeforePackHook.js"
+  }
+  ```
+  
+  File `myBeforePackHook.js` in the project root directory:
+  
+  !!! example "myBeforePackHook.js"
+      ```js
+      exports.default = async function(context) {
+        // your custom code
+      }
+      ```
      */
     readonly beforePack?: Hook<BeforePackContext, any> | string | null;
     /**
      * The function (or path to file or module id) to be [run after the prebuilt Electron binary has been extracted to the output directory](#afterextract)
+     * Same setup as {@link beforePack}
      */
     readonly afterExtract?: Hook<AfterExtractContext, any> | string | null;
     /**
      * The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).
+     * Same setup as {@link beforePack}
      */
     readonly afterPack?: Hook<AfterPackContext, any> | string | null;
     /**
      * The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).
+     * Same setup as {@link beforePack}
      */
     readonly afterSign?: Hook<AfterPackContext, any> | string | null;
     /**
      * The function (or path to file or module id) to be run on artifact build start.
+     * Same setup as {@link beforePack}
      */
     readonly artifactBuildStarted?: Hook<ArtifactBuildStarted, any> | string | null;
     /**
      * The function (or path to file or module id) to be run on artifact build completed.
+     * Same setup as {@link beforePack}
      */
     readonly artifactBuildCompleted?: Hook<ArtifactCreated, any> | string | null;
     /**
-     * The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild).
+     * The function (or path to file or module id) to be run after all artifacts are built.
+  
+  ```typescript
+  (buildResult: BuildResult): Promise<Array<string>> | Array<string>
+  ```
+  
+  Configuration in the same way as `afterPack` (see above).
+  
+  !!! example "myAfterAllArtifactBuild.js"
+      ```js
+      exports.default = function () {
+        // you can return additional files to publish
+        return ["/path/to/additional/result/file"]
+      }
+      ```
      */
     readonly afterAllArtifactBuild?: Hook<BuildResult, Array<string>> | string | null;
     /**
@@ -236,40 +326,7 @@ export interface Configuration extends PlatformSpecificBuildOptions {
      * If provided and `node_modules` are missing, it will not invoke production dependencies check.
      */
     readonly beforeBuild?: Hook<BeforeBuildContext, boolean | void> | string | null;
-    /**
-     * Whether to include PDB files.
-     * @default false
-     */
-    readonly includePdb?: boolean;
-    /**
-     * Whether to remove `scripts` field from `package.json` files.
-     *
-     * @default true
-     */
-    readonly removePackageScripts?: boolean;
-    /**
-     * Whether to remove `keywords` field from `package.json` files.
-     *
-     * @default true
-     */
-    readonly removePackageKeywords?: boolean;
-    /**
-     * Whether to disable sanity check asar package (useful for custom electron forks that implement their own encrypted integrity validation)
-     * @default false
-     */
-    readonly disableSanityCheckAsar?: boolean;
 }
-interface PackContext {
-    readonly outDir: string;
-    readonly appOutDir: string;
-    readonly packager: PlatformPackager<any>;
-    readonly electronPlatformName: string;
-    readonly arch: Arch;
-    readonly targets: Array<Target>;
-}
-export type AfterPackContext = PackContext;
-export type BeforePackContext = PackContext;
-export type AfterExtractContext = PackContext;
 export interface MetadataDirectories {
     /**
      * The path to build resources.
@@ -288,6 +345,3 @@ export interface MetadataDirectories {
      */
     readonly app?: string | null;
 }
-export type CustomElectronDistributable = (options: PrepareApplicationStageDirectoryOptions) => string;
-export type Hook<T, V> = (contextOrPath: T) => Promise<V> | V;
-export {};

package/out/configuration.js.map

@@ -1 +1 @@
-{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../src/configuration.ts"],"names":[],"mappings":"","sourcesContent":["import { Arch } from \"builder-util\"\nimport { BeforeBuildContext, Target } from \"./core\"\nimport { ElectronBrandingOptions, ElectronDownloadOptions } from \"./electron/ElectronFramework\"\nimport { PrepareApplicationStageDirectoryOptions } from \"./Framework\"\nimport { AppXOptions } from \"./options/AppXOptions\"\nimport { AppImageOptions, DebOptions, FlatpakOptions, LinuxConfiguration, LinuxTargetSpecificOptions } from \"./options/linuxOptions\"\nimport { DmgOptions, MacConfiguration, MasConfiguration } from \"./options/macOptions\"\nimport { MsiOptions } from \"./options/MsiOptions\"\nimport { MsiWrappedOptions } from \"./options/MsiWrappedOptions\"\nimport { PkgOptions } from \"./options/pkgOptions\"\nimport { PlatformSpecificBuildOptions } from \"./options/PlatformSpecificBuildOptions\"\nimport { SnapOptions } from \"./options/SnapOptions\"\nimport { SquirrelWindowsOptions } from \"./options/SquirrelWindowsOptions\"\nimport { WindowsConfiguration } from \"./options/winOptions\"\nimport { BuildResult } from \"./packager\"\nimport { ArtifactBuildStarted, ArtifactCreated } from \"./packagerApi\"\nimport { PlatformPackager } from \"./platformPackager\"\nimport { NsisOptions, NsisWebOptions, PortableOptions } from \"./targets/nsis/nsisOptions\"\n\n// duplicate appId here because it is important\n/**\n * Configuration Options\n */\nexport interface Configuration extends PlatformSpecificBuildOptions {\n  /**\n   * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n   * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\n   * @default com.electron.${name}\n   */\n  readonly appId?: string | null\n\n  /**\n   * As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).\n   * If not specified inside of the `build` configuration, `productName` property defined at the top level of `package.json` is used. If not specified at the top level of `package.json`, [name property](https://docs.npmjs.com/files/package.json#name) is used.\n   */\n  readonly productName?: string | null\n\n  /**\n   * The human-readable copyright line for the app.\n   * @default Copyright © year ${author}\n   */\n  readonly copyright?: string | null\n\n  readonly directories?: MetadataDirectories | null\n\n  /**\n   * Options related to how build macOS targets.\n   */\n  readonly mac?: MacConfiguration | null\n  /**\n   * MAS (Mac Application Store) options.\n   */\n  readonly mas?: MasConfiguration | null\n  /**\n   * MAS (Mac Application Store) development options (`mas-dev` target).\n   */\n  readonly masDev?: MasConfiguration | null\n  /**\n   * macOS DMG options.\n   */\n  readonly dmg?: DmgOptions | null\n  /**\n   * macOS PKG options.\n   */\n  readonly pkg?: PkgOptions | null\n\n  /**\n   * Options related to how build Windows targets.\n   */\n  readonly win?: WindowsConfiguration | null\n  readonly nsis?: NsisOptions | null\n  readonly nsisWeb?: NsisWebOptions | null\n  readonly portable?: PortableOptions | null\n  readonly appx?: AppXOptions | null\n  /** @private */\n  readonly msi?: MsiOptions | null\n  /** @private */\n  readonly msiWrapped?: MsiWrappedOptions | null\n  readonly squirrelWindows?: SquirrelWindowsOptions | null\n\n  /**\n   * Options related to how build Linux targets.\n   */\n  readonly linux?: LinuxConfiguration | null\n  /**\n   * Debian package options.\n   */\n  readonly deb?: DebOptions | null\n  /**\n   * Snap options.\n   */\n  readonly snap?: SnapOptions | null\n  /**\n   * AppImage options.\n   */\n  readonly appImage?: AppImageOptions | null\n  /**\n   * Flatpak options.\n   */\n  readonly flatpak?: FlatpakOptions | null\n  readonly pacman?: LinuxTargetSpecificOptions | null\n  readonly rpm?: LinuxTargetSpecificOptions | null\n  readonly freebsd?: LinuxTargetSpecificOptions | null\n  readonly p5p?: LinuxTargetSpecificOptions | null\n  readonly apk?: LinuxTargetSpecificOptions | null\n\n  /**\n   * Whether to include *all* of the submodules node_modules directories\n   * @default false\n   */\n  includeSubNodeModules?: boolean\n\n  /**\n   * Whether to build the application native dependencies from source.\n   * @default false\n   */\n  buildDependenciesFromSource?: boolean\n  /**\n   * Whether to execute `node-gyp rebuild` before starting to package the app.\n   *\n   * Don't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.\n   * @default false\n   */\n  readonly nodeGypRebuild?: boolean\n  /**\n   * Additional command line arguments to use when installing app native deps.\n   */\n  readonly npmArgs?: Array<string> | string | null\n  /**\n   * Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.\n   * @default true\n   */\n  readonly npmRebuild?: boolean\n  /**\n   * Use `legacy` app-builder binary for installing native dependencies, or `@electron/rebuild` in `sequential` or `parallel` compilation modes.\n   * @default sequential\n   */\n  readonly nativeRebuilder?: \"legacy\" | \"sequential\" | \"parallel\" | null\n\n  /**\n   * The build number. Maps to the `--iteration` flag for builds using FPM on Linux.\n   * If not defined, then it will fallback to `BUILD_NUMBER` or `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_BUILDNUMBER` or `CI_PIPELINE_IID` env.\n   */\n  readonly buildNumber?: string | null\n\n  /**\n   * The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.\n   * If `buildVersion` is not defined and `buildNumber` (or one of the `buildNumber` envs) is defined, it will be used as a build version (`version.buildNumber`).\n   */\n  readonly buildVersion?: string | null\n\n  /**\n   * Whether to download the alternate FFmpeg library from Electron's release assets and replace the default FFmpeg library prior to signing\n   */\n  readonly downloadAlternateFFmpeg?: boolean\n\n  /**\n   * Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.\n   */\n  readonly electronCompile?: boolean\n\n  /**\n   * Returns the path to custom Electron build (e.g. `~/electron/out/R`). Zip files must follow the pattern `electron-v${version}-${platformName}-${arch}.zip`, otherwise it will be assumed to be an unpacked Electron app directory\n   */\n  readonly electronDist?: string | CustomElectronDistributable\n\n  /**\n   * The [electron-download](https://github.com/electron-userland/electron-download#usage) options.\n   */\n  readonly electronDownload?: ElectronDownloadOptions\n\n  /**\n   * The branding used by Electron's distributables. This is needed if a fork has modified Electron's BRANDING.json file.\n   */\n  readonly electronBranding?: ElectronBrandingOptions\n\n  /**\n   * The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.\n   */\n  electronVersion?: string | null\n\n  /**\n   * The name of a built-in configuration preset (currently, only `react-cra` is supported) or any number of paths to config files (relative to project dir).\n   *\n   * The latter allows to mixin a config from multiple other configs, as if you `Object.assign` them, but properly combine `files` glob patterns.\n   *\n   * If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.\n   */\n  extends?: Array<string> | string | null\n\n  /**\n   * Inject properties to `package.json`.\n   */\n  readonly extraMetadata?: any\n\n  /**\n   * Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).\n   * @default false\n   */\n  readonly forceCodeSigning?: boolean\n\n  /**\n   * *libui-based frameworks only* The version of NodeJS you are packaging for.\n   * You can set it to `current` to set the Node.js version that you use to run.\n   */\n  readonly nodeVersion?: string | null\n\n  /**\n   * *libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.\n   */\n  readonly launchUiVersion?: boolean | string | null\n\n  /**\n   * The framework name. One of `electron`, `proton`, `libui`. Defaults to `electron`.\n   */\n  readonly framework?: string | null\n\n  /**\n   * The function (or path to file or module id) to be [run before pack](#beforepack)\n   */\n  readonly beforePack?: Hook<BeforePackContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be [run after the prebuilt Electron binary has been extracted to the output directory](#afterextract)\n   */\n  readonly afterExtract?: Hook<AfterExtractContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).\n   */\n  readonly afterPack?: Hook<AfterPackContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).\n   */\n  readonly afterSign?: Hook<AfterPackContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be run on artifact build start.\n   */\n  readonly artifactBuildStarted?: Hook<ArtifactBuildStarted, any> | string | null\n  /**\n   * The function (or path to file or module id) to be run on artifact build completed.\n   */\n  readonly artifactBuildCompleted?: Hook<ArtifactCreated, any> | string | null\n  /**\n   * The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild).\n   */\n  readonly afterAllArtifactBuild?: Hook<BuildResult, Array<string>> | string | null\n  /**\n   * MSI project created on disk - not packed into .msi package yet.\n   */\n  readonly msiProjectCreated?: Hook<string, any> | string | null\n  /**\n   * Appx manifest created on disk - not packed into .appx package yet.\n   */\n  readonly appxManifestCreated?: Hook<string, any> | string | null\n  /**\n   * The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file. Returning `true`/`false` will determine whether to force include or to use the default copier logic\n   */\n  readonly onNodeModuleFile?: Hook<string, void | boolean> | string | null\n  /**\n   * The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.\n   *\n   * If provided and `node_modules` are missing, it will not invoke production dependencies check.\n   */\n  readonly beforeBuild?: Hook<BeforeBuildContext, boolean | void> | string | null\n\n  /**\n   * Whether to include PDB files.\n   * @default false\n   */\n  readonly includePdb?: boolean\n\n  /**\n   * Whether to remove `scripts` field from `package.json` files.\n   *\n   * @default true\n   */\n  readonly removePackageScripts?: boolean\n\n  /**\n   * Whether to remove `keywords` field from `package.json` files.\n   *\n   * @default true\n   */\n  readonly removePackageKeywords?: boolean\n\n  /**\n   * Whether to disable sanity check asar package (useful for custom electron forks that implement their own encrypted integrity validation)\n   * @default false\n   */\n  readonly disableSanityCheckAsar?: boolean\n}\n\ninterface PackContext {\n  readonly outDir: string\n  readonly appOutDir: string\n  readonly packager: PlatformPackager<any>\n  readonly electronPlatformName: string\n  readonly arch: Arch\n  readonly targets: Array<Target>\n}\nexport type AfterPackContext = PackContext\nexport type BeforePackContext = PackContext\nexport type AfterExtractContext = PackContext\n\nexport interface MetadataDirectories {\n  /**\n   * The path to build resources.\n   *\n   * Please note — build resources are not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `\"files\": [\"**\\/*\", \"build/icon.*\"]`\n   * @default build\n   */\n  readonly buildResources?: string | null\n\n  /**\n   * The output directory. [File macros](./file-patterns.md#file-macros) are supported.\n   * @default dist\n   */\n  readonly output?: string | null\n\n  /**\n   * The application directory (containing the application package.json), defaults to `app`, `www` or working directory.\n   */\n  readonly app?: string | null\n}\n\nexport type CustomElectronDistributable = (options: PrepareApplicationStageDirectoryOptions) => string\n\nexport type Hook<T, V> = (contextOrPath: T) => Promise<V> | V\n"]}
+{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../src/configuration.ts"],"names":[],"mappings":"","sourcesContent":["import { Arch } from \"builder-util\"\nimport { BeforeBuildContext, Target } from \"./core\"\nimport { ElectronBrandingOptions, ElectronDownloadOptions } from \"./electron/ElectronFramework\"\nimport { PrepareApplicationStageDirectoryOptions } from \"./Framework\"\nimport { AppXOptions } from \"./options/AppXOptions\"\nimport { AppImageOptions, DebOptions, FlatpakOptions, LinuxConfiguration, LinuxTargetSpecificOptions } from \"./options/linuxOptions\"\nimport { DmgOptions, MacConfiguration, MasConfiguration } from \"./options/macOptions\"\nimport { MsiOptions } from \"./options/MsiOptions\"\nimport { MsiWrappedOptions } from \"./options/MsiWrappedOptions\"\nimport { PkgOptions } from \"./options/pkgOptions\"\nimport { PlatformSpecificBuildOptions } from \"./options/PlatformSpecificBuildOptions\"\nimport { SnapOptions } from \"./options/SnapOptions\"\nimport { SquirrelWindowsOptions } from \"./options/SquirrelWindowsOptions\"\nimport { WindowsConfiguration } from \"./options/winOptions\"\nimport { BuildResult } from \"./packager\"\nimport { ArtifactBuildStarted, ArtifactCreated } from \"./packagerApi\"\nimport { PlatformPackager } from \"./platformPackager\"\nimport { NsisOptions, NsisWebOptions, PortableOptions } from \"./targets/nsis/nsisOptions\"\n\n// duplicate appId here because it is important\n/**\n * Configuration Options\n */\nexport interface CommonConfiguration {\n  /**\n   * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n   * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\n   * @default com.electron.${name}\n   */\n  readonly appId?: string | null\n\n  /**\n   * As [name](#metadata), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).\n   * If not specified inside of the `build` configuration, `productName` property defined at the top level of `package.json` is used. If not specified at the top level of `package.json`, [name property](https://docs.npmjs.com/files/package.json#name) is used.\n   */\n  readonly productName?: string | null\n\n  /**\n   * The human-readable copyright line for the app.\n   * @default Copyright © year ${author}\n   */\n  readonly copyright?: string | null\n\n  /**\n   * Directories for build resources\n   */\n  readonly directories?: MetadataDirectories | null\n\n  /**\n   * Options related to how build macOS targets.\n   */\n  readonly mac?: MacConfiguration | null\n  /**\n   * MAS (Mac Application Store) options.\n   */\n  readonly mas?: MasConfiguration | null\n  /**\n   * MAS (Mac Application Store) development options (`mas-dev` target).\n   */\n  readonly masDev?: MasConfiguration | null\n  /**\n   * macOS DMG options.\n   */\n  readonly dmg?: DmgOptions | null\n  /**\n   * macOS PKG options.\n   */\n  readonly pkg?: PkgOptions | null\n\n  /**\n   * Options related to how build Windows targets.\n   */\n  readonly win?: WindowsConfiguration | null\n  readonly nsis?: NsisOptions | null\n  readonly nsisWeb?: NsisWebOptions | null\n  readonly portable?: PortableOptions | null\n  readonly appx?: AppXOptions | null\n  /** @private */\n  readonly msi?: MsiOptions | null\n  /** @private */\n  readonly msiWrapped?: MsiWrappedOptions | null\n  readonly squirrelWindows?: SquirrelWindowsOptions | null\n\n  /**\n   * Options related to how build Linux targets.\n   */\n  readonly linux?: LinuxConfiguration | null\n  /**\n   * Debian package options.\n   */\n  readonly deb?: DebOptions | null\n  /**\n   * Snap options.\n   */\n  readonly snap?: SnapOptions | null\n  /**\n   * AppImage options.\n   */\n  readonly appImage?: AppImageOptions | null\n  /**\n   * Flatpak options.\n   */\n  readonly flatpak?: FlatpakOptions | null\n  readonly pacman?: LinuxTargetSpecificOptions | null\n  readonly rpm?: LinuxTargetSpecificOptions | null\n  readonly freebsd?: LinuxTargetSpecificOptions | null\n  readonly p5p?: LinuxTargetSpecificOptions | null\n  readonly apk?: LinuxTargetSpecificOptions | null\n\n  /**\n   * Whether to build the application native dependencies from source.\n   * @default false\n   */\n  buildDependenciesFromSource?: boolean\n  /**\n   * Whether to execute `node-gyp rebuild` before starting to package the app.\n   *\n   * Don't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.\n   * @default false\n   */\n  readonly nodeGypRebuild?: boolean\n  /**\n   * Additional command line arguments to use when installing app native deps.\n   */\n  readonly npmArgs?: Array<string> | string | null\n  /**\n   * Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.\n   * @default true\n   */\n  readonly npmRebuild?: boolean\n  /**\n   * Use `legacy` app-builder binary for installing native dependencies, or `@electron/rebuild` in `sequential` or `parallel` compilation modes.\n   * @default sequential\n   */\n  readonly nativeRebuilder?: \"legacy\" | \"sequential\" | \"parallel\" | null\n\n  /**\n   * The build number. Maps to the `--iteration` flag for builds using FPM on Linux.\n   * If not defined, then it will fallback to `BUILD_NUMBER` or `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_BUILDNUMBER` or `CI_PIPELINE_IID` env.\n   */\n  readonly buildNumber?: string | null\n\n  /**\n   * The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.\n   * If `buildVersion` is not defined and `buildNumber` (or one of the `buildNumber` envs) is defined, it will be used as a build version (`version.buildNumber`).\n   */\n  readonly buildVersion?: string | null\n\n  /**\n   * Whether to download the alternate FFmpeg library from Electron's release assets and replace the default FFmpeg library prior to signing\n   */\n  readonly downloadAlternateFFmpeg?: boolean\n\n  /**\n   * Inject properties to `package.json`.\n   */\n  readonly extraMetadata?: any\n\n  /**\n   * Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).\n   * @default false\n   */\n  readonly forceCodeSigning?: boolean\n\n  /**\n   * Whether to include PDB files.\n   * @default false\n   */\n  readonly includePdb?: boolean\n\n  /**\n   * Whether to remove `scripts` field from `package.json` files.\n   *\n   * @default true\n   */\n  readonly removePackageScripts?: boolean\n\n  /**\n   * Whether to remove `keywords` field from `package.json` files.\n   *\n   * @default true\n   */\n  readonly removePackageKeywords?: boolean\n}\nexport interface Configuration extends CommonConfiguration, PlatformSpecificBuildOptions, Hooks {\n  /**\n   * Whether to include *all* of the submodules node_modules directories\n   * @default false\n   */\n  includeSubNodeModules?: boolean\n\n  /**\n   * Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.\n   */\n  readonly electronCompile?: boolean\n\n  /**\n   * Returns the path to custom Electron build (e.g. `~/electron/out/R`). Zip files must follow the pattern `electron-v${version}-${platformName}-${arch}.zip`, otherwise it will be assumed to be an unpacked Electron app directory\n   */\n  readonly electronDist?: string | CustomElectronDistributable\n\n  /**\n   * The [electron-download](https://github.com/electron-userland/electron-download#usage) options.\n   */\n  readonly electronDownload?: ElectronDownloadOptions\n\n  /**\n   * The branding used by Electron's distributables. This is needed if a fork has modified Electron's BRANDING.json file.\n   */\n  readonly electronBranding?: ElectronBrandingOptions\n\n  /**\n   * The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.\n   */\n  electronVersion?: string | null\n\n  /**\n   * The name of a built-in configuration preset (currently, only `react-cra` is supported) or any number of paths to config files (relative to project dir).\n   *\n   * The latter allows to mixin a config from multiple other configs, as if you `Object.assign` them, but properly combine `files` glob patterns.\n   *\n   * If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.\n   */\n  extends?: Array<string> | string | null\n\n  /**\n   * *libui-based frameworks only* The version of NodeJS you are packaging for.\n   * You can set it to `current` to set the Node.js version that you use to run.\n   */\n  readonly nodeVersion?: string | null\n\n  /**\n   * *libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.\n   */\n  readonly launchUiVersion?: boolean | string | null\n\n  /**\n   * The framework name. One of `electron`, `proton`, `libui`. Defaults to `electron`.\n   */\n  readonly framework?: string | null\n\n  /**\n   * Whether to disable sanity check asar package (useful for custom electron forks that implement their own encrypted integrity validation)\n   * @default false\n   */\n  readonly disableSanityCheckAsar?: boolean\n}\n\nexport type CustomElectronDistributable = (options: PrepareApplicationStageDirectoryOptions) => string\n\nexport type Hook<T, V> = (contextOrPath: T) => Promise<V> | V\n\nexport interface PackContext {\n  readonly outDir: string\n  readonly appOutDir: string\n  readonly packager: PlatformPackager<any>\n  readonly electronPlatformName: string\n  readonly arch: Arch\n  readonly targets: Array<Target>\n}\nexport type AfterPackContext = PackContext\nexport type BeforePackContext = PackContext\nexport type AfterExtractContext = PackContext\n\nexport interface Hooks {\n  /**\nThe function (or path to file or module id) to be run before pack.\n\n```typescript\n(context: BeforePackContext): Promise<any> | any\n```\n\n!!! example \"As function\"\n\n    ```js\n    beforePack: async (context) => {\n      // your code\n    }\n    ```\n\nBecause in a configuration file you cannot use JavaScript, can be specified as a path to file or module id. Function must be exported as default export.\n\n```json\n\"build\": {\n  \"beforePack\": \"./myBeforePackHook.js\"\n}\n```\n\nFile `myBeforePackHook.js` in the project root directory:\n\n!!! example \"myBeforePackHook.js\"\n    ```js\n    exports.default = async function(context) {\n      // your custom code\n    }\n    ```\n   */\n  readonly beforePack?: Hook<BeforePackContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be [run after the prebuilt Electron binary has been extracted to the output directory](#afterextract)\n   * Same setup as {@link beforePack}\n   */\n  readonly afterExtract?: Hook<AfterExtractContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).\n   * Same setup as {@link beforePack}\n   */\n  readonly afterPack?: Hook<AfterPackContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).\n   * Same setup as {@link beforePack}\n   */\n  readonly afterSign?: Hook<AfterPackContext, any> | string | null\n\n  /**\n   * The function (or path to file or module id) to be run on artifact build start.\n   * Same setup as {@link beforePack}\n   */\n  readonly artifactBuildStarted?: Hook<ArtifactBuildStarted, any> | string | null\n  /**\n   * The function (or path to file or module id) to be run on artifact build completed.\n   * Same setup as {@link beforePack}\n   */\n  readonly artifactBuildCompleted?: Hook<ArtifactCreated, any> | string | null\n  /**\n   * The function (or path to file or module id) to be run after all artifacts are built.\n\n```typescript\n(buildResult: BuildResult): Promise<Array<string>> | Array<string>\n```\n\nConfiguration in the same way as `afterPack` (see above).\n\n!!! example \"myAfterAllArtifactBuild.js\"\n    ```js\n    exports.default = function () {\n      // you can return additional files to publish\n      return [\"/path/to/additional/result/file\"]\n    }\n    ```\n   */\n  readonly afterAllArtifactBuild?: Hook<BuildResult, Array<string>> | string | null\n  /**\n   * MSI project created on disk - not packed into .msi package yet.\n   */\n  readonly msiProjectCreated?: Hook<string, any> | string | null\n  /**\n   * Appx manifest created on disk - not packed into .appx package yet.\n   */\n  readonly appxManifestCreated?: Hook<string, any> | string | null\n  /**\n   * The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file. Returning `true`/`false` will determine whether to force include or to use the default copier logic\n   */\n  readonly onNodeModuleFile?: Hook<string, void | boolean> | string | null\n  /**\n   * The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.\n   *\n   * If provided and `node_modules` are missing, it will not invoke production dependencies check.\n   */\n  readonly beforeBuild?: Hook<BeforeBuildContext, boolean | void> | string | null\n}\n\nexport interface MetadataDirectories {\n  /**\n   * The path to build resources.\n   *\n   * Please note — build resources are not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `\"files\": [\"**\\/*\", \"build/icon.*\"]`\n   * @default build\n   */\n  readonly buildResources?: string | null\n\n  /**\n   * The output directory. [File macros](./file-patterns.md#file-macros) are supported.\n   * @default dist\n   */\n  readonly output?: string | null\n\n  /**\n   * The application directory (containing the application package.json), defaults to `app`, `www` or working directory.\n   */\n  readonly app?: string | null\n}\n"]}

package/out/index.d.ts

@@ -5,7 +5,7 @@ export { Packager, BuildResult } from "./packager";
 export { PackagerOptions, ArtifactCreated, ArtifactBuildStarted } from "./packagerApi";
 export { TargetConfiguration, Platform, Target, DIR_TARGET, BeforeBuildContext, SourceRepositoryInfo, TargetSpecificOptions, TargetConfigType, DEFAULT_TARGET, CompressionLevel, } from "./core";
 export { getArchSuffix, Arch, archFromString } from "builder-util";
-export { Configuration, AfterPackContext, MetadataDirectories, BeforePackContext, AfterExtractContext, CustomElectronDistributable, Hook } from "./configuration";
+export { CommonConfiguration, Configuration, AfterPackContext, MetadataDirectories, BeforePackContext, AfterExtractContext, CustomElectronDistributable, Hooks, Hook, PackContext, } from "./configuration";
 export { ElectronBrandingOptions, ElectronDownloadOptions, ElectronPlatformName } from "./electron/ElectronFramework";
 export { PlatformSpecificBuildOptions, AsarOptions, FileSet, Protocol, ReleaseInfo, FilesBuildOptions } from "./options/PlatformSpecificBuildOptions";
 export { FileAssociation } from "./options/FileAssociation";

package/out/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AA8DA,4DAMC;AAED,sBAwDC;AA7HD,+CAA6E;AAC7E,+DAA8C;AAC9C,yCAAqC;AAErC,4CAAgD;AAChD,6DAAyD;AAEzD,uCAAkD;AAAzC,oGAAA,QAAQ,OAAA;AAEjB,+BAWe;AATb,gGAAA,QAAQ,OAAA;AACR,8FAAA,MAAM,OAAA;AACN,kGAAA,UAAU,OAAA;AAKV,sGAAA,cAAc,OAAA;AAGhB,6CAAkE;AAAzD,6GAAA,aAAa,OAAA;AAAE,oGAAA,IAAI,OAAA;AAAE,8GAAA,cAAc,OAAA;AAgB5C,qCAAmC;AAA1B,kGAAA,OAAO,OAAA;AAYhB,6DAAsE;AAA7D,yHAAA,iBAAiB,OAAA;AAE1B,2DAAyD;AAAhD,gHAAA,cAAc,OAAA;AACvB,uDAAqD;AAA5C,oHAAA,gBAAgB,OAAA;AAEzB,6CAAwD;AAA/C,yGAAA,UAAU,OAAA;AACnB,iDAA+C;AAAtC,8GAAA,aAAa,OAAA;AACtB,6CAA2C;AAAlC,0GAAA,WAAW,OAAA;AACpB,6CAA2C;AAAlC,0GAAA,WAAW,OAAA;AAEpB,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,yBAAyB,EAAE,QAAQ,EAAE,yBAAyB,EAAE,aAAa,CAAC,CAAC,CAAA;AAE3K,SAAgB,wBAAwB,CAAC,OAAyC;IAChF,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,IAAK,OAAe,CAAC,UAAU,CAAC,KAAK,SAAS,EAAE,CAAC;YACnF,MAAM,IAAI,wCAAyB,CAAC,mBAAmB,UAAU,GAAG,CAAC,CAAA;QACvE,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,KAAK,CAAC,OAAyC,EAAE,WAAqB,IAAI,mBAAQ,CAAC,OAAO,CAAC;IACzG,wBAAwB,CAAC,OAAO,CAAC,CAAA;IAEjC,MAAM,cAAc,GAAG,IAAI,+BAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC5D,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,kBAAG,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;QAC/B,QAAQ,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAA;QACnC,cAAc,CAAC,WAAW,EAAE,CAAA;IAC9B,CAAC,CAAA;IACD,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAErC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,EAAC,WAAW,EAAC,EAAE;QACxD,MAAM,qBAAqB,GAAG,MAAM,IAAA,yBAAe,EAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAA;QACpJ,IAAI,qBAAqB,IAAI,IAAI,EAAE,CAAC;YAClC,MAAM,YAAY,GAAG,IAAA,8BAAO,EAAC,MAAM,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YACvF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC;gBAC3D,OAAO,WAAW,CAAC,aAAa,CAAA;YAClC,CAAC;YAED,MAAM,qBAAqB,GAAG,MAAM,cAAc,CAAC,8BAA8B,EAAE,CAAA;YACnF,IAAI,qBAAqB,IAAI,IAAI,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxE,OAAO,WAAW,CAAC,aAAa,CAAA;YAClC,CAAC;YAED,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;gBACvC,IAAI,WAAW,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;oBACpD,kBAAG,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,EAAE,iDAAiD,CAAC,CAAA;oBAC5E,SAAQ;gBACV,CAAC;gBACD,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC3C,KAAK,MAAM,oBAAoB,IAAI,qBAAqB,EAAE,CAAC;oBACzD,cAAc,CAAC,cAAc,CAC3B,oBAAoB,EACpB;wBACE,IAAI,EAAE,WAAW;wBACjB,IAAI,EAAE,IAAI;qBACX,EACD,QAAQ,CAAC,OAAO,CACjB,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAC,aAAa,CAAA;IAClC,CAAC,CAAC,CAAA;IAEF,OAAO,IAAA,6BAAc,EAAC,OAAO,EAAE,eAAe,CAAC,EAAE;QAC/C,IAAI,OAAqB,CAAA;QACzB,IAAI,eAAe,EAAE,CAAC;YACpB,cAAc,CAAC,WAAW,EAAE,CAAA;YAC5B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACjC,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,cAAc,CAAC,UAAU,EAAE,CAAA;QACvC,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAA;IAC5E,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import { PublishOptions } from \"electron-publish/out/publisher\"\nimport { log, InvalidConfigurationError, executeFinally } from \"builder-util\"\nimport { asArray } from \"builder-util-runtime\"\nimport { Packager } from \"./packager\"\nimport { PackagerOptions } from \"./packagerApi\"\nimport { resolveFunction } from \"./util/resolve\"\nimport { PublishManager } from \"./publish/PublishManager\"\n\nexport { Packager, BuildResult } from \"./packager\"\nexport { PackagerOptions, ArtifactCreated, ArtifactBuildStarted } from \"./packagerApi\"\nexport {\n  TargetConfiguration,\n  Platform,\n  Target,\n  DIR_TARGET,\n  BeforeBuildContext,\n  SourceRepositoryInfo,\n  TargetSpecificOptions,\n  TargetConfigType,\n  DEFAULT_TARGET,\n  CompressionLevel,\n} from \"./core\"\nexport { getArchSuffix, Arch, archFromString } from \"builder-util\"\nexport { Configuration, AfterPackContext, MetadataDirectories, BeforePackContext, AfterExtractContext, CustomElectronDistributable, Hook } from \"./configuration\"\nexport { ElectronBrandingOptions, ElectronDownloadOptions, ElectronPlatformName } from \"./electron/ElectronFramework\"\nexport { PlatformSpecificBuildOptions, AsarOptions, FileSet, Protocol, ReleaseInfo, FilesBuildOptions } from \"./options/PlatformSpecificBuildOptions\"\nexport { FileAssociation } from \"./options/FileAssociation\"\nexport { MacConfiguration, DmgOptions, MasConfiguration, MacOsTargetName, DmgContent, DmgWindow, NotarizeNotaryOptions } from \"./options/macOptions\"\nexport { PkgOptions, PkgBackgroundOptions, BackgroundAlignment, BackgroundScaling } from \"./options/pkgOptions\"\nexport { WindowsConfiguration, WindowsAzureSigningConfiguration, WindowsSigntoolConfiguration } from \"./options/winOptions\"\nexport { AppXOptions } from \"./options/AppXOptions\"\nexport { MsiOptions } from \"./options/MsiOptions\"\nexport { MsiWrappedOptions } from \"./options/MsiWrappedOptions\"\nexport { CommonWindowsInstallerConfiguration } from \"./options/CommonWindowsInstallerConfiguration\"\nexport { NsisOptions, NsisWebOptions, PortableOptions, CommonNsisOptions, CustomNsisBinary } from \"./targets/nsis/nsisOptions\"\nexport { LinuxConfiguration, DebOptions, CommonLinuxOptions, LinuxTargetSpecificOptions, AppImageOptions, FlatpakOptions } from \"./options/linuxOptions\"\nexport { SnapOptions, PlugDescriptor, SlotDescriptor } from \"./options/SnapOptions\"\nexport { Metadata, AuthorMetadata, RepositoryInfo } from \"./options/metadata\"\nexport { AppInfo } from \"./appInfo\"\nexport { SquirrelWindowsOptions } from \"./options/SquirrelWindowsOptions\"\n\nexport { CustomMacSign, CustomMacSignOptions } from \"./macPackager\"\nexport { WindowsSignOptions } from \"./codeSign/windowsCodeSign\"\nexport {\n  CustomWindowsSignTaskConfiguration,\n  WindowsSignTaskConfiguration,\n  CustomWindowsSign,\n  FileCodeSigningInfo,\n  CertificateFromStoreInfo,\n} from \"./codeSign/windowsSignToolManager\"\nexport { CancellationToken, ProgressInfo } from \"builder-util-runtime\"\nexport { PublishOptions, UploadTask } from \"electron-publish\"\nexport { PublishManager } from \"./publish/PublishManager\"\nexport { PlatformPackager } from \"./platformPackager\"\nexport { Framework, PrepareApplicationStageDirectoryOptions } from \"./Framework\"\nexport { buildForge, ForgeOptions } from \"./forge-maker\"\nexport { LinuxPackager } from \"./linuxPackager\"\nexport { WinPackager } from \"./winPackager\"\nexport { MacPackager } from \"./macPackager\"\n\nconst expectedOptions = new Set([\"publish\", \"targets\", \"mac\", \"win\", \"linux\", \"projectDir\", \"platformPackagerFactory\", \"config\", \"effectiveOptionComputed\", \"prepackaged\"])\n\nexport function checkBuildRequestOptions(options: PackagerOptions & PublishOptions) {\n  for (const optionName of Object.keys(options)) {\n    if (!expectedOptions.has(optionName) && (options as any)[optionName] !== undefined) {\n      throw new InvalidConfigurationError(`Unknown option \"${optionName}\"`)\n    }\n  }\n}\n\nexport function build(options: PackagerOptions & PublishOptions, packager: Packager = new Packager(options)): Promise<Array<string>> {\n  checkBuildRequestOptions(options)\n\n  const publishManager = new PublishManager(packager, options)\n  const sigIntHandler = () => {\n    log.warn(\"cancelled by SIGINT\")\n    packager.cancellationToken.cancel()\n    publishManager.cancelTasks()\n  }\n  process.once(\"SIGINT\", sigIntHandler)\n\n  const promise = packager.build().then(async buildResult => {\n    const afterAllArtifactBuild = await resolveFunction(packager.appInfo.type, buildResult.configuration.afterAllArtifactBuild, \"afterAllArtifactBuild\")\n    if (afterAllArtifactBuild != null) {\n      const newArtifacts = asArray(await Promise.resolve(afterAllArtifactBuild(buildResult)))\n      if (newArtifacts.length === 0 || !publishManager.isPublish) {\n        return buildResult.artifactPaths\n      }\n\n      const publishConfigurations = await publishManager.getGlobalPublishConfigurations()\n      if (publishConfigurations == null || publishConfigurations.length === 0) {\n        return buildResult.artifactPaths\n      }\n\n      for (const newArtifact of newArtifacts) {\n        if (buildResult.artifactPaths.includes(newArtifact)) {\n          log.warn({ newArtifact }, \"skipping publish of artifact, already published\")\n          continue\n        }\n        buildResult.artifactPaths.push(newArtifact)\n        for (const publishConfiguration of publishConfigurations) {\n          publishManager.scheduleUpload(\n            publishConfiguration,\n            {\n              file: newArtifact,\n              arch: null,\n            },\n            packager.appInfo\n          )\n        }\n      }\n    }\n    return buildResult.artifactPaths\n  })\n\n  return executeFinally(promise, isErrorOccurred => {\n    let promise: Promise<any>\n    if (isErrorOccurred) {\n      publishManager.cancelTasks()\n      promise = Promise.resolve(null)\n    } else {\n      promise = publishManager.awaitTasks()\n    }\n\n    return promise.then(() => process.removeListener(\"SIGINT\", sigIntHandler))\n  })\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAyEA,4DAMC;AAED,sBAwDC;AAxID,+CAA6E;AAC7E,+DAA8C;AAC9C,yCAAqC;AAErC,4CAAgD;AAChD,6DAAyD;AAEzD,uCAAkD;AAAzC,oGAAA,QAAQ,OAAA;AAEjB,+BAWe;AATb,gGAAA,QAAQ,OAAA;AACR,8FAAA,MAAM,OAAA;AACN,kGAAA,UAAU,OAAA;AAKV,sGAAA,cAAc,OAAA;AAGhB,6CAAkE;AAAzD,6GAAA,aAAa,OAAA;AAAE,oGAAA,IAAI,OAAA;AAAE,8GAAA,cAAc,OAAA;AA2B5C,qCAAmC;AAA1B,kGAAA,OAAO,OAAA;AAYhB,6DAAsE;AAA7D,yHAAA,iBAAiB,OAAA;AAE1B,2DAAyD;AAAhD,gHAAA,cAAc,OAAA;AACvB,uDAAqD;AAA5C,oHAAA,gBAAgB,OAAA;AAEzB,6CAAwD;AAA/C,yGAAA,UAAU,OAAA;AACnB,iDAA+C;AAAtC,8GAAA,aAAa,OAAA;AACtB,6CAA2C;AAAlC,0GAAA,WAAW,OAAA;AACpB,6CAA2C;AAAlC,0GAAA,WAAW,OAAA;AAEpB,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,yBAAyB,EAAE,QAAQ,EAAE,yBAAyB,EAAE,aAAa,CAAC,CAAC,CAAA;AAE3K,SAAgB,wBAAwB,CAAC,OAAyC;IAChF,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9C,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,IAAK,OAAe,CAAC,UAAU,CAAC,KAAK,SAAS,EAAE,CAAC;YACnF,MAAM,IAAI,wCAAyB,CAAC,mBAAmB,UAAU,GAAG,CAAC,CAAA;QACvE,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,KAAK,CAAC,OAAyC,EAAE,WAAqB,IAAI,mBAAQ,CAAC,OAAO,CAAC;IACzG,wBAAwB,CAAC,OAAO,CAAC,CAAA;IAEjC,MAAM,cAAc,GAAG,IAAI,+BAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC5D,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,kBAAG,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;QAC/B,QAAQ,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAA;QACnC,cAAc,CAAC,WAAW,EAAE,CAAA;IAC9B,CAAC,CAAA;IACD,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAErC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,EAAC,WAAW,EAAC,EAAE;QACxD,MAAM,qBAAqB,GAAG,MAAM,IAAA,yBAAe,EAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,aAAa,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAA;QACpJ,IAAI,qBAAqB,IAAI,IAAI,EAAE,CAAC;YAClC,MAAM,YAAY,GAAG,IAAA,8BAAO,EAAC,MAAM,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;YACvF,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC;gBAC3D,OAAO,WAAW,CAAC,aAAa,CAAA;YAClC,CAAC;YAED,MAAM,qBAAqB,GAAG,MAAM,cAAc,CAAC,8BAA8B,EAAE,CAAA;YACnF,IAAI,qBAAqB,IAAI,IAAI,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxE,OAAO,WAAW,CAAC,aAAa,CAAA;YAClC,CAAC;YAED,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;gBACvC,IAAI,WAAW,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;oBACpD,kBAAG,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,EAAE,iDAAiD,CAAC,CAAA;oBAC5E,SAAQ;gBACV,CAAC;gBACD,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC3C,KAAK,MAAM,oBAAoB,IAAI,qBAAqB,EAAE,CAAC;oBACzD,cAAc,CAAC,cAAc,CAC3B,oBAAoB,EACpB;wBACE,IAAI,EAAE,WAAW;wBACjB,IAAI,EAAE,IAAI;qBACX,EACD,QAAQ,CAAC,OAAO,CACjB,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAC,aAAa,CAAA;IAClC,CAAC,CAAC,CAAA;IAEF,OAAO,IAAA,6BAAc,EAAC,OAAO,EAAE,eAAe,CAAC,EAAE;QAC/C,IAAI,OAAqB,CAAA;QACzB,IAAI,eAAe,EAAE,CAAC;YACpB,cAAc,CAAC,WAAW,EAAE,CAAA;YAC5B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACjC,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,cAAc,CAAC,UAAU,EAAE,CAAA;QACvC,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAA;IAC5E,CAAC,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import { PublishOptions } from \"electron-publish/out/publisher\"\nimport { log, InvalidConfigurationError, executeFinally } from \"builder-util\"\nimport { asArray } from \"builder-util-runtime\"\nimport { Packager } from \"./packager\"\nimport { PackagerOptions } from \"./packagerApi\"\nimport { resolveFunction } from \"./util/resolve\"\nimport { PublishManager } from \"./publish/PublishManager\"\n\nexport { Packager, BuildResult } from \"./packager\"\nexport { PackagerOptions, ArtifactCreated, ArtifactBuildStarted } from \"./packagerApi\"\nexport {\n  TargetConfiguration,\n  Platform,\n  Target,\n  DIR_TARGET,\n  BeforeBuildContext,\n  SourceRepositoryInfo,\n  TargetSpecificOptions,\n  TargetConfigType,\n  DEFAULT_TARGET,\n  CompressionLevel,\n} from \"./core\"\nexport { getArchSuffix, Arch, archFromString } from \"builder-util\"\nexport {\n  CommonConfiguration,\n  Configuration,\n  AfterPackContext,\n  MetadataDirectories,\n  BeforePackContext,\n  AfterExtractContext,\n  CustomElectronDistributable,\n  Hooks,\n  Hook,\n  PackContext,\n} from \"./configuration\"\nexport { ElectronBrandingOptions, ElectronDownloadOptions, ElectronPlatformName } from \"./electron/ElectronFramework\"\nexport { PlatformSpecificBuildOptions, AsarOptions, FileSet, Protocol, ReleaseInfo, FilesBuildOptions } from \"./options/PlatformSpecificBuildOptions\"\nexport { FileAssociation } from \"./options/FileAssociation\"\nexport { MacConfiguration, DmgOptions, MasConfiguration, MacOsTargetName, DmgContent, DmgWindow, NotarizeNotaryOptions } from \"./options/macOptions\"\nexport { PkgOptions, PkgBackgroundOptions, BackgroundAlignment, BackgroundScaling } from \"./options/pkgOptions\"\nexport { WindowsConfiguration, WindowsAzureSigningConfiguration, WindowsSigntoolConfiguration } from \"./options/winOptions\"\nexport { AppXOptions } from \"./options/AppXOptions\"\nexport { MsiOptions } from \"./options/MsiOptions\"\nexport { MsiWrappedOptions } from \"./options/MsiWrappedOptions\"\nexport { CommonWindowsInstallerConfiguration } from \"./options/CommonWindowsInstallerConfiguration\"\nexport { NsisOptions, NsisWebOptions, PortableOptions, CommonNsisOptions, CustomNsisBinary } from \"./targets/nsis/nsisOptions\"\nexport { LinuxConfiguration, DebOptions, CommonLinuxOptions, LinuxTargetSpecificOptions, AppImageOptions, FlatpakOptions } from \"./options/linuxOptions\"\nexport { SnapOptions, PlugDescriptor, SlotDescriptor } from \"./options/SnapOptions\"\nexport { Metadata, AuthorMetadata, RepositoryInfo } from \"./options/metadata\"\nexport { AppInfo } from \"./appInfo\"\nexport { SquirrelWindowsOptions } from \"./options/SquirrelWindowsOptions\"\n\nexport { CustomMacSign, CustomMacSignOptions } from \"./macPackager\"\nexport { WindowsSignOptions } from \"./codeSign/windowsCodeSign\"\nexport {\n  CustomWindowsSignTaskConfiguration,\n  WindowsSignTaskConfiguration,\n  CustomWindowsSign,\n  FileCodeSigningInfo,\n  CertificateFromStoreInfo,\n} from \"./codeSign/windowsSignToolManager\"\nexport { CancellationToken, ProgressInfo } from \"builder-util-runtime\"\nexport { PublishOptions, UploadTask } from \"electron-publish\"\nexport { PublishManager } from \"./publish/PublishManager\"\nexport { PlatformPackager } from \"./platformPackager\"\nexport { Framework, PrepareApplicationStageDirectoryOptions } from \"./Framework\"\nexport { buildForge, ForgeOptions } from \"./forge-maker\"\nexport { LinuxPackager } from \"./linuxPackager\"\nexport { WinPackager } from \"./winPackager\"\nexport { MacPackager } from \"./macPackager\"\n\nconst expectedOptions = new Set([\"publish\", \"targets\", \"mac\", \"win\", \"linux\", \"projectDir\", \"platformPackagerFactory\", \"config\", \"effectiveOptionComputed\", \"prepackaged\"])\n\nexport function checkBuildRequestOptions(options: PackagerOptions & PublishOptions) {\n  for (const optionName of Object.keys(options)) {\n    if (!expectedOptions.has(optionName) && (options as any)[optionName] !== undefined) {\n      throw new InvalidConfigurationError(`Unknown option \"${optionName}\"`)\n    }\n  }\n}\n\nexport function build(options: PackagerOptions & PublishOptions, packager: Packager = new Packager(options)): Promise<Array<string>> {\n  checkBuildRequestOptions(options)\n\n  const publishManager = new PublishManager(packager, options)\n  const sigIntHandler = () => {\n    log.warn(\"cancelled by SIGINT\")\n    packager.cancellationToken.cancel()\n    publishManager.cancelTasks()\n  }\n  process.once(\"SIGINT\", sigIntHandler)\n\n  const promise = packager.build().then(async buildResult => {\n    const afterAllArtifactBuild = await resolveFunction(packager.appInfo.type, buildResult.configuration.afterAllArtifactBuild, \"afterAllArtifactBuild\")\n    if (afterAllArtifactBuild != null) {\n      const newArtifacts = asArray(await Promise.resolve(afterAllArtifactBuild(buildResult)))\n      if (newArtifacts.length === 0 || !publishManager.isPublish) {\n        return buildResult.artifactPaths\n      }\n\n      const publishConfigurations = await publishManager.getGlobalPublishConfigurations()\n      if (publishConfigurations == null || publishConfigurations.length === 0) {\n        return buildResult.artifactPaths\n      }\n\n      for (const newArtifact of newArtifacts) {\n        if (buildResult.artifactPaths.includes(newArtifact)) {\n          log.warn({ newArtifact }, \"skipping publish of artifact, already published\")\n          continue\n        }\n        buildResult.artifactPaths.push(newArtifact)\n        for (const publishConfiguration of publishConfigurations) {\n          publishManager.scheduleUpload(\n            publishConfiguration,\n            {\n              file: newArtifact,\n              arch: null,\n            },\n            packager.appInfo\n          )\n        }\n      }\n    }\n    return buildResult.artifactPaths\n  })\n\n  return executeFinally(promise, isErrorOccurred => {\n    let promise: Promise<any>\n    if (isErrorOccurred) {\n      publishManager.cancelTasks()\n      promise = Promise.resolve(null)\n    } else {\n      promise = publishManager.awaitTasks()\n    }\n\n    return promise.then(() => process.removeListener(\"SIGINT\", sigIntHandler))\n  })\n}\n"]}

package/out/options/AppXOptions.d.ts

@@ -15,7 +15,7 @@ export interface AppXOptions extends TargetSpecificOptions {
      */
     readonly displayName?: string | null;
     /**
-     * The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](./configuration.md#Metadata-name).
+     * The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](./configuration.md#metadata).
      */
     readonly identityName?: string | null;
     /**

package/out/options/AppXOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppXOptions.js","sourceRoot":"","sources":["../../src/options/AppXOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { TargetSpecificOptions } from \"../core\"\n\nexport interface AppXOptions extends TargetSpecificOptions {\n  /**\n   * The application id. Defaults to `identityName`. This string contains alpha-numeric fields separated by periods. Each field must begin with an ASCII alphabetic character.\n   */\n  readonly applicationId?: string\n\n  /**\n   * The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).\n   * @default #464646\n   */\n  readonly backgroundColor?: string | null\n\n  /**\n   * A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).\n   * Defaults to the application product name.\n   */\n  readonly displayName?: string | null\n\n  /**\n   * The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](./configuration.md#Metadata-name).\n   */\n  readonly identityName?: string | null\n\n  /**\n   * The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.\n   */\n  readonly publisher?: string | null\n\n  /**\n   * A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).\n   * Defaults to company name from the application metadata.\n   */\n  readonly publisherDisplayName?: string | null\n\n  /**\n   * The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.\n   * The first entry (index 0) will be the default language.\n   * Defaults to en-US if omitted.\n   */\n  readonly languages?: Array<string> | string | null\n\n  /**\n   * Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.\n   */\n  readonly addAutoLaunchExtension?: boolean\n\n  /**\n   * Relative path to custom extensions xml to be included in an `appmanifest.xml`.\n   */\n  readonly customExtensionsPath?: string\n\n  /**\n   * Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.\n   * @default false\n   */\n  readonly showNameOnTiles?: boolean\n\n  /**\n   * @private\n   * @default false\n   */\n  readonly electronUpdaterAware?: boolean\n\n  /**\n   * Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875\n   * @default false\n   */\n  readonly setBuildNumber?: boolean\n\n  /**\n   * Set the MinVersion field in the appx manifest.xml\n   * @default arch === Arch.arm64 ? \"10.0.16299.0\" : \"10.0.14316.0\"\n   */\n  readonly minVersion?: string | null\n\n  /**\n   * Set the `MaxVersionTested` field in the appx manifest.xml\n   * @default arch === Arch.arm64 ? \"10.0.16299.0\" : \"10.0.14316.0\"\n   */\n  readonly maxVersionTested?: string | null\n\n  /** @private */\n  readonly makeappxArgs?: Array<string> | null\n}\n"]}
+{"version":3,"file":"AppXOptions.js","sourceRoot":"","sources":["../../src/options/AppXOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { TargetSpecificOptions } from \"../core\"\n\nexport interface AppXOptions extends TargetSpecificOptions {\n  /**\n   * The application id. Defaults to `identityName`. This string contains alpha-numeric fields separated by periods. Each field must begin with an ASCII alphabetic character.\n   */\n  readonly applicationId?: string\n\n  /**\n   * The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).\n   * @default #464646\n   */\n  readonly backgroundColor?: string | null\n\n  /**\n   * A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).\n   * Defaults to the application product name.\n   */\n  readonly displayName?: string | null\n\n  /**\n   * The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](./configuration.md#metadata).\n   */\n  readonly identityName?: string | null\n\n  /**\n   * The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.\n   */\n  readonly publisher?: string | null\n\n  /**\n   * A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).\n   * Defaults to company name from the application metadata.\n   */\n  readonly publisherDisplayName?: string | null\n\n  /**\n   * The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.\n   * The first entry (index 0) will be the default language.\n   * Defaults to en-US if omitted.\n   */\n  readonly languages?: Array<string> | string | null\n\n  /**\n   * Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.\n   */\n  readonly addAutoLaunchExtension?: boolean\n\n  /**\n   * Relative path to custom extensions xml to be included in an `appmanifest.xml`.\n   */\n  readonly customExtensionsPath?: string\n\n  /**\n   * Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.\n   * @default false\n   */\n  readonly showNameOnTiles?: boolean\n\n  /**\n   * @private\n   * @default false\n   */\n  readonly electronUpdaterAware?: boolean\n\n  /**\n   * Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875\n   * @default false\n   */\n  readonly setBuildNumber?: boolean\n\n  /**\n   * Set the MinVersion field in the appx manifest.xml\n   * @default arch === Arch.arm64 ? \"10.0.16299.0\" : \"10.0.14316.0\"\n   */\n  readonly minVersion?: string | null\n\n  /**\n   * Set the `MaxVersionTested` field in the appx manifest.xml\n   * @default arch === Arch.arm64 ? \"10.0.16299.0\" : \"10.0.14316.0\"\n   */\n  readonly maxVersionTested?: string | null\n\n  /** @private */\n  readonly makeappxArgs?: Array<string> | null\n}\n"]}

package/out/options/PlatformSpecificBuildOptions.d.ts

@@ -4,7 +4,7 @@ export interface FileSet {
     /**
      * The source path relative to and defaults to:
      *
-     *  - the [app directory](configuration.md#MetadataDirectories-app) for `files`,
+     *  - the [app directory](configuration.md#directories) for `files`,
      *  - the project directory for `extraResources` and `extraFiles`.
      * If you don't use two-package.json structure and don't set custom app directory, app directory equals to project directory.
      */
@@ -32,7 +32,7 @@ export interface AsarOptions {
 }
 export interface FilesBuildOptions {
     /**
-     * A [glob patterns](./file-patterns.md) relative to the [app directory](configuration.md#MetadataDirectories-app), which specifies which files to include when copying files to create the package.
+     * A [glob patterns](./file-patterns.md) relative to the [app directory](configuration.md#directories), which specifies which files to include when copying files to create the package.
   
   Defaults to:
   ```json
@@ -114,12 +114,12 @@ export interface PlatformSpecificBuildOptions extends TargetSpecificOptions, Fil
     /**
      * Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).
      *
-     * Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.
+     * Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#asarUnpack) - please file an issue if this doesn't work.
      * @default true
      */
     readonly asar?: AsarOptions | boolean | null;
     /**
-     * A [glob patterns](./file-patterns.md) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.
+     * A [glob patterns](./file-patterns.md) relative to the [app directory](#directories), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.
      */
     readonly asarUnpack?: Array<string> | string | null;
     readonly icon?: string | null;
@@ -177,7 +177,7 @@ export interface ReleaseInfo {
      */
     releaseNotes?: string | null;
     /**
-     * The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).
+     * The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](./contents.md#extraresources).
      */
     releaseNotesFile?: string | null;
     /**

package/out/options/PlatformSpecificBuildOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlatformSpecificBuildOptions.js","sourceRoot":"","sources":["../../src/options/PlatformSpecificBuildOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { CompressionLevel, Publish, TargetConfiguration, TargetSpecificOptions } from \"../core\"\nimport { FileAssociation } from \"./FileAssociation\"\n\nexport interface FileSet {\n  /**\n   * The source path relative to and defaults to:\n   *\n   *  - the [app directory](configuration.md#MetadataDirectories-app) for `files`,\n   *  - the project directory for `extraResources` and `extraFiles`.\n   * If you don't use two-package.json structure and don't set custom app directory, app directory equals to project directory.\n   */\n  from?: string\n  /**\n   * The destination path relative to and defaults to:\n   *\n   *  - the asar archive root for `files`,\n   *  - the app's content directory for `extraFiles`,\n   *  - the app's resource directory for `extraResources`.\n   */\n  to?: string\n  /**\n   * The [glob patterns](./file-patterns.md). Defaults to \"**\\/*\"\n   */\n  filter?: Array<string> | string\n}\n\nexport interface AsarOptions {\n  /**\n   * Whether to automatically unpack executables files.\n   * @default true\n   */\n  smartUnpack?: boolean\n\n  ordering?: string | null\n}\n\nexport interface FilesBuildOptions {\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](configuration.md#MetadataDirectories-app), which specifies which files to include when copying files to create the package.\n\nDefaults to:\n```json\n[\n  \"**\\/*\",\n  \"!**\\/node_modules/*\\/{CHANGELOG.md,README.md,README,readme.md,readme}\",\n  \"!**\\/node_modules/*\\/{test,__tests__,tests,powered-test,example,examples}\",\n  \"!**\\/node_modules/*.d.ts\",\n  \"!**\\/node_modules/.bin\",\n  \"!**\\/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}\",\n  \"!.editorconfig\",\n  \"!**\\/._*\",\n  \"!**\\/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}\",\n  \"!**\\/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}\",\n  \"!**\\/{appveyor.yml,.travis.yml,circle.yml}\",\n  \"!**\\/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}\"\n]\n```\n\nDevelopment dependencies are never copied in any case. You don't need to ignore it explicitly. Hidden files are not ignored by default, but all files that should be ignored, are ignored by default.\n\nDefault pattern \\`**\\/*\\` **is not added to your custom** if some of your patterns is not ignore (i.e. not starts with `!`). `package.json` and \\`**\\/node_modules/**\\/*` (only production dependencies will be copied) is added to your custom in any case. All default ignores are added in any case — you don't need to repeat it if you configure own patterns.\n\nMay be specified in the platform options (e.g. in the [mac](mac.md)).\n\nYou may also specify custom source and destination directories by using `FileSet` objects instead of simple glob patterns.\n\n```json\n[\n  {\n    \"from\": \"path/to/source\",\n    \"to\": \"path/to/destination\",\n    \"filter\": [\"**\\/*\", \"!foo/*.js\"]\n  }\n]\n```\n\nYou can use [file macros](./file-patterns.md#file-macros) in the `from` and `to` fields as well. `from` and `to` can be files and you can use this to [rename](https://github.com/electron-userland/electron-builder/issues/1119) a file while packaging.\n   */\n  files?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the project directory, when specified, copy the file or directory with matching names directly into the app's resources directory (`Contents/Resources` for MacOS, `resources` for Linux and Windows).\n   *\n   * File patterns (and support for `from` and `to` fields) the same as for [files](#files).\n   *\n   */\n  extraResources?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * The same as [extraResources](#extraresources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux and Windows).\n   */\n  extraFiles?: Array<FileSet | string> | FileSet | string | null\n}\n\nexport interface PlatformSpecificBuildOptions extends TargetSpecificOptions, FilesBuildOptions {\n  /**\n   * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n   * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\n   * @default com.electron.${name}\n   */\n  readonly appId?: string | null\n\n  /**\n   * The [artifact file name template](./configuration.md#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\n   */\n  readonly artifactName?: string | null\n\n  /**\n   * The executable name. Defaults to `productName`.\n   */\n  readonly executableName?: string | null\n\n  /**\n   * The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\n   * @default normal\n   */\n  readonly compression?: CompressionLevel | null\n\n  /**\n   * Whether to exclude all default ignored files(https://www.electron.build/contents#files) and options. Defaults to `false`.\n   *\n   * @default false\n   */\n  disableDefaultIgnoredFiles?: boolean | null\n\n  /**\n   * Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n   *\n   * Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.\n   * @default true\n   */\n  readonly asar?: AsarOptions | boolean | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\n   */\n  readonly asarUnpack?: Array<string> | string | null\n\n  /*  - @private */\n  readonly icon?: string | null\n\n  /**\n   * The file associations.\n   */\n  readonly fileAssociations?: Array<FileAssociation> | FileAssociation\n  /**\n   * The URL protocol schemes.\n   */\n  readonly protocols?: Array<Protocol> | Protocol\n\n  /**\n   * The electron locales to keep. By default, all Electron locales used as-is.\n   */\n  readonly electronLanguages?: Array<string> | string\n\n  /**\n   * Whether to fail if app will be not code signed.\n   */\n  readonly forceCodeSigning?: boolean\n\n  /**\n   * The [electron-updater compatibility](./auto-update.md#compatibility) semver range.\n   */\n  readonly electronUpdaterCompatibility?: string | null\n\n  publish?: Publish\n\n  /**\n   * Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\n   * @default true\n   */\n  readonly detectUpdateChannel?: boolean\n\n  /**\n   * Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\n   * @default false\n   */\n  readonly generateUpdatesFilesForAllChannels?: boolean\n\n  /**\n   * The release info. Intended for command line usage:\n   *\n   * ```\n   * -c.releaseInfo.releaseNotes=\"new features\"\n   * ```\n   */\n  readonly releaseInfo?: ReleaseInfo\n\n  readonly target?: Array<string | TargetConfiguration> | string | TargetConfiguration | null\n\n  /*  - @private */\n  cscLink?: string | null\n\n  /*  - @private */\n  cscKeyPassword?: string | null\n\n  readonly defaultArch?: string\n}\n\nexport interface ReleaseInfo {\n  /**\n   * The release name.\n   */\n  releaseName?: string | null\n\n  /**\n   * The release notes.\n   */\n  releaseNotes?: string | null\n\n  /**\n   * The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).\n   */\n  releaseNotesFile?: string | null\n\n  /**\n   * The release date.\n   */\n  releaseDate?: string\n\n  /**\n   * Vendor specific information.\n   */\n  vendor?: { [key: string]: any } | null\n}\n\n/**\n * URL Protocol Schemes. Protocols to associate the app with. macOS only.\n *\n * Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).\n */\nexport interface Protocol {\n  /**\n   * The name. e.g. `IRC server URL`.\n   */\n  readonly name: string\n\n  /**\n   * The schemes. e.g. `[\"irc\", \"ircs\"]`.\n   */\n  readonly schemes: Array<string>\n\n  /**\n   * *macOS-only* The app’s role with respect to the type.\n   * @default Editor\n   */\n  readonly role?: \"Editor\" | \"Viewer\" | \"Shell\" | \"None\"\n}\n"]}
+{"version":3,"file":"PlatformSpecificBuildOptions.js","sourceRoot":"","sources":["../../src/options/PlatformSpecificBuildOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { CompressionLevel, Publish, TargetConfiguration, TargetSpecificOptions } from \"../core\"\nimport { FileAssociation } from \"./FileAssociation\"\n\nexport interface FileSet {\n  /**\n   * The source path relative to and defaults to:\n   *\n   *  - the [app directory](configuration.md#directories) for `files`,\n   *  - the project directory for `extraResources` and `extraFiles`.\n   * If you don't use two-package.json structure and don't set custom app directory, app directory equals to project directory.\n   */\n  from?: string\n  /**\n   * The destination path relative to and defaults to:\n   *\n   *  - the asar archive root for `files`,\n   *  - the app's content directory for `extraFiles`,\n   *  - the app's resource directory for `extraResources`.\n   */\n  to?: string\n  /**\n   * The [glob patterns](./file-patterns.md). Defaults to \"**\\/*\"\n   */\n  filter?: Array<string> | string\n}\n\nexport interface AsarOptions {\n  /**\n   * Whether to automatically unpack executables files.\n   * @default true\n   */\n  smartUnpack?: boolean\n\n  ordering?: string | null\n}\n\nexport interface FilesBuildOptions {\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](configuration.md#directories), which specifies which files to include when copying files to create the package.\n\nDefaults to:\n```json\n[\n  \"**\\/*\",\n  \"!**\\/node_modules/*\\/{CHANGELOG.md,README.md,README,readme.md,readme}\",\n  \"!**\\/node_modules/*\\/{test,__tests__,tests,powered-test,example,examples}\",\n  \"!**\\/node_modules/*.d.ts\",\n  \"!**\\/node_modules/.bin\",\n  \"!**\\/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}\",\n  \"!.editorconfig\",\n  \"!**\\/._*\",\n  \"!**\\/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}\",\n  \"!**\\/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}\",\n  \"!**\\/{appveyor.yml,.travis.yml,circle.yml}\",\n  \"!**\\/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}\"\n]\n```\n\nDevelopment dependencies are never copied in any case. You don't need to ignore it explicitly. Hidden files are not ignored by default, but all files that should be ignored, are ignored by default.\n\nDefault pattern \\`**\\/*\\` **is not added to your custom** if some of your patterns is not ignore (i.e. not starts with `!`). `package.json` and \\`**\\/node_modules/**\\/*` (only production dependencies will be copied) is added to your custom in any case. All default ignores are added in any case — you don't need to repeat it if you configure own patterns.\n\nMay be specified in the platform options (e.g. in the [mac](mac.md)).\n\nYou may also specify custom source and destination directories by using `FileSet` objects instead of simple glob patterns.\n\n```json\n[\n  {\n    \"from\": \"path/to/source\",\n    \"to\": \"path/to/destination\",\n    \"filter\": [\"**\\/*\", \"!foo/*.js\"]\n  }\n]\n```\n\nYou can use [file macros](./file-patterns.md#file-macros) in the `from` and `to` fields as well. `from` and `to` can be files and you can use this to [rename](https://github.com/electron-userland/electron-builder/issues/1119) a file while packaging.\n   */\n  files?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the project directory, when specified, copy the file or directory with matching names directly into the app's resources directory (`Contents/Resources` for MacOS, `resources` for Linux and Windows).\n   *\n   * File patterns (and support for `from` and `to` fields) the same as for [files](#files).\n   *\n   */\n  extraResources?: Array<FileSet | string> | FileSet | string | null\n\n  /**\n   * The same as [extraResources](#extraresources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux and Windows).\n   */\n  extraFiles?: Array<FileSet | string> | FileSet | string | null\n}\n\nexport interface PlatformSpecificBuildOptions extends TargetSpecificOptions, FilesBuildOptions {\n  /**\n   * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n   * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.\n   * @default com.electron.${name}\n   */\n  readonly appId?: string | null\n\n  /**\n   * The [artifact file name template](./configuration.md#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).\n   */\n  readonly artifactName?: string | null\n\n  /**\n   * The executable name. Defaults to `productName`.\n   */\n  readonly executableName?: string | null\n\n  /**\n   * The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.\n   * @default normal\n   */\n  readonly compression?: CompressionLevel | null\n\n  /**\n   * Whether to exclude all default ignored files(https://www.electron.build/contents#files) and options. Defaults to `false`.\n   *\n   * @default false\n   */\n  disableDefaultIgnoredFiles?: boolean | null\n\n  /**\n   * Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).\n   *\n   * Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#asarUnpack) - please file an issue if this doesn't work.\n   * @default true\n   */\n  readonly asar?: AsarOptions | boolean | null\n\n  /**\n   * A [glob patterns](./file-patterns.md) relative to the [app directory](#directories), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.\n   */\n  readonly asarUnpack?: Array<string> | string | null\n\n  /*  - @private */\n  readonly icon?: string | null\n\n  /**\n   * The file associations.\n   */\n  readonly fileAssociations?: Array<FileAssociation> | FileAssociation\n  /**\n   * The URL protocol schemes.\n   */\n  readonly protocols?: Array<Protocol> | Protocol\n\n  /**\n   * The electron locales to keep. By default, all Electron locales used as-is.\n   */\n  readonly electronLanguages?: Array<string> | string\n\n  /**\n   * Whether to fail if app will be not code signed.\n   */\n  readonly forceCodeSigning?: boolean\n\n  /**\n   * The [electron-updater compatibility](./auto-update.md#compatibility) semver range.\n   */\n  readonly electronUpdaterCompatibility?: string | null\n\n  publish?: Publish\n\n  /**\n   * Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\n   * @default true\n   */\n  readonly detectUpdateChannel?: boolean\n\n  /**\n   * Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).\n   * @default false\n   */\n  readonly generateUpdatesFilesForAllChannels?: boolean\n\n  /**\n   * The release info. Intended for command line usage:\n   *\n   * ```\n   * -c.releaseInfo.releaseNotes=\"new features\"\n   * ```\n   */\n  readonly releaseInfo?: ReleaseInfo\n\n  readonly target?: Array<string | TargetConfiguration> | string | TargetConfiguration | null\n\n  /*  - @private */\n  cscLink?: string | null\n\n  /*  - @private */\n  cscKeyPassword?: string | null\n\n  readonly defaultArch?: string\n}\n\nexport interface ReleaseInfo {\n  /**\n   * The release name.\n   */\n  releaseName?: string | null\n\n  /**\n   * The release notes.\n   */\n  releaseNotes?: string | null\n\n  /**\n   * The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](./contents.md#extraresources).\n   */\n  releaseNotesFile?: string | null\n\n  /**\n   * The release date.\n   */\n  releaseDate?: string\n\n  /**\n   * Vendor specific information.\n   */\n  vendor?: { [key: string]: any } | null\n}\n\n/**\n * URL Protocol Schemes. Protocols to associate the app with. macOS only.\n *\n * Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).\n */\nexport interface Protocol {\n  /**\n   * The name. e.g. `IRC server URL`.\n   */\n  readonly name: string\n\n  /**\n   * The schemes. e.g. `[\"irc\", \"ircs\"]`.\n   */\n  readonly schemes: Array<string>\n\n  /**\n   * *macOS-only* The app’s role with respect to the type.\n   * @default Editor\n   */\n  readonly role?: \"Editor\" | \"Viewer\" | \"Shell\" | \"None\"\n}\n"]}

package/out/options/SnapOptions.d.ts

@@ -17,7 +17,7 @@ export interface SnapOptions extends CommonLinuxOptions, TargetSpecificOptions {
         [key: string]: string;
     } | null;
     /**
-     * The 78 character long summary. Defaults to [productName](./configuration.md#Configuration-productName).
+     * The 78 character long summary. Defaults to [productName](./configuration.md#productName).
      */
     readonly summary?: string | null;
     /**

package/out/options/SnapOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"SnapOptions.js","sourceRoot":"","sources":["../../src/options/SnapOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { TargetSpecificOptions } from \"../core\"\nimport { CommonLinuxOptions } from \"./linuxOptions\"\n\nexport interface SnapOptions extends CommonLinuxOptions, TargetSpecificOptions {\n  /**\n   * A snap of type base to be used as the execution environment for this snap. Examples: `core`, `core18`, `core20`, `core22`. Defaults to `core20`\n   */\n  readonly base?: string | null\n\n  /**\n   * The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.\n   * @default strict\n   */\n  readonly confinement?: \"devmode\" | \"strict\" | \"classic\" | null\n\n  /**\n   * The custom environment. Defaults to `{\"TMPDIR: \"$XDG_RUNTIME_DIR\"}`. If you set custom, it will be merged with default.\n   */\n  readonly environment?: { [key: string]: string } | null\n\n  /**\n   * The 78 character long summary. Defaults to [productName](./configuration.md#Configuration-productName).\n   */\n  readonly summary?: string | null\n\n  /**\n   * The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the “stable” or “candidate” channels) or “stable” (i.e. a stable release or release candidate, which can be released to all channels).\n   * @default stable\n   */\n  readonly grade?: \"devel\" | \"stable\" | null\n\n  /**\n   * The list of features that must be supported by the core in order for this snap to install.\n   */\n  readonly assumes?: Array<string> | string | null\n\n  /**\n   * The list of debian packages needs to be installed for building this snap.\n   */\n  readonly buildPackages?: Array<string> | null\n\n  /**\n   * The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`.\n   * Defaults to `[\"libnspr4\", \"libnss3\", \"libxss1\", \"libappindicator3-1\", \"libsecret-1-0\"]`.\n   *\n   * If list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom package `foo` in addition to defaults.\n   */\n  readonly stagePackages?: Array<string> | null\n\n  /**\n   * The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).\n   * @default build/snap-hooks\n   */\n  readonly hooks?: string | null\n\n  /**\n   * The list of [plugs](https://snapcraft.io/docs/reference/interfaces).\n   * Defaults to `[\"desktop\", \"desktop-legacy\", \"home\", \"x11\", \"wayland\", \"unity7\", \"browser-support\", \"network\", \"gsettings\", \"audio-playback\", \"pulseaudio\", \"opengl\"]`.\n   *\n   * If list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom plug `foo` in addition to defaults.\n   *\n   * Additional attributes can be specified using object instead of just name of plug:\n   * ```\n   *[\n   *  {\n   *    \"browser-sandbox\": {\n   *      \"interface\": \"browser-support\",\n   *      \"allow-sandbox\": true\n   *    },\n   *  },\n   *  \"another-simple-plug-name\"\n   *]\n   * ```\n   */\n  readonly plugs?: Array<string | PlugDescriptor> | PlugDescriptor | null\n\n  /**\n   * The list of [slots](https://snapcraft.io/docs/reference/interfaces).\n   *\n   * Additional attributes can be specified using object instead of just name of slot:\n   * ```\n   *[\n   *  {\n   *    \"mpris\": {\n   *      \"name\": \"chromium\"\n   *    },\n   *  }\n   *]\n   *\n   * In case you want your application to be a compliant MPris player, you will need to definie\n   * The mpris slot with \"chromium\" name.\n   * This electron has it [hardcoded](https://source.chromium.org/chromium/chromium/src/+/master:components/system_media_controls/linux/system_media_controls_linux.cc;l=51;bpv=0;bpt=1),\n   * and we need to pass this name so snap [will allow it](https://forum.snapcraft.io/t/unable-to-use-mpris-interface/15360/7) in strict confinement.\n   *\n   */\n  readonly slots?: Array<string | SlotDescriptor> | PlugDescriptor | null\n\n  /**\n   * Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part.\n   * Defaults to `[\"desktop-gtk2\"\"]`.\n   *\n   * If list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom parts `foo` in addition to defaults.\n   */\n  readonly after?: Array<string> | null\n\n  /**\n   * Whether to use template snap. Defaults to `true` if `stagePackages` not specified.\n   */\n  readonly useTemplateApp?: boolean\n\n  /**\n   * Whether or not the snap should automatically start on login.\n   * @default false\n   */\n  readonly autoStart?: boolean\n\n  /**\n   * Specifies any files to make accessible from locations such as `/usr`, `/var`, and `/etc`. See [snap layouts](https://snapcraft.io/docs/snap-layouts) to learn more.\n   */\n  readonly layout?: { [key: string]: { [key: string]: string } } | null\n\n  /**\n   * Specifies which files from the app part to stage and which to exclude. Individual files, directories, wildcards, globstars, and exclusions are accepted. See [Snapcraft filesets](https://snapcraft.io/docs/snapcraft-filesets) to learn more about the format.\n   *\n   * The defaults can be found in [snap.ts](https://github.com/electron-userland/electron-builder/blob/master/packages/app-builder-lib/templates/snap/snapcraft.yaml#L29).\n   */\n  readonly appPartStage?: Array<string> | null\n\n  /**\n   * An optional title for the snap, may contain uppercase letters and spaces. Defaults to `productName`. See [snap format documentation](https://snapcraft.io/docs/snap-format).\n   */\n  readonly title?: string | null\n\n  /**\n   * Sets the compression type for the snap. Can be xz, lzo, or null.\n   */\n  readonly compression?: \"xz\" | \"lzo\" | null\n\n  /**\n   * Allow running the program with native wayland support with --ozone-platform=wayland.\n   * Disabled by default because of this issue in older Electron/Snap versions: https://github.com/electron-userland/electron-builder/issues/4007\n   */\n  readonly allowNativeWayland?: boolean | null\n}\n\nexport interface PlugDescriptor {\n  [key: string]: { [key: string]: any } | null\n}\n\nexport interface SlotDescriptor {\n  [key: string]: { [key: string]: any } | null\n}\n"]}
+{"version":3,"file":"SnapOptions.js","sourceRoot":"","sources":["../../src/options/SnapOptions.ts"],"names":[],"mappings":"","sourcesContent":["import { TargetSpecificOptions } from \"../core\"\nimport { CommonLinuxOptions } from \"./linuxOptions\"\n\nexport interface SnapOptions extends CommonLinuxOptions, TargetSpecificOptions {\n  /**\n   * A snap of type base to be used as the execution environment for this snap. Examples: `core`, `core18`, `core20`, `core22`. Defaults to `core20`\n   */\n  readonly base?: string | null\n\n  /**\n   * The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.\n   * @default strict\n   */\n  readonly confinement?: \"devmode\" | \"strict\" | \"classic\" | null\n\n  /**\n   * The custom environment. Defaults to `{\"TMPDIR: \"$XDG_RUNTIME_DIR\"}`. If you set custom, it will be merged with default.\n   */\n  readonly environment?: { [key: string]: string } | null\n\n  /**\n   * The 78 character long summary. Defaults to [productName](./configuration.md#productName).\n   */\n  readonly summary?: string | null\n\n  /**\n   * The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the “stable” or “candidate” channels) or “stable” (i.e. a stable release or release candidate, which can be released to all channels).\n   * @default stable\n   */\n  readonly grade?: \"devel\" | \"stable\" | null\n\n  /**\n   * The list of features that must be supported by the core in order for this snap to install.\n   */\n  readonly assumes?: Array<string> | string | null\n\n  /**\n   * The list of debian packages needs to be installed for building this snap.\n   */\n  readonly buildPackages?: Array<string> | null\n\n  /**\n   * The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`.\n   * Defaults to `[\"libnspr4\", \"libnss3\", \"libxss1\", \"libappindicator3-1\", \"libsecret-1-0\"]`.\n   *\n   * If list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom package `foo` in addition to defaults.\n   */\n  readonly stagePackages?: Array<string> | null\n\n  /**\n   * The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).\n   * @default build/snap-hooks\n   */\n  readonly hooks?: string | null\n\n  /**\n   * The list of [plugs](https://snapcraft.io/docs/reference/interfaces).\n   * Defaults to `[\"desktop\", \"desktop-legacy\", \"home\", \"x11\", \"wayland\", \"unity7\", \"browser-support\", \"network\", \"gsettings\", \"audio-playback\", \"pulseaudio\", \"opengl\"]`.\n   *\n   * If list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom plug `foo` in addition to defaults.\n   *\n   * Additional attributes can be specified using object instead of just name of plug:\n   * ```\n   *[\n   *  {\n   *    \"browser-sandbox\": {\n   *      \"interface\": \"browser-support\",\n   *      \"allow-sandbox\": true\n   *    },\n   *  },\n   *  \"another-simple-plug-name\"\n   *]\n   * ```\n   */\n  readonly plugs?: Array<string | PlugDescriptor> | PlugDescriptor | null\n\n  /**\n   * The list of [slots](https://snapcraft.io/docs/reference/interfaces).\n   *\n   * Additional attributes can be specified using object instead of just name of slot:\n   * ```\n   *[\n   *  {\n   *    \"mpris\": {\n   *      \"name\": \"chromium\"\n   *    },\n   *  }\n   *]\n   *\n   * In case you want your application to be a compliant MPris player, you will need to definie\n   * The mpris slot with \"chromium\" name.\n   * This electron has it [hardcoded](https://source.chromium.org/chromium/chromium/src/+/master:components/system_media_controls/linux/system_media_controls_linux.cc;l=51;bpv=0;bpt=1),\n   * and we need to pass this name so snap [will allow it](https://forum.snapcraft.io/t/unable-to-use-mpris-interface/15360/7) in strict confinement.\n   *\n   */\n  readonly slots?: Array<string | SlotDescriptor> | PlugDescriptor | null\n\n  /**\n   * Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part.\n   * Defaults to `[\"desktop-gtk2\"\"]`.\n   *\n   * If list contains `default`, it will be replaced to default list, so, `[\"default\", \"foo\"]` can be used to add custom parts `foo` in addition to defaults.\n   */\n  readonly after?: Array<string> | null\n\n  /**\n   * Whether to use template snap. Defaults to `true` if `stagePackages` not specified.\n   */\n  readonly useTemplateApp?: boolean\n\n  /**\n   * Whether or not the snap should automatically start on login.\n   * @default false\n   */\n  readonly autoStart?: boolean\n\n  /**\n   * Specifies any files to make accessible from locations such as `/usr`, `/var`, and `/etc`. See [snap layouts](https://snapcraft.io/docs/snap-layouts) to learn more.\n   */\n  readonly layout?: { [key: string]: { [key: string]: string } } | null\n\n  /**\n   * Specifies which files from the app part to stage and which to exclude. Individual files, directories, wildcards, globstars, and exclusions are accepted. See [Snapcraft filesets](https://snapcraft.io/docs/snapcraft-filesets) to learn more about the format.\n   *\n   * The defaults can be found in [snap.ts](https://github.com/electron-userland/electron-builder/blob/master/packages/app-builder-lib/templates/snap/snapcraft.yaml#L29).\n   */\n  readonly appPartStage?: Array<string> | null\n\n  /**\n   * An optional title for the snap, may contain uppercase letters and spaces. Defaults to `productName`. See [snap format documentation](https://snapcraft.io/docs/snap-format).\n   */\n  readonly title?: string | null\n\n  /**\n   * Sets the compression type for the snap. Can be xz, lzo, or null.\n   */\n  readonly compression?: \"xz\" | \"lzo\" | null\n\n  /**\n   * Allow running the program with native wayland support with --ozone-platform=wayland.\n   * Disabled by default because of this issue in older Electron/Snap versions: https://github.com/electron-userland/electron-builder/issues/4007\n   */\n  readonly allowNativeWayland?: boolean | null\n}\n\nexport interface PlugDescriptor {\n  [key: string]: { [key: string]: any } | null\n}\n\nexport interface SlotDescriptor {\n  [key: string]: { [key: string]: any } | null\n}\n"]}

package/out/options/linuxOptions.d.ts

@@ -10,15 +10,15 @@ export interface LinuxConfiguration extends CommonLinuxOptions, PlatformSpecific
      */
     readonly target?: TargetConfigType;
     /**
-     * The maintainer. Defaults to [author](./configuration.md#Metadata-author).
+     * The maintainer. Defaults to [author](./configuration.md#author).
      */
     readonly maintainer?: string | null;
     /**
-     * The vendor. Defaults to [author](./configuration.md#Metadata-author).
+     * The vendor. Defaults to [author](./configuration.md#author).
      */
     readonly vendor?: string | null;
     /**
-     * The path to icon set directory or one png file, relative to the [build resources](./configuration.md#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.
+     * The path to icon set directory or one png file, relative to the [build resources](./contents.md#extraresources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.
      * By default will be generated automatically based on the macOS icns file.
      */
     readonly icon?: string;
@@ -34,7 +34,7 @@ export interface CommonLinuxOptions {
      */
     readonly synopsis?: string | null;
     /**
-     * As [description](./configuration.md#Metadata-description) from application package.json, but allows you to specify different for Linux.
+     * As [description](./configuration.md#description) from application package.json, but allows you to specify different for Linux.
      */
     readonly description?: string | null;
     /**