@splitsoftware/splitio-commons 1.17.1-rc.4 → 1.17.1

package/cjs/sdkClient/identity.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildInstanceId = void 0;
-function buildInstanceId(key, trafficType) {
-    return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType ? trafficType : '');
-}
-exports.buildInstanceId = buildInstanceId;

package/cjs/storages/AbstractMySegmentsCacheSync.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractMySegmentsCacheSync = void 0;
-/**
- * This class provides a skeletal implementation of the ISegmentsCacheSync interface
- * to minimize the effort required to implement this interface.
- */
-var AbstractMySegmentsCacheSync = /** @class */ (function () {
-    function AbstractMySegmentsCacheSync() {
-    }
-    /**
-     * clear the cache.
-     */
-    AbstractMySegmentsCacheSync.prototype.clear = function () {
-        this.resetSegments({});
-    };
-    // No-op. Not used in client-side.
-    AbstractMySegmentsCacheSync.prototype.registerSegments = function () { return false; };
-    AbstractMySegmentsCacheSync.prototype.update = function () { return false; };
-    /**
-     * For server-side synchronizer: the method is not used.
-     * For client-side synchronizer: it resets or updates the cache.
-     */
-    AbstractMySegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
-        var _this = this;
-        this.setChangeNumber(segmentsData.cn);
-        var _a = segmentsData, added = _a.added, removed = _a.removed;
-        if (added && removed) {
-            var isDiff_1 = false;
-            added.forEach(function (segment) {
-                isDiff_1 = _this.addSegment(segment) || isDiff_1;
-            });
-            removed.forEach(function (segment) {
-                isDiff_1 = _this.removeSegment(segment) || isDiff_1;
-            });
-            return isDiff_1;
-        }
-        var names = (segmentsData.k || []).map(function (s) { return s.n; }).sort();
-        var storedSegmentKeys = this.getRegisteredSegments().sort();
-        // Extreme fast => everything is empty
-        if (!names.length && !storedSegmentKeys.length)
-            return false;
-        var index = 0;
-        while (index < names.length && index < storedSegmentKeys.length && names[index] === storedSegmentKeys[index])
-            index++;
-        // Quick path => no changes
-        if (index === names.length && index === storedSegmentKeys.length)
-            return false;
-        // Slowest path => add and/or remove segments
-        for (var removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
-            this.removeSegment(storedSegmentKeys[removeIndex]);
-        }
-        for (var addIndex = index; addIndex < names.length; addIndex++) {
-            this.addSegment(names[addIndex]);
-        }
-        return true;
-    };
-    return AbstractMySegmentsCacheSync;
-}());
-exports.AbstractMySegmentsCacheSync = AbstractMySegmentsCacheSync;

package/esm/evaluator/matchers/large_segment.js

@@ -1,12 +0,0 @@
-import { thenable } from '../../utils/promise/thenable';
-export function largeSegmentMatcherContext(largeSegmentName, storage) {
-    return function largeSegmentMatcher(key) {
-        var isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
-        if (thenable(isInLargeSegment)) {
-            isInLargeSegment.then(function (result) {
-                return result;
-            });
-        }
-        return isInLargeSegment;
-    };
-}

package/esm/sdkClient/identity.js

@@ -1,3 +0,0 @@
-export function buildInstanceId(key, trafficType) {
-    return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType ? trafficType : '');
-}

package/esm/storages/AbstractMySegmentsCacheSync.js

@@ -1,57 +0,0 @@
-/**
- * This class provides a skeletal implementation of the ISegmentsCacheSync interface
- * to minimize the effort required to implement this interface.
- */
-var AbstractMySegmentsCacheSync = /** @class */ (function () {
-    function AbstractMySegmentsCacheSync() {
-    }
-    /**
-     * clear the cache.
-     */
-    AbstractMySegmentsCacheSync.prototype.clear = function () {
-        this.resetSegments({});
-    };
-    // No-op. Not used in client-side.
-    AbstractMySegmentsCacheSync.prototype.registerSegments = function () { return false; };
-    AbstractMySegmentsCacheSync.prototype.update = function () { return false; };
-    /**
-     * For server-side synchronizer: the method is not used.
-     * For client-side synchronizer: it resets or updates the cache.
-     */
-    AbstractMySegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
-        var _this = this;
-        this.setChangeNumber(segmentsData.cn);
-        var _a = segmentsData, added = _a.added, removed = _a.removed;
-        if (added && removed) {
-            var isDiff_1 = false;
-            added.forEach(function (segment) {
-                isDiff_1 = _this.addSegment(segment) || isDiff_1;
-            });
-            removed.forEach(function (segment) {
-                isDiff_1 = _this.removeSegment(segment) || isDiff_1;
-            });
-            return isDiff_1;
-        }
-        var names = (segmentsData.k || []).map(function (s) { return s.n; }).sort();
-        var storedSegmentKeys = this.getRegisteredSegments().sort();
-        // Extreme fast => everything is empty
-        if (!names.length && !storedSegmentKeys.length)
-            return false;
-        var index = 0;
-        while (index < names.length && index < storedSegmentKeys.length && names[index] === storedSegmentKeys[index])
-            index++;
-        // Quick path => no changes
-        if (index === names.length && index === storedSegmentKeys.length)
-            return false;
-        // Slowest path => add and/or remove segments
-        for (var removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
-            this.removeSegment(storedSegmentKeys[removeIndex]);
-        }
-        for (var addIndex = index; addIndex < names.length; addIndex++) {
-            this.addSegment(names[addIndex]);
-        }
-        return true;
-    };
-    return AbstractMySegmentsCacheSync;
-}());
-export { AbstractMySegmentsCacheSync };

