@launchdarkly/js-client-sdk 0.5.2 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [0.6.0](https://github.com/launchdarkly/js-core/compare/js-client-sdk-v0.5.3...js-client-sdk-v0.6.0) (2025-04-29)
+
+
+### Features
+
+* Add client-side SDK plugin support. ([#834](https://github.com/launchdarkly/js-core/issues/834)) ([a843a33](https://github.com/launchdarkly/js-core/commit/a843a33e97dcab706a0034bd1fd1e3d2f78a9262))
+
+
+### Bug Fixes
+
+* Client SDKs should use wrapper information. ([#836](https://github.com/launchdarkly/js-core/issues/836)) ([1e0cf6a](https://github.com/launchdarkly/js-core/commit/1e0cf6a0f77f8cfe6a7a0e675fc6490ea52a5b07))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @launchdarkly/js-client-sdk-common bumped from 1.12.6 to 1.13.0
+
+## [0.5.3](https://github.com/launchdarkly/js-core/compare/js-client-sdk-v0.5.2...js-client-sdk-v0.5.3) (2025-04-16)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @launchdarkly/js-client-sdk-common bumped from 1.12.5 to 1.12.6
+
 ## [0.5.2](https://github.com/launchdarkly/js-core/compare/js-client-sdk-v0.5.1...js-client-sdk-v0.5.2) (2025-04-15)
 
 

package/dist/{common-DPjctgS7.d.cts → common-Duna6UXR.d.cts}

@@ -1,4 +1,4 @@
-import { LDIdentifyOptions, LDOptions, LDClient as LDClient$1, LDContext, BasicLoggerOptions, LDLogger } from '@launchdarkly/js-client-sdk-common';
+import { LDIdentifyOptions, LDClient as LDClient$1, LDContext, LDPluginBase, Hook, LDOptions, BasicLoggerOptions, LDLogger } from '@launchdarkly/js-client-sdk-common';
 
 interface BrowserIdentifyOptions extends Omit<LDIdentifyOptions, 'waitForNetworkResults'> {
     /**
@@ -22,49 +22,6 @@ interface BrowserIdentifyOptions extends Omit<LDIdentifyOptions, 'waitForNetwork
     bootstrap?: unknown;
 }
 
-/**
- * Initialization options for the LaunchDarkly browser SDK.
- */
-interface BrowserOptions extends Omit<LDOptions, 'initialConnectionMode'> {
-    /**
-     * Whether the client should make a request to LaunchDarkly for Experimentation metrics (goals).
-     *
-     * This is true by default, meaning that this request will be made on every page load.
-     * Set it to false if you are not using Experimentation and want to skip the request.
-     */
-    fetchGoals?: boolean;
-    /**
-     * A function which, if present, can change the URL in analytics events to something other
-     * than the actual browser URL. It will be called with the current browser URL as a parameter,
-     * and returns the value that should be stored in the event's `url` property.
-     *
-     * It may be useful to customize the `url` to provide specific meaning, incorporate
-     * client-side routing concerns, or redact tokens or other info.
-     */
-    eventUrlTransformer?: (url: string) => string;
-    /**
-     * Whether or not to open a streaming connection to LaunchDarkly for live flag updates.
-     *
-     * If this is true, the client will always attempt to maintain a streaming connection; if false,
-     * it never will. If you leave the value undefined (the default), the client will open a streaming
-     * connection if you subscribe to `"change"` or `"change:flag-key"` events.
-     *
-     * This is equivalent to calling `client.setStreaming()` with the same value.
-     */
-    streaming?: boolean;
-    /**
-     * Determines if the SDK responds to entering different visibility states, such as foreground and background.
-     * An example is flushing buffered events when going to the background.
-     *
-     * This is true by default. Generally speaking the SDK will be able to most reliably deliver
-     * events with this setting on.
-     *
-     * It may be useful to disable for environments where not all window/document objects are
-     * available, such as when running the SDK in a browser extension.
-     */
-    automaticBackgroundHandling?: boolean;
-}
-
 /**
  *
  * The LaunchDarkly SDK client object.
@@ -121,6 +78,61 @@ type LDClient = Omit<LDClient$1, 'setConnectionMode' | 'getConnectionMode' | 'ge
     identify(context: LDContext, identifyOptions?: BrowserIdentifyOptions): Promise<void>;
 };
 
+/**
+ * Interface for plugins to the LaunchDarkly SDK.
+ */
+interface LDPlugin extends LDPluginBase<LDClient, Hook> {
+}
+
+/**
+ * Initialization options for the LaunchDarkly browser SDK.
+ */
+interface BrowserOptions extends Omit<LDOptions, 'initialConnectionMode'> {
+    /**
+     * Whether the client should make a request to LaunchDarkly for Experimentation metrics (goals).
+     *
+     * This is true by default, meaning that this request will be made on every page load.
+     * Set it to false if you are not using Experimentation and want to skip the request.
+     */
+    fetchGoals?: boolean;
+    /**
+     * A function which, if present, can change the URL in analytics events to something other
+     * than the actual browser URL. It will be called with the current browser URL as a parameter,
+     * and returns the value that should be stored in the event's `url` property.
+     *
+     * It may be useful to customize the `url` to provide specific meaning, incorporate
+     * client-side routing concerns, or redact tokens or other info.
+     */
+    eventUrlTransformer?: (url: string) => string;
+    /**
+     * Whether or not to open a streaming connection to LaunchDarkly for live flag updates.
+     *
+     * If this is true, the client will always attempt to maintain a streaming connection; if false,
+     * it never will. If you leave the value undefined (the default), the client will open a streaming
+     * connection if you subscribe to `"change"` or `"change:flag-key"` events.
+     *
+     * This is equivalent to calling `client.setStreaming()` with the same value.
+     */
+    streaming?: boolean;
+    /**
+     * Determines if the SDK responds to entering different visibility states, such as foreground and background.
+     * An example is flushing buffered events when going to the background.
+     *
+     * This is true by default. Generally speaking the SDK will be able to most reliably deliver
+     * events with this setting on.
+     *
+     * It may be useful to disable for environments where not all window/document objects are
+     * available, such as when running the SDK in a browser extension.
+     */
+    automaticBackgroundHandling?: boolean;
+    /**
+     * A list of plugins to be used with the SDK.
+     *
+     * Plugin support is currently experimental and subject to change.
+     */
+    plugins?: LDPlugin[];
+}
+
 /**
  * Provides a basic {@link LDLogger} implementation.
  *
@@ -171,4 +183,4 @@ type LDClient = Omit<LDClient$1, 'setConnectionMode' | 'getConnectionMode' | 'ge
  */
 declare function basicLogger(options: BasicLoggerOptions): LDLogger;
 
-export { type BrowserOptions as B, type LDClient as L, type BrowserIdentifyOptions as a, basicLogger as b };
+export { type BrowserOptions as B, type LDClient as L, type LDPlugin as a, type BrowserIdentifyOptions as b, basicLogger as c };

package/dist/{common-DPjctgS7.d.ts → common-Duna6UXR.d.ts}

@@ -1,4 +1,4 @@
-import { LDIdentifyOptions, LDOptions, LDClient as LDClient$1, LDContext, BasicLoggerOptions, LDLogger } from '@launchdarkly/js-client-sdk-common';
+import { LDIdentifyOptions, LDClient as LDClient$1, LDContext, LDPluginBase, Hook, LDOptions, BasicLoggerOptions, LDLogger } from '@launchdarkly/js-client-sdk-common';
 
 interface BrowserIdentifyOptions extends Omit<LDIdentifyOptions, 'waitForNetworkResults'> {
     /**
@@ -22,49 +22,6 @@ interface BrowserIdentifyOptions extends Omit<LDIdentifyOptions, 'waitForNetwork
     bootstrap?: unknown;
 }
 
-/**
- * Initialization options for the LaunchDarkly browser SDK.
- */
-interface BrowserOptions extends Omit<LDOptions, 'initialConnectionMode'> {
-    /**
-     * Whether the client should make a request to LaunchDarkly for Experimentation metrics (goals).
-     *
-     * This is true by default, meaning that this request will be made on every page load.
-     * Set it to false if you are not using Experimentation and want to skip the request.
-     */
-    fetchGoals?: boolean;
-    /**
-     * A function which, if present, can change the URL in analytics events to something other
-     * than the actual browser URL. It will be called with the current browser URL as a parameter,
-     * and returns the value that should be stored in the event's `url` property.
-     *
-     * It may be useful to customize the `url` to provide specific meaning, incorporate
-     * client-side routing concerns, or redact tokens or other info.
-     */
-    eventUrlTransformer?: (url: string) => string;
-    /**
-     * Whether or not to open a streaming connection to LaunchDarkly for live flag updates.
-     *
-     * If this is true, the client will always attempt to maintain a streaming connection; if false,
-     * it never will. If you leave the value undefined (the default), the client will open a streaming
-     * connection if you subscribe to `"change"` or `"change:flag-key"` events.
-     *
-     * This is equivalent to calling `client.setStreaming()` with the same value.
-     */
-    streaming?: boolean;
-    /**
-     * Determines if the SDK responds to entering different visibility states, such as foreground and background.
-     * An example is flushing buffered events when going to the background.
-     *
-     * This is true by default. Generally speaking the SDK will be able to most reliably deliver
-     * events with this setting on.
-     *
-     * It may be useful to disable for environments where not all window/document objects are
-     * available, such as when running the SDK in a browser extension.
-     */
-    automaticBackgroundHandling?: boolean;
-}
-
 /**
  *
  * The LaunchDarkly SDK client object.
@@ -121,6 +78,61 @@ type LDClient = Omit<LDClient$1, 'setConnectionMode' | 'getConnectionMode' | 'ge
     identify(context: LDContext, identifyOptions?: BrowserIdentifyOptions): Promise<void>;
 };
 
+/**
+ * Interface for plugins to the LaunchDarkly SDK.
+ */
+interface LDPlugin extends LDPluginBase<LDClient, Hook> {
+}
+
+/**
+ * Initialization options for the LaunchDarkly browser SDK.
+ */
+interface BrowserOptions extends Omit<LDOptions, 'initialConnectionMode'> {
+    /**
+     * Whether the client should make a request to LaunchDarkly for Experimentation metrics (goals).
+     *
+     * This is true by default, meaning that this request will be made on every page load.
+     * Set it to false if you are not using Experimentation and want to skip the request.
+     */
+    fetchGoals?: boolean;
+    /**
+     * A function which, if present, can change the URL in analytics events to something other
+     * than the actual browser URL. It will be called with the current browser URL as a parameter,
+     * and returns the value that should be stored in the event's `url` property.
+     *
+     * It may be useful to customize the `url` to provide specific meaning, incorporate
+     * client-side routing concerns, or redact tokens or other info.
+     */
+    eventUrlTransformer?: (url: string) => string;
+    /**
+     * Whether or not to open a streaming connection to LaunchDarkly for live flag updates.
+     *
+     * If this is true, the client will always attempt to maintain a streaming connection; if false,
+     * it never will. If you leave the value undefined (the default), the client will open a streaming
+     * connection if you subscribe to `"change"` or `"change:flag-key"` events.
+     *
+     * This is equivalent to calling `client.setStreaming()` with the same value.
+     */
+    streaming?: boolean;
+    /**
+     * Determines if the SDK responds to entering different visibility states, such as foreground and background.
+     * An example is flushing buffered events when going to the background.
+     *
+     * This is true by default. Generally speaking the SDK will be able to most reliably deliver
+     * events with this setting on.
+     *
+     * It may be useful to disable for environments where not all window/document objects are
+     * available, such as when running the SDK in a browser extension.
+     */
+    automaticBackgroundHandling?: boolean;
+    /**
+     * A list of plugins to be used with the SDK.
+     *
+     * Plugin support is currently experimental and subject to change.
+     */
+    plugins?: LDPlugin[];
+}
+
 /**
  * Provides a basic {@link LDLogger} implementation.
  *
@@ -171,4 +183,4 @@ type LDClient = Omit<LDClient$1, 'setConnectionMode' | 'getConnectionMode' | 'ge
  */
 declare function basicLogger(options: BasicLoggerOptions): LDLogger;
 
-export { type BrowserOptions as B, type LDClient as L, type BrowserIdentifyOptions as a, basicLogger as b };
+export { type BrowserOptions as B, type LDClient as L, type LDPlugin as a, type BrowserIdentifyOptions as b, basicLogger as c };