typia 3.3.12 → 3.4.0-dev.20221212

package/src/factories/internal/iterate_metadata_map.ts

@@ -0,0 +1,41 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { ArrayUtil } from "../../utils/ArrayUtil";
+
+import { MetadataCollection } from "../MetadataCollection";
+import { MetadataFactory } from "../MetadataFactory";
+import { TypeFactory } from "../TypeFactory";
+import { explore_metadata } from "./explore_metadata";
+
+export const iterate_metadata_map =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (meta: Metadata, type: ts.Type): boolean => {
+        type = checker.getApparentType(type);
+
+        const name = TypeFactory.getFullName(checker, type, type.getSymbol());
+        const generic = type.aliasSymbol
+            ? type.aliasTypeArguments
+            : checker.getTypeArguments(type as ts.TypeReference);
+        if (name.substring(0, 4) !== "Map<" || generic?.length !== 2)
+            return false;
+
+        const key: ts.Type = generic[0]!;
+        const value: ts.Type = generic[1]!;
+
+        ArrayUtil.set(
+            meta.maps,
+            {
+                key: explore_metadata(checker)(options)(collection)(key, false),
+                value: explore_metadata(checker)(options)(collection)(
+                    value,
+                    false,
+                ),
+            },
+            (elem) => `Map<${elem.key.getName()}, ${elem.value.getName()}>`,
+        );
+        return true;
+    };

package/src/factories/internal/iterate_metadata_native.ts

