@splitsoftware/splitio-commons 1.2.1-rc.1 → 1.2.1-rc.2

package/esm/sync/polling/fetchers/segmentChangesFetcher.js

@@ -1,4 +1,4 @@
-import { __spreadArrays } from "tslib";
+import { __spreadArray } from "tslib";
 function greedyFetch(fetchSegmentChanges, since, segmentName, noCache) {
     return fetchSegmentChanges(since, segmentName, noCache)
         .then(function (resp) { return resp.json(); })
@@ -9,7 +9,7 @@ function greedyFetch(fetchSegmentChanges, since, segmentName, noCache) {
         }
         else {
             return Promise.all([json, greedyFetch(fetchSegmentChanges, till, segmentName, noCache)]).then(function (flatMe) {
-                return __spreadArrays([flatMe[0]], flatMe[1]);
+                return __spreadArray([flatMe[0]], flatMe[1], true);
             });
         }
     });

package/esm/utils/inputValidation/key.js

@@ -35,7 +35,8 @@ export function validateKey(log, maybeKey, method) {
         var bucketingKey = validateKeyValue(log, maybeKey.bucketingKey, method, 'bucketingKey');
         if (matchingKey && bucketingKey)
             return {
-                matchingKey: matchingKey, bucketingKey: bucketingKey
+                matchingKey: matchingKey,
+                bucketingKey: bucketingKey
             };
         log.error(ERROR_INVALID_KEY_OBJECT, [method]);
         return false;

package/esm/utils/lang/index.js

@@ -1,4 +1,4 @@
-import { __spreadArrays } from "tslib";
+import { __spreadArray } from "tslib";
 /**
  * Checks if the target string ends with the sub string.
  */
@@ -179,7 +179,7 @@ export function merge(target, source) {
     });
     if (rest && rest.length) {
         var nextSource = rest.splice(0, 1)[0];
-        res = merge.apply(void 0, __spreadArrays([res, nextSource], rest));
+        res = merge.apply(void 0, __spreadArray([res, nextSource], rest, false));
     }
     return res;
 }

package/esm/utils/settingsValidation/index.js

@@ -64,10 +64,6 @@ var base = {
         impressionsMode: OPTIMIZED,
         localhostMode: undefined
     },
-    runtime: {
-        ip: false,
-        hostname: false
-    },
     // Logger
     log: undefined
 };
@@ -114,8 +110,7 @@ export function settingsValidation(config, validationParams) {
     }
     // Current ip/hostname information
     // @ts-ignore, modify readonly prop
-    if (runtime)
-        withDefaults.runtime = runtime(withDefaults);
+    withDefaults.runtime = runtime(withDefaults);
     // ensure a valid list of integrations.
     // `integrations` returns an array of valid integration items.
     // @ts-ignore, modify readonly prop

package/esm/utils/settingsValidation/runtime/browser.js

@@ -0,0 +1,6 @@
+export function validateRuntime() {
+    return {
+        ip: false,
+        hostname: false
+    };
+}

package/esm/utils/settingsValidation/runtime/node.js

