Class SingleDocumentRepository<T_model>

Repository with a basic CRUD implemention for collections of one named document.

Type Parameters

T_model extends IFirestormModel

Hierarchy (View Summary)

Repository<T_model>
- SingleDocumentRepository

Constructors

constructor

new SingleDocumentRepository<T_model extends IFirestormModel>(
    type: Type<T_model>,
    firestore: Firestore,
    parents?: CollectionDocumentTuples,
): SingleDocumentRepository<T_model>
Creates a new SingleDocumentRepository on a model
Type Parameters
- T_model extends IFirestormModel
Parameters
- type: Type<T_model>
  Type on which the repository operates
- firestore: Firestore
  The instance of firestore this repository connects to
- Optionalparents: CollectionDocumentTuples
  The optional parent collections for repositories of subcollections
Returns SingleDocumentRepository<T_model>
Overrides Repository.constructor
- Defined in packages/firestorm/src/repositories/single-document-crud-repository.ts:25

Properties

documentId

documentId: string = ""

Id of the document

`Protected` `Readonly`firestore

firestore: Firestore

Instance of firestore this repository uses to reach the DB

`Protected` `Optional`parents

parents?: CollectionDocumentTuples

Accessors

collectionPath

get collectionPath(): string
Gets the path to the collection of this repository

Returns string
Inherited from Repository.collectionPath
- Defined in packages/firestorm/src/repositories/repository.ts:81

`Protected`collectionRef

get collectionRef(): CollectionReference<DocumentData, DocumentData>
Gets a collection reference to the collection of this repository

Returns CollectionReference<DocumentData, DocumentData>
Collection ref to this repository
Inherited from Repository.collectionRef
- Defined in packages/firestorm/src/repositories/repository.ts:129

documentBlueprint

get documentBlueprint(): Record<string, PropertyBluePrint>
Gets the blueprint for a document built with the type of this repository

Returns Record<string, PropertyBluePrint>
Deprecated
⚠️ Not ready
Inherited from Repository.documentBlueprint
- Defined in packages/firestorm/src/repositories/repository.ts:291

isOnSubcollection

get isOnSubcollection(): boolean
Whether or not this repository is a subcollection or not

Returns boolean
Inherited from Repository.isOnSubcollection
- Defined in packages/firestorm/src/repositories/repository.ts:74

`Protected`storage

get storage(): FirestormMetadataStore
The storage of metadatas of this repository

Returns FirestormMetadataStore
Inherited from Repository.storage
- Defined in packages/firestorm/src/repositories/repository.ts:60

type

get type(): Type<T_model>
Gets the type this repository work on

Returns Type<T_model>
Inherited from Repository.type
- Defined in packages/firestorm/src/repositories/repository.ts:44

`Protected`typeMetadata

get typeMetadata(): FirestormMetadata<T_model>
The metadatas corresponding to the type of this repository

Returns FirestormMetadata<T_model>
Inherited from Repository.typeMetadata
- Defined in packages/firestorm/src/repositories/repository.ts:67

`Protected`typeName

get typeName(): string
Gets the name of the type.

Returns string
Deprecated
Don't rely on its result to do stuff, the name will get mangled after compilation.
Inherited from Repository.typeName
- Defined in packages/firestorm/src/repositories/repository.ts:53

Methods

documentsToModels

documentsToModels(documents: FirestoreDocument[]): T_model[]
Converts multiple documents to their corresponding model
Parameters
- documents: FirestoreDocument[]
  Documents to convert
Returns T_model[]
The converted models
Inherited from Repository.documentsToModels
- Defined in packages/firestorm/src/repositories/repository.ts:265

documentToModel

documentToModel(document: FirestoreDocument): T_model
Converts a document to a model (if the id is not in the document, it is lost in the process)
Parameters
- document: FirestoreDocument
  Document to convert
Returns T_model
The converted model
Inherited from Repository.documentToModel
- Defined in packages/firestorm/src/repositories/repository.ts:256

existsAsync

existsAsync(): Promise<boolean>
Check if the document exists in the database

If you need to use the document later in the process, getAsync is a better fit

Returns Promise<boolean>
- Defined in packages/firestorm/src/repositories/single-document-crud-repository.ts:106

`Protected`firestoreDocumentSnapshotToModel

firestoreDocumentSnapshotToModel(
documentSnapshot: DocumentSnapshot<DocumentData, DocumentData>,
): T_model
Converts a snapshot to a model
Parameters
- documentSnapshot: DocumentSnapshot<DocumentData, DocumentData>
  Document snapshot in firestore
Returns T_model
Converts a document snapshot to a model
Inherited from Repository.firestoreDocumentSnapshotToModel
- Defined in packages/firestorm/src/repositories/repository.ts:201

