@splitsoftware/splitio-commons 1.2.1-rc.11 → 1.2.1-rc.12

package/cjs/{utils/consent.js → consent/index.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isConsentGranted = void 0;
-var constants_1 = require("./constants");
+var constants_1 = require("../utils/constants");
 function isConsentGranted(settings) {
     var userConsent = settings.userConsent;
     // undefined userConsent is handled as granted (default)

package/cjs/consent/sdkUserConsent.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUserConsentAPI = void 0;
+var constants_1 = require("../logger/constants");
+var index_1 = require("./index");
+var constants_2 = require("../utils/constants");
+var lang_1 = require("../utils/lang");
+// User consent enum
+var ConsentStatus = {
+    GRANTED: constants_2.CONSENT_GRANTED,
+    DECLINED: constants_2.CONSENT_DECLINED,
+    UNKNOWN: constants_2.CONSENT_UNKNOWN,
+};
+/**
+ * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not.
+ */
+function createUserConsentAPI(params) {
+    var settings = params.settings, log = params.settings.log, syncManager = params.syncManager, _a = params.storage, events = _a.events, impressions = _a.impressions, impressionCounts = _a.impressionCounts;
+    if (!(0, index_1.isConsentGranted)(settings))
+        log.info(constants_1.USER_CONSENT_INITIAL, [settings.userConsent]);
+    return {
+        setStatus: 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) {
+                log.info(constants_1.USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop
+                settings.userConsent = newConsentStatus;
+                if (consent) { // resumes submitters if transitioning to GRANTED
+                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _a === void 0 ? void 0 : _a.start();
+                }
+                else { // pauses submitters and drops tracked data if transitioning to DECLINED
+                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _b === void 0 ? void 0 : _b.stop();
+                    // @ts-ignore, clear method is present in storage for standalone and partial consumer mode
+                    if (events.clear)
+                        events.clear(); // @ts-ignore
+                    if (impressions.clear)
+                        impressions.clear();
+                    if (impressionCounts)
+                        impressionCounts.clear();
+                }
+            }
+            else {
+                log.info(constants_1.USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
+            }
+            return true;
+        },
+        getStatus: function () {
+            return settings.userConsent;
+        },
+        Status: ConsentStatus
+    };
+}
+exports.createUserConsentAPI = createUserConsentAPI;

package/cjs/listeners/browser.js

@@ -6,7 +6,7 @@ var impressionCountsSyncTask_1 = require("../sync/submitters/impressionCountsSyn
 var constants_1 = require("../utils/constants");
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_2 = require("../logger/constants");
-var consent_1 = require("../utils/consent");
+var consent_1 = require("../consent");
 // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
 var UNLOAD_DOM_EVENT = 'unload';
 var EVENT_NAME = 'for unload page event.';

package/cjs/sdkClient/sdkClient.js

@@ -8,8 +8,8 @@ var clientInputValidation_1 = require("./clientInputValidation");
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-function sdkClientFactory(params) {
-    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, sharedClient = params.sharedClient;
+function sdkClientFactory(params, isSharedClient) {
+    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings;
     return (0, objectAssign_1.objectAssign)(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
@@ -26,7 +26,7 @@ function sdkClientFactory(params) {
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();
                 // Release the API Key if it is the main client
-                if (!sharedClient)
+                if (!isSharedClient)
                     (0, apiKey_1.releaseApiKey)(settings.core.authorizationKey);
                 // Cleanup storage
                 return storage.destroy();

package/cjs/sdkClient/sdkClientMethodCS.js

@@ -19,8 +19,7 @@ var method = 'Client instantiation';
  */
 function sdkClientMethodCSFactory(params) {
     var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, readyTimeout = _a.startup.readyTimeout, log = _a.log;
-    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), // @ts-ignore
-    key);
+    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key);
     var parsedDefaultKey = (0, key_2.keyParser)(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey);
     // Cache instances created per factory.
@@ -58,9 +57,8 @@ function sdkClientMethodCSFactory(params) {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined,
-                sharedClient: true
-            })), validKey);
+                signalListener: undefined, // only the main client "destroy" method stops the signal listener
+            }), true), validKey);
             sharedSyncManager && sharedSyncManager.start();
             log.info(constants_1.NEW_SHARED_CLIENT);
         }

