schema-dsl document map

This page is a document map. The left sidebar keeps the main learning path, while this page also lists smaller reference and appendix pages for readers who already know the area they need.

Start

Document	When to read it
Home	Landing page and primary product positioning.
Quick Start	First successful schema, validation result, and common usage path.
Design Philosophy	Why schema-dsl favors concise DSL, JSON Schema output, and runtime validation.
TypeScript Guide	Type inference boundaries, editor hints, and TypeScript usage patterns.

Schema Authoring

Document	When to read it
DSL Syntax	Complete DSL grammar for string and object schemas.
Complete Type List	Supported base types, formats, factory calls, and type-oriented behavior.
Chain Method List	Complete field builder method list and entry support.
Optional Marker ?	Optional field syntax and required-field behavior.
Multi-type Support	Design notes for fields that accept multiple types.
Union Types	`types:` syntax and cross-type validation.
Union Type Guide	Practical guide for one field accepting multiple types.
Number Operators	Numeric comparison operators and range notation.
Enum	Enumeration syntax and allowed-value validation.
String Extensions	JavaScript String chain helpers and side-effect-controlled entries.

Validation and Runtime

Document	When to read it
validate()	Synchronous validation helper and result shape.
validateAsync()	Async validation and `ValidationError` behavior.
Batch Validation	Validating arrays of data with aggregate results.
DSL Object Support	Passing DSL object definitions directly to validation helpers.
Validation Guide	End-to-end validation scenarios, failures, and options.
Validator	Validator class usage, lifecycle, and cache behavior.
Conditional API	ConditionalBuilder and conditional validation chains.
Error Handling	Error formatting, messages, and recovery patterns.
compile()	Compiling schemas before repeated validation.
Runtime Isolation	Isolated runtime state for app, plugin, tenant, or worker boundaries.

Export and Interop

Document	When to read it
JSON Schema Basics	JSON Schema concepts used by schema-dsl output.
Export Guide	How JSON Schema maps to database and Markdown exporters.
Export Limitations	Which validation semantics cannot be represented by database DDL.
MongoDB Exporter	MongoDB `$jsonSchema` output and collection commands.
MySQL Exporter	MySQL DDL and type mapping.
PostgreSQL Exporter	PostgreSQL DDL, schemas, and indexes.
Markdown Exporter	Markdown documentation output from schemas.
TypeConverter	JSON Schema to database type conversion utilities.

Reuse and Utilities

Document	When to read it
SchemaUtils	Schema reuse, composition, filtering, and helper exports.
SchemaUtils Chaining	Chain-style reuse operations.
SchemaUtils Best Practices	Practical patterns and common pitfalls for reusable schemas.
SchemaUtils Advanced Issues	Deeper edge cases and maintenance notes.
SchemaHelper	Schema analysis and helper utilities.
Validator Cache	Compile cache capacity, TTL, and hit-rate statistics.
Labels and Messages	Difference between `.label()`, `.description()`, `.messages()`, and `.error()`.

Internationalization

Document	When to read it
i18n Overview	Internationalization model and supported locale concepts.
Multi-language Support	Built-in multilingual behavior.
i18n User Guide	User-facing i18n configuration and usage.
Frontend i18n Guide	Frontend language switching patterns.
Add Custom Locale	Adding custom language packs.
Dynamic Locale	Runtime locale switching.
Runtime Locale Support	Locale behavior during runtime validation.

Extensions and Integration

Document	When to read it
Extension Overview	Choose between custom business types, validation keywords, runtime isolation, and plugins.
Custom DSL Types	Define reusable business types once for pure DSL, `s('...')`, and `s.xxx()` entries.
Custom Validation Keywords	Add custom AJV keywords.
Framework Integration	Organize reusable extension modules for applications and frameworks.
Plugin Manager (Advanced)	Plugin lifecycle, hooks, and integration orchestration.

Production and Troubleshooting

Document	When to read it
Best Practices	Recommended usage patterns for production projects.
Project Structure Best Practices	Organizing schema-dsl in a real project.
Performance Guide	Performance tuning and cache considerations.
Security Notes	Security notes for schema usage, custom validators, and export.
Troubleshooting	Common failures and reproducible fixes.
FAQ	Short answers to common questions.

Reference and Index

Document	When to read it
API Reference	Full public API reference.
API Overview	Compact API entry point.
Document Map	This page, organized by topic.
Feature Index	Capability-oriented lookup across documents.

Examples

Resource	Purpose
examples/docs	Companion examples for the documentation pages.
doc-index.ts	Small entry script that connects quick start, compilation, and document export.

For current validation commands and test counts, use the repository scripts and project Profile rather than static numbers on this page.

#schema-dsl document map

#Start

#Schema Authoring

#Validation and Runtime

#Export and Interop

#Reuse and Utilities

#Internationalization

#Extensions and Integration

#Production and Troubleshooting

#Reference and Index

#Examples