feat: custom app scheme

Closes #575

docs/Options.md

@@ -58,7 +58,8 @@ Here documented only `electron-builder` specific options:
 | files | <a name="BuildMetadata-files"></a><p>A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the [app directory](#MetadataDirectories-app), which specifies which files to include when copying files to create the package.</p> <p>See [File Patterns](#multiple-glob-patterns).</p>
 | extraResources | <a name="BuildMetadata-extraResources"></a><p>A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the project directory, when specified, copy the file or directory with matching names directly into the app’s resources directory (<code>Contents/Resources</code> for MacOS, <code>resources</code> for Linux/Windows).</p> <p>Glob rules the same as for [files](#multiple-glob-patterns).</p>
 | extraFiles | <a name="BuildMetadata-extraFiles"></a>The same as [extraResources](#BuildMetadata-extraResources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux/Windows).
-| fileAssociations | <a name="BuildMetadata-fileAssociations"></a>File associations. See [.build.fileAssociations](#FileAssociation).
+| fileAssociations | <a name="BuildMetadata-fileAssociations"></a>The file associations. See [.build.fileAssociations](#FileAssociation).
+| protocols | <a name="BuildMetadata-protocols"></a>The URL protocol scheme(s) to associate the app with. See [.build.protocol](#Protocol).
 | mac | <a name="BuildMetadata-mac"></a>See [.build.mac](#MacOptions).
 | dmg | <a name="BuildMetadata-dmg"></a>See [.build.dmg](#DmgOptions).
 | mas | <a name="BuildMetadata-mas"></a>See [.build.mas](#MasBuildOptions).
@@ -172,6 +173,16 @@ NSIS only, [in progress](/~https://github.com/electron-userland/electron-builder/i
 | description | <a name="FileAssociation-description"></a>*windows-only.* The description.
 | icon | <a name="FileAssociation-icon"></a>*windows-only.* The path to icon (`.ico`), relative to `build` (build resources directory). Defaults to `${ext}.ico`.
 
+<a name="Protocol"></a>
+### `.build.protocols`
+
+macOS only.
+
+| Name | Description
+| --- | ---
+| **name** | <a name="Protocol-name"></a>The name. e.g. `IRC server URL`
+| **schemes** | <a name="Protocol-schemes"></a>The schemes. e.g. `["irc", "ircs"]`
+
 <a name="MetadataDirectories"></a>
 ## `.directories`
 | Name | Description

src/metadata.ts

@@ -145,10 +145,15 @@ export interface BuildMetadata {
   readonly extraFiles?: Array<string> | string | null
 
   /*
-  File associations. See [.build.fileAssociations](#FileAssociation).
+  The file associations. See [.build.fileAssociations](#FileAssociation).
    */
   readonly fileAssociations?: Array<FileAssociation> | FileAssociation
 
+  /*
+  The URL protocol scheme(s) to associate the app with. See [.build.protocol](#Protocol).
+  */
+  readonly protocols?: Array<Protocol> | Protocol
+
   /*
    See [.build.mac](#MacOptions).
    */
@@ -490,12 +495,12 @@ export interface LinuxBuildOptions extends PlatformSpecificBuildOptions {
  */
 export interface FileAssociation {
   /*
-  The extension (minus the leading period). e.g. `png`
+  The extension (minus the leading period). e.g. `png`.
    */
   readonly ext: string
 
   /*
-   The name. e.g. `PNG`
+   The name. e.g. `PNG`.
    */
   readonly name: string
 
@@ -510,6 +515,23 @@ export interface FileAssociation {
   readonly icon?: string
 }
 
+/*
+ ### `.build.protocols`
+
+ macOS only.
+ */
+export interface Protocol {
+  /*
+   The name. e.g. `IRC server URL`.
+   */
+  readonly name: string
+
+  /*
+  The schemes. e.g. `["irc", "ircs"]`.
+  */
+  readonly schemes: Array<string>
+}
+
 /*
  ## `.directories`
  */

src/packager/dirPackager.ts

@@ -3,6 +3,7 @@ import { emptyDir } from "fs-extra-p"
 import { warn } from "../util/log"
 import { AppInfo } from "../appInfo"
 import { PlatformPackager } from "../platformPackager"
+import { Protocol } from "../metadata"
 
 const downloadElectron: (options: any) => Promise<any> = BluebirdPromise.promisify(require("electron-download"))
 const extract: any = BluebirdPromise.promisify(require("extract-zip"))
@@ -13,8 +14,6 @@ const __awaiter = require("../util/awaiter")
 export interface ElectronPackagerOptions {
   "extend-info"?: string
 
-  protocols?: any
-
   appInfo: AppInfo
   platformPackager: PlatformPackager<any>
 

src/packager/mac.ts

@@ -3,7 +3,7 @@ import { rename, readFile, writeFile, copy } from "fs-extra-p"
 import * as path from "path"
 import { parse as parsePlist, build as buildPlist } from "plist"
 import { Promise as BluebirdPromise } from "bluebird"
-import { use } from "../util/util"
+import { use, asArray } from "../util/util"
 
 //noinspection JSUnusedLocalSymbols
 const __awaiter = require("../util/awaiter")
@@ -79,11 +79,12 @@ export async function createApp(opts: ElectronPackagerOptions, appOutDir: string
   })
   use(appInfo.buildVersion, it => appPlist.CFBundleVersion = it)
 
-  if (opts.protocols && opts.protocols.length) {
-    appPlist.CFBundleURLTypes = opts.protocols.map(function (protocol: any) {
+  const protocols = asArray(opts.platformPackager.devMetadata.build.protocols).concat(asArray(opts.platformPackager.platformSpecificBuildOptions.protocols))
+  if (protocols.length > 0) {
+    appPlist.CFBundleURLTypes = protocols.map(protocol => {
       return {
         CFBundleURLName: protocol.name,
-        CFBundleURLSchemes: [].concat(protocol.schemes)
+        CFBundleURLSchemes: protocol.schemes.slice()
       }
     })
   }

src/targets/nsis.ts

@@ -1,6 +1,6 @@
 import { WinPackager } from "../winPackager"
 import { Arch, NsisOptions, FileAssociation } from "../metadata"
-import { exec, debug, doSpawn, handleProcess, use } from "../util/util"
+import { exec, debug, doSpawn, handleProcess, use, asArray } from "../util/util"
 import * as path from "path"
 import { Promise as BluebirdPromise } from "bluebird"
 import { getBinFromBintray } from "../util/binDownload"
@@ -285,16 +285,4 @@ export default class NsisTarget extends Target {
 // remove leading dot
 function normalizeExt(ext: string) {
   return ext.startsWith(".") ? ext.substring(1) : ext
-}
-
-function asArray<T>(v: n | T | Array<T>): Array<T> {
-  if (v == null) {
-    return []
-  }
-  else if (Array.isArray(v)) {
-    return v
-  }
-  else {
-    return [v]
-  }
 }

src/util/util.ts

@@ -274,4 +274,16 @@ export function unlinkIfExists(file: string) {
     .catch(() => {
       // ignore
     })
+}
+
+export function asArray<T>(v: n | T | Array<T>): Array<T> {
+  if (v == null) {
+    return []
+  }
+  else if (Array.isArray(v)) {
+    return v
+  }
+  else {
+    return [v]
+  }
 }