@splitsoftware/splitio-commons 1.6.2-rc.0 → 1.6.2-rc.3

package/types/storages/pluggable/index.d.ts

@@ -1,4 +1,5 @@
-import { IPluggableStorageWrapper, IStorageAsyncFactory } from '../types';
+import { IPluggableStorageWrapper } from '../types';
+import { StorageAsyncFactory } from '../../types';
 export interface PluggableStorageOptions {
     prefix?: string;
     wrapper: IPluggableStorageWrapper;
@@ -6,4 +7,4 @@ export interface PluggableStorageOptions {
 /**
  * Pluggable storage factory for consumer server-side & client-side SplitFactory.
  */
-export declare function PluggableStorage(options: PluggableStorageOptions): IStorageAsyncFactory;
+export declare function PluggableStorage(options: PluggableStorageOptions): StorageAsyncFactory;

package/types/storages/pluggable/wrapperAdapter.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 import { IPluggableStorageWrapper } from '../types';
 export declare const METHODS_TO_PROMISE_WRAP: string[];
 /**

package/types/storages/types.d.ts

@@ -1,7 +1,6 @@
-import { MaybeThenable, IMetadata, ISplitFiltersValidation } from '../dtos/types';
-import { ILogger } from '../logger/types';
+import { MaybeThenable, IMetadata } from '../dtos/types';
 import { EventDataType, HttpErrors, HttpLatencies, ImpressionDataType, LastSync, Method, MethodExceptions, MethodLatencies, OperationType, StoredEventWithMetadata, StoredImpressionWithMetadata, StreamingEvent } from '../sync/submitters/types';
-import { SplitIO, ImpressionDTO, SDKMode } from '../types';
+import { ImpressionDTO, SDKMode, ILogger, EventData, ISplitFiltersValidation } from '../types';
 /**
  * Interface of a pluggable storage wrapper.
  */
@@ -260,7 +259,7 @@ export interface IImpressionsCacheBase {
     track(data: ImpressionDTO[]): MaybeThenable<void>;
 }
 export interface IEventsCacheBase {
-    track(data: SplitIO.EventData, size?: number): MaybeThenable<boolean>;
+    track(data: EventData, size?: number): MaybeThenable<boolean>;
 }
 /** Impressions and events cache for standalone mode (sync) */
 export interface IRecorderCacheProducerSync<T> {
@@ -272,8 +271,8 @@ export interface IImpressionsCacheSync extends IImpressionsCacheBase, IRecorderC
     track(data: ImpressionDTO[]): void;
     setOnFullQueueCb(cb: () => void): void;
 }
-export interface IEventsCacheSync extends IEventsCacheBase, IRecorderCacheProducerSync<SplitIO.EventData[]> {
-    track(data: SplitIO.EventData, size?: number): boolean;
+export interface IEventsCacheSync extends IEventsCacheBase, IRecorderCacheProducerSync<EventData[]> {
+    track(data: EventData, size?: number): boolean;
     setOnFullQueueCb(cb: () => void): void;
 }
 /** Impressions and events cache for consumer and producer mode (async) */
@@ -286,7 +285,7 @@ export interface IImpressionsCacheAsync extends IImpressionsCacheBase, IRecorder
     track(data: ImpressionDTO[]): Promise<void>;
 }
 export interface IEventsCacheAsync extends IEventsCacheBase, IRecorderCacheProducerAsync<StoredEventWithMetadata[]> {
-    track(data: SplitIO.EventData, size?: number): Promise<boolean>;
+    track(data: EventData, size?: number): Promise<boolean>;
 }
 /**
  * Impression counts cache for impressions dedup in standalone and producer mode.
@@ -393,12 +392,39 @@ export interface IStorageFactoryParams {
     onReadyCb: (error?: any) => void;
     metadata: IMetadata;
 }
-export declare type StorageType = 'MEMORY' | 'LOCALSTORAGE' | 'REDIS' | 'PLUGGABLE';
-export declare type IStorageSyncFactory = {
-    readonly type: StorageType;
-    (params: IStorageFactoryParams): IStorageSync;
-};
-export declare type IStorageAsyncFactory = {
-    type: StorageType;
-    (params: IStorageFactoryParams): IStorageAsync;
-};
+/**
+ * Defines the format of Split data to preload on the factory storage (cache).
+ */
+export 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;
+    };
+}

package/types/sync/offline/LocalhostFromObject.d.ts

@@ -1,2 +1,2 @@
-import { SplitIO } from '../../types';
-export declare function LocalhostFromObject(): SplitIO.LocalhostFactory;
+import { LocalhostFactory } from '../../types';
+export declare function LocalhostFromObject(): LocalhostFactory;

