typia 5.0.0-dev.20230711 → 5.0.0-dev.20230715

package/src/programmers/{MessageProgrammer.ts → protobuf/ProtobufMessageProgrammer.ts}

@@ -1,126 +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);
+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 ProtobufMessageProgrammer {
+    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/protobuf.ts

@@ -0,0 +1,121 @@
+import { IValidation } from "./IValidation";
+import { Primitive } from "./Primitive";
+
+/* ===========================================================
+    PROTOCOL BUFFER
+      - MESSAGE
+      - DECODE
+      - ENCODE
+      - FACTORY FUNCTIONS
+==============================================================
+    SCHEMA
+----------------------------------------------------------- */
+export function message(): never;
+
+export function message<T>(): string;
+
+/**
+ * @internal
+ */
+export function message(): never {
+    halt("message");
+}
+
+/* -----------------------------------------------------------
+    DECODE
+----------------------------------------------------------- */
+export function decode(input: Uint8Array): never;
+
+export function decode<T>(input: Uint8Array): Primitive<T>;
+
+/**
+ * @internal
+ */
+export function decode(): never {
+    halt("decode");
+}
+
+export function isDecode(input: Uint8Array): never;
+
+export function isDecode<T>(input: Uint8Array): Primitive<T> | null;
+
+/**
+ * @internal
+ */
+export function isDecode(): never {
+    halt("isDecode");
+}
+
+export function assertDecode(input: Uint8Array): never;
+
+export function assertDecode<T>(input: Uint8Array): Primitive<T>;
+
+/**
+ * @internal
+ */
+export function assertDecode(): never {
+    halt("assertDecode");
+}
+
+export function validateDecode(input: Uint8Array): never;
+
+export function validateDecode<T>(input: Uint8Array): IValidation<Primitive<T>>;
+
+/**
+ * @internal
+ */
+export function validateDecode(): never {
+    halt("validateDecode");
+}
+
+/* -----------------------------------------------------------
+    ENCODE
+----------------------------------------------------------- */
+export function encode<T>(input: T): Uint16Array;
+
+/**
+ * @internal
+ */
+export function encode(): never {
+    halt("encode");
+}
+
+export function isEncode<T>(input: T): Uint16Array | null;
+
+/**
+ * @internal
+ */
+export function isEncode(): never {
+    halt("isEncode");
+}
+
+export function assertEncode<T>(input: T): Uint16Array;
+
+/**
+ * @internal
+ */
+export function assertEncode(): never {
+    halt("assertEncode");
+}
+
+export function validateEncode<T>(input: T): IValidation<Uint16Array>;
+
+/**
+ * @internal
+ */
+export function validateEncode(): never {
+    halt("validateEncode");
+}
+
+/* -----------------------------------------------------------
+    FACTORY FUNCTIONS
+----------------------------------------------------------- */
+
+/**
+ * @internal
+ */
+function halt(name: string): never {
+    throw new Error(
+        `Error on typia.protobuf.${name}(): no transform has been configured. Read and follow https://typia.io/docs/setup please.`,
+    );
+}