oas 20.10.1 → 20.10.3

package/dist/lib/reducer.js

@@ -77,6 +77,14 @@ function reducer(definition, opts) {
     }
     // Stringify and parse so we get a full non-reference clone of the API definition to work with.
     var reduced = JSON.parse(JSON.stringify(definition));
+    // Retain any root-level security definitions.
+    if ('security' in reduced) {
+        Object.values(reduced.security).forEach(function (sec) {
+            Object.keys(sec).forEach(function (scheme) {
+                $refs.add("#/components/securitySchemes/".concat(scheme));
+            });
+        });
+    }
     if ('paths' in reduced) {
         Object.keys(reduced.paths).forEach(function (path) {
             var pathLC = path.toLowerCase();

package/dist/operation/get-response-examples.d.ts

@@ -1,7 +1,9 @@
+import type { MediaTypeExample } from '../lib/get-mediatype-examples';
 import type * as RMOAS from '../rmoas.types';
 export type ResponseExamples = {
-    mediaTypes: Record<string, RMOAS.MediaTypeObject>;
+    mediaTypes: Record<string, MediaTypeExample[]>;
     status: string;
+    onlyHeaders?: boolean;
 }[];
 /**
  * Retrieve a collection of response examples keyed, by their media type.

package/dist/samples/utils.js

@@ -50,8 +50,7 @@ exports.isFunc = isFunc;
 // `predicate` can be used to discriminate the stripping further,
 // by preserving the key's place in the object based on its value.
 // @todo make this have a better type than `any`
-function deeplyStripKey(input, keyToStrip, predicate // eslint-disable-line @typescript-eslint/no-unused-vars
-) {
+function deeplyStripKey(input, keyToStrip, predicate) {
     if (predicate === void 0) { predicate = function (obj, key) { return true; }; }
     if (typeof input !== 'object' || Array.isArray(input) || input === null || !keyToStrip) {
         return input;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "20.10.1",
+  "version": "20.10.3",
   "description": "Comprehensive tooling for working with OpenAPI definitions",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -32,16 +32,17 @@
   },
   "scripts": {
     "build": "tsc",
-    "lint": "eslint . --ext .js,.ts",
+    "lint": "npm run lint:types; npm run lint:js; npm run lint:docs; npm run prettier",
+    "lint:js": "eslint . --ext .js,.ts",
     "lint:docs": "npx -y alex .",
+    "lint:types": "tsc --noEmit",
     "prebuild": "rm -rf dist/",
     "prepack": "npm run build",
     "prepare": "husky install",
-    "pretest": "npm run lint",
-    "prettier": "prettier --list-different \"./**/**.{js,ts,md}\"",
-    "prettier:write": "prettier --list-different --write \"./**/**.{js,ts,md}\"",
-    "test": "tsc; jest --coverage",
-    "test-watch": "tsc; jest --watch",
+    "pretest": "npm run build",
+    "prettier": "prettier --check .",
+    "prettier:fix": "prettier --check --write .",
+    "test": "vitest --coverage",
     "watch": "tsc --watch"
   },
   "dependencies": {
@@ -57,21 +58,20 @@
     "remove-undefined-objects": "^3.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
-    "@readme/eslint-config": "^10.6.2",
-    "@readme/oas-examples": "^5.11.1",
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@readme/eslint-config": "^12.1.0",
+    "@readme/oas-examples": "^5.12.0",
     "@readme/openapi-parser": "^2.5.0",
-    "@types/jest": "^29.5.3",
     "@types/json-schema-merge-allof": "^0.6.1",
     "@types/memoizee": "^0.4.6",
-    "@types/node": "^20.4.1",
-    "eslint": "^8.44.0",
+    "@types/node": "^20.5.3",
+    "@vitest/coverage-v8": "^0.34.2",
+    "eslint": "^8.47.0",
     "husky": "^8.0.3",
-    "jest": "^29.6.1",
-    "prettier": "^2.8.8",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.1.6"
+    "prettier": "^3.0.2",
+    "typescript": "^5.1.6",
+    "vitest": "^0.34.2"
   },
   "prettier": "@readme/eslint-config/prettier",
   "commitlint": {

package/src/analyzer/queries/openapi.ts

@@ -77,8 +77,8 @@ export function mediaTypes(definition: OASDocument) {
           // into `['application/json', 'text/xml']`.
           return Object.keys(res.value);
         })
-        .flat()
-    )
+        .flat(),
+    ),
   );
 
   results.sort();
