flagsmith-nodejs 2.2.2 → 2.3.0

package/examples/api-proxy/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "nodejs-es6-boilerplate",
+  "version": "1.0.1",
+  "description": "Node.js boilerplate with ES6, ESLint, and Prettier",
+  "main": "src/index.js",
+  "browserslist": [
+    "last 2 Chrome versions"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "clean": "rm -rf build && mkdir build",
+    "build-babel": "babel -d ./build ./src -s",
+    "build": "npm run clean && npm run build-babel",
+    "dev": "nodemon --exec npm start --ignore ./build",
+    "node-cache": "^5.1.2",
+    "ssg-node-express": "4.16.4",
+    "start": "npm run build && node ./build/index.js",
+    "format": "prettier --write \"src/**/*.js\"",
+    "format:check": "prettier --list-different \"src/**/*.js\"",
+    "lint": "eslint \"src/**/*.js\"",
+    "lint:fix": "eslint --fix \"src/**/*.js\""
+  },
+  "repository": "github:vferdiansyah/nodejs-es6-boilerplate",
+  "keywords": [
+    "javascript",
+    "node",
+    "nodejs",
+    "es6",
+    "eslint",
+    "prettier",
+    "boilerplate"
+  ],
+  "author": {
+    "name": "Veri Ferdiansyah",
+    "email": "veri.ferdi@gmail.com",
+    "url": "https://vferdiansyah.github.io"
+  },
+  "license": "MIT",
+  "bugs": "https://github.com/vferdiansyah/nodejs-es6-boilerplate/issues",
+  "homepage": "https://github.com/vferdiansyah/nodejs-es6-boilerplate#readme",
+  "devDependencies": {
+    "@babel/cli": "^7.5.5",
+    "@babel/core": "^7.5.5",
+    "@babel/preset-env": "^7.5.5",
+    "eslint": "^6.2.1",
+    "eslint-config-prettier": "^6.1.0",
+    "eslint-plugin-prettier": "^3.1.0",
+    "express": "^4.18.1",
+    "nodemon": "^2.0.19",
+    "prettier": "^1.18.2"
+  },
+  "dependencies": {
+    "flagsmith-nodejs": "^2.2.2",
+    "https-proxy-agent": "^5.0.1",
+    "node-cache": "^5.1.2"
+  }
+}

package/examples/api-proxy/src/api/index.js

@@ -0,0 +1,42 @@
+import {Router}  from 'express'
+import Flagsmith from '../../../../build'
+import HttpsProxyAgent from 'https-proxy-agent'
+
+const environmentKey = 'NowEDzKzNJXZVTVanLVdMQ';
+
+const flagsmith = new Flagsmith({
+    environmentKey,
+    agent: new HttpsProxyAgent({
+        host: "localhost",
+        protocol: "https",
+        port:8080,
+        headers: {
+            "Custom-Header": 1
+        }
+    })
+});
+
+const api =  () => {
+    const api = Router();
+
+    api.get('/', async (req, res) => {
+        const flags = await flagsmith.getEnvironmentFlags();
+        res.json(flags);
+    });
+
+    api.get('/:user', async (req, res) => {
+        const flags = await flagsmith.getIdentityFlags(req.params.user, { checkout_v2: 1 });
+        const fontSize = flags.getFeatureValue('font_size');
+        const checkoutV2 = flags.isFeatureEnabled('checkout_v2');
+        res.json({ fontSize, checkoutV2 });
+    });
+
+    api.get('/:user/segments', async (req, res) => {
+        const segments = await flagsmith.getIdentitySegments(req.params.user, { checkout_v2: 1 });
+        res.json(segments.map(v => v.name));
+    });
+
+    return api;
+};
+
+export default api

package/examples/basic/.babelrc

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

package/examples/basic/.eslintrc

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

package/examples/basic/README.md

@@ -0,0 +1,10 @@
+<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
+
+# Flagsmith Node.js example with custom fetch agent
+
+This is a simple Flagsmith Node.js example in local evaluation modes with a custom fetch agent. Using a custom fetch agent lets allows you to specify networking related options such as keep alive and socket timeout, read more on this [here](https://github.com/node-fetch/node-fetch#custom-agent).
+
+```shell
+npm i
+npm run dev
+```

package/{es6-example → examples/basic}/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.1",
       "license": "MIT",
       "dependencies": {
-        "flagsmith-nodejs": "^2.2.2-beta.3",
+        "flagsmith-nodejs": "^2.2.2",
         "node-cache": "^5.1.2"
       },
       "devDependencies": {
@@ -2474,9 +2474,9 @@
       }
     },
     "node_modules/flagsmith-nodejs": {
-      "version": "2.2.2-beta.3",
-      "resolved": "https://registry.npmjs.org/flagsmith-nodejs/-/flagsmith-nodejs-2.2.2-beta.3.tgz",
-      "integrity": "sha512-t1jCcH/EMXWjJ5ufcRPgXPemObppHYUDAHmkPks4XeYYA4L9kVApt/S/8DachipOXaD6V9qaEzzRMbamw+Icyw==",
+      "version": "2.2.2",
+      "resolved": "https://registry.npmjs.org/flagsmith-nodejs/-/flagsmith-nodejs-2.2.2.tgz",
+      "integrity": "sha512-T8RI5+H6GdHwXz7fOaQOE5Q6XJOeMLlSuSw4uDExQRkVzaO/6k0KFBYRRiTce//guRrkSSW1xqvcB8AuqYLkNA==",
       "dependencies": {
         "big-integer": "^1.6.51",
         "md5": "^2.3.0",
@@ -3871,12 +3871,6 @@
         "node": ">=6"
       }
     },
