@splitsoftware/splitio-browserjs 0.1.1-canary.1 → 0.2.1-rc.0

package/src/full/umd.ts

@@ -0,0 +1,14 @@
+// @ts-nocheck
+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;
+SplitFactory.GoogleAnalyticsToSplit = GoogleAnalyticsToSplit;
+SplitFactory.SplitToGoogleAnalytics = SplitToGoogleAnalytics;
+SplitFactory.ErrorLogger = ErrorLogger;
+SplitFactory.WarnLogger = WarnLogger;
+SplitFactory.InfoLogger = InfoLogger;
+SplitFactory.DebugLogger = DebugLogger;
+
+export default SplitFactory;

package/src/index.ts

@@ -1,4 +1,10 @@
 export { SplitFactory } from './splitFactory';
 export { InLocalStorage } from '@splitsoftware/splitio-commons/src/storages/inLocalStorage/index';
-export { default as GoogleAnalyticsToSplit } from '@splitsoftware/splitio-commons/src/integrations/ga/GaToSplitPlugin';
-export { default as SplitToGoogleAnalytics } from '@splitsoftware/splitio-commons/src/integrations/ga/SplitToGaPlugin';
+export { GoogleAnalyticsToSplit } from '@splitsoftware/splitio-commons/src/integrations/ga/GoogleAnalyticsToSplit';
+export { SplitToGoogleAnalytics } from '@splitsoftware/splitio-commons/src/integrations/ga/SplitToGoogleAnalytics';
+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 { LocalhostFromObject } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromObject';
+export { PluggableStorage } from '@splitsoftware/splitio-commons/src/storages/pluggable';

package/src/platform/getModules.ts

@@ -1,6 +1,4 @@
 import { splitApiFactory } from '@splitsoftware/splitio-commons/src/services/splitApi';
-import { splitsParserFromSettingsFactory } from '@splitsoftware/splitio-commons/src/sync/offline/splitsParser/splitsParserFromSettings';
-import { syncManagerOfflineFactory } from '@splitsoftware/splitio-commons/src/sync/syncManagerOffline';
 import { syncManagerOnlineFactory } from '@splitsoftware/splitio-commons/src/sync/syncManagerOnline';
 import pushManagerFactory from '@splitsoftware/splitio-commons/src/sync/streaming/pushManager';
 import pollingManagerCSFactory from '@splitsoftware/splitio-commons/src/sync/polling/pollingManagerCS';
@@ -9,42 +7,35 @@ import { sdkClientMethodCSFactory } from '@splitsoftware/splitio-commons/src/sdk
 import BrowserSignalListener from '@splitsoftware/splitio-commons/src/listeners/browser';
 import { impressionObserverCSFactory } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/impressionObserverCS';
 import integrationsManagerFactory from '@splitsoftware/splitio-commons/src/integrations/pluggable';
-import EventEmitter from '@splitsoftware/splitio-commons/src/utils/MinEvents';
 
-import { getFetch } from './getFetch';
-import { getEventSource } from './getEventSource';
 import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
