turbo_firestore_api 0.13.0

A clean and efficient approach to dealing with data from Firestore.

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.

0.13.0 - 2026-06-04

Added

• TCollectionManagement mixin for reactive sorting and filtering of model-wrapped document lists, including filter toggle support
• TFilterInput for binding a filter option to a concrete input value

Changed

• BREAKING: Replaced the filter and sort API — the former IFilter/TFilter/TSort (and the earlier TFilterType/TSortType) types are removed in favour of TFilterOption<MODEL>, TFilterInput<MODEL, OPTION, INPUT>, and TSortOption<VALUE>
• BREAKING: Renamed TSortFilteredList to TList
• Document updates now send only the changed fields instead of the full document (PKG-32)
• Streamlined error handling in Firestore streams

Fixed

• Corrected filter semantics and equality comparison
• id override now propagates through createDoc and handleMissingRemoteValue

0.12.0 - 2026-05-03

Added

• TModel<DTO> base class for wrapping DTOs with identity and copy semantics
• TModelDocs model for managing collections of model-wrapped documents with sorted/filtered list support
• TSortFilteredList model for maintaining pre-sorted and filtered document subsets
• TFirestoreCollection model encapsulating Firestore collection reference, path, and configuration
• TFirestorePage pagination model for cursor-based Firestore queries
• TVars (renamed from TAuthVars) with defaultIdValue and unknownIdValue constants
• TUserIdLocation enum with defaultValue for configuring user ID resolution
• IFirestoreCacheService abstraction and TFirestoreCache for time-based Firestore query caching
• TCachedQuery DTO with JSON serialization for persisting cached query metadata
• TFirestoreApiDefaults constants class for default configuration values
• TApiFactory for constructing Firestore API instances
• TUserCollectionService and TUserDocService for user-scoped document management
• listByIds lookup methods on TFirestoreGetApi and TFirestoreListApi
• TCollectionValueBuilderDef and TDocValueBuilderDef typedefs
• TModelBuilderDef, TModelDocsBuilderDef, TApiBuilderDef, TStreamBuilderDef typedefs
• TSortFilterDefs typedefs for sort and filter configuration
• TWriteableItemBuilderDef typedef for item-level widget builders
• TListExtension utilities for document list operations
• onMissingRemoteValue builder on TDocService for handling absent remote documents

Changed

• BREAKING: Renamed TAuthVars to TVars
• BREAKING: Renamed defaultId/unknownId to defaultIdValue/unknownIdValue on TVars
• BREAKING: Renamed service classes: TDocumentService to TDocService, BeAfSyncTurboDocumentService to THookDocService, BeSyncTurboDocumentService to TPreDocumentService, AfSyncTurboDocumentService to TPostDocService, and equivalent collection service renames
• BREAKING: TCollectionService constructor now accepts TFirestoreCollection, modelBuilder, apiBuilder, streamBuilder, modelDocsBuilder, and optional caching/default/initial parameters
• BREAKING: TFirestoreApi and sub-APIs now operate on TWriteableId DTOs with TModel wrappers
• BREAKING: Removed TDummyFirestoreApi and _TDummyProbingMap (dummy data generation system)
• BREAKING: Removed TApiVars model and TValues constants class
• BREAKING: Removed TLocatorDef typedef
• TCollectionService now manages TModelDocs via docsNotifier instead of raw DTO lists
• TFirestoreGetApi and TFirestoreListApi accept Iterable for ID-based lookups
• createDoc/updateDoc operations use updated CreateDocDef/UpdateDocDef signatures

Removed

• TDummyFirestoreApi and all dummy data probing infrastructure
• TApiVars, TValues, TLocatorDef
• lib/abstracts/t_vars.dart (replaced by lib/models/t_vars.dart)

Fixed

• Removed unused imports across typedefs, services, and example code
• Resolved analyzer warnings (unnecessary parentheses, missing @override annotations)

0.11.0 - 2026-04-17

Changed

