ts-json-schema-generator 2.4.1-next.0 → 2.5.0--canary.76e1a68.0

package/src/Utils/castArray.ts

@@ -0,0 +1,7 @@
+export function castArray<T>(input: undefined | T | T[]): undefined | T[] {
+    if (input === undefined) {
+        return undefined;
+    }
+
+    return Array.isArray(input) ? input : [input];
+}

package/src/Utils/derefType.ts

@@ -3,8 +3,10 @@ import { AnnotatedType } from "../Type/AnnotatedType.js";
 import type { BaseType } from "../Type/BaseType.js";
 import { DefinitionType } from "../Type/DefinitionType.js";
 import { HiddenType } from "../Type/HiddenType.js";
+import { LiteralType } from "../Type/LiteralType.js";
 import { NeverType } from "../Type/NeverType.js";
 import { ReferenceType } from "../Type/ReferenceType.js";
+import { UnionType } from "../Type/UnionType.js";
 
 /**
  * Dereference the type as far as possible.
@@ -38,6 +40,23 @@ export function isHiddenType(type: BaseType): boolean {
     return false;
 }
 
+/**
+ * Recursively checks whether the given type is a union composed entirely of literal types.
+ */
+export function isDeepLiteralUnion(type: BaseType): boolean {
+    const resolved = derefType(type);
+
+    if (resolved instanceof LiteralType) {
+        return true;
+    }
+
+    if (resolved instanceof UnionType) {
+        return resolved.getTypes().every((t) => isDeepLiteralUnion(t));
+    }
+
+    return false;
+}
+
 export function derefAliasedType(type: BaseType): BaseType {
     if (type instanceof AliasType) {
         return derefAliasedType(type.getType());

package/src/Utils/getFullDescription.ts

@@ -0,0 +1,39 @@
+import ts from "typescript";
+
+export function getFullDescription(node: ts.Node): string | undefined {
+    const sourceFile = node.getSourceFile();
+    const jsDocNodes = ts.getJSDocCommentsAndTags(node);
+
+    if (!jsDocNodes || jsDocNodes.length === 0) {
+        return undefined;
+    }
+
+    let rawText = "";
+
+    for (const jsDoc of jsDocNodes) {
+        rawText += jsDoc.getFullText(sourceFile) + "\n";
+    }
+
+    rawText = rawText.trim();
+
+    return getTextWithoutStars(rawText).trim();
+}
+
+function getTextWithoutStars(inputText: string) {
+    const innerTextWithStars = inputText.replace(/^\/\*\*[^\S\n]*\n?/, "").replace(/(\r?\n)?[^\S\n]*\*\/$/, "");
+
+    return innerTextWithStars
+        .split(/\n/)
+        .map((line) => {
+            const trimmedLine = line.trimStart();
+
+            if (trimmedLine[0] !== "*") {
+                return line;
+            }
+
+            const textStartPos = trimmedLine[1] === " " ? 2 : 1;
+
+            return trimmedLine.substring(textStartPos);
+        })
+        .join("\n");
+}

package/ts-json-schema-generator.ts

@@ -11,14 +11,14 @@ import pkg from "./package.json";
 
 const args = new Command()
     .option("-p, --path <path>", "Source file path")
-    .option("-t, --type <name>", "Type name")
+    .option("-t, --type <name...>", "Type name(s)")
     .option("-i, --id <name>", "$id for generated schema")
     .option("-f, --tsconfig <path>", "Custom tsconfig.json path")
     .addOption(
         new Option("-e, --expose <expose>", "Type exposing").choices(["all", "none", "export"]).default("export"),
     )
     .addOption(
-        new Option("-j, --jsDoc <extended>", "Read JsDoc annotations")
+        new Option("-j, --jsDoc <extended>", "Read JSDoc annotations")
             .choices(["none", "basic", "extended"])
             .default("extended"),
     )
@@ -27,6 +27,14 @@ const args = new Command()
             jsDoc: "extended",
         }),
     )
+    .addOption(
+        new Option(
+            "--full-description",
+            "Include the full raw JSDoc comment as `fullDescription` in the schema.",
+        ).implies({
+            jsDoc: "extended",
+        }),
+    )
     .addOption(
         new Option(
             "--functions <functions>",
@@ -65,6 +73,7 @@ const config: Config = {
     topRef: args.topRef,
     jsDoc: args.jsDoc,
     markdownDescription: args.markdownDescription,
+    fullDescription: args.fullDescription,
     sortProps: !args.unstable,
     strictTuples: args.strictTuples,
     skipTypeCheck: !args.typeCheck,
@@ -75,7 +84,7 @@ const config: Config = {
 };
 
 try {
-    const schema = createGenerator(config).createSchema(args.type);
+    const schema = createGenerator(config).createSchema(config.type);
 
     const stringify = config.sortProps ? stableStringify : JSON.stringify;
     // need as string since TS can't figure out that the string | undefined case doesn't happen