nestjs-firebase-admin 0.0.1

package/.commitlintrc.json

@@ -0,0 +1,28 @@
+{
+  "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

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

package/.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+    'prettier/@typescript-eslint',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+  },
+};

package/.release-it.json

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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hebert Cisco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+[![codecov](https://codecov.io/gh/hebertcisco/nestjs-firebase-admin/branch/master/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/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/hebertcisco/nestjs-firebase-admin/tree/master)
+
+[![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)
+
+> Firebase Admin SDK for Nestjs :fire:
+
+## Installation
+
+> Install with yarn or npm: `yarn` or `npm`:
+
+```bash
+# yarn
+yarn add nestjs-firebase-admin
+```
+
+```bash
+# npm
+npm i nestjs-firebase-admin --save
+```
+
+```bash
+# pnpm
+pnpm add nestjs-firebase-admin --save
+```
+
+### Usage example
+
+```ts
+// common.module.ts
+import { Module } from '@nestjs/common';
+
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { AdminModule } from 'nestjs-firebase-admin';
+
+import { CommonService } from './common.service';
+
+@Module({
+  imports: [
+    AdminModule.register({
+     credential: {
+        projectId: 'my-project-id',
+        clientEmail: 'my-client-email',
+        privateKey: 'my-private-key',
+      },
+      databaseURL: 'https://my-project-id.firebaseio.com',
+    }),
+  ],
+  providers: [CommonService],
+})
+export class CommonModule {}
+```
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](issues).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+Or buy me a coffee 🙌🏾
+
+<a href="https://www.buymeacoffee.com/hebertcisco">
+    <img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=hebertcisco&button_colour=FFDD00&font_colour=000000&font_family=Inter&outline_colour=000000&coffee_colour=ffffff" />
+</a>
+
+## 📝 License
+
+Copyright © 2022 [Hebert F Barros](https://github.com/hebertcisco).<br />
+This project is [MIT](LICENSE) licensed.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './modules/admin/admin.module';
+export * from './modules/admin/admin.service';
+export * from './modules/admin/interfaces';
+export * from './modules/admin/types';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./modules/admin/admin.module"), exports);
+__exportStar(require("./modules/admin/admin.service"), exports);
+__exportStar(require("./modules/admin/interfaces"), exports);
+__exportStar(require("./modules/admin/types"), exports);

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

@@ -0,0 +1,3 @@
+export declare const FIREBASE_ADMIN_INSTANCE_TOKEN = "FIREBASE_ADMIN_INSTANCE_TOKEN";
+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

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

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

@@ -0,0 +1,9 @@
+import { DynamicModule } from '@nestjs/common';
+import type { AdminModuleAsyncOptions } from './interfaces';
+import type { AdminModuleOptions } from './types';
+export declare class AdminModule {
+    static register(options: AdminModuleOptions): DynamicModule;
+    static registerAsync(options: AdminModuleAsyncOptions): DynamicModule;
+    private static createAsyncProviders;
+    private static createAsyncOptionsProvider;
+}

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

@@ -0,0 +1,92 @@
+"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 __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());
+    });
+};
+var AdminModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+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 admin_constants_1 = require("./admin.constants");
+const admin_service_1 = require("./admin.service");
+let AdminModule = AdminModule_1 = class AdminModule {
+    static register(options) {
+        return {
+            module: AdminModule_1,
+            providers: [
+                {
+                    provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
+                    useValue: options,
+                },
+                {
+                    provide: admin_constants_1.ADMIN_MODULE_ID,
+                    useValue: (0, random_string_generator_util_1.randomStringGenerator)(),
+                },
+            ],
+        };
+    }
+    static registerAsync(options) {
+        return {
+            module: AdminModule_1,
+            imports: options.imports,
+            providers: [
+                ...this.createAsyncProviders(options),
+                {
+                    provide: admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN,
+                    useFactory: (options) => options,
+                    inject: [admin_constants_1.ADMIN_MODULE_OPTIONS],
+                },
+                {
+                    provide: admin_constants_1.ADMIN_MODULE_ID,
+                    useValue: (0, random_string_generator_util_1.randomStringGenerator)(),
+                },
+                ...(options.extraProviders || []),
+            ],
+        };
+    }
+    static createAsyncProviders(options) {
+        if (options.useExisting || options.useFactory) {
+            return [this.createAsyncOptionsProvider(options)];
+        }
+        return [
+            this.createAsyncOptionsProvider(options),
+            {
+                provide: options.useClass,
+                useClass: options.useClass,
+            },
+        ];
+    }
+    static createAsyncOptionsProvider(options) {
+        if (options.useFactory) {
+            return {
+                provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+                useFactory: options.useFactory,
+                inject: options.inject || [],
+            };
+        }
+        return {
+            provide: admin_constants_1.ADMIN_MODULE_OPTIONS,
+            useFactory: (optionsFactory) => __awaiter(this, void 0, void 0, function* () { return optionsFactory.createAdminOptions(); }),
+            inject: [options.useExisting || options.useClass],
+        };
+    }
+};
+AdminModule = AdminModule_1 = __decorate([
+    (0, common_1.Module)({
+        providers: [admin_service_1.AdminService],
+        exports: [admin_service_1.AdminService],
+    })
+], AdminModule);
+exports.AdminModule = AdminModule;

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

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import { Observable } from 'rxjs';
+import type { App } from 'firebase-admin/app';
+import type { Agent } from 'node:http';
+import type { AdminModuleOptions } from './types';
+export declare class AdminService {
+    protected readonly options: AdminModuleOptions;
+    constructor(options: AdminModuleOptions);
+    applicationDefault(httpAgent?: Agent): import("firebase-admin/app").Credential;
+    deleteApp(app: App): Promise<void>;
+    get getApps(): App[];
+    get getApp(): App;
+    initializeApp(): App;
+    initializeAppObservable<T = App>(): Observable<App>;
+    get appRef(): App;
+}

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

