@prmichaelsen/firebase-admin-sdk-v8 2.0.5 → 2.0.7

package/EXAMPLES.md

@@ -50,16 +50,18 @@ await setDocument('users', 'user123', {
 import { addDocument } from 'firebase-admin-sdk-v8';
 
 // Auto-generate document ID
-const docId = await addDocument('posts', {
+const docRef = await addDocument('posts', {
   title: 'Hello World',
   content: 'This is my first post',
   createdAt: new Date(),
 });
+console.log('Created document:', docRef.id);
 
 // Or specify custom ID
-const customId = await addDocument('posts', {
+const customDocRef = await addDocument('posts', {
   title: 'Custom ID Post',
 }, 'my-custom-id');
+console.log('Created document:', customDocRef.id); // 'my-custom-id'
 ```
 
 ### Get Document
@@ -426,7 +428,7 @@ await setDocument('users', 'user123', {
 import { addDocument, FieldValue } from 'firebase-admin-sdk-v8';
 
 async function registerUser(email: string, name: string) {
-  const userId = await addDocument('users', {
+  const docRef = await addDocument('users', {
     email,
     name,
     createdAt: FieldValue.serverTimestamp(),
@@ -435,7 +437,7 @@ async function registerUser(email: string, name: string) {
     roles: ['user'],
   });
   
-  return userId;
+  return docRef.id;
 }
 ```
 
@@ -458,7 +460,7 @@ async function trackUserLogin(userId: string) {
 import { addDocument, updateDocument, FieldValue } from 'firebase-admin-sdk-v8';
 
 async function createPost(title: string, content: string, tags: string[]) {
-  const postId = await addDocument('posts', {
+  const docRef = await addDocument('posts', {
     title,
     content,
     tags,
@@ -468,7 +470,7 @@ async function createPost(title: string, content: string, tags: string[]) {
     updatedAt: FieldValue.serverTimestamp(),
   });
   
-  return postId;
+  return docRef.id;
 }
 
 async function addTagToPost(postId: string, tag: string) {

package/README.md

@@ -169,13 +169,16 @@ await setDocument('users', 'user123', { age: 31, city: 'NYC' }, {
 });
 ```
 
-#### `addDocument(collectionPath, data, documentId?): Promise<string>`
+#### `addDocument(collectionPath, data, documentId?): Promise<DocumentReference>`
 
-Add a document with auto-generated or custom ID.
+Add a document with auto-generated or custom ID. Returns a DocumentReference with `id` and `path` properties.
 
 ```typescript
-const id = await addDocument('posts', { title: 'Hello' });
-const customId = await addDocument('posts', { title: 'Hi' }, 'custom-id');
+const docRef = await addDocument('posts', { title: 'Hello' });
+console.log('Created:', docRef.id); // Auto-generated ID
+
+const customDocRef = await addDocument('posts', { title: 'Hi' }, 'custom-id');
+console.log('Created:', customDocRef.id); // 'custom-id'
 ```
 
 #### `getDocument(collectionPath, documentId): Promise<DataObject | null>`

package/dist/index.d.mts

@@ -91,6 +91,15 @@ interface FirestoreDocument {
  * Generic data object
  */
 type DataObject = Record<string, any>;
+/**
+ * Document reference (simplified version for REST API)
+ */
+interface DocumentReference {
+    /** Document ID */
+    id: string;
+    /** Collection path */
+    path: string;
+}
 /**
  * Set options for document writes
  */
@@ -311,19 +320,20 @@ declare function setDocument(collectionPath: string, documentId: string, data: D
  * @param {string} collectionPath - Collection path (e.g., 'users' or 'users/uid/posts')
  * @param {DataObject} data - Document data
  * @param {string} [documentId] - Optional document ID (auto-generated if not provided)
- * @returns {Promise<string>} Created document ID
+ * @returns {Promise<DocumentReference>} Document reference with id and path
  * @throws {Error} If the operation fails
  *
  * @example
  * ```typescript
- * const docId = await addDocument('users', {
+ * const docRef = await addDocument('users', {
  *   name: 'John Doe',
  *   email: 'john@example.com',
  *   createdAt: new Date()
  * });
+ * console.log('Created document:', docRef.id);
  * ```
  */
-declare function addDocument(collectionPath: string, data: DataObject, documentId?: string): Promise<string>;
+declare function addDocument(collectionPath: string, data: DataObject, documentId?: string): Promise<DocumentReference>;
 /**
  * Get a document from Firestore
  *
@@ -512,4 +522,4 @@ declare function getAdminAccessToken(): Promise<string>;
  */
 declare function clearTokenCache(): void;
 
-export { type BatchWrite, type BatchWriteResult, type DataObject, type DecodedIdToken, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FirestoreDocument, type FirestoreValue, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type TokenResponse, type UpdateOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, deleteDocument, getAdminAccessToken, getAuth, getConfig, getDocument, getProjectId, getServiceAccount, getUserFromToken, initializeApp, queryDocuments, setDocument, updateDocument, verifyIdToken };
+export { type BatchWrite, type BatchWriteResult, type DataObject, type DecodedIdToken, type DocumentReference, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FirestoreDocument, type FirestoreValue, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type TokenResponse, type UpdateOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, deleteDocument, getAdminAccessToken, getAuth, getConfig, getDocument, getProjectId, getServiceAccount, getUserFromToken, initializeApp, queryDocuments, setDocument, updateDocument, verifyIdToken };

package/dist/index.d.ts

@@ -91,6 +91,15 @@ interface FirestoreDocument {
  * Generic data object
  */
 type DataObject = Record<string, any>;
+/**
+ * Document reference (simplified version for REST API)
+ */
+interface DocumentReference {
+    /** Document ID */
+    id: string;
+    /** Collection path */
+    path: string;
+}
 /**
  * Set options for document writes
  */
@@ -311,19 +320,20 @@ declare function setDocument(collectionPath: string, documentId: string, data: D
  * @param {string} collectionPath - Collection path (e.g., 'users' or 'users/uid/posts')
  * @param {DataObject} data - Document data
  * @param {string} [documentId] - Optional document ID (auto-generated if not provided)
- * @returns {Promise<string>} Created document ID
+ * @returns {Promise<DocumentReference>} Document reference with id and path
  * @throws {Error} If the operation fails
  *
  * @example
  * ```typescript
- * const docId = await addDocument('users', {
+ * const docRef = await addDocument('users', {
  *   name: 'John Doe',
  *   email: 'john@example.com',
  *   createdAt: new Date()
  * });
+ * console.log('Created document:', docRef.id);
  * ```
  */
-declare function addDocument(collectionPath: string, data: DataObject, documentId?: string): Promise<string>;
+declare function addDocument(collectionPath: string, data: DataObject, documentId?: string): Promise<DocumentReference>;
 /**
  * Get a document from Firestore
  *
@@ -512,4 +522,4 @@ declare function getAdminAccessToken(): Promise<string>;
  */
 declare function clearTokenCache(): void;
 
-export { type BatchWrite, type BatchWriteResult, type DataObject, type DecodedIdToken, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FirestoreDocument, type FirestoreValue, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type TokenResponse, type UpdateOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, deleteDocument, getAdminAccessToken, getAuth, getConfig, getDocument, getProjectId, getServiceAccount, getUserFromToken, initializeApp, queryDocuments, setDocument, updateDocument, verifyIdToken };
+export { type BatchWrite, type BatchWriteResult, type DataObject, type DecodedIdToken, type DocumentReference, FieldValue, type FieldValue$1 as FieldValueSentinel, FieldValueType, type FirestoreDocument, type FirestoreValue, type QueryFilter, type QueryOptions, type QueryOrder, type ServiceAccount, type SetOptions, type TokenResponse, type UpdateOptions, type UserInfo, type WhereFilterOp, addDocument, batchWrite, clearConfig, clearTokenCache, deleteDocument, getAdminAccessToken, getAuth, getConfig, getDocument, getProjectId, getServiceAccount, getUserFromToken, initializeApp, queryDocuments, setDocument, updateDocument, verifyIdToken };

package/dist/index.js

@@ -722,7 +722,11 @@ async function addDocument(collectionPath, data, documentId) {
     throw new Error(`Failed to add document: ${errorText}`);
   }
   const result = await response.json();
-  return result.name.split("/").pop();
+  const docId = result.name.split("/").pop();
+  return {
+    id: docId,
+    path: `${collectionPath}/${docId}`
+  };
 }
 async function getDocument(collectionPath, documentId) {
   const accessToken = await getAdminAccessToken();

package/dist/index.mjs

@@ -679,7 +679,11 @@ async function addDocument(collectionPath, data, documentId) {
     throw new Error(`Failed to add document: ${errorText}`);
   }
   const result = await response.json();
-  return result.name.split("/").pop();
+  const docId = result.name.split("/").pop();
+  return {
+    id: docId,
+    path: `${collectionPath}/${docId}`
+  };
 }
 async function getDocument(collectionPath, documentId) {
   const accessToken = await getAdminAccessToken();

package/package.json

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