Interfaces

CollectionAccessor

Collection accessor interface

Replication state manager interface

Main client interface

Properties:

Property	Type	Required	Description
`replication`	`ReplicationManager \| undefined`	No

Query selector for finding documents

Properties:

Property	Type	Required
`selector`	`Record<string, any> \| undefined`	No
`sort`	`Record<string, "asc" \| "desc">[] \| undefined`	No
`limit`	`number \| undefined`	No
`skip`	`number \| undefined`	No

Common base configuration

Properties:

Property	Type	Required
`serverUrl`	`string`	Yes
`authToken`	`string`	Yes
`domainId`	`string`	Yes
`collections`	`CollectionDefinitions<TCollections>`	Yes
`userId`	`string \| undefined`	No
`orgId`	`string \| undefined`	No
`databaseName`	`string \| undefined`	No

Replication mode configuration

Properties:

Property	Type	Required
`mode`	`"replication"`	Yes
`storage`	`{ type?: "indexeddb" \| "memory"; options?: Record<string, any>; } \| undefined`	No
`replication`	`{ live?: boolean; batchSize?: number; waitForLeadership?: boolean; } \| undefined`	No

REST mode configuration

Properties:

Property	Type	Required	Description
`mode`	`"rest"`	Yes
`rest`	`{ timeout?: number; retryAttempts?: number; } \| undefined`	No

Stubbed Log Collection

The Log collection has been removed from db-collections. This stub maintains compatibility until a new logging system is implemented.

TODO: Replace with new logging system (e.g., observability platform integration)

Properties:

Property	Type	Required
`id`	`string`	Yes
`message`	`string`	Yes
`level`	`string`	Yes
`source`	`string \| undefined`	No
`timestamp`	`string`	Yes
`entityType`	`string \| undefined`	No
`entityId`	`string \| undefined`	No
`category`	`string \| undefined`	No
`metadata`	`Record<string, unknown> \| undefined`	No
`orgId`	`string`	Yes
`userId`	`string \| undefined`	No
`workspaceId`	`string \| undefined`	No
`parentLogId`	`string \| undefined`	No
`trashed`	`boolean \| undefined`	No
`createdAt`	`string \| undefined`	No
`updatedAt`	`string \| undefined`	No