@readme/oas-to-har 15.0.0 → 17.0.0

package/CHANGELOG.md

@@ -1,3 +1,45 @@
+## 17.0.0 (2022-04-22)
+
+> **BREAKING RELEASE**
+>
+> Node 12 is no longer supported.
+
+* chore: adding some more exclusions into the npmignore list ([25b3121](https://github.com/readmeio/oas-to-har/commit/25b3121))
+* chore(deps-dev): bump @readme/oas-examples from 4.5.0 to 5.0.0 (#75) ([845535b](https://github.com/readmeio/oas-to-har/commit/845535b)), closes [#75](https://github.com/readmeio/oas-to-har/issues/75)
+* chore(deps-dev): bump eslint from 8.11.0 to 8.12.0 (#73) ([c26d37c](https://github.com/readmeio/oas-to-har/commit/c26d37c)), closes [#73](https://github.com/readmeio/oas-to-har/issues/73)
+* chore(deps-dev): bump prettier from 2.6.0 to 2.6.1 (#72) ([24613fc](https://github.com/readmeio/oas-to-har/commit/24613fc)), closes [#72](https://github.com/readmeio/oas-to-har/issues/72)
+* chore(deps): bump actions/checkout from 2.4.0 to 3 (#71) ([38c66a7](https://github.com/readmeio/oas-to-har/commit/38c66a7)), closes [#71](https://github.com/readmeio/oas-to-har/issues/71)
+* chore(deps): bump oas from 18.0.6 to 18.1.0 (#74) ([93c2bc4](https://github.com/readmeio/oas-to-har/commit/93c2bc4)), closes [#74](https://github.com/readmeio/oas-to-har/issues/74)
+* fix: code cleanup (#79) ([245dcbb](https://github.com/readmeio/oas-to-har/commit/245dcbb)), closes [#79](https://github.com/readmeio/oas-to-har/issues/79)
+* fix: support for allowReserved (#76) ([f609297](https://github.com/readmeio/oas-to-har/commit/f609297)), closes [#76](https://github.com/readmeio/oas-to-har/issues/76)
+* fix: support for multi-level deepObjects (#77) ([b287f68](https://github.com/readmeio/oas-to-har/commit/b287f68)), closes [#77](https://github.com/readmeio/oas-to-har/issues/77)
+* feat: browser testing! (#78) ([5ebe4d4](https://github.com/readmeio/oas-to-har/commit/5ebe4d4)), closes [#78](https://github.com/readmeio/oas-to-har/issues/78)
+
+
+
+## 16.1.0 (2022-03-23)
+
+* chore: removing some docs from the repo as they're in our .github/ repo now ([f3d81c3](https://github.com/readmeio/oas-to-har/commit/f3d81c3))
+* chore(deps): bumping out of date deps ([0d7add6](https://github.com/readmeio/oas-to-har/commit/0d7add6))
+* fix: issue where null-assigned object properties would be filtered out (#70) ([9d51794](https://github.com/readmeio/oas-to-har/commit/9d51794)), closes [#70](https://github.com/readmeio/oas-to-har/issues/70)
+
+
+
+## 16.0.0 (2022-03-08)
+
+* chore(deps-dev): bump @commitlint/cli from 16.1.0 to 16.2.1 (#65) ([d1ce5b5](https://github.com/readmeio/oas-to-har/commit/d1ce5b5)), closes [#65](https://github.com/readmeio/oas-to-har/issues/65)
+* chore(deps-dev): bump @commitlint/config-conventional (#62) ([51ad7f3](https://github.com/readmeio/oas-to-har/commit/51ad7f3)), closes [#62](https://github.com/readmeio/oas-to-har/issues/62)
+* chore(deps-dev): bump @readme/eslint-config from 8.2.0 to 8.5.0 (#67) ([adae50c](https://github.com/readmeio/oas-to-har/commit/adae50c)), closes [#67](https://github.com/readmeio/oas-to-har/issues/67)
+* chore(deps-dev): bump eslint from 8.8.0 to 8.10.0 (#63) ([31c1aa3](https://github.com/readmeio/oas-to-har/commit/31c1aa3)), closes [#63](https://github.com/readmeio/oas-to-har/issues/63)
+* chore(deps-dev): bump jest from 27.4.7 to 27.5.1 (#64) ([d99e123](https://github.com/readmeio/oas-to-har/commit/d99e123)), closes [#64](https://github.com/readmeio/oas-to-har/issues/64)
+* chore(deps): bump actions/setup-node from 2.5.1 to 3 (#61) ([362859e](https://github.com/readmeio/oas-to-har/commit/362859e)), closes [#61](https://github.com/readmeio/oas-to-har/issues/61)
+* chore(deps): upgrading oas to v18 (#69) ([3a5a54d](https://github.com/readmeio/oas-to-har/commit/3a5a54d)), closes [#69](https://github.com/readmeio/oas-to-har/issues/69)
+* docs: incorporating alex into our documentation workflow (#68) ([6b20368](https://github.com/readmeio/oas-to-har/commit/6b20368)), closes [#68](https://github.com/readmeio/oas-to-har/issues/68)
+* feat: moving to our new remove-undefined-objects package (#59) ([d35a014](https://github.com/readmeio/oas-to-har/commit/d35a014)), closes [#59](https://github.com/readmeio/oas-to-har/issues/59)
+* feat(styles): add space and pipe delimited support for objects per 3.1 (#60) ([49e2d13](https://github.com/readmeio/oas-to-har/commit/49e2d13)), closes [#60](https://github.com/readmeio/oas-to-har/issues/60)
+
+
+
 ## 15.0.0 (2022-02-03)
 
 > **BREAKING RELEASE**

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2021 ReadMe
+Copyright © 2022 ReadMe
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

package/README.md

@@ -2,7 +2,7 @@
 
 Utility to transform an OAS operation into a [HAR](http://www.softwareishard.com/blog/har-12-spec/) representation
 
-[![Build](https://github.com/readmeio/oas-to-har/workflows/CI/badge.svg)](https://github.com/readmeio/oas-to-har)
+[![Build](https://github.com/readmeio/oas-to-har/workflows/CI/badge.svg)](https://github.com/readmeio/oas-to-har/) [![](https://img.shields.io/npm/v/@readme/oas-to-har)](https://npm.im/@readme/oas-to-har)
 
 [![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)
 
@@ -15,14 +15,37 @@ npm install --save @readme/oas-to-har
 ## Usage
 
 ```js
-const Oas = require('oas');
+const Oas = require('oas').default;
 const oasToHar = require('@readme/oas-to-har');
 
-const spec = new Oas('petstore.json');
-console.log(oasToHar(spec, { path: '/pets', method: 'post'}));
+const petstore = require('./petstore.json');
+
+const spec = new Oas(petstore);
+console.log(oasToHar(spec, spec.operation('/pets', 'post')));
+```
+
+```json
+{
+  log: {
+    entries: [
+      {
+        request: {
+          cookies: [],
+          headers: [],
+          headersSize: 0,
+          queryString: [],
+          bodySize: 0,
+          method: 'POST',
+          url: 'http://petstore.swagger.io/v2/pets',
+          httpVersion: 'HTTP/1.1'
+        }
+      }
+    ]
+  }
+}
 ```
 
-### `oasToHar(har, operationSchema, values, auth, opts) => Object`
+### `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)`.
@@ -36,10 +59,3 @@ console.log(oasToHar(spec, { path: '/pets', method: 'post'}));
   - `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`.
-
-## Credits
-[Jon Ursenbach](https://github.com/erunion)
-
-## License
-
-ISC

package/karma.conf.js

@@ -0,0 +1,14 @@
+const { karmaConfig } = require('@jsdevtools/karma-config');
+const { host } = require('@jsdevtools/host-environment');
+
+module.exports = karmaConfig({
+  sourceDir: '.',
+  fixtures: ['test/__datasets__/*.json'],
+  browsers: {
+    chrome: true,
+    firefox: true,
+    safari: host.os.mac,
+    edge: false,
+    ie: 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": "15.0.0",
+  "version": "17.0.0",
   "main": "src/index.js",
   "author": "Jon Ursenbach <jon@ursenba.ch>",
   "license": "ISC",
@@ -10,7 +10,7 @@
     "url": "git://github.com/readmeio/oas-to-har.git"
   },
   "engines": {
-    "node": "^12 || ^14 || ^16"
+    "node": ">=14"
   },
   "scripts": {
     "lint": "eslint .",
@@ -18,24 +18,32 @@
     "pretest": "npm run lint",
     "prettier": "prettier --list-different --write \"./**/**.{js}\"",
     "release": "npx conventional-changelog-cli -i CHANGELOG.md -s && git add CHANGELOG.md",
-    "test": "jest --coverage"
+    "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": "nyc mocha"
   },
   "dependencies": {
-    "@readme/oas-extensions": "^14.1.1",
-    "oas": "^17.7.1",
-    "parse-data-url": "^4.0.1"
+    "@readme/oas-extensions": "^14.2.0",
+    "oas": "^18.0.6",
+    "parse-data-url": "^4.0.1",
+    "qs": "^6.10.3",
+    "remove-undefined-objects": "^1.1.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.1.0",
+    "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.0.0",
-    "@readme/eslint-config": "^8.1.2",
-    "@readme/oas-examples": "^4.3.3",
-    "datauri": "^4.1.0",
-    "eslint": "^8.7.0",
+    "@jsdevtools/host-environment": "^2.1.2",
+    "@jsdevtools/karma-config": "^3.1.7",
+    "@readme/eslint-config": "^8.5.1",
+    "@readme/oas-examples": "^5.0.0",
+    "chai": "^4.3.6",
+    "eslint": "^8.11.0",
+    "har-validator": "^5.1.5",
     "husky": "^7.0.4",
-    "jest": "^27.4.7",
-    "jest-expect-har": "^3.0.1",
-    "prettier": "^2.5.1"
+    "mocha": "^9.2.2",
+    "nyc": "^15.1.0",
+    "prettier": "^2.6.0"
   },
   "prettier": "@readme/eslint-config/prettier",
   "commitlint": {

package/src/index.js

@@ -1,9 +1,9 @@
 const extensions = require('@readme/oas-extensions');
 const { Operation, utils } = require('oas');
 const parseDataUrl = require('parse-data-url');
+const { default: removeUndefinedObjects } = require('remove-undefined-objects');
 
 const configureSecurity = require('./lib/configure-security');
-const removeUndefinedObjects = require('./lib/remove-undefined-objects');
 const formatStyle = require('./lib/style-formatting');
 
 const { jsonSchemaTypes } = utils;
@@ -11,8 +11,8 @@ const { jsonSchemaTypes } = utils;
 function formatter(values, param, type, onlyIfExists) {
   if (param.style) {
     const value = 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).
+    // 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 formatStyle(value, param);
   }
 
@@ -26,18 +26,20 @@ function formatter(values, param, type, onlyIfExists) {
   } else if (param.required && 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 value so we don't
-    // try try to build a URL to something like `https://example.com/undefined`.
+    // If we don't have any values for the path parameter, just use the name of the parameter as the
+    // value so we don't try try to build a URL to something like `https://example.com/undefined`.
     return param.name;
   }
 
-  // Handle file uploads. Specifically arrays of file uploads which need to be formatted very specifically.
+  // 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') {
     return JSON.stringify(value);
   }
 
   if (value !== undefined) {
-    // Query params should always be formatted, even if they don't have a `style` serialization configured.
+    // Query params should always be formatted, even if they don't have a `style` serialization
+    // configured.
     if (type === 'query') {
       return formatStyle(value, param);
     }
@@ -77,7 +79,8 @@ function multipartBodyToFormatterParams(multipartBody, oasMediaTypeObject) {
       .filter(Boolean);
   }
 
-  // Pretty sure that we'll never have anything but an object for multipart bodies, so returning empty array if we get anything else.
+  // Pretty sure that we'll never have anything but an object for multipart bodies, so returning
+  // empty array if we get anything else.
   return [];
 }
 
@@ -118,12 +121,14 @@ function appendHarValue(harParam, name, value, addtlData = {}) {
   if (typeof value === 'undefined') return;
 
   if (Array.isArray(value)) {
-    // If the formatter gives us an array, we're expected to add each array value as a new parameter item with the same parameter name
+    // If the formatter gives us an array, we're expected to add each array value as a new
+    // parameter item with the same parameter name
     value.forEach(singleValue => {
       appendHarValue(harParam, name, singleValue);
     });
   } else if (typeof value === 'object' && value !== null) {
-    // If the formatter gives us an object, we're expected to add each property value as a new parameter item, each with the name of the property
+    // If the formatter gives us an object, we're expected to add each property value as a new
+    // parameter item, each with the name of the property
     Object.keys(value).forEach(key => {
       appendHarValue(harParam, key, value[key]);
     });
@@ -143,8 +148,8 @@ module.exports = (
   values = {},
   auth = {},
   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.
+    // 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,
   }
 ) => {
@@ -196,7 +201,8 @@ module.exports = (
     // Find the path parameter or set a default value if it does not exist
     const parameter = parameters.find(param => param.name === key) || { name: key };
 
-    // The library that handles our style processing already encodes uri elements. For everything else we need to handle it here.
+    // The library that handles our style processing already encodes uri elements. For everything
+    // else we need to handle it here.
     if (!parameter.style) {
       return encodeURIComponent(formatter(formData, parameter, 'path'));
     }
@@ -316,8 +322,9 @@ 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`.
+            // 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'
             );
@@ -333,9 +340,10 @@ module.exports = (
 
                 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.
+                // 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)) {
@@ -355,17 +363,21 @@ module.exports = (
             har.postData.mimeType = contentType;
 
             // Handle arbitrary JSON input via a string.
-            // In OAS you usually find this in an application/json content type.
-            //   with a schema type=string, format=json.
-            // In the UI this is represented by an arbitrary text input
-            // This ensures we remove any newlines or tabs and use a clean json block in the example
+            //
+            // In OAS you usually find this in an `application/json` content type with a schema
+            // `type=string, format=json`. In the UI this is represented by an arbitrary text input.
+            //
+            // This ensures we remove any newlines or tabs and use a clean JSON block in the
+            // example.
             if (requestBody.schema.type === 'string') {
               har.postData.text = JSON.stringify(JSON.parse(cleanBody));
             } else {
-              // Handle formatted JSON objects that have properties that accept arbitrary JSON
-              // Find all `{ type: string, format: json }` properties in the schema because we need to manually JSON.parse
-              // them before submit, otherwise they'll be escaped instead of actual objects.
-              // We also only want values that the user has entered, so we drop any undefined cleanBody keys
+              // Handle formatted JSON objects that have properties that accept arbitrary JSON.
+              //
+              // Find all `{ type: string, format: json }` properties in the schema because we need
+              // to manually `JSON.parse` them before submit, otherwise they'll be escaped instead
+              // of actual objects. We also only want values that the user has entered, so we drop
+              // any `undefined` `cleanBody` keys
               const jsonTypes = Object.keys(requestBody.schema.properties).filter(
                 key => requestBody.schema.properties[key].format === 'json' && cleanBody[key] !== undefined
               );
@@ -380,7 +392,8 @@ module.exports = (
                     }
                   });
 
-                  // `RAW_BODY` is a ReadMe-specific thing where we'll interpret its contents as raw JSON.
+                  // `RAW_BODY` is a ReadMe-specific thing where we'll interpret its contents as
+                  // raw JSON.
                   if (typeof cleanBody.RAW_BODY !== 'undefined') {
                     cleanBody = cleanBody.RAW_BODY;
                   }
@@ -395,10 +408,8 @@ module.exports = (
             }
           }
         } catch (e) {
-          // you should log this error if you're debugging why data is showing up in text, when it  should show up in params
-          // console.log('catching ', e);
-          // If anything above fails for whatever reason, assume that whatever we had is invalid JSON and just treat it
-          // as raw text.
+          // If anything above fails for whatever reason, assume that whatever we had is invalid
+          // JSON and just treat it as raw text.
           har.postData.text = stringify(formData.body);
         }
       } else {
@@ -412,8 +423,9 @@ module.exports = (
     }
   }
 
-  // Add a `Content-Type` header if there are any body values setup above or if there is a schema defined, but only do
-  // so if we don't already have a `Content-Type` present as it's impossible for a request to have multiple.
+  // Add a `Content-Type` header if there are any body values setup above or if there is a schema
+  // defined, but only do so if we don't already have a `Content-Type` present as it's impossible
+  // for a request to have multiple.
   if ((har.postData.text || (requestBody && Object.keys(requestBody.schema).length)) && !hasContentType) {
     har.headers.push({
       name: 'Content-Type',

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

@@ -1,6 +1,7 @@
+const qs = require('qs');
 const stylize = require('./style-serializer');
 
-// Certain styles don't support empty values, This function tracks that list
+// Certain styles don't support empty values.
 function shouldNotStyleEmptyValues(parameter) {
   return ['simple', 'spaceDelimited', 'pipeDelimited', 'deepObject'].includes(parameter.style);
 }
@@ -9,9 +10,12 @@ function shouldNotStyleReservedHeader(parameter) {
   return ['accept', 'authorization', 'content-type'].includes(parameter.name.toLowerCase());
 }
 
-// Note: This isn't necessarily part of the spec. Behavior for the value 'undefined' is, well, undefined.
-//   This code makes our system look better. If we wanted to be more accurate, we might want to remove this,
-//   restore the un-fixed behavior for undefined and have our UI pass in empty string instead of undefined.
+/**
+ * Note: This isn't necessarily part of the spec. Behavior for the value 'undefined' is, well,
+ * undefined. This code makes our system look better. If we wanted to be more accurate, we might
+ * want to remove this, restore the un-fixed behavior for undefined and have our UI pass in empty
+ * string instead of undefined.
+ */
 function removeUndefinedForPath(value) {
   let finalValue = value;
 
@@ -41,35 +45,43 @@ function stylizeValue(value, parameter) {
 
   // Some styles don't work with empty values. We catch those there
   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
+    // Paths need return an unstyled empty string instead of undefined so it's ignored in the final
+    // path string.
     if (parameter.in === 'path') {
       return '';
     }
-    // Everything but path should return undefined when unstyled so it's ignored in the final parameter array
+
+    // Everything but path should return undefined when unstyled so it's ignored in the final
+    // parameter array.
     return undefined;
   }
 
-  // Every style that adds their style to empty values should use emptystring for path parameters instead of undefined to avoid the string 'undefined'
+  // 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') {
     finalValue = removeUndefinedForPath(finalValue);
   }
 
-  // Eventhough `Accept`, `Authorization`, and `Content-Type` headers can be defined as parameters, they should be
-  // completely ignored when it comes to serialization.
-  //
-  //  > If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition
-  //  > SHALL be ignored.
-  //
-  // https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#fixed-fields-10
+  /**
+   * Eventhough `Accept`, `Authorization`, and `Content-Type` headers can be defined as parameters,
+   * they should be completely ignored when it comes to serialization.
+   *
+   *  > If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the
+   *  > parameter definition SHALL be ignored.
+   *
+   * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#fixed-fields-10}
+   */
   if (parameter.in === 'header' && shouldNotStyleReservedHeader(parameter)) {
     return value;
   }
 
-  // All parameter types have a default `style` format so if they don't have one prescribed we should still conform to
-  // what the spec defines.
-  //
-  // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#user-content-parameterstyle
-  // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#user-content-parameterstyle
+  /**
+   * All parameter types have a default `style` format so if they don't have one prescribed we
+   * should still conform to what the spec defines.
+   *
+   * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#user-content-parameterstyle}
+   * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#user-content-parameterstyle}
+   */
   let style = parameter.style;
   if (!style) {
     if (parameter.in === 'query') {
@@ -85,10 +97,12 @@ function stylizeValue(value, parameter) {
 
   let explode = parameter.explode;
   if (explode === undefined && style === 'form') {
-    // Per the spec if no `explode` is present but `style` is `form` then `explode` should default to `true`.
-    //
-    // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#user-content-parameterexplode
-    // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#user-content-parameterexplode
+    /**
+     * Per the spec if no `explode` is present but `style` is `form` then `explode` should default to `true`.
+     *
+     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#user-content-parameterexplode}
+     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#user-content-parameterexplode}
+     */
     explode = true;
   }
 
@@ -98,15 +112,49 @@ function stylizeValue(value, parameter) {
     key: parameter.name,
     style,
     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
-    */
+    /**
+     * @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 } : {}),
   });
 }
 
-// Explode is handled on its own, because style-serializer doesn't return what we expect for proper HAR output
+function handleDeepObject(value, parameter) {
+  return qs
+    .stringify(value, {
+      // eslint-disable-next-line consistent-return
+      encoder(str, defaultEncoder, charset, type) {
+        if (type === 'key') {
+          // `str` will be here as `dog[treats][0]` but because the `qs` library doesn't have any
+          // awareness of our OpenAPI parameters we need to rewrite it to slap the `parameter.name`
+          // to the top, like `pets[dog][treats][0]`.
+          const prefixedKey = str
+            .split(/[[\]]/g)
+            .filter(Boolean)
+            .map(k => `[${k}]`)
+            .join('');
+
+          return `${parameter.name}${prefixedKey}`;
+        } else if (type === 'value') {
+          return stylizeValue(str, parameter);
+        }
+      },
+    })
+    .split('&')
+    .map(item => {
+      const split = item.split('=');
+      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],
+      };
+    });
+}
+
+// Explode is handled on its own, because style-serializer doesn't return what we expect for proper
+// HAR output.
 function handleExplode(value, parameter) {
   if (Array.isArray(value)) {
     return value.map(val => {
@@ -118,12 +166,13 @@ function handleExplode(value, parameter) {
     const newObj = {};
 
     Object.keys(value).forEach(key => {
-      const stylizedValue = stylizeValue(value[key], parameter);
-
       if (parameter.style === 'deepObject') {
-        newObj[`${parameter.name}[${key}]`] = stylizedValue;
+        const deepObjs = handleDeepObject(value, parameter);
+        deepObjs.forEach(obj => {
+          newObj[obj.label] = obj.value;
+        });
       } else {
-        newObj[key] = stylizedValue;
+        newObj[key] = stylizeValue(value[key], parameter);
       }
     });
 
@@ -148,10 +197,15 @@ module.exports = function formatStyle(value, parameter) {
     return undefined;
   }
 
-  // This custom explode logic allows us to bubble up arrays and objects to be handled differently by our HAR transformer
-  //  We need this because the stylizeValue function assumes we're building strings, not richer data types
-  // The first part of this conditional checks if explode is enabled. Explode is disabled for everything by default except for forms.
-  // The second part of this conditional bypasses the custom explode logic for headers, because they work differently, and stylizeValue is accurate
+  // This custom explode logic allows us to bubble up arrays and objects to be handled differently
+  // by our HAR transformer. We need this because the `stylizeValue` function assumes we're building
+  // strings, not richer data types.
+  //
+  // The first part of this conditional checks if `explode` is enabled. Explode is disabled for
+  // everything by default except for forms.
+  //
+  // The second part of this conditional bypasses the custom explode logic for headers, because they
+  // work differently, and `stylizeValue` is accurate.
   if (shouldExplode(parameter)) {
     return handleExplode(value, parameter);
   }

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

@@ -16,8 +16,8 @@ function isURIEncoded(value) {
   try {
     return decodeURIComponent(value) !== value;
   } catch (err) {
-    // `decodeURIComponent` will throw an exception if a string that has an un-encoded percent sign in it (like 20%),
-    // so if it's throwing we can just assume that the value hasn't been encoded.
+    // `decodeURIComponent` will throw an exception if a string that has an un-encoded percent sign
+    //  in it (like 20%), o if it's throwing we can just assume that the value hasn't been encoded.
     return false;
   }
 }
@@ -36,7 +36,7 @@ module.exports = function stylize(config) {
 
 module.exports.encodeDisallowedCharacters = function encodeDisallowedCharacters(
   str,
-  { escape, returnIfEncoded = false } = {}, // eslint-disable-line default-param-last
+  { escape, returnIfEncoded = false, isAllowedReserved } = {}, // eslint-disable-line default-param-last
   parse
 ) {
   if (typeof str === 'number') {
@@ -61,17 +61,16 @@ module.exports.encodeDisallowedCharacters = function encodeDisallowedCharacters(
     return JSON.parse(str);
   }
 
-  // In ES6 you can do this quite easily by using the new ... spread operator.
-  // This causes the string iterator (another new ES6 feature) to be used internally,
-  // and because that iterator is designed to deal with
-  // code points rather than UCS-2/UTF-16 code units.
+  // In ES6 you can do this quite easily by using the new ... spread operator. This causes the
+  // string iterator (another new ES6 feature) to be used internally, and because that iterator is
+  // designed to deal with code points rather than UCS-2/UTF-16 code units.
   return [...str]
     .map(char => {
       if (isRfc3986Unreserved(char)) {
         return char;
       }
 
-      if (isRfc3986Reserved(char) && escape === 'unsafe') {
+      if (isRfc3986Reserved(char) && (escape === 'unsafe' || isAllowedReserved)) {
         return char;
       }
 
@@ -86,142 +85,255 @@ module.exports.encodeDisallowedCharacters = function encodeDisallowedCharacters(
     .join('');
 };
 
-function encodeArray({ location, key, value, style, explode, escape }) {
+/**
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-examples}
+ */
+function encodeArray({ location, key, value, style, explode, escape, isAllowedReserved = false }) {
   const valueEncoder = str =>
     module.exports.encodeDisallowedCharacters(str, {
       escape,
       returnIfEncoded: location === 'query',
+      isAllowedReserved,
     });
 
-  if (style === 'simple') {
-    return value.map(val => valueEncoder(val)).join(',');
-  }
-
-  if (style === 'label') {
-    return `.${value.map(val => valueEncoder(val)).join('.')}`;
-  }
-
-  if (style === 'matrix') {
-    return value
-      .map(val => valueEncoder(val))
-      .reduce((prev, curr) => {
-        if (!prev || explode) {
-          return `${prev || ''};${key}=${curr}`;
-        }
-        return `${prev},${curr}`;
-      }, '');
-  }
-
-  if (style === 'form') {
-    const after = explode ? `&${key}=` : ',';
-    return value.map(val => valueEncoder(val)).join(after);
-  }
-
-  if (style === 'spaceDelimited') {
-    const after = explode ? `${key}=` : '';
-    return value.map(val => valueEncoder(val)).join(` ${after}`);
+  switch (style) {
+    /**
+     * @example <caption>`style: simple`</caption>
+     * `["blue","black","brown"]` → `blue,black,brown`
+     */
+    case 'simple':
+      return value.map(val => valueEncoder(val)).join(',');
+
+    /**
+     * @example <caption>`style: label`</caption>
+     * `["blue","black","brown"]` → `.blue.black.brown`
+     */
+    case 'label':
+      return `.${value.map(val => valueEncoder(val)).join('.')}`;
+
+    /**
+     * @example <caption>`style: matrix` + `explode: true`</caption>
+     * `["blue","black","brown"]` → `;color=blue;color=black;color=brown`
+     *
+     * @example <caption>`style: matrix` + `explode: false` (the default behavior)</caption>
+     * `["blue","black","brown"]` → `;color=blue,black,brown	`
+     */
+    case 'matrix':
+      return value
+        .map(val => valueEncoder(val))
+        .reduce((prev, curr) => {
+          if (!prev || explode) {
+            return `${prev || ''};${key}=${curr}`;
+          }
+          return `${prev},${curr}`;
+        }, '');
+
+    /**
+     * @example <caption>`style: form` + `explode: true`</caption>
+     * `["blue","black","brown"]` → `color=blue&color=black&color=brown`
+     *
+     * @example <caption>`style: form` + `explode: false` (the default behavior)</caption>
+     * `["blue","black","brown"]` → `ccolor=blue,black,brown`
+     */
+    case 'form':
+      return value.map(val => valueEncoder(val)).join(explode ? `&${key}=` : ',');
+
+    /**
+     * @example <caption>`style: spaceDelimited`</caption>
+     * `["blue","black","brown"]` → `blue%20black%20brown`
+     */
+    case 'spaceDelimited':
+      return value.map(val => valueEncoder(val)).join(` ${explode ? `${key}=` : ''}`);
+
+    /**
+     * @example <caption>`style: pipeDelimited`</caption>
+     * `["blue","black","brown"]` → `blue|black|brown`
+     */
+    case 'pipeDelimited':
+      return value.map(val => valueEncoder(val)).join(`|${explode ? `${key}=` : ''}`);
+
+    default:
+      return undefined;
   }
-
-  if (style === 'pipeDelimited') {
-    const after = explode ? `${key}=` : '';
-    return value.map(val => valueEncoder(val)).join(`|${after}`);
-  }
-
-  return undefined;
 }
 
-function encodeObject({ location, key, value, style, explode, escape }) {
+/**
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-examples}
+ */
+function encodeObject({ location, key, value, style, explode, escape, isAllowedReserved = false }) {
   const valueEncoder = str =>
     module.exports.encodeDisallowedCharacters(str, {
       escape,
       returnIfEncoded: location === 'query',
+      isAllowedReserved,
     });
 
   const valueKeys = Object.keys(value);
 
-  if (style === 'simple') {
-    return valueKeys.reduce((prev, curr) => {
-      const val = valueEncoder(value[curr]);
-      const middleChar = explode ? '=' : ',';
-      const prefix = prev ? `${prev},` : '';
+  switch (style) {
+    /**
+     * @example <caption>`style: simple` + `explode: true`</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `R=100,G=200,B=150`
+     *
+     * @example <caption>`style: simple` + `explode: false` (the default behavior)</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `R,100,G,200,B,150`
+     */
+    case 'simple':
+      return valueKeys.reduce((prev, curr) => {
+        const val = valueEncoder(value[curr]);
+        const middleChar = explode ? '=' : ',';
+        const prefix = prev ? `${prev},` : '';
+
+        return `${prefix}${curr}${middleChar}${val}`;
+      }, '');
 
-      return `${prefix}${curr}${middleChar}${val}`;
-    }, '');
-  }
+    /**
+     * @example <caption>`style: label` + `explode: true`</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `.R=100.G=200.B=150`
+     *
+     * @example <caption>`style: label` + `explode: false` (the default behavior)</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `.R.100.G.200.B.150`
+     */
+    case 'label':
+      return valueKeys.reduce((prev, curr) => {
+        const val = valueEncoder(value[curr]);
+        const middleChar = explode ? '=' : '.';
+        const prefix = prev ? `${prev}.` : '.';
+
+        return `${prefix}${curr}${middleChar}${val}`;
+      }, '');
 
-  if (style === 'label') {
-    return valueKeys.reduce((prev, curr) => {
-      const val = valueEncoder(value[curr]);
-      const middleChar = explode ? '=' : '.';
-      const prefix = prev ? `${prev}.` : '.';
+    /**
+     * @example <caption>`style: matrix` + `explode: true`</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `;R=100;G=200;B=150`
+     *
+     * @example <caption>`style: matrix` + `explode: false` (the default behavior)</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `;color=R,100,G,200,B,150`
+     */
+    case 'matrix':
+      if (explode) {
+        return valueKeys.reduce((prev, curr) => {
+          const val = valueEncoder(value[curr]);
+          const prefix = prev ? `${prev};` : ';';
+
+          return `${prefix}${curr}=${val}`;
+        }, '');
+      }
 
-      return `${prefix}${curr}${middleChar}${val}`;
-    }, '');
-  }
+      return valueKeys.reduce((prev, curr) => {
+        const val = valueEncoder(value[curr]);
+        const prefix = prev ? `${prev},` : `;${key}=`;
 
-  if (style === 'matrix' && explode) {
-    return valueKeys.reduce((prev, curr) => {
-      const val = valueEncoder(value[curr]);
-      const prefix = prev ? `${prev};` : ';';
+        return `${prefix}${curr},${val}`;
+      }, '');
 
-      return `${prefix}${curr}=${val}`;
-    }, '');
-  }
+    /**
+     * @example <caption>`style: form` + `explode: true`</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `R=100&G=200&B=150`
+     *
+     * @example <caption>`style: form` + `explode: false` (the default behavior)</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `color=R,100,G,200,B,150`
+     */
+    case 'form':
+      return valueKeys.reduce((prev, curr) => {
+        const val = valueEncoder(value[curr]);
+        const prefix = prev ? `${prev}${explode ? '&' : ','}` : '';
+        const separator = explode ? '=' : ',';
+
+        return `${prefix}${curr}${separator}${val}`;
+      }, '');
 
-  if (style === 'matrix') {
-    // no explode
-    return valueKeys.reduce((prev, curr) => {
-      const val = valueEncoder(value[curr]);
-      const prefix = prev ? `${prev},` : `;${key}=`;
+    /**
+     * @example <caption>`style: spaceDelimited`</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `R%20100%20G%20200%20B%20150`
+     */
+    case 'spaceDelimited':
+      return valueKeys.reduce((prev, curr) => {
+        const val = valueEncoder(value[curr]);
+        const prefix = prev ? `${prev} ` : '';
 
-      return `${prefix}${curr},${val}`;
-    }, '');
-  }
+        return `${prefix}${curr} ${val}`;
+      }, '');
 
-  if (style === 'form') {
-    return valueKeys.reduce((prev, curr) => {
-      const val = valueEncoder(value[curr]);
-      const prefix = prev ? `${prev}${explode ? '&' : ','}` : '';
-      const separator = explode ? '=' : ',';
+    /**
+     * @example <caption>`style: pipeDelimited`</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `R|100|G|200|B|150`
+     */
+    case 'pipeDelimited':
+      return valueKeys.reduce((prev, curr) => {
+        const val = valueEncoder(value[curr]);
+        const prefix = prev ? `${prev}|` : '';
 
-      return `${prefix}${curr}${separator}${val}`;
-    }, '');
-  }
+        return `${prefix}${curr}|${val}`;
+      }, '');
 
-  return undefined;
+    /**
+     * @example <caption>`style: deepObject`</caption>
+     * `{ "R": 100, "G": 200, "B": 150 }` → `color[R]=100&color[G]=200&color[B]=150`
+     */
+    case 'deepObject':
+      return valueKeys.reduce(curr => {
+        const val = valueEncoder(value[curr], {}, true);
+        return `${val}`;
+      }, '');
+
+    default:
+      return undefined;
+  }
 }
 
-function encodePrimitive({ location, key, value, style, escape }) {
+/**
+ * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-examples}
+ */
+function encodePrimitive({ location, key, value, style, escape, isAllowedReserved = false }) {
   const valueEncoder = str =>
     module.exports.encodeDisallowedCharacters(str, {
       escape,
       returnIfEncoded: location === 'query' || location === 'body',
+      isAllowedReserved,
     });
 
-  if (style === 'simple') {
-    return valueEncoder(value);
-  }
-
-  if (style === 'label') {
-    return `.${valueEncoder(value)}`;
-  }
+  switch (style) {
+    /**
+     * @example <caption>`style: simple`</caption>
+     * `blue` → `blue`
+     */
+    case 'simple':
+      return valueEncoder(value);
+
+    /**
+     * @example <caption>`style: label`</caption>
+     * `blue` → `.blue`
+     */
+    case 'label':
+      return `.${valueEncoder(value)}`;
+
+    /**
+     * @example <caption>`style: matrix`</caption>
+     * `blue` → `;color=blue`
+     */
+    case 'matrix':
+      if (value === '') {
+        return `;${key}`;
+      }
 
-  if (style === 'matrix') {
-    // This conditional added by Aaron to be more accurate to the spec
-    if (value === '') {
-      return `;${key}`;
-    }
+      return `;${key}=${valueEncoder(value)}`;
 
-    return `;${key}=${valueEncoder(value)}`;
-  }
+    /**
+     * @example <caption>`style: form`</caption>
+     * `blue` → `color=blue`
+     */
+    case 'form':
+      return valueEncoder(value);
 
-  if (style === 'form') {
-    return valueEncoder(value);
-  }
+    /**
+     * @example <caption>`style: deepObject`</caption>
+     * `blue` → n/a
+     */
+    case 'deepObject':
+      return valueEncoder(value, {}, true);
 
-  if (style === 'deepObject') {
-    return valueEncoder(value, {}, true);
+    default:
+      return undefined;
   }
-
-  return undefined;
 }

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +0,0 @@
-## 🧰 What's being changed?
-
-Describe in detail what this PR is for.
-
-## 🧬 Testing
-
-Provide as much information as you can on how to test what you've done.

package/.github/dependabot.yml

@@ -1,26 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: github-actions
-    directory: "/"
-    schedule:
-      interval: monthly
-    reviewers:
-      - erunion
-    labels:
-      - dependencies
-    commit-message:
-      prefix: chore(deps)
-      prefix-development: chore(deps-dev)
-
-  - package-ecosystem: npm
-    directory: "/"
-    schedule:
-      interval: monthly
-    open-pull-requests-limit: 10
-    reviewers:
-      - erunion
-    labels:
-      - dependencies
-    commit-message:
-      prefix: chore(deps)
-      prefix-development: chore(deps-dev)

package/.github/workflows/ci.yml

@@ -1,24 +0,0 @@
-name: CI
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-
-    steps:
-      - uses: actions/checkout@v2.4.0
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2.5.1
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Install deps
-        run: npm ci
-
-      - name: Run tests
-        run: npm test

package/.github/workflows/codeql-analysis.yml

@@ -1,35 +0,0 @@
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-  schedule:
-    - cron: '0 0 1 * *'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2.4.0
-
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1

package/.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx commitlint --edit $1

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[support+coc@readme.io](mailto:support+coc@readme.io).
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/SECURITY.md

@@ -1,12 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-If there are any vulnerabilities in `@readme/oas-to-har`, don't hesitate to _report them_.
-
-Please email security@readme.io and describe what you've found.
-
-- If you have a fix, explain or attach it.
-- In the near time, expect a reply with the required steps. Also, there may be a demand for a pull request which include the fixes.
-
-> You should not disclose the vulnerability publicly if you haven't received an answer in some weeks. If the vulnerability is rejected, you may post it publicly within some hour of rejection, unless the rejection is withdrawn within that time period. After the vulnerability has been fixed, you may disclose the vulnerability details publicly over some days.

package/src/lib/remove-undefined-objects.js

@@ -1,56 +0,0 @@
-function isEmptyObject(obj) {
-  // Then remove all empty objects from the top level object
-  return typeof obj === 'object' && Object.keys(obj).length === 0;
-}
-
-// Modified from here: https://stackoverflow.com/a/43781499
-function stripEmptyObjects(obj) {
-  let cleanObj = obj;
-
-  Object.keys(cleanObj).forEach(key => {
-    let value = cleanObj[key];
-
-    if (typeof value === 'object' && !Array.isArray(cleanObj) && value !== null) {
-      // Recurse, strip out empty objects from children
-      value = stripEmptyObjects(value);
-
-      // Then remove all empty objects from the top level object
-      if (isEmptyObject(value)) {
-        delete cleanObj[key];
-      } else {
-        cleanObj[key] = value;
-      }
-    } else if (value === null) {
-      delete cleanObj[key];
-    }
-  });
-
-  if (Array.isArray(cleanObj)) {
-    // Since deleting a key from an array will retain an undefined value in that array, we need to
-    // filter them out.
-    cleanObj = cleanObj.filter(function (el) {
-      return el !== undefined;
-    });
-  }
-
-  return cleanObj;
-}
-
-function removeUndefinedObjects(obj) {
-  // JSON.stringify removes undefined values. Though `[undefined]` will be converted with this to
-  // `[null]`, we'll clean that up next.
-  let withoutUndefined = JSON.parse(JSON.stringify(obj));
-
-  // Then we recursively remove all empty objects and nullish arrays.
-  withoutUndefined = stripEmptyObjects(withoutUndefined);
-
-  // If the only thing that's leftover is an empty object
-  // then return nothing so we don't end up with default
-  // code samples with:
-  // --data '{}'
-  if (isEmptyObject(withoutUndefined)) return undefined;
-
-  return withoutUndefined;
-}
-
-module.exports = removeUndefinedObjects;