Merge pull request #121 from zotoio/feat/openapi

feat(codegen): switch from swagger.yaml to openapi.json

Author: wyvern8

.travis.yml

@@ -5,16 +5,13 @@ cache:
 notifications:
   email: false
 node_js:
-  - '12'
-before_install: npm install -g greenkeeper-lockfile@1 yarn
+  - '14'
 before_script:
-  - greenkeeper-lockfile-update
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
 install: yarn
 after_script:
-  - greenkeeper-lockfile-upload
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 after_success:
   - yarn semantic-release

API.md

@@ -23,7 +23,7 @@
 **Kind**: global class  
 <a name="LaunchDarklyApiClient.create"></a>
 
-### LaunchDarklyApiClient.create(API_TOKEN, log, swaggerYamlString) ⇒ <code>Promise</code>
+### LaunchDarklyApiClient.create(API_TOKEN, log, openapiJsonString) ⇒ <code>Promise</code>
 Used internally by LaunchDarklyUtils to create an instance of
 Swagger apiClient with interceptors configured
 
@@ -35,7 +35,7 @@ Swagger apiClient with interceptors configured
 | --- | --- | --- |
 | API_TOKEN | <code>string</code> | from LaunchDarkly dashboard |
 | log | <code>Object</code> | logger implementation |
-| swaggerYamlString | <code>string</code> | optional serialized yaml |
+| openapiJsonString | <code>string</code> | optional serialized json |
 
 <a name="LaunchDarklyLogger"></a>
 