@@ -0,0 +1,17 @@
+import osFunction from 'os';
+import ipFunction from 'ip';
+import { UNKNOWN, NA, CONSUMER_MODE } from '../../constants';
+export function validateRuntime(settings) {
+    var isIPAddressesEnabled = settings.core.IPAddressesEnabled === true;
+    var isConsumerMode = settings.mode === CONSUMER_MODE;
+    // If the values are not available, default to false (for standalone) or "unknown" (for consumer mode, to be used on Redis keys)
+    var ip = ipFunction.address() || (isConsumerMode ? UNKNOWN : false);
+    var hostname = osFunction.hostname() || (isConsumerMode ? UNKNOWN : false);
+    if (!isIPAddressesEnabled) { // If IPAddresses setting is not enabled, set as false (for standalone) or "NA" (for consumer mode, to  be used on Redis keys)
+        ip = hostname = isConsumerMode ? NA : false;
+    }
+    return {
+        ip: ip,
+        hostname: hostname
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.2.1-rc.1",
+  "version": "1.2.1-rc.2",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -20,12 +20,12 @@
     "check:lint": "eslint src --ext .js,.ts",
     "check:types": "tsc --noEmit",
     "build": "npm run build:cjs && npm run build:esm",
-    "build:esm": "rimraf esm && tsc -m es2015 --outDir esm -d true --declarationDir types --importHelpers",
-    "build:cjs": "rimraf cjs && tsc -m CommonJS --outDir cjs --importHelpers",
+    "build:esm": "rimraf esm && tsc -m es2015 --outDir esm -d true --declarationDir types",
+    "build:cjs": "rimraf cjs && tsc -m CommonJS --outDir cjs",
     "test": "jest",
     "test:coverage": "jest --coverage",
-    "publish:rc": "npm run check && npm run build && npm run test && npm publish --tag rc",
-    "publish:stable": "npm run check && npm run build && npm run test && npm publish"
+    "publish:rc": "npm run check && npm run test && npm run build && npm publish --tag rc",
+    "publish:stable": "npm run check && npm run test && npm run build && npm publish"
   },
   "repository": {
     "type": "git",
@@ -44,11 +44,12 @@
   "bugs": "https://github.com/splitio/javascript-commons/issues",
   "homepage": "https://github.com/splitio/javascript-commons#readme",
   "dependencies": {
-    "tslib": "^2.1.0"
+    "tslib": "^2.3.1"
   },
   "devDependencies": {
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
+    "@types/ip": "^1.1.0",
     "@types/jest": "^27.0.0",
     "@types/lodash": "^4.14.162",
     "@typescript-eslint/eslint-plugin": "^4.2.0",
@@ -58,7 +59,7 @@
     "eslint": "^7.32.0",
     "eslint-plugin-compat": "3.7.0",
     "eslint-plugin-import": "^2.25.3",
-    "fetch-mock": "^9.10.7",
+    "fetch-mock": "^9.11.0",
     "ioredis": "^4.28.0",
     "jest": "^27.2.3",
     "jest-localstorage-mock": "^2.4.3",
@@ -68,7 +69,7 @@
     "redis-server": "1.2.2",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.0.5",
-    "typescript": "^4.0.2"
+    "typescript": "4.4.4"
   },
   "sideEffects": false
 }

package/src/logger/types.ts

@@ -9,11 +9,15 @@ export interface ILoggerOptions {
 export interface ILogger {
   setLogLevel(logLevel: LogLevel): void
 
+  debug(msg: unknown): void
   debug(msg: string | number, args?: any[]): void
 
+  info(msg: unknown): void
   info(msg: string | number, args?: any[]): void
 
+  warn(msg: unknown): void
   warn(msg: string | number, args?: any[]): void
 
+  error(msg: unknown): void
   error(msg: string | number, args?: any[]): void
 }

package/src/sync/offline/splitsParser/splitsParserFromFile.ts

@@ -82,7 +82,7 @@ export function splitsParserFromFileFactory(): ISplitsParser {
     try {
       data = fs.readFileSync(filePath, 'utf-8');
     } catch (e) {
-      log.error(e.message);
+      log.error(e && (e as Error).message);
 
       return {};
     }

package/src/utils/settingsValidation/index.ts

@@ -78,11 +78,6 @@ const base = {
     localhostMode: undefined
   },
 
-  runtime: {
-    ip: false,
-    hostname: false
-  },
-
   // Logger
   log: undefined
 };
@@ -139,7 +134,7 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
 
   // Current ip/hostname information
   // @ts-ignore, modify readonly prop
-  if (runtime) withDefaults.runtime = runtime(withDefaults);
+  withDefaults.runtime = runtime(withDefaults);
 
   // ensure a valid list of integrations.
   // `integrations` returns an array of valid integration items.

package/src/utils/settingsValidation/runtime/browser.ts

@@ -0,0 +1,6 @@
+export function validateRuntime() {
+  return {
+    ip: false,
+    hostname: false
+  };
+}

package/src/utils/settingsValidation/runtime/node.ts

@@ -0,0 +1,22 @@
+import osFunction from 'os';
+import ipFunction from 'ip';
+
+import { UNKNOWN, NA, CONSUMER_MODE } from '../../constants';
+import { ISettings } from '../../../types';
+
+export function validateRuntime(settings: ISettings) {
+  const isIPAddressesEnabled = settings.core.IPAddressesEnabled === true;
+  const isConsumerMode = settings.mode === CONSUMER_MODE;
+
+  // If the values are not available, default to false (for standalone) or "unknown" (for consumer mode, to be used on Redis keys)
+  let ip = ipFunction.address() || (isConsumerMode ? UNKNOWN : false);
+  let hostname = osFunction.hostname() || (isConsumerMode ? UNKNOWN : false);
+
+  if (!isIPAddressesEnabled) { // If IPAddresses setting is not enabled, set as false (for standalone) or "NA" (for consumer mode, to  be used on Redis keys)
+    ip = hostname = isConsumerMode ? NA : false;
+  }
+
+  return {
+    ip, hostname
+  };
+}

package/src/utils/settingsValidation/types.ts

@@ -6,15 +6,15 @@ import { ISettings } from '../../types';
  */
 export interface ISettingsValidationParams {
   /**
-   * Object of values to overwrite default settings.
-   * Version and startup properties are mandatory, because these values are not part of the base setting.
+   * Object of values to overwrite base settings.
+   * Version and startup properties are required, because they are not defined in the base settings.
    */
   defaults: Partial<ISettings> & { version: string } & { startup: ISettings['startup'] },
-  /** Function to overwrite runtime values (ip and hostname) which are false by default */
-  runtime?: (settings: ISettings) => ISettings['runtime'],
-  /** Storage validator */
+  /** Function to define runtime values (`settings.runtime`) */
+  runtime: (settings: ISettings) => ISettings['runtime'],
+  /** Storage validator (`settings.storage`) */
   storage?: (settings: ISettings) => ISettings['storage'],
-  /** Integrations validator */
+  /** Integrations validator (`settings.integrations`) */
   integrations?: (settings: ISettings) => ISettings['integrations'],
   /** Logger validator (`settings.debug`) */
   logger: (settings: ISettings) => ISettings['log'],

package/types/logger/types.d.ts

@@ -6,8 +6,12 @@ export interface ILoggerOptions {
 }
 export interface ILogger {
     setLogLevel(logLevel: LogLevel): void;
+    debug(msg: unknown): void;
     debug(msg: string | number, args?: any[]): void;
+    info(msg: unknown): void;
     info(msg: string | number, args?: any[]): void;
+    warn(msg: unknown): void;
     warn(msg: string | number, args?: any[]): void;
+    error(msg: unknown): void;
     error(msg: string | number, args?: any[]): void;
 }

package/types/sdkClient/clientAttributesDecoration.d.ts

@@ -8,7 +8,7 @@ export declare function clientAttributesDecoration<TClient extends SplitIO.IClie
     getTreatmentWithConfig: (maybeKey: SplitIO.SplitKey, maybeSplit: string, maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentWithConfig | SplitIO.AsyncTreatmentWithConfig;
     getTreatments: (maybeKey: SplitIO.SplitKey, maybeSplits: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.Treatments | SplitIO.AsyncTreatments;
     getTreatmentsWithConfig: (maybeKey: SplitIO.SplitKey, maybeSplits: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentsWithConfig | SplitIO.AsyncTreatmentsWithConfig;
-    track: (maybeKey: SplitIO.SplitKey, maybeTT: string, maybeEvent: string, maybeEventValue?: number | undefined, maybeProperties?: SplitIO.Properties | undefined) => import("../dtos/types").MaybeThenable<boolean>;
+    track: (maybeKey: SplitIO.SplitKey, maybeTT: string, maybeEvent: string, maybeEventValue?: number | undefined, maybeProperties?: SplitIO.Properties | undefined) => boolean | Promise<boolean>;
     /**
      * Add an attribute to client's in memory attributes storage
      *

package/types/utils/settingsValidation/runtime/browser.d.ts

@@ -0,0 +1,4 @@
+export declare function validateRuntime(): {
+    ip: boolean;
+    hostname: boolean;
+};

package/types/utils/settingsValidation/runtime/node.d.ts

@@ -0,0 +1,5 @@
+import { ISettings } from '../../../types';
+export declare function validateRuntime(settings: ISettings): {
+    ip: string | false;
+    hostname: string | false;
+};

package/types/utils/settingsValidation/types.d.ts

@@ -5,19 +5,19 @@ import { ISettings } from '../../types';
  */
 export interface ISettingsValidationParams {
     /**
-     * Object of values to overwrite default settings.
-     * Version and startup properties are mandatory, because these values are not part of the base setting.
+     * Object of values to overwrite base settings.
+     * Version and startup properties are required, because they are not defined in the base settings.
      */
     defaults: Partial<ISettings> & {
         version: string;
     } & {
         startup: ISettings['startup'];
     };
-    /** Function to overwrite runtime values (ip and hostname) which are false by default */
-    runtime?: (settings: ISettings) => ISettings['runtime'];
-    /** Storage validator */
+    /** Function to define runtime values (`settings.runtime`) */
+    runtime: (settings: ISettings) => ISettings['runtime'];
+    /** Storage validator (`settings.storage`) */
     storage?: (settings: ISettings) => ISettings['storage'];
-    /** Integrations validator */
+    /** Integrations validator (`settings.integrations`) */
     integrations?: (settings: ISettings) => ISettings['integrations'];
     /** Logger validator (`settings.debug`) */
     logger: (settings: ISettings) => ISettings['log'];