@splitsoftware/splitio 10.23.1-rc.2 → 10.23.1-rc.3

package/CHANGES.txt

@@ -2,7 +2,7 @@
  - Updated @splitsoftware/splitio-commons package to version 1.9.1. This update removes the handler for 'unload' DOM events, that can prevent browsers from being able to put pages in the back/forward cache for faster back and forward loads (Related to issue https://github.com/splitio/javascript-client/issues/759).
 
 10.23.0 (July 18, 2023)
- - Updated @splitsoftware/splitio-commons package to version 1.8.4 that includes minor improvements:
+ - Updated @splitsoftware/splitio-commons package to version 1.9.0 that includes minor improvements:
     - Updated streaming architecture implementation to apply feature flag updates from the notification received which is now enhanced, improving efficiency and reliability of the whole update system.
 
 10.22.6 (July 6, 2023)

package/es/factory/browserSuite.js

@@ -0,0 +1,67 @@
+import { objectAssign } from '@splitsoftware/splitio-commons/esm/utils/lang/objectAssign';
+import { _Set, setToArray } from '@splitsoftware/splitio-commons/esm/utils/lang/sets';
+import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
+// @TODO import RumAgent automatically or users should import it?
+import { SplitRumAgent } from '@splitsoftware/browser-rum-agent';
+import { SplitFactory } from './browser';
+var DEFAULT_TRAFFIC_TYPE = 'user';
+/**
+ * SplitFactory for client-side with RUM Agent.
+ *
+ * @param {import('../../types/splitio').IBrowserSuiteSettings} config configuration object used to instantiate the Suite
+ * @param {Function=} __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
+ * @throws Will throw an error if the provided config is invalid.
+ */
+export function SplitSuite(config, __updateModules) {
+    var sdk = SplitFactory(config, __updateModules);
+    /** @type {import('../../types/splitio').IBrowserSuiteSettings} */
+    var settings = sdk.settings;
+    // Do not setup RUM Agent if not in standalone mode
+    if (settings.mode !== STANDALONE_MODE)
+        return sdk;
+    // Setup RUM Agent
+    var agentConfig = SplitRumAgent.__getConfig();
+    if (agentConfig.a) {
+        settings.log.warn('RUM Agent already setup. The new Suite instance will reset the RUM Agent configuration.');
+    }
+    agentConfig.log = settings.log;
+    SplitRumAgent.removeIdentities(); // reset identities for new Suite
+    SplitRumAgent.setup(settings.core.authorizationKey, objectAssign({
+        url: settings.urls.events,
+        userConsent: settings.userConsent
+    }, settings.rumAgent));
+    var clients = new _Set();
+    // Override UserConsent.setStatus to update RUM Agent consent
+    var originalSetStatus = sdk.UserConsent.setStatus;
+    sdk.UserConsent.setStatus = function (newStatus) {
+        SplitRumAgent.setUserConsent(newStatus);
+        return originalSetStatus.apply(this, arguments);
+    };
+    // Create Suite instance extending SDK
+    return objectAssign({}, sdk, {
+        client: function () {
+            var client = sdk.client.apply(sdk, arguments);
+            if (!clients.has(client)) {
+                clients.add(client);
+                SplitRumAgent.addIdentity({
+                    key: client.key,
+                    trafficType: client.trafficType || DEFAULT_TRAFFIC_TYPE
+                });
+                // override client.destroy to remove identity from RUM Agent
+                var originalDestroy_1 = client.destroy;
+                client.destroy = function () {
+                    SplitRumAgent.removeIdentity({
+                        key: client.key,
+                        trafficType: client.trafficType || DEFAULT_TRAFFIC_TYPE
+                    });
+                    return originalDestroy_1.apply(client, arguments);
+                };
+            }
+            return client;
+        },
+        destroy: function () {
+            return Promise.all(setToArray(clients).map(function (client) { return client.destroy(); }));
+        }
+    });
+}

package/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.23.1-rc.2';
+export var packageVersion = '10.23.1-rc.3';

package/lib/factory/browserSuite.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplitSuite = void 0;
+var objectAssign_1 = require("@splitsoftware/splitio-commons/cjs/utils/lang/objectAssign");
+var sets_1 = require("@splitsoftware/splitio-commons/cjs/utils/lang/sets");
+var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
+// @TODO import RumAgent automatically or users should import it?
+var browser_rum_agent_1 = require("@splitsoftware/browser-rum-agent");
+var browser_1 = require("./browser");
+var DEFAULT_TRAFFIC_TYPE = 'user';
+/**
+ * SplitFactory for client-side with RUM Agent.
+ *
+ * @param {import('../../types/splitio').IBrowserSuiteSettings} config configuration object used to instantiate the Suite
+ * @param {Function=} __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
+ * @throws Will throw an error if the provided config is invalid.
+ */
+function SplitSuite(config, __updateModules) {
+    var sdk = (0, browser_1.SplitFactory)(config, __updateModules);
+    /** @type {import('../../types/splitio').IBrowserSuiteSettings} */
+    var settings = sdk.settings;
+    // Do not setup RUM Agent if not in standalone mode
+    if (settings.mode !== constants_1.STANDALONE_MODE)
+        return sdk;
+    // Setup RUM Agent
+    var agentConfig = browser_rum_agent_1.SplitRumAgent.__getConfig();
+    if (agentConfig.a) {
+        settings.log.warn('RUM Agent already setup. The new Suite instance will reset the RUM Agent configuration.');
+    }
+    agentConfig.log = settings.log;
+    browser_rum_agent_1.SplitRumAgent.removeIdentities(); // reset identities for new Suite
+    browser_rum_agent_1.SplitRumAgent.setup(settings.core.authorizationKey, (0, objectAssign_1.objectAssign)({
+        url: settings.urls.events,
+        userConsent: settings.userConsent
+    }, settings.rumAgent));
+    var clients = new sets_1._Set();
+    // Override UserConsent.setStatus to update RUM Agent consent
+    var originalSetStatus = sdk.UserConsent.setStatus;
+    sdk.UserConsent.setStatus = function (newStatus) {
+        browser_rum_agent_1.SplitRumAgent.setUserConsent(newStatus);
+        return originalSetStatus.apply(this, arguments);
+    };
+    // Create Suite instance extending SDK
+    return (0, objectAssign_1.objectAssign)({}, sdk, {
+        client: function () {
+            var client = sdk.client.apply(sdk, arguments);
+            if (!clients.has(client)) {
+                clients.add(client);
+                browser_rum_agent_1.SplitRumAgent.addIdentity({
+                    key: client.key,
+                    trafficType: client.trafficType || DEFAULT_TRAFFIC_TYPE
+                });
+                // override client.destroy to remove identity from RUM Agent
+                var originalDestroy_1 = client.destroy;
+                client.destroy = function () {
+                    browser_rum_agent_1.SplitRumAgent.removeIdentity({
+                        key: client.key,
+                        trafficType: client.trafficType || DEFAULT_TRAFFIC_TYPE
+                    });
+                    return originalDestroy_1.apply(client, arguments);
+                };
+            }
+            return client;
+        },
+        destroy: function () {
+            return Promise.all((0, sets_1.setToArray)(clients).map(function (client) { return client.destroy(); }));
+        }
+    });
+}
+exports.SplitSuite = SplitSuite;

package/lib/settings/defaults/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageVersion = void 0;
-exports.packageVersion = '10.23.1-rc.2';
+exports.packageVersion = '10.23.1-rc.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.23.1-rc.2",
+  "version": "10.23.1-rc.3",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -12,6 +12,7 @@
     "es",
     "src",
     "scripts/ga-to-split-autorequire.js",
+    "suite",
     "client",
     "server"
   ],
