typia 3.9.0-dev.20230603 → 3.9.0-dev.20230604-2

package/src/factories/MetadataCollection.ts

@@ -1,257 +1,254 @@
-import ts from "typescript";
-
-import { IMetadataCollection } from "../metadata/IMetadataCollection";
-import { Metadata } from "../metadata/Metadata";
-import { MetadataArray } from "../metadata/MetadataArray";
-import { MetadataDefinition } from "../metadata/MetadataDefinition";
-import { MetadataObject } from "../metadata/MetadataObject";
-import { MetadataTuple } from "../metadata/MetadataTuple";
-
-import { Writable } from "../typings/Writable";
-
-import { MapUtil } from "../utils/MapUtil";
-
-import { CommentFactory } from "./CommentFactory";
-import { TypeFactory } from "./TypeFactory";
-
-export class MetadataCollection {
-    private readonly objects_: Map<ts.Type, MetadataObject>;
-    private readonly object_unions_: Map<string, MetadataObject[]>;
-    private readonly definitions_: Map<ts.Type, MetadataDefinition>;
-    private readonly arrays_: Map<ts.Type, MetadataArray>;
-    private readonly tuples_: Map<ts.Type, MetadataTuple>;
-
-    private readonly names_: Map<string, Map<ts.Type, string>>;
-    private object_index_: number;
-    private recursive_array_index_: number;
-    private recursive_tuple_index_: number;
-
-    public constructor(
-        private readonly options?: Partial<MetadataCollection.IOptions>,
-    ) {
-        this.objects_ = new Map();
-        this.object_unions_ = new Map();
-        this.definitions_ = new Map();
-        this.arrays_ = new Map();
-        this.tuples_ = new Map();
-
-        this.names_ = new Map();
-        this.object_index_ = 0;
-        this.recursive_array_index_ = 0;
-        this.recursive_tuple_index_ = 0;
-    }
-
-    /* -----------------------------------------------------------
-        ACCESSORS
-    ----------------------------------------------------------- */
-    public definitions(): MetadataDefinition[] {
-        return [...this.definitions_.values()];
-    }
-
-    public objects(): MetadataObject[] {
-        return [...this.objects_.values()];
-    }
-
-    public unions(): MetadataObject[][] {
-        return [...this.object_unions_.values()];
-    }
-
-    public arrays(): MetadataArray[] {
-        return [...this.arrays_.values()];
-    }
-
-    public tuples(): MetadataTuple[] {
-        return [...this.tuples_.values()];
-    }
-
-    private getName(checker: ts.TypeChecker, type: ts.Type): string {
-        const name: string = (() => {
-            const str: string = TypeFactory.getFullName(checker)(type);
-            return this.options?.replace ? this.options.replace(str) : str;
-        })();
-
-        const duplicates: Map<ts.Type, string> = MapUtil.take(this.names_)(
-            name,
-            () => new Map(),
-        );
-        const oldbie: string | undefined = duplicates.get(type);
-        if (oldbie !== undefined) return oldbie;
-
-        const addicted: string = duplicates.size
-            ? `${name}.o${duplicates.size}`
-            : name;
-        duplicates.set(type, addicted);
-        return addicted;
-    }
-
-    /**
-     * @internal
-     */
-    public getUnionIndex(meta: Metadata): number {
-        const key: string = meta.objects.map((obj) => obj.name).join(" | ");
-        MapUtil.take(this.object_unions_)(key, () => meta.objects);
-        return [...this.object_unions_.keys()].indexOf(key);
-    }
-
-    /* -----------------------------------------------------------
-        INSTANCES
-    ----------------------------------------------------------- */
-    public emplace(
-        checker: ts.TypeChecker,
-        type: ts.Type,
-    ): [MetadataObject, boolean] {
-        const oldbie = this.objects_.get(type);
-        if (oldbie !== undefined) return [oldbie, false];
-
-        const $id: string = this.getName(checker, type);
-        const obj: MetadataObject = MetadataObject.create({
-            name: $id,
-            properties: [],
-            description:
-                (type.symbol && CommentFactory.description(type.symbol)) ??
-                undefined,
-            jsDocTags: type.symbol?.getJsDocTags() ?? [],
-            validated: false,
-            index: this.object_index_++,
-            recursive: null!,
-            nullables: [],
-        });
-        this.objects_.set(type, obj);
-        return [obj, true];
-    }
-
-    public emplaceDefinition(
-        checker: ts.TypeChecker,
-        type: ts.Type,
-        symbol: ts.Symbol,
-    ): [MetadataDefinition, boolean, (meta: Metadata) => void] {
-        const oldbie = this.definitions_.get(type);
-        if (oldbie !== undefined) return [oldbie, false, () => {}];
-
-        const $id: string = this.getName(checker, type);
-        const def: MetadataDefinition = MetadataDefinition.create({
-            name: $id,
-            value: null!,
-            description: CommentFactory.description(symbol) ?? null,
-            recursive: null!,
-            nullables: [],
-            jsDocTags: symbol.getJsDocTags() ?? [],
-        });
-        this.definitions_.set(type, def);
-        return [def, true, (meta) => (Writable(def).value = meta)];
-    }
-
-    public emplaceArray(
-        checker: ts.TypeChecker,
-        type: ts.Type,
-    ): [MetadataArray, boolean, (meta: Metadata) => void] {
-        const oldbie = this.arrays_.get(type);
-        if (oldbie !== undefined) return [oldbie, false, () => {}];
-
-        const $id = this.getName(checker, type);
-        const array: MetadataArray = MetadataArray.create({
-            name: $id,
-            value: null!,
-            index: null,
-            recursive: null!,
-            nullables: [],
-        });
-        this.arrays_.set(type, array);
-        return [array, true, (meta) => (Writable(array).value = meta)];
-    }
-
-    public emplaceTuple(
-        checker: ts.TypeChecker,
-        type: ts.TupleType,
-    ): [MetadataTuple, boolean, (elements: Metadata[]) => void] {
-        const oldbie = this.tuples_.get(type);
-        if (oldbie !== undefined) return [oldbie, false, () => {}];
-
-        const $id = this.getName(checker, type);
-        const tuple: MetadataTuple = MetadataTuple.create({
-            name: $id,
-            elements: null!,
-            index: null,
-            recursive: null!,
-            nullables: [],
-        });
-        this.tuples_.set(type, tuple);
-        return [
-            tuple,
-            true,
-            (elements) => (Writable(tuple).elements = elements),
-        ];
-    }
-
-    /**
-     * @internal
-     */
-    public setObjectRecursive(obj: MetadataObject, recursive: boolean): void {
-        Writable(obj).recursive = recursive;
-    }
-
-    /**
-     * @internal
-     */
-    public setDefinitionRecursive(
-        def: MetadataDefinition,
-        recursive: boolean,
-    ): void {
-        Writable(def).recursive = recursive;
-    }
-
-    /**
-     * @internal
-     */
-    public setArrayRecursive(array: MetadataArray, recursive: boolean): void {
-        Writable(array).recursive = recursive;
-        if (recursive) Writable(array).index = this.recursive_array_index_++;
-    }
-
-    public setTupleRecursive(tuple: MetadataTuple, recursive: boolean): void {
-        Writable(tuple).recursive = recursive;
-        if (recursive) Writable(tuple).index = this.recursive_tuple_index_++;
-    }
-
-    public toJSON(): IMetadataCollection {
-        return {
-            objects: this.objects().map((o) => o.toJSON()),
-            definitions: this.definitions().map((d) => d.toJSON()),
-            arrays: [...this.arrays_.values()].map((a) => a.toJSON()),
-            tuples: [...this.tuples_.values()].map((t) => t.toJSON()),
-        };
-    }
-}
-export namespace MetadataCollection {
-    export interface IOptions {
-        replace?(str: string): string;
-    }
-
-    export const replace = (str: string): string => {
-        for (const [before, after] of REPLACERS)
-            str = str.split(before).join(after);
-        return str;
-    };
-
-    export const escape = (str: string): string => {
-        for (const [before, after] of REPLACERS)
-            if (after !== "") str = str.split(after).join(before);
-        return str;
-    };
-}
-const REPLACERS: [string, string][] = [
-    ["$", "_dollar_"],
-    ["&", "_and_"],
-    ["|", "_or_"],
-    ["{", "_blt_"],
-    ["}", "_bgt_"],
-    ["<", "_lt_"],
-    [">", "_gt_"],
-    ["[", "_alt_"],
-    ["]", "_agt_"],
-    [",", "_comma_"],
-    ["`", "_backquote_"],
-    ["'", "_singlequote_"],
-    ['"', "_doublequote_"],
-    [" ", "_space_"],
-];
+import ts from "typescript";
+
+import { IMetadataCollection } from "../metadata/IMetadataCollection";
+import { Metadata } from "../metadata/Metadata";
+import { MetadataAlias } from "../metadata/MetadataAlias";
+import { MetadataArray } from "../metadata/MetadataArray";
+import { MetadataObject } from "../metadata/MetadataObject";
+import { MetadataTuple } from "../metadata/MetadataTuple";
+
+import { Writable } from "../typings/Writable";
+
+import { MapUtil } from "../utils/MapUtil";
+
+import { CommentFactory } from "./CommentFactory";
+import { TypeFactory } from "./TypeFactory";
+
+export class MetadataCollection {
+    private readonly objects_: Map<ts.Type, MetadataObject>;
+    private readonly object_unions_: Map<string, MetadataObject[]>;
+    private readonly aliases_: Map<ts.Type, MetadataAlias>;
+    private readonly arrays_: Map<ts.Type, MetadataArray>;
+    private readonly tuples_: Map<ts.Type, MetadataTuple>;
+
+    private readonly names_: Map<string, Map<ts.Type, string>>;
+    private object_index_: number;
+    private recursive_array_index_: number;
+    private recursive_tuple_index_: number;
+
+    public constructor(
+        private readonly options?: Partial<MetadataCollection.IOptions>,
+    ) {
+        this.objects_ = new Map();
+        this.object_unions_ = new Map();
+        this.aliases_ = new Map();
+        this.arrays_ = new Map();
+        this.tuples_ = new Map();
+
+        this.names_ = new Map();
+        this.object_index_ = 0;
+        this.recursive_array_index_ = 0;
+        this.recursive_tuple_index_ = 0;
+    }
+
+    /* -----------------------------------------------------------
+        ACCESSORS
+    ----------------------------------------------------------- */
+    public aliases(): MetadataAlias[] {
+        return [...this.aliases_.values()];
+    }
+
+    public objects(): MetadataObject[] {
+        return [...this.objects_.values()];
+    }
+
+    public unions(): MetadataObject[][] {
+        return [...this.object_unions_.values()];
+    }
+
+    public arrays(): MetadataArray[] {
+        return [...this.arrays_.values()];
+    }
+
+    public tuples(): MetadataTuple[] {
+        return [...this.tuples_.values()];
+    }
+
+    private getName(checker: ts.TypeChecker, type: ts.Type): string {
+        const name: string = (() => {
+            const str: string = TypeFactory.getFullName(checker)(type);
+            return this.options?.replace ? this.options.replace(str) : str;
+        })();
+
+        const duplicates: Map<ts.Type, string> = MapUtil.take(this.names_)(
+            name,
+            () => new Map(),
+        );
+        const oldbie: string | undefined = duplicates.get(type);
+        if (oldbie !== undefined) return oldbie;
+
+        const addicted: string = duplicates.size
+            ? `${name}.o${duplicates.size}`
+            : name;
+        duplicates.set(type, addicted);
+        return addicted;
+    }
+
+    /**
+     * @internal
+     */
+    public getUnionIndex(meta: Metadata): number {
+        const key: string = meta.objects.map((obj) => obj.name).join(" | ");
+        MapUtil.take(this.object_unions_)(key, () => meta.objects);
+        return [...this.object_unions_.keys()].indexOf(key);
+    }
+
+    /* -----------------------------------------------------------
+        INSTANCES
+    ----------------------------------------------------------- */
+    public emplace(
+        checker: ts.TypeChecker,
+        type: ts.Type,
+    ): [MetadataObject, boolean] {
+        const oldbie = this.objects_.get(type);
+        if (oldbie !== undefined) return [oldbie, false];
+
+        const $id: string = this.getName(checker, type);
+        const obj: MetadataObject = MetadataObject.create({
+            name: $id,
+            properties: [],
+            description:
+                (type.symbol && CommentFactory.description(type.symbol)) ??
+                undefined,
+            jsDocTags: type.symbol?.getJsDocTags() ?? [],
+            validated: false,
+            index: this.object_index_++,
+            recursive: null!,
+            nullables: [],
+        });
+        this.objects_.set(type, obj);
+        return [obj, true];
+    }
+
+    public emplaceAlias(
+        checker: ts.TypeChecker,
+        type: ts.Type,
+        symbol: ts.Symbol,
+    ): [MetadataAlias, boolean, (meta: Metadata) => void] {
+        const oldbie = this.aliases_.get(type);
+        if (oldbie !== undefined) return [oldbie, false, () => {}];
+
+        const $id: string = this.getName(checker, type);
+        const alias: MetadataAlias = MetadataAlias.create({
+            name: $id,
+            value: null!,
+            description: CommentFactory.description(symbol) ?? null,
+            recursive: null!,
+            nullables: [],
+            jsDocTags: symbol.getJsDocTags() ?? [],
+        });
+        this.aliases_.set(type, alias);
+        return [alias, true, (meta) => (Writable(alias).value = meta)];
+    }
+
+    public emplaceArray(
+        checker: ts.TypeChecker,
+        type: ts.Type,
+    ): [MetadataArray, boolean, (meta: Metadata) => void] {
+        const oldbie = this.arrays_.get(type);
+        if (oldbie !== undefined) return [oldbie, false, () => {}];
+
+        const $id = this.getName(checker, type);
+        const array: MetadataArray = MetadataArray.create({
+            name: $id,
+            value: null!,
+            index: null,
+            recursive: null!,
+            nullables: [],
+        });
+        this.arrays_.set(type, array);
+        return [array, true, (meta) => (Writable(array).value = meta)];
+    }
+
+    public emplaceTuple(
+        checker: ts.TypeChecker,
+        type: ts.TupleType,
+    ): [MetadataTuple, boolean, (elements: Metadata[]) => void] {
+        const oldbie = this.tuples_.get(type);
+        if (oldbie !== undefined) return [oldbie, false, () => {}];
+
+        const $id = this.getName(checker, type);
+        const tuple: MetadataTuple = MetadataTuple.create({
+            name: $id,
+            elements: null!,
+            index: null,
+            recursive: null!,
+            nullables: [],
+        });
+        this.tuples_.set(type, tuple);
+        return [
+            tuple,
+            true,
+            (elements) => (Writable(tuple).elements = elements),
+        ];
+    }
+
+    /**
+     * @internal
+     */
+    public setObjectRecursive(obj: MetadataObject, recursive: boolean): void {
+        Writable(obj).recursive = recursive;
+    }
+
+    /**
+     * @internal
+     */
+    public setAliasRecursive(alias: MetadataAlias, recursive: boolean): void {
+        Writable(alias).recursive = recursive;
+    }
+
+    /**
+     * @internal
+     */
+    public setArrayRecursive(array: MetadataArray, recursive: boolean): void {
+        Writable(array).recursive = recursive;
+        if (recursive) Writable(array).index = this.recursive_array_index_++;
+    }
+
+    public setTupleRecursive(tuple: MetadataTuple, recursive: boolean): void {
+        Writable(tuple).recursive = recursive;
+        if (recursive) Writable(tuple).index = this.recursive_tuple_index_++;
+    }
+
+    public toJSON(): IMetadataCollection {
+        return {
+            objects: this.objects().map((o) => o.toJSON()),
+            aliases: this.aliases().map((d) => d.toJSON()),
+            arrays: [...this.arrays_.values()].map((a) => a.toJSON()),
+            tuples: [...this.tuples_.values()].map((t) => t.toJSON()),
+        };
+    }
+}
+export namespace MetadataCollection {
+    export interface IOptions {
+        replace?(str: string): string;
+    }
+
+    export const replace = (str: string): string => {
+        for (const [before, after] of REPLACERS)
+            str = str.split(before).join(after);
+        return str;
+    };
+
+    export const escape = (str: string): string => {
+        for (const [before, after] of REPLACERS)
+            if (after !== "") str = str.split(after).join(before);
+        return str;
+    };
+}
+const REPLACERS: [string, string][] = [
+    ["$", "_dollar_"],
+    ["&", "_and_"],
+    ["|", "_or_"],
+    ["{", "_blt_"],
+    ["}", "_bgt_"],
+    ["<", "_lt_"],
+    [">", "_gt_"],
+    ["[", "_alt_"],
+    ["]", "_agt_"],
+    [",", "_comma_"],
+    ["`", "_backquote_"],
+    ["'", "_singlequote_"],
+    ['"', "_doublequote_"],
+    [" ", "_space_"],
+];

