release(v4.0.0): Shade GA — V3.x consolidation + audit prep
Some checks failed
Test / test (push) Has been cancelled
Cross-platform vectors / TypeScript vectors (bun) (push) Has been cancelled
Cross-platform vectors / Kotlin vectors (gradle) (push) Has been cancelled
Docker build and publish / docker (push) Has been cancelled
Publish / publish (push) Has been cancelled
Some checks failed
Test / test (push) Has been cancelled
Cross-platform vectors / TypeScript vectors (bun) (push) Has been cancelled
Cross-platform vectors / Kotlin vectors (gradle) (push) Has been cancelled
Docker build and publish / docker (push) Has been cancelled
Publish / publish (push) Has been cancelled
V3.1 → V3.12 consolidated and tagged for the first GA release. Wire format unchanged from 0.4.x — 4.0 peers interoperate with 0.4.x peers byte-for-byte. The version bump is semantic: audit-cycle complete, opt-in surface fully exposed, threat model refreshed for every new surface. Highlights: - All 24 @shade/* packages bumped to 4.0.0 in lockstep. - CHANGELOG 4.0.0 section is the canonical manifest of what landed. - THREAT-MODEL extended (§10 fingerprint gates, §11 WebRTC P2P, §12 Web-Worker boundary) + residual-risks table refreshed. - OpenAPI now covers all 27 routes: prekey, transfer, KT, inbox, bridge, observer, /metrics, /healthz, /ready. - MIGRATION 0.3.x → 4.0 documented + smoke-tested against shade migrate-storage on a real SQLite DB. - docs/audit/REVIEW-BUNDLE.md + SCOPE.md ready for external reviewer. - scripts/soak.ts harness for the GA-stable 2-week soak window. - All V*.md plans archived under docs/archive/ with Status: Done. - Voice/Video carved out into V5.0; 4.0 audit focuses on the frozen non-realtime stack. Tests: TS 1000/1000 + Kotlin 11/11 cross-platform vectors green. Docker: gt.zyon.no/stian/shade-prekey:4.0.0 builds and reports version 4.0.0 on /health. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
72
packages/shade-inbox/src/events.ts
Normal file
72
packages/shade-inbox/src/events.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
/**
|
||||
* Client-side inbox event emitter.
|
||||
*
|
||||
* The high-level `Inbox` orchestrator emits structural events — message
|
||||
* queued, delivered, polled, decrypted — so apps can drive UI badges,
|
||||
* push hooks, or telemetry without polling internal state.
|
||||
*/
|
||||
|
||||
export interface InboxClientEventMap {
|
||||
/**
|
||||
* A new ciphertext entry was added to the outgoing queue. The push-hook
|
||||
* mentioned in the V3.6 spec dispatches off this event.
|
||||
*/
|
||||
'inbox.message_queued': {
|
||||
recipientAddress: string;
|
||||
msgId: string;
|
||||
bytes: number;
|
||||
ttlSeconds: number;
|
||||
};
|
||||
/** Server confirmed a queued blob landed. */
|
||||
'inbox.message_delivered': {
|
||||
recipientAddress: string;
|
||||
msgId: string;
|
||||
idempotent: boolean;
|
||||
};
|
||||
/** Delivery attempt failed; will retry on next flush. */
|
||||
'inbox.message_failed': {
|
||||
recipientAddress: string;
|
||||
msgId: string;
|
||||
attempts: number;
|
||||
error: string;
|
||||
};
|
||||
/** A poll cycle completed and pulled `count` blobs. */
|
||||
'inbox.poll_completed': { ownAddress: string; count: number; cursor: number };
|
||||
/** Caller successfully decrypted and acked a blob. */
|
||||
'inbox.message_received': {
|
||||
senderHint: string | null;
|
||||
msgId: string;
|
||||
};
|
||||
/** Caller failed to decrypt — typically tampering or stale ratchet. */
|
||||
'inbox.message_decrypt_failed': {
|
||||
msgId: string;
|
||||
error: string;
|
||||
};
|
||||
}
|
||||
|
||||
export type InboxClientEventName = keyof InboxClientEventMap;
|
||||
export type InboxClientEvent = {
|
||||
[K in InboxClientEventName]: { name: K; data: InboxClientEventMap[K]; timestamp: number };
|
||||
}[InboxClientEventName];
|
||||
|
||||
export type InboxClientListener = (e: InboxClientEvent) => void;
|
||||
|
||||
export class InboxClientEvents {
|
||||
private readonly listeners = new Set<InboxClientListener>();
|
||||
|
||||
on(listener: InboxClientListener): () => void {
|
||||
this.listeners.add(listener);
|
||||
return () => this.listeners.delete(listener);
|
||||
}
|
||||
|
||||
emit<K extends InboxClientEventName>(name: K, data: InboxClientEventMap[K]): void {
|
||||
const event = { name, data, timestamp: Date.now() } as InboxClientEvent;
|
||||
for (const l of this.listeners) {
|
||||
try {
|
||||
l(event);
|
||||
} catch (err) {
|
||||
console.error('[Shade] Inbox client listener threw:', err);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user