@splitsoftware/splitio-browserjs 1.0.0-rc.2 → 1.0.0-rc.3

package/CHANGES.txt

@@ -3,11 +3,10 @@
  - Added `factory.destroy()` method, which invokes the `destroy` method of all clients created by the factory.
  - Updated @splitsoftware/splitio-commons package to version 2.0.0 that includes major updates and updated some transitive dependencies for vulnerability fixes.
  - BREAKING CHANGES:
-    - Renamed some TypeScript definitions in the SplitIO namespace to avoid conflicts with other libraries: `SplitIO.IBrowserSettings` to `SplitIO.IClientSideSettings`, `SplitIO.IBrowserAsyncSettings` to `SplitIO.IClientSideAsyncSettings`.
+    - Renamed some TypeScript definitions in the SplitIO namespace to avoid conflicts with other Split packages: `SplitIO.IBrowserSettings` to `SplitIO.IClientSideSettings`, `SplitIO.IBrowserAsyncSettings` to `SplitIO.IClientSideAsyncSettings`, `SplitIO.ISDK` to `SplitIO.IBrowserSDK`, and `SplitIO.IAsyncSDK` to `SplitIO.IBrowserAsyncSDK`.
     - Removed internal ponyfills for the `Map` and `Set` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or provide a polyfill.
     - Removed the deprecated `GoogleAnalyticsToSplit` and `SplitToGoogleAnalytics` pluggable integration modules, along with the related interfaces in the TypeScript definitions.
     - Removed the `LocalhostFromObject` export from the default import (`import { LocalhostFromObject } from '@splitsoftware/splitio-browserjs'`). It is no longer necessary to manually import and configure it in the `sync.localhostMode` option to enable localhost mode.
-    - Removed the "full" import (`import { SplitFactory } from '@splitsoftware/splitio-browserjs/full'`), since with the removal of `LocalhostFromObject` from the default import, the difference between them is minimal. The "full" import differs only by including the `unfetch` ponyfill to support older browsers.
 
 0.15.0 (September 13, 2024)
  - Updated @splitsoftware/splitio-commons package to version 1.17.0 that includes minor updates:

package/cjs/full/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PluggableStorage = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = 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");
+Object.defineProperty(exports, "InLocalStorage", { enumerable: true, get: function () { return index_1.InLocalStorage; } });
+var ErrorLogger_1 = require("@splitsoftware/splitio-commons/cjs/logger/browser/ErrorLogger");
+Object.defineProperty(exports, "ErrorLogger", { enumerable: true, get: function () { return ErrorLogger_1.ErrorLogger; } });
+var WarnLogger_1 = require("@splitsoftware/splitio-commons/cjs/logger/browser/WarnLogger");
+Object.defineProperty(exports, "WarnLogger", { enumerable: true, get: function () { return WarnLogger_1.WarnLogger; } });
+var InfoLogger_1 = require("@splitsoftware/splitio-commons/cjs/logger/browser/InfoLogger");
+Object.defineProperty(exports, "InfoLogger", { enumerable: true, get: function () { return InfoLogger_1.InfoLogger; } });
+var DebugLogger_1 = require("@splitsoftware/splitio-commons/cjs/logger/browser/DebugLogger");
+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; } });

