nestjs-firebase-admin 0.4.5 → 0.5.6

package/README.md

@@ -1,15 +1,25 @@
-[![codecov](https://codecov.io/gh/hebertcisco/nestjs-firebase-admin/branch/main/graph/badge.svg?token=N0IW1UNNIP)](https://codecov.io/gh/hebertcisco/nestjs-firebase-admin)
-
-[![CircleCI](https://dl.circleci.com/status-badge/img/gh/hebertcisco/nestjs-firebase-admin/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/hebertcisco/nestjs-firebase-admin/tree/main)
-
-[![Node.js build and publish package](https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/npm-publish.yml)
-
-[![Running Code Coverage](https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/coverage.yml/badge.svg)](https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/coverage.yml)
-
-[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
-[![Nestjs](https://img.shields.io/badge/Nestjs-ea2845?style=flat&logo=nestjs&logoColor=white)](https://nestjs.com/)
-[![Free. Built on open source. Runs everywhere.](https://img.shields.io/badge/VS_Code-0078D4?style=flat&logo=visual%20studio%20code&logoColor=white)](https://code.visualstudio.com/)
-[![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=flat&logo=githubactions&logoColor=white)](https://github.com/hebertcisco/nestjs-firebase-admin/actions)
+<p align="center">
+  <img src="art/logo.png" alt="nestjs-firebase-admin logo" width="200">
+</p>
+
+<p align="center">
+  <a href="https://codecov.io/gh/hebertcisco/nestjs-firebase-admin">
+    <img src="https://codecov.io/gh/hebertcisco/nestjs-firebase-admin/branch/main/graph/badge.svg?token=N0IW1UNNIP" alt="codecov">
+  </a>
+  <a href="https://dl.circleci.com/status-badge/redirect/gh/hebertcisco/nestjs-firebase-admin/tree/main">
+    <img src="https://dl.circleci.com/status-badge/img/gh/hebertcisco/nestjs-firebase-admin/tree/main.svg?style=svg" alt="CircleCI">
+  </a>
+  <a href="https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/npm-publish.yml">
+    <img src="https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/npm-publish.yml/badge.svg" alt="Node.js build and publish package">
+  </a>
+  <a href="https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/coverage.yml">
+    <img src="https://github.com/hebertcisco/nestjs-firebase-admin/actions/workflows/coverage.yml/badge.svg" alt="Running Code Coverage">
+  </a>
+  <img src="https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white" alt="TypeScript">
+  <img src="https://img.shields.io/badge/Nestjs-ea2845?style=flat&logo=nestjs&logoColor=white" alt="Nestjs">
+  <img src="https://img.shields.io/badge/VS_Code-0078D4?style=flat&logo=visual%20studio%20code&logoColor=white" alt="VS Code">
+  <img src="https://img.shields.io/badge/github%20actions-%232671E5.svg?style=flat&logo=githubactions&logoColor=white" alt="GitHub Actions">
+</p>
 
 > Firebase Admin SDK for NestJS :fire:
 
@@ -38,121 +48,6 @@ npm i nestjs-firebase-admin --save
 pnpm add nestjs-firebase-admin --save
 ```
 
-## Usage Example
-
-Here is an example of how to configure the `AdminModule` in NestJS:
-
-```ts
-// common.module.ts
-import { Module } from '@nestjs/common';
-import { AdminModule } from 'nestjs-firebase-admin';
-
-@Module({
-  imports: [
-    AdminModule.register({
-      credential: {
-        projectId: 'my-project-id',
-        clientEmail: 'my-client-email',
-        privateKey: 'my-private-key',
-      },
-      databaseURL: 'https://my-project-id.firebaseio.com',
-    }),
-  ],
-})
-export class CommonModule {}
-```
-
-### Asynchronous Registration
-
-If you need asynchronous configuration, use the `registerAsync` method:
-
-```ts
-import { Module } from '@nestjs/common';
-import { AdminModule } from 'nestjs-firebase-admin';
-
-@Module({
-  imports: [
-    AdminModule.registerAsync({
-      useFactory: async () => ({
-        credential: {
-          projectId: 'my-project-id',
-          clientEmail: 'my-client-email',
-          privateKey: 'my-private-key',
-        },
-        databaseURL: 'https://my-project-id.firebaseio.com',
-      }),
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-## DatabaseService
-
-The `DatabaseService` provides a clean and type-safe interface for interacting with the Firebase Realtime Database. This service is automatically injected when you import the `AdminModule`.
-
-### Features
-
-- Full CRUD operations (Create, Read, Update, Delete)
-- TypeScript type support
-- Asynchronous methods with Promises
-- Database reference handling
-- List operations with unique keys
-
-### Usage Example
-
-```ts
-import { Injectable } from '@nestjs/common';
-import { DatabaseService } from 'nestjs-firebase-admin';
-
-@Injectable()
-export class UsersService {
-  constructor(private readonly databaseService: DatabaseService) {}
-
-  // Get data from a path
-  async getUser(userId: string) {
-    return this.databaseService.get<User>(`users/${userId}`);
-  }
-
-  // Set data at a path
-  async createUser(userId: string, userData: User) {
-    await this.databaseService.set(`users/${userId}`, userData);
-  }
-
-  // Update specific fields
-  async updateUser(userId: string, updates: Partial<User>) {
-    await this.databaseService.update(`users/${userId}`, updates);
-  }
-
-  // Remove data
-  async deleteUser(userId: string) {
-    await this.databaseService.remove(`users/${userId}`);
-  }
-
-  // Add to a list
-  async addUser(userData: User) {
-    const newKey = await this.databaseService.push('users', userData);
-    return newKey;
-  }
-
-  // Get a database reference
-  async getUsersRef() {
-    return this.databaseService.ref('users');
-  }
-}
-```
-
-### Available Methods
-
-| Method | Description | Documentation |
-|--------|-------------|---------------|
-| `ref(path)` | Gets a reference to a specific path | [Firebase Ref](https://firebase.google.com/docs/database/admin/retrieve-data#section-queries) |
-| `get<T>(path)` | Retrieves data from a specific path | [Read Data](https://firebase.google.com/docs/database/admin/retrieve-data#section-read-once) |
-| `set<T>(path, data)` | Sets data at a specific path | [Set Data](https://firebase.google.com/docs/database/admin/save-data#section-set) |
-| `update<T>(path, data)` | Updates specific fields at a path | [Update Data](https://firebase.google.com/docs/database/admin/save-data#section-update) |
-| `remove(path)` | Removes data from a specific path | [Delete Data](https://firebase.google.com/docs/database/admin/save-data#section-delete) |
-| `push<T>(path, data)` | Adds data to a list | [Push Data](https://firebase.google.com/docs/database/admin/save-data#section-push) |
-
 ## Testing
 
 To run tests, use the following commands:

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './modules/admin/admin.module';
-export * from './modules/admin/admin.service';
-export * from './modules/admin/database.service';
-export * from './modules/admin/messaging.service';
+export * from './modules/admin/services/admin.service';
+export * from './modules/admin/services/database.service';
+export * from './modules/admin/services/messaging.service';
+export * from './modules/admin/services/firestore.service';
 export * from './modules/admin/interfaces';
 export * from './modules/admin/types';

package/dist/index.js

@@ -15,8 +15,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./modules/admin/admin.module"), exports);
-__exportStar(require("./modules/admin/admin.service"), exports);
-__exportStar(require("./modules/admin/database.service"), exports);
-__exportStar(require("./modules/admin/messaging.service"), exports);
+__exportStar(require("./modules/admin/services/admin.service"), exports);
+__exportStar(require("./modules/admin/services/database.service"), exports);
+__exportStar(require("./modules/admin/services/messaging.service"), exports);
+__exportStar(require("./modules/admin/services/firestore.service"), exports);
 __exportStar(require("./modules/admin/interfaces"), exports);
 __exportStar(require("./modules/admin/types"), exports);

package/dist/modules/admin/admin.module.js

@@ -23,19 +23,27 @@ exports.AdminModule = void 0;
 const common_1 = require("@nestjs/common");
 const random_string_generator_util_1 = require("@nestjs/common/utils/random-string-generator.util");
 const firebase_admin_1 = __importDefault(require("firebase-admin"));
-const admin_constants_1 = require("./admin.constants");
-const admin_service_1 = require("./admin.service");
-const database_service_1 = require("./database.service");
-const messaging_service_1 = require("./messaging.service");
+const admin_constants_1 = require("./constants/admin.constants");
+const admin_service_1 = require("./services/admin.service");
+const database_service_1 = require("./services/database.service");
+const messaging_service_1 = require("./services/messaging.service");
+const firestore_service_1 = require("./services/firestore.service");
+const auth_service_1 = require("./services/auth.service");
 let AdminModule = AdminModule_1 = class AdminModule {
     static register(options) {
         const firebaseApp = firebase_admin_1.default.initializeApp(Object.assign(Object.assign({}, options), { credential: firebase_admin_1.default.credential.cert(options.credential) }));
         return {
             module: AdminModule_1,
             providers: [
+                {
+                    provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                    useValue: options,
+                },
                 admin_service_1.AdminService,
                 database_service_1.DatabaseService,
                 messaging_service_1.MessagingService,
+                firestore_service_1.FirestoreService,
+                auth_service_1.AuthService,
                 {
                     provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
                     useValue: options,
@@ -53,16 +61,28 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 admin_service_1.AdminService,
                 database_service_1.DatabaseService,
                 messaging_service_1.MessagingService,
+                firestore_service_1.FirestoreService,
+                auth_service_1.AuthService,
                 admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
                 admin_constants_1.FIREBASE_ADMIN_APP,
             ],
         };
     }
     static registerAsync(options) {
+        if (!options.useFactory) {
+            throw new Error('useFactory is required in registerAsync options');
+        }
         const providers = [
+            {
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: options.useFactory,
+                inject: options.inject || [],
+            },
             admin_service_1.AdminService,
             database_service_1.DatabaseService,
             messaging_service_1.MessagingService,
+            firestore_service_1.FirestoreService,
+            auth_service_1.AuthService,
             {
                 provide: admin_constants_1.ADMIN_MODULE_ID,
                 useValue: (0, random_string_generator_util_1.randomStringGenerator)(),
@@ -129,12 +149,14 @@ let AdminModule = AdminModule_1 = class AdminModule {
         }
         return {
             module: AdminModule_1,
-            imports: options.imports,
+            imports: options.imports || [],
             providers,
             exports: [
                 admin_service_1.AdminService,
                 database_service_1.DatabaseService,
                 messaging_service_1.MessagingService,
+                firestore_service_1.FirestoreService,
+                auth_service_1.AuthService,
                 admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
                 admin_constants_1.FIREBASE_ADMIN_APP,
             ],
@@ -148,11 +170,19 @@ exports.AdminModule = AdminModule = AdminModule_1 = __decorate([
             admin_service_1.AdminService,
             database_service_1.DatabaseService,
             messaging_service_1.MessagingService,
+            firestore_service_1.FirestoreService,
+            auth_service_1.AuthService,
             {
                 provide: admin_constants_1.ADMIN_MODULE_ID,
                 useValue: (0, random_string_generator_util_1.randomStringGenerator)(),
             },
         ],
-        exports: [admin_service_1.AdminService, database_service_1.DatabaseService, messaging_service_1.MessagingService],
+        exports: [
+            admin_service_1.AdminService,
+            database_service_1.DatabaseService,
+            messaging_service_1.MessagingService,
+            firestore_service_1.FirestoreService,
+            auth_service_1.AuthService,
+        ],
     })
 ], AdminModule);

package/dist/modules/admin/{admin.service.d.ts → services/admin.service.d.ts}

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import Admin from 'firebase-admin';
 import type { App } from 'firebase-admin/app';
 import type { Agent } from 'node:http';
-import type { AdminModuleOptions } from './types';
+import type { AdminModuleOptions } from '../types';
 export declare class AdminService {
     protected readonly options: AdminModuleOptions;
     private readonly firebaseApp;

package/dist/modules/admin/{admin.service.js → services/admin.service.js}

@@ -20,7 +20,7 @@ const common_1 = require("@nestjs/common");
 const rxjs_1 = require("rxjs");
 const app_1 = require("firebase-admin/app");
 const firebase_admin_1 = __importDefault(require("firebase-admin"));
-const admin_constants_1 = require("./admin.constants");
+const admin_constants_1 = require("../constants/admin.constants");
 let AdminService = class AdminService {
     constructor(options, firebaseApp) {
         this.options = options;

package/dist/modules/admin/services/auth.service.d.ts

@@ -0,0 +1,32 @@
+import { AdminService } from './admin.service';
+export declare class AuthService {
+    private readonly adminService;
+    constructor(adminService: AdminService);
+    get auth(): import("firebase-admin/auth").Auth;
+    createUser(properties: {
+        email?: string;
+        emailVerified?: boolean;
+        phoneNumber?: string;
+        password?: string;
+        displayName?: string;
+        photoURL?: string;
+        disabled?: boolean;
+    }): Promise<import("firebase-admin/auth").UserRecord>;
+    getUser(uid: string): Promise<import("firebase-admin/auth").UserRecord>;
+    getUserByEmail(email: string): Promise<import("firebase-admin/auth").UserRecord>;
+    getUserByPhoneNumber(phoneNumber: string): Promise<import("firebase-admin/auth").UserRecord>;
+    updateUser(uid: string, properties: {
+        email?: string;
+        emailVerified?: boolean;
+        phoneNumber?: string;
+        password?: string;
+        displayName?: string;
+        photoURL?: string;
+        disabled?: boolean;
+    }): Promise<import("firebase-admin/auth").UserRecord>;
+    deleteUser(uid: string): Promise<void>;
+    createCustomToken(uid: string, claims?: object): Promise<string>;
+    verifyIdToken(idToken: string): Promise<import("firebase-admin/auth").DecodedIdToken>;
+    setCustomUserClaims(uid: string, claims: object): Promise<void>;
+    listUsers(maxResults?: number, pageToken?: string): Promise<import("firebase-admin/auth").ListUsersResult>;
+}

package/dist/modules/admin/services/auth.service.js

@@ -0,0 +1,87 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthService = void 0;
+const common_1 = require("@nestjs/common");
+const auth_1 = require("firebase-admin/auth");
+const admin_service_1 = require("./admin.service");
+let AuthService = class AuthService {
+    constructor(adminService) {
+        this.adminService = adminService;
+    }
+    get auth() {
+        return (0, auth_1.getAuth)(this.adminService.appRef);
+    }
+    createUser(properties) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.createUser(properties);
+        });
+    }
+    getUser(uid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.getUser(uid);
+        });
+    }
+    getUserByEmail(email) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.getUserByEmail(email);
+        });
+    }
+    getUserByPhoneNumber(phoneNumber) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.getUserByPhoneNumber(phoneNumber);
+        });
+    }
+    updateUser(uid, properties) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.updateUser(uid, properties);
+        });
+    }
+    deleteUser(uid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.deleteUser(uid);
+        });
+    }
+    createCustomToken(uid, claims) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.createCustomToken(uid, claims);
+        });
+    }
+    verifyIdToken(idToken) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.verifyIdToken(idToken);
+        });
+    }
+    setCustomUserClaims(uid, claims) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.setCustomUserClaims(uid, claims);
+        });
+    }
+    listUsers(maxResults, pageToken) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.auth.listUsers(maxResults, pageToken);
+        });
+    }
+};
+exports.AuthService = AuthService;
+exports.AuthService = AuthService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [admin_service_1.AdminService])
+], AuthService);

