@readme/oas-to-har 21.0.2 → 21.0.4

package/dist/index.js

@@ -125,25 +125,6 @@ function multipartBodyToFormatterParams(payload, oasMediaTypeObject, schema) {
     // 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));
@@ -400,7 +381,7 @@ function oasToHar(oas, operationSchema, values, auth, opts) {
                         // 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 safeBodySchema_1 = getSafeRequestBody(requestBodySchema);
+                        var safeBodySchema_1 = (0, utils_1.getSafeRequestBody)(requestBodySchema);
                         /**
                          * 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

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

@@ -198,7 +198,11 @@ function handleExplode(value, parameter) {
     return stylizeValue(value, parameter);
 }
 function shouldExplode(parameter) {
-    return ((parameter.explode || (parameter.explode !== false && parameter.style === 'form')) &&
+    return ((parameter.explode ||
+        (parameter.explode !== false && parameter.style === 'form') ||
+        // style: deepObject && explode: false doesn't exist so explode it always
+        // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-examples
+        parameter.style === 'deepObject') &&
         // header and path doesn't explode into separate parameters like query and cookie do
         parameter.in !== 'header' &&
         parameter.in !== 'path');

package/dist/lib/utils.d.ts

@@ -4,6 +4,14 @@ import type { SchemaObject } from 'oas/dist/rmoas.types';
  *
  */
 export declare function hasSchemaType(schema: SchemaObject, discriminator: 'array' | 'object' | 'string' | 'number' | 'boolean' | 'integer' | 'null'): boolean;
+/**
+ * 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.
+ *
+ */
+export declare function getSafeRequestBody(obj: any): any;
 interface Options {
     parentIsArray?: boolean;
     parentKey?: string;

package/dist/lib/utils.js

@@ -16,7 +16,7 @@ var __read = (this && this.__read) || function (o, n) {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTypedFormatsInSchema = exports.hasSchemaType = void 0;
+exports.getTypedFormatsInSchema = exports.getSafeRequestBody = exports.hasSchemaType = void 0;
 var lodash_1 = require("lodash"); // eslint-disable-line no-restricted-imports
 /**
  * Determine if a schema `type` is, or contains, a specific discriminator.
@@ -29,6 +29,23 @@ function hasSchemaType(schema, discriminator) {
     return schema.type === discriminator;
 }
 exports.hasSchemaType = hasSchemaType;
+/**
+ * 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 ('oneOf' in obj) {
+        return getSafeRequestBody(obj.oneOf[0]);
+    }
+    else if ('anyOf' in obj) {
+        return getSafeRequestBody(obj.anyOf[0]);
+    }
+    return obj;
+}
+exports.getSafeRequestBody = getSafeRequestBody;
 function getSubschemas(schema, opts) {
     var subSchemaDataSize = 0;
     if (opts.parentIsArray) {
@@ -48,7 +65,7 @@ function getSubschemas(schema, opts) {
                 var _b = __read(_a, 2), key = _b[0], subschema = _b[1];
                 return ({
                     key: opts.parentKey ? [opts.parentKey, idx, key].join('.') : key,
-                    schema: subschema,
+                    schema: getSafeRequestBody(subschema),
                 });
             }));
         };
@@ -61,7 +78,7 @@ function getSubschemas(schema, opts) {
             var _b = __read(_a, 2), key = _b[0], subschema = _b[1];
             return ({
                 key: opts.parentKey ? [opts.parentKey, key].join('.') : key,
-                schema: subschema,
+                schema: getSafeRequestBody(subschema),
             });
         });
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@readme/oas-to-har",
   "description": "Utility to transform an OAS operation into a HAR representation",
-  "version": "21.0.2",
+  "version": "21.0.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
@@ -27,27 +27,27 @@
     "@readme/data-urls": "^1.0.1",
     "@readme/oas-extensions": "^17.0.1",
     "lodash": "^4.17.21",
-    "oas": "^20.8.9",
+    "oas": "^20.10.1",
     "qs": "^6.11.2",
     "remove-undefined-objects": "^3.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
+    "@commitlint/cli": "^17.6.7",
+    "@commitlint/config-conventional": "^17.6.7",
     "@readme/eslint-config": "^10.6.2",
-    "@readme/oas-examples": "^5.11.1",
+    "@readme/oas-examples": "^5.12.0",
     "@types/har-format": "^1.2.11",
-    "@types/jest": "^29.5.2",
-    "@types/lodash": "^4.14.195",
+    "@types/jest": "^29.5.3",
+    "@types/lodash": "^4.14.196",
     "@types/qs": "^6.9.7",
-    "eslint": "^8.44.0",
+    "eslint": "^8.45.0",
     "har-validator": "^5.1.5",
     "husky": "^8.0.3",
-    "jest": "^29.6.1",
+    "jest": "^29.6.2",
     "jest-expect-har": "^6.0.0",
     "prettier": "^2.8.8",
     "ts-jest": "^29.1.1",
-    "type-fest": "^3.12.0",
+    "type-fest": "^4.0.0",
     "typescript": "^5.1.6"
   },
   "browserslist": [

package/src/index.ts

@@ -24,7 +24,7 @@ import removeUndefinedObjects from 'remove-undefined-objects';
 
 import configureSecurity from './lib/configure-security';
 import formatStyle from './lib/style-formatting';
-import { getTypedFormatsInSchema, hasSchemaType } from './lib/utils';
+import { getSafeRequestBody, getTypedFormatsInSchema, hasSchemaType } from './lib/utils';
 
 const { jsonSchemaTypes, matchesMimeType } = utils;
 
@@ -137,25 +137,6 @@ function multipartBodyToFormatterParams(payload: unknown, oasMediaTypeObject: Me
   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]: {} });
 }, {});

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

@@ -215,7 +215,11 @@ function handleExplode(value: any, parameter: ParameterObject) {
 
 function shouldExplode(parameter: ParameterObject) {
   return (
-    (parameter.explode || (parameter.explode !== false && parameter.style === 'form')) &&
+    (parameter.explode ||
+      (parameter.explode !== false && parameter.style === 'form') ||
+      // style: deepObject && explode: false doesn't exist so explode it always
+      // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-examples
+      parameter.style === 'deepObject') &&
     // header and path doesn't explode into separate parameters like query and cookie do
     parameter.in !== 'header' &&
     parameter.in !== 'path'

package/src/lib/utils.ts

@@ -17,6 +17,23 @@ export function hasSchemaType(
   return schema.type === discriminator;
 }
 
+/**
+ * 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.
+ *
+ */
+export function getSafeRequestBody(obj: any) {
+  if ('oneOf' in obj) {
+    return getSafeRequestBody(obj.oneOf[0]);
+  } else if ('anyOf' in obj) {
+    return getSafeRequestBody(obj.anyOf[0]);
+  }
+
+  return obj;
+}
+
 interface Options {
   parentIsArray?: boolean;
   parentKey?: string;
@@ -43,14 +60,14 @@ function getSubschemas(schema: any, opts: Options) {
       subschemas = subschemas.concat(
         Object.entries(schema).map(([key, subschema]: [string, JSONSchema]) => ({
           key: opts.parentKey ? [opts.parentKey, idx, key].join('.') : key,
-          schema: subschema,
+          schema: getSafeRequestBody(subschema),
         }))
       );
     }
   } else {
     subschemas = Object.entries(schema).map(([key, subschema]: [string, JSONSchema]) => ({
       key: opts.parentKey ? [opts.parentKey, key].join('.') : key,
-      schema: subschema,
+      schema: getSafeRequestBody(subschema),
     }));
   }