FireStoreRepository

@webda/gcp

---

Class: FireStoreRepository<T>

Defined in: gcp/src/services/firestore.service.ts:141

Firestore-backed repository for a single model class

Every object is stored as a document of the collection, keyed by its primary key. The inherited MemoryRepository is only used for its helpers, every storage method hits Firestore.

Extends

• MemoryRepository<T>

Type Parameters

T

T extends ModelClass

Constructors

Constructor

new FireStoreRepository<T>(model, pks, firestore, collection, indexes?, log?, separator?): FireStoreRepository<T>

Defined in: gcp/src/services/firestore.service.ts:156

Parameters

model

T

the model class

pks

string[]

primary key field names

firestore

Firestore

the Firestore client

collection

string

the collection name

indexes?

FireStoreIndex[] = []

compound indexes declared on the store

log?

(level, ...args) => void

logger of the store

separator?

string

primary key separator

Returns

FireStoreRepository<T>

Overrides

MemoryRepository<T>.constructor

Properties

[WEBDA_TEST]

[WEBDA_TEST]: object

Defined in: models/lib/repositories/memory.d.ts:258

Test utilities - clears all stored data

clear

clear: () => Promise<void>

Returns

Promise<void>

Inherited from

MemoryRepository.[WEBDA_TEST]

---

collection

protected readonly collection: string

Defined in: gcp/src/services/firestore.service.ts:160

the collection name

---

compoundIndexes

protected compoundIndexes: object = {}

Defined in: gcp/src/services/firestore.service.ts:145

Compound indexes available, keyed by the sorted fields joined with "/"

Index Signature

[key: string]: FireStoreIndexOrder

---

events

protected events: Map<keyof InstanceType<T>[typeof WEBDA_EVENTS], Set<(data) => void>>

Defined in: models/lib/repositories/abstract.d.ts:22

Registered event listeners keyed by event name

Inherited from

MemoryRepository.events

---

firestore

protected readonly firestore: Firestore

Defined in: gcp/src/services/firestore.service.ts:159

the Firestore client

---

log

protected readonly log: (level, ...args) => void

Defined in: gcp/src/services/firestore.service.ts:162

logger of the store

Parameters

level

any

args

...any[]

Returns

void

---

maxListeners

protected maxListeners: number

Defined in: models/lib/repositories/abstract.d.ts:111

Max-listeners hint kept for Node EventEmitter API compatibility. Not enforced — repositories use an unbounded Set per event.

Inherited from

MemoryRepository.maxListeners

---

model

protected model: T

Defined in: models/lib/repositories/abstract.d.ts:18

Inherited from

MemoryRepository.model

---

pks

protected pks: string[]

Defined in: models/lib/repositories/abstract.d.ts:19

Inherited from

MemoryRepository.pks

---

separator

protected separator: string

Defined in: models/lib/repositories/abstract.d.ts:20

Inherited from

MemoryRepository.separator

---

storage

protected storage: Map

Defined in: models/lib/repositories/memory.d.ts:35

Inherited from

MemoryRepository.storage

Methods

buildClassFilter()

protected buildClassFilter(): string

Defined in: models/lib/repositories/memory.d.ts:161

Build the WebdaQL class-filter clause __type IN ['A', 'B', ...] covering this.model's identifier and every transitive descendant.

Returns undefined when the model carries no Metadata.

Returns

string

the class-filter WebdaQL clause, or undefined when no Metadata

Inherited from

MemoryRepository.buildClassFilter

---

buildClassFilterIdentifiers()

protected buildClassFilterIdentifiers(): string[]

Defined in: models/lib/repositories/memory.d.ts:152

Collect the WebdaQL class-filter identifier list — this.model's identifier and every transitive descendant carried in Metadata.Subclasses.

