oas 20.5.1 → 20.5.3

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## <small>20.5.3 (2023-03-08)</small>
+
+* fix: bug where request example selection wouldn't always use the first (#739) ([7c000e0](https://github.com/readmeio/oas/commit/7c000e0)), closes [#739](https://github.com/readmeio/oas/issues/739)
+
+
+
+## <small>20.5.2 (2023-03-03)</small>
+
+* fix: bug where primitive schemas would crash dereferencing (#738) ([30c06f0](https://github.com/readmeio/oas/commit/30c06f0)), closes [#738](https://github.com/readmeio/oas/issues/738)
+
+
+
 ## <small>20.5.1 (2023-03-03)</small>
 
 * fix: running prettier to resolve some issues ([bc3c7e4](https://github.com/readmeio/oas/commit/bc3c7e4))

package/dist/index.js

@@ -78,6 +78,7 @@ var json_schema_ref_parser_1 = __importDefault(require("@readme/json-schema-ref-
 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"));
+var helpers_1 = require("./lib/helpers");
 var operation_1 = __importStar(require("./operation"));
 exports.Operation = operation_1["default"];
 exports.Callback = operation_1.Callback;
@@ -764,6 +765,15 @@ var Oas = /** @class */ (function () {
                 // what their name is so that when dereferencing happens below those names will be preserved.
                 if (api && api.components && api.components.schemas && typeof api.components.schemas === 'object') {
                     Object.keys(api.components.schemas).forEach(function (schemaName) {
+                        // As of OpenAPI 3.1 component schemas can be primitives or arrays. If this happens then we
+                        // shouldn't try to add `title` or `x-readme-ref-name` properties because we can't. We'll
+                        // have some data loss on these schemas but as they aren't objects they likely won't be used
+                        // in ways that would require needing a `title` or `x-readme-ref-name` anyways.
+                        if ((0, helpers_1.isPrimitive)(api.components.schemas[schemaName]) ||
+                            Array.isArray(api.components.schemas[schemaName]) ||
+                            api.components.schemas[schemaName] === null) {
+                            return;
+                        }
                         if (opts.preserveRefAsJSONSchemaTitle) {
                             // This may result in some data loss if there's already a `title` present, but in the case
                             // where we want to generate code for the API definition (see http://npm.im/api), we'd

package/dist/lib/helpers.d.ts

@@ -0,0 +1 @@
+export declare function isPrimitive(val: unknown): boolean;

package/dist/lib/helpers.js

@@ -0,0 +1,7 @@
+"use strict";
+exports.__esModule = true;
+exports.isPrimitive = void 0;
+function isPrimitive(val) {
+    return typeof val === 'string' || typeof val === 'number' || typeof val === 'boolean';
+}
+exports.isPrimitive = isPrimitive;

package/dist/lib/openapi-to-json-schema.d.ts

@@ -31,7 +31,6 @@ export interface toJSONSchemaOptions {
     transformer?: (schema: RMOAS.SchemaObject) => RMOAS.SchemaObject;
 }
 export declare function getSchemaVersionString(schema: RMOAS.SchemaObject, api: RMOAS.OASDocument): string;
-export declare function isPrimitive(val: unknown): boolean;
 /**
  * Given an OpenAPI-flavored JSON Schema, make an effort to modify it so it's shaped more towards
  * stock JSON Schema.

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

@@ -57,10 +57,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-exports.isPrimitive = exports.getSchemaVersionString = void 0;
+exports.getSchemaVersionString = void 0;
 var json_schema_merge_allof_1 = __importDefault(require("json-schema-merge-allof"));
 var jsonpointer_1 = __importDefault(require("jsonpointer"));
 var RMOAS = __importStar(require("../rmoas.types"));
+var helpers_1 = require("./helpers");
 /**
  * This list has been pulled from `openapi-schema-to-json-schema` but been slightly modified to fit
  * within the constraints in which ReadMe uses the output from this library in schema form
@@ -137,10 +138,6 @@ function getSchemaVersionString(schema, api) {
     return 'https://json-schema.org/draft/2020-12/schema#';
 }
 exports.getSchemaVersionString = getSchemaVersionString;
-function isPrimitive(val) {
-    return typeof val === 'string' || typeof val === 'number' || typeof val === 'boolean';
-}
-exports.isPrimitive = isPrimitive;
 function isPolymorphicSchema(schema) {
     return 'allOf' in schema || 'anyOf' in schema || 'oneOf' in schema;
 }
@@ -205,7 +202,7 @@ function searchForExampleByPointer(pointer, examples) {
                     continue;
                 }
                 // Prevent us from crashing if `examples` is a completely empty object.
-                schema = schema.examples.shift();
+                schema = __spreadArray([], schema.examples, true).shift();
             }
             try {
                 example = jsonpointer_1["default"].get(schema, pointers[i]);
@@ -370,11 +367,11 @@ function toJSONSchema(data, opts) {
         // JSON Schema doesn't support OpenAPI-style examples so we need to reshape them a bit.
         if ('example' in schema) {
             // Only bother adding primitive examples.
-            if (isPrimitive(schema.example)) {
+            if ((0, helpers_1.isPrimitive)(schema.example)) {
                 schema.examples = [schema.example];
             }
             else if (Array.isArray(schema.example)) {
-                schema.examples = schema.example.filter(function (example) { return isPrimitive(example); });
+                schema.examples = schema.example.filter(function (example) { return (0, helpers_1.isPrimitive)(example); });
                 if (!schema.examples.length) {
                     delete schema.examples;
                 }
@@ -396,11 +393,11 @@ function toJSONSchema(data, opts) {
                         refLogger(example.$ref, 'ref');
                     }
                     else if ('value' in example) {
-                        if (isPrimitive(example.value)) {
+                        if ((0, helpers_1.isPrimitive)(example.value)) {
                             examples_1.push(example.value);
                             reshapedExamples_1 = true;
                         }
-                        else if (Array.isArray(example.value) && isPrimitive(example.value[0])) {
+                        else if (Array.isArray(example.value) && (0, helpers_1.isPrimitive)(example.value[0])) {
                             examples_1.push(example.value[0]);
                             reshapedExamples_1 = true;
                         }
@@ -419,7 +416,7 @@ function toJSONSchema(data, opts) {
                     schema.examples = examples_1;
                 }
             }
-            else if (Array.isArray(schema.examples) && isPrimitive(schema.examples[0])) {
+            else if (Array.isArray(schema.examples) && (0, helpers_1.isPrimitive)(schema.examples[0])) {
                 // We haven't reshaped `examples` here, but since it's in a state that's preferrable to us
                 // let's keep it around.
                 reshapedExamples_1 = true;
@@ -436,7 +433,7 @@ function toJSONSchema(data, opts) {
             if (foundExample) {
                 // We can only really deal with primitives, so only promote those as the found example if
                 // it is.
-                if (isPrimitive(foundExample) || (Array.isArray(foundExample) && isPrimitive(foundExample[0]))) {
+                if ((0, helpers_1.isPrimitive)(foundExample) || (Array.isArray(foundExample) && (0, helpers_1.isPrimitive)(foundExample[0]))) {
                     schema.examples = [foundExample];
                 }
             }

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

@@ -39,6 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 exports.__esModule = true;
 exports.types = void 0;
 var clone_object_1 = __importDefault(require("../lib/clone-object"));
+var helpers_1 = require("../lib/helpers");
 var matches_mimetype_1 = __importDefault(require("../lib/matches-mimetype"));
 var openapi_to_json_schema_1 = __importStar(require("../lib/openapi-to-json-schema"));
 var isJSON = matches_mimetype_1["default"].json;
@@ -115,7 +116,7 @@ function getParametersAsJSONSchema(operation, api, opts) {
         });
         return {
             type: type,
-            schema: (0, openapi_to_json_schema_1.isPrimitive)(deprecatedSchema)
+            schema: (0, helpers_1.isPrimitive)(deprecatedSchema)
                 ? deprecatedSchema
                 : __assign(__assign({}, deprecatedSchema), { $schema: (0, openapi_to_json_schema_1.getSchemaVersionString)(deprecatedSchema, api) })
         };
@@ -157,7 +158,7 @@ function getParametersAsJSONSchema(operation, api, opts) {
         if (!Object.keys(cleanedSchema).length) {
             return null;
         }
-        return __assign({ type: type, label: exports.types[type], schema: (0, openapi_to_json_schema_1.isPrimitive)(cleanedSchema)
+        return __assign({ type: type, label: exports.types[type], schema: (0, helpers_1.isPrimitive)(cleanedSchema)
                 ? cleanedSchema
                 : __assign(__assign({}, cleanedSchema), { $schema: (0, openapi_to_json_schema_1.getSchemaVersionString)(cleanedSchema, api) }), deprecatedProps: getDeprecated(cleanedSchema, type) }, (description ? { description: description } : {}));
     }
@@ -250,7 +251,7 @@ function getParametersAsJSONSchema(operation, api, opts) {
                         refLogger: refLogger,
                         transformer: opts.transformer
                     });
-                    schema = (0, openapi_to_json_schema_1.isPrimitive)(interimSchema)
+                    schema = (0, helpers_1.isPrimitive)(interimSchema)
                         ? interimSchema
                         : __assign(__assign({}, interimSchema), { 
                             // Note: this applies a `$schema` version to each field in the larger schema
@@ -299,7 +300,7 @@ function getParametersAsJSONSchema(operation, api, opts) {
                                 refLogger: refLogger,
                                 transformer: opts.transformer
                             });
-                            schema = (0, openapi_to_json_schema_1.isPrimitive)(interimSchema)
+                            schema = (0, helpers_1.isPrimitive)(interimSchema)
                                 ? interimSchema
                                 : __assign(__assign({}, interimSchema), { 
                                     // Note: this applies a `$schema` version to each field in the larger schema
@@ -312,7 +313,7 @@ function getParametersAsJSONSchema(operation, api, opts) {
                 // Parameter descriptions don't exist in `current.schema` so `constructSchema` will never
                 // have access to it.
                 if (current.description) {
-                    if (!(0, openapi_to_json_schema_1.isPrimitive)(schema)) {
+                    if (!(0, helpers_1.isPrimitive)(schema)) {
                         schema.description = current.description;
                     }
                 }

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

@@ -38,6 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 exports.__esModule = true;
 var clone_object_1 = __importDefault(require("../lib/clone-object"));
+var helpers_1 = require("../lib/helpers");
 var matches_mimetype_1 = __importDefault(require("../lib/matches-mimetype"));
 var openapi_to_json_schema_1 = __importStar(require("../lib/openapi-to-json-schema"));
 var isJSON = matches_mimetype_1["default"].json;
@@ -145,7 +146,7 @@ function getResponseAsJSONSchema(operation, api, statusCode, opts) {
             // able to render so instead of generating a JSON Schema with an `undefined` type we should
             // default to `string` so there's at least *something* the end-user can interact with.
             type: foundSchema.type || 'string',
-            schema: (0, openapi_to_json_schema_1.isPrimitive)(schema)
+            schema: (0, helpers_1.isPrimitive)(schema)
                 ? schema
                 : __assign(__assign({}, schema), { $schema: (0, openapi_to_json_schema_1.getSchemaVersionString)(schema, api) }),
             label: 'Response body'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "20.5.1",
+  "version": "20.5.3",
   "description": "Comprehensive tooling for working with OpenAPI definitions",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",

package/src/index.ts

@@ -7,6 +7,7 @@ import { pathToRegexp, match } from 'path-to-regexp';
 
 import getAuth from './lib/get-auth';
 import getUserVariable from './lib/get-user-variable';
+import { isPrimitive } from './lib/helpers';
 import Operation, { Callback, Webhook } from './operation';
 import utils, { supportedMethods } from './utils';
 
@@ -825,6 +826,18 @@ export default class Oas {
     // what their name is so that when dereferencing happens below those names will be preserved.
     if (api && api.components && api.components.schemas && typeof api.components.schemas === 'object') {
       Object.keys(api.components.schemas).forEach(schemaName => {
+        // As of OpenAPI 3.1 component schemas can be primitives or arrays. If this happens then we
+        // shouldn't try to add `title` or `x-readme-ref-name` properties because we can't. We'll
+        // have some data loss on these schemas but as they aren't objects they likely won't be used
+        // in ways that would require needing a `title` or `x-readme-ref-name` anyways.
+        if (
+          isPrimitive(api.components.schemas[schemaName]) ||
+          Array.isArray(api.components.schemas[schemaName]) ||
+          api.components.schemas[schemaName] === null
+        ) {
+          return;
+        }
+
         if (opts.preserveRefAsJSONSchemaTitle) {
           // This may result in some data loss if there's already a `title` present, but in the case
           // where we want to generate code for the API definition (see http://npm.im/api), we'd

package/src/lib/helpers.ts

@@ -0,0 +1,3 @@
+export function isPrimitive(val: unknown): boolean {
+  return typeof val === 'string' || typeof val === 'number' || typeof val === 'boolean';
+}

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

@@ -6,6 +6,8 @@ import jsonpointer from 'jsonpointer';
 
 import * as RMOAS from '../rmoas.types';
 
+import { isPrimitive } from './helpers';
+
 /**
  * This list has been pulled from `openapi-schema-to-json-schema` but been slightly modified to fit
  * within the constraints in which ReadMe uses the output from this library in schema form
@@ -133,10 +135,6 @@ export function getSchemaVersionString(schema: RMOAS.SchemaObject, api: RMOAS.OA
   return 'https://json-schema.org/draft/2020-12/schema#';
 }
 
-export function isPrimitive(val: unknown): boolean {
-  return typeof val === 'string' || typeof val === 'number' || typeof val === 'boolean';
-}
-
 function isPolymorphicSchema(schema: RMOAS.SchemaObject): boolean {
   return 'allOf' in schema || 'anyOf' in schema || 'oneOf' in schema;
 }
@@ -206,7 +204,7 @@ function searchForExampleByPointer(pointer: string, examples: PrevSchemasType =
         }
 
         // Prevent us from crashing if `examples` is a completely empty object.
-        schema = schema.examples.shift();
+        schema = [...schema.examples].shift();
       }
 
       try {

package/src/operation/get-parameters-as-json-schema.ts

@@ -3,8 +3,9 @@ import type { ComponentsObject, ExampleObject, OASDocument, ParameterObject, Sch
 import type { OpenAPIV3_1 } from 'openapi-types';
 
 import cloneObject from '../lib/clone-object';
+import { isPrimitive } from '../lib/helpers';
 import matchesMimetype from '../lib/matches-mimetype';
-import toJSONSchema, { isPrimitive, getSchemaVersionString } from '../lib/openapi-to-json-schema';
+import toJSONSchema, { getSchemaVersionString } from '../lib/openapi-to-json-schema';
 
 const isJSON = matchesMimetype.json;
 

package/src/operation/get-response-as-json-schema.ts

@@ -9,8 +9,9 @@ import type {
 } from 'rmoas.types';
 
 import cloneObject from '../lib/clone-object';
+import { isPrimitive } from '../lib/helpers';
 import matches from '../lib/matches-mimetype';
-import toJSONSchema, { isPrimitive, getSchemaVersionString } from '../lib/openapi-to-json-schema';
+import toJSONSchema, { getSchemaVersionString } from '../lib/openapi-to-json-schema';
 
 const isJSON = matches.json;