@splitsoftware/splitio-browserjs 0.6.1-rc.2 → 0.7.1-rc.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/full/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataLoaderFactory = exports.PluggableStorage = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = exports.SplitToGoogleAnalytics = exports.GoogleAnalyticsToSplit = exports.InLocalStorage = exports.SplitFactory = void 0;
+exports.PluggableStorage = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = exports.SplitToGoogleAnalytics = exports.GoogleAnalyticsToSplit = exports.InLocalStorage = exports.SplitFactory = void 0;
 var splitFactory_1 = require("./splitFactory");
 Object.defineProperty(exports, "SplitFactory", { enumerable: true, get: function () { return splitFactory_1.SplitFactory; } });
 var index_1 = require("@splitsoftware/splitio-commons/cjs/storages/inLocalStorage/index");
@@ -19,5 +19,3 @@ var DebugLogger_1 = require("@splitsoftware/splitio-commons/cjs/logger/browser/D
 Object.defineProperty(exports, "DebugLogger", { enumerable: true, get: function () { return DebugLogger_1.DebugLogger; } });
 var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/storages/pluggable");
 Object.defineProperty(exports, "PluggableStorage", { enumerable: true, get: function () { return pluggable_1.PluggableStorage; } });
-var dataLoader_1 = require("@splitsoftware/splitio-commons/cjs/storages/dataLoader");
-Object.defineProperty(exports, "DataLoaderFactory", { enumerable: true, get: function () { return dataLoader_1.DataLoaderFactory; } });

package/cjs/full/umd.js

@@ -11,6 +11,5 @@ index_1.SplitFactory.ErrorLogger = index_1.ErrorLogger;
 index_1.SplitFactory.WarnLogger = index_1.WarnLogger;
 index_1.SplitFactory.InfoLogger = index_1.InfoLogger;
 index_1.SplitFactory.DebugLogger = index_1.DebugLogger;
-index_1.SplitFactory.DataLoaderFactory = index_1.DataLoaderFactory;
 // eslint-disable-next-line import/no-default-export
 exports.default = index_1.SplitFactory;

package/cjs/index.js

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 **/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataLoaderFactory = exports.PluggableStorage = exports.LocalhostFromObject = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = exports.SplitToGoogleAnalytics = exports.GoogleAnalyticsToSplit = exports.InLocalStorage = exports.SplitFactory = void 0;
+exports.PluggableStorage = exports.LocalhostFromObject = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = exports.SplitToGoogleAnalytics = exports.GoogleAnalyticsToSplit = exports.InLocalStorage = exports.SplitFactory = void 0;
 var splitFactory_1 = require("./splitFactory");
 Object.defineProperty(exports, "SplitFactory", { enumerable: true, get: function () { return splitFactory_1.SplitFactory; } });
 var index_1 = require("@splitsoftware/splitio-commons/cjs/storages/inLocalStorage/index");
@@ -36,5 +36,3 @@ var LocalhostFromObject_1 = require("@splitsoftware/splitio-commons/cjs/sync/off
 Object.defineProperty(exports, "LocalhostFromObject", { enumerable: true, get: function () { return LocalhostFromObject_1.LocalhostFromObject; } });
 var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/storages/pluggable");
 Object.defineProperty(exports, "PluggableStorage", { enumerable: true, get: function () { return pluggable_1.PluggableStorage; } });
-var dataLoader_1 = require("@splitsoftware/splitio-commons/cjs/storages/dataLoader");
-Object.defineProperty(exports, "DataLoaderFactory", { enumerable: true, get: function () { return dataLoader_1.DataLoaderFactory; } });

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.2';
+var packageVersion = '0.7.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/full/index.js

@@ -7,4 +7,3 @@ export { WarnLogger } from '@splitsoftware/splitio-commons/esm/logger/browser/Wa
 export { InfoLogger } from '@splitsoftware/splitio-commons/esm/logger/browser/InfoLogger';
 export { DebugLogger } from '@splitsoftware/splitio-commons/esm/logger/browser/DebugLogger';
 export { PluggableStorage } from '@splitsoftware/splitio-commons/esm/storages/pluggable';
-export { DataLoaderFactory } from '@splitsoftware/splitio-commons/esm/storages/dataLoader';

package/esm/full/umd.js

@@ -1,5 +1,5 @@
 // @ts-nocheck
-import { SplitFactory, InLocalStorage, GoogleAnalyticsToSplit, SplitToGoogleAnalytics, ErrorLogger, WarnLogger, InfoLogger, DebugLogger, DataLoaderFactory } from './index';
+import { SplitFactory, InLocalStorage, GoogleAnalyticsToSplit, SplitToGoogleAnalytics, ErrorLogger, WarnLogger, InfoLogger, DebugLogger } from './index';
 // Include all pluggable modules as properties to expose at the global `splitio` object
 SplitFactory.SplitFactory = SplitFactory;
 SplitFactory.InLocalStorage = InLocalStorage;
@@ -9,6 +9,5 @@ SplitFactory.ErrorLogger = ErrorLogger;
 SplitFactory.WarnLogger = WarnLogger;
 SplitFactory.InfoLogger = InfoLogger;
 SplitFactory.DebugLogger = DebugLogger;
-SplitFactory.DataLoaderFactory = DataLoaderFactory;
 // eslint-disable-next-line import/no-default-export
 export default SplitFactory;

package/esm/index.js

@@ -23,4 +23,3 @@ export { InfoLogger } from '@splitsoftware/splitio-commons/esm/logger/browser/In
 export { DebugLogger } from '@splitsoftware/splitio-commons/esm/logger/browser/DebugLogger';
 export { LocalhostFromObject } from '@splitsoftware/splitio-commons/esm/sync/offline/LocalhostFromObject';
 export { PluggableStorage } from '@splitsoftware/splitio-commons/esm/storages/pluggable';
-export { DataLoaderFactory } from '@splitsoftware/splitio-commons/esm/storages/dataLoader';

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.2';
+var packageVersion = '0.7.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "0.6.1-rc.2",
+  "version": "0.7.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,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.2",
+    "@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/full/index.ts

@@ -7,4 +7,3 @@ export { WarnLogger } from '@splitsoftware/splitio-commons/src/logger/browser/Wa
 export { InfoLogger } from '@splitsoftware/splitio-commons/src/logger/browser/InfoLogger';
 export { DebugLogger } from '@splitsoftware/splitio-commons/src/logger/browser/DebugLogger';
 export { PluggableStorage } from '@splitsoftware/splitio-commons/src/storages/pluggable';
-export { DataLoaderFactory } from '@splitsoftware/splitio-commons/src/storages/dataLoader';

package/src/full/umd.ts

@@ -1,5 +1,5 @@
 // @ts-nocheck
-import { SplitFactory, InLocalStorage, GoogleAnalyticsToSplit, SplitToGoogleAnalytics, ErrorLogger, WarnLogger, InfoLogger, DebugLogger, DataLoaderFactory } from './index';
+import { SplitFactory, InLocalStorage, GoogleAnalyticsToSplit, SplitToGoogleAnalytics, ErrorLogger, WarnLogger, InfoLogger, DebugLogger } from './index';
 
 // Include all pluggable modules as properties to expose at the global `splitio` object
 SplitFactory.SplitFactory = SplitFactory;
@@ -10,7 +10,6 @@ SplitFactory.ErrorLogger = ErrorLogger;
 SplitFactory.WarnLogger = WarnLogger;
 SplitFactory.InfoLogger = InfoLogger;
 SplitFactory.DebugLogger = DebugLogger;
-SplitFactory.DataLoaderFactory = DataLoaderFactory;
 
 // eslint-disable-next-line import/no-default-export
 export default SplitFactory;

package/src/index.ts

@@ -24,4 +24,3 @@ export { InfoLogger } from '@splitsoftware/splitio-commons/src/logger/browser/In
 export { DebugLogger } from '@splitsoftware/splitio-commons/src/logger/browser/DebugLogger';
 export { LocalhostFromObject } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromObject';
 export { PluggableStorage } from '@splitsoftware/splitio-commons/src/storages/pluggable';
-export { DataLoaderFactory } from '@splitsoftware/splitio-commons/src/storages/dataLoader';

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.2';
+const packageVersion = '0.7.1-rc.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;
 
@@ -74,9 +74,4 @@ declare module JsSdk {
    * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#logging}
    */
   export function ErrorLogger(): SplitIO.ILogger;
-
-  /**
-   * @TODO
-   */
-  export function DataLoaderFactory(preloadedData: SplitIO.PreloadedData): SplitIO.DataLoader;
 }

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;
 
@@ -82,9 +82,4 @@ declare module JsSdk {
    * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#localhost-mode}
    */
   export function LocalhostFromObject(): SplitIO.LocalhostFactory;
-
-  /**
-   * @TODO
-   */
-  export function DataLoaderFactory(preloadedData: SplitIO.PreloadedData): SplitIO.DataLoader;
 }

package/types/splitio.d.ts

@@ -73,7 +73,6 @@ interface ISettings {
     eventsFirstPushWindow: number
   },
   readonly storage?: SplitIO.StorageSyncFactory | SplitIO.StorageAsyncFactory,
-  readonly dataLoader?: SplitIO.DataLoader,
   readonly urls: {
     events: string,
     sdk: string,
@@ -94,7 +93,6 @@ interface ISettings {
     impressionsMode: SplitIO.ImpressionsMode,
     localhostMode?: SplitIO.LocalhostFactory,
     enabled?: boolean
-    onlySubmitters?: boolean
   },
   readonly userConsent: SplitIO.ConsentStatus
 }
@@ -255,14 +253,6 @@ interface ISharedSettings {
      * @default true
      */
     enabled?: boolean
-    /*
-     * @TODO
-     *
-     * False by default.
-     * If true and standalone mode, it will DISABLE splits and segments synchronization (i.e., polling and streaming).
-     * In consumer and partial consumer mode, it has no effect
-     */
-    onlySubmitters?: boolean
   }
 }
 /**
@@ -553,10 +543,6 @@ declare namespace SplitIO {
      */
     prefix?: string
   }
