schema-dsl 2.0.0 → 2.0.1

package/docs/validator.md

@@ -1,39 +1,39 @@
-# Validator 类概述
-
-`Validator` 是对 AJV 的封装，提供编译缓存、错误格式化、自定义关键字和批量验证能力。
-
-```javascript
-const { Validator, dsl } = require('schema-dsl');
-const validator = new Validator();
-const schema = dsl({ email: 'email!' });
-console.log(validator.validate(schema, { email: 'test@example.com' }));
-```
-
-## 缓存配置
-
-`Validator` 构造器支持两种缓存写法：
-
-```javascript
-new Validator({ cache: true });   // 使用默认缓存配置
-new Validator({ cache: false });  // 关闭缓存
-
-new Validator({
-  cache: {
-	enabled: true,
-	maxSize: 500,
-	ttl: 60 * 60 * 1000
-  }
-});
-```
-
-> 如果你希望直接传入 DSL 对象（例如 `validate({ email: 'email!' }, data)`），请使用顶层便捷函数 `validate()` / `validateAsync()`；`Validator` 实例方法仍建议接收标准 JSON Schema 或 `dsl({...})` 的转换结果。
-
-相关方法：`compile()`、`validate()`、`validateAsync()`、`validateBatch()`、`addKeyword()`、`addFormat()`。
-
----
-
-## 对应示例文件
-
-**示例入口**: [validator.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validator.ts)  
-**说明**: 覆盖 `new Validator()` 的常见配置、单次验证、编译缓存命中和 `validateBatch()` 复用路径。
-
+# Validator 类概述
+
+`Validator` 是对 AJV 的封装，提供编译缓存、错误格式化、自定义关键字和批量验证能力。
+
+```javascript
+const { Validator, dsl } = require('schema-dsl');
+const validator = new Validator();
+const schema = dsl({ email: 'email!' });
+console.log(validator.validate(schema, { email: 'test@example.com' }));
+```
+
+## 缓存配置
+
+`Validator` 构造器支持两种缓存写法：
+
+```javascript
+new Validator({ cache: true });   // 使用默认缓存配置
+new Validator({ cache: false });  // 关闭缓存
+
+new Validator({
+  cache: {
+	enabled: true,
+	maxSize: 500,
+	ttl: 60 * 60 * 1000
+  }
+});
+```
+
+> 如果你希望直接传入 DSL 对象（例如 `validate({ email: 'email!' }, data)`），请使用顶层便捷函数 `validate()` / `validateAsync()`；`Validator` 实例方法仍建议接收标准 JSON Schema 或 `dsl({...})` 的转换结果。
+
+相关方法：`compile()`、`validate()`、`validateAsync()`、`validateBatch()`、`addKeyword()`、`addFormat()`。
+
+---
+
+## 对应示例文件
+
+**示例入口**: [validator.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validator.ts)  
+**说明**: 覆盖 `new Validator()` 的常见配置、单次验证、编译缓存命中和 `validateBatch()` 复用路径。
+

package/package.json

