npm - schema-dsl - Versions diffs - 2.0.0 → 2.0.1 - Mend

schema-dsl 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (145) hide show

package/CHANGELOG.md +130 -113
package/LICENSE +21 -21
package/README.md +628 -628
package/dist/{DslBuilder-DkLaOo9Q.d.ts → DslBuilder-BIgQOAXp.d.ts} +2 -0
package/dist/{DslBuilder-DQDN0ZxZ.d.cts → DslBuilder-CjHTucNQ.d.cts} +2 -0
package/dist/{Validator-hFWKGxir.d.ts → Validator-CllRdrY0.d.ts} +1 -1
package/dist/{Validator-C7GsVQOH.d.cts → Validator-D6okG9tr.d.cts} +1 -1
package/dist/index.cjs +75 -29
package/dist/index.d.cts +10 -4
package/dist/index.d.ts +10 -4
package/dist/index.js +75 -29
package/dist/plugins/custom-format.cjs +33 -17
package/dist/plugins/custom-format.d.cts +1 -1
package/dist/plugins/custom-format.d.ts +1 -1
package/dist/plugins/custom-format.js +33 -17
package/dist/plugins/custom-type-example.cjs +33 -17
package/dist/plugins/custom-type-example.d.cts +1 -1
package/dist/plugins/custom-type-example.d.ts +1 -1
package/dist/plugins/custom-type-example.js +33 -17
package/dist/plugins/custom-validator.cjs +0 -2
package/dist/plugins/custom-validator.d.cts +1 -1
package/dist/plugins/custom-validator.d.ts +1 -1
package/dist/plugins/custom-validator.js +0 -2
package/docs/FEATURE-INDEX.md +553 -553
package/docs/add-custom-locale.md +496 -496
package/docs/add-keyword.md +24 -24
package/docs/api-reference.md +1047 -1047
package/docs/api.md +13 -13
package/docs/best-practices-project-structure.md +417 -417
package/docs/best-practices.md +712 -712
package/docs/cache-manager.md +344 -344
package/docs/compile.md +45 -45
package/docs/conditional-api.md +1307 -1307
package/docs/custom-extensions-guide.md +339 -339
package/docs/design-philosophy.md +606 -606
package/docs/doc-index.md +324 -324
package/docs/dsl-syntax.md +714 -714
package/docs/dynamic-locale.md +608 -608
package/docs/enum.md +482 -482
package/docs/error-handling.md +1975 -1975
package/docs/export-guide.md +501 -501
package/docs/export-limitations.md +567 -567
package/docs/faq.md +596 -596
package/docs/frontend-i18n-guide.md +307 -307
package/docs/i18n-user-guide.md +487 -487
package/docs/i18n.md +476 -476
package/docs/index.md +48 -48
package/docs/json-schema-basics.md +40 -40
package/docs/label-vs-description.md +271 -271
package/docs/markdown-exporter.md +406 -406
package/docs/mongodb-exporter.md +302 -302
package/docs/multi-language.md +26 -26
package/docs/multi-type-support.md +322 -322
package/docs/mysql-exporter.md +280 -280
package/docs/number-operators.md +449 -449
package/docs/optional-marker-guide.md +326 -326
package/docs/performance-guide.md +49 -49
package/docs/plugin-system.md +381 -381
package/docs/plugin-type-registration.md +34 -34
package/docs/postgresql-exporter.md +311 -311
package/docs/public/favicon.svg +4 -4
package/docs/quick-start.md +435 -435
package/docs/runtime-locale-support.md +532 -532
package/docs/schema-helper.md +345 -345
package/docs/schema-utils-advanced-issues.md +23 -23
package/docs/schema-utils-best-practices.md +20 -20
package/docs/schema-utils-chaining.md +150 -150
package/docs/schema-utils.md +524 -524
package/docs/security-checklist.md +20 -20
package/docs/string-extensions.md +488 -488
package/docs/troubleshooting.md +486 -486
package/docs/type-converter.md +310 -310
package/docs/type-reference.md +242 -242
package/docs/typescript-guide.md +584 -584
package/docs/union-type-guide.md +157 -157
package/docs/union-types.md +284 -284
package/docs/validate-async.md +491 -491
package/docs/validate-batch.md +49 -49
package/docs/validate-dsl-object-support.md +578 -578
package/docs/validate.md +506 -506
package/docs/validation-guide.md +502 -502
package/docs/validator.md +39 -39
package/package.json +131 -131
package/plugins/custom-format.cjs +8 -8
package/plugins/custom-type-example.cjs +8 -8
package/plugins/custom-validator.cjs +8 -8
package/src/adapters/DslAdapter.ts +111 -111
package/src/adapters/index.ts +1 -1
package/src/config/constants.ts +83 -83
package/src/config/index.ts +2 -2
package/src/config/patterns.ts +77 -77
package/src/core/CacheManager.ts +169 -159
package/src/core/ConditionalBuilder.ts +382 -382
package/src/core/ConditionalRuntime.ts +27 -27
package/src/core/ConditionalValidator.ts +254 -254
package/src/core/DslBuilder.ts +687 -677
package/src/core/ErrorCodes.ts +38 -38
package/src/core/ErrorFormatter.ts +271 -271
package/src/core/JSONSchemaCore.ts +65 -65
package/src/core/Locale.ts +187 -187
package/src/core/MessageTemplate.ts +42 -42
package/src/core/ObjectDslBuilder.ts +64 -64
package/src/core/PluginManager.ts +326 -326
package/src/core/StringExtensions.ts +140 -140
package/src/core/TemplateEngine.ts +44 -44
package/src/core/Validator.ts +448 -448
package/src/errors/I18nError.ts +159 -159
package/src/errors/ValidationError.ts +105 -105
package/src/exporters/BaseExporter.ts +60 -60
package/src/exporters/MarkdownExporter.ts +305 -305
package/src/exporters/MongoDBExporter.ts +126 -126
package/src/exporters/MySQLExporter.ts +156 -155
package/src/exporters/PostgreSQLExporter.ts +222 -222
package/src/exporters/index.ts +18 -18
package/src/index.ts +651 -633
package/src/locales/en-US.ts +160 -160
package/src/locales/es-ES.ts +160 -160
package/src/locales/fr-FR.ts +160 -160
package/src/locales/index.ts +103 -103
package/src/locales/ja-JP.ts +160 -160
package/src/locales/types.ts +156 -156
package/src/locales/zh-CN.ts +160 -160
package/src/parser/ConstraintParser.ts +101 -101
package/src/parser/DslParser.ts +470 -470
package/src/parser/SchemaCompiler.ts +66 -66
package/src/parser/TypeRegistry.ts +250 -250
package/src/parser/index.ts +6 -6
package/src/plugins/custom-format.ts +124 -126
package/src/plugins/custom-type-example.ts +106 -108
package/src/plugins/custom-validator.ts +138 -140
package/src/types/conditional.ts +28 -28
package/src/types/config.ts +59 -59
package/src/types/dsl.ts +131 -131
package/src/types/error.ts +60 -60
package/src/types/index.ts +17 -17
package/src/types/infer.ts +127 -127
package/src/types/plugin.ts +58 -58
package/src/types/safe-regex.d.ts +9 -9
package/src/types/schema.ts +66 -66
package/src/types/validate.ts +71 -71
package/src/utils/SchemaHelper.ts +196 -196
package/src/utils/SchemaUtils.ts +365 -346
package/src/utils/TypeConverter.ts +215 -215
package/src/utils/index.ts +10 -10
package/src/validators/CustomKeywords.ts +477 -477

