@alanszp/split 7.8.0

package/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+*.log
+dist

package/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+src
+*.log

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["alanszp"]
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alan Szpigiel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/client/index.d.ts

@@ -0,0 +1,17 @@
+import { ILogger } from "@alanszp/logger";
+export interface SplitClientConstructor {
+    apiKey: string;
+    logger: ILogger;
+    timeout: number;
+    debug: boolean;
+}
+export declare class BaseSplitClient {
+    protected static client: SplitIO.IClient;
+    protected static logger: ILogger;
+    protected promiseConstruction: Promise<boolean>;
+    constructor({ apiKey, logger, timeout, debug, }: SplitClientConstructor);
+    hasLoaded(): Promise<boolean>;
+    getTreatment(key: string, splitName: string, attributes?: {}): string;
+    getBooleanTreatment(key: string, splitName: string, attributes?: {}): boolean;
+    destroy(): Promise<void>;
+}

package/dist/client/index.js

@@ -0,0 +1,70 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseSplitClient = void 0;
+const splitio_1 = require("@splitsoftware/splitio");
+const ON = "on";
+const CONTROL = "control";
+const TIMEOUT_ERROR = 6000;
+class BaseSplitClient {
+    constructor({ apiKey, logger, timeout = TIMEOUT_ERROR, debug = false, }) {
+        BaseSplitClient.logger = logger;
+        const factory = (0, splitio_1.SplitFactory)({
+            core: {
+                authorizationKey: apiKey,
+            },
+            scheduler: {
+                impressionsRefreshRate: 1,
+                eventsPushRate: 2,
+            },
+            debug,
+        });
+        BaseSplitClient.client = factory.client();
+        this.promiseConstruction = Promise.race([
+            new Promise((resolve) => {
+                BaseSplitClient.client.on(BaseSplitClient.client.Event.SDK_READY, () => {
+                    BaseSplitClient.logger.info("split_io_client.created.succeed");
+                    resolve(true);
+                });
+            }),
+            new Promise((resolve) => {
+                setTimeout(() => {
+                    resolve(false);
+                }, timeout);
+            }),
+        ]);
+    }
+    hasLoaded() {
+        return this.promiseConstruction;
+    }
+    getTreatment(key, splitName, attributes = {}) {
+        const treatment = BaseSplitClient.client.getTreatment(key, splitName, attributes);
+        if (treatment === CONTROL) {
+            BaseSplitClient.logger.warn("split_io_client.created.sdk_return_control", {
+                key,
+                splitName,
+                attributes,
+            });
+        }
+        return treatment;
+    }
+    getBooleanTreatment(key, splitName, attributes = {}) {
+        const treatment = this.getTreatment(key, splitName, attributes);
+        return treatment === ON;
+    }
+    destroy() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield BaseSplitClient.client.destroy();
+        });
+    }
+}
+exports.BaseSplitClient = BaseSplitClient;
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,oDAAsD;AAEtD,MAAM,EAAE,GAAG,IAAI,CAAC;AAChB,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,aAAa,GAAG,IAAI,CAAC;AAS3B,MAAa,eAAe;IAO1B,YAAY,EACV,MAAM,EACN,MAAM,EACN,OAAO,GAAG,aAAa,EACvB,KAAK,GAAG,KAAK,GACU;QACvB,eAAe,CAAC,MAAM,GAAG,MAAM,CAAC;QAEhC,MAAM,OAAO,GAAG,IAAA,sBAAY,EAAC;YAC3B,IAAI,EAAE;gBACJ,gBAAgB,EAAE,MAAM;aACzB;YACD,SAAS,EAAE;gBACT,sBAAsB,EAAE,CAAC;gBACzB,cAAc,EAAE,CAAC;aAClB;YACD,KAAK;SACN,CAAC,CAAC;QAEH,eAAe,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;YACtC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAC5B,eAAe,CAAC,MAAM,CAAC,EAAE,CACvB,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EACtC,GAAG,EAAE;oBACH,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;oBAC/D,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC,CACF,CAAC;YACJ,CAAC,CAAC;YACF,IAAI,OAAO,CAAQ,CAAC,OAAO,EAAE,EAAE;gBAC7B,UAAU,CAAC,GAAG,EAAE;oBACd,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjB,CAAC,EAAE,OAAO,CAAC,CAAC;YACd,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAED,YAAY,CAAC,GAAW,EAAE,SAAiB,EAAE,UAAU,GAAG,EAAE;QAC1D,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,YAAY,CACnD,GAAG,EACH,SAAS,EACT,UAAU,CACX,CAAC;QAEF,IAAI,SAAS,KAAK,OAAO,EAAE;YACzB,eAAe,CAAC,MAAM,CAAC,IAAI,CACzB,4CAA4C,EAC5C;gBACE,GAAG;gBACH,SAAS;gBACT,UAAU;aACX,CACF,CAAC;SACH;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mBAAmB,CACjB,GAAW,EACX,SAAiB,EACjB,UAAU,GAAG,EAAE;QAEf,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAChE,OAAO,SAAS,KAAK,EAAE,CAAC;IAC1B,CAAC;IAEK,OAAO;;YACX,MAAM,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACzC,CAAC;KAAA;CACF;AAnFD,0CAmFC"}

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+// comment to republish
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,uBAAuB"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@alanszp/split",
+  "version": "7.8.0",
+  "description": "Alan's split client",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "license": "MIT",
+  "files": [
+    "**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "compile": "rm -rf ./dist && tsc --declaration",
+    "compile-watch": "tsc -w",
+    "build": "yarn run compile",
+    "prepack": "yarn run build",
+    "yalc-publish": "yarn run yalc publish"
+  },
+  "peerDependencies": {
+    "@alanszp/logger": "^5.0.0"
+  },
+  "devDependencies": {
+    "@alanszp/logger": "^7.0.0",
+    "@types/lodash": "^4.14.170",
+    "@types/node": "^15.12.3",
+    "ts-node": "^10.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.3.4"
+  },
+  "dependencies": {
+    "@alanszp/core": "^7.0.0",
+    "@alanszp/shared-context": "^7.0.0",
+    "@alanszp/typeorm": "^7.0.0",
+    "@splitsoftware/splitio": "^10.22.0",
+    "cuid": "^2.1.8",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "a3db8bf208ad80b94d63daee370b63ead267a410"
+}

