firestore_odm_annotation 5.0.0

Pure annotations for Firestore ODM code generation. Provides the core annotations used to generate type-safe Firestore ODM code.

5.0.0

• Stable release of the 5.0 clean break (ADR-0002) — exact Firestore semantics: native Timestamp storage, create/set/patch/delete write verbs, no sentinels, one-shot server-side aggregates, typed Pipelines (experimental), chunked bulk writes, stable documentId tie-breaker pagination, real evidence gates (unit + goldens + benchmarks + emulator e2e) and release readback. See docs/adr/0002-semantics-contract-v5.md and docs/guide/migration-guide-5.md.

4.1.0-dev.1

• Bump version to match other packages (typed pipeline API).

4.0.0

Stable release of the 4.0 line (version kept in lockstep with the other packages). See 4.0.0-dev.* below.

4.0.0-dev.6

• Bump version to match other packages.

4.0.0-dev.5

• Bump version to match other packages.

4.0.0-dev.4

• Bump version to match other packages.

4.0.0-dev.3

• Bump version to match other packages.

4.0.0-dev.2

• Fix nullable type handling in code generation
• Fix enum null assertion for non-nullable enums
• Fix fromJson type casting for custom types
• Fix workspace configuration for publishing

4.0.0-dev.1

• Bump "firestore_odm_annotation" to 4.0.0-dev.1.

4.0.0-dev

• FEAT: supporting nested class withot manual import, filter and patcher done. (37bf6d4b)

3.0.2

• Bump "firestore_odm_annotation" to 3.0.2.

3.0.1

• Bump "firestore_odm_annotation" to 3.0.1.

3.0.0

1.3.0

• FEAT: refactor project folder structure. (d4907075)
• DOCS: Update all documentation URLs to GitHub Pages. (321ccdcd)
• DOCS: refactor and centralize README.md. (7c121c62)

1.2.0

• FEAT: add Schema annotation for Firestore schema definitions. (036425be)

1.1.0

• REFACTOR: Remove all hardcoded field names and simplify generator. (8afa7ecd)
• FEAT: Introduce schema-based architecture for Firestore ODM. (de939d90)
• FEAT: Successfully publish all packages to pub.dev. (9e10b6c6)
• FEAT: Complete CI/CD pipeline setup with melos for publishing. (5f3e440c)
• FEAT: add comprehensive @Collection validation system. (12659528)
• FEAT: refactor to unified @Collection annotation with subcollection support. (c4330d39)
• FEAT: add @DocumentIdField annotation support. (9cfb884d)
• FEAT: restructure as monorepo with strong-typed Firestore ODM. (b9e6ced0)
• FEAT: Convert Firestore ODM to monorepo library. (279e3547)

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0.0 - 2025-01-09

Added

• Initial release of firestore_odm_annotation
• @Collection(path) annotation for marking Firestore collections
• @SubCollection(path) annotation for marking Firestore subcollections
• @DocumentId() annotation for marking document ID fields
• @FirestoreField(name) annotation for field name mapping
• Comprehensive documentation and examples
• Full type safety support for code generation

5.0.0-dev.1

• BREAKING (clean break, ADR-0002): exact Firestore semantics.
• DateTime is a native Timestamp both directions; the ODM owns storage serialization (model toJson/fromJson remain for JSON interchange).
• Write verbs: create (returns the generated ID), set, patch (six FieldValue-shaped ops), delete. Removed insert/update/upsert, modify(), sentinels, fake aggregate streaming, exists().
• Typed bulk writes chunked to Firestore's 500-write limit.
• Schema classes are user-declared; generated code lands in <library>.g.dart.
• Root collections are getters with callable doc(id); subcollections use path-derived accessors (users/*/posts -> usersPosts).
• Recorded benchmark harness and emulator e2e lane.