package/dist/modules/admin/{database.service.d.ts → services/database.service.d.ts}

@@ -1,4 +1,4 @@
-import type { AdminModuleOptions } from './types';
+import type { AdminModuleOptions } from '../types';
 import { App } from 'firebase-admin/app';
 export declare class DatabaseService {
     protected readonly options: AdminModuleOptions;

package/dist/modules/admin/{database.service.js → services/database.service.js}

@@ -24,7 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatabaseService = void 0;
 const common_1 = require("@nestjs/common");
 const database_1 = require("firebase-admin/database");
-const admin_constants_1 = require("./admin.constants");
+const admin_constants_1 = require("../constants/admin.constants");
 let DatabaseService = class DatabaseService {
     constructor(options, firebaseApp) {
         this.options = options;

package/dist/modules/admin/services/firestore.service.d.ts

@@ -0,0 +1,18 @@
+import { CollectionReference, DocumentReference, DocumentData, SetOptions, WithFieldValue } from 'firebase-admin/firestore';
+import type { AdminModuleOptions } from '../types';
+import { App } from 'firebase-admin/app';
+export declare class FirestoreService {
+    protected readonly options: AdminModuleOptions;
+    private readonly firebaseApp;
+    private app;
+    private firestore;
+    constructor(options: AdminModuleOptions, firebaseApp: App);
+    collection<T = DocumentData>(path: string): CollectionReference<T>;
+    doc<T = DocumentData>(path: string): DocumentReference<T>;
+    get<T = DocumentData>(path: string): Promise<T | null>;
+    set<T = DocumentData>(path: string, data: WithFieldValue<T>, options?: SetOptions): Promise<void>;
+    update<T = DocumentData>(path: string, data: Record<string, any>): Promise<void>;
+    delete(path: string): Promise<void>;
+    add<T = DocumentData>(collectionPath: string, data: WithFieldValue<T>): Promise<DocumentReference<T>>;
+    query<T = DocumentData>(collectionPath: string, ...constraints: any[]): Promise<T[]>;
+}

package/dist/modules/admin/services/firestore.service.js

@@ -0,0 +1,94 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirestoreService = void 0;
+const common_1 = require("@nestjs/common");
+const firestore_1 = require("firebase-admin/firestore");
+const admin_constants_1 = require("../constants/admin.constants");
+let FirestoreService = class FirestoreService {
+    constructor(options, firebaseApp) {
+        this.options = options;
+        this.firebaseApp = firebaseApp;
+        this.app = firebaseApp;
+        this.firestore = (0, firestore_1.getFirestore)();
+    }
+    collection(path) {
+        return this.firestore.collection(path);
+    }
+    doc(path) {
+        return this.firestore.doc(path);
+    }
+    get(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const docSnap = yield this.doc(path).get();
+            return docSnap.exists ? docSnap.data() : null;
+        });
+    }
+    set(path, data, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (options) {
+                yield this.doc(path).set(data, options);
+            }
+            else {
+                yield this.doc(path).set(data);
+            }
+        });
+    }
+    update(path, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!data || typeof data !== 'object') {
+                throw new Error('Update data must be a non-null object');
+            }
+            yield this.doc(path).update(data);
+        });
+    }
+    delete(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.doc(path).delete();
+        });
+    }
+    add(collectionPath, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.collection(collectionPath).add(data);
+        });
+    }
+    query(collectionPath, ...constraints) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let q = this.collection(collectionPath);
+            if (constraints.length) {
+                for (const constraint of constraints) {
+                    q = constraint(q);
+                }
+            }
+            const snap = yield q.get();
+            return snap.docs.map(doc => doc.data());
+        });
+    }
+};
+exports.FirestoreService = FirestoreService;
+exports.FirestoreService = FirestoreService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN)),
+    __param(1, (0, common_1.Inject)('FIREBASE_ADMIN_APP')),
+    __metadata("design:paramtypes", [Object, Object])
+], FirestoreService);