@@ -0,0 +1,227 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { ArrayUtil } from "../../utils/ArrayUtil";
+
+import { TypeFactory } from "../TypeFactory";
+
+export const iterate_metadata_native =
+    (checker: ts.TypeChecker) =>
+    (meta: Metadata, type: ts.Type): boolean => {
+        const validator = validate(checker)(type);
+        const name: string = TypeFactory.getFullName(
+            checker,
+            type,
+            type.getSymbol(),
+        );
+
+        const simple = SIMPLES.get(name);
+        if (simple && validator(simple)) {
+            if (FORBIDDEN.has(name))
+                throw new Error(
+                    `Error on typia.metadata(): typia does not allow "${name}" class type. Use "${name.toLowerCase()}" type instead.`,
+                );
+            ArrayUtil.set(meta.natives, name, (str) => str);
+            return true;
+        }
+
+        const complicate = COMPLICATES.get(name);
+        if (complicate && validator(complicate)) {
+            ArrayUtil.set(meta.natives, complicate.name ?? name, (str) => str);
+            return true;
+        }
+
+        for (const generic of GENERICS)
+            if (
+                name.substring(0, generic.name.length) === generic.name &&
+                validator(generic)
+            ) {
+                ArrayUtil.set(meta.natives, generic.name ?? name, (str) => str);
+                return true;
+            }
+        return false;
+    };
+
+const validate =
+    (checker: ts.TypeChecker) => (type: ts.Type) => (info: IClassInfo) =>
+        (info.methods ?? []).every((method) => {
+            const returnType = TypeFactory.getReturnType(
+                checker,
+                type,
+                method.name,
+            );
+            return (
+                returnType !== null &&
+                checker.typeToString(returnType) === method.return
+            );
+        }) &&
+        (info.properties ?? []).every((property) => {
+            const prop = checker.getPropertyOfType(type, property.name);
+            const propType = prop?.valueDeclaration
+                ? checker.getTypeAtLocation(prop?.valueDeclaration)
+                : undefined;
+            return (
+                propType !== undefined &&
+                checker.typeToString(propType) === property.type
+            );
+        });
+
+const getBinaryProps = (className: string): IClassInfo => ({
+    name: className,
+    methods: [
+        ...["indexOf", "lastIndexOf"].map((name) => ({
+            name,
+            return: "number",
+        })),
+        ...["some", "every"].map((name) => ({
+            name,
+            return: "boolean",
+        })),
+        ...["join", "toLocaleString"].map((name) => ({
+            name,
+            return: "string",
+        })),
+        ...["reverse", "slice", "subarray"].map((name) => ({
+            name,
+            return: className,
+        })),
+    ],
+    properties: ["BYTES_PER_ELEMENT", "length", "byteLength", "byteOffset"].map(
+        (name) => ({
+            name,
+            type: "number",
+        }),
+    ),
+});
+const SIMPLES: Map<string, IClassInfo> = new Map([
+    [
+        "Date",
+        {
+            methods: ["getTime", "getFullYear", "getMonth", "getMinutes"].map(
+                (name) => ({
+                    name,
+                    return: "number",
+                }),
+            ),
+        },
+    ],
+    [
+        "Boolean",
+        {
+            methods: [
+                {
+                    name: "valueOf",
+                    return: "boolean",
+                },
+            ],
+        },
+    ],
+    [
+        "Number",
+        {
+            methods: [
+                ...["toFixed", "toExponential", "toPrecision"].map((name) => ({
+                    name,
+                    return: "string",
+                })),
+                {
+                    name: "valueOf",
+                    return: "number",
+                },
+            ],
+        },
+    ],
+    [
+        "String",
+        {
+            methods: [
+                "charAt",
+                "concat",
+                "valueOf",
+                "trim",
+                "replace",
+                "substring",
+            ].map((name) => ({
+                name,
+                return: "string",
+            })),
+        },
+    ],
+    ...[
+        "Uint8Array",
+        "Uint8ClampedArray",
+        "Uint16Array",
+        "Uint32Array",
+        "BigUint64Array",
+        "Int8Array",
+        "Int16Array",
+        "Int32Array",
+        "BigInt64Array",
+        "Float32Array",
+        "Float64Array",
+    ].map((name) => [name, getBinaryProps(name)] as const),
+    ...["ArrayBuffer", "SharedArrayBuffer"].map((className) => {
+        const info: IClassInfo = {
+            methods: [
+                {
+                    name: "slice",
+                    return: className,
+                },
+            ],
+            properties: [
+                {
+                    name: "byteLength",
+                    type: "number",
+                },
+            ],
+        };
+        return [className, info] as const;
+    }),
+    [
+        "DataView",
+        {
+            methods: [
+                "getFloat32",
+                "getFloat64",
+                "getInt8",
+                "getInt16",
+                "getInt32",
+                "getUint8",
+                "getUint16",
+                "getUint32",
+            ].map((name) => ({
+                name,
+                return: "number",
+            })),
+        },
+    ],
+]);
+const COMPLICATES: Map<string, IClassInfo> = new Map([
+    [`'buffer'.global.Buffer`, getBinaryProps("Buffer")],
+]);
+const GENERICS: Array<IClassInfo & { name: string }> = [
+    "WeakMap",
+    "WeakSet",
+].map((name) => ({
+    name,
+    methods: ["has", "delete"].map((name) => ({
+        name,
+        return: "boolean",
+    })),
+}));
+const FORBIDDEN: Set<string> = new Set(["Bolean", "Number", "String"]);
+
+interface IClassInfo {
+    name?: string;
+    methods?: IMethod[];
+    properties?: IProperty[];
+}
+interface IProperty {
+    name: string;
+    type: string;
+}
+interface IMethod {
+    name: string;
+    return: string;
+}

package/src/factories/internal/iterate_metadata_object.ts

@@ -0,0 +1,45 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+import { MetadataObject } from "../../metadata/MetadataObject";
+
+import { ArrayUtil } from "../../utils/ArrayUtil";
+
+import { MetadataCollection } from "../MetadataCollection";
+import { MetadataFactory } from "../MetadataFactory";
+import { emplace_metadata_object } from "./emplace_metadata_object";
+import { iterate_metadata } from "./iterate_metadata";
+
+export const iterate_metadata_object =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (meta: Metadata, type: ts.Type, parentResolved: boolean): boolean => {
+        const filter = (flag: ts.TypeFlags) => (type.getFlags() & flag) !== 0;
+        if (!filter(ts.TypeFlags.Object) && !type.isIntersection())
+            return false;
+
+        if (type.isIntersection()) {
+            const fakeCollection = new MetadataCollection();
+            const fakeSchema: Metadata = Metadata.initialize();
+
+            type.types.forEach((t) =>
+                iterate_metadata(checker)(options)(fakeCollection)(
+                    fakeSchema,
+                    t,
+                    parentResolved,
+                ),
+            );
+            if (
+                fakeSchema.objects.length === 0 ||
+                fakeSchema.objects.length !== fakeSchema.size()
+            )
+                return true;
+        }
+
+        const obj: MetadataObject = emplace_metadata_object(checker)(options)(
+            collection,
+        )(type, meta.nullable);
+        ArrayUtil.add(meta.objects, obj, (elem) => elem.name === obj.name);
+        return true;
+    };