Returns undefined when the model carries no Metadata (plain unit-test classes that didn't go through Application.setModelMetadata). In that case query() skips the prepend and returns everything in storage, preserving the pre-fix behavior for those bare classes.

Returns

string[]

the list of identifiers to match, or undefined when no Metadata

Inherited from

MemoryRepository.buildClassFilterIdentifiers

---

buildItem()

protected buildItem(data): InstanceType<T>

Defined in: models/lib/repositories/abstract.d.ts:41

Build the model instance to create from the incoming data

Primary key fields that are undefined or null are dropped from the data so a key generated by the model constructor (e.g. UuidModel) is not overwritten. Repositories must read the storage key from the returned instance.

Parameters

data

Helpers<InstanceType<T>>

the incoming data

Returns

InstanceType<T>

the model instance

Inherited from

MemoryRepository.buildItem

---

checkCondition()

protected checkCondition<K>(item, conditionField?, condition?): void

Defined in: models/lib/repositories/memory.d.ts:62

Verify an optimistic locking condition on an item

Type Parameters

K

K extends string

Parameters

item

InstanceType<T>

The item to check

conditionField?

K

Field to validate

condition?

any

Expected value

Returns

void

Throws

Error if the condition does not match

Inherited from

MemoryRepository.checkCondition

---

checkFirestoreCondition()

protected checkFirestoreCondition(uid, data, field, condition): void

Defined in: gcp/src/services/firestore.service.ts:218

Verify a write condition

Parameters

uid

string

the object key, for the error

data

any

the current data

field

string

the field to check

condition

any

the expected value

Returns

void

---

checkItemWriteCondition()

protected checkItemWriteCondition(item, index, itemWriteConditionField, itemWriteCondition): void

Defined in: models/lib/repositories/memory.d.ts:250

Verify a write condition on a collection item

Parameters

item

any[]

The array to check

index

number

Index of the item in the array

itemWriteConditionField

string

Field name to check on the item

itemWriteCondition

any

Expected value for the field

Returns

void

Throws

Error if the condition does not match

Inherited from

MemoryRepository.checkItemWriteCondition

---

clear()

clear(): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:628

Delete every document of the collection (used in tests)

Returns

Promise<void>

---

create()

create(data, save?): Promise<any>

Defined in: gcp/src/services/firestore.service.ts:259

Parameters

data

any

save?

boolean = true

Returns

Promise<any>

Overrides

MemoryRepository.create

---

delete()

delete(primaryKey, conditionField?, condition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:313

Parameters

primaryKey

any

conditionField?

any

condition?

any

Returns

Promise<void>

Overrides

MemoryRepository.delete

---

deleteItemFromCollection()

deleteItemFromCollection(primaryKey, collection, index, itemWriteConditionField?, itemWriteCondition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:401

Parameters

primaryKey

any

collection

any

index

number

itemWriteConditionField?

any

itemWriteCondition?

any

Returns

Promise<void>

Overrides

MemoryRepository.deleteItemFromCollection

---

deserialize()

deserialize(item): InstanceType<T>

Defined in: models/lib/repositories/memory.d.ts:116

Unserialize the object from a string

Beyond restoring the concrete type via @webda/serialize's $serializer.type typeKey, this also surfaces the storage envelope's __type stamp on the in-memory instance as a NON-ENUMERABLE property. The non-enumerable bit keeps __type invisible to JSON.stringify and Object.keys (so API responses and re-serialize cycles are byte-identical for the model's own fields), while still being readable via direct property access — which is exactly how WebdaQL's filter eval reads it (ComparisonExpression.getAttributeValue walks obj[name]).

Backward-compat: legacy rows written before the envelope-stamping was introduced won't carry __type. In that case we backfill from the repository's own model.Metadata.Identifier so they look like records of the parent class — which is exactly what query()'s prepended class filter expects (parent + descendants). Plain unit-test classes without Metadata get no stamp at all; their repos opt out of class filtering on the query side too (see query).

Parameters

item

string

the serialized string

Returns

InstanceType<T>

the deserialized model instance

Inherited from

MemoryRepository.deserialize

---

emit()

emit<K>(event, data): Promise<void>

Defined in: models/lib/repositories/abstract.d.ts:136

Emit an event to all registered listeners and await their completion.

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

The event name to emit

data

InstanceType<T>[typeof WEBDA_EVENTS][K]

The event payload

Returns

Promise<void>

Inherited from

MemoryRepository.emit

---

excludePrimaryKey()

excludePrimaryKey(object): any

Defined in: models/lib/repositories/abstract.d.ts:65

Parameters

object

any

Returns

any

Inherited from

MemoryRepository.excludePrimaryKey

---

exists()

exists(primaryKey): Promise<boolean>

Defined in: gcp/src/services/firestore.service.ts:254

Parameters

primaryKey

any

Returns

Promise<boolean>

Overrides

MemoryRepository.exists

---

find()

find(parsedQuery): Promise<FireStoreFindResult<InstanceType<T>>>

Defined in: gcp/src/services/firestore.service.ts:440

Run a parsed query against Firestore

Firestore has strong limitations on what can be queried natively, the part of the query that cannot be translated is applied in memory and returned as filter

Parameters

parsedQuery

Query

the parsed WebdaQL query

Returns

Promise<FireStoreFindResult<InstanceType<T>>>

the results, the in-memory filter and the continuation token

---

findModelClass()

protected findModelClass(identifier): any

Defined in: models/lib/repositories/memory.d.ts:132

Find the class to hydrate a row typed identifier: the repository model, one of its transitive subclasses, or the repository model for one of its ancestors

Parameters

identifier

string

model identifier

Returns

any

the class, this.model when it carries no Metadata, or undefined when unrelated

Inherited from

MemoryRepository.findModelClass

---

fromFirestore()

protected fromFirestore(data): InstanceType<T>

Defined in: gcp/src/services/firestore.service.ts:200

Deserialize a Firestore document into a model instance

Parameters

data

any

the document data

Returns

InstanceType<T>

the model instance

---

fromUID()

fromUID(uid): ModelRefWithCreate<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:47

Return a ref from the uuid

Parameters

uid

string

the serialized primary key

Returns

ModelRefWithCreate<InstanceType<T>>

a model reference with create capability

Inherited from

MemoryRepository.fromUID

---

get()

get(primaryKey): Promise<any>

Defined in: gcp/src/services/firestore.service.ts:244

Parameters

primaryKey

any

Returns

Promise<any>

Overrides

MemoryRepository.get

---

getCollection()

getCollection(): string

Defined in: gcp/src/services/firestore.service.ts:182

The backing collection name for this repository's model

Returns

string

the collection name

---

getDocumentRef()

getDocumentRef(primaryKey): DocumentReference

Defined in: gcp/src/services/firestore.service.ts:191

Get Document Reference

Parameters

primaryKey

any

the object or primary key

Returns

DocumentReference

the document reference

---

getMaxListeners()

getMaxListeners(): number

Defined in: models/lib/repositories/abstract.d.ts:124

EventEmitter-compatibility shim. Returns the max-listeners hint.

Returns

number

the current max-listeners hint

Inherited from

MemoryRepository.getMaxListeners

---

getPrimaryKey()

Call Signature

getPrimaryKey(object, forceObject?): PrimaryKeyType<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:67

Get the primary key value for an object as a scalar or string.

Parameters

object

any

forceObject?

false

Returns

PrimaryKeyType<InstanceType<T>>

Inherited from

MemoryRepository.getPrimaryKey

Call Signature

getPrimaryKey(object, forceObject): PrimaryKey<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:69

Get the primary key value for an object as a structured key object.

Parameters

object

any

forceObject

true

Returns

PrimaryKey<InstanceType<T>>

Inherited from

MemoryRepository.getPrimaryKey

---

getRootModel()

getRootModel(): T

Defined in: models/lib/repositories/abstract.d.ts:30

Returns

T

Inherited from

MemoryRepository.getRootModel

---

getSync()

protected getSync(primaryKey): InstanceType<T>

Defined in: models/lib/repositories/memory.d.ts:50

Synchronous read used by conditional writes to keep check-and-set atomic

Parameters

primaryKey

string | PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

key of the item

Returns

InstanceType<T>

the deserialized item

Inherited from

MemoryRepository.getSync

---

getUID()

getUID(object): string

Defined in: models/lib/repositories/abstract.d.ts:71

Parameters

object

any

Returns

string

Inherited from

MemoryRepository.getUID

---

handleOrderBy()

handleOrderBy(query, orderBy, rangeAttribute): Query<DocumentData>

Defined in: gcp/src/services/firestore.service.ts:556

Manage OrderBy complex condition on Firebase

Parameters

query

Query<DocumentData>

the Firestore query

orderBy

OrderBy[]

the requested order

rangeAttribute

string

the attribute used in a range condition if any

Returns

Query<DocumentData>

the Firestore query with ordering

---

hydratePlainRow()

protected hydratePlainRow(raw): InstanceType<T>

Defined in: models/lib/repositories/memory.d.ts:140

Hydrate a plain JSON row as an instance of the repository model (or of the transitive subclass named by its __type; an ancestor type hydrates as the repository model), the same way document stores hydrate their rows; a row typed as an unrelated model is refused

Parameters

raw

any

the parsed row

Returns

InstanceType<T>

the model instance

Inherited from

MemoryRepository.hydratePlainRow

---

incrementAttribute()

incrementAttribute<K, L>(primaryKey, info, _conditionField?, _condition?): Promise<void>

Defined in: models/lib/repositories/abstract.d.ts:79

Type Parameters

K

K extends string

L

L extends string

Parameters

primaryKey

PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

info

L | { property: L; value?: number; }

_conditionField?

K

_condition?

any

Returns

Promise<void>

Inherited from

MemoryRepository.incrementAttribute

---

incrementAttributes()

incrementAttributes(primaryKey, info, _conditionField?, _condition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:340

Parameters

primaryKey

any

info

any

_conditionField?

any

_condition?

any

Returns

Promise<void>

Overrides

MemoryRepository.incrementAttributes

---

isPlainRow()

protected isPlainRow(raw): boolean

Defined in: models/lib/repositories/memory.d.ts:125

Whether a stored row is a plain JSON object without a serializer envelope

Rows written by earlier versions (e.g. a v3 FileStore folder or MemoryStore persistence file) store the object itself, its type in a top-level __type.

Parameters

raw

any

the parsed row

Returns

boolean

true for a plain object row

Inherited from

MemoryRepository.isPlainRow

---

iterate()

iterate(query): AsyncGenerator<InstanceType<T>, any, any>

Defined in: gcp/src/services/firestore.service.ts:613

Parameters

query

string

Returns

AsyncGenerator<InstanceType<T>, any, any>

Overrides

MemoryRepository.iterate

---

listKeysOfModel()

protected listKeysOfModel(ids?): string[]

Defined in: models/lib/repositories/memory.d.ts:200

List the storage keys that may belong to this model

A storage shared by several models holds foreign entries whose key shape can be invalid for this repository: they are skipped from the stored envelope __type before any parsing. Entries without a readable stamp (legacy rows, corrupted payloads) are kept so any error on them still surfaces.

Parameters

ids?

string[]

class identifiers (model and subclasses), undefined to keep everything

Returns

string[]

the keys to evaluate

Inherited from

MemoryRepository.listKeysOfModel

---

off()

off<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:106

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

listener

(data) => void

Returns

void

Inherited from

MemoryRepository.off

---

on()

on<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:102

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

listener

(data) => void

Returns

void

Inherited from

MemoryRepository.on

---

once()

once<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:104

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

listener

(data) => void

Returns

void

Inherited from

MemoryRepository.once

---

parseLegacyUID()

protected parseLegacyUID(uid): PrimaryKey<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:63

Parse a uid through the model's parseLegacyUID hook

Parameters

uid

string

the raw storage key

Returns

PrimaryKey<InstanceType<T>>

a key whose string form is the raw uid, or undefined when the model does not recognise it

Inherited from

MemoryRepository.parseLegacyUID

---

parseUID()

parseUID(uid, forceObject?): PrimaryKeyType<InstanceType<T>> | PrimaryKey<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:57

Parse a serialized primary key

A composite key that does not split into the primary key fields is offered to the model's optional static parseLegacyUID(uid) hook (see WEBDA_LEGACY_UID): the returned key keeps the raw uid as its string form so it addresses the legacy storage entry. Without a hook, or when the hook declines, the uid is rejected.

Parameters

uid

string

forceObject?

boolean

Returns

PrimaryKeyType<InstanceType<T>> | PrimaryKey<InstanceType<T>>

Inherited from

MemoryRepository.parseUID

---

patch()

patch(primaryKey, data, conditionField?, condition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:308

Parameters

primaryKey

any

data

any

conditionField?

any

condition?

any

Returns

Promise<void>

Overrides

MemoryRepository.patch

---

query()

query(query): Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

Defined in: gcp/src/services/firestore.service.ts:606

Parameters

query

any

Returns

Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

Overrides

MemoryRepository.query

---

ref()

ref(key): ModelRefWithCreate<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:77

Parameters

key

PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

Returns

ModelRefWithCreate<InstanceType<T>>

Inherited from

MemoryRepository.ref

---

removeAttribute()

removeAttribute(primaryKey, attribute, conditionField?, condition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:325

Parameters

primaryKey

any

attribute

any

conditionField?

any

condition?

any

Returns

Promise<void>

Overrides

MemoryRepository.removeAttribute

---

removeListener()

removeListener<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:119

EventEmitter-compatibility alias for off. Consumers that treat a repository as a Node EventEmitter (e.g. @webda/runtime EventIterator) call removeListener.

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

the event name

listener

(data) => void

the listener to remove

Returns

void

Inherited from

MemoryRepository.removeListener

---

resolvePath()

protected resolvePath(item, path): object

Defined in: models/lib/repositories/memory.d.ts:229

Resolve the parent object and last key of a dotted path, creating intermediate objects

Parameters

item

any

root object

path

string

dotted path

Returns

object

the holder and the last key

holder

holder: any

key

key: string

Inherited from

MemoryRepository.resolvePath

---

serialize()

serialize(item): string

Defined in: models/lib/repositories/memory.d.ts:92

Serialize the object to a string

This method is used to allow switching between different serialization methods

The serialized payload is also stamped with a top-level __type field carrying the concrete model identifier when available (item.constructor.Metadata?.Identifier). This lets query() and external storage backends filter results by class without re-instantiating every item — important when a single underlying storage map is shared across a model and its subclasses (the common case in production where each registered model owns its own MemoryRepository pointing at the same Map).

The stamp lives on the serializer envelope (sibling of value / $serializer), not inside value. deserialize() re-surfaces it on the reconstructed instance as a non-enumerable __type property so WebdaQL's filter eval can read it without it ever leaking into JSON.stringify or Object.keys output — keeping API responses and re-serialize cycles byte-identical for the model's own fields.

Models that don't carry Metadata (plain unit-test classes that don't go through Application.setModelMetadata) simply skip the stamp; the resulting payload is byte-identical to the previous implementation.

Parameters

item

InstanceType<T>

to serialize

Returns

string

serialized object

Inherited from

MemoryRepository.serialize

---

setAttribute()

setAttribute<K, L>(primaryKey, attribute, value, conditionField?, condition?): Promise<void>

Defined in: models/lib/repositories/abstract.d.ts:75

Type Parameters

K

K extends string

L

L extends string

Parameters

primaryKey

string | PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

attribute

K

value

_PropertyPathType<InstanceType<T>, K>

conditionField?

L

condition?

_PropertyPathType<InstanceType<T>, L> | JSONed<_PropertyPathType<InstanceType<T>, L>>

Returns

Promise<void>

Inherited from

MemoryRepository.setAttribute

---

setDocument()

protected setDocument(merge, primaryKey, data, conditionField?, condition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:283

Implement both update and patch

Parameters

merge

boolean

merge with the existing document (patch) or replace it (update)

primaryKey

any

the object or primary key

data

any

the data to write

conditionField?

string

the field to check

condition?

any

the expected value

Returns

Promise<void>

---

setMaxListeners()

setMaxListeners(n): this

Defined in: models/lib/repositories/abstract.d.ts:130

EventEmitter-compatibility shim. Records the max-listeners hint (no enforcement).

Parameters

n

number

the new hint value

Returns

this

this for chaining

Inherited from

MemoryRepository.setMaxListeners

---

translateError()

protected translateError(uid, err): never

Defined in: gcp/src/services/firestore.service.ts:236

Translate Firestore not found error

Parameters

uid

string

the object key

err

any

the error raised

Returns

never

---

update()

update(data, conditionField?, condition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:303

Parameters

data

any

conditionField?

any

condition?

any

Returns

Promise<void>

Overrides

MemoryRepository.update

---

upsert()

upsert(data): Promise<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:73

Parameters

data

Helpers<InstanceType<T>>

Returns

Promise<InstanceType<T>>

Inherited from

MemoryRepository.upsert

---

upsertItemToCollection()

upsertItemToCollection(primaryKey, collection, item, index?, itemWriteConditionField?, itemWriteCondition?): Promise<void>

Defined in: gcp/src/services/firestore.service.ts:361

Parameters

primaryKey

any

collection

any

item

any

index?

number

itemWriteConditionField?

any

itemWriteCondition?

any

Returns

Promise<void>

Overrides

MemoryRepository.upsertItemToCollection

---

simulateFind()

static simulateFind<T>(query, uuids, repository): Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

Defined in: models/lib/repositories/memory.d.ts:209

Allow to simulate a find on a list of uuids It is static to be reusable by other repository like FileRepository

Type Parameters

T

T extends ModelClass<Storable<any, any>>

Parameters

query

Query

the parsed query

uuids

any[]

the list of UIDs to search

repository

Repository<T>

the repository to fetch objects from

Returns

Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

the query results with optional continuation token

Inherited from

MemoryRepository.simulateFind