oas 18.0.7 → 18.1.1

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## <small>18.1.1 (2022-04-06)</small>
+
+* feat: `operation.getOperationId()` will now always return a "clean" operationID (#631) ([6c91fbd](https://github.com/readmeio/oas/commit/6c91fbd)), closes [#631](https://github.com/readmeio/oas/issues/631)
+* test: adding tests for openapi 3.1 $ref and description handling ([ac64a4c](https://github.com/readmeio/oas/commit/ac64a4c))
+* chore(deps): bump inquirer from 8.2.0 to 8.2.2 (#630) ([1802fd6](https://github.com/readmeio/oas/commit/1802fd6)), closes [#630](https://github.com/readmeio/oas/issues/630)
+
+
+
+## 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)

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

@@ -335,7 +335,13 @@ var Operation = /** @class */ (function () {
             return "".concat(method).concat(operationId);
         }
         else if (this.hasOperationId()) {
-            return operationId;
+            // If we aren't creating a programming language-friendly accessor off this operationID we
+            // should still make sure that it doesn't have any weird characters that might throw off
+            // something like AJV when it's set as an `$id` property in a JSON Schema representation.
+            //
+            // And though `_` is non-alphanumeric it's okay in this because it's a neutral enough
+            // character we can use for delineation and it won't harm anything.
+            return operationId.replace(/[^a-zA-Z0-9_]/g, '_').replace(/__+/g, '_');
         }
         return "".concat(method, "_").concat(operationId);
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "18.0.7",
+  "version": "18.1.1",
   "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,28 +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

@@ -365,7 +365,13 @@ export default class Operation {
       operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
       return `${method}${operationId}`;
     } else if (this.hasOperationId()) {
-      return operationId;
+      // If we aren't creating a programming language-friendly accessor off this operationID we
+      // should still make sure that it doesn't have any weird characters that might throw off
+      // something like AJV when it's set as an `$id` property in a JSON Schema representation.
+      //
+      // And though `_` is non-alphanumeric it's okay in this because it's a neutral enough
+      // character we can use for delineation and it won't harm anything.
+      return operationId.replace(/[^a-zA-Z0-9_]/g, '_').replace(/__+/g, '_');
     }
 
     return `${method}_${operationId}`;