fireschema_dart_runtime

This package provides the runtime library for Dart/Flutter code generated by the FireSchema tool. It contains the base classes and utilities necessary for the generated Object Document Mapper (ODM) code to interact with Google Cloud Firestore.

Features

  • Provides base classes (BaseCollectionRef, BaseQueryBuilder, BaseUpdateBuilder) for generated code.
  • Includes helper functions for common Firestore operations used by generated code.

Getting started

This package is intended to be a dependency of your project when using code generated by fireschema. If you use the package option in your fireschema.config.json, the generated pubspec.yaml will include this. Otherwise, you need to add it manually.

However, if you need to install it manually:

dependencies:
  fireschema_dart_runtime: ^0.1.3 # Use the latest version
  cloud_firestore: ^4.0.0 # Ensure you have the Firestore plugin

Then run flutter pub get or dart pub get.

Usage

This package is intended for internal use by the code generated by fireschema. The generated classes (e.g., UsersCollection, UsersQueryBuilder, UsersUpdateBuilder) extend the base classes provided by this runtime.

Refer to the main FireSchema documentation for details on how to use the generated code in your Flutter or Dart application.

Additional information

  • Repository: Find the source code and contribute at the main FireSchema repository.
    • Issues: Report bugs and suggest features on the main repository's issue tracker.

License

MIT

Libraries

fireschema_dart_runtime