oas 20.8.2 → 20.8.4

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## <small>20.8.4 (2023-05-23)</small>
+
+* chore: minor annoying spacing fix ([20535b1](https://github.com/readmeio/oas/commit/20535b1))
+* chore(deps-dev): bumping out of date deps ([5aa85a3](https://github.com/readmeio/oas/commit/5aa85a3))
+* fix: ensure summaries + descriptions are strings (#764) ([2b1338e](https://github.com/readmeio/oas/commit/2b1338e)), closes [#764](https://github.com/readmeio/oas/issues/764) [/github.com/readmeio/oas/pull/764#discussion_r1203069976](https://github.com//github.com/readmeio/oas/pull/764/issues/discussion_r1203069976)
+
+
+
+## <small>20.8.3 (2023-05-11)</small>
+
+* feat: split mixed json schema types with booleans out into a oneOf (#763) ([0e1014a](https://github.com/readmeio/oas/commit/0e1014a)), closes [#763](https://github.com/readmeio/oas/issues/763)
+
+
+
 ## <small>20.8.2 (2023-05-04)</small>
 
 * feat: adding a broken skipped test, retaining soeme more jsonschema props ([94436b8](https://github.com/readmeio/oas/commit/94436b8))

package/dist/lib/openapi-to-json-schema.js

@@ -411,7 +411,7 @@ function toJSONSchema(data, opts) {
             if (schema.type.length === 1) {
                 schema.type = schema.type.shift();
             }
-            else if (schema.type.includes('array') || schema.type.includes('object')) {
+            else if (schema.type.includes('array') || schema.type.includes('boolean') || schema.type.includes('object')) {
                 // If we have a `null` type but there's only two types present then we can remove `null`
                 // as an option and flag the whole schema as `nullable`.
                 var isNullable_1 = schema.type.includes('null');
@@ -422,10 +422,11 @@ function toJSONSchema(data, opts) {
                     // If this mixed type has non-primitives then we for convenience of our implementation
                     // we're moving them into a `oneOf`.
                     var nonPrimitives_1 = [];
-                    // Because we're moving an `array` and/or an `object` into a `oneOf` we also want to take
-                    // with it its specific properties that maybe present on our current schema.
+                    // Because arrays, booleans, and objects are not compatible with any other schem type
+                    // other than null we're moving them into an isolated `oneOf`, and as such want to take
+                    // with it its specific properties that may be present on our current schema.
                     Object.entries({
-                        // json-schema.org/understanding-json-schema/reference/array.html
+                        // https://json-schema.org/understanding-json-schema/reference/array.html
                         array: [
                             'additionalItems',
                             'contains',
@@ -437,6 +438,10 @@ function toJSONSchema(data, opts) {
                             'prefixItems',
                             'uniqueItems',
                         ],
+                        // https://json-schema.org/understanding-json-schema/reference/boolean.html
+                        boolean: [
+                        // Booleans don't have any boolean-specific properties.
+                        ],
                         // https://json-schema.org/understanding-json-schema/reference/object.html
                         object: [
                             'additionalProperties',
@@ -471,7 +476,7 @@ function toJSONSchema(data, opts) {
                         });
                         nonPrimitives_1.push(reducedSchema);
                     });
-                    schema.type = schema.type.filter(function (t) { return t !== 'array' && t !== 'object'; });
+                    schema.type = schema.type.filter(function (t) { return t !== 'array' && t !== 'boolean' && t !== 'object'; });
                     if (schema.type.length === 1) {
                         schema.type = schema.type.shift();
                     }

package/dist/operation.js

@@ -85,20 +85,20 @@ var Operation = /** @class */ (function () {
     }
     Operation.prototype.getSummary = function () {
         var _a;
-        if ((_a = this.schema) === null || _a === void 0 ? void 0 : _a.summary) {
-            return this.schema.summary.trim();
+        if (((_a = this.schema) === null || _a === void 0 ? void 0 : _a.summary) && typeof this.schema.summary === 'string') {
+            return this.schema.summary;
         }
-        else if (this.api.paths[this.path].summary) {
+        else if (this.api.paths[this.path].summary && typeof this.api.paths[this.path].summary === 'string') {
             return this.api.paths[this.path].summary;
         }
         return undefined;
     };
     Operation.prototype.getDescription = function () {
         var _a;
-        if ((_a = this.schema) === null || _a === void 0 ? void 0 : _a.description) {
-            return this.schema.description.trim();
+        if (((_a = this.schema) === null || _a === void 0 ? void 0 : _a.description) && typeof this.schema.description === 'string') {
+            return this.schema.description;
         }
-        else if (this.api.paths[this.path].description) {
+        else if (this.api.paths[this.path].description && typeof this.api.paths[this.path].description === 'string') {
             return this.api.paths[this.path].description;
         }
         return undefined;
@@ -709,20 +709,20 @@ var Callback = /** @class */ (function (_super) {
     };
     Callback.prototype.getSummary = function () {
         var _a;
-        if ((_a = this.schema) === null || _a === void 0 ? void 0 : _a.summary) {
-            return this.schema.summary.trim();
+        if (((_a = this.schema) === null || _a === void 0 ? void 0 : _a.summary) && typeof this.schema.summary === 'string') {
+            return this.schema.summary;
         }
-        else if (this.parentSchema.summary) {
+        else if (this.parentSchema.summary && typeof this.parentSchema.summary === 'string') {
             return this.parentSchema.summary;
         }
         return undefined;
     };
     Callback.prototype.getDescription = function () {
         var _a;
-        if ((_a = this.schema) === null || _a === void 0 ? void 0 : _a.description) {
-            return this.schema.description.trim();
+        if (((_a = this.schema) === null || _a === void 0 ? void 0 : _a.description) && typeof this.schema.description === 'string') {
+            return this.schema.description;
         }
-        else if (this.parentSchema.description) {
+        else if (this.parentSchema.description && typeof this.parentSchema.description === 'string') {
             return this.parentSchema.description;
         }
         return undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "20.8.2",
+  "version": "20.8.4",
   "description": "Comprehensive tooling for working with OpenAPI definitions",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -53,21 +53,21 @@
     "jsonpointer": "^5.0.0",
     "memoizee": "^0.4.14",
     "oas-normalize": "^8.4.0",
-    "openapi-types": "^12.1.0",
+    "openapi-types": "^12.1.1",
     "path-to-regexp": "^6.2.0",
     "remove-undefined-objects": "^2.0.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.1",
-    "@commitlint/config-conventional": "^17.6.1",
+    "@commitlint/cli": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
     "@readme/eslint-config": "^10.5.2",
     "@readme/oas-examples": "^5.11.1",
     "@readme/openapi-parser": "^2.5.0",
     "@types/jest": "^29.5.1",
     "@types/json-schema-merge-allof": "^0.6.1",
     "@types/memoizee": "^0.4.6",
-    "@types/node": "^18.16.0",
-    "eslint": "^8.39.0",
+    "@types/node": "^20.2.3",
+    "eslint": "^8.41.0",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
     "prettier": "^2.8.8",

package/src/lib/helpers.ts

@@ -7,6 +7,7 @@ export function hasSchemaType(schema: SchemaObject, discriminator: 'array' | 'ob
 
   return schema.type === discriminator;
 }
+
 export function isPrimitive(val: unknown): boolean {
   return typeof val === 'string' || typeof val === 'number' || typeof val === 'boolean';
 }

package/src/lib/openapi-to-json-schema.ts

@@ -456,7 +456,7 @@ export default function toJSONSchema(
       // We don't need `type: [<type>]` when we can just as easily make it `type: <type>`.
       if (schema.type.length === 1) {
         schema.type = schema.type.shift();
-      } else if (schema.type.includes('array') || schema.type.includes('object')) {
+      } else if (schema.type.includes('array') || schema.type.includes('boolean') || schema.type.includes('object')) {
         // If we have a `null` type but there's only two types present then we can remove `null`
         // as an option and flag the whole schema as `nullable`.
         const isNullable = schema.type.includes('null');
@@ -468,10 +468,11 @@ export default function toJSONSchema(
           // we're moving them into a `oneOf`.
           const nonPrimitives: any[] = [];
 
-          // Because we're moving an `array` and/or an `object` into a `oneOf` we also want to take
-          // with it its specific properties that maybe present on our current schema.
+          // Because arrays, booleans, and objects are not compatible with any other schem type
+          // other than null we're moving them into an isolated `oneOf`, and as such want to take
+          // with it its specific properties that may be present on our current schema.
           Object.entries({
-            // json-schema.org/understanding-json-schema/reference/array.html
+            // https://json-schema.org/understanding-json-schema/reference/array.html
             array: [
               'additionalItems',
               'contains',
@@ -484,6 +485,11 @@ export default function toJSONSchema(
               'uniqueItems',
             ],
 
+            // https://json-schema.org/understanding-json-schema/reference/boolean.html
+            boolean: [
+              // Booleans don't have any boolean-specific properties.
+            ],
+
             // https://json-schema.org/understanding-json-schema/reference/object.html
             object: [
               'additionalProperties',
@@ -521,7 +527,7 @@ export default function toJSONSchema(
             nonPrimitives.push(reducedSchema);
           });
 
-          schema.type = schema.type.filter(t => t !== 'array' && t !== 'object');
+          schema.type = schema.type.filter(t => t !== 'array' && t !== 'boolean' && t !== 'object');
           if (schema.type.length === 1) {
             schema.type = schema.type.shift();
           }

package/src/operation.ts

@@ -78,9 +78,9 @@ export default class Operation {
   }
 
   getSummary(): string {
-    if (this.schema?.summary) {
-      return this.schema.summary.trim();
-    } else if (this.api.paths[this.path].summary) {
+    if (this.schema?.summary && typeof this.schema.summary === 'string') {
+      return this.schema.summary;
+    } else if (this.api.paths[this.path].summary && typeof this.api.paths[this.path].summary === 'string') {
       return this.api.paths[this.path].summary;
     }
 
@@ -88,9 +88,9 @@ export default class Operation {
   }
 
   getDescription(): string {
-    if (this.schema?.description) {
-      return this.schema.description.trim();
-    } else if (this.api.paths[this.path].description) {
+    if (this.schema?.description && typeof this.schema.description === 'string') {
+      return this.schema.description;
+    } else if (this.api.paths[this.path].description && typeof this.api.paths[this.path].description === 'string') {
       return this.api.paths[this.path].description;
     }
 
@@ -854,9 +854,9 @@ export class Callback extends Operation {
   }
 
   getSummary(): string {
-    if (this.schema?.summary) {
-      return this.schema.summary.trim();
-    } else if (this.parentSchema.summary) {
+    if (this.schema?.summary && typeof this.schema.summary === 'string') {
+      return this.schema.summary;
+    } else if (this.parentSchema.summary && typeof this.parentSchema.summary === 'string') {
       return this.parentSchema.summary;
     }
 
@@ -864,9 +864,9 @@ export class Callback extends Operation {
   }
 
   getDescription(): string {
-    if (this.schema?.description) {
-      return this.schema.description.trim();
-    } else if (this.parentSchema.description) {
+    if (this.schema?.description && typeof this.schema.description === 'string') {
+      return this.schema.description;
+    } else if (this.parentSchema.description && typeof this.parentSchema.description === 'string') {
       return this.parentSchema.description;
     }