typia 3.3.12 → 3.4.0-dev.20221212

package/src/metadata/Metadata.ts

@@ -0,0 +1,477 @@
+import { Atomic } from "../typings/Atomic";
+import { ClassProperties } from "../typings/ClassProperties";
+
+import { IMetadata } from "./IMetadata";
+import { IMetadataObject } from "./IMetadataObject";
+import { MetadataConstant } from "./MetadataConstant";
+import { MetadataObject } from "./MetadataObject";
+import { MetadataProperty } from "./MetadataProperty";
+
+export class Metadata {
+    public readonly any: boolean;
+    public readonly required: boolean;
+    public readonly nullable: boolean;
+    public readonly functional: boolean;
+
+    public readonly resolved: Metadata | null;
+    public readonly atomics: Atomic.Literal[];
+    public readonly constants: MetadataConstant[];
+    public readonly templates: Metadata[][];
+
+    public readonly rest: Metadata | null;
+    public readonly arrays: Metadata[];
+    public readonly tuples: Metadata[][];
+    public readonly objects: MetadataObject[];
+
+    public readonly natives: string[];
+    public readonly sets: Metadata[];
+    public readonly maps: Metadata.Entry[];
+
+    /**
+     * @internal
+     */
+    private name_: string | undefined = undefined;
+
+    /**
+     * @internal
+     */
+    private parent_resolved_: boolean = false;
+
+    /**
+     * @internal
+     */
+    public union_index?: number;
+
+    /* -----------------------------------------------------------
+        CONSTRUCTORS
+    ----------------------------------------------------------- */
+    /**
+     * @hidden
+     */
+    private constructor(props: ClassProperties<Metadata>) {
+        this.any = props.any;
+        this.required = props.required;
+        this.nullable = props.nullable;
+        this.functional = props.functional;
+
+        this.resolved = props.resolved;
+        this.atomics = props.atomics;
+        this.constants = props.constants;
+        this.templates = props.templates;
+
+        this.rest = props.rest;
+        this.arrays = props.arrays;
+        this.tuples = props.tuples;
+        this.objects = props.objects;
+
+        this.natives = props.natives;
+        this.sets = props.sets;
+        this.maps = props.maps;
+    }
+
+    /**
+     * @internal
+     */
+    public static create(props: ClassProperties<Metadata>): Metadata {
+        return new Metadata(props);
+    }
+
+    /**
+     * @internal
+     */
+    public static initialize(parentResolved: boolean = false): Metadata {
+        const meta: Metadata = this.create({
+            any: false,
+            nullable: false,
+            required: true,
+            functional: false,
+
+            resolved: null,
+            constants: [],
+            atomics: [],
+            templates: [],
+            arrays: [],
+            tuples: [],
+            objects: [],
+
+            rest: null,
+            natives: [],
+            sets: [],
+            maps: [],
+        });
+        meta.parent_resolved_ = parentResolved;
+        return meta;
+    }
+
+    public toJSON(): IMetadata {
+        return {
+            any: this.any,
+            required: this.required,
+            nullable: this.nullable,
+            functional: this.functional,
+
+            atomics: this.atomics.slice(),
+            constants: JSON.parse(JSON.stringify(this.constants)),
+            templates: this.templates.map((tpl) =>
+                tpl.map((meta) => meta.toJSON()),
+            ),
+            resolved: this.resolved ? this.resolved.toJSON() : null,
+
+            rest: this.rest ? this.rest.toJSON() : null,
+            arrays: this.arrays.map((meta) => meta.toJSON()),
+            tuples: this.tuples.map((meta) =>
+                meta.map((meta) => meta.toJSON()),
+            ),
+            objects: this.objects.map((obj) => obj.name),
+
+            natives: this.natives.slice(),
+            sets: this.sets.map((meta) => meta.toJSON()),
+            maps: this.maps.map((entry) => ({
+                key: entry.key.toJSON(),
+                value: entry.value.toJSON(),
+            })),
+        };
+    }
+
+    public static from(meta: IMetadata, objects: IMetadataObject[]): Metadata {
+        const dict: Map<string, MetadataObject> = new Map();
+        for (const obj of objects)
+            dict.set(obj.name, MetadataObject._From_without_properties(obj));
+
+        for (const obj of objects) {
+            const initialized = dict.get(obj.name)!;
+            initialized.properties.push(
+                ...obj.properties.map((prop) =>
+                    MetadataProperty._From(prop, dict),
+                ),
+            );
+        }
+        return this._From(meta, dict);
+    }
+
+    /**
+     * @internal
+     */
+    public static _From(
+        meta: IMetadata,
+        objects: Map<string, MetadataObject>,
+    ): Metadata {
+        return this.create({
+            any: meta.any,
+            required: meta.required,
+            nullable: meta.nullable,
+            functional: meta.functional,
+
+            constants: JSON.parse(JSON.stringify(meta.constants)),
+            atomics: meta.atomics.slice(),
+            templates: meta.templates.map((tpl) =>
+                tpl.map((meta) => this._From(meta, objects)),
+            ),
+            resolved: meta.resolved ? this._From(meta.resolved, objects) : null,
+
+            rest: meta.rest ? this._From(meta.rest, objects) : null,
+            arrays: meta.arrays.map((meta) => this._From(meta, objects)),
+            tuples: meta.tuples.map((tuple) =>
+                tuple.map((meta) => this._From(meta, objects)),
+            ),
+            objects: meta.objects.map((name) => {
+                const found = objects.get(name);
+                if (found === undefined)
+                    throw new Error(
+                        `Error on Metadata.from(): failed to find object "${name}".`,
+                    );
+                return found;
+            }),
+
+            natives: meta.natives.slice(),
+            sets: meta.sets.map((meta) => this._From(meta, objects)),
+            maps: meta.maps.map((entry) => ({
+                key: this._From(entry.key, objects),
+                value: this._From(entry.value, objects),
+            })),
+        });
+    }
+
+    /* -----------------------------------------------------------
+        ACCESSORS
+    ----------------------------------------------------------- */
+    public getName(): string {
+        this.name_ ||= getName(this);
+        return this.name_;
+    }
+
+    public empty(): boolean {
+        return this.bucket() === 0 || this.size() === 0;
+    }
+    public size(): number {
+        return (
+            (this.resolved ? 1 : 0) +
+            (this.functional ? 1 : 0) +
+            this.templates.length +
+            this.atomics.length +
+            this.constants
+                .map((c) => c.values.length)
+                .reduce((x, y) => x + y, 0) +
+            (this.rest ? this.rest.size() : 0) +
+            this.arrays.length +
+            this.tuples.length +
+            this.objects.length +
+            this.natives.length +
+            this.sets.length +
+            this.maps.length
+        );
+    }
+    public bucket(): number {
+        return (
+            (this.resolved ? 1 : 0) +
+            (this.functional ? 1 : 0) +
+            (this.templates.length ? 1 : 0) +
+            (this.atomics.length ? 1 : 0) +
+            (this.constants.length ? 1 : 0) +
+            (this.rest ? this.rest.size() : 0) +
+            (this.arrays.length ? 1 : 0) +
+            (this.tuples.length ? 1 : 0) +
+            (this.objects.length ? 1 : 0) +
+            (this.natives.length ? 1 : 0) +
+            (this.sets.length ? 1 : 0) +
+            (this.maps.length ? 1 : 0)
+        );
+    }
+    public isConstant(): boolean {
+        return this.bucket() === (this.constants.length ? 1 : 0);
+    }
+
+    /**
+     * @internal
+     */
+    public isUnionBucket(): boolean {
+        const size: number = this.bucket();
+        const emended: number = this.constants.length ? size - 1 : size;
+        return emended > 1;
+    }
+
+    /**
+     * @internal
+     */
+    public getSoleLiteral(): string | null {
+        if (
+            this.size() === 1 &&
+            this.constants.length === 1 &&
+            this.constants[0]!.type === "string" &&
+            this.constants[0]!.values.length === 1
+        )
+            return this.constants[0]!.values[0] as string;
+        else return null;
+    }
+
+    /**
+     * @internal
+     */
+    public isSoleLiteral(): boolean {
+        return this.getSoleLiteral() !== null;
+    }
+
+    /**
+     * @internal
+     */
+    public isParentResolved(): boolean {
+        return this.parent_resolved_;
+    }
+}
+export namespace Metadata {
+    export function intersects(
+        x: Metadata,
+        y: Metadata,
+        deep: boolean,
+    ): boolean {
+        // CHECK ANY & OPTIONAL
+        if (x.any || y.any) return true;
+        if (x.required === false && false === y.required) return true;
+        if (x.nullable === true && true === y.nullable) return true;
+
+        //----
+        // INSTANCES
+        //----
+        // ARRAYS AND OBJECTS
+        if (deep === true) {
+            for (const xa of x.arrays)
+                for (const ya of y.arrays)
+                    if (intersects(xa, ya, deep)) {
+                        return true;
+                    }
+            for (const xo of x.objects)
+                for (const yo of y.objects)
+                    if (MetadataObject.intersects(xo, yo)) {
+                        return true;
+                    }
+        } else {
+            if (x.arrays.length && y.arrays.length) return true;
+            if (x.objects.length && y.objects.length) return true;
+        }
+
+        // TUPLES
+        for (const xt of x.tuples)
+            for (const yt of y.tuples)
+                if (
+                    xt
+                        .slice(0, Math.min(xt.length, yt.length))
+                        .some((xv, i) => intersects(xv, yt[i]!, deep))
+                )
+                    return true;
+
+        //----
+        // VALUES
+        //----
+        // ATOMICS
+        for (const atomic of x.atomics)
+            if (y.atomics.includes(atomic)) return true;
+
+        // CONSTANTS
+        for (const constant of x.constants) {
+            const opposite: MetadataConstant | undefined = y.constants.find(
+                (elem) => elem.type === constant.type,
+            );
+            if (opposite === undefined) continue;
+
+            const values: Set<any> = new Set([
+                ...constant.values,
+                ...opposite.values,
+            ]);
+            if (values.size !== constant.values.length + opposite.values.length)
+                return true;
+        }
+
+        // FUNCTIONAL
+        if (x.functional === true && y.functional === true) return true;
+
+        return false;
+    }
+
+    export function covers(x: Metadata, y: Metadata): boolean {
+        // CHECK ANY
+        if (x.any) return true;
+        else if (y.any) return false;
+
+        //----
+        // INSTANCES
+        //----
+        // ARRAYS
+        for (const ya of y.arrays)
+            if (x.arrays.some((xa) => covers(xa, ya) === true) === false)
+                return false;
+
+        // OBJECTS
+        for (const yo of y.objects)
+            if (x.objects.some((xo) => MetadataObject.covers(xo, yo)) === false)
+                return false;
+
+        // TUPLES
+        for (const yt of y.tuples)
+            if (
+                x.tuples.some(
+                    (xt) =>
+                        xt.length >= yt.length &&
+                        xt
+                            .slice(yt.length)
+                            .every((xv, i) => covers(xv, yt[i]!)),
+                ) === false
+            )
+                return false;
+
+        // NATIVES
+
+        // SETS
+        for (const ys of y.sets)
+            if (x.sets.some((xs) => covers(xs, ys)) === false) return false;
+
+        //----
+        // VALUES
+        //----
+        // ATOMICS
+        if (y.atomics.some((atomic) => x.atomics.includes(atomic) === false))
+            return false;
+
+        // CONSTANTS
+        for (const yc of y.constants) {
+            const xc: MetadataConstant | undefined = x.constants.find(
+                (elem) => elem.type === yc.type,
+            );
+            if (xc === undefined) return false;
+            else if (
+                (yc.values as number[]).some(
+                    (yv) => xc.values.includes(yv as never) === false,
+                )
+            )
+                return false;
+        }
+
+        // FUNCTIONAL
+        if (x.functional === false && y.functional) return false;
+
+        // SUCCESS
+        return true;
+    }
+}
+
+function getName(metadata: Metadata): string {
+    if (metadata.any === true) return "any";
+
+    const elements: string[] = [];
+
+    // OPTIONAL
+    if (metadata.nullable === true) elements.push("null");
+    if (metadata.required === false) elements.push("undefined");
+
+    // ATOMIC
+    for (const type of metadata.atomics) {
+        elements.push(type);
+    }
+    for (const constant of metadata.constants)
+        for (const value of constant.values)
+            elements.push(JSON.stringify(value));
+    for (const template of metadata.templates)
+        elements.push(
+            "`" +
+                template
+                    .map((child) =>
+                        child.isConstant() && child.size() === 1
+                            ? child.constants[0]!.values[0]!
+                            : `$\{${child.getName()}\}`,
+                    )
+                    .join("")
+                    .split("`")
+                    .join("\\`") +
+                "`",
+        );
+
+    // ARRAY
+    if (metadata.rest !== null) elements.push(`...${metadata.rest.getName()}`);
+    for (const tuple of metadata.tuples)
+        elements.push(`[${tuple.map((elem) => elem.getName()).join(", ")}]`);
+    for (const array of metadata.arrays)
+        elements.push(`Array<${array.getName()}>`);
+
+    // OBJECT
+    for (const object of metadata.objects)
+        elements.push(`Resolve<${object.name}>`);
+    if (metadata.resolved !== null) elements.push(metadata.resolved.getName());
+
+    // NATIVES
+    for (const native of metadata.natives) elements.push(native);
+    for (const set of metadata.sets) elements.push(`Set<${set.getName()}>`);
+    for (const map of metadata.maps)
+        elements.push(`Map<${map.key.getName()}, ${map.value.getName()}>`);
+
+    // RETURNS
+    if (elements.length === 0) return "unknown";
+    else if (elements.length === 1) return elements[0]!;
+
+    elements.sort();
+    return `(${elements.join(" | ")})`;
+}
+export namespace Metadata {
+    export interface Entry {
+        key: Metadata;
+        value: Metadata;
+    }
+}

package/src/metadata/MetadataConstant.ts

@@ -0,0 +1,3 @@
+import { IMetadataConstant } from "./IMetadataConstant";
+
+export import MetadataConstant = IMetadataConstant;

package/src/metadata/MetadataObject.ts

@@ -0,0 +1,131 @@
+import { ClassProperties } from "../typings/ClassProperties";
+
+import { IJsDocTagInfo } from "./IJsDocTagInfo";
+import { IMetadataObject } from "./IMetadataObject";
+import { MetadataProperty } from "./MetadataProperty";
+
+export class MetadataObject {
+    public readonly name: string;
+    public readonly properties: Array<MetadataProperty>;
+    public readonly description: string | undefined;
+    public readonly jsDocTags: IJsDocTagInfo[];
+
+    /**
+     * @internal
+     */
+    public readonly index: number;
+
+    /**
+     * @internal
+     */
+    public validated: boolean;
+
+    /**
+     * @internal
+     */
+    public recursive: boolean;
+
+    /**
+     * @internal
+     */
+    public nullables: boolean[] = [];
+
+    /* -----------------------------------------------------------
+        CONSTRUCTORS
+    ----------------------------------------------------------- */
+    /**
+     * @hidden
+     */
+    private constructor(props: ClassProperties<MetadataObject>) {
+        this.name = props.name;
+        this.properties = props.properties;
+        this.description = props.description;
+        this.jsDocTags = props.jsDocTags;
+
+        this.index = props.index;
+        this.validated = props.validated;
+        this.recursive = false;
+        this.nullables = [];
+    }
+
+    /**
+     * @internal
+     */
+    public static create(props: ClassProperties<MetadataObject>) {
+        return new MetadataObject(props);
+    }
+
+    /**
+     * @internal
+     */
+    public static _From_without_properties(
+        obj: IMetadataObject,
+    ): MetadataObject {
+        return this.create({
+            name: obj.name,
+            properties: [],
+            description: obj.description,
+            jsDocTags: obj.jsDocTags,
+
+            index: obj.index,
+            validated: obj.validated,
+            recursive: obj.recursive,
+            nullables: obj.nullables.slice(),
+        });
+    }
+
+    /**
+     * @internal
+     */
+    public _Is_simple(): boolean {
+        return (
+            this.properties.length < 4 &&
+            this.properties.every(
+                (property) =>
+                    property.key.isSoleLiteral() &&
+                    property.value.size() === 1 &&
+                    property.value.atomics.length === 1 &&
+                    property.value.nullable === false &&
+                    property.value.required === true,
+            )
+        );
+    }
+
+    public toJSON(): IMetadataObject {
+        return {
+            name: this.name,
+            properties: this.properties.map((property) => property.toJSON()),
+            description: this.description,
+            jsDocTags: this.jsDocTags,
+
+            index: this.index,
+            validated: this.validated,
+            recursive: this.recursive,
+            nullables: this.nullables.slice(),
+        };
+    }
+}
+
+/**
+ * @internal
+ */
+export namespace MetadataObject {
+    export function intersects(x: MetadataObject, y: MetadataObject): boolean {
+        return x.properties.some(
+            (prop) =>
+                y.properties.find((oppo) => prop.key === oppo.key) !==
+                undefined,
+        );
+    }
+
+    export function covers(x: MetadataObject, y: MetadataObject): boolean {
+        return (
+            x.properties.length >= y.properties.length &&
+            x.properties.every(
+                (prop) =>
+                    y.properties.find((oppo) => prop.key === oppo.key) !==
+                    undefined,
+            )
+        );
+    }
+}