package/dist/modules/admin/{messaging.service.js → services/messaging.service.js}

@@ -23,7 +23,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessagingService = void 0;
 const common_1 = require("@nestjs/common");
-const admin_constants_1 = require("./admin.constants");
+const admin_constants_1 = require("../constants/admin.constants");
 let MessagingService = class MessagingService {
     constructor(app) {
         this.app = app;

package/docs/_sidebar.md

@@ -0,0 +1,10 @@
+* [Home](/)
+* [Getting Started](docs/getting-started.md)
+* Services
+  * [Admin Service](docs/services/admin-service.md)
+  * [Auth Service](docs/services/auth-service.md)
+  * [Database Service](docs/services/database-service.md)
+  * [Firestore Service](docs/services/firestore-service.md)
+  * [Messaging Service](docs/services/messaging-service.md)
+* [Testing](docs/testing.md)
+* [Contributing](docs/contributing.md)

package/docs/getting-started.md

@@ -0,0 +1,82 @@
+# Getting Started
+
+## Requirements
+
+- **Node.js**: >= 20
+- **NPM**: >= 10
+- **NestJS**: >= 7.0.0
+
+## Installation
+
+Install the package using `yarn`, `npm`, or `pnpm`:
+
+```bash
+# yarn
+yarn add nestjs-firebase-admin
+```
+
+```bash
+# npm
+npm i nestjs-firebase-admin --save
+```
+
+```bash
+# pnpm
+pnpm add nestjs-firebase-admin --save
+```
+
+## Basic Usage
+
+Here is an example of how to configure the `AdminModule` in NestJS:
+
+```ts
+// common.module.ts
+import { Module } from '@nestjs/common';
+import { AdminModule } from 'nestjs-firebase-admin';
+
+@Module({
+  imports: [
+    AdminModule.register({
+      credential: {
+        projectId: 'my-project-id',
+        clientEmail: 'my-client-email',
+        privateKey: 'my-private-key',
+      },
+      databaseURL: 'https://my-project-id.firebaseio.com',
+    }),
+  ],
+})
+export class CommonModule {}
+```
+
+### Asynchronous Registration
+
+If you need asynchronous configuration, use the `registerAsync` method:
+
+```ts
+import { Module } from '@nestjs/common';
+import { AdminModule } from 'nestjs-firebase-admin';
+
+@Module({
+  imports: [
+    AdminModule.registerAsync({
+      useFactory: async () => ({
+        credential: {
+          projectId: 'my-project-id',
+          clientEmail: 'my-client-email',
+          privateKey: 'my-private-key',
+        },
+        databaseURL: 'https://my-project-id.firebaseio.com',
+      }),
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## Next Steps
+
+- Learn about the [Admin Service](services/admin-service.md)
+- Explore the [Database Service](services/database-service.md)
+- Check out the [Firestore Service](services/firestore-service.md)
+- Discover the [Messaging Service](services/messaging-service.md)