schema-dsl 1.2.4 → 2.0.0

package/dist/plugin-CIKtTMtS.d.cts

@@ -0,0 +1,246 @@
+/**
+ * Error message templates (custom validation error copy).
+ */
+interface ErrorMessages {
+    min?: string;
+    max?: string;
+    minLength?: string;
+    maxLength?: string;
+    minimum?: string;
+    maximum?: string;
+    minItems?: string;
+    maxItems?: string;
+    type?: string;
+    string?: string;
+    number?: string;
+    integer?: string;
+    boolean?: string;
+    array?: string;
+    object?: string;
+    email?: string;
+    url?: string;
+    date?: string;
+    dateTime?: string;
+    uuid?: string;
+    ipv4?: string;
+    ipv6?: string;
+    pattern?: string;
+    format?: string;
+    required?: string;
+    enum?: string;
+    uniqueItems?: string;
+    exactLength?: string;
+    phone?: string;
+    idCard?: string;
+    creditCard?: string;
+    [key: string]: string | undefined;
+}
+/**
+ * Error code constant type (shape of the ErrorCodes object).
+ */
+interface ErrorCodeMap {
+    VALIDATION_ERROR: 'VALIDATION_ERROR';
+    INVALID_SCHEMA: 'INVALID_SCHEMA';
+    INVALID_CONFIG: 'INVALID_CONFIG';
+    INVALID_LOCALE: 'INVALID_LOCALE';
+    PLUGIN_INSTALL_ERROR: 'PLUGIN_INSTALL_ERROR';
+    PLUGIN_NOT_FOUND: 'PLUGIN_NOT_FOUND';
+    [key: string]: string;
+}
+
+/**
+ * JSON Schema Draft 7 type definitions.
+ * Includes schema-dsl internal keys (prefixed with _; stripped by toJsonSchema()).
+ */
+
+interface JSONSchema {
+    type?: string | string[];
+    properties?: Record<string, JSONSchema>;
+    required?: string[];
+    minLength?: number;
+    maxLength?: number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number | boolean;
+    exclusiveMaximum?: number | boolean;
+    multipleOf?: number;
+    pattern?: string;
+    format?: string;
+    enum?: unknown[];
+    const?: unknown;
+    items?: JSONSchema | JSONSchema[];
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+    additionalProperties?: boolean | JSONSchema;
+    allOf?: JSONSchema[];
+    anyOf?: JSONSchema[];
+    oneOf?: JSONSchema[];
+    not?: JSONSchema;
+    if?: JSONSchema;
+    then?: JSONSchema;
+    else?: JSONSchema;
+    title?: string;
+    description?: string;
+    default?: unknown;
+    examples?: unknown[];
+    $ref?: string;
+    $schema?: string;
+    $id?: string;
+    definitions?: Record<string, JSONSchema>;
+    $defs?: Record<string, JSONSchema>;
+    _label?: string;
+    _customMessages?: Record<string, string>;
+    _description?: string;
+    _required?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * SchemaIO configuration options (backwards-compatible with v1).
+ */
+interface SchemaIOOptions {
+    allErrors?: boolean;
+    verbose?: boolean;
+    messages?: ErrorMessages;
+    locale?: string;
+    cache?: boolean;
+    cacheSize?: number;
+    [key: string]: unknown;
+}
+
+/**
+ * Cache configuration options.
+ * @alias CacheConfig — v1 BC alias exported from index
+ */
+interface CacheOptions {
+    /** Maximum number of cache entries (default 5000). */
+    maxSize?: number;
+    /** Cache TTL in milliseconds (0 = no expiry). */
+    ttl?: number;
+    /** Whether caching is enabled. */
+    enabled?: boolean;
+    /** Whether statistics are enabled (default true). */
+    statsEnabled?: boolean;
+}
+/**
+ * I18n configuration type.
+ */
+type I18nConfig = string | Record<string, ErrorMessages> | {
+    localesPath: string;
+} | {
+    locales: Record<string, ErrorMessages>;
+};
+/**
+ * dsl.config() options.
+ */
+interface DslConfigOptions {
+    /** Internationalisation config. */
+    i18n?: I18nConfig;
+    /** Cache config. */
+    cache?: CacheOptions;
+    /** Custom validation rule extensions. */
+    patterns?: {
+        phone?: Record<string, RegExp>;
+        idCard?: Record<string, RegExp>;
+        creditCard?: Record<string, RegExp>;
+        [key: string]: Record<string, RegExp> | undefined;
+    };
+    /** Default locale (default 'en-US'). */
+    defaultLocale?: string;
+    /** Strict type resolution: throw on unknown types instead of warn + fallback to string. */
+    strict?: boolean;
+}
+/**
+ * ValidatorOptions (Validator class constructor parameters).
+ */
+interface ValidatorOptions {
+    allErrors?: boolean;
+    verbose?: boolean;
+    strict?: boolean;
+    coerceTypes?: boolean | 'array';
+    removeAdditional?: boolean | 'all' | 'failing';
+    useDefaults?: boolean;
+    cache?: boolean | CacheOptions;
+}
+
+/**
+ * Validation options.
+ */
+
+interface ValidateOptions {
+    /** Whether to format errors (default true). */
+    format?: boolean;
+    /** Whether to return all errors (default false — only the first). */
+    allErrors?: boolean;
+    /** Dynamically specify a locale (e.g. 'zh-CN', 'en-US', 'ja-JP', 'es-ES', 'fr-FR'). */
+    locale?: string;
+    /** Custom error messages. */
+    messages?: ErrorMessages;
+    /** Whether to enable smart type coercion (auto-converts string → number etc.). */
+    smartCoerce?: boolean;
+    /** Whether to remove additional properties. */
+    removeAdditional?: boolean | 'all' | 'failing';
+    /** Whether to enable caching. */
+    cache?: boolean | CacheOptions;
+    /** Whether to enable strict mode. */
+    strict?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * Validation result.
+ */
+interface ValidationResult<T = unknown> {
+    /** Whether validation passed. */
+    valid: boolean;
+    /** Snapshot of the data after validation (returned on both success and failure; useful for locating input on failure). */
+    data?: T;
+    /** Error list (empty array on success; detailed errors on failure). */
+    errors?: ValidationErrorItem[];
+    /** First error message (convenience accessor). */
+    errorMessage?: string;
+}
+/**
+ * Validation error item (element of ValidationResult.errors).
+ */
+interface ValidationErrorItem {
+    /** Error message. */
+    message: string;
+    /** Error field path (dot-separated, e.g. 'user.email'). */
+    path: string;
+    /** Validation keyword (min, max, email, pattern, etc.). */
+    keyword: string;
+    /** Validation parameters. */
+    params?: Record<string, unknown>;
+    /** Alias for path (backwards compatibility). */
+    field?: string;
+    /** Alias for keyword (backwards-compatible with v1 err.type). */
+    type?: string | undefined;
+    /** Expected type (backwards-compatible with v1 err.expected; only present for type errors). */
+    expected?: string | undefined;
+}
+
+/**
+ * Hook function type (accepts arbitrary arguments; compatible with v1 custom hook names).
+ */
+type HookFn = (...args: unknown[]) => unknown | Promise<unknown>;
+/**
+ * Plugin interface (backwards-compatible with v1).
+ */
+interface Plugin {
+    /** Plugin name. */
+    name: string;
+    /** Plugin version. */
+    version?: string;
+    /** Plugin description. */
+    description?: string;
+    /** Plugin options (passed as the second argument to install). */
+    options?: Record<string, unknown>;
+    /** Plugin hook map (supports arbitrary hook names for v1 compatibility). */
+    hooks?: Record<string, HookFn>;
+    /** Install method. */
+    install?(core: unknown, options?: unknown, context?: unknown): void;
+    /** Uninstall method (optional). */
+    uninstall?(core?: unknown, context?: unknown): void;
+}
+
+export type { CacheOptions as C, DslConfigOptions as D, ErrorMessages as E, HookFn as H, I18nConfig as I, JSONSchema as J, Plugin as P, SchemaIOOptions as S, ValidationResult as V, ValidationErrorItem as a, ErrorCodeMap as b, ValidateOptions as c, ValidatorOptions as d };

package/dist/plugin-CIKtTMtS.d.ts

@@ -0,0 +1,246 @@
+/**
+ * Error message templates (custom validation error copy).
+ */
+interface ErrorMessages {
+    min?: string;
+    max?: string;
+    minLength?: string;
+    maxLength?: string;
+    minimum?: string;
+    maximum?: string;
+    minItems?: string;
+    maxItems?: string;
+    type?: string;
+    string?: string;
+    number?: string;
+    integer?: string;
+    boolean?: string;
+    array?: string;
+    object?: string;
+    email?: string;
+    url?: string;
+    date?: string;
+    dateTime?: string;
+    uuid?: string;
+    ipv4?: string;
+    ipv6?: string;
+    pattern?: string;
+    format?: string;
+    required?: string;
+    enum?: string;
+    uniqueItems?: string;
+    exactLength?: string;
+    phone?: string;
+    idCard?: string;
+    creditCard?: string;
+    [key: string]: string | undefined;
+}
+/**
+ * Error code constant type (shape of the ErrorCodes object).
+ */
+interface ErrorCodeMap {
+    VALIDATION_ERROR: 'VALIDATION_ERROR';
+    INVALID_SCHEMA: 'INVALID_SCHEMA';
+    INVALID_CONFIG: 'INVALID_CONFIG';
+    INVALID_LOCALE: 'INVALID_LOCALE';
+    PLUGIN_INSTALL_ERROR: 'PLUGIN_INSTALL_ERROR';
+    PLUGIN_NOT_FOUND: 'PLUGIN_NOT_FOUND';
+    [key: string]: string;
+}
+
+/**
+ * JSON Schema Draft 7 type definitions.
+ * Includes schema-dsl internal keys (prefixed with _; stripped by toJsonSchema()).
+ */
+
+interface JSONSchema {
+    type?: string | string[];
+    properties?: Record<string, JSONSchema>;
+    required?: string[];
+    minLength?: number;
+    maxLength?: number;
+    minimum?: number;
+    maximum?: number;
+    exclusiveMinimum?: number | boolean;
+    exclusiveMaximum?: number | boolean;
+    multipleOf?: number;
+    pattern?: string;
+    format?: string;
+    enum?: unknown[];
+    const?: unknown;
+    items?: JSONSchema | JSONSchema[];
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+    additionalProperties?: boolean | JSONSchema;
+    allOf?: JSONSchema[];
+    anyOf?: JSONSchema[];
+    oneOf?: JSONSchema[];
+    not?: JSONSchema;
+    if?: JSONSchema;
+    then?: JSONSchema;
+    else?: JSONSchema;
+    title?: string;
+    description?: string;
+    default?: unknown;
+    examples?: unknown[];
+    $ref?: string;
+    $schema?: string;
+    $id?: string;
+    definitions?: Record<string, JSONSchema>;
+    $defs?: Record<string, JSONSchema>;
+    _label?: string;
+    _customMessages?: Record<string, string>;
+    _description?: string;
+    _required?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * SchemaIO configuration options (backwards-compatible with v1).
+ */
+interface SchemaIOOptions {
+    allErrors?: boolean;
+    verbose?: boolean;
+    messages?: ErrorMessages;
+    locale?: string;
+    cache?: boolean;
+    cacheSize?: number;
+    [key: string]: unknown;
+}
+
+/**
+ * Cache configuration options.
+ * @alias CacheConfig — v1 BC alias exported from index
+ */
+interface CacheOptions {
+    /** Maximum number of cache entries (default 5000). */
+    maxSize?: number;
+    /** Cache TTL in milliseconds (0 = no expiry). */
+    ttl?: number;
+    /** Whether caching is enabled. */
+    enabled?: boolean;
+    /** Whether statistics are enabled (default true). */
+    statsEnabled?: boolean;
+}
+/**
+ * I18n configuration type.
+ */
+type I18nConfig = string | Record<string, ErrorMessages> | {
+    localesPath: string;
+} | {
+    locales: Record<string, ErrorMessages>;
+};
+/**
+ * dsl.config() options.
+ */
+interface DslConfigOptions {
+    /** Internationalisation config. */
+    i18n?: I18nConfig;
+    /** Cache config. */
+    cache?: CacheOptions;
+    /** Custom validation rule extensions. */
+    patterns?: {
+        phone?: Record<string, RegExp>;
+        idCard?: Record<string, RegExp>;
+        creditCard?: Record<string, RegExp>;
+        [key: string]: Record<string, RegExp> | undefined;
+    };
+    /** Default locale (default 'en-US'). */
+    defaultLocale?: string;
+    /** Strict type resolution: throw on unknown types instead of warn + fallback to string. */
+    strict?: boolean;
+}
+/**
+ * ValidatorOptions (Validator class constructor parameters).
+ */
+interface ValidatorOptions {
+    allErrors?: boolean;
+    verbose?: boolean;
+    strict?: boolean;
+    coerceTypes?: boolean | 'array';
+    removeAdditional?: boolean | 'all' | 'failing';
+    useDefaults?: boolean;
+    cache?: boolean | CacheOptions;
+}
+
+/**
+ * Validation options.
+ */
+
+interface ValidateOptions {
+    /** Whether to format errors (default true). */
+    format?: boolean;
+    /** Whether to return all errors (default false — only the first). */
+    allErrors?: boolean;
+    /** Dynamically specify a locale (e.g. 'zh-CN', 'en-US', 'ja-JP', 'es-ES', 'fr-FR'). */
+    locale?: string;
+    /** Custom error messages. */
+    messages?: ErrorMessages;
+    /** Whether to enable smart type coercion (auto-converts string → number etc.). */
+    smartCoerce?: boolean;
+    /** Whether to remove additional properties. */
+    removeAdditional?: boolean | 'all' | 'failing';
+    /** Whether to enable caching. */
+    cache?: boolean | CacheOptions;
+    /** Whether to enable strict mode. */
+    strict?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * Validation result.
+ */
+interface ValidationResult<T = unknown> {
+    /** Whether validation passed. */
+    valid: boolean;
+    /** Snapshot of the data after validation (returned on both success and failure; useful for locating input on failure). */
+    data?: T;
+    /** Error list (empty array on success; detailed errors on failure). */
+    errors?: ValidationErrorItem[];
+    /** First error message (convenience accessor). */
+    errorMessage?: string;
+}
+/**
+ * Validation error item (element of ValidationResult.errors).
+ */
+interface ValidationErrorItem {
+    /** Error message. */
+    message: string;
+    /** Error field path (dot-separated, e.g. 'user.email'). */
+    path: string;
+    /** Validation keyword (min, max, email, pattern, etc.). */
+    keyword: string;
+    /** Validation parameters. */
+    params?: Record<string, unknown>;
+    /** Alias for path (backwards compatibility). */
+    field?: string;
+    /** Alias for keyword (backwards-compatible with v1 err.type). */
+    type?: string | undefined;
+    /** Expected type (backwards-compatible with v1 err.expected; only present for type errors). */
+    expected?: string | undefined;
+}
+
+/**
+ * Hook function type (accepts arbitrary arguments; compatible with v1 custom hook names).
+ */
+type HookFn = (...args: unknown[]) => unknown | Promise<unknown>;
+/**
+ * Plugin interface (backwards-compatible with v1).
+ */
+interface Plugin {
+    /** Plugin name. */
+    name: string;
+    /** Plugin version. */
+    version?: string;
+    /** Plugin description. */
+    description?: string;
+    /** Plugin options (passed as the second argument to install). */
+    options?: Record<string, unknown>;
+    /** Plugin hook map (supports arbitrary hook names for v1 compatibility). */
+    hooks?: Record<string, HookFn>;
+    /** Install method. */
+    install?(core: unknown, options?: unknown, context?: unknown): void;
+    /** Uninstall method (optional). */
+    uninstall?(core?: unknown, context?: unknown): void;
+}
+
+export type { CacheOptions as C, DslConfigOptions as D, ErrorMessages as E, HookFn as H, I18nConfig as I, JSONSchema as J, Plugin as P, SchemaIOOptions as S, ValidationResult as V, ValidationErrorItem as a, ErrorCodeMap as b, ValidateOptions as c, ValidatorOptions as d };