v1.0.20 - Documentation Restructure & Codebase Optimization
Release v1.0.20
Highlights
This release focuses on documentation restructure and codebase optimization, resulting in a cleaner, more maintainable project with improved developer experience.
Key Improvements
- Simplified documentation structure - Easier navigation and discovery
- Comprehensive API documentation - New
API.mdwith complete coverage - Codebase reduction - 9,020 fewer lines while maintaining all functionality
- Multilingual support - Updated EN/ES/DE documentation
What's Changed
Documentation
Structure Reorganization
| Before | After |
|---|---|
docs/guides/ |
docs/references/ |
docs/api/ |
docs/references/ |
docs/advanced/ |
docs/references/ |
docs/guides/getting-started.md |
docs/getting-started.md |
File Renames
| Before | After |
|---|---|
basic-model.md |
basic.md |
advanced-queries.md |
advanced.md |
relationships.md |
relations.md |
CHANGELOG.md |
changelog.md |
New Files
API.md- Comprehensive API documentationdocs/references/table.md- Table class API reference (EN)docs/references/types.md- TypeScript types documentation (EN)src/@types/index.ts- Centralized TypeScript type definitionseslint.config.js- ESLint configurationscripts/generate_seed.ts- Test data generation utilityscripts/load_seed.ts- Seed data loader utilitytsx.config.json- TSX runtime configuration
Code Improvements
- Refactored
src/core/table.tswith improved query handling - Enhanced
src/core/decorator.tswith optimized pipelines - Improved
src/core/client.tsconnection handling - Optimized all decorators for better performance
- Consolidated
method.tsintotable.ts
Removed
docs/examples/validation.*(merged into basic examples)docs/guides/relationships.*(consolidated into relations)src/core/method.ts(moved to table.ts)
Stats
66 files changed
6,087 insertions(+)
15,107 deletions(-)
────────────────────
Net: -9,020 lines
Migration Guide
If you have external links to the documentation, update them:
docs/guides/getting-started.md → docs/getting-started.md
docs/api/* → docs/references/*
docs/guides/decorators.md → docs/references/decorators.md
docs/examples/basic-model.md → docs/examples/basic.md
docs/examples/advanced-queries.md → docs/examples/advanced.md
docs/examples/relationships.md → docs/examples/relations.md
No breaking API changes. All features are backward compatible.
Installation
npm install @arcaelas/dynamite@1.0.20
# or
yarn add @arcaelas/dynamite@1.0.20Full Changelog
See CHANGELOG for complete details.
Full Changelog: v1.0.19...v1.0.20