CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning using Conventional Commits.

Since v4.6.0, we have switched to automated releases and this file does not need to be manually updated.

4.7.1 (2024-03-30)

Bug Fixes

• get: missing import (bd2273a)

Chores

• deps: reconfigure dependabot (698ecd5)

4.7.0 (2024-03-26)

Features

• get: support file:// for options.downloadUrl (094567c)

Chores

• deps: bump follow-redirects from 1.15.5 to 1.15.6 (#1052) (8258de9)
• deps: bump the gha group in /.github/workflows with 1 update (#1054) (1935800)
• deps: bump the gha group in /.github/workflows with 2 updates (#1051) (0362403)
• deps: bump the npm group with 1 update (#1055) (5a7bc71)
• deps: bump the npm group with 3 updates (#1050) (a70aabc)
• deps: bump the npm group with 8 updates (#1048) (0ca3c34)
• get: deprecate get mode (#1053) (386fc18)

4.6.4 (2024-02-24)

Bug Fixes

• get: copy ffmpeg to correct location on windows (#1044) (71fa4ab)

4.6.3 (2024-02-22)

Bug Fixes

• get: correct ffmpeg path (#1042) (391a6e1)

Chores

• docs: update contributing guidelines (ca594df)

4.6.2 (2024-02-22)

Bug Fixes

• get: ffmpeg and symlinks (d5c1bf5)

Chores

• deps: bump ip from 2.0.0 to 2.0.1 (2284d52)

4.6.1 (2024-02-15)

Chores

• ci: add chores section to changelog (#1028) (d630720)
• ci: fixup release please action (#1032) (f9ae7cd)
• ci: remove schema prop (33238b1)
• deps: bump the gha group in /.github/workflows with 1 update (70030df)
• docs: update PR template to simplify commit descriptions (#1029) (6da9b89)
• docs: update readme and changelog (63fd50b)
• fix remaining lint errors (334ae74)
• get: refactor implementation (#1025) (72f65e1)
• get: refactor unzip symlink implementation (#1030) (69661c3)
• get: simplify symlink logic (#1035) (4f64307), closes #1030
• release-please-action: do not point to manifest file (96eeec8)
• release-please-action: point to config and manifest (0a6a44d)
• release-please: correct path to package (3719cee)
• release-please: remove manifest (23a16fb)
• run: mark run mode as deprecated (#1027) (1115728)
• test: try adding chores to release notes (#1031) (5cabc20)

4.6.0 (2024-02-01)

Features

• get: set cacheDir on another volume (#1023) (7c0f711), closes #1017

[Unreleased]

[4.5.4] - 2024-01-23

Changed

• Migrate from unzipper to yauzl-promise to prevent corrupting files.

[4.5.3] - 2023-12-20

Changed

• Wrap unzipper call inside Promise to prevent race condition.

[4.5.2] - 2023-12-19

Changed

• Fix yargs/helpers import for cli usage.

[4.5.1] - 2023-12-19

Changed

• Manually create symbolic links for MacOS builds.

[4.5.0] - 2023-12-18

Added

• Use unzipper to decompress ZIP files.

Changed

• Use tar to extract tarballs.
• Disable options.nativeAddon.

Removed

• Remove yauzl-promise since it does not preserve symlinks on MacOS.

[4.4.2-beta.4] - 2023-11-03

Changed

• Use yauzl-promise to decompress MacOS build on MacOS platform.

Removed

• Native package unzip usage.

[4.4.2-beta.3] - 2023-10-23

Added

• Align cache implementation with nwjs/npm-installer
• nw module can use the options.cacheDir to get cached NW.js binaries.

[4.4.2-beta.2] - 2023-10-20

Added

• Node Native Addon support using GYP. To enable, set options.nativeAddon to gyp.

[4.4.2-beta.1] - 2023-10-16

Added

• Managed Manifest mode. options.ManagedManifest defaults to false.
• If true, then first package.json globbed is parsed as manifest.
• If JSON type, object is parsed as manifest.
• If string type, then resolve as file path to manifest.

[4.4.2] - 2023-10-16

Changed

• Fix FFmpeg decompression.
• Auto generate docs from JSDoc comments.
• Improve TypeScript type definitions.
• Fix get mode.
• Refactor build mode.
• Generate markdown docs from JSDocs.

[4.4.1] - 2023-09-06

Changed

• Improve debug logging.
• Fixed handling of argv.

[4.4.0] - 2023-09-05

Added

• Cache community FFmpeg.
• Move FFmpeg decompress function to relevant location

[4.3.11] - 2023-09-05

Changed

• Separate download logic for NW.js and FFmpeg.

[4.3.10] - 2023-08-21

Removed

• Do not copy the first package.json encountered to the root of options.outDir when options.glob is enabled. This may seem like a breaking change but it is actually reverting incorrect behaviour.

[4.3.9] - 2023-08-15

Changed

• Some mac environments don't restore symlinks when using compressing lib. Now we will use system unzip command to extract zip files

[4.3.8] - 2023-08-14

Changed

• Handle error during ffmpeg copy on some mac environments

[4.3.7] - 2023-08-11

Changed

• Move community ffmpeg in the correct folder.

[4.3.6] - 2023-08-11

Changed

• Move community ffmpeg in the correct folder.

[4.3.5] - 2023-08-03

Changed

• Return promise in get mode to await it correctly.

[4.3.4] - 2023-08-02

Changed

• Conditonally set Icon for Windows build.
• Refactor get mode into a single file.

[4.3.3] - 2023-07-25

Changed

• Set NSHumanReadableCopyright property in *.app/Resources/en.lproj/InfoPlist.strings to update copyright

Removed

• NSHumanReadableCopyright from Info.plist

[4.3.2] - 2023-07-11

Added

• Descriptions and argument types for remaining cli arguments.

[4.3.1] - 2023-07-07

Changed

• Replace the icon at nwjs.app/Contents/Resources/app.icns with the icon at options.app.icon file path.

Removed

• xattr package. The com.apple.quarantine flag should be handled by the developer.

[4.3.0] - 2023-07-03

Added

• Compress outDir to zip, tar and tgz formats.
• Specify log level via options.logLevel.
• Add platform, arch, Node and NW.js info in debug log.
• Add MacOS name, version, description and legal metadata
• Removed redundant options.app.icon property (Refer to NW.js docs on how to set icon)

[4.2.8] - 2023-06-29

Changed

• Refactor zip implementation. Use compressing instead of archiver package.
• If zip is true or "zip", then remove outDir after compression. (This was supposed to be the intented behavior all along).

[4.2.7] - 2023-06-27

Changed

• Redownload manifest.json every time the nwbuild function is executed.
• If manifest.json already exists and we are unable to connect to the nwjs.io domain, then use the existing manifest.
• If no manifest.json exists in the cache dir, then the validate function will cache this and throw an error - preventing the build.

[4.2.6] - 2023-06-20

Changed

• Preserve relative symbolic links of NW.js files during build mode

[4.2.5] - 2023-06-20

Changed

• Rename executable using options.app.name value.

[4.2.4] - 2023-06-18

Changed

• Migrate from decompress to compressing

[4.2.3-beta.2] - 2023-06-16

Changed

• Preserve relative symbolic links during build mode

[4.2.3-beta.1] - 2023-06-15

Changed

• Do not resolve options.srcDir when parsing options object.

[4.2.3] - 2023-04-19

Changed

• Fix module imports which broke in 04ccd51

[4.2.2] - 2023-04-14

Added

• Validation for options.version.
• Type definition file for nwbuild function.

[4.2.1] - 2023-03-28

Changed

• Set files to options.srcDir if glob disabled preventing a package.json not found error.

[4.2.0] - 2023-03-27

Added

• Glob flag defaulting to true. Currently file globbing is broken and it is recommended to set glob to false.

Changed

• Fixed get mode
• Fixed run mode
• Fixed build mode
• Updated get mode docs

[4.1.1-beta.2] - 2023-03-15

Changed

• Parse the first package.json file and treat it as the NW.js manifest. Copy it to outDir/package.nw/package.json for Linux and Windows and outDir/nwjs.app/Contents/Resources/app.nw/package.json for MacOS.

To simplify your workflow, you can pass the path to the package.json first:

nwbuild ./path/to/package.json ./app/**/* ./node_modules/**/*

Make sure your manifest file's main property points to a valid file path. In this case it might be:

{
  "main": "app/index.html"
}

[4.1.1-beta.1] - 2023-03-14

Added

• get mode to only download NW.js binaries. Example use case: download during Node's postinstall hook:

{
  "scripts": {
    "postinstall": "nwbuild --mode=get --flavor=sdk"
  }
}

• Check if NW.js's Node version matches host's Node version

Changed

• Fix undefined import for Windows configuration

[4.1.1-beta.0] - 2023-03-12

Changed

• Remove false test for run mode.

[4.1.1] - 2023-03-12

Changed

• Glob file and directory differently.
• MacOS ARM build is no longer behind beta version.

[4.1.0-beta.3] - 2023-03-01

Added

• Allow list https://npmmirror.com/mirrors/nwjs/ and https://npm.taobao.org/mirrors/nwjs/ mirrors.

[4.1.0-beta.2] - 2023-02-29

Changed

• Do not convert srcDir files to absolute paths.
• Copy files to correct location.

[4.1.0-beta.1] - 2023-02-28

Changed

• Resolve path iff file path type is valid.

[4.1.0-beta.0] - 2023-02-25

Added

• MacOS ARM support

[4.1.0] - 2023-02-23

Added

• Use (community) prebuilt version of ffmpeg if the ffmpeg flag is true (defaults to false).

Changed

• await platform specific config steps

[4.0.11] - 2023-02-5

Changed

• Security update http-cache-semantics to v4.1.1.

[4.0.10] - 2023-02-05

Added

• options.cli flag to prevent node-glob from globbing already globbed files and erroring out with a package.json not found in srcDir file glob patterns message.

Changed

• Copy subdirectories of options.srDir in the correct location.

[4.0.9] - 2023-02-03

Added

• Run and build demo app in CI.

Changed

• Fixed false positives in CI
• Throw errors instead of returning them
• Reject error object instead of exit code

[4.0.8] - 2023-01-15

Added

• Flag to check if specific nw release is cached. #772

Changed

• Create cacheDir, outDir before getting release info. #772

[4.0.7] - 2023-01-14

Changed

• Do not throw error if nwbuild is of object type. #769

• Fix package.json path for updateNotifier. #767

[4.0.6] - 2023-01-09

Added

• Warn about loss of permissions if building Linux or MacOS on Windows. 8793d4b

Changed

• Fix error when options.version is latest. 33ef184

Removed

• CJS support 968f798

[4.0.5] - 2023-01-06

Changed

• Prevent duplicate globbing of srcDir files. 07901c9

[4.0.4] - 2023-01-06

Changed

• Convert srcDir type from string[] to string. 1a699af

[4.0.3] - 2023-01-06

Added

• File globing. #749

• Linux and Windows configuration options. #729

Changed

• Skip modification of Windows executable if platform is not Windows or Wine is not installed. #739

• Run mode should only require srcDir, version and flavor. #718

[4.0.2] - 2022-11-30

Added

• Allow user to rename NW executable. #712

Changed

• Fix MacOS build. #717

• CJS support via esbuild. #713

[4.0.1] - 2022-11-20

Added

• Support for Desktop Entry file. #690

Changed

• Resolve promise in close event with respect to compression. #698

• Check for release info after downloading NW binaries in cacheDir. #697

[4.0.0] - 2022-11-16

Added

• Rename Helper apps. #687

• MacOS support. #685

• Check for nwbuild object in package.json. #684

[3.8.6] - 2022-09-22

• Fix mac and windows build

[3.8.5] - 2022-09-20

Added

• nwbuild function which accidently got removed.

Changed

• Update usage docs for nwbuild

[3.8.4] - 2022-09-20

Changed

• Refactor download function

[3.8.3-beta.1]

Changed

• Check for first instance of package.json

[3.8.3] - 2022-08-26

Changed

• platforms argument also accepts comma separated (without spaces) values

[3.8.2] - 2022-08-08

Added

• Support for multiple file paths

[3.8.1] - 2022-07-18

Changed

• Fix regex to match package.json files only

[3.8.0] - 2022-07-11

Added

• mode option which defaults to run
• nwbuild function
• quiet option to documentation

Changed

• CLI options by matching them to the API

[3.7.4] - 2022-06-06

Removed

• Remove Version from CFBundleShortVersionString #576

[3.7.2] - 2022-06-02

Added

• Added options buildType, macCredits, macPlist, zip, zipOptions to CLI #575

Changed

• Update lint command #575

[3.7.1] - 2022-06-02

Changed

• Add EditorConfig #574
• Fix build step for Windows x64 platform #572
• Refactor platforms object #571

[3.7.0] - 2022-05-30

Added

• Optional zip file merging for Windows and Linux #567
• Add code of conduct #560

Changed

• Update contributing guide #569
• Switch from TypeScript to JSDocs #568
• Set window icon with rcedit #566
• Refactor checkCache #565
• Simplify demo
• Refactor detectCurrentPlatform #564
• Update dependencies #561 #532

Removed

[3.6.0] - 2022-05-18

Added

• GitHub Actions for CICD #552
• Support multiple locales on OSX #389
• Pull request and issue template #553

Changed

• Dependencies #550
• Documentation #540 #553 #555
• Improve run mode by detecting current platform to prevent downloading additional binaries

Removed

• Travis
• AppVeyor
• JSHint
• EditorConfig

[3.5.7]

Security

• Source platform overrides module into the project instead of it being an extenal dependency. This helped us get rid of a vulnerable lodash version. See #500

[3.5.1] - 2017-10-19

Added

• Add option.winVersionString for accurate process name. See #459.

Fixed

• Small platform overrides fix. See https://github.com/nwjs-community/nw-builder/pull/477/files.

[3.4.1] - 2017-06-05

Removed

• The bluebird dependency. We're now using native promises instead.

[3.4.0] - 2017-05-28

Added

• If using the package programmatically and it's out of date, a message will be shown (this was always the case for the CLI).
• There is now a README in every directory (with at least a single sentence summarizing the directory) to help with onboarding contributors.

Changed

• Some dependencies are updated.

Removed

• osx32 is removed from the default list of platforms. Thanks to @preaction (PR #439).
• An unnecessary rcedit dependency is removed.

Fixed

• For Node 7+ users, you won't see a os.tmpDir deprecation warning anymore.

---

Old format

• 2017-05-22 3.2.3 Fix for caching when a version is specified (thanks @piwonesien for the help).
• 2017-05-20 3.2.2 Fix: when using the nwbuild in run mode, the -p option was ignored and the current platform was always used.
• 2017-05-16 3.2.1 Fix: NW.js 0.22.0+ apps didn't open.
• 2017-02-12 3.2.0 Defaults to HTTPS now, added manifestUrl option, and bumped some dependencies.
• 2016-10-09 3.1.2 Fix for passing array as files option when running app (plus some security fixes).
• 2016-10-09 3.1.1 Fix for flavor feature when using CLI.
• 2016-09-14 3.1.0 Ability to select any flavor of NW.js, not just sdk.
• 2016-08-28 3.0.0 bumping graceful-fs-extra dependency to 2.0.0.
• 2016-08-14 2.2.7 fix for macIcns option when using NW.js 0.12.3
• 2016-07-31 2.2.6 fix for OS X caching
• 2016-07-03 2.2.5 fix for update-notifier usage in bin
• 2016-07-03 2.2.4 fix for syntax error in CLI
• 2016-07-02 2.2.3 a few small fixes for the run option and more
• 2016-07-02 2.2.2 fix for cache check of some legacy versions
• 2016-07-02 2.2.1 supports newer NW.js versions (via http://nwjs.io/versions.json), plus other fixes.
• 2015-12-18 2.2.0 added zip option.
• 2015-12-06 2.1.0 added cacheDir command-line option, fix for no info being passed back, etc.
• 2015-06-28 2.0.2 put upper bound to semver check for windows.
• 2015-06-14 2.0.1 safer validation of versions.
• 2015-06-14 2.0.0 changed to nw-builder, etc.
• 2015-05-05 1.0.12 when using latest NW.js version, it's first validated that it's not an alpha version (fixes #222). Plus a fix for the winIco & macIcns command line options
• 2015-01-29 1.0.8 fixed EMFILE errors (see #147 #148)
• 2015-01-21 1.0.7 fixed about screen when copyright is not supplied
• 2015-01-15 1.0.6 fixed downloads for nw.js version 0.12.0-alpha1
• 2015-01-15 1.0.5 fixed downloads for NW.js versions < 0.12.0-alpha
• 2014-12-12 1.0.0 64-bit support, improved platform-overrides and no more EMFILE errors.
• 2014-12-07 0.4.0 macPlist CFBundleIdentifier is generated from package.json (see #131)
• 2014-11-14 0.3.0 macPlist option improvements (see #96)
• 2014-10-30 0.2.0 adds support for platform-specific manifest overrides (see #94)
• 2014-08-19 0.1.2 adds a progress bar to downloads, fixes downloading through a proxy, fixed winIco, bug fixes
• 2014-08-01 0.1.0 use app filename for generated executables, optimized version checking, (known issue: winIco on windows)
• 2014-07-31 0.0.4 fixed compatibility with nodewebkit 0.10.0
• 2014-04-20 Added run option, bug fixes
• 2014-04-13 Preview Release