nestjs-firebase-admin 0.6.0 → 0.6.2

package/dist/index.d.ts

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

package/dist/index.js

@@ -16,6 +16,7 @@ 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/services/admin.service"), exports);
+__exportStar(require("./modules/admin/services/auth.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);

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

@@ -69,15 +69,10 @@ let AdminModule = AdminModule_1 = class AdminModule {
         };
     }
     static registerAsync(options) {
-        if (!options.useFactory) {
-            throw new Error('useFactory is required in registerAsync options');
+        if (!options.useFactory && !options.useExisting && !options.useClass) {
+            throw new Error('One of useFactory, useExisting, or useClass must be provided in AdminModuleAsyncOptions');
         }
         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,
@@ -89,6 +84,11 @@ let AdminModule = AdminModule_1 = class AdminModule {
             },
         ];
         if (options.useFactory) {
+            providers.push({
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: options.useFactory,
+                inject: options.inject || [],
+            });
             const factory = options.useFactory;
             providers.push({
                 provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
@@ -105,12 +105,14 @@ let AdminModule = AdminModule_1 = class AdminModule {
             });
         }
         else if (options.useExisting) {
+            providers.push({
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
+                inject: [options.useExisting],
+            });
             providers.push({
                 provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
-                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () {
-                    const config = yield optionsFactory.createAdminOptions();
-                    return config;
-                }),
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
                 inject: [options.useExisting],
             });
             providers.push({
@@ -127,12 +129,14 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 provide: options.useClass,
                 useClass: options.useClass,
             });
+            providers.push({
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
+                inject: [options.useClass],
+            });
             providers.push({
                 provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
-                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () {
-                    const config = yield optionsFactory.createAdminOptions();
-                    return config;
-                }),
+                useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
                 inject: [options.useClass],
             });
             providers.push({
@@ -144,9 +148,6 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 inject: [options.useClass],
             });
         }
-        else {
-            throw new Error('One of useFactory, useExisting, or useClass must be provided in AdminModuleAsyncOptions');
-        }
         return {
             module: AdminModule_1,
             imports: options.imports || [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-firebase-admin",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "Firebase Admin SDK for Nestjs",
   "author": "hebertcisco <hebertcisco@outlook.com>",
   "license": "MIT",
@@ -22,9 +22,14 @@
   ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
   "scripts": {
     "start:debug": "nest start --debug --watch",
-    "build": "npx tsc",
+    "build": "npx tsc -p tsconfig.build.json",
     "prebuild": "rimraf dist",
     "format": "npx prettier --write \"{lib,test}/**/*.ts\"",
     "lint": "npx eslint \"lib/**/*.ts\" --fix",
@@ -33,8 +38,6 @@
     "prepublish:next": "npm run build",
     "publish:next": "npm publish --access public --tag next",
     "test:e2e": "npx jest --config ./tests/jest-e2e.json --runInBand",
-    "prerelease": "npm run build",
-    "release": "release-it",
     "prepare": "npm run build",
     "test": "npx jest",
     "test:watch": "npx jest --watch",
@@ -45,59 +48,41 @@
     "version": "npm run format && git add -A lib",
     "postversion": "git push && git push --tags"
   },
-  "dependencies": {
-    "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
-    "@nestjs/core": "^11.1.18",
-    "@nestjs/platform-express": "^11.1.18",
-    "firebase-admin": "^13.0.0",
-    "nest-shared": "^5.0.6"
-  },
   "engines": {
     "node": ">=20",
     "npm": ">=10"
   },
+  "dependencies": {
+    "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
+    "@nestjs/core": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
+    "firebase-admin": "^13.7.0"
+  },
   "devDependencies": {
-    "@commitlint/cli": "18.6.1",
-    "@commitlint/config-angular": "18.6.1",
-    "@nestjs/testing": "^11.1.18",
-    "@types/jest": "29.5.14",
-    "@types/node": "20.17.9",
-    "@types/supertest": "^2.0.16",
-    "@typescript-eslint/eslint-plugin": "^8.56.1",
-    "@typescript-eslint/parser": "^8.56.1",
-    "eslint": "8.57.1",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-jest": "^28.8.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "husky": "8.0.3",
-    "jest": "29.7.0",
-    "lint-staged": "^15.5.2",
-    "prettier": "^3.4.2",
-    "reflect-metadata": "0.2.2",
-    "release-it": "^19.0.2",
-    "rimraf": "5.0.10",
-    "rxjs": "7.8.1",
-    "supertest": "^7.1.0",
-    "ts-jest": "29.2.5",
-    "typescript": "5.7.2"
+    "@nestjs/testing": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.19.17",
+    "@types/supertest": "^7.2.0",
+    "@typescript-eslint/eslint-plugin": "^8.58.1",
+    "@typescript-eslint/parser": "^8.58.1",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^28.14.0",
+    "eslint-plugin-prettier": "^5.5.5",
+    "jest": "^29.7.0",
+    "prettier": "^3.8.1",
+    "reflect-metadata": "^0.2.2",
+    "rimraf": "^5.0.10",
+    "rxjs": "^7.8.2",
+    "supertest": "^7.2.2",
+    "ts-jest": "^29.4.9",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.2.1 || ^10.2.1 || ^11.0.0",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^6.0.0 || ^7.0.0"
   },
-  "lint-staged": {
-    "*.ts": [
-      "prettier --write"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -c .commitlintrc.json -E HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged"
-    }
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/hebertcisco/nestjs-firebase-admin"
@@ -114,9 +99,23 @@
       "^.+\\.(t|j)s$": "ts-jest"
     },
     "collectCoverageFrom": [
-      "**/*.(t|j)s"
+      "**/*.(t|j)s",
+      "!**/*.spec.ts",
+      "!**/tests/**",
+      "!**/mocks/**",
+      "!**/interfaces/index.ts",
+      "!**/types/index.ts",
+      "!index.ts"
     ],
     "coverageDirectory": "../coverage",
+    "coverageThreshold": {
+      "global": {
+        "statements": 85,
+        "branches": 65,
+        "functions": 92,
+        "lines": 95
+      }
+    },
     "testEnvironment": "node"
   }
 }

package/.commitlintrc.json

@@ -1,28 +0,0 @@
-{
-  "extends": ["@commitlint/config-angular"],
-  "rules": {
-    "subject-case": [
-      2,
-      "always",
-      ["sentence-case", "start-case", "pascal-case", "upper-case", "lower-case"]
-    ],
-    "type-enum": [
-      2,
-      "always",
-      [
-        "build",
-        "chore",
-        "ci",
-        "docs",
-        "feat",
-        "fix",
-        "perf",
-        "refactor",
-        "revert",
-        "style",
-        "test",
-        "sample"
-      ]
-    ]
-  }
-}

package/.eslintignore

@@ -1,3 +0,0 @@
-src/**/*.test.ts
-src/**/files/**
-test/**

package/.eslintrc

@@ -1,21 +0,0 @@
-{
-  "root": true,
-  "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "@typescript-eslint",
-    "jest"
-  ],
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:jest/recommended"
-  ],
-  "rules": {
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-unused-vars": "off",
-    "jest/no-export": "off",
-    "jest/no-disabled-tests": "off",
-    "jest/expect-expect": "off",
-    "jest/valid-title": "off"
-  }
-}

package/.gitpod.yml

@@ -1,10 +0,0 @@
-# This configuration file was automatically generated by Gitpod.
-# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
-# and commit this file to your remote git repository to share the goodness with others.
-
-# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart
-
-tasks:
-  - init: npm install && npm run build
-
-

package/.nvmrc

@@ -1 +0,0 @@
-lts/jod

package/.release-it.json

@@ -1,8 +0,0 @@
-{
-  "git": {
-    "commitMessage": "chore(): release v${version}"
-  },
-  "github": {
-    "release": true
-  }
-}

package/_coverpage.md

@@ -1,13 +0,0 @@
-![logo](art/logo.png ':size=120')
-
-# nestjs-firebase-admin
-
-> Firebase Admin SDK module for NestJS
-
-- Injectable services for Auth, Firestore, Database, and Messaging
-- Sync and async module registration
-- TypeScript-first with full type support
-- Compatible with NestJS 7 through 11
-
-[Get Started](docs/getting-started.md)
-[GitHub](https://github.com/hebertcisco/nestjs-firebase-admin)

package/dist/modules/admin/interfaces/admin-module.interface.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/modules/admin/interfaces/admin-module.interface.spec.js

@@ -1,43 +0,0 @@
-"use strict";
-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 });
-describe('AdminModuleOptionsFactory', () => {
-    it('should define a method to create admin options', () => {
-        class TestFactory {
-            createAdminOptions() {
-                return { credential: { projectId: 'test' } };
-            }
-        }
-        const factory = new TestFactory();
-        expect(factory.createAdminOptions()).toEqual({
-            credential: { projectId: 'test' },
-        });
-    });
-});
-describe('AdminModuleAsyncOptions', () => {
-    it('should allow useExisting, useClass, or useFactory for async options', () => {
-        const asyncOptions = {
-            useFactory: () => __awaiter(void 0, void 0, void 0, function* () { return ({ credential: { projectId: 'test' } }); }),
-            inject: [],
-        };
-        expect(asyncOptions.useFactory).toBeDefined();
-        expect(asyncOptions.inject).toEqual([]);
-    });
-    it('should support extraProviders', () => {
-        const extraProvider = { provide: 'TEST', useValue: 'value' };
-        const asyncOptions = {
-            useFactory: () => __awaiter(void 0, void 0, void 0, function* () { return ({ credential: { projectId: 'test' } }); }),
-            inject: [],
-            extraProviders: [extraProvider],
-        };
-        expect(asyncOptions.extraProviders).toContain(extraProvider);
-    });
-});

package/dist/modules/admin/types/admin.type.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/modules/admin/types/admin.type.spec.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-describe('Admin Types', () => {
-    it('should define AdminConfig with required and optional properties', () => {
-        const config = {
-            credential: {
-                projectId: 'test-project',
-                clientEmail: 'test@example.com',
-                privateKey: 'test-key',
-            },
-            databaseURL: 'https://test.firebaseio.com',
-            storageBucket: 'test-bucket',
-            projectId: 'test-project-id',
-            httpAgent: undefined,
-        };
-        expect(config.credential.projectId).toBe('test-project');
-        expect(config.databaseURL).toBe('https://test.firebaseio.com');
-        expect(config.storageBucket).toBe('test-bucket');
-        expect(config.projectId).toBe('test-project-id');
-        expect(config.httpAgent).toBeUndefined();
-    });
-    it('should define AdminModuleOptions as an alias for AdminConfig', () => {
-        const options = {
-            credential: {
-                projectId: 'test-project',
-                clientEmail: 'test@example.com',
-                privateKey: 'test-key',
-            },
-        };
-        expect(options.credential.projectId).toBe('test-project');
-        expect(options.credential.clientEmail).toBe('test@example.com');
-        expect(options.credential.privateKey).toBe('test-key');
-    });
-});

package/docs/_sidebar.md

@@ -1,10 +0,0 @@
-* [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

@@ -1,93 +0,0 @@
-# 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 { ConfigService } from '@nestjs/config';
-import { AdminModule } from 'nestjs-firebase-admin';
-
-@Module({
-  imports: [
-    AdminModule.registerAsync({
-      inject: [ConfigService],
-      useFactory: async (config: ConfigService) => ({
-        credential: {
-          projectId: config.get('FIREBASE_PROJECT_ID'),
-          clientEmail: config.get('FIREBASE_CLIENT_EMAIL'),
-          privateKey: config.get('FIREBASE_PRIVATE_KEY'),
-        },
-        databaseURL: config.get('FIREBASE_DATABASE_URL'),
-      }),
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-You can also use `useClass` or `useExisting` for more advanced scenarios:
-
-```ts
-AdminModule.registerAsync({
-  useClass: FirebaseConfigService,
-})
-```
-
-## Next Steps
-
-- Learn about the [Admin Service](services/admin-service.md)
-- Manage users with the [Auth Service](services/auth-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)

package/docs/services/admin-service.md

@@ -1,102 +0,0 @@
-# Admin Service
-
-The `AdminService` is the core service that manages the Firebase Admin SDK initialization and configuration. This service is automatically injected when you import the `AdminModule`.
-
-## Features
-
-- Firebase Admin SDK initialization
-- Multiple app instances support
-- Credential management
-- App lifecycle management
-- TypeScript type support
-
-## Usage Example
-
-```ts
-import { Injectable } from '@nestjs/common';
-import { AdminService } from 'nestjs-firebase-admin';
-
-@Injectable()
-export class FirebaseService {
-  constructor(private readonly adminService: AdminService) {}
-
-  // Get the default app instance
-  getApp() {
-    return this.adminService.getApp;
-  }
-
-  // Get all initialized apps
-  getApps() {
-    return this.adminService.getApps;
-  }
-
-  // Delete an app instance
-  async deleteApp(app) {
-    await this.adminService.deleteApp(app);
-  }
-
-  // Get default credentials
-  getDefaultCredentials() {
-    return this.adminService.applicationDefault();
-  }
-
-  // Get the Firebase Admin SDK instance
-  getAdmin() {
-    return this.adminService.admin();
-  }
-}
-```
-
-## Available Methods
-
-| Method | Description | Documentation |
-|--------|-------------|---------------|
-| `getApp` | Gets the default Firebase app instance | [Get App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#getapp) |
-| `getApps` | Gets all initialized Firebase apps | [Get Apps](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#getapps) |
-| `deleteApp(app)` | Deletes a Firebase app instance | [Delete App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#deleteapp) |
-| `applicationDefault(httpAgent?)` | Gets default credentials | [Application Default](https://firebase.google.com/docs/reference/admin/node/firebase-admin.credential#applicationdefault) |
-| `admin()` | Gets the Firebase Admin SDK instance | [Admin SDK](https://firebase.google.com/docs/admin/setup) |
-| `appRef` | Gets the initialized app instance reference | [Initialize App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#initializeapp) |
-| `initializeApp()` | Returns the initialized app instance | [Initialize App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#initializeapp) |
-| `initializeAppObservable()` | Creates an Observable that emits the app instance | [Initialize App](https://firebase.google.com/docs/reference/admin/node/firebase-admin.app#initializeapp) |
-
-## Configuration
-
-The service can be configured through the `AdminModule` using either synchronous or asynchronous registration:
-
-### Synchronous Registration
-
-```ts
-AdminModule.register({
-  credential: {
-    projectId: 'my-project-id',
-    clientEmail: 'my-client-email',
-    privateKey: 'my-private-key',
-  },
-  databaseURL: 'https://my-project-id.firebaseio.com',
-})
-```
-
-### Asynchronous Registration
-
-```ts
-AdminModule.registerAsync({
-  useFactory: async () => ({
-    credential: {
-      projectId: 'my-project-id',
-      clientEmail: 'my-client-email',
-      privateKey: 'my-private-key',
-    },
-    databaseURL: 'https://my-project-id.firebaseio.com',
-  }),
-})
-```
-
-## App Lifecycle
-
-The service manages the lifecycle of Firebase app instances:
-
-1. **Initialization**: Apps are initialized when the module is registered
-2. **Access**: Apps can be accessed through `getApp` or `getApps`
-3. **Cleanup**: Apps can be deleted using `deleteApp`
-4. **Multiple Instances**: Multiple app instances can be managed simultaneously

package/docs/services/auth-service.md

@@ -1,123 +0,0 @@
-# Auth Service
-
-The `AuthService` provides a clean and type-safe interface for managing Firebase Authentication. This service is automatically injected when you import the `AdminModule`.
-
-## Features
-
-- User management (create, read, update, delete)
-- Custom token generation
-- ID token verification
-- Custom claims management
-- User listing and pagination
-- Email and phone number authentication
-- TypeScript type support
-
-## Usage Example
-
-```ts
-import { Injectable } from '@nestjs/common';
-import { AuthService } from 'nestjs-firebase-admin';
-
-@Injectable()
-export class UsersService {
-  constructor(private readonly authService: AuthService) {}
-
-  // Create a new user
-  async createUser(email: string, password: string) {
-    return this.authService.createUser({
-      email,
-      password,
-      emailVerified: false,
-    });
-  }
-
-  // Get user by UID
-  async getUser(uid: string) {
-    return this.authService.getUser(uid);
-  }
-
-  // Update user profile
-  async updateProfile(uid: string, displayName: string, photoURL: string) {
-    return this.authService.updateUser(uid, {
-      displayName,
-      photoURL,
-    });
-  }
-
-  // Set custom claims
-  async setUserRole(uid: string, role: string) {
-    return this.authService.setCustomUserClaims(uid, { role });
-  }
-
-  // Verify ID token
-  async verifyToken(idToken: string) {
-    return this.authService.verifyIdToken(idToken);
-  }
-
-  // List users with pagination
-  async listUsers(pageSize: number = 100) {
-    return this.authService.listUsers(pageSize);
-  }
-}
-```
-
-## Available Methods
-
-| Method | Description | Documentation |
-|--------|-------------|---------------|
-| `createUser(properties)` | Creates a new user | [Create User](https://firebase.google.com/docs/auth/admin/manage-users#create_a_user) |
-| `getUser(uid)` | Gets a user by UID | [Get User](https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data) |
-| `getUserByEmail(email)` | Gets a user by email | [Get User by Email](https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data) |
-| `getUserByPhoneNumber(phoneNumber)` | Gets a user by phone number | [Get User by Phone](https://firebase.google.com/docs/auth/admin/manage-users#retrieve_user_data) |
-| `updateUser(uid, properties)` | Updates a user's properties | [Update User](https://firebase.google.com/docs/auth/admin/manage-users#update_a_user) |
-| `deleteUser(uid)` | Deletes a user | [Delete User](https://firebase.google.com/docs/auth/admin/manage-users#delete_a_user) |
-| `createCustomToken(uid, claims?)` | Creates a custom token | [Custom Tokens](https://firebase.google.com/docs/auth/admin/create-custom-tokens) |
-| `verifyIdToken(idToken)` | Verifies an ID token | [Verify ID Token](https://firebase.google.com/docs/auth/admin/verify-id-tokens) |
-| `setCustomUserClaims(uid, claims)` | Sets custom claims | [Custom Claims](https://firebase.google.com/docs/auth/admin/custom-claims) |
-| `listUsers(maxResults?, pageToken?)` | Lists users with pagination | [List Users](https://firebase.google.com/docs/auth/admin/manage-users#list_all_users) |
-
-## User Properties
-
-When creating or updating a user, you can specify the following properties:
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `email` | string | The user's email address |
-| `emailVerified` | boolean | Whether the email is verified |
-| `phoneNumber` | string | The user's phone number |
-| `password` | string | The user's password |
-| `displayName` | string | The user's display name |
-| `photoURL` | string | The user's profile photo URL |
-| `disabled` | boolean | Whether the user account is disabled |
-
-## Custom Claims
-
-Custom claims can be used to define user roles and permissions. They are included in the ID token and can be accessed on the client side.
-
-Example:
-
-```ts
-// Set admin role
-await authService.setCustomUserClaims(uid, { role: 'admin' });
-
-// Set multiple roles
-await authService.setCustomUserClaims(uid, { 
-  roles: ['admin', 'editor'],
-  premium: true 
-});
-```
-
-## Token Verification
-
-The service provides methods for token verification and custom token generation:
-
-```ts
-// Verify ID token
-const decodedToken = await authService.verifyIdToken(idToken);
-console.log(decodedToken.uid);
-
-// Create custom token
-const customToken = await authService.createCustomToken(uid, {
-  role: 'admin'
-});
-```

package/docs/services/database-service.md

@@ -1,65 +0,0 @@
-# Database Service
-
-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) |

package/docs/services/firestore-service.md

@@ -1,69 +0,0 @@
-# Firestore Service
-
-The `FirestoreService` provides a clean and type-safe interface for interacting with Cloud Firestore. This service is automatically injected when you import the `AdminModule`.
-
-## Features
-
-- Full CRUD operations (Create, Read, Update, Delete)
-- TypeScript type support
-- Collection and document management
-- Query support
-- Batch operations
-- Transaction support
-
-## Usage Example
-
-```ts
-import { Injectable } from '@nestjs/common';
-import { FirestoreService } from 'nestjs-firebase-admin';
-
-@Injectable()
-export class UsersService {
-  constructor(private readonly firestoreService: FirestoreService) {}
-
-  // Get a document
-  async getUser(userId: string) {
-    return this.firestoreService.get<User>(`users/${userId}`);
-  }
-
-  // Create or update a document
-  async createUser(userId: string, userData: User) {
-    await this.firestoreService.set(`users/${userId}`, userData);
-  }
-
-  // Update specific fields
-  async updateUser(userId: string, updates: Partial<User>) {
-    await this.firestoreService.update(`users/${userId}`, updates);
-  }
-
-  // Delete a document
-  async deleteUser(userId: string) {
-    await this.firestoreService.delete(`users/${userId}`);
-  }
-
-  // Add a document with auto-generated ID
-  async addUser(userData: User) {
-    return this.firestoreService.add('users', userData);
-  }
-
-  // Query documents
-  async getActiveUsers() {
-    return this.firestoreService.query<User>('users', 
-      (q) => q.where('status', '==', 'active')
-    );
-  }
-}
-```
-
-## Available Methods
-
-| Method | Description | Documentation |
-|--------|-------------|---------------|
-| `collection<T>(path)` | Gets a reference to a collection | [Firestore Collections](https://firebase.google.com/docs/firestore/manage-data/structure-data) |
-| `doc<T>(path)` | Gets a reference to a document | [Firestore Documents](https://firebase.google.com/docs/firestore/manage-data/structure-data) |
-| `get<T>(path)` | Retrieves a document's data | [Read Data](https://firebase.google.com/docs/firestore/query-data/get-data) |
-| `set<T>(path, data, options?)` | Sets a document's data | [Set Data](https://firebase.google.com/docs/firestore/manage-data/add-data) |
-| `update<T>(path, data)` | Updates specific fields | [Update Data](https://firebase.google.com/docs/firestore/manage-data/add-data#update-data) |
-| `delete(path)` | Deletes a document | [Delete Data](https://firebase.google.com/docs/firestore/manage-data/delete-data) |
-| `add<T>(path, data)` | Adds a document with auto-generated ID | [Add Data](https://firebase.google.com/docs/firestore/manage-data/add-data) |
-| `query<T>(path, ...constraints)` | Queries a collection | [Query Data](https://firebase.google.com/docs/firestore/query-data/queries) |

package/docs/services/messaging-service.md

@@ -1,84 +0,0 @@
-# Messaging Service
-
-The `MessagingService` provides a clean and type-safe interface for sending messages through Firebase Cloud Messaging (FCM). This service is automatically injected when you import the `AdminModule`.
-
-## Features
-
-- Send messages to individual devices
-- Send messages to multiple devices
-- Topic messaging and subscription management
-- Message customization per platform (Android, iOS, Web)
-- TypeScript type support
-
-## Usage Example
-
-```ts
-import { Injectable } from '@nestjs/common';
-import { MessagingService } from 'nestjs-firebase-admin';
-
-@Injectable()
-export class NotificationService {
-  constructor(private readonly messagingService: MessagingService) {}
-
-  // Send a message to a single device
-  async sendToDevice(deviceToken: string, title: string, body: string) {
-    return this.messagingService.sendToDevice(deviceToken, {
-      notification: {
-        title,
-        body,
-      },
-    });
-  }
-
-  // Send a message to multiple devices
-  async sendToDevices(deviceTokens: string[], title: string, body: string) {
-    return this.messagingService.sendToDevices(deviceTokens, {
-      notification: {
-        title,
-        body,
-      },
-    });
-  }
-
-  // Send a message to a topic
-  async sendToTopic(topic: string, title: string, body: string) {
-    return this.messagingService.sendToTopic(topic, {
-      notification: {
-        title,
-        body,
-      },
-    });
-  }
-
-  // Subscribe devices to a topic
-  async subscribeToTopic(topic: string, deviceTokens: string[]) {
-    return this.messagingService.subscribeToTopic(deviceTokens, topic);
-  }
-
-  // Unsubscribe devices from a topic
-  async unsubscribeFromTopic(topic: string, deviceTokens: string[]) {
-    return this.messagingService.unsubscribeFromTopic(deviceTokens, topic);
-  }
-}
-```
-
-## Available Methods
-
-| Method | Description | Documentation |
-|--------|-------------|---------------|
-| `sendToDevice(token, payload)` | Sends a message to a single device | [Send Messages](https://firebase.google.com/docs/cloud-messaging/send-message) |
-| `sendToDevices(tokens, payload)` | Sends a message to multiple devices | [Send Multicast](https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-to-multiple-devices) |
-| `sendToTopic(topic, payload)` | Sends a message to a topic | [Topic Messaging](https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-to-topics) |
-| `subscribeToTopic(tokens, topic)` | Subscribes devices to a topic | [Topic Management](https://firebase.google.com/docs/cloud-messaging/manage-topics) |
-| `unsubscribeFromTopic(tokens, topic)` | Unsubscribes devices from a topic | [Topic Management](https://firebase.google.com/docs/cloud-messaging/manage-topics) |
-
-## Message Types
-
-The service supports various message types:
-
-- **Notification Messages**: Simple messages with title and body
-- **Data Messages**: Custom key-value pairs
-- **Combined Messages**: Both notification and data
-- **Android Messages**: Android-specific configurations (priority, TTL, channel)
-- **APNS Messages**: iOS-specific configurations (sound, badge, alert)
-- **Webpush Messages**: Web-specific configurations (headers, icons, actions)

package/docs/testing.md

@@ -1,67 +0,0 @@
-# Testing
-
-This document provides instructions on how to run tests for the `nestjs-firebase-admin` project.
-
-## Prerequisites
-
-Ensure you have the following installed:
-
-- **Node.js**: >= 20
-- **NPM**: >= 10
-
-Install the dependencies:
-
-```bash
-npm install
-```
-
-## Running Tests
-
-### Unit Tests
-
-To run unit tests, use the following command:
-
-```bash
-npm test
-```
-
-### Coverage Tests
-
-To generate a code coverage report, run:
-
-```bash
-npm run test:cov
-```
-
-The coverage report will be available in the `coverage/` directory.
-
-### Watch Mode Tests
-
-To run tests in watch mode, use:
-
-```bash
-npm run test:watch
-```
-
-### Debug Tests
-
-To debug tests, use:
-
-```bash
-npm run test:debug
-```
-
-## Testing Tools
-
-This project uses the following tools for testing:
-
-- **Jest**: A JavaScript testing framework.
-- **@nestjs/testing**: Utilities for testing NestJS applications.
-
-## Mocking
-
-Mock implementations are provided for Firebase services to ensure tests do not make actual calls to Firebase. These mocks are located in the `lib/tests/mocks/` directory.
-
-## Continuous Integration
-
-Tests are automatically run in CI pipelines using GitHub Actions. Refer to the respective configuration files for more details.

package/index.html

@@ -1,107 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-<head>
-    <meta charset="UTF-8">
-    <title>NestJS Firebase Admin — Firebase Admin SDK module for NestJS</title>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
-
-    <!-- SEO -->
-    <meta name="description"
-        content="NestJS Firebase Admin is a NestJS module that wraps the Firebase Admin SDK, providing injectable services for Auth, Firestore, Realtime Database, and Cloud Messaging in your NestJS applications.">
-    <meta name="keywords"
-        content="NestJS, Firebase, Admin SDK, NestJS module, Firebase Auth, Firestore, Realtime Database, Cloud Messaging, FCM, TypeScript, Node.js, serverless, backend, nestjs-firebase-admin">
-    <meta name="author" content="Hebert Cisco">
-    <meta name="robots" content="index, follow">
-    <link rel="canonical" href="https://hebertcisco.github.io/nestjs-firebase-admin/" />
-
-    <!-- Open Graph -->
-    <meta property="og:type" content="website" />
-    <meta property="og:title" content="NestJS Firebase Admin — Firebase Admin SDK module for NestJS" />
-    <meta property="og:description"
-        content="Injectable NestJS services for Firebase Auth, Firestore, Realtime Database, and Cloud Messaging. TypeScript-first with sync and async module registration." />
-    <meta property="og:url" content="https://hebertcisco.github.io/nestjs-firebase-admin/" />
-    <meta property="og:image"
-        content="https://raw.githubusercontent.com/hebertcisco/nestjs-firebase-admin/refs/heads/main/art/logo.png" />
-    <meta property="og:site_name" content="nestjs-firebase-admin" />
-
-    <!-- Twitter Card -->
-    <meta name="twitter:card" content="summary" />
-    <meta name="twitter:title" content="NestJS Firebase Admin — Firebase Admin SDK module for NestJS" />
-    <meta name="twitter:description"
-        content="Injectable NestJS services for Firebase Auth, Firestore, Realtime Database, and Cloud Messaging." />
-    <meta name="twitter:image"
-        content="https://raw.githubusercontent.com/hebertcisco/nestjs-firebase-admin/refs/heads/main/art/logo.png" />
-
-    <!-- Theme -->
-    <meta name="theme-color" content="#1E2830">
-    <link rel="icon" type="image/png"
-        href="https://raw.githubusercontent.com/hebertcisco/nestjs-firebase-admin/refs/heads/main/art/logo.png" />
-    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
-
-    <!-- Structured Data (JSON-LD) -->
-    <script type="application/ld+json">
-    {
-        "@context": "https://schema.org",
-        "@type": "SoftwareSourceCode",
-        "name": "nestjs-firebase-admin",
-        "description": "NestJS module that wraps the Firebase Admin SDK, providing injectable services for Auth, Firestore, Realtime Database, and Cloud Messaging.",
-        "url": "https://hebertcisco.github.io/nestjs-firebase-admin/",
-        "codeRepository": "https://github.com/hebertcisco/nestjs-firebase-admin",
-        "programmingLanguage": "TypeScript",
-        "runtimePlatform": "Node.js",
-        "license": "https://opensource.org/licenses/MIT",
-        "author": {
-            "@type": "Person",
-            "name": "Hebert Cisco",
-            "url": "https://github.com/hebertcisco"
-        },
-        "keywords": ["NestJS", "Firebase", "Admin SDK", "Firestore", "Auth", "Cloud Messaging", "TypeScript"]
-    }
-    </script>
-</head>
-
-<body>
-    <div id="app"></div>
-    <script>
-        window.$docsify = {
-            name: 'NestJS Firebase Admin',
-            nameLink: '/',
-            repo: 'hebertcisco/nestjs-firebase-admin',
-            coverpage: '_coverpage.md',
-            loadSidebar: 'docs/_sidebar.md',
-            auto2top: true,
-            subMaxLevel: 3,
-            maxLevel: 3,
-            themeColor: '#1E2830',
-            noCompileLinks: ['benchmarks/.*'],
-            externalLinkTarget: '_blank',
-            search: {
-                placeholder: 'Search documentation...',
-                maxAge: 86400000,
-                paths: 'auto',
-                noData: 'No results found!',
-                depth: 6
-            },
-            pagination: {
-                previousText: 'Previous',
-                nextText: 'Next',
-                crossChapter: true,
-                crossChapterText: true
-            },
-            plugins: [
-                function (hook, vm) {
-                    hook.beforeEach(function (content) {
-                        return content + '\n\n---\n\nLast updated: {docsify-updated}';
-                    });
-                }
-            ]
-        }
-    </script>
-    <script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
-    <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
-    <script src="https://cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
-</body>
-
-</html>

package/llms.txt

@@ -1,68 +0,0 @@
-# nestjs-firebase-admin
-
-> Firebase Admin SDK module for NestJS
-
-nestjs-firebase-admin is a NestJS module that wraps the Firebase Admin SDK into injectable, testable services. It supports NestJS 7-11 and Firebase Admin 13+.
-
-## Install
-
-```bash
-npm i nestjs-firebase-admin --save
-```
-
-## Quick start
-
-```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 AppModule {}
-```
-
-Use `AdminModule.registerAsync()` with `useFactory`, `useClass`, or `useExisting` for dynamic configuration (e.g. from `ConfigService`).
-
-## Services
-
-After importing `AdminModule`, inject any of these services:
-
-- **AdminService** — Firebase app initialization, lifecycle management, credential access.
-- **AuthService** — User management: create, update, delete, verify ID tokens, manage custom claims.
-- **DatabaseService** — Firebase Realtime Database: read, write, push, update, remove, and listen to refs.
-- **FirestoreService** — Cloud Firestore: typed CRUD, collection queries, batch writes, transactions.
-- **MessagingService** — Firebase Cloud Messaging: send to device tokens, topics, conditions; manage topic subscriptions.
-
-## Requirements
-
-- Node.js >= 20
-- NestJS >= 7.0.0
-- firebase-admin >= 13.0.0
-
-## Links
-
-- Docs: https://hebertcisco.github.io/nestjs-firebase-admin/
-- Repository: https://github.com/hebertcisco/nestjs-firebase-admin
-- npm: https://www.npmjs.com/package/nestjs-firebase-admin
-- Issues: https://github.com/hebertcisco/nestjs-firebase-admin/issues
-
-## Detailed docs
-
-- [Getting started](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/getting-started)
-- [Admin Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/admin-service)
-- [Auth Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/auth-service)
-- [Database Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/database-service)
-- [Firestore Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/firestore-service)
-- [Messaging Service](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/messaging-service)
-- [Testing](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/testing)
-- [Contributing](https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/contributing)

package/robots.txt

@@ -1,4 +0,0 @@
-User-agent: *
-Allow: /
-
-Sitemap: https://hebertcisco.github.io/nestjs-firebase-admin/sitemap.xml

package/sitemap.xml

@@ -1,48 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/</loc>
-    <changefreq>weekly</changefreq>
-    <priority>1.0</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/getting-started</loc>
-    <changefreq>weekly</changefreq>
-    <priority>0.9</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/admin-service</loc>
-    <changefreq>monthly</changefreq>
-    <priority>0.8</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/auth-service</loc>
-    <changefreq>monthly</changefreq>
-    <priority>0.8</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/database-service</loc>
-    <changefreq>monthly</changefreq>
-    <priority>0.8</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/firestore-service</loc>
-    <changefreq>monthly</changefreq>
-    <priority>0.8</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/services/messaging-service</loc>
-    <changefreq>monthly</changefreq>
-    <priority>0.8</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/testing</loc>
-    <changefreq>monthly</changefreq>
-    <priority>0.6</priority>
-  </url>
-  <url>
-    <loc>https://hebertcisco.github.io/nestjs-firebase-admin/#/docs/contributing</loc>
-    <changefreq>monthly</changefreq>
-    <priority>0.5</priority>
-  </url>
-</urlset>

package/tsconfig.build.json

@@ -1,4 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "__tests__", "dist", "**/*spec.ts"]
-}