Skip to content

CHANGELOG.md

Latest commit

 

History

History
106 lines (86 loc) · 6.13 KB

CHANGELOG.md

File metadata and controls

106 lines (86 loc) · 6.13 KB
Raw

2.1.0 (June 21, 2025)

Warning

This version contains breaking changes.

Breaking changes

  • TLS Client Initialization Requirement
    The new method initTLS() must be called before using any session methods.
    You must also call destroyTLS() when the session is no longer needed.
  • Refactor Cookies API
    <session>.cookies is no longer a synchronous getter.
    It now returns a Promise that resolves to a cookie object.
    Usage: session-cookies.md
  • Redirect Handling Change
    The redirect option in requestOptions is no longer supported. Use followRedirects instead.

Additions/Fixes

  • Node.js Compatibility Fix
    The process.clearLine() bug has been resolved. Fixed issues #2 , #3 , #6

  • Shared Worker Pool (Performance Improvement)
    A centralized shared worker pool has been introduced, leading to major performance gains across concurrent TLS sessions.

    Proof of concept:

    Performance Benchmark

  • New: transportOptions in SessionOptions
    Introduced transportOptions to customize low-level transport configuration.
    Docs → transportOptions

  • Additional Session Options Introduced
    The following options provide extended control over stream output:

  • Enhanced Documentation
    Executable compatibility instructions and examples have been added to the documentation. Instructions

  • Refactor byteRequest handling Taking into account the Content-Encoding and Content-Transfer-Encoding headers to determine if the response is a byte response. Accounting for pull request #8

2.0.0 (December 15, 2024)

Warning

This version contains breaking changes.

  • Call <session>.init() after setting up a session and before using any HTTP methods. (See the documentation for more details.)
  • Resolved memory leak issues by moving to workerpool.
  • Added new profiles: chrome_131, chrome_131_psk, firefox_132, firefox_133, and ios_safari_18. The default profile is now chrome_131 (previously chrome_124).
  • Introduced the isRotatingProxy option for handling rotating proxies. PS: SessionOptions

1.1.4 (July 29, 2024)

Important

This version includes significant updates and improvements.

Breaking changes

  • response.cookies is now a property instead of a method. [Note: response.cookies() has been removed and replaced with response.cookies.]

Additional updates

  • Added session.cookies property to retrieve all session cookies. For detailed information, see examples/session-cookies.md.
  • Added byteResponse option in requestOptions. Setting this to true ensures that the response is treated as a byte response. For detailed information, see examples/images.js
  • Added functionality to send binary data. Note: Ensure that the appropriate headers are set before sending binary data in the body.
  • Added disableIPV6 and disableIPV4 options in SessionOptions. For detailed information, see SessionOptions
  • Added hostOverride property in requestOptions. Used to override the Host header, typically needed when making requests directly to an IP address.
  • chrome_124 profile will be used when no client_identifier is specified in session options.
  • Refactored cookies.ts and session typings for improved readability (internal change, no impact on existing use cases)
  • Updated TlsResponse according to new changes.

1.1.3 (June 13, 2024)

Warning

This version contains breaking changes.

Breaking changes

  • response.json() and response.text() methods now return a Promise.
  • response.cookies() now returns an object of cookies instead of aPromise.
  • session.methods no longer include the timeout and rejectUnauthorized options. Since timeout cannot be changed during a session, ensure to specify timeout & rejectUnauthorized in SessionOptions when creating a session.

Additions

  • fetch(fetchOptions) method have been added to use different timeouts & rejectUnauthorized values in each request. [examples/timeout.js] for more information.

Fixes

  • Fixed a typo that prevented timeout from working correctly.

1.1.2 (June 9, 2024)

Additions

  • Introduced client profile types.

Changes

  • Enhanced documentation for improved clarity and usability.
  • Updated the README with minor adjustments.
  • Refined interface definitions for better readability and understanding.

1.1.1 (June 4 2024)

Additions

  • Implemented dynamic methods for downloading shared files in "node-tls-client", eliminating the inclusion of prebuilt files.

Changes

  • Path used for storing the shared library files is strictly set to tmpdir path.

Benefits

  • Reduces package size.
  • Ensures better support for executables.

1.1.0 (June 3, 2024)

Changes

  • Improved handling of shared library files:
    • Only the shared library file matching the current operating system is preserved. All other shared library files are deleted.
  • Added support for executables.