typia 3.8.4 → 4.0.0-dev.20230502

package/src/Primitive.ts

@@ -1,123 +1,123 @@
-/**
- * Primitive type.
- *
- * `Primitive` is a type of TMP (Type Meta Programming) type who converts its argument as a
- * primitive type.
- *
- * If the target argument is a built-in class who returns its origin primitive type through
- * the `valueOf()` method like the `String` or `Number`, its return type would be the
- * `string` or `number`.
- *
- * Otherwise, the target argument is a type of custom class, all of its custom method would
- * be erased and its prototype would be changed to the primitive `object`. Therefore, return
- * type of the TMP type finally be the primitive object.
- *
- * In addition, if the target argument is a type of custom class and it has a special
- * method `toJSON()`, return type of this `Primitive` would be not `Primitive<Instance>`
- * but `Primitive<ReturnType<Instance.toJSON>>`.
- *
- * Before                  | After
- * ------------------------|----------------------------------------
- * `Boolean`               | `boolean`
- * `Number`                | `number`
- * `String`                | `string`
- * `Class`                 | `object`
- * `Class` with `toJSON()` | `Primitive<ReturnType<Class.toJSON>>`
- * Others                  | No change
- *
- * @template Instance Target argument type.
- * @author Jenogho Nam - https://github.com/samchon
- */
-export type Primitive<T> = Equal<T, PrimitiveMain<T>> extends true
-    ? T
-    : PrimitiveMain<T>;
-
-type Equal<X, Y> = X extends Y ? (Y extends X ? true : false) : false;
-
-type PrimitiveMain<Instance> = ValueOf<Instance> extends object
-    ? Instance extends object
-        ? Instance extends NativeClass
-            ? {}
-            : Instance extends IJsonable<infer Raw>
-            ? ValueOf<Raw> extends object
-                ? Raw extends object
-                    ? PrimitiveObject<Raw> // object would be primitified
-                    : never // cannot be
-                : ValueOf<Raw> // atomic value
-            : PrimitiveObject<Instance> // object would be primitified
-        : never // cannot be
-    : ValueOf<Instance>;
-
-type PrimitiveObject<Instance extends object> = Instance extends Array<infer T>
-    ? IsTuple<Instance> extends true
-        ? PrimitiveTuple<Instance>
-        : PrimitiveMain<T>[]
-    : {
-          [P in keyof Instance]: Instance[P] extends Function
-              ? never
-              : PrimitiveMain<Instance[P]>;
-      };
-
-type PrimitiveTuple<T extends readonly any[]> = T extends [infer F]
-    ? [PrimitiveMain<F>]
-    : T extends [infer F, ...infer Rest extends readonly any[]]
-    ? [PrimitiveMain<F>, ...PrimitiveTuple<Rest>]
-    : T extends [(infer F)?]
-    ? [PrimitiveMain<F>?]
-    : T extends [(infer F)?, ...infer Rest extends readonly any[]]
-    ? [PrimitiveMain<F>?, ...PrimitiveTuple<Rest>]
-    : [];
-
-type ValueOf<Instance> = IsValueOf<Instance, Boolean> extends true
-    ? boolean
-    : IsValueOf<Instance, Number> extends true
-    ? number
-    : IsValueOf<Instance, String> extends true
-    ? string
-    : Instance;
-
-type NativeClass =
-    | Set<any>
-    | Map<any, any>
-    | WeakSet<any>
-    | WeakMap<any, any>
-    | Uint8Array
-    | Uint8ClampedArray
-    | Uint16Array
-    | Uint32Array
-    | BigUint64Array
-    | Int8Array
-    | Int16Array
-    | Int32Array
-    | BigInt64Array
-    | Float32Array
-    | Float64Array
-    | ArrayBuffer
-    | SharedArrayBuffer
-    | DataView;
-
-type IsTuple<T extends readonly any[] | { length: number }> = [T] extends [
-    never,
-]
-    ? false
-    : T extends readonly any[]
-    ? number extends T["length"]
-        ? false
-        : true
-    : false;
-
-type IsValueOf<Instance, Object extends IValueOf<any>> = Instance extends Object
-    ? Object extends IValueOf<infer Primitive>
-        ? Instance extends Primitive
-            ? false
-            : true // not Primitive, but Object
-        : false // cannot be
-    : false;
-
-interface IValueOf<T> {
-    valueOf(): T;
-}
-
-interface IJsonable<T> {
-    toJSON(): T;
-}
+/**
+ * Primitive type.
+ *
+ * `Primitive` is a type of TMP (Type Meta Programming) type who converts its argument as a
+ * primitive type.
+ *
+ * If the target argument is a built-in class who returns its origin primitive type through
+ * the `valueOf()` method like the `String` or `Number`, its return type would be the
+ * `string` or `number`.
+ *
+ * Otherwise, the target argument is a type of custom class, all of its custom method would
+ * be erased and its prototype would be changed to the primitive `object`. Therefore, return
+ * type of the TMP type finally be the primitive object.
+ *
+ * In addition, if the target argument is a type of custom class and it has a special
+ * method `toJSON()`, return type of this `Primitive` would be not `Primitive<Instance>`
+ * but `Primitive<ReturnType<Instance.toJSON>>`.
+ *
+ * Before                  | After
+ * ------------------------|----------------------------------------
+ * `Boolean`               | `boolean`
+ * `Number`                | `number`
+ * `String`                | `string`
+ * `Class`                 | `object`
+ * `Class` with `toJSON()` | `Primitive<ReturnType<Class.toJSON>>`
+ * Others                  | No change
+ *
+ * @template Instance Target argument type.
+ * @author Jenogho Nam - https://github.com/samchon
+ */
+export type Primitive<T> = Equal<T, PrimitiveMain<T>> extends true
+    ? T
+    : PrimitiveMain<T>;
+
+type Equal<X, Y> = X extends Y ? (Y extends X ? true : false) : false;
+
+type PrimitiveMain<Instance> = ValueOf<Instance> extends object
+    ? Instance extends object
+        ? Instance extends NativeClass
+            ? {}
+            : Instance extends IJsonable<infer Raw>
+            ? ValueOf<Raw> extends object
+                ? Raw extends object
+                    ? PrimitiveObject<Raw> // object would be primitified
+                    : never // cannot be
+                : ValueOf<Raw> // atomic value
+            : PrimitiveObject<Instance> // object would be primitified
+        : never // cannot be
+    : ValueOf<Instance>;
+
+type PrimitiveObject<Instance extends object> = Instance extends Array<infer T>
+    ? IsTuple<Instance> extends true
+        ? PrimitiveTuple<Instance>
+        : PrimitiveMain<T>[]
+    : {
+          [P in keyof Instance]: Instance[P] extends Function
+              ? never
+              : PrimitiveMain<Instance[P]>;
+      };
+
+type PrimitiveTuple<T extends readonly any[]> = T extends [infer F]
+    ? [PrimitiveMain<F>]
+    : T extends [infer F, ...infer Rest extends readonly any[]]
+    ? [PrimitiveMain<F>, ...PrimitiveTuple<Rest>]
+    : T extends [(infer F)?]
+    ? [PrimitiveMain<F>?]
+    : T extends [(infer F)?, ...infer Rest extends readonly any[]]
+    ? [PrimitiveMain<F>?, ...PrimitiveTuple<Rest>]
+    : [];
+
+type ValueOf<Instance> = IsValueOf<Instance, Boolean> extends true
+    ? boolean
+    : IsValueOf<Instance, Number> extends true
+    ? number
+    : IsValueOf<Instance, String> extends true
+    ? string
+    : Instance;
+
+type NativeClass =
+    | Set<any>
+    | Map<any, any>
+    | WeakSet<any>
+    | WeakMap<any, any>
+    | Uint8Array
+    | Uint8ClampedArray
+    | Uint16Array
+    | Uint32Array
+    | BigUint64Array
+    | Int8Array
+    | Int16Array
+    | Int32Array
+    | BigInt64Array
+    | Float32Array
+    | Float64Array
+    | ArrayBuffer
+    | SharedArrayBuffer
+    | DataView;
+
+type IsTuple<T extends readonly any[] | { length: number }> = [T] extends [
+    never,
+]
+    ? false
+    : T extends readonly any[]
+    ? number extends T["length"]
+        ? false
+        : true
+    : false;
+
+type IsValueOf<Instance, Object extends IValueOf<any>> = Instance extends Object
+    ? Object extends IValueOf<infer Primitive>
+        ? Instance extends Primitive
+            ? false
+            : true // not Primitive, but Object
+        : false // cannot be
+    : false;
+
+interface IValueOf<T> {
+    valueOf(): T;
+}
+
+interface IJsonable<T> {
+    toJSON(): T;
+}