package/src/evaluator/matchers/large_segment.ts

@@ -1,18 +0,0 @@
-import { MaybeThenable } from '../../dtos/types';
-import { ISegmentsCacheBase } from '../../storages/types';
-import { thenable } from '../../utils/promise/thenable';
-
-export function largeSegmentMatcherContext(largeSegmentName: string, storage: { largeSegments?: ISegmentsCacheBase }) {
-
-  return function largeSegmentMatcher(key: string): MaybeThenable<boolean> {
-    const isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
-
-    if (thenable(isInLargeSegment)) {
-      isInLargeSegment.then(result => {
-        return result;
-      });
-    }
-
-    return isInLargeSegment;
-  };
-}

package/src/sdkClient/identity.ts

@@ -1,5 +0,0 @@
-import { SplitIO } from '../types';
-
-export function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string) { // @ts-ignore
-  return `${key.matchingKey ? key.matchingKey : key}-${key.bucketingKey ? key.bucketingKey : key}-${trafficType ? trafficType : ''}`;
-}

package/src/storages/AbstractMySegmentsCacheSync.ts

@@ -1,94 +0,0 @@
-import { IMySegmentsResponse } from '../dtos/types';
-import { MySegmentsData } from '../sync/polling/types';
-import { ISegmentsCacheSync } from './types';
-
-/**
- * This class provides a skeletal implementation of the ISegmentsCacheSync interface
- * to minimize the effort required to implement this interface.
- */
-export abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync {
-
-  protected abstract addSegment(name: string): boolean
-  protected abstract removeSegment(name: string): boolean
-  protected abstract setChangeNumber(changeNumber?: number): boolean | void
-
-  /**
-   * For server-side synchronizer: check if `key` is in `name` segment.
-   * For client-side synchronizer: check if `name` segment is in the cache. `key` is undefined.
-   */
-  abstract isInSegment(name: string, key?: string): boolean
-
-  /**
-   * clear the cache.
-   */
-  clear() {
-    this.resetSegments({});
-  }
-
-
-  // No-op. Not used in client-side.
-  registerSegments(): boolean { return false; }
-  update() { return false; }
-
-  /**
-   * For server-side synchronizer: get the list of segments to fetch changes.
-   * Also used for the `seC` (segment count) telemetry stat.
-   */
-  abstract getRegisteredSegments(): string[]
-
-  /**
-   * Only used for the `skC`(segment keys count) telemetry stat: 1 for client-side, and total count of keys in server-side.
-   * @TODO for client-side it should be the number of clients, but it requires a refactor of MySegments caches to simplify the code.
-   */
-  abstract getKeysCount(): number
-
-  abstract getChangeNumber(name: string): number
-
-  /**
-   * For server-side synchronizer: the method is not used.
-   * For client-side synchronizer: it resets or updates the cache.
-   */
-  resetSegments(segmentsData: MySegmentsData | IMySegmentsResponse): boolean {
-    this.setChangeNumber(segmentsData.cn);
-
-    const { added, removed } = segmentsData as MySegmentsData;
-
-    if (added && removed) {
-      let isDiff = false;
-
-      added.forEach(segment => {
-        isDiff = this.addSegment(segment) || isDiff;
-      });
-
-      removed.forEach(segment => {
-        isDiff = this.removeSegment(segment) || isDiff;
-      });
-
-      return isDiff;
-    }
-
-    const names = ((segmentsData as IMySegmentsResponse).k || []).map(s => s.n).sort();
-    const storedSegmentKeys = this.getRegisteredSegments().sort();
-
-    // Extreme fast => everything is empty
-    if (!names.length && !storedSegmentKeys.length) return false;
-
-    let index = 0;
-
-    while (index < names.length && index < storedSegmentKeys.length && names[index] === storedSegmentKeys[index]) index++;
-
-    // Quick path => no changes
-    if (index === names.length && index === storedSegmentKeys.length) return false;
-
-    // Slowest path => add and/or remove segments
-    for (let removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
-      this.removeSegment(storedSegmentKeys[removeIndex]);
-    }
-
-    for (let addIndex = index; addIndex < names.length; addIndex++) {
-      this.addSegment(names[addIndex]);
-    }
-
-    return true;
-  }
-}

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

