typia 3.8.4 → 4.0.0-dev.20230502

package/src/programmers/MessageProgrammer.ts

@@ -0,0 +1,126 @@
+import ts from "typescript";
+
+import { MetadataCollection } from "../factories/MetadataCollection";
+import { ProtocolFactory } from "../factories/ProtocolFactory";
+
+import { Metadata } from "../metadata/Metadata";
+
+import { IProject } from "../transformers/IProject";
+
+import { Escaper } from "../utils/Escaper";
+import { MapUtil } from "../utils/MapUtil";
+import { NameEncoder } from "../utils/NameEncoder";
+
+import { IProtocolMap } from "../messages/IProtocolMap";
+import { IProtocolMessage } from "../messages/IProtocolMessage";
+
+export namespace MessageProgrammer {
+    export const generate =
+        ({ checker }: IProject) =>
+        (type: ts.Type) => {
+            // PARSE TARGET TYPE
+            const collection: MetadataCollection = new MetadataCollection();
+            const metadata: Metadata =
+                ProtocolFactory.metadata(checker)(collection)(type);
+
+            // CONVERT TO PROTOCOL MESSAGES
+            const dict: Map<string, IProtocolMessage> = new Map();
+            ProtocolFactory.generate(collection)(dict)(metadata);
+
+            // STRINGIFY
+            const hierarchies: Map<string, Hierarchy> = new Map();
+            for (const msg of dict.values()) emplace(hierarchies)(msg);
+
+            const content: string =
+                `syntax = "proto3";\n\n` +
+                [...hierarchies.values()]
+                    .map((hier) => stringify(hier))
+                    .join("\n\n");
+
+            // RETURNS
+            return ts.factory.createStringLiteral(content);
+        };
+
+    const stringify = (hierarchy: Hierarchy): string => {
+        const { key, message, children } = hierarchy;
+        let index: number = 1;
+
+        const elements: string[] = [`message ${NameEncoder.encode(key)} {`];
+        if (message !== null)
+            elements.push(
+                ...message.properties.map((property) => {
+                    const key: string =
+                        Escaper.variable(property.key) &&
+                        property.key.indexOf("$") === -1
+                            ? property.key
+                            : `v${index + 1}`;
+                    if (property.oneOf.length === 1)
+                        return [
+                            TAB,
+                            property.required ? "" : "optional ",
+                            property.repeated ? "repeated " : "",
+                            getTypeName(property.oneOf[0]!.type) + " ",
+                            key,
+                            " = ",
+                            `${index++};`,
+                        ].join("");
+                    return (
+                        `${TAB}oneof ${key} {\n` +
+                        property.oneOf
+                            .map(
+                                (o, i) =>
+                                    `${TAB}${TAB}${getTypeName(
+                                        o.type,
+                                    )} ${key}_o${i} = ${index++};`,
+                            )
+                            .join("\n") +
+                        `\n${TAB}}`
+                    );
+                }),
+            );
+        if (message !== null && children.size) elements.push("\n");
+        if (children.size)
+            elements.push(
+                [...children.values()]
+                    .map((child) => stringify(child))
+                    .map((body) =>
+                        body
+                            .split("\n")
+                            .map((line) => `${TAB}${line}`)
+                            .join("\n"),
+                    )
+                    .join("\n\n"),
+            );
+        elements.push("}");
+
+        return elements.join("\n");
+    };
+
+    const emplace =
+        (dict: Map<string, Hierarchy>) => (message: IProtocolMessage) => {
+            const accessors: string[] = message.name.split(".");
+            accessors.forEach((access, i) => {
+                const hierarchy: Hierarchy = MapUtil.take(dict)(access, () => ({
+                    key: access,
+                    message: null!,
+                    children: new Map(),
+                }));
+                dict = hierarchy.children;
+                if (i === accessors.length - 1) hierarchy.message = message;
+            });
+        };
+
+    function getTypeName(type: string | IProtocolMap): string {
+        return typeof type === "string"
+            ? NameEncoder.encode(type)
+            : `map<${type.key}, ${getTypeName(type.value)}>`;
+    }
+}
+
+interface Hierarchy {
+    key: string;
+    message: IProtocolMessage | null;
+    children: Map<string, Hierarchy>;
+}
+
+const TAB = " ".repeat(4);

package/src/programmers/internal/application_object.ts

