@splitsoftware/splitio-browserjs 0.6.1-rc.3 → 0.8.0

package/CHANGES.txt

@@ -1,3 +1,15 @@
+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.
  - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.

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.6.1-rc.3';
+var packageVersion = '0.8.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/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.6.1-rc.3';
+var packageVersion = '0.8.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.6.1-rc.3",
+  "version": "0.8.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,6 +27,7 @@
     "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",
@@ -61,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.4.2-rc.3",
+    "@splitsoftware/splitio-commons": "1.6.1",
     "@types/google.analytics": "0.0.40"
   },
   "devDependencies": {
@@ -77,9 +79,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/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.6.1-rc.3';
+const packageVersion = '0.8.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/types/full/index.d.ts

@@ -35,14 +35,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;
 

package/types/index.d.ts

@@ -35,14 +35,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;
 

package/types/splitio.d.ts

@@ -244,11 +244,11 @@ interface ISharedSettings {
      */
     localhostMode?: SplitIO.LocalhostFactory
     /**
-     * Controls the SDK continuous synchronization flags. 
-     * 
-     * When `true` a running SDK will process rollout plan updates performed on the UI (default). 
+     * 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
-     * 
+     *
      * @property {boolean} enabled
      * @default true
      */
@@ -628,7 +628,7 @@ declare namespace SplitIO {
   /**
    * Configuration params for 'Google Analytics to Split' integration plugin, 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}
    */
   interface GoogleAnalyticsToSplitOptions {
     /**
@@ -669,6 +669,17 @@ declare namespace SplitIO {
      * If not provided, events are sent using the key and traffic type provided at SDK config.
      */
     identities: Identity[],
+    /**
+     * Optional flag to log an error if the `auto-require` script is not detected.
+     * The auto-require script automatically requires the `splitTracker` plugin for created trackers,
+     * and should be placed right after your Google Analytics, Google Tag Manager or gtag.js script tag.
+     *
+     * @see {@link https://help.split.io/hc/en-us/articles/360040838752#set-up-with-gtm-and-gtag.js}
+     *
+     * @property {boolean} autoRequire
+     * @default false
+     */
+    autoRequire?: boolean,
   }
   /**
    * Object representing the data sent by Split (events and impressions).
@@ -680,7 +691,7 @@ declare namespace SplitIO {
   /**
    * Configuration params for 'Split to Google Analytics' integration plugin, 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}
    */
   interface SplitToGoogleAnalyticsOptions {
     /**