package/src/factories/MetadataFactory.ts

@@ -1,62 +1,62 @@
-import ts from "typescript";
-
-import { Metadata } from "../metadata/Metadata";
-import { explore_metadata } from "./internal/metadata/explore_metadata";
-
-import { MetadataCollection } from "./MetadataCollection";
-
-export namespace MetadataFactory {
-    export interface IOptions {
-        resolve: boolean;
-        constant: boolean;
-        validate?: (meta: Metadata) => void;
-    }
-
-    export const analyze =
-        (checker: ts.TypeChecker) =>
-        (options: IOptions) =>
-        (collection: MetadataCollection) =>
-        (type: ts.Type | null): Metadata => {
-            // CONSTRUCT SCHEMA WITH OBJECTS
-            const metadata: Metadata = explore_metadata(checker)(options)(
-                collection,
-            )(type, false);
-
-            // FIND RECURSIVE OBJECTS
-            for (const object of collection.objects())
-                object.recursive = object.properties.some((prop) =>
-                    isRecursive(object.name)(prop.value),
-                );
-
-            // RETURNS
-            return metadata;
-        };
-
-    const isRecursive =
-        (name: string) =>
-        (meta: Metadata): boolean => {
-            const similar = (str: string) =>
-                name === str ||
-                name.indexOf(`<${str},`) !== -1 ||
-                name.indexOf(`, ${str}>`) !== -1 ||
-                name.indexOf(`, ${str},`) !== -1;
-            return (
-                meta.objects.some((obj) => similar(obj.name)) ||
-                meta.arrays.some((arr) => isRecursive(name)(arr)) ||
-                meta.tuples.some((tuple) =>
-                    tuple.some((m) => isRecursive(name)(m.rest ?? m)),
-                ) ||
-                meta.maps.some((map) => isRecursive(name)(map.value))
-            );
-        };
-
-    /**
-     * @deprecated Use `analyze` function instead
-     */
-    export const generate = (
-        checker: ts.TypeChecker,
-        collection: MetadataCollection,
-        type: ts.Type,
-        options: IOptions,
-    ) => analyze(checker)(options)(collection)(type);
-}
+import ts from "typescript";
+
+import { Metadata } from "../metadata/Metadata";
+import { explore_metadata } from "./internal/metadata/explore_metadata";
+
+import { MetadataCollection } from "./MetadataCollection";
+
+export namespace MetadataFactory {
+    export interface IOptions {
+        resolve: boolean;
+        constant: boolean;
+        validate?: (meta: Metadata) => void;
+    }
+
+    export const analyze =
+        (checker: ts.TypeChecker) =>
+        (options: IOptions) =>
+        (collection: MetadataCollection) =>
+        (type: ts.Type | null): Metadata => {
+            // CONSTRUCT SCHEMA WITH OBJECTS
+            const metadata: Metadata = explore_metadata(checker)(options)(
+                collection,
+            )(type, false);
+
+            // FIND RECURSIVE OBJECTS
+            for (const object of collection.objects())
+                object.recursive = object.properties.some((prop) =>
+                    isRecursive(object.name)(prop.value),
+                );
+
+            // RETURNS
+            return metadata;
+        };
+
+    const isRecursive =
+        (name: string) =>
+        (meta: Metadata): boolean => {
+            const similar = (str: string) =>
+                name === str ||
+                name.indexOf(`<${str},`) !== -1 ||
+                name.indexOf(`, ${str}>`) !== -1 ||
+                name.indexOf(`, ${str},`) !== -1;
+            return (
+                meta.objects.some((obj) => similar(obj.name)) ||
+                meta.arrays.some((arr) => isRecursive(name)(arr)) ||
+                meta.tuples.some((tuple) =>
+                    tuple.some((m) => isRecursive(name)(m.rest ?? m)),
+                ) ||
+                meta.maps.some((map) => isRecursive(name)(map.value))
+            );
+        };
+
+    /**
+     * @deprecated Use `analyze` function instead
+     */
+    export const generate = (
+        checker: ts.TypeChecker,
+        collection: MetadataCollection,
+        type: ts.Type,
+        options: IOptions,
+    ) => analyze(checker)(options)(collection)(type);
+}

