@loongdotjs/electron-winstaller 5.4.0

package/.circleci/config.yml

@@ -0,0 +1,95 @@
+version: 2.1
+
+orbs:
+  cfa: continuousauth/npm@2.1.0
+  node: electronjs/node@2.3.0
+
+jobs:
+  test:
+    environment:
+      # prevent Wine popup dialogs about installing additional packages
+      WINEDLLOVERRIDES: mscoree,mshtml=
+      WINEDEBUG: -all
+    executor: <<parameters.executor>>
+    parameters:
+      executor:
+        description: The executor to use for the job.
+        type: string
+      node-version:
+        description: Specify the Node.js version to install.
+        type: string
+    steps:
+      - node/test:
+          override-ci-command: |
+            if [ << parameters.node-version >> = '14.21' ]; then
+              yarn install --frozen-lockfile --ignore-engines
+            else
+              yarn install --frozen-lockfile
+            fi
+          checkout-steps:
+            - when:
+                condition:
+                  equal: [ node/macos, << parameters.executor >> ]
+                steps:
+                  - restore_cache:
+                      name: Restoring Homebrew cache
+                      paths:
+                        - /usr/local/Homebrew
+                      keys:
+                        - v1-brew-cache-{{ arch }}
+            - run:
+                name: Install OS Dependencies
+                command: |
+                  case "$(uname)" in
+                    Linux)
+                      sudo dpkg --add-architecture i386
+                      sudo apt-get -qq update
+                      sudo apt-get install --no-install-recommends -y wine64 wine32 wine mono-devel
+                      wine64 hostname
+                    ;;
+                    Darwin)
+                      brew install --cask xquartz
+                      brew tap homebrew/cask-versions
+                      brew install --cask --no-quarantine wine-stable
+                      brew install mono
+                      wine64 hostname
+                    ;;
+                  esac
+            - when:
+                condition:
+                  equal: [ node/macos, << parameters.executor >> ]
+                steps:
+                  - save_cache:
+                      name: Persisting Homebrew cache
+                      paths:
+                        - /usr/local/Homebrew
+                      key: v1-brew-cache-{{ arch }}
+            - checkout
+          node-version: << parameters.node-version >>
+
+workflows:
+  test_and_release:
+    # Run the test jobs first, then the release only when all the test jobs are successful
+    jobs:
+      - test:
+          name: test-<< matrix.executor >>-<< matrix.node-version >>
+          matrix:
+            alias: test
+            parameters:
+              executor:
+                - node/linux
+                # - node/macos
+                - node/windows
+              node-version:
+                - '20.10'
+                - '18.18'
+                - '16.20'
+                - '14.21'
+      - cfa/release:
+          requires:
+            - test
+          filters:
+            branches:
+              only:
+                - main
+          context: cfa-release

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintrc.json

@@ -0,0 +1,30 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint",
+    "ava"
+  ],
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:ava/recommended",
+    "eslint:recommended"
+  ],
+  "rules": {
+    "strict": 0,
+    "@typescript-eslint/indent": [
+      2,
+      2
+    ],
+    "@typescript-eslint/no-var-requires": "off",
+    "semi": [
+      2,
+      "always"
+    ],
+    "no-console": 0,
+    "quotes": [2, "single", "avoid-escape"]
+  },
+  "env": {
+    "es6": true,
+    "node": true
+  }
+}

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @electron/wg-ecosystem

package/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

package/.github/workflows/add-to-project.yml

@@ -0,0 +1,29 @@
+name: Add to Ecosystem WG Project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request_target:
+    types:
+      - opened
+
+permissions: {}
+
+jobs:
+  add-to-project:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate GitHub App token
+        uses: electron/github-app-auth-action@384fd19694fe7b6dcc9a684746c6976ad78228ae # v1.1.1
+        id: generate-token
+        with:
+          creds: ${{ secrets.ECOSYSTEM_ISSUE_TRIAGE_GH_APP_CREDS }}
+          org: electron
+      - name: Add to Project
+        uses: dsanders11/project-actions/add-item@eb760c48894b5702398529cbb8f6e98378e315d0 # v1.3.0
+        with:
+          field: Opened
+          field-value: ${{ github.event.pull_request.created_at || github.event.issue.created_at }}
+          project-number: 89
+          token: ${{ steps.generate-token.outputs.token }}

