flagsmith-nodejs 2.0.2 → 2.1.0

package/README.md

@@ -9,7 +9,7 @@ The SDK clients for NodeJS [https://www.flagsmith.com/](https://www.flagsmith.co
 
 ## Adding to your project
 
-For full documentation visit [https://docs.flagsmith.com/clients/node/](https://docs.flagsmith.com/clients/node/)
+For full documentation visit [https://docs.flagsmith.com/clients/server-side](https://docs.flagsmith.com/clients/server-side).
 
 ## Contributing
 

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

@@ -2,6 +2,13 @@ import { EnvironmentModel } from './environments/models';
 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';
+export { SegmentModel } from './segments/models';
+export { OrganisationModel } from './organisations/models';
 export declare function getIdentityFeatureState(environment: EnvironmentModel, identity: IdentityModel, featureName: string, overrideTraits?: TraitModel[]): FeatureStateModel;
 export declare function getIdentityFeatureStates(environment: EnvironmentModel, identity: IdentityModel, overrideTraits?: TraitModel[]): FeatureStateModel[];
 export declare function getEnvironmentFeatureState(environment: EnvironmentModel, featureName: string): FeatureStateModel;

package/build/flagsmith-engine/index.js

@@ -11,9 +11,23 @@ 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 = void 0;
+exports.getEnvironmentFeatureStates = exports.getEnvironmentFeatureState = exports.getIdentityFeatureStates = exports.getIdentityFeatureState = exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.IntegrationModel = 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; } });
 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 +1,2 @@
-export { Flagsmith } from './sdk';
+export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags } from './sdk';
+export { EnvironmentModel, IntegrationModel, FeatureStateModel, IdentityModel, TraitModel, SegmentModel, OrganisationModel } from './flagsmith-engine';

package/build/index.js

@@ -3,9 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Flagsmith = void 0;
+exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.IntegrationModel = exports.EnvironmentModel = 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, "Flagsmith", { enumerable: true, get: function () { return sdk_2.Flagsmith; } });
-// export default Flagsmith;
+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; } });
+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/index.d.ts

@@ -3,6 +3,11 @@ import { DefaultFlag, Flags } from './models';
 import { EnvironmentDataPollingManager } from './polling_manager';
 import { SegmentModel } from '../flagsmith-engine/segments/models';
 import { FlagsmithCache } from './types';