package/src/factories/ProtocolFactory.ts

@@ -0,0 +1,79 @@
+import ts from "typescript";
+
+import { Metadata } from "../metadata/Metadata";
+
+import { IProtocolMessage } from "../messages/IProtocolMessage";
+import { MetadataCollection } from "./MetadataCollection";
+import { MetadataFactory } from "./MetadataFactory";
+import { emplace_protocol_object } from "./internal/protocols/emplace_protocol_object";
+import { iterate_protocol_main } from "./internal/protocols/iterate_protocol_main";
+
+export namespace ProtocolFactory {
+    export const metadata =
+        (checker: ts.TypeChecker) =>
+        (collection: MetadataCollection) =>
+        (type: ts.Type) =>
+            MetadataFactory.generate(checker, collection, type, {
+                resolve: false,
+                constant: true,
+                validate: (meta) => {
+                    if (meta.any) throw new Error(ErrorMessages.NO_ANY);
+                    else if (meta.functional && meta.size() !== 1)
+                        throw new Error(ErrorMessages.NO_FUNCTIONAL);
+                    else if (meta.objects.find((o) => o.name === "__Main"))
+                        throw new Error(ErrorMessages.NO_MAIN);
+                    else if (meta.objects.find((o) => o.name === "__Timestamp"))
+                        throw new Error(ErrorMessages.NO_TIMESTAMP);
+                    else if (
+                        meta.objects.some((o) =>
+                            o.properties.some((p) => !is_atomic_key(p.key)),
+                        ) ||
+                        meta.maps.some((m) => !is_atomic_key(m.key))
+                    )
+                        throw new Error(ErrorMessages.NOT_ALLOWED_KEY);
+                },
+            });
+
+    export const generate =
+        (collection: MetadataCollection) =>
+        (dict: Map<string, IProtocolMessage>) =>
+        (meta: Metadata) => {
+            // EMPLACE OBJECTS
+            for (const obj of collection.objects())
+                emplace_protocol_object(dict)(obj);
+
+            // WHEN NOT OBJECT, WRAP IT INTO A FAKE MAIN OBJECT
+            iterate_protocol_main(dict)(meta);
+        };
+
+    const is_atomic_key = (key: Metadata) => {
+        if (
+            key.required &&
+            key.nullable === false &&
+            key.functional === false &&
+            key.resolved === null &&
+            key.size() ===
+                key.atomics.length +
+                    key.constants
+                        .map((c) => c.values.length)
+                        .reduce((a, b) => a + b, 0) +
+                    key.templates.length
+        ) {
+            const set: Set<string> = new Set();
+            for (const atomic of key.atomics) set.add(atomic);
+            for (const constant of key.constants) set.add(constant.type);
+            if (key.templates.length) set.add("string");
+
+            return set.size === 1;
+        }
+        return false;
+    };
+}
+
+const enum ErrorMessages {
+    NO_ANY = `Error on typia.message(): any type is not supported in protocol buffer.`,
+    NO_FUNCTIONAL = `Error on typia.message(): functional type is not supported in protocol buffer.`,
+    NO_MAIN = `Error on typia.message(): reserved type "__Main" has been detected.`,
+    NO_TIMESTAMP = `Error on typia.message(): reserved type "__Timestamp" has been detected.`,
+    NOT_ALLOWED_KEY = `Error on typia.message(): only atomic key type is supported in protocol buffer.`,
+}