@@ -40,7 +41,8 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.9.1",
+    "@splitsoftware/browser-rum-agent": "0.3.2-rc.0",
+    "@splitsoftware/splitio-commons": "1.9.2-rc.2",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "bloom-filters": "^3.0.0",
@@ -100,13 +102,14 @@
     "check:version": "cross-env NODE_ENV=test tape -r ./ts-node.register src/settings/__tests__/defaults.spec.js",
     "test-browser": "npm run test-browser-unit && npm run test-browser-e2e",
     "test-browser-unit": "cross-env NODE_ENV=test karma start karma/unit.karma.conf.js",
-    "test-browser-e2e": "npm run test-browser-e2e-online && npm run test-browser-e2e-offline && npm run test-browser-e2e-destroy && npm run test-browser-e2e-errorCatching && npm run test-browser-e2e-push && npm run test-browser-e2e-gaIntegration",
+    "test-browser-e2e": "npm run test-browser-e2e-online && npm run test-browser-e2e-offline && npm run test-browser-e2e-destroy && npm run test-browser-e2e-errorCatching && npm run test-browser-e2e-push && npm run test-browser-e2e-gaIntegration && npm run test-browser-e2e-suite",
     "test-browser-e2e-online": "cross-env NODE_ENV=test karma start karma/e2e.online.karma.conf.js",
     "test-browser-e2e-offline": "cross-env NODE_ENV=test karma start karma/e2e.offline.karma.conf.js",
     "test-browser-e2e-destroy": "cross-env NODE_ENV=test karma start karma/e2e.destroy.karma.conf.js",
     "test-browser-e2e-errorCatching": "cross-env NODE_ENV=test karma start karma/e2e.errorCatching.karma.conf.js",
     "test-browser-e2e-push": "cross-env NODE_ENV=test karma start karma/e2e.push.karma.conf.js",
     "test-browser-e2e-gaIntegration": "cross-env NODE_ENV=test karma start karma/e2e.gaIntegration.karma.conf.js",
