@readme/oas-to-har 14.0.0 → 14.0.4

package/.github/workflows/ci.yml

@@ -10,16 +10,13 @@ jobs:
         node-version: [12.x, 14.x, 16.x]
 
     steps:
-      - uses: actions/checkout@v2.3.5
+      - uses: actions/checkout@v2.4.0
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.4.1
+        uses: actions/setup-node@v2.5.0
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Install npm@7
-        run: npm install -g npm@7
-
       - name: Install deps
         run: npm ci
 

package/.github/workflows/codeql-analysis.yml

@@ -24,7 +24,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2.3.5
+      uses: actions/checkout@v2.4.0
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+## <small>14.0.4 (2021-12-16)</small>
+
+* fix: issue where we'd try to stylize iterate over a nullilsh value (#42) ([5baa462](https://github.com/readmeio/oas-to-har/commit/5baa462)), closes [#42](https://github.com/readmeio/oas-to-har/issues/42)
+
+
+
+## <small>14.0.3 (2021-12-16)</small>
+
+* fix: cleaning up engine requirements and updating dev deps (#40) ([c377906](https://github.com/readmeio/oas-to-har/commit/c377906)), closes [#40](https://github.com/readmeio/oas-to-har/issues/40)
+* test: overhauling the test suite to make it easier to maintain (#41) ([e04944d](https://github.com/readmeio/oas-to-har/commit/e04944d)), closes [#41](https://github.com/readmeio/oas-to-har/issues/41)
+
+
+
+## <small>14.0.2 (2021-12-01)</small>
+
+* chore(deps-dev): bump @commitlint/cli from 14.1.0 to 15.0.0 (#33) ([64cf308](https://github.com/readmeio/oas-to-har/commit/64cf308)), closes [#33](https://github.com/readmeio/oas-to-har/issues/33)
+* chore(deps-dev): bump @commitlint/config-conventional (#37) ([7e76ecd](https://github.com/readmeio/oas-to-har/commit/7e76ecd)), closes [#37](https://github.com/readmeio/oas-to-har/issues/37)
+* chore(deps-dev): bump eslint from 8.2.0 to 8.3.0 (#38) ([b6c0fa2](https://github.com/readmeio/oas-to-har/commit/b6c0fa2)), closes [#38](https://github.com/readmeio/oas-to-har/issues/38)
+* chore(deps-dev): bump jest from 27.3.1 to 27.4.3 (#35) ([f20606b](https://github.com/readmeio/oas-to-har/commit/f20606b)), closes [#35](https://github.com/readmeio/oas-to-har/issues/35)
+* chore(deps-dev): bump prettier from 2.4.1 to 2.5.0 (#39) ([8f63cc6](https://github.com/readmeio/oas-to-har/commit/8f63cc6)), closes [#39](https://github.com/readmeio/oas-to-har/issues/39)
+* chore(deps): bump @readme/oas-extensions from 14.0.0 to 14.0.1 (#34) ([d110b9e](https://github.com/readmeio/oas-to-har/commit/d110b9e)), closes [#34](https://github.com/readmeio/oas-to-har/issues/34)
+* chore(deps): bump actions/checkout from 2.3.5 to 2.4.0 (#32) ([0937308](https://github.com/readmeio/oas-to-har/commit/0937308)), closes [#32](https://github.com/readmeio/oas-to-har/issues/32)
+* chore(deps): bump actions/setup-node from 2.4.1 to 2.5.0 (#31) ([fae7aed](https://github.com/readmeio/oas-to-har/commit/fae7aed)), closes [#31](https://github.com/readmeio/oas-to-har/issues/31)
+* chore(deps): bump oas from 17.1.0 to 17.1.6 (#36) ([0d2f7ff](https://github.com/readmeio/oas-to-har/commit/0d2f7ff)), closes [#36](https://github.com/readmeio/oas-to-har/issues/36)
+
+
+
+## <small>14.0.1 (2021-11-29)</small>
+
+* fix: bug where nested object formData would be improperly converted as a string (#30) ([4f993a6](https://github.com/readmeio/oas-to-har/commit/4f993a6)), closes [#30](https://github.com/readmeio/oas-to-har/issues/30)
+* chore(deps-dev): upgrading eslint to v8 ([09f4b27](https://github.com/readmeio/oas-to-har/commit/09f4b27))
+
+
+
 ## 14.0.0 (2021-11-08)
 
 * feat: upgrading oas to v17 (#29) ([c223f7a](https://github.com/readmeio/oas-to-har/commit/c223f7a)), closes [#29](https://github.com/readmeio/oas-to-har/issues/29)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@readme/oas-to-har",
   "description": "Utility to transform an OAS operation into a HAR representation",
-  "version": "14.0.0",
+  "version": "14.0.4",
   "main": "src/index.js",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
   "license": "ISC",
@@ -10,8 +10,7 @@
     "url": "git://github.com/readmeio/oas-to-har.git"
   },
   "engines": {
-    "node": "^12 || ^14 || ^16",
-    "npm": "^7"
+    "node": "^12 || ^14 || ^16"
   },
   "scripts": {
     "lint": "eslint .",
@@ -22,21 +21,21 @@
     "test": "jest --coverage"
   },
   "dependencies": {
-    "@readme/oas-extensions": "^14.0.0",
-    "oas": "^17.1.0",
+    "@readme/oas-extensions": "^14.0.3",
+    "oas": "^17.3.2",
     "parse-data-url": "^4.0.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^14.1.0",
-    "@commitlint/config-conventional": "^14.1.0",
-    "@readme/eslint-config": "^7.2.2",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
+    "@readme/eslint-config": "^8.0.4",
     "@readme/oas-examples": "^4.3.2",
     "datauri": "^4.1.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.4.1",
     "husky": "^7.0.4",
-    "jest": "^27.3.1",
-    "jest-expect-har": "^3.0.0",
-    "prettier": "^2.4.1"
+    "jest": "^27.4.5",
+    "jest-expect-har": "^3.0.1",
+    "prettier": "^2.5.1"
   },
   "prettier": "@readme/eslint-config/prettier",
   "commitlint": {

package/src/index.js

@@ -65,6 +65,16 @@ function stringify(json) {
   return JSON.stringify(removeUndefinedObjects(typeof json.RAW_BODY !== 'undefined' ? json.RAW_BODY : json));
 }
 
+function stringifyParameter(param) {
+  if (param === null || isPrimitive(param)) {
+    return param;
+  } else if (Array.isArray(param) && param.every(isPrimitive)) {
+    return String(param);
+  }
+
+  return JSON.stringify(param);
+}
+
 function appendHarValue(harParam, name, value) {
   if (typeof value === 'undefined') return;
 
@@ -220,7 +230,7 @@ module.exports = (
     });
   }
 
-  // Are there `x-static` static headers configured for this OAS?
+  // Are there `x-headers` static headers configured for this OAS?
   const userDefinedHeaders = extensions.getExtension(extensions.HEADERS, oas, operation);
   if (userDefinedHeaders) {
     userDefinedHeaders.forEach(header => {
@@ -262,7 +272,7 @@ module.exports = (
           Object.keys(cleanFormData).forEach(name => {
             har.postData.params.push({
               name,
-              value: String(cleanFormData[name]),
+              value: stringifyParameter(cleanFormData[name]),
             });
           });
         }
@@ -354,6 +364,7 @@ module.exports = (
                     }
                   });
 
+                  // `RAW_BODY` is a ReadMe-specific thing where we'll interpret its contents as raw JSON.
                   if (typeof cleanBody.RAW_BODY !== 'undefined') {
                     cleanBody = cleanBody.RAW_BODY;
                   }

package/src/lib/configure-security.js

@@ -25,7 +25,6 @@ module.exports = function configureSecurity(apiDefinition, values, scheme) {
 
       return harValue('headers', {
         name: 'Authorization',
-        // eslint-disable-next-line sonarjs/no-nested-template-literals
         value: `Basic ${Buffer.from(`${user}:${pass}`).toString('base64')}`,
       });
     } else if (security.scheme === 'bearer') {

package/src/lib/style-formatting/index.js

@@ -114,7 +114,7 @@ function handleExplode(value, parameter) {
     });
   }
 
-  if (typeof value === 'object') {
+  if (typeof value === 'object' && value !== null) {
     const newObj = {};
 
     Object.keys(value).forEach(key => {

package/src/lib/style-formatting/style-serializer.js

@@ -1,8 +1,5 @@
-/* eslint-disable sonarjs/no-extra-arguments */
 /* eslint-disable no-use-before-define */
-/* eslint-disable sonarjs/prefer-immediate-return */
 /* eslint-disable no-param-reassign */
-/* eslint-disable sonarjs/no-identical-functions */
 
 /**
  * This file has been extracted and modified from `swagger-client`.
@@ -39,7 +36,7 @@ module.exports = function stylize(config) {
 
 module.exports.encodeDisallowedCharacters = function encodeDisallowedCharacters(
   str,
-  { escape, returnIfEncoded = false } = {},
+  { escape, returnIfEncoded = false } = {}, // eslint-disable-line default-param-last
   parse
 ) {
   if (typeof str === 'number') {