package/cjs/sdkClient/sdkClientMethodCSWithTT.js

@@ -21,8 +21,7 @@ var method = 'Client instantiation';
  */
 function sdkClientMethodCSFactory(params) {
     var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, readyTimeout = _a.startup.readyTimeout, log = _a.log;
-    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), // @ts-ignore
-    key, trafficType);
+    var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key, trafficType);
     var parsedDefaultKey = (0, key_2.keyParser)(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
     // Cache instances created per factory.
@@ -67,9 +66,8 @@ function sdkClientMethodCSFactory(params) {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined,
-                sharedClient: true
-            })), validKey, validTrafficType);
+                signalListener: undefined, // only the main client "destroy" method stops the signal listener
+            }), true), validKey, validTrafficType);
             sharedSyncManager && sharedSyncManager.start();
             log.info(constants_1.NEW_SHARED_CLIENT);
         }

package/cjs/sdkFactory/index.js

@@ -64,7 +64,8 @@ function sdkFactory(params) {
     // signal listener
     var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
     // Sdk client and manager
-    var clientMethod = sdkClientMethodFactory({ eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener });
+    var ctx = { eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener };
+    var clientMethod = sdkClientMethodFactory(ctx);
     var managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager);
     syncManager && syncManager.start();
     signalListener && signalListener.start();
@@ -81,6 +82,6 @@ function sdkFactory(params) {
         // Logger wrapper API
         Logger: (0, sdkLogger_1.createLoggerAPI)(settings.log),
         settings: settings,
-    }, extraProps && extraProps(settings, syncManager));
+    }, extraProps && extraProps(ctx));
 }
 exports.sdkFactory = sdkFactory;

package/cjs/sync/syncManagerOnline.js

@@ -4,7 +4,7 @@ exports.syncManagerOnlineFactory = void 0;
 var submitterManager_1 = require("./submitters/submitterManager");
 var constants_1 = require("./streaming/constants");
 var constants_2 = require("../logger/constants");
-var consent_1 = require("../utils/consent");
+var consent_1 = require("../consent");
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.

package/esm/{utils/consent.js → consent/index.js}

@@ -1,4 +1,4 @@
-import { CONSENT_GRANTED } from './constants';
+import { CONSENT_GRANTED } from '../utils/constants';
 export function isConsentGranted(settings) {
     var userConsent = settings.userConsent;
     // undefined userConsent is handled as granted (default)

package/esm/consent/sdkUserConsent.js

@@ -0,0 +1,54 @@
+import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants';
+import { isConsentGranted } from './index';
+import { CONSENT_GRANTED, CONSENT_DECLINED, CONSENT_UNKNOWN } from '../utils/constants';
+import { isBoolean } from '../utils/lang';
+// User consent enum
+var ConsentStatus = {
+    GRANTED: CONSENT_GRANTED,
+    DECLINED: CONSENT_DECLINED,
+    UNKNOWN: CONSENT_UNKNOWN,
+};
+/**
+ * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not.
+ */
+export function createUserConsentAPI(params) {
+    var settings = params.settings, log = params.settings.log, syncManager = params.syncManager, _a = params.storage, events = _a.events, impressions = _a.impressions, impressionCounts = _a.impressionCounts;
+    if (!isConsentGranted(settings))
+        log.info(USER_CONSENT_INITIAL, [settings.userConsent]);
+    return {
+        setStatus: 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) {
+                log.info(USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop
+                settings.userConsent = newConsentStatus;
+                if (consent) { // resumes submitters if transitioning to GRANTED
+                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _a === void 0 ? void 0 : _a.start();
+                }
+                else { // pauses submitters and drops tracked data if transitioning to DECLINED
+                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitter) === null || _b === void 0 ? void 0 : _b.stop();
+                    // @ts-ignore, clear method is present in storage for standalone and partial consumer mode
+                    if (events.clear)
+                        events.clear(); // @ts-ignore
+                    if (impressions.clear)
+                        impressions.clear();
+                    if (impressionCounts)
+                        impressionCounts.clear();
+                }
+            }
+            else {
+                log.info(USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
+            }
+            return true;
+        },
+        getStatus: function () {
+            return settings.userConsent;
+        },
+        Status: ConsentStatus
+    };
+}

