oas 18.0.5 → 18.0.8

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## <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)
+
+
+
 ## <small>18.0.5 (2022-03-21)</small>
 
 * fix: `operation.hasOperationId` should return false for an empty string (#624) ([bc23a43](https://github.com/readmeio/oas/commit/bc23a43)), closes [#624](https://github.com/readmeio/oas/issues/624)

package/dist/index.js

@@ -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; });
@@ -294,15 +307,18 @@ var Operation = /** @class */ (function () {
      * @param opts.camelCase Generate a JS method-friendly operation ID when one isn't present.
      */
     Operation.prototype.getOperationId = function (opts) {
+        var operationId;
         if (this.hasOperationId()) {
-            return this.schema.operationId;
+            operationId = this.schema.operationId;
+        }
+        else {
+            operationId = this.path
+                .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
+                .replace(/^-|-$/g, '') // Don't start or end with -
+                .replace(/--+/g, '-') // Remove double --'s
+                .toLowerCase();
         }
         var method = this.method.toLowerCase();
-        var operationId = this.path
-            .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
-            .replace(/^-|-$/g, '') // Don't start or end with -
-            .replace(/--+/g, '-') // Remove double --'s
-            .toLowerCase();
         if (opts === null || opts === void 0 ? void 0 : opts.camelCase) {
             operationId = operationId.replace(/[^a-zA-Z0-9]+(.)/g, function (_, chr) { return chr.toUpperCase(); });
             // If the generated `operationId` already starts with the method (eg. `getPets`) we don't want
@@ -310,9 +326,17 @@ var Operation = /** @class */ (function () {
             if (operationId.startsWith(method)) {
                 return operationId;
             }
+            // If this operation already has an operationId and we just cleaned it up then we shouldn't
+            // prefix it with an HTTP method.
+            if (this.hasOperationId()) {
+                return operationId;
+            }
             operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
             return "".concat(method).concat(operationId);
         }
+        else if (this.hasOperationId()) {
+            return operationId;
+        }
         return "".concat(method, "_").concat(operationId);
     };
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "18.0.5",
+  "version": "18.0.8",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -70,6 +70,7 @@
     "@commitlint/config-conventional": "^16.0.0",
     "@readme/eslint-config": "^8.5.0",
     "@readme/oas-examples": "^4.3.2",
+    "@readme/openapi-parser": "^2.0.4",
     "@types/jest": "^27.0.2",
     "@types/json-schema-merge-allof": "^0.6.1",
     "@types/memoizee": "^0.4.6",

package/src/index.ts

@@ -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);
@@ -331,17 +335,18 @@ export default class Operation {
    * @param opts.camelCase Generate a JS method-friendly operation ID when one isn't present.
    */
   getOperationId(opts?: { camelCase: boolean }): string {
+    let operationId;
     if (this.hasOperationId()) {
-      return this.schema.operationId;
+      operationId = this.schema.operationId;
+    } else {
+      operationId = this.path
+        .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
+        .replace(/^-|-$/g, '') // Don't start or end with -
+        .replace(/--+/g, '-') // Remove double --'s
+        .toLowerCase();
     }
 
     const method = this.method.toLowerCase();
-    let operationId = this.path
-      .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
-      .replace(/^-|-$/g, '') // Don't start or end with -
-      .replace(/--+/g, '-') // Remove double --'s
-      .toLowerCase();
-
     if (opts?.camelCase) {
       operationId = operationId.replace(/[^a-zA-Z0-9]+(.)/g, (_, chr) => chr.toUpperCase());
 
@@ -351,8 +356,16 @@ export default class Operation {
         return operationId;
       }
 
+      // If this operation already has an operationId and we just cleaned it up then we shouldn't
+      // prefix it with an HTTP method.
+      if (this.hasOperationId()) {
+        return operationId;
+      }
+
       operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
       return `${method}${operationId}`;
+    } else if (this.hasOperationId()) {
+      return operationId;
     }
 
     return `${method}_${operationId}`;