From aa1347cbdd9f0a324c33d7c84a739e7989408cfd Mon Sep 17 00:00:00 2001 From: Brian Quinlan Date: Thu, 9 Apr 2026 10:56:34 -0700 Subject: [PATCH 1/2] doc(dart_firebase_admin): s/undefined/null --- .../lib/src/auth/auth_request_handler.dart | 2 +- .../lib/src/auth/base_auth.dart | 2 +- .../dart_firebase_admin/lib/src/auth/tenant.dart | 2 +- .../lib/src/auth/tenant_manager.dart | 2 +- .../dart_firebase_admin/lib/src/utils/utils.dart | 2 +- .../google_cloud_firestore/lib/src/document.dart | 16 ++++++---------- 6 files changed, 11 insertions(+), 15 deletions(-) diff --git a/packages/dart_firebase_admin/lib/src/auth/auth_request_handler.dart b/packages/dart_firebase_admin/lib/src/auth/auth_request_handler.dart index 78838ddf..2504ce44 100644 --- a/packages/dart_firebase_admin/lib/src/auth/auth_request_handler.dart +++ b/packages/dart_firebase_admin/lib/src/auth/auth_request_handler.dart @@ -420,7 +420,7 @@ abstract class _AbstractAuthRequestHandler { /// Exports the users (single batch only) with a size of maxResults and starting from /// the offset as specified by pageToken. /// - /// maxResults - The page size, 1000 if undefined. This is also the maximum + /// maxResults - The page size, 1000 if not specified. This is also the maximum /// allowed limit. /// /// pageToken - The next page token. If not specified, returns users starting diff --git a/packages/dart_firebase_admin/lib/src/auth/base_auth.dart b/packages/dart_firebase_admin/lib/src/auth/base_auth.dart index 5f9c36bd..8f7d82bb 100644 --- a/packages/dart_firebase_admin/lib/src/auth/base_auth.dart +++ b/packages/dart_firebase_admin/lib/src/auth/base_auth.dart @@ -503,7 +503,7 @@ abstract class _BaseAuth { /// See https://firebase.google.com/docs/auth/admin/manage-users#list_all_users /// for code samples and detailed documentation. /// - /// - maxResults - The page size, 1000 if undefined. This is also + /// - maxResults - The page size, 1000 if not specified. This is also /// the maximum allowed limit. /// - pageToken - The next page token. If not specified, returns /// users starting without any offset. diff --git a/packages/dart_firebase_admin/lib/src/auth/tenant.dart b/packages/dart_firebase_admin/lib/src/auth/tenant.dart index caeb91d8..c87eb4aa 100644 --- a/packages/dart_firebase_admin/lib/src/auth/tenant.dart +++ b/packages/dart_firebase_admin/lib/src/auth/tenant.dart @@ -112,7 +112,7 @@ class Tenant { try { emailSignInConfig = _EmailSignInConfig.fromServerResponse(response); } catch (e) { - // If allowPasswordSignup is undefined, it is disabled by default. + // If allowPasswordSignup is `null`, it is disabled by default. emailSignInConfig = _EmailSignInConfig( enabled: false, passwordRequired: true, diff --git a/packages/dart_firebase_admin/lib/src/auth/tenant_manager.dart b/packages/dart_firebase_admin/lib/src/auth/tenant_manager.dart index f35694b0..62b71c1a 100644 --- a/packages/dart_firebase_admin/lib/src/auth/tenant_manager.dart +++ b/packages/dart_firebase_admin/lib/src/auth/tenant_manager.dart @@ -226,7 +226,7 @@ class TenantManager { /// starting from the offset as specified by [pageToken]. This is used to /// retrieve all the tenants of a specified project in batches. /// - /// [maxResults] - The page size, 1000 if undefined. This is also + /// [maxResults] - The page size, 1000 if not specified. This is also /// the maximum allowed limit. /// [pageToken] - The next page token. If not specified, returns /// tenants starting without any offset. diff --git a/packages/dart_firebase_admin/lib/src/utils/utils.dart b/packages/dart_firebase_admin/lib/src/utils/utils.dart index 92d571d7..fa9444ea 100644 --- a/packages/dart_firebase_admin/lib/src/utils/utils.dart +++ b/packages/dart_firebase_admin/lib/src/utils/utils.dart @@ -19,7 +19,7 @@ String get dartVersion => Platform.version.split(RegExp('[^0-9]')).take(3).join('.'); /// Generates the update mask for the provided object. -/// Note this will ignore the last key with value undefined. +/// Note this will ignore the last key with value `null`. List generateUpdateMask( Object? obj, { List terminalPaths = const [], diff --git a/packages/google_cloud_firestore/lib/src/document.dart b/packages/google_cloud_firestore/lib/src/document.dart index c061a0ae..dc1665f1 100644 --- a/packages/google_cloud_firestore/lib/src/document.dart +++ b/packages/google_cloud_firestore/lib/src/document.dart @@ -23,8 +23,8 @@ class Optional { /// Firestore database. The data can be extracted with [data]. /// /// For a DocumentSnapshot that points to a non-existing document, any data -/// access will return 'undefined'. You can use the -/// [exists] property to explicitly verify a document's existence. +/// access will return `null`. You can use the [exists] property to explicitly +/// verify a document's existence. @immutable class DocumentSnapshot { const DocumentSnapshot._({ @@ -195,19 +195,15 @@ class DocumentSnapshot { /// ``` bool get exists => _fieldsProto != null; - /// Retrieves all fields in the document as an object. Returns 'undefined' if + /// Retrieves all fields in the document as an object. Returns `null` if /// the document doesn't exist. /// - /// Returns an object containing all fields in the document or - /// 'null' if the document doesn't exist. - /// /// ```dart /// final documentRef = firestore.doc('col/doc'); /// - /// documentRef.get().then((documentSnapshot) { - /// final data = documentSnapshot.data(); - /// print('Retrieved data: ${JSON.stringify(data)}'); - /// }); + /// final documentSnapshot = await documentRef.get(); + /// final data = documentSnapshot.data(); + /// print('Retrieved data: ${JSON.stringify(data)}'); /// ``` T? data() { final fieldsProto = _fieldsProto; From d8e15a91d9e2cac90bf44b68cc7501ba55e93f38 Mon Sep 17 00:00:00 2001 From: Brian Quinlan Date: Thu, 9 Apr 2026 11:10:41 -0700 Subject: [PATCH 2/2] Update packages/google_cloud_firestore/lib/src/document.dart Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- packages/google_cloud_firestore/lib/src/document.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/google_cloud_firestore/lib/src/document.dart b/packages/google_cloud_firestore/lib/src/document.dart index dc1665f1..c8daf211 100644 --- a/packages/google_cloud_firestore/lib/src/document.dart +++ b/packages/google_cloud_firestore/lib/src/document.dart @@ -203,7 +203,7 @@ class DocumentSnapshot { /// /// final documentSnapshot = await documentRef.get(); /// final data = documentSnapshot.data(); - /// print('Retrieved data: ${JSON.stringify(data)}'); + /// print('Retrieved data: ${jsonEncode(data)}'); /// ``` T? data() { final fieldsProto = _fieldsProto;