package/types/sync/polling/updaters/mySegmentsUpdater.d.ts

@@ -1,7 +1,7 @@
 import { IMySegmentsFetcher } from '../fetchers/types';
 import { ISegmentsCacheSync, ISplitsCacheSync } from '../../../storages/types';
 import { ISegmentsEventEmitter } from '../../../readiness/types';
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 declare type IMySegmentsUpdater = (segmentList?: string[], noCache?: boolean) => Promise<boolean>;
 /**
  * factory of MySegments updater, a task that:

package/types/sync/polling/updaters/segmentChangesUpdater.d.ts

@@ -1,7 +1,7 @@
 import { ISegmentChangesFetcher } from '../fetchers/types';
 import { ISegmentsCacheBase } from '../../../storages/types';
 import { IReadinessManager } from '../../../readiness/types';
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 declare type ISegmentChangesUpdater = (fetchOnlyNew?: boolean, segmentName?: string, noCache?: boolean, till?: number) => Promise<boolean>;
 /**
  * Factory of SegmentChanges updater, a task that:

package/types/sync/polling/updaters/splitChangesUpdater.d.ts

@@ -3,7 +3,7 @@ import { ISegmentsCacheBase, ISplitsCacheBase } from '../../../storages/types';
 import { ISplitChangesFetcher } from '../fetchers/types';
 import { ISplit } from '../../../dtos/types';
 import { ISplitsEventEmitter } from '../../../readiness/types';
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 declare type ISplitChangesUpdater = (noCache?: boolean, till?: number) => Promise<boolean>;
 /**
  * Collect segments from a raw split definition.

package/types/sync/streaming/SSEHandler/index.d.ts

@@ -1,6 +1,6 @@
 import { IPushEventEmitter } from '../types';
 import { ISseEventHandler } from '../SSEClient/types';
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 import { ITelemetryTracker } from '../../../trackers/types';
 /**
  * Factory for SSEHandler, which processes SSEClient messages and emits the corresponding push events.

package/types/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 import { ISegmentsCacheSync } from '../../../storages/types';
 import { ISegmentsSyncTask } from '../../polling/types';
 import { IUpdateWorker } from './types';

package/types/sync/streaming/UpdateWorkers/SplitsUpdateWorker.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 import { ISplitsEventEmitter } from '../../../readiness/types';
 import { ISplitsCacheSync } from '../../../storages/types';
 import { ISegmentsSyncTask, ISplitsSyncTask } from '../../polling/types';

package/types/sync/submitters/submitter.d.ts

@@ -1,6 +1,6 @@
 import { ISyncTask } from '../types';
 import { IRecorderCacheProducerSync } from '../../storages/types';
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 import { IResponse } from '../../services/types';
 /**
  * Base function to create submitters, such as ImpressionsSubmitter and EventsSubmitter

package/types/sync/submitters/types.d.ts

@@ -1,5 +1,5 @@
 import { IMetadata } from '../../dtos/types';
-import { SplitIO } from '../../types';
+import { EventData } from '../../types';
 import { ISyncTask } from '../types';
 export declare type ImpressionsPayload = {
     /** Split name */
@@ -57,7 +57,7 @@ export declare type StoredEventWithMetadata = {
     /** Metadata */
     m: IMetadata;
     /** Stored event */
-    e: SplitIO.EventData;
+    e: EventData;
 };
 /**
  * Telemetry usage stats

package/types/sync/syncTask.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../logger/types';
+import { ILogger } from '../types';
 import { ISyncTask } from './types';
 /**
  * Creates an object that handles the periodic execution of a given task via "start" and "stop" methods.

package/types/trackers/types.d.ts

@@ -1,18 +1,18 @@
-import { SplitIO, ImpressionDTO } from '../types';
+import { ImpressionDTO, EventData, ImpressionData, Attributes } from '../types';
 import { StreamingEventType, Method, OperationType } from '../sync/submitters/types';
 import { IEventsCacheBase } from '../storages/types';
 import { NetworkError } from '../services/types';
 /** Events tracker */
 export interface IEventsHandler {
-    handleEvent(eventData: SplitIO.EventData): any;
+    handleEvent(eventData: EventData): any;
 }
 export declare type IEventTracker = IEventsCacheBase;
 /** Impressions tracker */
 export interface IImpressionsHandler {
-    handleImpression(impressionData: SplitIO.ImpressionData): any;
+    handleImpression(impressionData: ImpressionData): any;
 }
 export interface IImpressionsTracker {
-    track(impressions: ImpressionDTO[], attributes?: SplitIO.Attributes): void;
+    track(impressions: ImpressionDTO[], attributes?: Attributes): void;
 }
 /** Telemetry tracker */
 export declare type AUTH_REJECTION = 80;