package/src/types/infer.ts CHANGED Viewed

@@ -1,128 +1,128 @@
-type StripMarker<S extends string> = S extends `${infer Base}!` | `${infer Base}?` ? Base : S
-type KnownDslType =
-    | 'string'
-    | 'email'
-    | 'url'
-    | 'uri'
-    | 'uuid'
-    | 'ipv4'
-    | 'ipv6'
-    | 'ip'
-    | 'hostname'
-    | 'date'
-    | 'datetime'
-    | 'time'
-    | 'binary'
-    | 'objectId'
-    | 'hexColor'
-    | 'macAddress'
-    | 'cron'
-    | 'slug'
-    | 'chineseName'
-    | 'chinese'
-    | 'emailDomain'
-    | 'alphanum'
-    | 'lower'
-    | 'upper'
-    | 'json'
-    | 'port'
-    | 'number'
-    | 'integer'
-    | 'boolean'
-    | 'object'
-    | 'array'
-    | 'null'
-    | 'any'
-type InferPipeMember<S extends string> = StripMarker<S> extends KnownDslType ? InferDslString<S> : StripMarker<S>
-type SplitPipe<S extends string> = S extends `${infer Head}|${infer Tail}`
-    ? InferPipeMember<Head> | SplitPipe<Tail>
-    : InferPipeMember<S>
-type RequiredDslKeys<T extends Record<string, unknown>> = {
-    [K in keyof T]: K extends string
-    ? K extends `${infer Name}!`
-    ? Name
-    : T[K] extends `${string}!`
-    ? K
-    : never
-    : never
-}[keyof T]
-type CleanDslKey<K> = K extends `${infer Name}!` | `${infer Name}?` ? Name : K
-type InferJsonSchemaProperties<Properties, RequiredKeys extends PropertyKey> =
-    & {
-        [K in keyof Properties as K extends RequiredKeys ? K : never]-?: InferSchema<Properties[K]>
-    }
-    & {
-        [K in keyof Properties as K extends RequiredKeys ? never : K]?: InferSchema<Properties[K]>
-    }
-type InferDslProperties<T extends Record<string, unknown>, RequiredKeys extends PropertyKey = RequiredDslKeys<T>> =
-    & {
-        [K in keyof T as CleanDslKey<K> extends RequiredKeys ? CleanDslKey<K> : never]-?: InferSchema<T[K]>
-    }
-    & {
-        [K in keyof T as CleanDslKey<K> extends RequiredKeys ? never : CleanDslKey<K>]?: InferSchema<T[K]>
-    }
-export type InferDslString<T extends string> = StripMarker<T> extends `types:${infer Rest}`
-    ? SplitPipe<Rest>
-    : StripMarker<T> extends `enum:${infer Values}`
-    ? SplitPipe<Values>
-    : StripMarker<T> extends `array<${infer Item}>`
-    ? InferDslString<Item>[]
-    : StripMarker<T> extends `${infer Base}:${string}`
-    ? InferDslString<Base>
-    : StripMarker<T> extends 'number' | 'integer' | 'port'
-    ? number
-    : StripMarker<T> extends 'boolean'
-    ? boolean
-    : StripMarker<T> extends 'object'
-    ? Record<string, unknown>
-    : StripMarker<T> extends 'array'
-    ? unknown[]
-    : StripMarker<T> extends 'null'
-    ? null
-    : StripMarker<T> extends 'any'
-    ? unknown
-    : StripMarker<T> extends `${string}|${string}`
-    ? SplitPipe<StripMarker<T>>
-    : string
-export type InferJsonSchema<T> = T extends { oneOf: readonly (infer Variant)[] }
-    ? InferSchema<Variant>
-    : T extends { anyOf: readonly (infer Variant)[] }
-    ? InferSchema<Variant>
-    : T extends { enum: readonly (infer Value)[] }
-    ? Value
-    : T extends { type: 'object'; properties: infer Properties; required?: readonly (infer RequiredKey)[] }
-    ? InferJsonSchemaProperties<Properties, Extract<RequiredKey, keyof Properties>>
-    : T extends { type: 'array'; items: infer Item }
-    ? InferSchema<Item>[]
-    : T extends { type: 'number' | 'integer' }
-    ? number
-    : T extends { type: 'boolean' }
-    ? boolean
-    : T extends { type: 'null' }
-    ? null
-    : T extends { type: 'object' }
-    ? Record<string, unknown>
-    : T extends { type: 'array' }
-    ? unknown[]
-    : T extends { type: 'string' }
-    ? string
-    : unknown
-export type InferDslDefinition<T extends Record<string, unknown>> = InferDslProperties<T>
-export type InferSchema<T> = T extends string
-    ? InferDslString<T>
-    : T extends { type: unknown } | { properties: unknown } | { oneOf: unknown } | { anyOf: unknown } | { enum: unknown }
-    ? InferJsonSchema<T>
-    : T extends Record<string, unknown>
-    ? InferDslDefinition<T>
+type StripMarker<S extends string> = S extends `${infer Base}!` | `${infer Base}?` ? Base : S
+type KnownDslType =
+    | 'string'
+    | 'email'
+    | 'url'
+    | 'uri'
+    | 'uuid'
+    | 'ipv4'
+    | 'ipv6'
+    | 'ip'
+    | 'hostname'
+    | 'date'
+    | 'datetime'
+    | 'time'
+    | 'binary'
+    | 'objectId'
+    | 'hexColor'
+    | 'macAddress'
+    | 'cron'
+    | 'slug'
+    | 'chineseName'
+    | 'chinese'
+    | 'emailDomain'
+    | 'alphanum'
+    | 'lower'
+    | 'upper'
+    | 'json'
+    | 'port'
+    | 'number'
+    | 'integer'
+    | 'boolean'
+    | 'object'
+    | 'array'
+    | 'null'
+    | 'any'
+type InferPipeMember<S extends string> = StripMarker<S> extends KnownDslType ? InferDslString<S> : StripMarker<S>
+type SplitPipe<S extends string> = S extends `${infer Head}|${infer Tail}`
+    ? InferPipeMember<Head> | SplitPipe<Tail>
+    : InferPipeMember<S>
+type RequiredDslKeys<T extends Record<string, unknown>> = {
+    [K in keyof T]: K extends string
+    ? K extends `${infer Name}!`
+    ? Name
+    : T[K] extends `${string}!`
+    ? K
+    : never
+    : never
+}[keyof T]
+type CleanDslKey<K> = K extends `${infer Name}!` | `${infer Name}?` ? Name : K
+type InferJsonSchemaProperties<Properties, RequiredKeys extends PropertyKey> =
+    & {
+        [K in keyof Properties as K extends RequiredKeys ? K : never]-?: InferSchema<Properties[K]>
+    }
+    & {
+        [K in keyof Properties as K extends RequiredKeys ? never : K]?: InferSchema<Properties[K]>
+    }
+type InferDslProperties<T extends Record<string, unknown>, RequiredKeys extends PropertyKey = RequiredDslKeys<T>> =
+    & {
+        [K in keyof T as CleanDslKey<K> extends RequiredKeys ? CleanDslKey<K> : never]-?: InferSchema<T[K]>
+    }
+    & {
+        [K in keyof T as CleanDslKey<K> extends RequiredKeys ? never : CleanDslKey<K>]?: InferSchema<T[K]>
+    }
+export type InferDslString<T extends string> = StripMarker<T> extends `types:${infer Rest}`
+    ? SplitPipe<Rest>
+    : StripMarker<T> extends `enum:${infer Values}`
+    ? SplitPipe<Values>
+    : StripMarker<T> extends `array<${infer Item}>`
+    ? InferDslString<Item>[]
+    : StripMarker<T> extends `${infer Base}:${string}`
+    ? InferDslString<Base>
+    : StripMarker<T> extends 'number' | 'integer' | 'port'
+    ? number
+    : StripMarker<T> extends 'boolean'
+    ? boolean
+    : StripMarker<T> extends 'object'
+    ? Record<string, unknown>
+    : StripMarker<T> extends 'array'
+    ? unknown[]
+    : StripMarker<T> extends 'null'
+    ? null
+    : StripMarker<T> extends 'any'
+    ? unknown
+    : StripMarker<T> extends `${string}|${string}`
+    ? SplitPipe<StripMarker<T>>
+    : string
+export type InferJsonSchema<T> = T extends { oneOf: readonly (infer Variant)[] }
+    ? InferSchema<Variant>
+    : T extends { anyOf: readonly (infer Variant)[] }
+    ? InferSchema<Variant>
+    : T extends { enum: readonly (infer Value)[] }
+    ? Value
+    : T extends { type: 'object'; properties: infer Properties; required?: readonly (infer RequiredKey)[] }
+    ? InferJsonSchemaProperties<Properties, Extract<RequiredKey, keyof Properties>>
+    : T extends { type: 'array'; items: infer Item }
+    ? InferSchema<Item>[]
+    : T extends { type: 'number' | 'integer' }
+    ? number
+    : T extends { type: 'boolean' }
+    ? boolean
+    : T extends { type: 'null' }
+    ? null
+    : T extends { type: 'object' }
+    ? Record<string, unknown>
+    : T extends { type: 'array' }
+    ? unknown[]
+    : T extends { type: 'string' }
+    ? string
+    : unknown
+export type InferDslDefinition<T extends Record<string, unknown>> = InferDslProperties<T>
+export type InferSchema<T> = T extends string
+    ? InferDslString<T>
+    : T extends { type: unknown } | { properties: unknown } | { oneOf: unknown } | { anyOf: unknown } | { enum: unknown }
+    ? InferJsonSchema<T>
+    : T extends Record<string, unknown>
+    ? InferDslDefinition<T>
     : unknown