@@ -1,131 +1,131 @@
-{
-  "name": "schema-dsl",
-  "version": "2.0.0",
-  "description": "A concise and powerful JSON Schema validation library - DSL syntax + String extensions + convenient validate API",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    },
-    "./plugins/custom-format": {
-      "import": {
-        "types": "./dist/plugins/custom-format.d.ts",
-        "default": "./dist/plugins/custom-format.js"
-      },
-      "require": {
-        "types": "./dist/plugins/custom-format.d.cts",
-        "default": "./dist/plugins/custom-format.cjs"
-      }
-    },
-    "./plugins/custom-validator": {
-      "import": {
-        "types": "./dist/plugins/custom-validator.d.ts",
-        "default": "./dist/plugins/custom-validator.js"
-      },
-      "require": {
-        "types": "./dist/plugins/custom-validator.d.cts",
-        "default": "./dist/plugins/custom-validator.cjs"
-      }
-    },
-    "./plugins/custom-type-example": {
-      "import": {
-        "types": "./dist/plugins/custom-type-example.d.ts",
-        "default": "./dist/plugins/custom-type-example.js"
-      },
-      "require": {
-        "types": "./dist/plugins/custom-type-example.d.cts",
-        "default": "./dist/plugins/custom-type-example.cjs"
-      }
-    }
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
-    "typecheck": "tsc --noEmit",
-    "examples:typecheck": "tsc -p tsconfig.examples.json --noEmit",
-    "examples:build": "tsc -p tsconfig.examples.json",
-    "lint": "eslint src/**/*.ts",
-    "test:version": "node -e \"const p=require('./package.json');const {VERSION}=require('./dist/index.cjs');if(p.version!==VERSION)throw new Error('Version mismatch: '+p.version+' vs '+VERSION);console.log('Version OK:',p.version)\"",
-    "bench": "node test/benchmarks/library-comparison.js",
-    "prepublishOnly": "npm run build && npm run typecheck && npm test"
-  },
-  "keywords": [
-    "schema",
-    "validation",
-    "validator",
-    "dsl",
-    "json-schema",
-    "data-validation",
-    "form-validation",
-    "mongodb",
-    "mysql",
-    "postgresql",
-    "database-schema",
-    "i18n",
-    "internationalization",
-    "typescript",
-    "express",
-    "koa",
-    "fastify",
-    "rest-api",
-    "input-validation"
-  ],
-  "author": "rocky <rockyshi1993@gmail.com>",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/vextjs/schema-dsl.git"
-  },
-  "bugs": {
-    "url": "https://github.com/vextjs/schema-dsl/issues"
-  },
-  "homepage": "https://github.com/vextjs/schema-dsl#readme",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "dependencies": {
-    "ajv": "^8.18.0",
-    "ajv-formats": "^2.1.1",
-    "cache-hub": "^1.0.0",
-    "json5": "^2.2.3",
-    "safe-regex": "^2.1.1"
-  },
-  "devDependencies": {
-    "@types/node": "^25.6.0",
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
-    "@vitest/coverage-v8": "^3.0.0",
-    "eslint": "^9.0.0",
-    "fastest-validator": "^1.19.1",
-    "joi": "^18.1.2",
-    "tsup": "^8.0.0",
-    "typescript": "^5.5.0",
-    "vitest": "^3.0.0",
-    "yup": "^1.7.1",
-    "zod": "^4.3.6"
-  },
-  "type": "module",
-  "files": [
-    "dist/**/*.js",
-    "dist/**/*.cjs",
-    "dist/**/*.d.ts",
-    "dist/**/*.d.cts",
-    "plugins",
-    "src",
-    "docs",
-    "README.md",
-    "CHANGELOG.md"
-  ]
-}
+{
+  "name": "schema-dsl",
+  "version": "2.0.1",
+  "description": "A concise and powerful JSON Schema validation library - DSL syntax + String extensions + convenient validate API",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./plugins/custom-format": {
+      "import": {
+        "types": "./dist/plugins/custom-format.d.ts",
+        "default": "./dist/plugins/custom-format.js"
+      },
+      "require": {
+        "types": "./dist/plugins/custom-format.d.cts",
+        "default": "./dist/plugins/custom-format.cjs"
+      }
+    },
+    "./plugins/custom-validator": {
+      "import": {
+        "types": "./dist/plugins/custom-validator.d.ts",
+        "default": "./dist/plugins/custom-validator.js"
+      },
+      "require": {
+        "types": "./dist/plugins/custom-validator.d.cts",
+        "default": "./dist/plugins/custom-validator.cjs"
+      }
+    },
+    "./plugins/custom-type-example": {
+      "import": {
+        "types": "./dist/plugins/custom-type-example.d.ts",
+        "default": "./dist/plugins/custom-type-example.js"
+      },
+      "require": {
+        "types": "./dist/plugins/custom-type-example.d.cts",
+        "default": "./dist/plugins/custom-type-example.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "examples:typecheck": "tsc -p tsconfig.examples.json --noEmit",
+    "examples:build": "tsc -p tsconfig.examples.json",
+    "lint": "eslint src/**/*.ts",
+    "test:version": "node -e \"const p=require('./package.json');const {VERSION}=require('./dist/index.cjs');if(p.version!==VERSION)throw new Error('Version mismatch: '+p.version+' vs '+VERSION);console.log('Version OK:',p.version)\"",
+    "bench": "node test/benchmarks/library-comparison.js",
+    "prepublishOnly": "npm run build && npm run typecheck && npm test"
+  },
+  "keywords": [
+    "schema",
+    "validation",
+    "validator",
+    "dsl",
+    "json-schema",
+    "data-validation",
+    "form-validation",
+    "mongodb",
+    "mysql",
+    "postgresql",
+    "database-schema",
+    "i18n",
+    "internationalization",
+    "typescript",
+    "express",
+    "koa",
+    "fastify",
+    "rest-api",
+    "input-validation"
+  ],
+  "author": "rocky <rockyshi1993@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vextjs/schema-dsl.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vextjs/schema-dsl/issues"
+  },
+  "homepage": "https://github.com/vextjs/schema-dsl#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "ajv": "^8.18.0",
+    "ajv-formats": "^2.1.1",
+    "cache-hub": "^1.0.0",
+    "json5": "^2.2.3",
+    "safe-regex": "^2.1.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.6.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/coverage-v8": "^3.0.0",
+    "eslint": "^9.0.0",
+    "fastest-validator": "^1.19.1",
+    "joi": "^18.1.2",
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0",
+    "vitest": "^3.0.0",
+    "yup": "^1.7.1",
+    "zod": "^4.3.6"
+  },
+  "type": "module",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.cjs",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.cts",
+    "plugins",
+    "src",
+    "docs",
+    "README.md",
+    "CHANGELOG.md"
+  ]
+}

