dtsgenerator 3.19.1 → 4.0.0

package/src/core/openApiV2.ts

@@ -1,5 +1,3 @@
-/* eslint-disable @typescript-eslint/no-empty-interface */
-/* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/no-namespace */
 import { JsonSchemaDraft04 } from './jsonSchemaDraft04';
 
@@ -72,11 +70,7 @@ export namespace OpenApisV2 {
             }
             export type CollectionFormat = 'csv' | 'ssv' | 'tsv' | 'pipes';
             export type CollectionFormatWithMulti =
-                | 'csv'
-                | 'ssv'
-                | 'tsv'
-                | 'pipes'
-                | 'multi';
+                'csv' | 'ssv' | 'tsv' | 'pipes' | 'multi';
             /**
              * Contact information for the owners of the API.
              */
@@ -98,15 +92,9 @@ export namespace OpenApisV2 {
             /**
              * One or more JSON objects describing the schemas being consumed and produced by the API.
              */
-            export interface Definitions {
-                [
-                    name: string
-                ]: /* A deterministic version of a JSON Schema object. */ Schema;
-            }
+            export type Definitions = Record<string, Schema>;
             export type Enum = JsonSchemaDraft04.Schema.Properties.Enum;
-            export interface Examples {
-                [name: string]: any;
-            }
+            export type Examples = Record<string, any>;
             export type ExclusiveMaximum =
                 JsonSchemaDraft04.Schema.Properties.ExclusiveMaximum;
             export type ExclusiveMinimum =
@@ -232,9 +220,7 @@ export namespace OpenApisV2 {
                 enum?: Enum;
                 multipleOf?: MultipleOf;
             }
-            export interface Headers {
-                [name: string]: Header;
-            }
+            export type Headers = Record<string, Header>;
             /**
              * General information about the API.
              */
@@ -323,9 +309,7 @@ export namespace OpenApisV2 {
                 tokenUrl: string; // uri
                 description?: string;
             }
-            export interface Oauth2Scopes {
-                [name: string]: string;
-            }
+            export type Oauth2Scopes = Record<string, string>;
             export interface Operation {
                 tags?: string[];
                 /**
@@ -359,9 +343,7 @@ export namespace OpenApisV2 {
             /**
              * One or more JSON representations for parameters
              */
-            export interface ParameterDefinitions {
-                [name: string]: Parameter;
-            }
+            export type ParameterDefinitions = Record<string, Parameter>;
             /**
              * The parameters needed to send a valid API call.
              */
@@ -415,11 +397,9 @@ export namespace OpenApisV2 {
             /**
              * Relative paths to the individual endpoints. They must be relative to the 'basePath'.
              */
-            export interface Paths {
-                [pattern: string]: PathItem;
-            }
+            export type Paths = Record<string, PathItem>;
             export type Pattern =
-                JsonSchemaDraft04.Schema.Properties.Pattern /* regex */;
+                JsonSchemaDraft04.Schema.Properties.Pattern; /* regex */
             export interface PrimitivesItems {
                 type?: 'string' | 'number' | 'integer' | 'boolean' | 'array';
                 format?: string;
@@ -480,8 +460,9 @@ export namespace OpenApisV2 {
             }
             export interface Response {
                 description: string;
-                schema?: /* A deterministic version of a JSON Schema object. */
-                | Schema
+                schema?:
+                    /* A deterministic version of a JSON Schema object. */
+                    | Schema
                     | /* A deterministic version of a JSON Schema object. */ FileSchema;
                 headers?: Headers;
                 examples?: Examples;
@@ -489,18 +470,12 @@ export namespace OpenApisV2 {
             /**
              * One or more JSON representations for responses
              */
-            export interface ResponseDefinitions {
-                [name: string]: Response;
-            }
+            export type ResponseDefinitions = Record<string, Response>;
             export type ResponseValue = Response | JsonReference;
             /**
              * Response objects names can either be any valid HTTP status code or 'default'.
              */
-            export interface Responses {
-                [
-                    pattern: string
-                ]: ResponseValue /* Patterns: ^([0-9]{3})$|^(default)$ | ^x- */;
-            }
+            export type Responses = Record<string, ResponseValue>;
             /**
              * A deterministic version of a JSON Schema object.
              */
@@ -525,11 +500,13 @@ export namespace OpenApisV2 {
                 minProperties?: JsonSchemaDraft04.Schema.Definitions.PositiveIntegerDefault0;
                 required?: JsonSchemaDraft04.Schema.Definitions.StringArray;
                 enum?: JsonSchemaDraft04.Schema.Properties.Enum;
-                additionalProperties?: /* A deterministic version of a JSON Schema object. */
-                Schema | boolean;
+                additionalProperties?:
+                    /* A deterministic version of a JSON Schema object. */
+                    Schema | boolean;
                 type?: JsonSchemaDraft04.Schema.Properties.Type;
-                items?: /* A deterministic version of a JSON Schema object. */
-                | Schema
+                items?:
+                    /* A deterministic version of a JSON Schema object. */
+                    | Schema
                     | [
                           /* A deterministic version of a JSON Schema object. */ Schema,
                           .../* A deterministic version of a JSON Schema object. */ Schema[],
@@ -538,11 +515,7 @@ export namespace OpenApisV2 {
                     /* A deterministic version of a JSON Schema object. */ Schema,
                     .../* A deterministic version of a JSON Schema object. */ Schema[],
                 ];
-                properties?: {
-                    [
-                        name: string
-                    ]: /* A deterministic version of a JSON Schema object. */ Schema;
-                };
+                properties?: Record<string, Schema>;
                 discriminator?: string;
                 readOnly?: boolean;
                 xml?: Xml;
@@ -554,18 +527,16 @@ export namespace OpenApisV2 {
              */
             export type SchemesList = ('http' | 'https' | 'ws' | 'wss')[];
             export type Security = SecurityRequirement[];
-            export interface SecurityDefinitions {
-                [name: string]:
-                    | BasicAuthenticationSecurity
-                    | ApiKeySecurity
-                    | Oauth2ImplicitSecurity
-                    | Oauth2PasswordSecurity
-                    | Oauth2ApplicationSecurity
-                    | Oauth2AccessCodeSecurity;
-            }
-            export interface SecurityRequirement {
-                [name: string]: string[];
-            }
+            export type SecurityDefinitions = Record<
+                string,
+                | BasicAuthenticationSecurity
+                | ApiKeySecurity
+                | Oauth2ImplicitSecurity
+                | Oauth2PasswordSecurity
+                | Oauth2ApplicationSecurity
+                | Oauth2AccessCodeSecurity
+            >;
+            export type SecurityRequirement = Record<string, string[]>;
             export interface Tag {
                 name: string;
                 description?: string;
@@ -583,5 +554,5 @@ export namespace OpenApisV2 {
         }
     }
 }
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
 export import SwaggerIo = OpenApisV2;

package/src/core/openApiV3.ts

@@ -1,5 +1,5 @@
-/* eslint-disable @typescript-eslint/no-empty-interface */
-/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+
 /* eslint-disable @typescript-eslint/no-namespace */
 import { JsonSchemaDraft07 } from './jsonSchemaDraft07';
 
@@ -20,21 +20,18 @@ export namespace OpenApisV3 {
     }
     export namespace SchemaJson {
         export namespace Definitions {
-            export interface Any {
-                [name: string]: any;
-            }
+            export type Any = Record<string, any>;
             export type AnyOrExpression = Any | Expression;
-            export interface AnysOrExpressions {
-                [name: string]: AnyOrExpression;
-            }
+            export type AnysOrExpressions = Record<string, AnyOrExpression>;
             /**
              * A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
              */
             export interface Callback {}
             export type CallbackOrReference = Callback | Reference;
-            export interface CallbacksOrReferences {
-                [name: string]: CallbackOrReference;
-            }
+            export type CallbacksOrReferences = Record<
+                string,
+                CallbackOrReference
+            >;
             /**
              * Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
              */
@@ -75,9 +72,7 @@ export namespace OpenApisV3 {
                 explode?: boolean;
                 allowReserved?: boolean;
             }
-            export interface Encodings {
-                [name: string]: Encoding;
-            }
+            export type Encodings = Record<string, Encoding>;
             /**
              *
              */
@@ -88,12 +83,11 @@ export namespace OpenApisV3 {
                 externalValue?: string;
             }
             export type ExampleOrReference = Example | Reference;
-            export interface ExamplesOrReferences {
-                [name: string]: ExampleOrReference;
-            }
-            export interface Expression {
-                [name: string]: any;
-            }
+            export type ExamplesOrReferences = Record<
+                string,
+                ExampleOrReference
+            >;
+            export type Expression = Record<string, any>;
             /**
              * Allows referencing an external resource for extended documentation.
              */
@@ -118,9 +112,7 @@ export namespace OpenApisV3 {
                 content?: MediaTypes;
             }
             export type HeaderOrReference = Header | Reference;
-            export interface HeadersOrReferences {
-                [name: string]: HeaderOrReference;
-            }
+            export type HeadersOrReferences = Record<string, HeaderOrReference>;
             /**
              * The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.
              */
@@ -151,9 +143,7 @@ export namespace OpenApisV3 {
                 server?: Server;
             }
             export type LinkOrReference = Link | Reference;
-            export interface LinksOrReferences {
-                [name: string]: LinkOrReference;
-            }
+            export type LinksOrReferences = Record<string, LinkOrReference>;
             /**
              * Each Media Type Object provides schema and examples for the media type identified by its key.
              */
@@ -163,9 +153,7 @@ export namespace OpenApisV3 {
                 examples?: ExamplesOrReferences;
                 encoding?: Encodings;
             }
-            export interface MediaTypes {
-                [name: string]: MediaType;
-            }
+            export type MediaTypes = Record<string, MediaType>;
             /**
              * Configuration details for a supported OAuth Flow
              */
@@ -220,9 +208,10 @@ export namespace OpenApisV3 {
                 content?: MediaTypes;
             }
             export type ParameterOrReference = Parameter | Reference;
-            export interface ParametersOrReferences {
-                [name: string]: ParameterOrReference;
-            }
+            export type ParametersOrReferences = Record<
+                string,
+                ParameterOrReference
+            >;
             /**
              * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.
              */
@@ -245,18 +234,17 @@ export namespace OpenApisV3 {
             /**
              * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the `Server Object` in order to construct the full URL.  The Paths MAY be empty, due to ACL constraints.
              */
-            export interface Paths {
-                [name: string]: PathItemOrReference;
-            }
+            export type Paths = Record<string, PathItemOrReference>;
             /**
              * A simple object to allow referencing other components in the specification, internally and externally.  The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules.   For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification.
              */
             export interface Reference {
                 $ref: string;
             }
-            export interface RequestBodiesOrReferences {
-                [name: string]: RequestBodyOrReference;
-            }
+            export type RequestBodiesOrReferences = Record<
+                string,
+                RequestBodyOrReference
+            >;
             /**
              * Describes a single request body.
              */
@@ -279,15 +267,13 @@ export namespace OpenApisV3 {
             /**
              * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.  The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.  The `default` MAY be used as a default response object for all HTTP codes  that are not covered individually by the specification.  The `Responses Object` MUST contain at least one response code, and it  SHOULD be the response for a successful operation call.
              */
-            export interface ResponsesOrReferences {
-                [name: string]: ResponseOrReference;
-            }
+            export type ResponsesOrReferences = Record<
+                string,
+                ResponseOrReference
+            >;
             export type SchemaOrReference =
-                | JsonSchemaDraft07.SchemaObject
-                | Reference;
-            export interface SchemasOrReferences {
-                [name: string]: SchemaOrReference;
-            }
+                JsonSchemaDraft07.SchemaObject | Reference;
+            export type SchemasOrReferences = Record<string, SchemaOrReference>;
             /**
              * Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.  Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.  When a list of Security Requirement Objects is defined on the Open API object or Operation Object, only one of Security Requirement Objects in the list needs to be satisfied to authorize the request.
              */
@@ -306,9 +292,10 @@ export namespace OpenApisV3 {
                 openIdConnectUrl?: string;
             }
             export type SecuritySchemeOrReference = SecurityScheme | Reference;
-            export interface SecuritySchemesOrReferences {
-                [name: string]: SecuritySchemeOrReference;
-            }
+            export type SecuritySchemesOrReferences = Record<
+                string,
+                SecuritySchemeOrReference
+            >;
             /**
              * An object representing a Server.
              */
@@ -325,21 +312,13 @@ export namespace OpenApisV3 {
                 default: string;
                 description?: string;
             }
-            export interface ServerVariables {
-                [name: string]: ServerVariable;
-            }
+            export type ServerVariables = Record<string, ServerVariable>;
             /**
              * Any property starting with x- is valid.
              */
             export type SpecificationExtension =
-                | null
-                | number
-                | boolean
-                | string
-                | any[];
-            export interface Strings {
-                [name: string]: string;
-            }
+                null | number | boolean | string | any[];
+            export type Strings = Record<string, string>;
             /**
              * Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.
              */

package/src/core/type.ts

@@ -12,21 +12,17 @@ import { OpenApisV3 } from './openApiV3';
 import SchemaId from './schemaId';
 
 // export `ts` for using the same version of TypeScript in all plugins.
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 export import ts = require('typescript');
 
 // Schema types
 
 export type JsonSchema = JsonSchemaDraft04.Schema | JsonSchemaDraft07.Schema;
 export type JsonSchemaObject =
-    | JsonSchemaDraft04.Schema
-    | JsonSchemaDraft07.SchemaObject;
+    JsonSchemaDraft04.Schema | JsonSchemaDraft07.SchemaObject;
 export type SchemaType =
-    | 'Draft04'
-    | 'Draft07'
-    | '2019-09'
-    | '2020-12'
-    | 'Latest';
+    'Draft04' | 'Draft07' | '2019-09' | '2020-12' | 'Latest';
 export function isJsonSchemaDraft04(
     _content: JsonSchemaObject,
     type: SchemaType,
@@ -119,7 +115,7 @@ export interface PluginContext {
 
 export type PreProcessHandler = (contents: Schema[]) => Schema[];
 
-export type Plugin = {
+export interface Plugin {
     meta: {
         name: string;
         version: string;
@@ -131,7 +127,7 @@ export type Plugin = {
     postProcess?: (
         context: PluginContext,
     ) => Promise<TransformerFactory<SourceFile> | undefined>;
-};
+}
 
 export async function loadPlugin(
     name: string,

package/src/core/utils.ts

@@ -78,9 +78,9 @@ export function checkValidMIMEType(mime: string): boolean {
     return /^application\/(?:[a-z0-9-_.]+\+)?json5?$/.test(type);
 }
 
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export function mergeSchema(a: any, b: any): boolean {
     if ('$ref' in a || '$ref' in b) {
+        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
         a.$ref = b.$ref || a.$ref;
         return false;
     }

package/src/core/validateIdentifier.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
 /* eslint-disable @typescript-eslint/no-unsafe-enum-comparison */
 import { ScriptTarget } from 'typescript';
 
@@ -785,16 +784,16 @@ function isUnicodeIdentifierStart(code: number, languageVersion: ScriptTarget) {
     return languageVersion >= ScriptTarget.ES2015
         ? lookupInUnicodeMap(code, unicodeESNextIdentifierStart)
         : languageVersion === ScriptTarget.ES5
-        ? lookupInUnicodeMap(code, unicodeES5IdentifierStart)
-        : lookupInUnicodeMap(code, unicodeES3IdentifierStart);
+          ? lookupInUnicodeMap(code, unicodeES5IdentifierStart)
+          : lookupInUnicodeMap(code, unicodeES3IdentifierStart);
 }
 
 function isUnicodeIdentifierPart(code: number, languageVersion: ScriptTarget) {
     return languageVersion >= ScriptTarget.ES2015
         ? lookupInUnicodeMap(code, unicodeESNextIdentifierPart)
         : languageVersion === ScriptTarget.ES5
-        ? lookupInUnicodeMap(code, unicodeES5IdentifierPart)
-        : lookupInUnicodeMap(code, unicodeES3IdentifierPart);
+          ? lookupInUnicodeMap(code, unicodeES5IdentifierPart)
+          : lookupInUnicodeMap(code, unicodeES3IdentifierPart);
 }
 
 function isIdentifierStart(ch: number, languageVersion: ScriptTarget): boolean {

package/src/jsonPointer.ts

@@ -1,7 +1,5 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
 
 export function get(
     obj: any,

package/src/utils.ts

@@ -16,6 +16,8 @@ export function readStream(
         let data = '';
         stream.on('data', (chunk) => (data += chunk));
         stream.on('end', () => resolve(data));
+        // Preserve the stream's original error object for callers.
+        // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
         stream.on('error', (error) => reject(error));
     });
 }
@@ -88,22 +90,20 @@ export function readConfig(options: CommandOptions): PartialConfig {
         }
     }
 
-    if (pc.input == null) {
-        pc.input = {
-            files: [],
-            urls: [],
-            stdin: false,
-        };
-    }
+    pc.input ??= {
+        files: [],
+        urls: [],
+        stdin: false,
+    };
     if (options.files.length > 0) {
         pc.input.files = options.files;
-    } else if (pc.input.files == null) {
-        pc.input.files = [];
+    } else {
+        pc.input.files ??= [];
     }
     if (options.urls.length > 0) {
         pc.input.urls = options.urls;
-    } else if (pc.input.urls == null) {
-        pc.input.urls = [];
+    } else {
+        pc.input.urls ??= [];
     }
     if (options.stdin != null) {
         pc.input.stdin = options.stdin;

package/tsconfig.json

@@ -19,7 +19,6 @@
     // "removeComments": true,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */
     "importHelpers": true,                    /* Import emit helpers from 'tslib'. */
-    "downlevelIteration": true,               /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
     /* Strict Type-Checking Options */
@@ -46,6 +45,7 @@
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
     // "types": [],                           /* Type declaration files to be included in compilation. */
+    "types": ["node", "mocha"],
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */

package/.eslintignore

@@ -1 +0,0 @@
-/test/snapshots

package/.eslintrc.json

@@ -1,30 +0,0 @@
-{
-  "root": true,
-  "extends": [
-    "@dtsgenerator"
-  ],
-  "rules": {
-    "@typescript-eslint/no-explicit-any": 0
-  },
-  "overrides": [
-    {
-      "files": [
-        "**/*_test.ts"
-      ],
-      "rules": {
-        "@typescript-eslint/ban-ts-comment": 0,
-        "@typescript-eslint/no-empty-interface": 0,
-        "@typescript-eslint/no-explicit-any": 0,
-        "@typescript-eslint/no-floating-promises": 0,
-        "@typescript-eslint/no-implied-eval": 0,
-        "@typescript-eslint/no-misused-promises": 0,
-        "@typescript-eslint/no-unsafe-assignment": 0,
-        "@typescript-eslint/no-unsafe-call": 0,
-        "@typescript-eslint/no-unsafe-member-access": 0,
-        "@typescript-eslint/no-unsafe-return": 0,
-        "@typescript-eslint/no-var-requires": 0,
-        "@typescript-eslint/unbound-method": 0
-      }
-    }
-  ]
-}