feat: add firestore module connection

package.json

@@ -21,6 +21,7 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
+    "@google-cloud/firestore": "^7.9.0",
     "@nestjs/common": "^10.0.0",
     "@nestjs/config": "^3.2.3",
     "@nestjs/core": "^10.0.0",

src/app.module.ts

@@ -2,15 +2,23 @@ import { Module } from '@nestjs/common'
 
 import { AppController } from './app.controller'
 import { AppService } from './app.service'
-import { ConfigModule } from '@nestjs/config'
+import { ConfigModule, ConfigService } from '@nestjs/config'
 import { getEnvFile } from './env'
+import { FirestoreModule } from './providers'
 
 @Module({
   imports: [
     ConfigModule.forRoot({
       isGlobal: true,
       envFilePath: getEnvFile(),
     }),
+    FirestoreModule.forRoot({
+      imports: [ConfigModule],
+      useFactory: (configService: ConfigService) => ({
+        keyFilename: configService.get<string>('SA_KEY'),
+      }),
+      inject: [ConfigService],
+    }),
   ],
   controllers: [AppController],
   providers: [AppService],

src/providers/firestore/firestore.module.ts

@@ -0,0 +1,40 @@
+import { Firestore } from '@google-cloud/firestore'
+import { DynamicModule, Module } from '@nestjs/common'
+
+import {
+  FirestoreCollectionProviders,
+  FirestoreDatabaseProvider,
+  FirestoreOptionsProvider,
+} from './firestore.providers'
+import { FirestoreModuleOptions } from './types'
+
+@Module({})
+export class FirestoreModule {
+  static forRoot(options: FirestoreModuleOptions): DynamicModule {
+    const collectionProviders = FirestoreCollectionProviders.map((providerName) => ({
+      provide: providerName,
+      useFactory: (db) => db.collection(providerName),
+      inject: [FirestoreDatabaseProvider],
+    }))
+
+    const optionsProvider = {
+      provide: FirestoreOptionsProvider,
+      useFactory: options.useFactory,
+      inject: options.inject,
+    }
+
+    const dbProvider = {
+      provide: FirestoreDatabaseProvider,
+      useFactory: (config) => new Firestore(config),
+      inject: [FirestoreOptionsProvider],
+    }
+
+    return {
+      global: true,
+      module: FirestoreModule,
+      imports: options.imports,
+      providers: [optionsProvider, dbProvider, ...collectionProviders],
+      exports: [dbProvider, ...collectionProviders],
+    }
+  }
+}

src/providers/firestore/firestore.providers.ts

@@ -0,0 +1,3 @@
+export const FirestoreDatabaseProvider = 'firestoredb'
+export const FirestoreOptionsProvider = 'firestoreOptions'
+export const FirestoreCollectionProviders: string[] = []

src/providers/firestore/index.ts

@@ -0,0 +1 @@
+export * from './firestore.module'

src/providers/firestore/types.ts

@@ -0,0 +1,7 @@
+import { Settings } from '@google-cloud/firestore'
+
+export type FirestoreModuleOptions = {
+  imports: any[]
+  useFactory: (...args: any[]) => Settings
+  inject: any[]
+}

src/providers/index.ts

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