@roar-firebase-functions/core

@roar-firebase-functions/core / FirestoreAdministrationRepository

Class: FirestoreAdministrationRepository

Defined in: packages/core/src/repositories/firestore/FirestoreAdministrationRepository.repository.firestore.ts:19

The AdministrationRepository class is used to interact with the Firestore Administrations collection. AdministrationRepository

Throws

AdministrationRepositoryError - Thrown if an error occurs.

See

FirestoreBaseRepository

Extends

Implements

Constructors

Constructor

new FirestoreAdministrationRepository(): FirestoreAdministrationRepository

Defined in: packages/core/src/repositories/firestore/FirestoreAdministrationRepository.repository.firestore.ts:23

Returns

FirestoreAdministrationRepository

Overrides

FirestoreBaseRepository.constructor

Properties

collection

protected collection: CollectionReference

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:46

Collection reference

Inherited from

FirestoreBaseRepository.collection

collectionGroup

protected collectionGroup: CollectionGroup

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:47

Collection group reference {getCollectionName} - Get collection reference {getCollectionGroupName} - Get collection group reference {getCollectionType} - Get collection type {get} - Get document by ID or with filters {getById} - Get document by ID, helper function for get() {fetchDocument} - Fetch document, helper function for getById() and getWithFilters() {getAll} - Get all documents {runTransaction} - Run transaction {create} - Create document {update} - Update document {delete} - Delete document {getWithFilters} - Get documents with filters, helper function for get()

Inherited from

FirestoreBaseRepository.collectionGroup

collectionType

protected collectionType: CollectionType

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:48

Inherited from

FirestoreBaseRepository.collectionType

filterAdapter

protected filterAdapter: FirestoreFilterAdapter

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:49

Inherited from

FirestoreBaseRepository.filterAdapter

Methods

create()

create(params): Promise<Result<Administration>>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:229

Creates a new entity in the repository.

Parameters

params

FirestoreCreateParams

CreateParams

Returns

Promise<Result<Administration>>

  • Document data or null

Throws

  • Error creating document

Implementation of

AdministrationBaseRepository.create

Inherited from

FirestoreBaseRepository.create

delete()

delete(params): Promise<void>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:280

Deletes an entity from the repository.

Parameters

params

FirestoreDeleteParams

DeleteParams

Returns

Promise<void>

Throws

  • Error deleting document

Implementation of

AdministrationBaseRepository.delete

Inherited from

FirestoreBaseRepository.delete

fetchDocument()

fetchDocument(params): Promise<Result<Administration>>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:178

Helper function to fetch a document fetchDocument

Parameters

params

FirestoreFetchDocumentParams

FetchDocumentParams

Returns

Promise<Result<Administration>>

  • Document data or null

Throws

  • Error fetching document

Inherited from

FirestoreBaseRepository.fetchDocument

get()

Get document(s) based on parameters

  • If id is provided, returns a single document
  • If filters are provided, returns multiple documents that match the filters
  • Requires either id or filters to be specified

Param

Parameters for retrieving documents

Param

Document ID for single document retrieval

Param

Array of filters for querying documents

Param

Maximum number of documents to return (for filtered queries)

Param

Fields to include in the result

Param

Firestore transaction

Throws

If neither ID nor filters are provided

Call Signature

get(params): Promise<Result<Administration>>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:94

Get document by ID get

Parameters
params

FirestoreGetParams & object

GetParams with ID

Returns

Promise<Result<Administration>>

  • Single document or array of documents
Param

Parameters for retrieving documents

Param

Document ID for single document retrieval

Param

Array of filters for querying documents

Param

Maximum number of documents to return (for filtered queries)

Param

Fields to include in the result

Param

Firestore transaction

Throws

If neither ID nor filters are provided

Implementation of

AdministrationBaseRepository.get

Inherited from

FirestoreBaseRepository.get

Call Signature

get(params): Promise<Result<Administration>[]>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:102

Get documents by filters get

Parameters
params

FirestoreGetParams & object

GetParams with filters

Returns

Promise<Result<Administration>[]>

  • Single document or array of documents
Param

Parameters for retrieving documents

Param

Document ID for single document retrieval

Param

Array of filters for querying documents

Param

Maximum number of documents to return (for filtered queries)

Param

Fields to include in the result

Param

Firestore transaction

Throws

If neither ID nor filters are provided

Implementation of

AdministrationBaseRepository.get

Inherited from

FirestoreBaseRepository.get

getAll()

getAll(): Promise<Result<Administration>[]>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:204

Retrieves all entities with optional filtering.

Returns

Promise<Result<Administration>[]>

  • Array of document data

Throws

  • Error getting all documents

Implementation of

AdministrationBaseRepository.getAll

Inherited from

FirestoreBaseRepository.getAll

getById()

getById(params): Promise<Result<Administration>>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:154

Helper function to get document by ID getById

Parameters

params

FirestoreGetByIdParams

GetByIdParams

Returns

Promise<Result<Administration>>

  • Document data or null

Throws

  • Error getting document by ID

Inherited from

FirestoreBaseRepository.getById

getByName()

getByName(params): Promise<Result<Administration>[]>

Defined in: packages/core/src/repositories/firestore/FirestoreAdministrationRepository.repository.firestore.ts:36

Retrieves administrations by name by wrapping the BaseRepository's getWithFilters method

Parameters

params

FirestoreGetByNameParams

The GetAdministrationsByNameParams object.

Returns

Promise<Result<Administration>[]>

A list of administrations.

Throws

AdministrationRepositoryError

Implementation of

AdministrationBaseRepository.getByName

getCollection()

getCollection(): CollectionReference

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:66

Get collection reference getCollection

Returns

CollectionReference

  • Collection reference

Inherited from

FirestoreBaseRepository.getCollection

getCollectionGroup()

getCollectionGroup(): CollectionGroup

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:75

Get collection group reference getCollectionGroup

Returns

CollectionGroup

  • Collection group reference

Inherited from

FirestoreBaseRepository.getCollectionGroup

getCollectionType()

getCollectionType(): CollectionType

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:84

Get collection type getCollectionType

Returns

CollectionType

  • Collection type

Inherited from

FirestoreBaseRepository.getCollectionType

getWithFilters()

getWithFilters(params): Promise<Result<Administration>[]>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:300

Get documents with filters getWithFilters

Parameters

params

FirestoreGetWithFiltersParams

GetWithFiltersParams

Returns

Promise<Result<Administration>[]>

  • Document data or null

Throws

  • Error getting documents with filters

Inherited from

FirestoreBaseRepository.getWithFilters

runTransaction()

runTransaction(params): Promise<Administration>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:360

Executes operations within a transaction context.

Parameters

params

FirestoreRunTransactionParams<Administration>

RunTransactionParams

Returns

Promise<Administration>

  • Result of the transaction

Throws

  • Error running transaction

Example

await runTransaction({ fn: async (transaction) => { ... } });

Implementation of

AdministrationBaseRepository.runTransaction

Inherited from

FirestoreBaseRepository.runTransaction

update()

update(params): Promise<Result<Administration>>

Defined in: packages/core/src/repositories/firestore/FirestoreBaseRepository.repository.firestore.ts:256

Updates an existing entity in the repository.

Parameters

params

FirestoreUpdateParams

UpdateParams

Returns

Promise<Result<Administration>>

  • Document data or null

Throws

  • Error updating document

Implementation of

AdministrationBaseRepository.update

Inherited from

FirestoreBaseRepository.update