@@ -78,7 +78,7 @@ as api grouping util classes are attached to this class.
     * [.getFeatureFlags(projectKey)](#LaunchDarklyUtilsFlags+getFeatureFlags) ⇒ <code>Promise</code>
     * [.getFeatureFlag(projectKey, featureFlagKey, environmentKeyQuery)](#LaunchDarklyUtilsFlags+getFeatureFlag) ⇒ <code>Promise</code>
     * [.getFeatureFlagState(projectKey, featureFlagKey, environmentKeyQuery)](#LaunchDarklyUtilsFlags+getFeatureFlagState) ⇒ <code>Promise</code>
-    * [.updateFeatureFlag(projectKey, featureFlagKey, patchComment)](#LaunchDarklyUtilsFlags+updateFeatureFlag) ⇒ <code>Promise</code>
+    * [.updateFeatureFlag(projectKey, featureFlagKey, patch)](#LaunchDarklyUtilsFlags+updateFeatureFlag) ⇒ <code>Promise</code>
     * [.toggleFeatureFlag(projectKey, featureFlagKey, environmentKeyQuery, value)](#LaunchDarklyUtilsFlags+toggleFeatureFlag) ⇒ <code>Promise</code>
     * [.migrateFeatureFlag(projectKey, featureFlagKey, fromEnv, toEnv, includeState)](#LaunchDarklyUtilsFlags+migrateFeatureFlag) ⇒ <code>Promise</code>
     * [.bulkMigrateFeatureFlags(projectKey, featureFlagKeys, fromEnv, toEnv, includeState)](#LaunchDarklyUtilsFlags+bulkMigrateFeatureFlags) ⇒ <code>Promise</code>
@@ -160,7 +160,7 @@ ldutils getFeatureFlagState my-project my-flag dev
 ```
 <a name="LaunchDarklyUtilsFlags+updateFeatureFlag"></a>
 
-### launchDarklyUtilsFlags.updateFeatureFlag(projectKey, featureFlagKey, patchComment) ⇒ <code>Promise</code>
+### launchDarklyUtilsFlags.updateFeatureFlag(projectKey, featureFlagKey, patch) ⇒ <code>Promise</code>
 patch a feature flag by key
 
 **Kind**: instance method of [<code>LaunchDarklyUtilsFlags</code>](#LaunchDarklyUtilsFlags)  
@@ -171,7 +171,7 @@ patch a feature flag by key
 | --- | --- | --- |
 | projectKey | <code>string</code> | project identifier |
 | featureFlagKey | <code>string</code> | feature flag identifier |
-| patchComment | <code>Array.&lt;Object&gt;</code> | array of valid json patch descriptors |
+| patch | <code>Array.&lt;Object&gt;</code> | array of valid json patch descriptors |
 
 **Example**  
 ```js

openapi.json

@@ -7,7 +7,7 @@
     "ldutils": "./ldutils"
   },
   "scripts": {
-    "build": "yarn lint && rimraf dist/ && babel ./src --out-dir dist/src --copy-files && babel ./test --out-dir dist/test --copy-files && babel ./*.js --out-dir dist/ --copy-files && cp swagger.yaml dist/",
+    "build": "yarn lint && rimraf dist/ && babel ./src --out-dir dist/src --copy-files && babel ./test --out-dir dist/test --copy-files && babel ./*.js --out-dir dist/ --copy-files && cp openapi.json dist/",
     "commit": "./node_modules/.bin/git-cz",
     "lint": "prettier --write ./src/** *.js ldutils && node ./node_modules/.bin/eslint ./src ./test --fix --ext=.js --ignore-pattern node_modules/ --ignore-pattern coverage/ --quiet",
     "test": "yarn build && cross-env NODE_ENV=test nyc ./node_modules/.bin/mocha --timeout 10000 --require @babel/register --require @babel/polyfill './dist/test/**/*.spec.js' && yarn jsdoc2markdown",
@@ -34,19 +34,19 @@
     "app-root-path": "^3.0.0",
     "bunyan": "^1.8.12",
     "bunyan-format": "^0.2.1",
+    "commander": "^6.1.0",
     "dotenv": "^8.2.0",
-    "fast-json-patch": "^3.0.0-1",
+    "fast-json-patch": "^3.1.1",
     "format-json": "^1.0.3",
     "globule": "^1.2.1",
     "https-proxy-agent": "^5.0.0",
-    "commander": "^6.1.0",
     "js-yaml": "^3.13.1",
     "json-diff": "^0.5.4",
     "json-format": "^1.0.1",
     "lodash": "^4.17.21",
-    "node-fetch": "^2.6.0",
-    "swagger-client": "^3.9.6",
-    "webpack": "^4.41.2"
+    "node-fetch": "2.6.7",
+    "swagger-client": "^3.18.5",
+    "webpack": "^5.0.0"
   },
   "engines": {
     "node": ">=10.0.0"
@@ -96,6 +96,7 @@
     "supertest": "^4.0.2"
   },
   "resolutions": {
-    "lodash": "4.17.20"
+    "lodash": "4.17.20",
+    "browserslist": "^4.21.4"
   }
 }

package.json

@@ -1,5 +1,4 @@
 import Swagger from 'swagger-client';
-import jsYaml from 'js-yaml';
 import { default as fs } from 'fs';
 import { default as json } from 'format-json';
 import { default as HttpsProxyAgent } from 'https-proxy-agent';
@@ -14,12 +13,12 @@ export class LaunchDarklyApiClient {
      * Swagger apiClient with interceptors configured
      * @param {string} API_TOKEN - from LaunchDarkly dashboard
      * @param { Object } log - logger implementation
-     * @param { string } swaggerYamlString - optional serialized yaml
+     * @param { string } openapiJsonString - optional serialized json
      * @returns {Promise}
      * @fulfil {Swagger} apiClient generated by swagger-js
      * @reject {Error} object with message
      */
-    static async create(API_TOKEN, log, swaggerYamlString) {
+    static async create(API_TOKEN, log, openapiJsonString) {
         log.debug(`creating api client with token: ${API_TOKEN}`);
 
         let proxy = process.env.http_proxy || process.env.https_proxy || null;
@@ -29,13 +28,13 @@ export class LaunchDarklyApiClient {
             log.debug(`using proxy from env var https_proxy=${proxy}`);
         }
 
-        // swagger.yaml from https://launchdarkly.github.io/ld-openapi/swagger.yaml
-        const swaggerYaml = swaggerYamlString || fs.readFileSync(__dirname + `/../swagger.yaml`, 'utf-8').toString();
-        const swaggerJson = jsYaml.safeLoad(swaggerYaml);
+        // openapi.json from https://static.launchdarkly.com/app/s/openapi.52aa3dc63.json
+        const openapiJson = openapiJsonString || fs.readFileSync(__dirname + `/../openapi.json`, 'utf-8').toString();
 
         return Swagger({
-            spec: swaggerJson,
+            spec: JSON.parse(openapiJson),
             usePromise: true,
+            requestContentType: 'application/json',
             requestInterceptor: req => {
                 req.userFetch = fetch;
                 req.agent = agent;

src/LaunchDarklyApiClient.js

@@ -49,7 +49,7 @@ export class LaunchDarklyUtilsFlags {
             throw {
                 api: 'getFeatureFlags',
                 message: e.message,
-                docs: 'https://apidocs.launchdarkly.com/docs/list-feature-flags'
+                docs: 'https://apidocs.launchdarkly.com/tag/Feature-flags#operation/getFeatureFlags'
             };
         }
     }
@@ -79,7 +79,7 @@ export class LaunchDarklyUtilsFlags {
             throw {
                 api: 'getFeatureFlag',
                 message: e.message,
-                docs: 'https://apidocs.launchdarkly.com/docs/get-feature-flag'
+                docs: 'https://apidocs.launchdarkly.com/tag/Feature-flags#operation/getFeatureFlag'
             };
         }
     }
@@ -104,28 +104,32 @@ export class LaunchDarklyUtilsFlags {
      * patch a feature flag by key
      * @param {string} projectKey - project identifier
      * @param {string} featureFlagKey - feature flag identifier
-     * @param {Array<Object>} patchComment - array of valid json patch descriptors
+     * @param {Array<Object>} patch - array of valid json patch descriptors
      * @returns {Promise}
      * @fulfil {Object} updated feature flag json
      * @reject {Error} object with message
      * @example ldutils updateFeatureFlag my-project my-flag {jsonPatch}
      */
-    async updateFeatureFlag(projectKey, featureFlagKey, patchComment) {
+    async updateFeatureFlag(projectKey, featureFlagKey, patch) {
         try {
             return this.apiClient.apis[this.API_GROUP]
-                .patchFeatureFlag({
-                    projectKey: projectKey,
-                    featureFlagKey: featureFlagKey,
-                    patchComment: patchComment
-                })
+                .patchFeatureFlag(
+                    {
+                        projectKey: projectKey,
+                        featureFlagKey: featureFlagKey
+                    },
+                    {
+                        requestBody: patch
+                    }
+                )
                 .then(response => {
                     return response.body;
                 });
         } catch (e) {
             throw {
                 api: 'patchFeatureFlag',
                 message: e.message,
-                docs: 'https://apidocs.launchdarkly.com/docs/update-feature-flag'
+                docs: 'https://apidocs.launchdarkly.com/tag/Feature-flags#operation/patchFeatureFlag'
             };
         }
     }
@@ -170,15 +174,15 @@ export class LaunchDarklyUtilsFlags {
                 return patchDelta;
             })
             .then(patchDelta => {
-                let patchComment = this.assembleFlagPatch(patchDelta, toEnv, includeState);
+                let patch = this.assembleFlagPatch(patchDelta, toEnv, includeState);
 
-                that.log.debug(`patchComment for '${featureFlagKey}' in ${toEnv} : ${json.plain(patchComment)}`);
-                return this.updateFeatureFlag(projectKey, featureFlagKey, patchComment);
+                that.log.debug(`patch for '${featureFlagKey}' in ${toEnv} : ${json.plain(patch)}`);
+                return this.updateFeatureFlag(projectKey, featureFlagKey, patch);
             });
     }
 
     assembleFlagPatch(patchDelta, targetEnv, includeState) {
-        let patchComment = [];
+        let patches = [];
         patchDelta.forEach(patch => {
             if (
                 patch.path.startsWith('/targets') ||
@@ -190,10 +194,10 @@ export class LaunchDarklyUtilsFlags {
             ) {
                 // add target env obj path and push
                 patch.path = `/environments/${targetEnv}${patch.path}`;
-                patchComment.push(patch);
+                patches.push(patch);
             }
         });
-        return patchComment;
+        return patches;
     }
 
     /**
@@ -256,10 +260,10 @@ export class LaunchDarklyUtilsFlags {
                         return patchDelta;
                     })
                     .then(patchDelta => {
-                        let patchComment = this.assembleFlagPatch(patchDelta, targetEnv, includeState);
+                        let patch = this.assembleFlagPatch(patchDelta, targetEnv, includeState);
 
-                        that.log.debug(`patchComment for '${key}' in ${targetEnv} : ${json.plain(patchComment)}`);
-                        return this.updateFeatureFlag(projectKey, key, patchComment);
+                        that.log.debug(`patch for '${key}' in ${targetEnv} : ${json.plain(patch)}`);
+                        return this.updateFeatureFlag(projectKey, key, patch);
                     })
             );
         });

src/LaunchDarklyUtilsFlags.js

@@ -26,7 +26,7 @@ export class LaunchDarklyUtilsMembers {
      * @returns {string}
      */
     get API_GROUP() {
-        return 'Team members';
+        return 'Account members';
     }
 
     /**
@@ -50,7 +50,7 @@ export class LaunchDarklyUtilsMembers {
             throw {
                 api: 'getMembers',
                 message: e.message,
-                docs: 'https://apidocs.launchdarkly.com/docs/list-team-members'
+                docs: 'https://apidocs.launchdarkly.com/tag/Account-members#operation/getMembers'
             };
         }
     }
@@ -65,14 +65,14 @@ export class LaunchDarklyUtilsMembers {
      */
     async getTeamMember(memberId) {
         try {
-            return this.apiClient.apis[this.API_GROUP].getMember({ memberId: memberId }).then(response => {
+            return this.apiClient.apis[this.API_GROUP].getMember({ id: memberId }).then(response => {
                 return response.body;
             });
         } catch (e) {
             throw {
                 api: 'getMember',
                 message: e.message,
-                docs: 'https://apidocs.launchdarkly.com/docs/get-team-member'
+                docs: 'https://apidocs.launchdarkly.com/tag/Account-members#operation/getMember'
             };
         }
     }
@@ -93,7 +93,7 @@ export class LaunchDarklyUtilsMembers {
                 throw {
                     api: 'getTeamMembers',
                     message: `member not found for email ${emailAddress}`,
-                    docs: 'https://apidocs.launchdarkly.com/docs/list-team-members'
+                    docs: 'https://apidocs.launchdarkly.com/tag/Account-members#operation/getMembers'
                 };
             }
 
@@ -120,7 +120,7 @@ export class LaunchDarklyUtilsMembers {
                     throw {
                         api: 'getTeamMemberCustomRoles',
                         message: `role not found for _id ${memberRoleId}`,
-                        docs: 'https://apidocs.launchdarkly.com/docs/list-team-members'
+                        docs: 'https://apidocs.launchdarkly.com/tag/Account-members#operation/getMembers'
                     };
                 }
             });
@@ -145,14 +145,14 @@ export class LaunchDarklyUtilsMembers {
         !defaultRoles.includes(initialRoleKey) ? (user.customRoles = [initialRoleKey]) : (user.role = initialRoleKey);
         members.membersBody.push(user);
         try {
-            return this.apiClient.apis[this.API_GROUP].postMembers(members).then(response => {
+            return this.apiClient.apis[this.API_GROUP].postMembers({}, { requestBody: members }).then(response => {
                 return response.body;
             });
         } catch (e) {
             throw {
                 api: 'postMembers',
                 message: e.message,
-                docs: 'https://apidocs.launchdarkly.com/docs/create-team-members-1'
+                docs: 'https://apidocs.launchdarkly.com/tag/Account-members#operation/postMembers'
             };
         }
     }

src/LaunchDarklyUtilsMembers.js

@@ -45,7 +45,7 @@ export class LaunchDarklyUtilsProjects {
                 throw {
                     api: 'getProjects',
                     message: e.message,
-                    docs: 'https://apidocs.launchdarkly.com/reference#list-projects'
+                    docs: 'https://apidocs.launchdarkly.com/tag/Projects#operation/getProjects'
                 };
             });
     }
@@ -68,7 +68,7 @@ export class LaunchDarklyUtilsProjects {
                 throw {
                     api: 'getProject',
                     message: e.message,
-                    docs: 'https://apidocs.launchdarkly.com/reference#get-project'
+                    docs: 'https://apidocs.launchdarkly.com/tag/Projects#operation/getProjects'
                 };
             });
     }
@@ -132,15 +132,15 @@ export class LaunchDarklyUtilsProjects {
             defaultClientSideAvailability
         };
         return this.apiClient.apis[this.API_GROUP]
-            .postProject({ projectBody: newProject })
+            .postProject({}, { requestBody: newProject })
             .then(response => {
                 return response.body;
             })
             .catch(e => {
                 throw {
                     api: 'createProject',
                     message: e.message,
-                    docs: 'https://apidocs.launchdarkly.com/reference#create-project'
+                    docs: 'https://apidocs.launchdarkly.com/tag/Projects#operation/postProject'
                 };
             });
     }
@@ -156,15 +156,15 @@ export class LaunchDarklyUtilsProjects {
      */
     async updateProject(projectKey, jsonPatch) {
         return this.apiClient.apis[this.API_GROUP]
-            .patchProject({ projectKey: projectKey, patchDelta: jsonPatch })
+            .patchProject({ projectKey: projectKey }, { requestBody: jsonPatch })
             .then(response => {
                 return response.body;
             })
             .catch(e => {
                 throw {
                     api: 'patchProject',
                     message: e.message,
-                    docs: 'https://apidocs.launchdarkly.com/reference#update-project'
+                    docs: 'https://apidocs.launchdarkly.com/tag/Projects#operation/patchProject'
                 };
             });
     }
@@ -186,7 +186,7 @@ export class LaunchDarklyUtilsProjects {
                 throw {
                     api: 'deleteProject',
                     message: e.message,
-                    docs: 'https://apidocs.launchdarkly.com/reference#delete-project'
+                    docs: 'https://apidocs.launchdarkly.com/tag/Projects#operation/deleteProject'
                 };
             });
     }