package/types/utils/constants/index.d.ts

@@ -1,4 +1,4 @@
-import { StorageType } from '../../storages/types';
+import { StorageType } from '../../types';
 import { SDKMode } from '../../types';
 export declare const CONTROL = "control";
 export declare const CONTROL_WITH_CONFIG: {

package/types/utils/inputValidation/apiKey.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 /** validates the given api key */
 export declare function validateApiKey(log: ILogger, maybeApiKey: any): string | false;
 export declare const usedKeysMap: Record<string, number>;

package/types/utils/inputValidation/attribute.d.ts

@@ -1,2 +1,2 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 export declare function validateAttribute(log: ILogger, attributeKey: string, attributeValue: Object, method: string): boolean;

package/types/utils/inputValidation/attributes.d.ts

@@ -1,4 +1,4 @@
-import { SplitIO } from '../../types';
-import { ILogger } from '../../logger/types';
-export declare function validateAttributes(log: ILogger, maybeAttrs: any, method: string): SplitIO.Attributes | undefined | false;
+import { Attributes } from '../../types';
+import { ILogger } from '../../types';
+export declare function validateAttributes(log: ILogger, maybeAttrs: any, method: string): Attributes | undefined | false;
 export declare function validateAttributesDeep(log: ILogger, maybeAttributes: Record<string, Object>, method: string): boolean;

package/types/utils/inputValidation/event.d.ts

@@ -1,2 +1,2 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 export declare function validateEvent(log: ILogger, maybeEvent: any, method: string): string | false;

package/types/utils/inputValidation/eventProperties.d.ts

@@ -1,6 +1,6 @@
-import { SplitIO } from '../../types';
-import { ILogger } from '../../logger/types';
+import { Properties } from '../../types';
+import { ILogger } from '../../types';
 export declare function validateEventProperties(log: ILogger, maybeProperties: any, method: string): {
-    properties: SplitIO.Properties | null | false;
+    properties: Properties | null | false;
     size: number;
 };

package/types/utils/inputValidation/eventValue.d.ts

@@ -1,2 +1,2 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 export declare function validateEventValue(log: ILogger, maybeValue: any, method: string): number | false;

package/types/utils/inputValidation/isOperational.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 import { IReadinessManager } from '../../readiness/types';
 export declare function validateIfNotDestroyed(log: ILogger, readinessManager: IReadinessManager, method: string): boolean;
 export declare function validateIfOperational(log: ILogger, readinessManager: IReadinessManager, method: string): boolean;

package/types/utils/inputValidation/key.d.ts

@@ -1,3 +1,3 @@
-import { SplitIO } from '../../types';
-import { ILogger } from '../../logger/types';
-export declare function validateKey(log: ILogger, maybeKey: any, method: string): SplitIO.SplitKey | false;
+import { SplitKey } from '../../types';
+import { ILogger } from '../../types';
+export declare function validateKey(log: ILogger, maybeKey: any, method: string): SplitKey | false;

package/types/utils/inputValidation/preloadedData.d.ts

@@ -1,3 +1,3 @@
-import { SplitIO } from '../../types';
-import { ILogger } from '../../logger/types';
-export declare function validatePreloadedData(log: ILogger, maybePreloadedData: any, method: string): maybePreloadedData is SplitIO.PreloadedData;
+import { ILogger } from '../../types';
+import { PreloadedData } from '../../storages/types';
+export declare function validatePreloadedData(log: ILogger, maybePreloadedData: any, method: string): maybePreloadedData is PreloadedData;

package/types/utils/inputValidation/split.d.ts

@@ -1,2 +1,2 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 export declare function validateSplit(log: ILogger, maybeSplit: any, method: string, item?: string): string | false;

package/types/utils/inputValidation/splitExistance.d.ts

@@ -1,5 +1,5 @@
 import { IReadinessManager } from '../../readiness/types';
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 /**
  * This is defined here and in this format mostly because of the logger and the fact that it's considered a validation at product level.
  * But it's not going to run on the input validation layer. In any case, the most compeling reason to use it as we do is to avoid going to Redis and get a split twice.

package/types/utils/inputValidation/splits.d.ts

@@ -1,2 +1,2 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 export declare function validateSplits(log: ILogger, maybeSplits: any, method: string, listName?: string, item?: string): string[] | false;

package/types/utils/inputValidation/trafficType.d.ts

@@ -1,2 +1,2 @@
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 export declare function validateTrafficType(log: ILogger, maybeTT: any, method: string): string | false;

package/types/utils/inputValidation/trafficTypeExistance.d.ts

@@ -2,7 +2,7 @@ import { ISplitsCacheBase } from '../../storages/types';
 import { IReadinessManager } from '../../readiness/types';
 import { SDKMode } from '../../types';
 import { MaybeThenable } from '../../dtos/types';
-import { ILogger } from '../../logger/types';
+import { ILogger } from '../../types';
 /**
  * Separated from the previous method since on some cases it'll be async.
  */

package/types/utils/key/index.d.ts

@@ -1,8 +1,8 @@
-import { SplitIO } from '../../types';
-export declare function getMatching(key: SplitIO.SplitKey): string;
-export declare function getBucketing(key: SplitIO.SplitKey): string | undefined;
+import { SplitKey, SplitKeyObject } from '../../types';
+export declare function getMatching(key?: SplitKey): string;
+export declare function getBucketing(key: SplitKey): string | undefined;
 /**
  * Verify type of key and return a valid object key used for get treatment for a
  * specific split.
  */
-export declare function keyParser(key: SplitIO.SplitKey): SplitIO.SplitKeyObject;
+export declare function keyParser(key: SplitKey): SplitKeyObject;

package/types/utils/settingsValidation/consent.d.ts

@@ -1,5 +1,4 @@
-import { ILogger } from '../../logger/types';
-import { ConsentStatus } from '../../types';
+import { ConsentStatus, ILogger } from '../../types';
 export declare function validateConsent({ userConsent, log }: {
     userConsent?: any;
     log: ILogger;

package/types/utils/settingsValidation/impressionsMode.d.ts

@@ -1,3 +1,3 @@
-import { ILogger } from '../../logger/types';
-import { SplitIO } from '../../types';
-export declare function validImpressionsMode(log: ILogger, impressionsMode: any): SplitIO.ImpressionsMode;
+import { ILogger } from '../../types';
+import { ImpressionsMode } from '../../types';
+export declare function validImpressionsMode(log: ILogger, impressionsMode: any): ImpressionsMode;

package/types/utils/settingsValidation/integrations/common.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 /**
  * This function validates `settings.integrations` object
  *

package/types/utils/settingsValidation/integrations/configurable.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 /**
  * This function validates `settings.integrations` object that consists of a list of configuration items, used by the isomorphic JS SDK.
  *

package/types/utils/settingsValidation/integrations/pluggable.d.ts

@@ -1,5 +1,4 @@
-import { ISettings } from '../../../types';
-import { ILogger } from '../../../logger/types';
+import { ISettings, ILogger } from '../../../types';
 /**
  * This function validates `settings.integrations` object that consists of a list of pluggable integration factories.
  *

package/types/utils/settingsValidation/localhost/builtin.d.ts

@@ -1,5 +1,4 @@
-import { ILogger } from '../../../logger/types';
-import { SDKMode } from '../../../types';
+import { SDKMode, ILogger } from '../../../types';
 /**
  * This function validates `settings.sync.localhostMode` object
  *

package/types/utils/settingsValidation/localhost/pluggable.d.ts

@@ -1,5 +1,4 @@
-import { ILogger } from '../../../logger/types';
-import { SDKMode } from '../../../types';
+import { SDKMode, ILogger } from '../../../types';
 /**
  * This function validates `settings.sync.localhostMode` object
  *

package/types/utils/settingsValidation/logger/builtinLogger.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 /**
  * Validates the `debug` property at config and use it to set the log level.
  *

package/types/utils/settingsValidation/logger/pluggableLogger.d.ts

@@ -1,4 +1,4 @@
-import { ILogger } from '../../../logger/types';
+import { ILogger } from '../../../types';
 /**
  * Validates the `debug` property at config and use it to set the logger.
  *

package/types/utils/settingsValidation/splitFilters.d.ts

@@ -1,5 +1,4 @@
-import { ISplitFiltersValidation } from '../../dtos/types';
-import { ILogger } from '../../logger/types';
+import { ISplitFiltersValidation, ILogger } from '../../types';
 /**
  * Validates `splitFilters` configuration object and parses it into a query string for filtering splits on `/splitChanges` fetch.
  *

package/types/utils/settingsValidation/storage/storageCS.d.ts

@@ -1,9 +1,8 @@
-import { ISettings, SDKMode } from '../../../types';
-import { ILogger } from '../../../logger/types';
+import { ISettings, SDKMode, ILogger } from '../../../types';
 import { IStorageFactoryParams, IStorageSync } from '../../../storages/types';
 export declare function __InLocalStorageMockFactory(params: IStorageFactoryParams): IStorageSync;
 export declare namespace __InLocalStorageMockFactory {
-    var type: import("../../../storages/types").StorageType;
+    var type: import("../../../types").StorageType;
 }
 /**
  * This function validates `settings.storage` object

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/esm/types.js

@@ -1 +0,0 @@
-export {};