@splitsoftware/splitio 10.17.4-rc.3 → 10.17.4-rc.4

package/CHANGES.txt

@@ -1,4 +1,4 @@
-10.18.0 (March XXX, 2022)
+10.18.0 (April 4, 2022)
  - Updated internal dependencies to use @splitsoftware/splitio-commons dependency, which includes:
       - Added support for user consent in client-side
       - Added impressionsQueueSize config parameter

package/es/factory/browser.js

@@ -12,7 +12,7 @@ import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/esm/
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
-import { userConsentProps } from '@splitsoftware/splitio-commons/esm/sdkFactory/userConsentProps';
+import { createUserConsentAPI } from '@splitsoftware/splitio-commons/esm/consent/sdkUserConsent';
 import { settingsFactory } from '../settings/browser';
 import { platform, SignalListener } from '../platform';
 var syncManagerOnlineCSFactory = syncManagerOnlineFactory(pollingManagerCSFactory, pushManagerFactory);
@@ -39,7 +39,11 @@ function getModules(settings) {
         SignalListener: SignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? integrationsManagerFactory.bind(null, settings.integrations) : undefined,
         impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
-        extraProps: userConsentProps
+        extraProps: function (params) {
+            return {
+                UserConsent: createUserConsentAPI(params)
+            };
+        }
     };
     switch (settings.mode) {
         case LOCALHOST_MODE:

package/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.17.4-rc.3';
+export var packageVersion = '10.17.4-rc.4';

package/lib/factory/browser.js

@@ -15,7 +15,7 @@ var storageCS_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsVali
 var sdkFactory_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var utils_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/utils");
-var userConsentProps_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory/userConsentProps");
+var sdkUserConsent_1 = require("@splitsoftware/splitio-commons/cjs/consent/sdkUserConsent");
 var browser_2 = require("../settings/browser");
 var platform_1 = require("../platform");
 var syncManagerOnlineCSFactory = (0, syncManagerOnline_1.syncManagerOnlineFactory)(pollingManagerCS_1.pollingManagerCSFactory, pushManager_1.pushManagerFactory);
@@ -42,7 +42,11 @@ function getModules(settings) {
         SignalListener: platform_1.SignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? browser_1.integrationsManagerFactory.bind(null, settings.integrations) : undefined,
         impressionsObserverFactory: (0, utils_1.shouldAddPt)(settings) ? impressionObserverCS_1.impressionObserverCSFactory : undefined,
-        extraProps: userConsentProps_1.userConsentProps
+        extraProps: function (params) {
+            return {
+                UserConsent: (0, sdkUserConsent_1.createUserConsentAPI)(params)
+            };
+        }
     };
     switch (settings.mode) {
         case constants_1.LOCALHOST_MODE:

package/lib/settings/defaults/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageVersion = void 0;
-exports.packageVersion = '10.17.4-rc.3';
+exports.packageVersion = '10.17.4-rc.4';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.17.4-rc.3",
+  "version": "10.17.4-rc.4",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -32,7 +32,7 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.2.1-rc.10",
+    "@splitsoftware/splitio-commons": "1.2.1-rc.12",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "ioredis": "^4.28.0",

package/src/factory/browser.js

@@ -12,7 +12,7 @@ import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/src/
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/src/utils/constants';
 import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
-import { userConsentProps } from '@splitsoftware/splitio-commons/src/sdkFactory/userConsentProps';
+import { createUserConsentAPI } from '@splitsoftware/splitio-commons/src/consent/sdkUserConsent';
 
 import { settingsFactory } from '../settings/browser';
 import { platform, SignalListener } from '../platform';
@@ -54,7 +54,11 @@ function getModules(settings) {
 
     impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
 
-    extraProps: userConsentProps
+    extraProps: (params) => {
+      return {
+        UserConsent: createUserConsentAPI(params)
+      };
+    }
   };
 
   switch (settings.mode) {

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.17.4-rc.3';
+export const packageVersion = '10.17.4-rc.4';

package/types/splitio.d.ts

@@ -143,7 +143,38 @@ interface ILoggerAPI {
    * Log level constants. Use this to pass them to setLogLevel function.
    */
   LogLevel: {
-    [level: string]: LogLevel
+    [level in LogLevel]: LogLevel
+  }
+}
+/**
+ * User consent API
+ * @interface IUserConsentAPI
+ */
+interface IUserConsentAPI {
+  /**
+   * Set or update the user consent status. Possible values are `true` and `false`, which represent user consent `'GRANTED'` and `'DECLINED'` respectively.
+   * - `true ('GRANTED')`: the user has granted consent for tracking events and impressions. The SDK will send them to Split cloud.
+   * - `false ('DECLINED')`: the user has declined consent for tracking events and impressions. The SDK will not send them to Split cloud.
+   *
+   * NOTE: calling this method updates the user consent at a factory level, affecting all clients of the same factory.
+   *
+   * @function setStatus
+   * @param {boolean} userConsent The user consent status, true for 'GRANTED' and false for 'DECLINED'.
+   * @returns {boolean} Whether the provided param is a valid value (i.e., a boolean value) or not.
+   */
+  setStatus(userConsent: boolean): boolean;
+  /**
+   * Get the user consent status.
+   *
+   * @function getStatus
+   * @returns {ConsentStatus} The user consent status.
+   */
+  getStatus(): SplitIO.ConsentStatus;
+  /**
+   * Consent status constants. Use this to compare with the getStatus function result.
+   */
+  Status: {
+    [status in SplitIO.ConsentStatus]: SplitIO.ConsentStatus
   }
 }
 /**
@@ -1215,24 +1246,10 @@ declare namespace SplitIO {
      */
     client(key: SplitKey, trafficType?: string): IBrowserClient
     /**
-     * Set or update the user consent status. Possible values are `true` and `false`, which represent user consent `'GRANTED'` and `'DECLINED'` respectively.
-     * - `true ('GRANTED')`: the user has granted consent for tracking events and impressions. The SDK will send them to Split cloud.
-     * - `false ('DECLINED')`: the user has declined consent for tracking events and impressions. The SDK will not send them to Split cloud.
-     *
-     * NOTE: calling this method updates the user consent at a factory level, affecting all clients of the same factory.
-     *
-     * @function setUserConsent
-     * @param {boolean} userConsent The user consent status, true for 'GRANTED' and false for 'DECLINED'.
-     * @returns {boolean} Whether the provided param is a valid value (i.e., a boolean value) or not.
-     */
-    setUserConsent(userConsent: boolean): boolean;
-    /**
-     * Get the user consent status.
-     *
-     * @function getUserConsent
-     * @returns {ConsentStatus} The user consent status.
+     * User consent API.
+     * @property UserConsent
      */
-    getUserConsent(): ConsentStatus;
+    UserConsent: IUserConsentAPI
   }
   /**
    * This represents the interface for the SDK instance with asynchronous storage.