typia 8.0.3 → 8.1.0

package/lib/notations.d.mts

@@ -0,0 +1,551 @@
+import { CamelCase } from "./CamelCase";
+import { IValidation } from "./IValidation";
+import { PascalCase } from "./PascalCase";
+import { SnakeCase } from "./SnakeCase";
+import { TypeGuardError } from "./TypeGuardError";
+/**
+ * Convert to camel case.
+ *
+ * Convert every property names of nested objects to follow the camel case convention.
+ *
+ * For reference, this `typia.notations.camel()` function does not validate the input value
+ * type. It just believes that the input value is following the type `T`. Therefore,
+ * if you can't ensure the input value type, it would be better to call one of them below:
+ *
+ * - {@link assertCamel}
+ * - {@link isCamel}
+ * - {@link validateCamel}
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Camel case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function camel<T>(input: T): CamelCase<T>;
+/**
+ * Converts to camel case with type assertion.
+ *
+ * Convert every property names of nested objects to follow the camel case convention.
+ * If the input value does not follow the type `T`, it throws {@link TypeGuardError}.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Camel case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function assertCamel<T>(input: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): CamelCase<T>;
+/**
+ * Converts to camel case with type assertion.
+ *
+ * Convert every property names of nested objects to follow the camel case convention.
+ * If the input value does not follow the type `T`, it throws {@link TypeGuardError}.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Camel case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function assertCamel<T>(input: unknown, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): CamelCase<T>;
+/**
+ * Converts to camel case with type checking.
+ *
+ * Convert every property names of nested objects to follow the camel case convention.
+ * If the input value does not follow the type `T`, it returns `null` value instead.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Camel case object when exact type, otherwise null
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function isCamel<T>(input: T): CamelCase<T> | null;
+/**
+ * Converts to camel case with type checking.
+ *
+ * Convert every property names of nested objects to follow the camel case convention.
+ * If the input value does not follow the type `T`, it returns `null` value instead.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Camel case object when exact type, otherwise null
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function isCamel<T>(input: unknown): CamelCase<T> | null;
+/**
+ * Converts to camel case with type validation.
+ *
+ * Convert every property names of nested objects to follow the camel case convention.
+ * If the input value does not follow the type `T`, it returns {@link IValidation.Failure}
+ * object. Otherwise, there's no problem on the input value, camel cased converted data
+ * would be stored in the `data` property of the output {@link IValidation.Success} object.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Validation result with camel case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function validateCamel<T>(input: T): IValidation<CamelCase<T>>;
+/**
+ * Converts to camel case with type validation.
+ *
+ * Convert every property names of nested objects to follow the camel case convention.
+ * If the input value does not follow the type `T`, it returns {@link IValidation.Failure}
+ * object. Otherwise, there's no problem on the input value, camel cased converted data
+ * would be stored in the `data` property of the output {@link IValidation.Success} object.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Validation result with camel case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function validateCamel<T>(input: unknown): IValidation<CamelCase<T>>;
+/**
+ * Convert to pascal case.
+ *
+ * Convert every property names of nested objects to follow the pascal case convention.
+ *
+ * For reference, this `typia.notations.pascal()` function does not validate the input value
+ * type. It just believes that the input value is following the type `T`. Therefore,
+ * if you can't ensure the input value type, it would be better to call one of them below:
+ *
+ * - {@link assertPascal}
+ * - {@link isPascal}
+ * - {@link validatePascal}
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Pascal case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function pascal<T>(input: T): PascalCase<T>;
+/**
+ * Converts to pascal case with type assertion.
+ *
+ * Convert every property names of nested objects to follow the pascal case convention.
+ * If the input value does not follow the type `T`, it throws {@link TypeGuardError}.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Pascal case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function assertPascal<T>(input: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): PascalCase<T>;
+/**
+ * Converts to pascal case with type assertion.
+ *
+ * Convert every property names of nested objects to follow the pascal case convention.
+ * If the input value does not follow the type `T`, it throws {@link TypeGuardError}.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Pascal case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function assertPascal<T>(input: unknown, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): PascalCase<T>;
+/**
+ * Converts to pascal case with type checking.
+ *
+ * Convert every property names of nested objects to follow the pascal case convention.
+ * If the input value does not follow the type `T`, it returns `null` value instead.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Pascal case object when exact type, otherwise null
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function isPascal<T>(input: T): PascalCase<T> | null;
+/**
+ * Converts to pascal case with type checking.
+ *
+ * Convert every property names of nested objects to follow the pascal case convention.
+ * If the input value does not follow the type `T`, it returns `null` value instead.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Pascal case object when exact type, otherwise null
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function isPascal<T>(input: unknown): PascalCase<T> | null;
+/**
+ * Converts to pascal case with type validation.
+ *
+ * Convert every property names of nested objects to follow the pascal case convention.
+ * If the input value does not follow the type `T`, it returns {@link IValidation.Failure}
+ * object. Otherwise, there's no problem on the input value, pascal cased converted data
+ * would be stored in the `data` property of the output {@link IValidation.Success} object.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Validation result with pascal case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function validatePascal<T>(input: T): IValidation<PascalCase<T>>;
+/**
+ * Converts to pascal case with type validation.
+ *
+ * Convert every property names of nested objects to follow the pascal case convention.
+ * If the input value does not follow the type `T`, it returns {@link IValidation.Failure}
+ * object. Otherwise, there's no problem on the input value, pascal cased converted data
+ * would be stored in the `data` property of the output {@link IValidation.Success} object.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Validation result with pascal case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function validatePascal<T>(input: unknown): IValidation<PascalCase<T>>;
+/**
+ * Convert to snake case.
+ *
+ * Convert every property names of nested objects to follow the snake case convention.
+ *
+ * For reference, this `typia.notations.snake()` function does not validate the input value
+ * type. It just believes that the input value is following the type `T`. Therefore,
+ * if you can't ensure the input value type, it would be better to call one of them below:
+ *
+ * - {@link assertSnake}
+ * - {@link isSnake}
+ * - {@link validateSnake}
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Snake case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function snake<T>(input: T): SnakeCase<T>;
+/**
+ * Converts to snake case with type assertion.
+ *
+ * Convert every property names of nested objects to follow the snake case convention.
+ * If the input value does not follow the type `T`, it throws {@link TypeGuardError}.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Snake case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function assertSnake<T>(input: T, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): SnakeCase<T>;
+/**
+ * Converts to snake case with type assertion.
+ *
+ * Convert every property names of nested objects to follow the snake case convention.
+ * If the input value does not follow the type `T`, it throws {@link TypeGuardError}.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Snake case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function assertSnake<T>(input: unknown, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): SnakeCase<T>;
+/**
+ * Converts to snake case with type checking.
+ *
+ * Convert every property names of nested objects to follow the snake case convention.
+ * If the input value does not follow the type `T`, it returns `null` value instead.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Snake case object when exact type, otherwise null
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function isSnake<T>(input: T): SnakeCase<T> | null;
+/**
+ * Converts to snake case with type checking.
+ *
+ * Convert every property names of nested objects to follow the snake case convention.
+ * If the input value does not follow the type `T`, it returns `null` value instead.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Snake case object when exact type, otherwise null
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function isSnake<T>(input: unknown): SnakeCase<T> | null;
+/**
+ * Converts to snake case with type validation.
+ *
+ * Convert every property names of nested objects to follow the snake case convention.
+ * If the input value does not follow the type `T`, it returns {@link IValidation.Failure}
+ * object. Otherwise, there's no problem on the input value, snake cased converted data
+ * would be stored in the `data` property of the output {@link IValidation.Success} object.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Validation result with snake case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function validateSnake<T>(input: T): IValidation<SnakeCase<T>>;
+/**
+ * Converts to snake case with type validation.
+ *
+ * Convert every property names of nested objects to follow the snake case convention.
+ * If the input value does not follow the type `T`, it returns {@link IValidation.Failure}
+ * object. Otherwise, there's no problem on the input value, snake cased converted data
+ * would be stored in the `data` property of the output {@link IValidation.Success} object.
+ *
+ * @template T Type of the input value
+ * @param input Target object
+ * @returns Validation result with snake case object
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function validateSnake<T>(input: unknown): IValidation<SnakeCase<T>>;
+/**
+ * Creates a reusable {@link camel} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createCamel(): never;
+/**
+ * Creates a reusable {@link camel} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `camel` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createCamel<T>(): (input: T) => CamelCase<T>;
+/**
+ * Creates a reusable {@link assertCamel} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createAssertCamel(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
+/**
+ * Creates a reusable {@link assertCamel} function.
+ *
+ * @template T Type of the input value
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns A reusable `assertCamel` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createAssertCamel<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: T) => CamelCase<T>;
+/**
+ * Creates a reusable {@link isCamel} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createIsCamel(): never;
+/**
+ * Creates a reusable {@link isCamel} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `isCamel` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createIsCamel<T>(): (input: T) => CamelCase<T> | null;
+/**
+ * Creates a reusable {@link validateCamel} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createValidateCamel(): never;
+/**
+ * Creates a reusable {@link validateCamel} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `validateCamel` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createValidateCamel<T>(): (input: T) => IValidation<CamelCase<T>>;
+/**
+ * Creates a reusable {@link pascal} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createPascal(): never;
+/**
+ * Creates a reusable {@link pascal} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `pascal` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createPascal<T>(): (input: T) => PascalCase<T>;
+/**
+ * Creates a reusable {@link assertPascal} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createAssertPascal(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
+/**
+ * Creates a reusable {@link assertPascal} function.
+ *
+ * @template T Type of the input value
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns A reusable `assertPascal` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createAssertPascal<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: T) => PascalCase<T>;
+/**
+ * Creates a reusable {@link isPascal} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createIsPascal(): never;
+/**
+ * Creates a reusable {@link isPascal} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `isPascal` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createIsPascal<T>(): (input: T) => PascalCase<T> | null;
+/**
+ * Creates a reusable {@link validatePascal} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createValidatePascal(): never;
+/**
+ * Creates a reusable {@link validatePascal} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `validatePascal` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createValidatePascal<T>(): (input: T) => IValidation<PascalCase<T>>;
+/**
+ * Creates a reusable {@link snake} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createSnake(): never;
+/**
+ * Creates a reusable {@link snake} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `snake` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createSnake<T>(): (input: T) => SnakeCase<T>;
+/**
+ * Creates a reusable {@link assertSnake} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createAssertSnake(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never;
+/**
+ * Creates a reusable {@link assertSnake} function.
+ *
+ * @template T Type of the input value
+ * @param errorFactory Custom error factory. Default is `TypeGuardError`
+ * @returns A reusable `assertSnake` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createAssertSnake<T>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: T) => SnakeCase<T>;
+/**
+ * Creates a reusable {@link isSnake} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createIsSnake(): never;
+/**
+ * Creates a reusable {@link isSnake} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `isSnake` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createIsSnake<T>(): (input: T) => SnakeCase<T> | null;
+/**
+ * Creates a reusable {@link validateSnake} function.
+ *
+ * @danger You must configure the generic argument `T`
+ * @returns Nothing until be configure the generic argument `T`
+ * @throws compile error
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createValidateSnake(): never;
+/**
+ * Creates a reusable {@link validateSnake} function.
+ *
+ * @template T Type of the input value
+ * @returns A reusable `validateSnake` function
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export declare function createValidateSnake<T>(): (input: T) => IValidation<SnakeCase<T>>;

package/lib/programmers/AssertProgrammer.d.mts

@@ -0,0 +1,31 @@
+import ts from "typescript";
+import { IProgrammerProps } from "../transformers/IProgrammerProps";
+import { ITypiaContext } from "../transformers/ITypiaContext";
+import { FeatureProgrammer } from "./FeatureProgrammer";
+import { FunctionProgrammer } from "./helpers/FunctionProgrammer";
+export declare namespace AssertProgrammer {
+    interface IConfig {
+        equals: boolean;
+        guard: boolean;
+    }
+    interface IProps extends IProgrammerProps {
+        config: IConfig;
+    }
+    const decompose: (props: {
+        config: IConfig;
+        context: ITypiaContext;
+        functor: FunctionProgrammer;
+        type: ts.Type;
+        name: string | undefined;
+        init?: ts.Expression | undefined;
+    }) => FeatureProgrammer.IDecomposed;
+    const write: (props: IProps) => ts.CallExpression;
+    namespace Guardian {
+        const identifier: () => ts.Identifier;
+        const parameter: (props: {
+            context: ITypiaContext;
+            init: ts.Expression | undefined;
+        }) => ts.ParameterDeclaration;
+        const type: (context: ITypiaContext) => ts.FunctionTypeNode;
+    }
+}