ts-json-schema-generator - npm Package Compare versions

Comparing version 1.5.1 to 1.5.2--canary.1910.50ff2b2.0

dist/factory/formatter.js

@@ -13,2 +13,3 @@ "use strict";
 const EnumTypeFormatter_1 = require("../src/TypeFormatter/EnumTypeFormatter");
+const FunctionTypeFormatter_1 = require("../src/TypeFormatter/FunctionTypeFormatter");
 const HiddenTypeFormatter_1 = require("../src/TypeFormatter/HiddenTypeFormatter");
@@ -61,2 +62,3 @@ const IntersectionTypeFormatter_1 = require("../src/TypeFormatter/IntersectionTypeFormatter");
         .addTypeFormatter(new LiteralUnionTypeFormatter_1.LiteralUnionTypeFormatter())
+        .addTypeFormatter(new FunctionTypeFormatter_1.FunctionTypeFormatter())
         .addTypeFormatter(new OptionalTypeFormatter_1.OptionalTypeFormatter(circularReferenceTypeFormatter))
@@ -63,0 +65,0 @@ .addTypeFormatter(new RestTypeFormatter_1.RestTypeFormatter(circularReferenceTypeFormatter))

dist/package.json

 {
     "name": "ts-json-schema-generator",
-    "version": "1.5.1",
+    "version": "1.5.2--canary.1910.50ff2b2.0",
     "description": "Generate JSON schema from your Typescript sources",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

dist/src/NodeParser/TypeofNodeParser.js

@@ -12,3 +12,4 @@ "use strict";
 const LiteralType_1 = require("../Type/LiteralType");
-const UnknownType_1 = require("../Type/UnknownType");
+const NeverType_1 = require("../Type/NeverType");
+const FunctionType_1 = require("../Type/FunctionType");
 class TypeofNodeParser {
@@ -29,3 +30,9 @@ constructor(typeChecker, childNodeParser) {
         const valueDec = symbol.valueDeclaration;
-        if (typescript_1.default.isEnumDeclaration(valueDec)) {
+        if (!valueDec) {
+            if (symbol.name === "globalThis") {
+                return new NeverType_1.NeverType();
+            }
+            throw new LogicError_1.LogicError(`No value declaration found for symbol "${symbol.name}"`);
+        }
+        else if (typescript_1.default.isEnumDeclaration(valueDec)) {
             return this.createObjectFromEnum(valueDec, context, reference);
@@ -51,3 +58,3 @@ }
         else if (valueDec.kind === typescript_1.default.SyntaxKind.FunctionDeclaration) {
-            return new UnknownType_1.UnknownType(`(${valueDec.parameters.map((p) => p.getFullText()).join(",")}) -> ${(_a = valueDec.type) === null || _a === void 0 ? void 0 : _a.getFullText()}`);
+            return new FunctionType_1.FunctionType(`(${valueDec.parameters.map((p) => p.getFullText()).join(",")}) ->${(_a = valueDec.type) === null || _a === void 0 ? void 0 : _a.getFullText()}`);
         }
@@ -54,0 +61,0 @@ throw new LogicError_1.LogicError(`Invalid type query "${valueDec.getFullText()}" (ts.SyntaxKind = ${valueDec.kind})`);

dist/src/Type/FunctionType.d.ts

 import { BaseType } from "./BaseType";
 export declare class FunctionType extends BaseType {
+    private comment?;
+    constructor(comment?: string | undefined);
     getId(): string;
+    getComment(): string | undefined;
 }

dist/src/Type/FunctionType.js

@@ -6,7 +6,14 @@ "use strict";
 class FunctionType extends BaseType_1.BaseType {
+    constructor(comment) {
+        super();
+        this.comment = comment;
+    }
     getId() {
         return "function";
     }
+    getComment() {
+        return this.comment;
+    }
 }
 exports.FunctionType = FunctionType;
 //# sourceMappingURL=FunctionType.js.map

dist/src/Type/UnknownType.d.ts

 import { BaseType } from "./BaseType";
 export declare class UnknownType extends BaseType {
-    private comment?;
-    constructor(comment?: string | undefined);
+    constructor();
     getId(): string;
-    getComment(): string | undefined;
 }

dist/src/Type/UnknownType.js

@@ -6,5 +6,4 @@ "use strict";
 class UnknownType extends BaseType_1.BaseType {
-    constructor(comment) {
+    constructor() {
         super();
-        this.comment = comment;
     }
@@ -14,7 +13,4 @@ getId() {
     }
-    getComment() {
-        return this.comment;
-    }
 }
 exports.UnknownType = UnknownType;
 //# sourceMappingURL=UnknownType.js.map

dist/src/TypeFormatter/UnknownTypeFormatter.js

@@ -10,5 +10,3 @@ "use strict";
     getDefinition(type) {
-        return {
-            $comment: type.getComment(),
-        };
+        return {};
     }
@@ -15,0 +13,0 @@ getChildren(type) {

factory/formatter.ts

@@ -13,2 +13,3 @@ import { ChainTypeFormatter } from "../src/ChainTypeFormatter";
 import { EnumTypeFormatter } from "../src/TypeFormatter/EnumTypeFormatter";
+import { FunctionTypeFormatter } from "../src/TypeFormatter/FunctionTypeFormatter";
 import { HiddenTypeFormatter } from "../src/TypeFormatter/HiddenTypeFormatter";
@@ -74,2 +75,4 @@ import { IntersectionTypeFormatter } from "../src/TypeFormatter/IntersectionTypeFormatter";
 
+        .addTypeFormatter(new FunctionTypeFormatter())
+
         .addTypeFormatter(new OptionalTypeFormatter(circularReferenceTypeFormatter))
@@ -76,0 +79,0 @@ .addTypeFormatter(new RestTypeFormatter(circularReferenceTypeFormatter))

package.json

 {
   "name": "ts-json-schema-generator",
-  "version": "1.5.1",
+  "version": "1.5.2--canary.1910.50ff2b2.0",
   "description": "Generate JSON schema from your Typescript sources",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/NodeParser/TypeofNodeParser.ts

@@ -11,2 +11,4 @@ import ts from "typescript";
 import { UnknownType } from "../Type/UnknownType";
+import { NeverType } from "../Type/NeverType";
+import { FunctionType } from "../Type/FunctionType";
 
@@ -29,4 +31,10 @@ export class TypeofNodeParser implements SubNodeParser {
 
-        const valueDec = symbol.valueDeclaration!;
-        if (ts.isEnumDeclaration(valueDec)) {
+        const valueDec = symbol.valueDeclaration;
+        if (!valueDec) {
+            if (symbol.name === "globalThis") {
+                // avoids crashes on globalThis but we really shoulodn't try to make a schema for globalThis
+                return new NeverType();
+            }
+            throw new LogicError(`No value declaration found for symbol "${symbol.name}"`);
+        } else if (ts.isEnumDeclaration(valueDec)) {
             return this.createObjectFromEnum(valueDec, context, reference);
@@ -50,5 +58,4 @@ } else if (
             // Silently ignoring Function as JSON Schema does not define them
-            // see https://github.com/vega/ts-json-schema-generator/issues/98
-            return new UnknownType(
-                `(${(<ts.FunctionDeclaration>valueDec).parameters.map((p) => p.getFullText()).join(",")}) -> ${(<
+            return new FunctionType(
+                `(${(<ts.FunctionDeclaration>valueDec).parameters.map((p) => p.getFullText()).join(",")}) ->${(<
                     ts.FunctionDeclaration
@@ -55,0 +62,0 @@ >valueDec).type?.getFullText()}`

src/Type/FunctionType.ts

 import { BaseType } from "./BaseType";
 
 export class FunctionType extends BaseType {
+    constructor(private comment?: string) {
+        super();
+    }
+
     public getId(): string {
         return "function";
     }
+
+    public getComment(): string | undefined {
+        return this.comment;
+    }
 }

src/Type/UnknownType.ts

 import { BaseType } from "./BaseType";
 
 export class UnknownType extends BaseType {
-    constructor(private comment?: string) {
+    constructor() {
         super();
@@ -10,6 +10,2 @@ }
     }
-
-    public getComment(): string | undefined {
-        return this.comment;
-    }
 }

src/TypeFormatter/UnknownTypeFormatter.ts

@@ -11,5 +11,3 @@ import { Definition } from "../Schema/Definition";
     public getDefinition(type: UnknownType): Definition {
-        return {
-            $comment: type.getComment(),
-        };
+        return {};
     }
@@ -16,0 +14,0 @@ public getChildren(type: UnknownType): BaseType[] {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

913390

increased by0.39%

Number of package files

730

increased by0.55%

Lines of code

13591

increased by0.48%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes