@readme/oas-to-har 20.1.0 → 21.0.0

package/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  }
+}

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 21.0.0 (2023-06-26)
+
+* fix: quirk with multipart/form-data schema payloads being handled as `text` (#212) ([aac989f](https://github.com/readmeio/oas-to-har/commit/aac989f)), closes [#212](https://github.com/readmeio/oas-to-har/issues/212)
+* feat: dropping support for node 14 (#211) ([30e9e2f](https://github.com/readmeio/oas-to-har/commit/30e9e2f)), closes [#211](https://github.com/readmeio/oas-to-har/issues/211)
+* chore(deps-dev): bump typescript from 4.9.5 to 5.0.4 (#186) ([df15481](https://github.com/readmeio/oas-to-har/commit/df15481)), closes [#186](https://github.com/readmeio/oas-to-har/issues/186)
+* chore(deps-dev): bumping out of date deps ([fb710c7](https://github.com/readmeio/oas-to-har/commit/fb710c7))
+* chore(deps): bump socket.io-parser from 4.2.1 to 4.2.3 (#193) ([f4c55ba](https://github.com/readmeio/oas-to-har/commit/f4c55ba)), closes [#193](https://github.com/readmeio/oas-to-har/issues/193)
+* chore(deps): bumping out of date deps ([92f7623](https://github.com/readmeio/oas-to-har/commit/92f7623))
+* chore(deps): bumping out of date deps ([b1a1e85](https://github.com/readmeio/oas-to-har/commit/b1a1e85))
+* chore(deps): bumping out of date deps ([7f63b39](https://github.com/readmeio/oas-to-har/commit/7f63b39))
+* refactor: moving our test suite back to jest (#202) ([ee3eb98](https://github.com/readmeio/oas-to-har/commit/ee3eb98)), closes [#202](https://github.com/readmeio/oas-to-har/issues/202)
+* ci: run tests against node 20 ([b3353df](https://github.com/readmeio/oas-to-har/commit/b3353df))
+
+
+
+## <small>20.1.1 (2023-03-02)</small>
+
+* chore: bumping out of date deps ([864ed47](https://github.com/readmeio/oas-to-har/commit/864ed47))
+* build: 20.1.0 release ([91e2319](https://github.com/readmeio/oas-to-har/commit/91e2319))
+
+
+
 ## 20.1.0 (2023-03-01)
 
 * feat: add support for arrays of objects in querystrings (#170) ([b1d6f51](https://github.com/readmeio/oas-to-har/commit/b1d6f51)), closes [#170](https://github.com/readmeio/oas-to-har/issues/170) [/github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-10](https://github.com//github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md/issues/fixed-fields-10)

package/dist/index.js

@@ -52,7 +52,7 @@ var __read = (this && this.__read) || function (o, n) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var data_urls_1 = require("@readme/data-urls");
 var extensions = __importStar(require("@readme/oas-extensions"));
 var oas_1 = require("oas");
@@ -67,7 +67,7 @@ function formatter(values, param, type, onlyIfExists) {
         var value_1 = values[type][param.name];
         // Note: Technically we could send everything through the format style and choose the proper
         // default for each `in` type (e.g. query defaults to form).
-        return (0, style_formatting_1["default"])(value_1, param);
+        return (0, style_formatting_1.default)(value_1, param);
     }
     var value;
     // Handle missing values
@@ -77,8 +77,8 @@ function formatter(values, param, type, onlyIfExists) {
     else if (onlyIfExists && !param.required) {
         value = undefined;
     }
-    else if (param.required && param.schema && !(0, rmoas_types_1.isRef)(param.schema) && param.schema["default"]) {
-        value = param.schema["default"];
+    else if (param.required && param.schema && !(0, rmoas_types_1.isRef)(param.schema) && param.schema.default) {
+        value = param.schema.default;
     }
     else if (type === 'path') {
         // If we don't have any values for the path parameter, just use the name of the parameter as the
@@ -105,17 +105,16 @@ function formatter(values, param, type, onlyIfExists) {
         // Query params should always be formatted, even if they don't have a `style` serialization
         // configured.
         if (type === 'query') {
-            return (0, style_formatting_1["default"])(value, param);
+            return (0, style_formatting_1.default)(value, param);
         }
         return value;
     }
     return undefined;
 }
-function multipartBodyToFormatterParams(multipartBody, oasMediaTypeObject) {
-    var schema = oasMediaTypeObject.schema;
+function multipartBodyToFormatterParams(payload, oasMediaTypeObject, schema) {
     var encoding = oasMediaTypeObject.encoding;
-    if (typeof multipartBody === 'object' && multipartBody !== null) {
-        return Object.keys(multipartBody)
+    if (typeof payload === 'object' && payload !== null) {
+        return Object.keys(payload)
             .map(function (key) {
             // If we have an incoming parameter, but it's not in the schema ignore it.
             if (!schema.properties[key]) {
@@ -131,7 +130,7 @@ function multipartBodyToFormatterParams(multipartBody, oasMediaTypeObject) {
                 required: (schema.required && typeof schema.required === 'boolean' && Boolean(schema.required)) ||
                     (Array.isArray(schema.required) && schema.required.includes(key)),
                 schema: schema.properties[key],
-                "in": 'body'
+                in: 'body',
             };
         })
             .filter(Boolean);
@@ -140,6 +139,25 @@ function multipartBodyToFormatterParams(multipartBody, oasMediaTypeObject) {
     // empty array if we get anything else.
     return [];
 }
+/**
+ * Because some request body schema shapes might not always be a top-level `properties`, instead
+ * nesting it in an `oneOf` or `anyOf` we need to extract the first usable schema that we have. If
+ * we don't do this then these non-conventional request body schema payloads may not be properly
+ * represented in the HAR that we generate.
+ *
+ */
+function getSafeRequestBody(obj) {
+    if ('properties' in obj) {
+        return obj;
+    }
+    else if ('oneOf' in obj) {
+        return getSafeRequestBody(obj.oneOf[0]);
+    }
+    else if ('anyOf' in obj) {
+        return getSafeRequestBody(obj.anyOf[0]);
+    }
+    return {};
+}
 var defaultFormDataTypes = Object.keys(jsonSchemaTypes).reduce(function (prev, curr) {
     var _a;
     return Object.assign(prev, (_a = {}, _a[curr] = {}, _a));
@@ -162,7 +180,7 @@ function isPrimitive(val) {
     return typeof val === 'string' || typeof val === 'number' || typeof val === 'boolean';
 }
 function stringify(json) {
-    return JSON.stringify((0, remove_undefined_objects_1["default"])(typeof json.RAW_BODY !== 'undefined' ? json.RAW_BODY : json));
+    return JSON.stringify((0, remove_undefined_objects_1.default)(typeof json.RAW_BODY !== 'undefined' ? json.RAW_BODY : json));
 }
 function stringifyParameter(param) {
     if (param === null || isPrimitive(param)) {
@@ -220,7 +238,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
     if (opts === void 0) { opts = {
         // If true, the operation URL will be rewritten and prefixed with https://try.readme.io/ in
         // order to funnel requests through our CORS-friendly proxy.
-        proxyUrl: false
+        proxyUrl: false,
     }; }
     var operation;
     if (!operationSchema || typeof operationSchema.getParameters !== 'function') {
@@ -241,7 +259,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
     var apiDefinition = oas.getDefinition();
     var formData = __assign(__assign(__assign({}, defaultFormDataTypes), { server: {
             selected: 0,
-            variables: oas.defaultVariables(0)
+            variables: oas.defaultVariables(0),
         } }), values);
     // If the incoming `server.variables` is missing variables let's pad it out with defaults.
     formData.server.variables = __assign(__assign({}, oas.defaultVariables(formData.server.selected)), (formData.server.variables ? formData.server.variables : {}));
@@ -255,7 +273,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         bodySize: 0,
         method: operation.method.toUpperCase(),
         url: "".concat(oas.url(formData.server.selected, formData.server.variables)).concat(operation.path).replace(/\s/g, '%20'),
-        httpVersion: 'HTTP/1.1'
+        httpVersion: 'HTTP/1.1',
     };
     if (opts.proxyUrl) {
         if (extensions.getExtension(extensions.PROXY_ENABLED, oas, operation)) {
@@ -275,7 +293,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         }
         return formatter(formData, parameter, 'path');
     });
-    var queryStrings = parameters && parameters.filter(function (param) { return param["in"] === 'query'; });
+    var queryStrings = parameters && parameters.filter(function (param) { return param.in === 'query'; });
     if (queryStrings && queryStrings.length) {
         queryStrings.forEach(function (queryString) {
             var value = formatter(formData, queryString, 'query', true);
@@ -283,7 +301,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         });
     }
     // Do we have any `cookie` parameters on the operation?
-    var cookies = parameters && parameters.filter(function (param) { return param["in"] === 'cookie'; });
+    var cookies = parameters && parameters.filter(function (param) { return param.in === 'cookie'; });
     if (cookies && cookies.length) {
         cookies.forEach(function (cookie) {
             var value = formatter(formData, cookie, 'cookie', true);
@@ -304,7 +322,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
                 return true;
             har.headers.push({
                 name: 'accept',
-                value: getResponseContentType(content)
+                value: getResponseContentType(content),
             });
             return true;
         });
@@ -312,7 +330,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
     // Do we have any `header` parameters on the operation?
     var hasContentType = false;
     var contentType = operation.getContentType();
-    var headers = parameters && parameters.filter(function (param) { return param["in"] === 'header'; });
+    var headers = parameters && parameters.filter(function (param) { return param.in === 'header'; });
     if (headers && headers.length) {
         headers.forEach(function (header) {
             var value = formatter(formData, header, 'header', true);
@@ -335,7 +353,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
             }
             har.headers.push({
                 name: String(header.key),
-                value: String(header.value)
+                value: String(header.value),
             });
         });
     }
@@ -345,7 +363,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         if (acceptHeader && !har.headers.find(function (hdr) { return hdr.name.toLowerCase() === 'accept'; })) {
             har.headers.push({
                 name: 'accept',
-                value: String(formData.header[acceptHeader])
+                value: String(formData.header[acceptHeader]),
             });
         }
         // Do we have a manually-defined `authorization` header set up in the form data?
@@ -353,7 +371,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         if (authorizationHeader && !har.headers.find(function (hdr) { return hdr.name.toLowerCase() === 'authorization'; })) {
             har.headers.push({
                 name: 'authorization',
-                value: String(formData.header[authorizationHeader])
+                value: String(formData.header[authorizationHeader]),
             });
         }
     }
@@ -366,14 +384,14 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         var requestBodySchema_1 = requestBody.schema;
         if (operation.isFormUrlEncoded()) {
             if (Object.keys(formData.formData).length) {
-                var cleanFormData_1 = (0, remove_undefined_objects_1["default"])(JSON.parse(JSON.stringify(formData.formData)));
+                var cleanFormData_1 = (0, remove_undefined_objects_1.default)(JSON.parse(JSON.stringify(formData.formData)));
                 if (cleanFormData_1 !== undefined) {
                     har.postData.params = [];
                     har.postData.mimeType = 'application/x-www-form-urlencoded';
                     Object.keys(cleanFormData_1).forEach(function (name) {
                         har.postData.params.push({
                             name: name,
-                            value: stringifyParameter(cleanFormData_1[name])
+                            value: stringifyParameter(cleanFormData_1[name]),
                         });
                     });
                 }
@@ -386,10 +404,15 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
             var isJSON = operation.isJson();
             if (isMultipart || isJSON) {
                 try {
-                    var cleanBody_1 = (0, remove_undefined_objects_1["default"])(JSON.parse(JSON.stringify(formData.body)));
+                    var cleanBody_1 = (0, remove_undefined_objects_1.default)(JSON.parse(JSON.stringify(formData.body)));
                     if (isMultipart) {
                         har.postData.mimeType = 'multipart/form-data';
                         har.postData.params = [];
+                        // Because some request body schema shapes might not always be a top-level `properties`,
+                        // instead nesting it in an `oneOf` or `anyOf` we need to extract the first usable
+                        // schema that we have in order to process this multipart payload.
+                        var requestBodyJSONSchema = operation.getParametersAsJSONSchema().find(function (js) { return js.type === 'body'; });
+                        var safeBodySchema_1 = getSafeRequestBody((requestBodyJSONSchema === null || requestBodyJSONSchema === void 0 ? void 0 : requestBodyJSONSchema.schema) || {});
                         /**
                          * 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
@@ -400,8 +423,8 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
                          * @example `{ type: string, format: binary }`
                          * @example `{ type: array, items: { type: string, format: binary } }`
                          */
-                        var binaryTypes_1 = Object.keys(requestBodySchema_1.properties).filter(function (key) {
-                            var propData = requestBodySchema_1.properties[key];
+                        var binaryTypes_1 = Object.keys(safeBodySchema_1.properties).filter(function (key) {
+                            var propData = safeBodySchema_1.properties[key];
                             if (propData.format === 'binary') {
                                 return true;
                             }
@@ -415,31 +438,33 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
                             return false;
                         });
                         if (cleanBody_1 !== undefined) {
-                            var multipartParams_1 = multipartBodyToFormatterParams(formData.body, operation.schema.requestBody.content['multipart/form-data']);
-                            Object.keys(cleanBody_1).forEach(function (name) {
-                                var param = multipartParams_1.find(function (multipartParam) { return multipartParam.name === name; });
-                                // 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.
-                                var addtlData = {};
-                                var value = formatter(formData, param, 'body', true);
-                                if (!Array.isArray(value)) {
-                                    value = [value];
-                                }
-                                value.forEach(function (val) {
-                                    if (binaryTypes_1.includes(name)) {
-                                        var parsed = (0, data_urls_1.parse)(val);
-                                        if (parsed) {
-                                            addtlData.fileName = 'name' in parsed ? parsed.name : 'unknown';
-                                            if ('contentType' in parsed) {
-                                                addtlData.contentType = parsed.contentType;
+                            var multipartParams_1 = multipartBodyToFormatterParams(formData.body, operation.schema.requestBody.content['multipart/form-data'], safeBodySchema_1);
+                            if (multipartParams_1.length) {
+                                Object.keys(cleanBody_1).forEach(function (name) {
+                                    var param = multipartParams_1.find(function (multipartParam) { return multipartParam.name === name; });
+                                    // 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.
+                                    var addtlData = {};
+                                    var value = formatter(formData, param, 'body', true);
+                                    if (!Array.isArray(value)) {
+                                        value = [value];
+                                    }
+                                    value.forEach(function (val) {
+                                        if (binaryTypes_1.includes(name)) {
+                                            var parsed = (0, data_urls_1.parse)(val);
+                                            if (parsed) {
+                                                addtlData.fileName = 'name' in parsed ? parsed.name : 'unknown';
+                                                if ('contentType' in parsed) {
+                                                    addtlData.contentType = parsed.contentType;
+                                                }
                                             }
                                         }
-                                    }
-                                    appendHarValue(har.postData.params, name, val, addtlData);
+                                        appendHarValue(har.postData.params, name, val, addtlData);
+                                    });
                                 });
-                            });
+                            }
                         }
                     }
                     else {
@@ -515,7 +540,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         !hasContentType) {
         har.headers.push({
             name: 'content-type',
-            value: contentType
+            value: contentType,
         });
     }
     var securityRequirements = operation.getSecurity();
@@ -523,7 +548,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         // TODO pass these values through the formatter?
         securityRequirements.forEach(function (schemes) {
             Object.keys(schemes).forEach(function (security) {
-                var securityValue = (0, configure_security_1["default"])(apiDefinition, auth, security);
+                var securityValue = (0, configure_security_1.default)(apiDefinition, auth, security);
                 if (!securityValue) {
                     return;
                 }
@@ -550,10 +575,10 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
         log: {
             entries: [
                 {
-                    request: har
+                    request: har,
                 },
-            ]
-        }
+            ],
+        },
     };
 }
-exports["default"] = oasToHar;
+exports.default = oasToHar;

package/dist/lib/configure-security.d.ts

@@ -1,7 +1,7 @@
 import type { OASDocument } from 'oas/dist/rmoas.types';
 export type AuthForHAR = Record<string, string | number | {
-    user?: string;
     pass?: string;
+    user?: string;
 }>;
 export default function configureSecurity(apiDefinition: OASDocument, values: AuthForHAR, scheme: string): false | {
     type: "cookies" | "headers" | "queryString";

package/dist/lib/configure-security.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var rmoas_types_1 = require("oas/dist/rmoas.types");
 function harValue(type, value) {
     if (!value.value)
@@ -39,27 +39,27 @@ function configureSecurity(apiDefinition, values, scheme) {
             }
             return harValue('headers', {
                 name: 'authorization',
-                value: "Basic ".concat(Buffer.from("".concat(user, ":").concat(pass)).toString('base64'))
+                value: "Basic ".concat(Buffer.from("".concat(user, ":").concat(pass)).toString('base64')),
             });
         }
         else if (security.scheme === 'bearer') {
             return harValue('headers', {
                 name: 'authorization',
-                value: "Bearer ".concat(values[scheme])
+                value: "Bearer ".concat(values[scheme]),
             });
         }
     }
     if (security.type === 'apiKey') {
-        if (security["in"] === 'query') {
+        if (security.in === 'query') {
             return harValue('queryString', {
                 name: security.name,
-                value: String(values[scheme])
+                value: String(values[scheme]),
             });
         }
-        else if (security["in"] === 'header') {
+        else if (security.in === 'header') {
             var header = {
                 name: security.name,
-                value: String(values[scheme])
+                value: String(values[scheme]),
             };
             if (security['x-bearer-format']) {
                 // Uppercase: token -> Token
@@ -69,19 +69,19 @@ function configureSecurity(apiDefinition, values, scheme) {
             }
             return harValue('headers', header);
         }
-        else if (security["in"] === 'cookie') {
+        else if (security.in === 'cookie') {
             return harValue('cookies', {
                 name: security.name,
-                value: String(values[scheme])
+                value: String(values[scheme]),
             });
         }
     }
     if (security.type === 'oauth2') {
         return harValue('headers', {
             name: 'authorization',
-            value: "Bearer ".concat(values[scheme])
+            value: "Bearer ".concat(values[scheme]),
         });
     }
     return undefined;
 }
-exports["default"] = configureSecurity;
+exports.default = configureSecurity;

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

@@ -13,7 +13,7 @@ var __assign = (this && this.__assign) || function () {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var qs_1 = __importDefault(require("qs"));
 var style_serializer_1 = __importDefault(require("./style-serializer"));
 // Certain styles don't support empty values.
@@ -53,7 +53,7 @@ function stylizeValue(value, parameter) {
     if (shouldNotStyleEmptyValues(parameter) && (typeof finalValue === 'undefined' || finalValue === '')) {
         // Paths need return an unstyled empty string instead of undefined so it's ignored in the final
         // path string.
-        if (parameter["in"] === 'path') {
+        if (parameter.in === 'path') {
             return '';
         }
         // Everything but path should return undefined when unstyled so it's ignored in the final
@@ -62,7 +62,7 @@ function stylizeValue(value, parameter) {
     }
     // Every style that adds their style to empty values should use emptystring for path parameters
     // instead of undefined to avoid the string `undefined`.
-    if (parameter["in"] === 'path') {
+    if (parameter.in === 'path') {
         finalValue = removeUndefinedForPath(finalValue);
     }
     /**
@@ -74,7 +74,7 @@ function stylizeValue(value, parameter) {
      *
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#fixed-fields-10}
      */
-    if (parameter["in"] === 'header' && shouldNotStyleReservedHeader(parameter)) {
+    if (parameter.in === 'header' && shouldNotStyleReservedHeader(parameter)) {
         return value;
     }
     /**
@@ -86,16 +86,16 @@ function stylizeValue(value, parameter) {
      */
     var style = parameter.style;
     if (!style) {
-        if (parameter["in"] === 'query') {
+        if (parameter.in === 'query') {
             style = 'form';
         }
-        else if (parameter["in"] === 'path') {
+        else if (parameter.in === 'path') {
             style = 'simple';
         }
-        else if (parameter["in"] === 'header') {
+        else if (parameter.in === 'header') {
             style = 'simple';
         }
-        else if (parameter["in"] === 'cookie') {
+        else if (parameter.in === 'cookie') {
             style = 'form';
         }
     }
@@ -109,15 +109,15 @@ function stylizeValue(value, parameter) {
          */
         explode = true;
     }
-    return (0, style_serializer_1["default"])(__assign({ location: parameter["in"], value: finalValue, key: parameter.name, style: style, explode: explode, 
+    return (0, style_serializer_1.default)(__assign({ location: parameter.in, value: finalValue, key: parameter.name, style: style, explode: explode, 
         /**
          * @todo this parameter is optional to stylize. It defaults to false, and can accept falsy, truthy, or "unsafe".
          *  I do not know if it is correct for query to use this. See style-serializer for more info
          */
-        escape: true }, (parameter["in"] === 'query' ? { isAllowedReserved: parameter.allowReserved || false } : {})));
+        escape: true }, (parameter.in === 'query' ? { isAllowedReserved: parameter.allowReserved || false } : {})));
 }
 function handleDeepObject(value, parameter) {
-    return qs_1["default"]
+    return qs_1.default
         .stringify(value, {
         // eslint-disable-next-line consistent-return
         encoder: function (str, defaultEncoder, charset, type) {
@@ -135,7 +135,7 @@ function handleDeepObject(value, parameter) {
             else if (type === 'value') {
                 return stylizeValue(str, parameter);
             }
-        }
+        },
     })
         .split('&')
         .map(function (item) {
@@ -143,7 +143,7 @@ function handleDeepObject(value, parameter) {
         return {
             label: split[0],
             // `qs` will coerce null values into being `undefined` string but we want to preserve them.
-            value: split[1] === 'undefined' ? null : split[1]
+            value: split[1] === 'undefined' ? null : split[1],
         };
     });
 }
@@ -200,8 +200,8 @@ function handleExplode(value, parameter) {
 function shouldExplode(parameter) {
     return ((parameter.explode || (parameter.explode !== false && parameter.style === 'form')) &&
         // header and path doesn't explode into separate parameters like query and cookie do
-        parameter["in"] !== 'header' &&
-        parameter["in"] !== 'path');
+        parameter.in !== 'header' &&
+        parameter.in !== 'path');
 }
 function formatStyle(value, parameter) {
     // Deep object style only works on objects and arrays, and only works with explode=true.
@@ -222,4 +222,4 @@ function formatStyle(value, parameter) {
     }
     return stylizeValue(value, parameter);
 }
-exports["default"] = formatStyle;
+exports.default = formatStyle;

package/dist/lib/style-formatting/style-serializer.d.ts

@@ -1,15 +1,15 @@
 export interface StylizerConfig {
-    location: 'body' | 'query';
-    key: string;
-    value: any;
-    style: 'deepObject' | 'form' | 'label' | 'matrix' | 'pipeDelimited' | 'simple' | 'spaceDelimited';
-    explode: boolean;
     escape: boolean | 'unsafe';
+    explode: boolean;
     isAllowedReserved?: boolean;
+    key: string;
+    location: 'body' | 'query';
+    style: 'deepObject' | 'form' | 'label' | 'matrix' | 'pipeDelimited' | 'simple' | 'spaceDelimited';
+    value: any;
 }
 export default function stylize(config: StylizerConfig): any;
 export declare function encodeDisallowedCharacters(str: string, { escape, returnIfEncoded, isAllowedReserved, }: {
     escape?: boolean | 'unsafe';
-    returnIfEncoded?: boolean;
     isAllowedReserved?: boolean;
+    returnIfEncoded?: boolean;
 }, parse: boolean): any;

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

@@ -24,7 +24,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.encodeDisallowedCharacters = void 0;
 /**
  * This file has been extracted and modified from `swagger-client`.
@@ -58,7 +58,7 @@ function stylize(config) {
     }
     return encodePrimitive(config);
 }
-exports["default"] = stylize;
+exports.default = stylize;
 function encodeDisallowedCharacters(str, 
 // eslint-disable-next-line @typescript-eslint/default-param-last
 _a, parse) {
@@ -111,7 +111,7 @@ function encodeArray(_a) {
         return module.exports.encodeDisallowedCharacters(str, {
             escape: escape,
             returnIfEncoded: location === 'query',
-            isAllowedReserved: isAllowedReserved
+            isAllowedReserved: isAllowedReserved,
         });
     };
     switch (style) {
@@ -177,7 +177,7 @@ function encodeObject(_a) {
         return module.exports.encodeDisallowedCharacters(str, {
             escape: escape,
             returnIfEncoded: location === 'query',
-            isAllowedReserved: isAllowedReserved
+            isAllowedReserved: isAllowedReserved,
         });
     };
     var valueKeys = Object.keys(value);
@@ -286,7 +286,7 @@ function encodePrimitive(_a) {
         return module.exports.encodeDisallowedCharacters(str, {
             escape: escape,
             returnIfEncoded: location === 'query' || location === 'body',
-            isAllowedReserved: isAllowedReserved
+            isAllowedReserved: isAllowedReserved,
         });
     };
     switch (style) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@readme/oas-to-har",
   "description": "Utility to transform an OAS operation into a HAR representation",
-  "version": "20.1.0",
+  "version": "21.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
@@ -11,7 +11,7 @@
     "url": "git://github.com/readmeio/oas-to-har.git"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "scripts": {
     "build": "tsc",
@@ -22,41 +22,32 @@
     "pretest": "npm run lint",
     "prettier": "prettier --list-different --write \"./**/**.{js,ts}\"",
     "release": "npx conventional-changelog-cli -i CHANGELOG.md -s && git add CHANGELOG.md",
-    "test": "nyc mocha \"test/**/*.test.ts\"",
-    "test:browser": "karma start --single-run",
-    "test:browser:chrome": "karma start --browsers=Chrome --single-run=false",
-    "test:browser:debug": "karma start --single-run=false"
+    "test": "jest --coverage"
   },
   "dependencies": {
     "@readme/data-urls": "^1.0.1",
     "@readme/oas-extensions": "^17.0.1",
-    "oas": "^20.4.0",
-    "qs": "^6.10.5",
-    "remove-undefined-objects": "^2.0.2"
+    "oas": "^20.8.4",
+    "qs": "^6.11.2",
+    "remove-undefined-objects": "^3.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.4.2",
-    "@commitlint/config-conventional": "^17.4.2",
-    "@jsdevtools/host-environment": "^2.1.2",
-    "@jsdevtools/karma-config": "^3.1.7",
-    "@readme/eslint-config": "^10.5.0",
-    "@readme/oas-examples": "^5.7.1",
-    "@types/chai": "^4.3.1",
-    "@types/har-format": "^1.2.10",
-    "@types/mocha": "^10.0.0",
+    "@commitlint/cli": "^17.6.6",
+    "@commitlint/config-conventional": "^17.6.6",
+    "@readme/eslint-config": "^10.6.0",
+    "@readme/oas-examples": "^5.11.1",
+    "@types/har-format": "^1.2.11",
+    "@types/jest": "^29.5.2",
     "@types/qs": "^6.9.7",
-    "chai": "^4.3.6",
-    "eslint": "^8.33.0",
+    "eslint": "^8.43.0",
     "har-validator": "^5.1.5",
     "husky": "^8.0.3",
-    "mocha": "^10.2.0",
-    "nyc": "^15.1.0",
-    "prettier": "^2.8.3",
-    "ts-loader": "^8.4.0",
-    "ts-node": "^10.9.1",
-    "type-fest": "^3.5.4",
-    "typescript": "^4.9.5",
-    "webpack": "^4.46.0"
+    "jest": "^29.5.0",
+    "jest-expect-har": "^6.0.0",
+    "prettier": "^2.8.8",
+    "ts-jest": "^29.1.0",
+    "type-fest": "^3.12.0",
+    "typescript": "^5.1.3"
   },
   "browserslist": [
     "last 2 versions"

package/src/index.ts

@@ -100,12 +100,11 @@ function formatter(
   return undefined;
 }
 
-function multipartBodyToFormatterParams(multipartBody: unknown, oasMediaTypeObject: MediaTypeObject) {
-  const schema = oasMediaTypeObject.schema as SchemaObject;
+function multipartBodyToFormatterParams(payload: unknown, oasMediaTypeObject: MediaTypeObject, schema: SchemaObject) {
   const encoding = oasMediaTypeObject.encoding;
 
-  if (typeof multipartBody === 'object' && multipartBody !== null) {
-    return Object.keys(multipartBody)
+  if (typeof payload === 'object' && payload !== null) {
+    return Object.keys(payload)
       .map(key => {
         // If we have an incoming parameter, but it's not in the schema ignore it.
         if (!schema.properties[key]) {
@@ -135,6 +134,25 @@ function multipartBodyToFormatterParams(multipartBody: unknown, oasMediaTypeObje
   return [];
 }
 
+/**
+ * Because some request body schema shapes might not always be a top-level `properties`, instead
+ * nesting it in an `oneOf` or `anyOf` we need to extract the first usable schema that we have. If
+ * we don't do this then these non-conventional request body schema payloads may not be properly
+ * represented in the HAR that we generate.
+ *
+ */
+function getSafeRequestBody(obj: any) {
+  if ('properties' in obj) {
+    return obj;
+  } else if ('oneOf' in obj) {
+    return getSafeRequestBody(obj.oneOf[0]);
+  } else if ('anyOf' in obj) {
+    return getSafeRequestBody(obj.anyOf[0]);
+  }
+
+  return {};
+}
+
 const defaultFormDataTypes = Object.keys(jsonSchemaTypes).reduce((prev, curr) => {
   return Object.assign(prev, { [curr]: {} });
 }, {});
@@ -180,8 +198,8 @@ function appendHarValue(
   name: string,
   value: any,
   addtlData: {
-    fileName?: string;
     contentType?: string;
+    fileName?: string;
   } = {}
 ) {
   if (typeof value === 'undefined') return;
@@ -452,6 +470,12 @@ export default function oasToHar(
             har.postData.mimeType = 'multipart/form-data';
             har.postData.params = [];
 
+            // Because some request body schema shapes might not always be a top-level `properties`,
+            // instead nesting it in an `oneOf` or `anyOf` we need to extract the first usable
+            // schema that we have in order to process this multipart payload.
+            const requestBodyJSONSchema = operation.getParametersAsJSONSchema().find(js => js.type === 'body');
+            const safeBodySchema = getSafeRequestBody(requestBodyJSONSchema?.schema || {});
+
             /**
              * 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
@@ -462,8 +486,8 @@ export default function oasToHar(
              * @example `{ type: string, format: binary }`
              * @example `{ type: array, items: { type: string, format: binary } }`
              */
-            const binaryTypes = Object.keys(requestBodySchema.properties).filter(key => {
-              const propData = requestBodySchema.properties[key] as JSONSchema;
+            const binaryTypes = Object.keys(safeBodySchema.properties).filter(key => {
+              const propData = safeBodySchema.properties[key] as JSONSchema;
               if (propData.format === 'binary') {
                 return true;
               } else if (
@@ -482,37 +506,40 @@ export default function oasToHar(
             if (cleanBody !== undefined) {
               const multipartParams = multipartBodyToFormatterParams(
                 formData.body,
-                (operation.schema.requestBody as RequestBodyObject).content['multipart/form-data']
+                (operation.schema.requestBody as RequestBodyObject).content['multipart/form-data'],
+                safeBodySchema
               );
 
-              Object.keys(cleanBody).forEach(name => {
-                const param = multipartParams.find(multipartParam => multipartParam.name === name);
+              if (multipartParams.length) {
+                Object.keys(cleanBody).forEach(name => {
+                  const param = multipartParams.find(multipartParam => multipartParam.name === name);
 
-                // 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: { fileName?: string; contentType?: string } = {};
+                  // 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: { contentType?: string; fileName?: string } = {};
 
-                let value = formatter(formData, param, 'body', true);
-                if (!Array.isArray(value)) {
-                  value = [value];
-                }
+                  let value = formatter(formData, param, 'body', true);
+                  if (!Array.isArray(value)) {
+                    value = [value];
+                  }
 
-                value.forEach((val: string) => {
-                  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;
+                  value.forEach((val: string) => {
+                    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, val, addtlData);
+                    appendHarValue(har.postData.params, name, val, addtlData);
+                  });
                 });
-              });
+              }
             }
           } else {
             har.postData.mimeType = contentType;

package/src/lib/configure-security.ts

@@ -2,7 +2,7 @@ import type { OASDocument, SecuritySchemeObject } from 'oas/dist/rmoas.types';
 
 import { isRef } from 'oas/dist/rmoas.types';
 
-export type AuthForHAR = Record<string, string | number | { user?: string; pass?: string }>;
+export type AuthForHAR = Record<string, string | number | { pass?: string; user?: string }>;
 
 function harValue(type: 'cookies' | 'headers' | 'queryString', value: { name: string; value: string }) {
   if (!value.value) return undefined;

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

@@ -29,13 +29,13 @@ function isObject(value: unknown) {
 }
 
 export interface StylizerConfig {
-  location: 'body' | 'query';
-  key: string;
-  value: any;
-  style: 'deepObject' | 'form' | 'label' | 'matrix' | 'pipeDelimited' | 'simple' | 'spaceDelimited';
-  explode: boolean;
   escape: boolean | 'unsafe';
+  explode: boolean;
   isAllowedReserved?: boolean;
+  key: string;
+  location: 'body' | 'query';
+  style: 'deepObject' | 'form' | 'label' | 'matrix' | 'pipeDelimited' | 'simple' | 'spaceDelimited';
+  value: any;
 }
 
 export default function stylize(config: StylizerConfig) {
@@ -61,8 +61,8 @@ export function encodeDisallowedCharacters(
     isAllowedReserved,
   }: {
     escape?: boolean | 'unsafe';
-    returnIfEncoded?: boolean;
     isAllowedReserved?: boolean;
+    returnIfEncoded?: boolean;
   } = {},
   parse: boolean
 ) {

package/karma.conf.js

@@ -1,27 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const { host } = require('@jsdevtools/host-environment');
-const { karmaConfig } = require('@jsdevtools/karma-config');
-
-module.exports = karmaConfig({
-  sourceDir: '.',
-  fixtures: ['test/__datasets__/*.json'],
-  browsers: {
-    chrome: true,
-    firefox: true,
-    safari: host.os.mac,
-    edge: false,
-    ie: false,
-  },
-  tests: ['test/*.ts'],
-  config: {
-    webpack: {
-      resolve: {
-        extensions: ['.js', '.ts'],
-      },
-      mode: 'production',
-      module: {
-        rules: [{ test: /\.ts$/, use: 'ts-loader' }],
-      },
-    },
-  },
-});