flagsmith-nodejs 1.0.7 → 1.1.1

package/.idea/{bullet-train-nodejs-client.iml → flagsmith-nodejs-client.iml}

@@ -2,8 +2,8 @@
 <module type="WEB_MODULE" version="4">
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
       <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
       <excludeFolder url="file://$MODULE_DIR$/tmp" />
     </content>
     <orderEntry type="inheritedJdk" />

package/.idea/modules.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/bullet-train-nodejs-client.iml" filepath="$PROJECT_DIR$/.idea/bullet-train-nodejs-client.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/flagsmith-nodejs-client.iml" filepath="$PROJECT_DIR$/.idea/flagsmith-nodejs-client.iml" />
     </modules>
   </component>
 </project>

package/.prettierignore

@@ -0,0 +1 @@
+*.json

package/.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+    bracketSpacing: true,
+    printWidth: 100,
+    singleQuote: true,
+    tabWidth: 4,
+    trailingComma: 'none',
+    useTabs: false,
+    arrowParens: 'avoid'
+};

package/CONTRIBUTING.md

@@ -1,4 +1,5 @@
 # Contributing
+
 We're always looking to improve this project, open source contribution is encouraged so long as they adhere to our guidelines.
 
 # Pull Requests
@@ -7,7 +8,7 @@ The Solid State team will be monitoring for pull requests. When we get one, a me
 
 **A couple things to keep in mind:**
 
- - If you've changed APIs, update the documentation.
- - Keep the code style (indents, wrapping) consistent.
- - If your PR involves a lot of commits, squash them using ```git rebase -i``` as this makes it easier for us to review.
- - Keep lines under 80 characters.
+-   If you've changed APIs, update the documentation.
+-   Keep the code style (indents, wrapping) consistent.
+-   If your PR involves a lot of commits, squash them using `git rebase -i` as this makes it easier for us to review.
+-   Keep lines under 80 characters.

package/LICENCE.md

@@ -9,4 +9,4 @@ Redistribution and use in source and binary forms, with or without modification,
 
     3. Neither the name of the Sentry nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,90 +1,19 @@
-<img width="100%" src="https://raw.githubusercontent.com/SolidStateGroup/bullet-train-frontend/master/hero.png"/>
+<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
 
-# Flagsmith Client
+# Flagsmith NodeJS Client
 
 [![npm version](https://badge.fury.io/js/flagsmith-nodejs.svg)](https://badge.fury.io/js/flagsmith-nodejs)
 [![](https://data.jsdelivr.com/v1/package/npm/flagsmith-nodejs/badge)](https://www.jsdelivr.com/package/npm/flagsmith-nodejs)
 
-The SDK clients for NodeJS [https://bullet-train.io/](https://www.bullet-train.io/). Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organisations.
+The SDK clients for NodeJS [https://www.flagsmith.com/](https://www.flagsmith.com/). Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organisations.
 
-## Getting Started
+## Adding to your project
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See running in production for notes on how to deploy the project on a live system.
-
-## Installing
-
-### VIA npm
-
-```npm i flagsmith-nodejs --save```
-
-## Usage
-
-### Retrieving feature flags for your project
-
-*For full documentation visit [https://docs.bullet-train.io](https://docs.bullet-train.io)*
-
-```javascript
-var flagsmith = require("flagsmith-nodejs");
-
-flagsmith.init({
-    environmentID:"<YOUR_ENVIRONMENT_KEY>"
-});
-
-flagsmith.hasFeature("header", '<My User Id>')
-.then((featureEnabled) => {
-    if (featureEnabled) {
-        //Show my awesome cool new feature to this one user
-    }
-});
-flagsmith.hasFeature("header")
-.then((featureEnabled) => {
-    if (featureEnabled) {
-        //Show my awesome cool new feature to the world
-    }
-});
-
-flagsmith.getValue("header", '<My User Id>')
-.then((value) => {
-    //Show some unique value to this user
-});
-
-flagsmith.getValue("header")
-.then((value) => {
-    //Show a value to the world
-});
-```
-
-### Available Options
-
-| Property        | Description           | Required  | Default Value  |
-| ------------- |:-------------:| -----:| -----:|
-| ```environmentID```     | Defines which project environment you wish to get flags for. *example ACME Project - Staging.* | **YES** | null
-| ```onError```     | Callback function on failure to retrieve flags. ``` (error)=>{...} ``` |  **NO** | null
-| ```defaultFlags```     | Defines the default flags if there are any | **NO** | null
-| ```api```     | Use this property to define where you're getting feature flags from, e.g. if you're self hosting. |  **NO** | https://bullet-train-api.dokku1.solidstategroup.com/api/v1/
-
-### Available Functions
-
-| Property        | Description |
-| ------------- |:-------------:|
-| ```init```     | Initialise the sdk against a particular environment
-| ```hasFeature(key)```     | Get the value of a particular feature e.g. ```flagsmith.hasFeature("powerUserFeature") // true```
-| ```hasFeature(key, userId)```     | Get the value of a particular feature for a user e.g. ```flagsmith.hasFeature("powerUserFeature", 1234) // true```
-| ```getValue(key)```     | Get the value of a particular feature e.g. ```flagsmith.getValue("font_size") // 10```
-| ```getValue(key, userId)```     | Get the value of a particular feature for a specificed userId e.g. ```flagsmith.getValue("font_size", 1234) // 15```
-| ```getFlags()```     | Trigger a manual fetch of the environment features, if a user is identified it will fetch their features
-| ```getFlagsForUser(userId)```     | Trigger a manual fetch of the environment features with a given userId
-| ```setTrait(userId, key, value)```     | Set the name/value pair for the specified userId
-| ```getTrait(userId, key)```     | Retrieve the value for the specified userId and Trait key
-
-### Identifying users
-
-Identifying users allows you to target specific users from the [Flagsmith dashboard](https://www.bullet-train.io/).
-You can include an optional user identifier as part of the `hasFeature` and `getValue` methods to retrieve unique user flags and variables.
+For full documentation visit [https://docs.flagsmith.com/clients/node/](https://docs.flagsmith.com/clients/node/)
 
 ## Contributing
 
-Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code of conduct, and the process for submitting pull requests to us.
+Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code of conduct, and the process for submitting pull requests
 
 ## Getting Help
 
@@ -92,14 +21,10 @@ If you encounter a bug or feature request we would like to hear about it. Before
 
 ## Get in touch
 
-If you have any questions about our projects you can email <a href="mailto:support@bullet-train.io">support@bullet-train.io</a>.
+If you have any questions about our projects you can email <a href="mailto:support@flagsmith.com">support@flagsmith.com</a>.
 
 ## Useful links
 
-[Website](https://bullet-train.io)
-
-[Documentation](https://docs.bullet-train.io/)
-
-[Code Examples](https://github.com/flagsmithHQ/bullet-train-docs)
+[Website](https://www.flagsmith.com/)
 
-[Youtube Tutorials](https://www.youtube.com/channel/UCki7GZrOdZZcsV9rAIRchCw)
+[Documentation](https://docs.flagsmith.com/)

package/example/README.md

@@ -1,21 +1,21 @@
-Flagsmith example
-==================================
+# Flagsmith example
 
-
-Getting Started
----------------
+## Getting Started
 
 # Setup via cli
 
-```npm i ssg-node -g```
+`npm i ssg-node -g`
 
-```ssg-node PROJECT_NAME```
+`ssg-node PROJECT_NAME`
 
 # Run
-```$ npm start```
+
+`$ npm start`
 
 # Nodemon (Restart server on changes)
-```npm run dev```
+
+`npm run dev`
 
 # The project
-- ``/server/api`` contains a simple express api that interacts with Flagsmith 
+
+-   `/server/api` contains a simple express api that interacts with Flagsmith

package/example/package-lock.json

@@ -54,19 +54,16 @@
         "concat-map": "0.0.1"
       }
     },
-    "bullet-train-nodejs": {
-      "version": "0.1.1",
-      "resolved": "https://registry.npmjs.org/bullet-train-nodejs/-/bullet-train-nodejs-0.1.1.tgz",
-      "integrity": "sha512-gkLPyJEZChvzfhTrGXFJuP2LMU/7pnybjIHDJ9cu4sK52q3eHim49Qh+p8KQykWmebymLpGHW9baPrRqr235PQ==",
-      "requires": {
-        "node-fetch": "^2.1.2"
-      }
-    },
     "bytes": {
       "version": "3.0.0",
       "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.0.0.tgz",
       "integrity": "sha1-0ygVQE1olpn4Wk6k+odV3ROpYEg="
     },
+    "clone": {
+      "version": "2.1.2",
+      "resolved": "https://registry.npmjs.org/clone/-/clone-2.1.2.tgz",
+      "integrity": "sha1-G39Ln1kfHo+DZwQBYANFoCiHQ18="
+    },
     "commander": {
       "version": "2.17.1",
       "resolved": "https://registry.npmjs.org/commander/-/commander-2.17.1.tgz",
@@ -470,10 +467,13 @@
       "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.1.tgz",
       "integrity": "sha512-iyam8fBuCUpWeKPGpaNMetEocMt364qkCsfL9JuhjXX6dRnguRVOfk2GZaDpPjcOKiiXCPINZC1GczQ7iTq3Zw=="
     },
-    "node-fetch": {
-      "version": "2.1.2",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.1.2.tgz",
-      "integrity": "sha1-q4hOjn5X44qUR1POxwb3iNF2i7U="
+    "node-cache": {
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/node-cache/-/node-cache-5.1.2.tgz",
+      "integrity": "sha512-t1QzWwnk4sjLWaQAS8CHgOJ+RAfmHpxFWmc36IWTiWHQfs0w5JDMBS1b1ZxQteo0vVVuWJvIUKHDkkeK7vIGCg==",
+      "requires": {
+        "clone": "2.x"
+      }
     },
     "object-assign": {
       "version": "4.1.1",

package/example/package.json

@@ -15,7 +15,7 @@
     "npm": "3.10.x"
   },
   "dependencies": {
-    "flagsmith-nodejs": "^1.0.0",
+    "node-cache": "^5.1.2",
     "ssg-node-express": "4.16.4",
     "ssg-util": "0.0.3"
   },

package/example/server/api/index.js

@@ -1,26 +1,32 @@
 const Router = require('express').Router;
-const environmentID = "QjgYur4LQTwe5HpvbvhpzK";
-const flagsmith = require("flagsmith-nodejs");
+const environmentID = 'uCDQzKWgejrutqSYYsKWen';
+const flagsmith = require('../../../');
+const NodeCache = require('node-cache');
 
 flagsmith.init({
     environmentID
+    // this is an example of a user-defined cache
+    /*cache: new NodeCache({
+        stdTTL: 5
+    })*/
 });
 
 module.exports = () => {
     const api = Router();
 
-    api.get('/', (req, res) => {
-        flagsmith.getValue("font_size")
-            .then((font_size) => {
-                res.json({font_size})
-            });
+    api.get('/', async (req, res) => {
+        const font_size = await flagsmith.getValue('font_size');
+        res.json({ font_size });
     });
 
-    api.get('/:user', (req, res) => {
-        flagsmith.getValue("font_size", "flagsmith_sample_user")
-            .then((font_size) => {
-                res.json({font_size})
-            });
+    api.get('/flags', async (req, res) => {
+        const flags = await flagsmith.getFlags();
+        res.json(flags);
+    });
+
+    api.get('/:user', async (req, res) => {
+        const font_size = await flagsmith.getValue('font_size', req.params.user);
+        res.json({ font_size });
     });
 
     return api;

package/example/server/index.js

@@ -1,5 +1,3 @@
-global.fetch = require('fetchify')(Promise).fetch; // polyfil
-
 const http = require('http');
 const express = require('express');
 const api = require('./api');
@@ -16,14 +14,15 @@ app.use(bodyParser.json());
 // api router
 app.use('/', api());
 
-
 app.server.listen(PORT);
 console.log('Server started on port ' + app.server.address().port);
 console.log();
-console.log('Go to http://localhost:'+PORT+'/');
+console.log('Go to http://localhost:' + PORT + '/');
 console.log('To get an example feature state');
 console.log();
-console.log('Go to http://localhost:'+PORT+'/flagsmith_sample_user');
+console.log('Go to http://localhost:' + PORT + '/flagsmith_sample_user');
 console.log('To get an example feature state for a user');
+console.log('Go to http://localhost:' + PORT + '/flags');
+console.log('To get an example response for getFlags');
 
 module.exports = app;

package/flagsmith-core.js

@@ -0,0 +1,243 @@
+let fetch = require('node-fetch');
+// https://github.com/node-fetch/node-fetch/issues/450
+if (typeof fetch.default !== "undefined") fetch = fetch.default
+
+module.exports = class FlagsmithCore {
+    normalizeFlags(flags) {
+        const _flags = {};
+
+        for (const { feature, enabled, feature_state_value } of flags) {
+            const normalizedKey = feature.name.toLowerCase().replace(/ /g, '_');
+            _flags[normalizedKey] = {
+                enabled,
+                value: feature_state_value
+            };
+        }
+
+        return _flags;
+    }
+
+    normalizeTraits(traits) {
+        const _traits = {};
+
+        for (const { trait_key, trait_value } of traits) {
+            const normalizedKey = trait_key.toLowerCase().replace(/ /g, '_');
+            _traits[normalizedKey] = trait_value;
+        }
+
+        return _traits;
+    }
+
+    async getJSON(url, method, body) {
+        const { environmentID } = this;
+        const options = {
+            method: method || 'GET',
+            body,
+            headers: {
+                'x-environment-key': environmentID
+            }
+        };
+
+        if (method !== 'GET') {
+            options.headers['Content-Type'] = 'application/json; charset=utf-8';
+        }
+
+        const res = await fetch(url, options);
+        const result = await res.json();
+
+        if (res.status >= 400) {
+            throw new Error(result.detail);
+        }
+
+        return result;
+    }
+
+    init({ environmentID, api, onError, cache }) {
+        if (!environmentID) {
+            throw new Error('Please specify a environment id');
+        }
+
+        this.environmentID = environmentID;
+
+        this.api = api || 'https://api.flagsmith.com/api/v1';
+        this.onError = onError;
+
+        if (cache) {
+            const missingMethods = [];
+
+            ['has', 'get', 'set'].forEach(method => {
+                if (!cache[method]) missingMethods.push(method);
+            });
+
+            if (missingMethods.length > 0) {
+                throw new Error(
+                    `Please implement the following methods in your cache: ${missingMethods.join(
+                        ', '
+                    )}`
+                );
+            }
+        }
+
+        this.cache = cache;
+    }
+
+    async getFlags() {
+        if (this.cache && (await this.cache.has('flags'))) {
+            return this.cache.get('flags');
+        }
+
+        const { onError, api } = this;
+
+        try {
+            const flags = await this.getJSON(`${api}/flags/`);
+            const normalizedFlags = this.normalizeFlags(flags);
+
+            if (this.cache) await this.cache.set('flags', normalizedFlags);
+
+            return normalizedFlags;
+        } catch (err) {
+            onError && onError({ message: err.message });
+            throw err;
+        }
+    }
+
+    async getFlagsForUser(identity) {
+        const cacheKey = `flags-${identity}`;
+
+        if (this.cache && (await this.cache.has(cacheKey))) {
+            return this.cache.get(cacheKey);
+        }
+
+        const { onError, api } = this;
+
+        if (!identity) {
+            const errMsg = 'getFlagsForUser() called without a user identity';
+            onError && onError({ message: errMsg });
+            throw new Error(errMsg);
+        }
+
+        try {
+            const { flags } = await this.getJSON(`${api}/identities/?identifier=${identity}`);
+            const normalizedFlags = this.normalizeFlags(flags);
+
+            if (this.cache) await this.cache.set(cacheKey, normalizedFlags);
+
+            return normalizedFlags;
+        } catch (err) {
+            onError && onError({ message: err.message });
+            throw err;
+        }
+    }
+
+    async getUserIdentity(identity) {
+        const cacheKey = `flags_traits-${identity}`;
+
+        if (this.cache && (await this.cache.has(cacheKey))) {
+            return this.cache.get(cacheKey);
+        }
+
+        const { onError, api } = this;
+
+        if (!identity) {
+            const errMsg = 'getUserIdentity() called without a user identity';
+            onError && onError({ message: errMsg });
+            throw new Error(errMsg);
+        }
+
+        try {
+            const { flags, traits } = await this.getJSON(
+                `${api}/identities/?identifier=${identity}`
+            );
+
+            const normalizedFlags = this.normalizeFlags(flags);
+            const normalizedTraits = this.normalizeTraits(traits);
+            const res = { flags: normalizedFlags, traits: normalizedTraits };
+
+            if (this.cache) await this.cache.set(cacheKey, res);
+
+            return res;
+        } catch (err) {
+            onError && onError({ message: err.message });
+            throw err;
+        }
+    }
+
+    async getValue(key, userId) {
+        const flags = userId ? await this.getFlagsForUser(userId) : await this.getFlags();
+
+        return this.getValueFromFeatures(key, flags);
+    }
+
+    async hasFeature(key, userId) {
+        const flags = userId ? await this.getFlagsForUser(userId) : await this.getFlags();
+
+        return this.checkFeatureEnabled(key, flags);
+    }
+
+    getValueFromFeatures(key, flags) {
+        if (!flags) return null;
+
+        const flag = flags[key];
+
+        //todo record check for value
+        return flag ? flag.value : null;
+    }
+
+    checkFeatureEnabled(key, flags) {
+        if (!flags) return false;
+
+        const flag = flags[key];
+        return flag && flag.enabled;
+    }
+
+    async getTrait(identity, key) {
+        const { onError } = this;
+
+        if (!identity || !key) {
+            const errMsg = `getTrait() called without a ${
+                !identity ? 'user identity' : 'trait key'
+            }`;
+            onError && onError({ message: errMsg });
+            throw new Error(errMsg);
+        }
+
+        try {
+            const { traits } = await this.getUserIdentity(identity);
+            return traits[key];
+        } catch (err) {
+            onError && onError({ message: err.message });
+            throw err;
+        }
+    }
+
+    async setTrait(identity, key, value) {
+        const { onError, api } = this;
+
+        if (!identity || !key) {
+            const errMsg = `setTrait() called without a ${
+                !identity ? 'user identity' : 'trait key'
+            }`;
+            onError &&
+                onError({
+                    message: errMsg
+                });
+            throw new Error(errMsg);
+        }
+
+        const body = {
+            identity: {
+                identifier: identity
+            },
+            trait_key: key,
+            trait_value: value
+        };
+
+        try {
+            await this.getJSON(`${api}/traits/`, 'POST', JSON.stringify(body));
+            return await this.getUserIdentity(identity);
+        } catch (err) {
+            onError && onError({ message: err.message });
+            throw err;
+        }
+    }
+};

package/index.d.ts

@@ -3,51 +3,52 @@ declare module 'flagsmith-nodejs' {
      * Initialise the sdk against a particular environment
      */
     export function init(config: {
-        environmentID: string
-        onError?: Function
-        defaultFlags?: string[]
-        api?: string
-    }): void
+        environmentID: string;
+        onError?: Function;
+        defaultFlags?: string[];
+        api?: string;
+        cache?: ICache;
+    }): void;
 
     /**
      * Get the whether a flag is enabled e.g. flagsmith.hasFeature("powerUserFeature")
      */
-    export function hasFeature(key: string): Promise<boolean>
+    export function hasFeature(key: string): Promise<boolean>;
 
     /**
      * Get the value of a whether a flag is enabled for a user e.g. flagsmith.hasFeature("powerUserFeature", 1234)
      */
-    export function hasFeature(key: string, userId: string): Promise<boolean>
+    export function hasFeature(key: string, userId: string): Promise<boolean>;
 
     /**
      * Get the value of a particular remote config e.g. flagsmith.getValue("font_size")
      */
-    export function getValue(key: string): Promise<string|number|boolean>
+    export function getValue(key: string): Promise<string | number | boolean>;
 
     /**
      * Get the value of a particular remote config for a specified user e.g. flagsmith.getValue("font_size", 1234)
      */
-    export function getValue(key: string, userId: string): Promise<string|number|boolean>
+    export function getValue(key: string, userId: string): Promise<string | number | boolean>;
 
     /**
      * Trigger a manual fetch of the environment features
      */
-    export function getFlags(): Promise<IFlags>
+    export function getFlags(): Promise<IFlags>;
 
     /**
      * Trigger a manual fetch of the environment features for a given user id
      */
-    export function getFlagsForUser(userId: string): Promise<IFlags>
+    export function getFlagsForUser(userId: string): Promise<IFlags>;
 
     /**
      * Trigger a manual fetch of both the environment features and users' traits for a given user id
      */
-    export function getUserIdentity(userId: string): Promise<IUserIdentity>
+    export function getUserIdentity(userId: string): Promise<IUserIdentity>;
 
     /**
      * Trigger a manual fetch of a specific trait for a given user id
      */
-    export function getTrait(userId: string, key: string): Promise<ITraits>
+    export function getTrait(userId: string, key: string): Promise<ITraits>;
 
     /**
      * Set a specific trait for a given user id
@@ -55,24 +56,30 @@ declare module 'flagsmith-nodejs' {
     export function setTrait(
         userId: string,
         key: string,
-        value: string|number|boolean
-    ): IUserIdentity
+        value: string | number | boolean
+    ): IUserIdentity;
 
     interface IFeature {
-        enabled: boolean
-        value?: string|number|boolean
+        enabled: boolean;
+        value?: string | number | boolean;
     }
 
     interface IFlags {
-        [key: string]: IFeature
+        [key: string]: IFeature;
     }
 
     interface ITraits {
-        [key: string]: string
+        [key: string]: string;
     }
 
     interface IUserIdentity {
-        flags: IFeature
-        traits: ITraits
+        flags: IFeature;
+        traits: ITraits;
+    }
+
+    interface ICache {
+        has(key: string): boolean | Promise<boolean>;
+        get(key: string): any | Promise<any>;
+        set(key: string, val: any): void | Promise<void>;
     }
 }

package/index.js

@@ -1,6 +1,3 @@
-const config = require("./config");
-const fetch = require('node-fetch').default;
-const core = require('./flagsmith-core');
-const flagsmith = core({fetch: fetch});
+const FlagsmithCore = require('./flagsmith-core');
 
-module.exports = flagsmith;
+module.exports = new FlagsmithCore();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "1.0.7",
+  "version": "1.1.1",
   "description": "Flagsmith lets you manage features flags and remote config across web, mobile and server side applications. Deliver true Continuous Integration. Get builds out faster. Control who has access to new features.",
   "main": "index.js",
   "repository": {
@@ -39,7 +39,13 @@
     }
   ],
   "license": "MIT",
+  "scripts": {
+    "lint": "prettier --write ."
+  },
   "dependencies": {
     "node-fetch": "^2.1.2"
+  },
+  "devDependencies": {
+    "prettier": "^2.2.1"
   }
 }

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
-  </state>
-</component>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JavaScriptSettings">
-    <option name="languageLevel" value="ES6" />
-  </component>
-</project>

package/.idea/workspace.xml

@@ -1,184 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="BranchesTreeState">
-    <expand />
-    <select />
-  </component>
-  <component name="ChangeListManager">
-    <list default="true" id="26715e52-92d0-449c-b0d3-02a97b26ec9d" name="Default Changelist" comment="">
-      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/bullet-train-core.js" beforeDir="false" afterPath="$PROJECT_DIR$/flagsmith.js" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/example/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/example/README.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/example/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/example/package.json" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/example/server/api/index.js" beforeDir="false" afterPath="$PROJECT_DIR$/example/server/api/index.js" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/example/server/index.js" beforeDir="false" afterPath="$PROJECT_DIR$/example/server/index.js" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/index.d.ts" beforeDir="false" afterPath="$PROJECT_DIR$/index.d.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/index.js" beforeDir="false" afterPath="$PROJECT_DIR$/index.js" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/package-lock.json" beforeDir="false" afterPath="$PROJECT_DIR$/package-lock.json" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/package.json" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="Git.Pull.Settings">
-    <option name="BRANCH" value="master" />
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_BRANCH_BY_REPOSITORY">
-      <map>
-        <entry key="$PROJECT_DIR$" value="master" />
-      </map>
-    </option>
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="ProjectId" id="1f0YMK9KVPUqTVp0gi8Qb1dD1il" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent">
-    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
-    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
-    <property name="WebServerToolWindowFactoryState" value="false" />
-    <property name="last_opened_file_path" value="$PROJECT_DIR$" />
-    <property name="nodejs_package_manager_path" value="npm" />
-    <property name="ts.external.directory.path" value="$APPLICATION_HOME_DIR$/plugins/JavaScriptLanguage/jsLanguageServicesImpl/external" />
-    <property name="vue.rearranger.settings.migration" value="true" />
-  </component>
-  <component name="RecentsManager">
-    <key name="CopyFile.RECENT_KEYS">
-      <recent name="$PROJECT_DIR$" />
-    </key>
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="SvnConfiguration">
-    <configuration />
-  </component>
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="26715e52-92d0-449c-b0d3-02a97b26ec9d" name="Default Changelist" comment="" />
-      <created>1595356427022</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1595356427022</updated>
-      <workItem from="1595356429123" duration="1282000" />
-      <workItem from="1598381125903" duration="3394000" />
-      <workItem from="1599668504494" duration="605000" />
-      <workItem from="1603729502044" duration="618000" />
-      <workItem from="1604853185978" duration="406000" />
-    </task>
-    <task id="LOCAL-00001" summary="Version bump">
-      <created>1595357856348</created>
-      <option name="number" value="00001" />
-      <option name="presentableId" value="LOCAL-00001" />
-      <option name="project" value="LOCAL" />
-      <updated>1595357856349</updated>
-    </task>
-    <task id="LOCAL-00002" summary="Add types">
-      <created>1598381689227</created>
-      <option name="number" value="00002" />
-      <option name="presentableId" value="LOCAL-00002" />
-      <option name="project" value="LOCAL" />
-      <updated>1598381689227</updated>
-    </task>
-    <task id="LOCAL-00003" summary="Adjust typescript doc wordings">
-      <created>1598381831762</created>
-      <option name="number" value="00003" />
-      <option name="presentableId" value="LOCAL-00003" />
-      <option name="project" value="LOCAL" />
-      <updated>1598381831762</updated>
-    </task>
-    <task id="LOCAL-00004" summary="Improve types">
-      <created>1598384180847</created>
-      <option name="number" value="00004" />
-      <option name="presentableId" value="LOCAL-00004" />
-      <option name="project" value="LOCAL" />
-      <updated>1598384180847</updated>
-    </task>
-    <task id="LOCAL-00005" summary="Version bump">
-      <created>1603729534660</created>
-      <option name="number" value="00005" />
-      <option name="presentableId" value="LOCAL-00005" />
-      <option name="project" value="LOCAL" />
-      <updated>1603729534660</updated>
-    </task>
-    <option name="localTasksCounter" value="6" />
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-  <component name="Vcs.Log.Tabs.Properties">
-    <option name="TAB_STATES">
-      <map>
-        <entry key="1">
-          <value>
-            <State>
-              <option name="SHOW_ONLY_AFFECTED_CHANGES" value="true" />
-              <option name="FILTERS">
-                <map>
-                  <entry key="branch">
-                    <value>
-                      <list>
-                        <option value="HEAD" />
-                      </list>
-                    </value>
-                  </entry>
-                  <entry key="roots">
-                    <value>
-                      <list>
-                        <option value="$PROJECT_DIR$" />
-                      </list>
-                    </value>
-                  </entry>
-                </map>
-              </option>
-            </State>
-          </value>
-        </entry>
-      </map>
-    </option>
-    <option name="OPEN_GENERIC_TABS">
-      <map>
-        <entry key="1" value="TOOL_WINDOW" />
-      </map>
-    </option>
-    <option name="oldMeFiltersMigrated" value="true" />
-  </component>
-  <component name="VcsManagerConfiguration">
-    <MESSAGE value="Add types" />
-    <MESSAGE value="Adjust typescript doc wordings" />
-    <MESSAGE value="Improve types" />
-    <MESSAGE value="Version bump" />
-    <option name="LAST_COMMIT_MESSAGE" value="Version bump" />
-  </component>
-  <component name="WindowStateProjectService">
-    <state x="843" y="48" key="CommitChangelistDialog2" timestamp="1603729534387">
-      <screen x="0" y="0" width="1920" height="1080" />
-    </state>
-    <state x="843" y="48" key="CommitChangelistDialog2/0.0.1920.1080/1920.0.1920.1080@0.0.1920.1080" timestamp="1603729534387" />
-    <state x="843" y="48" key="CommitChangelistDialog2/1920.0.1920.1080/0.0.1920.1080@0.0.1920.1080" timestamp="1598381831357" />
-    <state x="2763" y="48" key="CommitChangelistDialog2/1920.0.1920.1080/0.0.1920.1080@1920.0.1920.1080" timestamp="1598384180673" />
-    <state x="384" y="97" key="DiffContextDialog" timestamp="1598381684021">
-      <screen x="0" y="0" width="1920" height="1080" />
-    </state>
-    <state x="384" y="97" key="DiffContextDialog/1920.0.1920.1080/0.0.1920.1080@0.0.1920.1080" timestamp="1598381684021" />
-    <state x="854" y="276" key="Vcs.Push.Dialog.v2" timestamp="1603729535566">
-      <screen x="0" y="0" width="1920" height="1080" />
-    </state>
-    <state x="854" y="276" key="Vcs.Push.Dialog.v2/0.0.1920.1080/1920.0.1920.1080@0.0.1920.1080" timestamp="1603729535566" />
-    <state x="854" y="276" key="Vcs.Push.Dialog.v2/1920.0.1920.1080/0.0.1920.1080@0.0.1920.1080" timestamp="1598381832772" />
-    <state x="2774" y="276" key="Vcs.Push.Dialog.v2/1920.0.1920.1080/0.0.1920.1080@1920.0.1920.1080" timestamp="1598384181696" />
-    <state x="-1302" y="279" width="1302" height="612" key="find.popup" timestamp="1604853580359">
-      <screen x="-1920" y="0" width="1920" height="1080" />
-    </state>
-    <state x="-1302" y="279" width="1302" height="612" key="find.popup/0.0.1920.1080/-1920.0.1920.1080@-1920.0.1920.1080" timestamp="1604853580359" />
-    <state x="-1589" y="241" width="670" height="676" key="search.everywhere.popup" timestamp="1604853471394">
-      <screen x="-1920" y="0" width="1920" height="1080" />
-    </state>
-    <state x="-1589" y="241" width="670" height="676" key="search.everywhere.popup/0.0.1920.1080/-1920.0.1920.1080@-1920.0.1920.1080" timestamp="1604853471394" />
-    <state x="331" y="241" width="670" height="676" key="search.everywhere.popup/1920.0.1920.1080/0.0.1920.1080@0.0.1920.1080" timestamp="1598381551576" />
-  </component>
-</project>

package/config.js

@@ -1,12 +0,0 @@
-/**
- * Created by kylejohnson on 02/10/2016.
- * Global config
- */
-const env = process.env.config;
-switch (env) {
-    default: {
-        config = require('./env/config-local');
-    }
-}
-
-module.exports = config;

package/env/config-local.js

@@ -1,3 +0,0 @@
-module.exports = {
-    api : "https://api.bullet-train.io/api/v1/"
-};

package/flagsmith.js

@@ -1,236 +0,0 @@
-let fetch;
-const BULLET_TRAIN_KEY = "BULLET_TRAIN_DB";
-
-const Flagsmith = class {
-
-    constructor(props) {
-        fetch = props.fetch;
-
-        this.checkFeatureEnabled = this.checkFeatureEnabled.bind(this);
-        this.getFlags = this.getFlags.bind(this);
-        this.getFlagsForUser = this.getFlagsForUser.bind(this);
-        this.getUserIdentity = this.getUserIdentity.bind(this);
-        this.getValue = this.getValue.bind(this);
-        this.getValueFromFeatures = this.getValueFromFeatures.bind(this);
-        this.hasFeature = this.hasFeature.bind(this);
-        this.init = this.init.bind(this);
-
-        this.getJSON = function (url, method, body) {
-            const { environmentID } = this;
-            const options = {
-                method: method || 'GET',
-                body,
-                headers: {
-                    'x-environment-key': environmentID
-                }
-            };
-            if (method !== "GET") {
-                options.headers['Content-Type'] = 'application/json; charset=utf-8';
-            }
-            return fetch(url, options)
-                .then(res => res.json());
-        };
-    }
-
-    getFlagsForUser (identity) {
-        const { onError, api } = this;
-
-        if (!identity) {
-            onError && onError({message: 'getFlagsForUser() called without a user identity'});
-            return Promise.reject('getFlagsForUser() called without a user identity');
-        }
-
-        const handleResponse = (res) => {
-            // Handle server response
-            let flags = {};
-            res.flags.forEach(feature => {
-                flags[feature.feature.name.toLowerCase().replace(/ /g, '_')] = {
-                    enabled: feature.enabled,
-                    value: feature.feature_state_value
-                };
-            });
-            return flags;
-        };
-
-        return this.getJSON(api + 'identities/?identifier=' + identity)
-            .then(res => {
-                return handleResponse(res);
-            }).catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-
-    getUserIdentity (identity) {
-        const { onError, api } = this;
-
-        if (!identity) {
-            onError && onError({message: 'getUserIdentity() called without a user identity'});
-            return Promise.reject('getUserIdentity() called without a user identity');
-        }
-
-        const handleResponse = (res) => {
-            // Handle server response
-            let flags = {};
-            let traits = {};
-            res.flags.forEach(feature => {
-                flags[feature.feature.name.toLowerCase().replace(/ /g, '_')] = {
-                    enabled: feature.enabled,
-                    value: feature.feature_state_value
-                };
-            });
-            res.traits.forEach(({trait_key, trait_value}) => {
-                traits[trait_key.toLowerCase().replace(/ /g, '_')] = trait_value;
-            });
-            return { flags, traits };
-        };
-
-        return this.getJSON(api + 'identities/?identifier=' + identity)
-            .then(res => {
-                return handleResponse(res);
-            }).catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-
-    getFlags() {
-        const { onError, api } = this;
-
-        const handleResponse = (res) => {
-            // Handle server response
-            let flags = {};
-            res.forEach(feature => {
-                flags[feature.feature.name.toLowerCase().replace(/ /g, '_')] = {
-                    enabled: feature.enabled,
-                    value: feature.feature_state_value
-                };
-            });
-            return flags;
-        };
-
-        return this.getJSON(api + "flags/")
-            .then(res => {
-                return handleResponse(res);
-            }).catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    };
-
-    init({
-             environmentID,
-             api,
-             disableCache,
-             onError,
-         }) {
-
-        this.environmentID = environmentID;
-
-        this.api = api;
-        this.disableCache = disableCache;
-        this.onError = onError;
-
-        if (!environmentID) {
-            throw ('Please specify a environment id');
-        }
-        if (api === undefined) {
-            this.api = config.api;
-        }
-    }
-
-    getValue (key, userId) {
-        if (userId) {
-            return this.getFlagsForUser(userId).then((flags) => {
-                return this.getValueFromFeatures(key, flags);
-            })
-        } else {
-            return this.getFlags().then((flags) => {
-                return this.getValueFromFeatures(key, flags);
-            });
-        }
-    }
-
-    hasFeature (key, userId) {
-        if (userId) {
-            return this.getFlagsForUser(userId).then((flags) => {
-                return this.checkFeatureEnabled(key, flags);
-            })
-        } else {
-            return this.getFlags().then((flags) => {
-                return this.checkFeatureEnabled(key, flags);
-            });
-        }
-    }
-
-    getValueFromFeatures (key, flags) {
-        if (!flags) {
-            return null;
-        }
-        const flag = flags[key];
-        let res = null;
-        if (flag) {
-            res = flag.value;
-        }
-        //todo record check for value
-
-        return res;
-    }
-
-    checkFeatureEnabled (key, flags) {
-        if (!flags) {
-            return false;
-        }
-        const flag = flags[key];
-        let res = false;
-        if (flag && flag.enabled) {
-            res = true;
-        }
-
-        return res;
-    }
-
-    getTrait (identity, key) {
-        const { onError } = this;
-
-        if (!identity || !key) {
-            onError && onError({message: `getTrait() called without a ${!identity ? 'user identity' : 'trait key'}`});
-            return Promise.reject(`getTrait() called without a ${!identity ? 'user identity' : 'trait key'}`);
-        }
-
-        return this.getUserIdentity(identity)
-            .then(({traits}) => traits[key])
-            .catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-
-    setTrait (identity, key, value) {
-        const { onError, api } = this;
-
-        if (!identity || !key) {
-            onError && onError({message: `setTrait() called without a ${!identity ? 'user identity' : 'trait key'}`});
-            return Promise.reject(`setTrait() called without a ${!identity ? 'user identity' : 'trait key'}`);
-        }
-
-        const body = {
-            "identity": {
-                "identifier": identity
-            },
-            "trait_key": key,
-            "trait_value": value
-        }
-
-        return this.getJSON(`${api}traits/`, 'POST', JSON.stringify(body))
-            .then(() => this.getUserIdentity(identity))
-            .catch(({ message }) => {
-                onError && onError({ message });
-                return Promise.reject(message);
-            });
-    }
-};
-
-module.exports = function ({ fetch }) {
-    return new Flagsmith({ fetch });
-};