nestjs-firebase-admin 0.3.5 → 0.4.5

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 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/interfaces';
 export * from './modules/admin/types';

package/dist/index.js

@@ -17,5 +17,6 @@ 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/interfaces"), exports);
 __exportStar(require("./modules/admin/types"), exports);

package/dist/modules/admin/admin.constants.d.ts

@@ -1,3 +1,4 @@
 export declare const FIREBASE_ADMIN_INSTANCE_TOKEN = "FIREBASE_ADMIN_INSTANCE_TOKEN";
+export declare const FIREBASE_ADMIN_APP = "FIREBASE_ADMIN_APP";
 export declare const ADMIN_MODULE_ID = "ADMIN_MODULE_ID";
 export declare const ADMIN_MODULE_OPTIONS = "ADMIN_MODULE_OPTIONS";

package/dist/modules/admin/admin.constants.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ADMIN_MODULE_OPTIONS = exports.ADMIN_MODULE_ID = exports.FIREBASE_ADMIN_INSTANCE_TOKEN = void 0;
+exports.ADMIN_MODULE_OPTIONS = exports.ADMIN_MODULE_ID = exports.FIREBASE_ADMIN_APP = exports.FIREBASE_ADMIN_INSTANCE_TOKEN = void 0;
 exports.FIREBASE_ADMIN_INSTANCE_TOKEN = 'FIREBASE_ADMIN_INSTANCE_TOKEN';
+exports.FIREBASE_ADMIN_APP = 'FIREBASE_ADMIN_APP';
 exports.ADMIN_MODULE_ID = 'ADMIN_MODULE_ID';
 exports.ADMIN_MODULE_OPTIONS = 'ADMIN_MODULE_OPTIONS';

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

