@prmichaelsen/firebase-admin-sdk-v8 2.6.0 → 2.7.0

package/.claude/settings.local.json

@@ -13,7 +13,9 @@
       "WebFetch(domain:agentbase.me)",
       "WebSearch",
       "WebFetch(domain:firebase.google.com)",
-      "WebFetch(domain:developers.google.com)"
+      "WebFetch(domain:developers.google.com)",
+      "Bash(npx tsc:*)",
+      "Bash(node --env-file=.env node_modules/.bin/jest --config jest.e2e.config.js --testPathPatterns='firestore/operations.e2e' 2>&1 | tail -20)"
     ]
   }
 }

package/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.7.0] - 2026-03-12
+
+### Added
+- **Firestore Batch Get (`getAll`)**: Fetch multiple documents in a single REST API call
+  - `getAll(collectionPath, documentIds)` - Batch get up to 100 documents via `documents:batchGet` endpoint
+  - Returns results in the same order as input document IDs
+  - Missing documents return `null` (no throw)
+  - Enforces 100-document limit with clear error message
+  - Supports subcollection paths
+  - 8 unit tests + 5 e2e tests
+
+### Changed
+- Total unit tests increased from 498 to 506 (+8 tests)
+
 ## [2.6.0] - 2026-03-07
 
 ### Added

package/dist/index.d.mts

@@ -640,6 +640,22 @@ declare function queryDocuments(collectionPath: string, options?: QueryOptions):
     id: string;
     data: DataObject;
 }>>;
+/**
+ * Batch get multiple documents from Firestore
+ * Uses the documents:batchGet REST API endpoint
+ *
+ * @param collectionPath - The collection containing the documents
+ * @param documentIds - Array of document IDs to fetch (max 100)
+ * @returns Array of results in the same order as documentIds. Missing documents return null.
+ * @throws {Error} If the operation fails or more than 100 documents requested
+ *
+ * @example
+ * ```typescript
+ * const users = await getAll('users', ['user1', 'user2', 'user3']);
+ * // users[0] = { name: 'Alice', ... } or null if not found
+ * ```
+ */
+declare function getAll(collectionPath: string, documentIds: string[]): Promise<(DataObject | null)[]>;
 /**
  * Perform batch write operations (set, update, delete)
  *
@@ -1250,4 +1266,4 @@ declare function getAdminAccessToken(): Promise<string>;
  */
 declare function clearTokenCache(): void;
 
-export { type AndroidConfig, type AndroidNotification, type ApnsConfig, type BatchWrite, type BatchWriteResult, type CreateUserRequest, type CustomClaims, type CustomTokenSignInResponse, type DataObject, type DecodedIdToken, type DocumentReference, type DownloadOptions, type Notification as FcmNotification, type FcmOptions, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FileMetadata, type FirestoreDocument, type FirestoreValue, type ListFilesResult, type ListOptions, type ListUsersResult, type Message, type QueryFilter, type QueryOptions, type QueryOrder, type ResumableUploadOptions, type SendResponse, type ServiceAccount, type SessionCookieOptions, type SetOptions, type SignedUrlOptions, type TokenResponse, type TopicManagementError, type TopicManagementResponse, type UpdateOptions, type UpdateUserRequest, type UploadOptions, type UserInfo, type UserRecord, type WebpushConfig, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, countDocuments, createCustomToken, createSessionCookie, createUser, deleteDocument, deleteFile, deleteUser, downloadFile, fileExists, generateSignedUrl, getAdminAccessToken, getAuth, getConfig, getDocument, getFileMetadata, getProjectId, getServiceAccount, getUserByEmail, getUserByUid, getUserFromToken, initializeApp, iterateCollection, listDocuments, listFiles, listUsers, queryDocuments, sendMessage, setCustomUserClaims, setDocument, signInWithCustomToken, subscribeToTopic, unsubscribeFromTopic, updateDocument, updateUser, uploadFile, uploadFileResumable, verifyIdToken, verifySessionCookie };
+export { type AndroidConfig, type AndroidNotification, type ApnsConfig, type BatchWrite, type BatchWriteResult, type CreateUserRequest, type CustomClaims, type CustomTokenSignInResponse, type DataObject, type DecodedIdToken, type DocumentReference, type DownloadOptions, type Notification as FcmNotification, type FcmOptions, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FileMetadata, type FirestoreDocument, type FirestoreValue, type ListFilesResult, type ListOptions, type ListUsersResult, type Message, type QueryFilter, type QueryOptions, type QueryOrder, type ResumableUploadOptions, type SendResponse, type ServiceAccount, type SessionCookieOptions, type SetOptions, type SignedUrlOptions, type TokenResponse, type TopicManagementError, type TopicManagementResponse, type UpdateOptions, type UpdateUserRequest, type UploadOptions, type UserInfo, type UserRecord, type WebpushConfig, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, countDocuments, createCustomToken, createSessionCookie, createUser, deleteDocument, deleteFile, deleteUser, downloadFile, fileExists, generateSignedUrl, getAdminAccessToken, getAll, getAuth, getConfig, getDocument, getFileMetadata, getProjectId, getServiceAccount, getUserByEmail, getUserByUid, getUserFromToken, initializeApp, iterateCollection, listDocuments, listFiles, listUsers, queryDocuments, sendMessage, setCustomUserClaims, setDocument, signInWithCustomToken, subscribeToTopic, unsubscribeFromTopic, updateDocument, updateUser, uploadFile, uploadFileResumable, verifyIdToken, verifySessionCookie };

