mirror of
https://github.com/bulwarkmail/webmail.git
synced 2026-11-04 16:14:07 +00:00
Linus Rath
e0abc7fa18
Eviction now goes by the base's signal: `storeLost` and the `store-reset` notice, with `bulwark-store-opened` as the marker and `prune-files` for files with no key. The storage page and the lost count hang off that. What a user picks is stored under `bulwark-offline-scope`, the key `offlineScopeFor` reads, and `email-snapshot` follows the base's rule. `OfflineEnabled` is read from the desktop bridge when it's there.
92 lines
3.4 KiB
TypeScript
92 lines
3.4 KiB
TypeScript
/** Messages between the page and the store worker. */
|
|
|
|
import type { StoreEvent, StoreScope } from '../area';
|
|
import type { JmapResponse, MethodCall, StoreSession } from '../engine/transport';
|
|
|
|
export const RPC_CHANNEL = 'bulwark-store-rpc';
|
|
export const OWNER_LOCK = 'bulwark-store-owner';
|
|
/** The OPFS folder of the database pool. The page can delete it without loading wasm. */
|
|
export const POOL_DIRECTORY = '.bulwark-store';
|
|
|
|
export interface OpenAccountParams {
|
|
account: string;
|
|
/** `/a<hex>.db`, no account data: the name is plaintext in the OPFS slot. */
|
|
file: string;
|
|
/** 32 bytes in hex. Only ever sent to this tab's own worker, never over the channel. */
|
|
keyHex: string;
|
|
session: StoreSession | null;
|
|
/** Undefined while the page can't tell (no policy yet): the store keeps the last one. */
|
|
scope?: StoreScope;
|
|
/** Null when this tab's client hasn't probed it: the stored answer stays. */
|
|
invertedKeywordSort: boolean | null;
|
|
/** The page's current Authorization header. */
|
|
auth: string | null;
|
|
}
|
|
|
|
/** What other tabs can ask for, over the channel. */
|
|
export interface StoreRpc {
|
|
answer(params: { account: string; calls: MethodCall[] }): JmapResponse | null;
|
|
sync(params: { account: string }): void;
|
|
noteStateChange(params: { account: string; changed: Record<string, Record<string, string>> }): void;
|
|
setOnline(params: { online: boolean }): void;
|
|
status(params: { account: string }): StoreStatus | null;
|
|
/** A non-JMAP call into an area of the store. */
|
|
area(params: { account: string; name: string; params: unknown }): unknown;
|
|
/** Closes an account and deletes its file. The name holds no account data. */
|
|
removeAccount(params: { account: string; file: string }): boolean;
|
|
/** How far back to keep mail, and what else. Any tab may say, since a policy reaches every tab. */
|
|
setScope(params: { account: string; scope: StoreScope }): void;
|
|
}
|
|
|
|
export interface StoreStatus {
|
|
account: string;
|
|
open: boolean;
|
|
emails: number;
|
|
bodies: number;
|
|
lastSyncedAt: number | null;
|
|
}
|
|
|
|
export type RpcRequest<K extends keyof StoreRpc = keyof StoreRpc> = {
|
|
kind: 'rpc';
|
|
id: string;
|
|
from: string;
|
|
method: K;
|
|
params: Parameters<StoreRpc[K]>[0];
|
|
};
|
|
|
|
export type RpcReply = {
|
|
kind: 'reply';
|
|
id: string;
|
|
to: string;
|
|
result?: unknown;
|
|
error?: string;
|
|
errorName?: string;
|
|
};
|
|
|
|
export type ChannelMessage =
|
|
| RpcRequest
|
|
| RpcReply
|
|
| { kind: 'event'; event: StoreEvent }
|
|
| { kind: 'owner-changed'; owner: string | null }
|
|
// A tab started after the owner announced itself asks.
|
|
| { kind: 'who-owns' }
|
|
// Everyone signed out: every tab stops its worker, so the pool can go.
|
|
| { kind: 'shutdown' };
|
|
|
|
/** From this tab's page to its own worker, never on the channel. */
|
|
export type PageToWorker =
|
|
| { kind: 'init'; clientId: string; moduleUrl: string }
|
|
| { kind: 'open'; id: string; params: OpenAccountParams }
|
|
| { kind: 'close-account'; id: string; account: string }
|
|
| { kind: 'prune-files'; id: string; keep: string[] }
|
|
| { kind: 'set-auth'; account: string; auth: string | null }
|
|
| { kind: 'set-inverted'; account: string; inverted: boolean }
|
|
| { kind: 'set-session'; account: string; session: StoreSession }
|
|
| { kind: 'release'; id: string };
|
|
|
|
export type WorkerToPage =
|
|
| { kind: 'owner' }
|
|
| { kind: 'result'; id: string; result?: unknown; error?: string; errorName?: string }
|
|
| { kind: 'need-auth'; account: string }
|
|
| { kind: 'event'; event: StoreEvent };
|