From c0a19453e2d4c9380b4595acb7999b5d747a4b8b Mon Sep 17 00:00:00 2001 From: kevmoo Date: Thu, 9 Apr 2026 14:07:51 -0700 Subject: [PATCH 1/3] readme: clarify storage and firestore packages --- packages/dart_firebase_admin/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/dart_firebase_admin/README.md b/packages/dart_firebase_admin/README.md index 96711ef1..cd719a60 100644 --- a/packages/dart_firebase_admin/README.md +++ b/packages/dart_firebase_admin/README.md @@ -358,6 +358,8 @@ print('Token: ${result.token}'); ### Firestore +> **Note:** The core firestore API is provided by [package:google_cloud_firestore]. + ```dart import 'dart:async'; import 'package:dart_firebase_admin/dart_firebase_admin.dart'; @@ -582,6 +584,8 @@ await messaging.unsubscribeFromTopic(['', ''], 'news'); ### Storage +> **Note:** The core storage API is provided by [package:google_cloud_storage]. + ```dart import 'dart:typed_data'; import 'package:dart_firebase_admin/dart_firebase_admin.dart'; @@ -722,7 +726,7 @@ The Firebase Admin Dart SDK currently supports the following Firebase services: | Realtime Database | 🔴 | | | Event Arc | 🔴 | | | Extensions | 🔴 | | -| Firestore | 🟢 | Excludes realtime capabilities | +| Firestore | 🟢 | Via [package:google_cloud_firestore].
*Excludes realtime capabilities* | | Functions | 🟢 | | | Installations | 🔴 | | | Machine Learning | 🔴 | | @@ -730,14 +734,7 @@ The Firebase Admin Dart SDK currently supports the following Firebase services: | Project Management | 🔴 | | | Remote Config | 🔴 | | | Security Rules | 🟢 | | -| Storage | 🟢 | | - -## Additional Packages - -Alongside the Firebase Admin Dart SDK, this repository contains additional workspace/pub.dev packages to accomodate the SDK: - -- [google_cloud_firestore](/packages/google_cloud_firestore/): Standalone Google APIs Firestore SDK, which the Firebase SDK extends. -- [google_cloud_storage](https://github.com/googleapis/google-cloud-dart/tree/main/packages/google_cloud_storage): Standalone Google Cloud Storage SDK, which the Firebase SDK extends. +| Storage | 🟢 | Via [package:google_cloud_storage]. | # Contributing @@ -746,3 +743,6 @@ Contributions are welcome! Please read the [contributing guide](CONTRIBUTING.md) # License [Apache License Version 2.0](LICENSE) + +[package:google_cloud_firestore]: https://pub.dev/packages/google_cloud_firestore +[package:google_cloud_storage]: https://pub.dev/packages/google_cloud_storage From 215920ad0a4d0dbae46ec7b4df50c14ec4f0f61b Mon Sep 17 00:00:00 2001 From: kevmoo Date: Thu, 9 Apr 2026 14:44:08 -0700 Subject: [PATCH 2/3] docs: Clean up and modernize README.md - Moved the 'Supported Services' section to the top for better accessibility. - Centered the status icons in the services table. - Modernized callouts by replacing legacy bold notes with GitHub-native alerts. - Cleaned up the Table of Contents and removed redundant sections. --- packages/dart_firebase_admin/README.md | 76 +++++++++++++------------- 1 file changed, 39 insertions(+), 37 deletions(-) diff --git a/packages/dart_firebase_admin/README.md b/packages/dart_firebase_admin/README.md index cd719a60..ec0e5e78 100644 --- a/packages/dart_firebase_admin/README.md +++ b/packages/dart_firebase_admin/README.md @@ -1,8 +1,7 @@ -# Firebase Admin Dart SDK - ## Table of Contents - [Overview](#overview) + - [Supported Services](#supported-services) - [Installation](#installation) - [Add the Firebase Admin SDK to your server](#add-the-firebase-admin-sdk-to-your-server) - [Prerequisites](#prerequisites) @@ -10,7 +9,7 @@ - [Add the SDK](#add-the-sdk) - [Initialize the SDK](#initialize-the-sdk) - [Initialize the SDK in non-Google environments](#initialize-the-sdk-in-non-google-environments) - - [Using Workload Identity Federation](#using-workload-identity-federation) + - [Using Workload Identity Federation](#using-workload-identity-federation) - [Initialize multiple apps](#initialize-multiple-apps) - [Testing with gcloud end user credentials](#testing-with-gcloud-end-user-credentials) - [Usage](#usage) @@ -21,8 +20,6 @@ - [Messaging](#messaging) - [Storage](#storage) - [Security Rules](#security-rules) - - [Supported Services](#supported-services) - - [Additional Packages](#additional-packages) - [Contributing](#contributing) - [License](#license) @@ -36,6 +33,33 @@ Admin Dart SDK enables access to Firebase services from privileged environments For more information, visit the [Firebase Admin SDK setup guide](https://firebase.google.com/docs/admin/setup/). +## Supported Services + +The Firebase Admin Dart SDK currently supports the following Firebase services: + +🟢 - Fully supported
+🟡 - Partially supported / Work in progress
+🔴 - Not supported + +| Service | Status | Notes | +|--------------------|:------:|--------------------------------------| +| App | 🟢 | | +| App Check | 🟢 | | +| Authentication | 🟢 | | +| Data Connect | 🔴 | | +| Realtime Database | 🔴 | | +| Event Arc | 🔴 | | +| Extensions | 🔴 | | +| Firestore | 🟢 | Via [package:google_cloud_firestore] | +| Functions | 🟢 | | +| Installations | 🔴 | | +| Machine Learning | 🔴 | | +| Messaging | 🟢 | | +| Project Management | 🔴 | | +| Remote Config | 🔴 | | +| Security Rules | 🟢 | | +| Storage | 🟢 | Via [package:google_cloud_storage] | + ## Installation The Firebase Admin Dart SDK is available on [pub.dev](https://pub.dev/) as `dart_firebase_admin`: @@ -94,7 +118,8 @@ final app = FirebaseApp.initializeApp(); To optionally specify initialization options for services such as Realtime Database, Cloud Storage, or Cloud Functions, use the `FIREBASE_CONFIG` environment variable. If the content of the `FIREBASE_CONFIG` variable begins with a `{` it will be parsed as a JSON object. Otherwise the SDK assumes that the string is the path of a JSON file containing the options. -> **Note:** The `FIREBASE_CONFIG` environment variable is included automatically in App Hosting backends and Cloud Functions for Firebase functions. +> [!NOTE] +> The `FIREBASE_CONFIG` environment variable is included automatically in App Hosting backends and Cloud Functions for Firebase functions. ```bash export FIREBASE_CONFIG='{"projectId":"my-project"}' @@ -218,7 +243,8 @@ final otherAuth = otherApp.auth(); final otherFirestore = otherApp.firestore(); ``` -> **Note:** Each app instance has its own configuration options and authentication state. +> [!NOTE] +> Each app instance has its own configuration options and authentication state. ### Testing with gcloud end user credentials @@ -358,7 +384,8 @@ print('Token: ${result.token}'); ### Firestore -> **Note:** The core firestore API is provided by [package:google_cloud_firestore]. +> [!NOTE] +> The core firestore API is provided by [package:google_cloud_firestore]. ```dart import 'dart:async'; @@ -584,7 +611,8 @@ await messaging.unsubscribeFromTopic(['', ''], 'news'); ### Storage -> **Note:** The core storage API is provided by [package:google_cloud_storage]. +> [!NOTE] +> The core storage API is provided by [package:google_cloud_storage]. ```dart import 'dart:typed_data'; @@ -709,38 +737,12 @@ print('Created ruleset: ${ruleset.name}'); await securityRules.deleteRuleset(ruleset.name); ``` -## Supported Services - -The Firebase Admin Dart SDK currently supports the following Firebase services: - -🟢 - Fully supported
-🟡 - Partially supported / Work in progress
-🔴 - Not supported -| Service | Status | Notes | -|-----------------------|---------|--------------------------------| -| App | 🟢 | | -| App Check | 🟢 | | -| Authentication | 🟢 | | -| Data Connect | 🔴 | | -| Realtime Database | 🔴 | | -| Event Arc | 🔴 | | -| Extensions | 🔴 | | -| Firestore | 🟢 | Via [package:google_cloud_firestore].
*Excludes realtime capabilities* | -| Functions | 🟢 | | -| Installations | 🔴 | | -| Machine Learning | 🔴 | | -| Messaging | 🟢 | | -| Project Management | 🔴 | | -| Remote Config | 🔴 | | -| Security Rules | 🟢 | | -| Storage | 🟢 | Via [package:google_cloud_storage]. | - -# Contributing +## Contributing Contributions are welcome! Please read the [contributing guide](CONTRIBUTING.md) to get started. -# License +## License [Apache License Version 2.0](LICENSE) From 71bcc6a9869e8481210b20a401bbd7960312f6c7 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Thu, 9 Apr 2026 15:08:56 -0700 Subject: [PATCH 3/3] Update packages/dart_firebase_admin/README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- packages/dart_firebase_admin/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/dart_firebase_admin/README.md b/packages/dart_firebase_admin/README.md index ec0e5e78..0b48b01c 100644 --- a/packages/dart_firebase_admin/README.md +++ b/packages/dart_firebase_admin/README.md @@ -37,9 +37,9 @@ For more information, visit the The Firebase Admin Dart SDK currently supports the following Firebase services: -🟢 - Fully supported
-🟡 - Partially supported / Work in progress
-🔴 - Not supported +- 🟢 - Fully supported +- 🟡 - Partially supported / Work in progress +- 🔴 - Not supported | Service | Status | Notes | |--------------------|:------:|--------------------------------------|