typia 7.0.0-dev.20241012 → 7.0.0-dev.20241018

package/src/factories/ProtobufFactory.ts

@@ -1,7 +1,9 @@
 import ts from "typescript";
 
+import { IMetadataTypeTag } from "../schemas/metadata/IMetadataTypeTag";
 import { Metadata } from "../schemas/metadata/Metadata";
 import { MetadataObjectType } from "../schemas/metadata/MetadataObjectType";
+import { MetadataProperty } from "../schemas/metadata/MetadataProperty";
 
 import { ProtobufUtil } from "../programmers/helpers/ProtobufUtil";
 
@@ -21,6 +23,9 @@ export namespace ProtobufFactory {
     type: ts.Type;
   }
 
+  /* -----------------------------------------------------------
+    METADATA COMPOSER
+  ----------------------------------------------------------- */
   export const metadata = (props: IProps): Metadata => {
     // COMPOSE METADATA WITH INDIVIDUAL VALIDATIONS
     const result: ValidationPipe<Metadata, MetadataFactory.IError> =
@@ -31,7 +36,7 @@ export namespace ProtobufFactory {
           escape: false,
           constant: true,
           absorb: true,
-          validate,
+          validate: validate(),
         },
       });
     if (result.success === false)
@@ -42,192 +47,496 @@ export namespace ProtobufFactory {
     return result.data;
   };
 