package/cjs/full/splitFactory.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplitFactory = void 0;
+var full_1 = require("../settings/full");
+var getModules_1 = require("../platform/getModules");
+var index_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory/index");
+var getFetchFull_1 = require("../platform/getFetchFull");
+var getEventSource_1 = require("../platform/getEventSource");
+var MinEvents_1 = require("@splitsoftware/splitio-commons/cjs/utils/MinEvents");
+var browser_1 = require("@splitsoftware/splitio-commons/cjs/utils/timeTracker/now/browser");
+var platform = { getFetch: getFetchFull_1.getFetch, getEventSource: getEventSource_1.getEventSource, EventEmitter: MinEvents_1.EventEmitter, now: browser_1.now };
+/**
+ * SplitFactory with pluggable modules for Browser.
+ * It includes a `fetch` polyfill out-of-the-box.
+ *
+ * @param config - configuration object used to instantiate the SDK
+ * @param __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 SplitFactory(config, __updateModules) {
+    var settings = (0, full_1.settingsFactory)(config);
+    var modules = (0, getModules_1.getModules)(settings, platform);
+    if (__updateModules)
+        __updateModules(modules);
+    return (0, index_1.sdkFactory)(modules);
+}
+exports.SplitFactory = SplitFactory;

package/cjs/platform/getFetchFull.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFetch = void 0;
+var tslib_1 = require("tslib");
+var unfetch_1 = (0, tslib_1.__importDefault)(require("unfetch"));
+function getFetch() {
+    return typeof fetch === 'function' ? fetch : unfetch_1.default;
+}
+exports.getFetch = getFetch;

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 = '1.0.0-rc.2';
+var packageVersion = '1.0.0-rc.3';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/cjs/settings/full.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.settingsFactory = void 0;
+var index_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/index");
+var defaults_1 = require("./defaults");
+var runtime_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/runtime");
+var storageCS_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/storage/storageCS");
+var pluggable_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/integrations/pluggable");
+var pluggableLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/pluggableLogger");
+var consent_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/consent");
+var params = {
+    defaults: defaults_1.defaults,
+    acceptKey: true,
+    runtime: runtime_1.validateRuntime,
+    storage: storageCS_1.validateStorageCS,
+    integrations: pluggable_1.validatePluggableIntegrations,
+    logger: pluggableLogger_1.validateLogger,
+    consent: consent_1.validateConsent,
+};
+function settingsFactory(config) {
+    var settings = (0, index_1.settingsValidation)(config, params);
+    return settings;
+}
+exports.settingsFactory = settingsFactory;

package/cjs/splitFactory.js

@@ -4,11 +4,11 @@ exports.SplitFactory = void 0;
 var settings_1 = require("./settings");
 var getModules_1 = require("./platform/getModules");
 var index_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory/index");
-var getFetch_1 = require("./platform/getFetch");
+var getFetchSlim_1 = require("./platform/getFetchSlim");
 var getEventSource_1 = require("./platform/getEventSource");
 var MinEvents_1 = require("@splitsoftware/splitio-commons/cjs/utils/MinEvents");
 var browser_1 = require("@splitsoftware/splitio-commons/cjs/utils/timeTracker/now/browser");
-var platform = { getFetch: getFetch_1.getFetch, getEventSource: getEventSource_1.getEventSource, EventEmitter: MinEvents_1.EventEmitter, now: browser_1.now };
+var platform = { getFetch: getFetchSlim_1.getFetch, getEventSource: getEventSource_1.getEventSource, EventEmitter: MinEvents_1.EventEmitter, now: browser_1.now };
 /**
  * SplitFactory with pluggable modules for Browser.
  *

package/esm/full/index.js

@@ -0,0 +1,7 @@
+export { SplitFactory } from './splitFactory';
+export { InLocalStorage } from '@splitsoftware/splitio-commons/esm/storages/inLocalStorage/index';
+export { ErrorLogger } from '@splitsoftware/splitio-commons/esm/logger/browser/ErrorLogger';
+export { WarnLogger } from '@splitsoftware/splitio-commons/esm/logger/browser/WarnLogger';
+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';

package/esm/full/splitFactory.js

@@ -0,0 +1,24 @@
+import { settingsFactory } from '../settings/full';
+import { getModules } from '../platform/getModules';
+import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory/index';
+import { getFetch } from '../platform/getFetchFull';
+import { getEventSource } from '../platform/getEventSource';
+import { EventEmitter } from '@splitsoftware/splitio-commons/esm/utils/MinEvents';
+import { now } from '@splitsoftware/splitio-commons/esm/utils/timeTracker/now/browser';
+var platform = { getFetch: getFetch, getEventSource: getEventSource, EventEmitter: EventEmitter, now: now };
+/**
+ * SplitFactory with pluggable modules for Browser.
+ * It includes a `fetch` polyfill out-of-the-box.
+ *
+ * @param config - configuration object used to instantiate the SDK
+ * @param __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 SplitFactory(config, __updateModules) {
+    var settings = settingsFactory(config);
+    var modules = getModules(settings, platform);
+    if (__updateModules)
+        __updateModules(modules);
+    return sdkFactory(modules);
+}

package/esm/platform/getFetchFull.js

@@ -0,0 +1,4 @@
+import unfetch from 'unfetch';
+export function getFetch() {
+    return typeof fetch === 'function' ? fetch : unfetch;
+}

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 = '1.0.0-rc.2';
+var packageVersion = '1.0.0-rc.3';
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.
  * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.

package/esm/settings/full.js

@@ -0,0 +1,20 @@
+import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/index';
+import { defaults } from './defaults';
+import { validateRuntime } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/runtime';
+import { validateStorageCS } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/storage/storageCS';
+import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/integrations/pluggable';
+import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/pluggableLogger';
+import { validateConsent } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/consent';
+var params = {
+    defaults: defaults,
+    acceptKey: true,
+    runtime: validateRuntime,
+    storage: validateStorageCS,
+    integrations: validatePluggableIntegrations,
+    logger: validateLogger,
+    consent: validateConsent,
+};
+export function settingsFactory(config) {
+    var settings = settingsValidation(config, params);
+    return settings;
+}

package/esm/splitFactory.js

@@ -1,7 +1,7 @@
 import { settingsFactory } from './settings';
 import { getModules } from './platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory/index';
-import { getFetch } from './platform/getFetch';
+import { getFetch } from './platform/getFetchSlim';
 import { getEventSource } from './platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/esm/utils/MinEvents';
 import { now } from '@splitsoftware/splitio-commons/esm/utils/timeTracker/now/browser';

package/full/package.json

@@ -0,0 +1,6 @@
+{
+  "main": "../cjs/full/index.js",
+  "module": "../esm/full/index.js",
+  "types": "../types/full/index.d.ts",
+  "sideEffects": false
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-browserjs",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.3",
   "description": "Split SDK for JavaScript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -13,7 +13,8 @@
     "cjs",
     "esm",
     "src",
-    "types"
+    "types",
+    "full"
   ],
   "scripts": {
     "check": "npm run check:lint && npm run check:types && npm run check:version",
@@ -58,8 +59,9 @@
   "bugs": "https://github.com/splitio/javascript-browser-client/issues",
   "homepage": "https://github.com/splitio/javascript-browser-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio-commons": "2.0.0-rc.5",
-    "tslib": "^2.3.1"
+    "@splitsoftware/splitio-commons": "2.0.0-rc.6",
+    "tslib": "^2.3.1",
+    "unfetch": "^4.2.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^24.0.1",

package/src/full/index.ts

@@ -0,0 +1,7 @@
+export { SplitFactory } from './splitFactory';
+export { InLocalStorage } from '@splitsoftware/splitio-commons/src/storages/inLocalStorage/index';
+export { ErrorLogger } from '@splitsoftware/splitio-commons/src/logger/browser/ErrorLogger';
+export { WarnLogger } from '@splitsoftware/splitio-commons/src/logger/browser/WarnLogger';
+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';

package/src/full/splitFactory.ts

@@ -0,0 +1,27 @@
+import type SplitIO from '@splitsoftware/splitio-commons/types/splitio';
+import { settingsFactory } from '../settings/full';
+import { getModules } from '../platform/getModules';
+import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
+import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
+import { getFetch } from '../platform/getFetchFull';
+import { getEventSource } from '../platform/getEventSource';
+import { EventEmitter } from '@splitsoftware/splitio-commons/src/utils/MinEvents';
+import { now } from '@splitsoftware/splitio-commons/src/utils/timeTracker/now/browser';
+
+const platform = { getFetch, getEventSource, EventEmitter, now };
+
+/**
+ * SplitFactory with pluggable modules for Browser.
+ * It includes a `fetch` polyfill out-of-the-box.
+ *
+ * @param config - configuration object used to instantiate the SDK
+ * @param __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 SplitFactory(config: SplitIO.IClientSideSettings, __updateModules?: (modules: ISdkFactoryParams) => void) {
+  const settings = settingsFactory(config);
+  const modules = getModules(settings, platform);
+  if (__updateModules) __updateModules(modules);
+  return sdkFactory(modules);
+}

package/src/platform/getFetchFull.ts

@@ -0,0 +1,6 @@
+import { IFetch } from '@splitsoftware/splitio-commons/src/services/types';
+import unfetch from 'unfetch';
+
+export function getFetch() {
+  return typeof fetch === 'function' ? fetch : unfetch as unknown as IFetch;
+}

package/src/settings/defaults.ts

@@ -2,7 +2,7 @@ import type SplitIO from '@splitsoftware/splitio-commons/types/splitio';
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/logger/index';
 import { CONSENT_GRANTED } from '@splitsoftware/splitio-commons/src/utils/constants';
 
-const packageVersion = '1.0.0-rc.2';
+const packageVersion = '1.0.0-rc.3';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/src/settings/full.ts

@@ -0,0 +1,23 @@
+import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/index';
+import { defaults } from './defaults';
+import { validateRuntime } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/runtime';
+import { validateStorageCS } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/storage/storageCS';
+import { validatePluggableIntegrations } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/integrations/pluggable';
+import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
+import { validateConsent } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/consent';
+
+const params = {
+  defaults,
+  acceptKey: true, // Client with bound key
+  runtime: validateRuntime,
+  storage: validateStorageCS,
+  integrations: validatePluggableIntegrations,
+  logger: validateLogger,
+  consent: validateConsent,
+};
+
+export function settingsFactory(config: any) {
+  const settings = settingsValidation(config, params);
+
+  return settings;
+}

package/src/splitFactory.ts

@@ -3,7 +3,7 @@ import { settingsFactory } from './settings';
 import { getModules } from './platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
 import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
-import { getFetch } from './platform/getFetch';
+import { getFetch } from './platform/getFetchSlim';
 import { getEventSource } from './platform/getEventSource';
 import { EventEmitter } from '@splitsoftware/splitio-commons/src/utils/MinEvents';
 import { now } from '@splitsoftware/splitio-commons/src/utils/timeTracker/now/browser';

package/types/full/index.d.ts

@@ -0,0 +1,62 @@
+// Declaration file for JavaScript Browser Split Software SDK
+// Project: http://www.split.io/
+// Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
+
+import '@splitsoftware/splitio-commons';
+
+export = JsSdk;
+
+declare module JsSdk {
+  /**
+   * Full version of the Split.io SDK factory function.
+   *
+   * Unlike the default version, it includes a `fetch` polyfill to support old browsers @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#language-support}.
+   *
+   * The settings parameter should be an object that complies with the SplitIO.IClientSideSettings or SplitIO.IClientSideAsyncSettings interfaces.
+   * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#configuration}
+   */
+  export function SplitFactory(settings: SplitIO.IClientSideSettings): SplitIO.IBrowserSDK;
+  export function SplitFactory(settings: SplitIO.IClientSideAsyncSettings): SplitIO.IBrowserAsyncSDK;
+
+  /**
+   * Persistent storage based on the LocalStorage Web API for browsers.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#storage}
+   */
+  export function InLocalStorage(options?: SplitIO.InLocalStorageOptions): SplitIO.StorageSyncFactory;
+
+  /**
+   * Pluggable storage to use the SDK in consumer mode.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#sharing-state-with-a-pluggable-storage}
+   */
+  export function PluggableStorage(options: SplitIO.PluggableStorageOptions): SplitIO.StorageAsyncFactory;
+
+  /**
+   * Creates a logger instance that enables descriptive log messages with DEBUG log level when passed in the factory settings.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#logging}
+   */
+  export function DebugLogger(): SplitIO.ILogger;
+
+  /**
+   * Creates a logger instance that enables descriptive log messages with INFO log level when passed in the factory settings.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#logging}
+   */
+  export function InfoLogger(): SplitIO.ILogger;
+
+  /**
+   * Creates a logger instance that enables descriptive log messages with WARN log level when passed in the factory settings.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#logging}
+   */
+  export function WarnLogger(): SplitIO.ILogger;
+
+  /**
+   * Creates a logger instance that enables descriptive log messages with ERROR log level when passed in the factory settings.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#logging}
+   */
+  export function ErrorLogger(): SplitIO.ILogger;
+}

package/types/index.d.ts

@@ -13,8 +13,8 @@ declare module JsSdk {
    * The settings parameter should be an object that complies with the SplitIO.IClientSideSettings or SplitIO.IClientSideAsyncSettings interfaces.
    * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#configuration}
    */
-  export function SplitFactory(settings: SplitIO.IClientSideSettings): SplitIO.ISDK;
-  export function SplitFactory(settings: SplitIO.IClientSideAsyncSettings): SplitIO.IAsyncSDK;
+  export function SplitFactory(settings: SplitIO.IClientSideSettings): SplitIO.IBrowserSDK;
+  export function SplitFactory(settings: SplitIO.IClientSideAsyncSettings): SplitIO.IBrowserAsyncSDK;
 
   /**
    * Persistent storage based on the LocalStorage Web API for browsers.