@readme/oas-to-har 17.0.8 → 17.1.2

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## <small>17.1.2 (2022-07-27)</small>
+
+* fix: issue with filenames in data URLs not retaining their casing ([e8a7edb](https://github.com/readmeio/oas-to-har/commit/e8a7edb))
+
+
+
+## <small>17.1.1 (2022-07-27)</small>
+
+* fix: support for filenames that have underscores in them (#110) ([98a3972](https://github.com/readmeio/oas-to-har/commit/98a3972)), closes [#110](https://github.com/readmeio/oas-to-har/issues/110)
+
+
+
+## 17.1.0 (2022-07-26)
+
+* docs: fixing weird code formatting in the readme ([85e80a8](https://github.com/readmeio/oas-to-har/commit/85e80a8))
+* chore(deps): bump terser from 4.8.0 to 4.8.1 (#108) ([b0ffb8e](https://github.com/readmeio/oas-to-har/commit/b0ffb8e)), closes [#108](https://github.com/readmeio/oas-to-har/issues/108)
+* chore(deps): bumping out of date deps ([c667505](https://github.com/readmeio/oas-to-har/commit/c667505))
+* fix: keep arrays of binary files as separate params in postData (#109) ([545c0eb](https://github.com/readmeio/oas-to-har/commit/545c0eb)), closes [#109](https://github.com/readmeio/oas-to-har/issues/109)
+
+
+
 ## <small>17.0.8 (2022-07-07)</small>
 
 * fix: weird mess with instanceof checks not always working (#107) ([80c965e](https://github.com/readmeio/oas-to-har/commit/80c965e)), closes [#107](https://github.com/readmeio/oas-to-har/issues/107)

package/README.md

@@ -26,18 +26,18 @@ console.log(oasToHar(spec, spec.operation('/pets', 'post')));
 
 ```json
 {
-  log: {
-    entries: [
+  "log": {
+    "entries": [
       {
-        request: {
-          cookies: [],
-          headers: [],
-          headersSize: 0,
-          queryString: [],
-          bodySize: 0,
-          method: 'POST',
-          url: 'http://petstore.swagger.io/v2/pets',
-          httpVersion: 'HTTP/1.1'
+        "request": {
+          "cookies": [],
+          "headers": [],
+          "headersSize": 0,
+          "queryString": [],
+          "bodySize": 0,
+          "method": "POST",
+          "url": "http://petstore.swagger.io/v2/pets",
+          "httpVersion": "HTTP/1.1"
         }
       }
     ]
@@ -47,9 +47,9 @@ console.log(oasToHar(spec, spec.operation('/pets', 'post')));
 
 ### `oasToHar(oas, operationSchema, values, auth, opts) => Object`
 
-- `oas` *{Oas}*: Instance of our [oas/tooling](https://npm.im/oas) class.
-- `operationSchema` *{Object\|Operation}*: Can either be an object with `path` and `method` properties (that exist in the supplied OAS), or an instance of our `Operation` class from [oas/tooling](https://npm.im/oas) - accessed through `new Oas(spec).operation(path, method)`.
-- `values` *{Object}*: A object of payload data, with key-value data therein, that should be used to construct the request. Available data you can define here:
+- `oas` _{Oas}_: Instance of our [oas/tooling](https://npm.im/oas) class.
+- `operationSchema` _{Object\|Operation}_: Can either be an object with `path` and `method` properties (that exist in the supplied OAS), or an instance of our `Operation` class from [oas/tooling](https://npm.im/oas) - accessed through `new Oas(spec).operation(path, method)`.
+- `values` _{Object}_: A object of payload data, with key-value data therein, that should be used to construct the request. Available data you can define here:
   - `path`
   - `query`
   - `body`
@@ -57,5 +57,5 @@ console.log(oasToHar(spec, spec.operation('/pets', 'post')));
   - `formData`
   - `header`
   - `server` — If the supplied OAS has multiple severs or server variables you can use this to set which server and variables to use. Shape of it should be: `{ selected: Integer, variables: { ...key-values }}`. `selected` should coorespond to index of the `servers` array in your OAS.
-- `auth` *{Object}*: Authentication information for the request.
-- `opts.proxyUrl` *{Boolean}*: Boolean to toggle if composed HAR objects should have their `url` be sent through our CORS-friendly proxy. Defaults to `false`.
+- `auth` _{Object}_: Authentication information for the request.
+- `opts.proxyUrl` _{Boolean}_: Boolean to toggle if composed HAR objects should have their `url` be sent through our CORS-friendly proxy. Defaults to `false`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@readme/oas-to-har",
   "description": "Utility to transform an OAS operation into a HAR representation",
-  "version": "17.0.8",
+  "version": "17.1.2",
   "main": "src/index.js",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
   "license": "ISC",
@@ -24,9 +24,9 @@
     "test": "nyc mocha"
   },
   "dependencies": {
+    "@readme/data-urls": "^1.0.1",
     "@readme/oas-extensions": "^14.3.0",
     "oas": "^18.3.1",
-    "parse-data-url": "^4.0.1",
     "qs": "^6.10.5",
     "remove-undefined-objects": "^2.0.0"
   },
@@ -35,10 +35,10 @@
     "@commitlint/config-conventional": "^17.0.2",
     "@jsdevtools/host-environment": "^2.1.2",
     "@jsdevtools/karma-config": "^3.1.7",
-    "@readme/eslint-config": "^8.7.6",
-    "@readme/oas-examples": "^5.3.0",
+    "@readme/eslint-config": "^9.0.0",
+    "@readme/oas-examples": "^5.4.1",
     "chai": "^4.3.6",
-    "eslint": "^8.17.0",
+    "eslint": "^8.20.0",
     "har-validator": "^5.1.5",
     "husky": "^8.0.1",
     "mocha": "^10.0.0",

package/src/index.js

@@ -1,6 +1,6 @@
 const extensions = require('@readme/oas-extensions');
 const { Operation, utils } = require('oas');
-const parseDataUrl = require('parse-data-url');
+const { parse: parseDataUrl } = require('@readme/data-urls');
 const { default: removeUndefinedObjects } = require('remove-undefined-objects');
 
 const configureSecurity = require('./lib/configure-security');
@@ -34,6 +34,13 @@ function formatter(values, param, type, onlyIfExists) {
   // Handle file uploads. Specifically arrays of file uploads which need to be formatted very
   // specifically.
   if (param.schema && param.schema.type === 'array' && param.schema.items && param.schema.items.format === 'binary') {
+    if (Array.isArray(value)) {
+      // If this is array of binary data then we shouldn't do anything because we'll prepare them
+      // separately in the HAR in order to preserve `fileName` and `contentType` data within
+      // `postData.params`. If we don't then the HAR we generate for this data will be invalid.
+      return value;
+    }
+
     return JSON.stringify(value);
   }
 
@@ -353,12 +360,31 @@ module.exports = (
             har.postData.mimeType = 'multipart/form-data';
             har.postData.params = [];
 
-            // Discover all `{ type: string, format: binary }` properties the schema. If there are
-            // any, then that means that we're dealing with a `multipart/form-data` request and
-            // need to treat the payload as `postData.params`.
-            const binaryTypes = Object.keys(requestBody.schema.properties).filter(
-              key => requestBody.schema.properties[key].format === 'binary'
-            );
+            /**
+             * Discover all `{ type: string, format: binary }` properties, or arrays containing the
+             * same, within the request body. If there are any, then that means that we're dealing
+             * with a `multipart/form-data` request and need to treat the payload as
+             * `postData.params` and supply filenames and content types for the files (if they're
+             * available).
+             *
+             * @example `{ type: string, format: binary }`
+             * @example `{ type: array, items: { type: string, format: binary } }`
+             */
+            const binaryTypes = Object.keys(requestBody.schema.properties).filter(key => {
+              if (requestBody.schema.properties[key].format === 'binary') {
+                return true;
+              } else if (
+                requestBody.schema.properties[key].type === 'array' &&
+                requestBody.schema.properties[key].items &&
+                typeof requestBody.schema.properties[key].items === 'object' &&
+                requestBody.schema.properties[key].items !== null &&
+                requestBody.schema.properties[key].items.format === 'binary'
+              ) {
+                return true;
+              }
+
+              return false;
+            });
 
             if (cleanBody !== undefined) {
               const multipartParams = multipartBodyToFormatterParams(
@@ -369,25 +395,30 @@ module.exports = (
               Object.keys(cleanBody).forEach(name => {
                 const param = multipartParams.find(multipartParam => multipartParam.name === name);
 
-                const value = formatter(formData, param, 'body', true);
-
                 // If we're dealing with a binary type, and the value is a valid data URL we should
                 // parse out any available filename and content type to send along with the
                 // parameter to interpreters like `fetch-har` can make sense of it and send a usable
                 // payload.
                 const addtlData = {};
 
-                if (binaryTypes.includes(name)) {
-                  const parsed = parseDataUrl(value);
-                  if (parsed) {
-                    addtlData.fileName = 'name' in parsed ? parsed.name : 'unknown';
-                    if ('contentType' in parsed) {
-                      addtlData.contentType = parsed.contentType;
+                let value = formatter(formData, param, 'body', true);
+                if (!Array.isArray(value)) {
+                  value = [value];
+                }
+
+                value.forEach(val => {
+                  if (binaryTypes.includes(name)) {
+                    const parsed = parseDataUrl(val);
+                    if (parsed) {
+                      addtlData.fileName = 'name' in parsed ? parsed.name : 'unknown';
+                      if ('contentType' in parsed) {
+                        addtlData.contentType = parsed.contentType;
+                      }
                     }
                   }
-                }
 
-                appendHarValue(har.postData.params, name, value, addtlData);
+                  appendHarValue(har.postData.params, name, val, addtlData);
+                });
               });
             }
           } else {