package/esm/listeners/browser.js

@@ -3,7 +3,7 @@ import { fromImpressionCountsCollector } from '../sync/submitters/impressionCoun
 import { OPTIMIZED, DEBUG } from '../utils/constants';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
-import { isConsentGranted } from '../utils/consent';
+import { isConsentGranted } from '../consent';
 // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
 var UNLOAD_DOM_EVENT = 'unload';
 var EVENT_NAME = 'for unload page event.';

package/esm/sdkClient/sdkClient.js

@@ -5,8 +5,8 @@ import { clientInputValidationDecorator } from './clientInputValidation';
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-export function sdkClientFactory(params) {
-    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, sharedClient = params.sharedClient;
+export function sdkClientFactory(params, isSharedClient) {
+    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings;
     return objectAssign(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
@@ -23,7 +23,7 @@ export function sdkClientFactory(params) {
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();
                 // Release the API Key if it is the main client
-                if (!sharedClient)
+                if (!isSharedClient)
                     releaseApiKey(settings.core.authorizationKey);
                 // Cleanup storage
                 return storage.destroy();

package/esm/sdkClient/sdkClientMethodCS.js

@@ -16,8 +16,7 @@ var method = 'Client instantiation';
  */
 export function sdkClientMethodCSFactory(params) {
     var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, readyTimeout = _a.startup.readyTimeout, log = _a.log;
-    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), // @ts-ignore
-    key);
+    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key);
     var parsedDefaultKey = keyParser(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey);
     // Cache instances created per factory.
@@ -55,9 +54,8 @@ export function sdkClientMethodCSFactory(params) {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined,
-                sharedClient: true
-            })), validKey);
+                signalListener: undefined, // only the main client "destroy" method stops the signal listener
+            }), true), validKey);
             sharedSyncManager && sharedSyncManager.start();
             log.info(NEW_SHARED_CLIENT);
         }

package/esm/sdkClient/sdkClientMethodCSWithTT.js

@@ -18,8 +18,7 @@ var method = 'Client instantiation';
  */
 export function sdkClientMethodCSFactory(params) {
     var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, readyTimeout = _a.startup.readyTimeout, log = _a.log;
-    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), // @ts-ignore
-    key, trafficType);
+    var mainClientInstance = clientCSDecorator(log, sdkClientFactory(params), key, trafficType);
     var parsedDefaultKey = keyParser(key);
     var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
     // Cache instances created per factory.
@@ -64,9 +63,8 @@ export function sdkClientMethodCSFactory(params) {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined,
-                sharedClient: true
-            })), validKey, validTrafficType);
+                signalListener: undefined, // only the main client "destroy" method stops the signal listener
+            }), true), validKey, validTrafficType);
             sharedSyncManager && sharedSyncManager.start();
             log.info(NEW_SHARED_CLIENT);
         }

package/esm/sdkFactory/index.js

@@ -61,7 +61,8 @@ export function sdkFactory(params) {
     // signal listener
     var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
     // Sdk client and manager
-    var clientMethod = sdkClientMethodFactory({ eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener });
+    var ctx = { eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener };
+    var clientMethod = sdkClientMethodFactory(ctx);
     var managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager);
     syncManager && syncManager.start();
     signalListener && signalListener.start();
@@ -78,5 +79,5 @@ export function sdkFactory(params) {
         // Logger wrapper API
         Logger: createLoggerAPI(settings.log),
         settings: settings,
-    }, extraProps && extraProps(settings, syncManager));
+    }, extraProps && extraProps(ctx));
 }

package/esm/sync/syncManagerOnline.js

@@ -1,7 +1,7 @@
 import { submitterManagerFactory } from './submitters/submitterManager';
 import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants';
 import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants';