@@ -26,18 +26,22 @@ 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");
 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: [
+                admin_service_1.AdminService,
+                database_service_1.DatabaseService,
+                messaging_service_1.MessagingService,
                 {
                     provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
                     useValue: options,
                 },
                 {
-                    provide: 'FIREBASE_ADMIN_APP',
+                    provide: admin_constants_1.FIREBASE_ADMIN_APP,
                     useValue: firebaseApp,
                 },
                 {
@@ -45,10 +49,25 @@ let AdminModule = AdminModule_1 = class AdminModule {
                     useValue: (0, random_string_generator_util_1.randomStringGenerator)(),
                 },
             ],
+            exports: [
+                admin_service_1.AdminService,
+                database_service_1.DatabaseService,
+                messaging_service_1.MessagingService,
+                admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
+                admin_constants_1.FIREBASE_ADMIN_APP,
+            ],
         };
     }
     static registerAsync(options) {
-        const providers = [];
+        const providers = [
+            admin_service_1.AdminService,
+            database_service_1.DatabaseService,
+            messaging_service_1.MessagingService,
+            {
+                provide: admin_constants_1.ADMIN_MODULE_ID,
+                useValue: (0, random_string_generator_util_1.randomStringGenerator)(),
+            },
+        ];
         if (options.useFactory) {
             const factory = options.useFactory;
             providers.push({
@@ -57,7 +76,7 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 inject: options.inject || [],
             });
             providers.push({
-                provide: 'FIREBASE_ADMIN_APP',
+                provide: admin_constants_1.FIREBASE_ADMIN_APP,
                 useFactory: (...args) => __awaiter(this, void 0, void 0, function* () {
                     const config = yield factory(...args);
                     return firebase_admin_1.default.initializeApp(Object.assign(Object.assign({}, config), { credential: firebase_admin_1.default.credential.cert(config.credential) }));
@@ -75,7 +94,7 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 inject: [options.useExisting],
             });
             providers.push({
-                provide: 'FIREBASE_ADMIN_APP',
+                provide: admin_constants_1.FIREBASE_ADMIN_APP,
                 useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () {
                     const config = yield optionsFactory.createAdminOptions();
                     return firebase_admin_1.default.initializeApp(Object.assign(Object.assign({}, config), { credential: firebase_admin_1.default.credential.cert(config.credential) }));
@@ -97,7 +116,7 @@ let AdminModule = AdminModule_1 = class AdminModule {
                 inject: [options.useClass],
             });
             providers.push({
-                provide: 'FIREBASE_ADMIN_APP',
+                provide: admin_constants_1.FIREBASE_ADMIN_APP,
                 useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () {
                     const config = yield optionsFactory.createAdminOptions();
                     return firebase_admin_1.default.initializeApp(Object.assign(Object.assign({}, config), { credential: firebase_admin_1.default.credential.cert(config.credential) }));
@@ -112,14 +131,28 @@ let AdminModule = AdminModule_1 = class AdminModule {
             module: AdminModule_1,
             imports: options.imports,
             providers,
-            exports: [admin_service_1.AdminService],
+            exports: [
+                admin_service_1.AdminService,
+                database_service_1.DatabaseService,
+                messaging_service_1.MessagingService,
+                admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
+                admin_constants_1.FIREBASE_ADMIN_APP,
+            ],
         };
     }
 };
 exports.AdminModule = AdminModule;
 exports.AdminModule = AdminModule = AdminModule_1 = __decorate([
     (0, common_1.Module)({
-        providers: [admin_service_1.AdminService, database_service_1.DatabaseService],
-        exports: [admin_service_1.AdminService, database_service_1.DatabaseService],
+        providers: [
+            admin_service_1.AdminService,
+            database_service_1.DatabaseService,
+            messaging_service_1.MessagingService,
+            {
+                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],
     })
 ], AdminModule);

package/dist/modules/admin/messaging.service.d.ts

@@ -0,0 +1,105 @@
+import { App } from 'firebase-admin/app';
+import { Messaging, Message, MulticastMessage, TopicMessage } from 'firebase-admin/messaging';
+interface AppWithMessaging extends App {
+    messaging(): Messaging;
+}
+export declare class MessagingService {
+    private readonly app;
+    private readonly messaging;
+    constructor(app: AppWithMessaging);
+    sendToDevice(token: string, payload: Partial<Message>): Promise<string>;
+    sendToDevices(tokens: string[], payload: Partial<MulticastMessage>): Promise<MessagingBatchResponse>;
+    sendToTopic(topic: string, payload: Partial<TopicMessage>): Promise<string>;
+    subscribeToTopic(tokens: string[], topic: string): Promise<MessagingTopicManagementResponse>;
+    unsubscribeFromTopic(tokens: string[], topic: string): Promise<MessagingTopicManagementResponse>;
+}
+export interface MessagingPayload {
+    notification?: {
+        title?: string;
+        body?: string;
+        imageUrl?: string;
+    };
+    data?: {
+        [key: string]: string;
+    };
+    android?: {
+        priority?: 'high' | 'normal';
+        ttl?: number;
+        notification?: {
+            channelId?: string;
+            clickAction?: string;
+            color?: string;
+            icon?: string;
+            sound?: string;
+            tag?: string;
+            title?: string;
+            body?: string;
+        };
+    };
+    apns?: {
+        payload?: {
+            aps?: {
+                alert?: {
+                    title?: string;
+                    body?: string;
+                };
+                sound?: string;
+                badge?: number;
+            };
+        };
+        headers?: {
+            [key: string]: string;
+        };
+    };
+    webpush?: {
+        headers?: {
+            [key: string]: string;
+        };
+        notification?: {
+            title?: string;
+            body?: string;
+            icon?: string;
+            badge?: string;
+            data?: {
+                [key: string]: string;
+            };
+            actions?: Array<{
+                action: string;
+                title: string;
+                icon?: string;
+            }>;
+        };
+    };
+}
+export type MessagingMessage = {
+    token: string;
+} & MessagingPayload;
+export type MessagingMulticastMessage = {
+    tokens: string[];
+} & MessagingPayload;
+export type MessagingTopicMessage = {
+    topic: string;
+} & MessagingPayload;
+export type MessagingBatchResponse = {
+    successCount: number;
+    failureCount: number;
+    responses: Array<{
+        messageId?: string;
+        error?: {
+            code: string;
+            message: string;
+        };
+    }>;
+};
+export type MessagingTopicManagementResponse = {
+    successCount: number;
+    failureCount: number;
+    errors: Array<{
+        index: number;
+        error: {
+            code: string;
+            message: string;
+        };
+    }>;
+};
+export {};

package/dist/modules/admin/messaging.service.js

@@ -0,0 +1,71 @@
+"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.MessagingService = void 0;
+const common_1 = require("@nestjs/common");
+const admin_constants_1 = require("./admin.constants");
+let MessagingService = class MessagingService {
+    constructor(app) {
+        this.app = app;
+        this.messaging = this.app.messaging();
+    }
+    sendToDevice(token, payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const message = Object.assign({ token }, payload);
+            const response = yield this.messaging.send(message);
+            return response;
+        });
+    }
+    sendToDevices(tokens, payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const message = Object.assign({ tokens }, payload);
+            const response = yield this.messaging.sendMulticast(message);
+            return response;
+        });
+    }
+    sendToTopic(topic, payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const message = Object.assign({ topic }, payload);
+            const response = yield this.messaging.send(message);
+            return response;
+        });
+    }
+    subscribeToTopic(tokens, topic) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.messaging.subscribeToTopic(tokens, topic);
+            return response;
+        });
+    }
+    unsubscribeFromTopic(tokens, topic) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.messaging.unsubscribeFromTopic(tokens, topic);
+            return response;
+        });
+    }
+};
+exports.MessagingService = MessagingService;
+exports.MessagingService = MessagingService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(admin_constants_1.FIREBASE_ADMIN_APP)),
+    __metadata("design:paramtypes", [Object])
+], MessagingService);

package/dist/modules/admin/messaging.service.spec.d.ts

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

package/dist/modules/admin/messaging.service.spec.js

