flagsmith-nodejs 2.5.2 → 3.0.0

package/build/flagsmith-engine/utils/collections.js

@@ -1,26 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IdentityFeaturesList = void 0;
-var IdentityFeaturesList = /** @class */ (function (_super) {
-    __extends(IdentityFeaturesList, _super);
-    function IdentityFeaturesList() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return IdentityFeaturesList;
-}(Array));
-exports.IdentityFeaturesList = IdentityFeaturesList;

package/build/flagsmith-engine/utils/errors.d.ts

@@ -1,2 +0,0 @@
-export declare class FeatureStateNotFound extends Error {
-}

package/build/flagsmith-engine/utils/errors.js

@@ -1,26 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeatureStateNotFound = void 0;
-var FeatureStateNotFound = /** @class */ (function (_super) {
-    __extends(FeatureStateNotFound, _super);
-    function FeatureStateNotFound() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return FeatureStateNotFound;
-}(Error));
-exports.FeatureStateNotFound = FeatureStateNotFound;

package/build/flagsmith-engine/utils/hashing/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * Given a list of object ids, get a floating point number between 0 and 1 based on
- * the hash of those ids. This should give the same value every time for any list of ids.
- *
- * @param  {Array<any>} objectIds list of object ids to calculate the has for
- * @param  {} iterations=1 num times to include each id in the generated string to hash
- * @returns number number between 0 (inclusive) and 100 (exclusive)
- */
-export declare function getHashedPercentateForObjIds(objectIds: Array<any>, iterations?: number): number;

package/build/flagsmith-engine/utils/hashing/index.js

@@ -1,60 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHashedPercentateForObjIds = void 0;
-var md5_1 = __importDefault(require("md5"));
-var big_integer_1 = __importDefault(require("big-integer"));
-var makeRepeated = function (arr, repeats) {
-    return Array.from({ length: repeats }, function () { return arr; }).flat();
-};
-// https://stackoverflow.com/questions/12532871/how-to-convert-a-very-large-hex-number-to-decimal-in-javascript
-function h2d(s) {
-    function add(x, y) {
-        var c = 0, r = [];
-        var x = x.split('').map(Number);
-        var y = y.split('').map(Number);
-        while (x.length || y.length) {
-            var s = (x.pop() || 0) + (y.pop() || 0) + c;
-            r.unshift(s < 10 ? s : s - 10);
-            c = s < 10 ? 0 : 1;
-        }
-        if (c)
-            r.unshift(c);
-        return r.join('');
-    }
-    var dec = '0';
-    s.split('').forEach(function (chr) {
-        var n = parseInt(chr, 16);
-        for (var t = 8; t; t >>= 1) {
-            dec = add(dec, dec);
-            if (n & t)
-                dec = add(dec, '1');
-        }
-    });
-    return dec;
-}
-/**
- * Given a list of object ids, get a floating point number between 0 and 1 based on
- * the hash of those ids. This should give the same value every time for any list of ids.
- *
- * @param  {Array<any>} objectIds list of object ids to calculate the has for
- * @param  {} iterations=1 num times to include each id in the generated string to hash
- * @returns number number between 0 (inclusive) and 100 (exclusive)
- */
-function getHashedPercentateForObjIds(objectIds, iterations) {
-    if (iterations === void 0) { iterations = 1; }
-    var toHash = makeRepeated(objectIds, iterations).join(',');
-    var hashedValue = (0, md5_1.default)(toHash);
-    var hashedInt = (0, big_integer_1.default)(h2d(hashedValue));
-    var value = (hashedInt.mod(9999).toJSNumber() / 9998) * 100;
-    // we ignore this for it's nearly impossible use case to catch
-    /* istanbul ignore next */
-    if (value === 100) {
-        /* istanbul ignore next */
-        return getHashedPercentateForObjIds(objectIds, iterations + 1);
-    }
-    return value;
-}
-exports.getHashedPercentateForObjIds = getHashedPercentateForObjIds;

package/build/flagsmith-engine/utils/index.d.ts

@@ -1 +0,0 @@
-export declare function getCastingFunction(traitType: 'boolean' | 'string' | 'number' | 'semver' | any): CallableFunction;

package/build/flagsmith-engine/utils/index.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCastingFunction = void 0;
-var util_1 = require("../segments/util");
-function getCastingFunction(traitType) {
-    switch (traitType) {
-        case 'boolean':
-            return function (x) { return !['False', 'false'].includes(x); };
-        case 'number':
-            return function (x) { return parseFloat(x); };
-        case 'semver':
-            return function (x) { return (0, util_1.removeSemverSuffix)(x); };
-        default:
-            return function (x) { return String(x); };
-    }
-}
-exports.getCastingFunction = getCastingFunction;

package/build/index.d.ts

@@ -1,2 +0,0 @@
-export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags, default } from './sdk';
-export { EnvironmentModel, IntegrationModel, FeatureStateModel, IdentityModel, TraitModel, SegmentModel, OrganisationModel } from './flagsmith-engine';

package/build/index.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.IntegrationModel = exports.EnvironmentModel = exports.default = exports.Flags = exports.DefaultFlag = exports.EnvironmentDataPollingManager = exports.FlagsmithClientError = exports.FlagsmithAPIError = exports.AnalyticsProcessor = void 0;
-var sdk_1 = __importDefault(require("./sdk"));
-var sdk_2 = require("./sdk");
-Object.defineProperty(exports, "AnalyticsProcessor", { enumerable: true, get: function () { return sdk_2.AnalyticsProcessor; } });
-Object.defineProperty(exports, "FlagsmithAPIError", { enumerable: true, get: function () { return sdk_2.FlagsmithAPIError; } });
-Object.defineProperty(exports, "FlagsmithClientError", { enumerable: true, get: function () { return sdk_2.FlagsmithClientError; } });
-Object.defineProperty(exports, "EnvironmentDataPollingManager", { enumerable: true, get: function () { return sdk_2.EnvironmentDataPollingManager; } });
-Object.defineProperty(exports, "DefaultFlag", { enumerable: true, get: function () { return sdk_2.DefaultFlag; } });
-Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return sdk_2.Flags; } });
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(sdk_2).default; } });
-var flagsmith_engine_1 = require("./flagsmith-engine");
-Object.defineProperty(exports, "EnvironmentModel", { enumerable: true, get: function () { return flagsmith_engine_1.EnvironmentModel; } });
-Object.defineProperty(exports, "IntegrationModel", { enumerable: true, get: function () { return flagsmith_engine_1.IntegrationModel; } });
-Object.defineProperty(exports, "FeatureStateModel", { enumerable: true, get: function () { return flagsmith_engine_1.FeatureStateModel; } });
-Object.defineProperty(exports, "IdentityModel", { enumerable: true, get: function () { return flagsmith_engine_1.IdentityModel; } });
-Object.defineProperty(exports, "TraitModel", { enumerable: true, get: function () { return flagsmith_engine_1.TraitModel; } });
-Object.defineProperty(exports, "SegmentModel", { enumerable: true, get: function () { return flagsmith_engine_1.SegmentModel; } });
-Object.defineProperty(exports, "OrganisationModel", { enumerable: true, get: function () { return flagsmith_engine_1.OrganisationModel; } });
-module.exports = sdk_1.default;

package/build/sdk/analytics.d.ts

@@ -1,31 +0,0 @@
-import { Logger } from 'pino';
-export declare class AnalyticsProcessor {
-    private analyticsEndpoint;
-    private environmentKey;
-    private lastFlushed;
-    analyticsData: {
-        [key: string]: any;
-    };
-    private requestTimeoutMs;
-    private logger;
-    /**
-     * AnalyticsProcessor is used to track how often individual Flags are evaluated within
-     * the Flagsmith SDK. Docs: https://docs.flagsmith.com/advanced-use/flag-analytics.
-     *
-     * @param data.environmentKey environment key obtained from the Flagsmith UI
-     * @param data.baseApiUrl base api url to override when using self hosted version
-     * @param data.requestTimeoutMs used to tell requests to stop waiting for a response after a
-            given number of milliseconds
-     */
-    constructor(data: {
-        environmentKey: string;
-        baseApiUrl: string;
-        requestTimeoutMs?: number;
-        logger?: Logger;
-    });
-    /**
-     * Sends all the collected data to the api asynchronously and resets the timer
-     */
-    flush(): Promise<void>;
-    trackFeature(featureName: string): void;
-}

package/build/sdk/analytics.js

@@ -1,116 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalyticsProcessor = void 0;
-var node_fetch_1 = __importDefault(require("node-fetch"));
-var pino_1 = __importDefault(require("pino"));
-var ANALYTICS_ENDPOINT = 'analytics/flags/';
-// Used to control how often we send data(in seconds)
-var ANALYTICS_TIMER = 10;
-var AnalyticsProcessor = /** @class */ (function () {
-    /**
-     * AnalyticsProcessor is used to track how often individual Flags are evaluated within
-     * the Flagsmith SDK. Docs: https://docs.flagsmith.com/advanced-use/flag-analytics.
-     *
-     * @param data.environmentKey environment key obtained from the Flagsmith UI
-     * @param data.baseApiUrl base api url to override when using self hosted version
-     * @param data.requestTimeoutMs used to tell requests to stop waiting for a response after a
-            given number of milliseconds
-     */
-    function AnalyticsProcessor(data) {
-        this.requestTimeoutMs = 3000;
-        this.analyticsEndpoint = data.baseApiUrl + ANALYTICS_ENDPOINT;
-        this.environmentKey = data.environmentKey;
-        this.lastFlushed = Date.now();
-        this.analyticsData = {};
-        this.requestTimeoutMs = data.requestTimeoutMs || this.requestTimeoutMs;
-        this.logger = data.logger || (0, pino_1.default)();
-    }
-    /**
-     * Sends all the collected data to the api asynchronously and resets the timer
-     */
-    AnalyticsProcessor.prototype.flush = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var error_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!Object.keys(this.analyticsData).length) {
-                            return [2 /*return*/];
-                        }
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, (0, node_fetch_1.default)(this.analyticsEndpoint, {
-                                method: 'POST',
-                                body: JSON.stringify(this.analyticsData),
-                                timeout: this.requestTimeoutMs,
-                                headers: {
-                                    'Content-Type': 'application/json',
-                                    'X-Environment-Key': this.environmentKey
-                                }
-                            })];
-                    case 2:
-                        _a.sent();
-                        return [3 /*break*/, 4];
-                    case 3:
-                        error_1 = _a.sent();
-                        // We don't want failing to write analytics to cause any exceptions in the main
-                        // thread so we just swallow them here.
-                        this.logger.warn('Failed to post analytics to Flagsmith API. Not clearing data, will retry.');
-                        return [2 /*return*/];
-                    case 4:
-                        this.analyticsData = {};
-                        this.lastFlushed = Date.now();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    AnalyticsProcessor.prototype.trackFeature = function (featureName) {
-        this.analyticsData[featureName] = (this.analyticsData[featureName] || 0) + 1;
-        if (Date.now() - this.lastFlushed > ANALYTICS_TIMER * 1000) {
-            this.flush();
-        }
-    };
-    return AnalyticsProcessor;
-}());
-exports.AnalyticsProcessor = AnalyticsProcessor;

package/build/sdk/errors.d.ts

@@ -1,4 +0,0 @@
-export declare class FlagsmithClientError extends Error {
-}
-export declare class FlagsmithAPIError extends Error {
-}

package/build/sdk/errors.js

@@ -1,34 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlagsmithAPIError = exports.FlagsmithClientError = void 0;
-var FlagsmithClientError = /** @class */ (function (_super) {
-    __extends(FlagsmithClientError, _super);
-    function FlagsmithClientError() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return FlagsmithClientError;
-}(Error));
-exports.FlagsmithClientError = FlagsmithClientError;
-var FlagsmithAPIError = /** @class */ (function (_super) {
-    __extends(FlagsmithAPIError, _super);
-    function FlagsmithAPIError() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return FlagsmithAPIError;
-}(Error));
-exports.FlagsmithAPIError = FlagsmithAPIError;

package/build/sdk/index.d.ts

@@ -1,120 +0,0 @@
-import { RequestInit } from "node-fetch";
-import { EnvironmentModel } from '../flagsmith-engine/environments/models';
-import { DefaultFlag, Flags } from './models';
-import { EnvironmentDataPollingManager } from './polling_manager';
-import { SegmentModel } from '../flagsmith-engine/segments/models';
-import { FlagsmithConfig } from './types';
-export { AnalyticsProcessor } from './analytics';
-export { FlagsmithAPIError, FlagsmithClientError } from './errors';
-export { DefaultFlag, Flags } from './models';
-export { EnvironmentDataPollingManager } from './polling_manager';
-export { FlagsmithCache, FlagsmithConfig } from './types';
-export declare class Flagsmith {
-    environmentKey?: string;
-    apiUrl: string;
-    customHeaders?: {
-        [key: string]: any;
-    };
-    requestTimeoutSeconds?: number;
-    agent: RequestInit['agent'];
-    requestTimeoutMs?: number;
-    enableLocalEvaluation?: boolean;
-    environmentRefreshIntervalSeconds: number;
-    retries?: number;
-    enableAnalytics: boolean;
-    defaultFlagHandler?: (featureName: string) => DefaultFlag;
-    environmentFlagsUrl: string;
-    identitiesUrl: string;
-    environmentUrl: string;
-    environmentDataPollingManager?: EnvironmentDataPollingManager;
-    environment: EnvironmentModel;
-    private cache?;
-    private onEnvironmentChange?;
-    private analyticsProcessor?;
-    private logger;
-    /**
-     * A Flagsmith client.
-     *
-     * Provides an interface for interacting with the Flagsmith http API.
-     * Basic Usage::
-     *
-     * import flagsmith from Flagsmith
-     * const flagsmith = new Flagsmith({environmentKey: '<your API key>'});
-     * const environmentFlags = flagsmith.getEnvironmentFlags();
-     * const featureEnabled = environmentFlags.isFeatureEnabled('foo');
-     * const identityFlags = flagsmith.getIdentityFlags('identifier', {'foo': 'bar'});
-     * const featureEnabledForIdentity = identityFlags.isFeatureEnabled("foo")
-     *
-     *  @param {string} data.environmentKey: The environment key obtained from Flagsmith interface
-        @param {string} data.apiUrl: Override the URL of the Flagsmith API to communicate with
-        @param  data.customHeaders: Additional headers to add to requests made to the
-            Flagsmith API
-        @param {number} data.requestTimeoutSeconds: Number of seconds to wait for a request to
-            complete before terminating the request
-        @param {boolean} data.enableLocalEvaluation: Enables local evaluation of flags
-        @param {number} data.environmentRefreshIntervalSeconds: If using local evaluation,
-            specify the interval period between refreshes of local environment data
-        @param {number} data.retries: a urllib3.Retry object to use on all http requests to the
-            Flagsmith API
-        @param {boolean} data.enableAnalytics: if enabled, sends additional requests to the Flagsmith
-            API to power flag analytics charts
-        @param data.defaultFlagHandler: callable which will be used in the case where
-            flags cannot be retrieved from the API or a non existent feature is
-            requested
-        @param data.logger: an instance of the pino Logger class to use for logging
-     */
-    constructor(data: FlagsmithConfig);
-    /**
-     * Get all the default for flags for the current environment.
-     *
-     * @returns Flags object holding all the flags for the current environment.
-     */
-    getEnvironmentFlags(): Promise<Flags>;
-    /**
-     * Get all the flags for the current environment for a given identity. Will also
-        upsert all traits to the Flagsmith API for future evaluations. Providing a
-        trait with a value of None will remove the trait from the identity if it exists.
-     *
-     * @param  {string} identifier a unique identifier for the identity in the current
-            environment, e.g. email address, username, uuid
-     * @param  {{[key:string]:any}} traits? a dictionary of traits to add / update on the identity in
-            Flagsmith, e.g. {"num_orders": 10}
-     * @returns Flags object holding all the flags for the given identity.
-     */
-    getIdentityFlags(identifier: string, traits?: {
-        [key: string]: any;
-    }): Promise<Flags>;
-    /**
-     * Get the segments for the current environment for a given identity. Will also
-        upsert all traits to the Flagsmith API for future evaluations. Providing a
-        trait with a value of None will remove the trait from the identity if it exists.
-     *
-     * @param  {string} identifier a unique identifier for the identity in the current
-            environment, e.g. email address, username, uuid
-     * @param  {{[key:string]:any}} traits? a dictionary of traits to add / update on the identity in
-            Flagsmith, e.g. {"num_orders": 10}
-     * @returns Segments that the given identity belongs to.
-     */
-    getIdentitySegments(identifier: string, traits?: {
-        [key: string]: any;
-    }): Promise<SegmentModel[]>;
-    /**
-     * Updates the environment state for local flag evaluation.
-     * Sets a local promise to prevent race conditions in getIdentityFlags / getIdentitySegments.
-     * You only need to call this if you wish to bypass environmentRefreshIntervalSeconds.
-     */
-    updateEnvironment(): Promise<void>;
-    close(): Promise<void>;
-    private getJSONResponse;
-    /**
-     * This promise ensures that the environment is retrieved before attempting to locally evaluate.
-     */
-    private environmentPromise;
-    private getEnvironmentFromApi;
-    private getEnvironmentFlagsFromDocument;
-    private getIdentityFlagsFromDocument;
-    private getEnvironmentFlagsFromApi;
-    private getIdentityFlagsFromApi;
-    private buildIdentityModel;
-}
-export default Flagsmith;