launchdarkly-react-client-sdk - npm Package Versions

[2.28.0] - 2022-10-05

Changed:

• Updated js-client-sdk version which removed event de-duplication functionality which was made redundant by support of summary events. This will improve the default event behavior when using experimentation.

[2.27.0] - 2022-08-31

Added:

• useFlags hook is now generically typed, allowing you to assert what type your flag set will be.
• useLDClientError hook for exposing client initialization failures.

Changed:

• sendEventsOnlyForVariation is now set to true by default to prevent a flag evaluation event being generated for every flag on load.
• flags object (that is either injected via props using LDConsumer or returned from the useFlags hook) will generate a flag evaluation event on flag read (using a JavaScript proxy). This can be disabled by setting reactOptions.sendEventsOnFlagRead: false.
• upgraded from ES5 to ES6.

[2.26.0] - 2022-04-27

Added:

• LDOptions.application, for configuration of application metadata that may be used in LaunchDarkly analytics or other product features. This does not affect feature flag evaluations.
• Added basicLogger, a replacement for the deprecated createConsoleLogger.

Fixed:

• The baseUrl, streamUrl, and eventsUrl properties now work properly regardless of whether the URL string has a trailing slash. Previously, a trailing slash would cause request URL paths to have double slashes.

[2.25.2] - 2022-04-15

Changed:

• Updated LDProvider and the SDK's peer dependencies so that it can run in an application with React 18 (#129)

[2.25.1] - 2022-02-18

Fixed:

• If the SDK receives invalid JSON data from a streaming connection (possibly as a result of the connection being cut off), it now uses its regular error-handling logic: the error is emitted as an error event or, if there are no error event listeners, it is logged. Previously, the error would be thrown as an unhandled exception.

[2.25.0] - 2022-02-08

Updated to version 2.20.1 of the JavaScript SDK, incorporating improvements from the 2.19.4, 2.20.0, and 2.20.1 releases.

Added:

• Added exports of the types LDReactOptions, ProviderConfig, AsyncProviderConfig, and AllFlagsLDClient. These were referenced in exported functions, but were not previously importable from the main module.
• New property LDOptions.requestHeaderTransform allows custom headers to be added to all HTTP requests. This may be necessary if you have an Internet gateway that uses a custom header for authentication. Note that custom headers may cause cross-origin browser requests to be rejected unless you have a way to ensure that the header name also appears in Access-Control-Allow-Headers for CORS preflight responses; if you are connecting to the LaunchDarkly Relay Proxy, it has a way to configure this.

Fixed:

• If the browser local storage mechanism throws an exception (for instance, if it is disabled or if storage is full), the SDK now correctly catches the exception and logs a message about the failure. It will only log this message once during the lifetime of the SDK client. (#109)
• Removed an obsolete warning that would appear in the browser console after calling track: Custom event "_____" does not exist. Originally, the SDK had an expectation that track would be used only for event keys that had been previously defined as custom goals in the LaunchDarkly dashboard. That is still often the case, but it is not required and LaunchDarkly no longer sends custom goal names to the SDK, so the warning was happening even if such a goal did exist.

[2.24.0] - 2021-12-09

Added:

• When initializing the SDK, consumers can now optionally pass in a previously-initialized ldClient instance (thanks, TimboTambo!)
• Introduced missing typedoc annotations for AsyncProviderConfig.

[2.23.3] - 2021-11-02

Added:

• The AsyncProviderConfig type was added. This type is a clone of ProviderConfig except that deferInitialization is marked as deprecated; see the "Deprecated" section below for more information.

Fixed:

• Fixed a bug where sourcemaps did not point to released files. (#66)

Deprecated:

• Deprecated the ability to specify deferInitialization in the config object parameter for asyncWithLDProvider. The asyncWithLDProvider function needs to be initialized at the app entry point prior to render to ensure flags and the ldClient are ready at the beginning of the app. As a result, initialization cannot be deferred when using asyncWithLDProvider. (#99)

[2.23.2] - 2021-10-06

Changed:

• Improved withLDProvider so that prop types can be provided (thanks, dsifford!)

[2.23.1] - 2021-09-03

Fixed:

• When using asyncWithLDProvider, components added to the DOM after client initialization now use the latest known flag values instead of the bootstrapped values.