@splitsoftware/splitio-browserjs 0.7.0 → 0.8.1-rc.0

package/CHANGES.txt

@@ -1,8 +1,14 @@
+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.
+- Updated the synchronization flow to be more reliable in the event of an edge case generating delay in cache purge propagation, keeping the SDK cache properly synced.
+- Updated some dependencies for vulnerability fixes.
+
 0.7.0 (June 29, 2022)
 - Added a new config option to control the tasks that listen or poll for updates on feature flags and segments, via the new config sync.enabled . Running online Split will always pull the most recent updates upon initialization, this only affects updates fetching on a running instance. Useful when a consistent session experience is a must or to save resources when updates are not being used.
 - Updated telemetry logic to track the anonymous config for user consent flag set to declined or unknown.
 - Updated submitters logic, to avoid duplicating the post of impressions to Split cloud when the SDK is destroyed while its periodic post of impressions is running.
-
+- Bugfixing - Updated submitters logic, to avoid dropping impressions and events that are being tracked while POST request is pending.
 
 0.6.0 (May 24, 2022)
  - Added `scheduler.telemetryRefreshRate` property to SDK configuration.

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/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.7.0';
+var packageVersion = '0.8.1-rc.0';
 /**
  * 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/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.7.0';
+var packageVersion = '0.8.1-rc.0';
 /**
  * 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.7.0",
+  "version": "0.8.1-rc.0",
   "description": "Split SDK for Javascript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -14,7 +14,8 @@
     "esm",
     "src",
     "types",
-    "full"
+    "full",
+    "scripts/ga-to-split-autorequire.js"
   ],
   "scripts": {
     "check": "npm run check:lint && npm run check:types && npm run check:version",
@@ -26,20 +27,19 @@
     "build:cjs": "rimraf cjs && tsc -outDir cjs -m CommonJS && ./scripts/build_cjs_replace_imports.sh",
     "build:umd-visualizer": "rollup --config rollup.visualizer.config.js",
     "build:umd": "rollup --config rollup.ci.config.js --branch=$BUILD_BRANCH --commit_hash=$BUILD_COMMIT",
+    "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",
-    "posttest-ts-decls": "npm unlink && npm install",
+    "test-ts-decls": "tsc --build ts-tests",
     "publish:rc": "npm run check && npm run build && npm publish --tag rc",
     "publish:stable": "npm run check && npm run build && npm publish"
   },
@@ -61,7 +61,7 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.5.0",
+    "@splitsoftware/splitio-commons": "1.6.2-rc.4",
     "@types/google.analytics": "0.0.40"
   },
   "devDependencies": {
@@ -77,9 +77,9 @@
     "eslint-plugin-import": "^2.25.4",
     "fetch-mock": "^9.11.0",
     "jest": "^27.2.3",
-    "karma": "^6.3.16",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-rollup-preprocessor": "^7.0.5",
+    "karma": "^6.4.0",
+    "karma-chrome-launcher": "^3.1.1",
+    "karma-rollup-preprocessor": "^7.0.8",
     "karma-tap": "^4.2.0",
     "replace": "^1.2.1",
     "rimraf": "^3.0.2",

package/scripts/ga-to-split-autorequire.js

@@ -0,0 +1 @@
+(function(n,t,e){n[e]=n[e]||t;n[t]=n[t]||function(){n[t].q.push(arguments)};n[t].q=n[t].q||[];var r={};function i(n){return typeof n==="object"&&typeof n.name==="string"&&n.name}function o(e){if(e&&e[0]==="create"){var o=i(e[1])||i(e[2])||i(e[3])||(typeof e[3]==="string"?e[3]:undefined);if(!r[o]){r[o]=true;n[t]((o?o+".":"")+"require","splitTracker")}}}n[t].q.forEach(o);var u=n[t].q.push;n[t].q.push=function(n){var t=u.apply(this,arguments);o(n);return t}})(window,"ga","GoogleAnalyticsObject");

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';
@@ -19,7 +19,7 @@ const platform = { getFetch, getEventSource, EventEmitter, now };
  * @throws Will throw an error if the provided config is invalid.
  */
 export function SplitFactory(config: any, __updateModules?: (modules: ISdkFactoryParams) => void) {
-  const settings = settingsValidator(config);
+  const settings = settingsFactory(config);
   const modules = getModules(settings, platform);
   if (__updateModules) __updateModules(modules);
   return sdkFactory(modules);

package/src/platform/getModules.ts

@@ -10,7 +10,7 @@ import { pluggableIntegrationsManagerFactory } from '@splitsoftware/splitio-comm
 
 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 { IntegrationFactory, ISettings } from '@splitsoftware/splitio-commons/src/types';
 import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 import { createUserConsentAPI } from '@splitsoftware/splitio-commons/src/consent/sdkUserConsent';
 
@@ -26,7 +26,7 @@ export function getModules(settings: ISettings, platform: IPlatform): ISdkFactor
 
     platform,
 
-    storageFactory: settings.storage,
+    storageFactory: settings.storage as ISdkFactoryParams['storageFactory'],
 
     splitApiFactory,
 
@@ -38,7 +38,7 @@ export function getModules(settings: ISettings, platform: IPlatform): ISdkFactor
 
     SignalListener: BrowserSignalListener as ISdkFactoryParams['SignalListener'],
 
-    integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggableIntegrationsManagerFactory.bind(null, settings.integrations) : undefined,
+    integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? pluggableIntegrationsManagerFactory.bind(null, settings.integrations as IntegrationFactory[]) : undefined,
 
     impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
 

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.7.0';
+const packageVersion = '0.8.1-rc.0';
 
 /**
  * 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';
@@ -19,7 +19,7 @@ const platform = { getFetch, getEventSource, EventEmitter, now };
  * @throws Will throw an error if the provided config is invalid.
  */
 export function SplitFactory(config: any, __updateModules?: (modules: ISdkFactoryParams) => void) {
-  const settings = settingsValidator(config);
+  const settings = settingsFactory(config);
   const modules = getModules(settings, platform);
   if (__updateModules) __updateModules(modules);
   return sdkFactory(modules);

package/types/full/index.d.ts

@@ -3,9 +3,8 @@
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
 /// <reference path="../splitio.d.ts" />
-export = JsSdk;
 
-declare module JsSdk {
+declare module '@splitsoftware/splitio-browserjs/full' {
   /**
    * Full version of the Split.io sdk factory function.
    *
@@ -30,19 +29,19 @@ declare module JsSdk {
    *
    * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage}
    */
-   export function PluggableStorage(options: SplitIO.PluggableStorageOptions): SplitIO.StorageAsyncFactory;
+  export function PluggableStorage(options: SplitIO.PluggableStorageOptions): SplitIO.StorageAsyncFactory;
 
   /**
    * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#integrations}
+   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
    */
   export function GoogleAnalyticsToSplit(options?: SplitIO.GoogleAnalyticsToSplitOptions): SplitIO.IntegrationFactory;
 
   /**
    * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#integrations}
+   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
    */
   export function SplitToGoogleAnalytics(options?: SplitIO.SplitToGoogleAnalyticsOptions): SplitIO.IntegrationFactory;
 

package/types/index.d.ts

@@ -3,9 +3,8 @@
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
 /// <reference path="./splitio.d.ts" />
-export = JsSdk;
 
-declare module JsSdk {
+declare module '@splitsoftware/splitio-browserjs' {
   /**
    * Slim version of the Split.io sdk factory function.
    *
@@ -35,14 +34,14 @@ declare module JsSdk {
   /**
    * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#integrations}
+   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
    */
   export function GoogleAnalyticsToSplit(options?: SplitIO.GoogleAnalyticsToSplitOptions): SplitIO.IntegrationFactory;
 
   /**
    * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#integrations}
+   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
    */
   export function SplitToGoogleAnalytics(options?: SplitIO.SplitToGoogleAnalyticsOptions): SplitIO.IntegrationFactory;