package/src/factories/internal/iterate_metadata_resolve.ts

@@ -0,0 +1,27 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { Writable } from "../../typings/Writable";
+
+import { MetadataCollection } from "../MetadataCollection";
+import { MetadataFactory } from "../MetadataFactory";
+import { TypeFactory } from "../TypeFactory";
+import { explore_metadata } from "./explore_metadata";
+
+export const iterate_metadata_resolve =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (meta: Metadata, type: ts.Type, parentResolved: boolean): boolean => {
+        if (options.resolve === true && parentResolved === false) {
+            const resolved: ts.Type | null = TypeFactory.resolve(checker, type);
+            if (resolved !== null) {
+                Writable(meta).resolved = explore_metadata(checker)(options)(
+                    collection,
+                )(resolved, true);
+                return true;
+            }
+        }
+        return false;
+    };

package/src/factories/internal/iterate_metadata_set.ts

@@ -0,0 +1,33 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { ArrayUtil } from "../../utils/ArrayUtil";
+
+import { MetadataCollection } from "../MetadataCollection";
+import { MetadataFactory } from "../MetadataFactory";
+import { TypeFactory } from "../TypeFactory";
+import { explore_metadata } from "./explore_metadata";
+
+export const iterate_metadata_set =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (meta: Metadata, type: ts.Type): boolean => {
+        type = checker.getApparentType(type);
+
+        const name = TypeFactory.getFullName(checker, type, type.getSymbol());
+        const generic = type.aliasSymbol
+            ? type.aliasTypeArguments
+            : checker.getTypeArguments(type as ts.TypeReference);
+        if (name.substring(0, 4) !== "Set<" || generic?.length !== 1)
+            return false;
+
+        const key: ts.Type = generic[0]!;
+        ArrayUtil.set(
+            meta.sets,
+            explore_metadata(checker)(options)(collection)(key, false),
+            (elem) => elem.getName(),
+        );
+        return true;
+    };

package/src/factories/internal/iterate_metadata_template.ts

@@ -0,0 +1,38 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { MetadataCollection } from "../MetadataCollection";
+import { MetadataFactory } from "../MetadataFactory";
+import { MetadataHelper } from "./MetadataHelper";
+import { explore_metadata } from "./explore_metadata";
+
+export const iterate_metadata_template =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (meta: Metadata, type: ts.Type): boolean => {
+        const filter = (flag: ts.TypeFlags) => (type.getFlags() & flag) !== 0;
+        if (!filter(ts.TypeFlags.TemplateLiteral)) return false;
+
+        const template: ts.TemplateLiteralType = type as ts.TemplateLiteralType;
+        const row: Metadata[] = [];
+
+        template.texts.forEach((text, i) => {
+            // TEXT LITERAL TYPE
+            if (text !== "") row.push(MetadataHelper.literal_to_metadata(text));
+
+            // BINDED TEMPLATE TYPE
+            const binded: ts.Type | undefined = template.types[i];
+            if (binded)
+                row.push(
+                    explore_metadata(checker)(options)(collection)(
+                        binded,
+                        false,
+                    ),
+                );
+        });
+        meta.templates.push(row);
+
+        return true;
+    };

package/src/factories/internal/iterate_metadata_tuple.ts

