typia 3.3.12 → 3.4.0-dev.20221212

package/src/programmers/internal/application_number.ts

@@ -0,0 +1,76 @@
+import { IJsonSchema } from "../../module";
+import { application_default } from "./application_default";
+
+/**
+ * @internal
+ */
+export const application_number = (
+    nullable: boolean,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.INumber => {
+    const output: IJsonSchema.INumber = {
+        type: "number",
+        nullable,
+        ...attribute,
+    };
+    for (const tag of attribute["x-typia-metaTags"] || []) {
+        // CHECK TYPE
+        if (
+            tag.kind === "type" &&
+            (tag.value === "int" || tag.value === "uint")
+        )
+            output.type = "integer";
+        // RANGE TAG
+        else if (tag.kind === "minimum") output.minimum = tag.value;
+        else if (tag.kind === "maximum") output.maximum = tag.value;
+        else if (tag.kind === "range") {
+            if (tag.minimum !== undefined)
+                if (tag.minimum.include === true)
+                    output.minimum = tag.minimum.value;
+                else output.exclusiveMinimum = tag.minimum.value;
+            if (tag.maximum !== undefined)
+                if (tag.maximum.include === true)
+                    output.maximum = tag.maximum.value;
+                else output.exclusiveMaximum = tag.maximum.value;
+        }
+        // MULTIPLE-OF
+        else if (tag.kind === "multipleOf") output.multipleOf = tag.value;
+    }
+
+    // WHEN UNSIGNED INT
+    if (
+        output.type === "integer" &&
+        (attribute["x-typia-metaTags"] || []).find(
+            (tag) => tag.kind === "type" && tag.value === "uint",
+        )
+    )
+        if (output.minimum === undefined || output.minimum < 0)
+            output.minimum = 0;
+        else if (
+            output.exclusiveMinimum === undefined ||
+            output.exclusiveMinimum < 0
+        ) {
+            delete output.exclusiveMinimum;
+            output.maximum = 0;
+        }
+
+    // DEFAULT CONFIGURATION
+    output.default = application_default(attribute)((str) => {
+        const value: number = Number(str);
+        const conditions: boolean[] = [!Number.isNaN(value)];
+        if (output.minimum !== undefined)
+            conditions.push(value >= output.minimum);
+        if (output.maximum !== undefined)
+            conditions.push(value <= output.maximum);
+        if (output.exclusiveMinimum !== undefined)
+            conditions.push(value > output.exclusiveMinimum);
+        if (output.exclusiveMaximum !== undefined)
+            conditions.push(value < output.exclusiveMaximum);
+        if (output.multipleOf !== undefined)
+            conditions.push(value % output.multipleOf === 0);
+        return conditions.every((cond) => cond);
+    })((str) => Number(str));
+
+    // RETURNS
+    return output;
+};

package/src/programmers/internal/application_object.ts

@@ -0,0 +1,103 @@
+import { CommentFactory } from "../../factories/CommentFactory";
+
+import { IJsDocTagInfo } from "../../metadata/IJsDocTagInfo";
+import { MetadataObject } from "../../metadata/MetadataObject";
+import { IJsonComponents } from "../../schemas/IJsonComponents";
+
+import { PatternUtil } from "../../utils/PatternUtil";
+
+import { IJsonSchema } from "../../module";
+import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { application_schema } from "./application_schema";
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const application_object =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    (key: string, obj: MetadataObject, nullable: boolean): void => {
+        // TEMPORARY ASSIGNMENT
+        if (components.schemas[key] !== undefined) return;
+        components.schemas[key] = {} as any;
+
+        // ITERATE PROPERTIES
+        const properties: Record<string, any> = {};
+        const patternProperties: Record<string, any> = {};
+        const additionalProperties: IJsonSchema[] = [];
+        const required: string[] = [];
+
+        for (const property of obj.properties) {
+            if (
+                property.value.functional === true &&
+                property.value.nullable === false &&
+                property.value.required === true &&
+                property.value.size() === 0
+            )
+                continue;
+
+            const key: string | null = property.key.getSoleLiteral();
+            const value: IJsonSchema | null = application_schema(options)(
+                components,
+            )(true)(property.value, {
+                deprecated:
+                    !!property.jsDocTags.find(
+                        (tag) => tag.name === "deprecated",
+                    ) || undefined,
+                title: (() => {
+                    const info: IJsDocTagInfo | undefined =
+                        property.jsDocTags.find((tag) => tag.name === "title");
+                    return info?.text?.length
+                        ? CommentFactory.generate(info.text)
+                        : undefined;
+                })(),
+                description: property.description,
+                "x-typia-metaTags": property.tags.length
+                    ? property.tags
+                    : undefined,
+                "x-typia-jsDocTags": property.jsDocTags.length
+                    ? property.jsDocTags
+                    : undefined,
+                "x-typia-required": property.value.required,
+            });
+
+            if (value === null) continue;
+            else if (key !== null) {
+                properties[key] = value;
+                if (property.value.required === true) required.push(key);
+            } else {
+                const pattern: string = metadata_to_pattern(true)(property.key);
+                if (
+                    options.purpose === "swagger" ||
+                    pattern === PatternUtil.STRING
+                )
+                    additionalProperties.push(value);
+                else patternProperties[pattern] = value;
+            }
+        }
+
+        const schema: IJsonComponents.IObject = {
+            $id:
+                options.purpose === "ajv"
+                    ? options.prefix + "/" + key
+                    : undefined,
+            $recursiveAnchor:
+                (options.purpose === "ajv" && obj.recursive) || undefined,
+            type: "object",
+            properties,
+            patternProperties: Object.keys(patternProperties).length
+                ? patternProperties
+                : undefined,
+            additionalProperties: additionalProperties.length
+                ? additionalProperties.length === 1
+                    ? additionalProperties[0]
+                    : { oneOf: additionalProperties }
+                : undefined,
+            nullable,
+            required: required.length ? required : undefined,
+            description: obj.description,
+            "x-typia_jsDocTags": obj.jsDocTags,
+        };
+        components.schemas[key] = schema;
+    };

package/src/programmers/internal/application_schema.ts

@@ -0,0 +1,221 @@
+import { Metadata } from "../../metadata/Metadata";
+import { MetadataConstant } from "../../metadata/MetadataConstant";
+import { IJsonComponents } from "../../schemas/IJsonComponents";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { ArrayUtil } from "../../utils/ArrayUtil";
+
+import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { AtomicPredicator } from "../helpers/AtomicPredicator";
+import { application_array } from "./application_array";
+import { application_boolean } from "./application_boolean";
+import { application_constant } from "./application_constant";
+import { application_native } from "./application_native";
+import { application_number } from "./application_number";
+import { application_object } from "./application_object";
+import { application_string } from "./application_string";
+import { application_templates } from "./application_templates";
+import { application_tuple } from "./application_tuple";
+
+/**
+ * @internal
+ */
+export const application_schema =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    <BlockNever extends boolean>(blockNever: BlockNever) =>
+    (
+        meta: Metadata,
+        attribute: IJsonSchema.IAttribute,
+    ): BlockNever extends true ? IJsonSchema | null : IJsonSchema => {
+        // VULNERABLE CASE
+        if (meta.any === true) return {};
+        else if (meta.nullable && meta.empty())
+            return { type: "null", ...attribute };
+
+        //----
+        // GATHER UNION SCHEMAS
+        //----
+        const union: IJsonSchema[] = [];
+
+        // toJSON() METHOD
+        if (meta.resolved !== null) {
+            const resolved = application_schema(options)(components)(
+                blockNever,
+            )(meta.resolved, attribute);
+            if (resolved !== null) union.push(resolved);
+        }
+
+        // ATOMIC TYPES
+        if (meta.templates.length && AtomicPredicator.template(meta))
+            union.push(application_templates(meta, attribute));
+        for (const constant of meta.constants) {
+            if (constant.type === "string" && meta.templates.length) continue;
+            else if (!AtomicPredicator.constant(meta)(constant.type)) continue;
+            union.push(
+                application_constant(constant, meta.nullable, attribute),
+            );
+        }
+        for (const type of meta.atomics) {
+            union.push(
+                type === "string"
+                    ? application_string(meta, attribute)
+                    : type === "boolean"
+                    ? application_boolean(meta.nullable, attribute)
+                    : application_number(meta.nullable, attribute),
+            );
+        }
+
+        // ARRAY
+        for (const schema of meta.arrays.values())
+            union.push(
+                application_array(options)(components)(
+                    schema,
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+
+        // TUPLE
+        for (const items of meta.tuples)
+            if (
+                options.purpose === "ajv" &&
+                items.every((i) => i.rest === null)
+            )
+                union.push(
+                    application_tuple(options)(components)(
+                        items,
+                        meta.nullable,
+                        attribute,
+                    ),
+                );
+            else {
+                // SWAGGER DOES NOT SUPPORT TUPLE TYPE YET
+                const merged: Metadata = items.reduce((x, y) =>
+                    merge_metadata(x, y),
+                );
+                union.push(
+                    application_array(options)(components)(
+                        merged,
+                        merged?.nullable || false,
+                        attribute,
+                    ),
+                );
+            }
+
+        // NATIVES
+        for (const native of meta.natives)
+            union.push(
+                application_native(options)(components)(native)(
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+        if (meta.sets.length)
+            union.push(
+                application_native(options)(components)(`Set`)(
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+        if (meta.maps.length)
+            union.push(
+                application_native(options)(components)(`Map`)(
+                    meta.nullable,
+                    attribute,
+                ),
+            );
+
+        // OBJECT
+        for (const obj of meta.objects) {
+            const key: string = obj.name + (meta.nullable ? ".Nullable" : "");
+            application_object(options)(components)(key, obj, meta.nullable);
+            union.push(
+                (options.purpose === "ajv" && obj.recursive
+                    ? recursive
+                    : reference)(`${options.prefix}/${key}`, attribute),
+            );
+        }
+
+        //----
+        // RETURNS
+        //----
+        if (union.length === 0) return blockNever === true ? null! : {};
+        else if (union.length === 1) return union[0]!;
+        return { oneOf: union, ...attribute };
+    };
+
+/**
+ * @internal
+ */
+const reference = (
+    $ref: string,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IReference => ({
+    $ref,
+    ...attribute,
+});
+
+/**
+ * @internal
+ */
+const recursive = (
+    $recursiveRef: string,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IRecursiveReference => ({
+    $recursiveRef,
+    ...attribute,
+});
+
+/**
+ * @internal
+ * @todo: not perfect
+ */
+function merge_metadata(x: Metadata, y: Metadata): Metadata {
+    const output: Metadata = Metadata.create({
+        any: x.any || y.any,
+        nullable: x.nullable || y.nullable,
+        required: x.required && y.required,
+        functional: x.functional || y.functional,
+
+        resolved:
+            x.resolved !== null && y.resolved !== null
+                ? merge_metadata(x.resolved, y.resolved)
+                : x.resolved || y.resolved,
+        atomics: [...new Set([...x.atomics, ...y.atomics])],
+        constants: [...x.constants],
+        templates: x.templates.slice(),
+
+        rest: null,
+        arrays: x.arrays.slice(),
+        tuples: x.tuples.slice(),
+        objects: x.objects.slice(),
+
+        natives: [...new Set([...x.natives, ...y.natives])],
+        sets: x.sets.slice(),
+        maps: x.maps.slice(),
+    });
+    for (const constant of y.constants) {
+        const target: MetadataConstant = ArrayUtil.take(
+            output.constants,
+            (elem) => elem.type === constant.type,
+            () => ({
+                type: constant.type,
+                values: [],
+            }),
+        );
+        for (const value of constant.values)
+            ArrayUtil.add(target.values, value);
+    }
+    for (const array of y.arrays)
+        ArrayUtil.set(output.arrays, array, (elem) => elem.getName());
+    for (const obj of y.objects)
+        ArrayUtil.set(output.objects, obj, (elem) => elem.name);
+
+    if (x.rest !== null)
+        ArrayUtil.set(output.arrays, x.rest, (elem) => elem.getName());
+    if (y.rest !== null)
+        ArrayUtil.set(output.arrays, y.rest, (elem) => elem.getName());
+
+    return output;
+}

package/src/programmers/internal/application_string.ts

@@ -0,0 +1,49 @@
+import { Metadata } from "../../metadata/Metadata";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { application_default_string } from "./application_default_string";
+
+/**
+ * @internal
+ */
+export const application_string = (
+    meta: Metadata,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IString => {
+    const output: IJsonSchema.IString = {
+        type: "string",
+        nullable: meta.nullable,
+        ...attribute,
+    };
+
+    // FORMAT TAG OF METADATA
+    const formatJsdocTag = attribute["x-typia-jsDocTags"]?.find(
+        (tag) => tag.name === "format",
+    );
+    if (formatJsdocTag?.text?.length)
+        output.format = formatJsdocTag?.text.map((t) => t.text).join(" ");
+
+    // REGULAR TAGS COMPATIBLE WITH JSON-SCHEMA
+    for (const tag of attribute["x-typia-metaTags"] || []) {
+        // RANGE
+        if (tag.kind === "minLength") output.minLength = tag.value;
+        else if (tag.kind === "maxLength") output.maxLength = tag.value;
+        else if (tag.kind === "length") {
+            if (tag.minimum !== undefined)
+                output.minLength =
+                    tag.minimum.value + (tag.minimum.include ? 0 : 1);
+            if (tag.maximum !== undefined)
+                output.maxLength =
+                    tag.maximum.value - (tag.maximum.include ? 0 : 1);
+        }
+        // FORMAT AND PATTERN
+        else if (tag.kind === "format") output.format = tag.value;
+        else if (tag.kind === "pattern") output.pattern = tag.value;
+    }
+
+    // DEFAULT CONFIGURATION
+    output.default = application_default_string(meta, attribute)(output);
+
+    // RETURNS
+    return output;
+};

package/src/programmers/internal/application_templates.ts

@@ -0,0 +1,27 @@
+import { Metadata } from "../../metadata/Metadata";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { application_default_string } from "./application_default_string";
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const application_templates = (
+    meta: Metadata,
+    attribute: IJsonSchema.IAttribute,
+): IJsonSchema.IString => {
+    // CONSTRUCT PATTERN
+    const output: IJsonSchema.IString = {
+        type: "string",
+        nullable: meta.nullable,
+        ...attribute,
+    };
+    output.pattern = metadata_to_pattern(true)(meta);
+
+    // DEFAULT VALUE
+    output.default = application_default_string(meta, attribute)(output);
+
+    // RETURNS
+    return output;
+};

package/src/programmers/internal/application_tuple.ts

@@ -0,0 +1,25 @@
+import { Metadata } from "../../metadata/Metadata";
+import { IJsonComponents } from "../../schemas/IJsonComponents";
+import { IJsonSchema } from "../../schemas/IJsonSchema";
+
+import { ApplicationProgrammer } from "../ApplicationProgrammer";
+import { application_schema } from "./application_schema";
+
+/**
+ * @internal
+ */
+export const application_tuple =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    (
+        items: Array<Metadata>,
+        nullable: boolean,
+        attribute: IJsonSchema.IAttribute,
+    ): IJsonSchema.ITuple => ({
+        type: "array",
+        items: items.map((meta) =>
+            application_schema(options)(components)(false)(meta, attribute),
+        ),
+        nullable,
+        ...attribute,
+    });

package/src/programmers/internal/check_array.ts

@@ -0,0 +1,44 @@
+import ts from "typescript";
+
+import { ExpressionFactory } from "../../factories/ExpressionFactory";
+import { IdentifierFactory } from "../../factories/IdentifierFactory";
+
+import { IMetadataTag } from "../../metadata/IMetadataTag";
+
+import { check_length } from "./check_length";
+
+/**
+ * @internal
+ */
+export function check_array(
+    input: ts.Expression,
+    tagList: IMetadataTag[],
+): ts.Expression {
+    const conditions: ts.Expression[] = [ExpressionFactory.isArray(input)];
+
+    // CHECK TAGS
+    for (const tag of tagList)
+        if (tag.kind === "minItems")
+            conditions.push(
+                ts.factory.createLessThanEquals(
+                    ts.factory.createNumericLiteral(tag.value),
+                    IdentifierFactory.join(input, "length"),
+                ),
+            );
+        else if (tag.kind === "maxItems")
+            conditions.push(
+                ts.factory.createGreaterThanEquals(
+                    ts.factory.createNumericLiteral(tag.value),
+                    IdentifierFactory.join(input, "length"),
+                ),
+            );
+        else if (tag.kind === "items")
+            check_length(
+                conditions,
+                IdentifierFactory.join(input, "length"),
+                tag,
+            );
+
+    // COMBINATION
+    return conditions.reduce((x, y) => ts.factory.createLogicalAnd(x, y));
+}

package/src/programmers/internal/check_dynamic_properties.ts

@@ -0,0 +1,146 @@
+import ts from "typescript";
+
+import { IdentifierFactory } from "../../factories/IdentifierFactory";
+import { StatementFactory } from "../../factories/StatementFactory";
+
+import { IExpressionEntry } from "../helpers/IExpressionEntry";
+import { check_everything } from "./check_everything";
+import { check_object } from "./check_object";
+import { metadata_to_pattern } from "./metadata_to_pattern";
+
+/**
+ * @internal
+ */
+export const check_dynamic_properties =
+    (props: check_object.IProps) =>
+    (
+        regular: IExpressionEntry[],
+        dynamic: IExpressionEntry[],
+    ): ts.Expression => {
+        const criteria = props.entries
+            ? ts.factory.createCallExpression(props.entries, undefined, [
+                  ts.factory.createCallExpression(
+                      ts.factory.createIdentifier("Object.keys"),
+                      undefined,
+                      [ts.factory.createIdentifier("input")],
+                  ),
+                  check_dynamic_property(props)(regular, dynamic),
+              ])
+            : ts.factory.createCallExpression(
+                  IdentifierFactory.join(
+                      ts.factory.createCallExpression(
+                          ts.factory.createIdentifier("Object.keys"),
+                          undefined,
+                          [ts.factory.createIdentifier("input")],
+                      ),
+                      props.assert ? "every" : "map",
+                  ),
+                  undefined,
+                  [check_dynamic_property(props)(regular, dynamic)],
+              );
+        return (props.halt || ((elem) => elem))(
+            props.assert ? criteria : check_everything(criteria),
+        );
+    };
+
+const check_dynamic_property =
+    (props: check_object.IProps) =>
+    (regular: IExpressionEntry[], dynamic: IExpressionEntry[]) => {
+        //----
+        // IF CONDITIONS
+        //----
+        // PREPARE ASSETS
+        const key = ts.factory.createIdentifier("key");
+        const value = ts.factory.createIdentifier("value");
+
+        const statements: ts.Statement[] = [];
+        const add = (exp: ts.Expression, output: ts.Expression) =>
+            statements.push(
+                ts.factory.createIfStatement(
+                    exp,
+                    ts.factory.createReturnStatement(output),
+                ),
+            );
+
+        // GATHER CONDITIONS
+        if (props.equals === true && regular.length)
+            add(is_regular_property(regular), props.positive);
+        statements.push(
+            StatementFactory.constant(
+                "value",
+                ts.factory.createIdentifier("input[key]"),
+            ),
+        );
+        add(
+            ts.factory.createStrictEquality(
+                ts.factory.createIdentifier("undefined"),
+                value,
+            ),
+            props.positive,
+        );
+        for (const entry of dynamic)
+            add(
+                ts.factory.createCallExpression(
+                    ts.factory.createIdentifier(
+                        `RegExp(/${metadata_to_pattern(true)(
+                            entry.key,
+                        )}/).test`,
+                    ),
+                    undefined,
+                    [key],
+                ),
+                entry.expression,
+            );
+
+        //----
+        // FUNCTION BODY
+        //----
+        // CLOSURE BLOCK
+        const block: ts.Block = ts.factory.createBlock(
+            [
+                ...statements,
+                ts.factory.createReturnStatement(
+                    props.equals === true
+                        ? props.superfluous(value)
+                        : props.positive,
+                ),
+            ],
+            true,
+        );
+
+        // RETURNS
+        return ts.factory.createArrowFunction(
+            undefined,
+            undefined,
+            [IdentifierFactory.parameter("key")],
+            undefined,
+            undefined,
+            block,
+        );
+    };
+
+const is_regular_property = (regular: IExpressionEntry[]) =>
+    ts.factory.createCallExpression(
+        IdentifierFactory.join(
+            ts.factory.createArrayLiteralExpression(
+                regular.map((entry) =>
+                    ts.factory.createStringLiteral(entry.key.getSoleLiteral()!),
+                ),
+            ),
+            "some",
+        ),
+        undefined,
+        [
+            ts.factory.createArrowFunction(
+                undefined,
+                undefined,
+                [IdentifierFactory.parameter("prop")],
+                undefined,
+                undefined,
+                ts.factory.createStrictEquality(
+                    ts.factory.createIdentifier("key"),
+                    ts.factory.createIdentifier("prop"),
+                ),
+            ),
+        ],
+    );