oas 18.0.6 → 18.1.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 18.1.0 (2022-03-31)
+
+* feat: moving us over to our json-schema-ref-parser fork (#629) ([b986f35](https://github.com/readmeio/oas/commit/b986f35)), closes [#629](https://github.com/readmeio/oas/issues/629)
+
+
+
+## <small>18.0.8 (2022-03-29)</small>
+
+* fix: improved error handling on `Oas.findOperation()` calls (#628) ([22198dd](https://github.com/readmeio/oas/commit/22198dd)), closes [#628](https://github.com/readmeio/oas/issues/628)
+
+
+
+## <small>18.0.7 (2022-03-24)</small>
+
+* fix: getSecurity() should return an empty array for an empty securitySchemes object (#626) ([f96bee1](https://github.com/readmeio/oas/commit/f96bee1)), closes [#626](https://github.com/readmeio/oas/issues/626)
+* fix: issue where a securityScheme may be corrupted with internal library data (#627) ([666ba9f](https://github.com/readmeio/oas/commit/666ba9f)), closes [#627](https://github.com/readmeio/oas/issues/627)
+
+
+
 ## <small>18.0.6 (2022-03-21)</small>
 
 * feat: `camelCase` opt on `getOperationId()` should clean IDs if present (#625) ([6ab85df](https://github.com/readmeio/oas/commit/6ab85df)), closes [#625](https://github.com/readmeio/oas/issues/625)

package/dist/index.js

@@ -74,7 +74,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 exports.__esModule = true;
 exports.utils = exports.Webhook = exports.Callback = exports.Operation = void 0;
-var json_schema_ref_parser_1 = __importDefault(require("@apidevtools/json-schema-ref-parser"));
+var json_schema_ref_parser_1 = __importDefault(require("@readme/json-schema-ref-parser"));
 var path_to_regexp_1 = require("path-to-regexp");
 var get_auth_1 = __importDefault(require("./lib/get-auth"));
 var get_user_variable_1 = __importDefault(require("./lib/get-user-variable"));
@@ -197,14 +197,23 @@ function generatePathMatches(paths, pathName, origin) {
     return Object.keys(paths)
         .map(function (path) {
         var cleanedPath = normalizePath(path);
-        var matchStatement = (0, path_to_regexp_1.match)(cleanedPath, { decode: decodeURIComponent });
-        var matchResult = matchStatement(prunedPathName);
+        var matchResult;
+        try {
+            var matchStatement = (0, path_to_regexp_1.match)(cleanedPath, { decode: decodeURIComponent });
+            matchResult = matchStatement(prunedPathName);
+        }
+        catch (err) {
+            // If path matching fails for whatever reason (maybe they have a malformed path parameter)
+            // then we shouldn't also fail.
+            return;
+        }
         var slugs = {};
         if (matchResult && Object.keys(matchResult.params).length) {
             Object.keys(matchResult.params).forEach(function (param) {
                 slugs[":".concat(param)] = matchResult.params[param];
             });
         }
+        // eslint-disable-next-line consistent-return
         return {
             url: {
                 origin: origin,
@@ -216,6 +225,7 @@ function generatePathMatches(paths, pathName, origin) {
             match: matchResult
         };
     })
+        .filter(Boolean)
         .filter(function (p) { return p.match; });
 }
 /**

package/dist/operation.js

@@ -14,6 +14,17 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -122,7 +133,7 @@ var Operation = /** @class */ (function () {
      */
     Operation.prototype.getSecurity = function () {
         var _a, _b;
-        if (!((_b = (_a = this.api) === null || _a === void 0 ? void 0 : _a.components) === null || _b === void 0 ? void 0 : _b.securitySchemes)) {
+        if (!((_b = (_a = this.api) === null || _a === void 0 ? void 0 : _a.components) === null || _b === void 0 ? void 0 : _b.securitySchemes) || !Object.keys(this.api.components.securitySchemes).length) {
             return [];
         }
         return this.schema.security || this.api.security || [];
@@ -185,8 +196,10 @@ var Operation = /** @class */ (function () {
                 else {
                     return false;
                 }
-                security._key = key;
-                return { type: type, security: security };
+                return {
+                    type: type,
+                    security: __assign(__assign({}, security), { _key: key })
+                };
             });
             if (filterInvalid)
                 return keysWithTypes.filter(function (key) { return key !== false; });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "18.0.6",
+  "version": "18.1.0",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -49,8 +49,8 @@
     "watch": "tsc --watch"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^9.0.6",
-    "@types/json-schema": "^7.0.9",
+    "@readme/json-schema-ref-parser": "^1.1.0",
+    "@types/json-schema": "^7.0.11",
     "cardinal": "^2.1.1",
     "chalk": "^4.1.2",
     "glob": "^7.1.2",
@@ -60,27 +60,27 @@
     "jsonpointer": "^5.0.0",
     "memoizee": "^0.4.14",
     "minimist": "^1.2.0",
-    "oas-normalize": "^5.1.2",
+    "oas-normalize": "^5.2.0",
     "openapi-types": "^10.0.0",
     "path-to-regexp": "^6.2.0",
-    "swagger-inline": "^5.1.0"
+    "swagger-inline": "^5.2.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.0.1",
+    "@commitlint/cli": "^16.2.3",
     "@commitlint/config-conventional": "^16.0.0",
-    "@readme/eslint-config": "^8.5.0",
-    "@readme/oas-examples": "^4.3.2",
+    "@readme/eslint-config": "^8.5.1",
+    "@readme/oas-examples": "^5.0.0",
+    "@readme/openapi-parser": "^2.0.4",
     "@types/jest": "^27.0.2",
     "@types/json-schema-merge-allof": "^0.6.1",
     "@types/memoizee": "^0.4.6",
     "alex": "^10.0.0",
-    "eslint": "^8.6.0",
-    "eslint-plugin-jsdoc": "^37.0.3",
+    "eslint": "^8.12.0",
     "husky": "^7.0.2",
     "jest": "^27.0.3",
-    "prettier": "^2.5.1",
-    "ts-jest": "^27.0.7",
-    "typescript": "^4.4.4"
+    "prettier": "^2.6.1",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.3"
   },
   "prettier": "@readme/eslint-config/prettier",
   "commitlint": {

package/src/index.ts

@@ -2,7 +2,7 @@ import type * as RMOAS from './rmoas.types';
 import type { OpenAPIV3_1 } from 'openapi-types';
 import type { MatchResult } from 'path-to-regexp';
 
-import $RefParser from '@apidevtools/json-schema-ref-parser';
+import $RefParser from '@readme/json-schema-ref-parser';
 import { pathToRegexp, match } from 'path-to-regexp';
 import getAuth from './lib/get-auth';
 import getUserVariable from './lib/get-user-variable';
@@ -147,8 +147,17 @@ function generatePathMatches(paths: RMOAS.PathsObject, pathName: string, origin:
   return Object.keys(paths)
     .map(path => {
       const cleanedPath = normalizePath(path);
-      const matchStatement = match(cleanedPath, { decode: decodeURIComponent });
-      const matchResult = matchStatement(prunedPathName);
+
+      let matchResult: MatchResult;
+      try {
+        const matchStatement = match(cleanedPath, { decode: decodeURIComponent });
+        matchResult = matchStatement(prunedPathName) as MatchResult;
+      } catch (err) {
+        // If path matching fails for whatever reason (maybe they have a malformed path parameter)
+        // then we shouldn't also fail.
+        return;
+      }
+
       const slugs: Record<string, string> = {};
 
       if (matchResult && Object.keys(matchResult.params).length) {
@@ -157,6 +166,7 @@ function generatePathMatches(paths: RMOAS.PathsObject, pathName: string, origin:
         });
       }
 
+      // eslint-disable-next-line consistent-return
       return {
         url: {
           origin,
@@ -168,6 +178,7 @@ function generatePathMatches(paths: RMOAS.PathsObject, pathName: string, origin:
         match: matchResult,
       };
     })
+    .filter(Boolean)
     .filter(p => p.match) as PathMatches;
 }
 

package/src/operation.ts

@@ -146,7 +146,7 @@ export default class Operation {
    *
    */
   getSecurity(): RMOAS.SecurityRequirementObject[] {
-    if (!this.api?.components?.securitySchemes) {
+    if (!this.api?.components?.securitySchemes || !Object.keys(this.api.components.securitySchemes).length) {
       return [];
     }
 
@@ -204,9 +204,13 @@ export default class Operation {
           return false;
         }
 
-        security._key = key;
-
-        return { type, security };
+        return {
+          type,
+          security: {
+            ...security,
+            _key: key,
+          },
+        };
       });
 
       if (filterInvalid) return keysWithTypes.filter(key => key !== false);