+export { AnalyticsProcessor } from './analytics';
+export { FlagsmithAPIError, FlagsmithClientError } from './errors';
+export { DefaultFlag, Flags } from './models';
+export { EnvironmentDataPollingManager } from './polling_manager';
+export { FlagsmithCache } from './types';
 export declare class Flagsmith {
     environmentKey?: string;
     apiUrl: string;

package/build/sdk/index.js

@@ -63,7 +63,7 @@ var __read = (this && this.__read) || function (o, n) {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Flagsmith = void 0;
+exports.Flagsmith = exports.EnvironmentDataPollingManager = exports.Flags = exports.DefaultFlag = exports.FlagsmithClientError = exports.FlagsmithAPIError = exports.AnalyticsProcessor = void 0;
 var flagsmith_engine_1 = require("../flagsmith-engine");
 var util_1 = require("../flagsmith-engine/environments/util");
 var models_1 = require("../flagsmith-engine/identities/models");
@@ -74,6 +74,16 @@ 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 analytics_2 = require("./analytics");
+Object.defineProperty(exports, "AnalyticsProcessor", { enumerable: true, get: function () { return analytics_2.AnalyticsProcessor; } });
+var errors_2 = require("./errors");
+Object.defineProperty(exports, "FlagsmithAPIError", { enumerable: true, get: function () { return errors_2.FlagsmithAPIError; } });
+Object.defineProperty(exports, "FlagsmithClientError", { enumerable: true, get: function () { return errors_2.FlagsmithClientError; } });
+var models_4 = require("./models");
+Object.defineProperty(exports, "DefaultFlag", { enumerable: true, get: function () { return models_4.DefaultFlag; } });
+Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return models_4.Flags; } });
+var polling_manager_2 = require("./polling_manager");
+Object.defineProperty(exports, "EnvironmentDataPollingManager", { enumerable: true, get: function () { return polling_manager_2.EnvironmentDataPollingManager; } });
 var DEFAULT_API_URL = 'https://edge.api.flagsmith.com/api/v1/';
 var Flagsmith = /** @class */ (function () {
     /**
@@ -368,8 +378,10 @@ var Flagsmith = /** @class */ (function () {
                             defaultFlagHandler: this.defaultFlagHandler
                         });
                         if (!!!this.cache) return [3 /*break*/, 2];
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         return [4 /*yield*/, this.cache.set('flags', flags)];
                     case 1:
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         _a.sent();
                         _a.label = 2;
                     case 2: return [2 /*return*/, flags];
@@ -394,8 +406,10 @@ var Flagsmith = /** @class */ (function () {
                             defaultFlagHandler: this.defaultFlagHandler
                         });
                         if (!!!this.cache) return [3 /*break*/, 2];
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         return [4 /*yield*/, this.cache.set("flags-".concat(identifier), flags)];
                     case 1:
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         _a.sent();
                         _a.label = 2;
                     case 2: return [2 /*return*/, flags];
@@ -419,8 +433,10 @@ var Flagsmith = /** @class */ (function () {
                             defaultFlagHandler: this.defaultFlagHandler
                         });
                         if (!!!this.cache) return [3 /*break*/, 3];
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         return [4 /*yield*/, this.cache.set('flags', flags)];
                     case 2:
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         _a.sent();
                         _a.label = 3;
                     case 3: return [2 /*return*/, flags];
@@ -455,8 +471,10 @@ var Flagsmith = /** @class */ (function () {
                             defaultFlagHandler: this.defaultFlagHandler
                         });
                         if (!!!this.cache) return [3 /*break*/, 3];
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         return [4 /*yield*/, this.cache.set("flags-".concat(identifier), flags)];
                     case 2:
+                        // @ts-ignore node-cache types are incorrect, ttl should be optional
                         _a.sent();
                         _a.label = 3;
                     case 3: return [2 /*return*/, flags];

package/build/sdk/types.d.ts

@@ -1,7 +1,7 @@
 import { Flags } from "./models";
 export interface FlagsmithCache {
-    get(key: string): Promise<Flags>;
-    set(key: string, value: Flags): Promise<void>;
-    has(key: string): Promise<boolean>;
+    get(key: string): Promise<Flags | undefined> | undefined;
+    set(key: string, value: Flags, ttl: string | number): boolean | Promise<boolean>;
+    has(key: string): boolean | Promise<boolean>;
     [key: string]: any;
 }

package/es6-example/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"]
+}

package/es6-example/.eslintrc

@@ -0,0 +1,8 @@
+{
+  "extends": ["eslint:recommended", "prettier"],
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "env": { "es6": true, "node": true }
+}

package/es6-example/README.md

@@ -0,0 +1,62 @@
+# Nodejs-ES6-Boilerplate
+[![Made in Indonesia](https://made-in-indonesia.github.io/made-in-indonesia.svg)](https://github.com/made-in-indonesia/made-in-indonesia)
+
+A Node.js boilerplate with ES6, ESLint, and Prettier
+
+## Background
+
+I created this boilerplate because I have several coding interviews that needs to be done using JavaScript.
+
+## Scripts
+
+```bash
+# Run the project without nodemon
+npm run start
+
+# Build the project
+npm run build
+
+# Clean build
+npm run clean
+
+# Check the lint errors
+npm run lint
+
+# Fix the lint errors
+npm run lint:fix
+
+# Run prettier
+npm run format
+
+# Check prettier errors
+npm run format:check
+```
+
+## Usage
+
+1. Clone the repository and init new git project
+
+```bash
+$ git clone git@github.com:vferdiansyah/nodejs-es6-boilerplate.git ./your/project/folder
+$ cd ./your/project/folder
+$ rm -rf .git
+$ git init
+```
+
+2. Change project specific information in the following places
+
+- [package.json](./package.json)
+- [README.md](./README.md)
+
+3. Install dependencies
+
+```bash
+$ npm i
+```
+
+4. Start coding
+
+## License
+
+Copyright (c) 2020 Veri Ferdiansyah  
+Licensed under the MIT license.