package/src/client/index.ts

@@ -0,0 +1,98 @@
+import { ILogger } from "@alanszp/logger";
+import { SplitFactory } from "@splitsoftware/splitio";
+
+const ON = "on";
+const CONTROL = "control";
+const TIMEOUT_ERROR = 6000;
+
+export interface SplitClientConstructor {
+  apiKey: string;
+  logger: ILogger;
+  timeout: number;
+  debug: boolean;
+}
+
+export class BaseSplitClient {
+  protected static client: SplitIO.IClient;
+
+  protected static logger: ILogger;
+
+  protected promiseConstruction: Promise<boolean>;
+
+  constructor({
+    apiKey,
+    logger,
+    timeout = TIMEOUT_ERROR,
+    debug = false,
+  }: SplitClientConstructor) {
+    BaseSplitClient.logger = logger;
+
+    const factory = SplitFactory({
+      core: {
+        authorizationKey: apiKey,
+      },
+      scheduler: {
+        impressionsRefreshRate: 1,
+        eventsPushRate: 2,
+      },
+      debug,
+    });
+
+    BaseSplitClient.client = factory.client();
+
+    this.promiseConstruction = Promise.race([
+      new Promise<true>((resolve) => {
+        BaseSplitClient.client.on(
+          BaseSplitClient.client.Event.SDK_READY,
+          () => {
+            BaseSplitClient.logger.info("split_io_client.created.succeed");
+            resolve(true);
+          }
+        );
+      }),
+      new Promise<false>((resolve) => {
+        setTimeout(() => {
+          resolve(false);
+        }, timeout);
+      }),
+    ]);
+  }
+
+  hasLoaded(): Promise<boolean> {
+    return this.promiseConstruction;
+  }
+
+  getTreatment(key: string, splitName: string, attributes = {}): string {
+    const treatment = BaseSplitClient.client.getTreatment(
+      key,
+      splitName,
+      attributes
+    );
+
+    if (treatment === CONTROL) {
+      BaseSplitClient.logger.warn(
+        "split_io_client.created.sdk_return_control",
+        {
+          key,
+          splitName,
+          attributes,
+        }
+      );
+    }
+
+    return treatment;
+  }
+
+  getBooleanTreatment(
+    key: string,
+    splitName: string,
+    attributes = {}
+  ): boolean {
+    const treatment = this.getTreatment(key, splitName, attributes);
+    return treatment === ON;
+  }
+
+  async destroy(): Promise<void> {
+    await BaseSplitClient.client.destroy();
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+// comment to republish

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "module": "commonjs",
+    "target": "es6",
+    "types": ["node"],
+    "esModuleInterop": true,
+    "sourceMap": true,
+
+    "alwaysStrict": true,
+    "strictNullChecks": true
+  },
+  "exclude": ["node_modules"]
+}