@idpass/data-collect-core / EntityStore
Interface: EntityStore
Defined in: interfaces/types.ts:580
Entity store interface for managing current entity state.
Stores the materialized view of entities derived from applying events. Optimized for fast queries and lookups.
Methods
initialize()
initialize():
Promise<void>
Defined in: interfaces/types.ts:582
Initialize the entity store (create tables, indexes, etc.)
Returns
Promise<void>
saveEntity()
saveEntity(
initial,modified):Promise<void>
Defined in: interfaces/types.ts:584
Save entity with both initial and current state (initial is null for entities not yet synced)
Parameters
initial
EntityDoc | null
modified
Returns
Promise<void>
getEntity()
getEntity(
id):Promise<EntityPair|null>
Defined in: interfaces/types.ts:586
Get entity by internal ID
Parameters
id
string
Returns
Promise<EntityPair | null>
getEntityByExternalId()
getEntityByExternalId(
externalId):Promise<EntityPair|null>
Defined in: interfaces/types.ts:588
Get entity by external system ID
Parameters
externalId
string
Returns
Promise<EntityPair | null>
searchEntities()
searchEntities(
criteria):Promise<EntityPair[]>
Defined in: interfaces/types.ts:590
Search entities using query criteria
Parameters
criteria
Returns
Promise<EntityPair[]>
getAllEntities()
getAllEntities():
Promise<EntityPair[]>
Defined in: interfaces/types.ts:592
Get all entities in the store
Returns
Promise<EntityPair[]>
getModifiedEntitiesSince()
getModifiedEntitiesSince(
timestamp):Promise<EntityPair[]>
Defined in: interfaces/types.ts:594
Get entities modified since a timestamp (for sync)
Parameters
timestamp
string
Returns
Promise<EntityPair[]>
markEntityAsSynced()
markEntityAsSynced(
id):Promise<void>
Defined in: interfaces/types.ts:596
Mark an entity as synced with remote server
Parameters
id
string
Returns
Promise<void>
deleteEntity()
deleteEntity(
id):Promise<void>
Defined in: interfaces/types.ts:598
Delete an entity by ID
Parameters
id
string
Returns
Promise<void>
savePotentialDuplicates()
savePotentialDuplicates(
duplicates):Promise<void>
Defined in: interfaces/types.ts:600
Save potential duplicate entity pairs for review
Parameters
duplicates
object[]
Returns
Promise<void>
getPotentialDuplicates()
getPotentialDuplicates():
Promise<object[]>
Defined in: interfaces/types.ts:602
Get all potential duplicate pairs
Returns
Promise<object[]>
resolvePotentialDuplicates()
resolvePotentialDuplicates(
duplicates):Promise<void>
Defined in: interfaces/types.ts:604
Resolve potential duplicate pairs (mark as reviewed)
Parameters
duplicates
object[]
Returns
Promise<void>
clearStore()
clearStore():
Promise<void>
Defined in: interfaces/types.ts:606
Clear all data from the store (for testing)
Returns
Promise<void>
closeConnection()
closeConnection():
Promise<void>
Defined in: interfaces/types.ts:608
Close database connections and cleanup resources
Returns
Promise<void>