oas 18.3.0 → 18.3.3

package/@types/lib/find-schema-definition.d.ts

@@ -2,8 +2,7 @@
  * Lookup a reference pointer within an OpenAPI definition and return the schema that it resolves
  * to.
  *
- * @deprecated
  * @param $ref Reference to look up a schema for.
- * @param definitions OpenAPI definition to look for the `$ref` pointer in.
+ * @param definition OpenAPI definition to look for the `$ref` pointer in.
  */
-export default function findSchemaDefinition($ref: string, definitions?: {}): any;
+export default function findSchemaDefinition($ref: string, definition?: {}): any;

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## <small>18.3.3 (2022-05-20)</small>
+
+* fix: add protections for if a `requestBody` has no `schema` (#649) ([0aa38d3](https://github.com/readmeio/oas/commit/0aa38d3)), closes [#649](https://github.com/readmeio/oas/issues/649)
+
+
+
+## <small>18.3.2 (2022-05-16)</small>
+
+* feat: adding $ref awareness to `Oas.getPaths()` (#648) ([9cf5786](https://github.com/readmeio/oas/commit/9cf5786)), closes [#648](https://github.com/readmeio/oas/issues/648)
+* chore(deps-dev): bump @commitlint/cli from 16.2.3 to 16.2.4 (#644) ([7976d5b](https://github.com/readmeio/oas/commit/7976d5b)), closes [#644](https://github.com/readmeio/oas/issues/644)
+* chore(deps-dev): bump @commitlint/config-conventional (#645) ([4addef9](https://github.com/readmeio/oas/commit/4addef9)), closes [#645](https://github.com/readmeio/oas/issues/645)
+* chore(deps-dev): bump @readme/eslint-config from 8.7.2 to 8.7.3 (#641) ([ec78d08](https://github.com/readmeio/oas/commit/ec78d08)), closes [#641](https://github.com/readmeio/oas/issues/641)
+* chore(deps-dev): bump typescript from 4.6.3 to 4.6.4 (#647) ([24048f3](https://github.com/readmeio/oas/commit/24048f3)), closes [#647](https://github.com/readmeio/oas/issues/647)
+* chore(deps): bump github/codeql-action from 1 to 2 (#640) ([72da639](https://github.com/readmeio/oas/commit/72da639)), closes [#640](https://github.com/readmeio/oas/issues/640)
+* chore(deps): bump glob from 7.2.0 to 8.0.1 (#646) ([5190e62](https://github.com/readmeio/oas/commit/5190e62)), closes [#646](https://github.com/readmeio/oas/issues/646)
+* chore(deps): bump inquirer from 8.2.2 to 8.2.4 (#642) ([479aa5f](https://github.com/readmeio/oas/commit/479aa5f)), closes [#642](https://github.com/readmeio/oas/issues/642)
+* chore(deps): bump openapi-types from 10.0.0 to 11.0.0 (#643) ([5c53b5e](https://github.com/readmeio/oas/commit/5c53b5e)), closes [#643](https://github.com/readmeio/oas/issues/643)
+
+
+
+## <small>18.3.1 (2022-04-26)</small>
+
+* chore(deps): bumping out of date deps to get rid of node 18 compat issues (#639) ([13703c8](https://github.com/readmeio/oas/commit/13703c8)), closes [#639](https://github.com/readmeio/oas/issues/639)
+
+
+
 ## <small>18.2.2 (2022-04-11)</small>
 
 * fix: stop rewriting operationIds when we don't need to (#635) ([996cd40](https://github.com/readmeio/oas/commit/996cd40)), closes [#635](https://github.com/readmeio/oas/issues/635)

package/dist/index.js

@@ -634,11 +634,16 @@ var Oas = /** @class */ (function () {
          * anything from within the paths object that isn't a known HTTP method.
          *
          * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields-7}
-         * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-7
+         * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-7}
          */
         var paths = {};
         Object.keys(this.api.paths ? this.api.paths : []).forEach(function (path) {
             paths[path] = {};
+            // Though this library is generally unaware of `$ref` pointers we're making a singular
+            // exception with this accessor out of convenience.
+            if ('$ref' in _this.api.paths[path]) {
+                _this.api.paths[path] = utils_1["default"].findSchemaDefinition(_this.api.paths[path].$ref, _this.api);
+            }
             Object.keys(_this.api.paths[path]).forEach(function (method) {
                 if (!utils_1.supportedMethods.has(method))
                     return;

package/dist/lib/find-schema-definition.js

@@ -3,18 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-// Nabbed from react-jsonschema-form, but this should probably be extracted into a slim NPM module.
 var jsonpointer_1 = __importDefault(require("jsonpointer"));
 /**
  * Lookup a reference pointer within an OpenAPI definition and return the schema that it resolves
  * to.
  *
- * @deprecated
  * @param $ref Reference to look up a schema for.
- * @param definitions OpenAPI definition to look for the `$ref` pointer in.
+ * @param definition OpenAPI definition to look for the `$ref` pointer in.
  */
-function findSchemaDefinition($ref, definitions) {
-    if (definitions === void 0) { definitions = {}; }
+function findSchemaDefinition($ref, definition) {
+    if (definition === void 0) { definition = {}; }
     var origRef = $ref;
     $ref = $ref.trim();
     if ($ref === '') {
@@ -28,7 +26,7 @@ function findSchemaDefinition($ref, definitions) {
     else {
         throw new Error("Could not find a definition for ".concat(origRef, "."));
     }
-    var current = jsonpointer_1["default"].get(definitions, $ref);
+    var current = jsonpointer_1["default"].get(definition, $ref);
     if (current === undefined) {
         throw new Error("Could not find a definition for ".concat(origRef, "."));
     }

package/dist/operation/get-parameters-as-json-schema.js

@@ -121,7 +121,7 @@ function getParametersAsJsonSchema(operation, api, opts) {
         var mediaType = requestBody[0], mediaTypeObject = requestBody[1];
         var type = mediaType === 'application/x-www-form-urlencoded' ? 'formData' : 'body';
         // If this schema is completely empty, don't bother processing it.
-        if (!Object.keys(mediaTypeObject.schema).length) {
+        if (!mediaTypeObject.schema || !Object.keys(mediaTypeObject.schema).length) {
             return null;
         }
         var prevSchemas = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "18.3.0",
+  "version": "18.3.3",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -37,11 +37,10 @@
   "scripts": {
     "build": "tsc",
     "lint": "eslint . --ext .js,.ts",
-    "lint:docs": "alex . .github/",
     "prebuild": "rm -rf dist/ @types/",
     "prepack": "npm run build",
     "prepare": "husky install",
-    "pretest": "npm run lint && npm run lint:docs",
+    "pretest": "npm run lint",
     "prettier": "prettier --list-different --write \"./**/**.{js,ts}\"",
     "release": "npx conventional-changelog-cli -i CHANGELOG.md -s && git add CHANGELOG.md",
     "test": "tsc; jest --coverage",
@@ -53,32 +52,31 @@
     "@types/json-schema": "^7.0.11",
     "cardinal": "^2.1.1",
     "chalk": "^4.1.2",
-    "glob": "^7.1.2",
+    "glob": "^8.0.1",
     "inquirer": "^8.1.2",
     "json-schema-merge-allof": "^0.8.1",
     "json2yaml": "^1.1.0",
     "jsonpointer": "^5.0.0",
     "memoizee": "^0.4.14",
     "minimist": "^1.2.0",
-    "oas-normalize": "^5.2.0",
-    "openapi-types": "^10.0.0",
+    "oas-normalize": "^6.0.0",
+    "openapi-types": "^11.0.0",
     "path-to-regexp": "^6.2.0",
-    "swagger-inline": "^5.2.0"
+    "swagger-inline": "^6.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.0.0",
-    "@readme/eslint-config": "^8.5.1",
-    "@readme/oas-examples": "^5.0.0",
-    "@readme/openapi-parser": "^2.0.4",
+    "@readme/eslint-config": "^8.7.2",
+    "@readme/oas-examples": "^5.1.1",
+    "@readme/openapi-parser": "^2.2.0",
     "@types/jest": "^27.0.2",
     "@types/json-schema-merge-allof": "^0.6.1",
     "@types/memoizee": "^0.4.6",
-    "alex": "^10.0.0",
-    "eslint": "^8.12.0",
+    "eslint": "^8.14.0",
     "husky": "^7.0.2",
     "jest": "^27.0.3",
-    "prettier": "^2.6.1",
+    "prettier": "^2.6.2",
     "ts-jest": "^27.1.4",
     "typescript": "^4.6.3"
   },

package/src/index.ts

@@ -657,12 +657,19 @@ export default class Oas {
      * anything from within the paths object that isn't a known HTTP method.
      *
      * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields-7}
-     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-7
+     * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-7}
      */
     const paths: Record<string, Record<RMOAS.HttpMethods, Operation | Webhook>> = {};
 
     Object.keys(this.api.paths ? this.api.paths : []).forEach(path => {
       paths[path] = {} as Record<RMOAS.HttpMethods, Operation | Webhook>;
+
+      // Though this library is generally unaware of `$ref` pointers we're making a singular
+      // exception with this accessor out of convenience.
+      if ('$ref' in this.api.paths[path]) {
+        this.api.paths[path] = utils.findSchemaDefinition(this.api.paths[path].$ref, this.api);
+      }
+
       Object.keys(this.api.paths[path]).forEach((method: RMOAS.HttpMethods) => {
         if (!supportedMethods.has(method)) return;
 

package/src/lib/find-schema-definition.ts

@@ -1,15 +1,13 @@
-// Nabbed from react-jsonschema-form, but this should probably be extracted into a slim NPM module.
 import jsonpointer from 'jsonpointer';
 
 /**
  * Lookup a reference pointer within an OpenAPI definition and return the schema that it resolves
  * to.
  *
- * @deprecated
  * @param $ref Reference to look up a schema for.
- * @param definitions OpenAPI definition to look for the `$ref` pointer in.
+ * @param definition OpenAPI definition to look for the `$ref` pointer in.
  */
-export default function findSchemaDefinition($ref: string, definitions = {}) {
+export default function findSchemaDefinition($ref: string, definition = {}) {
   const origRef = $ref;
 
   $ref = $ref.trim();
@@ -25,7 +23,7 @@ export default function findSchemaDefinition($ref: string, definitions = {}) {
     throw new Error(`Could not find a definition for ${origRef}.`);
   }
 
-  const current = jsonpointer.get(definitions, $ref);
+  const current = jsonpointer.get(definition, $ref);
   if (current === undefined) {
     throw new Error(`Could not find a definition for ${origRef}.`);
   }

package/src/operation/get-parameters-as-json-schema.ts

@@ -117,7 +117,7 @@ export default function getParametersAsJsonSchema(
     const type = mediaType === 'application/x-www-form-urlencoded' ? 'formData' : 'body';
 
     // If this schema is completely empty, don't bother processing it.
-    if (!Object.keys(mediaTypeObject.schema).length) {
+    if (!mediaTypeObject.schema || !Object.keys(mediaTypeObject.schema).length) {
       return null;
     }