@stratasync/storage-idb

IndexedDB storage adapter for offline-first client-side persistence in Strata Sync.

Implements StorageAdapter using IndexedDB. Persists model data, the outbox, sync metadata, partial indexes, and sync actions for offline-first operation and instant startup.

What it provides

createIndexedDbStorage: factory function that creates a configured StorageAdapter instance
IndexedDbStorageAdapter: the class implementing the full StorageAdapter interface
DatabaseManager: manages a registry of workspace databases for multi-user/multi-version support
Store operations: typed functions for model rows, metadata, outbox transactions, partial indexes, and sync actions
Schema migrations: automatic IndexedDB schema upgrades when the model schema changes
Store name utilities: deterministic hashing for store and database names

Installation


npm install @stratasync/storage-idb

@stratasync/storage-idb has no peer dependencies. It uses the idb library (^8.0.0) internally for a promise-based IndexedDB wrapper.

Quick start

@stratasync/storage-idb

IndexedDB storage adapter for offline-first client-side persistence in Strata Sync.

Implements StorageAdapter using IndexedDB. Persists model data, the outbox, sync metadata, partial indexes, and sync actions for offline-first operation and instant startup.

What it provides

createIndexedDbStorage: factory function that creates a configured StorageAdapter instance
IndexedDbStorageAdapter: the class implementing the full StorageAdapter interface
DatabaseManager: manages a registry of workspace databases for multi-user/multi-version support
Store operations: typed functions for model rows, metadata, outbox transactions, partial indexes, and sync actions
Schema migrations: automatic IndexedDB schema upgrades when the model schema changes
Store name utilities: deterministic hashing for store and database names

Installation


npm install @stratasync/storage-idb

@stratasync/storage-idb has no peer dependencies. It uses the idb library (^8.0.0) internally for a promise-based IndexedDB wrapper.

Method	Signature	Description
`open`	`(options: StorageOptions) => Promise<void>`	Opens the database, creates object stores, initializes metadata.
`close`	`() => Promise<void>`	Closes all database connections.
`clear`	`() => Promise<void>`	Clears all data from all stores (for testing or logout).

Method	Signature	Description
`get`	`<T>(modelName: string, id: string) => Promise<T \| null>`	Gets a single row by primary key.
`getAll`	`<T>(modelName: string) => Promise<T[]>`	Gets all rows for a model.
`put`	`<T>(modelName: string, row: T) => Promise<void>`	Inserts or updates a row.
`delete`	`(modelName: string, id: string) => Promise<void>`	Deletes a row by primary key.
`getByIndex`	`<T>(modelName: string, indexName: string, key: string) => Promise<T[]>`	Gets rows by an indexed field value.
`count`	`(modelName: string) => Promise<number>`	Counts rows in a model store.
`writeBatch`	`(ops: BatchOperation[]) => Promise<void>`	Executes multiple put/delete operations atomically in a single transaction.

Method	Signature	Description
`getMeta`	`() => Promise<StorageMeta>`	Gets the sync metadata (lastSyncId, schemaHash, and more).
`setMeta`	`(updates: Partial<StorageMeta>) => Promise<void>`	Updates sync metadata fields.
`getModelPersistence`	`(modelName: string) => Promise<ModelPersistenceMeta>`	Gets persistence status for a model.
`setModelPersistence`	`(modelName: string, persisted: boolean) => Promise<void>`	Sets whether a model's data is fully persisted locally.

Method	Signature	Description
`getOutbox`	`() => Promise<Transaction[]>`	Gets all pending transactions from the outbox.
`addToOutbox`	`(tx: Transaction) => Promise<void>`	Adds a transaction to the outbox.
`removeFromOutbox`	`(clientTxId: string) => Promise<void>`	Removes a transaction by client transaction ID.
`updateOutboxTransaction`	`(clientTxId: string, updates: Partial<Transaction>) => Promise<void>`	Updates fields on an outbox transaction.

Method	Signature	Description
`hasPartialIndex`	`(modelName: string, indexedKey: string, keyValue: string) => Promise<boolean>`	Checks if a partial index key has been fetched.
`setPartialIndex`	`(modelName: string, indexedKey: string, keyValue: string) => Promise<void>`	Marks a partial index key as fetched.

@stratasync/storage-idb

What it provides

Installation

Quick start

@stratasync/storage-idb

What it provides

Installation

Quick start

StorageAdapter interface

Lifecycle

Model row operations

Metadata operations

Outbox operations

Partial index operations

Sync action operations

Configuration

StorageOptions

Types

StorageMeta

ModelPersistenceMeta

BatchOperation

PartialIndexEntry

Internal database structure

Workspace database

Partial databases

Database registry

Schema migrations

Multi-workspace support

Utility exports

Store name functions

Granular store operations

Architecture role

Method	Signature	Description
`addSyncActions`	`(actions: SyncAction[]) => Promise<void>`	Persists sync actions for local replay/debugging.
`getSyncActions`	`(afterSyncId?: number, limit?: number) => Promise<SyncAction[]>`	Reads stored sync actions after a given sync ID.
`clearSyncActions`	`() => Promise<void>`	Clears all stored sync actions.

Store	Key	Description
`_meta`	`string`	Sync metadata and per-model persistence flags.
`_transaction`	`clientTxId`	Outbox of pending transactions. Indexes: `byState`, `byCreatedAt`, `byBatchIndex`.
`_sync_action`	`id`	Persisted sync actions for debugging.
`<model_hash>`	Model primary key	One store per registered model. Store names are deterministic hashes.

Function	Description
`computeModelStoreName(modelName, schemaVersion, registry)`	Deterministic hash-based store name for a model.
`computeWorkspaceDatabaseName({ userId, version, userVersion })`	Deterministic database name for a workspace.
`computePartialDatabaseName(storeName)`	Derives the partial index database name from a store name.