schema-dsl 2.0.0 → 2.0.1

package/src/plugins/custom-format.ts

@@ -1,126 +1,124 @@
-import type { Plugin } from '../types/plugin.js'
-import { DslBuilder } from '../core/DslBuilder.js'
-import type { Validator } from '../core/Validator.js'
-
-interface FormatConfig {
-  pattern?: RegExp
-  validate?: (value: string) => boolean
-  schema: Record<string, unknown>
-}
-
-const FORMATS: Record<string, FormatConfig> = {
-  'phone-cn': {
-    pattern: /^1[3-9]\d{9}$/,
-    schema: { type: 'string', pattern: /^1[3-9]\d{9}$/.source, minLength: 11, maxLength: 11 },
-  },
-  'postal-code-cn': {
-    pattern: /^\d{6}$/,
-    schema: { type: 'string', pattern: /^\d{6}$/.source, minLength: 6, maxLength: 6 },
-  },
-  'ipv4-custom': {
-    pattern: /^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/,
-    schema: { type: 'string', format: 'ipv4' },
-  },
-  'wechat': {
-    pattern: /^[a-zA-Z][-_a-zA-Z0-9]{5,19}$/,
-    schema: { type: 'string', pattern: /^[a-zA-Z][-_a-zA-Z0-9]{5,19}$/.source, minLength: 6, maxLength: 20 },
-  },
-  'qq': {
-    pattern: /^[1-9][0-9]{4,10}$/,
-    schema: { type: 'string', pattern: /^[1-9][0-9]{4,10}$/.source, minLength: 5, maxLength: 11 },
-  },
-  'bank-card': {
-    validate: (value: string) => {
-      if (!/^\d{16,19}$/.test(value)) return false
-
-      let sum = 0
-      let shouldDouble = false
-
-      for (let i = value.length - 1; i >= 0; i -= 1) {
-        let digit = Number.parseInt(value[i], 10)
-
-        if (shouldDouble) {
-          digit *= 2
-          if (digit > 9) digit -= 9
-        }
-
-        sum += digit
-        shouldDouble = !shouldDouble
-      }
-
-      return sum % 10 === 0
-    },
-    schema: { type: 'string', minLength: 16, maxLength: 19, pattern: /^\d{16,19}$/.source },
-  },
-  'license-plate': {
-    pattern: /^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z][A-HJ-NP-Z0-9]{4,5}[A-HJ-NP-Z0-9挂学警港澳]$/,
-    schema: {
-      type: 'string',
-      pattern: /^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z][A-HJ-NP-Z0-9]{4,5}[A-HJ-NP-Z0-9挂学警港澳]$/.source,
-    },
-  },
-  'credit-code': {
-    pattern: /^[0-9A-HJ-NPQRTUWXY]{2}\d{6}[0-9A-HJ-NPQRTUWXY]{10}$/,
-    schema: {
-      type: 'string',
-      pattern: /^[0-9A-HJ-NPQRTUWXY]{2}\d{6}[0-9A-HJ-NPQRTUWXY]{10}$/.source,
-      minLength: 18,
-      maxLength: 18,
-    },
-  },
-  'passport-cn': {
-    pattern: /^[EG]\d{8}$/,
-    schema: { type: 'string', pattern: /^[EG]\d{8}$/.source, minLength: 9, maxLength: 9 },
-  },
-  'hk-macao-pass': {
-    pattern: /^[HM]\d{8,10}$/,
-    schema: { type: 'string', pattern: /^[HM]\d{8,10}$/.source, minLength: 9, maxLength: 11 },
-  },
-}
-
-function getAjvLike(core: unknown): {
-  addFormat: (name: string, definition: RegExp | { validate: RegExp | ((value: string) => boolean) }) => void
-} {
-  const coreRecord = core as { getDefaultValidator?: () => Validator }
-  const validator = coreRecord.getDefaultValidator?.()
-  if (!validator) {
-    throw new Error('getDefaultValidator() is not available. Please provide schema-dsl core object.')
-  }
-  return validator.getAjv() as {
-    addFormat: (name: string, definition: RegExp | { validate: RegExp | ((value: string) => boolean) }) => void
-  }
-}
-
-function getDslBuilderLike(core: unknown): typeof DslBuilder {
-  const coreRecord = core as { DslBuilder?: typeof DslBuilder }
-  return coreRecord.DslBuilder ?? DslBuilder
-}
-
-export const customFormatPlugin: Plugin & {
-  addCustomFormats: (ajv: { addFormat: (name: string, definition: { validate: RegExp | ((value: string) => boolean) }) => void }, dslBuilder: typeof DslBuilder) => void
-} = {
-  name: 'custom-format',
-  version: '2.0.0',
-  description: 'Custom format validation plugin (with DSL type registration)',
-  install(core, _options = {}, _context) {
-    const ajv = getAjvLike(core)
-    const dslBuilder = getDslBuilderLike(core)
-    this.addCustomFormats(ajv, dslBuilder)
-    console.log('[Plugin] custom-format v2.0.0 installed (with DSL type registration)')
-  },
-  uninstall() {
-    console.log('[Plugin] custom-format uninstalled')
-  },
-  addCustomFormats(ajv, dslBuilder) {
-    for (const [name, config] of Object.entries(FORMATS)) {
-      ajv.addFormat(name, {
-        validate: config.validate ?? config.pattern!,
-      })
-      dslBuilder.registerType(name, config.schema)
-    }
-  },
-}
-
-export default customFormatPlugin
-
-
+import type { Plugin } from '../types/plugin.js'
+import { DslBuilder } from '../core/DslBuilder.js'
+import type { Validator } from '../core/Validator.js'
+
+interface FormatConfig {
+  pattern?: RegExp
+  validate?: (value: string) => boolean
+  schema: Record<string, unknown>
+}
+
+const FORMATS: Record<string, FormatConfig> = {
+  'phone-cn': {
+    pattern: /^1[3-9]\d{9}$/,
+    schema: { type: 'string', pattern: /^1[3-9]\d{9}$/.source, minLength: 11, maxLength: 11 },
+  },
+  'postal-code-cn': {
+    pattern: /^\d{6}$/,
+    schema: { type: 'string', pattern: /^\d{6}$/.source, minLength: 6, maxLength: 6 },
+  },
+  'ipv4-custom': {
+    pattern: /^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/,
+    schema: { type: 'string', format: 'ipv4' },
+  },
+  'wechat': {
+    pattern: /^[a-zA-Z][-_a-zA-Z0-9]{5,19}$/,
+    schema: { type: 'string', pattern: /^[a-zA-Z][-_a-zA-Z0-9]{5,19}$/.source, minLength: 6, maxLength: 20 },
+  },
+  'qq': {
+    pattern: /^[1-9][0-9]{4,10}$/,
+    schema: { type: 'string', pattern: /^[1-9][0-9]{4,10}$/.source, minLength: 5, maxLength: 11 },
+  },
+  'bank-card': {
+    validate: (value: string) => {
+      if (!/^\d{16,19}$/.test(value)) return false
+
+      let sum = 0
+      let shouldDouble = false
+
+      for (let i = value.length - 1; i >= 0; i -= 1) {
+        let digit = Number.parseInt(value[i], 10)
+
+        if (shouldDouble) {
+          digit *= 2
+          if (digit > 9) digit -= 9
+        }
+
+        sum += digit
+        shouldDouble = !shouldDouble
+      }
+
+      return sum % 10 === 0
+    },
+    schema: { type: 'string', minLength: 16, maxLength: 19, pattern: /^\d{16,19}$/.source },
+  },
+  'license-plate': {
+    pattern: /^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z][A-HJ-NP-Z0-9]{4,5}[A-HJ-NP-Z0-9挂学警港澳]$/,
+    schema: {
+      type: 'string',
+      pattern: /^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z][A-HJ-NP-Z0-9]{4,5}[A-HJ-NP-Z0-9挂学警港澳]$/.source,
+    },
+  },
+  'credit-code': {
+    pattern: /^[0-9A-HJ-NPQRTUWXY]{2}\d{6}[0-9A-HJ-NPQRTUWXY]{10}$/,
+    schema: {
+      type: 'string',
+      pattern: /^[0-9A-HJ-NPQRTUWXY]{2}\d{6}[0-9A-HJ-NPQRTUWXY]{10}$/.source,
+      minLength: 18,
+      maxLength: 18,
+    },
+  },
+  'passport-cn': {
+    pattern: /^[EG]\d{8}$/,
+    schema: { type: 'string', pattern: /^[EG]\d{8}$/.source, minLength: 9, maxLength: 9 },
+  },
+  'hk-macao-pass': {
+    pattern: /^[HM]\d{8,10}$/,
+    schema: { type: 'string', pattern: /^[HM]\d{8,10}$/.source, minLength: 9, maxLength: 11 },
+  },
+}
+
+function getAjvLike(core: unknown): {
+  addFormat: (name: string, definition: RegExp | { validate: RegExp | ((value: string) => boolean) }) => void
+} {
+  const coreRecord = core as { getDefaultValidator?: () => Validator }
+  const validator = coreRecord.getDefaultValidator?.()
+  if (!validator) {
+    throw new Error('getDefaultValidator() is not available. Please provide schema-dsl core object.')
+  }
+  return validator.getAjv() as {
+    addFormat: (name: string, definition: RegExp | { validate: RegExp | ((value: string) => boolean) }) => void
+  }
+}
+
+function getDslBuilderLike(core: unknown): typeof DslBuilder {
+  const coreRecord = core as { DslBuilder?: typeof DslBuilder }
+  return coreRecord.DslBuilder ?? DslBuilder
+}
+
+export const customFormatPlugin: Plugin & {
+  addCustomFormats: (ajv: { addFormat: (name: string, definition: { validate: RegExp | ((value: string) => boolean) }) => void }, dslBuilder: typeof DslBuilder) => void
+} = {
+  name: 'custom-format',
+  version: '2.0.0',
+  description: 'Custom format validation plugin (with DSL type registration)',
+  install(core, _options = {}, _context) {
+    const ajv = getAjvLike(core)
+    const dslBuilder = getDslBuilderLike(core)
+    this.addCustomFormats(ajv, dslBuilder)
+  },
+  uninstall() {
+  },
+  addCustomFormats(ajv, dslBuilder) {
+    for (const [name, config] of Object.entries(FORMATS)) {
+      ajv.addFormat(name, {
+        validate: config.validate ?? config.pattern!,
+      })
+      dslBuilder.registerType(name, config.schema)
+    }
+  },
+}
+
+export default customFormatPlugin
+
+