-import { isConsentGranted } from '../utils/consent';
+import { isConsentGranted } from '../consent';
 /**
  * Online SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.2.1-rc.11",
+  "version": "1.2.1-rc.12",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/{utils/consent.ts → consent/index.ts}

@@ -1,5 +1,5 @@
 import { ISettings } from '../types';
-import { CONSENT_GRANTED } from './constants';
+import { CONSENT_GRANTED } from '../utils/constants';
 
 export function isConsentGranted(settings: ISettings) {
   const userConsent = settings.userConsent;

package/src/consent/sdkUserConsent.ts

@@ -0,0 +1,58 @@
+import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants';
+import { isConsentGranted } from './index';
+import { CONSENT_GRANTED, CONSENT_DECLINED, CONSENT_UNKNOWN } from '../utils/constants';
+import { isBoolean } from '../utils/lang';
+import { ISdkFactoryContext } from '../sdkFactory/types';
+
+// User consent enum
+const ConsentStatus = {
+  GRANTED: CONSENT_GRANTED,
+  DECLINED: CONSENT_DECLINED,
+  UNKNOWN: CONSENT_UNKNOWN,
+};
+
+/**
+ * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not.
+ */
+export function createUserConsentAPI(params: ISdkFactoryContext) {
+  const { settings, settings: { log }, syncManager, storage: { events, impressions, impressionCounts } } = params;
+
+  if (!isConsentGranted(settings)) log.info(USER_CONSENT_INITIAL, [settings.userConsent]);
+
+  return {
+    setStatus(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) {
+        log.info(USER_CONSENT_UPDATED, [settings.userConsent, newConsentStatus]); // @ts-ignore, modify readonly prop
+        settings.userConsent = newConsentStatus;
+
+        if (consent) { // resumes submitters if transitioning to GRANTED
+          syncManager?.submitter?.start();
+        } else { // pauses submitters and drops tracked data if transitioning to DECLINED
+          syncManager?.submitter?.stop();
+          // @ts-ignore, clear method is present in storage for standalone and partial consumer mode
+          if (events.clear) events.clear(); // @ts-ignore
+          if (impressions.clear) impressions.clear();
+          if (impressionCounts) impressionCounts.clear();
+        }
+      } else {
+        log.info(USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
+      }
+
+      return true;
+    },
+
+    getStatus() {
+      return settings.userConsent;
+    },
+
+    Status: ConsentStatus
+  };
+}

package/src/listeners/browser.ts

@@ -11,7 +11,7 @@ import { OPTIMIZED, DEBUG } from '../utils/constants';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
 import { ISyncManager } from '../sync/types';
-import { isConsentGranted } from '../utils/consent';
+import { isConsentGranted } from '../consent';
 
 // 'unload' event is used instead of 'beforeunload', since 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
 const UNLOAD_DOM_EVENT = 'unload';

package/src/sdkClient/client.ts

@@ -5,17 +5,16 @@ import { validateSplitExistance } from '../utils/inputValidation/splitExistance'
 import { validateTrafficTypeExistance } from '../utils/inputValidation/trafficTypeExistance';
 import { SDK_NOT_READY } from '../utils/labels';
 import { CONTROL } from '../utils/constants';
-import { IClientFactoryParams } from './types';
 import { IEvaluationResult } from '../evaluator/types';
 import { SplitIO, ImpressionDTO } from '../types';
 import { IMPRESSION, IMPRESSION_QUEUEING } from '../logger/constants';
-
+import { ISdkFactoryContext } from '../sdkFactory/types';
 
 /**
  * Creator of base client with getTreatments and track methods.
  */
 // @TODO missing time tracking to collect telemetry
