chore: update experimental status

Lyokone · Lyokone · commit a6fb444334b9 · 2026-03-17T12:03:37.000+01:00
diff --git a/README.md b/README.md
@@ -7,21 +7,24 @@ Write Firebase Cloud Functions in Dart with full type safety and performance.
 
 ## Status: Alpha (v0.1.0)
 
-This package provides a complete Dart implementation of Firebase Cloud Functions with support for:
+This package provides a Dart implementation of Firebase Cloud Functions. Only HTTPS triggers are currently supported in production. Other trigger types are experimental and have varying levels of support.
 
 | Trigger Type | Status | Functions |
 |-------------|--------|-----------|
-| **HTTPS** | ✅ Complete | `onRequest`, `onCall`, `onCallWithData` |
-| **Pub/Sub** | ✅ Complete | `onMessagePublished` |
-| **Firestore** | ✅ Complete | `onDocumentCreated`, `onDocumentUpdated`, `onDocumentDeleted`, `onDocumentWritten`, `onDocumentCreatedWithAuthContext`, `onDocumentUpdatedWithAuthContext`, `onDocumentDeletedWithAuthContext`, `onDocumentWrittenWithAuthContext` |
-| **Realtime Database** | ✅ Complete | `onValueCreated`, `onValueUpdated`, `onValueDeleted`, `onValueWritten` |
-| **Storage** | ✅ Complete | `onObjectFinalized`, `onObjectArchived`, `onObjectDeleted`, `onObjectMetadataUpdated` |
-| **Scheduler** | ✅ Complete | `onSchedule` |
-| **Firebase Alerts** | ✅ Complete | `onInAppFeedbackPublished`, `onNewAnrIssuePublished`, `onNewFatalIssuePublished`, `onNewNonfatalIssuePublished`, `onNewTesterIosDevicePublished`, `onPlanAutomatedUpdatePublished`, `onPlanUpdatePublished`, `onRegressionAlertPublished`, `onStabilityDigestPublished`, `onThresholdAlertPublished`, `onVelocityAlertPublished` |
-| **Eventarc** | ✅ Complete | `onCustomEventPublished` |
-| **Identity Platform** | ✅ Complete | `beforeUserCreated`, `beforeUserSignedIn` (+ `beforeEmailSent`, `beforeSmsSent`*) |
-| **Remote Config** | ✅ Complete | `onConfigUpdated` |
-| **Test Lab** | ✅ Complete | `onTestMatrixCompleted` |
+| **HTTPS** | ✅ Production | `onRequest`, `onCall`, `onCallWithData` |
+| **Firestore** | ⚠️ Emulator only | `onDocumentCreated`, `onDocumentUpdated`, `onDocumentDeleted`, `onDocumentWritten`, `onDocumentCreatedWithAuthContext`, `onDocumentUpdatedWithAuthContext`, `onDocumentDeletedWithAuthContext`, `onDocumentWrittenWithAuthContext` |
+| **Realtime Database** | ⚠️ Emulator only | `onValueCreated`, `onValueUpdated`, `onValueDeleted`, `onValueWritten` |
+| **Storage** | ⚠️ Emulator only | `onObjectFinalized`, `onObjectArchived`, `onObjectDeleted`, `onObjectMetadataUpdated` |
+| **Pub/Sub** | 🚧 Experimental | `onMessagePublished` |
+| **Scheduler** | 🚧 Experimental | `onSchedule` |
+| **Firebase Alerts** | 🚧 Experimental | `onAlertPublished` and sub-namespace triggers |
+| **Eventarc** | 🚧 Experimental | `onCustomEventPublished` |
+| **Identity Platform** | 🚧 Experimental | `beforeUserCreated`, `beforeUserSignedIn` (+ `beforeEmailSent`, `beforeSmsSent`) |
+| **Remote Config** | 🚧 Experimental | `onConfigUpdated` |
+| **Test Lab** | 🚧 Experimental | `onTestMatrixCompleted` |
+| **Task Queues** | 🚧 Experimental | `onTaskDispatched` |
+
+> **Legend**: ✅ Production — works in production and emulator. ⚠️ Emulator only — works with the Firebase emulator but not yet in production. 🚧 Experimental — implemented but not currently supported by the emulator or production; APIs may change.
 
 ## Table of Contents
 
