offline-outbox/com.siddharth.kmp.offlineoutbox

Package-level declarations

Types

data class DraftEntry<T>(val formKey: String, val uniqueKey: String, val payload: T, val status: DraftStatus, val errorMessage: String?, val createdAt: Long, val updatedAt: Long)

DraftStatus

enum DraftStatus : Enum<DraftStatus>

OpEntry

data class OpEntry(val id: String, val type: String, val payload: String, val attempts: Int, val status: OpStatus, val lastError: String?, val createdAtMs: Long)

One logged operation. id is the idempotency key; attempts counts transient failures so far.

OpOutbox

interface OpOutbox

The SECOND outbox shape: a durable, FIFO, append-only operation log — distinct from SubmitOutbox, which is a keyed latest-write-wins draft store. Reach for this one when order matters and every mutation must reach the server exactly once, surviving process death:

OpOutboxDao

interface OpOutboxDao

OpOutboxEntity

data class OpOutboxEntity(val seq: Long = 0, val id: String, val type: String, val payload: String, val attempts: Int, val status: String, val lastError: String?, val createdAtMs: Long)

OpStatus

enum OpStatus : Enum<OpStatus>

OutboxDatabase

abstract class OutboxDatabase : RoomDatabase

OutboxDatabaseConstructor

expect object OutboxDatabaseConstructor : RoomDatabaseConstructor<OutboxDatabase>

RoomChangeBus

object RoomChangeBus

RoomOpOutbox

class RoomOpOutbox(dao: OpOutboxDao) : OpOutbox

Room-backed OpOutbox. The replay semantics (dead-letter on permanent/exhausted, stop-on-transient to preserve order) live here; the DAO only moves rows. Payload is an opaque string — the caller serializes before enqueue and deserializes inside its send, so this stays transport-agnostic.

RoomSubmitOutbox

class RoomSubmitOutbox<T : Any>(dao: SubmitDraftDao, json: Json, serializer: KSerializer<T>) : SubmitOutbox<T>

SubmitDraftDao

interface SubmitDraftDao

SubmitDraftEntity

data class SubmitDraftEntity(val formKey: String, val uniqueKey: String, val payloadJson: String, val status: String, val errorMessage: String?, val createdAt: Long, val updatedAt: Long)

SubmitOutbox

interface SubmitOutbox<T : Any>

Properties

MIGRATION_1_2

val MIGRATION_1_2: Migration

Functions

buildOutboxDatabase

fun buildOutboxDatabase(context: Context): OutboxDatabase

fun buildOutboxDatabase(): OutboxDatabase

epochMillis

actual fun epochMillis(): Long