getAsync

getAsync(): Promise<null | T_model>
Gets the document of this repository

Returns Promise<null | T_model>
A promise containing either the item retrieved or null if it doesn't exist
- Defined in packages/firestorm/src/repositories/single-document-crud-repository.ts:81

`Protected`getDocumentRef

getDocumentRef(id: string): DocumentReference<DocumentData, DocumentData>
Gets a reference to the document corresponding to this id.
Parameters
- id: string
  Id for which you want a document ref
Returns DocumentReference<DocumentData, DocumentData>
A document ref corresponding to the model
Inherited from Repository.getDocumentRef
- Defined in packages/firestorm/src/repositories/repository.ts:93
getDocumentRef(
model: IFirestormModel,
): DocumentReference<DocumentData, DocumentData>
Gets a reference to the document corresponding to this model.

If the model doesn't have any id, it will give you a reference to a new document, generate an id and assign it to the model
Parameters
- model: IFirestormModel
  Model for which you want a document ref
Returns DocumentReference<DocumentData, DocumentData>
A document ref corresponding to the model
Inherited from Repository.getDocumentRef
- Defined in packages/firestorm/src/repositories/repository.ts:102
getDocumentRef(
modelOrId: string | IFirestormModel,
): DocumentReference<DocumentData, DocumentData>
Gets a reference to the document corresponding to this model.
Parameters
- modelOrId: string | IFirestormModel
  Id or model for which you want a document ref
Returns DocumentReference<DocumentData, DocumentData>
A document ref corresponding to the model
Inherited from Repository.getDocumentRef
- Defined in packages/firestorm/src/repositories/repository.ts:109

`Protected`getDocumentRefs

getDocumentRefs(ids: string[]): DocumentReference<DocumentData, DocumentData>[]
Gets a document reference for each of the models provided.
Parameters
- ids: string[]
  Ids for which you want document refs
Returns DocumentReference<DocumentData, DocumentData>[]
A document ref for each of the models provided in the same order

See
getDocumentRef For the rules on each individual model/documentRef
Inherited from Repository.getDocumentRefs
- Defined in packages/firestorm/src/repositories/repository.ts:141
getDocumentRefs(
models: IFirestormModel[],
): DocumentReference<DocumentData, DocumentData>[]
Gets a document reference for each of the models provided.
Parameters
- models: IFirestormModel[]
  Models for which you want document refs
Returns DocumentReference<DocumentData, DocumentData>[]
A document ref for each of the models provided in the same order

See
getDocumentRef For the rules on each individual model/documentRef
Inherited from Repository.getDocumentRefs
- Defined in packages/firestorm/src/repositories/repository.ts:150
getDocumentRefs(
modelsOrIds: (string | IFirestormModel)[],
): DocumentReference<DocumentData, DocumentData>[]
Gets a document reference for each of the models provided.
Parameters
- modelsOrIds: (string | IFirestormModel)[]
  Ids or models for which you want document refs
Returns DocumentReference<DocumentData, DocumentData>[]
A document ref for each of the models provided in the same order
Inherited from Repository.getDocumentRefs
- Defined in packages/firestorm/src/repositories/repository.ts:157

getRepositoryFromFunction

getRepositoryFromFunction<
    R extends Repository<T_linked_model>,
    T_linked_model extends IFirestormModel,
>(
    generator: RepositoryGeneratorFunction<R, T_linked_model>,
    type: Type<T_linked_model>,
    location: RelationshipLocation,
): R
Creates a repository using a generator function
Type Parameters
- R extends Repository<T_linked_model>
  Type of the repository
- T_linked_model extends IFirestormModel
  Type of the model
Parameters
- generator: RepositoryGeneratorFunction<R, T_linked_model>
  Generator function of the repository
- type: Type<T_linked_model>
  Type of the model
- location: RelationshipLocation
Returns R
Inherited from Repository.getRepositoryFromFunction
- Defined in packages/firestorm/src/repositories/repository.ts:241

listen

listen(): DocumentObservable<T_model>
Listens to the changes of the document

Returns DocumentObservable<T_model>
An observable on the document's changes
- Defined in packages/firestorm/src/repositories/single-document-crud-repository.ts:95

modelsToDocuments

modelsToDocuments(models: Partial<T_model>[]): FirestoreDocument[]
Converts multiple models to their corresponding document
Parameters
- models: Partial<T_model>[]
  Models to convert
Returns FirestoreDocument[]
The converted documents
Inherited from Repository.modelsToDocuments
- Defined in packages/firestorm/src/repositories/repository.ts:283

modelToDocument

