@splitsoftware/splitio-commons 1.2.1-rc.8 → 1.3.1-rc.0

package/types/sync/submitters/telemetrySyncTask.d.ts

@@ -1,17 +1,27 @@
 import { ISyncTask, ITimeTracker } from '../types';
-import { IPostMetricsUsage } from '../../services/types';
+import { ISplitApi } from '../../services/types';
 import { IStorageSync, TelemetryCacheSync } from '../../storages/types';
-import { TelemetryStatsPayload } from './types';
-import { ILogger } from '../../logger/types';
+import { TelemetryUsageStatsPayload, TelemetryConfigStatsPayload } from './types';
+import { IReadinessManager } from '../../readiness/types';
+import { ISettings } from '../../types';
 /**
  * Converts `impressions` data from cache into request payload.
  */
-export declare function telemetryCacheAdapter(telemetryCache: TelemetryCacheSync, storage: IStorageSync): {
+export declare function telemetryCacheStatsAdapter({ splits, segments, telemetry }: IStorageSync & {
+    telemetry: TelemetryCacheSync;
+}): {
     isEmpty(): boolean;
     clear(): void;
-    state(): TelemetryStatsPayload;
+    state(): TelemetryUsageStatsPayload;
+};
+export declare function telemetryCacheConfigAdapter(settings: ISettings, telemetryCache: TelemetryCacheSync): {
+    isEmpty(): boolean;
+    clear(): void;
+    state(): TelemetryConfigStatsPayload;
 };
 /**
  * Sync task that periodically posts impressions data
  */
-export declare function telemetrySyncTaskFactory(log: ILogger, postMetricsUsage: IPostMetricsUsage, telemetryCache: TelemetryCacheSync, telemetryRefreshRate: number, latencyTracker: ITimeTracker, storage: IStorageSync): ISyncTask;
+export declare function telemetrySyncTaskFactory(settings: ISettings, { postMetricsUsage, postMetricsConfig }: ISplitApi, storage: IStorageSync & {
+    telemetry: TelemetryCacheSync;
+}, telemetryRefreshRate: number, readiness: IReadinessManager, latencyTracker?: ITimeTracker): ISyncTask;

package/types/types.d.ts

@@ -389,7 +389,7 @@ interface IBasicClient extends IStatusInterface {
      * @returns {Promise<void>}
      */
     destroy(): Promise<void>;
-    isBrowserClient: boolean;
+    isClientSide: boolean;
 }
 /**
  * Common definitions between SDK instances for different environments interface.
@@ -526,8 +526,8 @@ export declare namespace SplitIO {
     type ImpressionData = {
         impression: ImpressionDTO;
         attributes?: SplitIO.Attributes;
-        ip: string;
-        hostname: string;
+        ip: string | false;
+        hostname: string | false;
         sdkLanguageVersion: string;
     };
     /**

package/types/utils/lang/index.d.ts

@@ -55,7 +55,8 @@ export declare function isIntegerNumber(val: any): boolean;
  */
 export declare function isNaNNumber(val: any): boolean;
 /**
- * Validates if a value is an object with the Object prototype (map object).
+ * Validates if a value is an object created by the Object constructor (plain object).
+ * It checks `constructor.name` to avoid false negatives when validating values on a separate VM context, which has its own global built-ins.
  */
 export declare function isObject(obj: any): boolean;
 /**

package/types/utils/lang/maps.d.ts

@@ -44,5 +44,12 @@ interface IMapConstructor {
     new <K, V>(entries?: readonly (readonly [K, V])[] | null): IMap<K, V>;
     readonly prototype: IMap<any, any>;
 }
+/**
+ * return the Map constructor to use. If native Map is not available or it doesn't support the required features (e.g., IE11),
+ * a ponyfill with minimal features is returned instead.
+ *
+ * Exported for testing purposes only.
+ */
+export declare function __getMapConstructor(): IMapConstructor;
 export declare const _Map: IMapConstructor;
 export {};

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

@@ -13,7 +13,11 @@ export interface ISettingsValidationParams {
     } & {
         startup: ISettings['startup'];
     };
-    /** Function to define runtime values (`settings.runtime`) */
+    /** If true, validates core.key */
+    acceptKey?: boolean;
+    /** If true, validates core.trafficType */
+    acceptTT?: boolean;
+    /** Define runtime values (`settings.runtime`) */
     runtime: (settings: ISettings) => ISettings['runtime'];
     /** Storage validator (`settings.storage`) */
     storage?: (settings: ISettings) => ISettings['storage'];

package/cjs/sdkClient/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/sdkFactory/userConsentProps.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.userConsentProps = void 0;
-var constants_1 = require("../logger/constants");
-var constants_2 = require("../utils/constants");
-var lang_1 = require("../utils/lang");
-// Extend client-side factory instances with user consent getter/setter
-function userConsentProps(settings, syncManager) {
-    var log = settings.log;
-    return {
-        setUserConsent: function (consent) {
-            var _a, _b;
-            // validate input param
-            if (!(0, lang_1.isBoolean)(consent)) {
-                log.warn(constants_1.ERROR_NOT_BOOLEAN, ['setUserConsent']);
-                return false;
-            }
-            var newConsentStatus = consent ? constants_2.CONSENT_GRANTED : constants_2.CONSENT_DECLINED;
-            if (settings.userConsent !== newConsentStatus) { // @ts-ignore, modify readonly prop
-                settings.userConsent = newConsentStatus;
-                if (consent)
-                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _a === void 0 ? void 0 : _a.start(); // resumes submitters if transitioning to GRANTED
-                else
-                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _b === void 0 ? void 0 : _b.stop(); // pauses submitters if transitioning to DECLINED
-                log.info(constants_1.USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]);
-            }
-            else {
-                log.info(constants_1.USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
-            }
-            return true;
-        },
-        getUserConsent: function () {
-            return settings.userConsent;
-        }
-    };
-}
-exports.userConsentProps = userConsentProps;

package/esm/sdkClient/types.js

@@ -1 +0,0 @@
-export {};

package/esm/sdkFactory/userConsentProps.js

@@ -1,33 +0,0 @@
-import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED } from '../logger/constants';
-import { CONSENT_GRANTED, CONSENT_DECLINED } from '../utils/constants';
-import { isBoolean } from '../utils/lang';
-// Extend client-side factory instances with user consent getter/setter
-export function userConsentProps(settings, syncManager) {
-    var log = settings.log;
-    return {
-        setUserConsent: function (consent) {
-            var _a, _b;
-            // validate input param
-            if (!isBoolean(consent)) {
-                log.warn(ERROR_NOT_BOOLEAN, ['setUserConsent']);
-                return false;
-            }
-            var newConsentStatus = consent ? CONSENT_GRANTED : CONSENT_DECLINED;
-            if (settings.userConsent !== newConsentStatus) { // @ts-ignore, modify readonly prop
-                settings.userConsent = newConsentStatus;
-                if (consent)
-                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _a === void 0 ? void 0 : _a.start(); // resumes submitters if transitioning to GRANTED
-                else
-                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _b === void 0 ? void 0 : _b.stop(); // pauses submitters if transitioning to DECLINED
-                log.info(USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]);
-            }
-            else {
-                log.info(USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
-            }
-            return true;
-        },
-        getUserConsent: function () {
-            return settings.userConsent;
-        }
-    };
-}

