@readme/oas-to-har 30.0.2 → 31.0.0

package/dist/index.cjs

@@ -1,9 +1,10 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 
 var _chunkIN7TUPJQcjs = require('./chunk-IN7TUPJQ.cjs');
 
 // src/index.ts
 var _dataurls = require('@readme/data-urls');
+var _oas = require('oas'); var _oas2 = _interopRequireDefault(_oas);
 var _extensions = require('oas/extensions');
 var _operation = require('oas/operation');
 var _types = require('oas/types');
@@ -50,7 +51,7 @@ function getSafeRequestBody(obj) {
   }
   return obj;
 }
-function getSubschemas(schema, opts) {
+function getSubschemas(schema, api, opts) {
   let subSchemaDataSize = 0;
   if (opts.parentIsArray) {
     const parentData = get(opts.payload, opts.parentKey || "");
@@ -62,22 +63,67 @@ function getSubschemas(schema, opts) {
   let subschemas = [];
   if (subSchemaDataSize > 0) {
     for (let idx = 0; idx < subSchemaDataSize; idx += 1) {
-      subschemas = subschemas.concat(
-        Object.entries(schema).map(([key, subschema]) => ({
-          key: opts.parentKey ? [opts.parentKey, idx, key].join(".") : key,
-          schema: getSafeRequestBody(subschema)
-        }))
-      );
+      const foundSubschemas = getSubschemas(schema, api, {
+        ...opts,
+        parentIsArray: false,
+        parentKey: opts.parentKey ? [opts.parentKey, idx].join(".") : String(idx)
+      });
+      if (foundSubschemas) {
+        subschemas = subschemas.concat(foundSubschemas);
+      }
     }
   } else {
-    subschemas = Object.entries(schema).map(([key, subschema]) => ({
-      key: opts.parentKey ? [opts.parentKey, key].join(".") : key,
-      schema: getSafeRequestBody(subschema)
-    }));
+    let resolvedSchema = schema;
+    if (schema && _types.isRef.call(void 0, schema)) {
+      resolvedSchema = _utils.dereferenceRef.call(void 0, schema, api);
+      if (!resolvedSchema || _types.isRef.call(void 0, resolvedSchema)) {
+        return subschemas;
+      }
+    }
+    const baseKey = _nullishCoalesce(opts.parentKey, () => ( ""));
+    if (resolvedSchema.properties && typeof resolvedSchema.properties === "object") {
+      for (const [propName, propSchema] of Object.entries(resolvedSchema.properties)) {
+        if (propSchema && typeof propSchema === "object") {
+          const resolved = _types.isRef.call(void 0, propSchema) ? _utils.dereferenceRef.call(void 0, propSchema, api) : propSchema;
+          if (resolved && !_types.isRef.call(void 0, resolved)) {
+            subschemas.push({
+              key: baseKey ? [baseKey, propName].join(".") : propName,
+              schema: resolved
+            });
+          }
+        }
+      }
+    }
+    if (!("properties" in resolvedSchema) && typeof resolvedSchema === "object" && !("type" in resolvedSchema && resolvedSchema.type !== "object")) {
+      for (const [propName, propSchema] of Object.entries(resolvedSchema)) {
+        if (propSchema && (Array.isArray(propSchema) || typeof propSchema === "object" && propSchema !== null)) {
+          const raw = getSafeRequestBody(propSchema);
+          const resolved = _types.isRef.call(void 0, raw) ? _utils.dereferenceRef.call(void 0, raw, api) : raw;
+          const toPush = resolved && !_types.isRef.call(void 0, resolved) ? resolved : raw;
+          if (toPush && typeof toPush === "object") {
+            subschemas.push({
+              key: baseKey ? [baseKey, propName].join(".") : propName,
+              schema: toPush
+            });
+          }
+        }
+      }
+    }
+    if ("items" in resolvedSchema && resolvedSchema.items !== void 0 && resolvedSchema.items !== true) {
+      const itemsSchema = resolvedSchema.items;
+      const resolved = _types.isRef.call(void 0, itemsSchema) ? _utils.dereferenceRef.call(void 0, itemsSchema, api) : itemsSchema;
+      if (resolved && !_types.isRef.call(void 0, resolved)) {
+        subschemas.push({
+          key: baseKey,
+          schema: resolved,
+          parentIsArray: true
+        });
+      }
+    }
   }
   return subschemas;
 }
-function getTypedFormatsInSchema(format, schema, opts) {
+function getTypedFormatsInSchema(format, schema, api, opts) {
   try {
     if (_optionalChain([schema, 'optionalAccess', _6 => _6.format]) === format) {
       if (opts.parentIsArray) {
@@ -93,33 +139,28 @@ function getTypedFormatsInSchema(format, schema, opts) {
         }
       } else if (opts.parentKey && get(opts.payload, opts.parentKey) !== void 0) {
         return opts.parentKey;
-      } else if (opts.payload !== void 0) {
+      } else if (!opts.parentKey && opts.payload !== void 0) {
         return true;
       }
       return false;
     }
-    const subschemas = getSubschemas(schema, opts);
+    const subschemas = getSubschemas(schema, api, opts);
     if (!subschemas) {
       return false;
     }
-    return subschemas.flatMap(({ key, schema: subschema }) => {
-      if ("properties" in subschema) {
-        return getTypedFormatsInSchema(format, subschema.properties, { payload: opts.payload, parentKey: key });
-      } else if ("items" in subschema) {
-        if (_optionalChain([subschema, 'access', _7 => _7.items, 'optionalAccess', _8 => _8.properties])) {
-          return getTypedFormatsInSchema(format, subschema.items.properties, {
-            payload: opts.payload,
-            parentKey: key,
-            parentIsArray: true
-          });
+    return subschemas.flatMap(({ key, schema: subschema, parentIsArray: entryIsArray }) => {
+      if (_types.isRef.call(void 0, subschema)) {
+        const resolved = _utils.dereferenceRef.call(void 0, subschema, api);
+        if (resolved && !_types.isRef.call(void 0, resolved)) {
+          return resolved;
         }
-        return getTypedFormatsInSchema(format, subschema.items, {
-          payload: opts.payload,
-          parentKey: key,
-          parentIsArray: true
-        });
+        return false;
       }
-      return getTypedFormatsInSchema(format, subschema, { payload: opts.payload, parentKey: key });
+      return getTypedFormatsInSchema(format, subschema, api, {
+        payload: opts.payload,
+        parentKey: key,
+        parentIsArray: entryIsArray
+      });
     }).filter(Boolean);
   } catch (e) {
     return [];
@@ -145,6 +186,27 @@ function getParameterContentSchema(param, contentType) {
   }
   return null;
 }
+function parseJsonStringsInBody(obj) {
+  if (typeof obj === "string") {
+    try {
+      const p = JSON.parse(obj);
+      return typeof p === "object" && p !== null ? parseJsonStringsInBody(p) : p;
+    } catch (e2) {
+      return obj;
+    }
+  }
+  if (Array.isArray(obj)) {
+    return obj.map(parseJsonStringsInBody);
+  }
+  if (obj !== null && typeof obj === "object") {
+    const out = {};
+    for (const [k, v] of Object.entries(obj)) {
+      out[k] = parseJsonStringsInBody(v);
+    }
+    return out;
+  }
+  return obj;
+}
 
 // src/lib/style-formatting/style-serializer.ts
 var isRfc3986Reserved = (char) => ":/?#[]@!$&'()*+,;=".indexOf(char) > -1;
@@ -152,7 +214,7 @@ var isRfc3986Unreserved = (char) => /^[a-z0-9\-._~]+$/i.test(char);
 function isURIEncoded(value) {
   try {
     return decodeURIComponent(value) !== value;
-  } catch (e2) {
+  } catch (e3) {
     return false;
   }
 }
@@ -524,7 +586,7 @@ function handleDeepObject(value, parameter) {
   });
 }
 function handleExplode(value, parameter) {
-  if (Array.isArray(value) && _optionalChain([parameter, 'access', _9 => _9.schema, 'optionalAccess', _10 => _10.type]) === "array" && parameter.style === "deepObject") {
+  if (Array.isArray(value) && _optionalChain([parameter, 'access', _7 => _7.schema, 'optionalAccess', _8 => _8.type]) === "array" && parameter.style === "deepObject") {
     const newObj = {};
     const deepObjs = handleDeepObject(value, parameter);
     deepObjs.forEach((obj) => {
@@ -585,7 +647,7 @@ function formatter(values, param, type, onlyIfExists = false) {
   } else if (param.required && param.content) {
     const contentType = getParameterContentType(param);
     const schema = contentType ? getParameterContentSchema(param, contentType) : null;
-    value = _optionalChain([schema, 'optionalAccess', _11 => _11.default]);
+    value = _optionalChain([schema, 'optionalAccess', _9 => _9.default]);
   } else if (type === "path") {
     return param.name;
   }
@@ -607,7 +669,7 @@ function multipartBodyToFormatterParams(payload, oasMediaTypeObject, schema) {
   const encoding = oasMediaTypeObject.encoding;
   if (typeof payload === "object" && payload !== null) {
     return Object.keys(payload).map((key) => {
-      if (!_optionalChain([schema, 'access', _12 => _12.properties, 'optionalAccess', _13 => _13[key]])) {
+      if (!_optionalChain([schema, 'access', _10 => _10.properties, 'optionalAccess', _11 => _11[key]])) {
         return false;
       }
       const paramEncoding = encoding ? encoding[key] : void 0;
@@ -630,7 +692,7 @@ var defaultFormDataTypes = Object.keys(_utils.jsonSchemaTypes).reduce((prev, cur
 }, {});
 function getResponseContentType(content) {
   const types = Object.keys(content) || [];
-  if (_optionalChain([types, 'optionalAccess', _14 => _14.length])) {
+  if (_optionalChain([types, 'optionalAccess', _12 => _12.length])) {
     const jsonType = types.find((t) => _utils.matchesMimeType.json(t));
     if (jsonType) {
       return jsonType;
@@ -689,10 +751,11 @@ function encodeBodyForHAR(body) {
 function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUrl: "" }) {
   let operation;
   if (!operationSchema || typeof operationSchema.getParameters !== "function") {
+    const currentOas = _oas2.default.init(oas);
     operation = new (0, _operation.Operation)(
-      oas,
-      _optionalChain([operationSchema, 'optionalAccess', _15 => _15.path]) || "",
-      _optionalChain([operationSchema, 'optionalAccess', _16 => _16.method]) || "",
+      currentOas,
+      _optionalChain([operationSchema, 'optionalAccess', _13 => _13.path]) || "",
+      _optionalChain([operationSchema, 'optionalAccess', _14 => _14.method]) || "",
       operationSchema || { path: "", method: "" }
     );
   } else {
@@ -742,24 +805,25 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
     }
     return formatter(formData, parameter, "path");
   });
-  const queryStrings = _optionalChain([parameters, 'optionalAccess', _17 => _17.filter, 'call', _18 => _18((param) => param.in === "query")]);
-  if (_optionalChain([queryStrings, 'optionalAccess', _19 => _19.length])) {
+  const queryStrings = _optionalChain([parameters, 'optionalAccess', _15 => _15.filter, 'call', _16 => _16((param) => param.in === "query")]);
+  if (_optionalChain([queryStrings, 'optionalAccess', _17 => _17.length])) {
     queryStrings.forEach((queryString) => {
       const value = formatter(formData, queryString, "query", true);
       appendHarValue(har.queryString, queryString.name, value);
     });
   }
-  const cookies = _optionalChain([parameters, 'optionalAccess', _20 => _20.filter, 'call', _21 => _21((param) => param.in === "cookie")]);
-  if (_optionalChain([cookies, 'optionalAccess', _22 => _22.length])) {
+  const cookies = _optionalChain([parameters, 'optionalAccess', _18 => _18.filter, 'call', _19 => _19((param) => param.in === "cookie")]);
+  if (_optionalChain([cookies, 'optionalAccess', _20 => _20.length])) {
     cookies.forEach((cookie) => {
       const value = formatter(formData, cookie, "cookie", true);
       appendHarValue(har.cookies, cookie.name, value);
     });
   }
   if (operation.schema.responses) {
-    Object.keys(operation.schema.responses).some((response) => {
-      if (_types.isRef.call(void 0, _optionalChain([operation, 'access', _23 => _23.schema, 'access', _24 => _24.responses, 'optionalAccess', _25 => _25[response]]))) return false;
-      const content = (_optionalChain([operation, 'access', _26 => _26.schema, 'access', _27 => _27.responses, 'optionalAccess', _28 => _28[response]])).content;
+    Object.keys(operation.schema.responses).some((statusCode) => {
+      const response = operation.getResponseByStatusCode(statusCode);
+      if (!response) return false;
+      const content = response.content;
       if (!content) return false;
       if (Object.keys(formData.header || {}).find((h) => h.toLowerCase() === "accept")) return true;
       har.headers.push({
@@ -771,8 +835,8 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
   }
   let hasContentType = false;
   let contentType = operation.getContentType();
-  const headers = _optionalChain([parameters, 'optionalAccess', _29 => _29.filter, 'call', _30 => _30((param) => param.in === "header")]);
-  if (_optionalChain([headers, 'optionalAccess', _31 => _31.length])) {
+  const headers = _optionalChain([parameters, 'optionalAccess', _21 => _21.filter, 'call', _22 => _22((param) => param.in === "header")]);
+  if (_optionalChain([headers, 'optionalAccess', _23 => _23.length])) {
     headers.forEach((header) => {
       const value = formatter(formData, header, "header", true);
       if (typeof value === "undefined") return;
@@ -814,11 +878,11 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
   }
   let requestBody;
   if (operation.hasRequestBody()) {
-    requestBody = _optionalChain([operation, 'access', _32 => _32.getParametersAsJSONSchema, 'call', _33 => _33(), 'optionalAccess', _34 => _34.find, 'call', _35 => _35((payload) => {
+    requestBody = _optionalChain([operation, 'access', _24 => _24.getParametersAsJSONSchema, 'call', _25 => _25(), 'optionalAccess', _26 => _26.find, 'call', _27 => _27((payload) => {
       return payload.type === (operation.isFormUrlEncoded() ? "formData" : "body");
     })]);
   }
-  if (_optionalChain([requestBody, 'optionalAccess', _36 => _36.schema]) && Object.keys(requestBody.schema).length) {
+  if (_optionalChain([requestBody, 'optionalAccess', _28 => _28.schema]) && Object.keys(requestBody.schema).length) {
     const requestBodySchema = requestBody.schema;
     if (operation.isFormUrlEncoded()) {
       if (Object.keys(formData.formData || {}).length) {
@@ -853,11 +917,15 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
               return false;
             });
             if (cleanBody !== void 0) {
-              const multipartParams = multipartBodyToFormatterParams(
-                formData.body,
-                operation.schema.requestBody.content["multipart/form-data"],
-                safeBodySchema
-              );
+              let multipartParams = [];
+              const multipartContent = operation.getRequestBody("multipart/form-data");
+              if (typeof multipartContent === "object" && multipartContent !== null && // `getRequestBody()` will return an array if there are multiple content types that
+              // match the one we're looking for but because we're looking for an exact
+              // `multipart/form-data` match `getRequestBody()` will only ever return a single
+              // object back for us.
+              !Array.isArray(multipartContent)) {
+                multipartParams = multipartBodyToFormatterParams(formData.body, multipartContent, safeBodySchema);
+              }
               if (multipartParams.length) {
                 Object.keys(cleanBody).forEach((name) => {
                   const param = multipartParams.find((multipartParam) => multipartParam.name === name);
@@ -877,7 +945,7 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
                           }
                         }
                       }
-                      appendHarValue(_optionalChain([har, 'access', _37 => _37.postData, 'optionalAccess', _38 => _38.params]) || [], name, val, addtlData);
+                      appendHarValue(_optionalChain([har, 'access', _29 => _29.postData, 'optionalAccess', _30 => _30.params]) || [], name, val, addtlData);
                     });
                   }
                 });
@@ -888,28 +956,39 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
             if (hasSchemaType(requestBody.schema, "string") || hasSchemaType(requestBody.schema, "integer") || hasSchemaType(requestBody.schema, "number") || hasSchemaType(requestBody.schema, "boolean")) {
               har.postData.text = JSON.stringify(JSON.parse(cleanBody));
             } else {
-              const jsonTypes = getTypedFormatsInSchema("json", requestBodySchema.properties, { payload: cleanBody });
+              const jsonTypes = getTypedFormatsInSchema("json", requestBodySchema, operation.api, {
+                payload: cleanBody
+              });
               if (Array.isArray(jsonTypes) && jsonTypes.length) {
                 try {
                   jsonTypes.forEach((prop) => {
                     try {
                       set(cleanBody, String(prop), JSON.parse(get(cleanBody, String(prop))));
-                    } catch (e3) {
+                    } catch (e4) {
                     }
                   });
                   if (typeof cleanBody.RAW_BODY !== "undefined") {
                     cleanBody = cleanBody.RAW_BODY;
                   }
                   har.postData.text = JSON.stringify(cleanBody);
-                } catch (e4) {
+                } catch (e5) {
                   har.postData.text = stringify(formData.body);
                 }
               } else {
-                har.postData.text = encodeBodyForHAR(formData.body);
+                try {
+                  const parsed = parseJsonStringsInBody(cleanBody);
+                  if (typeof _optionalChain([parsed, 'optionalAccess', _31 => _31.RAW_BODY]) !== "undefined") {
+                    har.postData.text = isPrimitive(parsed.RAW_BODY) ? String(parsed.RAW_BODY) : stringify(parsed.RAW_BODY);
+                  } else {
+                    har.postData.text = JSON.stringify(parsed);
+                  }
+                } catch (e6) {
+                  har.postData.text = encodeBodyForHAR(formData.body);
+                }
               }
             }
           }
-        } catch (e5) {
+        } catch (e7) {
           har.postData = { mimeType: contentType, text: stringify(formData.body) };
         }
       } else {
@@ -917,14 +996,14 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
       }
     }
   }
-  if ((_optionalChain([har, 'access', _39 => _39.postData, 'optionalAccess', _40 => _40.text]) || _optionalChain([requestBody, 'optionalAccess', _41 => _41.schema]) && Object.keys(requestBody.schema).length) && !hasContentType) {
+  if ((_optionalChain([har, 'access', _32 => _32.postData, 'optionalAccess', _33 => _33.text]) || _optionalChain([requestBody, 'optionalAccess', _34 => _34.schema]) && Object.keys(requestBody.schema).length) && !hasContentType) {
     har.headers.push({
       name: "content-type",
       value: contentType
     });
   }
   const securityRequirements = operation.getSecurity();
-  if (_optionalChain([securityRequirements, 'optionalAccess', _42 => _42.length])) {
+  if (_optionalChain([securityRequirements, 'optionalAccess', _35 => _35.length])) {
     securityRequirements.forEach((schemes) => {
       Object.keys(schemes).forEach((security) => {
         const securityValue = _chunkIN7TUPJQcjs.configureSecurity.call(void 0, apiDefinition, auth, security);