@@ -1,155 +1,155 @@
-import { CommentFactory } from "../../factories/CommentFactory";
-
-import { IJsDocTagInfo } from "../../metadata/IJsDocTagInfo";
-import { Metadata } from "../../metadata/Metadata";
-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) =>
-    (obj: MetadataObject) =>
-    (props: { key: string; nullable: boolean }): void => {
-        // TEMPORARY ASSIGNMENT
-        if (components.schemas[props.key] !== undefined) return;
-        components.schemas[props.key] = {} as any;
-
-        // ITERATE PROPERTIES
-        const properties: Record<string, any> = {};
-        const extraMeta: ISuperfluous = {
-            patternProperties: {},
-            additionalProperties: undefined,
-        };
-        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 schema: IJsonSchema | null = application_schema(options)(
-                true,
-            )(components)(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.string(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,
-                "x-typia-optional": property.value.optional,
-            });
-
-            if (schema === null) continue;
-            else if (key !== null) {
-                properties[key] = schema;
-                if (property.value.required === true) required.push(key);
-            } else {
-                const pattern: string = metadata_to_pattern(true)(property.key);
-                if (pattern === PatternUtil.STRING)
-                    extraMeta.additionalProperties = [property.value, schema];
-                else
-                    extraMeta.patternProperties[pattern] = [
-                        property.value,
-                        schema,
-                    ];
-            }
-        }
-
-        const extraProps = {
-            additionalProperties: extraMeta.additionalProperties?.[1],
-            patternProperties: (() => {
-                if (Object.keys(extraMeta.patternProperties).length === 0)
-                    return undefined;
-                const output: Record<string, IJsonSchema> = {};
-                for (const [key, value] of Object.entries(
-                    extraMeta.patternProperties,
-                ))
-                    output[key] = value[1];
-                return output;
-            })(),
-        };
-        const schema: IJsonComponents.IObject = {
-            $id:
-                options.purpose === "ajv"
-                    ? options.prefix + "/" + props.key
-                    : undefined,
-            $recursiveAnchor:
-                (options.purpose === "ajv" && obj.recursive) || undefined,
-            type: "object",
-            properties,
-            nullable: props.nullable,
-            required: required.length ? required : undefined,
-            description: obj.description,
-            "x-typia-jsDocTags": obj.jsDocTags,
-            ...(options.purpose === "ajv"
-                ? extraProps
-                : {
-                      // swagger can't express patternProperties
-                      "x-typia-additionalProperties":
-                          extraProps.additionalProperties,
-                      "x-typia-patternProperties": extraProps.patternProperties,
-                      additionalProperties:
-                          join(options)(components)(extraMeta),
-                  }),
-        };
-        components.schemas[props.key] = schema;
-    };
-
-const join =
-    (options: ApplicationProgrammer.IOptions) =>
-    (components: IJsonComponents) =>
-    (extra: ISuperfluous): IJsonSchema | undefined => {
-        // LIST UP METADATA
-        const elements: [Metadata, IJsonSchema][] = Object.values(
-            extra.patternProperties || {},
-        );
-        if (extra.additionalProperties)
-            elements.push(extra.additionalProperties);
-
-        // SHORT RETURN
-        if (elements.length === 0) return undefined;
-        else if (elements.length === 1) return elements[0]![1]!;
-
-        // MERGE METADATA AND GENERATE VULNERABLE SCHEMA
-        const meta: Metadata = elements
-            .map((tuple) => tuple[0])
-            .reduce((x, y) => Metadata.merge(x, y));
-        return (
-            application_schema(options)(true)(components)(meta)({
-                "x-typia-required": false,
-            }) ?? undefined
-        );
-    };
-
-interface ISuperfluous {
-    additionalProperties?: [Metadata, IJsonSchema];
-    patternProperties: Record<string, [Metadata, IJsonSchema]>;
-}
+import { CommentFactory } from "../../factories/CommentFactory";
+
+import { IJsDocTagInfo } from "../../metadata/IJsDocTagInfo";
+import { Metadata } from "../../metadata/Metadata";
+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) =>
+    (obj: MetadataObject) =>
+    (props: { key: string; nullable: boolean }): void => {
+        // TEMPORARY ASSIGNMENT
+        if (components.schemas[props.key] !== undefined) return;
+        components.schemas[props.key] = {} as any;
+
+        // ITERATE PROPERTIES
+        const properties: Record<string, any> = {};
+        const extraMeta: ISuperfluous = {
+            patternProperties: {},
+            additionalProperties: undefined,
+        };
+        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 schema: IJsonSchema | null = application_schema(options)(
+                true,
+            )(components)(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.string(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,
+                "x-typia-optional": property.value.optional,
+            });
+
+            if (schema === null) continue;
+            else if (key !== null) {
+                properties[key] = schema;
+                if (property.value.required === true) required.push(key);
+            } else {
+                const pattern: string = metadata_to_pattern(true)(property.key);
+                if (pattern === PatternUtil.STRING)
+                    extraMeta.additionalProperties = [property.value, schema];
+                else
+                    extraMeta.patternProperties[pattern] = [
+                        property.value,
+                        schema,
+                    ];
+            }
+        }
+
+        const extraProps = {
+            additionalProperties: extraMeta.additionalProperties?.[1],
+            patternProperties: (() => {
+                if (Object.keys(extraMeta.patternProperties).length === 0)
+                    return undefined;
+                const output: Record<string, IJsonSchema> = {};
+                for (const [key, value] of Object.entries(
+                    extraMeta.patternProperties,
+                ))
+                    output[key] = value[1];
+                return output;
+            })(),
+        };
+        const schema: IJsonComponents.IObject = {
+            $id:
+                options.purpose === "ajv"
+                    ? options.prefix + "/" + props.key
+                    : undefined,
+            $recursiveAnchor:
+                (options.purpose === "ajv" && obj.recursive) || undefined,
+            type: "object",
+            properties,
+            nullable: props.nullable,
+            required: required.length ? required : undefined,
+            description: obj.description,
+            "x-typia-jsDocTags": obj.jsDocTags,
+            ...(options.purpose === "ajv"
+                ? extraProps
+                : {
+                      // swagger can't express patternProperties
+                      "x-typia-additionalProperties":
+                          extraProps.additionalProperties,
+                      "x-typia-patternProperties": extraProps.patternProperties,
+                      additionalProperties:
+                          join(options)(components)(extraMeta),
+                  }),
+        };
+        components.schemas[props.key] = schema;
+    };
+
+const join =
+    (options: ApplicationProgrammer.IOptions) =>
+    (components: IJsonComponents) =>
+    (extra: ISuperfluous): IJsonSchema | undefined => {
+        // LIST UP METADATA
+        const elements: [Metadata, IJsonSchema][] = Object.values(
+            extra.patternProperties || {},
+        );
+        if (extra.additionalProperties)
+            elements.push(extra.additionalProperties);
+
+        // SHORT RETURN
+        if (elements.length === 0) return undefined;
+        else if (elements.length === 1) return elements[0]![1]!;
+
+        // MERGE METADATA AND GENERATE VULNERABLE SCHEMA
+        const meta: Metadata = elements
+            .map((tuple) => tuple[0])
+            .reduce((x, y) => Metadata.merge(x, y));
+        return (
+            application_schema(options)(true)(components)(meta)({
+                "x-typia-required": false,
+            }) ?? undefined
+        );
+    };
+
+interface ISuperfluous {
+    additionalProperties?: [Metadata, IJsonSchema];
+    patternProperties: Record<string, [Metadata, IJsonSchema]>;
+}