package/src/metadata/MetadataProperty.ts

@@ -0,0 +1,64 @@
+import { ClassProperties } from "../typings/ClassProperties";
+
+import { IJsDocTagInfo } from "./IJsDocTagInfo";
+import { IMetadataProperty } from "./IMetadataProperty";
+import { IMetadataTag } from "./IMetadataTag";
+import { Metadata } from "./Metadata";
+import { MetadataObject } from "./MetadataObject";
+
+export class MetadataProperty {
+    public readonly key: Metadata;
+    public readonly value: Metadata;
+    public readonly description: string | undefined;
+    public readonly tags: IMetadataTag[];
+    public readonly jsDocTags: IJsDocTagInfo[];
+
+    /* -----------------------------------------------------------
+        CONSTRUCTORS
+    ----------------------------------------------------------- */
+    /**
+     * @hidden
+     */
+    private constructor(props: ClassProperties<MetadataProperty>) {
+        this.key = props.key;
+        this.value = props.value;
+        this.description = props.description;
+        this.tags = props.tags;
+        this.jsDocTags = props.jsDocTags;
+    }
+
+    /**
+     * @internal
+     */
+    public static create(
+        props: ClassProperties<MetadataProperty>,
+    ): MetadataProperty {
+        return new MetadataProperty(props);
+    }
+
+    /**
+     * @internal
+     */
+    public static _From(
+        property: IMetadataProperty,
+        objects: Map<string, MetadataObject>,
+    ) {
+        return this.create({
+            key: Metadata._From(property.key, objects),
+            value: Metadata._From(property.value, objects),
+            description: property.description,
+            tags: property.tags.slice(),
+            jsDocTags: property.jsDocTags.slice(),
+        });
+    }
+
+    public toJSON(): IMetadataProperty {
+        return {
+            key: this.key.toJSON(),
+            value: this.value.toJSON(),
+            description: this.description,
+            tags: this.tags,
+            jsDocTags: this.jsDocTags,
+        };
+    }
+}