@readme/oas-to-har 19.1.0 → 20.0.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 20.0.0 (2022-10-28)
+
+* chore: bumping oas to v20 (#132) ([1477086](https://github.com/readmeio/oas-to-har/commit/1477086)), closes [#132](https://github.com/readmeio/oas-to-har/issues/132)
+* ci: running tests on node 19 ([cdb8df9](https://github.com/readmeio/oas-to-har/commit/cdb8df9))
+
+
+
+## 19.2.0 (2022-10-25)
+
+* feat: ability to manuall specify an `authorization` header in formData (#131) ([9623d38](https://github.com/readmeio/oas-to-har/commit/9623d38)), closes [#131](https://github.com/readmeio/oas-to-har/issues/131)
+
+
+
 ## 19.1.0 (2022-10-17)
 
 * fix: preferring JSON response content accept headers over everything else (#130) ([41fdd11](https://github.com/readmeio/oas-to-har/commit/41fdd11)), closes [#130](https://github.com/readmeio/oas-to-har/issues/130)

package/dist/index.js

@@ -339,8 +339,8 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
             });
         });
     }
-    // Do we have an `accept` header set up in the form, but it hasn't been added yet?
     if (formData.header) {
+        // Do we have an `accept` header set up in the form data, but it hasn't been added yet?
         var acceptHeader = Object.keys(formData.header).find(function (h) { return h.toLowerCase() === 'accept'; });
         if (acceptHeader && !har.headers.find(function (hdr) { return hdr.name.toLowerCase() === 'accept'; })) {
             har.headers.push({
@@ -348,6 +348,14 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
                 value: String(formData.header[acceptHeader])
             });
         }
+        // Do we have a manually-defined `authorization` header set up in the form data?
+        var authorizationHeader = Object.keys(formData.header).find(function (h) { return h.toLowerCase() === 'authorization'; });
+        if (authorizationHeader && !har.headers.find(function (hdr) { return hdr.name.toLowerCase() === 'authorization'; })) {
+            har.headers.push({
+                name: 'authorization',
+                value: String(formData.header[authorizationHeader])
+            });
+        }
     }
     var requestBody;
     if (operation.hasRequestBody()) {
@@ -519,7 +527,14 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
                 if (!securityValue) {
                     return;
                 }
-                // If we've already added this security value then don't add it again.
+                // If this is an `authorization` header and we've already added one (maybe one was manually
+                // specified), then we shouldn't add another.
+                if (securityValue.value.name === 'authorization') {
+                    if (har[securityValue.type].find(function (v) { return v.name === securityValue.value.name; })) {
+                        return;
+                    }
+                }
+                // If we've already added this **specific** security value then don't add it again.
                 if (har[securityValue.type].find(function (v) { return v.name === securityValue.value.name && v.value === securityValue.value.value; })) {
                     return;
                 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@readme/oas-to-har",
   "description": "Utility to transform an OAS operation into a HAR representation",
-  "version": "19.1.0",
+  "version": "20.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
@@ -29,8 +29,8 @@
   },
   "dependencies": {
     "@readme/data-urls": "^1.0.1",
-    "@readme/oas-extensions": "^16.0.0",
-    "oas": "^19.0.0",
+    "@readme/oas-extensions": "^17.0.0",
+    "oas": "^20.0.0",
     "qs": "^6.10.5",
     "remove-undefined-objects": "^2.0.0"
   },
@@ -40,16 +40,16 @@
     "@jsdevtools/host-environment": "^2.1.2",
     "@jsdevtools/karma-config": "^3.1.7",
     "@readme/eslint-config": "^10.1.1",
-    "@readme/oas-examples": "^5.6.0",
+    "@readme/oas-examples": "^5.7.1",
     "@types/chai": "^4.3.1",
     "@types/har-format": "^1.2.8",
     "@types/mocha": "^10.0.0",
     "@types/qs": "^6.9.7",
     "chai": "^4.3.6",
-    "eslint": "^8.25.0",
+    "eslint": "^8.26.0",
     "har-validator": "^5.1.5",
     "husky": "^8.0.1",
-    "mocha": "^10.0.0",
+    "mocha": "^10.1.0",
     "nyc": "^15.1.0",
     "prettier": "^2.7.0",
     "ts-loader": "^8.4.0",

package/src/index.ts

@@ -392,8 +392,8 @@ export default function oasToHar(
     });
   }
 
-  // Do we have an `accept` header set up in the form, but it hasn't been added yet?
   if (formData.header) {
+    // Do we have an `accept` header set up in the form data, but it hasn't been added yet?
     const acceptHeader = Object.keys(formData.header).find(h => h.toLowerCase() === 'accept');
     if (acceptHeader && !har.headers.find(hdr => hdr.name.toLowerCase() === 'accept')) {
       har.headers.push({
@@ -401,6 +401,15 @@ export default function oasToHar(
         value: String(formData.header[acceptHeader]),
       });
     }
+
+    // Do we have a manually-defined `authorization` header set up in the form data?
+    const authorizationHeader = Object.keys(formData.header).find(h => h.toLowerCase() === 'authorization');
+    if (authorizationHeader && !har.headers.find(hdr => hdr.name.toLowerCase() === 'authorization')) {
+      har.headers.push({
+        name: 'authorization',
+        value: String(formData.header[authorizationHeader]),
+      });
+    }
   }
 
   let requestBody: MediaTypeObject;
@@ -594,7 +603,15 @@ export default function oasToHar(
           return;
         }
 
-        // If we've already added this security value then don't add it again.
+        // If this is an `authorization` header and we've already added one (maybe one was manually
+        // specified), then we shouldn't add another.
+        if (securityValue.value.name === 'authorization') {
+          if (har[securityValue.type].find(v => v.name === securityValue.value.name)) {
+            return;
+          }
+        }
+
+        // If we've already added this **specific** security value then don't add it again.
         if (
           har[securityValue.type].find(
             v => v.name === securityValue.value.name && v.value === securityValue.value.value