package/dist/index.d.ts

@@ -640,6 +640,22 @@ declare function queryDocuments(collectionPath: string, options?: QueryOptions):
     id: string;
     data: DataObject;
 }>>;
+/**
+ * Batch get multiple documents from Firestore
+ * Uses the documents:batchGet REST API endpoint
+ *
+ * @param collectionPath - The collection containing the documents
+ * @param documentIds - Array of document IDs to fetch (max 100)
+ * @returns Array of results in the same order as documentIds. Missing documents return null.
+ * @throws {Error} If the operation fails or more than 100 documents requested
+ *
+ * @example
+ * ```typescript
+ * const users = await getAll('users', ['user1', 'user2', 'user3']);
+ * // users[0] = { name: 'Alice', ... } or null if not found
+ * ```
+ */
+declare function getAll(collectionPath: string, documentIds: string[]): Promise<(DataObject | null)[]>;
 /**
  * Perform batch write operations (set, update, delete)
  *
@@ -1250,4 +1266,4 @@ declare function getAdminAccessToken(): Promise<string>;
  */
 declare function clearTokenCache(): void;
 
-export { type AndroidConfig, type AndroidNotification, type ApnsConfig, type BatchWrite, type BatchWriteResult, type CreateUserRequest, type CustomClaims, type CustomTokenSignInResponse, type DataObject, type DecodedIdToken, type DocumentReference, type DownloadOptions, type Notification as FcmNotification, type FcmOptions, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FileMetadata, type FirestoreDocument, type FirestoreValue, type ListFilesResult, type ListOptions, type ListUsersResult, type Message, type QueryFilter, type QueryOptions, type QueryOrder, type ResumableUploadOptions, type SendResponse, type ServiceAccount, type SessionCookieOptions, type SetOptions, type SignedUrlOptions, type TokenResponse, type TopicManagementError, type TopicManagementResponse, type UpdateOptions, type UpdateUserRequest, type UploadOptions, type UserInfo, type UserRecord, type WebpushConfig, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, countDocuments, createCustomToken, createSessionCookie, createUser, deleteDocument, deleteFile, deleteUser, downloadFile, fileExists, generateSignedUrl, getAdminAccessToken, getAuth, getConfig, getDocument, getFileMetadata, getProjectId, getServiceAccount, getUserByEmail, getUserByUid, getUserFromToken, initializeApp, iterateCollection, listDocuments, listFiles, listUsers, queryDocuments, sendMessage, setCustomUserClaims, setDocument, signInWithCustomToken, subscribeToTopic, unsubscribeFromTopic, updateDocument, updateUser, uploadFile, uploadFileResumable, verifyIdToken, verifySessionCookie };
+export { type AndroidConfig, type AndroidNotification, type ApnsConfig, type BatchWrite, type BatchWriteResult, type CreateUserRequest, type CustomClaims, type CustomTokenSignInResponse, type DataObject, type DecodedIdToken, type DocumentReference, type DownloadOptions, type Notification as FcmNotification, type FcmOptions, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FileMetadata, type FirestoreDocument, type FirestoreValue, type ListFilesResult, type ListOptions, type ListUsersResult, type Message, type QueryFilter, type QueryOptions, type QueryOrder, type ResumableUploadOptions, type SendResponse, type ServiceAccount, type SessionCookieOptions, type SetOptions, type SignedUrlOptions, type TokenResponse, type TopicManagementError, type TopicManagementResponse, type UpdateOptions, type UpdateUserRequest, type UploadOptions, type UserInfo, type UserRecord, type WebpushConfig, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, countDocuments, createCustomToken, createSessionCookie, createUser, deleteDocument, deleteFile, deleteUser, downloadFile, fileExists, generateSignedUrl, getAdminAccessToken, getAll, getAuth, getConfig, getDocument, getFileMetadata, getProjectId, getServiceAccount, getUserByEmail, getUserByUid, getUserFromToken, initializeApp, iterateCollection, listDocuments, listFiles, listUsers, queryDocuments, sendMessage, setCustomUserClaims, setDocument, signInWithCustomToken, subscribeToTopic, unsubscribeFromTopic, updateDocument, updateUser, uploadFile, uploadFileResumable, verifyIdToken, verifySessionCookie };

package/dist/index.js

@@ -216,6 +216,7 @@ __export(index_exports, {
   fileExists: () => fileExists,
   generateSignedUrl: () => generateSignedUrl,
   getAdminAccessToken: () => getAdminAccessToken,
+  getAll: () => getAll,
   getAuth: () => getAuth,
   getConfig: () => getConfig,
   getDocument: () => getDocument,
@@ -1514,6 +1515,44 @@ async function queryDocuments(collectionPath, options) {
     data: convertFromFirestoreFormat(result.document.fields)
   }));
 }