-export function clientFactory(params: IClientFactoryParams): SplitIO.IClient | SplitIO.IAsyncClient {
+export function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | SplitIO.IAsyncClient {
   const { sdkReadinessManager: { readinessManager }, storage, settings, impressionsTracker, eventTracker } = params;
   const { log, mode } = settings;
 

package/src/sdkClient/sdkClient.ts

@@ -3,13 +3,13 @@ import { IStatusInterface, SplitIO } from '../types';
 import { releaseApiKey } from '../utils/inputValidation/apiKey';
 import { clientFactory } from './client';
 import { clientInputValidationDecorator } from './clientInputValidation';
-import { ISdkClientFactoryParams } from './types';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-export function sdkClientFactory(params: ISdkClientFactoryParams): SplitIO.IClient | SplitIO.IAsyncClient {
-  const { sdkReadinessManager, syncManager, storage, signalListener, settings, sharedClient } = params;
+export function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.IClient | SplitIO.IAsyncClient {
+  const { sdkReadinessManager, syncManager, storage, signalListener, settings } = params;
 
   return objectAssign(
     // Proto-linkage of the readiness Event Emitter
@@ -35,7 +35,7 @@ export function sdkClientFactory(params: ISdkClientFactoryParams): SplitIO.IClie
           signalListener && signalListener.stop();
 
           // Release the API Key if it is the main client
-          if (!sharedClient) releaseApiKey(settings.core.authorizationKey);
+          if (!isSharedClient) releaseApiKey(settings.core.authorizationKey);
 
           // Cleanup storage
           return storage.destroy();

package/src/sdkClient/sdkClientMethod.ts

@@ -1,12 +1,12 @@
-import { ISdkClientFactoryParams } from './types';
 import { SplitIO } from '../types';
 import { sdkClientFactory } from './sdkClient';
 import { RETRIEVE_CLIENT_DEFAULT } from '../logger/constants';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 
 /**
  * Factory of client method for server-side SDKs (ISDK and IAsyncSDK)
  */
-export function sdkClientMethodFactory(params: ISdkClientFactoryParams): () => SplitIO.IClient | SplitIO.IAsyncClient {
+export function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.IClient | SplitIO.IAsyncClient {
   const log = params.settings.log;
   const clientInstance = sdkClientFactory(params);
 

package/src/sdkClient/sdkClientMethodCS.ts

@@ -1,5 +1,4 @@
 import { clientCSDecorator } from './clientCS';
-import { ISdkClientFactoryParams } from './types';
 import { SplitIO } from '../types';
 import { validateKey } from '../utils/inputValidation/key';
 import { getMatching, keyParser } from '../utils/key';
@@ -8,6 +7,7 @@ import { ISyncManagerCS } from '../sync/types';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants';
 import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 
 function buildInstanceId(key: SplitIO.SplitKey) {
   // @ts-ignore
@@ -20,12 +20,12 @@ const method = 'Client instantiation';
  * Factory of client method for the client-side API variant where TT is ignored and thus
  * clients don't have a binded TT for the track method.
  */
-export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?: SplitIO.SplitKey) => SplitIO.ICsClient {
+export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.ICsClient {
   const { storage, syncManager, sdkReadinessManager, settings: { core: { key }, startup: { readyTimeout }, log } } = params;
 
   const mainClientInstance = clientCSDecorator(
     log,
-    sdkClientFactory(params) as SplitIO.IClient, // @ts-ignore
+    sdkClientFactory(params) as SplitIO.IClient,
     key
   );
 
@@ -76,8 +76,7 @@ export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?
           storage: sharedStorage || storage,
           syncManager: sharedSyncManager,
           signalListener: undefined, // only the main client "destroy" method stops the signal listener
-          sharedClient: true
-        })) as SplitIO.IClient,
+        }), true) as SplitIO.IClient,
         validKey
       );
 

package/src/sdkClient/sdkClientMethodCSWithTT.ts

@@ -1,5 +1,4 @@
 import { clientCSDecorator } from './clientCS';
-import { ISdkClientFactoryParams } from './types';
 import { SplitIO } from '../types';
 import { validateKey } from '../utils/inputValidation/key';
 import { validateTrafficType } from '../utils/inputValidation/trafficType';
@@ -9,6 +8,7 @@ import { ISyncManagerCS } from '../sync/types';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { RETRIEVE_CLIENT_DEFAULT, NEW_SHARED_CLIENT, RETRIEVE_CLIENT_EXISTING } from '../logger/constants';
 import { SDK_SEGMENTS_ARRIVED } from '../readiness/constants';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 
 function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string) {
   // @ts-ignore
@@ -22,12 +22,12 @@ const method = 'Client instantiation';
  * where clients can have a binded TT for the track method, which is provided via the settings
  * (default client) or the client method (shared clients).
  */
-export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient {
+export function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient {
   const { storage, syncManager, sdkReadinessManager, settings: { core: { key, trafficType }, startup: { readyTimeout }, log } } = params;
 
   const mainClientInstance = clientCSDecorator(
     log,
-    sdkClientFactory(params) as SplitIO.IClient, // @ts-ignore
+    sdkClientFactory(params) as SplitIO.IClient,
     key,
     trafficType
   );
@@ -86,8 +86,7 @@ export function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?
           storage: sharedStorage || storage,
           syncManager: sharedSyncManager,
           signalListener: undefined, // only the main client "destroy" method stops the signal listener
-          sharedClient: true
-        })) as SplitIO.IClient,
+        }), true) as SplitIO.IClient,
         validKey,
         validTrafficType
       );