package/src/programmers/internal/application_tuple.ts

@@ -1,31 +1,31 @@
-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>) =>
-    (props: {
-        nullable: boolean;
-        attribute: IJsonSchema.IAttribute;
-    }): IJsonSchema.ITuple => ({
-        type: "array",
-        items: items.map((meta, i) =>
-            application_schema(options)(false)(components)(meta.rest ?? meta)({
-                ...props.attribute,
-                "x-typia-rest":
-                    i === items.length - 1 ? meta.rest !== null : undefined,
-                "x-typia-required": meta.required,
-                "x-typia-optional": meta.optional,
-            }),
-        ),
-        nullable: props.nullable,
-        ...props.attribute,
-    });
+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>) =>
+    (props: {
+        nullable: boolean;
+        attribute: IJsonSchema.IAttribute;
+    }): IJsonSchema.ITuple => ({
+        type: "array",
+        items: items.map((meta, i) =>
+            application_schema(options)(false)(components)(meta.rest ?? meta)({
+                ...props.attribute,
+                "x-typia-rest":
+                    i === items.length - 1 ? meta.rest !== null : undefined,
+                "x-typia-required": meta.required,
+                "x-typia-optional": meta.optional,
+            }),
+        ),
+        nullable: props.nullable,
+        ...props.attribute,
+    });