• BREAKING: Bumped turbo_serializable constraint from ^0.3.0 to ^0.5.0. Consumers on older turbo_serializable versions must upgrade to 0.5.x, which includes the ts_map_extension file rename and expanded barrel exports. No API changes in turbo_firestore_api itself.

0.10.1 - 2026-04-14

Fixed

• Excluded internal dev artifacts (workspace/ with specs, mockups, task JSON) from the published package via .pubignore.
• Excluded host-generated .flutter-plugins-dependencies and .flutter-plugins files from the published package.

0.10.0 - 2026-04-12

Added

• TDummyFirestoreApi<T> — drop-in replacement for TFirestoreApi<T> that serves realistic, deterministic fake data from an in-memory store without contacting Firestore
• TValueGeneratorRegistry — composable value generator system for producing typed dummy field values
• TValueSpecs — declarative field-level specifications for controlling dummy data generation
• TDummySchema — sealed type representing probed document structures (leaf vs branch fields)
• In-memory WriteBatch and Transaction support with atomic commit/rollback semantics
• Fully-stubbed DocumentReference with working .get(), .update(), .delete(), .set(), .snapshots()
• Query filter, sort, and substring search support via constructor-supplied predicates

0.9.0 - 2026-01-18

Fixes

• Fixed example code imports to use correct turbo_serializable package paths
• Fixed example DTO class to properly extend TWriteable with correct method signatures
• Fixed example validate() method to use correct generic type parameter signature
• Fixed broken imports and missing method implementations in example code
• Fixed dependency references and package structure inconsistencies
• Resolved type safety issues across API extensions

Improvements

• Enhanced type safety in Firestore API extensions
• Streamlined logging and error handling in Firestore API
• Updated import paths to reflect new package structure
• Improved code consistency and documentation
• Cleaned up example code to match current API patterns

0.8.4 - 2026-01-09

Features

• Added turbo_serializable package dependency for reusable serialization abstractions
• Re-exports TurboSerializable<M> and TurboSerializableId<T, M> from turbo_serializable
• Support for typed metadata via the M type parameter

Improvements

• Added null-check guards for toJson() calls in create/update APIs with proper TurboResponse.fail error handling
• Added type aliases for backwards compatibility:
  • TWriteable<M> = TurboSerializable<M>
  • TWriteableId<T, M> = TurboSerializableId<T, M>
• Converted turbo_writeable.dart and turbo_writeable_id.dart to re-export modules
• Renamed docsPerIdInformer to docsPerIdNotifier in TurboCollectionService for consistency with turbo_notifiers package naming

Migration Notes

• Breaking: docsPerIdInformer protected field renamed to docsPerIdNotifier in TurboCollectionService and related service classes. Update any code that directly accesses this field.

Tests

• Added tests for null toJson() error handling in createDoc and updateDoc

0.8.3 - 2026-01-08

Improvements

• Updated internal package dependencies to latest versions:
  • loglytics: ^0.16.1 -> ^0.17.0
  • turbo_response: ^0.2.6 -> ^1.0.1
  • informers: ^0.0.3+2 -> ^0.0.5

0.8.2 - 2026-01-01

Improvements

• Updated GitHub repository URLs to appboypov organization

0.8.1 - 2025-09-01

Improvements

• Updated dependencies to latest versions: Cloud Firestore to ^6.0.2, Firebase Auth to ^6.1.0, loglytics to ^0.16.1, and fake_cloud_firestore to ^4.0.0
• Enhanced compatibility with latest Firebase SDK features and improvements

0.8.0 - 2025-09-01

Breaking

• Changed sync notification methods to be asynchronous: beforeSyncNotifyUpdate and afterSyncNotifyUpdate methods in sync services now return Future<void> instead of void. Affects:
  • BeAfSyncTurboDocumentService
  • BeSyncTurboDocumentService
  • BeAfSyncTurboCollectionService
  • BeSyncTurboCollectionService

Improvements

