schema-dsl 1.2.4 → 2.0.0

package/src/parser/DslParser.ts

@@ -0,0 +1,470 @@
+import type { JSONSchema } from '../types/schema.js'
+import type { DslDefinition } from '../types/dsl.js'
+import { TypeRegistry } from './TypeRegistry.js'
+import { ConstraintParser } from './ConstraintParser.js'
+import { SchemaCompiler } from './SchemaCompiler.js'
+import { PATTERNS } from '../config/patterns.js'
+
+/**
+ * DslParser — unified entry point for parsing DSL strings and object definitions
+ *
+ * Replaces the dual implementations of DslBuilder._parseTypeString() and DslAdapter._parseType() from v1.
+ * All parsing flows through a single pipeline:
+ *   parseString() → TypeRegistry.resolve() → ConstraintParser.parse() → SchemaCompiler.compile()
+ */
+
+/** Set of standard JSON Schema types used to distinguish native JSON Schema objects from DSL definition objects. */
+const JSON_SCHEMA_TYPES = new Set(['string', 'number', 'integer', 'boolean', 'array', 'object', 'null'])
+
+/**
+ * Determine whether an object is a raw JSON Schema (rather than a DSL definition object).
+ *
+ * Criteria:
+ *   1. The `type` field is a valid JSON Schema type string, or
+ *   2. The object contains JSON Schema keywords such as anyOf / oneOf / allOf / $ref
+ *
+ * This allows distinguishing:
+ *   - `{ type: 'object', properties: {...} }` → raw JSON Schema ✅
+ *   - `{ street: 'string!', city: 'string!' }` → DSL definition ✅
+ */
+function _isRawJsonSchema(obj: Record<string, unknown>): boolean {
+  if (typeof obj['type'] === 'string' && JSON_SCHEMA_TYPES.has(obj['type'] as string)) return true
+  if ('anyOf' in obj || 'oneOf' in obj || 'allOf' in obj || '$ref' in obj) return true
+  return false
+}
+
+function _cleanRequiredMarks(schema: unknown): void {
+  if (!schema || typeof schema !== 'object') return
+  delete (schema as Record<string, unknown>)['_required']
+  const obj = schema as JSONSchema
+  if (obj.properties) {
+    for (const prop of Object.values(obj.properties)) _cleanRequiredMarks(prop)
+  }
+  if (obj.items) _cleanRequiredMarks(obj.items)
+}
+
+function _copyHiddenSchemaProperties(source: object, target: object): void {
+  for (const symbol of Object.getOwnPropertySymbols(source)) {
+    const descriptor = Object.getOwnPropertyDescriptor(source, symbol)
+    if (descriptor) Object.defineProperty(target, symbol, descriptor)
+  }
+}
+
+function _resolveDsl(value: unknown): JSONSchema {
+  if (value === null || value === undefined) return {}
+  if (typeof value === 'string') return DslParser.parseString(value)
+  if (typeof value === 'object' && !Array.isArray(value)) {
+    const obj = value as Record<string, unknown>
+    if (typeof obj['toSchema'] === 'function') return (obj['toSchema'] as () => JSONSchema)()
+    if (_isRawJsonSchema(obj)) return value as JSONSchema
+    return DslParser.parseObject(value as DslDefinition)
+  }
+  return value as JSONSchema
+}
+
+function _schemaForTarget(targetField: string, dslValue: unknown): JSONSchema {
+  const s = _resolveDsl(dslValue)
+  const isRequired = s._required
+  _cleanRequiredMarks(s)
+  const result: JSONSchema = { properties: { [targetField]: s } }
+  if (isRequired) result.required = [targetField]
+  return result
+}
+
+function _buildMatchSchema(conditionField: string, targetField: string, map: Record<string, unknown>): JSONSchema {
+  const entries = Object.entries(map).filter(([k]) => k !== '_default')
+  const defaultDsl = map['_default']
+
+  const build = (index: number): JSONSchema => {
+    if (index >= entries.length) {
+      if (defaultDsl === null || defaultDsl === undefined) return {}
+      const defaultObj = defaultDsl as Record<string, unknown>
+      if (defaultObj && defaultObj['_isMatch']) {
+        return _buildMatchSchema(String(defaultObj['field']), targetField, defaultObj['map'] as Record<string, unknown>)
+      }
+      if (defaultObj && defaultObj['_isIf']) {
+        return _buildIfSchema(String(defaultObj['condition']), targetField, defaultObj['then'], defaultObj['else'])
+      }
+      return _schemaForTarget(targetField, defaultDsl)
+    }
+
+    const [val, dslValue] = entries[index]
+    if (dslValue === null || dslValue === undefined) return build(index + 1)
+
+    const branchObj = dslValue as Record<string, unknown>
+    let thenSchema: JSONSchema
+    if (branchObj && branchObj['_isMatch']) {
+      thenSchema = _buildMatchSchema(String(branchObj['field']), targetField, branchObj['map'] as Record<string, unknown>)
+    } else if (branchObj && branchObj['_isIf']) {
+      thenSchema = _buildIfSchema(String(branchObj['condition']), targetField, branchObj['then'], branchObj['else'])
+    } else {
+      thenSchema = _schemaForTarget(targetField, dslValue)
+    }
+
+    return {
+      if: { properties: { [conditionField]: { const: val } } },
+      then: thenSchema,
+      else: build(index + 1),
+    }
+  }
+
+  return build(0)
+}
+
+function _buildIfSchema(conditionField: string, targetField: string, thenDsl: unknown, elseDsl: unknown): JSONSchema {
+  const thenObj = thenDsl as Record<string, unknown>
+  const elseObj = elseDsl as Record<string, unknown>
+
+  let thenResult: JSONSchema
+  if (thenObj && thenObj['_isMatch']) {
+    thenResult = _buildMatchSchema(String(thenObj['field']), targetField, thenObj['map'] as Record<string, unknown>)
+  } else if (thenObj && thenObj['_isIf']) {
+    thenResult = _buildIfSchema(String(thenObj['condition']), targetField, thenObj['then'], thenObj['else'])
+  } else {
+    thenResult = _schemaForTarget(targetField, thenDsl)
+  }
+
+  let elseResult: JSONSchema = {}
+  if (elseDsl !== null && elseDsl !== undefined) {
+    if (elseObj && elseObj['_isMatch']) {
+      elseResult = _buildMatchSchema(String(elseObj['field']), targetField, elseObj['map'] as Record<string, unknown>)
+    } else if (elseObj && elseObj['_isIf']) {
+      elseResult = _buildIfSchema(String(elseObj['condition']), targetField, elseObj['then'], elseObj['else'])
+    } else {
+      elseResult = _schemaForTarget(targetField, elseDsl)
+    }
+  }
+
+  return {
+    if: { properties: { [conditionField]: { const: true } } },
+    then: thenResult,
+    else: elseResult,
+  }
+}
+
+export const DslParser = {
+  /**
+   * Parse a DSL string → JSONSchema
+   *
+   * Supported formats:
+   *   - 'string'          → { type: 'string' }
+   *   - 'string!'         → { type: 'string', _required: true }
+   *   - 'string:6'        → { type: 'string', exactLength: 6 }  (DA-03 fix)
+   *   - 'string:3-32'     → { type: 'string', minLength: 3, maxLength: 32 }
+   *   - 'number:0-100'    → { type: 'number', minimum: 0, maximum: 100 }
+   *   - 'number:-100-0'   → { type: 'number', minimum: -100, maximum: 0 }  (DB-03 fix)
+   *   - 'enum:a,b,c'      → { type: 'string', enum: ['a','b','c'] }
+   *   - 'a|b|c'           → { type: 'string', enum: ['a','b','c'] }
+   *   - 'array!1-10'      → { type: 'array', minItems:1, maxItems:10, _required:true }
+   */
+  parseString(dslStr: string): JSONSchema {
+    if (!dslStr || typeof dslStr !== 'string') {
+      return { type: 'string' }
+    }
+
+    let s = dslStr.trim()
+    let required = false
+
+    // ========== Pre-processing 1: array!N-M special syntax (v1 compat) ==========
+    // 'array!1-10' → equivalent to 'array:1-10' + required=true
+    const arrayBangMatch = /^array!([\d-]+)$/.exec(s)
+    if (arrayBangMatch) {
+      s = `array:${arrayBangMatch[1]}`
+      required = true
+    }
+
+    // ========== Pre-processing 2: trailing '!' / '?' → required/optional marker, strip ==========
+    if (s.endsWith('!')) {
+      required = true
+      s = s.slice(0, -1)
+    } else if (s.endsWith('?')) {
+      s = s.slice(0, -1)
+    }
+
+    // ========== Special case: pipe enum 'a|b|c' (no colon — entire segment is enum) ==========
+    if (s.includes('|') && !s.includes(':')) {
+      const rawValues = s.split('|').map(v => v.trim())
+      // Auto-detect type from values
+      if (rawValues.every(v => v === 'true' || v === 'false')) {
+        // Boolean enum
+        return {
+          type: 'boolean',
+          enum: rawValues.map(v => v === 'true'),
+          ...(required ? { _required: true } : {}),
+        }
+      }
+      const numericValues = rawValues.map(v => Number(v))
+      if (rawValues.every((v, i) => v !== '' && !isNaN(numericValues[i]))) {
+        // Numeric enum — always use 'number' type for v1 compat
+        return {
+          type: 'number',
+          enum: numericValues,
+          ...(required ? { _required: true } : {}),
+        }
+      }
+      // String enum (default)
+      return {
+        type: 'string',
+        enum: rawValues,
+        ...(required ? { _required: true } : {}),
+      }
+    }
+
+    // ========== Special case: enum: prefix ==========
+    // 'enum:a,b,c'         → { type:'string', enum:['a','b','c'] }
+    // 'enum:number:1,2,3'  → { type:'number', enum:[1,2,3] }
+    if (s.startsWith('enum:')) {
+      return DslParser._parseEnumSyntax(s, required)
+    }
+
+    // ========== Special case: types: union type prefix (v1 compat) ==========
+    // 'types:string|number'              → oneOf: [{ type:'string' }, { type:'number' }]
+    // 'types:string:3-10|number:0-100'   → oneOf with constraints
+    // 'types:email|phone'                → oneOf with format types
+    if (s.startsWith('types:')) {
+      return DslParser._parseUnionTypes(s.slice(6), required)
+    }
+
+    // ========== Special case: array<TYPE> syntax ==========
+    // 'array<string>'                  → { type:'array', items:{ type:'string' } }
+    // 'array<enum:public|private>'     → { type:'array', items:{ type:'string', enum:[...] } }
+    // 'array:1-5<string:1-20>'         → { type:'array', minItems:1, maxItems:5, items:{ type:'string', minLength:1, maxLength:20 } }
+    const arrayAngleWithConstraintMatch = /^array:([^<]+)<(.+)>$/.exec(s)
+    if (arrayAngleWithConstraintMatch) {
+      const arrayConstraint = ConstraintParser.parse(arrayAngleWithConstraintMatch[1], 'array')
+      const itemSchema = DslParser.parseString(arrayAngleWithConstraintMatch[2])
+      return {
+        type: 'array',
+        ...arrayConstraint,
+        items: itemSchema,
+        ...(required ? { _required: true } : {}),
+      }
+    }
+    const arrayAngleMatch = /^array<(.+)>$/.exec(s)
+    if (arrayAngleMatch) {
+      const itemSchema = DslParser.parseString(arrayAngleMatch[1])
+      return {
+        type: 'array',
+        items: itemSchema,
+        ...(required ? { _required: true } : {}),
+      }
+    }
+
+    // ========== Main parsing: typeName[:constraint] ==========
+    const colonIdx = s.indexOf(':')
+    let typeName: string
+    let constraintStr: string
+
+    if (colonIdx === -1) {
+      typeName = s
+      constraintStr = ''
+    } else {
+      typeName = s.slice(0, colonIdx)
+      constraintStr = s.slice(colonIdx + 1)
+    }
+
+    // ========== Special case: pattern types (phone/idCard/creditCard/licensePlate/postalCode/passport) ==========
+    const PATTERN_TYPES = ['phone', 'idCard', 'creditCard', 'licensePlate', 'postalCode', 'passport'] as const
+    if (PATTERN_TYPES.includes(typeName as typeof PATTERN_TYPES[number])) {
+      const patternGroup = PATTERNS[typeName as keyof typeof PATTERNS] as Record<string, { pattern: RegExp; min?: number; max?: number; key: string }>
+      if (patternGroup) {
+        const arg = constraintStr || (typeName === 'creditCard' ? 'visa' : 'cn')
+        const cfg = patternGroup[arg.toLowerCase()]
+        if (cfg) {
+          return {
+            type: 'string',
+            pattern: cfg.pattern.source,
+            ...(cfg.min !== undefined ? { minLength: cfg.min } : {}),
+            ...(cfg.max !== undefined ? { maxLength: cfg.max } : {}),
+            _customMessages: { pattern: cfg.key },
+            ...(required ? { _required: true } : {}),
+          }
+        }
+        throw new Error(`[schema-dsl] Unsupported country/variant "${arg}" for type "${typeName}"`)
+      }
+    }
+
+    // TypeRegistry resolution
+    const typeDef = TypeRegistry.resolve(typeName)
+
+    // ConstraintParser parse — use resolved base type (e.g., 'string' for 'alphanum')
+    const resolvedBaseType = (typeDef.baseSchema.type as string) ?? typeName
+    const constraints = ConstraintParser.parse(constraintStr, resolvedBaseType)
+
+    // SchemaCompiler assembly
+    const schema = SchemaCompiler.compile(typeDef, constraints, {
+      required,
+    })
+
+    return schema
+  },
+
+  /**
+   * Parse an object DSL definition → JSONSchema (type:object + properties + required[])
+   */
+  parseObject(dslObj: DslDefinition): JSONSchema {
+    const schema: JSONSchema = {
+      type: 'object',
+      properties: {},
+      required: [],
+    }
+
+    for (const [rawKey, value] of Object.entries(dslObj)) {
+      let fieldKey = rawKey
+      let isKeyRequired = false
+
+      // key! suffix marks this field as required
+      if (rawKey.endsWith('!')) {
+        fieldKey = rawKey.slice(0, -1)
+        isKeyRequired = true
+      }
+
+      let fieldSchema: JSONSchema
+
+      if (typeof value === 'string') {
+        fieldSchema = DslParser.parseString(value)
+      } else if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
+        const obj = value as Record<string, unknown>
+        if (obj['_isMatch']) {
+          if (!schema.allOf) schema.allOf = []
+          schema.allOf.push(_buildMatchSchema(String(obj['field']), fieldKey, obj['map'] as Record<string, unknown>))
+          fieldSchema = { description: `Depends on ${String(obj['field'])}` }
+        } else if (obj['_isIf']) {
+          if (!schema.allOf) schema.allOf = []
+          schema.allOf.push(_buildIfSchema(String(obj['condition']), fieldKey, obj['then'], obj['else']))
+          fieldSchema = { description: `Conditional field based on ${String(obj['condition'])}` }
+        } else if (typeof obj['toSchema'] === 'function') {
+          // DslBuilder instance or ConditionalBuilder (has toSchema method)
+          fieldSchema = (obj['toSchema'] as () => JSONSchema)()
+        } else if (_isRawJsonSchema(obj)) {
+          // Raw JSON Schema object (e.g., { type: 'object', properties: {...} }) — pass through as-is
+          fieldSchema = value as JSONSchema
+        } else {
+          // Nested DslDefinition (e.g., { street: 'string!', city: 'string!' })
+          fieldSchema = DslParser.parseObject(value as DslDefinition)
+        }
+      } else {
+        // Pass through as-is (compatible with direct schema fragment input)
+        fieldSchema = value as JSONSchema
+      }
+
+      // Apply required flag: key! takes priority over the field's internal _required marker
+      if (isKeyRequired) {
+        ; (schema.required as string[]).push(fieldKey)
+      } else if (fieldSchema._required) {
+        ; (schema.required as string[]).push(fieldKey)
+      }
+
+      // Strip the internal _required marker
+      const { _required: _r, ...cleanSchema } = fieldSchema as JSONSchema & { _required?: boolean }
+      void _r
+      _copyHiddenSchemaProperties(fieldSchema as object, cleanSchema as object)
+      _cleanRequiredMarks(cleanSchema)
+
+        ; (schema.properties as Record<string, JSONSchema>)[fieldKey] = cleanSchema
+    }
+
+    if ((schema.required as string[]).length === 0) {
+      delete schema.required
+    }
+
+    return schema
+  },
+
+  // --------------- Private helpers ---------------
+
+  /** Parse enum: prefix syntax */
+  _parseEnumSyntax(s: string, required: boolean): JSONSchema {
+    // Strip the 'enum:' prefix
+    const rest = s.slice('enum:'.length)
+
+    // Check for a type prefix: 'enum:number:1|2|3' or 'enum:number:1,2,3'
+    const typedEnumMatch = /^(string|number|integer|boolean):(.+)$/.exec(rest)
+    if (typedEnumMatch) {
+      const enumType = typedEnumMatch[1] as 'string' | 'number' | 'integer' | 'boolean'
+      const rawStr = typedEnumMatch[2]
+      const rawValues = (rawStr.includes('|') ? rawStr.split('|') : rawStr.split(',')).map(v => v.trim())
+      const values = DslParser._coerceEnumValues(rawValues, enumType)
+      return {
+        type: enumType,
+        enum: values,
+        ...(required ? { _required: true } : {}),
+      }
+    }
+
+    // No type prefix: default to string, supporting both '|' and ',' as separators
+    return {
+      type: 'string',
+      enum: (rest.includes('|') ? rest.split('|') : rest.split(',')).map(v => v.trim()),
+      ...(required ? { _required: true } : {}),
+    }
+  },
+
+  /** Convert a string array to enum values of the specified type */
+  _coerceEnumValues(
+    values: string[],
+    type: 'string' | 'number' | 'integer' | 'boolean'
+  ): (string | number | boolean)[] {
+    if (type === 'number' || type === 'integer') {
+      return values.map(v => {
+        const n = parseFloat(v)
+        if (isNaN(n)) throw new Error(`[schema-dsl] Invalid number enum value: "${v}"`)
+        return n
+      })
+    }
+    if (type === 'boolean') {
+      return values.map(v => {
+        if (v !== 'true' && v !== 'false')
+          throw new Error(`[schema-dsl] Invalid boolean enum value: "${v}"`)
+        return v === 'true'
+      })
+    }
+    return values
+  },
+
+  /**
+   * Parse types: union type syntax (v1 compatible)
+   *
+   * Splits 'string|number' into a oneOf array, parsing each segment independently.
+   * Uses smart splitting: 'string:3-10|number:0-100' → ['string:3-10', 'number:0-100']
+   * When only a single type is present, emits a plain schema instead of a oneOf wrapper.
+   */
+  _parseUnionTypes(typesStr: string, required: boolean): JSONSchema {
+    // Smart split by | that is a type separator (not inside constraints)
+    const segments: string[] = []
+    let current = ''
+    let depth = 0
+
+    for (let i = 0; i < typesStr.length; i++) {
+      const ch = typesStr[i]
+      if (ch === '<') { depth++; current += ch }
+      else if (ch === '>') { depth--; current += ch }
+      else if (ch === '|' && depth === 0) {
+        if (current.trim()) segments.push(current.trim())
+        current = ''
+      } else {
+        current += ch
+      }
+    }
+    if (current.trim()) segments.push(current.trim())
+
+    if (segments.length === 0) {
+      throw new Error('[schema-dsl] types: requires at least one type')
+    }
+
+    // Single type → optimize to direct schema (no oneOf)
+    if (segments.length === 1) {
+      const schema = DslParser.parseString(segments[0])
+      if (required) schema._required = true
+      return schema
+    }
+
+    // Multiple types → oneOf
+    const oneOf = segments.map(seg => DslParser.parseString(seg))
+
+    return {
+      oneOf,
+      ...(required ? { _required: true } : {}),
+    } as JSONSchema
+  },
+}

