@splitsoftware/splitio-commons 1.8.2-rc.0 → 1.8.2-rc.2

package/src/utils/inputValidation/apiKey.ts

@@ -1,51 +1,52 @@
-import { ERROR_NULL, ERROR_EMPTY, ERROR_INVALID, WARN_API_KEY, LOG_PREFIX_INSTANTIATION } from '../../logger/constants';
+import { ERROR_NULL, ERROR_EMPTY, ERROR_INVALID, WARN_SDK_KEY, LOG_PREFIX_INSTANTIATION } from '../../logger/constants';
 import { ILogger } from '../../logger/types';
 import { isString } from '../lang';
 
-const item = 'api_key';
+const item = 'sdk_key';
 
-/** validates the given api key */
-export function validateApiKey(log: ILogger, maybeApiKey: any): string | false {
-  let apiKey: string | false = false;
-  if (maybeApiKey == undefined) { // eslint-disable-line eqeqeq
+// @TODO replace ApiKey with SdkKey in function names
+/** validates the given SDK key */
+export function validateApiKey(log: ILogger, maybeSdkKey: any): string | false {
+  let sdkKey: string | false = false;
+  if (maybeSdkKey == undefined) { // eslint-disable-line eqeqeq
     log.error(ERROR_NULL, [LOG_PREFIX_INSTANTIATION, item]);
-  } else if (isString(maybeApiKey)) {
-    if (maybeApiKey.length > 0)
-      apiKey = maybeApiKey;
+  } else if (isString(maybeSdkKey)) {
+    if (maybeSdkKey.length > 0)
+      sdkKey = maybeSdkKey;
     else
       log.error(ERROR_EMPTY, [LOG_PREFIX_INSTANTIATION, item]);
   } else {
     log.error(ERROR_INVALID, [LOG_PREFIX_INSTANTIATION, item]);
   }
 
-  return apiKey;
+  return sdkKey;
 }
 
 // Exported for telemetry
 export const usedKeysMap: Record<string, number> = {};
 
-/** validates the given api key and also warns if it is in use */
-export function validateAndTrackApiKey(log: ILogger, maybeApiKey: any): string | false {
-  const apiKey = validateApiKey(log, maybeApiKey);
+/** validates the given SDK key and also warns if it is in use */
+export function validateAndTrackApiKey(log: ILogger, maybeSdkKey: any): string | false {
+  const sdkKey = validateApiKey(log, maybeSdkKey);
 
-  // If the apiKey is correct, we'll save it as the instance creation should work.
-  if (apiKey) {
-    if (!usedKeysMap[apiKey]) {
+  // If sdkKey is correct, we'll save it as the instance creation should work.
+  if (sdkKey) {
+    if (!usedKeysMap[sdkKey]) {
       // If this key is not present, only warning scenarios is that we have factories for other keys.
-      usedKeysMap[apiKey] = 1;
+      usedKeysMap[sdkKey] = 1;
       if (Object.keys(usedKeysMap).length > 1) {
-        log.warn(WARN_API_KEY, ['an instance of the Split factory']);
+        log.warn(WARN_SDK_KEY, ['an instance of the Split factory']);
       }
     } else {
-      log.warn(WARN_API_KEY, [`${usedKeysMap[apiKey]} factory/ies with this API Key`]);
-      usedKeysMap[apiKey]++;
+      log.warn(WARN_SDK_KEY, [`${usedKeysMap[sdkKey]} factory/ies with this SDK Key`]);
+      usedKeysMap[sdkKey]++;
     }
   }
 
-  return apiKey;
+  return sdkKey;
 }
 
-export function releaseApiKey(apiKey: string) {
-  if (usedKeysMap[apiKey]) usedKeysMap[apiKey]--;
-  if (usedKeysMap[apiKey] === 0) delete usedKeysMap[apiKey];
+export function releaseApiKey(sdkKey: string) {
+  if (usedKeysMap[sdkKey]) usedKeysMap[sdkKey]--;
+  if (usedKeysMap[sdkKey] === 0) delete usedKeysMap[sdkKey];
 }

package/src/utils/inputValidation/preloadedData.ts

@@ -12,11 +12,11 @@ function validateTimestampData(log: ILogger, maybeTimestamp: any, method: string
 function validateSplitsData(log: ILogger, maybeSplitsData: any, method: string) {
   if (isObject(maybeSplitsData)) {
     const splitNames = Object.keys(maybeSplitsData);
-    if (splitNames.length === 0) log.warn(`${method}: preloadedData.splitsData doesn't contain split definitions.`);
+    if (splitNames.length === 0) log.warn(`${method}: preloadedData.splitsData doesn't contain feature flag definitions.`);
     // @TODO in the future, consider handling the possibility of having parsed definitions of splits
     if (splitNames.every(splitName => validateSplit(log, splitName, method) && isString(maybeSplitsData[splitName]))) return true;
   }
-  log.error(`${method}: preloadedData.splitsData must be a map of split names to their serialized definitions.`);
+  log.error(`${method}: preloadedData.splitsData must be a map of feature flag names to their stringified definitions.`);
   return false;
 }
 
@@ -38,7 +38,7 @@ function validateSegmentsData(log: ILogger, maybeSegmentsData: any, method: stri
     const segmentNames = Object.keys(maybeSegmentsData);
     if (segmentNames.every(segmentName => isString(maybeSegmentsData[segmentName]))) return true;
   }
-  log.error(`${method}: preloadedData.segmentsData must be a map of segment names to their serialized definitions.`);
+  log.error(`${method}: preloadedData.segmentsData must be a map of segment names to their stringified definitions.`);
   return false;
 }
 

package/src/utils/inputValidation/split.ts

@@ -5,7 +5,7 @@ import { isString } from '../lang';
 // include BOM and nbsp
 const TRIMMABLE_SPACES_REGEX = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/;
 
-export function validateSplit(log: ILogger, maybeSplit: any, method: string, item = 'split name'): string | false {
+export function validateSplit(log: ILogger, maybeSplit: any, method: string, item = 'feature flag name'): string | false {
   if (maybeSplit == undefined) { // eslint-disable-line eqeqeq
     log.error(ERROR_NULL, [method, item]);
   } else if (!isString(maybeSplit)) {

package/src/utils/inputValidation/splits.ts

@@ -3,7 +3,7 @@ import { ILogger } from '../../logger/types';
 import { uniq } from '../lang';
 import { validateSplit } from './split';
 
-export function validateSplits(log: ILogger, maybeSplits: any, method: string, listName = 'split_names', item = 'split name'): string[] | false {
+export function validateSplits(log: ILogger, maybeSplits: any, method: string, listName = 'feature flag names', item = 'feature flag name'): string[] | false {
   if (Array.isArray(maybeSplits) && maybeSplits.length > 0) {
     let validatedArray: string[] = [];
     // Remove invalid values

package/src/utils/settingsValidation/index.ts

@@ -97,7 +97,7 @@ function fromSecondsToMillis(n: number) {
 
 /**
  * Validates the given config and use it to build a settings object.
- * NOTE: it doesn't validate the Api Key. Call `validateApikey` or `validateAndTrackApiKey` for that after settings validation.
+ * NOTE: it doesn't validate the SDK Key. Call `validateApiKey` or `validateAndTrackApiKey` for that after settings validation.
  *
  * @param config user defined configuration
  * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config

package/types/logger/constants.d.ts

@@ -92,7 +92,7 @@ export declare const WARN_INTEGRATION_INVALID = 218;
 export declare const WARN_SPLITS_FILTER_IGNORED = 219;
 export declare const WARN_SPLITS_FILTER_INVALID = 220;
 export declare const WARN_SPLITS_FILTER_EMPTY = 221;
-export declare const WARN_API_KEY = 222;
+export declare const WARN_SDK_KEY = 222;
 export declare const STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 export declare const ERROR_ENGINE_COMBINER_IFELSEIF = 300;
 export declare const ERROR_LOGLEVEL_INVALID = 301;

package/types/sdkClient/clientAttributesDecoration.d.ts

@@ -4,10 +4,10 @@ import { ILogger } from '../logger/types';
  * Add in memory attributes storage methods and combine them with any attribute received from the getTreatment/s call
  */
 export declare function clientAttributesDecoration<TClient extends SplitIO.IClient | SplitIO.IAsyncClient>(log: ILogger, client: TClient): TClient & {
-    getTreatment: (maybeKey: SplitIO.SplitKey, maybeSplit: string, maybeAttributes?: SplitIO.Attributes | undefined) => string | SplitIO.AsyncTreatment;
-    getTreatmentWithConfig: (maybeKey: SplitIO.SplitKey, maybeSplit: string, maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentWithConfig | SplitIO.AsyncTreatmentWithConfig;
-    getTreatments: (maybeKey: SplitIO.SplitKey, maybeSplits: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.Treatments | SplitIO.AsyncTreatments;
-    getTreatmentsWithConfig: (maybeKey: SplitIO.SplitKey, maybeSplits: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentsWithConfig | SplitIO.AsyncTreatmentsWithConfig;
+    getTreatment: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagName: string, maybeAttributes?: SplitIO.Attributes | undefined) => string | SplitIO.AsyncTreatment;
+    getTreatmentWithConfig: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagName: string, maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentWithConfig | SplitIO.AsyncTreatmentWithConfig;
+    getTreatments: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagNames: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.Treatments | SplitIO.AsyncTreatments;
+    getTreatmentsWithConfig: (maybeKey: SplitIO.SplitKey, maybeFeatureFlagNames: string[], maybeAttributes?: SplitIO.Attributes | undefined) => SplitIO.TreatmentsWithConfig | SplitIO.AsyncTreatmentsWithConfig;
     track: (maybeKey: SplitIO.SplitKey, maybeTT: string, maybeEvent: string, maybeEventValue?: number | undefined, maybeProperties?: SplitIO.Properties | undefined) => boolean | Promise<boolean>;
     /**
      * Add an attribute to client's in memory attributes storage
@@ -16,14 +16,14 @@ export declare function clientAttributesDecoration<TClient extends SplitIO.IClie
      * @param {string, number, boolean, list} attributeValue Attribute value
      * @returns {boolean} true if the attribute was stored and false otherways
      */
-    setAttribute(attributeName: string, attributeValue: Object): boolean;
+    setAttribute(attributeName: string, attributeValue: SplitIO.AttributeType): boolean;
     /**
      * Returns the attribute with the given key
      *
      * @param {string} attributeName Attribute name
      * @returns {Object} Attribute with the given key
      */
-    getAttribute(attributeName: string): Object;
+    getAttribute(attributeName: string): SplitIO.AttributeType;
     /**
      * Add to client's in memory attributes storage the attributes in 'attributes'
      *
@@ -36,7 +36,7 @@ export declare function clientAttributesDecoration<TClient extends SplitIO.IClie
      *
      * @returns {Object} returns all the stored attributes
      */
-    getAttributes(): Record<string, Object>;
+    getAttributes(): Record<string, SplitIO.AttributeType>;
     /**
      * Removes from client's in memory attributes storage the attribute with the given key
      *

package/types/storages/inMemory/AttributesCacheInMemory.d.ts

@@ -1,3 +1,4 @@
+import { SplitIO } from '../../types';
 export declare class AttributesCacheInMemory {
     private attributesCache;
     /**
@@ -7,14 +8,14 @@ export declare class AttributesCacheInMemory {
      * @param {Object} attributeValue attribute value
      * @returns {boolean} the attribute was stored
      */
-    setAttribute(attributeName: string, attributeValue: Object): boolean;
+    setAttribute(attributeName: string, attributeValue: SplitIO.AttributeType): boolean;
     /**
      * Retrieves the value of a given attribute
      *
      * @param {string} attributeName attribute name
      * @returns {Object?} stored attribute value
      */
-    getAttribute(attributeName: string): Object;
+    getAttribute(attributeName: string): SplitIO.AttributeType;
     /**
      * Create or update all the given attributes
      *
@@ -27,7 +28,7 @@ export declare class AttributesCacheInMemory {
      *
      * @returns {Map<string, Object>} stored attributes
      */
-    getAll(): Record<string, Object>;
+    getAll(): Record<string, SplitIO.AttributeType>;
     /**
      * Removes a given attribute from the map
      *