typia 5.2.1 → 5.2.2-dev.20231012

package/src/SnakeCase.ts

@@ -1,156 +1,156 @@
-/**
- * Snake case type.
- *
- * `SnakeCase` type is a type that all keys of an object are converted to snake case.
- *
- * It also erase every method properties like {@link Resolved} type.
- *
- * @template T Target type to be snake cased
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type SnakeCase<T> = Equal<T, SnakageMain<T>> extends true
-    ? T
-    : SnakageMain<T>;
-
-/* -----------------------------------------------------------
-    OBJECT CONVERSION
------------------------------------------------------------ */
-type Equal<X, Y> = X extends Y ? (Y extends X ? true : false) : false;
-
-type SnakageMain<T> = T extends [never]
-    ? never // special trick for (jsonable | null) type
-    : T extends { valueOf(): boolean | bigint | number | string }
-    ? ValueOf<T>
-    : T extends Function
-    ? never
-    : T extends object
-    ? SnakageObject<T>
-    : T;
-
-type SnakageObject<T extends object> = T extends Array<infer U>
-    ? IsTuple<T> extends true
-        ? SnakageTuple<T>
-        : SnakageMain<U>[]
-    : T extends Set<infer U>
-    ? Set<SnakageMain<U>>
-    : T extends Map<infer K, infer V>
-    ? Map<SnakageMain<K>, SnakageMain<V>>
-    : T extends WeakSet<any> | WeakMap<any, any>
-    ? never
-    : T extends
-          | Date
-          | Uint8Array
-          | Uint8ClampedArray
-          | Uint16Array
-          | Uint32Array
-          | BigUint64Array
-          | Int8Array
-          | Int16Array
-          | Int32Array
-          | BigInt64Array
-          | Float32Array
-          | Float64Array
-          | ArrayBuffer
-          | SharedArrayBuffer
-          | DataView
-    ? T
-    : {
-          [Key in keyof T as SnakageString<Key & string>]: SnakageMain<T[Key]>;
-      };
-
-/* -----------------------------------------------------------
-    SPECIAL CASES
------------------------------------------------------------ */
-type IsTuple<T extends readonly any[] | { length: number }> = [T] extends [
-    never,
-]
-    ? false
-    : T extends readonly any[]
-    ? number extends T["length"]
-        ? false
-        : true
-    : false;
-type SnakageTuple<T extends readonly any[]> = T extends []
-    ? []
-    : T extends [infer F]
-    ? [SnakageMain<F>]
-    : T extends [infer F, ...infer Rest extends readonly any[]]
-    ? [SnakageMain<F>, ...SnakageTuple<Rest>]
-    : T extends [(infer F)?]
-    ? [SnakageMain<F>?]
-    : T extends [(infer F)?, ...infer Rest extends readonly any[]]
-    ? [SnakageMain<F>?, ...SnakageTuple<Rest>]
-    : [];
-
-type ValueOf<Instance> = IsValueOf<Instance, Boolean> extends true
-    ? boolean
-    : IsValueOf<Instance, Number> extends true
-    ? number
-    : IsValueOf<Instance, String> extends true
-    ? string
-    : Instance;
-
-type IsValueOf<Instance, Object extends IValueOf<any>> = Instance extends Object
-    ? Object extends IValueOf<infer Primitive>
-        ? Instance extends Primitive
-            ? false
-            : true // not Primitive, but Object
-        : false // cannot be
-    : false;
-
-interface IValueOf<T> {
-    valueOf(): T;
-}
-
-/* -----------------------------------------------------------
-    STRING CONVERTER
------------------------------------------------------------ */
-type SnakageString<Key extends string> = Key extends `${infer _}`
-    ? SnakageStringRepeatedly<Key, "">
-    : Key;
-type SnakageStringRepeatedly<
-    S extends string,
-    Previous extends string,
-> = S extends `${infer First}${infer Second}${infer Rest}`
-    ? `${Underscore<Previous, First>}${Lowercase<First>}${Underscore<
-          First,
-          Second
-      >}${Lowercase<Second>}${SnakageStringRepeatedly<Rest, Second>}`
-    : S extends `${infer First}`
-    ? `${Underscore<Previous, First>}${Lowercase<First>}`
-    : "";
-type Underscore<First extends string, Second extends string> = First extends
-    | UpperAlphabetic
-    | ""
-    | "_"
-    ? ""
-    : Second extends UpperAlphabetic
-    ? "_"
-    : "";
-type UpperAlphabetic =
-    | "A"
-    | "B"
-    | "C"
-    | "D"
-    | "E"
-    | "F"
-    | "G"
-    | "H"
-    | "I"
-    | "J"
-    | "K"
-    | "L"
-    | "M"
-    | "N"
-    | "O"
-    | "P"
-    | "Q"
-    | "R"
-    | "S"
-    | "T"
-    | "U"
-    | "V"
-    | "W"
-    | "X"
-    | "Y"
-    | "Z";
+/**
+ * Snake case type.
+ *
+ * `SnakeCase` type is a type that all keys of an object are converted to snake case.
+ *
+ * It also erase every method properties like {@link Resolved} type.
+ *
+ * @template T Target type to be snake cased
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type SnakeCase<T> = Equal<T, SnakageMain<T>> extends true
+    ? T
+    : SnakageMain<T>;
+
+/* -----------------------------------------------------------
+    OBJECT CONVERSION
+----------------------------------------------------------- */
+type Equal<X, Y> = X extends Y ? (Y extends X ? true : false) : false;
+
+type SnakageMain<T> = T extends [never]
+    ? never // special trick for (jsonable | null) type
+    : T extends { valueOf(): boolean | bigint | number | string }
+    ? ValueOf<T>
+    : T extends Function
+    ? never
+    : T extends object
+    ? SnakageObject<T>
+    : T;
+
+type SnakageObject<T extends object> = T extends Array<infer U>
+    ? IsTuple<T> extends true
+        ? SnakageTuple<T>
+        : SnakageMain<U>[]
+    : T extends Set<infer U>
+    ? Set<SnakageMain<U>>
+    : T extends Map<infer K, infer V>
+    ? Map<SnakageMain<K>, SnakageMain<V>>
+    : T extends WeakSet<any> | WeakMap<any, any>
+    ? never
+    : T extends
+          | Date
+          | Uint8Array
+          | Uint8ClampedArray
+          | Uint16Array
+          | Uint32Array
+          | BigUint64Array
+          | Int8Array
+          | Int16Array
+          | Int32Array
+          | BigInt64Array
+          | Float32Array
+          | Float64Array
+          | ArrayBuffer
+          | SharedArrayBuffer
+          | DataView
+    ? T
+    : {
+          [Key in keyof T as SnakageString<Key & string>]: SnakageMain<T[Key]>;
+      };
+
+/* -----------------------------------------------------------
+    SPECIAL CASES
+----------------------------------------------------------- */
+type IsTuple<T extends readonly any[] | { length: number }> = [T] extends [
+    never,
+]
+    ? false
+    : T extends readonly any[]
+    ? number extends T["length"]
+        ? false
+        : true
+    : false;
+type SnakageTuple<T extends readonly any[]> = T extends []
+    ? []
+    : T extends [infer F]
+    ? [SnakageMain<F>]
+    : T extends [infer F, ...infer Rest extends readonly any[]]
+    ? [SnakageMain<F>, ...SnakageTuple<Rest>]
+    : T extends [(infer F)?]
+    ? [SnakageMain<F>?]
+    : T extends [(infer F)?, ...infer Rest extends readonly any[]]
+    ? [SnakageMain<F>?, ...SnakageTuple<Rest>]
+    : [];
+
+type ValueOf<Instance> = IsValueOf<Instance, Boolean> extends true
+    ? boolean
+    : IsValueOf<Instance, Number> extends true
+    ? number
+    : IsValueOf<Instance, String> extends true
+    ? string
+    : Instance;
+
+type IsValueOf<Instance, Object extends IValueOf<any>> = Instance extends Object
+    ? Object extends IValueOf<infer Primitive>
+        ? Instance extends Primitive
+            ? false
+            : true // not Primitive, but Object
+        : false // cannot be
+    : false;
+
+interface IValueOf<T> {
+    valueOf(): T;
+}
+
+/* -----------------------------------------------------------
+    STRING CONVERTER
+----------------------------------------------------------- */
+type SnakageString<Key extends string> = Key extends `${infer _}`
+    ? SnakageStringRepeatedly<Key, "">
+    : Key;
+type SnakageStringRepeatedly<
+    S extends string,
+    Previous extends string,
+> = S extends `${infer First}${infer Second}${infer Rest}`
+    ? `${Underscore<Previous, First>}${Lowercase<First>}${Underscore<
+          First,
+          Second
+      >}${Lowercase<Second>}${SnakageStringRepeatedly<Rest, Second>}`
+    : S extends `${infer First}`
+    ? `${Underscore<Previous, First>}${Lowercase<First>}`
+    : "";
+type Underscore<First extends string, Second extends string> = First extends
+    | UpperAlphabetic
+    | ""
+    | "_"
+    ? ""
+    : Second extends UpperAlphabetic
+    ? "_"
+    : "";
+type UpperAlphabetic =
+    | "A"
+    | "B"
+    | "C"
+    | "D"
+    | "E"
+    | "F"
+    | "G"
+    | "H"
+    | "I"
+    | "J"
+    | "K"
+    | "L"
+    | "M"
+    | "N"
+    | "O"
+    | "P"
+    | "Q"
+    | "R"
+    | "S"
+    | "T"
+    | "U"
+    | "V"
+    | "W"
+    | "X"
+    | "Y"
+    | "Z";