@@ -103,7 +103,7 @@ export function parameterSerialization(definition: OASDocument) {
  */
 export function polymorphism(definition: OASDocument) {
   const results = Array.from(
-    new Set(query(['$..allOf^', '$..anyOf^', '$..oneOf^'], definition).map(res => refizePointer(res.pointer)))
+    new Set(query(['$..allOf^', '$..anyOf^', '$..oneOf^'], definition).map(res => refizePointer(res.pointer))),
   );
 
   results.sort();
@@ -179,6 +179,6 @@ export function xml(definition: OASDocument) {
       "$..responses..['text/xml-external-parsed-entity']",
       '$..responses[*].content[?(@property.match(/\\+xml$/i))]',
     ],
-    definition
+    definition,
   ).map(res => refizePointer(res.pointer));
 }

package/src/analyzer/queries/readme.ts

@@ -23,8 +23,8 @@ export function codeSampleLanguages(definition: OASDocument) {
     new Set(
       query(["$..['x-readme']['samples-languages']", "$..['x-samples-languages']"], definition)
         .map(res => res.value as string)
-        .reduce((prev, next) => prev.concat(next), [])
-    )
+        .reduce((prev, next) => prev.concat(next), []),
+    ),
   );
 
   results.sort();
@@ -47,9 +47,9 @@ export function codeSamplesDisabled(definition: OASDocument) {
           "$..paths[*]..['x-samples-enabled']^",
           "$..paths[*]..['x-readme']['samples-enabled']^^",
         ],
-        definition
-      ).map(res => refizePointer(res.pointer))
-    )
+        definition,
+      ).map(res => refizePointer(res.pointer)),
+    ),
   );
 }
 
@@ -69,9 +69,9 @@ export function corsProxyDisabled(definition: OASDocument) {
           "$..paths[*]..['x-proxy-enabled']^",
           "$..paths[*]..['x-readme']['proxy-enabled']^^",
         ],
-        definition
-      ).map(res => refizePointer(res.pointer))
-    )
+        definition,
+      ).map(res => refizePointer(res.pointer)),
+    ),
   );
 }
 
@@ -104,7 +104,7 @@ export function explorerDisabled(definition: OASDocument) {
       "$..paths[*]..['x-explorer-enabled']^",
       "$..paths[*]..['x-readme']['explorer-enabled']^^",
     ],
-    definition
+    definition,
   ).map(res => refizePointer(res.pointer));
 }
 

package/src/index.ts

@@ -463,7 +463,7 @@ export default class Oas {
         }
 
         return original;
-      })
+      }),
     );
   }
 
