flagsmith-nodejs 2.0.0-beta.5 → 2.0.0-beta.6

package/build/sdk/errors.js

@@ -1,9 +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;
-class FlagsmithClientError extends Error {
-}
+var FlagsmithClientError = /** @class */ (function (_super) {
+    __extends(FlagsmithClientError, _super);
+    function FlagsmithClientError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return FlagsmithClientError;
+}(Error));
 exports.FlagsmithClientError = FlagsmithClientError;
-class FlagsmithAPIError extends Error {
-}
+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.js

@@ -1,33 +1,81 @@
 "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 __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Flagsmith = void 0;
-const flagsmith_engine_1 = require("../flagsmith-engine");
-const util_1 = require("../flagsmith-engine/environments/util");
-const models_1 = require("../flagsmith-engine/identities/models");
-const models_2 = require("../flagsmith-engine/identities/traits/models");
-const analytics_1 = require("./analytics");
-const errors_1 = require("./errors");
-const models_3 = require("./models");
-const polling_manager_1 = require("./polling_manager");
-const utils_1 = require("./utils");
-const evaluators_1 = require("../flagsmith-engine/segments/evaluators");
-const DEFAULT_API_URL = 'https://api.flagsmith.com/api/v1/';
-class Flagsmith {
-    environmentKey;
-    apiUrl = DEFAULT_API_URL;
-    customHeaders;
-    requestTimeoutSeconds;
-    enableLocalEvaluation = false;
-    environmentRefreshIntervalSeconds = 60;
-    retries;
-    enableAnalytics = false;
-    defaultFlagHandler;
-    environmentFlagsUrl;
-    identitiesUrl;
-    environmentUrl;
-    environmentDataPollingManager;
-    environment;
-    analyticsProcessor;
+var flagsmith_engine_1 = require("../flagsmith-engine");
+var util_1 = require("../flagsmith-engine/environments/util");
+var models_1 = require("../flagsmith-engine/identities/models");
+var models_2 = require("../flagsmith-engine/identities/traits/models");
+var analytics_1 = require("./analytics");
+var errors_1 = require("./errors");
+var models_3 = require("./models");
+var polling_manager_1 = require("./polling_manager");
+var utils_1 = require("./utils");
+var evaluators_1 = require("../flagsmith-engine/segments/evaluators");
+var DEFAULT_API_URL = 'https://api.flagsmith.com/api/v1/';
+var Flagsmith = /** @class */ (function () {
     /**
      * A Flagsmith client.
      *
@@ -58,7 +106,11 @@ class Flagsmith {
             flags cannot be retrieved from the API or a non existent feature is
             requested
      */
-    constructor(data) {
+    function Flagsmith(data) {
+        this.apiUrl = DEFAULT_API_URL;
+        this.enableLocalEvaluation = false;
+        this.environmentRefreshIntervalSeconds = 60;
+        this.enableAnalytics = false;
         this.environmentKey = data.environmentKey;
         this.apiUrl = data.apiUrl || this.apiUrl;
         this.customHeaders = data.customHeaders;
@@ -69,9 +121,9 @@ class Flagsmith {
         this.retries = data.retries;
         this.enableAnalytics = data.enableAnalytics || false;
         this.defaultFlagHandler = data.defaultFlagHandler;
-        this.environmentFlagsUrl = `${this.apiUrl}flags/`;
-        this.identitiesUrl = `${this.apiUrl}identities/`;
-        this.environmentUrl = `${this.apiUrl}environment-document/`;
+        this.environmentFlagsUrl = "".concat(this.apiUrl, "flags/");
+        this.identitiesUrl = "".concat(this.apiUrl, "identities/");
+        this.environmentUrl = "".concat(this.apiUrl, "environment-document/");
         if (this.enableLocalEvaluation) {
             if (!this.environmentKey.startsWith('ser.')) {
                 console.error('In order to use local evaluation, please generate a server key in the environment settings page.');
@@ -93,12 +145,17 @@ class Flagsmith {
      *
      * @returns Flags object holding all the flags for the current environment.
      */
-    async getEnvironmentFlags() {
-        if (this.environment) {
-            return new Promise(resolve => resolve(this.getEnvironmentFlagsFromDocument()));
-        }
-        return this.getEnvironmentFlagsFromApi();
-    }
+    Flagsmith.prototype.getEnvironmentFlags = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                if (this.environment) {
+                    return [2 /*return*/, new Promise(function (resolve) { return resolve(_this.getEnvironmentFlagsFromDocument()); })];
+                }
+                return [2 /*return*/, this.getEnvironmentFlagsFromApi()];
+            });
+        });
+    };
     /**
      * 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
@@ -110,15 +167,18 @@ class Flagsmith {
             Flagsmith, e.g. {"num_orders": 10}
      * @returns Flags object holding all the flags for the given identity.
      */
-    getIdentityFlags(identifier, traits) {
+    Flagsmith.prototype.getIdentityFlags = function (identifier, traits) {
+        var _this = this;
         traits = traits || {};
         if (this.enableLocalEvaluation) {
-            return new Promise(resolve => this.environmentPromise.then(() => {
-                resolve(this.getIdentityFlagsFromDocument(identifier, traits || {}));
-            }));
+            return new Promise(function (resolve) {
+                return _this.environmentPromise.then(function () {
+                    resolve(_this.getIdentityFlagsFromDocument(identifier, traits || {}));
+                });
+            });
         }
         return this.getIdentityFlagsFromApi(identifier, traits);
-    }
+    };
     /**
      * 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
@@ -130,134 +190,197 @@ class Flagsmith {
             Flagsmith, e.g. {"num_orders": 10}
      * @returns Segments that the given identity belongs to.
      */
-    getIdentitySegments(identifier, traits) {
+    Flagsmith.prototype.getIdentitySegments = function (identifier, traits) {
+        var _this = this;
         traits = traits || {};
         if (this.enableLocalEvaluation) {
-            return this.environmentPromise.then(() => {
-                return new Promise(resolve => {
-                    const identityModel = this.buildIdentityModel(identifier, Object.keys(traits || {}).map(key => ({
-                        key,
-                        value: traits?.[key]
-                    })));
-                    const segments = (0, evaluators_1.getIdentitySegments)(this.environment, identityModel);
+            return this.environmentPromise.then(function () {
+                return new Promise(function (resolve) {
+                    var identityModel = _this.buildIdentityModel(identifier, Object.keys(traits || {}).map(function (key) { return ({
+                        key: key,
+                        value: traits === null || traits === void 0 ? void 0 : traits[key]
+                    }); }));
+                    var segments = (0, evaluators_1.getIdentitySegments)(_this.environment, identityModel);
                     return resolve(segments);
                 });
             });
         }
         console.error('This function is only permitted with local evaluation.');
         return Promise.resolve([]);
-    }
+    };
     /**
      * 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.
      */
-    async updateEnvironment() {
-        const request = this.getEnvironmentFromApi();
-        if (!this.environmentPromise) {
-            this.environmentPromise = request.then(res => {
-                this.environment = res;
+    Flagsmith.prototype.updateEnvironment = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var request, _a;
+            var _this = this;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        request = this.getEnvironmentFromApi();
+                        if (!!this.environmentPromise) return [3 /*break*/, 2];
+                        this.environmentPromise = request.then(function (res) {
+                            _this.environment = res;
+                        });
+                        return [4 /*yield*/, this.environmentPromise];
+                    case 1:
+                        _b.sent();
+                        return [3 /*break*/, 4];
+                    case 2:
+                        _a = this;
+                        return [4 /*yield*/, request];
+                    case 3:
+                        _a.environment = _b.sent();
+                        _b.label = 4;
+                    case 4: return [2 /*return*/];
+                }
             });
-            await this.environmentPromise;
-        }
-        else {
-            this.environment = await request;
-        }
-    }
-    async getJSONResponse(url, method, body) {
-        const headers = { 'Content-Type': 'application/json' };
-        if (this.environmentKey) {
-            headers['X-Environment-Key'] = this.environmentKey;
-        }
-        if (this.customHeaders) {
-            for (const [k, v] of Object.entries(this.customHeaders)) {
-                headers[k] = v;
-            }
-        }
-        const data = await (0, utils_1.retryFetch)(url, {
-            method: method,
-            timeout: this.requestTimeoutSeconds || undefined,
-            body: JSON.stringify(body),
-            headers: headers
-        }, this.retries, 1000, (this.requestTimeoutSeconds || 10) * 1000);
-        if (data.status !== 200) {
-            throw new errors_1.FlagsmithAPIError(`Invalid request made to Flagsmith API. Response status code: ${data.status}`);
-        }
-        return data.json();
-    }
-    /**
-     * This promise ensures that the environment is retrieved before attempting to locally evaluate.
-     */
-    environmentPromise;
-    async getEnvironmentFromApi() {
-        const environment_data = await this.getJSONResponse(this.environmentUrl, 'GET');
-        return (0, util_1.buildEnvironmentModel)(environment_data);
-    }
-    getEnvironmentFlagsFromDocument() {
+        });
+    };
+    Flagsmith.prototype.getJSONResponse = function (url, method, body) {
+        return __awaiter(this, void 0, void 0, function () {
+            var headers, _a, _b, _c, k, v, data;
+            var e_1, _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        headers = { 'Content-Type': 'application/json' };
+                        if (this.environmentKey) {
+                            headers['X-Environment-Key'] = this.environmentKey;
+                        }
+                        if (this.customHeaders) {
+                            try {
+                                for (_a = __values(Object.entries(this.customHeaders)), _b = _a.next(); !_b.done; _b = _a.next()) {
+                                    _c = __read(_b.value, 2), k = _c[0], v = _c[1];
+                                    headers[k] = v;
+                                }
+                            }
+                            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                            finally {
+                                try {
+                                    if (_b && !_b.done && (_d = _a.return)) _d.call(_a);
+                                }
+                                finally { if (e_1) throw e_1.error; }
+                            }
+                        }
+                        return [4 /*yield*/, (0, utils_1.retryFetch)(url, {
+                                method: method,
+                                timeout: this.requestTimeoutSeconds || undefined,
+                                body: JSON.stringify(body),
+                                headers: headers
+                            }, this.retries, 1000, (this.requestTimeoutSeconds || 10) * 1000)];
+                    case 1:
+                        data = _e.sent();
+                        if (data.status !== 200) {
+                            throw new errors_1.FlagsmithAPIError("Invalid request made to Flagsmith API. Response status code: ".concat(data.status));
+                        }
+                        return [2 /*return*/, data.json()];
+                }
+            });
+        });
+    };
+    Flagsmith.prototype.getEnvironmentFromApi = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var environment_data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getJSONResponse(this.environmentUrl, 'GET')];
+                    case 1:
+                        environment_data = _a.sent();
+                        return [2 /*return*/, (0, util_1.buildEnvironmentModel)(environment_data)];
+                }
+            });
+        });
+    };
+    Flagsmith.prototype.getEnvironmentFlagsFromDocument = function () {
         return models_3.Flags.fromFeatureStateModels({
             featureStates: (0, flagsmith_engine_1.getEnvironmentFeatureStates)(this.environment),
             analyticsProcessor: this.analyticsProcessor,
             defaultFlagHandler: this.defaultFlagHandler
         });
-    }
-    getIdentityFlagsFromDocument(identifier, traits) {
-        const identityModel = this.buildIdentityModel(identifier, Object.keys(traits).map(key => ({
-            key,
+    };
+    Flagsmith.prototype.getIdentityFlagsFromDocument = function (identifier, traits) {
+        var identityModel = this.buildIdentityModel(identifier, Object.keys(traits).map(function (key) { return ({
+            key: key,
             value: traits[key]
-        })));
-        const featureStates = (0, flagsmith_engine_1.getIdentityFeatureStates)(this.environment, identityModel);
+        }); }));
+        var featureStates = (0, flagsmith_engine_1.getIdentityFeatureStates)(this.environment, identityModel);
         return models_3.Flags.fromFeatureStateModels({
             featureStates: featureStates,
             analyticsProcessor: this.analyticsProcessor,
             defaultFlagHandler: this.defaultFlagHandler
         });
-    }
-    async getEnvironmentFlagsFromApi() {
-        try {
-            const apiFlags = await this.getJSONResponse(this.environmentFlagsUrl, 'GET');
-            return models_3.Flags.fromAPIFlags({
-                apiFlags: apiFlags,
-                analyticsProcessor: this.analyticsProcessor,
-                defaultFlagHandler: this.defaultFlagHandler
+    };
+    Flagsmith.prototype.getEnvironmentFlagsFromApi = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiFlags, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.getJSONResponse(this.environmentFlagsUrl, 'GET')];
+                    case 1:
+                        apiFlags = _a.sent();
+                        return [2 /*return*/, models_3.Flags.fromAPIFlags({
+                                apiFlags: apiFlags,
+                                analyticsProcessor: this.analyticsProcessor,
+                                defaultFlagHandler: this.defaultFlagHandler
+                            })];
+                    case 2:
+                        e_2 = _a.sent();
+                        if (this.defaultFlagHandler) {
+                            return [2 /*return*/, new models_3.Flags({
+                                    flags: {},
+                                    defaultFlagHandler: this.defaultFlagHandler
+                                })];
+                        }
+                        throw e_2;
+                    case 3: return [2 /*return*/];
+                }
             });
