Merge pull request #107 from zotoio/fix/upgrade-deps

feat(upgrade): use latest swagger, and ..

Author: wyvern8

.eslintrc.json

@@ -26,6 +26,14 @@
         "semi": [
             "error",
             "always"
-        ]
+        ],
+        "comma-dangle": ["error", "never"],
+        "arrow-parens": ["error", "as-needed"],
+        "space-before-function-paren": ["error", {
+            "anonymous": "never",
+            "named": "never",
+            "asyncArrow": "always"
+        }],
+        "keyword-spacing": ["error", { "before": true }]
     }
 }

.prettierrc.json

@@ -2,5 +2,7 @@
   "useTabs": false,
   "printWidth": 120,
   "tabWidth": 4,
-  "singleQuote": true
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "trailingComma": "none"
 }

API.md

@@ -268,7 +268,7 @@ ldutils restoreFeatureFlags my-project my-flag,my-flag-two prod ./preReleaseBack
 * [LaunchDarklyUtilsMembers](#LaunchDarklyUtilsMembers)
     * [new LaunchDarklyUtilsMembers(apiClient, log, ldUtils)](#new_LaunchDarklyUtilsMembers_new)
     * [.API_GROUP](#LaunchDarklyUtilsMembers+API_GROUP) ⇒ <code>string</code>
-    * [.getTeamMembers()](#LaunchDarklyUtilsMembers+getTeamMembers) ⇒ <code>Promise</code>
+    * [.getTeamMembers(limit, offset, filter)](#LaunchDarklyUtilsMembers+getTeamMembers) ⇒ <code>Promise</code>
     * [.getTeamMember(memberId)](#LaunchDarklyUtilsMembers+getTeamMember) ⇒ <code>Promise</code>
     * [.getTeamMemberByEmail(emailAddress)](#LaunchDarklyUtilsMembers+getTeamMemberByEmail) ⇒ <code>Promise</code>
     * [.getTeamMemberCustomRoles(emailAddress)](#LaunchDarklyUtilsMembers+getTeamMemberCustomRoles) ⇒ <code>Promise</code>
@@ -295,12 +295,19 @@ Api group object key in LD api
 **Kind**: instance property of [<code>LaunchDarklyUtilsMembers</code>](#LaunchDarklyUtilsMembers)  
 <a name="LaunchDarklyUtilsMembers+getTeamMembers"></a>
 
-### launchDarklyUtilsMembers.getTeamMembers() ⇒ <code>Promise</code>
+### launchDarklyUtilsMembers.getTeamMembers(limit, offset, filter) ⇒ <code>Promise</code>
 Get all team members in account
 
 **Kind**: instance method of [<code>LaunchDarklyUtilsMembers</code>](#LaunchDarklyUtilsMembers)  
 **Fulfil**: <code>Object</code> team member list json  
 **Reject**: <code>Error</code> object with message  
+
+| Param | Description |
+| --- | --- |
+| limit | max number of members to return (defaults to 20 per api) |
+| offset | starting offset to return |
+| filter | an optional filter https://apidocs.launchdarkly.com/reference#list-team-members |
+
 **Example**  
 ```js
 ldutils getTeamMembers
@@ -450,7 +457,7 @@ Get a single role by _id
 
 **Example**  
 ```js
-ldutils getCustomRoleById 5a554j890b575421b255d96e
+ldutils getCustomRoleById <id>
 ```
 <a name="LaunchDarklyUtilsRoles+createCustomRole"></a>
 

README.md

@@ -1,7 +1,7 @@
 # LaunchDarkly nodejs utils
 
 [![npm version](https://badge.fury.io/js/launchdarkly-nodeutils.svg)](https://badge.fury.io/js/launchdarkly-nodeutils)
-[![Build Status](https://travis-ci.org/zotoio/launchdarkly-nodeutils.svg?branch=master)](https://travis-ci.org/zotoio/launchdarkly-nodeutils)
+[![Build Status](https://travis-ci.com/zotoio/launchdarkly-nodeutils.svg?branch=master)](https://travis-ci.org/zotoio/launchdarkly-nodeutils)
 [![Code Climate](https://img.shields.io/codeclimate/maintainability/zotoio/launchdarkly-nodeutils.svg)](https://codeclimate.com/github/zotoio/launchdarkly-nodeutils)
 [![Test Coverage](https://codeclimate.com/github/zotoio/launchdarkly-nodeutils/badges/coverage.svg)](https://codeclimate.com/github/zotoio/launchdarkly-nodeutils/coverage)
 [![Greenkeeper badge](https://badges.greenkeeper.io/zotoio/launchdarkly-nodeutils.svg)](https://greenkeeper.io/)
@@ -16,12 +16,33 @@ This unofficial module provides NodeJs functions wrapping the LaunchDarkly API.
 We need a way to manage flags as part of CI/CD pipelines, and there is not another project currently providing a simple interface to manage flags and other objects in LaunchDarkly via API in nodejs.
 
 ## How?
-There is a swagger.yaml available to generate bindings (https://launchdarkly.github.io/ld-openapi/swagger.yaml), so we use the swagger-js module to generate a client (https://github.com/swagger-api/swagger-js), and add some extra features around logging, error handling, and chaining of operations.
+There is an openapi spec available to generate bindings (https://launchdarkly.github.io/ld-openapi/openapi.yaml), so we use the swagger-js module to generate a client (https://github.com/swagger-api/swagger-js), and add some extra features around logging, error handling, and chaining of operations.
 In addition we expose apis as a commandline tool.
 
 ## Install
-1. `npm install launchdarkly-nodeutils --save` or clone this repo.
-2. Generate an access token with the permissions for the operations you will use. Please read: https://docs.launchdarkly.com/v2.0/docs/api-access-tokens
+1. `npm install launchdarkly-nodeutils -g` (this will install the `ldutils` command).
+1. Generate an access token with the permissions for the operations you will use. Please read: https://docs.launchdarkly.com/v2.0/docs/api-access-tokens
+1. export your api token `export LAUNCHDARKLY_API_TOKEN=<api-token>`
+1. run `ldutils` to confirm your installation was successful - you should see usage instructions.
+
+The installation instructions above should be all you need to do. Alternatively, you can clone this repo and install manually.
+
+After cloning this repo:
+1. run `yarn build`
+1. check that `ldutils` is executable and run it:
+```
+chmod 755 ./ldutils
+./ldutils
+```
+
+The above will display a help screen of instructions, thanks to https://github.com/tj/commander.js/
+
+Optionally you can add `ldutils` to your PATH, or symlink in a directory already in your path:
+
+```
+sudo ln -s /<clonepath>/launchdarkly-nodeutils/ldutils /usr/local/bin/ldutils
+```
+> Make sure you have env var LAUNCHDARKLY_API_TOKEN set, and if piping output to another command, ensure that LAUNCHDARKLY_API_LOGLEVEL is not set to 'debug' to ensure only the json result of the command is returned.
 
 ## Use cases
 The command line tool or nodejs module can be used for many things.  Here are some examples.
@@ -51,29 +72,8 @@ Copying flag attributes from prod back to preprod for testing. Also newly create
 
 
 ## Command line usage
-After cloning this repo you can make `ldutils` executable, and use it to make api calls based on passed in parameters.
-
-> please read the [API documentation](API.md) for examples.
-
-```
-chmod 755 ./ldutils
-./ldutils
-```
-
-The above will display a help screen of instructions, thanks to https://github.com/tj/commander.js/
-
-Optionally you can add `ldutils` to your PATH:
-
-```
-# cloned repo
-sudo ln -s /<clonepath>/launchdarkly-nodeutils/ldutils /usr/local/bin/ldutils
-
-# or after 'npm install launchdarkly-nodeutils --save'
-sudo ln -s /<installpath>/node_modules/launchdarkly-nodeutils/ldutils /usr/local/bin/ldutils
-```
-> Make sure you have env var LAUNCHDARKLY_API_TOKEN set, and if piping output to another command, ensure that LAUNCHDARKLY_API_LOGLEVEL is not set to 'debug' to ensure only the json result of the command is returned.
 
-Here are some examples of commandline usage (if you have not added ldutils to PATH, prefix with `./`:
+Here are some examples of commandline usage - see below for all available command modes:
 ```
 export LAUNCHDARKLY_API_TOKEN=<api-token>
 

ldutils

@@ -19,208 +19,206 @@ process.on('unhandledRejection', (reason, p) => {
     process.exit(1);
 });
 
-new LaunchDarklyUtils().create(process.env.LAUNCHDARKLY_API_TOKEN, log).then(function(ldUtils) {
+new LaunchDarklyUtils().create(process.env.LAUNCHDARKLY_API_TOKEN, log).then(ldUtils => {
     program.version('1.0.0').description('Manage LaunchDarkly flags and other assets from the command line.');
 
     program
         .command('getFeatureFlags <projectKey>')
         .description('get all flags for a given project')
-        .action(function(projectKey) {
-            ldUtils.flags.getFeatureFlags(projectKey).then(function(response) {
+        .action(projectKey => {
+            ldUtils.flags.getFeatureFlags(projectKey).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command(`getFeatureFlag <projectKey> <featureFlagKey> [environmentKeyQuery]`)
         .description('get a single flag - with optional env')
-        .action(function(projectKey, featureFlagKey, environmentKeyQuery) {
-            ldUtils.flags.getFeatureFlag(projectKey, featureFlagKey, environmentKeyQuery).then(function(response) {
+        .action((projectKey, featureFlagKey, environmentKeyQuery) => {
+            ldUtils.flags.getFeatureFlag(projectKey, featureFlagKey, environmentKeyQuery).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command(`getFeatureFlagState <projectKey> <featureFlagKey> <environmentKeyQuery>`)
         .description('get boolean flag state')
-        .action(function(projectKey, featureFlagKey, environmentKeyQuery) {
-            ldUtils.flags.getFeatureFlagState(projectKey, featureFlagKey, environmentKeyQuery).then(function(response) {
+        .action((projectKey, featureFlagKey, environmentKeyQuery) => {
+            ldUtils.flags.getFeatureFlagState(projectKey, featureFlagKey, environmentKeyQuery).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command(`toggleFeatureFlag <projectKey> <featureFlagKey> <environmentKeyQuery> <value>`)
         .description('set boolean flag state')
-        .action(function(projectKey, featureFlagKey, environmentKeyQuery, value) {
+        .action((projectKey, featureFlagKey, environmentKeyQuery, value) => {
             let enabled = value === 'true';
-            ldUtils.flags
-                .toggleFeatureFlag(projectKey, featureFlagKey, environmentKeyQuery, enabled)
-                .then(function(response) {
-                    console.log(json.plain(response));
-                });
+            ldUtils.flags.toggleFeatureFlag(projectKey, featureFlagKey, environmentKeyQuery, enabled).then(response => {
+                console.log(json.plain(response));
+            });
         });
 
     program
         .command(`migrateFeatureFlag <projectKey> <featureFlagKey> <fromEnv> <toEnv> (includeState)`)
         .description('migrate flag settings from one environment to another')
-        .action(function(projectKey, featureFlagKey, fromEnv, toEnv, includeState) {
+        .action((projectKey, featureFlagKey, fromEnv, toEnv, includeState) => {
             ldUtils.flags
                 .migrateFeatureFlag(projectKey, featureFlagKey, fromEnv, toEnv, includeState)
-                .then(function(response) {
+                .then(response => {
                     console.log(json.plain(response));
                 });
         });
 
     program
         .command(`bulkMigrateFeatureFlags <projectKey> <featureFlagKeys> <fromEnv> <toEnv> (includeState)`)
         .description('migrate multiple flag settings from one environment to another')
-        .action(function(projectKey, featureFlagKeys, fromEnv, toEnv, includeState) {
+        .action((projectKey, featureFlagKeys, fromEnv, toEnv, includeState) => {
             ldUtils.flags
                 .bulkMigrateFeatureFlags(projectKey, featureFlagKeys, fromEnv, toEnv, includeState)
-                .then(function(response) {
+                .then(response => {
                     console.log(json.plain(response));
                 });
         });
 
     program
         .command(`restoreFeatureFlags <projectKey> <featureFlagKeys> <targetEnv> <backupJsonFile> (includeState)`)
         .description('restore environment flag settings from a backup file - backup from getFeatureFlags')
-        .action(function(projectKey, featureFlagKeys, targetEnv, backupJsonFile, includeState) {
+        .action((projectKey, featureFlagKeys, targetEnv, backupJsonFile, includeState) => {
             ldUtils.flags
                 .restoreFeatureFlags(projectKey, featureFlagKeys, targetEnv, backupJsonFile, includeState)
-                .then(function(response) {
+                .then(response => {
                     console.log(json.plain(response));
                 });
         });
 
     program
         .command('getCustomRoles')
         .description('get all custom roles in account')
-        .action(function() {
-            ldUtils.roles.getCustomRoles().then(function(response) {
+        .action(() => {
+            ldUtils.roles.getCustomRoles().then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command('getCustomRole <customRoleKey>')
         .description('get custom role by key')
-        .action(function(customRoleKey) {
-            ldUtils.roles.getCustomRole(customRoleKey).then(function(response) {
+        .action(customRoleKey => {
+            ldUtils.roles.getCustomRole(customRoleKey).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command('getCustomRoleById <customRoleId>')
         .description('get custom role by id')
-        .action(function(customRoleId) {
-            ldUtils.roles.getCustomRoleById(customRoleId).then(function(response) {
+        .action(customRoleId => {
+            ldUtils.roles.getCustomRoleById(customRoleId).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command(`createCustomRole <customRoleKey> <customRoleName> <customRolePolicyArray> [customRoleDescription]`)
         .description('create custom role')
-        .action(function(customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription) {
+        .action((customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription) => {
             customRolePolicyArray = JSON.parse(customRolePolicyArray);
             ldUtils.roles
                 .createCustomRole(customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription)
-                .then(function(response) {
+                .then(response => {
                     console.log(json.plain(response));
                 });
         });
 
     program
         .command(`updateCustomRole <customRoleKey> <customRoleName> <customRolePolicyArray> [customRoleDescription]`)
         .description('update custom role')
-        .action(function(customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription) {
+        .action((customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription) => {
             customRolePolicyArray = JSON.parse(customRolePolicyArray);
             ldUtils.roles
                 .updateCustomRole(customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription)
-                .then(function(response) {
+                .then(response => {
                     console.log(json.plain(response));
                 });
         });
 
     program
         .command(`upsertCustomRole <customRoleKey> <customRoleName> <customRolePolicyArray> [customRoleDescription]`)
         .description('create or update custom role')
-        .action(function(customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription) {
+        .action((customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription) => {
             customRolePolicyArray = JSON.parse(customRolePolicyArray);
             ldUtils.roles
                 .upsertCustomRole(customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription)
-                .then(function(response) {
+                .then(response => {
                     console.log(json.plain(response));
                 });
         });
 
     program
         .command('bulkUpsertCustomRoles <roleBulkLoadFile>')
         .description('path to a file containing array of role json')
-        .action(function(roleBulkLoadFile) {
-            ldUtils.roles.bulkUpsertCustomRoles(roleBulkLoadFile).then(function(response) {
+        .action(roleBulkLoadFile => {
+            ldUtils.roles.bulkUpsertCustomRoles(roleBulkLoadFile).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command('bulkUpsertCustomRoleFolder <roleFolder>')
         .description('path to a directory containing multiple files of role json')
-        .action(function(roleFolder) {
-            ldUtils.roles.bulkUpsertCustomRoleFolder(roleFolder).then(function(response) {
+        .action(roleFolder => {
+            ldUtils.roles.bulkUpsertCustomRoleFolder(roleFolder).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command('inviteTeamMember <emailAddress> <initialRoleName>')
         .description('Invite a New Team Member')
-        .action(function(emailAddress, initialRoleName) {
-            ldUtils.members.inviteTeamMember(emailAddress, initialRoleName).then(function(response) {
+        .action((emailAddress, initialRoleName) => {
+            ldUtils.members.inviteTeamMember(emailAddress, initialRoleName).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
-        .command('getTeamMembers')
+        .command('getTeamMembers [limit] [offset] [filter]')
         .description('list all team members in account')
-        .action(function() {
-            ldUtils.members.getTeamMembers().then(function(response) {
+        .action((limit, offset, filter) => {
+            ldUtils.members.getTeamMembers(limit, offset, filter).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command('getTeamMember <memberId>')
         .description('get a team member by id')
-        .action(function(memberId) {
-            ldUtils.members.getTeamMember(memberId).then(function(response) {
+        .action(memberId => {
+            ldUtils.members.getTeamMember(memberId).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command('getTeamMemberByEmail <emailAddress>')
         .description('get a team member by email address')
-        .action(function(emailAddress) {
-            ldUtils.members.getTeamMemberByEmail(emailAddress).then(function(response) {
+        .action(emailAddress => {
+            ldUtils.members.getTeamMemberByEmail(emailAddress).then(response => {
                 console.log(json.plain(response));
             });
         });
 
     program
         .command('getTeamMemberCustomRoles <emailAddress>')
         .description('get a team members custom roles by email address')
-        .action(function(emailAddress) {
-            ldUtils.members.getTeamMemberCustomRoles(emailAddress).then(function(response) {
+        .action(emailAddress => {
+            ldUtils.members.getTeamMemberCustomRoles(emailAddress).then(response => {
                 console.log(json.plain(response));
             });
         });
 
-    program.on('--help', function() {
+    program.on('--help', () => {
         console.log('\n  See https://github.com/zotoio/launchdarkly-nodeutils/API.md for examples.\n');
     });