diff --git a/example/alerts/bin/server.dart b/example/alerts/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/auth/bin/server.dart b/example/auth/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/database/bin/server.dart b/example/database/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/eventarc/bin/server.dart b/example/eventarc/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/firestore/bin/server.dart b/example/firestore/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/firestore_test/bin/server.dart b/example/firestore_test/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/pubsub/bin/server.dart b/example/pubsub/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/remoteconfig/bin/server.dart b/example/remoteconfig/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/scheduler/bin/server.dart b/example/scheduler/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/storage/bin/server.dart b/example/storage/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/tasks/bin/server.dart b/example/tasks/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/example/testlab/bin/server.dart b/example/testlab/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 void main(List<String> args) async {
diff --git a/lib/firebase_functions.dart b/lib/firebase_functions.dart
@@ -52,52 +52,60 @@
 /// );
 /// ```
 ///
+/// ## Trigger Support
+///
+/// Only HTTPS triggers (`onRequest`, `onCall`, `onCallWithData`) are
+/// production-ready. All other trigger types are marked `@experimental`:
+///
+/// - **Emulator only**: Firestore, Realtime Database, Storage
+/// - **Not yet supported**: Pub/Sub, Alerts, Eventarc, Identity, Remote Config,
+///   Scheduler, Tasks, Test Lab
+///
 /// See also:
 /// - [params.dart] for the full params API
 /// - [onInit] for safe initialization with secrets
 library;
 
-// Re-export Firestore types for convenience
+// Package re-exports
 export 'package:google_cloud_firestore/google_cloud_firestore.dart'
     show DocumentData, DocumentSnapshot, QueryDocumentSnapshot;
-// Re-export Shelf types for convenience
 export 'package:shelf/shelf.dart' show Request, Response;
 
-// Re-export built-in params from params.dart for convenience
+// Built-in params
 export 'params.dart' show databaseURL, gcloudProject, projectID, storageBucket;
-// Alerts triggers
+// Experimental: Alerts triggers (not yet supported in production or emulator)
 export 'src/alerts/alerts.dart';
 // Common types
 export 'src/common/cloud_event.dart';
 export 'src/common/expression.dart';
 export 'src/common/on_init.dart' show onInit;
 export 'src/common/options.dart';
 export 'src/common/params.dart';
-// Database triggers
+// Experimental: Realtime Database triggers (emulator only)
 export 'src/database/database.dart';
-// Eventarc triggers
+// Experimental: Eventarc triggers (not yet supported in production or emulator)
 export 'src/eventarc/eventarc.dart';
 // Core firebase instance
 export 'src/firebase.dart' show Firebase;
-// Firestore triggers
+// Experimental: Firestore triggers (emulator only)
 export 'src/firestore/firestore.dart';
-// HTTPS triggers
+// HTTPS triggers (production-ready)
 export 'src/https/https.dart';
-// Identity triggers
+// Experimental: Identity triggers (not yet supported in production or emulator)
 export 'src/identity/identity.dart';
 // Logger
 export 'src/logger/logger.dart' show Logger, LogEntry, LogSeverity, logger;
-// Pub/Sub triggers
+// Experimental: Pub/Sub triggers (not yet supported in production or emulator)
 export 'src/pubsub/pubsub.dart';
-// Remote Config triggers
+// Experimental: Remote Config triggers (not yet supported in production or emulator)
 export 'src/remote_config/remote_config.dart';
-// Scheduler triggers
+// Experimental: Scheduler triggers (not yet supported in production or emulator)
 export 'src/scheduler/scheduler.dart';
 // Core runtime
 export 'src/server.dart' show fireUp;
-// Storage triggers
+// Experimental: Storage triggers (emulator only)
 export 'src/storage/storage.dart';
-// Task queue triggers
+// Experimental: Task queue triggers (not yet supported in production or emulator)
 export 'src/tasks/tasks.dart';
-// Test Lab triggers
+// Experimental: Test Lab triggers (not yet supported in production or emulator)
 export 'src/test_lab/test_lab.dart';
diff --git a/lib/src/firebase.dart b/lib/src/firebase.dart
@@ -7,6 +7,7 @@ import 'dart:io';
 
 import 'package:dart_firebase_admin/dart_firebase_admin.dart';
 import 'package:google_cloud_firestore/google_cloud_firestore.dart' as gfs;
+import 'package:meta/meta.dart';
 import 'package:shelf/shelf.dart';
 
 import 'alerts/alerts_namespace.dart';
@@ -81,36 +82,80 @@ class Firebase {
   HttpsNamespace get https => HttpsNamespace(this);
 
   /// Pub/Sub triggers namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   PubSubNamespace get pubsub => PubSubNamespace(this);
 
   /// Firestore triggers namespace.
+  ///
+  /// **Experimental**: This trigger type is only supported in the Firebase
+  /// emulator and is not yet available for production deployments.
+  @experimental
   FirestoreNamespace get firestore => FirestoreNamespace(this);
 
   /// Eventarc triggers namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   EventarcNamespace get eventarc => EventarcNamespace(this);
 
   /// Realtime Database triggers namespace.
+  ///
+  /// **Experimental**: This trigger type is only supported in the Firebase
+  /// emulator and is not yet available for production deployments.
+  @experimental
   DatabaseNamespace get database => DatabaseNamespace(this);
 
   /// Firebase Alerts namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   AlertsNamespace get alerts => AlertsNamespace(this);
 
   /// Identity Platform namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   IdentityNamespace get identity => IdentityNamespace(this);
 
   /// Remote Config namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   RemoteConfigNamespace get remoteConfig => RemoteConfigNamespace(this);
 
   /// Scheduler namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   SchedulerNamespace get scheduler => SchedulerNamespace(this);
 
   /// Cloud Storage triggers namespace.
+  ///
+  /// **Experimental**: This trigger type is only supported in the Firebase
+  /// emulator and is not yet available for production deployments.
+  @experimental
   StorageNamespace get storage => StorageNamespace(this);
 
   /// Task queue triggers namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   TasksNamespace get tasks => TasksNamespace(this);
 
   /// Test Lab triggers namespace.
+  ///
+  /// **Experimental**: This trigger type is not yet supported in production
+  /// or the Firebase emulator.
+  @experimental
   TestLabNamespace get testLab => TestLabNamespace(this);
 }
 
diff --git a/test/fixtures/dart_reference/bin/server.dart b/test/fixtures/dart_reference/bin/server.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // MIT-style license that can be found in the LICENSE file.
 
+// ignore_for_file: experimental_member_use
+
 import 'package:firebase_functions/firebase_functions.dart';
 
 // =============================================================================
