@splitsoftware/splitio-browserjs 0.8.0 → 0.8.1-rc.1

package/CHANGES.txt

@@ -1,3 +1,6 @@
+0.8.1 (September XXX, 2022)
+- Updated @splitsoftware/splitio-commons package to version 1.6.2, that improves the performance of split evaluations (i.e., `getTreatment(s)` method calls) when using the default storage in memory.
+
 0.8.0 (July 22, 2022)
 - Added `autoRequire` configuration option to the Google Analytics to Split integration, which takes care of requiring the splitTracker plugin on trackers dynamically created by Google tag managers (See https://help.split.io/hc/en-us/articles/360040838752#set-up-with-gtm-and-gtag.js).
 - Updated browser listener to push remaining impressions and events on 'visibilitychange' and 'pagehide' DOM events, instead of 'unload', which is not reliable in modern mobile and desktop Web browsers.

package/cjs/full/splitFactory.js

@@ -19,7 +19,7 @@ var platform = { getFetch: getFetchFull_1.getFetch, getEventSource: getEventSour
  * @throws Will throw an error if the provided config is invalid.
  */
 function SplitFactory(config, __updateModules) {
-    var settings = (0, full_1.settingsValidator)(config);
+    var settings = (0, full_1.settingsFactory)(config);
     var modules = (0, getModules_1.getModules)(settings, platform);
     if (__updateModules)
         __updateModules(modules);

package/cjs/platform/getModules.js

@@ -10,7 +10,6 @@ var sdkClientMethodCS_1 = require("@splitsoftware/splitio-commons/cjs/sdkClient/
 var browser_1 = require("@splitsoftware/splitio-commons/cjs/listeners/browser");
 var impressionObserverCS_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/impressionObserverCS");
 var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/integrations/pluggable");
-var utils_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/utils");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
 var sdkUserConsent_1 = require("@splitsoftware/splitio-commons/cjs/consent/sdkUserConsent");
 var syncManagerStandaloneFactory;
@@ -28,7 +27,7 @@ function getModules(settings, platform) {
         sdkClientMethodFactory: sdkClientMethodCS_1.sdkClientMethodCSFactory,
         SignalListener: browser_1.BrowserSignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggable_1.pluggableIntegrationsManagerFactory.bind(null, settings.integrations) : undefined,
-        impressionsObserverFactory: (0, utils_1.shouldAddPt)(settings) ? impressionObserverCS_1.impressionObserverCSFactory : undefined,
+        impressionsObserverFactory: impressionObserverCS_1.impressionObserverCSFactory,
         extraProps: function (params) {
             return {
                 UserConsent: (0, sdkUserConsent_1.createUserConsentAPI)(params)

package/cjs/settings/defaults.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaults = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/logger/index");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-var packageVersion = '0.8.0';
+var packageVersion = '0.8.1-rc.1';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/cjs/settings/full.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.settingsValidator = void 0;
+exports.settingsFactory = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/index");
 var defaults_1 = require("./defaults");
 var runtime_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/runtime");
@@ -19,7 +19,7 @@ var params = {
     localhost: builtin_1.validateLocalhostWithDefault,
     consent: consent_1.validateConsent,
 };
-function settingsValidator(config) {
+function settingsFactory(config) {
     return (0, index_1.settingsValidation)(config, params);
 }
-exports.settingsValidator = settingsValidator;
+exports.settingsFactory = settingsFactory;

package/cjs/settings/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.settingsValidator = void 0;
+exports.settingsFactory = void 0;
 var index_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/index");
 var defaults_1 = require("./defaults");
 var runtime_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/runtime");
@@ -19,7 +19,7 @@ var params = {
     localhost: pluggable_2.validateLocalhost,
     consent: consent_1.validateConsent,
 };
-function settingsValidator(config) {
+function settingsFactory(config) {
     return (0, index_1.settingsValidation)(config, params);
 }
-exports.settingsValidator = settingsValidator;
+exports.settingsFactory = settingsFactory;

package/cjs/splitFactory.js

@@ -19,7 +19,7 @@ var platform = { getFetch: getFetchSlim_1.getFetch, getEventSource: getEventSour
  * @throws Will throw an error if the provided config is invalid.
  */
 function SplitFactory(config, __updateModules) {
-    var settings = (0, settings_1.settingsValidator)(config);
+    var settings = (0, settings_1.settingsFactory)(config);
     var modules = (0, getModules_1.getModules)(settings, platform);
     if (__updateModules)
         __updateModules(modules);

package/esm/full/splitFactory.js

@@ -1,4 +1,4 @@
-import { settingsValidator } from '../settings/full';
+import { settingsFactory } from '../settings/full';
 import { getModules } from '../platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory/index';
 import { getFetch } from '../platform/getFetchFull';
@@ -16,7 +16,7 @@ var platform = { getFetch: getFetch, getEventSource: getEventSource, EventEmitte
  * @throws Will throw an error if the provided config is invalid.
  */
 export function SplitFactory(config, __updateModules) {
-    var settings = settingsValidator(config);
+    var settings = settingsFactory(config);
     var modules = getModules(settings, platform);
     if (__updateModules)
         __updateModules(modules);

package/esm/platform/getModules.js

@@ -7,7 +7,6 @@ import { sdkClientMethodCSFactory } from '@splitsoftware/splitio-commons/esm/sdk
 import { BrowserSignalListener } from '@splitsoftware/splitio-commons/esm/listeners/browser';
 import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/impressionObserverCS';
 import { pluggableIntegrationsManagerFactory } from '@splitsoftware/splitio-commons/esm/integrations/pluggable';
-import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
 import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
 import { createUserConsentAPI } from '@splitsoftware/splitio-commons/esm/consent/sdkUserConsent';
 var syncManagerStandaloneFactory;
@@ -25,7 +24,7 @@ export function getModules(settings, platform) {
         sdkClientMethodFactory: sdkClientMethodCSFactory,
         SignalListener: BrowserSignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggableIntegrationsManagerFactory.bind(null, settings.integrations) : undefined,
-        impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
+        impressionsObserverFactory: impressionObserverCSFactory,
         extraProps: function (params) {
             return {
                 UserConsent: createUserConsentAPI(params)

package/esm/settings/defaults.js

@@ -1,6 +1,6 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/esm/logger/index';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/esm/utils/constants';
-var packageVersion = '0.8.0';
+var packageVersion = '0.8.1-rc.1';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/esm/settings/full.js

@@ -16,6 +16,6 @@ var params = {
     localhost: validateLocalhostWithDefault,
     consent: validateConsent,
 };
-export function settingsValidator(config) {
+export function settingsFactory(config) {
     return settingsValidation(config, params);
 }

package/esm/settings/index.js

@@ -16,6 +16,6 @@ var params = {
     localhost: validateLocalhost,
     consent: validateConsent,
 };
-export function settingsValidator(config) {
+export function settingsFactory(config) {
     return settingsValidation(config, params);
 }

package/esm/splitFactory.js

@@ -1,4 +1,4 @@
-import { settingsValidator } from './settings';
+import { settingsFactory } from './settings';
 import { getModules } from './platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory/index';
 import { getFetch } from './platform/getFetchSlim';
@@ -16,7 +16,7 @@ var platform = { getFetch: getFetch, getEventSource: getEventSource, EventEmitte
  * @throws Will throw an error if the provided config is invalid.
  */
 export function SplitFactory(config, __updateModules) {
-    var settings = settingsValidator(config);
+    var settings = settingsFactory(config);
     var modules = getModules(settings, platform);
     if (__updateModules)
         __updateModules(modules);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.8.0",
+  "version": "0.8.1-rc.1",
   "description": "Split SDK for Javascript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -30,14 +30,14 @@
     "build:ga-to-split-autorequire": "terser ./node_modules/@splitsoftware/splitio-commons/src/integrations/ga/autoRequire.js --mangle --output ./scripts/ga-to-split-autorequire.js",
     "test": "npm run test:unit && npm run test:e2e",
     "test:unit": "jest",
-    "test:e2e": "npm run test:e2e-logger && npm run test:e2e-offline && npm run test:e2e-online && npm run test:e2e-destroy && npm run test:e2e-errors && npm run test:e2e-push && npm run test:e2e-gaintegration && npm run test:e2e-consumer",
+    "test:e2e": "npm run test:e2e-logger && npm run test:e2e-offline && npm run test:e2e-online && npm run test:e2e-destroy && npm run test:e2e-errorCatching && npm run test:e2e-push && npm run test:e2e-gaIntegration && npm run test:e2e-consumer",
     "test:e2e-logger": "karma start karma/e2e.logger.karma.conf.js",
     "test:e2e-offline": "karma start karma/e2e.offline.karma.conf.js",
     "test:e2e-online": "karma start karma/e2e.online.karma.conf.js",
     "test:e2e-destroy": "karma start karma/e2e.destroy.karma.conf.js",
-    "test:e2e-errors": "karma start karma/e2e.errors.karma.conf.js",
+    "test:e2e-errorCatching": "karma start karma/e2e.errorCatching.karma.conf.js",
     "test:e2e-push": "karma start karma/e2e.push.karma.conf.js",
-    "test:e2e-gaintegration": "karma start karma/e2e.gaintegration.karma.conf.js",
+    "test:e2e-gaIntegration": "karma start karma/e2e.gaIntegration.karma.conf.js",
     "test:e2e-consumer": "karma start karma/e2e.consumer.karma.conf.js",
     "pretest-ts-decls": "npm run build:esm && npm run build:cjs && npm link",
     "test-ts-decls": "./scripts/ts-tests.sh",
@@ -63,7 +63,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.6.1",
+    "@splitsoftware/splitio-commons": "1.6.2-rc.10",
     "@types/google.analytics": "0.0.40"
   },
   "devDependencies": {

package/src/full/splitFactory.ts

@@ -1,4 +1,4 @@
-import { settingsValidator } from '../settings/full';
+import { settingsFactory } from '../settings/full';
 import { getModules } from '../platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
 import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
@@ -6,6 +6,7 @@ import { getFetch } from '../platform/getFetchFull';
 import { getEventSource } from '../platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/src/utils/MinEvents';
 import { now } from '@splitsoftware/splitio-commons/src/utils/timeTracker/now/browser';
+import { IBrowserSettings } from '../../types/splitio';
 
 const platform = { getFetch, getEventSource, EventEmitter, now };
 
@@ -18,8 +19,8 @@ const platform = { getFetch, getEventSource, EventEmitter, now };
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-export function SplitFactory(config: any, __updateModules?: (modules: ISdkFactoryParams) => void) {
-  const settings = settingsValidator(config);
+export function SplitFactory(config: IBrowserSettings, __updateModules?: (modules: ISdkFactoryParams) => void) {
+  const settings = settingsFactory(config);
   const modules = getModules(settings, platform);
   if (__updateModules) __updateModules(modules);
   return sdkFactory(modules);

package/src/platform/getModules.ts

@@ -8,7 +8,6 @@ import { BrowserSignalListener } from '@splitsoftware/splitio-commons/src/listen
 import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/impressionObserverCS';
 import { pluggableIntegrationsManagerFactory } from '@splitsoftware/splitio-commons/src/integrations/pluggable';
 
-import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
 import { IPlatform, ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
 import { ISettings } from '@splitsoftware/splitio-commons/src/types';
 import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
@@ -40,7 +39,7 @@ export function getModules(settings: ISettings, platform: IPlatform): ISdkFactor
 
     integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggableIntegrationsManagerFactory.bind(null, settings.integrations) : undefined,
 
-    impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
+    impressionsObserverFactory: impressionObserverCSFactory,
 
     extraProps: (params) => {
       return {

package/src/settings/defaults.ts

@@ -2,7 +2,7 @@ import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/
 import { ConsentStatus, LogLevel } from '@splitsoftware/splitio-commons/src/types';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/src/utils/constants';
 
-const packageVersion = '0.8.0';
+const packageVersion = '0.8.1-rc.1';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/src/settings/full.ts

@@ -18,6 +18,6 @@ const params = {
   consent: validateConsent,
 };
 
-export function settingsValidator(config: any) {
+export function settingsFactory(config: any) {
   return settingsValidation(config, params);
 }

package/src/settings/index.ts

@@ -18,6 +18,6 @@ const params = {
   consent: validateConsent,
 };
 
-export function settingsValidator(config: any) {
+export function settingsFactory(config: any) {
   return settingsValidation(config, params);
 }

package/src/splitFactory.ts

@@ -1,4 +1,4 @@
-import { settingsValidator } from './settings';
+import { settingsFactory } from './settings';
 import { getModules } from './platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
 import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
@@ -6,6 +6,7 @@ import { getFetch } from './platform/getFetchSlim';
 import { getEventSource } from './platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/src/utils/MinEvents';
 import { now } from '@splitsoftware/splitio-commons/src/utils/timeTracker/now/browser';
+import { IBrowserSettings } from '../types/splitio';
 
 const platform = { getFetch, getEventSource, EventEmitter, now };
 
@@ -18,8 +19,8 @@ const platform = { getFetch, getEventSource, EventEmitter, now };
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
  * @throws Will throw an error if the provided config is invalid.
  */
-export function SplitFactory(config: any, __updateModules?: (modules: ISdkFactoryParams) => void) {
-  const settings = settingsValidator(config);
+export function SplitFactory(config: IBrowserSettings, __updateModules?: (modules: ISdkFactoryParams) => void) {
+  const settings = settingsFactory(config);
   const modules = getModules(settings, platform);
   if (__updateModules) __updateModules(modules);
   return sdkFactory(modules);

package/types/splitio.d.ts

@@ -91,8 +91,8 @@ interface ISettings {
   readonly sync: {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
-    localhostMode?: SplitIO.LocalhostFactory,
-    enabled?: boolean
+    enabled: boolean,
+    localhostMode?: SplitIO.LocalhostFactory
   },
   readonly userConsent: SplitIO.ConsentStatus
 }
@@ -247,7 +247,7 @@ interface ISharedSettings {
      * Controls the SDK continuous synchronization flags.
      *
      * When `true` a running SDK will process rollout plan updates performed on the UI (default).
-     * When false it'll just fetch all data upon init
+     * When false it'll just fetch all data upon init.
      *
      * @property {boolean} enabled
      * @default true
@@ -809,7 +809,7 @@ declare namespace SplitIO {
   * ImpressionsMode type
   * @typedef {string} ImpressionsMode
   */
-  type ImpressionsMode = 'OPTIMIZED' | 'DEBUG';
+  type ImpressionsMode = 'OPTIMIZED' | 'DEBUG' | 'NONE';
   /**
    * User consent status.
    * @typedef {string} ConsentStatus