-        }
-        catch (e) {
-            if (this.defaultFlagHandler) {
-                return new models_3.Flags({
-                    flags: {},
-                    defaultFlagHandler: this.defaultFlagHandler
-                });
-            }
-            throw e;
-        }
-    }
-    async getIdentityFlagsFromApi(identifier, traits) {
-        try {
-            const data = (0, utils_1.generateIdentitiesData)(identifier, traits);
-            const jsonResponse = await this.getJSONResponse(this.identitiesUrl, 'POST', data);
-            return models_3.Flags.fromAPIFlags({
-                apiFlags: jsonResponse['flags'],
-                analyticsProcessor: this.analyticsProcessor,
-                defaultFlagHandler: this.defaultFlagHandler
+        });
+    };
+    Flagsmith.prototype.getIdentityFlagsFromApi = function (identifier, traits) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data, jsonResponse, e_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        data = (0, utils_1.generateIdentitiesData)(identifier, traits);
+                        return [4 /*yield*/, this.getJSONResponse(this.identitiesUrl, 'POST', data)];
+                    case 1:
+                        jsonResponse = _a.sent();
+                        return [2 /*return*/, models_3.Flags.fromAPIFlags({
+                                apiFlags: jsonResponse['flags'],
+                                analyticsProcessor: this.analyticsProcessor,
+                                defaultFlagHandler: this.defaultFlagHandler
+                            })];
+                    case 2:
+                        e_3 = _a.sent();
+                        if (this.defaultFlagHandler) {
+                            return [2 /*return*/, new models_3.Flags({
+                                    flags: {},
+                                    defaultFlagHandler: this.defaultFlagHandler
+                                })];
+                        }
+                        throw e_3;
+                    case 3: return [2 /*return*/];
+                }
             });
-        }
-        catch (e) {
-            if (this.defaultFlagHandler) {
-                return new models_3.Flags({
-                    flags: {},
-                    defaultFlagHandler: this.defaultFlagHandler
-                });
-            }
-            throw e;
-        }
-    }
-    buildIdentityModel(identifier, traits) {
+        });
+    };
+    Flagsmith.prototype.buildIdentityModel = function (identifier, traits) {
         if (!this.environment) {
             throw new errors_1.FlagsmithClientError('Unable to build identity model when no local environment present.');
         }
-        const traitModels = traits.map(trait => new models_2.TraitModel(trait.key, trait.value));
+        var traitModels = traits.map(function (trait) { return new models_2.TraitModel(trait.key, trait.value); });
         return new models_1.IdentityModel('0', traitModels, [], this.environment.apiKey, identifier);
-    }
-}
+    };
+    return Flagsmith;
+}());
 exports.Flagsmith = Flagsmith;
 exports.default = Flagsmith;