@@ -1,5 +0,0 @@
-import { MaybeThenable } from '../../dtos/types';
-import { ISegmentsCacheBase } from '../../storages/types';
-export declare function largeSegmentMatcherContext(largeSegmentName: string, storage: {
-    largeSegments?: ISegmentsCacheBase;
-}): (key: string) => MaybeThenable<boolean>;

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/set.d.ts

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

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,2 +0,0 @@
-import { SplitIO } from '../types';
-export declare function buildInstanceId(key: SplitIO.SplitKey, trafficType?: string): string;

package/types/storages/AbstractMySegmentsCacheSync.d.ts

@@ -1,39 +0,0 @@
-import { IMySegmentsResponse } from '../dtos/types';
-import { MySegmentsData } from '../sync/polling/types';
-import { ISegmentsCacheSync } from './types';
-/**
- * This class provides a skeletal implementation of the ISegmentsCacheSync interface
- * to minimize the effort required to implement this interface.
- */
-export declare abstract class AbstractMySegmentsCacheSync implements ISegmentsCacheSync {
-    protected abstract addSegment(name: string): boolean;
-    protected abstract removeSegment(name: string): boolean;
-    protected abstract setChangeNumber(changeNumber?: number): boolean | void;
-    /**
-     * For server-side synchronizer: check if `key` is in `name` segment.
-     * For client-side synchronizer: check if `name` segment is in the cache. `key` is undefined.
-     */
-    abstract isInSegment(name: string, key?: string): boolean;
-    /**
-     * clear the cache.
-     */
-    clear(): void;
-    registerSegments(): boolean;
-    update(): boolean;
-    /**
-     * For server-side synchronizer: get the list of segments to fetch changes.
-     * Also used for the `seC` (segment count) telemetry stat.
-     */
-    abstract getRegisteredSegments(): string[];
-    /**
-     * Only used for the `skC`(segment keys count) telemetry stat: 1 for client-side, and total count of keys in server-side.
-     * @TODO for client-side it should be the number of clients, but it requires a refactor of MySegments caches to simplify the code.
-     */
-    abstract getKeysCount(): number;
-    abstract getChangeNumber(name: string): number;
-    /**
-     * For server-side synchronizer: the method is not used.
-     * For client-side synchronizer: it resets or updates the cache.
-     */
-    resetSegments(segmentsData: MySegmentsData | IMySegmentsResponse): boolean;
-}

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/sync/streaming/pushManagerCS_Spec1_3.d.ts

@@ -1,9 +0,0 @@
-import { IPushManager } from './types';
-import { IPollingManager } from '../polling/types';
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-/**
- * PushManager factory:
- * - for server-side if key is not provided in settings.
- * - for client-side, with support for multiple clients, if key is provided in settings
- */
-export declare function pushManagerFactory(params: ISdkFactoryContextSync, pollingManager: IPollingManager): IPushManager | undefined;

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

@@ -1,9 +0,0 @@
-import { IPushManager } from './types';
-import { IPollingManager } from '../polling/types';
-import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-/**
- * PushManager factory:
- * - for server-side if key is not provided in settings.
- * - for client-side, with support for multiple clients, if key is provided in settings
- */
-export declare function pushManagerFactory(params: ISdkFactoryContextSync, pollingManager: IPollingManager): IPushManager | undefined;

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

@@ -1,5 +0,0 @@
-import { ISettings } from '../../types';
-/**
- * Storage is async if mode is consumer or partial consumer
- */
-export declare function isStorageSync(settings: Pick<ISettings, 'mode'>): 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/inputValidation/splitExistance.d.ts

@@ -1,7 +0,0 @@
-import { IReadinessManager } from '../../readiness/types';
-import { ILogger } from '../../logger/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.
- */
-export declare function validateSplitExistance(log: ILogger, readinessManager: IReadinessManager, splitName: string, labelOrSplitObj: any, method: string): boolean;

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

@@ -1,9 +0,0 @@
-import { ISplitsCacheBase } from '../../storages/types';
-import { IReadinessManager } from '../../readiness/types';
-import { SDKMode } from '../../types';
-import { MaybeThenable } from '../../dtos/types';
-import { ILogger } from '../../logger/types';
-/**
- * Separated from the previous method since on some cases it'll be async.
- */
-export declare function validateTrafficTypeExistance(log: ILogger, readinessManager: IReadinessManager, splitsCache: ISplitsCacheBase, mode: SDKMode, maybeTT: string, method: string): MaybeThenable<boolean>;

package/types/utils/redis/RedisMock.d.ts

@@ -1,4 +0,0 @@
-export declare class RedisMock {
-    private pipelineMethods;
-    constructor();
-}

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;