package/src/plugins/custom-type-example.ts

@@ -1,108 +1,106 @@
-import type { Plugin } from '../types/plugin.js'
-import { DslBuilder } from '../core/DslBuilder.js'
-
-export const customTypeExamplePlugin: Plugin & {
-  registerCustomTypes: (dslBuilder: typeof DslBuilder) => void
-} = {
-  name: 'custom-type-example',
-  version: '1.0.0',
-  description: 'Custom type registration example plugin',
-  install(core, _options = {}, _context) {
-    const coreRecord = core as { DslBuilder?: typeof DslBuilder }
-    const builder = coreRecord.DslBuilder ?? DslBuilder
-
-    if (!builder || typeof builder.registerType !== 'function') {
-      throw new Error('DslBuilder.registerType is not available. Please upgrade to schema-dsl v1.1.0+')
-    }
-
-    this.registerCustomTypes(builder)
-    console.log('[Plugin] custom-type-example installed')
-  },
-  uninstall() {
-    console.log('[Plugin] custom-type-example uninstalled')
-  },
-  registerCustomTypes(dslBuilder) {
-    dslBuilder.registerType('order-id', {
-      type: 'string',
-      pattern: /^ORD[0-9]{12}$/.source,
-      minLength: 15,
-      maxLength: 15,
-      _customMessages: {
-        pattern: 'Invalid order ID format; must be 15 characters starting with ORD',
-      },
-    })
-
-    dslBuilder.registerType('sku', {
-      type: 'string',
-      pattern: /^SKU-[A-Z0-9]{6,10}$/.source,
-      minLength: 10,
-      maxLength: 14,
-      _customMessages: {
-        pattern: 'Invalid SKU format; must be SKU- followed by 6–10 alphanumeric characters',
-      },
-    })
-
-    dslBuilder.registerType('price', {
-      type: 'number',
-      minimum: 0,
-      multipleOf: 0.01,
-      _customMessages: {
-        minimum: 'Price cannot be negative',
-        multipleOf: 'Price can have at most 2 decimal places',
-      },
-    })
-
-    dslBuilder.registerType('rating', {
-      type: 'integer',
-      minimum: 1,
-      maximum: 5,
-      _customMessages: {
-        minimum: 'Rating cannot be lower than 1 star',
-        maximum: 'Rating cannot exceed 5 stars',
-      },
-    })
-
-    dslBuilder.registerType('color-code', {
-      oneOf: [
-        { type: 'string', pattern: /^#[0-9A-Fa-f]{6}$/.source },
-        { type: 'string', pattern: /^#[0-9A-Fa-f]{3}$/.source },
-        { type: 'string', pattern: /^rgb\(\d{1,3},\s*\d{1,3},\s*\d{1,3}\)$/.source },
-        { type: 'string', pattern: /^rgba\(\d{1,3},\s*\d{1,3},\s*\d{1,3},\s*(0|1|0?\.\d+)\)$/.source },
-      ],
-    })
-
-    dslBuilder.registerType('semver', {
-      type: 'string',
-      pattern: /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/.source,
-      _customMessages: {
-        pattern: 'Invalid version format; must follow semantic versioning (e.g. 1.0.0, 2.1.3-beta.1)',
-      },
-    })
-
-    dslBuilder.registerType('dynamic-age', () => {
-      const currentYear = new Date().getFullYear()
-      return {
-        type: 'integer',
-        minimum: 0,
-        maximum: currentYear - 1900,
-        _customMessages: {
-          minimum: 'Age cannot be negative',
-          maximum: `Age cannot exceed ${currentYear - 1900} years`,
-        },
-      }
-    })
-
-    dslBuilder.registerType('phone-intl', {
-      type: 'string',
-      pattern: /^\+?[1-9]\d{1,14}$/.source,
-      minLength: 8,
-      maxLength: 15,
-      _customMessages: {
-        pattern: 'Please enter a valid international phone number (E.164 format)',
-      },
-    })
-  },
-}
-
-export default customTypeExamplePlugin
-
+import type { Plugin } from '../types/plugin.js'
+import { DslBuilder } from '../core/DslBuilder.js'
+
+export const customTypeExamplePlugin: Plugin & {
+  registerCustomTypes: (dslBuilder: typeof DslBuilder) => void
+} = {
+  name: 'custom-type-example',
+  version: '1.0.0',
+  description: 'Custom type registration example plugin',
+  install(core, _options = {}, _context) {
+    const coreRecord = core as { DslBuilder?: typeof DslBuilder }
+    const builder = coreRecord.DslBuilder ?? DslBuilder
+
+    if (!builder || typeof builder.registerType !== 'function') {
+      throw new Error('DslBuilder.registerType is not available. Please upgrade to schema-dsl v1.1.0+')
+    }
+
+    this.registerCustomTypes(builder)
+  },
+  uninstall() {
+  },
+  registerCustomTypes(dslBuilder) {
+    dslBuilder.registerType('order-id', {
+      type: 'string',
+      pattern: /^ORD[0-9]{12}$/.source,
+      minLength: 15,
+      maxLength: 15,
+      _customMessages: {
+        pattern: 'Invalid order ID format; must be 15 characters starting with ORD',
+      },
+    })
+
+    dslBuilder.registerType('sku', {
+      type: 'string',
+      pattern: /^SKU-[A-Z0-9]{6,10}$/.source,
+      minLength: 10,
+      maxLength: 14,
+      _customMessages: {
+        pattern: 'Invalid SKU format; must be SKU- followed by 6–10 alphanumeric characters',
+      },
+    })
+
+    dslBuilder.registerType('price', {
+      type: 'number',
+      minimum: 0,
+      multipleOf: 0.01,
+      _customMessages: {
+        minimum: 'Price cannot be negative',
+        multipleOf: 'Price can have at most 2 decimal places',
+      },
+    })
+
+    dslBuilder.registerType('rating', {
+      type: 'integer',
+      minimum: 1,
+      maximum: 5,
+      _customMessages: {
+        minimum: 'Rating cannot be lower than 1 star',
+        maximum: 'Rating cannot exceed 5 stars',
+      },
+    })
+
+    dslBuilder.registerType('color-code', {
+      oneOf: [
+        { type: 'string', pattern: /^#[0-9A-Fa-f]{6}$/.source },
+        { type: 'string', pattern: /^#[0-9A-Fa-f]{3}$/.source },
+        { type: 'string', pattern: /^rgb\(\d{1,3},\s*\d{1,3},\s*\d{1,3}\)$/.source },
+        { type: 'string', pattern: /^rgba\(\d{1,3},\s*\d{1,3},\s*\d{1,3},\s*(0|1|0?\.\d+)\)$/.source },
+      ],
+    })
+
+    dslBuilder.registerType('semver', {
+      type: 'string',
+      pattern: /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/.source,
+      _customMessages: {
+        pattern: 'Invalid version format; must follow semantic versioning (e.g. 1.0.0, 2.1.3-beta.1)',
+      },
+    })
+
+    dslBuilder.registerType('dynamic-age', () => {
+      const currentYear = new Date().getFullYear()
+      return {
+        type: 'integer',
+        minimum: 0,
+        maximum: currentYear - 1900,
+        _customMessages: {
+          minimum: 'Age cannot be negative',
+          maximum: `Age cannot exceed ${currentYear - 1900} years`,
+        },
+      }
+    })
+
+    dslBuilder.registerType('phone-intl', {
+      type: 'string',
+      pattern: /^\+?[1-9]\d{1,14}$/.source,
+      minLength: 8,
+      maxLength: 15,
+      _customMessages: {
+        pattern: 'Please enter a valid international phone number (E.164 format)',
+      },
+    })
+  },
+}
+
+export default customTypeExamplePlugin
+