@splitsoftware/splitio-commons 1.13.2-rc.6 → 1.13.2-rc.8

package/types/evaluator/matchers/dependency.d.ts

@@ -2,4 +2,4 @@ import { IDependencyMatcherData, MaybeThenable } from '../../dtos/types';
 import { IStorageAsync, IStorageSync } from '../../storages/types';
 import { ILogger } from '../../logger/types';
 import { IDependencyMatcherValue, ISplitEvaluator } from '../types';
-export declare function dependencyMatcherContext({ split, treatments }: IDependencyMatcherData, storage: IStorageSync | IStorageAsync, log: ILogger): ({ key, attributes }: IDependencyMatcherValue, splitEvaluator: ISplitEvaluator) => MaybeThenable<boolean>;
+export declare function dependencyMatcherContext(log: ILogger, { split, treatments }: IDependencyMatcherData, storage: IStorageSync | IStorageAsync): ({ key, attributes }: IDependencyMatcherValue, splitEvaluator: ISplitEvaluator) => MaybeThenable<boolean>;

package/types/evaluator/matchers/eq.d.ts

@@ -1 +1,2 @@
-export declare function equalToMatcherContext(ruleAttr: number): (runtimeAttr: number) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function equalToMatcherContext(log: ILogger, ruleAttr: number): (runtimeAttr: number) => boolean;

package/types/evaluator/matchers/eq_set.d.ts

@@ -1 +1,2 @@
-export declare function equalToSetMatcherContext(ruleAttr: string[]): (runtimeAttr: string[]) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function equalToSetMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string[]) => boolean;

package/types/evaluator/matchers/ew.d.ts

@@ -1 +1,2 @@
-export declare function endsWithMatcherContext(ruleAttr: string[]): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function endsWithMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/gte.d.ts

@@ -1 +1,2 @@
-export declare function greaterThanEqualMatcherContext(ruleAttr: number): (runtimeAttr: number) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function greaterThanEqualMatcherContext(log: ILogger, ruleAttr: number): (runtimeAttr: number) => boolean;

package/types/evaluator/matchers/lte.d.ts

@@ -1 +1,2 @@
-export declare function lessThanEqualMatcherContext(ruleAttr: number): (runtimeAttr: number) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function lessThanEqualMatcherContext(log: ILogger, ruleAttr: number): (runtimeAttr: number) => boolean;

package/types/evaluator/matchers/part_of.d.ts

@@ -1 +1,2 @@
-export declare function partOfSetMatcherContext(ruleAttr: string[]): (runtimeAttr: string[]) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function partOfSetMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string[]) => boolean;

package/types/evaluator/matchers/segment.d.ts

@@ -1,5 +1,6 @@
 import { MaybeThenable } from '../../dtos/types';
 import { ISegmentsCacheBase } from '../../storages/types';