+    "test-browser-e2e-suite": "cross-env NODE_ENV=test karma start karma/e2e.suite.karma.conf.js",
     "test-node": "npm run test-node-unit && npm run test-node-e2e",
     "test-node-unit": "cross-env NODE_ENV=test tape -r ./ts-node.register \"src/*/**/__tests__/**/!(browser).spec.js\" | tap-min",
     "test-node-e2e": "npm run test-node-e2e-online && npm run test-node-e2e-offline && npm run test-node-e2e-destroy && npm run test-node-e2e-errorCatching && npm run test-node-e2e-push && npm run test-node-e2e-redis",

package/src/factory/browserSuite.js

@@ -0,0 +1,79 @@
+import { objectAssign } from '@splitsoftware/splitio-commons/src/utils/lang/objectAssign';
+import { _Set, setToArray } from '@splitsoftware/splitio-commons/src/utils/lang/sets';
+import { STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
+// @TODO import RumAgent automatically or users should import it?
+import { SplitRumAgent } from '@splitsoftware/browser-rum-agent';
+import { SplitFactory } from './browser';
+
+const DEFAULT_TRAFFIC_TYPE = 'user';
+
+/**
+ * SplitFactory for client-side with RUM Agent.
+ *
+ * @param {import('../../types/splitio').IBrowserSuiteSettings} config configuration object used to instantiate the Suite
+ * @param {Function=} __updateModules optional function that lets redefine internal SDK modules. Use with
+ * caution since, unlike `config`, this param is not validated neither considered part of the public API.
+ * @throws Will throw an error if the provided config is invalid.
+ */
+export function SplitSuite(config, __updateModules) {
+  const sdk = SplitFactory(config, __updateModules);
+
+  /** @type {import('../../types/splitio').IBrowserSuiteSettings} */
+  const settings = sdk.settings;
+
+  // Do not setup RUM Agent if not in standalone mode
+  if (settings.mode !== STANDALONE_MODE) return sdk;
+
+  // Setup RUM Agent
+  const agentConfig = SplitRumAgent.__getConfig();
+  if (agentConfig.a) {
+    settings.log.warn('RUM Agent already setup. The new Suite instance will reset the RUM Agent configuration.');
+  }
+  agentConfig.log = settings.log;
+  SplitRumAgent.removeIdentities(); // reset identities for new Suite
+  SplitRumAgent.setup(settings.core.authorizationKey, objectAssign({
+    url: settings.urls.events,
+    userConsent: settings.userConsent
+  }, settings.rumAgent));
+
+  const clients = new _Set();
+
+  // Override UserConsent.setStatus to update RUM Agent consent
+  const originalSetStatus = sdk.UserConsent.setStatus;
+  sdk.UserConsent.setStatus = function (newStatus) {
+    SplitRumAgent.setUserConsent(newStatus);
+    return originalSetStatus.apply(this, arguments);
+  };
+
+  // Create Suite instance extending SDK
+  return objectAssign({}, sdk, {
+    client() {
+      const client = sdk.client.apply(sdk, arguments);
+
+      if (!clients.has(client)) {
+        clients.add(client);
+
+        SplitRumAgent.addIdentity({
+          key: client.key,
+          trafficType: client.trafficType || DEFAULT_TRAFFIC_TYPE
+        });
+
+        // override client.destroy to remove identity from RUM Agent
+        const originalDestroy = client.destroy;
+        client.destroy = function () {
+          SplitRumAgent.removeIdentity({
+            key: client.key,
+            trafficType: client.trafficType || DEFAULT_TRAFFIC_TYPE
+          });
+          return originalDestroy.apply(client, arguments);
+        };
+      }
+
+      return client;
+    },
+
+    destroy() {
+      return Promise.all(setToArray(clients).map(client => client.destroy()));
+    }
+  });
+}

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.23.1-rc.2';
+export const packageVersion = '10.23.1-rc.3';

package/suite/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../lib/factory/browserSuite.js",
+  "module": "../es/factory/browserSuite.js",
+  "types": "../types/suite/index.d.ts"
+}

