@hy_ong/zod-kit 0.0.2 → 0.0.5

package/dist/index.d.ts

@@ -1,84 +1,376 @@
 import { ZodBoolean, ZodNullable, ZodString, ZodNumber } from 'zod';
 
+type Locale = "zh-TW" | "en";
+declare const setLocale: (locale: Locale) => void;
+declare const getLocale: () => Locale;
+
+type BooleanMessages = {
+    required?: string;
+    shouldBeTrue?: string;
+    shouldBeFalse?: string;
+    invalid?: string;
+};
 type BooleanOptions<IsRequired extends boolean = true> = {
     required?: IsRequired;
-    label: string;
     defaultValue?: IsRequired extends true ? boolean : boolean | null;
     shouldBe?: boolean;
+    truthyValues?: unknown[];
+    falsyValues?: unknown[];
+    strict?: boolean;
+    transform?: (value: boolean) => boolean;
+    i18n?: Record<Locale, BooleanMessages>;
 };
 type BooleanSchema<IsRequired extends boolean> = IsRequired extends true ? ZodBoolean : ZodNullable<ZodBoolean>;
 declare function boolean<IsRequired extends boolean = true>(options?: BooleanOptions<IsRequired>): BooleanSchema<IsRequired>;
 
-type EmailOptions<IsRequired extends boolean = true> = {
+type DateMessages = {
+    required?: string;
+    invalid?: string;
+    format?: string;
+    min?: string;
+    max?: string;
+    includes?: string;
+    excludes?: string;
+    past?: string;
+    future?: string;
+    today?: string;
+    notToday?: string;
+    weekday?: string;
+    notWeekday?: string;
+    weekend?: string;
+    notWeekend?: string;
+};
+type DateOptions<IsRequired extends boolean = true> = {
     required?: IsRequired;
-    label: string;
+    min?: string;
+    max?: string;
+    format?: string;
+    includes?: string;
+    excludes?: string | string[];
+    mustBePast?: boolean;
+    mustBeFuture?: boolean;
+    mustBeToday?: boolean;
+    mustNotBeToday?: boolean;
+    weekdaysOnly?: boolean;
+    weekendsOnly?: boolean;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, DateMessages>;
+};
+type DateSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare function date<IsRequired extends boolean = true>(options?: DateOptions<IsRequired>): DateSchema<IsRequired>;
+
+type EmailMessages = {
+    required?: string;
+    invalid?: string;
+    minLength?: string;
+    maxLength?: string;
+    includes?: string;
     domain?: string;
-    min?: number;
-    max?: number;
+    domainBlacklist?: string;
+    businessOnly?: string;
+    noDisposable?: string;
+};
+type EmailOptions<IsRequired extends boolean = true> = {
+    required?: IsRequired;
+    domain?: string | string[];
+    domainBlacklist?: string[];
+    minLength?: number;
+    maxLength?: number;
     includes?: string;
+    excludes?: string | string[];
+    allowSubdomains?: boolean;
+    businessOnly?: boolean;
+    noDisposable?: boolean;
+    lowercase?: boolean;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, EmailMessages>;
 };
 type EmailSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 declare function email<IsRequired extends boolean = true>(options?: EmailOptions<IsRequired>): EmailSchema<IsRequired>;
 
-type UrlOptions<IsRequired extends boolean = true> = {
-    required?: IsRequired;
-    label: string;
-    min?: number;
-    max?: number;
+type IdMessages = {
+    required?: string;
+    invalid?: string;
+    minLength?: string;
+    maxLength?: string;
+    numeric?: string;
+    uuid?: string;
+    objectId?: string;
+    nanoid?: string;
+    snowflake?: string;
+    cuid?: string;
+    ulid?: string;
+    shortid?: string;
+    customFormat?: string;
     includes?: string;
+    excludes?: string;
+    startsWith?: string;
+    endsWith?: string;
 };
-type UrlSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
-declare function url<IsRequired extends boolean = true>(options?: UrlOptions<IsRequired>): UrlSchema<IsRequired>;
-
-type TextOptions<IsRequired extends boolean = true> = {
+type IdType = "numeric" | "uuid" | "objectId" | "nanoid" | "snowflake" | "cuid" | "ulid" | "shortid" | "auto";
+type IdOptions<IsRequired extends boolean = true> = {
     required?: IsRequired;
-    label: string;
-    min?: number;
-    max?: number;
+    type?: IdType;
+    minLength?: number;
+    maxLength?: number;
+    allowedTypes?: IdType[];
+    customRegex?: RegExp;
+    includes?: string;
+    excludes?: string | string[];
     startsWith?: string;
     endsWith?: string;
-    includes?: string;
-    regex?: RegExp;
+    caseSensitive?: boolean;
+    transform?: (value: string) => string;
     defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, IdMessages>;
 };
-type TextSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
-declare function text<IsRequired extends boolean = true>(options?: TextOptions<IsRequired>): TextSchema<IsRequired>;
+type IdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const ID_PATTERNS: {
+    readonly numeric: RegExp;
+    readonly uuid: RegExp;
+    readonly objectId: RegExp;
+    readonly nanoid: RegExp;
+    readonly snowflake: RegExp;
+    readonly cuid: RegExp;
+    readonly ulid: RegExp;
+    readonly shortid: RegExp;
+};
+declare const detectIdType: (value: string) => IdType | null;
+declare const validateIdType: (value: string, type: IdType) => boolean;
+declare function id<IsRequired extends boolean = true>(options?: IdOptions<IsRequired>): IdSchema<IsRequired>;
 
+type NumberMessages = {
+    required?: string;
+    invalid?: string;
+    integer?: string;
+    float?: string;
+    min?: string;
+    max?: string;
+    positive?: string;
+    negative?: string;
+    nonNegative?: string;
+    nonPositive?: string;
+    multipleOf?: string;
+    finite?: string;
+    precision?: string;
+};
 type NumberOptions<IsRequired extends boolean = true> = {
     required?: IsRequired;
-    label: string;
     min?: number;
     max?: number;
     defaultValue?: IsRequired extends true ? number : number | null;
+    type?: "integer" | "float" | "both";
+    positive?: boolean;
+    negative?: boolean;
+    nonNegative?: boolean;
+    nonPositive?: boolean;
+    multipleOf?: number;
+    precision?: number;
+    finite?: boolean;
+    transform?: (value: number) => number;
+    parseCommas?: boolean;
+    i18n?: Record<Locale, NumberMessages>;
 };
 type NumberSchema<IsRequired extends boolean> = IsRequired extends true ? ZodNumber : ZodNullable<ZodNumber>;
 declare function number<IsRequired extends boolean = true>(options?: NumberOptions<IsRequired>): NumberSchema<IsRequired>;
 
+type PasswordMessages = {
+    required?: string;
+    min?: string;
+    max?: string;
+    uppercase?: string;
+    lowercase?: string;
+    digits?: string;
+    special?: string;
+    noRepeating?: string;
+    noSequential?: string;
+    noCommonWords?: string;
+    minStrength?: string;
+    excludes?: string;
+    includes?: string;
+    invalid?: string;
+};
+type PasswordStrength = "weak" | "medium" | "strong" | "very-strong";
 type PasswordOptions<IsRequired extends boolean = true> = {
     required?: IsRequired;
-    label: string;
     min?: number;
     max?: number;
     uppercase?: boolean;
     lowercase?: boolean;
     digits?: boolean;
     special?: boolean;
+    noRepeating?: boolean;
+    noSequential?: boolean;
+    noCommonWords?: boolean;
+    minStrength?: PasswordStrength;
+    excludes?: string | string[];
+    includes?: string;
+    regex?: RegExp;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, PasswordMessages>;
 };
 type PasswordSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
 declare function password<IsRequired extends boolean = true>(options?: PasswordOptions<IsRequired>): PasswordSchema<IsRequired>;
 
-type IntegerOptions<IsRequired extends boolean = true> = {
+type TextMessages = {
+    required?: string;
+    notEmpty?: string;
+    minLength?: string;
+    maxLength?: string;
+    startsWith?: string;
+    endsWith?: string;
+    includes?: string;
+    excludes?: string;
+    invalid?: string;
+};
+type TextOptions<IsRequired extends boolean = true> = {
+    required?: IsRequired;
+    minLength?: number;
+    maxLength?: number;
+    startsWith?: string;
+    endsWith?: string;
+    includes?: string;
+    excludes?: string | string[];
+    regex?: RegExp;
+    trimMode?: "trim" | "trimStart" | "trimEnd" | "none";
+    casing?: "upper" | "lower" | "title" | "none";
+    transform?: (value: string) => string;
+    notEmpty?: boolean;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, TextMessages>;
+};
+type TextSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare function text<IsRequired extends boolean = true>(options?: TextOptions<IsRequired>): TextSchema<IsRequired>;
+
+type UrlMessages = {
+    required?: string;
+    invalid?: string;
+    min?: string;
+    max?: string;
+    includes?: string;
+    excludes?: string;
+    protocol?: string;
+    domain?: string;
+    domainBlacklist?: string;
+    port?: string;
+    pathStartsWith?: string;
+    pathEndsWith?: string;
+    hasQuery?: string;
+    noQuery?: string;
+    hasFragment?: string;
+    noFragment?: string;
+    localhost?: string;
+    noLocalhost?: string;
+};
+type UrlOptions<IsRequired extends boolean = true> = {
     required?: IsRequired;
-    label: string;
     min?: number;
     max?: number;
-    defaultValue?: IsRequired extends true ? number : number | null;
+    includes?: string;
+    excludes?: string | string[];
+    protocols?: string[];
+    allowedDomains?: string[];
+    blockedDomains?: string[];
+    allowedPorts?: number[];
+    blockedPorts?: number[];
+    pathStartsWith?: string;
+    pathEndsWith?: string;
+    mustHaveQuery?: boolean;
+    mustNotHaveQuery?: boolean;
+    mustHaveFragment?: boolean;
+    mustNotHaveFragment?: boolean;
+    allowLocalhost?: boolean;
+    blockLocalhost?: boolean;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, UrlMessages>;
 };
-type IntegerSchema<IsRequired extends boolean> = IsRequired extends true ? ZodNumber : ZodNullable<ZodNumber>;
-declare function integer<IsRequired extends boolean = true>(options?: IntegerOptions<IsRequired>): IntegerSchema<IsRequired>;
+type UrlSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare function url<IsRequired extends boolean = true>(options?: UrlOptions<IsRequired>): UrlSchema<IsRequired>;
 
-type Locale = "zh-TW" | "en";
-declare const setLocale: (locale: Locale) => void;
-declare const getLocale: () => Locale;
+type BusinessIdMessages = {
+    required?: string;
+    invalid?: string;
+};
+type BusinessIdOptions<IsRequired extends boolean = true> = {
+    required?: IsRequired;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, BusinessIdMessages>;
+};
+type BusinessIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanBusinessId: (value: string) => boolean;
+declare function businessId<IsRequired extends boolean = true>(options?: BusinessIdOptions<IsRequired>): BusinessIdSchema<IsRequired>;
+
+type NationalIdMessages = {
+    required?: string;
+    invalid?: string;
+};
+type NationalIdType = "citizen" | "resident" | "both";
+type NationalIdOptions<IsRequired extends boolean = true> = {
+    required?: IsRequired;
+    type?: NationalIdType;
+    allowOldResident?: boolean;
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, NationalIdMessages>;
+};
+type NationalIdSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateCitizenId: (value: string) => boolean;
+declare const validateOldResidentId: (value: string) => boolean;
+declare const validateNewResidentId: (value: string) => boolean;
+declare const validateTaiwanNationalId: (value: string, type?: NationalIdType, allowOldResident?: boolean) => boolean;
+declare function nationalId<IsRequired extends boolean = true>(options?: NationalIdOptions<IsRequired>): NationalIdSchema<IsRequired>;
+
+type MobileMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+type MobileOptions<IsRequired extends boolean = true> = {
+    required?: IsRequired;
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, MobileMessages>;
+};
+type MobileSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanMobile: (value: string) => boolean;
+declare function mobile<IsRequired extends boolean = true>(options?: MobileOptions<IsRequired>): MobileSchema<IsRequired>;
+
+type TelMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+type TelOptions<IsRequired extends boolean = true> = {
+    required?: IsRequired;
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, TelMessages>;
+};
+type TelSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanTel: (value: string) => boolean;
+declare function tel<IsRequired extends boolean = true>(options?: TelOptions<IsRequired>): TelSchema<IsRequired>;
+
+type FaxMessages = {
+    required?: string;
+    invalid?: string;
+    notInWhitelist?: string;
+};
+type FaxOptions<IsRequired extends boolean = true> = {
+    required?: IsRequired;
+    whitelist?: string[];
+    transform?: (value: string) => string;
+    defaultValue?: IsRequired extends true ? string : string | null;
+    i18n?: Record<Locale, FaxMessages>;
+};
+type FaxSchema<IsRequired extends boolean> = IsRequired extends true ? ZodString : ZodNullable<ZodString>;
+declare const validateTaiwanFax: (value: string) => boolean;
+declare function fax<IsRequired extends boolean = true>(options?: FaxOptions<IsRequired>): FaxSchema<IsRequired>;
 
-export { type BooleanOptions, type BooleanSchema, type EmailOptions, type EmailSchema, type IntegerOptions, type IntegerSchema, type Locale, type NumberOptions, type NumberSchema, type PasswordOptions, type PasswordSchema, type TextOptions, type TextSchema, type UrlOptions, type UrlSchema, boolean, email, getLocale, integer, number, password, setLocale, text, url };
+export { type BooleanMessages, type BooleanOptions, type BooleanSchema, type BusinessIdMessages, type BusinessIdOptions, type BusinessIdSchema, type DateMessages, type DateOptions, type DateSchema, type EmailMessages, type EmailOptions, type EmailSchema, type FaxMessages, type FaxOptions, type FaxSchema, ID_PATTERNS, type IdMessages, type IdOptions, type IdSchema, type IdType, type Locale, type MobileMessages, type MobileOptions, type MobileSchema, type NationalIdMessages, type NationalIdOptions, type NationalIdSchema, type NationalIdType, type NumberMessages, type NumberOptions, type NumberSchema, type PasswordMessages, type PasswordOptions, type PasswordSchema, type PasswordStrength, type TelMessages, type TelOptions, type TelSchema, type TextMessages, type TextOptions, type TextSchema, type UrlMessages, type UrlOptions, type UrlSchema, boolean, businessId, date, detectIdType, email, fax, getLocale, id, mobile, nationalId, number, password, setLocale, tel, text, url, validateCitizenId, validateIdType, validateNewResidentId, validateOldResidentId, validateTaiwanBusinessId, validateTaiwanFax, validateTaiwanMobile, validateTaiwanNationalId, validateTaiwanTel };