package/src/types/plugin.ts CHANGED Viewed

@@ -1,58 +1,58 @@
-/**
- * Built-in hook names (pipeline execution phases).
- */
-export type HookName =
-  | 'beforeParse'
-  | 'afterParse'
-  | 'beforeCompile'
-  | 'afterCompile'
-  | 'beforeValidate'
-  | 'afterValidate'
-  | 'onError'
-/**
- * Hook function type (accepts arbitrary arguments; compatible with v1 custom hook names).
- */
-export type HookFn = (...args: unknown[]) => unknown | Promise<unknown>
-/**
- * Hook context (passed to built-in hooks).
- */
-export interface HookContext {
-  /** Current hook phase. */
-  hook: HookName
-  /** Data being processed. */
-  data?: unknown
-  /** DSL definition. */
-  schema?: unknown
-  /** Additional metadata. */
-  meta?: Record<string, unknown>
-}
-/**
- * Plugin interface (backwards-compatible with v1).
- */
-export 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
-}
-/**
- * PluginManager configuration.
- */
-export interface PluginManagerOptions {
-  /** Whether hooks are executed asynchronously (default true). */
-  async?: boolean
-}
+/**
+ * Built-in hook names (pipeline execution phases).
+ */
+export type HookName =
+  | 'beforeParse'
+  | 'afterParse'
+  | 'beforeCompile'
+  | 'afterCompile'
+  | 'beforeValidate'
+  | 'afterValidate'
+  | 'onError'
+/**
+ * Hook function type (accepts arbitrary arguments; compatible with v1 custom hook names).
+ */
+export type HookFn = (...args: unknown[]) => unknown | Promise<unknown>
+/**
+ * Hook context (passed to built-in hooks).
+ */
+export interface HookContext {
+  /** Current hook phase. */
+  hook: HookName
+  /** Data being processed. */
+  data?: unknown
+  /** DSL definition. */
+  schema?: unknown
+  /** Additional metadata. */
+  meta?: Record<string, unknown>
+}
+/**
+ * Plugin interface (backwards-compatible with v1).
+ */
+export 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
+}
+/**
+ * PluginManager configuration.
+ */
+export interface PluginManagerOptions {
+  /** Whether hooks are executed asynchronously (default true). */
+  async?: boolean
+}

package/src/types/safe-regex.d.ts CHANGED Viewed

@@ -1,9 +1,9 @@
-declare module 'safe-regex' {
-  interface SafeRegexOptions {
-    limit?: number
-  }
-  export default function safeRegex(pattern: string | RegExp, options?: SafeRegexOptions): boolean
-}
+declare module 'safe-regex' {
+  interface SafeRegexOptions {
+    limit?: number
+  }
+  export default function safeRegex(pattern: string | RegExp, options?: SafeRegexOptions): boolean
+}

package/src/types/schema.ts CHANGED Viewed

@@ -1,66 +1,66 @@
-/**
- * JSON Schema Draft 7 type definitions.
- * Includes schema-dsl internal keys (prefixed with _; stripped by toJsonSchema()).
- */
-import type { ErrorMessages } from './error.js'
-export interface JSONSchema {
-  // --- Standard JSON Schema Draft 7 fields ---
-  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>
-  // --- schema-dsl internal keys (used during parsing; stripped on output) ---
-  _label?: string
-  _customMessages?: Record<string, string>
-  _description?: string
-  _required?: boolean
-  // Allows custom keyword extensions (AJV custom keywords)
-  [key: string]: unknown
-}
-/**
- * SchemaIO configuration options (backwards-compatible with v1).
- */
-export interface SchemaIOOptions {
-  allErrors?: boolean
-  verbose?: boolean
-  messages?: ErrorMessages
-  locale?: string
-  cache?: boolean
-  cacheSize?: number
-  [key: string]: unknown
-}
+/**
+ * JSON Schema Draft 7 type definitions.
+ * Includes schema-dsl internal keys (prefixed with _; stripped by toJsonSchema()).
+ */
+import type { ErrorMessages } from './error.js'
+export interface JSONSchema {
+  // --- Standard JSON Schema Draft 7 fields ---
+  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>
+  // --- schema-dsl internal keys (used during parsing; stripped on output) ---
+  _label?: string
+  _customMessages?: Record<string, string>
+  _description?: string
+  _required?: boolean
+  // Allows custom keyword extensions (AJV custom keywords)
+  [key: string]: unknown
+}
+/**
+ * SchemaIO configuration options (backwards-compatible with v1).
+ */
+export interface SchemaIOOptions {
+  allErrors?: boolean
+  verbose?: boolean
+  messages?: ErrorMessages
+  locale?: string
+  cache?: boolean
+  cacheSize?: number
+  [key: string]: unknown
+}

package/src/types/validate.ts CHANGED Viewed

@@ -1,71 +1,71 @@
-/**
- * Validation options.
- */
-import type { CacheOptions } from './config.js'
-import type { ErrorMessages } from './error.js'
-export 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.
- */
-export 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).
- */
-export 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
-}
-/**
- * Raw AJV error object type (internal use).
- */
-export interface AjvError {
-  keyword: string
-  instancePath: string
-  schemaPath: string
-  params: Record<string, unknown>
-  message?: string
-  data?: unknown
-}
+/**
+ * Validation options.
+ */
+import type { CacheOptions } from './config.js'
+import type { ErrorMessages } from './error.js'
+export 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.
+ */
+export 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).
+ */
+export 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
+}
+/**
+ * Raw AJV error object type (internal use).
+ */
+export interface AjvError {
+  keyword: string
+  instancePath: string
+  schemaPath: string
+  params: Record<string, unknown>
+  message?: string
+  data?: unknown
+}