package/types/splitio.d.ts

@@ -4,6 +4,7 @@
 
 /// <reference types="google.analytics" />
 import { RedisOptions } from "ioredis";
+import { SplitRumAgentConfig, EventCollector } from '@splitsoftware/browser-rum-agent';
 
 export as namespace SplitIO;
 export = SplitIO;
@@ -189,8 +190,14 @@ interface IUserConsentAPI {
  */
 interface ISharedSettings {
   /**
-   * Whether the logger should be enabled or disabled by default.
-   * @property {Boolean} debug
+   * Boolean value to indicate whether the logger should be enabled or disabled, or a log level string.
+   *
+   * Examples:
+   * ```javascript
+   * config.debug = true
+   * config.debug = 'WARN'
+   * ```
+   * @property {boolean | LogLevel} debug
    * @default false
    */
   debug?: boolean | LogLevel,
@@ -1113,6 +1120,19 @@ declare namespace SplitIO {
      */
     userConsent?: ConsentStatus
   }
+  /**
+   * Settings interface for Suite instances created on the browser.
+   * @interface IBrowserSuiteSettings
+   * @extends IBrowserSettings
+   * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#configuration}
+   */
+  interface IBrowserSuiteSettings extends IBrowserSettings {
+    /**
+     * Optional configuration object for the RUM agent.
+     * @see {@link https://help.split.io/hc/en-us/articles/360030898431-Browser-RUM-agent#configuration}
+     */
+    rumAgent?: SplitRumAgentConfig
+  }
   /**
    * Settings interface for SDK instances created on NodeJS.
    * If your storage is asynchronous (Redis for example) use SplitIO.INodeAsyncSettings instead.
@@ -1282,8 +1302,8 @@ declare namespace SplitIO {
   }
   /**
    * This represents the interface for the SDK instance with synchronous storage.
-   * @interface ISDK
-   * @extends IBasicSDK
+   * @interface IBrowserSDK
+   * @extends ISDK
    */
   interface IBrowserSDK extends ISDK {
     /**
@@ -1306,6 +1326,41 @@ declare namespace SplitIO {
      */
     UserConsent: IUserConsentAPI
   }
+  /**
+   * This represents the interface for the Suite instance, that is an extension of the SDK interface.
+   * @interface IBrowserSuiteSDK
+   * @extends IBrowserSDK
+   */
+  interface IBrowserSuiteSDK extends IBrowserSDK {
+    /**
+     * Returns the default client instance of the SDK, and adds its identity (i.e., user key and traffic type pair) to the RUM agent to track events for it.
+     *
+     * NOTE: if no traffic type was provided to the config, 'user' will be used as default for the RUM Agent.
+     *
+     * @function client
+     * @returns {IBrowserClient} The client instance.
+     */
+    client(): IBrowserClient,
+    /**
+     * Returns a shared client of the SDK, and adds its identity (i.e., user key and traffic type pair) to the RUM agent to track events for it.
+     *
+     * NOTE: if no traffic type is provided as second argument, 'user' will be used as default for the RUM Agent.
+     *
+     * @function client
+     * @param {SplitKey} key The key for the new client instance.
+     * @param {string=} trafficType The traffic type of the provided key.
+     * @returns {IBrowserClient} The client instance.
+     */
+    client(key: SplitKey, trafficType?: string): IBrowserClient
+    /**
+     * Destroys all client instances and remove identities from the RUM agent to stop tracking events for them.
+     * This method will flush any pending impressions and events, and stop the synchronization of feature flag definitions with the backend.
+     *
+     * @function destroy
+     * @returns {Promise<void>} A promise that resolves once the client is destroyed.
+     */
+    destroy(): Promise<void>
+  }
   /**
    * This represents the interface for the SDK instance with asynchronous storage.
    * @interface IAsyncSDK

package/types/suite/index.d.ts

@@ -0,0 +1,12 @@
+// Declaration file for JavaScript Split Software SDK
+// Project: http://www.split.io/
+
+/// <reference path="../splitio.d.ts" />
+export = JsSdk;
+
+declare module JsSdk {
+  /**
+   * @TODO
+   */
+  export function SplitSuite(settings: SplitIO.IBrowserSuiteSettings): SplitIO.IBrowserSuiteSDK;
+}