package/src/factories/MetadataFactory.ts

@@ -1,40 +1,40 @@
-import ts from "typescript";
-
-import { Metadata } from "../metadata/Metadata";
-import { explore_metadata } from "./internal/metadata/explore_metadata";
-import { iterate_metadata_collection } from "./internal/metadata/iterate_metadata_collection";
-import { iterate_metadata_sort } from "./internal/metadata/iterate_metadata_sort";
-
-import { MetadataCollection } from "./MetadataCollection";
-
-export namespace MetadataFactory {
-    export interface IOptions {
-        resolve: boolean;
-        constant: boolean;
-        absorb: boolean;
-        validate?: (meta: Metadata) => void;
-    }
-
-    export const analyze =
-        (checker: ts.TypeChecker) =>
-        (options: IOptions) =>
-        (collection: MetadataCollection) =>
-        (type: ts.Type | null): Metadata => {
-            const meta: Metadata = explore_metadata(checker)(options)(
-                collection,
-            )(type, false);
-            iterate_metadata_collection(collection);
-            iterate_metadata_sort(collection)(meta);
-            return meta;
-        };
-
-    /**
-     * @deprecated Use `analyze` function instead
-     */
-    export const generate = (
-        checker: ts.TypeChecker,
-        collection: MetadataCollection,
-        type: ts.Type,
-        options: IOptions,
-    ) => analyze(checker)(options)(collection)(type);
-}
+import ts from "typescript";
+
+import { Metadata } from "../metadata/Metadata";
+import { explore_metadata } from "./internal/metadata/explore_metadata";
+import { iterate_metadata_collection } from "./internal/metadata/iterate_metadata_collection";
+import { iterate_metadata_sort } from "./internal/metadata/iterate_metadata_sort";
+
+import { MetadataCollection } from "./MetadataCollection";
+
+export namespace MetadataFactory {
+    export interface IOptions {
+        resolve: boolean;
+        constant: boolean;
+        absorb: boolean;
+        validate?: (meta: Metadata) => void;
+    }
+
+    export const analyze =
+        (checker: ts.TypeChecker) =>
+        (options: IOptions) =>
+        (collection: MetadataCollection) =>
+        (type: ts.Type | null): Metadata => {
+            const meta: Metadata = explore_metadata(checker)(options)(
+                collection,
+            )(type, false);
+            iterate_metadata_collection(collection);
+            iterate_metadata_sort(collection)(meta);
+            return meta;
+        };
+
+    /**
+     * @deprecated Use `analyze` function instead
+     */
+    export const generate = (
+        checker: ts.TypeChecker,
+        collection: MetadataCollection,
+        type: ts.Type,
+        options: IOptions,
+    ) => analyze(checker)(options)(collection)(type);
+}