package/src/sdkFactory/index.ts

@@ -81,7 +81,8 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
   const signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
 
   // Sdk client and manager
-  const clientMethod = sdkClientMethodFactory({ eventTracker, impressionsTracker, sdkReadinessManager, settings, storage, syncManager, signalListener });
+  const ctx = { eventTracker, impressionsTracker, sdkReadinessManager, settings, storage, syncManager, signalListener };
+  const clientMethod = sdkClientMethodFactory(ctx);
   const managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager);
 
   syncManager && syncManager.start();
@@ -104,5 +105,5 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
     Logger: createLoggerAPI(settings.log),
 
     settings,
-  }, extraProps && extraProps(settings, syncManager));
+  }, extraProps && extraProps(ctx));
 }

package/src/sdkFactory/types.ts

@@ -2,13 +2,23 @@ import { IIntegrationManager, IIntegrationFactoryParams } from '../integrations/
 import { ISignalListener } from '../listeners/types';
 import { ILogger } from '../logger/types';
 import { ISdkReadinessManager } from '../readiness/types';
-import { ISdkClientFactoryParams } from '../sdkClient/types';
 import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types';
 import { IStorageAsync, IStorageSync, ISplitsCacheSync, ISplitsCacheAsync, IStorageFactoryParams } from '../storages/types';
 import { ISyncManager, ISyncManagerFactoryParams } from '../sync/types';
 import { IImpressionObserver } from '../trackers/impressionObserver/types';
+import { IImpressionsTracker, IEventTracker } from '../trackers/types';
 import { SplitIO, ISettings, IEventEmitter } from '../types';
 
+export interface ISdkFactoryContext {
+  storage: IStorageSync | IStorageAsync,
+  sdkReadinessManager: ISdkReadinessManager,
+  settings: ISettings
+  impressionsTracker: IImpressionsTracker,
+  eventTracker: IEventTracker,
+  signalListener?: ISignalListener
+  syncManager?: ISyncManager,
+}
+
 /**
  * Environment related dependencies.
  * These getters are called a fixed number of times per factory instantiation.
@@ -53,7 +63,7 @@ export interface ISdkFactoryParams {
 
   // Sdk client method factory (ISDK::client method).
   // It Allows to distinguish SDK clients with the client-side API (`ICsSDK`) or server-side API (`ISDK` or `IAsyncSDK`).
-  sdkClientMethodFactory: (params: ISdkClientFactoryParams) => ({ (): SplitIO.ICsClient; (key: SplitIO.SplitKey, trafficType?: string | undefined): SplitIO.ICsClient; } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient))
+  sdkClientMethodFactory: (params: ISdkFactoryContext) => ({ (): SplitIO.ICsClient; (key: SplitIO.SplitKey, trafficType?: string | undefined): SplitIO.ICsClient; } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient))
 
   // Optional signal listener constructor. Used to handle special app states, like shutdown, app paused or resumed.
   // Pass only if `syncManager` (used by Node listener) and `splitApi` (used by Browser listener) are passed.
@@ -70,5 +80,5 @@ export interface ISdkFactoryParams {
   impressionsObserverFactory?: () => IImpressionObserver
 
   // Optional function to assign additional properties to the factory instance
-  extraProps?: (settings: ISettings, syncManager?: ISyncManager) => object
+  extraProps?: (params: ISdkFactoryContext) => object
 }

package/src/sync/syncManagerOnline.ts

@@ -6,7 +6,7 @@ import { IPushManager } from './streaming/types';
 import { IPollingManager, IPollingManagerCS } from './polling/types';
 import { PUSH_SUBSYSTEM_UP, PUSH_SUBSYSTEM_DOWN } from './streaming/constants';
 import { SYNC_START_POLLING, SYNC_CONTINUE_POLLING, SYNC_STOP_POLLING } from '../logger/constants';
-import { isConsentGranted } from '../utils/consent';
+import { isConsentGranted } from '../consent';
 
 /**
  * Online SyncManager factory.

package/types/consent/index.d.ts

@@ -0,0 +1,2 @@
+import { ISettings } from '../types';
+export declare function isConsentGranted(settings: ISettings): boolean;

package/types/consent/sdkUserConsent.d.ts

@@ -0,0 +1,13 @@
+import { ISdkFactoryContext } from '../sdkFactory/types';
+/**
+ * The public user consent API exposed via SplitFactory, used to control if the SDK tracks and sends impressions and events or not.
+ */
+export declare function createUserConsentAPI(params: ISdkFactoryContext): {
+    setStatus(consent: unknown): boolean;
+    getStatus(): import("../types").ConsentStatus | undefined;
+    Status: {
+        GRANTED: string;
+        DECLINED: string;
+        UNKNOWN: string;
+    };
+};

