flagsmith-nodejs 3.1.1 → 3.3.0

package/.husky/pre-commit

@@ -2,5 +2,5 @@
 . "$(dirname "$0")/_/husky.sh"
 
 npm run lint
-git add ./flagsmith-engine ./sdk ./tests ./example ./index.ts ./.github
+git add ./flagsmith-engine ./sdk ./tests ./index.ts ./.github
 npm run test

package/README.md

@@ -22,7 +22,8 @@ If you encounter a bug or feature request we would like to hear about it. Before
 ## Testing
 
 To run the local tests you need to run following command beforehand:
-```
+
+```bash
 git submodule add git@github.com:Flagsmith/engine-test-data.git tests/engine/engine-tests/engine-test-data/
 ```
 

package/build/flagsmith-engine/environments/models.d.ts

@@ -1,6 +1,6 @@
 import { FeatureStateModel } from '../features/models';
+import { IdentityModel } from '../identities/models';
 import { ProjectModel } from '../projects/models';
-import { IntegrationModel } from './integrations/models';
 export declare class EnvironmentAPIKeyModel {
     id: number;
     key: string;
@@ -17,9 +17,6 @@ export declare class EnvironmentModel {
     apiKey: string;
     project: ProjectModel;
     featureStates: FeatureStateModel[];
-    amplitude_config?: IntegrationModel;
-    segment_config?: IntegrationModel;
-    mixpanel_config?: IntegrationModel;
-    heap_config?: IntegrationModel;
+    identityOverrides: IdentityModel[];
     constructor(id: number, apiKey: string, project: ProjectModel);
 }

package/build/flagsmith-engine/environments/models.js

@@ -20,6 +20,7 @@ exports.EnvironmentAPIKeyModel = EnvironmentAPIKeyModel;
 var EnvironmentModel = /** @class */ (function () {
     function EnvironmentModel(id, apiKey, project) {
         this.featureStates = [];
+        this.identityOverrides = [];
         this.id = id;
         this.apiKey = apiKey;
         this.project = project;

package/build/flagsmith-engine/environments/util.js

@@ -2,15 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildEnvironmentAPIKeyModel = exports.buildEnvironmentModel = void 0;
 var util_1 = require("../features/util");
-var util_2 = require("../projects/util");
+var util_2 = require("../identities/util");
+var util_3 = require("../projects/util");
 var models_1 = require("./models");
 function buildEnvironmentModel(environmentJSON) {
-    var project = (0, util_2.buildProjectModel)(environmentJSON.project);
+    var project = (0, util_3.buildProjectModel)(environmentJSON.project);
     var featureStates = environmentJSON.feature_states.map(function (fs) {
         return (0, util_1.buildFeatureStateModel)(fs);
     });
     var environmentModel = new models_1.EnvironmentModel(environmentJSON.id, environmentJSON.api_key, project);
     environmentModel.featureStates = featureStates;
+    if (!!environmentJSON.identity_overrides) {
+        environmentModel.identityOverrides = environmentJSON.identity_overrides.map(function (identityData) {
+            return (0, util_2.buildIdentityModel)(identityData);
+        });
+    }
     return environmentModel;
 }
 exports.buildEnvironmentModel = buildEnvironmentModel;

package/build/flagsmith-engine/features/util.js

@@ -7,14 +7,14 @@ function buildFeatureModel(featuresModelJSON) {
 }
 exports.buildFeatureModel = buildFeatureModel;
 function buildFeatureStateModel(featuresStateModelJSON) {
-    var featureStateModel = new models_1.FeatureStateModel(buildFeatureModel(featuresStateModelJSON.feature), featuresStateModelJSON.enabled, featuresStateModelJSON.django_id, featuresStateModelJSON.feature_state_value, featuresStateModelJSON.uuid);
+    var featureStateModel = new models_1.FeatureStateModel(buildFeatureModel(featuresStateModelJSON.feature), featuresStateModelJSON.enabled, featuresStateModelJSON.django_id, featuresStateModelJSON.feature_state_value, featuresStateModelJSON.featurestate_uuid);
     featureStateModel.featureSegment = featuresStateModelJSON.feature_segment ?
         buildFeatureSegment(featuresStateModelJSON.feature_segment) :
         undefined;
     var multivariateFeatureStateValues = featuresStateModelJSON.multivariate_feature_state_values
         ? featuresStateModelJSON.multivariate_feature_state_values.map(function (fsv) {
             var featureOption = new models_1.MultivariateFeatureOptionModel(fsv.multivariate_feature_option.value, fsv.multivariate_feature_option.id);
-            return new models_1.MultivariateFeatureStateValueModel(featureOption, fsv.percentage_allocation, fsv.id);
+            return new models_1.MultivariateFeatureStateValueModel(featureOption, fsv.percentage_allocation, fsv.id, fsv.mv_fs_value_uuid);
         })
         : [];
     featureStateModel.multivariateFeatureStateValues = multivariateFeatureStateValues;

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

@@ -3,7 +3,6 @@ import { FeatureStateModel } from './features/models';
 import { IdentityModel } from './identities/models';
 import { TraitModel } from './identities/traits/models';
 export { EnvironmentModel } from './environments/models';
-export { IntegrationModel } from './environments/integrations/models';
 export { FeatureStateModel } from './features/models';
 export { IdentityModel } from './identities/models';
 export { TraitModel } from './identities/traits/models';

package/build/flagsmith-engine/index.js

@@ -11,23 +11,21 @@ var __values = (this && this.__values) || function(o) {
     throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnvironmentFeatureStates = exports.getEnvironmentFeatureState = exports.getIdentityFeatureStates = exports.getIdentityFeatureState = exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.IntegrationModel = exports.EnvironmentModel = void 0;
+exports.getEnvironmentFeatureStates = exports.getEnvironmentFeatureState = exports.getIdentityFeatureStates = exports.getIdentityFeatureState = exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.EnvironmentModel = void 0;
 var evaluators_1 = require("./segments/evaluators");
 var errors_1 = require("./utils/errors");
 var models_1 = require("./environments/models");
 Object.defineProperty(exports, "EnvironmentModel", { enumerable: true, get: function () { return models_1.EnvironmentModel; } });
-var models_2 = require("./environments/integrations/models");
-Object.defineProperty(exports, "IntegrationModel", { enumerable: true, get: function () { return models_2.IntegrationModel; } });
-var models_3 = require("./features/models");
-Object.defineProperty(exports, "FeatureStateModel", { enumerable: true, get: function () { return models_3.FeatureStateModel; } });
-var models_4 = require("./identities/models");
-Object.defineProperty(exports, "IdentityModel", { enumerable: true, get: function () { return models_4.IdentityModel; } });
-var models_5 = require("./identities/traits/models");
-Object.defineProperty(exports, "TraitModel", { enumerable: true, get: function () { return models_5.TraitModel; } });
-var models_6 = require("./segments/models");
-Object.defineProperty(exports, "SegmentModel", { enumerable: true, get: function () { return models_6.SegmentModel; } });
-var models_7 = require("./organisations/models");
-Object.defineProperty(exports, "OrganisationModel", { enumerable: true, get: function () { return models_7.OrganisationModel; } });
+var models_2 = require("./features/models");
+Object.defineProperty(exports, "FeatureStateModel", { enumerable: true, get: function () { return models_2.FeatureStateModel; } });
+var models_3 = require("./identities/models");
+Object.defineProperty(exports, "IdentityModel", { enumerable: true, get: function () { return models_3.IdentityModel; } });
+var models_4 = require("./identities/traits/models");
+Object.defineProperty(exports, "TraitModel", { enumerable: true, get: function () { return models_4.TraitModel; } });
+var models_5 = require("./segments/models");
+Object.defineProperty(exports, "SegmentModel", { enumerable: true, get: function () { return models_5.SegmentModel; } });
+var models_6 = require("./organisations/models");
+Object.defineProperty(exports, "OrganisationModel", { enumerable: true, get: function () { return models_6.OrganisationModel; } });
 function getIdentityFeatureStatesDict(environment, identity, overrideTraits) {
     var e_1, _a, e_2, _b, e_3, _c, e_4, _d;
     // Get feature states from the environment

package/build/index.d.ts

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

package/build/index.js

@@ -3,7 +3,7 @@ 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;
+exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = 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; } });
@@ -15,7 +15,6 @@ Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { r
 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; } });

package/build/sdk/index.d.ts

@@ -1,5 +1,7 @@
-import { RequestInit } from "node-fetch";
+import { RequestInit } from 'node-fetch';
 import { EnvironmentModel } from '../flagsmith-engine/environments/models';
+import { IdentityModel } from '../flagsmith-engine/identities/models';
+import { BaseOfflineHandler } from './offline_handlers';
 import { DefaultFlag, Flags } from './models';
 import { EnvironmentDataPollingManager } from './polling_manager';
 import { SegmentModel } from '../flagsmith-engine/segments/models';
@@ -11,7 +13,7 @@ export { EnvironmentDataPollingManager } from './polling_manager';
 export { FlagsmithCache, FlagsmithConfig } from './types';
 export declare class Flagsmith {
     environmentKey?: string;
-    apiUrl: string;
+    apiUrl?: string;
     customHeaders?: {
         [key: string]: any;
     };
@@ -22,11 +24,14 @@ export declare class Flagsmith {
     retries?: number;
     enableAnalytics: boolean;
     defaultFlagHandler?: (featureName: string) => DefaultFlag;
-    environmentFlagsUrl: string;
-    identitiesUrl: string;
-    environmentUrl: string;
+    environmentFlagsUrl?: string;
+    identitiesUrl?: string;
+    environmentUrl?: string;
     environmentDataPollingManager?: EnvironmentDataPollingManager;
     environment: EnvironmentModel;
+    offlineMode: boolean;
+    offlineHandler?: BaseOfflineHandler;
+    identitiesWithOverridesByIdentifier?: Map<string, IdentityModel>;
     private cache?;
     private onEnvironmentChange?;
     private analyticsProcessor?;
@@ -45,6 +50,7 @@ export declare class Flagsmith {
      * const featureEnabledForIdentity = identityFlags.isFeatureEnabled("foo")
      *
      *  @param {string} data.environmentKey: The environment key obtained from Flagsmith interface
+     *      Required unless offlineMode is True.
         @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
@@ -58,11 +64,16 @@ export declare class Flagsmith {
         @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
+            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);
+        @param {boolean} data.offlineMode: sets the client into offline mode. Relies on offlineHandler for
+            evaluating flags.
+        @param {BaseOfflineHandler} data.offlineHandler: provide a handler for offline logic. Used to get environment
+            document from another source when in offlineMode. Works in place of
+            defaultFlagHandler if offlineMode is not set and using remote evaluation.
+    */
+    constructor(data?: FlagsmithConfig);
     /**
      * Get all the default for flags for the current environment.
      *
@@ -114,6 +125,6 @@ export declare class Flagsmith {
     private getIdentityFlagsFromDocument;
     private getEnvironmentFlagsFromApi;
     private getIdentityFlagsFromApi;
-    private buildIdentityModel;
+    private getIdentityModel;
 }
 export default Flagsmith;

package/build/sdk/index.js

@@ -105,6 +105,7 @@ var Flagsmith = /** @class */ (function () {
      * const featureEnabledForIdentity = identityFlags.isFeatureEnabled("foo")
      *
      *  @param {string} data.environmentKey: The environment key obtained from Flagsmith interface
+     *      Required unless offlineMode is True.
         @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
@@ -118,32 +119,54 @@ var Flagsmith = /** @class */ (function () {
         @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
+            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
-     */
+        @param {boolean} data.offlineMode: sets the client into offline mode. Relies on offlineHandler for
+            evaluating flags.
+        @param {BaseOfflineHandler} data.offlineHandler: provide a handler for offline logic. Used to get environment
+            document from another source when in offlineMode. Works in place of
+            defaultFlagHandler if offlineMode is not set and using remote evaluation.
+    */
     function Flagsmith(data) {
+        // if (!data.offlineMode && !data.environmentKey) {
+        //     throw new Error('ValueError: environmentKey is required.');
+        // }
+        if (data === void 0) { data = {}; }
         var _a;
-        this.apiUrl = DEFAULT_API_URL;
+        this.environmentKey = undefined;
+        this.apiUrl = undefined;
         this.enableLocalEvaluation = false;
         this.environmentRefreshIntervalSeconds = 60;
         this.enableAnalytics = false;
+        this.offlineMode = false;
+        this.offlineHandler = undefined;
         this.agent = data.agent;
         this.environmentKey = data.environmentKey;
         this.apiUrl = data.apiUrl || this.apiUrl;
         this.customHeaders = data.customHeaders;
-        this.requestTimeoutMs = 1000 * ((_a = data.requestTimeoutSeconds) !== null && _a !== void 0 ? _a : DEFAULT_REQUEST_TIMEOUT_SECONDS);
+        this.requestTimeoutMs =
+            1000 * ((_a = data.requestTimeoutSeconds) !== null && _a !== void 0 ? _a : DEFAULT_REQUEST_TIMEOUT_SECONDS);
         this.enableLocalEvaluation = data.enableLocalEvaluation;
         this.environmentRefreshIntervalSeconds =
             data.environmentRefreshIntervalSeconds || this.environmentRefreshIntervalSeconds;
         this.retries = data.retries;
         this.enableAnalytics = data.enableAnalytics || false;
         this.defaultFlagHandler = data.defaultFlagHandler;
-        this.environmentFlagsUrl = "".concat(this.apiUrl, "flags/");
-        this.identitiesUrl = "".concat(this.apiUrl, "identities/");
-        this.environmentUrl = "".concat(this.apiUrl, "environment-document/");
         this.onEnvironmentChange = data.onEnvironmentChange;
         this.logger = data.logger || (0, pino_1.default)();
+        this.offlineMode = data.offlineMode || false;
+        this.offlineHandler = data.offlineHandler;
+        // argument validation
+        if (this.offlineMode && !this.offlineHandler) {
+            throw new Error('ValueError: offlineHandler must be provided to use offline mode.');
+        }
+        else if (this.defaultFlagHandler && this.offlineHandler) {
+            throw new Error('ValueError: Cannot use both defaultFlagHandler and offlineHandler.');
+        }
+        if (this.offlineHandler) {
+            this.environment = this.offlineHandler.getEnvironment();
+        }
         if (!!data.cache) {
             var missingMethods = ['has', 'get', 'set'].filter(function (method) { return data.cache && !data.cache[method]; });
             if (missingMethods.length > 0) {
@@ -151,22 +174,32 @@ var Flagsmith = /** @class */ (function () {
             }
             this.cache = data.cache;
         }
-        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.');
+        if (!this.offlineMode) {
+            if (!this.environmentKey) {
+                throw new Error('ValueError: environmentKey is required.');
             }
-            this.environmentDataPollingManager = new polling_manager_1.EnvironmentDataPollingManager(this, this.environmentRefreshIntervalSeconds);
-            this.environmentDataPollingManager.start();
-            this.updateEnvironment();
+            var apiUrl = data.apiUrl || DEFAULT_API_URL;
+            this.apiUrl = apiUrl.endsWith('/') ? apiUrl : "".concat(apiUrl, "/");
+            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.');
+                }
+                this.environmentDataPollingManager = new polling_manager_1.EnvironmentDataPollingManager(this, this.environmentRefreshIntervalSeconds);
+                this.environmentDataPollingManager.start();
+                this.updateEnvironment();
+            }
+            this.analyticsProcessor = data.enableAnalytics
+                ? new analytics_1.AnalyticsProcessor({
+                    environmentKey: this.environmentKey,
+                    baseApiUrl: this.apiUrl,
+                    requestTimeoutMs: this.requestTimeoutMs,
+                    logger: this.logger
+                })
+                : undefined;
         }
-        this.analyticsProcessor = data.enableAnalytics
-            ? new analytics_1.AnalyticsProcessor({
-                environmentKey: this.environmentKey,
-                baseApiUrl: this.apiUrl,
-                requestTimeoutMs: this.requestTimeoutMs,
-                logger: this.logger
-            })
-            : undefined;
     }
     /**
      * Get all the default for flags for the current environment.
@@ -191,7 +224,7 @@ var Flagsmith = /** @class */ (function () {
                         if (!!cachedItem) {
                             return [2 /*return*/, cachedItem];
                         }
-                        if (this.enableLocalEvaluation) {
+                        if (this.enableLocalEvaluation && !this.offlineMode) {
                             return [2 /*return*/, new Promise(function (resolve, reject) {
                                     return _this.environmentPromise.then(function () {
                                         resolve(_this.getEnvironmentFlagsFromDocument());
@@ -225,7 +258,7 @@ var Flagsmith = /** @class */ (function () {
                 switch (_b.label) {
                     case 0:
                         if (!identifier) {
-                            throw new Error("`identifier` argument is missing or invalid.");
+                            throw new Error('`identifier` argument is missing or invalid.');
                         }
                         _a = !!this.cache;
                         if (!_a) return [3 /*break*/, 2];
@@ -246,6 +279,9 @@ var Flagsmith = /** @class */ (function () {
                                     }).catch(function (e) { return reject(e); });
                                 })];
                         }
+                        if (this.offlineMode) {
+                            return [2 /*return*/, this.getIdentityFlagsFromDocument(identifier, traits || {})];
+                        }
                         return [2 /*return*/, this.getIdentityFlagsFromApi(identifier, traits)];
                 }
             });
@@ -265,13 +301,13 @@ var Flagsmith = /** @class */ (function () {
     Flagsmith.prototype.getIdentitySegments = function (identifier, traits) {
         var _this = this;
         if (!identifier) {
-            throw new Error("`identifier` argument is missing or invalid.");
+            throw new Error('`identifier` argument is missing or invalid.');
         }
         traits = traits || {};
         if (this.enableLocalEvaluation) {
             return new Promise(function (resolve, reject) {
                 return _this.environmentPromise.then(function () {
-                    var identityModel = _this.buildIdentityModel(identifier, Object.keys(traits || {}).map(function (key) { return ({
+                    var identityModel = _this.getIdentityModel(identifier, Object.keys(traits || {}).map(function (key) { return ({
                         key: key,
                         value: traits === null || traits === void 0 ? void 0 : traits[key]
                     }); }));
@@ -289,13 +325,14 @@ var Flagsmith = /** @class */ (function () {
      * You only need to call this if you wish to bypass environmentRefreshIntervalSeconds.
      */
     Flagsmith.prototype.updateEnvironment = function () {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var request, _a, e_1;
+            var request, _b, e_1;
             var _this = this;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
-                        _b.trys.push([0, 5, , 6]);
+                        _c.trys.push([0, 5, , 6]);
                         request = this.getEnvironmentFromApi();
                         if (!!this.environmentPromise) return [3 /*break*/, 2];
                         this.environmentPromise = request.then(function (res) {
@@ -303,21 +340,24 @@ var Flagsmith = /** @class */ (function () {
                         });
                         return [4 /*yield*/, this.environmentPromise];
                     case 1:
-                        _b.sent();
+                        _c.sent();
                         return [3 /*break*/, 4];
                     case 2:
-                        _a = this;
+                        _b = this;
                         return [4 /*yield*/, request];
                     case 3:
-                        _a.environment = _b.sent();
-                        _b.label = 4;
+                        _b.environment = _c.sent();
+                        _c.label = 4;
                     case 4:
+                        if ((_a = this.environment.identityOverrides) === null || _a === void 0 ? void 0 : _a.length) {
+                            this.identitiesWithOverridesByIdentifier = new Map(this.environment.identityOverrides.map(function (identity) { return [identity.identifier, identity]; }));
+                        }
                         if (this.onEnvironmentChange) {
                             this.onEnvironmentChange(null, this.environment);
                         }
                         return [3 /*break*/, 6];
                     case 5:
-                        e_1 = _b.sent();
+                        e_1 = _c.sent();
                         if (this.onEnvironmentChange) {
                             this.onEnvironmentChange(e_1, this.environment);
                         }
@@ -383,7 +423,11 @@ var Flagsmith = /** @class */ (function () {
             var environment_data;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getJSONResponse(this.environmentUrl, 'GET')];
+                    case 0:
+                        if (!this.environmentUrl) {
+                            throw new Error('`apiUrl` argument is missing or invalid.');
+                        }
+                        return [4 /*yield*/, this.getJSONResponse(this.environmentUrl, 'GET')];
                     case 1:
                         environment_data = _a.sent();
                         return [2 /*return*/, (0, util_1.buildEnvironmentModel)(environment_data)];
@@ -420,7 +464,7 @@ var Flagsmith = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        identityModel = this.buildIdentityModel(identifier, Object.keys(traits).map(function (key) { return ({
+                        identityModel = this.getIdentityModel(identifier, Object.keys(traits).map(function (key) { return ({
                             key: key,
                             value: traits[key]
                         }); }));
@@ -449,25 +493,33 @@ var Flagsmith = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 4, , 5]);
-                        return [4 /*yield*/, this.getJSONResponse(this.environmentFlagsUrl, 'GET')];
+                        if (!this.environmentFlagsUrl) {
+                            throw new Error('`apiUrl` argument is missing or invalid.');
+                        }
+                        _a.label = 1;
                     case 1:
+                        _a.trys.push([1, 5, , 6]);
+                        return [4 /*yield*/, this.getJSONResponse(this.environmentFlagsUrl, 'GET')];
+                    case 2:
                         apiFlags = _a.sent();
                         flags = models_3.Flags.fromAPIFlags({
                             apiFlags: apiFlags,
                             analyticsProcessor: this.analyticsProcessor,
                             defaultFlagHandler: this.defaultFlagHandler
                         });
-                        if (!!!this.cache) return [3 /*break*/, 3];
+                        if (!!!this.cache) return [3 /*break*/, 4];
                         // @ts-ignore node-cache types are incorrect, ttl should be optional
                         return [4 /*yield*/, this.cache.set('flags', flags)];
-                    case 2:
+                    case 3:
                         // @ts-ignore node-cache types are incorrect, ttl should be optional
                         _a.sent();
-                        _a.label = 3;
-                    case 3: return [2 /*return*/, flags];
-                    case 4:
+                        _a.label = 4;
+                    case 4: return [2 /*return*/, flags];
+                    case 5:
                         e_3 = _a.sent();
+                        if (this.offlineHandler) {
+                            return [2 /*return*/, this.getEnvironmentFlagsFromDocument()];
+                        }
                         if (this.defaultFlagHandler) {
                             return [2 /*return*/, new models_3.Flags({
                                     flags: {},
@@ -475,7 +527,7 @@ var Flagsmith = /** @class */ (function () {
                                 })];
                         }
                         throw e_3;
-                    case 5: return [2 /*return*/];
+                    case 6: return [2 /*return*/];
                 }
             });
         });
@@ -486,26 +538,34 @@ var Flagsmith = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 4, , 5]);
+                        if (!this.identitiesUrl) {
+                            throw new Error('`apiUrl` argument is missing or invalid.');
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 5, , 6]);
                         data = (0, utils_1.generateIdentitiesData)(identifier, traits);
                         return [4 /*yield*/, this.getJSONResponse(this.identitiesUrl, 'POST', data)];
-                    case 1:
+                    case 2:
                         jsonResponse = _a.sent();
                         flags = models_3.Flags.fromAPIFlags({
                             apiFlags: jsonResponse['flags'],
                             analyticsProcessor: this.analyticsProcessor,
                             defaultFlagHandler: this.defaultFlagHandler
                         });
-                        if (!!!this.cache) return [3 /*break*/, 3];
+                        if (!!!this.cache) return [3 /*break*/, 4];
                         // @ts-ignore node-cache types are incorrect, ttl should be optional
                         return [4 /*yield*/, this.cache.set("flags-".concat(identifier), flags)];
-                    case 2:
+                    case 3:
                         // @ts-ignore node-cache types are incorrect, ttl should be optional
                         _a.sent();
-                        _a.label = 3;
-                    case 3: return [2 /*return*/, flags];
-                    case 4:
+                        _a.label = 4;
+                    case 4: return [2 /*return*/, flags];
+                    case 5:
                         e_4 = _a.sent();
+                        if (this.offlineHandler) {
+                            return [2 /*return*/, this.getIdentityFlagsFromDocument(identifier, traits)];
+                        }
                         if (this.defaultFlagHandler) {
                             return [2 /*return*/, new models_3.Flags({
                                     flags: {},
@@ -513,13 +573,19 @@ var Flagsmith = /** @class */ (function () {
                                 })];
                         }
                         throw e_4;
-                    case 5: return [2 /*return*/];
+                    case 6: return [2 /*return*/];
                 }
             });
         });
     };
-    Flagsmith.prototype.buildIdentityModel = function (identifier, traits) {
+    Flagsmith.prototype.getIdentityModel = function (identifier, traits) {
+        var _a;
         var traitModels = traits.map(function (trait) { return new models_2.TraitModel(trait.key, trait.value); });
+        var identityWithOverrides = (_a = this.identitiesWithOverridesByIdentifier) === null || _a === void 0 ? void 0 : _a.get(identifier);
+        if (identityWithOverrides) {
+            identityWithOverrides.updateTraits(traitModels);
+            return identityWithOverrides;
+        }
         return new models_1.IdentityModel('0', traitModels, [], this.environment.apiKey, identifier);
     };
     return Flagsmith;

package/build/sdk/offline_handlers.d.ts

@@ -0,0 +1,9 @@
+import { EnvironmentModel } from '../flagsmith-engine/environments/models';
+export declare class BaseOfflineHandler {
+    getEnvironment(): EnvironmentModel;
+}
+export declare class LocalFileHandler extends BaseOfflineHandler {
+    environment: EnvironmentModel;
+    constructor(environment_document_path: string);
+    getEnvironment(): EnvironmentModel;
+}