-  /**
-   * @TODO
-   */
-  type DataLoader = (storage: StorageSync, key?: string) => void
   /**
    * Storage for asynchronous (consumer) SDK.
    * Its interface details are not part of the public API.
@@ -642,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 {
     /**
@@ -683,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).
@@ -694,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 {
     /**
@@ -813,42 +810,6 @@ declare namespace SplitIO {
   * @typedef {string} ImpressionsMode
   */
   type ImpressionsMode = 'OPTIMIZED' | 'DEBUG';
-  /**
-   * Defines the format of Split data to preload on the factory storage (cache).
-   */
-  interface PreloadedData {
-    /**
-     * Timestamp of the last moment the data was synchronized with Split servers.
-     * If this value is older than 10 days ago (expiration time policy), the data is not used to update the storage content.
-     * @TODO configurable expiration time policy?
-     */
-    lastUpdated: number,
-    /**
-     * Change number of the preloaded data.
-     * If this value is older than the current changeNumber at the storage, the data is not used to update the storage content.
-     */
-    since: number,
-    /**
-     * Map of splits to their serialized definitions.
-     */
-    splitsData: {
-      [splitName: string]: string
-    },
-    /**
-     * Optional map of user keys to their list of segments.
-     * @TODO remove when releasing first version
-     */
-    mySegmentsData?: {
-      [key: string]: string[]
-    },
-    /**
-     * Optional map of segments to their serialized definitions.
-     * This property is ignored if `mySegmentsData` was provided.
-     */
-    segmentsData?: {
-      [segmentName: string]: string
-    },
-  }
   /**
    * User consent status.
    * @typedef {string} ConsentStatus
@@ -954,10 +915,6 @@ declare namespace SplitIO {
      * @property {Object} storage
      */
     storage?: StorageSyncFactory,
-    /**
-     * @TODO
-     */
-    dataLoader?: DataLoader,
     /**
      * SDK Startup settings for the Browser.
      * @property {Object} startup