MemoryRepository

@webda/models

---

Class: MemoryRepository<T, K>

Defined in: packages/models/src/repositories/memory.ts:39

This is a simple in-memory repository implementation It is used for testing purposes only

Extends

• AbstractRepository<T>

Type Parameters

T

T extends ModelClass

K

K extends Map<string, string> = Map<string, string>

Constructors

Constructor

new MemoryRepository<T, K>(model, pks, separator?, map?): MemoryRepository<T, K>

Defined in: packages/models/src/repositories/memory.ts:51

Parameters

model

T

The model class constructor

pks

string[]

Primary key field names

separator?

string

Composite key separator (default: "_")

map?

K

Optional pre-existing Map to use as storage backend

Returns

MemoryRepository<T, K>

Overrides

AbstractRepository.constructor

Properties

[WEBDA_TEST]

[WEBDA_TEST]: object

Defined in: packages/models/src/repositories/memory.ts:697

Test utilities - clears all stored data

clear

clear: () => Promise<void>

Returns

Promise<void>

---

events

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

Defined in: packages/models/src/repositories/abstract.ts:20

Registered event listeners keyed by event name

Inherited from

AbstractRepository.events

---

maxListeners

protected maxListeners: number = 100

Defined in: packages/models/src/repositories/abstract.ts:357

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

Inherited from

AbstractRepository.maxListeners

---

model

protected model: T

Defined in: packages/models/src/repositories/abstract.ts:28

The model class constructor

Inherited from

AbstractRepository.model

---

pks

protected pks: string[]

Defined in: packages/models/src/repositories/abstract.ts:29

Array of primary key field names

Inherited from

AbstractRepository.pks

---

separator

protected separator: string = "_"

Defined in: packages/models/src/repositories/abstract.ts:30

Separator used when joining composite key fields into a string (default: "_")

Inherited from

AbstractRepository.separator

---

storage

protected storage: K

Defined in: packages/models/src/repositories/memory.ts:43

Methods

buildClassFilter()

protected buildClassFilter(): string | undefined

Defined in: packages/models/src/repositories/memory.ts:332

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 | undefined

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

---

buildClassFilterIdentifiers()

protected buildClassFilterIdentifiers(): string[] | undefined

Defined in: packages/models/src/repositories/memory.ts:311

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[] | undefined

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

---

buildItem()

protected buildItem(data): InstanceType<T>

Defined in: packages/models/src/repositories/abstract.ts:47

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

AbstractRepository.buildItem

---

checkCondition()

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

Defined in: packages/models/src/repositories/memory.ts:112

Verify an optimistic locking condition on an item

Type Parameters

K

K extends string

Parameters

item

InstanceType<T>

The item to check

conditionField?

K | null

Field to validate

condition?

any

Expected value

Returns

void

Throws

Error if the condition does not match

---

checkItemWriteCondition()

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

Defined in: packages/models/src/repositories/memory.ts:615

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

---

create()

create(data, save?): Promise<InstanceType<T>>

Defined in: packages/models/src/repositories/memory.ts:80

Parameters

data

Helpers<InstanceType<T>>

save?

boolean = true

Returns

Promise<InstanceType<T>>

Overrides

AbstractRepository.create

---

delete()

delete<K>(primaryKey, _conditionField?, _condition?): Promise<void>

Defined in: packages/models/src/repositories/memory.ts:529

Type Parameters

K

K extends string

Parameters

primaryKey

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

_conditionField?

K | null

_condition?

any

Returns

Promise<void>

Overrides

AbstractRepository.delete

---

deleteItemFromCollection()

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

Defined in: packages/models/src/repositories/memory.ts:660

Type Parameters

K

K extends string

L

L extends string | number | symbol

Parameters

primaryKey

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

collection

K

index

number

itemWriteConditionField?

any

itemWriteCondition?

any

Returns

Promise<void>

Overrides

AbstractRepository.deleteItemFromCollection

---

deserialize()

deserialize(item): InstanceType<T>

Defined in: packages/models/src/repositories/memory.ts:205

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

---

emit()

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

Defined in: packages/models/src/repositories/abstract.ts:396

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

AbstractRepository.emit

---

excludePrimaryKey()

excludePrimaryKey(object): any

Defined in: packages/models/src/repositories/abstract.ts:131

Parameters

object

any

Returns

any

Inherited from

