@pmate/chat-sdk 0.12.0-next.2 → 0.12.0-next.20

package/README.md

@@ -137,6 +137,52 @@ sends and reading synchronization independently. The runtime now provides local
 IndexedDB storage and fixed-window scheduling primitives so those operations can
 share bounded I/O, durable confirmation and scoped subscriptions.
 
+The browser entry point is `createChat` from `@pmate/chat-sdk/runtime`:
+
+```ts
+const chat = createChat({ appId, accountId, profileId, teamId, token, onError })
+await chat.start()
+const page = await chat.getMessages(threadId)
+// SDK owns the page size and history boundary; hosts need not construct a cursor.
+const earlier = await chat.getMessages(threadId, { earlier: true })
+// After an authoritative mutation (e.g. history assignment), await reconciliation.
+// Concurrent refreshes share transport; errors do not masquerade as fresh cache.
+const reconciled = await chat.getMessages(threadId, { refresh: true })
+// Explicit full-history queries reuse cached pages and internally rebase expired cursors.
+const history = await chat.getMessages(threadId, { all: true })
+const off = chat.subscribe(threadId, () => render(chat.getSnapshot(threadId)))
+const offSummary = chat.subscribe(() => renderSummary(chat.getSnapshot()))
+await chat.observeMessages(threadId, visibleIds, "visible")
+// Report only the actual audio `playing` event.
+await chat.observeMessages(threadId, [voiceId], "played")
+await chat.sendMessage(threadId, { to, body, recipients })
+const readers = await chat.getReaders(threadId, messageId)
+off(); offSummary()
+await chat.close()
+```
+
+The facade owns all clients below. Message reads transparently restore IndexedDB
+windows and fetch missing ranges through the authenticated Hub. Its normalized
+messages retain the protocol body; product rendering remains with the host.
+`sendMessage` resolves after local persistence, while `outgoing` in the thread
+snapshot reports transport progress and failure. Retry uses the original message
+hash. The subscribed recent window remains 100 records regardless of individual
+query limits; history requests return their own pages and do not replace it.
+Global snapshots contain thread summaries and totals, not complete message arrays.
+Message pages report `complete`; unavailable older pages return cached records with
+`complete: false`. Authorization failures throw and never fall back to denied
+records. Thread snapshots expose `resetVersion`; hosts discard retained rows when
+it changes. Reset epochs are durable, so late cross-tab writes cannot restore a
+pre-reset payload.
+Voice visibility never acknowledges playback, including observations that arrive
+before metadata. Create a new instance and close the previous owner when the
+account or active Team changes.
+
+This facade is still under integration. Reader details currently require network
+access, global summaries do not yet replace the host's contact/thread metadata,
+and Merry's message-list/send migration and production validation are unfinished.
+The lower-level primitives remain available for custom transports:
+
 `MessageClient` reads a trusted recent window locally, coalesces concurrent misses,
 subscribes per conversation, and accepts incremental event batches. Its transport
 supplies authoritative `load`, `changes` and `older` pages. `nextBefore` tracks
@@ -157,6 +203,11 @@ legacy cleanup happens after durable migration. Normal reads use memory and writ
 are merged into bounded IndexedDB transactions. Cache errors must be surfaced by
 the host, and pending operations are not reported as saved before their promise
 resolves.
+Control-event batches are bounded by both 128 records and 1 MiB per transaction;
+the queue includes in-flight writes and is limited to 4096 records / 8 MiB.
+`transactionBytes` and `queueBytes` can lower these limits. Oversized operations
+fail before changing the memory snapshot. Repeating an in-flight write waits for
+that physical write, including its failure, rather than acknowledging it early.
 
 `DurableChatSender` saves the exact message created by `ChatClient.prepareChat`
 before transmitting it. `retry(hash)` uses `sendPrepared` with the original hash
@@ -165,7 +216,7 @@ when the connection returns. Call `confirm(hashes)` only after authoritative
 messages have been durably merged. Confirmation tombstones prevent another tab's
 late transport failure from recreating an outgoing message.
 
-These APIs are runtime primitives; applications must initialize them with the
-same authenticated scope, dispose them on identity changes, and wire their
-transport to an authorized server. The Merry migration and production validation
+Custom primitive integrations must initialize them with the same authenticated
+scope, dispose them on identity changes, and wire their transport to an authorized
+server. Standard browser integrations should use the facade instead. The Merry migration and production validation
 are tracked in the unified message layer proposal.

package/lib/runtime/chatClient.d.ts

@@ -56,6 +56,14 @@ export declare class ChatClient {
     private initialize;
     close(): void;
     connectionState(): ChatConnectionState;
+    /** Non-secret identity used to validate a shared browser transport. */
+    identityScope(): {
+        appId: string;
+        profileId: string | undefined;
+        accountId: string | undefined;
+        teamId: string | undefined;
+        clientInstanceId: string;
+    };
     watchConnection(handler: (state: ChatConnectionState) => void): () => void;
     private setConnection;
     private rejectPending;

package/lib/runtime/chatClient.js

@@ -120,6 +120,11 @@ export class ChatClient {
         this.rejectPending(new Error("ChatClient closed"));
     }
     connectionState() { return this.connection; }
+    /** Non-secret identity used to validate a shared browser transport. */
+    identityScope() {
+        const identity = this.session?.identity ?? this.session?.session?.identity;
+        return { appId: this.options.appId, profileId: this.profileIdValue ?? this.options.profileId, accountId: identity?.accountId, teamId: this.options.teamId, clientInstanceId: this.instanceId };
+    }
     watchConnection(handler) {
         this.connectionHandlers.add(handler);
         handler(this.connection);
@@ -423,10 +428,11 @@ export class ChatClient {
         return profileId;
     }
     profileId() {
-        if (!this.profileIdValue) {
+        const profileId = this.profileIdValue ?? this.options.profileId;
+        if (!profileId) {
             throw new Error("ChatClient is missing profile id; call connect() first");
         }
-        return this.profileIdValue;
+        return profileId;
     }
     async fetchProfiles(appId, accountId, token) {
         const fetcher = this.options.fetchImpl ?? fetch;

package/lib/runtime/chatSession.d.ts

@@ -1,14 +1,19 @@
+import type { ConversationReadMessage } from "./conversationRead.js";
+import { type ReadCountsResult } from "./readCounts.js";
+import type { OnlineReachEvent } from "./reach.js";
 import { type MessageReadersQuery } from "./messageReaders.js";
-import { type MessageClientOptions } from "./messageClient.js";
+import { type MessageClientOptions, type MessageSnapshot } from "./messageClient.js";
 import { DurableChatSender } from "./durableSender.js";
-import { type ReadingClientOptions } from "./readingClient.js";
-import { type ChatClientOptions } from "./chatClient.js";
+import { ReadingClient, type ReadingClientOptions } from "./readingClient.js";
+import { ChatClient, type ChatClientOptions, type ChatConnectionState } from "./chatClient.js";
 import { unreadInConversation } from "./readIndex.js";
 import type { StoredMessage } from "./messageStore.js";
 import type { ChatBody, ChatRuntimeMessage } from "./protocol.js";
 export type ChatSessionOptions<T extends StoredMessage> = {
     messages: MessageClientOptions<T>;
     connection: ChatClientOptions;
+    sharedConnection?: ChatClient;
+    activeThreadId?: string;
     reading: ReadingClientOptions;
     decode: (message: ChatRuntimeMessage) => T | undefined;
     onError: (error: unknown) => void;
@@ -17,7 +22,21 @@ export type ChatThreadSnapshot<T> = {
     messages: readonly T[];
     outgoing: ReturnType<DurableChatSender["snapshot"]>;
     hasEarlier: boolean;
-    unread: ReturnType<typeof unreadInConversation>;
+    resetVersion: number;
+    complete: boolean;
+    readCounts?: ReadCountsResult;
+    unread: ReturnType<typeof unreadInConversation> | undefined;
+};
+export type ChatSummarySnapshot<T> = {
+    threads: readonly {
+        threadId: string;
+        lastMessage?: T;
+        unread: ChatThreadSnapshot<T>["unread"];
+        outgoingCount: number;
+    }[];
+    unreadMessageCount: number | undefined;
+    badgeCount: number | undefined;
+    connection: ChatConnectionState;
 };
 /** Owns all browser message clients. Hosts subscribe to stable thread snapshots. */
 export declare class ChatSession<T extends StoredMessage> {
@@ -26,15 +45,41 @@ export declare class ChatSession<T extends StoredMessage> {
     private connection;
     private reading;
     private readers;
+    private counts?;
+    private countsReceiver?;
+    private countsThread?;
+    private countSnapshots;
+    private countClosings;
+    private countTasks;
     private sender;
     private listeners;
     private snapshots;
+    private historyEdges;
+    private earlierReads;
     private off;
+    private globalListeners;
+    private globalSnapshot?;
+    private connectionState;
+    private catchUp;
+    private readingStarted;
     private closed;
     private starting?;
+    private initializing?;
     private closing?;
     constructor(options: ChatSessionOptions<T>);
     start(): Promise<void>;
+    /** Initializes local state and background reading sync without opening a
+     * second transport when the host already owns calls/presence. */
+    initialize(): Promise<void>;
+    /** One-time migration only: never establishes trusted history coverage. */
+    importLegacyMessages(threadId: string, messages: T[]): Promise<void>;
+    getReadingSnapshot(): import("./readIndex.js").ReadIndexState | undefined;
+    subscribeReading(listener: () => void): () => void;
+    refreshReading(): void;
+    synchronizeReading(cursor?: string, profileId?: string): Promise<import("./readIndex.js").ReadIndexState>;
+    /** Explicit text-history acknowledgement; unheard audio stays unread. */
+    markRead(threadId: string, messages?: readonly ConversationReadMessage[]): Promise<import("./readIndex.js").ReadIndexState>;
+    updateReading(transform: Parameters<ReadingClient["update"]>[0]): Promise<import("./readIndex.js").ReadIndexState>;
     private assertOpen;
     getMessages(threadId: string, options?: {
         limit?: number;
@@ -42,7 +87,13 @@ export declare class ChatSession<T extends StoredMessage> {
             timestamp: number;
             id: string;
         };
-    }): Promise<import("./messageClient.js").MessageSnapshot<T>>;
+        earlier?: boolean;
+        all?: boolean;
+        refresh?: boolean;
+    }): Promise<MessageSnapshot<T>>;
+    private rememberHistoryEdge;
+    private readEarlier;
+    private readAll;
     sendMessage(threadId: string, input: {
         to: string;
         body: ChatBody;
@@ -50,10 +101,21 @@ export declare class ChatSession<T extends StoredMessage> {
     }): Promise<ChatRuntimeMessage>;
     getReaders(threadId: string, messageId: string, page?: Omit<MessageReadersQuery, "threadId" | "messageId">, signal?: AbortSignal): Promise<import("./messageReaders.js").MessageReadersPage>;
     retryMessage(messageId: string): Promise<ChatRuntimeMessage>;
-    observeMessages(threadId: string, ids: string[], event: "visible" | "played"): Promise<import("./readIndex.js").ReadIndexState>;
+    observeMessages(threadId: string, ids: string[], event: "visible" | "played"): ReturnType<ReadingClient["recordVisible"]>;
+    observeMessages(threadId: string | undefined, ids: string[], event: "receipts", clientInstanceId?: string): Promise<void>;
+    /** Bridge transports can delegate social events without maintaining clients. */
+    handleReach(event: OnlineReachEvent): Promise<"handled" | undefined>;
+    private wakeCounts;
+    private publishCountSnapshot;
+    private publishCounts;
+    private watchCounts;
+    getSnapshot(): ChatSummarySnapshot<T>;
     getSnapshot(threadId: string): ChatThreadSnapshot<T>;
-    subscribe(threadId: string, listener: () => void): () => void;
+    subscribe(listener: () => void): () => void;
+    subscribe(threadId: string, listener: () => void, fields?: readonly (keyof ChatThreadSnapshot<T>)[]): () => void;
     private publishAll;
+    private buildGlobal;
+    private publishGlobal;
     private publish;
     close(): Promise<void>;
 }