@@ -0,0 +1,148 @@
+"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 });
+const testing_1 = require("@nestjs/testing");
+const messaging_service_1 = require("./messaging.service");
+const admin_constants_1 = require("./admin.constants");
+jest.mock('firebase-admin/messaging', () => {
+    return {
+        Messaging: jest.fn().mockImplementation(() => ({
+            send: jest.fn().mockResolvedValue('message-id'),
+            sendMulticast: jest.fn().mockResolvedValue({
+                successCount: 1,
+                failureCount: 0,
+                responses: [{ messageId: 'message-id' }],
+            }),
+            subscribeToTopic: jest.fn().mockResolvedValue({
+                successCount: 1,
+                failureCount: 0,
+                errors: [],
+            }),
+            unsubscribeFromTopic: jest.fn().mockResolvedValue({
+                successCount: 1,
+                failureCount: 0,
+                errors: [],
+            }),
+        })),
+    };
+});
+describe('MessagingService', () => {
+    let service;
+    let mockMessaging;
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        const mockApp = {
+            messaging: jest.fn().mockReturnValue({
+                send: jest.fn().mockResolvedValue('message-id'),
+                sendMulticast: jest.fn().mockResolvedValue({
+                    successCount: 1,
+                    failureCount: 0,
+                    responses: [{ messageId: 'message-id' }],
+                }),
+                subscribeToTopic: jest.fn().mockResolvedValue({
+                    successCount: 1,
+                    failureCount: 0,
+                    errors: [],
+                }),
+                unsubscribeFromTopic: jest.fn().mockResolvedValue({
+                    successCount: 1,
+                    failureCount: 0,
+                    errors: [],
+                }),
+            }),
+        };
+        const module = yield testing_1.Test.createTestingModule({
+            providers: [
+                messaging_service_1.MessagingService,
+                {
+                    provide: admin_constants_1.FIREBASE_ADMIN_APP,
+                    useValue: mockApp,
+                },
+            ],
+        }).compile();
+        service = module.get(messaging_service_1.MessagingService);
+        mockMessaging = mockApp.messaging();
+    }));
+    it('should be defined', () => {
+        expect(service).toBeDefined();
+    });
+    describe('sendToDevice', () => {
+        it('should send a message to a single device', () => __awaiter(void 0, void 0, void 0, function* () {
+            const token = 'device-token';
+            const payload = {
+                notification: {
+                    title: 'Test Title',
+                    body: 'Test Body',
+                },
+            };
+            const result = yield service.sendToDevice(token, payload);
+            expect(result).toBe('message-id');
+            expect(mockMessaging.send).toHaveBeenCalledWith(Object.assign({ token }, payload));
+        }));
+    });
+    describe('sendToDevices', () => {
+        it('should send a message to multiple devices', () => __awaiter(void 0, void 0, void 0, function* () {
+            const tokens = ['token1', 'token2'];
+            const payload = {
+                notification: {
+                    title: 'Test Title',
+                    body: 'Test Body',
+                },
+            };
+            const result = yield service.sendToDevices(tokens, payload);
+            expect(result).toEqual({
+                successCount: 1,
+                failureCount: 0,
+                responses: [{ messageId: 'message-id' }],
+            });
+            expect(mockMessaging.sendMulticast).toHaveBeenCalledWith(Object.assign({ tokens }, payload));
+        }));
+    });
+    describe('sendToTopic', () => {
+        it('should send a message to a topic', () => __awaiter(void 0, void 0, void 0, function* () {
+            const topic = 'test-topic';
+            const payload = {
+                notification: {
+                    title: 'Test Title',
+                    body: 'Test Body',
+                },
+            };
+            const result = yield service.sendToTopic(topic, payload);
+            expect(result).toBe('message-id');
+            expect(mockMessaging.send).toHaveBeenCalledWith(Object.assign({ topic }, payload));
+        }));
+    });
+    describe('subscribeToTopic', () => {
+        it('should subscribe devices to a topic', () => __awaiter(void 0, void 0, void 0, function* () {
+            const tokens = ['token1', 'token2'];
+            const topic = 'test-topic';
+            const result = yield service.subscribeToTopic(tokens, topic);
+            expect(result).toEqual({
+                successCount: 1,
+                failureCount: 0,
+                errors: [],
+            });
+            expect(mockMessaging.subscribeToTopic).toHaveBeenCalledWith(tokens, topic);
+        }));
+    });
+    describe('unsubscribeFromTopic', () => {
+        it('should unsubscribe devices from a topic', () => __awaiter(void 0, void 0, void 0, function* () {
+            const tokens = ['token1', 'token2'];
+            const topic = 'test-topic';
+            const result = yield service.unsubscribeFromTopic(tokens, topic);
+            expect(result).toEqual({
+                successCount: 1,
+                failureCount: 0,
+                errors: [],
+            });
+            expect(mockMessaging.unsubscribeFromTopic).toHaveBeenCalledWith(tokens, topic);
+        }));
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-firebase-admin",
-  "version": "0.3.5",
+  "version": "0.4.5",
   "description": "Firebase Admin SDK for Nestjs",
   "author": "Hebert Cisco",
   "license": "MIT",