AbstractRepository.excludePrimaryKey

---

exists()

exists(primaryKey): Promise<boolean>

Defined in: packages/models/src/repositories/memory.ts:538

Parameters

primaryKey

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

Returns

Promise<boolean>

Overrides

AbstractRepository.exists

---

findModelClass()

protected findModelClass(identifier): any

Defined in: packages/models/src/repositories/memory.ts:256

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

---

fromUID()

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

Defined in: packages/models/src/repositories/abstract.ts:80

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

AbstractRepository.fromUID

---

get()

get(primaryKey): Promise<HelperProperties<InstanceType<T>>>

Defined in: packages/models/src/repositories/memory.ts:56

Parameters

primaryKey

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

Returns

Promise<HelperProperties<InstanceType<T>>>

Overrides

AbstractRepository.get

---

getMaxListeners()

getMaxListeners(): number

Defined in: packages/models/src/repositories/abstract.ts:377

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

Returns

number

the current max-listeners hint

Inherited from

AbstractRepository.getMaxListeners

---

getPrimaryKey()

Call Signature

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

Defined in: packages/models/src/repositories/abstract.ts:141

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

Parameters

object

any

forceObject?

false

Returns

PrimaryKeyType<InstanceType<T>>

Inherited from

AbstractRepository.getPrimaryKey

Call Signature

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

Defined in: packages/models/src/repositories/abstract.ts:143

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

Parameters

object

any

forceObject

true

Returns

PrimaryKey<InstanceType<T>>

Inherited from

AbstractRepository.getPrimaryKey

---

getRootModel()

getRootModel(): T

Defined in: packages/models/src/repositories/abstract.ts:33

Returns

T

Inherited from

AbstractRepository.getRootModel

---

getSync()

protected getSync(primaryKey): InstanceType<T>

Defined in: packages/models/src/repositories/memory.ts:70

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

---

getUID()

getUID(object): string

Defined in: packages/models/src/repositories/abstract.ts:216

Parameters

object

any

Returns

string

Inherited from

AbstractRepository.getUID

---

hydratePlainRow()

protected hydratePlainRow(raw): InstanceType<T>

Defined in: packages/models/src/repositories/memory.ts:285

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

---

incrementAttribute()

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

Defined in: packages/models/src/repositories/abstract.ts:249

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 | null

_condition?

any

Returns

Promise<void>

Inherited from

AbstractRepository.incrementAttribute

---

incrementAttributes()

incrementAttributes<K, L>(primaryKey, info, _conditionField?, _condition?): Promise<void | Record<string, number>>

Defined in: packages/models/src/repositories/memory.ts:574

Increment attributes atomically: the read-modify-write never yields, so concurrent calls all count

Type Parameters

K

K extends string

L

L extends string

Parameters

primaryKey

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

info

(L | { property: L; value?: number; })[] | Record<L, number>

_conditionField?

K | null

_condition?

any

Returns

Promise<void | Record<string, number>>

the new value of each incremented attribute, by path

Overrides

AbstractRepository.incrementAttributes

---

isPlainRow()

protected isPlainRow(raw): boolean

Defined in: packages/models/src/repositories/memory.ts:240

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

---

iterate()

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

Defined in: packages/models/src/repositories/memory.ts:509

Add iterator support

Parameters

query

string

the query string

params?

QueryParameters

values for the ? or :name placeholders

Returns

AsyncGenerator<InstanceType<T>, any, any>

Overrides

AbstractRepository.iterate

---

listKeysOfModel()

protected listKeysOfModel(ids?): string[]

Defined in: packages/models/src/repositories/memory.ts:416

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

---

off()

off<K>(event, listener): void

Defined in: packages/models/src/repositories/abstract.ts:346

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

listener

(data) => void

Returns

void

Inherited from

AbstractRepository.off

---

on()

on<K>(event, listener): void

Defined in: packages/models/src/repositories/abstract.ts:323

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

listener

(data) => void

Returns

void

Inherited from

AbstractRepository.on

---

once()

once<K>(event, listener): void

Defined in: packages/models/src/repositories/abstract.ts:334

Type Parameters

K

K extends string | number | symbol

Parameters

event

K

listener

(data) => void

Returns

void

Inherited from

AbstractRepository.once

---

parseLegacyUID()

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

Defined in: packages/models/src/repositories/abstract.ts:119

