@launchdarkly/js-client-sdk 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [0.11.0](https://github.com/launchdarkly/js-core/compare/js-client-sdk-v0.10.0...js-client-sdk-v0.11.0) (2025-12-18)
+
+
+### ⚠ BREAKING CHANGES
+
+* align browser v4 intialization flow to specs ([#1040](https://github.com/launchdarkly/js-core/issues/1040))
+
+### Features
+
+* adding support for debug override plugins ([#1033](https://github.com/launchdarkly/js-core/issues/1033)) ([17f5e7d](https://github.com/launchdarkly/js-core/commit/17f5e7d7d11d502d54a6ccf88aea6bec3e4b775c))
+* allow clients to evaluate bootstrapped flags when not ready ([#1036](https://github.com/launchdarkly/js-core/issues/1036)) ([9b4542a](https://github.com/launchdarkly/js-core/commit/9b4542a722e5d19e123e860faef113d134dad47c))
+* implement `waitForInitialization` for browser sdk 4.x ([#1028](https://github.com/launchdarkly/js-core/issues/1028)) ([156532a](https://github.com/launchdarkly/js-core/commit/156532aea3ec39635dab21dbab125c81fc31a3f5))
+
+
+### Code Refactoring
+
+* align browser v4 intialization flow to specs ([#1040](https://github.com/launchdarkly/js-core/issues/1040)) ([eff6a55](https://github.com/launchdarkly/js-core/commit/eff6a55163508bee4f2dec574ad256f88ec513d6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @launchdarkly/js-client-sdk-common bumped from 1.15.2 to 1.16.0
+
 ## [0.10.0](https://github.com/launchdarkly/js-core/compare/js-client-sdk-v0.9.1...js-client-sdk-v0.10.0) (2025-12-09)
 
 

package/dist/{common-Cn2MjelZ.d.cts → common-ekJnfmSx.d.cts}

@@ -29,6 +29,68 @@ interface BrowserIdentifyOptions extends Omit<LDIdentifyOptions, 'waitForNetwork
     bootstrap?: unknown;
 }
 
+/**
+ * @ignore
+ * Currently these options and the waitForInitialization method signiture will mirror the one
+ * that is defined in the server common. We will be consolidating this mehod so that it will
+ * be common to all sdks in the future.
+ */
+/**
+ * Options for the waitForInitialization method.
+ */
+interface LDWaitForInitializationOptions {
+    /**
+     * The timeout duration in seconds to wait for initialization before resolving the promise.
+     * If exceeded, the promise will resolve to a {@link LDWaitForInitializationTimeout} object.
+     *
+     * If no options are specified on the `waitForInitialization`, the default timeout of 5 seconds will be used.
+     *
+     * Using a high timeout, or no timeout, is not recommended because it could result in a long
+     * delay when conditions prevent successful initialization.
+     *
+     * A value of 0 will cause the promise to resolve without waiting. In that scenario it would be
+     * more effective to not call `waitForInitialization`.
+     *
+     * @default 5 seconds
+     */
+    timeout?: number;
+}
+/**
+ * The waitForInitialization operation failed.
+ */
+interface LDWaitForInitializationFailed {
+    status: 'failed';
+    error: Error;
+}
+/**
+ * The waitForInitialization operation timed out.
+ */
+interface LDWaitForInitializationTimeout {
+    status: 'timeout';
+}
+/**
+ * The waitForInitialization operation completed successfully.
+ */
+interface LDWaitForInitializationComplete {
+    status: 'complete';
+}
+/**
+ * The result of the waitForInitialization operation.
+ */
+type LDWaitForInitializationResult = LDWaitForInitializationFailed | LDWaitForInitializationTimeout | LDWaitForInitializationComplete;
+interface LDStartOptions extends LDWaitForInitializationOptions {
+    /**
+     * Optional bootstrap data to use for the identify operation. If {@link LDIdentifyOptions.bootstrap} is provided, it will be ignored.
+     */
+    bootstrap?: unknown;
+    /**
+     * Optional identify options to use for the identify operation. See {@link LDIdentifyOptions} for more information.
+     *
+     * @remarks
+     * Since the first identify option should never be sheddable, we omit the sheddable option from the interface to avoid confusion.
+     */
+    identifyOptions?: Omit<BrowserIdentifyOptions, 'sheddable'>;
+}
 /**
  *
  * The LaunchDarkly SDK client object.
@@ -81,6 +143,47 @@ type LDClient = Omit<LDClient$1, 'setConnectionMode' | 'getConnectionMode' | 'ge
      * @ignore Implementation Note: Browser implementation has different options.
      */
     identify(pristineContext: LDContext, identifyOptions?: BrowserIdentifyOptions): Promise<LDIdentifyResult>;
+    /**
+     * Returns a Promise that tracks the client's initialization state.
+     *
+     * The Promise will be resolved to a {@link LDWaitForInitializationResult} object containing the
+     * status of the waitForInitialization operation.
+     *
+     * @example
+     * This example shows use of async/await syntax for specifying handlers:
+     * ```
+     *     const result = await client.waitForInitialization({ timeout: 5 });
+     *
+     *     if (result.status === 'complete') {
+     *       doSomethingWithSuccessfullyInitializedClient();
+     *     } else if (result.status === 'failed') {
+     *       doSomethingForFailedStartup(result.error);
+     *     } else if (result.status === 'timeout') {
+     *       doSomethingForTimedOutStartup();
+     *     }
+     * ```
+     *
+     * @remarks
+     * You can also use event listeners ({@link on}) for the same purpose: the event `"initialized"`
+     * indicates success, and `"error"` indicates an error.
+     *
+     * @param options
+     *  Optional configuration. Please see {@link LDWaitForInitializationOptions}.
+     *
+     * @returns
+     *   A Promise that will be resolved to a {@link LDWaitForInitializationResult} object containing the
+     *   status of the waitForInitialization operation.
+     */
+    waitForInitialization(options?: LDWaitForInitializationOptions): Promise<LDWaitForInitializationResult>;
+    /**
+     * Starts the client and returns a promise that resolves to the initialization result.
+     *
+     * The promise will resolve to a {@link LDWaitForInitializationResult} object containing the
+     * status of the waitForInitialization operation.
+     *
+     * @param options Optional configuration. Please see {@link LDStartOptions}.
+     */
+    start(options?: LDStartOptions): Promise<LDWaitForInitializationResult>;
 };
 
 /**

package/dist/{common-Cn2MjelZ.d.ts → common-ekJnfmSx.d.ts}

@@ -29,6 +29,68 @@ interface BrowserIdentifyOptions extends Omit<LDIdentifyOptions, 'waitForNetwork
     bootstrap?: unknown;
 }
 
+/**
+ * @ignore
+ * Currently these options and the waitForInitialization method signiture will mirror the one
+ * that is defined in the server common. We will be consolidating this mehod so that it will
+ * be common to all sdks in the future.
+ */
+/**
+ * Options for the waitForInitialization method.
+ */
+interface LDWaitForInitializationOptions {
+    /**
+     * The timeout duration in seconds to wait for initialization before resolving the promise.
+     * If exceeded, the promise will resolve to a {@link LDWaitForInitializationTimeout} object.
+     *
+     * If no options are specified on the `waitForInitialization`, the default timeout of 5 seconds will be used.
+     *
+     * Using a high timeout, or no timeout, is not recommended because it could result in a long
+     * delay when conditions prevent successful initialization.
+     *
+     * A value of 0 will cause the promise to resolve without waiting. In that scenario it would be
+     * more effective to not call `waitForInitialization`.
+     *
+     * @default 5 seconds
+     */
+    timeout?: number;
+}
+/**
+ * The waitForInitialization operation failed.
+ */
+interface LDWaitForInitializationFailed {
+    status: 'failed';
+    error: Error;
+}
+/**
+ * The waitForInitialization operation timed out.
+ */
+interface LDWaitForInitializationTimeout {
+    status: 'timeout';
+}
+/**
+ * The waitForInitialization operation completed successfully.
+ */
+interface LDWaitForInitializationComplete {
+    status: 'complete';
+}
+/**
+ * The result of the waitForInitialization operation.
+ */
+type LDWaitForInitializationResult = LDWaitForInitializationFailed | LDWaitForInitializationTimeout | LDWaitForInitializationComplete;
+interface LDStartOptions extends LDWaitForInitializationOptions {
+    /**
+     * Optional bootstrap data to use for the identify operation. If {@link LDIdentifyOptions.bootstrap} is provided, it will be ignored.
+     */
+    bootstrap?: unknown;
+    /**
+     * Optional identify options to use for the identify operation. See {@link LDIdentifyOptions} for more information.
+     *
+     * @remarks
+     * Since the first identify option should never be sheddable, we omit the sheddable option from the interface to avoid confusion.
+     */
+    identifyOptions?: Omit<BrowserIdentifyOptions, 'sheddable'>;
+}
 /**
  *
  * The LaunchDarkly SDK client object.
@@ -81,6 +143,47 @@ type LDClient = Omit<LDClient$1, 'setConnectionMode' | 'getConnectionMode' | 'ge
      * @ignore Implementation Note: Browser implementation has different options.
      */
     identify(pristineContext: LDContext, identifyOptions?: BrowserIdentifyOptions): Promise<LDIdentifyResult>;
+    /**
+     * Returns a Promise that tracks the client's initialization state.
+     *
+     * The Promise will be resolved to a {@link LDWaitForInitializationResult} object containing the
+     * status of the waitForInitialization operation.
+     *
+     * @example
+     * This example shows use of async/await syntax for specifying handlers:
+     * ```
+     *     const result = await client.waitForInitialization({ timeout: 5 });
+     *
+     *     if (result.status === 'complete') {
+     *       doSomethingWithSuccessfullyInitializedClient();
+     *     } else if (result.status === 'failed') {
+     *       doSomethingForFailedStartup(result.error);
+     *     } else if (result.status === 'timeout') {
+     *       doSomethingForTimedOutStartup();
+     *     }
+     * ```
+     *
+     * @remarks
+     * You can also use event listeners ({@link on}) for the same purpose: the event `"initialized"`
+     * indicates success, and `"error"` indicates an error.
+     *
+     * @param options
+     *  Optional configuration. Please see {@link LDWaitForInitializationOptions}.
+     *
+     * @returns
+     *   A Promise that will be resolved to a {@link LDWaitForInitializationResult} object containing the
+     *   status of the waitForInitialization operation.
+     */
+    waitForInitialization(options?: LDWaitForInitializationOptions): Promise<LDWaitForInitializationResult>;
+    /**
+     * Starts the client and returns a promise that resolves to the initialization result.
+     *
+     * The promise will resolve to a {@link LDWaitForInitializationResult} object containing the
+     * status of the waitForInitialization operation.
+     *
+     * @param options Optional configuration. Please see {@link LDStartOptions}.
+     */
+    start(options?: LDStartOptions): Promise<LDWaitForInitializationResult>;
 };
 
 /**