@splitsoftware/splitio-commons 1.4.1 → 1.4.2-rc.0

package/CHANGES.txt

@@ -1,3 +1,7 @@
+1.4.2 (June XX, 2022)
+ - Added `autoRequire` configuration for GoogleAnalyticsToSplit integration (See https://help.split.io/hc/en-us/articles/360040838752#google-tag-manager).
+ - Updated telemetry to submit data even if user consent is not granted.
+
 1.4.1 (June 13, 2022)
  - Bugfixing - Updated submitters logic, to avoid dropping impressions and events that are being tracked while POST request is pending.
 

package/cjs/consent/sdkUserConsent.js

@@ -31,10 +31,10 @@ function createUserConsentAPI(params) {
                 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();
+                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitterManager) === 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();
+                else { // pauses submitters (except telemetry), and drops tracked data if transitioning to DECLINED
+                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitterManager) === null || _b === void 0 ? void 0 : _b.stop(true);
                     // @ts-ignore, clear method is present in storage for standalone and partial consumer mode
                     if (events.clear)
                         events.clear(); // @ts-ignore

package/cjs/integrations/ga/GaToSplit.js

@@ -10,23 +10,24 @@ var logNameMapper = 'ga-to-split:mapper';
 /**
  * Provides a plugin to use with analytics.js, accounting for the possibility
  * that the global command queue has been renamed or not yet defined.
- * @param {string} pluginName The plugin name identifier.
- * @param {Function} pluginConstructor The plugin constructor function.
+ * @param window Reference to global object.
+ * @param pluginName The plugin name identifier.
+ * @param pluginConstructor The plugin constructor function.
+ * @param log Logger instance.
+ * @param autoRequire If true, log error when auto-require script is not detected
  */
-function providePlugin(pluginName, pluginConstructor) {
+function providePlugin(window, pluginName, pluginConstructor, log, autoRequire) {
     // get reference to global command queue. Init it if not defined yet.
-    // @ts-expect-error
     var gaAlias = window.GoogleAnalyticsObject || 'ga';
     window[gaAlias] = window[gaAlias] || function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
-        (window[gaAlias].q = window[gaAlias].q || []).push(args);
+        (window[gaAlias].q = window[gaAlias].q || []).push(arguments);
     };
     // provides the plugin for use with analytics.js.
-    // @ts-expect-error
     window[gaAlias]('provide', pluginName, pluginConstructor);
+    if (autoRequire && (!window[gaAlias].q || window[gaAlias].q.push === [].push)) {
+        // Expecting spy on ga.q push method but not found
+        log.error('Auto-require script was expected but not provided.');
+    }
 }
 // Default mapping: object used for building the default mapper from hits to Split events
 var defaultMapping = {
@@ -246,6 +247,6 @@ function GaToSplit(sdkOptions, params) {
         return SplitTracker;
     }());
     // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-    providePlugin('splitTracker', SplitTracker);
+    providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire);
 }
 exports.GaToSplit = GaToSplit;

package/cjs/integrations/ga/autoRequire.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.autoRequire = void 0;
+/* eslint-disable no-undef */
+/**
+ * Auto-require script to use with GaToSplit integration
+ */
+function autoRequire() {
+    (function (i, r, s) {
+        i[s] = i[s] || r;
+        i[r] = i[r] || function () { i[r].q.push(arguments); };
+        i[r].q = i[r].q || [];
+        var ts = {}; // Tracker names
+        var o = i[r].q.push;
+        i[r].q.push = function (v) {
+            var result = o.apply(this, arguments);
+            if (v && v[0] === 'create') {
+                var t = typeof v[2] === 'object' && typeof v[2].name === 'string' ?
+                    v[2].name : // `ga('create', 'UA-ID', { name: 'trackerName', ... })`
+                    typeof v[3] === 'object' && typeof v[3].name === 'string' ?
+                        v[3].name : // `ga('create', 'UA-ID', 'auto', { name: 'trackerName', ... })`
+                        typeof v[3] === 'string' ?
+                            v[3] : // `ga('create', 'UA-ID', 'auto', 'trackerName')`
+                            undefined; // No name tracker, e.g.: `ga('create', 'UA-ID', 'auto')`
+                if (!ts[t]) {
+                    ts[t] = true;
+                    i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
+                }
+            }
+            return result;
+        };
+    })(window, 'ga', 'GoogleAnalyticsObject');
+}
+exports.autoRequire = autoRequire;

package/cjs/listeners/browser.js