• Enhanced sync service flexibility: sync notification methods can now perform asynchronous operations during data synchronization
• Better async/await support: services can now properly handle asynchronous operations during document and collection updates

0.7.3 - 2025-05-01

Improvements

• Clean release with all dependencies updated and proper git state

0.7.2 - 2025-05-01

Improvements

• Comprehensive dependency update to latest compatible versions
• Updated loglytics dependency to version 0.16.0
• Updated repository URLs to use the correct GitHub username (its-brianwithai)
• Updated flutter_lints to version 6.0.0
• Updated all Firebase dependencies to latest versions
• Verified compatibility with Flutter 3.32.0 and Dart 3.8.0

0.7.1 - 2025-04-01

Improvements

• Exposed docsPerIdNotifier (formerly docsPerIdInformer) as @protected in TurboCollectionService for better access control when overriding methods
• Updated dependencies to latest versions

0.7.0 - 2025-03-01

Features

• Enhanced error handling using TurboFirestoreException.fromFirestoreException for more structured error responses across all API methods

Improvements

• Refined documentation for error handling features
• Improved code consistency across API implementations
• Added detailed examples for exception handling

0.6.1 - 2025-01-01

Improvements

• Updated sync services to use upsertLocalDoc instead of updateLocalDoc for better consistency
• Enhanced error handling across multiple API methods using TurboFirestoreException.fromFirestoreException for more structured error responses

0.6.0 - 2025-01-01

Features

• Added upsertLocalDocs method for consistent batch local operations

Improvements

• Improved upsert operations to always use createDoc with merge: true
• Removed incorrect exists checks in upsert operations

Bug Fixes

• Fixed incorrect document creation skipping in upsert operations

0.5.0 - 2025-01-01

Breaking

• Removed templateBlockNotify

0.4.2 - 2025-01-01

Improvements

• Add id getter

0.4.1 - 2025-01-01

Improvements

• Made TurboAuthVars.userId non-nullable for better type safety (defaults to kValuesunknownId)
• Added UpdateDocDef type definition export

0.4.0 - 2025-01-01

Breaking

• Renamed createDoc and updateDoc named parameter names to doc

Improvements

• Update readme

0.3.0 - 2025-01-01

Breaking

• Renamed vars() to turboVars() for better clarity and consistency
• Renamed batch operation methods for better clarity:
  • createDocs() -> createDocInBatch()
  • deleteDocs() -> deleteDocInBatch()
  • updateDocs() -> updateDocInBatch()
• Updated method signatures to use new type definitions (CreateDocDef<T>, UpdateDocDef<T>)

Features

• Added sync service implementations:
  • AfSyncTurboDocumentService - After sync notifications
  • BeAfSyncTurboDocumentService - Before and after sync notifications
  • BeSyncTurboDocumentService - Before sync notifications
• Added type definitions for document operations:
  • CreateDocDef<T> - Type definition for document creation functions
  • UpdateDocDef<T> - Type definition for document update functions

Improvements

• Improved temporary block notify in sync services for better state management

0.2.0 - 2025-01-01

Breaking

• Updated dependencies to latest versions

0.1.3 - 2025-01-01

Features

• Added TurboApiVars and TurboAuthVars classes for standardized document variables

0.1.2 - 2025-01-01

Improvements

• Updated turbo_response to version 0.2.6
• Replaced tryThrowFail() with throwWhenFail() to match new TurboResponse API

0.1.1 - 2025-01-01

Bug Fixes

• Remove default stream implementation in TurboCollectionService to enforce inheritance

0.1.0+1 - 2025-01-01

Bug Fixes

• Made TurboResponse<T>? validate<T>() null by default to avoid forced inheritance

0.1.0 - 2025-01-01

Added

• Initial release of turbo_firestore_api
• TurboFirestoreApi for clean Firestore operations
• CRUD operations with error handling
• Search functionality
• Stream support
• Auth sync service
• Collection and document services
• Exception handling
• Basic documentation and examples