@@ -481,7 +481,7 @@ export default class Oas {
        * If you prefer to first look for a webhook with this path and method.
        */
       isWebhook?: boolean;
-    } = {}
+    } = {},
   ) {
     // 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
@@ -806,7 +806,7 @@ export default class Oas {
        * Preserve component schema names within themselves as a `title`.
        */
       preserveRefAsJSONSchemaTitle?: boolean;
-    } = { preserveRefAsJSONSchemaTitle: false }
+    } = { preserveRefAsJSONSchemaTitle: false },
   ) {
     if (this.dereferencing.complete) {
       return new Promise(resolve => {

package/src/lib/dedupe-common-parameters.ts

@@ -9,7 +9,7 @@ import * as RMOAS from '../rmoas.types';
  */
 export default function dedupeCommonParameters(
   parameters: RMOAS.ParameterObject[],
-  commonParameters: RMOAS.ParameterObject[]
+  commonParameters: RMOAS.ParameterObject[],
 ) {
   return commonParameters.filter((param: RMOAS.ParameterObject) => {
     return !parameters.find((param2: RMOAS.ParameterObject) => {

package/src/lib/get-auth.ts

@@ -45,13 +45,13 @@ function getKey(user: RMOAS.User, scheme: RMOAS.KeyedSecuritySchemeObject): auth
 export function getByScheme(
   user: RMOAS.User,
   scheme = <RMOAS.KeyedSecuritySchemeObject>{},
-  selectedApp?: string | number
+  selectedApp?: string | number,
 ): authKey {
   if (user?.keys && user.keys.length) {
     if (selectedApp) {
       return getKey(
         user.keys.find(key => key.name === selectedApp),
-        scheme
+        scheme,
       );
     }
 
@@ -72,7 +72,7 @@ export function getByScheme(
 export default function getAuth(
   api: OpenAPIV3.Document | OpenAPIV3_1.Document,
   user: RMOAS.User,
-  selectedApp?: string | number
+  selectedApp?: string | number,
 ) {
   return Object.keys(api?.components?.securitySchemes || {})
     .map(scheme => {
@@ -85,7 +85,7 @@ export default function getAuth(
             ...(api.components.securitySchemes[scheme] as RMOAS.SecuritySchemeObject),
             _key: scheme,
           },
-          selectedApp
+          selectedApp,
         ),
       };
     })

package/src/lib/get-mediatype-examples.ts

@@ -34,7 +34,7 @@ export default function getMediaTypeExamples(
      * If you wish to include data that's flatted as `writeOnly`.
      */
     includeWriteOnly?: boolean;
-  } = {}
+  } = {},
 ) {
   if (mediaTypeObject.example) {
     return [

package/src/lib/matches-mimetype.ts

@@ -12,14 +12,14 @@ export default {
   json: (contentType: string): boolean => {
     return matchesMediaType(
       ['application/json', 'application/x-json', 'text/json', 'text/x-json', '+json'],
-      contentType
+      contentType,
     );
   },
 
   multipart: (contentType: string): boolean => {
     return matchesMediaType(
       ['multipart/mixed', 'multipart/related', 'multipart/form-data', 'multipart/alternative'],
-      contentType
+      contentType,
     );
   },
 
@@ -37,7 +37,7 @@ export default {
         'text/xml-external-parsed-entity',
         '+xml',
       ],
-      contentType
+      contentType,
     );
   },
 };

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

@@ -193,7 +193,7 @@ function isRequestBodySchema(schema: unknown): schema is RMOAS.RequestBodyObject
 function searchForValueByPropAndPointer(
   property: 'example' | 'default',
   pointer: string,
-  schemas: toJSONSchemaOptions['prevExampleSchemas'] | toJSONSchemaOptions['prevDefaultSchemas'] = []
+  schemas: toJSONSchemaOptions['prevExampleSchemas'] | toJSONSchemaOptions['prevDefaultSchemas'] = [],
 ) {
   if (!schemas.length || !pointer.length) {
     return undefined;
@@ -289,7 +289,7 @@ function searchForValueByPropAndPointer(
  */
 export default function toJSONSchema(
   data: RMOAS.SchemaObject | boolean,
-  opts: toJSONSchemaOptions = {}
+  opts: toJSONSchemaOptions = {},
 ): RMOAS.SchemaObject {
   let schema = data === true ? {} : { ...data };
   const schemaAdditionalProperties = RMOAS.isSchema(schema) ? schema.additionalProperties : null;
@@ -421,12 +421,12 @@ export default function toJSONSchema(
           if ('properties' in schema) {
             schema[polyType][idx] = toJSONSchema(
               { allOf: [item, { properties: schema.properties }] } as RMOAS.SchemaObject,
-              polyOptions
+              polyOptions,
             );
           } else if ('items' in schema) {
             schema[polyType][idx] = toJSONSchema(
               { allOf: [item, { items: schema.items }] } as RMOAS.SchemaObject,
-              polyOptions
+              polyOptions,
             );
           } else {
             schema[polyType][idx] = toJSONSchema(item as RMOAS.SchemaObject, polyOptions);

package/src/lib/reducer.ts

@@ -88,6 +88,15 @@ export default function reducer(definition: OASDocument, opts: ReducerOptions =
   // Stringify and parse so we get a full non-reference clone of the API definition to work with.
   const reduced = JSON.parse(JSON.stringify(definition)) as OASDocument;
 
+  // Retain any root-level security definitions.
+  if ('security' in reduced) {
+    Object.values(reduced.security).forEach(sec => {
+      Object.keys(sec).forEach(scheme => {
+        $refs.add(`#/components/securitySchemes/${scheme}`);
+      });
+    });
+  }
+
   if ('paths' in reduced) {
     Object.keys(reduced.paths).forEach(path => {
       const pathLC = path.toLowerCase();

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

@@ -39,9 +39,9 @@ export default function getCallbackExamples(operation: RMOAS.OperationObject) {
                 example,
               };
             });
-          })
+          }),
         )
         .filter(Boolean);
-    })
+    }),
   );
 }

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

@@ -79,7 +79,7 @@ export interface getParametersAsJSONSchemaOptions {
 export default function getParametersAsJSONSchema(
   operation: Operation,
   api: OASDocument,
-  opts?: getParametersAsJSONSchemaOptions
+  opts?: getParametersAsJSONSchemaOptions,
 ) {
   let hasCircularRefs = false;
   let hasDiscriminatorMappingRefs = false;

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

@@ -33,7 +33,7 @@ function buildHeadersSchema(
      * just make sure to return your transformed schema.
      */
     transformer?: (schema: SchemaObject) => SchemaObject;
-  }
+  },
 ) {
   const headers = response.headers;
 
@@ -99,7 +99,7 @@ export default function getResponseAsJSONSchema(
      * name, just make sure to return your transformed schema.
      */
     transformer?: (schema: SchemaObject) => SchemaObject;
-  }
+  },
 ) {
   const response = operation.getResponseByStatusCode(statusCode);
   const jsonSchema = [];

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

@@ -5,8 +5,9 @@ import getMediaTypeExamples from '../lib/get-mediatype-examples';
 import { isRef } from '../rmoas.types';
 
 export type ResponseExamples = {
-  mediaTypes: Record<string, RMOAS.MediaTypeObject>;
+  mediaTypes: Record<string, MediaTypeExample[]>;
   status: string;
+  onlyHeaders?: boolean;
 }[];
 
 /**

package/src/operation.ts

@@ -170,7 +170,7 @@ export default class Operation {
    *    security schemes, rather than returning `false`.
    */
   getSecurityWithTypes(
-    filterInvalid = false
+    filterInvalid = false,
   ): (false | (false | { security: RMOAS.KeyedSecuritySchemeObject; type: SecurityType })[])[] {
     const securityRequirements = this.getSecurity();
 
@@ -233,23 +233,26 @@ export default class Operation {
   prepareSecurity(): Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]> {
     const securitiesWithTypes = this.getSecurityWithTypes();
 
-    return securitiesWithTypes.reduce((prev, securities) => {
-      if (!securities) return prev;
+    return securitiesWithTypes.reduce(
+      (prev, securities) => {
+        if (!securities) return prev;
 
-      securities.forEach(security => {
-        // Remove non-existent schemes
-        if (!security) return;
-        if (!prev[security.type]) prev[security.type] = [];
+        securities.forEach(security => {
+          // Remove non-existent schemes
+          if (!security) return;
+          if (!prev[security.type]) prev[security.type] = [];
 
-        // Only add schemes we haven't seen yet.
-        const exists = prev[security.type].findIndex(sec => sec._key === security.security._key);
-        if (exists < 0) {
-          prev[security.type].push(security.security);
-        }
-      });
+          // Only add schemes we haven't seen yet.
+          const exists = prev[security.type].findIndex(sec => sec._key === security.security._key);
+          if (exists < 0) {
+            prev[security.type].push(security.security);
+          }
+        });
 
-      return prev;
-    }, {} as Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]>);
+        return prev;
+      },
+      {} as Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]>,
+    );
   }
 
   getHeaders(): Operation['headers'] {
@@ -281,7 +284,7 @@ export default class Operation {
             if (p.in && p.in === 'header') return p.name;
             return undefined;
           })
-          .filter(p => p)
+          .filter(p => p),
       );
     }
 
@@ -291,7 +294,7 @@ export default class Operation {
         .filter(r => (this.schema.responses[r] as RMOAS.ResponseObject).headers)
         .map(r =>
           // Remove the reference object because we will have already dereferenced
-          Object.keys((this.schema.responses[r] as RMOAS.ResponseObject).headers)
+          Object.keys((this.schema.responses[r] as RMOAS.ResponseObject).headers),
         )
         .reduce((a, b) => a.concat(b), []);
     }
@@ -313,7 +316,7 @@ export default class Operation {
     if (this.schema.responses) {
       if (
         Object.keys(this.schema.responses).some(
-          response => !!(this.schema.responses[response] as RMOAS.ResponseObject).content
+          response => !!(this.schema.responses[response] as RMOAS.ResponseObject).content,
         )
       ) {
         if (!this.headers.request.includes('Accept')) this.headers.request.push('Accept');
@@ -501,7 +504,7 @@ export default class Operation {
        * name, just make sure to return your transformed schema.
        */
       transformer?: (schema: RMOAS.SchemaObject) => RMOAS.SchemaObject;
-    } = {}
+    } = {},
   ) {
     return getResponseAsJSONSchema(this, this.api, statusCode, {
       includeDiscriminatorMappingRefs: true,
@@ -804,7 +807,7 @@ export class Callback extends Operation {
     method: RMOAS.HttpMethods,
     operation: RMOAS.OperationObject,
     identifier: string,
-    parentPathItem: RMOAS.PathItemObject
+    parentPathItem: RMOAS.PathItemObject,
   ) {
     super(oas, path, method, operation);
 

package/src/samples/index.ts

@@ -80,7 +80,7 @@ function sampleFromSchema(
      * If you wish to include data that's flatted as `writeOnly`.
      */
     includeWriteOnly?: boolean;
-  } = {}
+  } = {},
 ): string | number | boolean | null | unknown[] | Record<string, unknown> | undefined {
   const objectifySchema = objectify(schema);
   let { type } = objectifySchema;
@@ -96,7 +96,7 @@ function sampleFromSchema(
             defaultResolver: mergeJSONSchemaAllOf.options.resolvers.title,
           },
         }),
-        opts
+        opts,
       );
     } catch (error) {
       return undefined;

package/src/samples/utils.ts

@@ -49,7 +49,7 @@ export function isFunc(thing: unknown): thing is Function {
 export function deeplyStripKey(
   input: unknown,
   keyToStrip: string,
-  predicate = (obj: unknown, key?: string): boolean => true // eslint-disable-line @typescript-eslint/no-unused-vars
+  predicate = (obj: unknown, key?: string): boolean => true, // eslint-disable-line @typescript-eslint/no-unused-vars
 ): any | RMOAS.SchemaObject {
   if (typeof input !== 'object' || Array.isArray(input) || input === null || !keyToStrip) {
     return input;