+async function getAll(collectionPath, documentIds) {
+  if (documentIds.length === 0) return [];
+  if (documentIds.length > 100) {
+    throw new Error("getAll supports a maximum of 100 documents per request");
+  }
+  for (const id of documentIds) {
+    validateDocumentPath("collectionPath", collectionPath, id);
+  }
+  const accessToken = await getAdminAccessToken();
+  const projectId = getProjectId();
+  const basePath = `projects/${projectId}/databases/(default)/documents`;
+  const documents = documentIds.map((id) => `${basePath}/${collectionPath}/${id}`);
+  const url = `${FIRESTORE_API}/${basePath}:batchGet`;
+  const response = await fetch(url, {
+    method: "POST",
+    headers: {
+      "Authorization": `Bearer ${accessToken}`,
+      "Content-Type": "application/json"
+    },
+    body: JSON.stringify({ documents })
+  });
+  if (!response.ok) {
+    const errorText = await response.text();
+    throw new Error(`Failed to batch get documents: ${errorText}`);
+  }
+  const results = await response.json();
+  const resultMap = /* @__PURE__ */ new Map();
+  for (const result of results) {
+    if (result.found) {
+      const name = result.found.name;
+      const data = convertFromFirestoreFormat(result.found.fields);
+      resultMap.set(name, data);
+    } else if (result.missing) {
+      resultMap.set(result.missing, null);
+    }
+  }
+  return documents.map((docPath) => resultMap.get(docPath) ?? null);
+}
 async function batchWrite(operations) {
   const accessToken = await getAdminAccessToken();
   const projectId = getProjectId();
@@ -2158,9 +2197,9 @@ async function sendMessage(message) {
   if (targets.length > 1) {
     throw new Error("Only one of token, topic, or condition can be specified");
   }
-  const config = getConfig();
   const accessToken = await getAdminAccessToken();
-  const url = `${FCM_BASE_URL}/projects/${config.projectId}/messages:send`;
+  const projectId = getProjectId();
+  const url = `${FCM_BASE_URL}/projects/${projectId}/messages:send`;
   const response = await fetch(url, {
     method: "POST",
     headers: {
@@ -2256,6 +2295,7 @@ init_service_account();
   fileExists,
   generateSignedUrl,
   getAdminAccessToken,
+  getAll,
   getAuth,
   getConfig,
   getDocument,

package/dist/index.mjs

@@ -1266,6 +1266,44 @@ async function queryDocuments(collectionPath, options) {
     data: convertFromFirestoreFormat(result.document.fields)
   }));
 }
+async function getAll(collectionPath, documentIds) {
+  if (documentIds.length === 0) return [];
+  if (documentIds.length > 100) {
+    throw new Error("getAll supports a maximum of 100 documents per request");
+  }
+  for (const id of documentIds) {
+    validateDocumentPath("collectionPath", collectionPath, id);
+  }
+  const accessToken = await getAdminAccessToken();
+  const projectId = getProjectId();
+  const basePath = `projects/${projectId}/databases/(default)/documents`;
+  const documents = documentIds.map((id) => `${basePath}/${collectionPath}/${id}`);
+  const url = `${FIRESTORE_API}/${basePath}:batchGet`;
+  const response = await fetch(url, {
+    method: "POST",
+    headers: {
+      "Authorization": `Bearer ${accessToken}`,
+      "Content-Type": "application/json"
+    },
+    body: JSON.stringify({ documents })
+  });
+  if (!response.ok) {
+    const errorText = await response.text();
+    throw new Error(`Failed to batch get documents: ${errorText}`);
+  }
+  const results = await response.json();
+  const resultMap = /* @__PURE__ */ new Map();
+  for (const result of results) {
+    if (result.found) {
+      const name = result.found.name;
+      const data = convertFromFirestoreFormat(result.found.fields);
+      resultMap.set(name, data);
+    } else if (result.missing) {
+      resultMap.set(result.missing, null);
+    }
+  }
+  return documents.map((docPath) => resultMap.get(docPath) ?? null);
+}
 async function batchWrite(operations) {
   const accessToken = await getAdminAccessToken();
   const projectId = getProjectId();
@@ -1903,9 +1941,9 @@ async function sendMessage(message) {
   if (targets.length > 1) {
     throw new Error("Only one of token, topic, or condition can be specified");
   }
-  const config = getConfig();
   const accessToken = await getAdminAccessToken();
-  const url = `${FCM_BASE_URL}/projects/${config.projectId}/messages:send`;
+  const projectId = getProjectId();
+  const url = `${FCM_BASE_URL}/projects/${projectId}/messages:send`;
   const response = await fetch(url, {
     method: "POST",
     headers: {
@@ -1996,6 +2034,7 @@ export {
   fileExists,
   generateSignedUrl,
   getAdminAccessToken,
+  getAll,
   getAuth,
   getConfig,
   getDocument,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prmichaelsen/firebase-admin-sdk-v8",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Firebase Admin SDK for Cloudflare Workers and edge runtimes using REST APIs",
   "main": "dist/index.js",
   "module": "dist/index.mjs",