-  const validate = (
-    meta: Metadata,
-    explore: MetadataFactory.IExplore,
-  ): string[] => {
-    const errors: string[] = [];
-    const insert = (msg: string) => errors.push(msg);
+  /* -----------------------------------------------------------
+    VALIDATORS
+  ----------------------------------------------------------- */
+  const validate = () => {
+    const visited: WeakSet<MetadataObjectType> = new WeakSet();
+    return (meta: Metadata, explore: MetadataFactory.IExplore): string[] => {
+      const errors: string[] = [];
+      const insert = (msg: string) => errors.push(msg);
 
-    if (explore.top === true) {
-      const onlyObject: boolean =
-        meta.size() === 1 &&
-        meta.objects.length === 1 &&
-        meta.objects[0]!.type.properties.every((p) => p.key.isSoleLiteral()) &&
-        meta.isRequired() === true &&
-        meta.nullable === false;
-      if (onlyObject === false)
-        insert("target type must be a sole and static object type");
-    }
+      if (explore.top === true) {
+        const onlyObject: boolean =
+          meta.size() === 1 &&
+          meta.objects.length === 1 &&
+          meta.objects[0]!.type.properties.every((p) =>
+            p.key.isSoleLiteral(),
+          ) &&
+          meta.isRequired() === true &&
+          meta.nullable === false;
+        if (onlyObject === false)
+          insert("target type must be a sole and static object type");
+      }
+      if (explore.object !== null && visited.has(explore.object) === false) {
+        visited.add(explore.object);
+        validateRegularObject({
+          object: explore.object,
+          errors,
+        });
+        for (const p of explore.object.properties)
+          validateRegularProperty({
+            value: p.value,
+            errors,
+          });
+      }
 
-    //----
-    // NOT SUPPORTED TYPES
-    //----
-    const noSupport = (msg: string) => insert(`does not support ${msg}`);
+      //----
+      // NOT SUPPORTED TYPES
+      //----
+      const noSupport = (msg: string) => insert(`does not support ${msg}`);
 
-    // PROHIBIT ANY TYPE
-    if (meta.any) noSupport("any type");
-    // PROHIBIT FUNCTIONAL TYPE
-    if (meta.functions.length) noSupport("functional type");
-    // PROHIBIT TUPLE TYPE
-    if (meta.tuples.length) noSupport("tuple type");
-    // PROHIBIT SET TYPE
-    if (meta.sets.length) noSupport("Set type");
-    // NATIVE TYPE, BUT NOT Uint8Array
-    if (meta.natives.length)
-      for (const native of meta.natives) {
-        if (native === "Uint8Array") continue;
+      // PROHIBIT ANY TYPE
+      if (meta.any) noSupport("any type");
+      // PROHIBIT FUNCTIONAL TYPE
+      if (meta.functions.length) noSupport("functional type");
+      // PROHIBIT TUPLE TYPE
+      if (meta.tuples.length) noSupport("tuple type");
+      // PROHIBIT SET TYPE
+      if (meta.sets.length) noSupport("Set type");
+      // NATIVE TYPE, BUT NOT Uint8Array
+      if (meta.natives.length)
+        for (const native of meta.natives) {
+          if (native.name === "Uint8Array") continue;
 
-        const instead = BANNED_NATIVE_TYPES.get(native);
-        if (instead === undefined) noSupport(`${native} type`);
-        else noSupport(`${native} type. Use ${instead} type instead.`);
-      }
-    //----
-    // ATOMIC CASES
-    //----
-    if (meta.atomics.length) {
-      const numbers = ProtobufUtil.getNumbers(meta);
-      const bigints = ProtobufUtil.getBigints(meta);
+          const instead = BANNED_NATIVE_TYPES.get(native.name);
+          if (instead === undefined) noSupport(`${native.name} type`);
+          else noSupport(`${native.name} type. Use ${instead} type instead.`);
+        }
+      //----
+      // ATOMIC CASES
+      //----
+      if (meta.atomics.length) {
+        const numbers = ProtobufUtil.getNumbers(meta);
+        const bigints = ProtobufUtil.getBigints(meta);
 
-      for (const type of ["int64", "uint64"])
-        if (numbers.some((n) => n === type) && bigints.some((b) => b === type))
-          insert(
-            `tags.Type<"${type}"> cannot be used in both number and bigint types. Recommend to remove from number type`,
-          );
-    }
-    //----
-    // ARRRAY CASES
-    //----
-    // DO NOT ALLOW MULTI-DIMENTIONAL ARRAY
-    if (
-      meta.arrays.length &&
-      meta.arrays.some((array) => !!array.type.value.arrays.length)
-    )
-      noSupport("over two dimenstional array type");
-    // CHILD OF ARRAY TYPE MUST BE REQUIRED
-    if (
-      meta.arrays.length &&
-      meta.arrays.some(
-        (array) =>
-          array.type.value.isRequired() === false ||
-          array.type.value.nullable === true,
+        for (const type of ["int64", "uint64"])
+          if (numbers.has(type) && bigints.has(type))
+            insert(
+              `tags.Type<"${type}"> cannot be used in both number and bigint types. Recommend to remove from number type`,
+            );
+      }
+      //----
+      // ARRRAY CASES
+      //----
+      // DO NOT ALLOW MULTI-DIMENTIONAL ARRAY
+      if (
+        meta.arrays.length &&
+        meta.arrays.some((array) => !!array.type.value.arrays.length)
       )
-    )
-      noSupport("optional type in array");
-    // UNION IN ARRAY
-    if (
-      meta.arrays.length &&
-      meta.arrays.some(
-        (a) =>
-          a.type.value.size() > 1 &&
-          a.type.value.constants.length !== 1 &&
-          a.type.value.constants[0]?.values.length !== a.type.value.size(),
+        noSupport("over two dimenstional array type");
+      // CHILD OF ARRAY TYPE MUST BE REQUIRED
+      if (
+        meta.arrays.length &&
+        meta.arrays.some(
+          (array) =>
+            array.type.value.isRequired() === false ||
+            array.type.value.nullable === true,
+        )
       )
-    )
-      noSupport("union type in array");
-    // DO DYNAMIC OBJECT IN ARRAY
-    if (
-      meta.arrays.length &&
-      meta.arrays.some(
-        (a) =>
-          a.type.value.maps.length ||
-          (a.type.value.objects.length &&
-            a.type.value.objects.some(
-              (o) => ProtobufUtil.isStaticObject(o.type) === false,
-            )),
+        noSupport("optional type in array");
+      // UNION IN ARRAY
+      if (
+        meta.arrays.length &&
+        meta.arrays.some(
+          (a) =>
+            a.type.value.size() > 1 &&
+            a.type.value.constants.length !== 1 &&
+            a.type.value.constants[0]?.values.length !== a.type.value.size(),
+        )
       )
-    )
-      noSupport("dynamic object in array");
-    // UNION WITH ARRAY
-    if (meta.size() > 1 && meta.arrays.length)
-      noSupport("union type with array type");
-    //----
-    // OBJECT CASES
-    //----
-    // EMPTY PROPERTY
-    if (
-      meta.objects.length &&
-      meta.objects.some((obj) => obj.type.properties.length === 0)
-    )
-      noSupport("empty object type");
-    // MULTIPLE DYNAMIC KEY TYPED PROPERTIES
-    if (
-      meta.objects.length &&
-      meta.objects.some(
-        (obj) =>
-          obj.type.properties.filter((p) => !p.key.isSoleLiteral()).length > 1,
+        noSupport("union type in array");
+      // DO DYNAMIC OBJECT IN ARRAY
+      if (
+        meta.arrays.length &&
+        meta.arrays.some(
+          (a) =>
+            a.type.value.maps.length ||
+            (a.type.value.objects.length &&
+              a.type.value.objects.some(
+                (o) => ProtobufUtil.isStaticObject(o.type) === false,
+              )),
+        )
       )
-    )
-      noSupport(
-        "object type with multiple dynamic key typed properties. Keep only one.",
-      );
-    // STATIC AND DYNAMIC PROPERTIES ARE COMPATIBLE
-    if (
-      meta.objects.length &&
-      meta.objects.some(
-        (obj) =>
-          obj.type.properties.some((p) => p.key.isSoleLiteral()) &&
-          obj.type.properties.some((p) => !p.key.isSoleLiteral()),
+        noSupport("dynamic object in array");
+      // UNION WITH ARRAY
+      if (meta.size() > 1 && meta.arrays.length)
+        noSupport("union type with array type");
+      //----
+      // OBJECT CASES
+      //----
+      // EMPTY PROPERTY
+      if (
+        meta.objects.length &&
+        meta.objects.some((obj) => obj.type.properties.length === 0)
       )
-    )
-      noSupport(
-        "object type with mixed static and dynamic key typed properties. Keep statics or dynamic only.",
-      );
-    // DYNAMIC OBJECT, BUT PROPERTY VALUE TYPE IS ARRAY
-    if (
-      meta.objects.length &&
-      isDynamicObject(meta.objects[0]!.type) &&
-      meta.objects[0]!.type.properties.some((p) => !!p.value.arrays.length)
-    )
-      noSupport("dynamic object with array value type");
-    // UNION WITH DYNAMIC OBJECTa
-    if (
-      meta.size() > 1 &&
-      meta.objects.length &&
-      isDynamicObject(meta.objects[0]!.type)
-    )
-      noSupport("union type with dynamic object type");
-    // UNION IN DYNAMIC PROPERTY VALUE
-    if (
-      meta.objects.length &&
-      meta.objects.some(
-        (obj) =>
-          isDynamicObject(obj.type) &&
-          obj.type.properties.some((p) => ProtobufUtil.isUnion(p.value)),
+        noSupport("empty object type");
+      // MULTIPLE DYNAMIC KEY TYPED PROPERTIES
+      if (
+        meta.objects.length &&
+        meta.objects.some(
+          (obj) =>
+            obj.type.properties.filter((p) => !p.key.isSoleLiteral()).length >
+            1,
+        )
+      )
+        noSupport(
+          "object type with multiple dynamic key typed properties. Keep only one.",
+        );
+      // STATIC AND DYNAMIC PROPERTIES ARE COMPATIBLE
+      if (
+        meta.objects.length &&
+        meta.objects.some(
+          (obj) =>
+            obj.type.properties.some((p) => p.key.isSoleLiteral()) &&
+            obj.type.properties.some((p) => !p.key.isSoleLiteral()),
+        )
+      )
+        noSupport(
+          "object type with mixed static and dynamic key typed properties. Keep statics or dynamic only.",
+        );
+      // DYNAMIC OBJECT, BUT PROPERTY VALUE TYPE IS ARRAY
+      if (
+        meta.objects.length &&
+        isDynamicObject(meta.objects[0]!.type) &&
+        meta.objects[0]!.type.properties.some((p) => !!p.value.arrays.length)
+      )
+        noSupport("dynamic object with array value type");
+      // UNION WITH DYNAMIC OBJECTa
+      if (
+        meta.size() > 1 &&
+        meta.objects.length &&
+        isDynamicObject(meta.objects[0]!.type)
+      )
+        noSupport("union type with dynamic object type");
+      // UNION IN DYNAMIC PROPERTY VALUE
+      if (
+        meta.objects.length &&
+        meta.objects.some(
+          (obj) =>
+            isDynamicObject(obj.type) &&
+            obj.type.properties.some((p) => ProtobufUtil.isUnion(p.value)),
+        )
+      )
+        noSupport("union type in dynamic property");
+      //----
+      // MAP CASES
+      //----
+      // KEY TYPE IS UNION
+      if (
+        meta.maps.length &&
+        meta.maps.some((m) => ProtobufUtil.isUnion(m.key))
       )
-    )
-      noSupport("union type in dynamic property");
-    //----
-    // MAP CASES
-    //----
-    // KEY TYPE IS UNION
-    if (meta.maps.length && meta.maps.some((m) => ProtobufUtil.isUnion(m.key)))
-      noSupport("union key typed map");
-    // KEY TYPE IS NOT ATOMIC
-    if (
-      meta.maps.length &&
-      meta.maps.some((m) => ProtobufUtil.getAtomics(m.key).length !== 1)
-    )
-      noSupport("non-atomic key typed map");
-    // MAP TYPE, BUT PROPERTY KEY TYPE IS OPTIONAL
-    if (
-      meta.maps.length &&
-      meta.maps.some((m) => m.key.isRequired() === false || m.key.nullable)
-    )
-      noSupport("optional key typed map");
-    // MAP TYPE, BUT VALUE TYPE IS ARRAY
-    if (meta.maps.length && meta.maps.some((m) => !!m.value.arrays.length))
-      noSupport("map type with array value type");
-    // UNION WITH MAP
-    if (meta.size() > 1 && meta.maps.length)
-      noSupport("union type with map type");
-    // UNION IN MAP
-    if (
-      meta.maps.length &&
-      meta.maps.some((m) => ProtobufUtil.isUnion(m.value))
-    )
-      noSupport("union type in map value type");
-    return errors;
+        noSupport("union key typed map");
+      // KEY TYPE IS NOT ATOMIC
+      if (
+        meta.maps.length &&
+        meta.maps.some((m) => ProtobufUtil.getAtomics(m.key).size !== 1)
+      )
+        noSupport("non-atomic key typed map");
+      // MAP TYPE, BUT PROPERTY KEY TYPE IS OPTIONAL
+      if (
+        meta.maps.length &&
+        meta.maps.some((m) => m.key.isRequired() === false || m.key.nullable)
+      )
+        noSupport("optional key typed map");
+      // MAP TYPE, BUT VALUE TYPE IS ARRAY
+      if (meta.maps.length && meta.maps.some((m) => !!m.value.arrays.length))
+        noSupport("map type with array value type");
+      // UNION WITH MAP
+      if (meta.size() > 1 && meta.maps.length)
+        noSupport("union type with map type");
+      // UNION IN MAP
+      if (
+        meta.maps.length &&
+        meta.maps.some((m) => ProtobufUtil.isUnion(m.value))
+      )
+        noSupport("union type in map value type");
+      return errors;
+    };
+  };
+
+  /* -----------------------------------------------------------
+    SEQUENE VALIDATOR
+  ----------------------------------------------------------- */
+  const validateRegularObject = (next: {
+    object: MetadataObjectType;
+    errors: string[];
+  }): void => {
+    const entire: Map<number, string> = new Map();
+    const visitProperty = (p: MetadataProperty) => {
+      const local: Set<number> = new Set();
+      const tagger = (matrix: IMetadataTypeTag[][]): void => {
+        matrix.forEach((tags) => {
+          const value: number | null = ProtobufUtil.getSequence(tags);
+          if (value !== null) local.add(value);
+        });
+      };
+      for (const c of p.value.constants)
+        for (const v of c.values) tagger(v.tags);
+      for (const a of p.value.atomics) tagger(a.tags);
+      for (const t of p.value.templates) tagger(t.tags);
+      for (const o of p.value.objects) tagger(o.tags);
+      for (const a of p.value.arrays) tagger(a.tags);
+
+      for (const s of local)
+        if (entire.has(s))
+          next.errors.push(
+            `The Sequence<${s}> tag is duplicated in two properties (${JSON.stringify(entire.get(s))} and ${JSON.stringify(p.key.getSoleLiteral())})`,
+          );
+        else entire.set(s, p.key.getSoleLiteral()!);
+    };
+    for (const p of next.object.properties) visitProperty(p);
+  };
+
+  const validateRegularProperty = (next: {
+    value: Metadata;
+    errors: string[];
+  }): void => {
+    let expected: number = 0;
+    const sequences: Set<number> = new Set();
+    const add = (value: number): boolean => {
+      if (sequences.has(value)) return false;
+      sequences.add(value);
+      ++expected;
+      return true;
+    };
+
+    for (const validator of [
+      validateBooleanSequence,
+      validateNumericSequences({
+        type: "bigint",
+        default: "int64",
+        categories: BIGINT_TYPES,
+      }),
+      validateNumericSequences({
+        type: "number",
+        default: "double",
+        categories: NUMBER_TYPES,
+      }),
+      validateStringSequence,
+    ])
+      validator({ metadata: next.value, errors: next.errors, add });
+    for (const array of next.value.arrays)
+      validateInstanceSequence({
+        type: "array",
+        tags: array.tags,
+        errors: next.errors,
+        add,
+      });
+    for (const object of next.value.objects)
+      validateInstanceSequence({
+        type: "object",
+        tags: object.tags,
+        errors: next.errors,
+        add,
+      });
+    for (const map of next.value.maps)
+      validateInstanceSequence({
+        type: "map",
+        tags: map.tags,
+        errors: next.errors,
+        add,
+      });
+    for (const native of next.value.natives)
+      if (native.name === "Uint8Array")
+        validateInstanceSequence({
+          type: "Uint8Array",
+          tags: native.tags,
+          errors: next.errors,
+          add,
+        });
+  };
+
+  const validateBooleanSequence = (next: {
+    metadata: Metadata;
+    errors: string[];
+    add: (value: number) => boolean;
+  }): void => {
+    // PREPARE EMPLACER
+    const unique: Set<number> = new Set();
+    let expected: number = 0;
+    let actual: number = 0;
+    const emplace = (matrix: IMetadataTypeTag[][]): void => {
+      for (const tags of matrix)
+        for (const tag of tags) {
+          const sequence = ProtobufUtil.getSequence([tag]);
+          if (sequence !== null) {
+            unique.add(sequence);
+            ++actual;
+          }
+          ++expected;
+        }
+    };
+
+    // GATHER SEQUENCE TAGS
+    for (const atomic of next.metadata.atomics)
+      if (atomic.type === "boolean") emplace(atomic.tags);
+    for (const constant of next.metadata.constants)
+      if (constant.type === "boolean")
+        for (const value of constant.values) emplace(value.tags);
+
+    // PREDICATE
+    if (unique.size && actual !== expected)
+      next.errors.push(
+        `The sequence tag must be declared in every union type members`,
+      );
+    else if (unique.size > 1)
+      next.errors.push(
+        `The sequence tag value must be the same in boolean type (including literal types)`,
+      );
+    else if (unique.size === 1) {
+      const value: number = unique.values().next().value!;
+      if (next.add(value) === false)
+        next.errors.push(
+          `The sequence tag value ${value} in boolean type is duplicated with other types`,
+        );
+    }
+  };
+
+  const validateNumericSequences =
+    (config: {
+      type: "number" | "bigint";
+      default: string;
+      categories: Set<string>;
+    }) =>
+    (next: {
+      metadata: Metadata;
+      errors: string[];
+      add: (value: number) => boolean;
+    }): void => {
+      // FIND TYPE CATEGORIES
+      const categories: Set<string> = new Set();
+      const getType = (tags: IMetadataTypeTag[]): string => {
+        const found: IMetadataTypeTag | undefined = tags.find(
+          (t) => t.kind === "type" && config.categories.has(t.value),
+        );
+        return found?.value ?? config.default;
+      };
+      const exploreCategory = (matrix: IMetadataTypeTag[][]): void => {
+        for (const tags of matrix) categories.add(getType(tags));
+      };
+      for (const atomic of next.metadata.atomics)
+        if (atomic.type === config.type) exploreCategory(atomic.tags);
+      for (const constant of next.metadata.constants)
+        if (constant.type === config.type)
+          for (const value of constant.values) exploreCategory(value.tags);
+
+      // ITERATE TYPE CATEGORIES
+      for (const category of categories) {
+        const unique: Set<number> = new Set();
+        let expected: number = 0;
+        let actual: number = 0;
+        const emplace = (tags: IMetadataTypeTag[]): void => {
+          const sequence: number | null = ProtobufUtil.getSequence(tags);
+          if (sequence !== null) {
+            unique.add(sequence);
+            ++actual;
+          }
+          ++expected;
+        };
+
+        for (const atomic of next.metadata.atomics)
+          if (atomic.type === config.type)
+            for (const tags of atomic.tags)
+              if (getType(tags) === category) emplace(tags);
+        for (const constant of next.metadata.constants)
+          if (constant.type === config.type)
+            for (const value of constant.values)
+              for (const tags of value.tags)
+                if (getType(tags) === category) emplace(tags);
+
+        if (unique.size && actual !== expected) {
+          console.log(category, actual, expected, unique);
+          next.errors.push(
+            `The sequence tag must be declared in every union type members`,
+          );
+        } else if (unique.size > 1)
+          next.errors.push(
+            `The sequence tag value must be the same in ${config.type} type (including literal types)`,
+          );
+        else if (unique.size === 1) {
+          const value: number = unique.values().next().value!;
+          if (next.add(value) === false)
+            next.errors.push(
+              `The sequence tag value ${value} in ${config.type} type is duplicated with other types`,
+            );
+        }
+      }
+    };
+
+  const validateStringSequence = (next: {
+    metadata: Metadata;
+    errors: string[];
+    add: (value: number) => boolean;
+  }): void => {
+    const unique: Set<number> = new Set();
+    let expected: number = 0;
+    let actual: number = 0;
+    const emplace = (matrix: IMetadataTypeTag[][]): void => {
+      for (const tags of matrix)
+        for (const tag of tags) {
+          const sequence = ProtobufUtil.getSequence([tag]);
+          if (sequence !== null) {
+            unique.add(sequence);
+            ++actual;
+          }
+          ++expected;
+        }
+    };
+    for (const atomic of next.metadata.atomics)
+      if (atomic.type === "string") emplace(atomic.tags);
+    for (const constant of next.metadata.constants)
+      if (constant.type === "string")
+        for (const value of constant.values) emplace(value.tags);
+    for (const template of next.metadata.templates) emplace(template.tags);
+
+    if (unique.size && actual !== expected)
+      next.errors.push(
+        `The sequence tag must be declared in every union type members`,
+      );
+    else if (unique.size > 1)
+      next.errors.push(
+        `The sequence tag value must be the same in string types including literal and template types`,
+      );
+    else if (unique.size === 1) {
+      const value: number = unique.values().next().value!;
+      if (next.add(value) === false)
+        next.errors.push(
+          `The sequence tag value ${value} in string type is duplicated with other types`,
+        );
+    }
+  };
+
+  const validateInstanceSequence = (next: {
+    type: "array" | "object" | "map" | "Uint8Array";
+    tags: IMetadataTypeTag[][];
+    errors: string[];
+    add: (value: number) => boolean;
+  }): void => {
+    const unique: Set<number> = new Set();
+    let count: number = 0;
+    for (const tags of next.tags) {
+      const value: number | null = ProtobufUtil.getSequence(tags);
+      if (value === null) continue;
+      unique.add(value);
+      ++count;
+    }
+    if (unique.size && count !== next.tags.length)
+      next.errors.push(
+        `The sequence tag must be declared in every union type members`,
+      );
+    else if (unique.size > 1)
+      next.errors.push(
+        `The sequence tag value must be the same in ${next.type === "array" ? "an array" : "object"} type.`,
+      );
+    else if (unique.size === 1) {
+      const value: number = unique.values().next().value!;
+      if (next.add(value) === false)
+        next.errors.push(
+          `The sequence tag value ${value} in ${next.type} type is duplicated with other types`,
+        );
+    }
   };
 }
 
@@ -259,3 +568,12 @@ const BANNED_NATIVE_TYPES: Map<string, string | null> = new Map([
   ["WeakSet", "Array"],
   ["WeakMap", "Map"],
 ]);
+const NUMBER_TYPES: Set<string> = new Set([
+  "int32",
+  "uint32",
+  "int64",
+  "uint64",
+  "float",
+  "double",
+]);
+const BIGINT_TYPES = new Set(["int64", "uint64"]);