@openfeature/flagd-provider 0.13.1 → 0.13.3

package/README.md

@@ -38,6 +38,7 @@ Options can be defined in the constructor or as environment variables. Construct
 | selector                               | FLAGD_SOURCE_SELECTOR          | string  | -                                                              |                  |
 | cache                                  | FLAGD_CACHE                    | string  | lru                                                            | lru, disabled    |
 | maxCacheSize                           | FLAGD_MAX_CACHE_SIZE           | int     | 1000                                                           |                  |
+| defaultAuthority                       | FLAGD_DEFAULT_AUTHORITY        | string  | -                                                              | rpc, in-process  |
 
 #### Resolver type-specific Defaults
 
@@ -61,7 +62,7 @@ In the above example, the provider expects flagd to be available at `localhost:8
 
 Alternatively, you can use socket paths to connect to flagd.
 
-```
+```ts
   OpenFeature.setProvider(new FlagdProvider({
       socketPath: "/tmp/flagd.socks",
   }))
@@ -72,7 +73,7 @@ Alternatively, you can use socket paths to connect to flagd.
 This mode performs flag evaluations locally (in-process).
 Flag configurations for evaluation are obtained via gRPC protocol using [sync protobuf schema](https://buf.build/open-feature/flagd/file/main:sync/v1/sync_service.proto) service definition.
 
-```
+```ts
   OpenFeature.setProvider(new FlagdProvider({
       resolverType: 'in-process',
   }))
@@ -83,7 +84,7 @@ In the above example, the provider expects a flag sync service implementation to
 In-process resolver can also work in an offline mode.
 To enable this mode, you should provide a valid flag configuration file with the option `offlineFlagSourcePath`.
 
-```
+```ts
   OpenFeature.setProvider(new FlagdProvider({
       resolverType: 'in-process',
       offlineFlagSourcePath: './flags.json',
@@ -93,6 +94,18 @@ To enable this mode, you should provide a valid flag configuration file with the
 Offline mode uses `fs.watchFile` and polls every 5 seconds for changes to the file.
 This mode is useful for local development, test cases, and for offline applications.
 
+### Default Authority usage (optional)
+
+This is useful for complex routing or service-discovery use cases that involve a proxy (e.g., Envoy).
+Please refer to this [GitHub issue](https://github.com/open-feature/js-sdk-contrib/issues/1187) for more information.
+
+```ts
+  OpenFeature.setProvider(new FlagdProvider({
+      resolverType: 'in-process',
+      defaultAuthority: 'b-target-api.service',
+  }))
+```
+
 ### Supported Events
 
 The flagd provider emits `PROVIDER_READY`, `PROVIDER_ERROR` and `PROVIDER_CONFIGURATION_CHANGED` events.
@@ -107,9 +120,8 @@ For general information on events, see the [official documentation](https://open
 
 ### Flag Metadata
 
-| Field   | Type   | Value                                             |
-| ------- | ------ | ------------------------------------------------- |
-| `scope` | string | "selector" set for the associated source in flagd |
+[Flag metadata](https://flagd.dev/reference/flag-definitions/#metadata) is a set of key-value pairs that can be associated with a flag.
+The values come from the flag definition in flagd.
 
 ## Building