@openfeature/ofrep-web-provider 0.3.3 → 0.3.5

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright OpenFeature Maintainers
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/index.cjs.js

@@ -41,23 +41,6 @@ var BulkEvaluationStatus;
     BulkEvaluationStatus["SUCCESS_WITH_CHANGES"] = "SUCCESS_WITH_CHANGES";
 })(BulkEvaluationStatus || (BulkEvaluationStatus = {}));
 
-function isResolutionError(response) {
-    if (!response || typeof response !== 'object') {
-        return false;
-    }
-    return 'reason' in response && 'errorCode' in response && !('value' in response);
-}
-
-const ErrorMessageMap = {
-    [webSdk.ErrorCode.FLAG_NOT_FOUND]: 'Flag was not found',
-    [webSdk.ErrorCode.GENERAL]: 'General error',
-    [webSdk.ErrorCode.INVALID_CONTEXT]: 'Context is invalid or could be parsed',
-    [webSdk.ErrorCode.PARSE_ERROR]: 'Flag or flag configuration could not be parsed',
-    [webSdk.ErrorCode.PROVIDER_FATAL]: 'Provider is in a fatal error state',
-    [webSdk.ErrorCode.PROVIDER_NOT_READY]: 'Provider is not yet ready',
-    [webSdk.ErrorCode.TARGETING_KEY_MISSING]: 'Targeting key is missing',
-    [webSdk.ErrorCode.TYPE_MISMATCH]: 'Flag is not of expected type',
-};
 class OFREPWebProvider {
     constructor(options, logger) {
         var _a;
@@ -68,7 +51,6 @@ class OFREPWebProvider {
         this.runsOn = 'client';
         this.events = new webSdk.OpenFeatureEventEmitter();
         this._flagCache = {};
-        this._flagSetMetadataCache = {};
         this._options = options;
         this._logger = logger;
         this._etag = null;
@@ -107,16 +89,16 @@ class OFREPWebProvider {
     /* eslint-disable @typescript-eslint/no-unused-vars*/
     /* to make overrides easier we keep these unused vars */
     resolveBooleanEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'boolean', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     resolveStringEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'string', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     resolveNumberEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'number', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     resolveObjectEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'object', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     /**
      * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
@@ -185,35 +167,20 @@ class OFREPWebProvider {
                     throw new webSdk.GeneralError(`Failed OFREP bulk evaluation request, status: ${response.httpStatus}`);
                 }
                 const bulkSuccessResp = response.value;
-                const newCache = {};
-                if ('flags' in bulkSuccessResp && Array.isArray(bulkSuccessResp.flags)) {
-                    bulkSuccessResp.flags.forEach((evalResp) => {
-                        if (ofrepCore.isEvaluationFailureResponse(evalResp)) {
-                            newCache[evalResp.key] = {
-                                reason: webSdk.StandardResolutionReasons.ERROR,
-                                flagMetadata: evalResp.metadata,
-                                errorCode: evalResp.errorCode,
-                                errorDetails: evalResp.errorDetails,
-                            };
-                        }
-                        if (ofrepCore.isEvaluationSuccessResponse(evalResp) && evalResp.key) {
-                            newCache[evalResp.key] = {
-                                value: evalResp.value,
-                                variant: evalResp.variant,
-                                reason: evalResp.reason,
-                                flagMetadata: evalResp.metadata,
-                            };
-                        }
-                    });
-                    const listUpdatedFlags = this._getListUpdatedFlags(this._flagCache, newCache);
-                    this._flagCache = newCache;
-                    this._etag = (_a = response.httpResponse) === null || _a === void 0 ? void 0 : _a.headers.get('etag');
-                    this._flagSetMetadataCache = typeof bulkSuccessResp.metadata === 'object' ? bulkSuccessResp.metadata : {};
-                    return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
-                }
-                else {
+                if (!('flags' in bulkSuccessResp) || !Array.isArray(bulkSuccessResp.flags)) {
                     throw new Error('No flags in OFREP bulk evaluation response');
                 }
+                const newCache = bulkSuccessResp.flags.reduce((currentCache, currentResponse) => {
+                    if (currentResponse.key) {
+                        currentCache[currentResponse.key] = currentResponse;
+                    }
+                    return currentCache;
+                }, {});
+                const listUpdatedFlags = this._getListUpdatedFlags(this._flagCache, newCache);
+                this._flagCache = newCache;
+                this._etag = (_a = response.httpResponse) === null || _a === void 0 ? void 0 : _a.headers.get('etag');
+                this._flagSetMetadataCache = ofrepCore.toFlagMetadata(typeof bulkSuccessResp.metadata === 'object' ? bulkSuccessResp.metadata : {});
+                return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
             }
             catch (error) {
                 if (error instanceof ofrepCore.OFREPApiTooManyRequestsError && error.retryAfterDate !== null) {
@@ -255,7 +222,7 @@ class OFREPWebProvider {
      * @param defaultValue - default value
      * @private
      */
-    _resolve(flagKey, type, defaultValue) {
+    _resolve(flagKey, defaultValue) {
         const resolved = this._flagCache[flagKey];
         if (!resolved) {
             return {
@@ -263,29 +230,16 @@ class OFREPWebProvider {
                 flagMetadata: this._flagSetMetadataCache,
                 reason: webSdk.StandardResolutionReasons.ERROR,
                 errorCode: webSdk.ErrorCode.FLAG_NOT_FOUND,
-                errorMessage: ErrorMessageMap[webSdk.ErrorCode.FLAG_NOT_FOUND],
+                errorMessage: ofrepCore.ErrorMessageMap[webSdk.ErrorCode.FLAG_NOT_FOUND],
             };
         }
-        if (isResolutionError(resolved)) {
-            return Object.assign(Object.assign({}, resolved), { value: defaultValue, errorMessage: ErrorMessageMap[resolved.errorCode] });
-        }
-        if (typeof resolved.value !== type) {
-            return {
-                value: defaultValue,
-                flagMetadata: resolved.flagMetadata,
-                reason: webSdk.StandardResolutionReasons.ERROR,
-                errorCode: webSdk.ErrorCode.TYPE_MISMATCH,
-                errorMessage: ErrorMessageMap[webSdk.ErrorCode.TYPE_MISMATCH],
-            };
+        return this.responseToResolutionDetails(resolved, defaultValue);
+    }
+    responseToResolutionDetails(response, defaultValue) {
+        if (ofrepCore.isEvaluationFailureResponse(response)) {
+            return ofrepCore.handleEvaluationError(response, defaultValue);
         }
-        return {
-            variant: resolved.variant,
-            value: resolved.value,
-            flagMetadata: resolved.flagMetadata,
-            errorCode: resolved.errorCode,
-            errorMessage: resolved.errorMessage,
-            reason: resolved.reason,
-        };
+        return ofrepCore.toResolutionDetails(response, defaultValue);
     }
     /**
      * Start polling for flag updates, it will call the bulk update function every pollInterval

package/index.esm.js

@@ -1,5 +1,5 @@
-import { OFREPApi, OFREPApiUnauthorizedError, OFREPForbiddenError, OFREPApiTooManyRequestsError, OFREPApiFetchError, isEvaluationFailureResponse, isEvaluationSuccessResponse } from '@openfeature/ofrep-core';
-import { ErrorCode, OpenFeatureEventEmitter, StandardResolutionReasons, ProviderFatalError, ClientProviderEvents, OpenFeatureError, GeneralError } from '@openfeature/web-sdk';
+import { OFREPApi, ErrorMessageMap, isEvaluationFailureResponse, handleEvaluationError, toResolutionDetails, OFREPApiUnauthorizedError, OFREPForbiddenError, OFREPApiTooManyRequestsError, OFREPApiFetchError, toFlagMetadata } from '@openfeature/ofrep-core';
+import { OpenFeatureEventEmitter, ErrorCode, StandardResolutionReasons, ProviderFatalError, ClientProviderEvents, OpenFeatureError, GeneralError } from '@openfeature/web-sdk';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -39,23 +39,6 @@ var BulkEvaluationStatus;
     BulkEvaluationStatus["SUCCESS_WITH_CHANGES"] = "SUCCESS_WITH_CHANGES";
 })(BulkEvaluationStatus || (BulkEvaluationStatus = {}));
 
-function isResolutionError(response) {
-    if (!response || typeof response !== 'object') {
-        return false;
-    }
-    return 'reason' in response && 'errorCode' in response && !('value' in response);
-}
-
-const ErrorMessageMap = {
-    [ErrorCode.FLAG_NOT_FOUND]: 'Flag was not found',
-    [ErrorCode.GENERAL]: 'General error',
-    [ErrorCode.INVALID_CONTEXT]: 'Context is invalid or could be parsed',
-    [ErrorCode.PARSE_ERROR]: 'Flag or flag configuration could not be parsed',
-    [ErrorCode.PROVIDER_FATAL]: 'Provider is in a fatal error state',
-    [ErrorCode.PROVIDER_NOT_READY]: 'Provider is not yet ready',
-    [ErrorCode.TARGETING_KEY_MISSING]: 'Targeting key is missing',
-    [ErrorCode.TYPE_MISMATCH]: 'Flag is not of expected type',
-};
 class OFREPWebProvider {
     constructor(options, logger) {
         var _a;
@@ -66,7 +49,6 @@ class OFREPWebProvider {
         this.runsOn = 'client';
         this.events = new OpenFeatureEventEmitter();
         this._flagCache = {};
-        this._flagSetMetadataCache = {};
         this._options = options;
         this._logger = logger;
         this._etag = null;
@@ -105,16 +87,16 @@ class OFREPWebProvider {
     /* eslint-disable @typescript-eslint/no-unused-vars*/
     /* to make overrides easier we keep these unused vars */
     resolveBooleanEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'boolean', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     resolveStringEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'string', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     resolveNumberEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'number', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     resolveObjectEvaluation(flagKey, defaultValue, context) {
-        return this._resolve(flagKey, 'object', defaultValue);
+        return this._resolve(flagKey, defaultValue);
     }
     /**
      * onContextChange is called when the context changes, it will re-evaluate the flags with the new context
@@ -183,35 +165,20 @@ class OFREPWebProvider {
                     throw new GeneralError(`Failed OFREP bulk evaluation request, status: ${response.httpStatus}`);
                 }
                 const bulkSuccessResp = response.value;
-                const newCache = {};
-                if ('flags' in bulkSuccessResp && Array.isArray(bulkSuccessResp.flags)) {
-                    bulkSuccessResp.flags.forEach((evalResp) => {
-                        if (isEvaluationFailureResponse(evalResp)) {
-                            newCache[evalResp.key] = {
-                                reason: StandardResolutionReasons.ERROR,
-                                flagMetadata: evalResp.metadata,
-                                errorCode: evalResp.errorCode,
-                                errorDetails: evalResp.errorDetails,
-                            };
-                        }
-                        if (isEvaluationSuccessResponse(evalResp) && evalResp.key) {
-                            newCache[evalResp.key] = {
-                                value: evalResp.value,
-                                variant: evalResp.variant,
-                                reason: evalResp.reason,
-                                flagMetadata: evalResp.metadata,
-                            };
-                        }
-                    });
-                    const listUpdatedFlags = this._getListUpdatedFlags(this._flagCache, newCache);
-                    this._flagCache = newCache;
-                    this._etag = (_a = response.httpResponse) === null || _a === void 0 ? void 0 : _a.headers.get('etag');
-                    this._flagSetMetadataCache = typeof bulkSuccessResp.metadata === 'object' ? bulkSuccessResp.metadata : {};
-                    return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
-                }
-                else {
+                if (!('flags' in bulkSuccessResp) || !Array.isArray(bulkSuccessResp.flags)) {
                     throw new Error('No flags in OFREP bulk evaluation response');
                 }
+                const newCache = bulkSuccessResp.flags.reduce((currentCache, currentResponse) => {
+                    if (currentResponse.key) {
+                        currentCache[currentResponse.key] = currentResponse;
+                    }
+                    return currentCache;
+                }, {});
+                const listUpdatedFlags = this._getListUpdatedFlags(this._flagCache, newCache);
+                this._flagCache = newCache;
+                this._etag = (_a = response.httpResponse) === null || _a === void 0 ? void 0 : _a.headers.get('etag');
+                this._flagSetMetadataCache = toFlagMetadata(typeof bulkSuccessResp.metadata === 'object' ? bulkSuccessResp.metadata : {});
+                return { status: BulkEvaluationStatus.SUCCESS_WITH_CHANGES, flags: listUpdatedFlags };
             }
             catch (error) {
                 if (error instanceof OFREPApiTooManyRequestsError && error.retryAfterDate !== null) {
@@ -253,7 +220,7 @@ class OFREPWebProvider {
      * @param defaultValue - default value
      * @private
      */
-    _resolve(flagKey, type, defaultValue) {
+    _resolve(flagKey, defaultValue) {
         const resolved = this._flagCache[flagKey];
         if (!resolved) {
             return {
@@ -264,26 +231,13 @@ class OFREPWebProvider {
                 errorMessage: ErrorMessageMap[ErrorCode.FLAG_NOT_FOUND],
             };
         }
-        if (isResolutionError(resolved)) {
-            return Object.assign(Object.assign({}, resolved), { value: defaultValue, errorMessage: ErrorMessageMap[resolved.errorCode] });
-        }
-        if (typeof resolved.value !== type) {
-            return {
-                value: defaultValue,
-                flagMetadata: resolved.flagMetadata,
-                reason: StandardResolutionReasons.ERROR,
-                errorCode: ErrorCode.TYPE_MISMATCH,
-                errorMessage: ErrorMessageMap[ErrorCode.TYPE_MISMATCH],
-            };
+        return this.responseToResolutionDetails(resolved, defaultValue);
+    }
+    responseToResolutionDetails(response, defaultValue) {
+        if (isEvaluationFailureResponse(response)) {
+            return handleEvaluationError(response, defaultValue);
         }
-        return {
-            variant: resolved.variant,
-            value: resolved.value,
-            flagMetadata: resolved.flagMetadata,
-            errorCode: resolved.errorCode,
-            errorMessage: resolved.errorMessage,
-            reason: resolved.reason,
-        };
+        return toResolutionDetails(response, defaultValue);
     }
     /**
      * Start polling for flag updates, it will call the bulk update function every pollInterval

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/ofrep-web-provider",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "license": "Apache-2.0",
   "main": "./index.cjs.js",
   "typings": "./src/index.d.ts",
@@ -12,7 +12,7 @@
     "@openfeature/web-sdk": "^1.4.0"
   },
   "dependencies": {
-    "@openfeature/ofrep-core": "^1.0.0"
+    "@openfeature/ofrep-core": "^2.0.0"
   },
   "exports": {
     "./package.json": "./package.json",

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

@@ -1,10 +1,10 @@
-import type { FlagMetadata, FlagValue, ResolutionDetails } from '@openfeature/web-sdk';
-import type { ResolutionError } from './resolution-error';
+import type { FlagMetadata } from '@openfeature/web-sdk';
+import type { EvaluationResponse } from '@openfeature/ofrep-core';
 /**
  * Cache of flag values from bulk evaluation.
  */
 export type FlagCache = {
-    [key: string]: ResolutionDetails<FlagValue> | ResolutionError;
+    [key: string]: EvaluationResponse;
 };
 /**
  * Cache of metadata from bulk evaluation.

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

@@ -17,7 +17,7 @@ export declare class OFREPWebProvider implements Provider {
     private _pollingInterval;
     private _retryPollingAfter;
     private _flagCache;
-    private _flagSetMetadataCache;
+    private _flagSetMetadataCache?;
     private _context;
     private _pollingIntervalId?;
     constructor(options: OFREPWebProviderOptions, logger?: Logger);
@@ -72,6 +72,7 @@ export declare class OFREPWebProvider implements Provider {
      * @private
      */
     private _resolve;
+    private responseToResolutionDetails;
     /**
      * Start polling for flag updates, it will call the bulk update function every pollInterval
      * @private