@openfeature/ofrep-web-provider 0.1.5 → 0.3.0

package/index.cjs.js

@@ -3,9 +3,15 @@
 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');
+var ofrepCore = require('@openfeature/ofrep-core');
+var webSdk = require('@openfeature/web-sdk');
+
+var BulkEvaluationStatus;
+(function (BulkEvaluationStatus) {
+    BulkEvaluationStatus["SUCCESS_NO_CHANGES"] = "SUCCESS_NO_CHANGES";
+    BulkEvaluationStatus["SUCCESS_WITH_CHANGES"] = "SUCCESS_WITH_CHANGES";
+})(BulkEvaluationStatus || (BulkEvaluationStatus = {}));
 
 function isResolutionError(response) {
     if (!response || typeof response !== 'object') {
@@ -14,12 +20,6 @@ function isResolutionError(response) {
     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;
@@ -29,13 +29,19 @@ class OFREPWebProvider {
         };
         this.runsOn = 'client';
         this.events = new webSdk.OpenFeatureEventEmitter();
-        this._cache = {};
+        this._flagCache = {};
         this._options = options;
         this._logger = logger;
         this._etag = null;
-        this._ofrepAPI = new ofrepCore.OFREPApi(this._options.baseUrl, this._options.fetchImplementation);
+        this._ofrepAPI = new ofrepCore.OFREPApi(this._options, this._options.fetchImplementation);
         this._pollingInterval = (_a = this._options.pollInterval) !== null && _a !== void 0 ? _a : this.DEFAULT_POLL_INTERVAL;
     }
+    /**
+     * Returns a shallow copy of the flag cache, which is updated at initialization/context-change/configuration-change once the flags are re-evaluated.
+     */
+    get flagCache() {
+        return Object.assign({}, this._flagCache);
+    }
     /**
      * 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
@@ -59,18 +65,21 @@ class OFREPWebProvider {
             }
         });
     }
-    resolveBooleanEvaluation(flagKey) {
+    /* eslint-disable @typescript-eslint/no-unused-vars*/
+    /* to make overrides easier we keep these unused vars */
+    resolveBooleanEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'boolean');
     }
-    resolveStringEvaluation(flagKey) {
+    resolveStringEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'string');
     }
-    resolveNumberEvaluation(flagKey) {
+    resolveNumberEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'number');
     }
-    resolveObjectEvaluation(flagKey) {
+    resolveObjectEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'object');
     }
+    /* eslint-enable @typescript-eslint/no-unused-vars */
     /**
      * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
      * and update the cache.
@@ -129,10 +138,7 @@ class OFREPWebProvider {
                 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);
+                const response = yield this._ofrepAPI.postBulkEvaluateFlags(evalReq, this._etag);
                 if (response.httpStatus === 304) {
                     // nothing has changed since last time, we are doing nothing
                     return { status: BulkEvaluationStatus.SUCCESS_NO_CHANGES, flags: [] };
@@ -159,8 +165,8 @@ class OFREPWebProvider {
                         };
                     }
                 });
-                const listUpdatedFlags = this._getListUpdatedFlags(this._cache, newCache);
-                this._cache = newCache;
+                const listUpdatedFlags = this._getListUpdatedFlags(this._flagCache, newCache);
+                this._flagCache = newCache;
                 this._etag = (_b = response.httpResponse) === null || _b === void 0 ? void 0 : _b.headers.get('etag');
                 return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
             }
@@ -204,7 +210,7 @@ class OFREPWebProvider {
      * @private
      */
     evaluate(flagKey, type) {
-        const resolved = this._cache[flagKey];
+        const resolved = this._flagCache[flagKey];
         if (!resolved) {
             throw new webSdk.FlagNotFoundError(`flag key ${flagKey} not found in cache`);
         }

package/index.esm.js

@@ -1,7 +1,13 @@
 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';
+import { OFREPApi, OFREPApiUnauthorizedError, OFREPForbiddenError, OFREPApiTooManyRequestsError, OFREPApiFetchError, handleEvaluationError, isEvaluationFailureResponse, isEvaluationSuccessResponse, EvaluationFailureErrorCode } from '@openfeature/ofrep-core';
+import { OpenFeatureEventEmitter, ProviderFatalError, ClientProviderEvents, OpenFeatureError, FlagNotFoundError, GeneralError, TypeMismatchError } from '@openfeature/web-sdk';
+
+var BulkEvaluationStatus;
+(function (BulkEvaluationStatus) {
+    BulkEvaluationStatus["SUCCESS_NO_CHANGES"] = "SUCCESS_NO_CHANGES";
+    BulkEvaluationStatus["SUCCESS_WITH_CHANGES"] = "SUCCESS_WITH_CHANGES";
+})(BulkEvaluationStatus || (BulkEvaluationStatus = {}));
 
 function isResolutionError(response) {
     if (!response || typeof response !== 'object') {
@@ -10,12 +16,6 @@ function isResolutionError(response) {
     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;
@@ -25,13 +25,19 @@ class OFREPWebProvider {
         };
         this.runsOn = 'client';
         this.events = new OpenFeatureEventEmitter();
-        this._cache = {};
+        this._flagCache = {};
         this._options = options;
         this._logger = logger;
         this._etag = null;
-        this._ofrepAPI = new OFREPApi(this._options.baseUrl, this._options.fetchImplementation);
+        this._ofrepAPI = new OFREPApi(this._options, this._options.fetchImplementation);
         this._pollingInterval = (_a = this._options.pollInterval) !== null && _a !== void 0 ? _a : this.DEFAULT_POLL_INTERVAL;
     }
+    /**
+     * Returns a shallow copy of the flag cache, which is updated at initialization/context-change/configuration-change once the flags are re-evaluated.
+     */
+    get flagCache() {
+        return Object.assign({}, this._flagCache);
+    }
     /**
      * 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
@@ -55,18 +61,21 @@ class OFREPWebProvider {
             }
         });
     }
-    resolveBooleanEvaluation(flagKey) {
+    /* eslint-disable @typescript-eslint/no-unused-vars*/
+    /* to make overrides easier we keep these unused vars */
+    resolveBooleanEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'boolean');
     }
-    resolveStringEvaluation(flagKey) {
+    resolveStringEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'string');
     }