package/plugins/custom-format.cjs

@@ -1,8 +1,8 @@
-'use strict';
-
-const mod = require('../dist/plugins/custom-format.cjs');
-const plugin = mod.default ?? mod.customFormatPlugin ?? mod;
-
-module.exports = plugin;
-module.exports.default = plugin;
-
+'use strict';
+
+const mod = require('../dist/plugins/custom-format.cjs');
+const plugin = mod.default ?? mod.customFormatPlugin ?? mod;
+
+module.exports = plugin;
+module.exports.default = plugin;
+

package/plugins/custom-type-example.cjs

@@ -1,8 +1,8 @@
-'use strict';
-
-const mod = require('../dist/plugins/custom-type-example.cjs');
-const plugin = mod.default ?? mod.customTypeExamplePlugin ?? mod;
-
-module.exports = plugin;
-module.exports.default = plugin;
-
+'use strict';
+
+const mod = require('../dist/plugins/custom-type-example.cjs');
+const plugin = mod.default ?? mod.customTypeExamplePlugin ?? mod;
+
+module.exports = plugin;
+module.exports.default = plugin;
+

package/plugins/custom-validator.cjs

@@ -1,8 +1,8 @@
-'use strict';
-
-const mod = require('../dist/plugins/custom-validator.cjs');
-const plugin = mod.default ?? mod.customValidatorPlugin ?? mod;
-
-module.exports = plugin;
-module.exports.default = plugin;
-
+'use strict';
+
+const mod = require('../dist/plugins/custom-validator.cjs');
+const plugin = mod.default ?? mod.customValidatorPlugin ?? mod;
+
+module.exports = plugin;
+module.exports.default = plugin;
+

package/src/adapters/DslAdapter.ts

