FirestoreCrudLib

Esta biblioteca simplifica operações CRUD (Create, Read, Update, Delete) em uma coleção do Firestore para projetos Angular.

OpenSource: Repositório GitHub

Começando

Para começar, instale o pacote @angular/fire em sua aplicação Angular usando o comando ng add @angular/fire.

No seu arquivo app.module.ts, certifique-se de importar e configurar o AngularFireModule corretamente:

1@NgModule({
2  declarations: [AppComponent],
3  imports: [BrowserModule, RouterModule.forRoot(routes), AngularFireModule.initializeApp(environment.firebaseConfig)],
4  providers: [provideFirestore(() => getFirestore())],
5  bootstrap: [AppComponent],
6})
7export class AppModule {}

Após essa configuração inicial, você pode criar suas interfaces e serviços exetendendo FirestoreCrudService conforme necessário. Por exemplo:

Para instanciar a classe é necessário chamar o construtor dela através do super() enviando os seguintes parametros:

@param {string} dbPath O caminho da coleção no Firestore.

@param {AngularFirestore} db Uma instância do AngularFirestore.

1import { Injectable } from "@angular/core";
2import { AngularFirestore } from "@angular/fire/compat/firestore";
3import { FirestoreCrudService } from "firestore-crud-lib";
4import { User } from "../models/user.model";
5
6interface User {
7  id: string;
8  nome: string;
9  login: string;
10  photoUrl?: string;
11}
12
13@Injectable()
14export class UserService extends FirestoreCrudService<User> {
15  constructor(db: AngularFirestore) {
16    super("users", db);
17  }
18}

Métodos disponíveis

A classe FirestoreCrudService fornece métodos úteis para realizar operações CRUD (Create, Read, Update, Delete) em uma coleção do Firestore.

listAll()

Método para obter todos os documentos da coleção.

1listAll(): Observable<T[]>

Retorna um Observable que emite uma matriz de documentos da coleção.

---

getById(id: string)

Método para obter um documento pelo seu ID.

1getById(id: string): Observable<T>

Parâmetros:

id: O ID do documento a ser obtido. Retorna um Observable que emite o documento encontrado.

---

create(value: T, id?: string)

Método para criar um novo documento na coleção.

1create(value: T, id?: string): Observable<T>

Parâmetros:

value: O valor do documento a ser criado. id (opcional): O ID do documento. Se não fornecido, um ID será gerado automaticamente. Retorna um Observable que emite o documento criado.

---

update(id: string, value: T)

Método para atualizar um documento existente na coleção.

1update(id: string, value: T): Observable<string>

Parâmetros:

id: O ID do documento a ser atualizado. value: O novo valor do documento. Retorna um Observable que emite uma mensagem de sucesso ou erro.

---

delete(id: string)

Método para excluir um documento da coleção.

1delete(id: string): Observable<string>

Parâmetros:

id: O ID do documento a ser excluído. Retorna um Observable que emite uma mensagem de sucesso ou erro.

Exemplo de uso:

1import { Component } from "@angular/core";
2import { UserService } from "./services/user.service";
3
4@Component({
5  selector: "app-root",
6  templateUrl: "./app.component.html",
7  providers: [UserService],
8})
9export class AppComponent {
10  constructor(private userService: UserService) {}
11  ngOnInit(): void {
12    this.userService.listAll().subscribe((users) => {
13      console.log(users);
14    });
15  }
16}