package/.github/workflows/semantic.yml

@@ -0,0 +1,26 @@
+name: "Check Semantic Commit"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  contents: read
+
+jobs:
+  main:
+    permissions:
+      pull-requests: read  # for amannn/action-semantic-pull-request to analyze PRs
+      statuses: write  # for amannn/action-semantic-pull-request to mark status of analyzed PR
+    name: Validate PR Title
+    runs-on: ubuntu-latest
+    steps:
+      - name: semantic-pull-request
+        uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5.5.3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          validateSingleCommit: false

package/.gitignore

@@ -0,0 +1,18 @@
+node_modules/
+build/
+tasks/
+lib/
+.idea/
+npm-debug.log
+SquirrelSetup.log
+electron-windows-sign.log
+receiver.mjs
+signtool-original.exe
+Squirrel-Releasify.log
+.node-version
+.DS_Store
+spec/fixtures/app/Update.exe
+vendor/7z.dll
+vendor/7z.exe
+hook.log
+docs

package/.releaserc.json

@@ -0,0 +1,9 @@
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@continuous-auth/semantic-release-npm",
+    "@semantic-release/github"
+  ],
+  "branches": [ "main" ]
+}

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,189 @@
+# Electron Installer
+
+[![CircleCI](https://circleci.com/gh/electron/windows-installer.svg?style=shield)](https://circleci.com/gh/electron/windows-installer)
+[![NPM package](https://img.shields.io/npm/v/electron-winstaller)](https://npm.im/electron-winstaller)
+
+NPM module that builds Windows installers for
+[Electron](https://github.com/electron/electron) apps using
+[Squirrel](https://github.com/Squirrel/Squirrel.Windows).
+
+## Installing
+
+```sh
+npm install --save-dev electron-winstaller
+```
+
+## Usage
+
+Require the package:
+
+```javascript
+const electronInstaller = require('electron-winstaller');
+```
+
+Then do a build like so..
+
+```javascript
+try {
+  await electronInstaller.createWindowsInstaller({
+    appDirectory: '/tmp/build/my-app-64',
+    outputDirectory: '/tmp/build/installer64',
+    authors: 'My App Inc.',
+    exe: 'myapp.exe'
+  });
+  console.log('It worked!');
+} catch (e) {
+  console.log(`No dice: ${e.message}`);
+}
+```
+
+After running you will have an `.nupkg`, a
+`RELEASES` file, and a `.exe` installer file in the `outputDirectory` folder
+for each multi task target given under the config entry.
+
+There are several configuration settings supported:
+
+| Config Name           | Required | Description |
+| --------------------- | -------- | ----------- |
+| `appDirectory`        | Yes      | The folder path of your Electron app |
+| `outputDirectory`     | No       | The folder path to create the `.exe` installer in. Defaults to the `installer` folder at the project root. |
+| `loadingGif`          | No       | The local path to a `.gif` file to display during install. |
+| `authors`             | Yes      | The authors value for the nuget package metadata. Defaults to the `author` field from your app's package.json file when unspecified. |
+| `owners`              | No       | The owners value for the nuget package metadata. Defaults to the `authors` field when unspecified. |
+| `exe`                 | No       | The name of your app's main `.exe` file. This uses the `name` field in your app's package.json file with an added `.exe` extension when unspecified. |
+| `description`         | No       | The description value for the nuget package metadata. Defaults to the `description` field from your app's package.json file when unspecified. |
+| `version`             | No       | The version value for the nuget package metadata. Defaults to the `version` field from your app's package.json file when unspecified. |
+| `title`               | No       | The title value for the nuget package metadata. Defaults to the `productName` field and then the `name` field from your app's package.json file when unspecified. |
+| `name`                | No      | Windows Application Model ID (appId). Defaults to the `name` field in your app's package.json file. |
+| `certificateFile`     | No       | The path to an Authenticode Code Signing Certificate |
+| `certificatePassword` | No       | The password to decrypt the certificate given in `certificateFile` |
+| `signWithParams`      | No       | Params to pass to signtool.  Overrides `certificateFile` and `certificatePassword`. |
+| `iconUrl`             | No       | A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Atom icon. |
+| `setupIcon`           | No       | The ICO file to use as the icon for the generated Setup.exe |
+| `skipUpdateIcon`      | No       | Disables setting the icon of `Update.exe`. This can solve installation errors with the following message: "This application could not be started", when the setup is built on a non-Windows system. |
+| `setupExe`            | No       | The name to use for the generated Setup.exe file |
+| `setupMsi`            | No       | The name to use for the generated Setup.msi file |
+| `noMsi`               | No       | Should Squirrel.Windows create an MSI installer? |
+| `noDelta`             | No       | Should Squirrel.Windows delta packages? (disable only if necessary, they are a Good Thing) |
+| `remoteReleases`      | No       | A URL to your existing updates. If given, these will be downloaded to create delta updates |
+| `remoteToken`         | No       | Authentication token for remote updates |
+| `frameworkVersion`    | No       | Set the required .NET framework version, e.g. `net461` |
+| `windowsSign`         | No       | Use [@electron/windows-sign][@electron/windows-sign] for advanced codesigning. See [documentation](#advanced-codesigning-with-electronwindows-sign) for details. |
+
+## Sign your installer or else bad things will happen
+
+For development / internal use, creating installers without a signature is okay, but for a production app you need to sign your application. Internet Explorer's SmartScreen filter will block your app from being downloaded, and many anti-virus vendors will consider your app as malware unless you obtain a valid cert.
+
+Any certificate valid for "Authenticode Code Signing" will work here, but if you get the right kind of code certificate, you can also opt-in to [Windows Error Reporting](http://en.wikipedia.org/wiki/Windows_Error_Reporting). [This MSDN page](http://msdn.microsoft.com/en-us/library/windows/hardware/hh801887.aspx) has the latest links on where to get a WER-compatible certificate. The "Standard Code Signing" certificate is sufficient for this purpose.
+
+## Handling Squirrel Events
+
+Squirrel will spawn your app with command line flags on first run, updates,
+and uninstalls. it is **very** important that your app handle these events as _early_
+as possible, and quit **immediately** after handling them. Squirrel will give your
+app a short amount of time (~15sec) to apply these operations and quit.
+
+The [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) module will handle
+the most common events for you, such as managing desktop shortcuts. Add the following to the top
+of your `main.js` and you're good to go:
+
+```javascript
+if (require('electron-squirrel-startup')) return;
+```
+
+You should handle these events in your app's `main` entry point with something
+such as:
+
+```javascript
+const app = require('app');
+
+// this should be placed at top of main.js to handle setup events quickly
+if (handleSquirrelEvent()) {
+  // squirrel event handled and app will exit in 1000ms, so don't do anything else
+  return;
+}
+
+function handleSquirrelEvent() {
+  if (process.argv.length === 1) {
+    return false;
+  }
+
+  const ChildProcess = require('child_process');
+  const path = require('path');
+
+  const appFolder = path.resolve(process.execPath, '..');
+  const rootAtomFolder = path.resolve(appFolder, '..');
+  const updateDotExe = path.resolve(path.join(rootAtomFolder, 'Update.exe'));
+  const exeName = path.basename(process.execPath);
+
+  const spawn = function(command, args) {
+    let spawnedProcess, error;
+
+    try {
+      spawnedProcess = ChildProcess.spawn(command, args, {detached: true});
+    } catch (error) {}
+
+    return spawnedProcess;
+  };
+
+  const spawnUpdate = function(args) {
+    return spawn(updateDotExe, args);
+  };
+
+  const squirrelEvent = process.argv[1];
+  switch (squirrelEvent) {
+    case '--squirrel-install':
+    case '--squirrel-updated':
+      // Optionally do things such as:
+      // - Add your .exe to the PATH
+      // - Write to the registry for things like file associations and
+      //   explorer context menus
+
+      // Install desktop and start menu shortcuts
+      spawnUpdate(['--createShortcut', exeName]);
+
+      setTimeout(app.quit, 1000);
+      return true;
+
+    case '--squirrel-uninstall':
+      // Undo anything you did in the --squirrel-install and
+      // --squirrel-updated handlers
+
+      // Remove desktop and start menu shortcuts
+      spawnUpdate(['--removeShortcut', exeName]);
+
+      setTimeout(app.quit, 1000);
+      return true;
+
+    case '--squirrel-obsolete':
+      // This is called on the outgoing version of your app before
+      // we update to the new version - it's the opposite of
+      // --squirrel-updated
+
+      app.quit();
+      return true;
+  }
+};
+```
+
+Notice that the first time the installer launches your app, your app will see a `--squirrel-firstrun` flag. This allows you to do things like showing up a splash screen or presenting a settings UI. Another thing to be aware of is that, since the app is spawned by squirrel and squirrel acquires a file lock during installation, you won't be able to successfully check for app updates till a few seconds later when squirrel releases the lock.
+
+## Advanced codesigning with [@electron/windows-sign][@electron/windows-sign]
+
+This package supports two different ways to codesign your application and the installer:
+
+1) Modern: By passing a `windowsSign` option, which will be passed to [@electron/windows-sign]. This method allows full customization of the code-signing process - and supports more complicated scenarios like cloud-hosted EV certificates, custom sign pipelines, and per-file overrides. It also supports all existing "simple" codesigning scenarios, including just passing a certificate file and password. Please see https://github.com/@electron/windows-sign for all possible configuration options.
+  
+    When passing `windowsSign`, do not pass any other available parameters at the top level (like `certificateFile`, `certificatePassword`, or `signWithParams`).
+
+2) Legacy: By passing the top-level settings (`certificateFile`, `certificatePassword`, and `signWithParams`). For simple codesigning scenarios, there's no reason not to use this method - it'll work just as fine as the modern method.
+
+## Debugging this package
+
+You can get debug messages from this package by running with the environment variable `DEBUG=electron-windows-installer:main` e.g.
+
+```shell
+DEBUG=electron-windows-installer:main node tasks/electron-winstaller.js
+```
+
+[@electron/windows-sign]: https://github.com/electron/windows-sign/

package/lib/index.d.ts

@@ -0,0 +1,20 @@
+import { SquirrelWindowsOptions } from './options';
+export { SquirrelWindowsOptions } from './options';
+export { SquirrelWindowsOptions as Options } from './options';
+/**
+ * A utility function to convert SemVer version strings into NuGet-compatible
+ * version strings.
+ * @param version A SemVer version string
+ * @returns A NuGet-compatible version string
+ * @see {@link https://semver.org/ | Semantic Versioning specification}
+ * @see {@link https://learn.microsoft.com/en-us/nuget/concepts/package-versioning?tabs=semver20sort | NuGet versioning specification}
+ */
+export declare function convertVersion(version: string): string;
+/**
+ * This package's main function, which creates a Squirrel.Windows executable
+ * installer and optionally code-signs the output.
+ *
+ * @param options Options for installer generation and signing
+ * @see {@link https://github.com/Squirrel/Squirrel.Windows | Squirrel.Windows}
+ */
+export declare function createWindowsInstaller(options: SquirrelWindowsOptions): Promise<void>;