@splitsoftware/openfeature-js-split-provider 1.0.3 → 1.0.5

package/CHANGES.txt

@@ -8,4 +8,7 @@
 - Up to date with spec 0.4.0 and @openfeature/js-sdk 0.4.0
 1.0.3
 - Adds types definitions for TypeScript
-- Up to date with spec 0.4.0 and @openfeature/js-sdk 0.4.0
+- Up to date with spec 0.4.0 and @openfeature/js-sdk 0.4.0
+1.0.4
+- Fixes issue with TS build
+- Up to date with spec 0.5.0 and @openfeature/js-sdk 0.5.0

package/README.md

@@ -10,13 +10,27 @@ This Provider is designed to allow the use of OpenFeature with Split, the platfo
 ## Getting started
 Below is a simple example that describes the instantiation of the Split Provider. Please see the [OpenFeature Documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api) for details on how to use the OpenFeature SDK.
 
+### Add the Split provider
+
+```sh
+npm install @splitsoftware/openfeature-js-split-provider
+```
+
+### Confirm peer dependencies are installed
+```sh
+npm install @splitsoftware/splitio
+npm install @openfeature/js-sdk
+```
+
+### Register the Split provider with OpenFeature
 ```js
 const OpenFeature = require('@openfeature/js-sdk').OpenFeature;
 const SplitFactory = require('@splitsoftware/splitio').SplitFactory;
 const OpenFeatureSplitProvider = require('@splitsoftware/openfeature-js-split-provider').OpenFeatureSplitProvider;
 
-splitClient = SplitFactory({core: {authorizationKey: 'localhost'}}).client();
-provider = new OpenFeatureSplitProvider({splitClient});
+const authorizationKey = 'your auth key'
+const splitClient = SplitFactory({core: {authorizationKey}}).client();
+const provider = new OpenFeatureSplitProvider({splitClient});
 openFeature.setProvider(provider);
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/openfeature-js-split-provider",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Split OpenFeature Provider",
   "files": [
     "README.md",
@@ -17,8 +17,6 @@
   "bugs": "https://github.com/splitio/openfeature-split-provider-js/issues",
   "license": "Apache-2.0",
   "author": "Josh Sirota <josh.sirota@split.io>",
-  "contributors": [
-  ],
   "main": "lib/index.js",
   "module": "es/index.js",
   "types": "types",
@@ -26,11 +24,14 @@
     "npm": ">=3",
     "node": ">=6"
   },
-  "dependencies": {
-    "@openfeature/js-sdk": "^0.4.0",
-    "@splitsoftware/splitio": "^10.21.1"
+  "dependencies": {},
+  "peerDependencies": {
+    "@openfeature/js-sdk": "^1.0.0",
+    "@splitsoftware/splitio": "^10.22.1"
   },
   "devDependencies": {
+    "@openfeature/js-sdk": "^1.0.0",
+    "@splitsoftware/splitio": "^10.22.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "replace": "^1.2.1",

package/src/__tests__/nodeSuites/client.spec.js

@@ -37,8 +37,8 @@ export default async function(assert) {
   const getControlVariantNonExistentSplit = async (client) => {
     let details = await client.getBooleanDetails('non-existent-feature', false);
     assert.equals(details.value, false);
-    assert.equals(details.variant, 'control');
-    assert.equals(details.reason, 'FLAG_NOT_FOUND');
+    assert.equals(details.errorCode, 'FLAG_NOT_FOUND');
+    assert.equals(details.reason, 'ERROR');
   };
 
   const getBooleanSplitTest = async (client) => {

package/src/lib/js-split-provider.ts

@@ -1,5 +1,14 @@
-import { EvaluationContext, Provider, ResolutionDetails, ParseError, FlagNotFoundError, JsonValue, OpenFeatureError, StandardResolutionReasons } from '@openfeature/js-sdk';
-import SplitIO from '@splitsoftware/splitio/types/splitio';
+import {
+  EvaluationContext,
+  Provider,
+  ResolutionDetails,
+  ParseError,
+  FlagNotFoundError,
+  JsonValue,
+  TargetingKeyMissingError,
+  StandardResolutionReasons,
+} from "@openfeature/js-sdk";
+import type SplitIO from "@splitsoftware/splitio/types/splitio";
 
 export interface SplitProviderOptions {
   splitClient: SplitIO.IClient;
@@ -10,9 +19,11 @@ type Consumer = {
   attributes: SplitIO.Attributes;
 };
 
+const CONTROL_VALUE_ERROR_MESSAGE = "Received the 'control' value from Split.";
+
 export class OpenFeatureSplitProvider implements Provider {
   metadata = {
-    name: 'split',
+    name: "split",
   };
   private initialized: Promise<void>;
   private client: SplitIO.IClient;
@@ -29,23 +40,26 @@ export class OpenFeatureSplitProvider implements Provider {
 
   async resolveBooleanEvaluation(
     flagKey: string,
-    defaultValue: boolean,
+    _: boolean,
     context: EvaluationContext
   ): Promise<ResolutionDetails<boolean>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
 
     let value: boolean;
     switch (details.value as unknown) {
-      case 'on':
+      case "on":
         value = true;
         break;
-      case 'off':
+      case "off":
         value = false;
         break;
-      case 'true':
+      case "true":
         value = true;
         break;
-      case 'false':
+      case "false":
         value = false;
         break;
       case true:
@@ -54,10 +68,8 @@ export class OpenFeatureSplitProvider implements Provider {
       case false:
         value = false;
         break;
-      case 'control':
-        value = defaultValue;
-        details.reason = 'FLAG_NOT_FOUND';
-        break;
+      case "control":
+        throw new FlagNotFoundError(CONTROL_VALUE_ERROR_MESSAGE);
       default:
         throw new ParseError(`Invalid boolean value for ${details.value}`);
     }
@@ -69,9 +81,12 @@ export class OpenFeatureSplitProvider implements Provider {
     _: string,
     context: EvaluationContext
   ): Promise<ResolutionDetails<string>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
-    if (details.value == 'control') {
-      throw new FlagNotFoundError(`Got error for split ${flagKey}`);
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
+    if (details.value === "control") {
+      throw new FlagNotFoundError(CONTROL_VALUE_ERROR_MESSAGE);
     }
     return details;
   }
@@ -81,7 +96,10 @@ export class OpenFeatureSplitProvider implements Provider {
     _: number,
     context: EvaluationContext
   ): Promise<ResolutionDetails<number>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
     return { ...details, value: this.parseValidNumber(details.value) };
   }
 
@@ -90,26 +108,32 @@ export class OpenFeatureSplitProvider implements Provider {
     _: U,
     context: EvaluationContext
   ): Promise<ResolutionDetails<U>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
     return { ...details, value: this.parseValidJsonObject(details.value) };
   }
 
-  private async evaluateTreatment(flagKey: string, consumer: Consumer): Promise<ResolutionDetails<string>> {
+  private async evaluateTreatment(
+    flagKey: string,
+    consumer: Consumer
+  ): Promise<ResolutionDetails<string>> {
     if (!consumer.key) {
-      const details: ResolutionDetails<string> = {
-        value: 'control',
-        variant: 'control',
-        reason: StandardResolutionReasons.ERROR,
-        errorCode: 'TARGETING_KEY_MISSING'
-      }
-      return details;
+      throw new TargetingKeyMissingError(
+        "The Split provider requires a targeting key."
+      );
     } else {
       await this.initialized;
-      const value = this.client.getTreatment(consumer.key, flagKey, consumer.attributes);
+      const value = this.client.getTreatment(
+        consumer.key,
+        flagKey,
+        consumer.attributes
+      );
       const details: ResolutionDetails<string> = {
         value: value,
         variant: value,
-        reason: StandardResolutionReasons.TARGETING_MATCH
+        reason: StandardResolutionReasons.TARGETING_MATCH,
       };
       return details;
     }
@@ -136,14 +160,16 @@ export class OpenFeatureSplitProvider implements Provider {
     return result;
   }
 
-  private parseValidJsonObject<T extends JsonValue>(stringValue: string | undefined): T {
+  private parseValidJsonObject<T extends JsonValue>(
+    stringValue: string | undefined
+  ): T {
     if (stringValue === undefined) {
       throw new ParseError(`Invalid 'undefined' JSON value.`);
     }
     // we may want to allow the parsing to be customized.
     try {
       const value = JSON.parse(stringValue);
-      if (typeof value !== 'object') {
+      if (typeof value !== "object") {
         throw new ParseError(
           `Flag value ${stringValue} had unexpected type ${typeof value}, expected "object"`
         );

package/es/index.js

@@ -1 +0,0 @@
-export * from './lib/js-split-provider';

package/es/lib/js-split-provider.js

@@ -1,163 +0,0 @@
-import { __assign, __awaiter, __generator, __rest } from "tslib";
-import { ParseError, FlagNotFoundError, StandardResolutionReasons } from '@openfeature/js-sdk';
-var OpenFeatureSplitProvider = /** @class */ (function () {
-    function OpenFeatureSplitProvider(options) {
-        var _this = this;
-        this.metadata = {
-            name: 'split',
-        };
-        this.client = options.splitClient;
-        this.initialized = new Promise(function (resolve) {
-            _this.client.on(_this.client.Event.SDK_READY, function () {
-                console.log(_this.metadata.name + " provider initialized");
-                resolve();
-            });
-        });
-    }
-    OpenFeatureSplitProvider.prototype.resolveBooleanEvaluation = function (flagKey, defaultValue, context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var details, value;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        switch (details.value) {
-                            case 'on':
-                                value = true;
-                                break;
-                            case 'off':
-                                value = false;
-                                break;
-                            case 'true':
-                                value = true;
-                                break;
-                            case 'false':
-                                value = false;
-                                break;
-                            case true:
-                                value = true;
-                                break;
-                            case false:
-                                value = false;
-                                break;
-                            case 'control':
-                                value = defaultValue;
-                                details.reason = 'FLAG_NOT_FOUND';
-                                break;
-                            default:
-                                throw new ParseError("Invalid boolean value for " + details.value);
-                        }
-                        return [2 /*return*/, __assign(__assign({}, details), { value: value })];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.resolveStringEvaluation = function (flagKey, _, context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var details;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        if (details.value == 'control') {
-                            throw new FlagNotFoundError("Got error for split " + flagKey);
-                        }
-                        return [2 /*return*/, details];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.resolveNumberEvaluation = function (flagKey, _, context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var details;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        return [2 /*return*/, __assign(__assign({}, details), { value: this.parseValidNumber(details.value) })];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.resolveObjectEvaluation = function (flagKey, _, context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var details;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        return [2 /*return*/, __assign(__assign({}, details), { value: this.parseValidJsonObject(details.value) })];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.evaluateTreatment = function (flagKey, consumer) {
-        return __awaiter(this, void 0, void 0, function () {
-            var details, value, details;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!!consumer.key) return [3 /*break*/, 1];
-                        details = {
-                            value: 'control',
-                            variant: 'control',
-                            reason: StandardResolutionReasons.ERROR,
-                            errorCode: 'TARGETING_KEY_MISSING'
-                        };
-                        return [2 /*return*/, details];
-                    case 1: return [4 /*yield*/, this.initialized];
-                    case 2:
-                        _a.sent();
-                        value = this.client.getTreatment(consumer.key, flagKey, consumer.attributes);
-                        details = {
-                            value: value,
-                            variant: value,
-                            reason: StandardResolutionReasons.TARGETING_MATCH
-                        };
-                        return [2 /*return*/, details];
-                }
-            });
-        });
-    };
-    //Transform the context into an object useful for the Split API, an key string with arbitrary Split "Attributes".
-    OpenFeatureSplitProvider.prototype.transformContext = function (context) {
-        var targetingKey = context.targetingKey, attributes = __rest(context, ["targetingKey"]);
-        return {
-            key: targetingKey,
-            // Stringify context objects include date.
-            attributes: JSON.parse(JSON.stringify(attributes)),
-        };
-    };
-    OpenFeatureSplitProvider.prototype.parseValidNumber = function (stringValue) {
-        if (stringValue === undefined) {
-            throw new ParseError("Invalid 'undefined' value.");
-        }
-        var result = Number.parseFloat(stringValue);
-        if (Number.isNaN(result)) {
-            throw new ParseError("Invalid numeric value " + stringValue);
-        }
-        return result;
-    };
-    OpenFeatureSplitProvider.prototype.parseValidJsonObject = function (stringValue) {
-        if (stringValue === undefined) {
-            throw new ParseError("Invalid 'undefined' JSON value.");
-        }
-        // we may want to allow the parsing to be customized.
-        try {
-            var value = JSON.parse(stringValue);
-            if (typeof value !== 'object') {
-                throw new ParseError("Flag value " + stringValue + " had unexpected type " + typeof value + ", expected \"object\"");
-            }
-            return value;
-        }
-        catch (err) {
-            throw new ParseError("Error parsing " + stringValue + " as JSON, " + err);
-        }
-    };
-    return OpenFeatureSplitProvider;
-}());
-export { OpenFeatureSplitProvider };

package/lib/index.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./lib/js-split-provider"), exports);

package/lib/lib/js-split-provider.js

@@ -1,166 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenFeatureSplitProvider = void 0;
-var tslib_1 = require("tslib");
-var js_sdk_1 = require("@openfeature/js-sdk");
-var OpenFeatureSplitProvider = /** @class */ (function () {
-    function OpenFeatureSplitProvider(options) {
-        var _this = this;
-        this.metadata = {
-            name: 'split',
-        };
-        this.client = options.splitClient;
-        this.initialized = new Promise(function (resolve) {
-            _this.client.on(_this.client.Event.SDK_READY, function () {
-                console.log(_this.metadata.name + " provider initialized");
-                resolve();
-            });
-        });
-    }
-    OpenFeatureSplitProvider.prototype.resolveBooleanEvaluation = function (flagKey, defaultValue, context) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var details, value;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        switch (details.value) {
-                            case 'on':
-                                value = true;
-                                break;
-                            case 'off':
-                                value = false;
-                                break;
-                            case 'true':
-                                value = true;
-                                break;
-                            case 'false':
-                                value = false;
-                                break;
-                            case true:
-                                value = true;
-                                break;
-                            case false:
-                                value = false;
-                                break;
-                            case 'control':
-                                value = defaultValue;
-                                details.reason = 'FLAG_NOT_FOUND';
-                                break;
-                            default:
-                                throw new js_sdk_1.ParseError("Invalid boolean value for " + details.value);
-                        }
-                        return [2 /*return*/, (0, tslib_1.__assign)((0, tslib_1.__assign)({}, details), { value: value })];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.resolveStringEvaluation = function (flagKey, _, context) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var details;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        if (details.value == 'control') {
-                            throw new js_sdk_1.FlagNotFoundError("Got error for split " + flagKey);
-                        }
-                        return [2 /*return*/, details];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.resolveNumberEvaluation = function (flagKey, _, context) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var details;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        return [2 /*return*/, (0, tslib_1.__assign)((0, tslib_1.__assign)({}, details), { value: this.parseValidNumber(details.value) })];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.resolveObjectEvaluation = function (flagKey, _, context) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var details;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.evaluateTreatment(flagKey, this.transformContext(context))];
-                    case 1:
-                        details = _a.sent();
-                        return [2 /*return*/, (0, tslib_1.__assign)((0, tslib_1.__assign)({}, details), { value: this.parseValidJsonObject(details.value) })];
-                }
-            });
-        });
-    };
-    OpenFeatureSplitProvider.prototype.evaluateTreatment = function (flagKey, consumer) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
-            var details, value, details;
-            return (0, tslib_1.__generator)(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!!consumer.key) return [3 /*break*/, 1];
-                        details = {
-                            value: 'control',
-                            variant: 'control',
-                            reason: js_sdk_1.StandardResolutionReasons.ERROR,
-                            errorCode: 'TARGETING_KEY_MISSING'
-                        };
-                        return [2 /*return*/, details];
-                    case 1: return [4 /*yield*/, this.initialized];
-                    case 2:
-                        _a.sent();
-                        value = this.client.getTreatment(consumer.key, flagKey, consumer.attributes);
-                        details = {
-                            value: value,
-                            variant: value,
-                            reason: js_sdk_1.StandardResolutionReasons.TARGETING_MATCH
-                        };
-                        return [2 /*return*/, details];
-                }
-            });
-        });
-    };
-    //Transform the context into an object useful for the Split API, an key string with arbitrary Split "Attributes".
-    OpenFeatureSplitProvider.prototype.transformContext = function (context) {
-        var targetingKey = context.targetingKey, attributes = (0, tslib_1.__rest)(context, ["targetingKey"]);
-        return {
-            key: targetingKey,
-            // Stringify context objects include date.
-            attributes: JSON.parse(JSON.stringify(attributes)),
-        };
-    };
-    OpenFeatureSplitProvider.prototype.parseValidNumber = function (stringValue) {
-        if (stringValue === undefined) {
-            throw new js_sdk_1.ParseError("Invalid 'undefined' value.");
-        }
-        var result = Number.parseFloat(stringValue);
-        if (Number.isNaN(result)) {
-            throw new js_sdk_1.ParseError("Invalid numeric value " + stringValue);
-        }
-        return result;
-    };
-    OpenFeatureSplitProvider.prototype.parseValidJsonObject = function (stringValue) {
-        if (stringValue === undefined) {
-            throw new js_sdk_1.ParseError("Invalid 'undefined' JSON value.");
-        }
-        // we may want to allow the parsing to be customized.
-        try {
-            var value = JSON.parse(stringValue);
-            if (typeof value !== 'object') {
-                throw new js_sdk_1.ParseError("Flag value " + stringValue + " had unexpected type " + typeof value + ", expected \"object\"");
-            }
-            return value;
-        }
-        catch (err) {
-            throw new js_sdk_1.ParseError("Error parsing " + stringValue + " as JSON, " + err);
-        }
-    };
-    return OpenFeatureSplitProvider;
-}());
-exports.OpenFeatureSplitProvider = OpenFeatureSplitProvider;

package/types/index.d.ts

@@ -1,17 +0,0 @@
-// Declaration file for Javascript and Node OpenFeature Split Provider
-// Project: http://www.split.io/
-
-import { Provider } from "@openfeature/js-sdk";
-
-export = SplitProvider;
-
-declare module SplitProvider {
-  export interface SplitProviderOptions {
-    splitClient: SplitIO.IClient;
-  }  
-
-  /**
-   * OpenFeature Split Provider constructor.
-   */
-  export function OpenFeatureSplitProvider(options: SplitProviderOptions): Provider;
-}