-export declare function segmentMatcherContext(segmentName: string, storage: {
+import { ILogger } from '../../logger/types';
+export declare function segmentMatcherContext(log: ILogger, segmentName: string, storage: {
     segments: ISegmentsCacheBase;
 }): (key: string) => MaybeThenable<boolean>;

package/types/evaluator/matchers/semver_between.d.ts

@@ -1,2 +1,3 @@
 import { IBetweenStringMatcherData } from '../../dtos/types';
-export declare function betweenSemverMatcherContext(ruleAttr: IBetweenStringMatcherData): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function betweenSemverMatcherContext(log: ILogger, ruleAttr: IBetweenStringMatcherData): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/semver_eq.d.ts

@@ -1 +1,2 @@
-export declare function equalToSemverMatcherContext(ruleAttr: string): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function equalToSemverMatcherContext(log: ILogger, ruleAttr: string): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/semver_gte.d.ts

@@ -1 +1,2 @@
-export declare function greaterThanEqualToSemverMatcherContext(ruleAttr: string): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function greaterThanEqualToSemverMatcherContext(log: ILogger, ruleAttr: string): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/semver_inlist.d.ts

@@ -1 +1,2 @@
-export declare function inListSemverMatcherContext(ruleAttr: string[]): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function inListSemverMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/semver_lte.d.ts

@@ -1 +1,2 @@
-export declare function lessThanEqualToSemverMatcherContext(ruleAttr: string): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function lessThanEqualToSemverMatcherContext(log: ILogger, ruleAttr: string): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/string.d.ts

@@ -1 +1,2 @@
-export declare function stringMatcherContext(ruleAttr: string): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function stringMatcherContext(log: ILogger, ruleAttr: string): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/sw.d.ts

@@ -1 +1,2 @@
-export declare function startsWithMatcherContext(ruleAttr: string[]): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function startsWithMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/whitelist.d.ts

@@ -1 +1,2 @@
-export declare function whitelistMatcherContext(ruleAttr: string[]): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function whitelistMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string) => boolean;

package/types/evaluator/matchersTransform/set.d.ts

@@ -1,5 +1,5 @@
-import { ISplitMatcher } from '../../dtos/types';
+import { IWhitelistMatcherData } from '../../dtos/types';
 /**
  * Extract whitelist array. Used by set and string matchers
  */
-export declare function setTransform(whitelistObject: ISplitMatcher['whitelistMatcherData']): string[] | null | undefined;
+export declare function setTransform(whitelistObject: IWhitelistMatcherData): string[];

package/types/evaluator/matchersTransform/whitelist.d.ts

@@ -1,5 +1,5 @@
 import { ISplitMatcher } from '../../dtos/types';
 /**
- * Extract whitelist as a set. Used by 'WHITELIST' matcher.
+ * Extract whitelist array.
  */
 export declare function whitelistTransform(whitelistObject: ISplitMatcher['whitelistMatcherData']): string[] | null | undefined;

package/types/evaluator/types.d.ts

@@ -8,6 +8,7 @@ export interface IDependencyMatcherValue {
 }
 export interface IMatcherDto {
     type: number;
+    name: string;
     value?: string | number | boolean | string[] | IDependencyMatcherData | IBetweenMatcherData | IBetweenStringMatcherData | null;
     attribute: string | null;
     negate: boolean;

package/types/logger/constants.d.ts

@@ -9,8 +9,24 @@ export declare const ENGINE_COMBINER_AND = 0;
 export declare const ENGINE_COMBINER_IFELSEIF = 1;
 export declare const ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = 2;
 export declare const ENGINE_BUCKET = 3;
+export declare const ENGINE_MATCHER_ALL = 4;
+export declare const ENGINE_MATCHER_BETWEEN = 5;
+export declare const ENGINE_MATCHER_BOOLEAN = 6;
+export declare const ENGINE_MATCHER_CONTAINS_ALL = 7;
+export declare const ENGINE_MATCHER_CONTAINS_ANY = 8;
+export declare const ENGINE_MATCHER_CONTAINS_STRING = 9;
 export declare const ENGINE_MATCHER_DEPENDENCY = 10;
 export declare const ENGINE_MATCHER_DEPENDENCY_PRE = 11;
+export declare const ENGINE_MATCHER_EQUAL = 12;
+export declare const ENGINE_MATCHER_EQUAL_TO_SET = 13;
+export declare const ENGINE_MATCHER_ENDS_WITH = 14;
+export declare const ENGINE_MATCHER_GREATER = 15;
+export declare const ENGINE_MATCHER_LESS = 16;
+export declare const ENGINE_MATCHER_PART_OF = 17;
+export declare const ENGINE_MATCHER_SEGMENT = 18;
+export declare const ENGINE_MATCHER_STRING = 19;
+export declare const ENGINE_MATCHER_STARTS_WITH = 21;
+export declare const ENGINE_MATCHER_WHITELIST = 22;
 export declare const ENGINE_VALUE = 23;
 export declare const ENGINE_SANITIZE = 24;
 export declare const CLEANUP_REGISTERING = 25;
@@ -28,7 +44,6 @@ export declare const SYNC_TASK_START = 36;
 export declare const SYNC_TASK_EXECUTE = 37;
 export declare const SYNC_TASK_STOP = 38;
 export declare const SETTINGS_SPLITS_FILTER = 39;
-export declare const ENGINE_MATCHER_RESULT = 40;
 export declare const CLIENT_READY_FROM_CACHE = 100;
 export declare const CLIENT_READY = 101;
 export declare const IMPRESSION = 102;

package/types/storages/KeyBuilder.d.ts

@@ -16,7 +16,7 @@ export declare class KeyBuilder {
     buildHashKey(): string;
 }
 /**
- * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export declare function getStorageHash(settings: ISettings): string;

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

@@ -2,4 +2,4 @@ import { ISettings } from '../../types';
 /**
  * Storage is async if mode is consumer or partial consumer
  */
-export declare function isStorageSync(settings: Pick<ISettings, 'mode'>): boolean;
+export declare function isStorageSync(settings: ISettings): boolean;

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

@@ -78,3 +78,4 @@ export declare const NON_REQUESTED = 1;
 export declare const DISABLED = 0;
 export declare const ENABLED = 1;
 export declare const PAUSED = 2;
+export declare const FLAGS_SPEC = "1.1";

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

@@ -5,4 +5,4 @@ export declare const SDK_NOT_READY = "not ready";
 export declare const EXCEPTION = "exception";
 export declare const SPLIT_ARCHIVED = "archived";
 export declare const NOT_IN_SPLIT = "not in split";
-export declare const UNSUPPORTED_MATCHER_TYPE = "unsupported matcher type";
+export declare const UNSUPPORTED_MATCHER_TYPE = "targeting rule type unsupported by sdk";

package/types/evaluator/matchers/sember_inlist.d.ts

@@ -1,3 +0,0 @@
-import { ISet } from '../../utils/lang/sets';
-import { ILogger } from '../../logger/types';
-export declare function inListSemverMatcherContext(log: ILogger, ruleAttr: ISet<string>): (runtimeAttr: string) => boolean;

package/types/evaluator/matchersTransform/string.d.ts

@@ -1,7 +0,0 @@
-import { ISplitMatcher } from '../../dtos/types';
-/**
- * Extract value from string matcher data.
- */
-export declare function stringTransform({ stringMatcherData }: ISplitMatcher): {
-    value: string | null | undefined;
-};

package/types/sdkClient/identity.d.ts

@@ -1,6 +0,0 @@
-import { SplitIO } from '../types';
-export declare function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string): string;
-export declare function parseInstanceId(instanceId: string): {
-    key: SplitIO.SplitKey;
-    trafficType?: string;
-};

package/types/storages/AbstractSplitsCache.d.ts

@@ -1,46 +0,0 @@
-import { ISplit, MaybeThenable } from '../dtos/types';
-/**
- * This class provides a skeletal implementation of the ISplitsCacheAsync interface
- * to minimize the effort required to implement this interface.
- */
-export declare abstract class AbstractSplitsCache {
-    /**
-     * Check if the splits information is already stored in cache. This data can be preloaded.
-     * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
-     */
-    checkCache(): boolean;
-    protected abstract addSplit(name: string, split: ISplit): MaybeThenable<boolean>;
-    /**
-     * Add a list of splits.
-     * The returned promise is resolved when the operation success or rejected if it fails (e.g., wrapper operation fails).
-     */
-    protected addSplits(entries: [string, ISplit][]): Promise<boolean[]>;
-    protected abstract removeSplit(name: string): MaybeThenable<boolean>;
-    /**
-     * Remove a list of splits.
-     * The returned promise is resolved when the operation success, with a boolean array indicating if the splits existed or not.
-     * or rejected if it fails (e.g., wrapper operation fails).
-     */
-    protected removeSplits(names: string[]): Promise<boolean[]>;
-    protected abstract setChangeNumber(changeNumber: number): MaybeThenable<boolean | void>;
-    /**
-     * Updates the cache with the provided changeNumber, feature flags to add and feature flags to remove.
-     *
-     * @returns {Promise<boolean>} a promise that resolved once the operation is performed successfully. The fulfillment value is `true` if at least one feature flag was added, modified or removed; or `false` if there was no change.
-     * The promise will reject if some storage operation rejects.
-     */
-    update(changeNumber: number, toAdd: [string, ISplit][], toRemove?: string[]): Promise<boolean>;
-    abstract getSplit(name: string): MaybeThenable<ISplit | null>;
-    /**
-     * Kill `name` split and set `defaultTreatment` and `changeNumber`.
-     * Used for SPLIT_KILL push notifications.
-     *
-     * @param {string} name
-     * @param {string} defaultTreatment
-     * @param {number} changeNumber
-     * @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
-     * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
-     * The promise will never be rejected.
-     */
-    killLocally(name: string, defaultTreatment: string, changeNumber: number): Promise<boolean>;
-}

package/types/sync/streaming/mySegmentsV2utils.d.ts

@@ -1,27 +0,0 @@
-import { Compression, KeyList } from './SSEHandler/types';
-/**
- * Decode, decompress and parse the provided 'data' into a KeyList object
- *
- * @param {string} data
- * @param {number} compression
- * @returns {{a?: string[], r?: string[] }}
- * @throws if data string cannot be decoded, decompressed or parsed
- */
-export declare function parseKeyList(data: string, compression: Compression): KeyList;
-/**
- * Decode, decompress and parse the provided 'data' into a Bitmap object
- *
- * @param {string} data
- * @param {number} compression
- * @returns {Uint8Array}
- * @throws if data string cannot be decoded or decompressed
- */
-export declare function parseBitmap(data: string, compression: Compression): Uint8Array;
-/**
- * Check if the 'bitmap' bit at 'hash64hex' position is 1
- *
- * @param {Uint8Array} bitmap
- * @param {string} hash64hex 16-chars string, representing a number in hexa
- * @returns {boolean}
- */
-export declare function isInBitmap(bitmap: Uint8Array, hash64hex: string): boolean;

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

@@ -1,7 +0,0 @@
-import { ILogger } from '../../logger/types';
-/** validates the given SDK key */
-export declare function validateApiKey(log: ILogger, maybeSdkKey: any): string | false;
-export declare const usedKeysMap: Record<string, number>;
-/** validates the given SDK key and also warns if it is in use */
-export declare function validateAndTrackApiKey(log: ILogger, maybeSdkKey: any): string | false;
-export declare function releaseApiKey(sdkKey: string): void;

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

@@ -1,8 +0,0 @@
-import { LogLevel } from '../../../types';
-/**
- * The debug level can be set globally via the `localStorage.splitio_debug` item in browser, or the `SPLITIO_DEBUG` env var in NodeJS.
- * Acceptable values are: 'DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'.
- * Other acceptable values are 'on', 'enable' and 'enabled', which are equivalent to 'DEBUG'.
- * Any other value, like undefined, null or an invalid string, returns `undefined` and means that the global log level is not set.
- */
-export declare function getGlobalLogLevel(): LogLevel | undefined;