Interface FeaturesDBInstance

Public API of the features store.

interface FeaturesDBInstance {
    put(record: FeatureRecord): Promise<void>;
    get(layerId: string, localId: string): Promise<FeatureRecord | null>;
    listByLayer(layerId: string): Promise<FeatureRecord[]>;
    listByState(state: string): Promise<FeatureRecord[]>;
    countByLayer(layerId: string): Promise<number>;
    remove(layerId: string, localId: string): Promise<void>;
    putManyPreservingLocal(
        records: readonly FeatureRecord[],
    ): Promise<PreservingPutTally>;
}

Index

Methods

put get listByLayer listByState countByLayer remove putManyPreservingLocal

Methods

put

put(record: FeatureRecord): Promise<void>
Parameters
- record: FeatureRecord
Returns Promise<void>
- Defined in src/capabilities/offline/db/features.ts:47

get

get(layerId: string, localId: string): Promise<FeatureRecord | null>
Parameters
- layerId: string
- localId: string
Returns Promise<FeatureRecord | null>
- Defined in src/capabilities/offline/db/features.ts:48

listByLayer

listByLayer(layerId: string): Promise<FeatureRecord[]>
Every record of one layer, via the composed key — no secondary index needed.
Parameters
- layerId: string
Returns Promise<FeatureRecord[]>
- Defined in src/capabilities/offline/db/features.ts:50

listByState

listByState(state: string): Promise<FeatureRecord[]>
Records in a given sync state, across every layer.
Parameters
- state: string
Returns Promise<FeatureRecord[]>
- Defined in src/capabilities/offline/db/features.ts:52

countByLayer

countByLayer(layerId: string): Promise<number>
Parameters
- layerId: string
Returns Promise<number>
- Defined in src/capabilities/offline/db/features.ts:53

remove

remove(layerId: string, localId: string): Promise<void>
Parameters
- layerId: string
- localId: string
Returns Promise<void>
- Defined in src/capabilities/offline/db/features.ts:54

putManyPreservingLocal

putManyPreservingLocal(
records: readonly FeatureRecord[],
): Promise<PreservingPutTally>
Writes a pulled batch in ONE transaction, skipping every record that holds unsynchronised local work.

🛑 The rule lives here, and not in the caller, because get and put above open SEPARATE transactions: reading the state in the orchestrator and writing after it would leave a window in which the optimistic write of task 4.4 lands between the two — and property 1 of the sync contract ("a capture never silently disappears") would hold only by timing.

A record is skipped when it already exists with syncState !== "synced". Everything else is inserted or refreshed.
Parameters
- records: readonly FeatureRecord[]
Returns Promise<PreservingPutTally>
- Defined in src/capabilities/offline/db/features.ts:68