@openfeature/web-sdk 1.6.2 → 1.7.1

package/README.md

@@ -16,8 +16,8 @@
     <img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
   </a>
   <!-- x-release-please-start-version -->
-  <a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.6.2">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.6.2&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.7.1">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.7.1&color=blue&style=for-the-badge" />
   </a>
   <!-- x-release-please-end -->
   <br/>
@@ -109,6 +109,7 @@ See [here](https://open-feature.github.io/js-sdk/modules/_openfeature_web_sdk.ht
 | ✅      | [Tracking](#tracking)               | Associate user actions with feature flag evaluations, particularly for A/B testing.                                                |
 | ✅      | [Shutdown](#shutdown)               | Gracefully clean up a provider during application shutdown.                                                                        |
 | ✅      | [Extending](#extending)             | Extend OpenFeature with custom providers and hooks.                                                                                |
+| ✅      | [Multi-Provider](#multi-provider)   | Combine multiple providers with configurable evaluation strategies.                                                                |
 
 <sub>Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌</sub>
 
@@ -145,6 +146,63 @@ Once the provider has been registered, the status can be tracked using [events](
 In some situations, it may be beneficial to register multiple providers in the same application.
 This is possible using [domains](#domains), which is covered in more detail below.
 
+#### Multi-Provider
+
+The Multi-Provider allows you to use multiple underlying providers as sources of flag data for the OpenFeature web SDK. When a flag is being evaluated, the Multi-Provider will consult each underlying provider it is managing in order to determine the final result. Different evaluation strategies can be defined to control which providers get evaluated and which result is used.
+
+The Multi-Provider is a powerful tool for performing migrations between flag providers, or combining multiple providers into a single feature flagging interface. For example:
+
+- **Migration**: When migrating between two providers, you can run both in parallel under a unified flagging interface. As flags are added to the new provider, the Multi-Provider will automatically find and return them, falling back to the old provider if the new provider does not have the flag.
+- **Multiple Data Sources**: The Multi-Provider allows you to seamlessly combine many sources of flagging data, such as environment variables, local files, database values and SaaS hosted feature management systems.
+
+```ts
+import { MultiProvider } from '@openfeature/web-sdk';
+
+const multiProvider = new MultiProvider([
+  { provider: new ProviderA() },
+  { provider: new ProviderB() }
+]);
+
+await OpenFeature.setProviderAndWait(multiProvider);
+
+const client = OpenFeature.getClient();
+console.log(client.getBooleanDetails("my-flag", false));
+```
+
+By default, the Multi-Provider will evaluate all underlying providers in order and return the first successful result. If a provider indicates it does not have a flag (FLAG_NOT_FOUND error code), then it will be skipped and the next provider will be evaluated.
+
+##### Evaluation Strategies
+
+The Multi-Provider comes with three strategies out of the box:
+
+- **FirstMatchStrategy** (default): Evaluates all providers in order and returns the first successful result. Providers that indicate FLAG_NOT_FOUND error will be skipped and the next provider will be evaluated.
+- **FirstSuccessfulStrategy**: Evaluates all providers in order and returns the first successful result. Any error will cause that provider to be skipped.
+- **ComparisonStrategy**: Evaluates all providers sequentially. If every provider returns a successful result with the same value, then that result is returned. Otherwise, the result returned by the configured "fallback provider" will be used.
+
+```ts
+import { MultiProvider, FirstSuccessfulStrategy } from '@openfeature/web-sdk';
+
+const multiProvider = new MultiProvider(
+  [
+    { provider: new ProviderA() },
+    { provider: new ProviderB() }
+  ], 
+  new FirstSuccessfulStrategy()
+);
+```
+
+##### Tracking Support
+
+The Multi-Provider supports tracking events across multiple providers, allowing you to send analytics events to all configured providers simultaneously:
+
+```ts
+// Tracked events will be sent to all providers by default
+client.track('user-conversion', { 
+  value: 99.99, 
+  currency: 'USD' 
+});
+```
+
 ### Flag evaluation flow
 
 When a new provider is added to OpenFeature client the following process happens: