flagsmith-nodejs 2.0.0 → 2.0.3

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

@@ -0,0 +1,17 @@
+"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

@@ -0,0 +1 @@
+export { Flagsmith } from './sdk';

package/build/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Flagsmith = void 0;
+var sdk_1 = __importDefault(require("./sdk"));
+var sdk_2 = require("./sdk");
+Object.defineProperty(exports, "Flagsmith", { enumerable: true, get: function () { return sdk_2.Flagsmith; } });
+// export default Flagsmith;
+module.exports = sdk_1.default;

package/build/sdk/analytics.d.ts

@@ -0,0 +1,28 @@
+export declare class AnalyticsProcessor {
+    private analyticsEndpoint;
+    private environmentKey;
+    private lastFlushed;
+    analyticsData: {
+        [key: string]: any;
+    };
+    private timeout;
+    /**
+     * 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.timeout used to tell requests to stop waiting for a response after a
+            given number of seconds
+     */
+    constructor(data: {
+        environmentKey: string;
+        baseApiUrl: string;
+        timeout?: number;
+    });
+    /**
+     * Sends all the collected data to the api asynchronously and resets the timer
+     */
+    flush(): Promise<void>;
+    trackFeature(featureId: number): void;
+}

package/build/sdk/analytics.js

@@ -0,0 +1,102 @@
+"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 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.timeout used to tell requests to stop waiting for a response after a
+            given number of seconds
+     */
+    function AnalyticsProcessor(data) {
+        this.timeout = 3;
+        this.analyticsEndpoint = data.baseApiUrl + ANALYTICS_ENDPOINT;
+        this.environmentKey = data.environmentKey;
+        this.lastFlushed = Date.now();
+        this.analyticsData = {};
+        this.timeout = data.timeout || this.timeout;
+    }
+    /**
+     * 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 () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!Object.keys(this.analyticsData).length) {
+                            return [2 /*return*/];
+                        }
+                        return [4 /*yield*/, (0, node_fetch_1.default)(this.analyticsEndpoint, {
+                                method: 'POST',
+                                body: JSON.stringify(this.analyticsData),
+                                timeout: this.timeout,
+                                headers: {
+                                    'Content-Type': 'application/json',
+                                    'X-Environment-Key': this.environmentKey
+                                }
+                            })];
+                    case 1:
+                        _a.sent();
+                        this.analyticsData = {};
+                        this.lastFlushed = Date.now();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AnalyticsProcessor.prototype.trackFeature = function (featureId) {
+        this.analyticsData[featureId] = (this.analyticsData[featureId] || 0) + 1;
+        if (Date.now() - this.lastFlushed > ANALYTICS_TIMER * 1000) {
+            this.flush();
+        }
+    };
+    return AnalyticsProcessor;
+}());
+exports.AnalyticsProcessor = AnalyticsProcessor;

package/build/sdk/errors.d.ts

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

package/build/sdk/errors.js

@@ -0,0 +1,34 @@
+"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

@@ -0,0 +1,123 @@
+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 { FlagsmithCache } from './types';
+export declare class Flagsmith {
+    environmentKey?: string;
+    apiUrl: string;
+    customHeaders?: {
+        [key: string]: any;
+    };
+    requestTimeoutSeconds?: 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?;
+    /**
+     * 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
+     */
+    constructor(data: {
+        environmentKey: string;
+        apiUrl?: string;
+        customHeaders?: {
+            [key: string]: any;
+        };
+        requestTimeoutSeconds?: number;
+        enableLocalEvaluation?: boolean;
+        environmentRefreshIntervalSeconds?: number;
+        retries?: number;
+        enableAnalytics?: boolean;
+        defaultFlagHandler?: (featureName: string) => DefaultFlag;
+        cache?: FlagsmithCache;
+        onEnvironmentChange?: (error: Error | null, result: EnvironmentModel) => void;
+    });
+    /**
+     * 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>;
+    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;