@openfeature/ofrep-web-provider 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,107 @@
+# Client-Side OFREP Provider
+
+This provider is designed to use the [OpenFeature Remote Evaluation Protocol (OFREP)](https://openfeature.dev/specification/appendix-c).
+
+## Installation
+
+### npm
+
+```sh
+npm install @openfeature/ofrep-web
+```
+
+### yarn
+
+```sh
+yarn add @openfeature/ofrep-web @openfeature/ofrep-core @openfeature/web-sdk
+```
+
+> [!NOTE]
+> yarn requires manual installation of peer dependencies
+
+## Configurations and Usage
+
+The provider needs the base url of the OFREP server for instantiation.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(new OFREPWebProvider({ baseUrl: 'https://localhost:8080', pollingInterval: 60000 }));
+```
+
+### HTTP headers
+
+The provider can use headers from either a static header map or a custom header factory.
+
+#### Static Headers
+
+Headers can be given as a list of tuples or as a map of headers.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    headers: [
+      ['Authorization', `my-api-key`],
+      ['X-My-Header', `CustomHeaderValue`],
+    ],
+  }),
+);
+```
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    headers: { Authorization: `my-api-key`, 'X-My-Header': `CustomHeaderValue` },
+  }),
+);
+```
+
+#### Header Factory
+
+The header factory is evaluated before every flag evaluation which makes it possible to use dynamic values for the headers.
+
+The following shows an example of loading a token and using it as bearer token.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    headersFactory: () => {
+      const token: string = loadDynamicToken();
+      return [['Authorization', `Bearer ${token}`]];
+    },
+  }),
+);
+```
+
+### Fetch implementation
+
+If needed, a custom fetch implementation can be injected, if e.g. the platform does not have fetch built in.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+import { fetchPolyfill } from 'some-fetch-polyfill';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    fetchImplementation: fetchPolyfill
+  }),
+);
+```
+
+## Building
+
+Run `nx package providers-ofrep-web` to build the library.
+
+## Running unit tests
+
+Run `nx test providers-ofrep-web` to execute the unit tests via [Jest](https://jestjs.io).

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,281 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var webSdk = require('@openfeature/web-sdk');
+var ofrepCore = require('@openfeature/ofrep-core');
+var core = require('@openfeature/core');
+
+function isResolutionError(response) {
+    if (!response || typeof response !== 'object') {
+        return false;
+    }
+    return 'reason' in response && 'errorCode' in response && !('value' in response);
+}
+
+var BulkEvaluationStatus;
+(function (BulkEvaluationStatus) {
+    BulkEvaluationStatus["SUCCESS_NO_CHANGES"] = "SUCCESS_NO_CHANGES";
+    BulkEvaluationStatus["SUCCESS_WITH_CHANGES"] = "SUCCESS_WITH_CHANGES";
+})(BulkEvaluationStatus || (BulkEvaluationStatus = {}));
+
+class OFREPWebProvider {
+    constructor(options, logger) {
+        var _a;
+        this.DEFAULT_POLL_INTERVAL = 30000;
+        this.metadata = {
+            name: 'OpenFeature Remote Evaluation Protocol Web Provider',
+        };
+        this.runsOn = 'client';
+        this.events = new webSdk.OpenFeatureEventEmitter();
+        this._cache = {};
+        try {
+            // Cannot use URL.canParse as it is only available from Node 19.x
+            new URL(options.baseUrl);
+        }
+        catch (_b) {
+            throw new Error(`The given OFREP URL "${options.baseUrl}" is not a valid URL.`);
+        }
+        this._options = options;
+        this._logger = logger;
+        this._etag = null;
+        this._ofrepAPI = new ofrepCore.OFREPApi(this._options.baseUrl, this._options.fetchImplementation);
+        this._pollingInterval = (_a = this._options.pollInterval) !== null && _a !== void 0 ? _a : this.DEFAULT_POLL_INTERVAL;
+    }
+    /**
+     * Initialize the provider, it will evaluate the flags and start the polling if it is not disabled.
+     * @param context - the context to use for the evaluation
+     */
+    initialize(context) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a;
+            try {
+                this._context = context;
+                yield this._evaluateFlags(context);
+                if (this._pollingInterval > 0) {
+                    this.startPolling();
+                }
+                (_a = this._logger) === null || _a === void 0 ? void 0 : _a.debug(`${this.metadata.name} initialized successfully`);
+            }
+            catch (error) {
+                if (error instanceof ofrepCore.OFREPApiUnauthorizedError || error instanceof ofrepCore.OFREPForbiddenError) {
+                    throw new webSdk.ProviderFatalError('Initialization failed', error);
+                }
+                throw error;
+            }
+        });
+    }
+    resolveBooleanEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'boolean');
+    }
+    resolveStringEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'string');
+    }
+    resolveNumberEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'number');
+    }
+    resolveObjectEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'object');
+    }
+    /**
+     * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
+     * and update the cache.
+     * @param oldContext - the old evaluation context
+     * @param newContext - the new evaluation context
+     */
+    onContextChange(oldContext, newContext) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            try {
+                this._context = newContext;
+                const now = new Date();
+                if (this._retryPollingAfter !== undefined && this._retryPollingAfter > now) {
+                    // we do nothing because we should not call the endpoint
+                    return;
+                }
+                yield this._evaluateFlags(newContext);
+            }
+            catch (error) {
+                if (error instanceof ofrepCore.OFREPApiTooManyRequestsError) {
+                    (_a = this.events) === null || _a === void 0 ? void 0 : _a.emit(webSdk.ClientProviderEvents.Stale, { message: `${error.name}: ${error.message}` });
+                    return;
+                }
+                if (error instanceof webSdk.OpenFeatureError ||
+                    error instanceof ofrepCore.OFREPApiFetchError ||
+                    error instanceof ofrepCore.OFREPApiUnauthorizedError ||
+                    error instanceof ofrepCore.OFREPForbiddenError) {
+                    (_b = this.events) === null || _b === void 0 ? void 0 : _b.emit(webSdk.ClientProviderEvents.Error, { message: `${error.name}: ${error.message}` });
+                    return;
+                }
+                (_c = this.events) === null || _c === void 0 ? void 0 : _c.emit(webSdk.ClientProviderEvents.Error, { message: `Unknown error: ${error}` });
+            }
+        });
+    }
+    /**
+     * onClose is called when the provider is closed, it will stop the polling if it is enabled.
+     */
+    onClose() {
+        this.stopPolling();
+        return Promise.resolve();
+    }
+    /**
+     * _evaluateFlags is a function that will call the bulk evaluate flags endpoint to get the flags values.
+     * @param context - the context to use for the evaluation
+     * @private
+     * @returns EvaluationStatus if the evaluation the API returned a 304, 200.
+     * @throws TargetingKeyMissingError if the API returned a 400 with the error code TargetingKeyMissing
+     * @throws InvalidContextError if the API returned a 400 with the error code InvalidContext
+     * @throws ParseError if the API returned a 400 with the error code ParseError
+     * @throws GeneralError if the API returned a 400 with an unknown error code
+     */
+    _evaluateFlags(context) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            try {
+                const evalReq = {
+                    context,
+                };
+                const options = Object.assign({ headers: new Headers({
+                        'Content-Type': 'application/json',
+                    }) }, (this._etag !== null ? { headers: { 'If-None-Match': this._etag } } : {}));
+                const response = yield this._ofrepAPI.postBulkEvaluateFlags(evalReq, options);
+                if (response.httpStatus === 304) {
+                    // nothing has changed since last time, we are doing nothing
+                    return { status: BulkEvaluationStatus.SUCCESS_NO_CHANGES, flags: [] };
+                }
+                if (response.httpStatus !== 200) {
+                    ofrepCore.handleEvaluationError(response);
+                }
+                const bulkSuccessResp = response.value;
+                const newCache = {};
+                (_a = bulkSuccessResp.flags) === null || _a === void 0 ? void 0 : _a.forEach((evalResp) => {
+                    if (ofrepCore.isEvaluationFailureResponse(evalResp)) {
+                        newCache[evalResp.key] = {
+                            errorCode: evalResp.errorCode,
+                            errorDetails: evalResp.errorDetails,
+                            reason: core.StandardResolutionReasons.ERROR,
+                        };
+                    }
+                    if (ofrepCore.isEvaluationSuccessResponse(evalResp) && evalResp.key) {
+                        newCache[evalResp.key] = {
+                            value: evalResp.value,
+                            flagMetadata: evalResp.metadata,
+                            reason: evalResp.reason,
+                            variant: evalResp.variant,
+                        };
+                    }
+                });
+                const listUpdatedFlags = this._getListUpdatedFlags(this._cache, newCache);
+                this._cache = newCache;
+                this._etag = (_b = response.httpResponse) === null || _b === void 0 ? void 0 : _b.headers.get('etag');
+                return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
+            }
+            catch (error) {
+                if (error instanceof ofrepCore.OFREPApiTooManyRequestsError && error.retryAfterDate !== null) {
+                    this._retryPollingAfter = error.retryAfterDate;
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * _getListUpdatedFlags is a function that will compare the old cache with the new cache and
+     * return the list of flags that have been updated / deleted / created.
+     * @param oldCache
+     * @param newCache
+     * @private
+     */
+    _getListUpdatedFlags(oldCache, newCache) {
+        const changedKeys = [];
+        const oldKeys = Object.keys(oldCache);
+        const newKeys = Object.keys(newCache);
+        // Check for added or modified keys in newCache
+        for (const key in newCache) {
+            if (oldKeys.indexOf(key) === -1 || JSON.stringify(oldCache[key]) !== JSON.stringify(newCache[key])) {
+                changedKeys.push(key);
+            }
+        }
+        // Check for removed keys in oldCache
+        for (const key in oldCache) {
+            if (newKeys.indexOf(key) === -1) {
+                changedKeys.push(key);
+            }
+        }
+        return changedKeys;
+    }
+    /**
+     * Evaluate is a function retrieving the value from a flag in the cache.
+     * @param flagKey - name of the flag to retrieve
+     * @param type - type of the flag
+     * @private
+     */
+    evaluate(flagKey, type) {
+        const resolved = this._cache[flagKey];
+        if (!resolved) {
+            throw new webSdk.FlagNotFoundError(`flag key ${flagKey} not found in cache`);
+        }
+        if (isResolutionError(resolved)) {
+            switch (resolved.errorCode) {
+                case ofrepCore.EvaluationFailureErrorCode.FlagNotFound:
+                    throw new webSdk.FlagNotFoundError(`flag key ${flagKey} not found: ${resolved.errorDetails}`);
+                case ofrepCore.EvaluationFailureErrorCode.TargetingKeyMissing:
+                    throw new core.TargetingKeyMissingError(`targeting key missing for flag key ${flagKey}: ${resolved.errorDetails}`);
+                case ofrepCore.EvaluationFailureErrorCode.InvalidContext:
+                    throw new core.InvalidContextError(`invalid context for flag key ${flagKey}: ${resolved.errorDetails}`);
+                case ofrepCore.EvaluationFailureErrorCode.ParseError:
+                    throw new core.ParseError(`parse error for flag key ${flagKey}: ${resolved.errorDetails}`);
+                case ofrepCore.EvaluationFailureErrorCode.General:
+                default:
+                    throw new webSdk.GeneralError(`general error during flag evaluation for flag key ${flagKey}: ${resolved.errorDetails}`);
+            }
+        }
+        if (typeof resolved.value !== type) {
+            throw new webSdk.TypeMismatchError(`flag key ${flagKey} is not of type ${type}`);
+        }
+        return {
+            variant: resolved.variant,
+            value: resolved.value,
+            flagMetadata: resolved.flagMetadata,
+            errorCode: resolved.errorCode,
+            errorMessage: resolved.errorMessage,
+            reason: resolved.reason,
+        };
+    }
+    /**
+     * Start polling for flag updates, it will call the bulk update function every pollInterval
+     * @private
+     */
+    startPolling() {
+        this._pollingIntervalId = setInterval(() => tslib.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            try {
+                const now = new Date();
+                if (this._retryPollingAfter !== undefined && this._retryPollingAfter > now) {
+                    return;
+                }
+                const res = yield this._evaluateFlags(this._context);
+                if (res.status === BulkEvaluationStatus.SUCCESS_WITH_CHANGES) {
+                    (_a = this.events) === null || _a === void 0 ? void 0 : _a.emit(webSdk.ClientProviderEvents.ConfigurationChanged, {
+                        message: 'Flags updated',
+                        flagsChanged: res.flags,
+                    });
+                }
+            }
+            catch (error) {
+                (_b = this.events) === null || _b === void 0 ? void 0 : _b.emit(webSdk.ClientProviderEvents.Stale, { message: `Error while polling: ${error}` });
+            }
+        }), this._pollingInterval);
+    }
+    /**
+     * Stop polling for flag updates
+     * @private
+     */
+    stopPolling() {
+        if (this._pollingIntervalId) {
+            clearInterval(this._pollingIntervalId);
+        }
+    }
+}
+
+exports.OFREPWebProvider = OFREPWebProvider;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.esm.js

@@ -0,0 +1,277 @@
+import { __awaiter } from 'tslib';
+import { OpenFeatureEventEmitter, ProviderFatalError, ClientProviderEvents, OpenFeatureError, FlagNotFoundError, GeneralError, TypeMismatchError } from '@openfeature/web-sdk';
+import { OFREPApi, OFREPApiUnauthorizedError, OFREPForbiddenError, OFREPApiTooManyRequestsError, OFREPApiFetchError, handleEvaluationError, isEvaluationFailureResponse, isEvaluationSuccessResponse, EvaluationFailureErrorCode } from '@openfeature/ofrep-core';
+import { StandardResolutionReasons, ParseError, InvalidContextError, TargetingKeyMissingError } from '@openfeature/core';
+
+function isResolutionError(response) {
+    if (!response || typeof response !== 'object') {
+        return false;
+    }
+    return 'reason' in response && 'errorCode' in response && !('value' in response);
+}
+
+var BulkEvaluationStatus;
+(function (BulkEvaluationStatus) {
+    BulkEvaluationStatus["SUCCESS_NO_CHANGES"] = "SUCCESS_NO_CHANGES";
+    BulkEvaluationStatus["SUCCESS_WITH_CHANGES"] = "SUCCESS_WITH_CHANGES";
+})(BulkEvaluationStatus || (BulkEvaluationStatus = {}));
+
+class OFREPWebProvider {
+    constructor(options, logger) {
+        var _a;
+        this.DEFAULT_POLL_INTERVAL = 30000;
+        this.metadata = {
+            name: 'OpenFeature Remote Evaluation Protocol Web Provider',
+        };
+        this.runsOn = 'client';
+        this.events = new OpenFeatureEventEmitter();
+        this._cache = {};
+        try {
+            // Cannot use URL.canParse as it is only available from Node 19.x
+            new URL(options.baseUrl);
+        }
+        catch (_b) {
+            throw new Error(`The given OFREP URL "${options.baseUrl}" is not a valid URL.`);
+        }
+        this._options = options;
+        this._logger = logger;
+        this._etag = null;
+        this._ofrepAPI = new OFREPApi(this._options.baseUrl, this._options.fetchImplementation);
+        this._pollingInterval = (_a = this._options.pollInterval) !== null && _a !== void 0 ? _a : this.DEFAULT_POLL_INTERVAL;
+    }
+    /**
+     * Initialize the provider, it will evaluate the flags and start the polling if it is not disabled.
+     * @param context - the context to use for the evaluation
+     */
+    initialize(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            try {
+                this._context = context;
+                yield this._evaluateFlags(context);
+                if (this._pollingInterval > 0) {
+                    this.startPolling();
+                }
+                (_a = this._logger) === null || _a === void 0 ? void 0 : _a.debug(`${this.metadata.name} initialized successfully`);
+            }
+            catch (error) {
+                if (error instanceof OFREPApiUnauthorizedError || error instanceof OFREPForbiddenError) {
+                    throw new ProviderFatalError('Initialization failed', error);
+                }
+                throw error;
+            }
+        });
+    }
+    resolveBooleanEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'boolean');
+    }
+    resolveStringEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'string');
+    }
+    resolveNumberEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'number');
+    }
+    resolveObjectEvaluation(flagKey) {
+        return this.evaluate(flagKey, 'object');
+    }
+    /**
+     * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
+     * and update the cache.
+     * @param oldContext - the old evaluation context
+     * @param newContext - the new evaluation context
+     */
+    onContextChange(oldContext, newContext) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            try {
+                this._context = newContext;
+                const now = new Date();
+                if (this._retryPollingAfter !== undefined && this._retryPollingAfter > now) {
+                    // we do nothing because we should not call the endpoint
+                    return;
+                }
+                yield this._evaluateFlags(newContext);
+            }
+            catch (error) {
+                if (error instanceof OFREPApiTooManyRequestsError) {
+                    (_a = this.events) === null || _a === void 0 ? void 0 : _a.emit(ClientProviderEvents.Stale, { message: `${error.name}: ${error.message}` });
+                    return;
+                }
+                if (error instanceof OpenFeatureError ||
+                    error instanceof OFREPApiFetchError ||
+                    error instanceof OFREPApiUnauthorizedError ||
+                    error instanceof OFREPForbiddenError) {
+                    (_b = this.events) === null || _b === void 0 ? void 0 : _b.emit(ClientProviderEvents.Error, { message: `${error.name}: ${error.message}` });
+                    return;
+                }
+                (_c = this.events) === null || _c === void 0 ? void 0 : _c.emit(ClientProviderEvents.Error, { message: `Unknown error: ${error}` });
+            }
+        });
+    }
+    /**
+     * onClose is called when the provider is closed, it will stop the polling if it is enabled.
+     */
+    onClose() {
+        this.stopPolling();
+        return Promise.resolve();
+    }
+    /**
+     * _evaluateFlags is a function that will call the bulk evaluate flags endpoint to get the flags values.
+     * @param context - the context to use for the evaluation
+     * @private
+     * @returns EvaluationStatus if the evaluation the API returned a 304, 200.
+     * @throws TargetingKeyMissingError if the API returned a 400 with the error code TargetingKeyMissing
+     * @throws InvalidContextError if the API returned a 400 with the error code InvalidContext
+     * @throws ParseError if the API returned a 400 with the error code ParseError
+     * @throws GeneralError if the API returned a 400 with an unknown error code
+     */
+    _evaluateFlags(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            try {
+                const evalReq = {
+                    context,
+                };
+                const options = Object.assign({ headers: new Headers({
+                        'Content-Type': 'application/json',
+                    }) }, (this._etag !== null ? { headers: { 'If-None-Match': this._etag } } : {}));
+                const response = yield this._ofrepAPI.postBulkEvaluateFlags(evalReq, options);
+                if (response.httpStatus === 304) {
+                    // nothing has changed since last time, we are doing nothing
+                    return { status: BulkEvaluationStatus.SUCCESS_NO_CHANGES, flags: [] };
+                }
+                if (response.httpStatus !== 200) {
+                    handleEvaluationError(response);
+                }
+                const bulkSuccessResp = response.value;
+                const newCache = {};
+                (_a = bulkSuccessResp.flags) === null || _a === void 0 ? void 0 : _a.forEach((evalResp) => {
+                    if (isEvaluationFailureResponse(evalResp)) {
+                        newCache[evalResp.key] = {
+                            errorCode: evalResp.errorCode,
+                            errorDetails: evalResp.errorDetails,
+                            reason: StandardResolutionReasons.ERROR,
+                        };
+                    }
+                    if (isEvaluationSuccessResponse(evalResp) && evalResp.key) {
+                        newCache[evalResp.key] = {
+                            value: evalResp.value,
+                            flagMetadata: evalResp.metadata,
+                            reason: evalResp.reason,
+                            variant: evalResp.variant,
+                        };
+                    }
+                });
+                const listUpdatedFlags = this._getListUpdatedFlags(this._cache, newCache);
+                this._cache = newCache;
+                this._etag = (_b = response.httpResponse) === null || _b === void 0 ? void 0 : _b.headers.get('etag');
+                return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
+            }
+            catch (error) {
+                if (error instanceof OFREPApiTooManyRequestsError && error.retryAfterDate !== null) {
+                    this._retryPollingAfter = error.retryAfterDate;
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * _getListUpdatedFlags is a function that will compare the old cache with the new cache and
+     * return the list of flags that have been updated / deleted / created.
+     * @param oldCache
+     * @param newCache
+     * @private
+     */
+    _getListUpdatedFlags(oldCache, newCache) {
+        const changedKeys = [];
+        const oldKeys = Object.keys(oldCache);
+        const newKeys = Object.keys(newCache);
+        // Check for added or modified keys in newCache
+        for (const key in newCache) {
+            if (oldKeys.indexOf(key) === -1 || JSON.stringify(oldCache[key]) !== JSON.stringify(newCache[key])) {
+                changedKeys.push(key);
+            }
+        }
+        // Check for removed keys in oldCache
+        for (const key in oldCache) {
+            if (newKeys.indexOf(key) === -1) {
+                changedKeys.push(key);
+            }
+        }
+        return changedKeys;
+    }
+    /**
+     * Evaluate is a function retrieving the value from a flag in the cache.
+     * @param flagKey - name of the flag to retrieve
+     * @param type - type of the flag
+     * @private
+     */
+    evaluate(flagKey, type) {
+        const resolved = this._cache[flagKey];
+        if (!resolved) {
+            throw new FlagNotFoundError(`flag key ${flagKey} not found in cache`);
+        }
+        if (isResolutionError(resolved)) {
+            switch (resolved.errorCode) {
+                case EvaluationFailureErrorCode.FlagNotFound:
+                    throw new FlagNotFoundError(`flag key ${flagKey} not found: ${resolved.errorDetails}`);
+                case EvaluationFailureErrorCode.TargetingKeyMissing:
+                    throw new TargetingKeyMissingError(`targeting key missing for flag key ${flagKey}: ${resolved.errorDetails}`);
+                case EvaluationFailureErrorCode.InvalidContext:
+                    throw new InvalidContextError(`invalid context for flag key ${flagKey}: ${resolved.errorDetails}`);
+                case EvaluationFailureErrorCode.ParseError:
+                    throw new ParseError(`parse error for flag key ${flagKey}: ${resolved.errorDetails}`);
+                case EvaluationFailureErrorCode.General:
+                default:
+                    throw new GeneralError(`general error during flag evaluation for flag key ${flagKey}: ${resolved.errorDetails}`);
+            }
+        }
+        if (typeof resolved.value !== type) {
+            throw new TypeMismatchError(`flag key ${flagKey} is not of type ${type}`);
+        }
+        return {
+            variant: resolved.variant,
+            value: resolved.value,
+            flagMetadata: resolved.flagMetadata,
+            errorCode: resolved.errorCode,
+            errorMessage: resolved.errorMessage,
+            reason: resolved.reason,
+        };
+    }
+    /**
+     * Start polling for flag updates, it will call the bulk update function every pollInterval
+     * @private
+     */
+    startPolling() {
+        this._pollingIntervalId = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            try {
+                const now = new Date();
+                if (this._retryPollingAfter !== undefined && this._retryPollingAfter > now) {
+                    return;
+                }
+                const res = yield this._evaluateFlags(this._context);
+                if (res.status === BulkEvaluationStatus.SUCCESS_WITH_CHANGES) {
+                    (_a = this.events) === null || _a === void 0 ? void 0 : _a.emit(ClientProviderEvents.ConfigurationChanged, {
+                        message: 'Flags updated',
+                        flagsChanged: res.flags,
+                    });
+                }
+            }
+            catch (error) {
+                (_b = this.events) === null || _b === void 0 ? void 0 : _b.emit(ClientProviderEvents.Stale, { message: `Error while polling: ${error}` });
+            }
+        }), this._pollingInterval);
+    }
+    /**
+     * Stop polling for flag updates
+     * @private
+     */
+    stopPolling() {
+        if (this._pollingIntervalId) {
+            clearInterval(this._pollingIntervalId);
+        }
+    }
+}
+
+export { OFREPWebProvider };

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@openfeature/ofrep-web-provider",
+  "version": "0.1.1",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "main": "./index.cjs.js",
+  "typings": "./src/index.d.ts",
+  "scripts": {
+    "publish-if-not-exists": "cp $NPM_CONFIG_USERCONFIG .npmrc && if [ \"$(npm show $npm_package_name@$npm_package_version version)\" = \"$(npm run current-version -s)\" ]; then echo 'already published, skipping'; else npm publish --access public; fi",
+    "current-version": "echo $npm_package_version"
+  },
+  "peerDependencies": {
+    "@openfeature/web-sdk": ">=0.4.0",
+    "@openfeature/ofrep-core": "^0.1.0"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    }
+  },
+  "module": "./index.esm.js"
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/ofrep-web-provider';

package/src/lib/model/evaluate-flags-response.d.ts

@@ -0,0 +1,14 @@
+export declare enum BulkEvaluationStatus {
+    SUCCESS_NO_CHANGES = "SUCCESS_NO_CHANGES",
+    SUCCESS_WITH_CHANGES = "SUCCESS_WITH_CHANGES"
+}
+export interface EvaluateFlagsResponse {
+    /**
+     * Status of the bulk evaluation.
+     */
+    status: BulkEvaluationStatus;
+    /**
+     * The List of flags changed when doing the bulk evaluation.
+     */
+    flags: string[];
+}

package/src/lib/model/in-memory-cache.d.ts

@@ -0,0 +1,8 @@
+import { FlagValue, ResolutionDetails } from '@openfeature/web-sdk';
+import { ResolutionError } from './resolution-error';
+/**
+ * inMemoryCache is a type representing the internal cache of the flags.
+ */
+export type InMemoryCache = {
+    [key: string]: ResolutionDetails<FlagValue> | ResolutionError;
+};

package/src/lib/model/ofrep-web-provider-options.d.ts

@@ -0,0 +1,11 @@
+import { OFREPProviderBaseOptions } from '@openfeature/ofrep-core';
+export type OFREPWebProviderOptions = OFREPProviderBaseOptions & {
+    /**
+     * pollInterval is the time in milliseconds to wait between we call the OFREP
+     * API to get the latest evaluation of your flags.
+     *
+     * If a negative number is provided, the provider will not poll the OFREP API.
+     * Default: 30000
+     */
+    pollInterval?: number;
+};

package/src/lib/model/resolution-error.d.ts

@@ -0,0 +1,8 @@
+import { ResolutionReason } from '@openfeature/web-sdk';
+import { EvaluationFailureErrorCode } from '@openfeature/ofrep-core';
+export type ResolutionError = {
+    reason: ResolutionReason;
+    errorCode: EvaluationFailureErrorCode;
+    errorDetails?: string;
+};
+export declare function isResolutionError(response: unknown): response is ResolutionError;

package/src/lib/ofrep-web-provider.d.ts

@@ -0,0 +1,77 @@
+import { EvaluationContext, Hook, JsonValue, Logger, OpenFeatureEventEmitter, Provider, ResolutionDetails } from '@openfeature/web-sdk';
+import { OFREPWebProviderOptions } from './model/ofrep-web-provider-options';
+export declare class OFREPWebProvider implements Provider {
+    DEFAULT_POLL_INTERVAL: number;
+    readonly metadata: {
+        name: string;
+    };
+    readonly runsOn = "client";
+    events: OpenFeatureEventEmitter;
+    hooks?: Hook[] | undefined;
+    private _logger?;
+    private _options;
+    private _ofrepAPI;
+    private _etag;
+    private _pollingInterval;
+    private _retryPollingAfter;
+    private _cache;
+    private _context;
+    private _pollingIntervalId?;
+    constructor(options: OFREPWebProviderOptions, logger?: Logger);
+    /**
+     * Initialize the provider, it will evaluate the flags and start the polling if it is not disabled.
+     * @param context - the context to use for the evaluation
+     */
+    initialize?(context?: EvaluationContext | undefined): Promise<void>;
+    resolveBooleanEvaluation(flagKey: string): ResolutionDetails<boolean>;
+    resolveStringEvaluation(flagKey: string): ResolutionDetails<string>;
+    resolveNumberEvaluation(flagKey: string): ResolutionDetails<number>;
+    resolveObjectEvaluation<T extends JsonValue>(flagKey: string): ResolutionDetails<T>;
+    /**
+     * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
+     * and update the cache.
+     * @param oldContext - the old evaluation context
+     * @param newContext - the new evaluation context
+     */
+    onContextChange(oldContext: EvaluationContext, newContext: EvaluationContext): Promise<void>;
+    /**
+     * onClose is called when the provider is closed, it will stop the polling if it is enabled.
+     */
+    onClose?(): Promise<void>;
+    /**
+     * _evaluateFlags is a function that will call the bulk evaluate flags endpoint to get the flags values.
+     * @param context - the context to use for the evaluation
+     * @private
+     * @returns EvaluationStatus if the evaluation the API returned a 304, 200.
+     * @throws TargetingKeyMissingError if the API returned a 400 with the error code TargetingKeyMissing
+     * @throws InvalidContextError if the API returned a 400 with the error code InvalidContext
+     * @throws ParseError if the API returned a 400 with the error code ParseError
+     * @throws GeneralError if the API returned a 400 with an unknown error code
+     */
+    private _evaluateFlags;
+    /**
+     * _getListUpdatedFlags is a function that will compare the old cache with the new cache and
+     * return the list of flags that have been updated / deleted / created.
+     * @param oldCache
+     * @param newCache
+     * @private
+     */
+    private _getListUpdatedFlags;
+    /**
+     * Evaluate is a function retrieving the value from a flag in the cache.
+     * @param flagKey - name of the flag to retrieve
+     * @param type - type of the flag
+     * @private
+     */
+    private evaluate;
+    /**
+     * Start polling for flag updates, it will call the bulk update function every pollInterval
+     * @private
+     */
+    private startPolling;
+    /**
+     * Stop polling for flag updates
+     * @private
+     */
+    private stopPolling;
+}

package/src/package.json

@@ -0,0 +1,3 @@
+{
+  "module": "commonjs"
+}

package/test/test-logger.d.ts

@@ -0,0 +1,10 @@
+/**
+ * TestLogger is a logger build for testing purposes.
+ * This is not ready to be production ready, so please avoid using it.
+ */
+export default class TestLogger {
+    error(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    info(...args: unknown[]): void;
+    debug(...args: unknown[]): void;
+}