oas 17.7.2 → 17.7.3

package/@types/index.d.ts

@@ -13,10 +13,10 @@ declare type PathMatch = {
     operation: RMOAS.PathsObject;
     match?: MatchResult;
 };
-declare type PathMatches = Array<PathMatch>;
-declare type Variables = Record<string, string | number | Array<{
+declare type PathMatches = PathMatch[];
+declare type Variables = Record<string, string | number | {
     default?: string | number;
-}> | {
+}[] | {
     default?: string | number;
 }>;
 export default class Oas {
@@ -35,10 +35,10 @@ export default class Oas {
      *
      * @todo These are always `Promise.resolve` and `Promise.reject`. Make these types more specific than `any`.
      */
-    protected promises: Array<{
+    protected promises: {
         resolve: any;
         reject: any;
-    }>;
+    }[];
     /**
      * Internal storage array that the library utilizes to keep track of its `dereferencing` state so it doesn't initiate
      * multiple dereferencing processes.
@@ -217,7 +217,10 @@ export default class Oas {
      * Dereference the current OAS definition so it can be parsed free of worries of `$ref` schemas and circular
      * structures.
      *
+     * @param opts
      */
-    dereference(): Promise<unknown>;
+    dereference(opts?: {
+        preserveRefAsJSONSchemaTitle: boolean;
+    }): Promise<unknown>;
 }
 export { Operation, Callback, Webhook, utils };

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

@@ -11,11 +11,7 @@ import type * as RMOAS from '../rmoas.types';
  * @param operation Operation to look for a primary requestBody schema in.
  * @param api The API definition that this operation exists within.
  */
-export default function getSchema(operation: RMOAS.OperationObject, api?: RMOAS.OASDocument | {
-    [schemaType: string]: {
-        [key: string]: RMOAS.SchemaObject;
-    };
-}): {
+export default function getSchema(operation: RMOAS.OperationObject, api?: RMOAS.OASDocument | Record<string, Record<string, RMOAS.SchemaObject>>): {
     type: string;
     schema: any;
 };

package/@types/lib/openapi-to-json-schema.d.ts

@@ -1,10 +1,8 @@
 import * as RMOAS from '../rmoas.types';
-declare type PrevSchemasType = Array<RMOAS.SchemaObject>;
+declare type PrevSchemasType = RMOAS.SchemaObject[];
 export declare type toJsonSchemaOptions = {
     currentLocation?: string;
-    globalDefaults?: {
-        [key: string]: unknown;
-    };
+    globalDefaults?: Record<string, unknown>;
     isPolymorphicAllOfChild?: boolean;
     prevSchemas?: PrevSchemasType;
     refLogger?: (ref: string) => void;

package/@types/operation/get-callback-examples.d.ts

@@ -1,10 +1,10 @@
 import type * as RMOAS from '../rmoas.types';
-export declare type CallbackExamples = Array<{
+export declare type CallbackExamples = {
     identifier: string;
     expression: string;
     method: string;
     example: unknown;
-}>;
+}[];
 /**
  * With an OpenAPI Operation Object return back a collection of examples for any callbacks that may be present.
  *

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

@@ -14,9 +14,7 @@ export declare type SchemaWrapper = {
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#parameterObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterObject}
  */
-export declare const types: {
-    [key: keyof RMOAS.OASDocument]: string;
-};
+export declare const types: Record<keyof RMOAS.OASDocument, string>;
 /**
  * @param operation
  * @param api

package/@types/operation/get-requestbody-examples.d.ts

@@ -1,8 +1,8 @@
 import type * as RMOAS from '../rmoas.types';
-export declare type RequestBodyExamples = Array<{
+export declare type RequestBodyExamples = {
     mediaType: string;
     examples: any;
-}>;
+}[];
 /**
  * Retrieve a collection of request body examples, keyed by their media type.
  *

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

@@ -10,7 +10,7 @@ import type Operation from 'operation';
  * @param statusCode The response status code to generate a schema for.
  */
 export default function getResponseAsJsonSchema(operation: Operation, api: OASDocument, statusCode: string | number): {
-    type: string | Array<string>;
+    type: string | string[];
     schema: SchemaObject;
     label: string;
     description?: string;

package/@types/operation/get-response-examples.d.ts

@@ -1,8 +1,8 @@
 import type * as RMOAS from '../rmoas.types';
-export declare type ResponseExamples = Array<{
+export declare type ResponseExamples = {
     status: string;
     mediaTypes: Record<string, RMOAS.MediaTypeObject>;
-}>;
+}[];
 /**
  * Retrieve a collection of response examples keyed, by their media type.
  *

package/@types/operation.d.ts

@@ -40,8 +40,8 @@ export default class Operation {
      * Flattened out arrays of both request and response headers that are utilized on this operation.
      */
     headers: {
-        request: Array<string>;
-        response: Array<string>;
+        request: string[];
+        response: string[];
     };
     constructor(api: RMOAS.OASDocument, path: string, method: RMOAS.HttpMethods, operation: RMOAS.OperationObject);
     getSummary(): string;
@@ -56,7 +56,7 @@ export default class Operation {
      * level, the securities for the entire API definition are returned (with an empty array as a final fallback).
      *
      */
-    getSecurity(): Array<RMOAS.SecurityRequirementObject>;
+    getSecurity(): RMOAS.SecurityRequirementObject[];
     /**
      * Retrieve a collection of grouped security schemes. The inner array determines and-grouped security schemes, the
      * outer array determines or-groups.
@@ -67,16 +67,16 @@ export default class Operation {
      * @param filterInvalid Optional flag that, when set to `true`, filters out invalid/nonexistent security schemes,
      *    rather than returning `false`.
      */
-    getSecurityWithTypes(filterInvalid?: boolean): Array<false | Array<false | {
+    getSecurityWithTypes(filterInvalid?: boolean): (false | (false | {
         security: RMOAS.KeyedSecuritySchemeObject;
         type: SecurityType;
-    }>>;
+    })[])[];
     /**
      * Retrieve an object where the keys are unique scheme types, and the values are arrays containing each security
      * scheme of that type.
      *
      */
-    prepareSecurity(): Record<SecurityType, Array<RMOAS.KeyedSecuritySchemeObject>>;
+    prepareSecurity(): Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]>;
     getHeaders(): Operation['headers'];
     /**
      * Determine if the operation has an operation present in its schema.
@@ -93,7 +93,7 @@ export default class Operation {
      * Return an array of all tags, and their metadata, that exist on this operation.
      *
      */
-    getTags(): Array<RMOAS.TagObject>;
+    getTags(): RMOAS.TagObject[];
     /**
      * Return is the operation is flagged as `deprecated` or not.
      *
@@ -108,7 +108,7 @@ export default class Operation {
      * Return the parameters (non-request body) on the operation.
      *
      */
-    getParameters(): Array<RMOAS.ParameterObject>;
+    getParameters(): RMOAS.ParameterObject[];
     /**
      * Convert the operation into an array of JSON Schema schemas for each available type of parameter available on the
      * operation.
@@ -131,7 +131,7 @@ export default class Operation {
      * Get an array of all valid response status codes for this operation.
      *
      */
-    getResponseStatusCodes(): Array<string>;
+    getResponseStatusCodes(): string[];
     /**
      * Determine if the operation has any request bodies.
      *
@@ -191,7 +191,7 @@ export default class Operation {
      * Retrieve an array of operations created from each callback.
      *
      */
-    getCallbacks(): false | Array<false | Callback>;
+    getCallbacks(): false | (false | Callback)[];
     /**
      * Retrieve an array of callback examples that this operation has.
      *
@@ -233,7 +233,7 @@ export declare class Callback extends Operation {
     getIdentifier(): string;
     getSummary(): string;
     getDescription(): string;
-    getParameters(): Array<RMOAS.ParameterObject>;
+    getParameters(): RMOAS.ParameterObject[];
 }
 export declare class Webhook extends Operation {
 }

package/@types/rmoas.types.d.ts

@@ -13,21 +13,19 @@ export declare function isRef(check: unknown): check is OpenAPIV3.ReferenceObjec
 export declare function isOAS31(check: OpenAPIV3.Document | OpenAPIV3_1.Document): check is OpenAPIV3_1.Document;
 export interface User {
     [key: string]: unknown;
-    keys?: Array<{
+    keys?: {
         name: string | number;
         user?: string | number;
         pass?: string | number;
         [key: string]: unknown;
-    }>;
+    }[];
 }
 export declare type HttpMethods = (OpenAPIV3.HttpMethods | OpenAPIV3_1.HttpMethods) | ('get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace');
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oasObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasObject}
  */
-export declare type OASDocument = (OpenAPIV3.Document | OpenAPIV3_1.Document) & {
-    [extension: string]: unknown;
-};
+export declare type OASDocument = (OpenAPIV3.Document | OpenAPIV3_1.Document) & Record<string, unknown>;
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#serverObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverObject}
@@ -38,12 +36,10 @@ export declare type ServerObject = OpenAPIV3.ServerObject | OpenAPIV3_1.ServerOb
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverVariableObject}
  */
 export declare type ServerVariableObject = OpenAPIV3.ServerVariableObject | OpenAPIV3_1.ServerVariableObject;
-export declare type ServerVariablesObject = {
-    [variable: string]: ServerVariableObject;
-};
-export declare type ServerVariable = Record<string, string | number | Array<{
+export declare type ServerVariablesObject = Record<string, ServerVariableObject>;
+export declare type ServerVariable = Record<string, string | number | {
     default?: string | number;
-}> | {
+}[] | {
     default?: string | number;
 } | Record<string, never>>;
 export declare type Servers = {
@@ -69,9 +65,7 @@ export declare type PathItemObject = OpenAPIV3.PathItemObject | OpenAPIV3_1.Path
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operationObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operationObject}
  */
-export declare type OperationObject = (OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject) & {
-    [extension: string]: unknown;
-};
+export declare type OperationObject = (OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject) & Record<string, unknown>;
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameterObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterObject}
@@ -121,7 +115,7 @@ export declare type SchemaObject = (OpenAPIV3.SchemaObject | OpenAPIV3_1.SchemaO
     readOnly?: boolean;
     writeOnly?: boolean;
     example?: unknown;
-    examples?: Array<unknown>;
+    examples?: unknown[];
     nullable?: boolean;
     xml?: unknown;
     externalDocs?: unknown;
@@ -139,9 +133,7 @@ export declare function isSchema(check: unknown, isPolymorphicAllOfChild?: boole
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject}
  */
 export declare type SecuritySchemeObject = OpenAPIV3.SecuritySchemeObject | OpenAPIV3_1.SecuritySchemeObject;
-export declare type SecuritySchemesObject = {
-    [key: string]: SecuritySchemeObject;
-};
+export declare type SecuritySchemesObject = Record<string, SecuritySchemeObject>;
 export declare type KeyedSecuritySchemeObject = {
     _key: string;
     'x-default'?: string | number;

package/@types/samples/index.d.ts

@@ -19,6 +19,6 @@ import memoize from 'memoizee';
 declare function sampleFromSchema(schema: RMOAS.SchemaObject, opts?: {
     includeReadOnly?: boolean;
     includeWriteOnly?: boolean;
-}): string | number | boolean | null | Array<unknown> | Record<string, unknown> | undefined;
+}): string | number | boolean | null | unknown[] | Record<string, unknown> | undefined;
 declare const _default: typeof sampleFromSchema & memoize.Memoized<typeof sampleFromSchema>;
 export default _default;

package/@types/samples/utils.d.ts

@@ -7,6 +7,6 @@
 import type * as RMOAS from '../rmoas.types';
 export declare function usesPolymorphism(schema: RMOAS.SchemaObject): false | "oneOf" | "anyOf" | "allOf";
 export declare function objectify(thing: unknown | Record<string, unknown>): Record<string, any>;
-export declare function normalizeArray(arr: string | number | Array<string | number>): (string | number)[];
+export declare function normalizeArray(arr: string | number | (string | number)[]): (string | number)[];
 export declare function isFunc(thing: unknown): thing is Function;
 export declare function deeplyStripKey(input: unknown, keyToStrip: string, predicate?: (obj: unknown, key?: string) => boolean): any | RMOAS.SchemaObject;

package/@types/utils.d.ts

@@ -4,10 +4,7 @@ declare const supportedMethods: Set<string>;
 declare const _default: {
     findSchemaDefinition: typeof findSchemaDefinition;
     getSchema: typeof getSchema;
-    jsonSchemaTypes: {
-        [key: string]: string;
-        [key: number]: string;
-    };
+    jsonSchemaTypes: Record<string, string>;
     matchesMimeType: {
         formUrlEncoded: (mimeType: string) => boolean;
         json: (contentType: string) => boolean;

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## <small>17.7.3 (2022-02-15)</small>
+
+* feat: adding a dereference option to preserve ref pointers as titles (#601) ([161aebf](https://github.com/readmeio/oas/commit/161aebf)), closes [#601](https://github.com/readmeio/oas/issues/601)
+* chore(style): upgrading our core typescript code standards (#598) ([f12d472](https://github.com/readmeio/oas/commit/f12d472)), closes [#598](https://github.com/readmeio/oas/issues/598)
+
+
+
 ## <small>17.7.2 (2022-02-02)</small>
 
 * chore(deps-dev): bump @commitlint/cli from 16.0.1 to 16.1.0 (#591) ([a46f0ab](https://github.com/readmeio/oas/commit/a46f0ab)), closes [#591](https://github.com/readmeio/oas/issues/591)

package/dist/index.js

@@ -667,8 +667,10 @@ var Oas = /** @class */ (function () {
      * Dereference the current OAS definition so it can be parsed free of worries of `$ref` schemas and circular
      * structures.
      *
+     * @param opts
      */
-    Oas.prototype.dereference = function () {
+    Oas.prototype.dereference = function (opts) {
+        if (opts === void 0) { opts = { preserveRefAsJSONSchemaTitle: false }; }
         return __awaiter(this, void 0, void 0, function () {
             var _a, api, promises;
             var _this = this;
@@ -690,6 +692,12 @@ var Oas = /** @class */ (function () {
                 // 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) {
+                        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
+                            // prefer to retain original reference name as a title for any generated types.
+                            api.components.schemas[schemaName].title = schemaName;
+                        }
                         api.components.schemas[schemaName]['x-readme-ref-name'] = schemaName;
                     });
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "17.7.2",
+  "version": "17.7.3",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",
@@ -67,7 +67,7 @@
   "devDependencies": {
     "@commitlint/cli": "^16.0.1",
     "@commitlint/config-conventional": "^16.0.0",
-    "@readme/eslint-config": "^8.1.2",
+    "@readme/eslint-config": "^8.4.1",
     "@readme/oas-examples": "^4.3.2",
     "@types/jest": "^27.0.2",
     "@types/json-schema-merge-allof": "^0.6.1",

package/src/index.ts

@@ -20,9 +20,9 @@ type PathMatch = {
   operation: RMOAS.PathsObject;
   match?: MatchResult;
 };
-type PathMatches = Array<PathMatch>;
+type PathMatches = PathMatch[];
 
-type Variables = Record<string, string | number | Array<{ default?: string | number }> | { default?: string | number }>;
+type Variables = Record<string, string | number | { default?: string | number }[] | { default?: string | number }>;
 
 function ensureProtocol(url: string) {
   // Add protocol to urls starting with // e.g. //example.com
@@ -173,14 +173,14 @@ function filterPathMethods(pathMatches: PathMatches, targetMethod: RMOAS.HttpMet
 
       return false;
     })
-    .filter(Boolean) as Array<{ url: PathMatch['url']; operation: RMOAS.OperationObject }>;
+    .filter(Boolean) as { url: PathMatch['url']; operation: RMOAS.OperationObject }[];
 }
 
 /**
  * @param pathMatches URL and PathsObject matches to narrow down to find a target path.
  * @returns An object containing matches that were discovered in the API definition.
  */
-function findTargetPath(pathMatches: Array<{ url: PathMatch['url']; operation: RMOAS.PathsObject }>) {
+function findTargetPath(pathMatches: { url: PathMatch['url']; operation: RMOAS.PathsObject }[]) {
   let minCount = Object.keys(pathMatches[0].url.slugs).length;
   let operation;
 
@@ -214,10 +214,10 @@ export default class Oas {
    *
    * @todo These are always `Promise.resolve` and `Promise.reject`. Make these types more specific than `any`.
    */
-  protected promises: Array<{
+  protected promises: {
     resolve: any;
     reject: any;
-  }>;
+  }[];
 
   /**
    * Internal storage array that the library utilizes to keep track of its `dereferencing` state so it doesn't initiate
@@ -504,7 +504,7 @@ export default class Oas {
             pathName: url.split(new RegExp(rgx)).slice(-1).pop(),
           };
         })
-        .filter(Boolean) as Array<{ matchedServer: RMOAS.ServerObject; pathName: string }>;
+        .filter(Boolean) as { matchedServer: RMOAS.ServerObject; pathName: string }[];
 
       if (!matchedServerAndPath.length) {
         return undefined;
@@ -548,10 +548,10 @@ export default class Oas {
       return undefined;
     }
 
-    const matches = filterPathMethods(annotatedPaths, method) as Array<{
+    const matches = filterPathMethods(annotatedPaths, method) as {
       url: PathMatch['url'];
       operation: RMOAS.PathsObject; // @fixme this should actually be an `OperationObject`.
-    }>;
+    }[];
     if (!matches.length) return undefined;
     return findTargetPath(matches);
   }
@@ -704,8 +704,9 @@ export default class Oas {
    * Dereference the current OAS definition so it can be parsed free of worries of `$ref` schemas and circular
    * structures.
    *
+   * @param opts
    */
-  async dereference() {
+  async dereference(opts = { preserveRefAsJSONSchemaTitle: false }) {
     if (this.dereferencing.complete) {
       return new Promise(resolve => {
         resolve(true);
@@ -727,6 +728,13 @@ export default class Oas {
     // 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 => {
+        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
+          // prefer to retain original reference name as a title for any generated types.
+          (api.components.schemas[schemaName] as RMOAS.SchemaObject).title = schemaName;
+        }
+
         (api.components.schemas[schemaName] as RMOAS.SchemaObject)['x-readme-ref-name'] = schemaName;
       });
     }

package/src/lib/get-schema.ts

@@ -16,13 +16,7 @@ import findSchemaDefinition from './find-schema-definition';
  */
 export default function getSchema(
   operation: RMOAS.OperationObject,
-  api?:
-    | RMOAS.OASDocument
-    | {
-        [schemaType: string]: {
-          [key: string]: RMOAS.SchemaObject;
-        };
-      }
+  api?: RMOAS.OASDocument | Record<string /* schemaType */, Record<string, RMOAS.SchemaObject>>
 ): {
   type: string;
   schema: any; // @fixme give this a better type

package/src/lib/matches-mimetype.ts

@@ -1,4 +1,4 @@
-function matchesMediaType(types: Array<string>, mediaType: string): boolean {
+function matchesMediaType(types: string[], mediaType: string): boolean {
   return types.some(function (type) {
     return mediaType.indexOf(type) > -1;
   });

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

@@ -11,7 +11,7 @@ import mergeJSONSchemaAllOf from 'json-schema-merge-allof';
  *
  * @see {@link https://github.com/openapi-contrib/openapi-schema-to-json-schema/blob/master/index.js#L23-L27}
  */
-const UNSUPPORTED_SCHEMA_PROPS: Array<'nullable' | 'xml' | 'externalDocs' | 'example'> = [
+const UNSUPPORTED_SCHEMA_PROPS: ('nullable' | 'xml' | 'externalDocs' | 'example')[] = [
   'nullable',
   // 'discriminator',
   // 'readOnly',
@@ -22,13 +22,11 @@ const UNSUPPORTED_SCHEMA_PROPS: Array<'nullable' | 'xml' | 'externalDocs' | 'exa
   // 'deprecated',
 ];
 
-type PrevSchemasType = Array<RMOAS.SchemaObject>;
+type PrevSchemasType = RMOAS.SchemaObject[];
 
 export type toJsonSchemaOptions = {
   currentLocation?: string;
-  globalDefaults?: {
-    [key: string]: unknown;
-  };
+  globalDefaults?: Record<string, unknown>;
   isPolymorphicAllOfChild?: boolean;
   prevSchemas?: PrevSchemasType;
   refLogger?: (ref: string) => void;
@@ -252,16 +250,16 @@ export default function toJSONSchema(
           resolvers: {
             // JSON Schema ony supports examples with the `examples` property, since we're ingesting OpenAPI
             // definitions we need to add a custom resolver for its `example` property.
-            example: (obj: Array<unknown>) => obj[0],
+            example: (obj: unknown[]) => obj[0],
 
             // JSON Schema has no support for `format` on anything other than `string`, but since OpenAPI has it on
             // `integer` and `number` we need to add a custom resolver here so we can still merge schemas that may
             // have those.
-            format: (obj: Array<string>) => obj[0],
+            format: (obj: string[]) => obj[0],
 
             // Since JSON Schema obviously doesn't know about our vendor extension we need to tell the library to
             // essentially ignore and pass it along.
-            'x-readme-ref-name': (obj: Array<string>) => obj[0],
+            'x-readme-ref-name': (obj: string[]) => obj[0],
           } as unknown,
         }) as RMOAS.SchemaObject;
       } catch (e) {
@@ -353,7 +351,7 @@ export default function toJSONSchema(
     } else if ('examples' in schema) {
       let reshapedExamples = false;
       if (typeof schema.examples === 'object' && !Array.isArray(schema.examples)) {
-        const examples: Array<unknown> = [];
+        const examples: unknown[] = [];
         Object.keys(schema.examples).forEach(name => {
           const example = schema.examples[name as unknown as number];
           if ('$ref' in example) {
@@ -544,7 +542,7 @@ export default function toJSONSchema(
   // Remove unsupported JSON Schema props.
   for (let i = 0; i < UNSUPPORTED_SCHEMA_PROPS.length; i += 1) {
     // Using the as here because the purpose is to delete keys we don't expect, so of course the typing won't work
-    delete (schema as { [key: string]: unknown })[UNSUPPORTED_SCHEMA_PROPS[i]];
+    delete (schema as Record<string, unknown>)[UNSUPPORTED_SCHEMA_PROPS[i]];
   }
 
   return schema;

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

@@ -1,12 +1,12 @@
 import type * as RMOAS from '../rmoas.types';
 import getResponseExamples from './get-response-examples';
 
-export type CallbackExamples = Array<{
+export type CallbackExamples = {
   identifier: string;
   expression: string;
   method: string;
   example: unknown;
-}>;
+}[];
 
 /**
  * With an OpenAPI Operation Object return back a collection of examples for any callbacks that may be present.

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

@@ -21,7 +21,7 @@ export type SchemaWrapper = {
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#parameterObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameterObject}
  */
-export const types: { [key: keyof RMOAS.OASDocument]: string } = {
+export const types: Record<keyof RMOAS.OASDocument, string> = {
   path: 'Path Params',
   query: 'Query Params',
   body: 'Body Params',
@@ -74,10 +74,10 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
     // Clone the original schema so this doesn't interfere with it
     const deprecatedBody = cloneObject(schema);
     // Booleans are not valid for required in draft 4, 7 or 2020. Not sure why the typing thinks they are.
-    const requiredParams = (schema.required || []) as Array<string>;
+    const requiredParams = (schema.required || []) as string[];
 
     // Find all top-level deprecated properties from the schema - required and readOnly params are excluded
-    const allDeprecatedProps: { [key: string]: SchemaObject } = {};
+    const allDeprecatedProps: Record<string, SchemaObject> = {};
 
     Object.keys(deprecatedBody.properties).forEach(key => {
       const deprecatedProp = deprecatedBody.properties[key] as SchemaObject;
@@ -87,7 +87,7 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
     });
 
     // We know this is the right type. todo: don't use as
-    (deprecatedBody.properties as { [key: string]: SchemaObject }) = allDeprecatedProps;
+    (deprecatedBody.properties as Record<string, SchemaObject>) = allDeprecatedProps;
     const deprecatedSchema = toJSONSchema(deprecatedBody, { globalDefaults, prevSchemas: [], refLogger });
 
     // Check if the schema wasn't created or there's no deprecated properties
@@ -128,7 +128,7 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
       return null;
     }
 
-    const prevSchemas = [] as Array<RMOAS.SchemaObject>;
+    const prevSchemas: RMOAS.SchemaObject[] = [];
     if ('example' in mediaTypeObject) {
       prevSchemas.push({ example: mediaTypeObject.example });
     } else if ('examples' in mediaTypeObject) {
@@ -186,11 +186,11 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
     return components;
   }
 
-  function transformParameters(): Array<SchemaWrapper> {
+  function transformParameters(): SchemaWrapper[] {
     const operationParams = operation.getParameters();
 
     return Object.keys(types).map(type => {
-      const required: Array<string> = [];
+      const required: string[] = [];
 
       // This `as` actually *could* be a ref, but we don't want refs to pass through here, so `.in` will never match `type`
       const parameters = operationParams.filter(param => (param as RMOAS.ParameterObject).in === type);
@@ -198,7 +198,7 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
         return null;
       }
 
-      const properties = parameters.reduce((prev: { [key: string]: SchemaObject }, current: RMOAS.ParameterObject) => {
+      const properties = parameters.reduce((prev: Record<string, SchemaObject>, current: RMOAS.ParameterObject) => {
         let schema: SchemaObject = {};
         if ('schema' in current) {
           const currentSchema: SchemaObject = current.schema ? cloneObject(current.schema) : {};
@@ -210,7 +210,7 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
           } else if (current.examples) {
             // `examples` isn't actually supported here in OAS 3.0, but we might as well support it because `examples` is
             // JSON Schema and that's fully supported in OAS 3.1.
-            currentSchema.examples = current.examples as unknown as Array<unknown>;
+            currentSchema.examples = current.examples as unknown as unknown[];
           }
 
           if (current.deprecated) currentSchema.deprecated = current.deprecated;
@@ -254,7 +254,7 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
               } else if (current.examples) {
                 // `examples` isn't actually supported here in OAS 3.0, but we might as well support it because `examples` is
                 // JSON Schema and that's fully supported in OAS 3.1.
-                currentSchema.examples = current.examples as unknown as Array<unknown>;
+                currentSchema.examples = current.examples as unknown as unknown[];
               }
 
               if (current.deprecated) currentSchema.deprecated = current.deprecated;
@@ -290,7 +290,7 @@ export default function getParametersAsJsonSchema(operation: Operation, api: OAS
       // This typing is technically WRONG :( but it's the best we can do for now.
       const schema: OpenAPIV3_1.SchemaObject = {
         type: 'object',
-        properties: properties as { [key: string]: OpenAPIV3_1.SchemaObject },
+        properties: properties as Record<string, OpenAPIV3_1.SchemaObject>,
         required,
       };
 

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

@@ -1,10 +1,10 @@
 import type * as RMOAS from '../rmoas.types';
 import getMediaTypeExamples from '../lib/get-mediatype-examples';
 
-export type RequestBodyExamples = Array<{
+export type RequestBodyExamples = {
   mediaType: string;
   examples: any;
-}>;
+}[];
 
 /**
  * Retrieve a collection of request body examples, keyed by their media type.

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

@@ -114,7 +114,7 @@ export default function getResponseAsJsonSchema(operation: Operation, api: OASDo
   const foundSchema = getPreferredSchema((response as ResponseObject).content);
   if (foundSchema) {
     const schemaWrapper: {
-      type: string | Array<string>;
+      type: string | string[];
       schema: SchemaObject;
       label: string;
       description?: string;

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

@@ -4,10 +4,10 @@ import type { MediaTypeExample } from '../lib/get-mediatype-examples';
 import { isRef } from '../rmoas.types';
 import getMediaTypeExamples from '../lib/get-mediatype-examples';
 
-export type ResponseExamples = Array<{
+export type ResponseExamples = {
   status: string;
   mediaTypes: Record<string, RMOAS.MediaTypeObject>;
-}>;
+}[];
 
 /**
  * Retrieve a collection of response examples keyed, by their media type.
@@ -25,7 +25,7 @@ export default function getResponseExamples(operation: RMOAS.OperationObject) {
         return false;
       }
 
-      const mediaTypes: Record<string, Array<MediaTypeExample>> = {};
+      const mediaTypes: Record<string, MediaTypeExample[]> = {};
       (response.content ? Object.keys(response.content) : []).forEach(mediaType => {
         if (!mediaType) return;
 

package/src/operation.ts

@@ -61,8 +61,8 @@ export default class Operation {
    * Flattened out arrays of both request and response headers that are utilized on this operation.
    */
   headers: {
-    request: Array<string>;
-    response: Array<string>;
+    request: string[];
+    response: string[];
   };
 
   constructor(api: RMOAS.OASDocument, path: string, method: RMOAS.HttpMethods, operation: RMOAS.OperationObject) {
@@ -98,7 +98,7 @@ export default class Operation {
       return this.contentType;
     }
 
-    let types: Array<string> = [];
+    let types: string[] = [];
     if (this.schema.requestBody) {
       if ('$ref' in this.schema.requestBody) {
         this.schema.requestBody = findSchemaDefinition(this.schema.requestBody.$ref, this.api);
@@ -145,7 +145,7 @@ export default class Operation {
    * level, the securities for the entire API definition are returned (with an empty array as a final fallback).
    *
    */
-  getSecurity(): Array<RMOAS.SecurityRequirementObject> {
+  getSecurity(): RMOAS.SecurityRequirementObject[] {
     if (!this.api?.components?.securitySchemes) {
       return [];
     }
@@ -165,7 +165,7 @@ export default class Operation {
    */
   getSecurityWithTypes(
     filterInvalid = false
-  ): Array<false | Array<false | { security: RMOAS.KeyedSecuritySchemeObject; type: SecurityType }>> {
+  ): (false | (false | { security: RMOAS.KeyedSecuritySchemeObject; type: SecurityType })[])[] {
     const securityRequirements = this.getSecurity();
 
     return securityRequirements.map(requirement => {
@@ -220,7 +220,7 @@ export default class Operation {
    * scheme of that type.
    *
    */
-  prepareSecurity(): Record<SecurityType, Array<RMOAS.KeyedSecuritySchemeObject>> {
+  prepareSecurity(): Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]> {
     const securitiesWithTypes = this.getSecurityWithTypes();
 
     return securitiesWithTypes.reduce((prev, securities) => {
@@ -239,7 +239,7 @@ export default class Operation {
       });
 
       return prev;
-    }, {} as Record<SecurityType, Array<RMOAS.KeyedSecuritySchemeObject>>);
+    }, {} as Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]>);
   }
 
   getHeaders(): Operation['headers'] {
@@ -250,7 +250,7 @@ export default class Operation {
 
     const security = this.prepareSecurity();
     if (security.Header) {
-      this.headers.request = (security.Header as Array<OpenAPIV3_1.ApiKeySecurityScheme>).map(h => {
+      this.headers.request = (security.Header as OpenAPIV3_1.ApiKeySecurityScheme[]).map(h => {
         return h.name;
       });
     }
@@ -266,7 +266,7 @@ export default class Operation {
     if (this.schema.parameters) {
       this.headers.request = this.headers.request.concat(
         // Remove the reference object because we will have already dereferenced
-        (this.schema.parameters as Array<OpenAPIV3.ParameterObject> | Array<OpenAPIV3_1.ParameterObject>)
+        (this.schema.parameters as OpenAPIV3.ParameterObject[] | OpenAPIV3_1.ParameterObject[])
           .map(p => {
             if (p.in && p.in === 'header') return p.name;
             return undefined;
@@ -345,7 +345,7 @@ export default class Operation {
    * Return an array of all tags, and their metadata, that exist on this operation.
    *
    */
-  getTags(): Array<RMOAS.TagObject> {
+  getTags(): RMOAS.TagObject[] {
     if (!('tags' in this.schema)) {
       return [];
     }
@@ -359,7 +359,7 @@ export default class Operation {
 
     const oasTags = Object.fromEntries(oasTagMap);
 
-    const tags: Array<RMOAS.TagObject> = [];
+    const tags: RMOAS.TagObject[] = [];
     if (Array.isArray(this.schema.tags)) {
       this.schema.tags.forEach(tag => {
         if (tag in oasTags) {
@@ -395,9 +395,9 @@ export default class Operation {
    * Return the parameters (non-request body) on the operation.
    *
    */
-  getParameters(): Array<RMOAS.ParameterObject> {
-    let parameters = (this.schema?.parameters || []) as Array<RMOAS.ParameterObject>;
-    const commonParams = (this.api?.paths?.[this.path]?.parameters || []) as Array<RMOAS.ParameterObject>;
+  getParameters(): RMOAS.ParameterObject[] {
+    let parameters = (this.schema?.parameters || []) as RMOAS.ParameterObject[];
+    const commonParams = (this.api?.paths?.[this.path]?.parameters || []) as RMOAS.ParameterObject[];
     if (commonParams.length) {
       parameters = parameters.concat(dedupeCommonParameters(parameters, commonParams) || []);
     }
@@ -428,7 +428,7 @@ export default class Operation {
    * Get an array of all valid response status codes for this operation.
    *
    */
-  getResponseStatusCodes(): Array<string> {
+  getResponseStatusCodes(): string[] {
     return this.schema.responses ? Object.keys(this.schema.responses) : [];
   }
 
@@ -603,8 +603,8 @@ export default class Operation {
    * Retrieve an array of operations created from each callback.
    *
    */
-  getCallbacks(): false | Array<false | Callback> {
-    const callbackOperations: Array<false | Callback> = [];
+  getCallbacks(): false | (false | Callback)[] {
+    const callbackOperations: (false | Callback)[] = [];
     if (!this.hasCallbacks()) return false;
 
     Object.keys(this.schema.callbacks).forEach(callback => {
@@ -715,9 +715,9 @@ export class Callback extends Operation {
     return this.schema?.description ? this.schema.description.trim() : undefined;
   }
 
-  getParameters(): Array<RMOAS.ParameterObject> {
-    let parameters = (this.schema?.parameters || []) as Array<RMOAS.ParameterObject>;
-    const commonParams = (this.parentSchema.parameters || []) as Array<RMOAS.ParameterObject>;
+  getParameters(): RMOAS.ParameterObject[] {
+    let parameters = (this.schema?.parameters || []) as RMOAS.ParameterObject[];
+    const commonParams = (this.parentSchema.parameters || []) as RMOAS.ParameterObject[];
     if (commonParams.length) {
       parameters = parameters.concat(dedupeCommonParameters(parameters, commonParams) || []);
     }

package/src/rmoas.types.ts

@@ -21,12 +21,12 @@ export function isOAS31(check: OpenAPIV3.Document | OpenAPIV3_1.Document): check
 
 export interface User {
   [key: string]: unknown;
-  keys?: Array<{
+  keys?: {
     name: string | number;
     user?: string | number;
     pass?: string | number;
     [key: string]: unknown;
-  }>;
+  }[];
 }
 
 export type HttpMethods =
@@ -42,9 +42,9 @@ export type HttpMethods =
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oasObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oasObject}
  */
-export type OASDocument = (OpenAPIV3.Document | OpenAPIV3_1.Document) & {
-  [extension: string]: unknown;
-};
+export type OASDocument = (OpenAPIV3.Document | OpenAPIV3_1.Document) &
+  // `x-*` extensions
+  Record<string, unknown>;
 
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#serverObject}
@@ -57,12 +57,10 @@ export type ServerObject = OpenAPIV3.ServerObject | OpenAPIV3_1.ServerObject;
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverVariableObject}
  */
 export type ServerVariableObject = OpenAPIV3.ServerVariableObject | OpenAPIV3_1.ServerVariableObject;
-export type ServerVariablesObject = {
-  [variable: string]: ServerVariableObject;
-};
+export type ServerVariablesObject = Record<string, ServerVariableObject>;
 export type ServerVariable = Record<
   string,
-  string | number | Array<{ default?: string | number }> | { default?: string | number } | Record<string, never>
+  string | number | { default?: string | number }[] | { default?: string | number } | Record<string, never>
 >;
 
 export type Servers = {
@@ -92,9 +90,9 @@ export type PathItemObject = OpenAPIV3.PathItemObject | OpenAPIV3_1.PathItemObje
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operationObject}
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operationObject}
  */
-export type OperationObject = (OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject) & {
-  [extension: string]: unknown;
-};
+export type OperationObject = (OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject) &
+  // `x-*` extensions
+  Record<string, unknown>;
 
 /**
  * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameterObject}
@@ -159,7 +157,7 @@ export type SchemaObject = (
   readOnly?: boolean;
   writeOnly?: boolean;
   example?: unknown;
-  examples?: Array<unknown>;
+  examples?: unknown[];
   nullable?: boolean;
 
   // OpenAPI-specific properties
@@ -194,9 +192,7 @@ export function isSchema(check: unknown, isPolymorphicAllOfChild = false): check
  */
 export type SecuritySchemeObject = OpenAPIV3.SecuritySchemeObject | OpenAPIV3_1.SecuritySchemeObject;
 
-export type SecuritySchemesObject = {
-  [key: string]: SecuritySchemeObject;
-};
+export type SecuritySchemesObject = Record<string, SecuritySchemeObject>;
 
 export type KeyedSecuritySchemeObject = {
   _key: string;

package/src/samples/index.ts

@@ -56,7 +56,7 @@ const primitive = (schema: RMOAS.SchemaObject) => {
 function sampleFromSchema(
   schema: RMOAS.SchemaObject,
   opts: { includeReadOnly?: boolean; includeWriteOnly?: boolean } = {}
-): string | number | boolean | null | Array<unknown> | Record<string, unknown> | undefined {
+): string | number | boolean | null | unknown[] | Record<string, unknown> | undefined {
   const objectifySchema = objectify(schema);
   let { type } = objectifySchema;
 
@@ -76,7 +76,7 @@ function sampleFromSchema(
       return undefined;
     }
   } else if (hasPolymorphism) {
-    return sampleFromSchema((objectifySchema[hasPolymorphism] as Array<RMOAS.SchemaObject>)[0], opts);
+    return sampleFromSchema((objectifySchema[hasPolymorphism] as RMOAS.SchemaObject[])[0], opts);
   }
 
   const { example, additionalProperties, properties, items } = objectifySchema;
@@ -158,7 +158,7 @@ function sampleFromSchema(
       return schema.default;
     }
 
-    return normalizeArray(schema.enum as Array<string>)[0];
+    return normalizeArray(schema.enum as string[])[0];
   }
 
   if (type === 'file') {

package/src/samples/utils.ts

@@ -31,7 +31,7 @@ export function objectify(thing: unknown | Record<string, unknown>): Record<stri
   return thing;
 }
 
-export function normalizeArray(arr: string | number | Array<string | number>) {
+export function normalizeArray(arr: string | number | (string | number)[]) {
   if (Array.isArray(arr)) {
     return arr;
   }