@@ -0,0 +1,59 @@
+"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); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminService = void 0;
+const common_1 = require("@nestjs/common");
+const rxjs_1 = require("rxjs");
+const app_1 = require("firebase-admin/app");
+const admin_constants_1 = require("./admin.constants");
+let AdminService = class AdminService {
+    constructor(options) {
+        this.options = options;
+    }
+    applicationDefault(httpAgent) {
+        return (0, app_1.applicationDefault)(httpAgent);
+    }
+    deleteApp(app) {
+        return (0, app_1.deleteApp)(app);
+    }
+    get getApps() {
+        return (0, app_1.getApps)();
+    }
+    get getApp() {
+        return (0, app_1.getApp)();
+    }
+    initializeApp() {
+        return (0, app_1.initializeApp)(Object.assign({}, this.options));
+    }
+    initializeAppObservable() {
+        return new rxjs_1.Observable(subscriber => {
+            subscriber.next(this.appRef);
+            subscriber.complete();
+            return () => {
+                if (this.appRef.name) {
+                    return this.appRef;
+                }
+                return this.getApp;
+            };
+        });
+    }
+    get appRef() {
+        return this.initializeApp();
+    }
+};
+AdminService = __decorate([
+    __param(0, (0, common_1.Inject)(admin_constants_1.FIREBASE_ADMIN_INSTANCE_TOKEN)),
+    __metadata("design:paramtypes", [Object])
+], AdminService);
+exports.AdminService = AdminService;

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

@@ -0,0 +1,12 @@
+import { ModuleMetadata, Provider, Type } from '@nestjs/common';
+import { AdminModuleOptions } from '../types';
+export interface AdminModuleOptionsFactory {
+    createAdminOptions(): Promise<AdminModuleOptions> | AdminModuleOptions;
+}
+export interface AdminModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    useExisting?: Type<AdminModuleOptionsFactory>;
+    useClass?: Type<AdminModuleOptionsFactory>;
+    useFactory?: (...args: any[]) => Promise<AdminModuleOptions> | AdminModuleOptions;
+    inject?: any[];
+    extraProviders?: Provider[];
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/admin/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './admin-module.interface';

package/dist/modules/admin/interfaces/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./admin-module.interface"), exports);

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

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import type { Agent } from 'node:http';
+import type { Credential } from 'firebase-admin/app';
+export declare type AdminConfig = {
+    credential: Credential;
+    databaseURL?: string;
+    databaseAuthVariableOverride?: object | null;
+    serviceAccountId?: string;
+    storageBucket?: string;
+    projectId?: string;
+    httpAgent?: Agent;
+};
+export declare type AdminModuleOptions = AdminConfig;

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/admin/types/index.d.ts

@@ -0,0 +1 @@
+export * from './admin.type';

package/dist/modules/admin/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./admin.type"), exports);

package/index.d.ts

@@ -0,0 +1 @@
+export * from './dist';

package/index.js

@@ -0,0 +1,6 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+exports.__esModule = true;
+__export(require("./dist"));

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "nestjs-firebase-admin",
+  "version": "0.0.1",
+  "description": "Firebase Admin SDK for Nestjs",
+  "author": "Hebert Cisco",
+  "license": "MIT",
+  "url": "https://github.com/hebertcisco/nestjs-firebase-admin#readme",
+  "scripts": {
+    "build": "rimraf -rf dist && tsc -p tsconfig.json",
+    "format": "prettier --write \"{lib,test}/**/*.ts\"",
+    "lint": "eslint 'lib/**/*.ts' --fix",
+    "prepublish:npm": "npm run build",
+    "publish:npm": "npm publish --access public",
+    "prepublish:next": "npm run build",
+    "publish:next": "npm publish --access public --tag next",
+    "test:e2e": "jest --config ./tests/jest-e2e.json --runInBand",
+    "prerelease": "npm run build",
+    "release": "release-it",
+    "prepare": "npm run build",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand"
+  },
+  "dependencies": {
+    "axios": "0.27.2",
+    "firebase-admin": "^11.0.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "17.1.2",
+    "@commitlint/config-angular": "17.1.0",
+    "@nestjs/common": "8.4.7",
+    "@nestjs/core": "8.4.7",
+    "@nestjs/platform-express": "8.4.7",
+    "@nestjs/testing": "^8.4.7",
+    "@types/jest": "29.0.3",
+    "@types/node": "16.11.41",
+    "@typescript-eslint/eslint-plugin": "5.30.0",
+    "@typescript-eslint/parser": "5.30.0",
+    "eslint": "8.23.1",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "husky": "8.0.1",
+    "jest": "29.0.3",
+    "lint-staged": "13.0.3",
+    "prettier": "2.7.1",
+    "reflect-metadata": "0.1.13",
+    "release-it": "15.4.2",
+    "rimraf": "3.0.2",
+    "rxjs": "7.5.6",
+    "ts-jest": "29.0.1",
+    "typescript": "4.8.3"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^7.0.0 || ^8.0.0",
+    "reflect-metadata": "^0.1.12",
+    "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"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "lib",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}