modelToDocument(model: Partial<T_model>): FirestoreDocument
Converts a partial model to a document
Parameters
- model: Partial<T_model>
  Model to convert
Returns FirestoreDocument
The converted document
Inherited from Repository.modelToDocument
- Defined in packages/firestorm/src/repositories/repository.ts:274

pathToDocument

pathToDocument(modelOrId: string | IFirestormModel): string
Builds the path to a document
Parameters
- modelOrId: string | IFirestormModel
  Model or id for which you want the Firestore's DB path
Returns string
Inherited from Repository.pathToDocument
- Defined in packages/firestorm/src/repositories/repository.ts:189

resolveRelationshipLocation

resolveRelationshipLocation(
location: RelationshipLocation,
): CollectionDocumentTuples
Parameters
- location: RelationshipLocation
Returns CollectionDocumentTuples
Inherited from Repository.resolveRelationshipLocation
- Defined in packages/firestorm/src/repositories/repository.ts:222

`Protected`runTransactionAsync

runTransactionAsync(
transactionFnc: TransactionFnc,
options?: TransactionOptions,
): Promise<void>
Runs a tansaction on the transaction function provided
Parameters
- transactionFnc: TransactionFnc
  Operations to do durring the transaction
- Optionaloptions: TransactionOptions
  Transaction options
Returns Promise<void>
Inherited from Repository.runTransactionAsync
- Defined in packages/firestorm/src/repositories/repository.ts:167

`Protected`toFirestoreQuery

toFirestoreQuery(
firestormQuery: IQueryBuildBlock | Query,
): Query<DocumentData, DocumentData>
Converts a firestORM query to a firestore query
Parameters
- firestormQuery: IQueryBuildBlock | Query
  Query to convert
Returns Query<DocumentData, DocumentData>
The firestorm query
Inherited from Repository.toFirestoreQuery
- Defined in packages/firestorm/src/repositories/repository.ts:180

updateAsync

updateAsync(model: Partial<T_model>): Promise<void>
Modifies the item in the database.

The id, if provided, is ignored in the model and set to this.documentId

It will fail if the document doesn't exist.
Parameters
- model: Partial<T_model>
  Partial or full model to update. It must have an id.
Returns Promise<void>
A Promise that resolved when the item has been updated
- Defined in packages/firestorm/src/repositories/single-document-crud-repository.ts:64

writeAsync

writeAsync(model: T_model): Promise<T_model>
Writes a new item in the databse.

The id is ignored in the model and set to this.documentId
Parameters
- model: T_model
  Model to store
Returns Promise<T_model>
- Defined in packages/firestorm/src/repositories/single-document-crud-repository.ts:42

Class SingleDocumentRepository<T_model>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SingleDocumentRepository<T_model>

Properties

documentId

Protected Readonlyfirestore

Protected Optionalparents

Accessors

collectionPath

Returns string

ProtectedcollectionRef

Returns CollectionReference<DocumentData, DocumentData>

documentBlueprint

Returns Record<string, PropertyBluePrint>

Deprecated

isOnSubcollection

Returns boolean

Protectedstorage

Returns FirestormMetadataStore

type

Returns Type<T_model>

ProtectedtypeMetadata

Returns FirestormMetadata<T_model>

ProtectedtypeName

Returns string

Deprecated

Methods

documentsToModels

Parameters

Returns T_model[]

documentToModel

Parameters

Returns T_model

existsAsync

Returns Promise<boolean>

ProtectedfirestoreDocumentSnapshotToModel

Parameters

Returns T_model

getAsync

Returns Promise<null | T_model>

ProtectedgetDocumentRef

Parameters

Returns DocumentReference<DocumentData, DocumentData>

Parameters

Returns DocumentReference<DocumentData, DocumentData>

Parameters

Returns DocumentReference<DocumentData, DocumentData>

ProtectedgetDocumentRefs

Parameters

Returns DocumentReference<DocumentData, DocumentData>[]

See

Parameters

Returns DocumentReference<DocumentData, DocumentData>[]

See

Parameters

Returns DocumentReference<DocumentData, DocumentData>[]

getRepositoryFromFunction

Type Parameters

Parameters

Returns R

listen

Returns DocumentObservable<T_model>

modelsToDocuments

Parameters

Returns FirestoreDocument[]

modelToDocument

Parameters

Returns FirestoreDocument

pathToDocument

Parameters

`Protected` `Readonly`firestore

`Protected` `Optional`parents

`Protected`collectionRef

`Protected`storage

`Protected`typeMetadata

`Protected`typeName

`Protected`firestoreDocumentSnapshotToModel

`Protected`getDocumentRef

`Protected`getDocumentRefs

`Protected`runTransactionAsync

`Protected`toFirestoreQuery