@readme/oas-to-har 30.0.2 → 31.0.0

package/dist/index.js

@@ -4,6 +4,7 @@ import {
 
 // src/index.ts
 import { parse as parseDataUrl } from "@readme/data-urls";
+import Oas from "oas";
 import { HEADERS, PROXY_ENABLED } from "oas/extensions";
 import { Operation } from "oas/operation";
 import { isRef as isRef2 } from "oas/types";
@@ -35,7 +36,7 @@ import qs from "qs";
 
 // src/lib/utils.ts
 import { isRef } from "oas/types";
-import { getParameterContentType as getParameterContentTypeUtil } from "oas/utils";
+import { dereferenceRef, getParameterContentType as getParameterContentTypeUtil } from "oas/utils";
 function hasSchemaType(schema, discriminator) {
   if (Array.isArray(schema.type)) {
     return schema.type.includes(discriminator);
@@ -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 && isRef(schema)) {
+      resolvedSchema = dereferenceRef(schema, api);
+      if (!resolvedSchema || isRef(resolvedSchema)) {
+        return subschemas;
+      }
+    }
+    const baseKey = 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 = isRef(propSchema) ? dereferenceRef(propSchema, api) : propSchema;
+          if (resolved && !isRef(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 = isRef(raw) ? dereferenceRef(raw, api) : raw;
+          const toPush = resolved && !isRef(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 = isRef(itemsSchema) ? dereferenceRef(itemsSchema, api) : itemsSchema;
+      if (resolved && !isRef(resolved)) {
+        subschemas.push({
+          key: baseKey,
+          schema: resolved,
+          parentIsArray: true
+        });
+      }
+    }
   }
   return subschemas;
 }
-function getTypedFormatsInSchema(format, schema, opts) {
+function getTypedFormatsInSchema(format, schema, api, opts) {
   try {
     if (schema?.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 (subschema.items?.properties) {
-          return getTypedFormatsInSchema(format, subschema.items.properties, {
-            payload: opts.payload,
-            parentKey: key,
-            parentIsArray: true
-          });
+    return subschemas.flatMap(({ key, schema: subschema, parentIsArray: entryIsArray }) => {
+      if (isRef(subschema)) {
+        const resolved = dereferenceRef(subschema, api);
+        if (resolved && !isRef(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 {
     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 {
+      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;
@@ -689,8 +751,9 @@ function encodeBodyForHAR(body) {
 function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUrl: "" }) {
   let operation;
   if (!operationSchema || typeof operationSchema.getParameters !== "function") {
+    const currentOas = Oas.init(oas);
     operation = new Operation(
-      oas,
+      currentOas,
       operationSchema?.path || "",
       operationSchema?.method || "",
       operationSchema || { path: "", method: "" }
@@ -757,9 +820,10 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
     });
   }
   if (operation.schema.responses) {
-    Object.keys(operation.schema.responses).some((response) => {
-      if (isRef2(operation.schema.responses?.[response])) return false;
-      const content = (operation.schema.responses?.[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({
@@ -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);
@@ -888,7 +956,9 @@ 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) => {
@@ -905,7 +975,16 @@ function oasToHar(oas, operationSchema, values = {}, auth = {}, opts = { proxyUr
                   har.postData.text = stringify(formData.body);
                 }
               } else {
-                har.postData.text = encodeBodyForHAR(formData.body);
+                try {
+                  const parsed = parseJsonStringsInBody(cleanBody);
+                  if (typeof parsed?.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 {
+                  har.postData.text = encodeBodyForHAR(formData.body);
+                }
               }
             }
           }