@@ -0,0 +1,51 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { Writable } from "../../typings/Writable";
+
+import { ArrayUtil } from "../../utils/ArrayUtil";
+
+import { MetadataCollection } from "../MetadataCollection";
+import { MetadataFactory } from "../MetadataFactory";
+import { explore_metadata } from "./explore_metadata";
+
+export const iterate_metadata_tuple =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (meta: Metadata, type: ts.Type, node: ts.TypeNode): boolean => {
+        if (!(checker as any).isTupleType(type)) return false;
+
+        while (ts.isTypeReferenceNode(node)) {
+            const declarations: ts.Declaration[] | undefined = (
+                node.typeName as any
+            )?.symbol?.declarations;
+            if (!declarations?.length) break;
+
+            const alias = declarations[0];
+            if (!alias || !ts.isTypeAliasDeclaration(alias)) break;
+            node = alias.type;
+        }
+
+        const elements = ts.isTupleTypeNode(node) ? node.elements : undefined;
+        const children: Metadata[] = checker
+            .getTypeArguments(type as ts.TypeReference)
+            .map((elem, i) => {
+                const child: Metadata = explore_metadata(checker)(options)(
+                    collection,
+                )(elem, false);
+                if (elements === undefined || !ts.isRestTypeNode(elements[i]!))
+                    return child;
+
+                const wrapper: Metadata = Metadata.initialize();
+                Writable(wrapper).rest = child;
+                return wrapper;
+            });
+        ArrayUtil.set(meta.tuples, children, join_tuple_names);
+        return true;
+    };
+
+function join_tuple_names(metas: Metadata[]): string {
+    return `[${metas.map((m) => m.getName).join(", ")}]`;
+}

package/src/factories/internal/iterate_metadata_union.ts

@@ -0,0 +1,59 @@
+import ts from "typescript";
+
+import { Metadata } from "../../metadata/Metadata";
+
+import { Writable } from "../../typings/Writable";
+
+import { MetadataCollection } from "../MetadataCollection";
+import { MetadataFactory } from "../MetadataFactory";
+import { TypeFactory } from "../TypeFactory";
+import { iterate_metadata } from "./iterate_metadata";
+
+export const iterate_metadata_union =
+    (checker: ts.TypeChecker) =>
+    (options: MetadataFactory.IOptions) =>
+    (collection: MetadataCollection) =>
+    (meta: Metadata, type: ts.Type, parentResolved: boolean): boolean => {
+        if (!type.isUnion()) return false;
+        else if (options.resolve === false || parentResolved === true) {
+            type.types.forEach((t) =>
+                iterate_metadata(checker)(options)(collection)(meta, t, false),
+            );
+            return true;
+        }
+
+        const filter = (flag: ts.TypeFlags, t: ts.Type) =>
+            (t.getFlags() & flag) !== 0;
+        const normals: ts.Type[] = [];
+        const toJsons: ts.Type[] = [];
+
+        for (const individual of type.types) {
+            if (filter(ts.TypeFlags.Object, individual)) {
+                const resolved: ts.Type | null = TypeFactory.resolve(
+                    checker,
+                    individual,
+                );
+                if (resolved !== null) toJsons.push(resolved);
+                else normals.push(individual);
+            } else normals.push(individual);
+        }
+        if (toJsons.length !== 0) {
+            Writable(meta).resolved = (() => {
+                const union: Metadata = Metadata.initialize();
+                toJsons.forEach((t) =>
+                    iterate_metadata(checker)(options)(collection)(
+                        meta,
+                        t,
+                        true,
+                    ),
+                );
+                if (union.objects.length > 1)
+                    union.union_index = collection.getUnionIndex(union);
+                return union;
+            })();
+        }
+        normals.forEach((t) =>
+            iterate_metadata(checker)(options)(collection)(meta, t, false),
+        );
+        return true;
+    };

package/src/functional/$every.ts

@@ -0,0 +1,11 @@
+import { TypeGuardError } from "../TypeGuardError";
+
+export const $every = <T>(
+    array: T[],
+    pred: (value: T, i: number) => null | Omit<TypeGuardError.IProps, "method">,
+): null | Omit<TypeGuardError.IProps, "method"> => {
+    let error: null | Omit<TypeGuardError.IProps, "method"> = null;
+    for (let i: number = 0; i < array.length; ++i)
+        if (null !== (error = pred(array[i]!, i))) return error;
+    return null;
+};

package/src/functional/$guard.ts