package/src/parser/SchemaCompiler.ts

@@ -0,0 +1,66 @@
+import type { JSONSchema } from '../types/schema.js'
+import type { TypeDefinition } from './TypeRegistry.js'
+
+/** Callback type for the afterCompile hook (synchronous only). */
+export type AfterCompileHook = (schema: JSONSchema) => void
+
+/**
+ * SchemaCompiler — assembles TypeDefinition + constraints into the final JSONSchema.
+ *
+ * Responsibilities:
+ *   1. Merge baseSchema + constraints (constraints take priority)
+ *   2. Inject _label / _customMessages / _required (from TypeDefinition or caller)
+ *   3. Fire afterCompile hooks
+ */
+export const SchemaCompiler = {
+  /**
+   * Compile and return a JSONSchema (including internal keys; stripped by toJsonSchema).
+   */
+  compile(
+    typeDef: TypeDefinition,
+    constraints: Partial<JSONSchema>,
+    meta?: {
+      label?: string
+      required?: boolean
+      afterCompileHook?: AfterCompileHook
+    }
+  ): JSONSchema {
+    // Merge baseSchema + constraints (constraints fields override baseSchema fields)
+    const schema: JSONSchema = {
+      ...typeDef.baseSchema,
+      ...constraints,
+    }
+
+    // Inject type-level _customMessages (e.g., phone, idCard types)
+    if (typeDef.customMessages) {
+      schema['_customMessages'] = {
+        ...(schema['_customMessages'] as Record<string, string> | undefined),
+        ...typeDef.customMessages,
+      }
+    }
+
+    // Inject meta
+    if (meta?.label) schema['_label'] = meta.label
+    if (meta?.required) schema['_required'] = true
+
+    // Fire afterCompile hook (synchronous)
+    if (meta?.afterCompileHook) {
+      meta.afterCompileHook(schema)
+    }
+
+    return schema
+  },
+
+  /**
+   * Strip internal keys and return a clean JSON Schema (used by toJsonSchema() output).
+   */
+  toJsonSchema(schema: JSONSchema, internalKeys: ReadonlySet<string>): JSONSchema {
+    const result: JSONSchema = {}
+    for (const [k, v] of Object.entries(schema)) {
+      if (!internalKeys.has(k)) {
+        result[k] = v
+      }
+    }
+    return result
+  },
+}