Skip to content

Latest commit

 

History

History
159 lines (93 loc) · 5.83 KB

CHANGELOG.md

File metadata and controls

159 lines (93 loc) · 5.83 KB
Raw

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.

[Unreleased]

Changed

Updates to ngrok binary version 3. This is a breaking change.

  • [breaking] Drops support for Node less than version 14.2
  • [breaking] download.js now uses URLs that download ngrok version 3
  • [breaking] To set basic auth on a tunnel, use the option basic_auth instead of auth or httpauth
  • [breaking] The ngrok client API now fails if you send arguments that aren't part of the available configuration. Changed the defaults function to return tunnelOpts and globalOpts from the available options
  • Updates the underlying ngrok client command to set the authtoken
  • Passing an authtoken as a connect option doesn't update the ngrok config file, it just passes it to the command
  • Updates the test setup to use mocha hooks to store/restore config
  • Basic auth password must be at least 8 characters now, updated tests that used a 4 character password
  • The ngrok client tries to guess the closest region, updated the tests to use a consistent region of "us" (the old default)
  • The v3 ngrok client looks for config in its new default location, but will fallback to the old location. Updated tests to remove both, to reset the state.
  • Adds a function to upgrade the config file.

[4.3.3] - 2022-08-18

Fixed

  • Removed old ngrok.d.ts from package.json files and added index.d.ts

[4.3.2] - 2022-08-16

Fixed

  • Removes an unused variable that was causing trouble in strict mode (#280)
  • Sets correct binary for darwin-arm architecture (#223)
  • Moves TypeScript definition file so it works with latest module resolution (#292)

Changed

  • Updates got dependency to 11.8.5

[4.3.1] - 2022-03-05

Fixed

  • Connect options were being mutated, clones them instead (#268)

Changed

  • Dropped dependency on colors for chalk (#265)
  • Updated test for information page

[4.3.0] - 2022-01-17

Fixed

  • ngrok now returns an information and login page when you try to request an HTML site with a guest account, which broke the tests. Fixed the broken test and added one to specifically test the behaviour.
  • Switched from decompress-zip to extract-zip to support Node 17
  • Updated version of uuid to avoid install warnings

[4.2.2] - 2021-09-06

Fixed

  • Got download type definitions correct

[4.2.1] - 2021-09-06

Fixed

  • Added download type definitions to package

[4.2.0] - 2021-09-06

Changed

  • Added onTerminated callback to notify users when the underlying ngrok process terminates

Fixed

  • TypeScript definition for the download function

[4.1.0] - 2021-07-26

Changed

  • Exposes the NgrokClientError class

Fixed

  • Previously, if the ngrok log_format was set to JSON, getProcess would never resolve. This is fixed now. (#221)
  • If the home directory download location isn't usable, the backup directory was defined wrong and the download would fail. The directory is now fixed. (#237)
  • Avoids memory leaks caused by adding listeners to the process "exit" event over and over. (#240)

[4.0.1] - 2021-04-05

Fixed

  • Trying to connect a new tunnel using a name would drop options like binPath as they were overwritten from the loaded config. #220 changes the behaviour to merge passed options with the named tunnel options
  • Avoids showing a terminal window on Windows when spawning (#211)

[4.0.0] - 2021-03-27

Breaking changes

  • Replaced the deprecated request and request-promise-native with got
  • ngrok.getApi() will now return an NgrokClient object which has methods to call on the available ngrok API methods
  • Revamped the exported types, there is now an Ngrok namespace under which most types now sit
  • Added types for the NgrokClient responses

Changed

  • Changed CI from Travis to GitHub Actions
  • Brought development dependencies up to date

Fixed

  • Passing a name option to connect now causes the module to read the ngrok config and retrieve a named tunnel (fixes #197)

[4.0.0-beta.4] - 2021-03-18

Fixed

  • Really fixed the location of the downloaded binary

[4.0.0-beta.3] - 2021-01-17

Fixed

  • Moved the download.js file back to the top level, since it can be required individually.

[4.0.0-beta.2] - 2021-01-17

Fixed

  • Corrected the file listing in package.json

[4.0.0-beta.1] - 2021-01-17

Changed

  • Replaced the deprecated request and request-promise-native with got
  • ngrok.getApi() will now return an NgrokClient object which has methods to call on the available ngrok API methods
  • Revamped the exported types, there is now an Ngrok namespace under which most types now sit
  • Added types for the NgrokClient responses
  • Changed CI from Travis to GitHub Actions

Fixed

  • Passing a name option to connect now causes the module to read the ngrok config and retrieve a named tunnel (fixes #197)

[3.4.0] - 2020-12-22

Please see commit logs for updates prior to version 4.