@splitsoftware/splitio-browserjs 0.6.1-rc.1 → 0.6.1-rc.2

package/cjs/full/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluggableStorage = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = exports.SplitToGoogleAnalytics = exports.GoogleAnalyticsToSplit = exports.InLocalStorage = exports.SplitFactory = void 0;
+exports.DataLoaderFactory = 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,3 +19,5 @@ 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,5 +11,6 @@ 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.PluggableStorage = exports.LocalhostFromObject = exports.DebugLogger = exports.InfoLogger = exports.WarnLogger = exports.ErrorLogger = exports.SplitToGoogleAnalytics = exports.GoogleAnalyticsToSplit = exports.InLocalStorage = exports.SplitFactory = void 0;
+exports.DataLoaderFactory = 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,3 +36,5 @@ 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.1';
+var packageVersion = '0.6.1-rc.2';
 /**
  * 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,3 +7,4 @@ 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 } from './index';
+import { SplitFactory, InLocalStorage, GoogleAnalyticsToSplit, SplitToGoogleAnalytics, ErrorLogger, WarnLogger, InfoLogger, DebugLogger, DataLoaderFactory } from './index';
 // Include all pluggable modules as properties to expose at the global `splitio` object
 SplitFactory.SplitFactory = SplitFactory;
 SplitFactory.InLocalStorage = InLocalStorage;
@@ -9,5 +9,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/esm/index.js

@@ -23,3 +23,4 @@ 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.1';
+var packageVersion = '0.6.1-rc.2';
 /**
  * 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.1",
+  "version": "0.6.1-rc.2",
   "description": "Split SDK for Javascript on Browser",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -61,7 +61,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.1",
+    "@splitsoftware/splitio-commons": "1.4.2-rc.2",
     "@types/google.analytics": "0.0.40"
   },
   "devDependencies": {

package/src/full/index.ts

@@ -7,3 +7,4 @@ 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 } from './index';
+import { SplitFactory, InLocalStorage, GoogleAnalyticsToSplit, SplitToGoogleAnalytics, ErrorLogger, WarnLogger, InfoLogger, DebugLogger, DataLoaderFactory } from './index';
 
 // Include all pluggable modules as properties to expose at the global `splitio` object
 SplitFactory.SplitFactory = SplitFactory;
@@ -10,6 +10,7 @@ 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,3 +24,4 @@ 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.1';
+const packageVersion = '0.6.1-rc.2';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/types/full/index.d.ts

@@ -74,4 +74,9 @@ 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

@@ -82,4 +82,9 @@ 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,6 +73,7 @@ interface ISettings {
     eventsFirstPushWindow: number
   },
   readonly storage?: SplitIO.StorageSyncFactory | SplitIO.StorageAsyncFactory,
+  readonly dataLoader?: SplitIO.DataLoader,
   readonly urls: {
     events: string,
     sdk: string,
@@ -91,7 +92,9 @@ interface ISettings {
   readonly sync: {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
-    localhostMode?: SplitIO.LocalhostFactory
+    localhostMode?: SplitIO.LocalhostFactory,
+    enabled?: boolean
+    onlySubmitters?: boolean
   },
   readonly userConsent: SplitIO.ConsentStatus
 }
@@ -242,6 +245,24 @@ interface ISharedSettings {
      * @property {Object} localhostMode
      */
     localhostMode?: SplitIO.LocalhostFactory
+    /**
+     * Controls the SDK continuous synchronization flags.
+     *
+     * When `true` a running SDK will process rollout plan updates performed on the UI (default).
+     * When false it'll just fetch all data upon init
+     *
+     * @property {boolean} enabled
+     * @default true
+     */
+    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
   }
 }
 /**
@@ -532,6 +553,10 @@ 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.
@@ -788,6 +813,42 @@ 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
@@ -893,6 +954,10 @@ declare namespace SplitIO {
      * @property {Object} storage
      */
     storage?: StorageSyncFactory,
+    /**
+     * @TODO
+     */
+    dataLoader?: DataLoader,
     /**
      * SDK Startup settings for the Browser.
      * @property {Object} startup