dtsgenerator 3.12.1 → 3.14.0

package/.eslintrc.json

@@ -1,50 +1,16 @@
 {
+  "root": true,
   "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:import/typescript",
-    "prettier"
+    "@dtsgenerator"
   ],
-  "plugins": [
-    "sort-imports-es6-autofix"
-  ],
-  "env": {
-    "node": true,
-    "es2021": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "./tsconfig.json"
-  },
-  "settings": {
-    "import/resolver": {
-      "typescript": {
-        "alwaysTryTypes": true
-      }
-    }
-  },
   "rules": {
-    "@typescript-eslint/no-unused-vars": ["error", {"argsIgnorePattern": "^_"}],
-    "@typescript-eslint/no-use-before-define": 0,
-    "@typescript-eslint/no-explicit-any": 0,
-    "@typescript-eslint/prefer-optional-chain": 2,
-    "@typescript-eslint/prefer-nullish-coalescing": 2,
-    "@typescript-eslint/no-floating-promises": ["error", {"ignoreIIFE": true, "ignoreVoid": true}],
-    "import/order": ["error", { "alphabetize": { "order": "asc" } }],
-    "import/no-named-as-default": 0,
-    "import/no-named-as-default-member": 0
+    "@typescript-eslint/no-explicit-any": 0
   },
   "overrides": [
     {
       "files": [
         "**/*_test.ts"
       ],
-      "env": {
-        "mocha": true
-      },
       "rules": {
         "@typescript-eslint/ban-ts-comment": 0,
         "@typescript-eslint/no-empty-interface": 0,

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/.nycrc

@@ -1,26 +1,13 @@
 {
-  "cache": false,
-  "check-coverage": false,
-  "extension": [
-    ".ts"
-  ],
-  "include": [
-    "**/*.ts"
-  ],
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "all": true,
+  "check-coverage": true,
   "exclude": [
     "**/*.js",
     "coverage/**",
     "node_modules/**",
     "**/*.d.ts",
     "**/*_test.ts"
-  ],
-  "sourceMap": true,
-  "reporter": [
-    "html",
-    "text",
-    "text-summary"
-  ],
-  "all": true,
-  "instrument": true
+  ]
 }
 

package/.prettierignore

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

package/README.md

@@ -4,10 +4,10 @@ TypeScript d.ts file generator from JSON Schema file or OpenAPI(Swagger) spec fi
 
 [![nodejs version](https://img.shields.io/node/v/dtsgenerator.svg)](#)
 [![npm version](https://badge.fury.io/js/dtsgenerator.svg)](https://www.npmjs.com/package/dtsgenerator)
-[![build status](https://travis-ci.org/horiuchi/dtsgenerator.svg?branch=master)](https://travis-ci.org/horiuchi/dtsgenerator)
+[![Build Status](https://github.com/horiuchi/dtsgenerator/actions/workflows/workflow-ci.yaml/badge.svg)](https://github.com/horiuchi/dtsgenerator/actions/workflows/workflow-ci.yaml)
 [![Coverage Status](https://coveralls.io/repos/github/horiuchi/dtsgenerator/badge.svg?branch=master)](https://coveralls.io/github/horiuchi/dtsgenerator?branch=master)
 [![npm download count](https://img.shields.io/npm/dt/dtsgenerator.svg)](https://www.npmjs.com/package/dtsgenerator)
-[![dtsgenerator Dev Token](https://badge.devtoken.rocks/dtsgenerator)](https://devtoken.rocks/package/dtsgenerator)
+[![Stake to support us](https://badge.devprotocol.xyz/0x68c824db5A1634940BB838468Ff2aee2bDa5794B/descriptive)](https://stakes.social/0x68c824db5A1634940BB838468Ff2aee2bDa5794B)
 [![MIT license](https://img.shields.io/npm/l/dtsgenerator.svg)](#)
 
 ## Table of Contents
@@ -55,6 +55,8 @@ Examples:
 
 ```
 
+For the configuration file, please refer to the file in the [config_sample](https://github.com/horiuchi/dtsgenerator/tree/master/config_sample/) directory.
+
 ### NodeJS API
 ```js
 const { default: dtsgenerator, parseSchema } = require('dtsgenerator');
@@ -141,6 +143,26 @@ Output debug message by [debug](https://www.npmjs.com/package/debug) library.
 
 ## ChangeLog
 
+### [v3.14.0](https://github.com/horiuchi/dtsgenerator/releases/tag/v3.13.2) (2022-01-27)
+
+- features:
+  - Support the nested `allOf` and `oneOf` schema for #513. Thank you for your report @Cry0nicS :+1:
+
+### [v3.13.2](https://github.com/horiuchi/dtsgenerator/releases/tag/v3.13.2) (2021-10-08)
+
+- features:
+  - Fix the type generation malformed objects with number-like keys for #523. Thank you for your report @DamianOsipiuk :+1:
+
+### [v3.13.1](https://github.com/horiuchi/dtsgenerator/releases/tag/v3.13.1) (2021-09-29)
+
+- features:
+  - Change the plug-in interface, the PluginContext::inputSchemas to IterableIterator for #521. Thank you @djrollins :+1:
+
+### [v3.13.0](https://github.com/horiuchi/dtsgenerator/releases/tag/v3.13.0) (2021-08-31)
+
+- features:
+  - Support new `$schema` types for #507.
+
 ### [v3.12.1](https://github.com/horiuchi/dtsgenerator/releases/tag/v3.12.1) (2021-05-19)
 
 - fixed:

package/config_sample/dtsgen.json

@@ -0,0 +1,10 @@
+{
+  "input": {
+    "files": [],
+    "urls": [],
+    "stdin": true
+  },
+  "target": "esnext",
+  "outputAST": false,
+  "plugins": {}
+}

package/config_sample/plugins.json

@@ -0,0 +1,25 @@
+{
+  "input": {
+    "files": ["./schema.json", "./schema/additional.yaml"],
+    "urls": ["http://www.example.com/schema.json"],
+    "stdin": false
+  },
+  "target": "es2020",
+  "outputAST": false,
+  "outputFile": "./types.d.ts",
+  "plugins": {
+    "@dtsgenerator/single-quote": true,
+    "@dtsgenerator/replace-namespace": {
+      "map": [
+        {
+          "from": ["Components", "Schemas"],
+          "to": ["Test", "PetStore"]
+        },
+        {
+          "from": ["Paths"],
+          "to": ["Test", "PetStore"]
+        }
+      ]
+    }
+  }
+}

package/dist/cli.js

@@ -1,97 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const fs = tslib_1.__importStar(require("fs"));
+const fs = (0, tslib_1.__importStar)(require("fs"));
 const path_1 = require("path");
-const typescript_1 = require("typescript");
-const commandOptions_1 = tslib_1.__importStar(require("./commandOptions"));
-const core_1 = tslib_1.__importStar(require("./core"));
-const config_1 = tslib_1.__importStar(require("./core/config"));
-function readConfig(options) {
-    var _a;
-    let pc = {};
-    const configFile = (_a = options.configFile) !== null && _a !== void 0 ? _a : commandOptions_1.defaultConfigFile;
-    try {
-        pc = loadJSON(configFile);
-        pc.configFile = configFile;
-    }
-    catch (err) {
-        if (options.configFile != null) {
-            console.error('Error to load config file from ' + options.configFile);
-        }
-    }
-    if (pc.input == null) {
-        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 = [];
-    }
-    if (options.urls.length > 0) {
-        pc.input.urls = options.urls;
-    }
-    else if (pc.input.urls == null) {
-        pc.input.urls = [];
-    }
-    pc.input.stdin = options.isReadFromStdin();
-    if (options.out != null) {
-        pc.outputFile = options.out;
-    }
-    if (options.target != null) {
-        pc.target = convertToScriptTarget(options.target);
-    }
-    pc.outputAST = !!options.outputAST;
-    return pc;
-}
-function loadJSON(file) {
-    const content = fs.readFileSync(file, 'utf-8');
-    return JSON.parse(content);
-}
-function convertToScriptTarget(target) {
-    switch (target.trim().toLowerCase()) {
-        case 'es3':
-            return typescript_1.ScriptTarget.ES3;
-        case 'es5':
-            return typescript_1.ScriptTarget.ES5;
-        case 'es2015':
-            return typescript_1.ScriptTarget.ES2015;
-        case 'es2016':
-            return typescript_1.ScriptTarget.ES2016;
-        case 'es2017':
-            return typescript_1.ScriptTarget.ES2017;
-        case 'es2018':
-            return typescript_1.ScriptTarget.ES2018;
-        case 'es2019':
-            return typescript_1.ScriptTarget.ES2019;
-        case 'es2020':
-            return typescript_1.ScriptTarget.ES2020;
-        case 'esnext':
-            return typescript_1.ScriptTarget.ESNext;
-        default:
-            return typescript_1.ScriptTarget.Latest;
-    }
-}
+const commandOptions_1 = (0, tslib_1.__importStar)(require("./commandOptions"));
+const core_1 = (0, tslib_1.__importStar)(require("./core"));
+const config_1 = (0, tslib_1.__importStar)(require("./core/config"));
+const utils_1 = require("./utils");
 async function loadContents() {
     let contents = [];
     const ps = [];
     if (config_1.default.input.stdin) {
-        ps.push(core_1.readSchemaFromStdin().then((s) => {
+        ps.push((0, core_1.readSchemaFromStdin)().then((s) => {
             contents.push(s);
         }));
     }
     for (const pattern of config_1.default.input.files) {
-        ps.push(core_1.readSchemasFromFile(pattern).then((ss) => {
+        ps.push((0, core_1.readSchemasFromFile)(pattern).then((ss) => {
             contents = contents.concat(ss);
         }));
     }
     for (const url of config_1.default.input.urls) {
-        ps.push(core_1.readSchemaFromUrl(url).then((s) => {
+        ps.push((0, core_1.readSchemaFromUrl)(url).then((s) => {
             contents.push(s);
         }));
     }
@@ -99,20 +29,20 @@ async function loadContents() {
     return contents;
 }
 async function exec() {
-    const command = commandOptions_1.initialize(process.argv);
-    const pc = readConfig(commandOptions_1.default);
-    config_1.setConfig(pc);
+    const command = (0, commandOptions_1.initialize)(process.argv);
+    const pc = (0, utils_1.readConfig)(commandOptions_1.default);
+    (0, config_1.setConfig)(pc);
     if (commandOptions_1.default.info) {
         const version = command.opts().version;
-        await config_1.showConfig(version, config_1.default);
+        await (0, config_1.showConfig)(version, config_1.default);
         return;
     }
     const contents = await loadContents();
-    const result = await core_1.default({
+    const result = await (0, core_1.default)({
         contents,
     });
     if (commandOptions_1.default.out) {
-        fs.mkdirSync(path_1.dirname(commandOptions_1.default.out), { recursive: true });
+        fs.mkdirSync((0, path_1.dirname)(commandOptions_1.default.out), { recursive: true });
         fs.writeFileSync(commandOptions_1.default.out, result, { encoding: 'utf-8' });
     }
     else {

package/dist/commandOptions.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clear = exports.initialize = exports.CommandOptions = exports.defaultConfigFile = void 0;
 const tslib_1 = require("tslib");
-const commander = tslib_1.__importStar(require("commander"));
+const commander = (0, tslib_1.__importStar)(require("commander"));
 exports.defaultConfigFile = 'dtsgen.json';
 class CommandOptions {
     constructor() {

package/dist/core/astBuilder.d.ts

@@ -21,6 +21,7 @@ export declare function buildIndexSignatureNode(name: string, indexType: ts.Type
 export declare function buildTypeLiteralNode(elements: ts.TypeElement[]): ts.TypeNode;
 export declare function buildFreeFormObjectTypeLiteralNode(): ts.TypeNode;
 export declare function buildUnionTypeNode<T>(types: T[], builder: (t: T, index: number) => ts.TypeNode, terminate: boolean): ts.TypeNode;
+export declare function buildIntersectionTypeNode(types: readonly ts.TypeNode[], terminate: boolean): ts.TypeNode;
 export declare function buildTupleTypeNode(types: ts.TypeNode | ts.TypeNode[], minItems?: number, maxItems?: number, additionalItems?: ts.TypeNode | false): ts.TypeNode;
 export declare function buildTypeReferenceNode(schema: NormalizedSchema, currentSchema: Schema): ts.TypeReferenceNode;
 export declare function addComment<T extends ts.Node>(node: T, schema: NormalizedSchema, terminate: boolean): T;

package/dist/core/astBuilder.js

@@ -1,18 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addOptionalInformation = exports.addComment = exports.buildTypeReferenceNode = exports.buildTupleTypeNode = exports.buildUnionTypeNode = exports.buildFreeFormObjectTypeLiteralNode = exports.buildTypeLiteralNode = exports.buildIndexSignatureNode = exports.buildPropertySignature = exports.buildTypeAliasNode = exports.buildInterfaceNode = exports.buildNamespaceNode = exports.buildBooleanLiteralTypeNode = exports.buildNumericLiteralTypeNode = exports.buildStringLiteralTypeNode = exports.buildNullKeyword = exports.buildSimpleArrayNode = exports.buildStringKeyword = exports.buildVoidKeyword = exports.buildUnknownKeyword = exports.buildNeverKeyword = exports.buildAnyKeyword = exports.buildKeyword = void 0;
+exports.addOptionalInformation = exports.addComment = exports.buildTypeReferenceNode = exports.buildTupleTypeNode = exports.buildIntersectionTypeNode = exports.buildUnionTypeNode = exports.buildFreeFormObjectTypeLiteralNode = exports.buildTypeLiteralNode = exports.buildIndexSignatureNode = exports.buildPropertySignature = exports.buildTypeAliasNode = exports.buildInterfaceNode = exports.buildNamespaceNode = exports.buildBooleanLiteralTypeNode = exports.buildNumericLiteralTypeNode = exports.buildStringLiteralTypeNode = exports.buildNullKeyword = exports.buildSimpleArrayNode = exports.buildStringKeyword = exports.buildVoidKeyword = exports.buildUnknownKeyword = exports.buildNeverKeyword = exports.buildAnyKeyword = exports.buildKeyword = void 0;
 const tslib_1 = require("tslib");
-const ts = tslib_1.__importStar(require("typescript"));
-const config_1 = tslib_1.__importDefault(require("./config"));
+const ts = (0, tslib_1.__importStar)(require("typescript"));
+const config_1 = (0, tslib_1.__importDefault)(require("./config"));
 const validateIdentifier_1 = require("./validateIdentifier");
 function buildTypeNameIdentifier(name) {
-    return ts.factory.createIdentifier(validateIdentifier_1.toValidIdentifier(name, config_1.default.target));
+    return ts.factory.createIdentifier((0, validateIdentifier_1.toValidIdentifier)(name, config_1.default.target));
 }
 function buildPropertyNameIdentifier(name) {
-    if (/^\d/.test(name)) {
-        name = '$' + name;
-    }
-    if (validateIdentifier_1.checkInvalidCharacter(name, config_1.default.target)) {
+    if ((0, validateIdentifier_1.checkInvalidCharacter)(name, config_1.default.target)) {
         return ts.factory.createIdentifier(name);
     }
     else {
@@ -125,6 +122,14 @@ function buildUnionTypeNode(types, builder, terminate) {
     return ts.factory.createParenthesizedType(node);
 }
 exports.buildUnionTypeNode = buildUnionTypeNode;
+function buildIntersectionTypeNode(types, terminate) {
+    const node = ts.factory.createIntersectionTypeNode(types);
+    if (terminate) {
+        return node;
+    }
+    return ts.factory.createParenthesizedType(node);
+}
+exports.buildIntersectionTypeNode = buildIntersectionTypeNode;
 function buildTupleTypeNode(types, minItems, maxItems, additionalItems) {
     function typesIsArray(types) {
         return Array.isArray(types);

package/dist/core/config.js

@@ -4,13 +4,15 @@ exports.showConfig = exports.clearToDefault = exports.setConfig = void 0;
 const typescript_1 = require("typescript");
 const type_1 = require("./type");
 const defaultConfig = {
+    configFile: undefined,
     input: {
         files: [],
         urls: [],
         stdin: false,
     },
-    outputAST: false,
+    outputFile: undefined,
     target: typescript_1.ScriptTarget.Latest,
+    outputAST: false,
     plugins: {},
 };
 let config = Object.assign({}, defaultConfig);
@@ -52,7 +54,7 @@ async function showConfig(version, c) {
     console.log();
     const plugins = [];
     for (const [name, option] of Object.entries(c.plugins)) {
-        const p = await type_1.loadPlugin(name, option);
+        const p = await (0, type_1.loadPlugin)(name, option);
         if (p != null) {
             plugins.push(p);
         }

package/dist/core/dtsGenerator.d.ts

@@ -5,12 +5,12 @@ export default class DtsGenerator {
     private contents;
     constructor(contents: Schema[]);
     generate(): Promise<string>;
-    private buildSchemaMergedMap;
     private getPlugins;
     private getPreProcess;
     private getPostProcess;
     private walk;
     private walkSchema;
+    private parseSchema;
     private normalizeContent;
     private normalizeSchemaContent;
     private generateDeclareType;
@@ -18,8 +18,10 @@ export default class DtsGenerator {
     private generateTypeCollection;
     private generateProperties;
     private generateTypeProperty;
+    private generateLiteralTypeProperty;
+    private checkExistOtherType;
     private generateLiteralTypeNode;
-    private generateArrayedType;
+    private generateUnionType;
     private generateArrayTypeProperty;
     private generateType;
     private generateTypeName;