@@ -1,111 +1,111 @@
-
-/**
- * DslAdapter — DSL parsing adapter (thin wrapper layer).
- *
- * v2 changes:
- *   - All parsing logic delegated to DslParser (replaces v1 DslAdapter._parseType duplication)
- *   - Fixes DA-01/DA-02/DA-03 (handled uniformly by the DslParser pipeline)
- *   - parseObject delegates to DslParser.parseObject (replaces JSONSchemaCore)
- *   - BC-2 fix: parseObject() returns ObjectDslBuilder (supports chain .strict()/.requireAll())
- *   - BC-4 fix: typeMap getter exposes all registered types; registerType() convenience entry point
- */
-
-import type { JSONSchema } from '../types/schema.js'
-import type { DslDefinition } from '../types/dsl.js'
-import { DslParser } from '../parser/DslParser.js'
-import { TypeRegistry } from '../parser/TypeRegistry.js'
-import { ObjectDslBuilder } from '../core/ObjectDslBuilder.js'
-
-type DslMarker = Record<string, unknown>
-
-export const DslAdapter = {
-  /**
-   * Parse a DSL string into a JSON Schema.
-   * Equivalent to v1 DslAdapter.parseString(), but delegates to the unified DslParser.
-   */
-  parseString(dslString: string): JSONSchema {
-    if (!dslString || typeof dslString !== 'string') {
-      throw new Error('[schema-dsl] DslAdapter.parseString: DSL must be a string')
-    }
-    return DslParser.parseString(dslString)
-  },
-
-  /**
-   * parse() — alias for parseString() (backwards compat with v1).
-   */
-  parse(dslString: string): JSONSchema {
-    if (!dslString || typeof dslString !== 'string') {
-      throw new Error('[schema-dsl] DslAdapter.parse: DSL must be a string')
-    }
-    const schema = DslParser.parseString(dslString)
-    // v1 compat: always set _required (false if not set)
-    if ((schema as Record<string, unknown>)['_required'] === undefined) {
-      (schema as Record<string, unknown>)['_required'] = false
-    }
-    return schema
-  },
-
-  /**
-   * Parse an object-form DSL definition → ObjectDslBuilder (BC-2 fix).
-   * v1: parseObject() returned a chainable builder (.strict()/.requireAll()).
-   * v2 fix: returns ObjectDslBuilder wrapping the compiled JSONSchema.
-   */
-  parseObject(dslObj: DslDefinition): ObjectDslBuilder {
-    const schema = DslParser.parseObject(dslObj)
-    return new ObjectDslBuilder(schema)
-  },
-
-  /**
-   * Create a Match marker (v1 compat). The actual JSON Schema is built per target field in parseObject.
-   */
-  match(field: string, map: Record<string, unknown>): DslMarker {
-    return { _isMatch: true, field, map }
-  },
-
-  /**
-   * Create an If marker (v1 compat). The actual JSON Schema is built per target field in parseObject.
-   */
-  if(condition: string, thenSchema: unknown, elseSchema?: unknown): DslMarker {
-    return { _isIf: true, condition, then: thenSchema, else: elseSchema }
-  },
-
-  /**
-   * toCore() — v1 compat: returns { schema } wrapper
-   */
-  toCore(dslInput: string | DslDefinition): { schema: JSONSchema } {
-    let schema: JSONSchema
-    if (typeof dslInput === 'string') {
-      schema = this.parse(dslInput)
-    } else {
-      schema = DslParser.parseObject(dslInput)
-    }
-    return { schema }
-  },
-
-  /**
-   * typeMap getter — v1 compat: DslAdapter.typeMap exposes all registered types (BC-4 fix).
-   * Assigning typeMap[name] = schema is equivalent to calling TypeRegistry.register(name, schema).
-   */
-  get typeMap(): Record<string, JSONSchema> {
-    const map: Record<string, JSONSchema> = {}
-    for (const [name, def] of TypeRegistry.entries()) {
-      map[name] = def.baseSchema as JSONSchema
-    }
-    return new Proxy(map, {
-      set(_target: Record<string, JSONSchema>, key: string, value: JSONSchema) {
-        TypeRegistry.register(key, { baseSchema: value })
-        return true
-      },
-    })
-  },
-
-  /**
-   * registerType() — v1 compat: register a custom type into TypeRegistry (BC-4 fix).
-   */
-  registerType(name: string, schema: JSONSchema): void {
-    TypeRegistry.register(name, { baseSchema: schema })
-  },
-}
-
-export type DslAdapterType = typeof DslAdapter
-
+
+/**
+ * DslAdapter — DSL parsing adapter (thin wrapper layer).
+ *
+ * v2 changes:
+ *   - All parsing logic delegated to DslParser (replaces v1 DslAdapter._parseType duplication)
+ *   - Fixes DA-01/DA-02/DA-03 (handled uniformly by the DslParser pipeline)
+ *   - parseObject delegates to DslParser.parseObject (replaces JSONSchemaCore)
+ *   - BC-2 fix: parseObject() returns ObjectDslBuilder (supports chain .strict()/.requireAll())
+ *   - BC-4 fix: typeMap getter exposes all registered types; registerType() convenience entry point
+ */
+
+import type { JSONSchema } from '../types/schema.js'
+import type { DslDefinition } from '../types/dsl.js'
+import { DslParser } from '../parser/DslParser.js'
+import { TypeRegistry } from '../parser/TypeRegistry.js'
+import { ObjectDslBuilder } from '../core/ObjectDslBuilder.js'
+
+type DslMarker = Record<string, unknown>
+
+export const DslAdapter = {
+  /**
+   * Parse a DSL string into a JSON Schema.
+   * Equivalent to v1 DslAdapter.parseString(), but delegates to the unified DslParser.
+   */
+  parseString(dslString: string): JSONSchema {
+    if (!dslString || typeof dslString !== 'string') {
+      throw new Error('[schema-dsl] DslAdapter.parseString: DSL must be a string')
+    }
+    return DslParser.parseString(dslString)
+  },
+
+  /**
+   * parse() — alias for parseString() (backwards compat with v1).
+   */
+  parse(dslString: string): JSONSchema {
+    if (!dslString || typeof dslString !== 'string') {
+      throw new Error('[schema-dsl] DslAdapter.parse: DSL must be a string')
+    }
+    const schema = DslParser.parseString(dslString)
+    // v1 compat: always set _required (false if not set)
+    if ((schema as Record<string, unknown>)['_required'] === undefined) {
+      (schema as Record<string, unknown>)['_required'] = false
+    }
+    return schema
+  },
+
+  /**
+   * Parse an object-form DSL definition → ObjectDslBuilder (BC-2 fix).
+   * v1: parseObject() returned a chainable builder (.strict()/.requireAll()).
+   * v2 fix: returns ObjectDslBuilder wrapping the compiled JSONSchema.
+   */
+  parseObject(dslObj: DslDefinition): ObjectDslBuilder {
+    const schema = DslParser.parseObject(dslObj)
+    return new ObjectDslBuilder(schema)
+  },
+
+  /**
+   * Create a Match marker (v1 compat). The actual JSON Schema is built per target field in parseObject.
+   */
+  match(field: string, map: Record<string, unknown>): DslMarker {
+    return { _isMatch: true, field, map }
+  },
+
+  /**
+   * Create an If marker (v1 compat). The actual JSON Schema is built per target field in parseObject.
+   */
+  if(condition: string, thenSchema: unknown, elseSchema?: unknown): DslMarker {
+    return { _isIf: true, condition, then: thenSchema, else: elseSchema }
+  },
+
+  /**
+   * toCore() — v1 compat: returns { schema } wrapper
+   */
+  toCore(dslInput: string | DslDefinition): { schema: JSONSchema } {
+    let schema: JSONSchema
+    if (typeof dslInput === 'string') {
+      schema = this.parse(dslInput)
+    } else {
+      schema = DslParser.parseObject(dslInput)
+    }
+    return { schema }
+  },
+
+  /**
+   * typeMap getter — v1 compat: DslAdapter.typeMap exposes all registered types (BC-4 fix).
+   * Assigning typeMap[name] = schema is equivalent to calling TypeRegistry.register(name, schema).
+   */
+  get typeMap(): Record<string, JSONSchema> {
+    const map: Record<string, JSONSchema> = {}
+    for (const [name, def] of TypeRegistry.entries()) {
+      map[name] = def.baseSchema as JSONSchema
+    }
+    return new Proxy(map, {
+      set(_target: Record<string, JSONSchema>, key: string, value: JSONSchema) {
+        TypeRegistry.register(key, { baseSchema: value })
+        return true
+      },
+    })
+  },
+
+  /**
+   * registerType() — v1 compat: register a custom type into TypeRegistry (BC-4 fix).
+   */
+  registerType(name: string, schema: JSONSchema): void {
+    TypeRegistry.register(name, { baseSchema: schema })
+  },
+}
+
+export type DslAdapterType = typeof DslAdapter
+

package/src/adapters/index.ts

@@ -1 +1 @@
-export * from './DslAdapter.js'
+export * from './DslAdapter.js'