dtsgenerator 3.17.0 → 3.19.0

package/src/core/jsonSchema.ts

@@ -11,6 +11,7 @@ import {
     JsonSchema,
     isJsonSchemaDraft04,
 } from './type';
+import { checkValidMIMEType } from './utils';
 
 type OpenApiSchema = OpenApisV2.SchemaJson | OpenApisV3.SchemaJson;
 type ParametersList =
@@ -31,11 +32,11 @@ export interface NormalizedSchema extends Schema {
 export function getSubSchema(
     rootSchema: Schema,
     pointer: string,
-    id?: SchemaId
+    id?: SchemaId,
 ): Schema {
     const content = JsonPointer.get(
         rootSchema.content,
-        JsonPointer.parse(pointer)
+        JsonPointer.parse(pointer),
     ) as JsonSchema;
     if (id == null) {
         const subId =
@@ -75,7 +76,7 @@ export function getId(type: SchemaType, content: JsonSchemaObject): string {
 export function setId(
     type: SchemaType,
     content: JsonSchemaObject,
-    id: string
+    id: string,
 ): void {
     if (isJsonSchemaDraft04(content, type)) {
         content[Draft04Id] ??= id;
@@ -87,12 +88,12 @@ export function setId(
 export function searchAllSubSchema(
     schema: Schema,
     onFoundSchema: (subSchema: Schema) => void,
-    onFoundReference: (refId: SchemaId) => void
+    onFoundReference: (refId: SchemaId) => void,
 ): void {
     const walkArray = (
         array: JsonSchema[] | undefined,
         paths: string[],
-        parentIds: string[]
+        parentIds: string[],
     ): void => {
         if (array == null) {
             return;
@@ -104,7 +105,7 @@ export function searchAllSubSchema(
     const walkObject = (
         obj: { [name: string]: JsonSchema } | undefined,
         paths: string[],
-        parentIds: string[]
+        parentIds: string[],
     ): void => {
         if (obj == null) {
             return;
@@ -119,7 +120,7 @@ export function searchAllSubSchema(
     const walkMaybeArray = (
         item: JsonSchema | JsonSchema[] | undefined,
         paths: string[],
-        parentIds: string[]
+        parentIds: string[],
     ): void => {
         if (Array.isArray(item)) {
             walkArray(item, paths, parentIds);
@@ -130,7 +131,7 @@ export function searchAllSubSchema(
     const walk = (
         s: JsonSchema | undefined,
         paths: string[],
-        parentIds: string[]
+        parentIds: string[],
     ) => {
         if (s == null || typeof s !== 'object') {
             return;
@@ -164,14 +165,14 @@ export function searchAllSubSchema(
         walk(
             s.additionalProperties,
             paths.concat('additionalProperties'),
-            parentIds
+            parentIds,
         );
         walkObject(s.definitions, paths.concat('definitions'), parentIds);
         walkObject(s.properties, paths.concat('properties'), parentIds);
         walkObject(
             s.patternProperties,
             paths.concat('patternProperties'),
-            parentIds
+            parentIds,
         );
         walkMaybeArray(s.dependencies, paths.concat('dependencies'), parentIds);
         if (schema.type === 'Draft07') {
@@ -202,7 +203,7 @@ export function searchAllSubSchema(
         function setSubIdToAnyObject<T>(
             f: (t: T, keys: string[]) => void,
             obj: { [key: string]: T } | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (obj == null) {
                 return;
@@ -221,7 +222,7 @@ export function searchAllSubSchema(
                 | OpenApisV2.SchemaJson.Definitions.ParameterDefinitions
                 | OpenApisV3.SchemaJson.Definitions.ParametersOrReferences
                 | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (obj == null) {
                 return;
@@ -230,7 +231,7 @@ export function searchAllSubSchema(
         }
         function setSubIdToParameters(
             array: ParametersList | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (array == null) {
                 return;
@@ -239,18 +240,18 @@ export function searchAllSubSchema(
                 array.map(
                     (
                         item: ParameterOrReference,
-                        index: number
+                        index: number,
                     ): [string, ParameterOrReference] => {
                         const key = 'name' in item ? item.name : `${index}`;
                         return [key, item];
-                    }
+                    },
                 ),
-                keys
+                keys,
             );
         }
         function addParameterSchema(
             input: readonly [string, ParameterOrReference][],
-            keys: string[]
+            keys: string[],
         ): void {
             const map = new Map<string, [string, Parameter][]>();
             const pushItem = (key: string, po: [string, Parameter]) => {
@@ -278,7 +279,7 @@ export function searchAllSubSchema(
                 if ('type' in item && item.in !== undefined) {
                     setSubId(
                         item as JsonSchemaDraft04.Schema,
-                        keys.concat(key)
+                        keys.concat(key),
                     );
                     pushItem(item.in, [key, item]);
                 }
@@ -291,7 +292,7 @@ export function searchAllSubSchema(
         function buildParameterSchema(
             inType: string,
             params: [string, Parameter][],
-            keys: string[]
+            keys: string[],
         ): [string[], JsonSchemaObject] {
             const paths = keys
                 .slice(0, keys.length - 1)
@@ -318,13 +319,13 @@ export function searchAllSubSchema(
         /// for OpenAPI V2 only
         const setSubIdToResponsesV2 = (
             responses: OpenApisV2.SchemaJson.Definitions.Responses | undefined,
-            keys: string[]
+            keys: string[],
         ) => setSubIdToAnyObject(setSubIdToResponseV2, responses, keys);
         function setSubIdToResponseV2(
             response:
                 | OpenApisV2.SchemaJson.Definitions.ResponseValue
                 | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (response == null) {
                 return;
@@ -339,7 +340,7 @@ export function searchAllSubSchema(
         }
         function setSubIdToOperationV2(
             ops: OpenApisV2.SchemaJson.Definitions.Operation | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (ops == null) {
                 return;
@@ -354,15 +355,15 @@ export function searchAllSubSchema(
         }
         const setSubIdToPathsV2 = (
             paths: OpenApisV2.SchemaJson.Definitions.Paths,
-            keys: string[]
+            keys: string[],
         ) => setSubIdToAnyObject(setSubIdToPathItemV2, paths, keys);
         function setSubIdToPathItemV2(
             pathItem: OpenApisV2.SchemaJson.Definitions.PathItem,
-            keys: string[]
+            keys: string[],
         ): void {
             setSubIdToParameters(
                 pathItem.parameters,
-                keys.concat('parameters')
+                keys.concat('parameters'),
             );
             setSubIdToOperationV2(pathItem.get, keys.concat('get'));
             setSubIdToOperationV2(pathItem.put, keys.concat('put'));
@@ -376,17 +377,13 @@ export function searchAllSubSchema(
         /// for OpenAPI V3 only
         function setSubIdToMediaTypes(
             types: OpenApisV3.SchemaJson.Definitions.MediaTypes | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (types == null) {
                 return;
             }
             for (const mime of Object.keys(types)) {
-                if (
-                    /^text\/|^(?:application\/x-www-form-urlencoded$|^application\/([a-z0-9-_.]+\+)?json)$|^application\/octet-stream$|^application\/jwt$|^application\/vnd.apple.pkpass$|^multipart\/form-data$|^image\//.test(
-                        mime
-                    )
-                ) {
+                if (checkValidMIMEType(mime)) {
                     const mt = types[mime];
                     if (mt != null) {
                         setSubId(mt.schema, keys);
@@ -398,13 +395,13 @@ export function searchAllSubSchema(
             bodies:
                 | OpenApisV3.SchemaJson.Definitions.RequestBodiesOrReferences
                 | undefined,
-            keys: string[]
+            keys: string[],
         ) => setSubIdToAnyObject(setSubIdToRequestBody, bodies, keys);
         function setSubIdToRequestBody(
             body:
                 | OpenApisV3.SchemaJson.Definitions.RequestBodyOrReference
                 | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (body == null) {
                 return;
@@ -421,13 +418,13 @@ export function searchAllSubSchema(
             responses:
                 | OpenApisV3.SchemaJson.Definitions.ResponsesOrReferences
                 | undefined,
-            keys: string[]
+            keys: string[],
         ) => setSubIdToAnyObject(setSubIdToResponseV3, responses, keys);
         function setSubIdToResponseV3(
             response:
                 | OpenApisV3.SchemaJson.Definitions.ResponseOrReference
                 | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (response == null) {
                 return;
@@ -442,7 +439,7 @@ export function searchAllSubSchema(
         }
         function setSubIdToOperationV3(
             ops: OpenApisV3.SchemaJson.Definitions.Operation | undefined,
-            keys: string[]
+            keys: string[],
         ): void {
             if (ops == null) {
                 return;
@@ -458,15 +455,15 @@ export function searchAllSubSchema(
         }
         const setSubIdToPathsV3 = (
             paths: OpenApisV3.SchemaJson.Definitions.Paths,
-            keys: string[]
+            keys: string[],
         ) => setSubIdToAnyObject(setSubIdToPathItemV3, paths, keys);
         function setSubIdToPathItemV3(
             pathItem: OpenApisV3.SchemaJson.Definitions.PathItem,
-            keys: string[]
+            keys: string[],
         ): void {
             setSubIdToParameters(
                 pathItem.parameters,
-                keys.concat('parameters')
+                keys.concat('parameters'),
             );
             setSubIdToOperationV3(pathItem.get, keys.concat('get'));
             setSubIdToOperationV3(pathItem.put, keys.concat('put'));
@@ -480,7 +477,7 @@ export function searchAllSubSchema(
 
         function setSubIdToObject(
             obj: { [name: string]: JsonSchema } | undefined,
-            paths: string[]
+            paths: string[],
         ): void {
             if (obj == null) {
                 return;
@@ -557,7 +554,7 @@ export function selectSchemaType(content: JsonSchema | OpenApiSchema): {
     }
     if (typeof content !== 'object') {
         throw new Error(
-            `expect parameter of type object, received ${typeof content}`
+            `expect parameter of type object, received ${typeof content}`,
         );
     }
     if ('$schema' in content) {
@@ -567,7 +564,7 @@ export function selectSchemaType(content: JsonSchema | OpenApiSchema): {
         }
         const match =
             /^https?:\/\/json-schema\.org\/(?:draft\/(\d{4}-\d{2})|draft-(\d+))\/schema#?$/.exec(
-                schema
+                schema,
             );
         if (match) {
             if (match[1] != null) {

package/src/core/openApiV2.ts

@@ -532,11 +532,11 @@ export namespace OpenApisV2 {
                 | Schema
                     | [
                           /* 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[],
                       ];
                 allOf?: [
                     /* 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[],
                 ];
                 properties?: {
                     [

package/src/core/openApiV3.ts

@@ -57,13 +57,7 @@ export namespace OpenApisV3 {
                 url?: string; // uri
                 email?: string; // email
             }
-            export type DefaultType =
-                | null
-                | any[]
-                | unknown
-                | number
-                | boolean
-                | string;
+            export type DefaultType = null | any[] | number | boolean | string;
             /**
              * When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation.  The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.  When using the discriminator, _inline_ schemas will not be considered.
              */
@@ -342,7 +336,6 @@ export namespace OpenApisV3 {
                 | number
                 | boolean
                 | string
-                | unknown
                 | any[];
             export interface Strings {
                 [name: string]: string;

package/src/core/referenceResolver.ts

@@ -27,7 +27,7 @@ export default class ReferenceResolver {
 
     public async resolve(): Promise<void> {
         debug(
-            `resolve reference: reference schema count=${this.referenceCache.size}.`
+            `resolve reference: reference schema count=${this.referenceCache.size}.`,
         );
         // debug('  schemaCache:');
         // debug(Array.from(this.schemaCache.keys()).join('\n'));
@@ -45,8 +45,8 @@ export default class ReferenceResolver {
                 const refSchema = this.schemaCache.get(fileId);
                 debug(
                     `get from schema cache, fileId=${fileId}, exists=${String(
-                        !!refSchema
-                    )}, ${id.getAbsoluteId()}`
+                        !!refSchema,
+                    )}, ${id.getAbsoluteId()}`,
                 );
                 if (refSchema == null && id.isFetchable()) {
                     try {
@@ -56,8 +56,8 @@ export default class ReferenceResolver {
                     } catch (e) {
                         error.push(
                             `Fail to fetch the $ref target: ${id.getAbsoluteId()}, ${String(
-                                e
-                            )}`
+                                e,
+                            )}`,
                         );
                         continue;
                     }
@@ -72,21 +72,21 @@ export default class ReferenceResolver {
                     const rootSchema = this.searchParentSchema(id);
                     if (rootSchema == null) {
                         error.push(
-                            `The $ref targets root is not found: ${id.getAbsoluteId()}`
+                            `The $ref targets root is not found: ${id.getAbsoluteId()}`,
                         );
                         continue;
                     }
                     const targetSchema = getSubSchema(
                         rootSchema,
                         id.getJsonPointerHash(),
-                        id
+                        id,
                     );
                     this.addSchema(targetSchema);
                     this.registerSchema(targetSchema);
                     this.referenceCache.set(id.getAbsoluteId(), targetSchema);
                 } else {
                     error.push(
-                        `The $ref target is not found: ${id.getAbsoluteId()}`
+                        `The $ref target is not found: ${id.getAbsoluteId()}`,
                     );
                     continue;
                 }
@@ -125,7 +125,7 @@ export default class ReferenceResolver {
             },
             (refId) => {
                 this.addReference(refId);
-            }
+            },
         );
     }
 

package/src/core/schemaId.ts

@@ -6,7 +6,10 @@ export default class SchemaId {
     public readonly id: url.Url;
     public static readonly empty = new SchemaId('');
 
-    constructor(public readonly inputId: string, parentIds?: string[]) {
+    constructor(
+        public readonly inputId: string,
+        parentIds?: string[],
+    ) {
         let absoluteId = url.resolve('', inputId);
         if (parentIds) {
             parentIds.forEach((parent: string) => {

package/src/core/type.ts

@@ -29,7 +29,7 @@ export type SchemaType =
     | 'Latest';
 export function isJsonSchemaDraft04(
     _content: JsonSchemaObject,
-    type: SchemaType
+    type: SchemaType,
 ): _content is JsonSchemaDraft04.Schema {
     return type === 'Draft04';
 }
@@ -77,7 +77,7 @@ export async function readSchemasFromFile(pattern: string): Promise<Schema[]> {
             });
             const content = parseFileContent(data);
             return parseSchema(content);
-        })
+        }),
     );
 }
 export async function readSchemaFromUrl(url: string): Promise<Schema> {
@@ -88,7 +88,7 @@ export async function readSchemaFromUrl(url: string): Promise<Schema> {
 
 export function parseFileContent(
     content: string,
-    filename?: string
+    filename?: string,
 ): JsonSchema {
     const ext = filename ? extname(filename).toLowerCase() : '';
     const maybeYaml = ext === '.yaml' || ext === '.yml';
@@ -126,16 +126,16 @@ export type Plugin = {
         description?: string;
     };
     preProcess?: (
-        context: PluginContext
+        context: PluginContext,
     ) => Promise<PreProcessHandler | undefined>;
     postProcess?: (
-        context: PluginContext
+        context: PluginContext,
     ) => Promise<TransformerFactory<SourceFile> | undefined>;
 };
 
 export async function loadPlugin(
     name: string,
-    option: boolean | Record<string, unknown>
+    option: boolean | Record<string, unknown>,
 ): Promise<Plugin | undefined> {
     if (!option) {
         return undefined;
@@ -144,14 +144,14 @@ export async function loadPlugin(
     const mod = (await import(name)) as { default?: Plugin };
     if (!mod.default) {
         console.warn(
-            `The plugin (${name}) is invalid module. That is not default export format.`
+            `The plugin (${name}) is invalid module. That is not default export format.`,
         );
         return undefined;
     }
     const plugin = mod.default;
     if (plugin.preProcess != null && typeof plugin.preProcess !== 'function') {
         console.warn(
-            `The plugin (${name}) is invalid module. The 'preProcess' is not a function.`
+            `The plugin (${name}) is invalid module. The 'preProcess' is not a function.`,
         );
         return undefined;
     }
@@ -160,7 +160,7 @@ export async function loadPlugin(
         typeof plugin.postProcess !== 'function'
     ) {
         console.warn(
-            `The plugin (${name}) is invalid module. The 'postProcess' is not a function.`
+            `The plugin (${name}) is invalid module. The 'postProcess' is not a function.`,
         );
         return undefined;
     }

package/src/core/utils.ts

@@ -11,7 +11,7 @@ const debug = Debug('dtsgen');
 
 export function toTSType(
     type: string,
-    debugSource?: JsonSchemaObject
+    debugSource?: JsonSchemaObject,
 ): ts.KeywordTypeSyntaxKind | ts.SyntaxKind.NullKeyword | undefined {
     switch (type) {
         case 'any':
@@ -39,8 +39,8 @@ export function toTSType(
                     `toTSType: unknown type: ${JSON.stringify(
                         debugSource,
                         null,
-                        2
-                    )}`
+                        2,
+                    )}`,
                 );
             }
             throw new Error('unknown type: ' + type);
@@ -55,6 +55,29 @@ export function reduceTypes(types: SimpleTypes[]): SimpleTypes[] {
     return Array.from(set.values());
 }
 
+export function checkValidMIMEType(mime: string): boolean {
+    const type = mime.toLowerCase().split(';')[0]?.trim();
+    if (type == null) {
+        return false;
+    }
+    if (
+        [
+            'application/octet-stream',
+            'application/x-www-form-urlencoded',
+            'multipart/form-data',
+
+            'application/jwt',
+            'application/vnd.apple.pkpass',
+        ].includes(type)
+    ) {
+        return true;
+    }
+    if (type.startsWith('text/') || type.startsWith('image/')) {
+        return true;
+    }
+    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) {

package/src/core/validateIdentifier.ts

@@ -1,10 +1,11 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
+/* eslint-disable @typescript-eslint/no-unsafe-enum-comparison */
 import { ScriptTarget } from 'typescript';
 
 // via. https://github.com/microsoft/TypeScript/blob/v3.7.5/src/services/codefixes/importFixes.ts#L689
 export function checkInvalidCharacter(
     text: string,
-    target: ScriptTarget
+    target: ScriptTarget,
 ): boolean {
     const firstCharCode = text.charCodeAt(0);
     if (!isIdentifierStart(firstCharCode, target)) {

package/src/jsonPointer.ts

@@ -6,7 +6,7 @@
 export function get(
     obj: any,
     path: string[],
-    isCreateOnNotExists = false
+    isCreateOnNotExists = false,
 ): any {
     if (path.length === 0) {
         return obj;

package/src/utils.ts

@@ -1,14 +1,15 @@
 import * as fs from 'fs';
 import { URL } from 'url';
-import glob from 'glob';
-import proxy from 'https-proxy-agent';
+import { GlobOptions, globIterate } from 'glob';
+import { HttpProxyAgent } from 'http-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 import { ScriptTarget } from 'typescript';
 import { CommandOptions, defaultConfigFile } from './commandOptions';
 import { PartialConfig } from './core/config';
 
 export function readStream(
     stream: NodeJS.ReadableStream,
-    encoding: BufferEncoding = 'utf8'
+    encoding: BufferEncoding = 'utf8',
 ): Promise<string> {
     stream.setEncoding(encoding);
     return new Promise((resolve, reject) => {
@@ -25,7 +26,7 @@ export async function readUrl(url: string): Promise<string> {
     const data = await res.text();
     if (!res.ok) {
         throw new Error(
-            `Error on fetch from url(${url}): ${res.status}, ${data}`
+            `Error on fetch from url(${url}): ${res.status}, ${data}`,
         );
     }
     return data;
@@ -40,42 +41,37 @@ function noProxy(url: URL): boolean {
     }
     return false;
 }
-export function buildProxyOptions(url: string): RequestInit | undefined {
+export function buildProxyOptions<Uri extends string>(
+    url: Uri,
+): RequestInit | undefined {
     const parsedUrl = new URL(url);
-    let proxyUrl;
     if (!noProxy(parsedUrl)) {
         if (parsedUrl.protocol === 'http:' && process.env.HTTP_PROXY) {
-            proxyUrl = new URL(process.env.HTTP_PROXY);
+            return {
+                agent: new HttpProxyAgent(process.env.HTTP_PROXY),
+            } as RequestInit;
         } else if (parsedUrl.protocol === 'https:' && process.env.HTTPS_PROXY) {
-            proxyUrl = new URL(process.env.HTTPS_PROXY);
+            return {
+                agent: new HttpsProxyAgent(process.env.HTTPS_PROXY),
+            } as RequestInit;
         }
     }
-    if (proxyUrl) {
-        const agentOptions: proxy.HttpsProxyAgentOptions = {};
-        agentOptions.protocol = proxyUrl.protocol;
-        agentOptions.host = proxyUrl.hostname;
-        agentOptions.port = proxyUrl.port;
-        if (proxyUrl.username) {
-            agentOptions.auth = proxyUrl.username + ':' + proxyUrl.password;
-        }
-        return { agent: proxy(agentOptions) } as RequestInit;
-    }
     return undefined;
 }
 
-export function globFiles(
+export async function globFiles(
     pattern: string,
-    options?: glob.IOptions
+    options?: GlobOptions,
 ): Promise<string[]> {
-    return new Promise((resolve, reject) => {
-        glob(pattern, options ?? {}, (err, matches) => {
-            if (err) {
-                reject(err);
-            } else {
-                resolve(matches);
-            }
-        });
-    });
+    const result: string[] = [];
+    for await (const r of globIterate(pattern, options ?? {})) {
+        if (typeof r === 'string') {
+            result.push(r);
+        } else {
+            result.push(r.fullpath());
+        }
+    }
+    return result;
 }
 
 export function readConfig(options: CommandOptions): PartialConfig {
@@ -87,7 +83,7 @@ export function readConfig(options: CommandOptions): PartialConfig {
     } catch (err) {
         if (options.configFile != null) {
             console.error(
-                'Error to load config file from ' + options.configFile
+                'Error to load config file from ' + options.configFile,
             );
         }
     }
@@ -113,6 +109,7 @@ export function readConfig(options: CommandOptions): PartialConfig {
         pc.input.stdin = options.stdin;
     } else {
         pc.input.stdin =
+            // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
             pc.input.stdin ||
             (pc.input.files.length === 0 && pc.input.urls.length === 0);
     }
@@ -150,6 +147,10 @@ function convertToScriptTarget(target: string): ScriptTarget {
             return ScriptTarget.ES2019;
         case 'es2020':
             return ScriptTarget.ES2020;
+        case 'es2021':
+            return ScriptTarget.ES2021;
+        case 'es2022':
+            return ScriptTarget.ES2022;
         case 'esnext':
             return ScriptTarget.ESNext;
         default: