\n\nThis project helps you to use your Firestore collections in a well known way,\nsimilar\\* to how TypeORM lets you to handle your tables.\n\nThe principal benefits are:\n\n- Model your collections using classes (similar on how ORMs works).\n- Simplify the testing of the Firestore SDK.\n\n_\\*This is NOT an ORM._\n\n## Installation\n\nIn order to install this package simply run the following command.\n\n```bash\nnpm install @cristobalgvera/nestjs-firestore\n```\n\n## Usage\n\nThe simplest way to use it is the following:\n\n1. Import the `FirestoreModule#forRoot` into your main module.\n\n ```ts\n import { FirestoreModule } from '@cristobalgvera/nestjs-firestore';\n import { Module } from '@nestjs/common';\n\n @Module({\n imports: [\n FirestoreModule.forRootAsync({\n useFactory: (environmentService: EnvironmentService) => ({\n // You can define custom properties here, see https://github.com/googleapis/nodejs-firestore\n projectId: 'firebase-project-id',\n }),\n }),\n ],\n })\n export class AppModule {}\n ```\n\n1. Define your model (currently only classes are supported).\n\n ```ts\n export class User {\n name: string;\n age: number;\n }\n ```\n\n1. Import the `FirestoreModule#forFeature` into your feature module.\n\n ```ts\n import { FirestoreModule } from '@cristobalgvera/nestjs-firestore';\n import { Module } from '@nestjs/common';\n import { User } from './user.collection';\n\n @Module({\n imports: [\n FirestoreModule.forFeature([\n { collection: User, path: 'path-to-your-collection' },\n ]),\n ],\n })\n export class UserModule {}\n ```\n\n1. Inject the collection into your services using the `InjectCollection` decorator\n and the `FirestoreCollection` type. The `FirestoreCollection` needs a generic\n class (soon type or interface too) in order to type your collection.\n\n The `FirestoreCollection` is a wrapper on top of the `CollectionReference` type\n provided by `@google-cloud/firestore`, so you can use the entire API, but it\n will provide correct typing based in the collection class.\n\n ```ts\n import {\n FirestoreCollection,\n InjectCollection,\n } from '@cristobalgvera/nestjs-firestore';\n import { Injectable } from '@nestjs/common';\n import { User } from './user.collection';\n\n @Injectable()\n export class UserService {\n constructor(\n @InjectCollection(User)\n private readonly userCollection: FirestoreCollection,\n ) {}\n\n saveUser({ name, age }: SaveUserDto) {\n return this.userCollection.add({ name, age });\n }\n }\n ```\n\n1. Test it using the `getCollectionToken` to get the token used to inject the collection\n in the service.\n\n ```ts\n import { TestBed } from '@automock/jest';\n import {\n FirestoreCollection,\n getCollectionToken,\n } from '@cristobalgvera/nestjs-firestore';\n import { User } from './user.collection';\n import { UserService } from './user.service';\n\n describe('UserService', () => {\n let underTest: UserService;\n let userCollection: FirestoreCollection;\n\n beforeEach(() => {\n // Don't focus on how to create the context of the test\n const { unit, unitRef } = TestBed.create(UserService).compile();\n underTest = unit;\n\n userCollection = unitRef.get(getCollectionToken(User)); // <-- THIS IS THE IMPORTANT PART\n });\n\n /* Your tests here... */\n });\n ```\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n \n