oas 17.1.0 → 17.1.4

package/@types/lib/get-auth.d.ts

@@ -17,7 +17,8 @@ declare type authKey = null | unknown | {
  * @param selectedApp The user app to retrieve an auth key for.
  * @returns The found auth key for this security scheme.
  */
-export declare function getByScheme(user: RMOAS.User, scheme?: RMOAS.KeyedSecuritySchemeObject, selectedApp?: string | number): authKey;
+export declare function getByScheme(user: RMOAS.User, scheme?: RMOAS.KeyedSecuritySchemeObject, // eslint-disable-line default-param-last
+selectedApp?: string | number): authKey;
 /**
  * Retrieve auth keys for an API definition from a given user for a specific "app" that they have configured.
  *

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+## <small>17.1.4 (2021-11-22)</small>
+
+* fix: more protections for when `api` is undefined ([3d217a3](https://github.com/readmeio/oas/commit/3d217a3))
+
+
+
+## <small>17.1.3 (2021-11-20)</small>
+
+* fix: don't fail to fetch an extension on an operation if there's no API definition ([08bc1d6](https://github.com/readmeio/oas/commit/08bc1d6))
+
+
+
+## <small>17.1.2 (2021-11-20)</small>
+
+* fix: issue where searching for an extension in an empty Oas object would fail ([15c7b88](https://github.com/readmeio/oas/commit/15c7b88))
+* fix: upgrading eslint to eslint 8 (#540) ([4d76f71](https://github.com/readmeio/oas/commit/4d76f71)), closes [#540](https://github.com/readmeio/oas/issues/540)
+
+
+
+## <small>17.1.1 (2021-11-13)</small>
+
+* fix: adding error handling to `Oas.operation()` for undefined API definitions ([9c1e633](https://github.com/readmeio/oas/commit/9c1e633))
+* docs: updating the changelog for the 14.9.0 release ([f7e7fd5](https://github.com/readmeio/oas/commit/f7e7fd5))
+* chore: removing some eslint rule exclusions for things that aren't happening ([9c37a43](https://github.com/readmeio/oas/commit/9c37a43))
+
+
+
+## 14.9.0 (2021-11-09)
+
+* feat: replaying callback work on top of the 14.8 release series ([930120d](https://github.com/readmeio/oas/commit/930120d))
+
+
+
 ## 17.1.0 (2021-11-07)
 
 * chore: jest config cleanup ([9396fad](https://github.com/readmeio/oas/commit/9396fad))

package/dist/index.js

@@ -285,6 +285,7 @@ var Oas = /** @class */ (function () {
     Oas.prototype.getDefinition = function () {
         return this.api;
     };
+    // eslint-disable-next-line default-param-last
     Oas.prototype.url = function (selected, variables) {
         if (selected === void 0) { selected = 0; }
         var url = normalizedUrl(this.api, selected);
@@ -441,7 +442,7 @@ var Oas = /** @class */ (function () {
      * @returns The found Operation or Webhook.
      */
     Oas.prototype.operation = function (path, method, opts) {
-        var _a;
+        var _a, _b, _c, _d;
         if (opts === void 0) { opts = {}; }
         // If we're unable to locate an operation for this path+method combination within the API definition, we should
         // still set an empty schema on the operation in the `Operation` class because if we don't trying to use any of the
@@ -457,7 +458,7 @@ var Oas = /** @class */ (function () {
                 return new operation_1.Webhook(api, path, method, operation);
             }
         }
-        if (this.api.paths && this.api.paths[path] && this.api.paths[path][method]) {
+        if ((_d = (_c = (_b = this === null || this === void 0 ? void 0 : this.api) === null || _b === void 0 ? void 0 : _b.paths) === null || _c === void 0 ? void 0 : _c[path]) === null || _d === void 0 ? void 0 : _d[method]) {
             operation = this.api.paths[path][method];
         }
         return new operation_1["default"](this.api, path, method, operation);
@@ -590,8 +591,8 @@ var Oas = /** @class */ (function () {
      * @returns Found auth keys for the found security schemes.
      */
     Oas.prototype.getAuth = function (user, selectedApp) {
-        if (Object.keys(this.api.components || {}).length === 0 ||
-            Object.keys(this.api.components.securitySchemes || {}).length === 0) {
+        var _a, _b;
+        if (!((_b = (_a = this.api) === null || _a === void 0 ? void 0 : _a.components) === null || _b === void 0 ? void 0 : _b.securitySchemes)) {
             return {};
         }
         return (0, get_auth_1["default"])(this.api, user, selectedApp);
@@ -680,7 +681,7 @@ var Oas = /** @class */ (function () {
      * @returns The extension exists.
      */
     Oas.prototype.hasExtension = function (extension) {
-        return extension in this.api;
+        return Boolean(this.api && extension in this.api);
     };
     /**
      * Retrieve a custom specification extension off of the API definition.
@@ -706,7 +707,9 @@ var Oas = /** @class */ (function () {
             var _this = this;
             return __generator(this, function (_b) {
                 if (this.dereferencing.complete) {
-                    return [2 /*return*/, new Promise(function (resolve) { return resolve(true); })];
+                    return [2 /*return*/, new Promise(function (resolve) {
+                            resolve(true);
+                        })];
                 }
                 if (this.dereferencing.processing) {
                     return [2 /*return*/, new Promise(function (resolve, reject) {

package/dist/lib/get-auth.js

@@ -47,7 +47,8 @@ function getKey(user, scheme) {
  * @param selectedApp The user app to retrieve an auth key for.
  * @returns The found auth key for this security scheme.
  */
-function getByScheme(user, scheme, selectedApp) {
+function getByScheme(user, scheme, // eslint-disable-line default-param-last
+selectedApp) {
     if (scheme === void 0) { scheme = {}; }
     if (user === null || user === void 0 ? void 0 : user.keys) {
         if (selectedApp) {
@@ -67,7 +68,8 @@ exports.getByScheme = getByScheme;
  * @returns Found auth keys for the found security schemes.
  */
 function getAuth(api, user, selectedApp) {
-    return Object.keys(api.components.securitySchemes)
+    var _a;
+    return Object.keys(((_a = api === null || api === void 0 ? void 0 : api.components) === null || _a === void 0 ? void 0 : _a.securitySchemes) || {})
         .map(function (scheme) {
         var _a;
         return _a = {},

package/dist/operation/get-callback-examples.js

@@ -13,7 +13,6 @@ var get_response_examples_1 = __importDefault(require("./get-response-examples")
 function getCallbackExamples(operation) {
     var ret = [];
     // spreads the contents of the map for each callback so there's not nested arrays returned
-    // eslint-disable-next-line sonarjs/no-empty-collection
     return ret.concat.apply(ret, Object.keys(operation.callbacks || {}).map(function (identifier) {
         var callback = operation.callbacks[identifier];
         // spreads the contents again so there's not nested arrays returned

package/dist/operation.js

@@ -84,7 +84,8 @@ var Operation = /** @class */ (function () {
      * @returns Array of security requirement objects.
      */
     Operation.prototype.getSecurity = function () {
-        if (!('components' in this.api) || !('securitySchemes' in this.api.components)) {
+        var _a, _b;
+        if (!((_b = (_a = this.api) === null || _a === void 0 ? void 0 : _a.components) === null || _b === void 0 ? void 0 : _b.securitySchemes)) {
             return [];
         }
         return this.schema.security || this.api.security || [];
@@ -438,7 +439,7 @@ var Operation = /** @class */ (function () {
      * @returns The extension exists.
      */
     Operation.prototype.hasExtension = function (extension) {
-        return extension in this.schema;
+        return Boolean(this.schema && extension in this.schema);
     };
     /**
      * Retrieve a custom specification extension off of the operation.
@@ -481,6 +482,3 @@ var Webhook = /** @class */ (function (_super) {
     return Webhook;
 }(Operation));
 exports.Webhook = Webhook;
-module.exports = Operation;
-module.exports.Callback = Callback;
-module.exports.Webhook = Webhook;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "17.1.0",
+  "version": "17.1.4",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -66,12 +66,12 @@
   "devDependencies": {
     "@commitlint/cli": "^14.1.0",
     "@commitlint/config-conventional": "^14.1.0",
-    "@readme/eslint-config": "^7.2.2",
+    "@readme/eslint-config": "^8.0.2",
     "@readme/oas-examples": "^4.3.2",
     "@types/jest": "^27.0.2",
     "@types/json-schema-merge-allof": "^0.6.1",
     "@types/memoizee": "^0.4.6",
-    "eslint": "^7.31.0",
+    "eslint": "^8.2.0",
     "eslint-plugin-jsdoc": "^37.0.3",
     "husky": "^7.0.2",
     "jest": "^27.0.3",

package/src/cli/commands/help.js

@@ -27,7 +27,6 @@ exports.run = function () {
 
     let cmdUsage;
     if (cmd.swagger) {
-      // eslint-disable-next-line sonarjs/no-nested-template-literals
       cmdUsage = `${pad(`${action} [oas.json]`)} ${chalk.grey(desc)}`;
       cmdUsage = cmdUsage.replace(/\[oas\.json\]/, chalk.grey('[oas.json]'));
     } else {

package/src/index.ts

@@ -287,6 +287,7 @@ export default class Oas {
     return this.api;
   }
 
+  // eslint-disable-next-line default-param-last
   url(selected = 0, variables?: Variables) {
     const url = normalizedUrl(this.api, selected);
     return this.replaceUrl(url, variables || this.variables(selected)).trim();
@@ -469,7 +470,7 @@ export default class Oas {
       }
     }
 
-    if (this.api.paths && this.api.paths[path] && this.api.paths[path][method]) {
+    if (this?.api?.paths?.[path]?.[method]) {
       operation = this.api.paths[path][method];
     }
 
@@ -619,10 +620,7 @@ export default class Oas {
    * @returns Found auth keys for the found security schemes.
    */
   getAuth(user: RMOAS.User, selectedApp?: string | number) {
-    if (
-      Object.keys(this.api.components || {}).length === 0 ||
-      Object.keys(this.api.components.securitySchemes || {}).length === 0
-    ) {
+    if (!this.api?.components?.securitySchemes) {
       return {};
     }
 
@@ -719,7 +717,7 @@ export default class Oas {
    * @returns The extension exists.
    */
   hasExtension(extension: string) {
-    return extension in this.api;
+    return Boolean(this.api && extension in this.api);
   }
 
   /**
@@ -742,7 +740,9 @@ export default class Oas {
    */
   async dereference() {
     if (this.dereferencing.complete) {
-      return new Promise(resolve => resolve(true));
+      return new Promise(resolve => {
+        resolve(true);
+      });
     }
 
     if (this.dereferencing.processing) {

package/src/lib/get-auth.ts

@@ -44,7 +44,7 @@ function getKey(user: RMOAS.User, scheme: RMOAS.KeyedSecuritySchemeObject): auth
  */
 export function getByScheme(
   user: RMOAS.User,
-  scheme = <RMOAS.KeyedSecuritySchemeObject>{},
+  scheme = <RMOAS.KeyedSecuritySchemeObject>{}, // eslint-disable-line default-param-last
   selectedApp?: string | number
 ): authKey {
   if (user?.keys) {
@@ -74,7 +74,7 @@ export default function getAuth(
   user: RMOAS.User,
   selectedApp?: string | number
 ) {
-  return Object.keys(api.components.securitySchemes)
+  return Object.keys(api?.components?.securitySchemes || {})
     .map(scheme => {
       return {
         [scheme]: getByScheme(

package/src/operation/get-callback-examples.ts

@@ -18,7 +18,6 @@ export default function getCallbackExamples(operation: RMOAS.OperationObject) {
   const ret: CallbackExamples = [];
 
   // spreads the contents of the map for each callback so there's not nested arrays returned
-  // eslint-disable-next-line sonarjs/no-empty-collection
   return ret.concat(
     ...Object.keys(operation.callbacks || {}).map(identifier => {
       const callback = operation.callbacks[identifier] as RMOAS.CallbackObject;

package/src/operation.ts

@@ -131,7 +131,7 @@ export default class Operation {
    * @returns Array of security requirement objects.
    */
   getSecurity() {
-    if (!('components' in this.api) || !('securitySchemes' in this.api.components)) {
+    if (!this.api?.components?.securitySchemes) {
       return [];
     }
 
@@ -524,7 +524,7 @@ export default class Operation {
    * @returns The extension exists.
    */
   hasExtension(extension: string) {
-    return extension in this.schema;
+    return Boolean(this.schema && extension in this.schema);
   }
 
   /**
@@ -566,7 +566,3 @@ export class Callback extends Operation {
 }
 
 export class Webhook extends Operation {}
-
-module.exports = Operation;
-module.exports.Callback = Callback;
-module.exports.Webhook = Webhook;

package/src/rmoas.types.ts

@@ -1,5 +1,5 @@
 import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
-import type { JSONSchema4, JSONSchema6, JSONSchema7 } from 'json-schema'; // eslint-disable-line import/no-unresolved
+import type { JSONSchema4, JSONSchema6, JSONSchema7 } from 'json-schema';
 
 /**
  * @param check Data to determine if it contains a ReferenceObject (`$ref` pointer`).