@@ -0,0 +1,35 @@
+import { TypeGuardError } from "../TypeGuardError";
+
+/* -----------------------------------------------------------
+    ASSERT V2 -> USE (NULL OR ERROR) CONDITION
+----------------------------------------------------------- */
+// /**
+//  * @internal
+//  */
+// export const $guardV2 =
+//     (method: string) => (props: Omit<TypeGuardError.IProps, "method">) =>
+//         new TypeGuardError({
+//             method,
+//             path: props.path,
+//             expected: props.expected,
+//             value: props.value,
+//         });
+
+/* -----------------------------------------------------------
+    ASSERT V3 -> (CONDITION OR THROW(exceptable): FALSE)
+----------------------------------------------------------- */
+/**
+ * @internal
+ */
+export const $guard =
+    (method: string) =>
+    (exceptionable: boolean, props: Omit<TypeGuardError.IProps, "method">) => {
+        if (exceptionable === true)
+            throw new TypeGuardError({
+                method,
+                path: props.path,
+                expected: props.expected,
+                value: props.value,
+            });
+        return false;
+    };

package/src/functional/$is_email.ts

@@ -0,0 +1,5 @@
+export function $is_email(str: string): boolean {
+    return REGEX.test(str);
+}
+const REGEX =
+    /^(([^<>()[\]\.,;:\s@\"]+(\.[^<>()[\]\.,;:\s@\"]+)*)|(\".+\"))@(([^<>()[\]\.,;:\s@\"]+\.)+[^<>()[\]\.,;:\s@\"]{2,})$/i;

package/src/functional/$is_ipv4.ts

@@ -0,0 +1,5 @@
+export function $is_ipv4(str: string): boolean {
+    return REGEX.test(str);
+}
+const REGEX =
+    /^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;

package/src/functional/$is_ipv6.ts

@@ -0,0 +1,5 @@
+export function $is_ipv6(str: string): boolean {
+    return REGEX.test(str);
+}
+const REGEX =
+    /^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/;

package/src/functional/$is_url.ts

@@ -0,0 +1,5 @@
+export function $is_url(str: string): boolean {
+    return REGEX.test(str);
+}
+const REGEX =
+    /^[a-zA-Z0-9]+:\/\/(?:www.)?[-a-zA-Z0-9@:%._+~#=]{1,256}.[a-zA-Z0-9()]{1,6}\b(?:[-a-zA-Z0-9()@:%_+.~#?&/=]*)$/;

package/src/functional/$is_uuid.ts

@@ -0,0 +1,5 @@
+export function $is_uuid(str: string): boolean {
+    return REGEX.test(str);
+}
+const REGEX =
+    /[0-9A-F]{8}-[0-9A-F]{4}-[4][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i;

package/src/functional/$join.ts

@@ -0,0 +1,50 @@
+export function $join(str: string): string {
+    return variable(str) ? `.${str}` : `[${JSON.stringify(str)}]`;
+}
+
+function variable(str: string): boolean {
+    return reserved(str) === false && /^[a-zA-Z_$][a-zA-Z_$0-9]*$/g.test(str);
+}
+
+function reserved(str: string): boolean {
+    return RESERVED.has(str);
+}
+
+const RESERVED: Set<string> = new Set([
+    "break",
+    "case",
+    "catch",
+    "class",
+    "const",
+    "continue",
+    "debugger",
+    "default",
+    "delete",
+    "do",
+    "else",
+    "enum",
+    "export",
+    "extends",
+    "false",
+    "finally",
+    "for",
+    "function",
+    "if",
+    "import",
+    "in",
+    "instanceof",
+    "new",
+    "null",
+    "return",
+    "super",
+    "switch",
+    "this",
+    "throw",
+    "true",
+    "try",
+    "typeof",
+    "var",
+    "void",
+    "while",
+    "with",
+]);

package/src/functional/$number.ts

@@ -0,0 +1,19 @@
+import { TypeGuardError } from "../TypeGuardError";
+
+export function $number(value: number): number {
+    if (!isFinite(value))
+        throw new TypeGuardError({
+            method: "typia.stringify",
+            expected: "number",
+            value,
+            message: "Error on typia.stringify(): infinite number.",
+        });
+    else if (isNaN(value))
+        throw new TypeGuardError({
+            method: "typia.stringify",
+            expected: "number",
+            value,
+            message: "Error on typia.stringify(): not a valid number.",
+        });
+    return value;
+}