package/src/sdkClient/types.ts

@@ -1,21 +0,0 @@
-import { ISignalListener } from '../listeners/types';
-import { ISdkReadinessManager } from '../readiness/types';
-import { IStorageAsync, IStorageSync } from '../storages/types';
-import { ISyncManager } from '../sync/types';
-import { IEventTracker, IImpressionsTracker } from '../trackers/types';
-import { ISettings } from '../types';
-
-export interface IClientFactoryParams {
-  storage: IStorageSync | IStorageAsync,
-  sdkReadinessManager: ISdkReadinessManager,
-  settings: ISettings
-  impressionsTracker: IImpressionsTracker,
-  eventTracker: IEventTracker,
-  // @TODO add time tracker and metricCollectors (a.k.a metricTracker)?
-}
-
-export interface ISdkClientFactoryParams extends IClientFactoryParams {
-  signalListener?: ISignalListener
-  syncManager?: ISyncManager,
-  sharedClient?: boolean
-}

package/src/sdkFactory/userConsentProps.ts

@@ -1,40 +0,0 @@
-import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED } from '../logger/constants';
-import { ISyncManager } from '../sync/types';
-import { ISettings } from '../types';
-import { CONSENT_GRANTED, CONSENT_DECLINED } from '../utils/constants';
-import { isBoolean } from '../utils/lang';
-
-// Extend client-side factory instances with user consent getter/setter
-export function userConsentProps(settings: ISettings, syncManager?: ISyncManager) {
-
-  const log = settings.log;
-
-  return {
-    setUserConsent(consent: unknown) {
-      // validate input param
-      if (!isBoolean(consent)) {
-        log.warn(ERROR_NOT_BOOLEAN, ['setUserConsent']);
-        return false;
-      }
-
-      const newConsentStatus = consent ? CONSENT_GRANTED : CONSENT_DECLINED;
-
-      if (settings.userConsent !== newConsentStatus) { // @ts-ignore, modify readonly prop
-        settings.userConsent = newConsentStatus;
-
-        if (consent) syncManager?.submitter?.start(); // resumes submitters if transitioning to GRANTED
-        else syncManager?.submitter?.stop(); // pauses submitters if transitioning to DECLINED
-
-        log.info(USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]);
-      } else {
-        log.info(USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
-      }
-
-      return true;
-    },
-
-    getUserConsent() {
-      return settings.userConsent;
-    }
-  };
-}