@splitsoftware/splitio-commons 1.2.1-rc.5 → 1.2.1-rc.8

package/src/utils/lang/index.ts

@@ -89,7 +89,7 @@ export function get(obj: any, prop: any, val: any): any {
 /**
  * Parses an array into a map of different arrays, grouping by the specified prop value.
  */
-export function groupBy<T extends Record<string, any> >(source: T[], prop: string): Record<string, T[]> {
+export function groupBy<T extends Record<string, any>>(source: T[], prop: string): Record<string, T[]> {
   const map: Record<string, any[]> = {};
 
   if (Array.isArray(source) && isString(prop)) {
@@ -164,6 +164,13 @@ export function isString(val: any): val is string {
   return typeof val === 'string' || val instanceof String;
 }
 
+/**
+ * String sanitizer. Returns the provided value converted to uppercase if it is a string.
+ */
+export function stringToUpperCase(val: any) {
+  return isString(val) ? val.toUpperCase() : val;
+}
+
 /**
  * Deep copy version of Object.assign using recursion.
  * There are some assumptions here. It's for internal use and we don't need verbose errors

package/src/utils/settingsValidation/consent.ts

@@ -1,11 +1,13 @@
 import { ERROR_INVALID_CONFIG_PARAM } from '../../logger/constants';
 import { ILogger } from '../../logger/types';
+import { ConsentStatus } from '../../types';
 import { CONSENT_DECLINED, CONSENT_GRANTED, CONSENT_UNKNOWN } from '../constants';
+import { stringToUpperCase } from '../lang';
 
 const userConsentValues = [CONSENT_DECLINED, CONSENT_GRANTED, CONSENT_UNKNOWN];
 
-export function validateConsent({ userConsent, log }: { userConsent: any, log: ILogger }) {
-  if (typeof userConsent === 'string') userConsent = userConsent.toUpperCase();
+export function validateConsent({ userConsent, log }: { userConsent?: any, log: ILogger }): ConsentStatus {
+  userConsent = stringToUpperCase(userConsent);
 
   if (userConsentValues.indexOf(userConsent) > -1) return userConsent;
 

package/src/utils/settingsValidation/impressionsMode.ts

@@ -2,9 +2,10 @@ import { ERROR_INVALID_CONFIG_PARAM } from '../../logger/constants';
 import { ILogger } from '../../logger/types';
 import { SplitIO } from '../../types';
 import { DEBUG, OPTIMIZED } from '../constants';
+import { stringToUpperCase } from '../lang';
 
 export function validImpressionsMode(log: ILogger, impressionsMode: any): SplitIO.ImpressionsMode {
-  if (typeof impressionsMode === 'string') impressionsMode = impressionsMode.toUpperCase();
+  impressionsMode = stringToUpperCase(impressionsMode);
 
   if ([DEBUG, OPTIMIZED].indexOf(impressionsMode) > -1) return impressionsMode;
 

package/types/logger/constants.d.ts

@@ -68,6 +68,7 @@ export declare const SYNC_STOP_POLLING = 119;
 export declare const EVENTS_TRACKER_SUCCESS = 120;
 export declare const IMPRESSIONS_TRACKER_SUCCESS = 121;
 export declare const USER_CONSENT_UPDATED = 122;
+export declare const USER_CONSENT_NOT_UPDATED = 123;
 export declare const ENGINE_VALUE_INVALID = 200;
 export declare const ENGINE_VALUE_NO_ATTRIBUTES = 201;
 export declare const CLIENT_NO_LISTENER = 202;

package/types/sdkClient/clientInputValidation.d.ts

@@ -1,8 +1,7 @@
 import { IReadinessManager } from '../readiness/types';
-import { SplitIO } from '../types';
-import { ILogger } from '../logger/types';
+import { ISettings, SplitIO } from '../types';
 /**
  * Decorator that validates the input before actually executing the client methods.
  * We should "guard" the client here, while not polluting the "real" implementation of those methods.
  */
-export declare function clientInputValidationDecorator<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(log: ILogger, client: TClient, readinessManager: IReadinessManager, isStorageSync?: boolean): TClient;
+export declare function clientInputValidationDecorator<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(settings: ISettings, client: TClient, readinessManager: IReadinessManager): TClient;

package/types/sdkFactory/types.d.ts

@@ -36,7 +36,6 @@ export interface ISdkFactoryParams {
     settings: ISettings, // Used by BrowserSignalListener
     storage: IStorageSync | IStorageAsync, // Used by BrowserSignalListener
     serviceApi: ISplitApi | undefined) => ISignalListener;
-    impressionListener?: SplitIO.IImpressionListener;
     integrationsManagerFactory?: (params: IIntegrationFactoryParams) => IIntegrationManager | undefined;
     impressionsObserverFactory?: () => IImpressionObserver;
     extraProps?: (settings: ISettings, syncManager?: ISyncManager) => object;

package/types/trackers/eventTracker.d.ts

@@ -1,10 +1,10 @@
 import { IEventsCacheBase } from '../storages/types';
 import { IEventsHandler, IEventTracker } from './types';
-import { ILogger } from '../logger/types';
+import { ISettings } from '../types';
 /**
  * Event tracker stores events in cache and pass them to the integrations manager if provided.
  *
  * @param eventsCache cache to save events
  * @param integrationsManager optional event handler used for integrations
  */
-export declare function eventTrackerFactory(log: ILogger, eventsCache: IEventsCacheBase, integrationsManager?: IEventsHandler): IEventTracker;
+export declare function eventTrackerFactory(settings: ISettings, eventsCache: IEventsCacheBase, integrationsManager?: IEventsHandler): IEventTracker;

package/types/trackers/impressionObserver/utils.d.ts

@@ -7,3 +7,7 @@ export declare function shouldAddPt(settings: ISettings): boolean;
  * Checks if it should dedupe impressions or not.
  */
 export declare function shouldBeOptimized(settings: ISettings): boolean;
+/**
+ * Storage is async if mode is consumer or partial consumer
+ */
+export declare function isStorageSync(settings: ISettings): boolean;

package/types/trackers/impressionsTracker.d.ts

@@ -1,8 +1,7 @@
 import { IImpressionCountsCacheSync, IImpressionsCacheBase } from '../storages/types';
 import { IImpressionsHandler, IImpressionsTracker } from './types';
-import { SplitIO, ISettings } from '../types';
+import { ISettings } from '../types';
 import { IImpressionObserver } from './impressionObserver/types';
-import { ILogger } from '../logger/types';
 /**
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
  *
@@ -13,4 +12,4 @@ import { ILogger } from '../logger/types';
  * @param observer optional impression observer. If provided, previous time (pt property) is included in impression instances
  * @param countsCache optional cache to save impressions count. If provided, impressions will be deduped (OPTIMIZED mode)
  */
-export declare function impressionsTrackerFactory(log: ILogger, impressionsCache: IImpressionsCacheBase, { runtime: { ip, hostname }, version }: Pick<ISettings, 'version' | 'runtime'>, impressionListener?: SplitIO.IImpressionListener, integrationsManager?: IImpressionsHandler, observer?: IImpressionObserver, countsCache?: IImpressionCountsCacheSync): IImpressionsTracker;
+export declare function impressionsTrackerFactory(settings: ISettings, impressionsCache: IImpressionsCacheBase, integrationsManager?: IImpressionsHandler, observer?: IImpressionObserver, countsCache?: IImpressionCountsCacheSync): IImpressionsTracker;

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

@@ -62,6 +62,10 @@ export declare function isObject(obj: any): boolean;
  * Checks if a given value is a string.
  */
 export declare function isString(val: any): val is string;
+/**
+ * String sanitizer. Returns the provided value converted to uppercase if it is a string.
+ */
+export declare function stringToUpperCase(val: any): any;
 /**
  * Deep copy version of Object.assign using recursion.
  * There are some assumptions here. It's for internal use and we don't need verbose errors

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

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