@@ -53,7 +53,7 @@ var BrowserSignalListener = /** @class */ (function () {
     BrowserSignalListener.prototype.flushData = function () {
         if (!this.syncManager)
             return; // In consumer mode there is not sync manager and data to flush
-        // Flush data if there is user consent
+        // Flush impressions & events data if there is user consent
         if ((0, consent_1.isConsentGranted)(this.settings)) {
             var eventsUrl = this.settings.urls.events;
             var extraMetadata = {
@@ -64,11 +64,12 @@ var BrowserSignalListener = /** @class */ (function () {
             this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
             if (this.storage.impressionCounts)
                 this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, impressionCountsSubmitter_1.fromImpressionCountsCollector);
-            if (this.storage.telemetry) {
-                var telemetryUrl = this.settings.urls.telemetry;
-                var telemetryCacheAdapter = (0, telemetrySubmitter_1.telemetryCacheStatsAdapter)(this.storage.telemetry, this.storage.splits, this.storage.segments);
-                this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
-            }
+        }
+        // Flush telemetry data
+        if (this.storage.telemetry) {
+            var telemetryUrl = this.settings.urls.telemetry;
+            var telemetryCacheAdapter = (0, telemetrySubmitter_1.telemetryCacheStatsAdapter)(this.storage.telemetry, this.storage.splits, this.storage.segments);
+            this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
         }
         // Close streaming connection
         if (this.syncManager.pushManager)

package/cjs/sync/submitters/submitterManager.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.submitterManagerFactory = void 0;
-var syncTaskComposite_1 = require("../syncTaskComposite");
 var eventsSubmitter_1 = require("./eventsSubmitter");
 var impressionsSubmitter_1 = require("./impressionsSubmitter");
 var impressionCountsSubmitter_1 = require("./impressionCountsSubmitter");
@@ -15,8 +14,33 @@ function submitterManagerFactory(params) {
     if (impressionCountsSubmitter)
         submitters.push(impressionCountsSubmitter);
     var telemetrySubmitter = (0, telemetrySubmitter_1.telemetrySubmitterFactory)(params);
-    if (telemetrySubmitter)
-        submitters.push(telemetrySubmitter);
-    return (0, syncTaskComposite_1.syncTaskComposite)(submitters);
+    return {
+        // `onlyTelemetry` true if SDK is created with userConsent not GRANTED
+        start: function (onlyTelemetry) {
+            if (!onlyTelemetry)
+                submitters.forEach(function (submitter) { return submitter.start(); });
+            if (telemetrySubmitter)
+                telemetrySubmitter.start();
+        },
+        // `allExceptTelemetry` true if userConsent is changed to DECLINED
+        stop: function (allExceptTelemetry) {
+            submitters.forEach(function (submitter) { return submitter.stop(); });
+            if (!allExceptTelemetry && telemetrySubmitter)
+                telemetrySubmitter.stop();
+        },
+        isRunning: function () {
+            return submitters.some(function (submitter) { return submitter.isRunning(); });
+        },
+        // Flush data. Called with `onlyTelemetry` true if SDK is destroyed with userConsent not GRANTED
+        execute: function (onlyTelemetry) {
+            var promises = onlyTelemetry ? [] : submitters.map(function (submitter) { return submitter.execute(); });
+            if (telemetrySubmitter)
+                promises.push(telemetrySubmitter.execute());
+            return Promise.all(promises);
+        },
+        isExecuting: function () {
+            return submitters.some(function (submitter) { return submitter.isExecuting(); });
+        }
+    };
 }
 exports.submitterManagerFactory = submitterManagerFactory;

package/cjs/sync/syncManagerOnline.js

@@ -28,7 +28,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
             undefined;
         /** Submitter Manager */
         // It is not inyected as push and polling managers, because at the moment it is required
-        var submitter = (0, submitterManager_1.submitterManagerFactory)(params);
+        var submitterManager = (0, submitterManager_1.submitterManagerFactory)(params);
         /** Sync Manager logic */
         function startPolling() {
             if (pollingManager.isRunning()) {
@@ -61,7 +61,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
             // E.g.: user consent, app state changes (Page hide, Foreground/Background, Online/Offline).
             pollingManager: pollingManager,
             pushManager: pushManager,
-            submitter: submitter,
+            submitterManager: submitterManager,
             /**
              * Method used to start the syncManager for the first time, or resume it after being stopped.
              */
@@ -82,8 +82,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
-                if ((0, consent_1.isConsentGranted)(settings))
-                    submitter.start();
+                submitterManager.start(!(0, consent_1.isConsentGranted)(settings));
             },
             /**
              * Method used to stop/pause the syncManager.
@@ -96,16 +95,13 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                 if (pollingManager && pollingManager.isRunning())
                     pollingManager.stop();
                 // stop periodic data recording (events, impressions, telemetry).
-                submitter.stop();
+                submitterManager.stop();
             },
             isRunning: function () {
                 return running;
             },
             flush: function () {
-                if ((0, consent_1.isConsentGranted)(settings))
-                    return submitter.execute();
-                else
-                    return Promise.resolve();
+                return submitterManager.execute(!(0, consent_1.isConsentGranted)(settings));
             },
             // [Only used for client-side]
             // If polling and push managers are defined (standalone mode), they implement the interfaces for client-side

package/esm/consent/sdkUserConsent.js

@@ -28,10 +28,10 @@ export function createUserConsentAPI(params) {
                 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();
+                    (_a = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitterManager) === 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();
+                else { // pauses submitters (except telemetry), and drops tracked data if transitioning to DECLINED
+                    (_b = syncManager === null || syncManager === void 0 ? void 0 : syncManager.submitterManager) === null || _b === void 0 ? void 0 : _b.stop(true);
                     // @ts-ignore, clear method is present in storage for standalone and partial consumer mode
                     if (events.clear)
                         events.clear(); // @ts-ignore

package/esm/integrations/ga/GaToSplit.js

@@ -7,23 +7,24 @@ var logNameMapper = 'ga-to-split:mapper';
 /**
  * Provides a plugin to use with analytics.js, accounting for the possibility
  * that the global command queue has been renamed or not yet defined.
- * @param {string} pluginName The plugin name identifier.
- * @param {Function} pluginConstructor The plugin constructor function.
+ * @param window Reference to global object.
+ * @param pluginName The plugin name identifier.
+ * @param pluginConstructor The plugin constructor function.
+ * @param log Logger instance.
+ * @param autoRequire If true, log error when auto-require script is not detected
  */
-function providePlugin(pluginName, pluginConstructor) {
+function providePlugin(window, pluginName, pluginConstructor, log, autoRequire) {
     // get reference to global command queue. Init it if not defined yet.
-    // @ts-expect-error
     var gaAlias = window.GoogleAnalyticsObject || 'ga';
     window[gaAlias] = window[gaAlias] || function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
-        (window[gaAlias].q = window[gaAlias].q || []).push(args);
+        (window[gaAlias].q = window[gaAlias].q || []).push(arguments);
     };
     // provides the plugin for use with analytics.js.
-    // @ts-expect-error
     window[gaAlias]('provide', pluginName, pluginConstructor);
+    if (autoRequire && (!window[gaAlias].q || window[gaAlias].q.push === [].push)) {
+        // Expecting spy on ga.q push method but not found
+        log.error('Auto-require script was expected but not provided.');
+    }
 }
 // Default mapping: object used for building the default mapper from hits to Split events
 var defaultMapping = {
@@ -240,5 +241,5 @@ export function GaToSplit(sdkOptions, params) {
         return SplitTracker;
     }());
     // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-    providePlugin('splitTracker', SplitTracker);
+    providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire);
 }

package/esm/integrations/ga/autoRequire.js

@@ -0,0 +1,30 @@
+/* eslint-disable no-undef */
+/**
+ * Auto-require script to use with GaToSplit integration
+ */
+export function autoRequire() {
+    (function (i, r, s) {
+        i[s] = i[s] || r;
+        i[r] = i[r] || function () { i[r].q.push(arguments); };
+        i[r].q = i[r].q || [];
+        var ts = {}; // Tracker names
+        var o = i[r].q.push;
+        i[r].q.push = function (v) {
+            var result = o.apply(this, arguments);
+            if (v && v[0] === 'create') {
+                var t = typeof v[2] === 'object' && typeof v[2].name === 'string' ?
+                    v[2].name : // `ga('create', 'UA-ID', { name: 'trackerName', ... })`
+                    typeof v[3] === 'object' && typeof v[3].name === 'string' ?
+                        v[3].name : // `ga('create', 'UA-ID', 'auto', { name: 'trackerName', ... })`
+                        typeof v[3] === 'string' ?
+                            v[3] : // `ga('create', 'UA-ID', 'auto', 'trackerName')`
+                            undefined; // No name tracker, e.g.: `ga('create', 'UA-ID', 'auto')`
+                if (!ts[t]) {
+                    ts[t] = true;
+                    i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
+                }
+            }
+            return result;
+        };
+    })(window, 'ga', 'GoogleAnalyticsObject');
+}

package/esm/listeners/browser.js

@@ -50,7 +50,7 @@ var BrowserSignalListener = /** @class */ (function () {
     BrowserSignalListener.prototype.flushData = function () {
         if (!this.syncManager)
             return; // In consumer mode there is not sync manager and data to flush
-        // Flush data if there is user consent
+        // Flush impressions & events data if there is user consent
         if (isConsentGranted(this.settings)) {
             var eventsUrl = this.settings.urls.events;
             var extraMetadata = {
@@ -61,11 +61,12 @@ var BrowserSignalListener = /** @class */ (function () {
             this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
             if (this.storage.impressionCounts)
                 this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
-            if (this.storage.telemetry) {
-                var telemetryUrl = this.settings.urls.telemetry;
-                var telemetryCacheAdapter = telemetryCacheStatsAdapter(this.storage.telemetry, this.storage.splits, this.storage.segments);
-                this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
-            }
+        }
+        // Flush telemetry data
+        if (this.storage.telemetry) {
+            var telemetryUrl = this.settings.urls.telemetry;
+            var telemetryCacheAdapter = telemetryCacheStatsAdapter(this.storage.telemetry, this.storage.splits, this.storage.segments);
+            this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
         }
         // Close streaming connection
         if (this.syncManager.pushManager)

package/esm/sync/submitters/submitterManager.js

@@ -1,4 +1,3 @@
-import { syncTaskComposite } from '../syncTaskComposite';
 import { eventsSubmitterFactory } from './eventsSubmitter';
 import { impressionsSubmitterFactory } from './impressionsSubmitter';
 import { impressionCountsSubmitterFactory } from './impressionCountsSubmitter';
@@ -12,7 +11,32 @@ export function submitterManagerFactory(params) {
     if (impressionCountsSubmitter)
         submitters.push(impressionCountsSubmitter);
     var telemetrySubmitter = telemetrySubmitterFactory(params);
-    if (telemetrySubmitter)
-        submitters.push(telemetrySubmitter);
-    return syncTaskComposite(submitters);
+    return {
+        // `onlyTelemetry` true if SDK is created with userConsent not GRANTED
+        start: function (onlyTelemetry) {
+            if (!onlyTelemetry)
+                submitters.forEach(function (submitter) { return submitter.start(); });
+            if (telemetrySubmitter)
+                telemetrySubmitter.start();
+        },
+        // `allExceptTelemetry` true if userConsent is changed to DECLINED
+        stop: function (allExceptTelemetry) {
+            submitters.forEach(function (submitter) { return submitter.stop(); });
+            if (!allExceptTelemetry && telemetrySubmitter)
+                telemetrySubmitter.stop();
+        },
+        isRunning: function () {
+            return submitters.some(function (submitter) { return submitter.isRunning(); });
+        },
+        // Flush data. Called with `onlyTelemetry` true if SDK is destroyed with userConsent not GRANTED
+        execute: function (onlyTelemetry) {
+            var promises = onlyTelemetry ? [] : submitters.map(function (submitter) { return submitter.execute(); });
+            if (telemetrySubmitter)
+                promises.push(telemetrySubmitter.execute());
+            return Promise.all(promises);
+        },
+        isExecuting: function () {
+            return submitters.some(function (submitter) { return submitter.isExecuting(); });
+        }
+    };
 }

package/esm/sync/syncManagerOnline.js

@@ -25,7 +25,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
             undefined;
         /** Submitter Manager */
         // It is not inyected as push and polling managers, because at the moment it is required
-        var submitter = submitterManagerFactory(params);
+        var submitterManager = submitterManagerFactory(params);
         /** Sync Manager logic */
         function startPolling() {
             if (pollingManager.isRunning()) {
@@ -58,7 +58,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
             // E.g.: user consent, app state changes (Page hide, Foreground/Background, Online/Offline).
             pollingManager: pollingManager,
             pushManager: pushManager,
-            submitter: submitter,
+            submitterManager: submitterManager,
             /**
              * Method used to start the syncManager for the first time, or resume it after being stopped.
              */
@@ -79,8 +79,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                     }
                 }
                 // start periodic data recording (events, impressions, telemetry).
-                if (isConsentGranted(settings))
-                    submitter.start();
+                submitterManager.start(!isConsentGranted(settings));
             },
             /**
              * Method used to stop/pause the syncManager.
@@ -93,16 +92,13 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 if (pollingManager && pollingManager.isRunning())
                     pollingManager.stop();
                 // stop periodic data recording (events, impressions, telemetry).
-                submitter.stop();
+                submitterManager.stop();
             },
             isRunning: function () {
                 return running;
             },
             flush: function () {
-                if (isConsentGranted(settings))
-                    return submitter.execute();
-                else
-                    return Promise.resolve();
+                return submitterManager.execute(!isConsentGranted(settings));
             },
             // [Only used for client-side]
             // If polling and push managers are defined (standalone mode), they implement the interfaces for client-side

package/package.json

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

package/src/consent/sdkUserConsent.ts

@@ -34,9 +34,10 @@ export function createUserConsentAPI(params: ISdkFactoryContext) {
         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();
+          syncManager?.submitterManager?.start();
+        } else { // pauses submitters (except telemetry), and drops tracked data if transitioning to DECLINED
+          syncManager?.submitterManager?.stop(true);
+
           // @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();

package/src/integrations/ga/GaToSplit.ts

@@ -19,20 +19,26 @@ const logNameMapper = 'ga-to-split:mapper';
 /**
  * Provides a plugin to use with analytics.js, accounting for the possibility
  * that the global command queue has been renamed or not yet defined.
- * @param {string} pluginName The plugin name identifier.
- * @param {Function} pluginConstructor The plugin constructor function.
+ * @param window Reference to global object.
+ * @param pluginName The plugin name identifier.
+ * @param pluginConstructor The plugin constructor function.
+ * @param log Logger instance.
+ * @param autoRequire If true, log error when auto-require script is not detected
  */
-function providePlugin(pluginName: string, pluginConstructor: Function) {
+function providePlugin(window: any, pluginName: string, pluginConstructor: Function, log: ILogger, autoRequire?: boolean) {
   // get reference to global command queue. Init it if not defined yet.
-  // @ts-expect-error
   const gaAlias = window.GoogleAnalyticsObject || 'ga';
-  window[gaAlias] = window[gaAlias] || function (...args: any[]) { // @ts-expect-error
-    (window[gaAlias].q = window[gaAlias].q || []).push(args);
+  window[gaAlias] = window[gaAlias] || function () {
+    (window[gaAlias].q = window[gaAlias].q || []).push(arguments);
   };
 
   // provides the plugin for use with analytics.js.
-  // @ts-expect-error
   window[gaAlias]('provide', pluginName, pluginConstructor);
+
+  if (autoRequire && (!window[gaAlias].q || window[gaAlias].q.push === [].push)) {
+    // Expecting spy on ga.q push method but not found
+    log.error('Auto-require script was expected but not provided.');
+  }
 }
 
 // Default mapping: object used for building the default mapper from hits to Split events
@@ -284,5 +290,5 @@ export function GaToSplit(sdkOptions: GoogleAnalyticsToSplitOptions, params: IIn
   }
 
   // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
-  providePlugin('splitTracker', SplitTracker);
+  providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire);
 }

package/src/integrations/ga/autoRequire.ts

@@ -0,0 +1,35 @@
+/* eslint-disable no-undef */
+/**
+ * Auto-require script to use with GaToSplit integration
+ */
+export function autoRequire() {
+  (function (i: any, r: string, s: string) {
+    i[s] = i[s] || r;
+    i[r] = i[r] || function () { i[r].q.push(arguments); };
+    i[r].q = i[r].q || [];
+
+    var ts: any = {}; // Tracker names
+    var o = i[r].q.push;
+    i[r].q.push = function (v: any) {
+      var result = o.apply(this, arguments);
+
+      if (v && v[0] === 'create') {
+        var t = typeof v[2] === 'object' && typeof v[2].name === 'string' ?
+          v[2].name : // `ga('create', 'UA-ID', { name: 'trackerName', ... })`
+          typeof v[3] === 'object' && typeof v[3].name === 'string' ?
+            v[3].name : // `ga('create', 'UA-ID', 'auto', { name: 'trackerName', ... })`
+            typeof v[3] === 'string' ?
+              v[3] : // `ga('create', 'UA-ID', 'auto', 'trackerName')`
+              undefined; // No name tracker, e.g.: `ga('create', 'UA-ID', 'auto')`
+
+        if (!ts[t]) {
+          ts[t] = true;
+          i[r](t ? t + '.require' : 'require', 'splitTracker'); // Auto-require
+        }
+      }
+
+      return result;
+    };
+
+  })(window, 'ga', 'GoogleAnalyticsObject');
+}

package/src/integrations/ga/types.ts

@@ -53,13 +53,24 @@ export interface GoogleAnalyticsToSplitOptions {
    * 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, GTM or gtag.js script tag.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-tag-manager}
+   *
+   * @property {boolean} autoRequire
+   * @default false
+   */
+  autoRequire?: boolean,
 }
 
 /**
  * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#google-analytics-to-split}
+ * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
  */
 export interface IGoogleAnalyticsToSplitConfig extends GoogleAnalyticsToSplitOptions {
   type: 'GOOGLE_ANALYTICS_TO_SPLIT'
@@ -129,7 +140,7 @@ export interface SplitToGoogleAnalyticsOptions {
  * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#split-to-google-analytics}
+ * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
  */
 export interface ISplitToGoogleAnalyticsConfig extends SplitToGoogleAnalyticsOptions {
   type: 'SPLIT_TO_GOOGLE_ANALYTICS'

package/src/listeners/browser.ts

@@ -67,7 +67,7 @@ export class BrowserSignalListener implements ISignalListener {
   flushData() {
     if (!this.syncManager) return; // In consumer mode there is not sync manager and data to flush
 
-    // Flush data if there is user consent
+    // Flush impressions & events data if there is user consent
     if (isConsentGranted(this.settings)) {
       const eventsUrl = this.settings.urls.events;
       const extraMetadata = {
@@ -78,11 +78,13 @@ export class BrowserSignalListener implements ISignalListener {
       this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
       this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
       if (this.storage.impressionCounts) this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, fromImpressionCountsCollector);
-      if (this.storage.telemetry) {
-        const telemetryUrl = this.settings.urls.telemetry;
-        const telemetryCacheAdapter = telemetryCacheStatsAdapter(this.storage.telemetry, this.storage.splits, this.storage.segments);
-        this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
-      }
+    }
+
+    // Flush telemetry data
+    if (this.storage.telemetry) {
+      const telemetryUrl = this.settings.urls.telemetry;
+      const telemetryCacheAdapter = telemetryCacheStatsAdapter(this.storage.telemetry, this.storage.splits, this.storage.segments);
+      this._flushData(telemetryUrl + '/v1/metrics/usage/beacon', telemetryCacheAdapter, this.serviceApi.postMetricsUsage);
     }
 
     // Close streaming connection

package/src/sync/submitters/submitterManager.ts

@@ -1,11 +1,11 @@
-import { syncTaskComposite } from '../syncTaskComposite';
 import { eventsSubmitterFactory } from './eventsSubmitter';
 import { impressionsSubmitterFactory } from './impressionsSubmitter';
 import { impressionCountsSubmitterFactory } from './impressionCountsSubmitter';
 import { telemetrySubmitterFactory } from './telemetrySubmitter';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
+import { ISubmitterManager } from './types';
 
-export function submitterManagerFactory(params: ISdkFactoryContextSync) {
+export function submitterManagerFactory(params: ISdkFactoryContextSync): ISubmitterManager {
 
   const submitters = [
     impressionsSubmitterFactory(params),
@@ -15,7 +15,33 @@ export function submitterManagerFactory(params: ISdkFactoryContextSync) {
   const impressionCountsSubmitter = impressionCountsSubmitterFactory(params);
   if (impressionCountsSubmitter) submitters.push(impressionCountsSubmitter);
   const telemetrySubmitter = telemetrySubmitterFactory(params);
-  if (telemetrySubmitter) submitters.push(telemetrySubmitter);
 
-  return syncTaskComposite(submitters);
+  return {
+    // `onlyTelemetry` true if SDK is created with userConsent not GRANTED
+    start(onlyTelemetry?: boolean) {
+      if (!onlyTelemetry) submitters.forEach(submitter => submitter.start());
+      if (telemetrySubmitter) telemetrySubmitter.start();
+    },
+
+    // `allExceptTelemetry` true if userConsent is changed to DECLINED
+    stop(allExceptTelemetry?: boolean) {
+      submitters.forEach(submitter => submitter.stop());
+      if (!allExceptTelemetry && telemetrySubmitter) telemetrySubmitter.stop();
+    },
+
+    isRunning() {
+      return submitters.some(submitter => submitter.isRunning());
+    },
+
+    // Flush data. Called with `onlyTelemetry` true if SDK is destroyed with userConsent not GRANTED
+    execute(onlyTelemetry?: boolean) {
+      const promises = onlyTelemetry ? [] : submitters.map(submitter => submitter.execute());
+      if (telemetrySubmitter) promises.push(telemetrySubmitter.execute());
+      return Promise.all(promises);
+    },
+
+    isExecuting() {
+      return submitters.some(submitter => submitter.isExecuting());
+    }
+  };
 }

package/src/sync/submitters/types.ts

@@ -1,5 +1,6 @@
 import { IMetadata } from '../../dtos/types';
 import { SplitIO } from '../../types';
+import { ISyncTask } from '../types';
 
 export type ImpressionsPayload = {
   /** Split name */
@@ -191,3 +192,9 @@ export type TelemetryConfigStatsPayload = TelemetryConfigStats & {
   i?: Array<string>, // integrations
   uC: number, // userConsent
 }
+
+export interface ISubmitterManager extends ISyncTask {
+  start(onlyTelemetry?: boolean): void,
+  stop(allExceptTelemetry?: boolean): void,
+  execute(onlyTelemetry?: boolean): Promise<any>
+}

package/src/sync/syncManagerOnline.ts

@@ -40,7 +40,7 @@ export function syncManagerOnlineFactory(
 
     /** Submitter Manager */
     // It is not inyected as push and polling managers, because at the moment it is required
-    const submitter = submitterManagerFactory(params);
+    const submitterManager = submitterManagerFactory(params);
 
     /** Sync Manager logic */
 
@@ -79,7 +79,7 @@ export function syncManagerOnlineFactory(
       // E.g.: user consent, app state changes (Page hide, Foreground/Background, Online/Offline).
       pollingManager,
       pushManager,
-      submitter,
+      submitterManager,
 
       /**
        * Method used to start the syncManager for the first time, or resume it after being stopped.
@@ -102,7 +102,7 @@ export function syncManagerOnlineFactory(
         }
 
         // start periodic data recording (events, impressions, telemetry).
-        if (isConsentGranted(settings)) submitter.start();
+        submitterManager.start(!isConsentGranted(settings));
       },
 
       /**
@@ -116,7 +116,7 @@ export function syncManagerOnlineFactory(
         if (pollingManager && pollingManager.isRunning()) pollingManager.stop();
 
         // stop periodic data recording (events, impressions, telemetry).
-        submitter.stop();
+        submitterManager.stop();
       },
 
       isRunning() {
@@ -124,8 +124,7 @@ export function syncManagerOnlineFactory(
       },
 
       flush() {
-        if (isConsentGranted(settings)) return submitter.execute();
-        else return Promise.resolve();
+        return submitterManager.execute(!isConsentGranted(settings));
       },
 
       // [Only used for client-side]

package/src/sync/types.ts

@@ -2,6 +2,7 @@ import { IReadinessManager } from '../readiness/types';
 import { IStorageSync } from '../storages/types';
 import { IPollingManager } from './polling/types';
 import { IPushManager } from './streaming/types';
+import { ISubmitterManager } from './submitters/types';
 
 export interface ITask<Input extends any[] = []> {
   /**
@@ -39,7 +40,7 @@ export interface ISyncManager extends ITask {
   flush(): Promise<any>,
   pushManager?: IPushManager,
   pollingManager?: IPollingManager,
-  submitter?: ISyncTask
+  submitterManager?: ISubmitterManager
 }
 
 export interface ISyncManagerCS extends ISyncManager {

package/types/integrations/ga/autoRequire.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Auto-require script to use with GaToSplit integration
+ */
+export declare function autoRequire(): void;

package/types/integrations/ga/types.d.ts

@@ -52,12 +52,23 @@ export interface GoogleAnalyticsToSplitOptions {
      * 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, GTM or gtag.js script tag.
+     *
+     * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-tag-manager}
+     *
+     * @property {boolean} autoRequire
+     * @default false
+     */
+    autoRequire?: boolean;
 }
 /**
  * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#google-analytics-to-split}
+ * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
  */
 export interface IGoogleAnalyticsToSplitConfig extends GoogleAnalyticsToSplitOptions {
     type: 'GOOGLE_ANALYTICS_TO_SPLIT';
@@ -125,7 +136,7 @@ export interface SplitToGoogleAnalyticsOptions {
  * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
  * Used by the browser variant of the isomorphic JS SDK.
  *
- * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#split-to-google-analytics}
+ * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
  */
 export interface ISplitToGoogleAnalyticsConfig extends SplitToGoogleAnalyticsOptions {
     type: 'SPLIT_TO_GOOGLE_ANALYTICS';

package/types/sync/submitters/submitterManager.d.ts

@@ -1,2 +1,3 @@
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-export declare function submitterManagerFactory(params: ISdkFactoryContextSync): import("../types").ISyncTask<[], any>;
+import { ISubmitterManager } from './types';
+export declare function submitterManagerFactory(params: ISdkFactoryContextSync): ISubmitterManager;

package/types/sync/submitters/types.d.ts

@@ -1,5 +1,6 @@
 import { IMetadata } from '../../dtos/types';
 import { SplitIO } from '../../types';
+import { ISyncTask } from '../types';
 export declare type ImpressionsPayload = {
     /** Split name */
     f: string;
@@ -169,3 +170,8 @@ export declare type TelemetryConfigStatsPayload = TelemetryConfigStats & {
     i?: Array<string>;
     uC: number;
 };
+export interface ISubmitterManager extends ISyncTask {
+    start(onlyTelemetry?: boolean): void;
+    stop(allExceptTelemetry?: boolean): void;
+    execute(onlyTelemetry?: boolean): Promise<any>;
+}

package/types/sync/types.d.ts

@@ -2,6 +2,7 @@ import { IReadinessManager } from '../readiness/types';
 import { IStorageSync } from '../storages/types';
 import { IPollingManager } from './polling/types';
 import { IPushManager } from './streaming/types';
+import { ISubmitterManager } from './submitters/types';
 export interface ITask<Input extends any[] = []> {
     /**
      * Start periodic execution of the task
@@ -35,7 +36,7 @@ export interface ISyncManager extends ITask {
     flush(): Promise<any>;
     pushManager?: IPushManager;
     pollingManager?: IPollingManager;
-    submitter?: ISyncTask;
+    submitterManager?: ISubmitterManager;
 }
 export interface ISyncManagerCS extends ISyncManager {
     shared(matchingKey: string, readinessManager: IReadinessManager, storage: IStorageSync): ISyncManager | undefined;

package/cjs/sync/syncTaskComposite.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.syncTaskComposite = void 0;
-/**
- * Composite Sync Task: group of sync tasks that are treated as a single one.
- */
-function syncTaskComposite(syncTasks) {
-    return {
-        start: function () {
-            syncTasks.forEach(function (syncTask) { return syncTask.start(); });
-        },
-        stop: function () {
-            syncTasks.forEach(function (syncTask) { return syncTask.stop(); });
-        },
-        isRunning: function () {
-            return syncTasks.some(function (syncTask) { return syncTask.isRunning(); });
-        },
-        execute: function () {
-            return Promise.all(syncTasks.map(function (syncTask) { return syncTask.execute(); }));
-        },
-        isExecuting: function () {
-            return syncTasks.some(function (syncTask) { return syncTask.isExecuting(); });
-        }
-    };
-}
-exports.syncTaskComposite = syncTaskComposite;

package/esm/sync/syncTaskComposite.js

@@ -1,22 +0,0 @@
-/**
- * Composite Sync Task: group of sync tasks that are treated as a single one.
- */
-export function syncTaskComposite(syncTasks) {
-    return {
-        start: function () {
-            syncTasks.forEach(function (syncTask) { return syncTask.start(); });
-        },
-        stop: function () {
-            syncTasks.forEach(function (syncTask) { return syncTask.stop(); });
-        },
-        isRunning: function () {
-            return syncTasks.some(function (syncTask) { return syncTask.isRunning(); });
-        },
-        execute: function () {
-            return Promise.all(syncTasks.map(function (syncTask) { return syncTask.execute(); }));
-        },
-        isExecuting: function () {
-            return syncTasks.some(function (syncTask) { return syncTask.isExecuting(); });
-        }
-    };
-}

package/src/sync/syncTaskComposite.ts

@@ -1,26 +0,0 @@
-import { ISyncTask } from './types';
-
-/**
- * Composite Sync Task: group of sync tasks that are treated as a single one.
- */
-export function syncTaskComposite(syncTasks: ISyncTask[]): ISyncTask {
-
-  return {
-    start() {
-      syncTasks.forEach(syncTask => syncTask.start());
-    },
-    stop() {
-      syncTasks.forEach(syncTask => syncTask.stop());
-    },
-    isRunning() {
-      return syncTasks.some(syncTask => syncTask.isRunning());
-    },
-    execute() {
-      return Promise.all(syncTasks.map(syncTask => syncTask.execute()));
-    },
-    isExecuting() {
-      return syncTasks.some(syncTask => syncTask.isExecuting());
-    }
-  };
-
-}