package/src/executable/TypiaSetupWizard.ts

@@ -33,8 +33,16 @@ export namespace TypiaSetupWizard {
 
         // SETUP TRANSFORMER
         await pack.save((data) => {
-            // COMPOSE POSTINSTALL COMMAND
+            // COMPOSE PREPARE COMMAND
             data.scripts ??= {};
+            if (
+                typeof data.scripts.prepare === "string" &&
+                data.scripts.prepare.trim().length
+            ) {
+                if (data.scripts.prepare.indexOf("ts-patch install") === -1)
+                    data.scripts.prepare =
+                        "ts-patch install && " + data.scripts.prepare;
+            } else data.scripts.prepare = "ts-patch install";
 
             // FOR OLDER VERSIONS
             if (typeof data.scripts.postinstall === "string") {
@@ -46,16 +54,6 @@ export namespace TypiaSetupWizard {
                 if (data.scripts.postinstall.length === 0)
                     delete data.scripts.postinstall;
             }
-
-            // THE PREPARE SCRIPT
-            if (
-                typeof data.scripts.prepare === "string" &&
-                data.scripts.prepare.trim().length
-            ) {
-                if (data.scripts.prepare.indexOf("ts-patch install") === -1)
-                    data.scripts.prepare =
-                        "ts-patch install && " + data.scripts.prepare;
-            } else data.scripts.prepare = "ts-patch install";
         });
         CommandExecutor.run(`${pack.manager} run prepare`);
 

package/src/factories/MetadataCollection.ts

@@ -117,9 +117,14 @@ export class MetadataCollection {
             name: $id,
             properties: [],
             description:
+                (type.aliasSymbol &&
+                    CommentFactory.description(type.aliasSymbol)) ??
                 (type.symbol && CommentFactory.description(type.symbol)) ??
                 undefined,
-            jsDocTags: type.symbol?.getJsDocTags() ?? [],
+            jsDocTags:
+                type.aliasSymbol?.getJsDocTags() ??
+                type.symbol?.getJsDocTags() ??
+                [],
             validated: false,
             index: this.object_index_++,
             recursive: null!,

package/src/factories/internal/metadata/emplace_metadata_object.ts

@@ -1,150 +1,150 @@
-import ts from "typescript";
-
-import { Metadata } from "../../../schemas/metadata/Metadata";
-import { MetadataObject } from "../../../schemas/metadata/MetadataObject";
-import { MetadataProperty } from "../../../schemas/metadata/MetadataProperty";
-
-import { Writable } from "../../../typings/Writable";
-
-import { ArrayUtil } from "../../../utils/ArrayUtil";
-
-import { CommentFactory } from "../../CommentFactory";
-import { MetadataCollection } from "../../MetadataCollection";
-import { MetadataFactory } from "../../MetadataFactory";
-import { MetadataHelper } from "./MetadataHelper";
-import { explore_metadata } from "./explore_metadata";
-import { iterate_metadata_coalesce } from "./iterate_metadata_coalesce";
-
-export const emplace_metadata_object =
-    (checker: ts.TypeChecker) =>
-    (options: MetadataFactory.IOptions) =>
-    (collection: MetadataCollection) =>
-    (errors: MetadataFactory.IError[]) =>
-    (parent: ts.Type, nullable: boolean): MetadataObject => {
-        // EMPLACE OBJECT
-        const [obj, newbie] = collection.emplace(checker, parent);
-        ArrayUtil.add(obj.nullables, nullable, (elem) => elem === nullable);
-
-        if (newbie === false) return obj;
-
-        // PREPARE ASSETS
-        const isClass: boolean = parent.isClass();
-        const pred: (node: ts.Declaration) => boolean = isClass
-            ? (node) => {
-                  const kind: ts.SyntaxKind | undefined = node
-                      .getChildren()[0]
-                      ?.getChildren()[0]?.kind;
-                  return (
-                      kind !== ts.SyntaxKind.PrivateKeyword &&
-                      kind !== ts.SyntaxKind.ProtectedKeyword &&
-                      (ts.isParameter(node) || isProperty(node))
-                  );
-              }
-            : (node) => isProperty(node);
-
-        const insert =
-            (key: Metadata) =>
-            (value: Metadata) =>
-            (
-                symbol: ts.Symbol | undefined,
-                filter?: (doc: ts.JSDocTagInfo) => boolean,
-            ): MetadataProperty => {
-                // COMMENTS AND TAGS
-                const description: string | null = symbol
-                    ? CommentFactory.description(symbol) ?? null
-                    : null;
-                const jsDocTags: ts.JSDocTagInfo[] = (
-                    symbol?.getJsDocTags() ?? []
-                ).filter(filter ?? (() => true));
-
-                // THE PROPERTY
-                const property = MetadataProperty.create({
-                    key,
-                    value,
-                    description,
-                    jsDocTags,
-                });
-                obj.properties.push(property);
-                return property;
-            };
-
-        //----
-        // REGULAR PROPERTIES
-        //----
-        for (const prop of parent.getApparentProperties()) {
-            // CHECK INTERNAL TAG
-            if (
-                (prop.getJsDocTags(checker) ?? []).find(
-                    (tag) => tag.name === "internal",
-                ) !== undefined
-            )
-                continue;
-
-            // CHECK NODE IS A FORMAL PROPERTY
-            const [node, type] = (() => {
-                const node = prop.getDeclarations()?.[0] as
-                    | ts.PropertyDeclaration
-                    | undefined;
-                const type: ts.Type | undefined = node
-                    ? checker.getTypeOfSymbolAtLocation(prop, node)
-                    : checker.getTypeOfPropertyOfType(parent, prop.name);
-                return [node, type];
-            })();
-            if ((node && pred(node) === false) || type === undefined) continue;
-
-            // GET EXACT TYPE
-            const key: Metadata = MetadataHelper.literal_to_metadata(prop.name);
-            const value: Metadata = explore_metadata(checker)(options)(
-                collection,
-            )(errors)(type, {
-                top: false,
-                object: obj,
-                property: prop.name,
-                nested: null,
-                escaped: false,
-                aliased: false,
-            });
-            Writable(value).optional =
-                (prop.flags & ts.SymbolFlags.Optional) !== 0;
-            insert(key)(value)(prop);
-        }
-
-        //----
-        // DYNAMIC PROPERTIES
-        //----
-        for (const index of checker.getIndexInfosOfType(parent)) {
-            // GET EXACT TYPE
-            const analyzer = (type: ts.Type) => (property: {} | null) =>
-                explore_metadata(checker)(options)(collection)(errors)(type, {
-                    top: false,
-                    object: obj,
-                    property,
-                    nested: null,
-                    escaped: false,
-                    aliased: false,
-                });
-            const key: Metadata = analyzer(index.keyType)(null);
-            const value: Metadata = analyzer(index.type)({});
-
-            // INSERT WITH REQUIRED CONFIGURATION
-            insert(key)(value)(
-                index.declaration?.parent
-                    ? checker.getSymbolAtLocation(index.declaration.parent)
-                    : undefined,
-                (doc) => doc.name !== "default",
-            );
-        }
-        return obj;
-    };
-
-const isProperty = (node: ts.Declaration) =>
-    ts.isPropertyDeclaration(node) ||
-    ts.isPropertyAssignment(node) ||
-    ts.isPropertySignature(node) ||
-    ts.isTypeLiteralNode(node);
-
-const iterate_optional_coalesce = (meta: Metadata, type: ts.Type): void => {
-    if (type.isUnionOrIntersection())
-        type.types.forEach((child) => iterate_optional_coalesce(meta, child));
-    else iterate_metadata_coalesce(meta, type);
-};
+import ts from "typescript";
+
+import { Metadata } from "../../../schemas/metadata/Metadata";
+import { MetadataObject } from "../../../schemas/metadata/MetadataObject";
+import { MetadataProperty } from "../../../schemas/metadata/MetadataProperty";
+
+import { Writable } from "../../../typings/Writable";
+
+import { ArrayUtil } from "../../../utils/ArrayUtil";
+
+import { CommentFactory } from "../../CommentFactory";
+import { MetadataCollection } from "../../MetadataCollection";
+import { MetadataFactory } from "../../MetadataFactory";
+import { MetadataHelper } from "./MetadataHelper";
+import { explore_metadata } from "./explore_metadata";
+import { iterate_metadata_coalesce } from "./iterate_metadata_coalesce";
+
+export const emplace_metadata_object =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (errors: MetadataFactory.IError[]) =>
+    (parent: ts.Type, nullable: boolean): MetadataObject => {
+        // EMPLACE OBJECT
+        const [obj, newbie] = collection.emplace(checker, parent);
+        ArrayUtil.add(obj.nullables, nullable, (elem) => elem === nullable);
+
+        if (newbie === false) return obj;
+
+        // PREPARE ASSETS
+        const isClass: boolean = parent.isClass();
+        const pred: (node: ts.Declaration) => boolean = isClass
+            ? (node) => {
+                  const kind: ts.SyntaxKind | undefined = node
+                      .getChildren()[0]
+                      ?.getChildren()[0]?.kind;
+                  return (
+                      kind !== ts.SyntaxKind.PrivateKeyword &&
+                      kind !== ts.SyntaxKind.ProtectedKeyword &&
+                      (ts.isParameter(node) || isProperty(node))
+                  );
+              }
+            : (node) => isProperty(node);
+
+        const insert =
+            (key: Metadata) =>
+            (value: Metadata) =>
+            (
+                symbol: ts.Symbol | undefined,
+                filter?: (doc: ts.JSDocTagInfo) => boolean,
+            ): MetadataProperty => {
+                // COMMENTS AND TAGS
+                const description: string | null = symbol
+                    ? CommentFactory.description(symbol) ?? null
+                    : null;
+                const jsDocTags: ts.JSDocTagInfo[] = (
+                    symbol?.getJsDocTags() ?? []
+                ).filter(filter ?? (() => true));
+
+                // THE PROPERTY
+                const property = MetadataProperty.create({
+                    key,
+                    value,
+                    description,
+                    jsDocTags,
+                });
+                obj.properties.push(property);
+                return property;
+            };
+
+        //----
+        // REGULAR PROPERTIES
+        //----
+        for (const prop of parent.getApparentProperties()) {
+            // CHECK INTERNAL TAG
+            if (
+                (prop.getJsDocTags(checker) ?? []).find(
+                    (tag) => tag.name === "internal",
+                ) !== undefined
+            )
+                continue;
+
+            // CHECK NODE IS A FORMAL PROPERTY
+            const [node, type] = (() => {
+                const node = prop.getDeclarations()?.[0] as
+                    | ts.PropertyDeclaration
+                    | undefined;
+                const type: ts.Type | undefined = node
+                    ? checker.getTypeOfSymbolAtLocation(prop, node)
+                    : checker.getTypeOfPropertyOfType(parent, prop.name);
+                return [node, type];
+            })();
+            if ((node && pred(node) === false) || type === undefined) continue;
+
+            // GET EXACT TYPE
+            const key: Metadata = MetadataHelper.literal_to_metadata(prop.name);
+            const value: Metadata = explore_metadata(checker)(options)(
+                collection,
+            )(errors)(type, {
+                top: false,
+                object: obj,
+                property: prop.name,
+                nested: null,
+                escaped: false,
+                aliased: false,
+            });
+            Writable(value).optional =
+                (prop.flags & ts.SymbolFlags.Optional) !== 0;
+            insert(key)(value)(prop);
+        }
+
+        //----
+        // DYNAMIC PROPERTIES
+        //----
+        for (const index of checker.getIndexInfosOfType(parent)) {
+            // GET EXACT TYPE
+            const analyzer = (type: ts.Type) => (property: {} | null) =>
+                explore_metadata(checker)(options)(collection)(errors)(type, {
+                    top: false,
+                    object: obj,
+                    property,
+                    nested: null,
+                    escaped: false,
+                    aliased: false,
+                });
+            const key: Metadata = analyzer(index.keyType)(null);
+            const value: Metadata = analyzer(index.type)({});
+
+            // INSERT WITH REQUIRED CONFIGURATION
+            insert(key)(value)(
+                index.declaration?.parent
+                    ? checker.getSymbolAtLocation(index.declaration.parent)
+                    : undefined,
+                (doc) => doc.name !== "default",
+            );
+        }
+        return obj;
+    };
+
+const isProperty = (node: ts.Declaration) =>
+    ts.isPropertyDeclaration(node) ||
+    ts.isPropertyAssignment(node) ||
+    ts.isPropertySignature(node) ||
+    ts.isTypeLiteralNode(node);
+
+const iterate_optional_coalesce = (meta: Metadata, type: ts.Type): void => {
+    if (type.isUnionOrIntersection())
+        type.types.forEach((child) => iterate_optional_coalesce(meta, child));
+    else iterate_metadata_coalesce(meta, type);
+};