-    "node_modules/json5/node_modules/minimist": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==",
-      "dev": true
-    },
     "node_modules/kind-of": {
       "version": "6.0.3",
       "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
@@ -3901,9 +3895,9 @@
       }
     },
     "node_modules/lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==",
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
       "dev": true
     },
     "node_modules/loose-envify": {
@@ -4066,9 +4060,9 @@
       }
     },
     "node_modules/minimist": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==",
+      "version": "1.2.6",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
+      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
       "dev": true
     },
     "node_modules/mixin-deep": {
@@ -4651,9 +4645,9 @@
       }
     },
     "node_modules/path-parse": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
-      "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==",
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+      "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==",
       "dev": true
     },
     "node_modules/path-to-regexp": {
@@ -8008,9 +8002,9 @@
       }
     },
     "flagsmith-nodejs": {
-      "version": "2.2.2-beta.3",
-      "resolved": "https://registry.npmjs.org/flagsmith-nodejs/-/flagsmith-nodejs-2.2.2-beta.3.tgz",
-      "integrity": "sha512-t1jCcH/EMXWjJ5ufcRPgXPemObppHYUDAHmkPks4XeYYA4L9kVApt/S/8DachipOXaD6V9qaEzzRMbamw+Icyw==",
+      "version": "2.2.2",
+      "resolved": "https://registry.npmjs.org/flagsmith-nodejs/-/flagsmith-nodejs-2.2.2.tgz",
+      "integrity": "sha512-T8RI5+H6GdHwXz7fOaQOE5Q6XJOeMLlSuSw4uDExQRkVzaO/6k0KFBYRRiTce//guRrkSSW1xqvcB8AuqYLkNA==",
       "requires": {
         "big-integer": "^1.6.51",
         "md5": "^2.3.0",
@@ -9107,14 +9101,6 @@
       "dev": true,
       "requires": {
         "minimist": "^1.2.0"
-      },
-      "dependencies": {
-        "minimist": {
-          "version": "1.2.5",
-          "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-          "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==",
-          "dev": true
-        }
       }
     },
     "kind-of": {
@@ -9135,9 +9121,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==",
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
       "dev": true
     },
     "loose-envify": {
@@ -9261,9 +9247,9 @@
       }
     },
     "minimist": {
-      "version": "1.2.5",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==",
+      "version": "1.2.6",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
+      "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
       "dev": true
     },
     "mixin-deep": {
@@ -9707,9 +9693,9 @@
       "dev": true
     },
     "path-parse": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
-      "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==",
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
+      "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==",
       "dev": true
     },
     "path-to-regexp": {

package/{es6-example → examples/basic}/package.json

@@ -50,7 +50,7 @@
     "prettier": "^1.18.2"
   },
   "dependencies": {
-    "flagsmith-nodejs": "^2.2.2-beta.3",
+    "flagsmith-nodejs": "^2.2.2",
     "node-cache": "^5.1.2"
   }
 }

package/examples/basic/src/api/index.js

@@ -0,0 +1,33 @@
+import {Router}  from 'express'
+import Flagsmith from '../../../../build'
+
+const environmentKey = 'NowEDzKzNJXZVTVanLVdMQ';
+
+const flagsmith = new Flagsmith({
+    environmentKey
+});
+
+const api =  () => {
+    const api = Router();
+
+    api.get('/', async (req, res) => {
+        const flags = await flagsmith.getEnvironmentFlags();
+        res.json(flags);
+    });
+
+    api.get('/:user', async (req, res) => {
+        const flags = await flagsmith.getIdentityFlags(req.params.user, { checkout_v2: 1 });
+        const fontSize = flags.getFeatureValue('font_size');
+        const checkoutV2 = flags.isFeatureEnabled('checkout_v2');
+        res.json({ fontSize, checkoutV2 });
+    });
+
+    api.get('/:user/segments', async (req, res) => {
+        const segments = await flagsmith.getIdentitySegments(req.params.user, { checkout_v2: 1 });
+        res.json(segments.map(v => v.name));
+    });
+
+    return api;
+};
+
+export default api

package/{example/server → examples/basic/src}/index.js

@@ -1,9 +1,9 @@
-const http = require('http');
-const express = require('express');
-const api = require('./api');
+import http from 'http'
+import express from 'express'
+import bodyParser from 'body-parser'
+import api from './api'
 const PORT = process.env.PORT || 3000;
 const app = express();
-const bodyParser = require('body-parser');
 
 app.server = http.createServer(app);
 

package/examples/caching/.babelrc

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

package/examples/caching/.eslintrc

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

package/examples/caching/README.md

@@ -0,0 +1,9 @@
+<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
+
+# Flagsmith Node.js example with caching
+
+This is a simple Flagsmith Node.js example that uses node-cache as a way to cache flags and identities with a TTL. This can also be used with other implementations such as Redis, see [here](https://docs.flagsmith.com/v1.0/clients/node#caching-data) for more information.
+```shell
+npm i
+npm run dev
+```