@arbidocs/react 0.5.84 → 0.5.85

package/README.md

@@ -257,6 +257,37 @@ live connection (a dropped socket counts once it has been up) and the person's "
 choice (`useWorkOffline`, a transient session view, `WORK_OFFLINE_VIEW`). `useReconnect` takes the
 cheapest way back: it clears "Work offline", says there is no network, or reloads.
 
+## Offline mail and calendar
+
+Mail can be kept on the device, sealed at rest to the signed-in user's key, bound to that account
+and readable only by them: offline reading and search, an Outbox whose sends go out exactly once
+on reconnect (each keeps its `request_id`), and drafts written offline. A host turns it on with
+three pieces:
+
+```tsx
+import { createMailClient, offlineMailReads, useOfflineMailRuntime, wipeOfflineMail } from '@arbidocs/react'
+
+const client = createMailClient((path, init) => getArbi().mail.fetch(path, init), {
+  ...offlineMailReads(getArbi), // reads answer from the device offline
+})
+useOfflineMailRuntime({ openOutbox }) // mounted once: sends the Outbox, uploads drafts, syncs
+await wipeOfflineMail() // at sign-out
+```
+
+The mailbox kit's device storage is `offlineMailSupport` (`@arbidocs/blocks/connect`); the
+per-device settings are `ConnectedMailOfflineSettings`.
+
+The calendar is kept the same way (its own sealed database): reads are answered from the device
+offline, and event writes made offline wait in an outbox that is replayed in order once back online.
+
+```tsx
+import { calendarOfflineSupport, useCalendarOfflineRuntime, wipeCalendarOffline } from '@arbidocs/react'
+
+<ArbiHost config={{ calendar: { offline: calendarOfflineSupport } }}>…</ArbiHost>
+useCalendarOfflineRuntime() // mounted once: replays the outbox on reconnect
+await wipeCalendarOffline() // at sign-out
+```
+
 ## The live connection
 
 `<ArbiWebSocketProvider>` holds the one reconnecting socket and applies what every site applies: