@productcraft/flags-openfeature 0.0.0-stage → 0.1.0
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/LICENSE +21 -0
- package/README.md +76 -2
- package/dist/index.cjs +197 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +60 -0
- package/dist/index.d.ts +60 -0
- package/dist/index.js +193 -0
- package/dist/index.js.map +1 -0
- package/package.json +64 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ProductCraft
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,77 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @productcraft/flags-openfeature
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[OpenFeature](https://openfeature.dev) server provider for [ProductCraft Flags](https://productcraft.co/docs/flags). It wraps [`FlagsClient`](https://github.com/clauderanelagh/productcraft-node/tree/main/packages/flags#readme), which downloads one config per environment and evaluates flags **locally**: the evaluation context never leaves your app.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install @openfeature/server-sdk @productcraft/flags @productcraft/flags-openfeature
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import { OpenFeature } from "@openfeature/server-sdk";
|
|
13
|
+
import { ProductCraftFlagsProvider } from "@productcraft/flags-openfeature";
|
|
14
|
+
|
|
15
|
+
// Takes FlagsClient options (polling, cache, bootstrap, overrides, ...) or { client } for a client you built.
|
|
16
|
+
await OpenFeature.setProviderAndWait(new ProductCraftFlagsProvider({ sdkKey: process.env.PRODUCTCRAFT_FLAGS_SDK_KEY }));
|
|
17
|
+
|
|
18
|
+
const flags = OpenFeature.getClient();
|
|
19
|
+
const user = { id: "user-1", email: "ada@example.com" };
|
|
20
|
+
const enabled = await flags.getBooleanValue("new_checkout", false, { targetingKey: user.id, email: user.email, plan: "pro" });
|
|
21
|
+
const banner = await flags.getStringValue("banner_text", "Welcome", { targetingKey: user.id });
|
|
22
|
+
const limits = await flags.getObjectValue("limits", { max: 5 }, { targetingKey: user.id });
|
|
23
|
+
|
|
24
|
+
const details = await flags.getBooleanDetails("new_checkout", false, { targetingKey: user.id });
|
|
25
|
+
// details.reason: "TARGETING_MATCH", details.variant: "rule:0", details.flagMetadata: { revision: 42, rule_index: 0 }
|
|
26
|
+
|
|
27
|
+
await OpenFeature.close(); // closes the FlagsClient: no timers left behind
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## How it maps
|
|
31
|
+
|
|
32
|
+
| OpenFeature | Flags |
|
|
33
|
+
|---|---|
|
|
34
|
+
| `targetingKey` | `identifier` (the attribute percentage splits hash) |
|
|
35
|
+
| `email`, `country` | the top-level user fields |
|
|
36
|
+
| any other string, number, boolean, `Date` or `string[]` | a custom attribute rules can target |
|
|
37
|
+
| nested objects, mixed arrays | dropped (logged at debug level) |
|
|
38
|
+
| an empty context | the client's `defaultUser` |
|
|
39
|
+
| boolean / string / number resolvers | `getValueDetails` with your default (a different setting type is `TYPE_MISMATCH`) |
|
|
40
|
+
| object resolver | a `json` setting, parsed; any other setting type is `TYPE_MISMATCH` |
|
|
41
|
+
| `reason` | `STATIC`, `TARGETING_MATCH`, `SPLIT`, `DEFAULT`, `CACHED` (served from the cache or `bootstrap` before the first download), `STALE` (the last download failed), `ERROR` |
|
|
42
|
+
| `variant` | `rule:<i>`, `rule:<i>/pct:<j>`, `pct:<j>` or `default` |
|
|
43
|
+
| `flagMetadata` | `revision`, plus `rule_index` / `percentage_index` when a rule or split decided the value |
|
|
44
|
+
| `errorCode` | `FLAG_NOT_FOUND`, `TYPE_MISMATCH`, `PARSE_ERROR`, `PROVIDER_NOT_READY`; prerequisite errors (cycle, missing, too deep) are `GENERAL` |
|
|
45
|
+
|
|
46
|
+
Evaluations never throw: on any failure you get your default with `reason: "ERROR"`.
|
|
47
|
+
|
|
48
|
+
## Lifecycle and events
|
|
49
|
+
|
|
50
|
+
- `initialize` waits for the first download, at most `polling.maxInitWaitSeconds` (default 5). It fails (provider status `ERROR`) only when there is no config at all: no download, no cache, no `bootstrap`. Evaluations then return `PROVIDER_NOT_READY` with your default until a config arrives, which reports `PROVIDER_READY`.
|
|
51
|
+
- `PROVIDER_CONFIGURATION_CHANGED` when a new config revision is adopted, with `flagsChanged` (every key when segments changed) and `metadata.revision`.
|
|
52
|
+
- `PROVIDER_STALE` when a download fails while an older config is being served; `PROVIDER_READY` after the next successful download.
|
|
53
|
+
- `PROVIDER_ERROR` when the SDK key is unknown, revoked or expired (HTTP 404; the held config is still served), or a download fails with no config held.
|
|
54
|
+
- Download failures are logged through the provider's `logger` (`console` by default, `null` for none). Log lines never contain the SDK key.
|
|
55
|
+
- `onClose` (`OpenFeature.close()` or replacing the provider) closes the `FlagsClient`, including one you passed in.
|
|
56
|
+
|
|
57
|
+
`provider.client` is the `FlagsClient` underneath, for `forceRefresh()`, `snapshot()` or `getAllValues()`.
|
|
58
|
+
|
|
59
|
+
## Tests
|
|
60
|
+
|
|
61
|
+
Use `createTestClient` from `@productcraft/flags/testing`: no network, no timers.
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
import { OpenFeature } from "@openfeature/server-sdk";
|
|
65
|
+
import { createTestClient } from "@productcraft/flags/testing";
|
|
66
|
+
import { ProductCraftFlagsProvider } from "@productcraft/flags-openfeature";
|
|
67
|
+
|
|
68
|
+
const client = createTestClient({ values: { new_checkout: true } });
|
|
69
|
+
await OpenFeature.setProviderAndWait(new ProductCraftFlagsProvider({ client }));
|
|
70
|
+
client.set("new_checkout", false); // emits PROVIDER_CONFIGURATION_CHANGED
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Requirements
|
|
74
|
+
|
|
75
|
+
Node.js 20.3+, `@openfeature/server-sdk` 1.17+ and `@productcraft/flags` 0.1+ (peer dependencies). ESM and CommonJS.
|
|
76
|
+
|
|
77
|
+
MIT licensed.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var serverSdk = require('@openfeature/server-sdk');
|
|
4
|
+
var flags = require('@productcraft/flags');
|
|
5
|
+
|
|
6
|
+
// src/provider.ts
|
|
7
|
+
var ERROR_CODES = {
|
|
8
|
+
FLAG_NOT_FOUND: serverSdk.ErrorCode.FLAG_NOT_FOUND,
|
|
9
|
+
TYPE_MISMATCH: serverSdk.ErrorCode.TYPE_MISMATCH,
|
|
10
|
+
PARSE_ERROR: serverSdk.ErrorCode.PARSE_ERROR,
|
|
11
|
+
PROVIDER_NOT_READY: serverSdk.ErrorCode.PROVIDER_NOT_READY
|
|
12
|
+
};
|
|
13
|
+
var DOWNLOAD_ERRORS = /* @__PURE__ */ new Set([
|
|
14
|
+
"network",
|
|
15
|
+
"http_status",
|
|
16
|
+
"too_large",
|
|
17
|
+
"PARSE_ERROR",
|
|
18
|
+
"UNSUPPORTED_SCHEMA",
|
|
19
|
+
"key_invalid",
|
|
20
|
+
"rate_limited"
|
|
21
|
+
]);
|
|
22
|
+
var OBJECT_DEFAULT = Object.freeze({});
|
|
23
|
+
var ProductCraftFlagsProvider = class {
|
|
24
|
+
metadata = { name: "productcraft-flags" };
|
|
25
|
+
runsOn = "server";
|
|
26
|
+
events = new serverSdk.OpenFeatureEventEmitter();
|
|
27
|
+
/** The `FlagsClient` underneath: for `snapshot()`, `forceRefresh()`, `getAllValues()` and its own events. */
|
|
28
|
+
client;
|
|
29
|
+
#log;
|
|
30
|
+
#unsubscribe;
|
|
31
|
+
/** The status this provider last reported; events fire on changes only. */
|
|
32
|
+
#status = "initializing";
|
|
33
|
+
#settings;
|
|
34
|
+
constructor(options) {
|
|
35
|
+
const own = !("client" in options && options.client);
|
|
36
|
+
this.client = own ? new flags.FlagsClient(options) : options.client;
|
|
37
|
+
const logger = options.logger;
|
|
38
|
+
this.#log = logger === null ? null : logger ?? console;
|
|
39
|
+
this.#settings = this.#currentSettings();
|
|
40
|
+
this.#unsubscribe = [
|
|
41
|
+
this.client.on("configChanged", () => this.#configChanged()),
|
|
42
|
+
this.client.on("error", (e) => this.#clientError(e))
|
|
43
|
+
];
|
|
44
|
+
}
|
|
45
|
+
/** Waits for the first download (at most `maxInitWaitSeconds`). Rejects when no config is available at all. */
|
|
46
|
+
async initialize() {
|
|
47
|
+
const state = await this.client.waitForReady();
|
|
48
|
+
if (this.client.snapshot().toJSON() === null) {
|
|
49
|
+
this.#status = "error";
|
|
50
|
+
throw new Error(
|
|
51
|
+
`[productcraft/flags] no config available (client state: ${state})`
|
|
52
|
+
);
|
|
53
|
+
}
|
|
54
|
+
this.#status = "ready";
|
|
55
|
+
}
|
|
56
|
+
/** Closes the client: stops polling and timers. */
|
|
57
|
+
async onClose() {
|
|
58
|
+
for (const off of this.#unsubscribe) off();
|
|
59
|
+
this.client.close();
|
|
60
|
+
}
|
|
61
|
+
resolveBooleanEvaluation(flagKey, defaultValue, context, logger) {
|
|
62
|
+
return this.#resolve(flagKey, defaultValue, context, logger);
|
|
63
|
+
}
|
|
64
|
+
resolveStringEvaluation(flagKey, defaultValue, context, logger) {
|
|
65
|
+
return this.#resolve(flagKey, defaultValue, context, logger);
|
|
66
|
+
}
|
|
67
|
+
resolveNumberEvaluation(flagKey, defaultValue, context, logger) {
|
|
68
|
+
return this.#resolve(flagKey, defaultValue, context, logger);
|
|
69
|
+
}
|
|
70
|
+
/** Json settings, parsed. Any other setting type is TYPE_MISMATCH. */
|
|
71
|
+
async resolveObjectEvaluation(flagKey, defaultValue, context, logger) {
|
|
72
|
+
const r = await this.#resolve(
|
|
73
|
+
flagKey,
|
|
74
|
+
OBJECT_DEFAULT,
|
|
75
|
+
context,
|
|
76
|
+
logger
|
|
77
|
+
);
|
|
78
|
+
return {
|
|
79
|
+
...r,
|
|
80
|
+
value: r.value === OBJECT_DEFAULT ? defaultValue : r.value
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
async #resolve(flagKey, defaultValue, context, logger) {
|
|
84
|
+
const d = await this.client.getValueDetails(
|
|
85
|
+
flagKey,
|
|
86
|
+
defaultValue,
|
|
87
|
+
toUser(context, logger)
|
|
88
|
+
);
|
|
89
|
+
this.#recovered();
|
|
90
|
+
return toResolution(d);
|
|
91
|
+
}
|
|
92
|
+
#configChanged() {
|
|
93
|
+
const before = this.#settings;
|
|
94
|
+
const after = this.#settings = this.#currentSettings();
|
|
95
|
+
this.#recovered();
|
|
96
|
+
if (this.#status === "initializing") return;
|
|
97
|
+
this.events.emit(serverSdk.ProviderEvents.ConfigurationChanged, {
|
|
98
|
+
flagsChanged: changedKeys(before, after),
|
|
99
|
+
metadata: { revision: this.client.snapshot().revision }
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
#clientError(e) {
|
|
103
|
+
if (!DOWNLOAD_ERRORS.has(e.code ?? "")) return;
|
|
104
|
+
try {
|
|
105
|
+
this.#log?.warn(`[productcraft/flags] ${e.message}`);
|
|
106
|
+
} catch {
|
|
107
|
+
}
|
|
108
|
+
if (this.#status === "initializing") return;
|
|
109
|
+
const next = e.code === "key_invalid" || this.client.snapshot().toJSON() === null ? "error" : "stale";
|
|
110
|
+
if (next === this.#status) return;
|
|
111
|
+
this.#status = next;
|
|
112
|
+
if (next === "error")
|
|
113
|
+
this.events.emit(serverSdk.ProviderEvents.Error, {
|
|
114
|
+
message: e.message,
|
|
115
|
+
errorCode: serverSdk.ErrorCode.GENERAL
|
|
116
|
+
});
|
|
117
|
+
else this.events.emit(serverSdk.ProviderEvents.Stale, { message: e.message });
|
|
118
|
+
}
|
|
119
|
+
/** After STALE or ERROR, the first successful download (or new config) reports READY again. */
|
|
120
|
+
#recovered() {
|
|
121
|
+
if ((this.#status === "stale" || this.#status === "error") && this.client.state === "ready" && this.client.snapshot().toJSON() !== null) {
|
|
122
|
+
this.#status = "ready";
|
|
123
|
+
this.events.emit(serverSdk.ProviderEvents.Ready);
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
#currentSettings() {
|
|
127
|
+
const raw = this.client.snapshot().toJSON();
|
|
128
|
+
return raw ? {
|
|
129
|
+
settings: raw.settings,
|
|
130
|
+
segments: raw.segments,
|
|
131
|
+
salt: raw.salt
|
|
132
|
+
} : null;
|
|
133
|
+
}
|
|
134
|
+
};
|
|
135
|
+
function changedKeys(before, after) {
|
|
136
|
+
const b = before?.settings ?? {};
|
|
137
|
+
const a = after?.settings ?? {};
|
|
138
|
+
const all = [.../* @__PURE__ */ new Set([...Object.keys(b), ...Object.keys(a)])];
|
|
139
|
+
const shared = JSON.stringify(before?.segments ?? null) === JSON.stringify(after?.segments ?? null) && before?.salt === after?.salt;
|
|
140
|
+
return shared ? all.filter((k) => JSON.stringify(b[k]) !== JSON.stringify(a[k])) : all;
|
|
141
|
+
}
|
|
142
|
+
function toUser(context, logger) {
|
|
143
|
+
const custom = /* @__PURE__ */ Object.create(null);
|
|
144
|
+
const user = { custom };
|
|
145
|
+
let any = false;
|
|
146
|
+
for (const key of Object.keys(context)) {
|
|
147
|
+
if (key === "targetingKey") continue;
|
|
148
|
+
const value = attribute(context[key]);
|
|
149
|
+
if (value === void 0) {
|
|
150
|
+
if (context[key] !== null && context[key] !== void 0)
|
|
151
|
+
logger?.debug(
|
|
152
|
+
`[productcraft/flags] context attribute ${JSON.stringify(key)} dropped: not a string, number, boolean, Date or string[]`
|
|
153
|
+
);
|
|
154
|
+
continue;
|
|
155
|
+
}
|
|
156
|
+
any = true;
|
|
157
|
+
if (key === "identifier" || key === "email" || key === "country")
|
|
158
|
+
user[key] = value;
|
|
159
|
+
else custom[key] = value;
|
|
160
|
+
}
|
|
161
|
+
if (typeof context.targetingKey === "string" && context.targetingKey !== "") {
|
|
162
|
+
user.identifier = context.targetingKey;
|
|
163
|
+
any = true;
|
|
164
|
+
}
|
|
165
|
+
return any ? user : void 0;
|
|
166
|
+
}
|
|
167
|
+
function attribute(v) {
|
|
168
|
+
if (typeof v === "string" || typeof v === "number" || typeof v === "boolean" || v instanceof Date)
|
|
169
|
+
return v;
|
|
170
|
+
if (Array.isArray(v) && v.every((x) => typeof x === "string"))
|
|
171
|
+
return v;
|
|
172
|
+
return void 0;
|
|
173
|
+
}
|
|
174
|
+
function toResolution(d) {
|
|
175
|
+
const flagMetadata = { revision: d.revision };
|
|
176
|
+
if (d.ruleIndex !== null) flagMetadata.rule_index = d.ruleIndex;
|
|
177
|
+
if (d.percentageIndex !== null)
|
|
178
|
+
flagMetadata.percentage_index = d.percentageIndex;
|
|
179
|
+
const out = {
|
|
180
|
+
value: d.value,
|
|
181
|
+
reason: d.reason,
|
|
182
|
+
flagMetadata
|
|
183
|
+
};
|
|
184
|
+
if (d.variant !== null) out.variant = d.variant;
|
|
185
|
+
if (d.reason === "ERROR" || d.errorCode !== null) {
|
|
186
|
+
out.reason = "ERROR";
|
|
187
|
+
out.errorCode = ERROR_CODES[d.errorCode ?? ""] ?? serverSdk.ErrorCode.GENERAL;
|
|
188
|
+
if (d.errorMessage) out.errorMessage = d.errorMessage;
|
|
189
|
+
}
|
|
190
|
+
return out;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
exports.ProductCraftFlagsProvider = ProductCraftFlagsProvider;
|
|
194
|
+
exports.toResolution = toResolution;
|
|
195
|
+
exports.toUser = toUser;
|
|
196
|
+
//# sourceMappingURL=index.cjs.map
|
|
197
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/provider.ts"],"names":["ErrorCode","OpenFeatureEventEmitter","FlagsClient","ProviderEvents"],"mappings":";;;;;;AA2CA,IAAM,WAAA,GAAyC;AAAA,EAC7C,gBAAgBA,mBAAA,CAAU,cAAA;AAAA,EAC1B,eAAeA,mBAAA,CAAU,aAAA;AAAA,EACzB,aAAaA,mBAAA,CAAU,WAAA;AAAA,EACvB,oBAAoBA,mBAAA,CAAU;AAChC,CAAA;AAGA,IAAM,eAAA,uBAAsB,GAAA,CAAI;AAAA,EAC9B,SAAA;AAAA,EACA,aAAA;AAAA,EACA,WAAA;AAAA,EACA,aAAA;AAAA,EACA,oBAAA;AAAA,EACA,aAAA;AAAA,EACA;AACF,CAAC,CAAA;AAGD,IAAM,cAAA,GAAgC,MAAA,CAAO,MAAA,CAAO,EAAE,CAAA;AAe/C,IAAM,4BAAN,MAAoD;AAAA,EAChD,QAAA,GAA6B,EAAE,IAAA,EAAM,oBAAA,EAAqB;AAAA,EAC1D,MAAA,GAAS,QAAA;AAAA,EACT,MAAA,GAAS,IAAIC,iCAAA,EAAwB;AAAA;AAAA,EAErC,MAAA;AAAA,EACA,IAAA;AAAA,EACA,YAAA;AAAA;AAAA,EAET,OAAA,GAAwD,cAAA;AAAA,EACxD,SAAA;AAAA,EAEA,YAAY,OAAA,EAA2C;AAErD,IAAA,MAAM,GAAA,GAAM,EAAE,QAAA,IAAY,OAAA,IAAW,OAAA,CAAQ,MAAA,CAAA;AAC7C,IAAA,IAAA,CAAK,SAAS,GAAA,GACV,IAAIC,iBAAA,CAAY,OAA6B,IAC5C,OAAA,CAAoC,MAAA;AACzC,IAAA,MAAM,SAAU,OAAA,CAA+C,MAAA;AAC/D,IAAA,IAAA,CAAK,IAAA,GAAO,MAAA,KAAW,IAAA,GAAO,IAAA,GAAQ,MAAA,IAAU,OAAA;AAChD,IAAA,IAAA,CAAK,SAAA,GAAY,KAAK,gBAAA,EAAiB;AACvC,IAAA,IAAA,CAAK,YAAA,GAAe;AAAA,MAClB,KAAK,MAAA,CAAO,EAAA,CAAG,iBAAiB,MAAM,IAAA,CAAK,gBAAgB,CAAA;AAAA,MAC3D,IAAA,CAAK,OAAO,EAAA,CAAG,OAAA,EAAS,CAAC,CAAA,KAAM,IAAA,CAAK,YAAA,CAAa,CAAC,CAAC;AAAA,KACrD;AAAA,EACF;AAAA;AAAA,EAGA,MAAM,UAAA,GAA4B;AAChC,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,MAAA,CAAO,YAAA,EAAa;AAC7C,IAAA,IAAI,KAAK,MAAA,CAAO,QAAA,EAAS,CAAE,MAAA,OAAa,IAAA,EAAM;AAC5C,MAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,2DAA2D,KAAK,CAAA,CAAA;AAAA,OAClE;AAAA,IACF;AACA,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AAAA,EACjB;AAAA;AAAA,EAGA,MAAM,OAAA,GAAyB;AAC7B,IAAA,KAAA,MAAW,GAAA,IAAO,IAAA,CAAK,YAAA,EAAc,GAAA,EAAI;AACzC,IAAA,IAAA,CAAK,OAAO,KAAA,EAAM;AAAA,EACpB;AAAA,EAEA,wBAAA,CACE,OAAA,EACA,YAAA,EACA,OAAA,EACA,MAAA,EACqC;AACrC,IAAA,OAAO,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,YAAA,EAAc,SAAS,MAAM,CAAA;AAAA,EAC7D;AAAA,EAEA,uBAAA,CACE,OAAA,EACA,YAAA,EACA,OAAA,EACA,MAAA,EACoC;AACpC,IAAA,OAAO,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,YAAA,EAAc,SAAS,MAAM,CAAA;AAAA,EAC7D;AAAA,EAEA,uBAAA,CACE,OAAA,EACA,YAAA,EACA,OAAA,EACA,MAAA,EACoC;AACpC,IAAA,OAAO,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,YAAA,EAAc,SAAS,MAAM,CAAA;AAAA,EAC7D;AAAA;AAAA,EAGA,MAAM,uBAAA,CACJ,OAAA,EACA,YAAA,EACA,SACA,MAAA,EAC+B;AAC/B,IAAA,MAAM,CAAA,GAAI,MAAM,IAAA,CAAK,QAAA;AAAA,MACnB,OAAA;AAAA,MACA,cAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,OAAO;AAAA,MACL,GAAG,CAAA;AAAA,MACH,KAAA,EAAQ,CAAA,CAAE,KAAA,KAAU,cAAA,GAAiB,eAAe,CAAA,CAAE;AAAA,KACxD;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,OAAA,EACA,YAAA,EACA,SACA,MAAA,EAC+B;AAC/B,IAAA,MAAM,CAAA,GAAK,MAAM,IAAA,CAAK,MAAA,CAAO,eAAA;AAAA,MAC3B,OAAA;AAAA,MACA,YAAA;AAAA,MACA,MAAA,CAAO,SAAS,MAAM;AAAA,KACxB;AACA,IAAA,IAAA,CAAK,UAAA,EAAW;AAChB,IAAA,OAAO,aAAa,CAAC,CAAA;AAAA,EACvB;AAAA,EAEA,cAAA,GAAuB;AACrB,IAAA,MAAM,SAAS,IAAA,CAAK,SAAA;AACpB,IAAA,MAAM,KAAA,GAAS,IAAA,CAAK,SAAA,GAAY,IAAA,CAAK,gBAAA,EAAiB;AACtD,IAAA,IAAA,CAAK,UAAA,EAAW;AAChB,IAAA,IAAI,IAAA,CAAK,YAAY,cAAA,EAAgB;AACrC,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAKC,wBAAA,CAAe,oBAAA,EAAsB;AAAA,MACpD,YAAA,EAAc,WAAA,CAAY,MAAA,EAAQ,KAAK,CAAA;AAAA,MACvC,UAAU,EAAE,QAAA,EAAU,KAAK,MAAA,CAAO,QAAA,GAAW,QAAA;AAAS,KACvD,CAAA;AAAA,EACH;AAAA,EAEA,aAAa,CAAA,EAAoC;AAC/C,IAAA,IAAI,CAAC,eAAA,CAAgB,GAAA,CAAI,CAAA,CAAE,IAAA,IAAQ,EAAE,CAAA,EAAG;AACxC,IAAA,IAAI;AACF,MAAA,IAAA,CAAK,IAAA,EAAM,IAAA,CAAK,CAAA,qBAAA,EAAwB,CAAA,CAAE,OAAO,CAAA,CAAE,CAAA;AAAA,IACrD,CAAA,CAAA,MAAQ;AAAA,IAER;AACA,IAAA,IAAI,IAAA,CAAK,YAAY,cAAA,EAAgB;AACrC,IAAA,MAAM,IAAA,GACJ,CAAA,CAAE,IAAA,KAAS,aAAA,IAAiB,IAAA,CAAK,MAAA,CAAO,QAAA,EAAS,CAAE,MAAA,EAAO,KAAM,IAAA,GAC5D,OAAA,GACA,OAAA;AACN,IAAA,IAAI,IAAA,KAAS,KAAK,OAAA,EAAS;AAC3B,IAAA,IAAA,CAAK,OAAA,GAAU,IAAA;AACf,IAAA,IAAI,IAAA,KAAS,OAAA;AACX,MAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAKA,wBAAA,CAAe,KAAA,EAAO;AAAA,QACrC,SAAS,CAAA,CAAE,OAAA;AAAA,QACX,WAAWH,mBAAA,CAAU;AAAA,OACtB,CAAA;AAAA,SACE,IAAA,CAAK,OAAO,IAAA,CAAKG,wBAAA,CAAe,OAAO,EAAE,OAAA,EAAS,CAAA,CAAE,OAAA,EAAS,CAAA;AAAA,EACpE;AAAA;AAAA,EAGA,UAAA,GAAmB;AACjB,IAAA,IAAA,CACG,KAAK,OAAA,KAAY,OAAA,IAAW,IAAA,CAAK,OAAA,KAAY,YAC9C,IAAA,CAAK,MAAA,CAAO,KAAA,KAAU,OAAA,IACtB,KAAK,MAAA,CAAO,QAAA,EAAS,CAAE,MAAA,OAAa,IAAA,EACpC;AACA,MAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,MAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAKA,wBAAA,CAAe,KAAK,CAAA;AAAA,IACvC;AAAA,EACF;AAAA,EAEA,gBAAA,GAA+B;AAC7B,IAAA,MAAM,GAAA,GAAM,IAAA,CAAK,MAAA,CAAO,QAAA,GAAW,MAAA,EAAO;AAC1C,IAAA,OAAO,GAAA,GACF;AAAA,MACC,UAAU,GAAA,CAAI,QAAA;AAAA,MACd,UAAU,GAAA,CAAI,QAAA;AAAA,MACd,MAAM,GAAA,CAAI;AAAA,KACZ,GACA,IAAA;AAAA,EACN;AACF;AAGA,SAAS,WAAA,CAAY,QAAoB,KAAA,EAA6B;AACpE,EAAA,MAAM,CAAA,GAAK,MAAA,EAAQ,QAAA,IAAY,EAAC;AAChC,EAAA,MAAM,CAAA,GAAK,KAAA,EAAO,QAAA,IAAY,EAAC;AAC/B,EAAA,MAAM,MAAM,CAAC,mBAAG,IAAI,GAAA,CAAI,CAAC,GAAG,MAAA,CAAO,IAAA,CAAK,CAAC,GAAG,GAAG,MAAA,CAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAC/D,EAAA,MAAM,MAAA,GACJ,IAAA,CAAK,SAAA,CAAU,MAAA,EAAQ,YAAY,IAAI,CAAA,KACrC,IAAA,CAAK,SAAA,CAAU,OAAO,QAAA,IAAY,IAAI,CAAA,IAAK,MAAA,EAAQ,SAAS,KAAA,EAAO,IAAA;AACvE,EAAA,OAAO,SACH,GAAA,CAAI,MAAA,CAAO,CAAC,CAAA,KAAM,KAAK,SAAA,CAAU,CAAA,CAAE,CAAC,CAAC,MAAM,IAAA,CAAK,SAAA,CAAU,EAAE,CAAC,CAAC,CAAC,CAAA,GAC/D,GAAA;AACN;AAGO,SAAS,MAAA,CACd,SACA,MAAA,EACkB;AAClB,EAAA,MAAM,MAAA,mBAAS,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AACjC,EAAA,MAAM,IAAA,GAAa,EAAE,MAAA,EAAO;AAC5B,EAAA,IAAI,GAAA,GAAM,KAAA;AACV,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,OAAO,CAAA,EAAG;AACtC,IAAA,IAAI,QAAQ,cAAA,EAAgB;AAC5B,IAAA,MAAM,KAAA,GAAQ,SAAA,CAAU,OAAA,CAAQ,GAAG,CAAC,CAAA;AACpC,IAAA,IAAI,UAAU,MAAA,EAAW;AACvB,MAAA,IAAI,QAAQ,GAAG,CAAA,KAAM,IAAA,IAAQ,OAAA,CAAQ,GAAG,CAAA,KAAM,MAAA;AAC5C,QAAA,MAAA,EAAQ,KAAA;AAAA,UACN,CAAA,uCAAA,EAA0C,IAAA,CAAK,SAAA,CAAU,GAAG,CAAC,CAAA,yDAAA;AAAA,SAC/D;AACF,MAAA;AAAA,IACF;AACA,IAAA,GAAA,GAAM,IAAA;AAEN,IAAA,IAAI,GAAA,KAAQ,YAAA,IAAgB,GAAA,KAAQ,OAAA,IAAW,GAAA,KAAQ,SAAA;AACrD,MAAC,IAAA,CAAa,GAAG,CAAA,GAAI,KAAA;AAAA,SAClB,MAAA,CAAO,GAAG,CAAA,GAAI,KAAA;AAAA,EACrB;AACA,EAAA,IAAI,OAAO,OAAA,CAAQ,YAAA,KAAiB,QAAA,IAAY,OAAA,CAAQ,iBAAiB,EAAA,EAAI;AAC3E,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,YAAA;AAC1B,IAAA,GAAA,GAAM,IAAA;AAAA,EACR;AAEA,EAAA,OAAO,MAAM,IAAA,GAAO,MAAA;AACtB;AAEA,SAAS,UACP,CAAA,EACgC;AAChC,EAAA,IACE,OAAO,MAAM,QAAA,IACb,OAAO,MAAM,QAAA,IACb,OAAO,CAAA,KAAM,SAAA,IACb,CAAA,YAAa,IAAA;AAEb,IAAA,OAAO,CAAA;AACT,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAA,IAAK,CAAA,CAAE,MAAM,CAAC,CAAA,KAAM,OAAO,CAAA,KAAM,QAAQ,CAAA;AAC1D,IAAA,OAAO,CAAA;AACT,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,aAAgB,CAAA,EAA+C;AAC7E,EAAA,MAAM,YAAA,GAA6B,EAAE,QAAA,EAAU,CAAA,CAAE,QAAA,EAAS;AAC1D,EAAA,IAAI,CAAA,CAAE,SAAA,KAAc,IAAA,EAAM,YAAA,CAAa,aAAa,CAAA,CAAE,SAAA;AACtD,EAAA,IAAI,EAAE,eAAA,KAAoB,IAAA;AACxB,IAAA,YAAA,CAAa,mBAAmB,CAAA,CAAE,eAAA;AACpC,EAAA,MAAM,GAAA,GAA4B;AAAA,IAChC,OAAO,CAAA,CAAE,KAAA;AAAA,IACT,QAAQ,CAAA,CAAE,MAAA;AAAA,IACV;AAAA,GACF;AACA,EAAA,IAAI,CAAA,CAAE,OAAA,KAAY,IAAA,EAAM,GAAA,CAAI,UAAU,CAAA,CAAE,OAAA;AACxC,EAAA,IAAI,CAAA,CAAE,MAAA,KAAW,OAAA,IAAW,CAAA,CAAE,cAAc,IAAA,EAAM;AAChD,IAAA,GAAA,CAAI,MAAA,GAAS,OAAA;AACb,IAAA,GAAA,CAAI,YAAY,WAAA,CAAY,CAAA,CAAE,SAAA,IAAa,EAAE,KAAKH,mBAAA,CAAU,OAAA;AAC5D,IAAA,IAAI,CAAA,CAAE,YAAA,EAAc,GAAA,CAAI,YAAA,GAAe,CAAA,CAAE,YAAA;AAAA,EAC3C;AACA,EAAA,OAAO,GAAA;AACT","file":"index.cjs","sourcesContent":["/**\n * ProductCraftFlagsProvider: an OpenFeature server provider over `FlagsClient` (design 8.3).\n *\n * Evaluation stays local: the provider maps the OpenFeature evaluation context to a Flags user and asks\n * `FlagsClient`, which evaluates the downloaded config in this process. Reasons, variants and error codes\n * map onto OpenFeature's; `PREREQUISITE_*` errors become `GENERAL`.\n */\nimport {\n ErrorCode,\n OpenFeatureEventEmitter,\n ProviderEvents,\n type EvaluationContext,\n type EvaluationContextValue,\n type FlagMetadata,\n type JsonValue,\n type Logger as OpenFeatureLogger,\n type Provider,\n type ProviderMetadata,\n type ResolutionDetails,\n type ResolutionReason,\n} from \"@openfeature/server-sdk\";\nimport {\n FlagsClient,\n type EvaluationDetails,\n type FlagsClientOptions,\n type User,\n type UserAttributeValue,\n} from \"@productcraft/flags\";\n\n/** Where the provider logs download failures it reports as events. `console` by default; `null` logs nothing. */\nexport interface ProviderLogger {\n warn(...args: unknown[]): void;\n}\n\nexport type ProductCraftFlagsProviderOptions =\n /** Use your own client (it is closed when the provider closes). */\n | { client: FlagsClient; logger?: ProviderLogger | null }\n /** Or let the provider create one from `FlagsClient` options. */\n | FlagsClientOptions;\n\ntype Obj = Record<string, unknown>;\n\n/** Engine and client error codes to OpenFeature's; anything else (`PREREQUISITE_*`) is GENERAL. */\nconst ERROR_CODES: Record<string, ErrorCode> = {\n FLAG_NOT_FOUND: ErrorCode.FLAG_NOT_FOUND,\n TYPE_MISMATCH: ErrorCode.TYPE_MISMATCH,\n PARSE_ERROR: ErrorCode.PARSE_ERROR,\n PROVIDER_NOT_READY: ErrorCode.PROVIDER_NOT_READY,\n};\n\n/** Download failures; the rest (`evaluation`, `listener`, `cache`, `overrides`) change no provider status. */\nconst DOWNLOAD_ERRORS = new Set([\n \"network\",\n \"http_status\",\n \"too_large\",\n \"PARSE_ERROR\",\n \"UNSUPPORTED_SCHEMA\",\n \"key_invalid\",\n \"rate_limited\",\n]);\n\n/** Stands in for an object default, so FlagsClient parses json settings and reports any other type as TYPE_MISMATCH. */\nconst OBJECT_DEFAULT: Readonly<Obj> = Object.freeze({});\n\n/**\n * ProductCraft Flags as an OpenFeature provider.\n *\n * @example\n * ```ts\n * import { OpenFeature } from \"@openfeature/server-sdk\";\n * import { ProductCraftFlagsProvider } from \"@productcraft/flags-openfeature\";\n *\n * await OpenFeature.setProviderAndWait(new ProductCraftFlagsProvider({ sdkKey: process.env.PRODUCTCRAFT_FLAGS_SDK_KEY }));\n * const client = OpenFeature.getClient();\n * const on = await client.getBooleanValue(\"new_checkout\", false, { targetingKey: user.id, plan: \"pro\" });\n * ```\n */\nexport class ProductCraftFlagsProvider implements Provider {\n readonly metadata: ProviderMetadata = { name: \"productcraft-flags\" };\n readonly runsOn = \"server\" as const;\n readonly events = new OpenFeatureEventEmitter();\n /** The `FlagsClient` underneath: for `snapshot()`, `forceRefresh()`, `getAllValues()` and its own events. */\n readonly client: FlagsClient;\n readonly #log: ProviderLogger | null;\n readonly #unsubscribe: Array<() => void>;\n /** The status this provider last reported; events fire on changes only. */\n #status: \"initializing\" | \"ready\" | \"stale\" | \"error\" = \"initializing\";\n #settings: Obj | null;\n\n constructor(options: ProductCraftFlagsProviderOptions) {\n // Duck-typed: an ESM FlagsClient and a CJS one are different classes.\n const own = !(\"client\" in options && options.client);\n this.client = own\n ? new FlagsClient(options as FlagsClientOptions)\n : (options as { client: FlagsClient }).client;\n const logger = (options as { logger?: ProviderLogger | null }).logger;\n this.#log = logger === null ? null : (logger ?? console);\n this.#settings = this.#currentSettings();\n this.#unsubscribe = [\n this.client.on(\"configChanged\", () => this.#configChanged()),\n this.client.on(\"error\", (e) => this.#clientError(e)),\n ];\n }\n\n /** Waits for the first download (at most `maxInitWaitSeconds`). Rejects when no config is available at all. */\n async initialize(): Promise<void> {\n const state = await this.client.waitForReady();\n if (this.client.snapshot().toJSON() === null) {\n this.#status = \"error\";\n throw new Error(\n `[productcraft/flags] no config available (client state: ${state})`,\n );\n }\n this.#status = \"ready\";\n }\n\n /** Closes the client: stops polling and timers. */\n async onClose(): Promise<void> {\n for (const off of this.#unsubscribe) off();\n this.client.close();\n }\n\n resolveBooleanEvaluation(\n flagKey: string,\n defaultValue: boolean,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<boolean>> {\n return this.#resolve(flagKey, defaultValue, context, logger);\n }\n\n resolveStringEvaluation(\n flagKey: string,\n defaultValue: string,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<string>> {\n return this.#resolve(flagKey, defaultValue, context, logger);\n }\n\n resolveNumberEvaluation(\n flagKey: string,\n defaultValue: number,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<number>> {\n return this.#resolve(flagKey, defaultValue, context, logger);\n }\n\n /** Json settings, parsed. Any other setting type is TYPE_MISMATCH. */\n async resolveObjectEvaluation<T extends JsonValue>(\n flagKey: string,\n defaultValue: T,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<T>> {\n const r = await this.#resolve<unknown>(\n flagKey,\n OBJECT_DEFAULT,\n context,\n logger,\n );\n return {\n ...r,\n value: (r.value === OBJECT_DEFAULT ? defaultValue : r.value) as T,\n };\n }\n\n async #resolve<T>(\n flagKey: string,\n defaultValue: T,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<T>> {\n const d = (await this.client.getValueDetails(\n flagKey,\n defaultValue as never,\n toUser(context, logger),\n )) as EvaluationDetails<T>;\n this.#recovered();\n return toResolution(d);\n }\n\n #configChanged(): void {\n const before = this.#settings;\n const after = (this.#settings = this.#currentSettings());\n this.#recovered();\n if (this.#status === \"initializing\") return;\n this.events.emit(ProviderEvents.ConfigurationChanged, {\n flagsChanged: changedKeys(before, after),\n metadata: { revision: this.client.snapshot().revision },\n });\n }\n\n #clientError(e: Error & { code?: string }): void {\n if (!DOWNLOAD_ERRORS.has(e.code ?? \"\")) return;\n try {\n this.#log?.warn(`[productcraft/flags] ${e.message}`);\n } catch {\n /* a broken logger never breaks the provider */\n }\n if (this.#status === \"initializing\") return;\n const next =\n e.code === \"key_invalid\" || this.client.snapshot().toJSON() === null\n ? \"error\"\n : \"stale\";\n if (next === this.#status) return;\n this.#status = next;\n if (next === \"error\")\n this.events.emit(ProviderEvents.Error, {\n message: e.message,\n errorCode: ErrorCode.GENERAL,\n });\n else this.events.emit(ProviderEvents.Stale, { message: e.message });\n }\n\n /** After STALE or ERROR, the first successful download (or new config) reports READY again. */\n #recovered(): void {\n if (\n (this.#status === \"stale\" || this.#status === \"error\") &&\n this.client.state === \"ready\" &&\n this.client.snapshot().toJSON() !== null\n ) {\n this.#status = \"ready\";\n this.events.emit(ProviderEvents.Ready);\n }\n }\n\n #currentSettings(): Obj | null {\n const raw = this.client.snapshot().toJSON() as Obj | null;\n return raw\n ? ({\n settings: raw.settings,\n segments: raw.segments,\n salt: raw.salt,\n } as Obj)\n : null;\n }\n}\n\n/** Keys whose setting changed; every key when segments or the salt changed (any rule may depend on them). */\nfunction changedKeys(before: Obj | null, after: Obj | null): string[] {\n const b = (before?.settings ?? {}) as Obj;\n const a = (after?.settings ?? {}) as Obj;\n const all = [...new Set([...Object.keys(b), ...Object.keys(a)])];\n const shared =\n JSON.stringify(before?.segments ?? null) ===\n JSON.stringify(after?.segments ?? null) && before?.salt === after?.salt;\n return shared\n ? all.filter((k) => JSON.stringify(b[k]) !== JSON.stringify(a[k]))\n : all;\n}\n\n/** OpenFeature's context to a Flags user: `targetingKey` is the identifier; primitives, Dates and string arrays are attributes. */\nexport function toUser(\n context: EvaluationContext,\n logger?: OpenFeatureLogger,\n): User | undefined {\n const custom = Object.create(null) as Record<string, UserAttributeValue>;\n const user: User = { custom };\n let any = false;\n for (const key of Object.keys(context)) {\n if (key === \"targetingKey\") continue;\n const value = attribute(context[key]);\n if (value === undefined) {\n if (context[key] !== null && context[key] !== undefined)\n logger?.debug(\n `[productcraft/flags] context attribute ${JSON.stringify(key)} dropped: not a string, number, boolean, Date or string[]`,\n );\n continue;\n }\n any = true;\n // The engine reads these three from the top level (and coerces a number identifier to text).\n if (key === \"identifier\" || key === \"email\" || key === \"country\")\n (user as Obj)[key] = value;\n else custom[key] = value;\n }\n if (typeof context.targetingKey === \"string\" && context.targetingKey !== \"\") {\n user.identifier = context.targetingKey;\n any = true;\n }\n // An empty context leaves the client's default user in place.\n return any ? user : undefined;\n}\n\nfunction attribute(\n v: EvaluationContextValue | undefined,\n): UserAttributeValue | undefined {\n if (\n typeof v === \"string\" ||\n typeof v === \"number\" ||\n typeof v === \"boolean\" ||\n v instanceof Date\n )\n return v;\n if (Array.isArray(v) && v.every((x) => typeof x === \"string\"))\n return v as string[];\n return undefined;\n}\n\n/** FlagsClient's evaluation details to OpenFeature's resolution. */\nexport function toResolution<T>(d: EvaluationDetails<T>): ResolutionDetails<T> {\n const flagMetadata: FlagMetadata = { revision: d.revision };\n if (d.ruleIndex !== null) flagMetadata.rule_index = d.ruleIndex;\n if (d.percentageIndex !== null)\n flagMetadata.percentage_index = d.percentageIndex;\n const out: ResolutionDetails<T> = {\n value: d.value,\n reason: d.reason as ResolutionReason,\n flagMetadata,\n };\n if (d.variant !== null) out.variant = d.variant;\n if (d.reason === \"ERROR\" || d.errorCode !== null) {\n out.reason = \"ERROR\";\n out.errorCode = ERROR_CODES[d.errorCode ?? \"\"] ?? ErrorCode.GENERAL;\n if (d.errorMessage) out.errorMessage = d.errorMessage;\n }\n return out;\n}\n"]}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { Provider, ProviderMetadata, OpenFeatureEventEmitter, EvaluationContext, Logger, ResolutionDetails, JsonValue } from '@openfeature/server-sdk';
|
|
2
|
+
import { FlagsClient, FlagsClientOptions, EvaluationDetails, User } from '@productcraft/flags';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* ProductCraftFlagsProvider: an OpenFeature server provider over `FlagsClient` (design 8.3).
|
|
6
|
+
*
|
|
7
|
+
* Evaluation stays local: the provider maps the OpenFeature evaluation context to a Flags user and asks
|
|
8
|
+
* `FlagsClient`, which evaluates the downloaded config in this process. Reasons, variants and error codes
|
|
9
|
+
* map onto OpenFeature's; `PREREQUISITE_*` errors become `GENERAL`.
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
/** Where the provider logs download failures it reports as events. `console` by default; `null` logs nothing. */
|
|
13
|
+
interface ProviderLogger {
|
|
14
|
+
warn(...args: unknown[]): void;
|
|
15
|
+
}
|
|
16
|
+
type ProductCraftFlagsProviderOptions =
|
|
17
|
+
/** Use your own client (it is closed when the provider closes). */
|
|
18
|
+
{
|
|
19
|
+
client: FlagsClient;
|
|
20
|
+
logger?: ProviderLogger | null;
|
|
21
|
+
}
|
|
22
|
+
/** Or let the provider create one from `FlagsClient` options. */
|
|
23
|
+
| FlagsClientOptions;
|
|
24
|
+
/**
|
|
25
|
+
* ProductCraft Flags as an OpenFeature provider.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* import { OpenFeature } from "@openfeature/server-sdk";
|
|
30
|
+
* import { ProductCraftFlagsProvider } from "@productcraft/flags-openfeature";
|
|
31
|
+
*
|
|
32
|
+
* await OpenFeature.setProviderAndWait(new ProductCraftFlagsProvider({ sdkKey: process.env.PRODUCTCRAFT_FLAGS_SDK_KEY }));
|
|
33
|
+
* const client = OpenFeature.getClient();
|
|
34
|
+
* const on = await client.getBooleanValue("new_checkout", false, { targetingKey: user.id, plan: "pro" });
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
declare class ProductCraftFlagsProvider implements Provider {
|
|
38
|
+
#private;
|
|
39
|
+
readonly metadata: ProviderMetadata;
|
|
40
|
+
readonly runsOn: "server";
|
|
41
|
+
readonly events: OpenFeatureEventEmitter;
|
|
42
|
+
/** The `FlagsClient` underneath: for `snapshot()`, `forceRefresh()`, `getAllValues()` and its own events. */
|
|
43
|
+
readonly client: FlagsClient;
|
|
44
|
+
constructor(options: ProductCraftFlagsProviderOptions);
|
|
45
|
+
/** Waits for the first download (at most `maxInitWaitSeconds`). Rejects when no config is available at all. */
|
|
46
|
+
initialize(): Promise<void>;
|
|
47
|
+
/** Closes the client: stops polling and timers. */
|
|
48
|
+
onClose(): Promise<void>;
|
|
49
|
+
resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
|
|
50
|
+
resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
|
|
51
|
+
resolveNumberEvaluation(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
|
|
52
|
+
/** Json settings, parsed. Any other setting type is TYPE_MISMATCH. */
|
|
53
|
+
resolveObjectEvaluation<T extends JsonValue>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
|
|
54
|
+
}
|
|
55
|
+
/** OpenFeature's context to a Flags user: `targetingKey` is the identifier; primitives, Dates and string arrays are attributes. */
|
|
56
|
+
declare function toUser(context: EvaluationContext, logger?: Logger): User | undefined;
|
|
57
|
+
/** FlagsClient's evaluation details to OpenFeature's resolution. */
|
|
58
|
+
declare function toResolution<T>(d: EvaluationDetails<T>): ResolutionDetails<T>;
|
|
59
|
+
|
|
60
|
+
export { ProductCraftFlagsProvider, type ProductCraftFlagsProviderOptions, type ProviderLogger, toResolution, toUser };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { Provider, ProviderMetadata, OpenFeatureEventEmitter, EvaluationContext, Logger, ResolutionDetails, JsonValue } from '@openfeature/server-sdk';
|
|
2
|
+
import { FlagsClient, FlagsClientOptions, EvaluationDetails, User } from '@productcraft/flags';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* ProductCraftFlagsProvider: an OpenFeature server provider over `FlagsClient` (design 8.3).
|
|
6
|
+
*
|
|
7
|
+
* Evaluation stays local: the provider maps the OpenFeature evaluation context to a Flags user and asks
|
|
8
|
+
* `FlagsClient`, which evaluates the downloaded config in this process. Reasons, variants and error codes
|
|
9
|
+
* map onto OpenFeature's; `PREREQUISITE_*` errors become `GENERAL`.
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
/** Where the provider logs download failures it reports as events. `console` by default; `null` logs nothing. */
|
|
13
|
+
interface ProviderLogger {
|
|
14
|
+
warn(...args: unknown[]): void;
|
|
15
|
+
}
|
|
16
|
+
type ProductCraftFlagsProviderOptions =
|
|
17
|
+
/** Use your own client (it is closed when the provider closes). */
|
|
18
|
+
{
|
|
19
|
+
client: FlagsClient;
|
|
20
|
+
logger?: ProviderLogger | null;
|
|
21
|
+
}
|
|
22
|
+
/** Or let the provider create one from `FlagsClient` options. */
|
|
23
|
+
| FlagsClientOptions;
|
|
24
|
+
/**
|
|
25
|
+
* ProductCraft Flags as an OpenFeature provider.
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* import { OpenFeature } from "@openfeature/server-sdk";
|
|
30
|
+
* import { ProductCraftFlagsProvider } from "@productcraft/flags-openfeature";
|
|
31
|
+
*
|
|
32
|
+
* await OpenFeature.setProviderAndWait(new ProductCraftFlagsProvider({ sdkKey: process.env.PRODUCTCRAFT_FLAGS_SDK_KEY }));
|
|
33
|
+
* const client = OpenFeature.getClient();
|
|
34
|
+
* const on = await client.getBooleanValue("new_checkout", false, { targetingKey: user.id, plan: "pro" });
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
declare class ProductCraftFlagsProvider implements Provider {
|
|
38
|
+
#private;
|
|
39
|
+
readonly metadata: ProviderMetadata;
|
|
40
|
+
readonly runsOn: "server";
|
|
41
|
+
readonly events: OpenFeatureEventEmitter;
|
|
42
|
+
/** The `FlagsClient` underneath: for `snapshot()`, `forceRefresh()`, `getAllValues()` and its own events. */
|
|
43
|
+
readonly client: FlagsClient;
|
|
44
|
+
constructor(options: ProductCraftFlagsProviderOptions);
|
|
45
|
+
/** Waits for the first download (at most `maxInitWaitSeconds`). Rejects when no config is available at all. */
|
|
46
|
+
initialize(): Promise<void>;
|
|
47
|
+
/** Closes the client: stops polling and timers. */
|
|
48
|
+
onClose(): Promise<void>;
|
|
49
|
+
resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
|
|
50
|
+
resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
|
|
51
|
+
resolveNumberEvaluation(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
|
|
52
|
+
/** Json settings, parsed. Any other setting type is TYPE_MISMATCH. */
|
|
53
|
+
resolveObjectEvaluation<T extends JsonValue>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
|
|
54
|
+
}
|
|
55
|
+
/** OpenFeature's context to a Flags user: `targetingKey` is the identifier; primitives, Dates and string arrays are attributes. */
|
|
56
|
+
declare function toUser(context: EvaluationContext, logger?: Logger): User | undefined;
|
|
57
|
+
/** FlagsClient's evaluation details to OpenFeature's resolution. */
|
|
58
|
+
declare function toResolution<T>(d: EvaluationDetails<T>): ResolutionDetails<T>;
|
|
59
|
+
|
|
60
|
+
export { ProductCraftFlagsProvider, type ProductCraftFlagsProviderOptions, type ProviderLogger, toResolution, toUser };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import { ErrorCode, OpenFeatureEventEmitter, ProviderEvents } from '@openfeature/server-sdk';
|
|
2
|
+
import { FlagsClient } from '@productcraft/flags';
|
|
3
|
+
|
|
4
|
+
// src/provider.ts
|
|
5
|
+
var ERROR_CODES = {
|
|
6
|
+
FLAG_NOT_FOUND: ErrorCode.FLAG_NOT_FOUND,
|
|
7
|
+
TYPE_MISMATCH: ErrorCode.TYPE_MISMATCH,
|
|
8
|
+
PARSE_ERROR: ErrorCode.PARSE_ERROR,
|
|
9
|
+
PROVIDER_NOT_READY: ErrorCode.PROVIDER_NOT_READY
|
|
10
|
+
};
|
|
11
|
+
var DOWNLOAD_ERRORS = /* @__PURE__ */ new Set([
|
|
12
|
+
"network",
|
|
13
|
+
"http_status",
|
|
14
|
+
"too_large",
|
|
15
|
+
"PARSE_ERROR",
|
|
16
|
+
"UNSUPPORTED_SCHEMA",
|
|
17
|
+
"key_invalid",
|
|
18
|
+
"rate_limited"
|
|
19
|
+
]);
|
|
20
|
+
var OBJECT_DEFAULT = Object.freeze({});
|
|
21
|
+
var ProductCraftFlagsProvider = class {
|
|
22
|
+
metadata = { name: "productcraft-flags" };
|
|
23
|
+
runsOn = "server";
|
|
24
|
+
events = new OpenFeatureEventEmitter();
|
|
25
|
+
/** The `FlagsClient` underneath: for `snapshot()`, `forceRefresh()`, `getAllValues()` and its own events. */
|
|
26
|
+
client;
|
|
27
|
+
#log;
|
|
28
|
+
#unsubscribe;
|
|
29
|
+
/** The status this provider last reported; events fire on changes only. */
|
|
30
|
+
#status = "initializing";
|
|
31
|
+
#settings;
|
|
32
|
+
constructor(options) {
|
|
33
|
+
const own = !("client" in options && options.client);
|
|
34
|
+
this.client = own ? new FlagsClient(options) : options.client;
|
|
35
|
+
const logger = options.logger;
|
|
36
|
+
this.#log = logger === null ? null : logger ?? console;
|
|
37
|
+
this.#settings = this.#currentSettings();
|
|
38
|
+
this.#unsubscribe = [
|
|
39
|
+
this.client.on("configChanged", () => this.#configChanged()),
|
|
40
|
+
this.client.on("error", (e) => this.#clientError(e))
|
|
41
|
+
];
|
|
42
|
+
}
|
|
43
|
+
/** Waits for the first download (at most `maxInitWaitSeconds`). Rejects when no config is available at all. */
|
|
44
|
+
async initialize() {
|
|
45
|
+
const state = await this.client.waitForReady();
|
|
46
|
+
if (this.client.snapshot().toJSON() === null) {
|
|
47
|
+
this.#status = "error";
|
|
48
|
+
throw new Error(
|
|
49
|
+
`[productcraft/flags] no config available (client state: ${state})`
|
|
50
|
+
);
|
|
51
|
+
}
|
|
52
|
+
this.#status = "ready";
|
|
53
|
+
}
|
|
54
|
+
/** Closes the client: stops polling and timers. */
|
|
55
|
+
async onClose() {
|
|
56
|
+
for (const off of this.#unsubscribe) off();
|
|
57
|
+
this.client.close();
|
|
58
|
+
}
|
|
59
|
+
resolveBooleanEvaluation(flagKey, defaultValue, context, logger) {
|
|
60
|
+
return this.#resolve(flagKey, defaultValue, context, logger);
|
|
61
|
+
}
|
|
62
|
+
resolveStringEvaluation(flagKey, defaultValue, context, logger) {
|
|
63
|
+
return this.#resolve(flagKey, defaultValue, context, logger);
|
|
64
|
+
}
|
|
65
|
+
resolveNumberEvaluation(flagKey, defaultValue, context, logger) {
|
|
66
|
+
return this.#resolve(flagKey, defaultValue, context, logger);
|
|
67
|
+
}
|
|
68
|
+
/** Json settings, parsed. Any other setting type is TYPE_MISMATCH. */
|
|
69
|
+
async resolveObjectEvaluation(flagKey, defaultValue, context, logger) {
|
|
70
|
+
const r = await this.#resolve(
|
|
71
|
+
flagKey,
|
|
72
|
+
OBJECT_DEFAULT,
|
|
73
|
+
context,
|
|
74
|
+
logger
|
|
75
|
+
);
|
|
76
|
+
return {
|
|
77
|
+
...r,
|
|
78
|
+
value: r.value === OBJECT_DEFAULT ? defaultValue : r.value
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
async #resolve(flagKey, defaultValue, context, logger) {
|
|
82
|
+
const d = await this.client.getValueDetails(
|
|
83
|
+
flagKey,
|
|
84
|
+
defaultValue,
|
|
85
|
+
toUser(context, logger)
|
|
86
|
+
);
|
|
87
|
+
this.#recovered();
|
|
88
|
+
return toResolution(d);
|
|
89
|
+
}
|
|
90
|
+
#configChanged() {
|
|
91
|
+
const before = this.#settings;
|
|
92
|
+
const after = this.#settings = this.#currentSettings();
|
|
93
|
+
this.#recovered();
|
|
94
|
+
if (this.#status === "initializing") return;
|
|
95
|
+
this.events.emit(ProviderEvents.ConfigurationChanged, {
|
|
96
|
+
flagsChanged: changedKeys(before, after),
|
|
97
|
+
metadata: { revision: this.client.snapshot().revision }
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
#clientError(e) {
|
|
101
|
+
if (!DOWNLOAD_ERRORS.has(e.code ?? "")) return;
|
|
102
|
+
try {
|
|
103
|
+
this.#log?.warn(`[productcraft/flags] ${e.message}`);
|
|
104
|
+
} catch {
|
|
105
|
+
}
|
|
106
|
+
if (this.#status === "initializing") return;
|
|
107
|
+
const next = e.code === "key_invalid" || this.client.snapshot().toJSON() === null ? "error" : "stale";
|
|
108
|
+
if (next === this.#status) return;
|
|
109
|
+
this.#status = next;
|
|
110
|
+
if (next === "error")
|
|
111
|
+
this.events.emit(ProviderEvents.Error, {
|
|
112
|
+
message: e.message,
|
|
113
|
+
errorCode: ErrorCode.GENERAL
|
|
114
|
+
});
|
|
115
|
+
else this.events.emit(ProviderEvents.Stale, { message: e.message });
|
|
116
|
+
}
|
|
117
|
+
/** After STALE or ERROR, the first successful download (or new config) reports READY again. */
|
|
118
|
+
#recovered() {
|
|
119
|
+
if ((this.#status === "stale" || this.#status === "error") && this.client.state === "ready" && this.client.snapshot().toJSON() !== null) {
|
|
120
|
+
this.#status = "ready";
|
|
121
|
+
this.events.emit(ProviderEvents.Ready);
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
#currentSettings() {
|
|
125
|
+
const raw = this.client.snapshot().toJSON();
|
|
126
|
+
return raw ? {
|
|
127
|
+
settings: raw.settings,
|
|
128
|
+
segments: raw.segments,
|
|
129
|
+
salt: raw.salt
|
|
130
|
+
} : null;
|
|
131
|
+
}
|
|
132
|
+
};
|
|
133
|
+
function changedKeys(before, after) {
|
|
134
|
+
const b = before?.settings ?? {};
|
|
135
|
+
const a = after?.settings ?? {};
|
|
136
|
+
const all = [.../* @__PURE__ */ new Set([...Object.keys(b), ...Object.keys(a)])];
|
|
137
|
+
const shared = JSON.stringify(before?.segments ?? null) === JSON.stringify(after?.segments ?? null) && before?.salt === after?.salt;
|
|
138
|
+
return shared ? all.filter((k) => JSON.stringify(b[k]) !== JSON.stringify(a[k])) : all;
|
|
139
|
+
}
|
|
140
|
+
function toUser(context, logger) {
|
|
141
|
+
const custom = /* @__PURE__ */ Object.create(null);
|
|
142
|
+
const user = { custom };
|
|
143
|
+
let any = false;
|
|
144
|
+
for (const key of Object.keys(context)) {
|
|
145
|
+
if (key === "targetingKey") continue;
|
|
146
|
+
const value = attribute(context[key]);
|
|
147
|
+
if (value === void 0) {
|
|
148
|
+
if (context[key] !== null && context[key] !== void 0)
|
|
149
|
+
logger?.debug(
|
|
150
|
+
`[productcraft/flags] context attribute ${JSON.stringify(key)} dropped: not a string, number, boolean, Date or string[]`
|
|
151
|
+
);
|
|
152
|
+
continue;
|
|
153
|
+
}
|
|
154
|
+
any = true;
|
|
155
|
+
if (key === "identifier" || key === "email" || key === "country")
|
|
156
|
+
user[key] = value;
|
|
157
|
+
else custom[key] = value;
|
|
158
|
+
}
|
|
159
|
+
if (typeof context.targetingKey === "string" && context.targetingKey !== "") {
|
|
160
|
+
user.identifier = context.targetingKey;
|
|
161
|
+
any = true;
|
|
162
|
+
}
|
|
163
|
+
return any ? user : void 0;
|
|
164
|
+
}
|
|
165
|
+
function attribute(v) {
|
|
166
|
+
if (typeof v === "string" || typeof v === "number" || typeof v === "boolean" || v instanceof Date)
|
|
167
|
+
return v;
|
|
168
|
+
if (Array.isArray(v) && v.every((x) => typeof x === "string"))
|
|
169
|
+
return v;
|
|
170
|
+
return void 0;
|
|
171
|
+
}
|
|
172
|
+
function toResolution(d) {
|
|
173
|
+
const flagMetadata = { revision: d.revision };
|
|
174
|
+
if (d.ruleIndex !== null) flagMetadata.rule_index = d.ruleIndex;
|
|
175
|
+
if (d.percentageIndex !== null)
|
|
176
|
+
flagMetadata.percentage_index = d.percentageIndex;
|
|
177
|
+
const out = {
|
|
178
|
+
value: d.value,
|
|
179
|
+
reason: d.reason,
|
|
180
|
+
flagMetadata
|
|
181
|
+
};
|
|
182
|
+
if (d.variant !== null) out.variant = d.variant;
|
|
183
|
+
if (d.reason === "ERROR" || d.errorCode !== null) {
|
|
184
|
+
out.reason = "ERROR";
|
|
185
|
+
out.errorCode = ERROR_CODES[d.errorCode ?? ""] ?? ErrorCode.GENERAL;
|
|
186
|
+
if (d.errorMessage) out.errorMessage = d.errorMessage;
|
|
187
|
+
}
|
|
188
|
+
return out;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
export { ProductCraftFlagsProvider, toResolution, toUser };
|
|
192
|
+
//# sourceMappingURL=index.js.map
|
|
193
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/provider.ts"],"names":[],"mappings":";;;;AA2CA,IAAM,WAAA,GAAyC;AAAA,EAC7C,gBAAgB,SAAA,CAAU,cAAA;AAAA,EAC1B,eAAe,SAAA,CAAU,aAAA;AAAA,EACzB,aAAa,SAAA,CAAU,WAAA;AAAA,EACvB,oBAAoB,SAAA,CAAU;AAChC,CAAA;AAGA,IAAM,eAAA,uBAAsB,GAAA,CAAI;AAAA,EAC9B,SAAA;AAAA,EACA,aAAA;AAAA,EACA,WAAA;AAAA,EACA,aAAA;AAAA,EACA,oBAAA;AAAA,EACA,aAAA;AAAA,EACA;AACF,CAAC,CAAA;AAGD,IAAM,cAAA,GAAgC,MAAA,CAAO,MAAA,CAAO,EAAE,CAAA;AAe/C,IAAM,4BAAN,MAAoD;AAAA,EAChD,QAAA,GAA6B,EAAE,IAAA,EAAM,oBAAA,EAAqB;AAAA,EAC1D,MAAA,GAAS,QAAA;AAAA,EACT,MAAA,GAAS,IAAI,uBAAA,EAAwB;AAAA;AAAA,EAErC,MAAA;AAAA,EACA,IAAA;AAAA,EACA,YAAA;AAAA;AAAA,EAET,OAAA,GAAwD,cAAA;AAAA,EACxD,SAAA;AAAA,EAEA,YAAY,OAAA,EAA2C;AAErD,IAAA,MAAM,GAAA,GAAM,EAAE,QAAA,IAAY,OAAA,IAAW,OAAA,CAAQ,MAAA,CAAA;AAC7C,IAAA,IAAA,CAAK,SAAS,GAAA,GACV,IAAI,WAAA,CAAY,OAA6B,IAC5C,OAAA,CAAoC,MAAA;AACzC,IAAA,MAAM,SAAU,OAAA,CAA+C,MAAA;AAC/D,IAAA,IAAA,CAAK,IAAA,GAAO,MAAA,KAAW,IAAA,GAAO,IAAA,GAAQ,MAAA,IAAU,OAAA;AAChD,IAAA,IAAA,CAAK,SAAA,GAAY,KAAK,gBAAA,EAAiB;AACvC,IAAA,IAAA,CAAK,YAAA,GAAe;AAAA,MAClB,KAAK,MAAA,CAAO,EAAA,CAAG,iBAAiB,MAAM,IAAA,CAAK,gBAAgB,CAAA;AAAA,MAC3D,IAAA,CAAK,OAAO,EAAA,CAAG,OAAA,EAAS,CAAC,CAAA,KAAM,IAAA,CAAK,YAAA,CAAa,CAAC,CAAC;AAAA,KACrD;AAAA,EACF;AAAA;AAAA,EAGA,MAAM,UAAA,GAA4B;AAChC,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,MAAA,CAAO,YAAA,EAAa;AAC7C,IAAA,IAAI,KAAK,MAAA,CAAO,QAAA,EAAS,CAAE,MAAA,OAAa,IAAA,EAAM;AAC5C,MAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,2DAA2D,KAAK,CAAA,CAAA;AAAA,OAClE;AAAA,IACF;AACA,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AAAA,EACjB;AAAA;AAAA,EAGA,MAAM,OAAA,GAAyB;AAC7B,IAAA,KAAA,MAAW,GAAA,IAAO,IAAA,CAAK,YAAA,EAAc,GAAA,EAAI;AACzC,IAAA,IAAA,CAAK,OAAO,KAAA,EAAM;AAAA,EACpB;AAAA,EAEA,wBAAA,CACE,OAAA,EACA,YAAA,EACA,OAAA,EACA,MAAA,EACqC;AACrC,IAAA,OAAO,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,YAAA,EAAc,SAAS,MAAM,CAAA;AAAA,EAC7D;AAAA,EAEA,uBAAA,CACE,OAAA,EACA,YAAA,EACA,OAAA,EACA,MAAA,EACoC;AACpC,IAAA,OAAO,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,YAAA,EAAc,SAAS,MAAM,CAAA;AAAA,EAC7D;AAAA,EAEA,uBAAA,CACE,OAAA,EACA,YAAA,EACA,OAAA,EACA,MAAA,EACoC;AACpC,IAAA,OAAO,IAAA,CAAK,QAAA,CAAS,OAAA,EAAS,YAAA,EAAc,SAAS,MAAM,CAAA;AAAA,EAC7D;AAAA;AAAA,EAGA,MAAM,uBAAA,CACJ,OAAA,EACA,YAAA,EACA,SACA,MAAA,EAC+B;AAC/B,IAAA,MAAM,CAAA,GAAI,MAAM,IAAA,CAAK,QAAA;AAAA,MACnB,OAAA;AAAA,MACA,cAAA;AAAA,MACA,OAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,OAAO;AAAA,MACL,GAAG,CAAA;AAAA,MACH,KAAA,EAAQ,CAAA,CAAE,KAAA,KAAU,cAAA,GAAiB,eAAe,CAAA,CAAE;AAAA,KACxD;AAAA,EACF;AAAA,EAEA,MAAM,QAAA,CACJ,OAAA,EACA,YAAA,EACA,SACA,MAAA,EAC+B;AAC/B,IAAA,MAAM,CAAA,GAAK,MAAM,IAAA,CAAK,MAAA,CAAO,eAAA;AAAA,MAC3B,OAAA;AAAA,MACA,YAAA;AAAA,MACA,MAAA,CAAO,SAAS,MAAM;AAAA,KACxB;AACA,IAAA,IAAA,CAAK,UAAA,EAAW;AAChB,IAAA,OAAO,aAAa,CAAC,CAAA;AAAA,EACvB;AAAA,EAEA,cAAA,GAAuB;AACrB,IAAA,MAAM,SAAS,IAAA,CAAK,SAAA;AACpB,IAAA,MAAM,KAAA,GAAS,IAAA,CAAK,SAAA,GAAY,IAAA,CAAK,gBAAA,EAAiB;AACtD,IAAA,IAAA,CAAK,UAAA,EAAW;AAChB,IAAA,IAAI,IAAA,CAAK,YAAY,cAAA,EAAgB;AACrC,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,cAAA,CAAe,oBAAA,EAAsB;AAAA,MACpD,YAAA,EAAc,WAAA,CAAY,MAAA,EAAQ,KAAK,CAAA;AAAA,MACvC,UAAU,EAAE,QAAA,EAAU,KAAK,MAAA,CAAO,QAAA,GAAW,QAAA;AAAS,KACvD,CAAA;AAAA,EACH;AAAA,EAEA,aAAa,CAAA,EAAoC;AAC/C,IAAA,IAAI,CAAC,eAAA,CAAgB,GAAA,CAAI,CAAA,CAAE,IAAA,IAAQ,EAAE,CAAA,EAAG;AACxC,IAAA,IAAI;AACF,MAAA,IAAA,CAAK,IAAA,EAAM,IAAA,CAAK,CAAA,qBAAA,EAAwB,CAAA,CAAE,OAAO,CAAA,CAAE,CAAA;AAAA,IACrD,CAAA,CAAA,MAAQ;AAAA,IAER;AACA,IAAA,IAAI,IAAA,CAAK,YAAY,cAAA,EAAgB;AACrC,IAAA,MAAM,IAAA,GACJ,CAAA,CAAE,IAAA,KAAS,aAAA,IAAiB,IAAA,CAAK,MAAA,CAAO,QAAA,EAAS,CAAE,MAAA,EAAO,KAAM,IAAA,GAC5D,OAAA,GACA,OAAA;AACN,IAAA,IAAI,IAAA,KAAS,KAAK,OAAA,EAAS;AAC3B,IAAA,IAAA,CAAK,OAAA,GAAU,IAAA;AACf,IAAA,IAAI,IAAA,KAAS,OAAA;AACX,MAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,cAAA,CAAe,KAAA,EAAO;AAAA,QACrC,SAAS,CAAA,CAAE,OAAA;AAAA,QACX,WAAW,SAAA,CAAU;AAAA,OACtB,CAAA;AAAA,SACE,IAAA,CAAK,OAAO,IAAA,CAAK,cAAA,CAAe,OAAO,EAAE,OAAA,EAAS,CAAA,CAAE,OAAA,EAAS,CAAA;AAAA,EACpE;AAAA;AAAA,EAGA,UAAA,GAAmB;AACjB,IAAA,IAAA,CACG,KAAK,OAAA,KAAY,OAAA,IAAW,IAAA,CAAK,OAAA,KAAY,YAC9C,IAAA,CAAK,MAAA,CAAO,KAAA,KAAU,OAAA,IACtB,KAAK,MAAA,CAAO,QAAA,EAAS,CAAE,MAAA,OAAa,IAAA,EACpC;AACA,MAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AACf,MAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,cAAA,CAAe,KAAK,CAAA;AAAA,IACvC;AAAA,EACF;AAAA,EAEA,gBAAA,GAA+B;AAC7B,IAAA,MAAM,GAAA,GAAM,IAAA,CAAK,MAAA,CAAO,QAAA,GAAW,MAAA,EAAO;AAC1C,IAAA,OAAO,GAAA,GACF;AAAA,MACC,UAAU,GAAA,CAAI,QAAA;AAAA,MACd,UAAU,GAAA,CAAI,QAAA;AAAA,MACd,MAAM,GAAA,CAAI;AAAA,KACZ,GACA,IAAA;AAAA,EACN;AACF;AAGA,SAAS,WAAA,CAAY,QAAoB,KAAA,EAA6B;AACpE,EAAA,MAAM,CAAA,GAAK,MAAA,EAAQ,QAAA,IAAY,EAAC;AAChC,EAAA,MAAM,CAAA,GAAK,KAAA,EAAO,QAAA,IAAY,EAAC;AAC/B,EAAA,MAAM,MAAM,CAAC,mBAAG,IAAI,GAAA,CAAI,CAAC,GAAG,MAAA,CAAO,IAAA,CAAK,CAAC,GAAG,GAAG,MAAA,CAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAC/D,EAAA,MAAM,MAAA,GACJ,IAAA,CAAK,SAAA,CAAU,MAAA,EAAQ,YAAY,IAAI,CAAA,KACrC,IAAA,CAAK,SAAA,CAAU,OAAO,QAAA,IAAY,IAAI,CAAA,IAAK,MAAA,EAAQ,SAAS,KAAA,EAAO,IAAA;AACvE,EAAA,OAAO,SACH,GAAA,CAAI,MAAA,CAAO,CAAC,CAAA,KAAM,KAAK,SAAA,CAAU,CAAA,CAAE,CAAC,CAAC,MAAM,IAAA,CAAK,SAAA,CAAU,EAAE,CAAC,CAAC,CAAC,CAAA,GAC/D,GAAA;AACN;AAGO,SAAS,MAAA,CACd,SACA,MAAA,EACkB;AAClB,EAAA,MAAM,MAAA,mBAAS,MAAA,CAAO,MAAA,CAAO,IAAI,CAAA;AACjC,EAAA,MAAM,IAAA,GAAa,EAAE,MAAA,EAAO;AAC5B,EAAA,IAAI,GAAA,GAAM,KAAA;AACV,EAAA,KAAA,MAAW,GAAA,IAAO,MAAA,CAAO,IAAA,CAAK,OAAO,CAAA,EAAG;AACtC,IAAA,IAAI,QAAQ,cAAA,EAAgB;AAC5B,IAAA,MAAM,KAAA,GAAQ,SAAA,CAAU,OAAA,CAAQ,GAAG,CAAC,CAAA;AACpC,IAAA,IAAI,UAAU,MAAA,EAAW;AACvB,MAAA,IAAI,QAAQ,GAAG,CAAA,KAAM,IAAA,IAAQ,OAAA,CAAQ,GAAG,CAAA,KAAM,MAAA;AAC5C,QAAA,MAAA,EAAQ,KAAA;AAAA,UACN,CAAA,uCAAA,EAA0C,IAAA,CAAK,SAAA,CAAU,GAAG,CAAC,CAAA,yDAAA;AAAA,SAC/D;AACF,MAAA;AAAA,IACF;AACA,IAAA,GAAA,GAAM,IAAA;AAEN,IAAA,IAAI,GAAA,KAAQ,YAAA,IAAgB,GAAA,KAAQ,OAAA,IAAW,GAAA,KAAQ,SAAA;AACrD,MAAC,IAAA,CAAa,GAAG,CAAA,GAAI,KAAA;AAAA,SAClB,MAAA,CAAO,GAAG,CAAA,GAAI,KAAA;AAAA,EACrB;AACA,EAAA,IAAI,OAAO,OAAA,CAAQ,YAAA,KAAiB,QAAA,IAAY,OAAA,CAAQ,iBAAiB,EAAA,EAAI;AAC3E,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,YAAA;AAC1B,IAAA,GAAA,GAAM,IAAA;AAAA,EACR;AAEA,EAAA,OAAO,MAAM,IAAA,GAAO,MAAA;AACtB;AAEA,SAAS,UACP,CAAA,EACgC;AAChC,EAAA,IACE,OAAO,MAAM,QAAA,IACb,OAAO,MAAM,QAAA,IACb,OAAO,CAAA,KAAM,SAAA,IACb,CAAA,YAAa,IAAA;AAEb,IAAA,OAAO,CAAA;AACT,EAAA,IAAI,KAAA,CAAM,OAAA,CAAQ,CAAC,CAAA,IAAK,CAAA,CAAE,MAAM,CAAC,CAAA,KAAM,OAAO,CAAA,KAAM,QAAQ,CAAA;AAC1D,IAAA,OAAO,CAAA;AACT,EAAA,OAAO,MAAA;AACT;AAGO,SAAS,aAAgB,CAAA,EAA+C;AAC7E,EAAA,MAAM,YAAA,GAA6B,EAAE,QAAA,EAAU,CAAA,CAAE,QAAA,EAAS;AAC1D,EAAA,IAAI,CAAA,CAAE,SAAA,KAAc,IAAA,EAAM,YAAA,CAAa,aAAa,CAAA,CAAE,SAAA;AACtD,EAAA,IAAI,EAAE,eAAA,KAAoB,IAAA;AACxB,IAAA,YAAA,CAAa,mBAAmB,CAAA,CAAE,eAAA;AACpC,EAAA,MAAM,GAAA,GAA4B;AAAA,IAChC,OAAO,CAAA,CAAE,KAAA;AAAA,IACT,QAAQ,CAAA,CAAE,MAAA;AAAA,IACV;AAAA,GACF;AACA,EAAA,IAAI,CAAA,CAAE,OAAA,KAAY,IAAA,EAAM,GAAA,CAAI,UAAU,CAAA,CAAE,OAAA;AACxC,EAAA,IAAI,CAAA,CAAE,MAAA,KAAW,OAAA,IAAW,CAAA,CAAE,cAAc,IAAA,EAAM;AAChD,IAAA,GAAA,CAAI,MAAA,GAAS,OAAA;AACb,IAAA,GAAA,CAAI,YAAY,WAAA,CAAY,CAAA,CAAE,SAAA,IAAa,EAAE,KAAK,SAAA,CAAU,OAAA;AAC5D,IAAA,IAAI,CAAA,CAAE,YAAA,EAAc,GAAA,CAAI,YAAA,GAAe,CAAA,CAAE,YAAA;AAAA,EAC3C;AACA,EAAA,OAAO,GAAA;AACT","file":"index.js","sourcesContent":["/**\n * ProductCraftFlagsProvider: an OpenFeature server provider over `FlagsClient` (design 8.3).\n *\n * Evaluation stays local: the provider maps the OpenFeature evaluation context to a Flags user and asks\n * `FlagsClient`, which evaluates the downloaded config in this process. Reasons, variants and error codes\n * map onto OpenFeature's; `PREREQUISITE_*` errors become `GENERAL`.\n */\nimport {\n ErrorCode,\n OpenFeatureEventEmitter,\n ProviderEvents,\n type EvaluationContext,\n type EvaluationContextValue,\n type FlagMetadata,\n type JsonValue,\n type Logger as OpenFeatureLogger,\n type Provider,\n type ProviderMetadata,\n type ResolutionDetails,\n type ResolutionReason,\n} from \"@openfeature/server-sdk\";\nimport {\n FlagsClient,\n type EvaluationDetails,\n type FlagsClientOptions,\n type User,\n type UserAttributeValue,\n} from \"@productcraft/flags\";\n\n/** Where the provider logs download failures it reports as events. `console` by default; `null` logs nothing. */\nexport interface ProviderLogger {\n warn(...args: unknown[]): void;\n}\n\nexport type ProductCraftFlagsProviderOptions =\n /** Use your own client (it is closed when the provider closes). */\n | { client: FlagsClient; logger?: ProviderLogger | null }\n /** Or let the provider create one from `FlagsClient` options. */\n | FlagsClientOptions;\n\ntype Obj = Record<string, unknown>;\n\n/** Engine and client error codes to OpenFeature's; anything else (`PREREQUISITE_*`) is GENERAL. */\nconst ERROR_CODES: Record<string, ErrorCode> = {\n FLAG_NOT_FOUND: ErrorCode.FLAG_NOT_FOUND,\n TYPE_MISMATCH: ErrorCode.TYPE_MISMATCH,\n PARSE_ERROR: ErrorCode.PARSE_ERROR,\n PROVIDER_NOT_READY: ErrorCode.PROVIDER_NOT_READY,\n};\n\n/** Download failures; the rest (`evaluation`, `listener`, `cache`, `overrides`) change no provider status. */\nconst DOWNLOAD_ERRORS = new Set([\n \"network\",\n \"http_status\",\n \"too_large\",\n \"PARSE_ERROR\",\n \"UNSUPPORTED_SCHEMA\",\n \"key_invalid\",\n \"rate_limited\",\n]);\n\n/** Stands in for an object default, so FlagsClient parses json settings and reports any other type as TYPE_MISMATCH. */\nconst OBJECT_DEFAULT: Readonly<Obj> = Object.freeze({});\n\n/**\n * ProductCraft Flags as an OpenFeature provider.\n *\n * @example\n * ```ts\n * import { OpenFeature } from \"@openfeature/server-sdk\";\n * import { ProductCraftFlagsProvider } from \"@productcraft/flags-openfeature\";\n *\n * await OpenFeature.setProviderAndWait(new ProductCraftFlagsProvider({ sdkKey: process.env.PRODUCTCRAFT_FLAGS_SDK_KEY }));\n * const client = OpenFeature.getClient();\n * const on = await client.getBooleanValue(\"new_checkout\", false, { targetingKey: user.id, plan: \"pro\" });\n * ```\n */\nexport class ProductCraftFlagsProvider implements Provider {\n readonly metadata: ProviderMetadata = { name: \"productcraft-flags\" };\n readonly runsOn = \"server\" as const;\n readonly events = new OpenFeatureEventEmitter();\n /** The `FlagsClient` underneath: for `snapshot()`, `forceRefresh()`, `getAllValues()` and its own events. */\n readonly client: FlagsClient;\n readonly #log: ProviderLogger | null;\n readonly #unsubscribe: Array<() => void>;\n /** The status this provider last reported; events fire on changes only. */\n #status: \"initializing\" | \"ready\" | \"stale\" | \"error\" = \"initializing\";\n #settings: Obj | null;\n\n constructor(options: ProductCraftFlagsProviderOptions) {\n // Duck-typed: an ESM FlagsClient and a CJS one are different classes.\n const own = !(\"client\" in options && options.client);\n this.client = own\n ? new FlagsClient(options as FlagsClientOptions)\n : (options as { client: FlagsClient }).client;\n const logger = (options as { logger?: ProviderLogger | null }).logger;\n this.#log = logger === null ? null : (logger ?? console);\n this.#settings = this.#currentSettings();\n this.#unsubscribe = [\n this.client.on(\"configChanged\", () => this.#configChanged()),\n this.client.on(\"error\", (e) => this.#clientError(e)),\n ];\n }\n\n /** Waits for the first download (at most `maxInitWaitSeconds`). Rejects when no config is available at all. */\n async initialize(): Promise<void> {\n const state = await this.client.waitForReady();\n if (this.client.snapshot().toJSON() === null) {\n this.#status = \"error\";\n throw new Error(\n `[productcraft/flags] no config available (client state: ${state})`,\n );\n }\n this.#status = \"ready\";\n }\n\n /** Closes the client: stops polling and timers. */\n async onClose(): Promise<void> {\n for (const off of this.#unsubscribe) off();\n this.client.close();\n }\n\n resolveBooleanEvaluation(\n flagKey: string,\n defaultValue: boolean,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<boolean>> {\n return this.#resolve(flagKey, defaultValue, context, logger);\n }\n\n resolveStringEvaluation(\n flagKey: string,\n defaultValue: string,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<string>> {\n return this.#resolve(flagKey, defaultValue, context, logger);\n }\n\n resolveNumberEvaluation(\n flagKey: string,\n defaultValue: number,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<number>> {\n return this.#resolve(flagKey, defaultValue, context, logger);\n }\n\n /** Json settings, parsed. Any other setting type is TYPE_MISMATCH. */\n async resolveObjectEvaluation<T extends JsonValue>(\n flagKey: string,\n defaultValue: T,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<T>> {\n const r = await this.#resolve<unknown>(\n flagKey,\n OBJECT_DEFAULT,\n context,\n logger,\n );\n return {\n ...r,\n value: (r.value === OBJECT_DEFAULT ? defaultValue : r.value) as T,\n };\n }\n\n async #resolve<T>(\n flagKey: string,\n defaultValue: T,\n context: EvaluationContext,\n logger: OpenFeatureLogger,\n ): Promise<ResolutionDetails<T>> {\n const d = (await this.client.getValueDetails(\n flagKey,\n defaultValue as never,\n toUser(context, logger),\n )) as EvaluationDetails<T>;\n this.#recovered();\n return toResolution(d);\n }\n\n #configChanged(): void {\n const before = this.#settings;\n const after = (this.#settings = this.#currentSettings());\n this.#recovered();\n if (this.#status === \"initializing\") return;\n this.events.emit(ProviderEvents.ConfigurationChanged, {\n flagsChanged: changedKeys(before, after),\n metadata: { revision: this.client.snapshot().revision },\n });\n }\n\n #clientError(e: Error & { code?: string }): void {\n if (!DOWNLOAD_ERRORS.has(e.code ?? \"\")) return;\n try {\n this.#log?.warn(`[productcraft/flags] ${e.message}`);\n } catch {\n /* a broken logger never breaks the provider */\n }\n if (this.#status === \"initializing\") return;\n const next =\n e.code === \"key_invalid\" || this.client.snapshot().toJSON() === null\n ? \"error\"\n : \"stale\";\n if (next === this.#status) return;\n this.#status = next;\n if (next === \"error\")\n this.events.emit(ProviderEvents.Error, {\n message: e.message,\n errorCode: ErrorCode.GENERAL,\n });\n else this.events.emit(ProviderEvents.Stale, { message: e.message });\n }\n\n /** After STALE or ERROR, the first successful download (or new config) reports READY again. */\n #recovered(): void {\n if (\n (this.#status === \"stale\" || this.#status === \"error\") &&\n this.client.state === \"ready\" &&\n this.client.snapshot().toJSON() !== null\n ) {\n this.#status = \"ready\";\n this.events.emit(ProviderEvents.Ready);\n }\n }\n\n #currentSettings(): Obj | null {\n const raw = this.client.snapshot().toJSON() as Obj | null;\n return raw\n ? ({\n settings: raw.settings,\n segments: raw.segments,\n salt: raw.salt,\n } as Obj)\n : null;\n }\n}\n\n/** Keys whose setting changed; every key when segments or the salt changed (any rule may depend on them). */\nfunction changedKeys(before: Obj | null, after: Obj | null): string[] {\n const b = (before?.settings ?? {}) as Obj;\n const a = (after?.settings ?? {}) as Obj;\n const all = [...new Set([...Object.keys(b), ...Object.keys(a)])];\n const shared =\n JSON.stringify(before?.segments ?? null) ===\n JSON.stringify(after?.segments ?? null) && before?.salt === after?.salt;\n return shared\n ? all.filter((k) => JSON.stringify(b[k]) !== JSON.stringify(a[k]))\n : all;\n}\n\n/** OpenFeature's context to a Flags user: `targetingKey` is the identifier; primitives, Dates and string arrays are attributes. */\nexport function toUser(\n context: EvaluationContext,\n logger?: OpenFeatureLogger,\n): User | undefined {\n const custom = Object.create(null) as Record<string, UserAttributeValue>;\n const user: User = { custom };\n let any = false;\n for (const key of Object.keys(context)) {\n if (key === \"targetingKey\") continue;\n const value = attribute(context[key]);\n if (value === undefined) {\n if (context[key] !== null && context[key] !== undefined)\n logger?.debug(\n `[productcraft/flags] context attribute ${JSON.stringify(key)} dropped: not a string, number, boolean, Date or string[]`,\n );\n continue;\n }\n any = true;\n // The engine reads these three from the top level (and coerces a number identifier to text).\n if (key === \"identifier\" || key === \"email\" || key === \"country\")\n (user as Obj)[key] = value;\n else custom[key] = value;\n }\n if (typeof context.targetingKey === \"string\" && context.targetingKey !== \"\") {\n user.identifier = context.targetingKey;\n any = true;\n }\n // An empty context leaves the client's default user in place.\n return any ? user : undefined;\n}\n\nfunction attribute(\n v: EvaluationContextValue | undefined,\n): UserAttributeValue | undefined {\n if (\n typeof v === \"string\" ||\n typeof v === \"number\" ||\n typeof v === \"boolean\" ||\n v instanceof Date\n )\n return v;\n if (Array.isArray(v) && v.every((x) => typeof x === \"string\"))\n return v as string[];\n return undefined;\n}\n\n/** FlagsClient's evaluation details to OpenFeature's resolution. */\nexport function toResolution<T>(d: EvaluationDetails<T>): ResolutionDetails<T> {\n const flagMetadata: FlagMetadata = { revision: d.revision };\n if (d.ruleIndex !== null) flagMetadata.rule_index = d.ruleIndex;\n if (d.percentageIndex !== null)\n flagMetadata.percentage_index = d.percentageIndex;\n const out: ResolutionDetails<T> = {\n value: d.value,\n reason: d.reason as ResolutionReason,\n flagMetadata,\n };\n if (d.variant !== null) out.variant = d.variant;\n if (d.reason === \"ERROR\" || d.errorCode !== null) {\n out.reason = \"ERROR\";\n out.errorCode = ERROR_CODES[d.errorCode ?? \"\"] ?? ErrorCode.GENERAL;\n if (d.errorMessage) out.errorMessage = d.errorMessage;\n }\n return out;\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,67 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@productcraft/flags-openfeature",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "OpenFeature server provider for ProductCraft Flags: plug FlagsClient (local evaluation, user attributes never leave your app) into @openfeature/server-sdk.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.cjs",
|
|
7
|
+
"module": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"import": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
},
|
|
15
|
+
"require": {
|
|
16
|
+
"types": "./dist/index.d.cts",
|
|
17
|
+
"default": "./dist/index.cjs"
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
"files": [
|
|
22
|
+
"dist/**",
|
|
23
|
+
"README.md",
|
|
24
|
+
"LICENSE"
|
|
25
|
+
],
|
|
26
|
+
"sideEffects": false,
|
|
27
|
+
"engines": {
|
|
28
|
+
"node": ">=20.3"
|
|
29
|
+
},
|
|
30
|
+
"keywords": [
|
|
31
|
+
"productcraft",
|
|
32
|
+
"sdk",
|
|
33
|
+
"openfeature",
|
|
34
|
+
"openfeature-provider",
|
|
35
|
+
"feature-flags",
|
|
36
|
+
"feature-toggles"
|
|
37
|
+
],
|
|
38
|
+
"author": "ProductCraft",
|
|
39
|
+
"license": "MIT",
|
|
40
|
+
"repository": {
|
|
41
|
+
"type": "git",
|
|
42
|
+
"url": "git+https://github.com/clauderanelagh/productcraft-node.git",
|
|
43
|
+
"directory": "packages/flags-openfeature"
|
|
44
|
+
},
|
|
45
|
+
"homepage": "https://productcraft.co/docs/flags",
|
|
46
|
+
"bugs": {
|
|
47
|
+
"url": "https://github.com/clauderanelagh/productcraft-node/issues"
|
|
48
|
+
},
|
|
49
|
+
"publishConfig": {
|
|
50
|
+
"access": "public",
|
|
51
|
+
"provenance": true
|
|
52
|
+
},
|
|
53
|
+
"peerDependencies": {
|
|
54
|
+
"@openfeature/server-sdk": "^1.17.0",
|
|
55
|
+
"@productcraft/flags": "^0.1.0 || ^1.0.0"
|
|
56
|
+
},
|
|
57
|
+
"devDependencies": {
|
|
58
|
+
"@openfeature/core": "^1.12.0",
|
|
59
|
+
"@openfeature/server-sdk": "^1.23.0",
|
|
60
|
+
"@productcraft/flags": "0.1.0",
|
|
61
|
+
"@productcraft/flags-engine": "0.1.0"
|
|
62
|
+
},
|
|
63
|
+
"scripts": {
|
|
64
|
+
"build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsup",
|
|
65
|
+
"test": "tsc -p tests/tsconfig.json && vitest run"
|
|
66
|
+
}
|
|
6
67
|
}
|