package/types/sdkClient/client.d.ts

@@ -1,6 +1,6 @@
-import { IClientFactoryParams } from './types';
 import { SplitIO } from '../types';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 /**
  * Creator of base client with getTreatments and track methods.
  */
-export declare function clientFactory(params: IClientFactoryParams): SplitIO.IClient | SplitIO.IAsyncClient;
+export declare function clientFactory(params: ISdkFactoryContext): SplitIO.IClient | SplitIO.IAsyncClient;

package/types/sdkClient/sdkClient.d.ts

@@ -1,6 +1,6 @@
 import { SplitIO } from '../types';
-import { ISdkClientFactoryParams } from './types';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 /**
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
-export declare function sdkClientFactory(params: ISdkClientFactoryParams): SplitIO.IClient | SplitIO.IAsyncClient;
+export declare function sdkClientFactory(params: ISdkFactoryContext, isSharedClient?: boolean): SplitIO.IClient | SplitIO.IAsyncClient;

package/types/sdkClient/sdkClientMethod.d.ts

@@ -1,6 +1,6 @@
-import { ISdkClientFactoryParams } from './types';
 import { SplitIO } from '../types';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 /**
  * Factory of client method for server-side SDKs (ISDK and IAsyncSDK)
  */
-export declare function sdkClientMethodFactory(params: ISdkClientFactoryParams): () => SplitIO.IClient | SplitIO.IAsyncClient;
+export declare function sdkClientMethodFactory(params: ISdkFactoryContext): () => SplitIO.IClient | SplitIO.IAsyncClient;

package/types/sdkClient/sdkClientMethodCS.d.ts

@@ -1,7 +1,7 @@
-import { ISdkClientFactoryParams } from './types';
 import { SplitIO } from '../types';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 /**
  * Factory of client method for the client-side API variant where TT is ignored and thus
  * clients don't have a binded TT for the track method.
  */
-export declare function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?: SplitIO.SplitKey) => SplitIO.ICsClient;
+export declare function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey) => SplitIO.ICsClient;

package/types/sdkClient/sdkClientMethodCSWithTT.d.ts

@@ -1,8 +1,8 @@
-import { ISdkClientFactoryParams } from './types';
 import { SplitIO } from '../types';
+import { ISdkFactoryContext } from '../sdkFactory/types';
 /**
  * Factory of client method for the client-side (browser) variant of the Isomorphic JS SDK,
  * where clients can have a binded TT for the track method, which is provided via the settings
  * (default client) or the client method (shared clients).
  */
-export declare function sdkClientMethodCSFactory(params: ISdkClientFactoryParams): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient;
+export declare function sdkClientMethodCSFactory(params: ISdkFactoryContext): (key?: SplitIO.SplitKey, trafficType?: string) => SplitIO.ICsClient;

package/types/sdkFactory/types.d.ts

@@ -2,12 +2,21 @@ import { IIntegrationManager, IIntegrationFactoryParams } from '../integrations/
 import { ISignalListener } from '../listeners/types';
 import { ILogger } from '../logger/types';
 import { ISdkReadinessManager } from '../readiness/types';
