@beignet/provider-flags-openfeature 0.0.20 → 0.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +18 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -13,10 +13,12 @@ types out of Beignet core.
|
|
|
13
13
|
## Install
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
bun add @beignet/provider-flags-openfeature @openfeature/server-sdk
|
|
16
|
+
bun add @beignet/provider-flags-openfeature @beignet/core @openfeature/server-sdk
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
Install and configure your chosen OpenFeature provider package separately.
|
|
20
|
+
This Beignet package does not require environment variables itself; your chosen
|
|
21
|
+
OpenFeature provider may require its own SDK package and env vars.
|
|
20
22
|
|
|
21
23
|
## Setup
|
|
22
24
|
|
|
@@ -43,6 +45,9 @@ The provider contributes:
|
|
|
43
45
|
- `ctx.ports.flags`, the standard Beignet `FlagsPort`
|
|
44
46
|
- `ctx.ports.openFeature`, an escape hatch with the raw OpenFeature client/API
|
|
45
47
|
|
|
48
|
+
`beignet doctor --strict` checks that installed OpenFeature flag providers are
|
|
49
|
+
registered in `server/providers.ts`.
|
|
50
|
+
|
|
46
51
|
## Direct port factory
|
|
47
52
|
|
|
48
53
|
Use `createOpenFeatureFlags(...)` when your app already owns an OpenFeature
|
|
@@ -66,3 +71,15 @@ When `@beignet/devtools` is installed before this provider, flag evaluations,
|
|
|
66
71
|
provider errors, explicit exposures, and tracking events appear under the
|
|
67
72
|
Feature flags watcher. Private attributes are redacted from instrumentation
|
|
68
73
|
details.
|
|
74
|
+
|
|
75
|
+
## Local and tests
|
|
76
|
+
|
|
77
|
+
Use OpenFeature's in-memory provider, or an app-owned fake `FlagsPort`, in
|
|
78
|
+
tests. Feature flags are not authorization; use policies and gates for access
|
|
79
|
+
control decisions that must be enforced.
|
|
80
|
+
|
|
81
|
+
## Deployment notes
|
|
82
|
+
|
|
83
|
+
Configure the vendor OpenFeature provider before registering
|
|
84
|
+
`createOpenFeatureFlagsProvider(...)`. Keep default flag values explicit in
|
|
85
|
+
Beignet flag definitions so provider outages degrade predictably.
|