-    resolveNumberEvaluation(flagKey) {
+    resolveNumberEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'number');
     }
-    resolveObjectEvaluation(flagKey) {
+    resolveObjectEvaluation(flagKey, defaultValue, context) {
         return this.evaluate(flagKey, 'object');
     }
+    /* eslint-enable @typescript-eslint/no-unused-vars */
     /**
      * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
      * and update the cache.
@@ -125,10 +134,7 @@ class OFREPWebProvider {
                 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);
+                const response = yield this._ofrepAPI.postBulkEvaluateFlags(evalReq, this._etag);
                 if (response.httpStatus === 304) {
                     // nothing has changed since last time, we are doing nothing
                     return { status: BulkEvaluationStatus.SUCCESS_NO_CHANGES, flags: [] };
@@ -155,8 +161,8 @@ class OFREPWebProvider {
                         };
                     }
                 });
-                const listUpdatedFlags = this._getListUpdatedFlags(this._cache, newCache);
-                this._cache = newCache;
+                const listUpdatedFlags = this._getListUpdatedFlags(this._flagCache, newCache);
+                this._flagCache = newCache;
                 this._etag = (_b = response.httpResponse) === null || _b === void 0 ? void 0 : _b.headers.get('etag');
                 return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
             }
@@ -200,7 +206,7 @@ class OFREPWebProvider {
      * @private
      */
     evaluate(flagKey, type) {
-        const resolved = this._cache[flagKey];
+        const resolved = this._flagCache[flagKey];
         if (!resolved) {
             throw new FlagNotFoundError(`flag key ${flagKey} not found in cache`);
         }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@openfeature/ofrep-web-provider",
-  "version": "0.1.5",
+  "version": "0.3.0",
   "dependencies": {
-    "tslib": "^2.3.0"
+    "tslib": "^2.3.0",
+    "@openfeature/ofrep-core": "0.2.0"
   },
   "main": "./index.cjs.js",
   "typings": "./src/index.d.ts",
@@ -11,8 +12,7 @@
     "current-version": "echo $npm_package_version"
   },
   "peerDependencies": {
-    "@openfeature/web-sdk": ">=0.4.0",
-    "@openfeature/ofrep-core": "^0.1.5"
+    "@openfeature/web-sdk": ">=0.4.0"
   },
   "exports": {
     "./package.json": "./package.json",

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

@@ -1,8 +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.
+ * FlagCache is a type representing the internal cache of the flags.
  */
-export type InMemoryCache = {
+export type FlagCache = {
     [key: string]: ResolutionDetails<FlagValue> | ResolutionError;
 };

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

@@ -1,4 +1,5 @@
 import { EvaluationContext, Hook, JsonValue, Logger, OpenFeatureEventEmitter, Provider, ResolutionDetails } from '@openfeature/web-sdk';
+import { FlagCache } from './model/in-memory-cache';
 import { OFREPWebProviderOptions } from './model/ofrep-web-provider-options';
 export declare class OFREPWebProvider implements Provider {
     DEFAULT_POLL_INTERVAL: number;
@@ -6,27 +7,31 @@ export declare class OFREPWebProvider implements Provider {
         name: string;
     };
     readonly runsOn = "client";
-    events: OpenFeatureEventEmitter;
-    hooks?: Hook[] | undefined;
+    readonly events: OpenFeatureEventEmitter;
+    readonly hooks?: Hook[] | undefined;
     private _logger?;
     private _options;
     private _ofrepAPI;
     private _etag;
     private _pollingInterval;
     private _retryPollingAfter;
-    private _cache;
+    private _flagCache;
     private _context;
     private _pollingIntervalId?;
     constructor(options: OFREPWebProviderOptions, logger?: Logger);
+    /**
+     * Returns a shallow copy of the flag cache, which is updated at initialization/context-change/configuration-change once the flags are re-evaluated.
+     */
+    get flagCache(): FlagCache;
     /**
      * 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>;
+    initialize(context?: EvaluationContext | undefined): Promise<void>;
+    resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext): ResolutionDetails<boolean>;
+    resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext): ResolutionDetails<string>;
+    resolveNumberEvaluation(flagKey: string, defaultValue: number, context: EvaluationContext): ResolutionDetails<number>;
+    resolveObjectEvaluation<T extends JsonValue>(flagKey: string, defaultValue: T, context: EvaluationContext): ResolutionDetails<T>;
     /**
      * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
      * and update the cache.