-import { ISdkClientFactoryParams } from '../sdkClient/types';
 import { IFetch, ISplitApi, IEventSourceConstructor } from '../services/types';
 import { IStorageAsync, IStorageSync, ISplitsCacheSync, ISplitsCacheAsync, IStorageFactoryParams } from '../storages/types';
 import { ISyncManager, ISyncManagerFactoryParams } from '../sync/types';
 import { IImpressionObserver } from '../trackers/impressionObserver/types';
+import { IImpressionsTracker, IEventTracker } from '../trackers/types';
 import { SplitIO, ISettings, IEventEmitter } from '../types';
+export interface ISdkFactoryContext {
+    storage: IStorageSync | IStorageAsync;
+    sdkReadinessManager: ISdkReadinessManager;
+    settings: ISettings;
+    impressionsTracker: IImpressionsTracker;
+    eventTracker: IEventTracker;
+    signalListener?: ISignalListener;
+    syncManager?: ISyncManager;
+}
 /**
  * Environment related dependencies.
  * These getters are called a fixed number of times per factory instantiation.
@@ -28,7 +37,7 @@ export interface ISdkFactoryParams {
     splitApiFactory?: (settings: ISettings, platform: IPlatform) => ISplitApi;
     syncManagerFactory?: (params: ISyncManagerFactoryParams) => ISyncManager;
     sdkManagerFactory: (log: ILogger, splits: ISplitsCacheSync | ISplitsCacheAsync, sdkReadinessManager: ISdkReadinessManager) => SplitIO.IManager | SplitIO.IAsyncManager;
-    sdkClientMethodFactory: (params: ISdkClientFactoryParams) => ({
+    sdkClientMethodFactory: (params: ISdkFactoryContext) => ({
         (): SplitIO.ICsClient;
         (key: SplitIO.SplitKey, trafficType?: string | undefined): SplitIO.ICsClient;
     } | (() => SplitIO.IClient) | (() => SplitIO.IAsyncClient));
@@ -38,5 +47,5 @@ export interface ISdkFactoryParams {
     serviceApi: ISplitApi | undefined) => ISignalListener;
     integrationsManagerFactory?: (params: IIntegrationFactoryParams) => IIntegrationManager | undefined;
     impressionsObserverFactory?: () => IImpressionObserver;
-    extraProps?: (settings: ISettings, syncManager?: ISyncManager) => object;
+    extraProps?: (params: ISdkFactoryContext) => object;
 }

package/cjs/sdkClient/types.js

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

package/cjs/sdkFactory/userConsentProps.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.userConsentProps = void 0;
-var constants_1 = require("../logger/constants");
-var consent_1 = require("../utils/consent");
-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;
-    if (!(0, consent_1.isConsentGranted)(settings))
-        log.info(constants_1.USER_CONSENT_INITIAL, [settings.userConsent]);
-    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) {
-                log.info(constants_1.USER_CONSENT_UPDATED, [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
-            }
-            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,36 +0,0 @@
-import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants';
-import { isConsentGranted } from '../utils/consent';
-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;
-    if (!isConsentGranted(settings))
-        log.info(USER_CONSENT_INITIAL, [settings.userConsent]);
-    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) {
-                log.info(USER_CONSENT_UPDATED, [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
-            }
-            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,42 +0,0 @@
-import { ERROR_NOT_BOOLEAN, USER_CONSENT_UPDATED, USER_CONSENT_NOT_UPDATED, USER_CONSENT_INITIAL } from '../logger/constants';
-import { ISyncManager } from '../sync/types';
-import { ISettings } from '../types';
-import { isConsentGranted } from '../utils/consent';
-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;
-
-  if (!isConsentGranted(settings)) log.info(USER_CONSENT_INITIAL, [settings.userConsent]);
-
-  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) {
-        log.info(USER_CONSENT_UPDATED, [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
-      } else {
-        log.info(USER_CONSENT_NOT_UPDATED, [newConsentStatus]);
-      }
-
-      return true;
-    },
-
-    getUserConsent() {
-      return settings.userConsent;
-    }
-  };
-}