oas 17.1.3 → 17.2.0

package/@types/operation/get-parameters-as-json-schema.d.ts

@@ -1,4 +1,4 @@
-declare function _exports(path: string, operation: any, api: any, globalDefaults?: Object): any;
+declare function _exports(path: string, operation: Operation, api: OpenAPI.Document, globalDefaults?: Object): array<object>;
 declare namespace _exports {
     export { types };
 }

package/@types/operation.d.ts

@@ -119,7 +119,7 @@ export default class Operation {
      * @param globalDefaults An object of global defaults to apply as a `default` in the returned JSON Schema.
      * @returns An array of JSON Schema objects.
      */
-    getParametersAsJsonSchema(globalDefaults?: unknown): any;
+    getParametersAsJsonSchema(globalDefaults?: unknown): array<object>;
     /**
      * Get a single response for this status code, formatted as JSON schema.
      *

package/CHANGELOG.md

@@ -1,3 +1,42 @@
+## 17.2.0 (2021-12-02)
+
+* chore(deps-dev): bump @commitlint/cli from 14.1.0 to 15.0.0 (#552) ([b03dbd3](https://github.com/readmeio/oas/commit/b03dbd3)), closes [#552](https://github.com/readmeio/oas/issues/552)
+* chore(deps-dev): bump @commitlint/config-conventional (#547) ([6b1c0b7](https://github.com/readmeio/oas/commit/6b1c0b7)), closes [#547](https://github.com/readmeio/oas/issues/547)
+* chore(deps-dev): bump @types/jest from 27.0.2 to 27.0.3 (#549) ([6356929](https://github.com/readmeio/oas/commit/6356929)), closes [#549](https://github.com/readmeio/oas/issues/549)
+* chore(deps-dev): bump eslint from 8.2.0 to 8.3.0 (#553) ([8d945f6](https://github.com/readmeio/oas/commit/8d945f6)), closes [#553](https://github.com/readmeio/oas/issues/553)
+* chore(deps-dev): bump eslint-plugin-jsdoc from 37.0.3 to 37.1.0 (#554) ([f7567a1](https://github.com/readmeio/oas/commit/f7567a1)), closes [#554](https://github.com/readmeio/oas/issues/554)
+* chore(deps-dev): bump jest from 27.3.1 to 27.4.3 (#544) ([6b9e3f1](https://github.com/readmeio/oas/commit/6b9e3f1)), closes [#544](https://github.com/readmeio/oas/issues/544)
+* chore(deps-dev): bump prettier from 2.4.1 to 2.5.0 (#555) ([c09af34](https://github.com/readmeio/oas/commit/c09af34)), closes [#555](https://github.com/readmeio/oas/issues/555)
+* chore(deps-dev): bump typescript from 4.4.4 to 4.5.2 (#548) ([f30435c](https://github.com/readmeio/oas/commit/f30435c)), closes [#548](https://github.com/readmeio/oas/issues/548)
+* chore(deps): bump actions/checkout from 2.3.5 to 2.4.0 (#543) ([770a69e](https://github.com/readmeio/oas/commit/770a69e)), closes [#543](https://github.com/readmeio/oas/issues/543)
+* chore(deps): bump actions/setup-node from 2.4.1 to 2.5.0 (#542) ([16aabb8](https://github.com/readmeio/oas/commit/16aabb8)), closes [#542](https://github.com/readmeio/oas/issues/542)
+* chore(deps): bump oas-normalize from 5.0.1 to 5.0.2 (#550) ([f5cb67a](https://github.com/readmeio/oas/commit/f5cb67a)), closes [#550](https://github.com/readmeio/oas/issues/550)
+* chore(deps): bump oas-normalize from 5.0.2 to 5.0.3 (#556) ([f3a829b](https://github.com/readmeio/oas/commit/f3a829b)), closes [#556](https://github.com/readmeio/oas/issues/556)
+* chore(deps): bump openapi-types from 9.3.0 to 9.3.1 (#546) ([aeafb36](https://github.com/readmeio/oas/commit/aeafb36)), closes [#546](https://github.com/readmeio/oas/issues/546)
+* chore(deps): bump swagger-inline from 4.2.2 to 5.0.2 (#551) ([0d095d3](https://github.com/readmeio/oas/commit/0d095d3)), closes [#551](https://github.com/readmeio/oas/issues/551)
+* ci: ignoring chalk updates because its now an esm-only package ([d0c97f1](https://github.com/readmeio/oas/commit/d0c97f1))
+
+
+
+## <small>17.1.6 (2021-11-29)</small>
+
+* fix: exposing response header descriptions in response json schema (#541) ([d6abf9e](https://github.com/readmeio/oas/commit/d6abf9e)), closes [#541](https://github.com/readmeio/oas/issues/541)
+
+
+
+## <small>17.1.5 (2021-11-22)</small>
+
+* fix: don't fail to dereference if the api definition is nullish ([e1e33a6](https://github.com/readmeio/oas/commit/e1e33a6))
+* test: adding more tests for null specs in `getAuth()` ([c8585c9](https://github.com/readmeio/oas/commit/c8585c9))
+
+
+
+## <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))

package/dist/index.js

@@ -88,12 +88,12 @@ function ensureProtocol(url) {
     // Add protocol to urls starting with // e.g. //example.com
     // This is because httpsnippet throws a HARError when it doesnt have a protocol
     if (url.match(/^\/\//)) {
-        return "https:" + url;
+        return "https:".concat(url);
     }
     // Add protocol to urls with no // within them
     // This is because httpsnippet throws a HARError when it doesnt have a protocol
     if (!url.match(/\/\//)) {
-        return "https://" + url;
+        return "https://".concat(url);
     }
     return url;
 }
@@ -188,7 +188,7 @@ function generatePathMatches(paths, pathName, origin) {
         var slugs = {};
         if (matchResult && Object.keys(matchResult.params).length) {
             Object.keys(matchResult.params).forEach(function (param) {
-                slugs[":" + param] = matchResult.params[param];
+                slugs[":".concat(param)] = matchResult.params[param];
             });
         }
         return {
@@ -326,7 +326,7 @@ var Oas = /** @class */ (function () {
             var value = part.replace(/[{}]/g, '');
             // To ensure unique keys, we're going to create a key
             // with the value concatenated to its index.
-            var key = value + "-" + i;
+            var key = "".concat(value, "-").concat(i);
             if (!isVariable) {
                 return {
                     type: 'text',
@@ -591,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);
@@ -727,7 +727,7 @@ var Oas = /** @class */ (function () {
                     });
                 }
                 return [2 /*return*/, json_schema_ref_parser_1["default"]
-                        .dereference(api, {
+                        .dereference(api || {}, {
                         resolve: {
                             // We shouldn't be resolving external pointers at this point so just ignore them.
                             external: false

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

@@ -23,11 +23,11 @@ function findSchemaDefinition($ref, definitions) {
         $ref = decodeURIComponent($ref.substring(1));
     }
     else {
-        throw new Error("Could not find a definition for " + origRef + ".");
+        throw new Error("Could not find a definition for ".concat(origRef, "."));
     }
     var current = jsonpointer_1["default"].get(definitions, $ref);
     if (current === undefined) {
-        throw new Error("Could not find a definition for " + origRef + ".");
+        throw new Error("Could not find a definition for ".concat(origRef, "."));
     }
     return current;
 }

package/dist/lib/get-auth.js

@@ -68,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/lib/openapi-to-json-schema.js

@@ -137,7 +137,7 @@ function searchForExampleByPointer(pointer, examples) {
     var pointers = [];
     var point = '';
     for (var i = 0; i < locSplit.length; i += 1) {
-        point = "/" + locSplit[i] + point;
+        point = "/".concat(locSplit[i]).concat(point);
         pointers.push(point);
     }
     var example;
@@ -230,7 +230,7 @@ function toJSONSchema(data, opts) {
         if (polyType in schema && Array.isArray(schema[polyType])) {
             schema[polyType].forEach(function (item, idx) {
                 var polyOptions = {
-                    currentLocation: currentLocation + "/" + idx,
+                    currentLocation: "".concat(currentLocation, "/").concat(idx),
                     globalDefaults: globalDefaults,
                     isPolymorphicAllOfChild: polyType === 'allOf',
                     prevSchemas: prevSchemas,
@@ -360,7 +360,7 @@ function toJSONSchema(data, opts) {
             else {
                 // Run through the arrays contents and clean them up.
                 schema.items = toJSONSchema(schema.items, {
-                    currentLocation: currentLocation + "/0",
+                    currentLocation: "".concat(currentLocation, "/0"),
                     globalDefaults: globalDefaults,
                     prevSchemas: prevSchemas,
                     refLogger: refLogger
@@ -384,7 +384,7 @@ function toJSONSchema(data, opts) {
         if ('properties' in schema) {
             Object.keys(schema.properties).map(function (prop) {
                 schema.properties[prop] = toJSONSchema(schema.properties[prop], {
-                    currentLocation: currentLocation + "/" + encodePointer(prop),
+                    currentLocation: "".concat(currentLocation, "/").concat(encodePointer(prop)),
                     globalDefaults: globalDefaults,
                     prevSchemas: prevSchemas,
                     refLogger: refLogger
@@ -422,14 +422,14 @@ function toJSONSchema(data, opts) {
     // `format` and `type` they adhere to.
     if ('format' in schema) {
         var formatUpper = schema.format.toUpperCase();
-        if (formatUpper + "_MIN" in FORMAT_OPTIONS) {
-            if ((!schema.minimum && schema.minimum !== 0) || schema.minimum < FORMAT_OPTIONS[formatUpper + "_MIN"]) {
-                schema.minimum = FORMAT_OPTIONS[formatUpper + "_MIN"];
+        if ("".concat(formatUpper, "_MIN") in FORMAT_OPTIONS) {
+            if ((!schema.minimum && schema.minimum !== 0) || schema.minimum < FORMAT_OPTIONS["".concat(formatUpper, "_MIN")]) {
+                schema.minimum = FORMAT_OPTIONS["".concat(formatUpper, "_MIN")];
             }
         }
-        if (formatUpper + "_MAX" in FORMAT_OPTIONS) {
-            if ((!schema.maximum && schema.maximum !== 0) || schema.maximum > FORMAT_OPTIONS[formatUpper + "_MAX"]) {
-                schema.maximum = FORMAT_OPTIONS[formatUpper + "_MAX"];
+        if ("".concat(formatUpper, "_MAX") in FORMAT_OPTIONS) {
+            if ((!schema.maximum && schema.maximum !== 0) || schema.maximum > FORMAT_OPTIONS["".concat(formatUpper, "_MAX")]) {
+                schema.maximum = FORMAT_OPTIONS["".concat(formatUpper, "_MAX")];
             }
         }
     }

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

@@ -172,7 +172,7 @@ module.exports = function (path, operation, api, globalDefaults) {
                     if (current.deprecated)
                         currentSchema.deprecated = current.deprecated;
                     schema = __assign({}, toJSONSchema(currentSchema, {
-                        currentLocation: "/" + current.name,
+                        currentLocation: "/".concat(current.name),
                         globalDefaults: globalDefaults,
                         refLogger: refLogger
                     }));
@@ -212,7 +212,7 @@ module.exports = function (path, operation, api, globalDefaults) {
                             if (current.deprecated)
                                 currentSchema.deprecated = current.deprecated;
                             schema = __assign({}, toJSONSchema(currentSchema, {
-                                currentLocation: "/" + current.name,
+                                currentLocation: "/".concat(current.name),
                                 globalDefaults: globalDefaults,
                                 refLogger: refLogger
                             }));

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

@@ -22,6 +22,9 @@ function buildHeadersSchema(response) {
             //    This means they can have content instead of schema.
             //    We should probably support that in the future
             headersSchema.properties[key] = toJSONSchema(headers[key].schema);
+            if (headers[key].description) {
+                headersSchema.properties[key].description = headers[key].description;
+            }
         }
     });
     var headersWrapper = {

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 || [];
@@ -256,7 +257,7 @@ var Operation = /** @class */ (function () {
             .replace(/^-|-$/g, '') // Don't start or end with -
             .replace(/--+/g, '-') // Remove double --'s
             .toLowerCase();
-        return this.method.toLowerCase() + "_" + url;
+        return "".concat(this.method.toLowerCase(), "_").concat(url);
     };
     /**
      * @returns An array of all tags, and their metadata, that exist on this operation.

package/dist/samples/index.js

@@ -25,11 +25,11 @@ var primitive = function (schema) {
     schema = (0, utils_1.objectify)(schema);
     var type = schema.type, format = schema.format;
     // @todo add support for if `type` is an array
-    var fn = primitives[type + "_" + format] || primitives[type];
+    var fn = primitives["".concat(type, "_").concat(format)] || primitives[type];
     if ((0, utils_1.isFunc)(fn)) {
         return fn(schema);
     }
-    return "Unknown Type: " + schema.type;
+    return "Unknown Type: ".concat(schema.type);
 };
 /**
  * Generate a piece of sample data from a JSON Schema object. If `example` declarations are present they will be

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "17.1.3",
+  "version": "17.2.0",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -61,11 +61,11 @@
     "oas-normalize": "^5.0.1",
     "openapi-types": "^9.3.0",
     "path-to-regexp": "^6.2.0",
-    "swagger-inline": "^4.1.5"
+    "swagger-inline": "^5.0.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^14.1.0",
-    "@commitlint/config-conventional": "^14.1.0",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
     "@readme/eslint-config": "^8.0.2",
     "@readme/oas-examples": "^4.3.2",
     "@types/jest": "^27.0.2",

package/src/index.ts

@@ -620,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 {};
     }
 
@@ -768,7 +765,7 @@ export default class Oas {
     }
 
     return $RefParser
-      .dereference(api, {
+      .dereference(api || {}, {
         resolve: {
           // We shouldn't be resolving external pointers at this point so just ignore them.
           external: false,

package/src/lib/get-auth.ts

@@ -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-response-as-json-schema.js

@@ -25,6 +25,9 @@ function buildHeadersSchema(response) {
       //    This means they can have content instead of schema.
       //    We should probably support that in the future
       headersSchema.properties[key] = toJSONSchema(headers[key].schema);
+      if (headers[key].description) {
+        headersSchema.properties[key].description = headers[key].description;
+      }
     }
   });
 

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 [];
     }