@reflag/openfeature-node-provider 1.0.0-alpha.1

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 ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Bucket ApS
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 ADDED
@@ -0,0 +1,196 @@
1
+ # Reflag Node.js OpenFeature Provider
2
+
3
+ The official OpenFeature Node.js provider for [Reflag](https://reflag.com) feature management service.
4
+
5
+ ## Installation
6
+
7
+ ```shell
8
+ npm install @reflag/openfeature-node-provider
9
+ ```
10
+
11
+ ### Required peer dependencies
12
+
13
+ The OpenFeature SDK is required as peer dependency.
14
+ The minimum required version of `@openfeature/server-sdk` currently is `1.13.5`.
15
+ The minimum required version of `@reflag/node-sdk` currently is `2.0.0`.
16
+
17
+ ```shell
18
+ npm install @openfeature/server-sdk @reflag/node-sdk
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ The provider uses the [Reflag Node.js SDK](https://docs.reflag.com/quickstart/supported-languages-frameworks/node.js-sdk).
24
+ The available options can be found in the [Reflag Node.js SDK](https://github.com/reflagcom/javascript/tree/main/packages/node-sdk#initialization-options).
25
+
26
+ ### Example using the default configuration
27
+
28
+ ```typescript
29
+ import { ReflagNodeProvider } from "@reflag/openfeature-node-provider";
30
+ import { OpenFeature } from "@openfeature/server-sdk";
31
+
32
+ const provider = new ReflagNodeProvider({ secretKey });
33
+
34
+ await OpenFeature.setProviderAndWait(provider);
35
+
36
+ // set a value to the global context
37
+ OpenFeature.setContext({ region: "us-east-1" });
38
+
39
+ // set a value to the invocation context
40
+ // this is merged with the global context
41
+ const requestContext = {
42
+ targetingKey: req.user.id,
43
+ email: req.user.email,
44
+ companyPlan: req.locals.plan,
45
+ };
46
+
47
+ const client = OpenFeature.getClient();
48
+
49
+ const enterpriseFeatureEnabled = await client.getBooleanValue(
50
+ "enterpriseFlag",
51
+ false,
52
+ requestContext,
53
+ );
54
+ ```
55
+
56
+ ## Feature resolution methods
57
+
58
+ The Reflag OpenFeature Provider implements the OpenFeature evaluation interface for different value types. Each method handles the resolution of flags according to the OpenFeature specification.
59
+
60
+ ### Common behavior
61
+
62
+ All resolution methods share these behaviors:
63
+
64
+ - Return default value with `PROVIDER_NOT_READY` if client is not initialized,
65
+ - Return default value with `FLAG_NOT_FOUND` if flag doesn't exist,
66
+ - Return default value with `ERROR` if there was a type mismatch,
67
+ - Return evaluated value with `TARGETING_MATCH` on successful resolution.
68
+
69
+ ### Type-Specific Methods
70
+
71
+ #### Boolean Resolution
72
+
73
+ ```ts
74
+ client.getBooleanValue("my-flag", false);
75
+ ```
76
+
77
+ Returns the feature's enabled state. This is the most common use case for flags.
78
+
79
+ #### String Resolution
80
+
81
+ ```ts
82
+ client.getStringValue("my-flag", "default");
83
+ ```
84
+
85
+ Returns the feature's remote config key (also known as "variant"). Useful for multi-variate use cases.
86
+
87
+ #### Number Resolution
88
+
89
+ ```ts
90
+ client.getNumberValue("my-flag", 0);
91
+ ```
92
+
93
+ Not directly supported by Reflag. Use `getObjectValue` instead for numeric configurations.
94
+
95
+ #### Object Resolution
96
+
97
+ ```ts
98
+ // works for any type:
99
+ client.getObjectValue("my-flag", { defaultValue: true });
100
+ client.getObjectValue("my-flag", "string-value");
101
+ client.getObjectValue("my-flag", 199);
102
+ ```
103
+
104
+ Returns the feature's remote config payload with type validation. This is the most flexible method,
105
+ allowing for complex configuration objects or simple types.
106
+
107
+ The object resolution performs runtime type checking between the default value and the feature payload to ensure type safety.
108
+
109
+ ## Translating Evaluation Context
110
+
111
+ Reflag uses a context object of the following shape:
112
+
113
+ ```ts
114
+ /**
115
+ * Describes the current user context, company context, and other context.
116
+ * This is used to determine if feature targeting matches and to track events.
117
+ **/
118
+ export type ReflagContext = {
119
+ /**
120
+ * The user context. If the user is set, the user ID is required.
121
+ */
122
+ user?: {
123
+ id: string;
124
+ name?: string;
125
+ email?: string;
126
+ avatar?: string;
127
+ [k: string]: any;
128
+ };
129
+
130
+ /**
131
+ * The company context. If the company is set, the company ID is required.
132
+ */
133
+ company?: { id: string; name?: string; avatar?: string; [k: string]: any };
134
+
135
+ /**
136
+ * The other context. This is used for any additional context that is not related to user or company.
137
+ */
138
+ other?: Record<string, any>;
139
+ };
140
+ ```
141
+
142
+ To use the Reflag Node.js OpenFeature provider, you must convert your OpenFeature contexts to Reflag contexts.
143
+ You can achieve this by supplying a context translation function which takes the Open Feature context and returns
144
+ a corresponding Reflag Context:
145
+
146
+ ```ts
147
+ import { ReflagNodeProvider } from "@openfeature/reflag-node-provider";
148
+
149
+ const contextTranslator = (context: EvaluationContext): ReflagContext => {
150
+ return {
151
+ user: {
152
+ id: context.targetingKey ?? context["userId"]?.toString(),
153
+ name: context["name"]?.toString(),
154
+ email: context["email"]?.toString(),
155
+ avatar: context["avatar"]?.toString(),
156
+ country: context["country"]?.toString(),
157
+ },
158
+ company: {
159
+ id: context["companyId"]?.toString(),
160
+ name: context["companyName"]?.toString(),
161
+ avatar: context["companyAvatar"]?.toString(),
162
+ plan: context["companyPlan"]?.toString(),
163
+ },
164
+ };
165
+ };
166
+
167
+ const provider = new ReflagNodeProvider({ secretKey, contextTranslator });
168
+
169
+ OpenFeature.setProvider(provider);
170
+ ```
171
+
172
+ ## Tracking feature adoption
173
+
174
+ The Reflag OpenFeature provider supports the OpenFeature Tracking API.
175
+ It's straight forward to start sending tracking events through OpenFeature.
176
+
177
+ Simply call the "track" method on the OpenFeature client:
178
+
179
+ ```typescript
180
+ import { ReflagNodeProvider } from "@reflag/openfeature-node-provider";
181
+ import { OpenFeature } from "@openfeature/server-sdk";
182
+
183
+ const provider = new ReflagNodeProvider({ secretKey });
184
+
185
+ await OpenFeature.setProviderAndWait(provider);
186
+
187
+ const client = OpenFeature.getClient();
188
+
189
+ // `evaluationContext` is whatever you use to evaluate features based off
190
+ const enterpriseFlagEnabled = await client.track("huddles", evaluationContext);
191
+ ```
192
+
193
+ ## License
194
+
195
+ > MIT License
196
+ > Copyright (c) 2025 Bucket ApS
package/dist/index.js ADDED
@@ -0,0 +1,174 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __rest = (this && this.__rest) || function (s, e) {
12
+ var t = {};
13
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
14
+ t[p] = s[p];
15
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
16
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
17
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
18
+ t[p[i]] = s[p[i]];
19
+ }
20
+ return t;
21
+ };
22
+ Object.defineProperty(exports, "__esModule", { value: true });
23
+ exports.ReflagNodeProvider = exports.defaultContextTranslator = void 0;
24
+ const server_sdk_1 = require("@openfeature/server-sdk");
25
+ const node_sdk_1 = require("@reflag/node-sdk");
26
+ const defaultContextTranslator = (context) => {
27
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
28
+ const user = {
29
+ id: (_a = context.targetingKey) !== null && _a !== void 0 ? _a : (_b = context["userId"]) === null || _b === void 0 ? void 0 : _b.toString(),
30
+ name: (_c = context["name"]) === null || _c === void 0 ? void 0 : _c.toString(),
31
+ email: (_d = context["email"]) === null || _d === void 0 ? void 0 : _d.toString(),
32
+ avatar: (_e = context["avatar"]) === null || _e === void 0 ? void 0 : _e.toString(),
33
+ country: (_f = context["country"]) === null || _f === void 0 ? void 0 : _f.toString(),
34
+ };
35
+ const company = {
36
+ id: (_g = context["companyId"]) === null || _g === void 0 ? void 0 : _g.toString(),
37
+ name: (_h = context["companyName"]) === null || _h === void 0 ? void 0 : _h.toString(),
38
+ avatar: (_j = context["companyAvatar"]) === null || _j === void 0 ? void 0 : _j.toString(),
39
+ plan: (_k = context["companyPlan"]) === null || _k === void 0 ? void 0 : _k.toString(),
40
+ };
41
+ return {
42
+ user,
43
+ company,
44
+ };
45
+ };
46
+ exports.defaultContextTranslator = defaultContextTranslator;
47
+ class ReflagNodeProvider {
48
+ get client() {
49
+ return this._client;
50
+ }
51
+ constructor(_a) {
52
+ var { contextTranslator } = _a, opts = __rest(_a, ["contextTranslator"]);
53
+ this.events = new server_sdk_1.OpenFeatureEventEmitter();
54
+ this.runsOn = "server";
55
+ this.status = server_sdk_1.ServerProviderStatus.NOT_READY;
56
+ this.metadata = {
57
+ name: "reflag-node",
58
+ };
59
+ this._client = new node_sdk_1.ReflagClient(opts);
60
+ this.contextTranslator = contextTranslator !== null && contextTranslator !== void 0 ? contextTranslator : exports.defaultContextTranslator;
61
+ }
62
+ initialize() {
63
+ return __awaiter(this, void 0, void 0, function* () {
64
+ yield this._client.initialize();
65
+ this.status = server_sdk_1.ServerProviderStatus.READY;
66
+ });
67
+ }
68
+ resolveFlag(flagKey, defaultValue, context, resolveFn) {
69
+ var _a;
70
+ if (this.status !== server_sdk_1.ServerProviderStatus.READY) {
71
+ return Promise.resolve({
72
+ value: defaultValue,
73
+ reason: server_sdk_1.StandardResolutionReasons.ERROR,
74
+ errorCode: server_sdk_1.ErrorCode.PROVIDER_NOT_READY,
75
+ errorMessage: "Reflag client not initialized",
76
+ });
77
+ }
78
+ if (!((_a = context.user) === null || _a === void 0 ? void 0 : _a.id)) {
79
+ return Promise.resolve({
80
+ value: defaultValue,
81
+ reason: server_sdk_1.StandardResolutionReasons.ERROR,
82
+ errorCode: server_sdk_1.ErrorCode.INVALID_CONTEXT,
83
+ errorMessage: "At least a user ID is required",
84
+ });
85
+ }
86
+ const featureDefs = this._client.getFlagDefinitions();
87
+ if (featureDefs.some(({ key }) => key === flagKey)) {
88
+ return resolveFn(this._client.getFlag(context, flagKey));
89
+ }
90
+ return Promise.resolve({
91
+ value: defaultValue,
92
+ reason: server_sdk_1.StandardResolutionReasons.ERROR,
93
+ errorCode: server_sdk_1.ErrorCode.FLAG_NOT_FOUND,
94
+ errorMessage: `Flag ${flagKey} not found`,
95
+ });
96
+ }
97
+ resolveBooleanEvaluation(flagKey, defaultValue, context) {
98
+ return this.resolveFlag(flagKey, defaultValue, this.contextTranslator(context), (feature) => {
99
+ var _a;
100
+ return Promise.resolve({
101
+ value: feature.isEnabled,
102
+ variant: (_a = feature.config) === null || _a === void 0 ? void 0 : _a.key,
103
+ reason: server_sdk_1.StandardResolutionReasons.TARGETING_MATCH,
104
+ });
105
+ });
106
+ }
107
+ resolveStringEvaluation(flagKey, defaultValue, context) {
108
+ return this.resolveFlag(flagKey, defaultValue, this.contextTranslator(context), (feature) => {
109
+ if (!feature.config.key) {
110
+ return Promise.resolve({
111
+ value: defaultValue,
112
+ reason: server_sdk_1.StandardResolutionReasons.DEFAULT,
113
+ });
114
+ }
115
+ return Promise.resolve({
116
+ value: feature.config.key,
117
+ variant: feature.config.key,
118
+ reason: server_sdk_1.StandardResolutionReasons.TARGETING_MATCH,
119
+ });
120
+ });
121
+ }
122
+ resolveNumberEvaluation(_flagKey, defaultValue) {
123
+ return Promise.resolve({
124
+ value: defaultValue,
125
+ reason: server_sdk_1.StandardResolutionReasons.ERROR,
126
+ errorCode: server_sdk_1.ErrorCode.GENERAL,
127
+ errorMessage: "Reflag doesn't support this method. Use `resolveObjectEvaluation` instead.",
128
+ });
129
+ }
130
+ resolveObjectEvaluation(flagKey, defaultValue, context) {
131
+ return this.resolveFlag(flagKey, defaultValue, this.contextTranslator(context), (feature) => {
132
+ const expType = typeof defaultValue;
133
+ const payloadType = typeof feature.config.payload;
134
+ if (feature.config.payload === undefined ||
135
+ feature.config.payload === null ||
136
+ payloadType !== expType) {
137
+ return Promise.resolve({
138
+ value: defaultValue,
139
+ variant: feature.config.key,
140
+ reason: server_sdk_1.StandardResolutionReasons.ERROR,
141
+ errorCode: server_sdk_1.ErrorCode.TYPE_MISMATCH,
142
+ errorMessage: `Expected remote config payload of type \`${expType}\` but got \`${payloadType}\`.`,
143
+ });
144
+ }
145
+ return Promise.resolve({
146
+ value: feature.config.payload,
147
+ variant: feature.config.key,
148
+ reason: server_sdk_1.StandardResolutionReasons.TARGETING_MATCH,
149
+ });
150
+ });
151
+ }
152
+ track(trackingEventName, context, trackingEventDetails) {
153
+ var _a, _b, _c, _d;
154
+ const translatedContext = context
155
+ ? this.contextTranslator(context)
156
+ : undefined;
157
+ const userId = (_a = translatedContext === null || translatedContext === void 0 ? void 0 : translatedContext.user) === null || _a === void 0 ? void 0 : _a.id;
158
+ if (!userId) {
159
+ (_b = this._client.logger) === null || _b === void 0 ? void 0 : _b.warn("No user ID provided for tracking event");
160
+ return;
161
+ }
162
+ void this._client.track(String(userId), trackingEventName, {
163
+ attributes: trackingEventDetails,
164
+ companyId: (_d = (_c = translatedContext === null || translatedContext === void 0 ? void 0 : translatedContext.company) === null || _c === void 0 ? void 0 : _c.id) === null || _d === void 0 ? void 0 : _d.toString(),
165
+ });
166
+ }
167
+ onClose() {
168
+ return __awaiter(this, void 0, void 0, function* () {
169
+ yield this._client.flush();
170
+ });
171
+ }
172
+ }
173
+ exports.ReflagNodeProvider = ReflagNodeProvider;
174
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,wDAWiC;AAEjC,+CAI0B;AAMnB,MAAM,wBAAwB,GAAG,CACtC,OAA0B,EACX,EAAE;;IACjB,MAAM,IAAI,GAAG;QACX,EAAE,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,MAAA,OAAO,CAAC,QAAQ,CAAC,0CAAE,QAAQ,EAAE;QACzD,IAAI,EAAE,MAAA,OAAO,CAAC,MAAM,CAAC,0CAAE,QAAQ,EAAE;QACjC,KAAK,EAAE,MAAA,OAAO,CAAC,OAAO,CAAC,0CAAE,QAAQ,EAAE;QACnC,MAAM,EAAE,MAAA,OAAO,CAAC,QAAQ,CAAC,0CAAE,QAAQ,EAAE;QACrC,OAAO,EAAE,MAAA,OAAO,CAAC,SAAS,CAAC,0CAAE,QAAQ,EAAE;KACxC,CAAC;IAEF,MAAM,OAAO,GAAG;QACd,EAAE,EAAE,MAAA,OAAO,CAAC,WAAW,CAAC,0CAAE,QAAQ,EAAE;QACpC,IAAI,EAAE,MAAA,OAAO,CAAC,aAAa,CAAC,0CAAE,QAAQ,EAAE;QACxC,MAAM,EAAE,MAAA,OAAO,CAAC,eAAe,CAAC,0CAAE,QAAQ,EAAE;QAC5C,IAAI,EAAE,MAAA,OAAO,CAAC,aAAa,CAAC,0CAAE,QAAQ,EAAE;KACzC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AAtBW,QAAA,wBAAwB,4BAsBnC;AAEF,MAAa,kBAAkB;IAe7B,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,YAAY,EAA+C;YAA/C,EAAE,iBAAiB,OAA4B,EAAvB,IAAI,cAA5B,qBAA8B,CAAF;QAlBxB,WAAM,GAAG,IAAI,oCAAuB,EAAE,CAAC;QAMhD,WAAM,GAAa,QAAQ,CAAC;QAE5B,WAAM,GAAyB,iCAAoB,CAAC,SAAS,CAAC;QAE9D,aAAQ,GAAG;YAChB,IAAI,EAAE,aAAa;SACpB,CAAC;QAOA,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAY,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,gCAAwB,CAAC;IACzE,CAAC;IAEY,UAAU;;YACrB,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,GAAG,iCAAoB,CAAC,KAAK,CAAC;QAC3C,CAAC;KAAA;IAEO,WAAW,CACjB,OAAe,EACf,YAAe,EACf,OAAsB,EACtB,SAEkC;;QAElC,IAAI,IAAI,CAAC,MAAM,KAAK,iCAAoB,CAAC,KAAK,EAAE,CAAC;YAC/C,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,YAAY;gBACnB,MAAM,EAAE,sCAAyB,CAAC,KAAK;gBACvC,SAAS,EAAE,sBAAS,CAAC,kBAAkB;gBACvC,YAAY,EAAE,+BAA+B;aAC9C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,CAAA,MAAA,OAAO,CAAC,IAAI,0CAAE,EAAE,CAAA,EAAE,CAAC;YACtB,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,YAAY;gBACnB,MAAM,EAAE,sCAAyB,CAAC,KAAK;gBACvC,SAAS,EAAE,sBAAS,CAAC,eAAe;gBACpC,YAAY,EAAE,gCAAgC;aAC/C,CAAC,CAAC;QACL,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACtD,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,KAAK,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,sCAAyB,CAAC,KAAK;YACvC,SAAS,EAAE,sBAAS,CAAC,cAAc;YACnC,YAAY,EAAE,QAAQ,OAAO,YAAY;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,wBAAwB,CACtB,OAAe,EACf,YAAqB,EACrB,OAA0B;QAE1B,OAAO,IAAI,CAAC,WAAW,CACrB,OAAO,EACP,YAAY,EACZ,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAC/B,CAAC,OAAO,EAAE,EAAE;;YACV,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,OAAO,CAAC,SAAS;gBACxB,OAAO,EAAE,MAAA,OAAO,CAAC,MAAM,0CAAE,GAAG;gBAC5B,MAAM,EAAE,sCAAyB,CAAC,eAAe;aAClD,CAAC,CAAC;QACL,CAAC,CACF,CAAC;IACJ,CAAC;IAED,uBAAuB,CACrB,OAAe,EACf,YAAoB,EACpB,OAA0B;QAE1B,OAAO,IAAI,CAAC,WAAW,CACrB,OAAO,EACP,YAAY,EACZ,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAC/B,CAAC,OAAO,EAAE,EAAE;YACV,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxB,OAAO,OAAO,CAAC,OAAO,CAAC;oBACrB,KAAK,EAAE,YAAY;oBACnB,MAAM,EAAE,sCAAyB,CAAC,OAAO;iBAC1C,CAAC,CAAC;YACL,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,GAAa;gBACnC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG;gBAC3B,MAAM,EAAE,sCAAyB,CAAC,eAAe;aAClD,CAAC,CAAC;QACL,CAAC,CACF,CAAC;IACJ,CAAC;IAED,uBAAuB,CACrB,QAAgB,EAChB,YAAoB;QAEpB,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,sCAAyB,CAAC,KAAK;YACvC,SAAS,EAAE,sBAAS,CAAC,OAAO;YAC5B,YAAY,EACV,4EAA4E;SAC/E,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB,CACrB,OAAe,EACf,YAAe,EACf,OAA0B;QAE1B,OAAO,IAAI,CAAC,WAAW,CACrB,OAAO,EACP,YAAY,EACZ,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAC/B,CAAC,OAAO,EAAE,EAAE;YACV,MAAM,OAAO,GAAG,OAAO,YAAY,CAAC;YACpC,MAAM,WAAW,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;YAElD,IACE,OAAO,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS;gBACpC,OAAO,CAAC,MAAM,CAAC,OAAO,KAAK,IAAI;gBAC/B,WAAW,KAAK,OAAO,EACvB,CAAC;gBACD,OAAO,OAAO,CAAC,OAAO,CAAC;oBACrB,KAAK,EAAE,YAAY;oBACnB,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG;oBAC3B,MAAM,EAAE,sCAAyB,CAAC,KAAK;oBACvC,SAAS,EAAE,sBAAS,CAAC,aAAa;oBAClC,YAAY,EAAE,4CAA4C,OAAO,gBAAgB,WAAW,KAAK;iBAClG,CAAC,CAAC;YACL,CAAC;YAED,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;gBAC7B,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG;gBAC3B,MAAM,EAAE,sCAAyB,CAAC,eAAe;aAClD,CAAC,CAAC;QACL,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CACH,iBAAyB,EACzB,OAA2B,EAC3B,oBAA2C;;QAE3C,MAAM,iBAAiB,GAAG,OAAO;YAC/B,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC;YACjC,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,MAAM,GAAG,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,IAAI,0CAAE,EAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAA,IAAI,CAAC,OAAO,CAAC,MAAM,0CAAE,IAAI,CAAC,wCAAwC,CAAC,CAAC;YACpE,OAAO;QACT,CAAC;QAED,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE;YACzD,UAAU,EAAE,oBAAoB;YAChC,SAAS,EAAE,MAAA,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,0CAAE,EAAE,0CAAE,QAAQ,EAAE;SACtD,CAAC,CAAC;IACL,CAAC;IAEY,OAAO;;YAClB,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7B,CAAC;KAAA;CACF;AA1LD,gDA0LC"}
@@ -0,0 +1,252 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ const server_sdk_1 = require("@openfeature/server-sdk");
13
+ const vitest_1 = require("vitest");
14
+ const node_sdk_1 = require("@reflag/node-sdk");
15
+ const index_1 = require("./index");
16
+ vitest_1.vi.mock("@reflag/node-sdk", () => {
17
+ const actualModule = vitest_1.vi.importActual("@reflag/node-sdk");
18
+ return Object.assign(Object.assign({ __esModule: true }, actualModule), { ReflagClient: vitest_1.vi.fn() });
19
+ });
20
+ const reflagClientMock = {
21
+ getFlag: vitest_1.vi.fn(),
22
+ getFlagDefinitions: vitest_1.vi.fn().mockReturnValue([]),
23
+ initialize: vitest_1.vi.fn().mockResolvedValue({}),
24
+ flush: vitest_1.vi.fn(),
25
+ track: vitest_1.vi.fn(),
26
+ };
27
+ const secretKey = "sec_fakeSecretKey______"; // must be 23 characters long
28
+ const context = {
29
+ targetingKey: "abc",
30
+ name: "John Doe",
31
+ email: "john@acme.inc",
32
+ };
33
+ const reflagContext = {
34
+ user: { id: "42" },
35
+ company: { id: "99" },
36
+ };
37
+ const testFlagKey = "a-key";
38
+ (0, vitest_1.beforeEach)(() => {
39
+ vitest_1.vi.clearAllMocks();
40
+ });
41
+ (0, vitest_1.describe)("ReflagNodeProvider", () => {
42
+ let provider;
43
+ const mockReflagClient = node_sdk_1.ReflagClient;
44
+ mockReflagClient.mockReturnValue(reflagClientMock);
45
+ let mockTranslatorFn;
46
+ function mockFlag(enabled, configKey, configPayload, flagKey = testFlagKey) {
47
+ const config = {
48
+ key: configKey,
49
+ payload: configPayload,
50
+ };
51
+ reflagClientMock.getFlag = vitest_1.vi.fn().mockReturnValue({
52
+ isEnabled: enabled,
53
+ config,
54
+ });
55
+ // Mock getFlagDefinitions to return feature definitions that include the specified flag
56
+ reflagClientMock.getFlagDefinitions = vitest_1.vi.fn().mockReturnValue([
57
+ {
58
+ key: flagKey,
59
+ description: "Test flag",
60
+ flag: {},
61
+ config: {},
62
+ },
63
+ ]);
64
+ }
65
+ (0, vitest_1.beforeEach)(() => __awaiter(void 0, void 0, void 0, function* () {
66
+ mockTranslatorFn = vitest_1.vi.fn().mockReturnValue(reflagContext);
67
+ provider = new index_1.ReflagNodeProvider({
68
+ secretKey,
69
+ contextTranslator: mockTranslatorFn,
70
+ });
71
+ yield provider.initialize();
72
+ }));
73
+ (0, vitest_1.describe)("contextTranslator", () => {
74
+ (0, vitest_1.it)("defaultContextTranslator provides the correct context", () => __awaiter(void 0, void 0, void 0, function* () {
75
+ (0, vitest_1.expect)((0, index_1.defaultContextTranslator)({
76
+ userId: 123,
77
+ name: "John Doe",
78
+ email: "ron@reflag.co",
79
+ avatar: "https://reflag.com/avatar.png",
80
+ companyId: "456",
81
+ companyName: "Acme, Inc.",
82
+ companyAvatar: "https://acme.com/company-avatar.png",
83
+ companyPlan: "pro",
84
+ })).toEqual({
85
+ user: {
86
+ id: "123",
87
+ name: "John Doe",
88
+ email: "ron@reflag.co",
89
+ avatar: "https://reflag.com/avatar.png",
90
+ },
91
+ company: {
92
+ id: "456",
93
+ name: "Acme, Inc.",
94
+ plan: "pro",
95
+ avatar: "https://acme.com/company-avatar.png",
96
+ },
97
+ });
98
+ }));
99
+ (0, vitest_1.it)("defaultContextTranslator uses targetingKey if provided", () => __awaiter(void 0, void 0, void 0, function* () {
100
+ (0, vitest_1.expect)((0, index_1.defaultContextTranslator)({
101
+ targetingKey: "123",
102
+ })).toMatchObject({
103
+ user: {
104
+ id: "123",
105
+ },
106
+ company: {
107
+ id: undefined,
108
+ },
109
+ });
110
+ }));
111
+ });
112
+ (0, vitest_1.describe)("lifecycle", () => {
113
+ (0, vitest_1.it)("calls the constructor of ReflagClient", () => {
114
+ mockReflagClient.mockClear();
115
+ provider = new index_1.ReflagNodeProvider({
116
+ secretKey,
117
+ contextTranslator: mockTranslatorFn,
118
+ });
119
+ (0, vitest_1.expect)(mockReflagClient).toHaveBeenCalledTimes(1);
120
+ (0, vitest_1.expect)(mockReflagClient).toHaveBeenCalledWith({ secretKey });
121
+ });
122
+ (0, vitest_1.it)("should set the status to READY if initialization succeeds", () => __awaiter(void 0, void 0, void 0, function* () {
123
+ provider = new index_1.ReflagNodeProvider({
124
+ secretKey,
125
+ contextTranslator: mockTranslatorFn,
126
+ });
127
+ yield provider.initialize();
128
+ (0, vitest_1.expect)(provider.status).toBe(server_sdk_1.ProviderStatus.READY);
129
+ }));
130
+ (0, vitest_1.it)("should keep the status as READY after closing", () => __awaiter(void 0, void 0, void 0, function* () {
131
+ provider = new index_1.ReflagNodeProvider({
132
+ secretKey: "invalid",
133
+ contextTranslator: mockTranslatorFn,
134
+ });
135
+ yield provider.initialize();
136
+ yield provider.onClose();
137
+ (0, vitest_1.expect)(provider.status).toBe(server_sdk_1.ProviderStatus.READY);
138
+ }));
139
+ (0, vitest_1.it)("calls flush when provider is closed", () => __awaiter(void 0, void 0, void 0, function* () {
140
+ yield provider.onClose();
141
+ (0, vitest_1.expect)(reflagClientMock.flush).toHaveBeenCalledTimes(1);
142
+ }));
143
+ (0, vitest_1.it)("uses the contextTranslator function", () => __awaiter(void 0, void 0, void 0, function* () {
144
+ mockFlag(true);
145
+ yield provider.resolveBooleanEvaluation(testFlagKey, false, context);
146
+ (0, vitest_1.expect)(mockTranslatorFn).toHaveBeenCalledTimes(1);
147
+ (0, vitest_1.expect)(mockTranslatorFn).toHaveBeenCalledWith(context);
148
+ (0, vitest_1.expect)(reflagClientMock.getFlagDefinitions).toHaveBeenCalledTimes(1);
149
+ (0, vitest_1.expect)(reflagClientMock.getFlag).toHaveBeenCalledWith(reflagContext, testFlagKey);
150
+ }));
151
+ });
152
+ (0, vitest_1.describe)("resolving flags", () => {
153
+ (0, vitest_1.beforeEach)(() => __awaiter(void 0, void 0, void 0, function* () {
154
+ yield provider.initialize();
155
+ }));
156
+ (0, vitest_1.it)("returns error if provider is not initialized", () => __awaiter(void 0, void 0, void 0, function* () {
157
+ provider = new index_1.ReflagNodeProvider({
158
+ secretKey: "invalid",
159
+ contextTranslator: mockTranslatorFn,
160
+ });
161
+ const val = yield provider.resolveBooleanEvaluation(testFlagKey, true, context);
162
+ (0, vitest_1.expect)(val).toMatchObject({
163
+ reason: "ERROR",
164
+ errorCode: "PROVIDER_NOT_READY",
165
+ value: true,
166
+ });
167
+ }));
168
+ (0, vitest_1.it)("returns error if flag is not found", () => __awaiter(void 0, void 0, void 0, function* () {
169
+ mockFlag(true, "key", true);
170
+ const val = yield provider.resolveBooleanEvaluation("missing-key", true, context);
171
+ (0, vitest_1.expect)(val).toMatchObject({
172
+ reason: "ERROR",
173
+ errorCode: "FLAG_NOT_FOUND",
174
+ value: true,
175
+ });
176
+ }));
177
+ (0, vitest_1.it)("calls the client correctly when evaluating", () => __awaiter(void 0, void 0, void 0, function* () {
178
+ mockFlag(true, "key", true);
179
+ const val = yield provider.resolveBooleanEvaluation(testFlagKey, false, context);
180
+ (0, vitest_1.expect)(val).toMatchObject({
181
+ reason: "TARGETING_MATCH",
182
+ value: true,
183
+ });
184
+ (0, vitest_1.expect)(reflagClientMock.getFlagDefinitions).toHaveBeenCalled();
185
+ (0, vitest_1.expect)(reflagClientMock.getFlag).toHaveBeenCalledWith(reflagContext, testFlagKey);
186
+ }));
187
+ vitest_1.it.each([
188
+ [true, false, true, "TARGETING_MATCH", undefined],
189
+ [undefined, true, true, "ERROR", "FLAG_NOT_FOUND"],
190
+ [undefined, false, false, "ERROR", "FLAG_NOT_FOUND"],
191
+ ])("should return the correct result when evaluating boolean. enabled: %s, value: %s, default: %s, expected: %s, reason: %s, errorCode: %s`", (enabled, def, expected, reason, errorCode) => __awaiter(void 0, void 0, void 0, function* () {
192
+ const configKey = enabled !== undefined ? "variant-1" : undefined;
193
+ mockFlag(enabled !== null && enabled !== void 0 ? enabled : false, configKey);
194
+ const flagKey = enabled ? testFlagKey : "missing-key";
195
+ (0, vitest_1.expect)(yield provider.resolveBooleanEvaluation(flagKey, def, context)).toMatchObject(Object.assign(Object.assign({ reason, value: expected }, (configKey ? { variant: configKey } : {})), (errorCode ? { errorCode } : {})));
196
+ }));
197
+ (0, vitest_1.it)("should return error when context is missing user ID", () => __awaiter(void 0, void 0, void 0, function* () {
198
+ mockTranslatorFn.mockReturnValue({ user: {} });
199
+ (0, vitest_1.expect)(yield provider.resolveBooleanEvaluation(testFlagKey, true, context)).toMatchObject({
200
+ reason: "ERROR",
201
+ errorCode: "INVALID_CONTEXT",
202
+ value: true,
203
+ });
204
+ }));
205
+ (0, vitest_1.it)("should return error when evaluating number", () => __awaiter(void 0, void 0, void 0, function* () {
206
+ (0, vitest_1.expect)(yield provider.resolveNumberEvaluation(testFlagKey, 1)).toMatchObject({
207
+ reason: "ERROR",
208
+ errorCode: "GENERAL",
209
+ value: 1,
210
+ });
211
+ }));
212
+ vitest_1.it.each([
213
+ ["key-1", "default", "key-1", "TARGETING_MATCH"],
214
+ [null, "default", "default", "DEFAULT"],
215
+ [undefined, "default", "default", "DEFAULT"],
216
+ ])("should return the correct result when evaluating string. variant: %s, def: %s, expected: %s, reason: %s, errorCode: %s`", (variant, def, expected, reason) => __awaiter(void 0, void 0, void 0, function* () {
217
+ mockFlag(true, variant, {});
218
+ (0, vitest_1.expect)(yield provider.resolveStringEvaluation(testFlagKey, def, context)).toMatchObject(Object.assign({ reason, value: expected }, (variant ? { variant } : {})));
219
+ }));
220
+ vitest_1.it.each([
221
+ [{}, { a: 1 }, {}, "TARGETING_MATCH", undefined],
222
+ ["string", "default", "string", "TARGETING_MATCH", undefined],
223
+ [15, -15, 15, "TARGETING_MATCH", undefined],
224
+ [true, false, true, "TARGETING_MATCH", undefined],
225
+ [null, { a: 2 }, { a: 2 }, "ERROR", "TYPE_MISMATCH"],
226
+ [100, "string", "string", "ERROR", "TYPE_MISMATCH"],
227
+ [true, 1337, 1337, "ERROR", "TYPE_MISMATCH"],
228
+ ["string", 1337, 1337, "ERROR", "TYPE_MISMATCH"],
229
+ [undefined, "default", "default", "ERROR", "TYPE_MISMATCH"],
230
+ ])("should return the correct result when evaluating object. payload: %s, default: %s, expected: %s, reason: %s, errorCode: %s`", (value, def, expected, reason, errorCode) => __awaiter(void 0, void 0, void 0, function* () {
231
+ const configKey = value === undefined ? undefined : "config-key";
232
+ mockFlag(true, configKey, value);
233
+ (0, vitest_1.expect)(yield provider.resolveObjectEvaluation(testFlagKey, def, context)).toMatchObject(Object.assign({ reason, value: expected }, (errorCode ? { errorCode, variant: configKey } : {})));
234
+ }));
235
+ });
236
+ (0, vitest_1.describe)("track", () => {
237
+ (0, vitest_1.it)("should track", () => __awaiter(void 0, void 0, void 0, function* () {
238
+ (0, vitest_1.expect)(mockTranslatorFn).toHaveBeenCalledTimes(0);
239
+ provider.track("event", context, {
240
+ action: "click",
241
+ });
242
+ (0, vitest_1.expect)(mockTranslatorFn).toHaveBeenCalledTimes(1);
243
+ (0, vitest_1.expect)(mockTranslatorFn).toHaveBeenCalledWith(context);
244
+ (0, vitest_1.expect)(reflagClientMock.track).toHaveBeenCalledTimes(1);
245
+ (0, vitest_1.expect)(reflagClientMock.track).toHaveBeenCalledWith("42", "event", {
246
+ attributes: { action: "click" },
247
+ companyId: reflagContext.company.id,
248
+ });
249
+ }));
250
+ });
251
+ });
252
+ //# sourceMappingURL=index.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,wDAAyD;AACzD,mCAAoE;AAEpE,+CAAgD;AAEhD,mCAAuE;AAEvE,WAAE,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC/B,MAAM,YAAY,GAAG,WAAE,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAEzD,qCACE,UAAU,EAAE,IAAI,IACb,YAAY,KACf,YAAY,EAAE,WAAE,CAAC,EAAE,EAAE,IACrB;AACJ,CAAC,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG;IACvB,OAAO,EAAE,WAAE,CAAC,EAAE,EAAE;IAChB,kBAAkB,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC;IAC/C,UAAU,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC;IACzC,KAAK,EAAE,WAAE,CAAC,EAAE,EAAE;IACd,KAAK,EAAE,WAAE,CAAC,EAAE,EAAE;CACf,CAAC;AAEF,MAAM,SAAS,GAAG,yBAAyB,CAAC,CAAC,6BAA6B;AAE1E,MAAM,OAAO,GAAG;IACd,YAAY,EAAE,KAAK;IACnB,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,eAAe;CACvB,CAAC;AAEF,MAAM,aAAa,GAAG;IACpB,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;IAClB,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;CACtB,CAAC;AAEF,MAAM,WAAW,GAAG,OAAO,CAAC;AAE5B,IAAA,mBAAU,EAAC,GAAG,EAAE;IACd,WAAE,CAAC,aAAa,EAAE,CAAC;AACrB,CAAC,CAAC,CAAC;AAEH,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAI,QAA4B,CAAC;IAEjC,MAAM,gBAAgB,GAAG,uBAAoB,CAAC;IAC9C,gBAAgB,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAEnD,IAAI,gBAAsB,CAAC;IAE3B,SAAS,QAAQ,CACf,OAAgB,EAChB,SAAyB,EACzB,aAAmB,EACnB,OAAO,GAAG,WAAW;QAErB,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,SAAS;YACd,OAAO,EAAE,aAAa;SACvB,CAAC;QAEF,gBAAgB,CAAC,OAAO,GAAG,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC;YACjD,SAAS,EAAE,OAAO;YAClB,MAAM;SACP,CAAC,CAAC;QAEH,wFAAwF;QACxF,gBAAgB,CAAC,kBAAkB,GAAG,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC;YAC5D;gBACE,GAAG,EAAE,OAAO;gBACZ,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,EAAE;gBACR,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;IACL,CAAC;IAED,IAAA,mBAAU,EAAC,GAAS,EAAE;QACpB,gBAAgB,GAAG,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAE1D,QAAQ,GAAG,IAAI,0BAAkB,CAAC;YAChC,SAAS;YACT,iBAAiB,EAAE,gBAAgB;SACpC,CAAC,CAAC;QAEH,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC,CAAA,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,IAAA,WAAE,EAAC,uDAAuD,EAAE,GAAS,EAAE;YACrE,IAAA,eAAM,EACJ,IAAA,gCAAwB,EAAC;gBACvB,MAAM,EAAE,GAAG;gBACX,IAAI,EAAE,UAAU;gBAChB,KAAK,EAAE,eAAe;gBACtB,MAAM,EAAE,+BAA+B;gBACvC,SAAS,EAAE,KAAK;gBAChB,WAAW,EAAE,YAAY;gBACzB,aAAa,EAAE,qCAAqC;gBACpD,WAAW,EAAE,KAAK;aACnB,CAAC,CACH,CAAC,OAAO,CAAC;gBACR,IAAI,EAAE;oBACJ,EAAE,EAAE,KAAK;oBACT,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,eAAe;oBACtB,MAAM,EAAE,+BAA+B;iBACxC;gBACD,OAAO,EAAE;oBACP,EAAE,EAAE,KAAK;oBACT,IAAI,EAAE,YAAY;oBAClB,IAAI,EAAE,KAAK;oBACX,MAAM,EAAE,qCAAqC;iBAC9C;aACF,CAAC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,wDAAwD,EAAE,GAAS,EAAE;YACtE,IAAA,eAAM,EACJ,IAAA,gCAAwB,EAAC;gBACvB,YAAY,EAAE,KAAK;aACpB,CAAC,CACH,CAAC,aAAa,CAAC;gBACd,IAAI,EAAE;oBACJ,EAAE,EAAE,KAAK;iBACV;gBACD,OAAO,EAAE;oBACP,EAAE,EAAE,SAAS;iBACd;aACF,CAAC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QACzB,IAAA,WAAE,EAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,gBAAgB,CAAC,SAAS,EAAE,CAAC;YAE7B,QAAQ,GAAG,IAAI,0BAAkB,CAAC;gBAChC,SAAS;gBACT,iBAAiB,EAAE,gBAAgB;aACpC,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,2DAA2D,EAAE,GAAS,EAAE;YACzE,QAAQ,GAAG,IAAI,0BAAkB,CAAC;gBAChC,SAAS;gBACT,iBAAiB,EAAE,gBAAgB;aACpC,CAAC,CAAC;YAEH,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;YAE5B,IAAA,eAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,2BAAc,CAAC,KAAK,CAAC,CAAC;QACrD,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,+CAA+C,EAAE,GAAS,EAAE;YAC7D,QAAQ,GAAG,IAAI,0BAAkB,CAAC;gBAChC,SAAS,EAAE,SAAS;gBACpB,iBAAiB,EAAE,gBAAgB;aACpC,CAAC,CAAC;YAEH,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC5B,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;YAEzB,IAAA,eAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,2BAAc,CAAC,KAAK,CAAC,CAAC;QACrD,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,qCAAqC,EAAE,GAAS,EAAE;YACnD,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;YACzB,IAAA,eAAM,EAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC1D,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,qCAAqC,EAAE,GAAS,EAAE;YACnD,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEf,MAAM,QAAQ,CAAC,wBAAwB,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAErE,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAEvD,IAAA,eAAM,EAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YACrE,IAAA,eAAM,EAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,oBAAoB,CACnD,aAAa,EACb,WAAW,CACZ,CAAC;QACJ,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,IAAA,mBAAU,EAAC,GAAS,EAAE;YACpB,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC9B,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,8CAA8C,EAAE,GAAS,EAAE;YAC5D,QAAQ,GAAG,IAAI,0BAAkB,CAAC;gBAChC,SAAS,EAAE,SAAS;gBACpB,iBAAiB,EAAE,gBAAgB;aACpC,CAAC,CAAC;YAEH,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,wBAAwB,CACjD,WAAW,EACX,IAAI,EACJ,OAAO,CACR,CAAC;YAEF,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;gBACxB,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE,oBAAoB;gBAC/B,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAS,EAAE;YAClD,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC5B,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,wBAAwB,CACjD,aAAa,EACb,IAAI,EACJ,OAAO,CACR,CAAC;YAEF,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;gBACxB,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE,gBAAgB;gBAC3B,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,4CAA4C,EAAE,GAAS,EAAE;YAC1D,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAE5B,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,wBAAwB,CACjD,WAAW,EACX,KAAK,EACL,OAAO,CACR,CAAC;YAEF,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,aAAa,CAAC;gBACxB,MAAM,EAAE,iBAAiB;gBACzB,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAC/D,IAAA,eAAM,EAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,oBAAoB,CACnD,aAAa,EACb,WAAW,CACZ,CAAC;QACJ,CAAC,CAAA,CAAC,CAAC;QAEH,WAAE,CAAC,IAAI,CAAC;YACN,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,SAAS,CAAC;YACjD,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,CAAC;YAClD,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,gBAAgB,CAAC;SACrD,CAAC,CACA,yIAAyI,EACzI,CAAO,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE;YAClD,MAAM,SAAS,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YAElE,QAAQ,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,KAAK,EAAE,SAAS,CAAC,CAAC;YACtC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC;YAEtD,IAAA,eAAM,EACJ,MAAM,QAAQ,CAAC,wBAAwB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAC/D,CAAC,aAAa,+BACb,MAAM,EACN,KAAK,EAAE,QAAQ,IACZ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACzC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACnC,CAAC;QACL,CAAC,CAAA,CACF,CAAC;QAEF,IAAA,WAAE,EAAC,qDAAqD,EAAE,GAAS,EAAE;YACnE,gBAAgB,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;YAE/C,IAAA,eAAM,EACJ,MAAM,QAAQ,CAAC,wBAAwB,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CACpE,CAAC,aAAa,CAAC;gBACd,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE,iBAAiB;gBAC5B,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,4CAA4C,EAAE,GAAS,EAAE;YAC1D,IAAA,eAAM,EACJ,MAAM,QAAQ,CAAC,uBAAuB,CAAC,WAAW,EAAE,CAAC,CAAC,CACvD,CAAC,aAAa,CAAC;gBACd,MAAM,EAAE,OAAO;gBACf,SAAS,EAAE,SAAS;gBACpB,KAAK,EAAE,CAAC;aACT,CAAC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;QAEH,WAAE,CAAC,IAAI,CAAC;YACN,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAiB,CAAC;YAChD,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;YACvC,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;SAC7C,CAAC,CACA,yHAAyH,EACzH,CAAO,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;YACvC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;YAC5B,IAAA,eAAM,EACJ,MAAM,QAAQ,CAAC,uBAAuB,CAAC,WAAW,EAAE,GAAG,EAAE,OAAO,CAAC,CAClE,CAAC,aAAa,iBACb,MAAM,EACN,KAAK,EAAE,QAAQ,IACZ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAC/B,CAAC;QACL,CAAC,CAAA,CACF,CAAC;QAEF,WAAE,CAAC,IAAI,CAAC;YACN,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,SAAS,CAAC;YAChD,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE,SAAS,CAAC;YAC7D,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,iBAAiB,EAAE,SAAS,CAAC;YAC3C,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,SAAS,CAAC;YACjD,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,eAAe,CAAC;YACpD,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,CAAC;YACnD,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,CAAC;YAC5C,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,CAAC;YAChD,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,CAAC;SAC5D,CAAC,CACA,6HAA6H,EAC7H,CAAO,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE;YAChD,MAAM,SAAS,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC;YACjE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YACjC,IAAA,eAAM,EACJ,MAAM,QAAQ,CAAC,uBAAuB,CAAC,WAAW,EAAE,GAAG,EAAE,OAAO,CAAC,CAClE,CAAC,aAAa,iBACb,MAAM,EACN,KAAK,EAAE,QAAQ,IACZ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACvD,CAAC;QACL,CAAC,CAAA,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,OAAO,EAAE,GAAG,EAAE;QACrB,IAAA,WAAE,EAAC,cAAc,EAAE,GAAS,EAAE;YAC5B,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE;gBAC/B,MAAM,EAAE,OAAO;aAChB,CAAC,CAAC;YAEH,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;YACvD,IAAA,eAAM,EAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YACxD,IAAA,eAAM,EAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,EAAE;gBACjE,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;gBAC/B,SAAS,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE;aACpC,CAAC,CAAC;QACL,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,27 @@
1
+ import { EvaluationContext, JsonValue, OpenFeatureEventEmitter, Paradigm, Provider, ResolutionDetails, ServerProviderStatus, TrackingEventDetails } from "@openfeature/server-sdk";
2
+ import { ClientOptions, Context as ReflagContext, ReflagClient } from "@reflag/node-sdk";
3
+ type ProviderOptions = ClientOptions & {
4
+ contextTranslator?: (context: EvaluationContext) => ReflagContext;
5
+ };
6
+ export declare const defaultContextTranslator: (context: EvaluationContext) => ReflagContext;
7
+ export declare class ReflagNodeProvider implements Provider {
8
+ readonly events: OpenFeatureEventEmitter;
9
+ private _client;
10
+ private contextTranslator;
11
+ runsOn: Paradigm;
12
+ status: ServerProviderStatus;
13
+ metadata: {
14
+ name: string;
15
+ };
16
+ get client(): ReflagClient;
17
+ constructor({ contextTranslator, ...opts }: ProviderOptions);
18
+ initialize(): Promise<void>;
19
+ private resolveFlag;
20
+ resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext): Promise<ResolutionDetails<boolean>>;
21
+ resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext): Promise<ResolutionDetails<string>>;
22
+ resolveNumberEvaluation(_flagKey: string, defaultValue: number): Promise<ResolutionDetails<number>>;
23
+ resolveObjectEvaluation<T extends JsonValue>(flagKey: string, defaultValue: T, context: EvaluationContext): Promise<ResolutionDetails<T>>;
24
+ track(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
25
+ onClose(): Promise<void>;
26
+ }
27
+ export {};
@@ -0,0 +1 @@
1
+ export {};
package/package.json ADDED
@@ -0,0 +1,59 @@
1
+ {
2
+ "name": "@reflag/openfeature-node-provider",
3
+ "version": "1.0.0-alpha.1",
4
+ "license": "MIT",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/reflagcom/javascript.git"
8
+ },
9
+ "scripts": {
10
+ "dev": "vite",
11
+ "start": "vite",
12
+ "build": "tsc --project tsconfig.build.json",
13
+ "test": "vitest -c vite.config.js",
14
+ "test:ci": "vitest run -c vite.config.js --reporter=default --reporter=junit --outputFile=junit.xml",
15
+ "coverage": "vitest run --coverage",
16
+ "lint": "eslint .",
17
+ "lint:ci": "eslint --output-file eslint-report.json --format json .",
18
+ "prettier": "prettier --check .",
19
+ "format": "yarn lint --fix && yarn prettier --write",
20
+ "preversion": "yarn lint && yarn prettier && yarn vitest run -c vite.config.js && yarn build"
21
+ },
22
+ "files": [
23
+ "dist"
24
+ ],
25
+ "publishConfig": {
26
+ "access": "public"
27
+ },
28
+ "main": "./dist/index.js",
29
+ "types": "./dist/types/index.d.ts",
30
+ "exports": {
31
+ ".": {
32
+ "types": "./dist/types/index.d.ts",
33
+ "require": "./dist/index.js"
34
+ }
35
+ },
36
+ "devDependencies": {
37
+ "@babel/core": "~7.24.7",
38
+ "@openfeature/core": "^1.5.0",
39
+ "@openfeature/server-sdk": ">=1.16.1",
40
+ "@reflag/eslint-config": "~0.0.2",
41
+ "@reflag/tsconfig": "~0.0.2",
42
+ "@types/node": "^22.12.0",
43
+ "eslint": "^9.21.0",
44
+ "flush-promises": "~1.0.2",
45
+ "prettier": "^3.5.2",
46
+ "ts-node": "~10.9.2",
47
+ "typescript": "^5.7.3",
48
+ "vite": "~5.4.18",
49
+ "vite-plugin-dts": "~3.9.1",
50
+ "vitest": "~1.6.0"
51
+ },
52
+ "dependencies": {
53
+ "@reflag/node-sdk": "1.0.0-alpha.1"
54
+ },
55
+ "peerDependencies": {
56
+ "@openfeature/server-sdk": ">=1.16.1"
57
+ },
58
+ "gitHead": "d70378c8d717b140cfbaf5f05ec018d60fc26724"
59
+ }