dtsgenerator 3.17.0 → 3.19.0

package/README.md

@@ -143,6 +143,11 @@ Output debug message by [debug](https://www.npmjs.com/package/debug) library.
 
 ## ChangeLog
 
+### [v3.18.0](https://github.com/horiuchi/dtsgenerator/releases/tag/v3.18.0) (2023-03-02)
+
+- features:
+  - Support 'application/json' with parameter media type for #551. Thank you @denizkenan :+1:
+
 ### [v3.17.0](https://github.com/horiuchi/dtsgenerator/releases/tag/v3.17.0) (2023-02-21)
 
 - features:

package/dist/core/dtsGenerator.js

@@ -90,7 +90,7 @@ class DtsGenerator {
             const factory = await p({ inputSchemas, option: pc.option });
             if (factory != null) {
                 result.push(factory);
-                debug('  pre process plugin:', pc.plugin.meta.name, pc.plugin.meta.description);
+                debug('  post process plugin:', pc.plugin.meta.name, pc.plugin.meta.description);
             }
         }
         return result;
@@ -140,6 +140,7 @@ class DtsGenerator {
         });
     }
     normalizeSchemaContent(content) {
+        var _a;
         if (typeof content === 'boolean') {
             content = content ? {} : { not: {} };
         }
@@ -163,7 +164,7 @@ class DtsGenerator {
                 content = Object.assign(content, work);
             }
             if (content.type === undefined &&
-                (content.properties || content.additionalProperties)) {
+                ((_a = content.properties) !== null && _a !== void 0 ? _a : content.additionalProperties)) {
                 content.type = 'object';
             }
             if (content.nullable) {
@@ -379,9 +380,7 @@ class DtsGenerator {
             const additionalItemsNode = getAdditionalItemNode();
             return additionalItemsNode === false
                 ? ast.buildTupleTypeNode([], 0, 0, additionalItemsNode)
-                : ast.buildSimpleArrayNode(additionalItemsNode === undefined
-                    ? ast.buildAnyKeyword()
-                    : additionalItemsNode);
+                : ast.buildSimpleArrayNode(additionalItemsNode !== null && additionalItemsNode !== void 0 ? additionalItemsNode : ast.buildAnyKeyword());
         }
         else if (minItems != null &&
             maxItems != null &&

package/dist/core/jsonSchema.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const JsonPointer = tslib_1.__importStar(require("../jsonPointer"));
 const schemaId_1 = tslib_1.__importDefault(require("./schemaId"));
 const type_1 = require("./type");
+const utils_1 = require("./utils");
 function getSubSchema(rootSchema, pointer, id) {
     const content = JsonPointer.get(rootSchema.content, JsonPointer.parse(pointer));
     if (id == null) {
@@ -258,7 +259,7 @@ function searchAllSubSchema(schema, onFoundSchema, onFoundReference) {
                 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 ((0, utils_1.checkValidMIMEType)(mime)) {
                     const mt = types[mime];
                     if (mt != null) {
                         setSubId(mt.schema, keys);

package/dist/core/openApiV3.d.ts

@@ -41,7 +41,7 @@ export declare namespace OpenApisV3 {
                 url?: string;
                 email?: string;
             }
-            type DefaultType = null | any[] | unknown | number | boolean | string;
+            type DefaultType = null | any[] | number | boolean | string;
             interface Discriminator {
                 propertyName: string;
                 mapping?: Strings;
@@ -242,7 +242,7 @@ export declare namespace OpenApisV3 {
             interface ServerVariables {
                 [name: string]: ServerVariable;
             }
-            type SpecificationExtension = null | number | boolean | string | unknown | any[];
+            type SpecificationExtension = null | number | boolean | string | any[];
             interface Strings {
                 [name: string]: string;
             }

package/dist/core/schemaId.js

@@ -71,5 +71,5 @@ class SchemaId {
         return ids.map(validateIdentifier_1.toTypeName);
     }
 }
-exports.default = SchemaId;
 SchemaId.empty = new SchemaId('');
+exports.default = SchemaId;

package/dist/core/type.js

@@ -1,5 +1,4 @@
 "use strict";
-var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadPlugin = exports.parseFileContent = exports.readSchemaFromUrl = exports.readSchemasFromFile = exports.readSchemaFromStdin = exports.parseSchema = exports.isJsonSchemaDraft04 = void 0;
 const tslib_1 = require("tslib");
@@ -82,7 +81,7 @@ async function loadPlugin(name, option) {
     if (!option) {
         return undefined;
     }
-    const mod = (await (_a = name, Promise.resolve().then(() => tslib_1.__importStar(require(_a)))));
+    const mod = (await Promise.resolve(`${name}`).then(s => tslib_1.__importStar(require(s))));
     if (!mod.default) {
         console.warn(`The plugin (${name}) is invalid module. That is not default export format.`);
         return undefined;

package/dist/core/utils.d.ts

@@ -4,4 +4,5 @@ import { JsonSchemaObject } from './type';
 import SimpleTypes = JsonSchemaDraft04.Schema.Definitions.SimpleTypes;
 export declare function toTSType(type: string, debugSource?: JsonSchemaObject): ts.KeywordTypeSyntaxKind | ts.SyntaxKind.NullKeyword | undefined;
 export declare function reduceTypes(types: SimpleTypes[]): SimpleTypes[];
+export declare function checkValidMIMEType(mime: string): boolean;
 export declare function mergeSchema(a: any, b: any): boolean;

package/dist/core/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeSchema = exports.reduceTypes = exports.toTSType = void 0;
+exports.mergeSchema = exports.checkValidMIMEType = exports.reduceTypes = exports.toTSType = void 0;
 const tslib_1 = require("tslib");
 const debug_1 = tslib_1.__importDefault(require("debug"));
 const ts = tslib_1.__importStar(require("typescript"));
@@ -42,6 +42,27 @@ function reduceTypes(types) {
     return Array.from(set.values());
 }
 exports.reduceTypes = reduceTypes;
+function checkValidMIMEType(mime) {
+    var _a;
+    const type = (_a = mime.toLowerCase().split(';')[0]) === null || _a === void 0 ? void 0 : _a.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);
+}
+exports.checkValidMIMEType = checkValidMIMEType;
 function mergeSchema(a, b) {
     if ('$ref' in a || '$ref' in b) {
         a.$ref = b.$ref || a.$ref;

package/dist/utils.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import glob from 'glob';
+import { GlobOptions } from 'glob';
 import { CommandOptions } from './commandOptions';
 import { PartialConfig } from './core/config';
 export declare function readStream(stream: NodeJS.ReadableStream, encoding?: BufferEncoding): Promise<string>;
 export declare function readUrl(url: string): Promise<string>;
-export declare function buildProxyOptions(url: string): RequestInit | undefined;
-export declare function globFiles(pattern: string, options?: glob.IOptions): Promise<string[]>;
+export declare function buildProxyOptions<Uri extends string>(url: Uri): RequestInit | undefined;
+export declare function globFiles(pattern: string, options?: GlobOptions): Promise<string[]>;
 export declare function readConfig(options: CommandOptions): PartialConfig;

package/dist/utils.js

@@ -4,8 +4,9 @@ exports.readConfig = exports.globFiles = exports.buildProxyOptions = exports.rea
 const tslib_1 = require("tslib");
 const fs = tslib_1.__importStar(require("fs"));
 const url_1 = require("url");
-const glob_1 = tslib_1.__importDefault(require("glob"));
-const https_proxy_agent_1 = tslib_1.__importDefault(require("https-proxy-agent"));
+const glob_1 = require("glob");
+const http_proxy_agent_1 = require("http-proxy-agent");
+const https_proxy_agent_1 = require("https-proxy-agent");
 const typescript_1 = require("typescript");
 const commandOptions_1 = require("./commandOptions");
 function readStream(stream, encoding = 'utf8') {
@@ -40,39 +41,32 @@ function noProxy(url) {
 }
 function buildProxyOptions(url) {
     const parsedUrl = new url_1.URL(url);
-    let proxyUrl;
     if (!noProxy(parsedUrl)) {
         if (parsedUrl.protocol === 'http:' && process.env.HTTP_PROXY) {
-            proxyUrl = new url_1.URL(process.env.HTTP_PROXY);
+            return {
+                agent: new http_proxy_agent_1.HttpProxyAgent(process.env.HTTP_PROXY),
+            };
         }
         else if (parsedUrl.protocol === 'https:' && process.env.HTTPS_PROXY) {
-            proxyUrl = new url_1.URL(process.env.HTTPS_PROXY);
+            return {
+                agent: new https_proxy_agent_1.HttpsProxyAgent(process.env.HTTPS_PROXY),
+            };
         }
     }
-    if (proxyUrl) {
-        const agentOptions = {};
-        agentOptions.protocol = proxyUrl.protocol;
-        agentOptions.host = proxyUrl.hostname;
-        agentOptions.port = proxyUrl.port;
-        if (proxyUrl.username) {
-            agentOptions.auth = proxyUrl.username + ':' + proxyUrl.password;
-        }
-        return { agent: (0, https_proxy_agent_1.default)(agentOptions) };
-    }
     return undefined;
 }
 exports.buildProxyOptions = buildProxyOptions;
-function globFiles(pattern, options) {
-    return new Promise((resolve, reject) => {
-        (0, glob_1.default)(pattern, options !== null && options !== void 0 ? options : {}, (err, matches) => {
-            if (err) {
-                reject(err);
-            }
-            else {
-                resolve(matches);
-            }
-        });
-    });
+async function globFiles(pattern, options) {
+    const result = [];
+    for await (const r of (0, glob_1.globIterate)(pattern, options !== null && options !== void 0 ? options : {})) {
+        if (typeof r === 'string') {
+            result.push(r);
+        }
+        else {
+            result.push(r.fullpath());
+        }
+    }
+    return result;
 }
 exports.globFiles = globFiles;
 function readConfig(options) {
@@ -150,6 +144,10 @@ function convertToScriptTarget(target) {
             return typescript_1.ScriptTarget.ES2019;
         case 'es2020':
             return typescript_1.ScriptTarget.ES2020;
+        case 'es2021':
+            return typescript_1.ScriptTarget.ES2021;
+        case 'es2022':
+            return typescript_1.ScriptTarget.ES2022;
         case 'esnext':
             return typescript_1.ScriptTarget.ESNext;
         default:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dtsgenerator",
-    "version": "3.17.0",
+    "version": "3.19.0",
     "description": "TypeScript d.ts file generator for JSON Schema file",
     "bin": {
         "dtsgen": "bin/dtsgen"
@@ -41,37 +41,38 @@
         "url": "https://github.com/horiuchi/dtsgenerator/issues"
     },
     "engines": {
-        "node": ">= 14.0"
+        "node": ">= 16.0"
     },
     "dependencies": {
-        "commander": "^10.0.0",
-        "cross-fetch": "^3.1.5",
+        "commander": "^11.0.0",
+        "cross-fetch": "^4.0.0",
         "debug": "^4.3.4",
-        "glob": "^8.1.0",
-        "https-proxy-agent": "^5.0.1",
+        "glob": "^10.3.3",
+        "http-proxy-agent": "^7.0.0",
+        "https-proxy-agent": "^7.0.1",
         "js-yaml": "^4.1.0",
-        "tslib": "^2.5.0",
-        "typescript": "^4.9.5"
+        "tslib": "^2.6.2",
+        "typescript": "^5.1.6"
     },
     "devDependencies": {
-        "@dtsgenerator/do-nothing": "^2.5.3",
-        "@dtsgenerator/eslint-config": "^0.6.4",
-        "@dtsgenerator/replace-namespace": "^1.5.4",
-        "@dtsgenerator/single-quote": "^1.6.3",
+        "@dtsgenerator/do-nothing": "^2.5.4",
+        "@dtsgenerator/eslint-config": "^0.6.5",
+        "@dtsgenerator/replace-namespace": "^1.5.5",
+        "@dtsgenerator/single-quote": "^1.6.5",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
-        "@types/debug": "^4.1.7",
-        "@types/glob": "^8.0.1",
+        "@types/debug": "^4.1.8",
+        "@types/glob": "^8.1.0",
         "@types/js-yaml": "^4.0.5",
         "@types/mocha": "^10.0.1",
-        "@types/node": "^16.18.12",
+        "@types/node": "^16.18.41",
         "cross-env": "^7.0.3",
-        "eslint": "^8.34.0",
+        "eslint": "^8.47.0",
         "husky": "^8.0.3",
-        "lint-staged": "^13.1.2",
+        "lint-staged": "^14.0.1",
         "mocha": "^10.2.0",
         "nyc": "^15.1.0",
-        "prettier": "^2.8.4",
-        "rimraf": "^4.1.2",
+        "prettier": "^3.0.2",
+        "rimraf": "^5.0.1",
         "source-map-support": "^0.5.21",
         "ts-node": "^10.9.1"
     },

package/src/cli.ts

@@ -17,21 +17,21 @@ async function loadContents(): Promise<Schema[]> {
         ps.push(
             readSchemaFromStdin().then((s) => {
                 contents.push(s);
-            })
+            }),
         );
     }
     for (const pattern of config.input.files) {
         ps.push(
             readSchemasFromFile(pattern).then((ss) => {
                 contents = contents.concat(ss);
-            })
+            }),
         );
     }
     for (const url of config.input.urls) {
         ps.push(
             readSchemaFromUrl(url).then((s) => {
                 contents.push(s);
-            })
+            }),
         );
     }
     await Promise.all(ps);

package/src/commandOptions.ts

@@ -53,17 +53,17 @@ function parse(options: CommandOptions, argv: string[]): commander.Command {
             '--url <url>',
             'input json schema from the url.',
             collectUrl,
-            []
+            [],
         )
         .option('--stdin', 'read stdin with other files or urls.')
         .option('-o, --out <file>', 'output filename.')
         .option(
             '-t, --target <version>',
-            "Specify ECMAScript target version: 'ES3', 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT' (default)."
+            "Specify ECMAScript target version: 'ES3', 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT' (default).",
         )
         .option(
             '--info',
-            'for developer mode. output loaded config and plugin details only.'
+            'for developer mode. output loaded config and plugin details only.',
         )
         .option('--output-ast', 'output TypeScript AST instead of d.ts file.')
         .addHelpText(
@@ -76,7 +76,7 @@ Examples:
   $ dtsgen -o swaggerSchema.d.ts --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/schemas/v2.0/schema.json
   $ dtsgen -o petstore.d.ts --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/petstore.yaml
   $ dtsgen -c dtsgen-test.json --info
-`
+`,
         )
         .parse(argv);
 

package/src/core/astBuilder.ts

@@ -17,7 +17,7 @@ function buildPropertyNameIdentifier(name: string): ts.PropertyName {
 }
 
 export function buildKeyword(
-    kind: ts.KeywordTypeSyntaxKind
+    kind: ts.KeywordTypeSyntaxKind,
 ): ts.KeywordTypeNode {
     return ts.factory.createKeywordTypeNode(kind);
 }
@@ -41,7 +41,7 @@ export function buildSimpleArrayNode(element: ts.TypeNode): ts.ArrayTypeNode {
 }
 export function buildNullKeyword(): ts.LiteralTypeNode {
     return ts.factory.createLiteralTypeNode(
-        ts.factory.createToken(ts.SyntaxKind.NullKeyword)
+        ts.factory.createToken(ts.SyntaxKind.NullKeyword),
     );
 }
 export function buildStringLiteralTypeNode(s: string): ts.LiteralTypeNode {
@@ -52,14 +52,14 @@ export function buildNumericLiteralTypeNode(n: string): ts.LiteralTypeNode {
 }
 export function buildBooleanLiteralTypeNode(b: boolean): ts.LiteralTypeNode {
     return ts.factory.createLiteralTypeNode(
-        b ? ts.factory.createTrue() : ts.factory.createFalse()
+        b ? ts.factory.createTrue() : ts.factory.createFalse(),
     );
 }
 
 export function buildNamespaceNode(
     name: string,
     statements: ts.Statement[],
-    root: boolean
+    root: boolean,
 ): ts.ModuleDeclaration {
     const modifiers = root
         ? [ts.factory.createModifier(ts.SyntaxKind.DeclareKeyword)]
@@ -70,14 +70,14 @@ export function buildNamespaceNode(
         ts.factory.createModuleBlock(statements),
         ts.NodeFlags.Namespace |
             ts.NodeFlags.ExportContext |
-            ts.NodeFlags.ContextFlags
+            ts.NodeFlags.ContextFlags,
     );
 }
 
 export function buildInterfaceNode(
     id: SchemaId,
     members: ts.TypeElement[],
-    root: boolean
+    root: boolean,
 ): ts.InterfaceDeclaration {
     const name = getLastTypeName(id);
     const modifiers = root
@@ -88,14 +88,14 @@ export function buildInterfaceNode(
         buildTypeNameIdentifier(name),
         undefined,
         undefined,
-        members
+        members,
     );
 }
 
 export function buildTypeAliasNode(
     id: SchemaId,
     type: ts.TypeNode,
-    root: boolean
+    root: boolean,
 ): ts.TypeAliasDeclaration {
     const name = getLastTypeName(id);
     const modifiers = root
@@ -105,7 +105,7 @@ export function buildTypeAliasNode(
         modifiers,
         buildTypeNameIdentifier(name),
         undefined,
-        type
+        type,
     );
 }
 
@@ -114,7 +114,7 @@ export function buildPropertySignature(
     propertyName: string,
     valueType: ts.TypeNode,
     required: string[] | undefined,
-    isPattern: boolean | undefined
+    isPattern: boolean | undefined,
 ): ts.PropertySignature | ts.IndexSignatureDeclaration {
     const modifiers = undefined;
     const questionToken =
@@ -131,24 +131,24 @@ export function buildPropertySignature(
                     ts.factory.createIdentifier('pattern'),
                     undefined,
                     ts.factory.createTypeReferenceNode('string', []),
-                    undefined
+                    undefined,
                 ),
             ],
-            valueType
+            valueType,
         );
     }
     return ts.factory.createPropertySignature(
         modifiers,
         buildPropertyNameIdentifier(propertyName),
         questionToken,
-        valueType
+        valueType,
     );
 }
 
 export function buildIndexSignatureNode(
     name: string,
     indexType: ts.TypeNode,
-    valueType: ts.TypeNode
+    valueType: ts.TypeNode,
 ): ts.IndexSignatureDeclaration {
     return ts.factory.createIndexSignature(
         undefined,
@@ -159,10 +159,10 @@ export function buildIndexSignatureNode(
                 buildTypeNameIdentifier(name),
                 undefined,
                 indexType,
-                undefined
+                undefined,
             ),
         ],
-        valueType
+        valueType,
     );
 }
 
@@ -179,7 +179,7 @@ export function buildFreeFormObjectTypeLiteralNode(): ts.TypeNode {
 export function buildUnionTypeNode<T>(
     types: T[],
     builder: (t: T, index: number) => ts.TypeNode,
-    terminate: boolean
+    terminate: boolean,
 ): ts.TypeNode {
     const node = ts.factory.createUnionTypeNode(types.map(builder));
     if (terminate) {
@@ -190,7 +190,7 @@ export function buildUnionTypeNode<T>(
 
 export function buildIntersectionTypeNode(
     types: readonly ts.TypeNode[],
-    terminate: boolean
+    terminate: boolean,
 ): ts.TypeNode {
     const node = ts.factory.createIntersectionTypeNode(types);
     if (terminate) {
@@ -203,7 +203,7 @@ export function buildTupleTypeNode(
     types: ts.TypeNode | ts.TypeNode[],
     minItems?: number,
     maxItems?: number,
-    additionalItems?: ts.TypeNode | false
+    additionalItems?: ts.TypeNode | false,
 ): ts.TypeNode {
     function typesIsArray<T>(types: T | T[]): types is T[] {
         return Array.isArray(types);
@@ -247,9 +247,9 @@ export function buildTupleTypeNode(
                         ? additionalItems !== undefined
                             ? (additionalItems as ts.TypeNode)
                             : buildAnyKeyword()
-                        : types
-                )
-            )
+                        : types,
+                ),
+            ),
         );
     }
     return ts.factory.createTupleTypeNode(nodes);
@@ -257,7 +257,7 @@ export function buildTupleTypeNode(
 
 export function buildTypeReferenceNode(
     schema: NormalizedSchema,
-    currentSchema: Schema
+    currentSchema: Schema,
 ): ts.TypeReferenceNode {
     const typeName = getTypename(schema.id, currentSchema);
     let node: ts.EntityName | undefined;
@@ -267,7 +267,7 @@ export function buildTypeReferenceNode(
         } else {
             node = ts.factory.createQualifiedName(
                 node,
-                buildTypeNameIdentifier(name)
+                buildTypeNameIdentifier(name),
             );
         }
     }
@@ -296,7 +296,7 @@ function getTypename(id: SchemaId, baseSchema: Schema): string[] {
 export function addComment<T extends ts.Node>(
     node: T,
     schema: NormalizedSchema,
-    terminate: boolean
+    terminate: boolean,
 ): T {
     const comments = getComment(schema);
     if (comments.length === 0) {
@@ -306,7 +306,7 @@ export function addComment<T extends ts.Node>(
             node,
             ts.SyntaxKind.MultiLineCommentTrivia,
             ` ${comments[0] ?? ''} `,
-            false
+            false,
         );
     } else {
         let result = '*\n';
@@ -318,7 +318,7 @@ export function addComment<T extends ts.Node>(
             node,
             ts.SyntaxKind.MultiLineCommentTrivia,
             result,
-            true
+            true,
         );
     }
 }
@@ -363,7 +363,7 @@ function getComment(schema: NormalizedSchema): string[] {
 export function addOptionalInformation<T extends ts.Node>(
     node: T,
     schema: NormalizedSchema,
-    terminate: boolean
+    terminate: boolean,
 ): T {
     const format = schema.content.format;
     const pattern = schema.content.pattern;

package/src/core/config.ts

@@ -85,7 +85,7 @@ export async function showConfig(version: string, c: Config): Promise<void> {
     console.log('Plugins: count=' + plugins.length.toString());
     for (const p of plugins) {
         console.log(
-            `  ${p.meta.name}@${p.meta.version}: ${p.meta.description ?? ''}`
+            `  ${p.meta.name}@${p.meta.version}: ${p.meta.description ?? ''}`,
         );
     }
     console.log();