-import { ISettingsInternal } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/types';
-import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
-import { SplitIO } from '@splitsoftware/splitio-commons/src/types';
+import { IPlatform, ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
+import { SplitIO, ISettings } from '@splitsoftware/splitio-commons/src/types';
+import { CONSUMER_MODE, CONSUMER_PARTIAL_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 
-const browserPlatform = {
-  getFetch,
-  getEventSource,
-  EventEmitter
-};
+let syncManagerStandaloneFactory: ISdkFactoryParams['syncManagerFactory'];
+let syncManagerSubmittersFactory: ISdkFactoryParams['syncManagerFactory'];
 
-const syncManagerOfflineCSBrowserFactory = syncManagerOfflineFactory(splitsParserFromSettingsFactory);
-const syncManagerOnlineCSFactory = syncManagerOnlineFactory(pollingManagerCSFactory, pushManagerFactory);
+export function getModules(settings: ISettings, platform: IPlatform): ISdkFactoryParams {
 
-export function getModules(settings: ISettingsInternal): ISdkFactoryParams {
+  if (!syncManagerStandaloneFactory) syncManagerStandaloneFactory = syncManagerOnlineFactory(pollingManagerCSFactory, pushManagerFactory);
 
-  return {
+  const modules: ISdkFactoryParams = {
     settings,
 
-    platform: browserPlatform,
+    platform,
 
     storageFactory: settings.storage,
 
-    splitApiFactory: settings.mode === 'localhost' ? undefined : splitApiFactory,
+    splitApiFactory,
 
-    syncManagerFactory: settings.mode === 'localhost' ? syncManagerOfflineCSBrowserFactory : syncManagerOnlineCSFactory,
+    syncManagerFactory: syncManagerStandaloneFactory,
 
     sdkManagerFactory,
 
     sdkClientMethodFactory: sdkClientMethodCSFactory,
 
-    SignalListener: settings.mode === 'localhost' ? undefined : BrowserSignalListener as ISdkFactoryParams['SignalListener'],
+    SignalListener: BrowserSignalListener as ISdkFactoryParams['SignalListener'],
 
     impressionListener: settings.impressionListener as SplitIO.IImpressionListener,
 
@@ -52,4 +43,20 @@ export function getModules(settings: ISettingsInternal): ISdkFactoryParams {
 
     impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
   };
+
+  switch (settings.mode) {
+    case LOCALHOST_MODE:
+      modules.splitApiFactory = undefined;
+      modules.syncManagerFactory = settings.sync.localhostMode;
+      modules.SignalListener = undefined;
+      break;
+    case CONSUMER_MODE:
+      modules.syncManagerFactory = undefined;
+      break;
+    case CONSUMER_PARTIAL_MODE:
+      if (!syncManagerSubmittersFactory) syncManagerSubmittersFactory = syncManagerOnlineFactory(undefined, undefined);
+      modules.syncManagerFactory = syncManagerSubmittersFactory;
+  }
+
+  return modules;
 }

package/src/settings/defaults.ts

@@ -1,7 +1,7 @@
 import { LogLevels, isLogLevelString } from '@splitsoftware/splitio-commons/src/logger/index';
 import { LogLevel } from '@splitsoftware/splitio-commons/src/types';
 
-const packageVersion = '0.1.1-canary.1';
+const packageVersion = '0.2.1-rc.0';
 
 /**
  * In browser, the default debug level, can be set via the `localStorage.splitio_debug` item.

package/src/settings/{slim.ts → full.ts}

@@ -3,12 +3,15 @@ import { defaults } from './defaults';
 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 { validateLocalhostWithDefault } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/builtin';
 
 const params = {
   defaults,
   storage: validateStorageCS,
   integrations: validatePluggableIntegrations,
-  logger: validateLogger
+  logger: validateLogger,
+  // Full SplitFactory returns a default instance, except a valid one is provided
+  localhost: validateLocalhostWithDefault
 };
 
 export function settingsValidator(config: any) {

package/src/settings/index.ts

@@ -2,13 +2,16 @@ import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/set
 import { defaults } from './defaults';
 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/builtinLogger';
+import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/pluggableLogger';
+import { validateLocalhost } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/localhost/pluggable';
 
 const params = {
   defaults,
   storage: validateStorageCS,
   integrations: validatePluggableIntegrations,
-  logger: validateLogger
+  logger: validateLogger,
+  // Slim SplitFactory validates that the localhost module is passed in localhost mode
+  localhost: validateLocalhost
 };
 
 export function settingsValidator(config: any) {

package/src/splitFactory.ts

@@ -3,16 +3,22 @@ import { getModules } from './platform/getModules';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory/index';
 import { ISdkFactoryParams } from '@splitsoftware/splitio-commons/src/sdkFactory/types';
 import { merge } from '@splitsoftware/splitio-commons/src/utils/lang';
+import { getFetch } from './platform/getFetchSlim';
+import { getEventSource } from './platform/getEventSource';
+import EventEmitter from '@splitsoftware/splitio-commons/src/utils/MinEvents';
+
+const platform = { getFetch, getEventSource, EventEmitter };
 
 /**
- * SplitFactory with pluggable modules for Browser.
- * Includes localhost mode and logger.
+ * Slim SplitFactory with pluggable modules for Browser.
+ * Doesn't include localhost mode and fetch ponyfill out-of-the-box.
  *
  * @param config configuration object used to instantiates the SDK
  * @param customModules optional object of SDK modules to overwrite default ones. Use with caution since, unlike `config`, this param is not validated.
+ * @throws Will throw an error if the provided config is invalid.
  */
 export function SplitFactory(config: any, customModules?: Partial<ISdkFactoryParams>) {
   const settings = settingsValidator(config);
-  const modules = getModules(settings);
+  const modules = getModules(settings, platform);
   return sdkFactory(customModules ? merge(modules, customModules) as ISdkFactoryParams : modules);
 }

package/src/umd.ts

@@ -1,21 +1,6 @@
 // @ts-nocheck
 import { SplitFactory } from './splitFactory';
-import { InLocalStorage } from '@splitsoftware/splitio-commons/src/storages/inLocalStorage/index';
-import { default as GoogleAnalyticsToSplit } from '@splitsoftware/splitio-commons/src/integrations/ga/GaToSplitPlugin';
-import { default as SplitToGoogleAnalytics } from '@splitsoftware/splitio-commons/src/integrations/ga/SplitToGaPlugin';
-import { ErrorLogger } from '@splitsoftware/splitio-commons/src/logger/browser/ErrorLogger';
-import { WarnLogger } from '@splitsoftware/splitio-commons/src/logger/browser/WarnLogger';
-import { InfoLogger } from '@splitsoftware/splitio-commons/src/logger/browser/InfoLogger';
-import { DebugLogger } from '@splitsoftware/splitio-commons/src/logger/browser/DebugLogger';
 
-// Include all pluggable modules as properties to expose at the global `splitio` object
 SplitFactory.SplitFactory = SplitFactory;
-SplitFactory.InLocalStorage = InLocalStorage;
-SplitFactory.GoogleAnalyticsToSplit = GoogleAnalyticsToSplit;
-SplitFactory.SplitToGoogleAnalytics = SplitToGoogleAnalytics;
-SplitFactory.ErrorLogger = ErrorLogger;
-SplitFactory.WarnLogger = WarnLogger;
-SplitFactory.InfoLogger = InfoLogger;
-SplitFactory.DebugLogger = DebugLogger;
 
 export default SplitFactory;

package/types/{slim → full}/index.d.ts

@@ -1,21 +1,22 @@
-// Declaration file for Javascript Browser Split Software SDK v1.0.0
+// Declaration file for Javascript Browser Split Software SDK
 // Project: http://www.split.io/
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
-/// <reference path="../../types/splitio.d.ts" />
+/// <reference path="../splitio.d.ts" />
 export = JsSdk;
 
 declare module JsSdk {
   /**
-   * Slim version of the Split.io sdk factory function.
+   * Full version of the Split.io sdk factory function.
    *
-   * Recommended to use for bundle size reduction in production, since it doesn't include development features like localhost mode
-   * and verbose log messages by default @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#size-optimization}.
+   * Unlike the slim version, it doesn't require a 'fetch' polyfill to support old browsers @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#language-support}.
+   * and includes localhost mode out-of-the-box @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#localhost-mode}.
    *
    * The settings parameter should be an object that complies with the SplitIO.IBrowserSettings.
    * 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.IBrowserSettings): SplitIO.ISDK;
+  export function SplitFactory(settings: SplitIO.IBrowserAsyncSettings): SplitIO.IAsyncSDK;
 
   /**
    * Persistent storage based on the LocalStorage Web API for browsers.
@@ -24,6 +25,13 @@ declare module JsSdk {
    */
   export function InLocalStorage(options?: SplitIO.InLocalStorageOptions): SplitIO.StorageSyncFactory;
 
+  /**
+   * Pluggable storage to use the SDK in consumer mode.
+   *
+   * @see {@link @TODO}
+   */
+   export function PluggableStorage(options: SplitIO.PluggableStorageOptions): SplitIO.StorageAsyncFactory;
+
   /**
    * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
    *

package/types/index.d.ts

@@ -1,4 +1,4 @@
-// Declaration file for Javascript Browser Split Software SDK v1.0.0
+// Declaration file for Javascript Browser Split Software SDK
 // Project: http://www.split.io/
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
@@ -7,11 +7,16 @@ export = JsSdk;
 
 declare module JsSdk {
   /**
-   * Split.io sdk factory function.
+   * Slim version of the Split.io sdk factory function.
+   *
+   * Recommended to use for bundle size reduction in production, since it doesn't include a 'fetch' polyfill and localhost mode out-of-the-box
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#localhost-mode}.
+   *
    * The settings parameter should be an object that complies with the SplitIO.IBrowserSettings.
    * 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.IBrowserSettings): SplitIO.ISDK;
+  export function SplitFactory(settings: SplitIO.IBrowserAsyncSettings): SplitIO.IAsyncSDK;
 
   /**
    * Persistent storage based on the LocalStorage Web API for browsers.
@@ -20,6 +25,13 @@ declare module JsSdk {
    */
   export function InLocalStorage(options?: SplitIO.InLocalStorageOptions): SplitIO.StorageSyncFactory;
 
+  /**
+   * Pluggable storage to use the SDK in consumer mode.
+   *
+   * @see {@link @TODO}
+   */
+  export function PluggableStorage(options: SplitIO.PluggableStorageOptions): SplitIO.StorageAsyncFactory;
+
   /**
    * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
    *
@@ -33,4 +45,41 @@ declare module JsSdk {
    * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#integrations}
    */
   export function SplitToGoogleAnalytics(options?: SplitIO.SplitToGoogleAnalyticsOptions): SplitIO.IntegrationFactory;
+
+  /**
+   * 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;
+
+  /**
+   * Required to enable localhost mode when importing the SDK from the slim entry point of the library.
+   * It uses the mocked features map defined in the 'features' config object.
+   *
+   * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#localhost-mode}
+   */
+  export function LocalhostFromObject(): SplitIO.LocalhostFactory;
 }