Parse a uid through the model's parseLegacyUID hook

Parameters

uid

string

the raw storage key

Returns

PrimaryKey<InstanceType<T>> | undefined

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

Inherited from

AbstractRepository.parseLegacyUID

---

parseUID()

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

Defined in: packages/models/src/repositories/abstract.ts:93

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

AbstractRepository.parseUID

---

patch()

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

Defined in: packages/models/src/repositories/memory.ts:124

Type Parameters

K

K extends string

Parameters

primaryKey

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

data

Partial<InstanceType<T>>

conditionField?

K | null

condition?

any

Returns

Promise<void>

Overrides

AbstractRepository.patch

---

query()

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

Defined in: packages/models/src/repositories/memory.ts:365

Add query support

Class filtering: when several model classes share the same underlying storage Map (e.g. a model and its subclasses each registering their own repository pointing at the same Map via MemoryStore.getRepository), results are restricted to instances of this.model and its transitive descendants. The filter is applied as a real WebdaQL clause — __type IN ['Webda/Post', 'Webda/BlogPost', ...] — prepended to the caller's query via WebdaQL.PrependCondition (string path) or merged directly into the AST (parsed-Query path used by iterate). Each stored item carries its __type as a non-enumerable property courtesy of deserialize, so the WebdaQL filter eval reads it directly without leaking it to JSON serialization. There is no post-filter step.

Models without Metadata (plain unit-test classes) opt out of the prepend — buildClassFilterIdentifiers returns undefined and the query runs as given. External storage backends that adopt the same __type stamping convention can use buildClassFilter to produce the equivalent server-side WHERE clause.

Parameters

query

string | Query

the query string or parsed query

params?

QueryParameters

values for the ? or :name placeholders of a query string

Returns

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

the query results with optional continuation token

Overrides

AbstractRepository.query

---

ref()

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

Defined in: packages/models/src/repositories/abstract.ts:242

Parameters

key

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

Returns

ModelRefWithCreate<InstanceType<T>>

Inherited from

AbstractRepository.ref

---

removeAttribute()

removeAttribute<L, K>(primaryKey, attribute, _conditionField?, _condition?): Promise<void>

Defined in: packages/models/src/repositories/memory.ts:685

Type Parameters

L

L extends string

K

K extends string

Parameters

primaryKey

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

attribute

K

_conditionField?

L | null

_condition?

any

Returns

Promise<void>

Overrides

AbstractRepository.removeAttribute

---

removeListener()

removeListener<K>(event, listener): void

Defined in: packages/models/src/repositories/abstract.ts:366

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

AbstractRepository.removeListener

---

resolvePath()

protected resolvePath(item, path): object

Defined in: packages/models/src/repositories/memory.ts:550

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

---

serialize()

serialize(item): string

Defined in: packages/models/src/repositories/memory.ts:164

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

---

setAttribute()

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

Defined in: packages/models/src/repositories/abstract.ts:231

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 | null

condition?

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

Returns

Promise<void>

Inherited from

AbstractRepository.setAttribute

---

setMaxListeners()

setMaxListeners(n): this

Defined in: packages/models/src/repositories/abstract.ts:386

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

Parameters

n

number

the new hint value

Returns

this

this for chaining

Inherited from

AbstractRepository.setMaxListeners

---

update()

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

Defined in: packages/models/src/repositories/memory.ts:95

Type Parameters

K

K extends string

Parameters

data

Helpers<InstanceType<T>>

conditionField?

K | null

condition?

any

Returns

Promise<void>

Overrides

AbstractRepository.update

---

upsert()

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

Defined in: packages/models/src/repositories/abstract.ts:221

Parameters

data

Helpers<InstanceType<T>>

Returns

Promise<InstanceType<T>>

Inherited from

AbstractRepository.upsert

---

upsertItemToCollection()

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

Defined in: packages/models/src/repositories/memory.ts:631

Type Parameters

K

K extends string

L

L extends string | number | symbol

Parameters

primaryKey

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

collection

K

item

ArrayElement<InstanceType<T>[K]> | JSONed<ArrayElement<InstanceType<T>[K]>>

index?

number

itemWriteConditionField?

any

itemWriteCondition?

any

Returns

Promise<void>

Overrides

AbstractRepository.upsertItemToCollection

---

simulateFind()

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

Defined in: packages/models/src/repositories/memory.ts:439

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