@pmate/chat-sdk 0.12.0-next.4 → 0.12.0-next.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +41 -1
  2. package/lib/runtime/batchedReadIndex.d.ts +11 -2
  3. package/lib/runtime/batchedReadIndex.js +21 -1
  4. package/lib/runtime/chatClient.d.ts +1 -0
  5. package/lib/runtime/chatClient.js +1 -1
  6. package/lib/runtime/chatSession.d.ts +78 -8
  7. package/lib/runtime/chatSession.js +504 -39
  8. package/lib/runtime/connectivity.d.ts +4 -0
  9. package/lib/runtime/connectivity.js +8 -0
  10. package/lib/runtime/conversationRead.d.ts +13 -0
  11. package/lib/runtime/conversationRead.js +34 -0
  12. package/lib/runtime/conversationReading.d.ts +28 -0
  13. package/lib/runtime/conversationReading.js +47 -0
  14. package/lib/runtime/createChat.d.ts +3 -0
  15. package/lib/runtime/createChat.js +18 -5
  16. package/lib/runtime/durableSender.d.ts +28 -4
  17. package/lib/runtime/durableSender.js +155 -34
  18. package/lib/runtime/index.d.ts +3 -0
  19. package/lib/runtime/index.js +3 -0
  20. package/lib/runtime/messageClient.d.ts +33 -6
  21. package/lib/runtime/messageClient.js +443 -71
  22. package/lib/runtime/messageControls.d.ts +19 -0
  23. package/lib/runtime/messageControls.js +44 -0
  24. package/lib/runtime/messageReaders.d.ts +12 -1
  25. package/lib/runtime/messageReaders.js +67 -3
  26. package/lib/runtime/messageStore.d.ts +41 -2
  27. package/lib/runtime/messageStore.js +212 -10
  28. package/lib/runtime/messageTimeline.d.ts +50 -0
  29. package/lib/runtime/messageTimeline.js +120 -0
  30. package/lib/runtime/readCounts.d.ts +15 -1
  31. package/lib/runtime/readCounts.js +96 -8
  32. package/lib/runtime/readIndex.d.ts +44 -6
  33. package/lib/runtime/readIndex.js +238 -11
  34. package/lib/runtime/readSync.d.ts +1 -0
  35. package/lib/runtime/readSync.js +21 -8
  36. package/lib/runtime/readingClient.d.ts +19 -0
  37. package/lib/runtime/readingClient.js +121 -18
  38. package/lib/runtime/readingContent.d.ts +5 -0
  39. package/lib/runtime/readingContent.js +23 -0
  40. package/lib/runtime/recordCache.d.ts +9 -0
  41. package/lib/runtime/recordCache.js +62 -5
  42. package/lib/runtime/responseCache.d.ts +44 -0
  43. package/lib/runtime/responseCache.js +173 -0
  44. package/package.json +1 -1
@@ -0,0 +1,23 @@
1
+ /** Social control envelopes do not contribute to message unread counts. */
2
+ export function isReadingControl(payload, appId) {
3
+ if (!payload || typeof payload !== "object")
4
+ return false;
5
+ const value = payload;
6
+ if (value.body !== undefined)
7
+ return isReadingControl(value.body, appId);
8
+ return value.kind === "message" && value.content?.appId === appId && (value.content.reaction !== undefined || value.content.recall !== undefined);
9
+ }
10
+ /** Mirrors the server's voice policy for ordinary and quoted wire envelopes. */
11
+ export function messageRequiresPlayback(body) {
12
+ if (!body || typeof body !== "object")
13
+ return false;
14
+ const value = body;
15
+ return value.contentKind === "voice" || value.content?.contentKind === "voice" || [value.content?.voice?.url, value.content?.content?.voice?.url].some(url => typeof url === "string" && url.length > 0);
16
+ }
17
+ export function messageMentionsProfile(body, profileId) {
18
+ if (!body || typeof body !== "object")
19
+ return false;
20
+ const content = body.content;
21
+ const mentions = content?.mentions !== undefined ? content.mentions : content?.content?.mentions;
22
+ return Array.isArray(mentions) && mentions.some(mention => mention?.id === profileId);
23
+ }
@@ -5,6 +5,8 @@ export type RecordCacheOptions<T> = {
5
5
  indexedDB?: IDBFactory;
6
6
  name?: string;
7
7
  onError?: (error: unknown) => void;
8
+ transactionBytes?: number;
9
+ queueBytes?: number;
8
10
  };
9
11
  /** In-memory control-event index backed by bounded asynchronous IndexedDB batches.
10
12
  * Legacy storage is read only during open; the hot path never uses localStorage. */
@@ -23,6 +25,11 @@ export declare class IndexedDbRecordCache<T> {
23
25
  private closing;
24
26
  private initialized;
25
27
  private running?;
28
+ private activeBytes;
29
+ private pendingBytes;
30
+ private activeRecords;
31
+ private transactionBytes;
32
+ private queueBytes;
26
33
  private channel?;
27
34
  private listeners;
28
35
  constructor(options: RecordCacheOptions<T>);
@@ -34,7 +41,9 @@ export declare class IndexedDbRecordCache<T> {
34
41
  subscribe(listener: () => void): () => void;
35
42
  private reload;
36
43
  upsert(incoming: T[]): Promise<void>;
44
+ private bytes;
37
45
  private write;
46
+ private writeBatch;
38
47
  flush(): Promise<void>;
39
48
  private runFlush;
40
49
  close(): Promise<void>;
@@ -17,17 +17,26 @@ export class IndexedDbRecordCache {
17
17
  closing = false;
18
18
  initialized = false;
19
19
  running;
20
+ activeBytes = 0;
21
+ pendingBytes = 0;
22
+ activeRecords = 0;
23
+ transactionBytes;
24
+ queueBytes;
20
25
  channel;
21
26
  listeners = new Set();
22
27
  constructor(options) {
23
28
  this.options = options;
29
+ this.transactionBytes = options.transactionBytes ?? 1_048_576;
30
+ this.queueBytes = options.queueBytes ?? 8_388_608;
31
+ if (!Number.isSafeInteger(this.transactionBytes) || this.transactionBytes < 1 || !Number.isSafeInteger(this.queueBytes) || this.queueBytes < this.transactionBytes)
32
+ throw new Error("INVALID_RECORD_CACHE_BYTE_LIMIT");
24
33
  this.db = new Dexie(options.name ?? "pmate-chat-records", { indexedDB: options.indexedDB ?? globalThis.indexedDB, IDBKeyRange: globalThis.IDBKeyRange });
25
34
  this.db.version(1).stores({ records: "[scope+id],scope", metadata: "scope" });
26
35
  this.records = this.db.table("records");
27
36
  this.metadata = this.db.table("metadata");
28
37
  this.tasks = new WindowedTasks(16, error => options.onError?.(error));
29
38
  if (typeof BroadcastChannel !== "undefined") {
30
- this.channel = new BroadcastChannel(`pmate-chat-records:${options.scope}`);
39
+ this.channel = new BroadcastChannel(`pmate-chat-records:${options.scope}${this.db.name === "pmate-chat-records" ? "" : `:${this.db.name}`}`);
31
40
  this.channel.onmessage = () => this.tasks.schedule("reload", () => this.reload());
32
41
  }
33
42
  }
@@ -83,30 +92,70 @@ export class IndexedDbRecordCache {
83
92
  await this.ready;
84
93
  if (this.closed || this.closing)
85
94
  throw new Error("RECORD_CACHE_CLOSED");
86
- if (incoming.length + this.pending.size > 4096)
95
+ if (incoming.length > 4096)
87
96
  throw new Error("RECORD_CACHE_BACKPRESSURE");
88
- let changed = false;
97
+ // Plan and validate the whole operation before publishing any in-memory state.
98
+ const staged = new Map();
89
99
  for (const value of incoming) {
90
- const key = this.options.key(value), old = this.values.get(key), next = this.options.merge(old, value);
100
+ const key = this.options.key(value), old = staged.get(key) ?? this.values.get(key);
101
+ const next = this.options.merge(old, value);
91
102
  if (JSON.stringify(old) === JSON.stringify(next))
92
103
  continue;
104
+ if (this.bytes(next) > this.transactionBytes)
105
+ throw new Error("RECORD_CACHE_RECORD_TOO_LARGE");
106
+ staged.set(key, structuredClone(next));
107
+ }
108
+ let nextBytes = this.pendingBytes, nextRecords = this.pending.size;
109
+ for (const [key, value] of staged) {
110
+ const previous = this.pending.get(key);
111
+ nextBytes += this.bytes(value) - (previous === undefined ? 0 : this.bytes(previous));
112
+ if (!this.pending.has(key))
113
+ nextRecords++;
114
+ }
115
+ if (nextRecords + this.activeRecords > 4096 || nextBytes + this.activeBytes > this.queueBytes)
116
+ throw new Error("RECORD_CACHE_BACKPRESSURE");
117
+ let changed = false;
118
+ for (const [key, next] of staged) {
93
119
  this.values.set(key, next);
94
120
  this.pending.set(key, next);
95
121
  changed = true;
96
122
  }
123
+ this.pendingBytes = nextBytes;
97
124
  if (changed)
98
125
  this.snapshotValue = [...this.values.values()];
99
- if (!changed && !this.pending.size)
126
+ if (!changed && !this.pending.size) {
127
+ await this.running;
100
128
  return;
129
+ }
101
130
  const committed = new Promise((resolve, reject) => this.waiters.push({ resolve, reject }));
102
131
  this.tasks.schedule("write", () => this.flush());
103
132
  return committed;
104
133
  }
134
+ bytes(value) { return new TextEncoder().encode(JSON.stringify({ scope: this.options.scope, id: this.options.key(value), value })).byteLength; }
105
135
  async write(values) {
136
+ let batch = [], bytes = 0;
137
+ for (const value of values) {
138
+ const size = this.bytes(value);
139
+ if (size > this.transactionBytes)
140
+ throw new Error("RECORD_CACHE_RECORD_TOO_LARGE");
141
+ if (batch.length && (batch.length === 128 || bytes + size > this.transactionBytes)) {
142
+ await this.writeBatch(batch);
143
+ batch = [];
144
+ bytes = 0;
145
+ }
146
+ batch.push(value);
147
+ bytes += size;
148
+ }
149
+ if (batch.length)
150
+ await this.writeBatch(batch);
151
+ }
152
+ async writeBatch(values) {
106
153
  await this.db.transaction("rw", this.records, async () => {
107
154
  const previous = await this.records.bulkGet(values.map(value => [this.options.scope, this.options.key(value)]));
108
155
  const records = values.map((value, index) => ({ scope: this.options.scope, id: this.options.key(value), value: this.options.merge(previous[index]?.value, value) }));
109
156
  const changed = records.filter((row, index) => JSON.stringify(previous[index]?.value) !== JSON.stringify(row.value));
157
+ if (changed.reduce((sum, row) => sum + this.bytes(row.value), 0) > this.transactionBytes)
158
+ throw new Error("RECORD_CACHE_MERGE_TOO_LARGE");
110
159
  if (changed.length)
111
160
  await this.records.bulkPut(changed);
112
161
  });
@@ -126,8 +175,11 @@ export class IndexedDbRecordCache {
126
175
  async runFlush() {
127
176
  const values = [...this.pending.values()], waiters = this.waiters.splice(0);
128
177
  this.pending.clear();
178
+ this.pendingBytes = 0;
129
179
  if (!values.length)
130
180
  return;
181
+ this.activeBytes = values.reduce((sum, value) => sum + this.bytes(value), 0);
182
+ this.activeRecords = values.length;
131
183
  try {
132
184
  for (let offset = 0; offset < values.length; offset += 128)
133
185
  await this.write(values.slice(offset, offset + 128));
@@ -142,9 +194,14 @@ export class IndexedDbRecordCache {
142
194
  const key = this.options.key(value);
143
195
  this.pending.set(key, this.options.merge(value, this.pending.get(key) ?? value));
144
196
  }
197
+ this.pendingBytes = [...this.pending.values()].reduce((sum, value) => sum + this.bytes(value), 0);
145
198
  waiters.forEach(waiter => waiter.reject(error));
146
199
  throw error;
147
200
  }
201
+ finally {
202
+ this.activeBytes = 0;
203
+ this.activeRecords = 0;
204
+ }
148
205
  }
149
206
  async close() {
150
207
  this.closing = true;
@@ -0,0 +1,44 @@
1
+ export type ResponseCacheAccess = () => Promise<{
2
+ version: number;
3
+ allowed: boolean;
4
+ }>;
5
+ export declare function isResponseCacheAuthorityError(error: unknown): boolean;
6
+ export declare function assertResponseCacheAccess(access?: ResponseCacheAccess, expectedVersion?: number): Promise<number | undefined>;
7
+ /** Small response windows, isolated by identity. Epochs fence late writes after
8
+ * access withdrawal. No localStorage or synchronous writes on the read path. */
9
+ export declare class IndexedDbResponseCache<T> {
10
+ private scope;
11
+ private options;
12
+ private db;
13
+ private rows;
14
+ private epochs;
15
+ private pending;
16
+ private tasks;
17
+ private running?;
18
+ private invalidations;
19
+ private closed;
20
+ private closing?;
21
+ constructor(scope: string, options?: {
22
+ indexedDB?: IDBFactory;
23
+ name?: string;
24
+ access?: ResponseCacheAccess;
25
+ });
26
+ /** Resolve shared message-scope authority before opening our transaction.
27
+ * A newer authority version retires response windows exactly once; delayed
28
+ * callers can never roll the authority backwards or delete recovered data. */
29
+ private synchronizeAccess;
30
+ read(key: string): Promise<{
31
+ epoch: number;
32
+ cached: {
33
+ value: T;
34
+ time: number;
35
+ } | undefined;
36
+ }>;
37
+ write(key: string, value: T, epoch: number): Promise<void>;
38
+ /** Idempotent shared-scope retirement: an old cleanup cannot erase windows
39
+ * created after the same authority version was already recovered. */
40
+ retire(version: number): Promise<void>;
41
+ invalidate(): Promise<void>;
42
+ flush(): Promise<void>;
43
+ close(): Promise<void>;
44
+ }
@@ -0,0 +1,173 @@
1
+ import { Dexie } from "dexie";
2
+ import { WindowedTasks } from "./coalescer.js";
3
+ export function isResponseCacheAuthorityError(error) {
4
+ return /RESPONSE_CACHE_(ACCESS_REVOKED|SCOPE_CHANGED|INVALIDATED)/.test(String(error));
5
+ }
6
+ export async function assertResponseCacheAccess(access, expectedVersion) {
7
+ if (!access)
8
+ return undefined;
9
+ const current = await access();
10
+ if (!current.allowed)
11
+ throw new Error("RESPONSE_CACHE_ACCESS_REVOKED");
12
+ if (expectedVersion !== undefined && current.version !== expectedVersion)
13
+ throw new Error("RESPONSE_CACHE_SCOPE_CHANGED");
14
+ return current.version;
15
+ }
16
+ /** Small response windows, isolated by identity. Epochs fence late writes after
17
+ * access withdrawal. No localStorage or synchronous writes on the read path. */
18
+ export class IndexedDbResponseCache {
19
+ scope;
20
+ options;
21
+ db;
22
+ rows;
23
+ epochs;
24
+ pending = [];
25
+ tasks = new WindowedTasks(16, () => { });
26
+ running;
27
+ invalidations = new Set();
28
+ closed = false;
29
+ closing;
30
+ constructor(scope, options = {}) {
31
+ this.scope = scope;
32
+ this.options = options;
33
+ this.db = new Dexie(options.name ?? "pmate-chat-response-windows", { indexedDB: options.indexedDB ?? globalThis.indexedDB, IDBKeyRange: globalThis.IDBKeyRange });
34
+ this.db.version(1).stores({ windows: "[scope+key],scope", epochs: "scope" });
35
+ this.rows = this.db.table("windows");
36
+ this.epochs = this.db.table("epochs");
37
+ }
38
+ /** Resolve shared message-scope authority before opening our transaction.
39
+ * A newer authority version retires response windows exactly once; delayed
40
+ * callers can never roll the authority backwards or delete recovered data. */
41
+ async synchronizeAccess() {
42
+ if (!this.options.access)
43
+ return;
44
+ const access = await this.options.access();
45
+ const stored = await this.epochs.get(this.scope);
46
+ const storedVersion = stored?.accessVersion ?? 0;
47
+ if (access.version < storedVersion)
48
+ throw new Error("RESPONSE_CACHE_SCOPE_CHANGED");
49
+ // Ordinary cache reads must not take an IndexedDB write lock. Only an
50
+ // authority transition needs the atomic epoch bump and range deletion.
51
+ if (access.version > storedVersion)
52
+ await this.db.transaction("rw", this.rows, this.epochs, async () => {
53
+ const current = await this.epochs.get(this.scope);
54
+ const version = current?.accessVersion ?? 0;
55
+ if (access.version < version)
56
+ throw new Error("RESPONSE_CACHE_SCOPE_CHANGED");
57
+ if (access.version > version) {
58
+ await this.epochs.put({ scope: this.scope, epoch: (current?.epoch ?? 0) + 1, accessVersion: access.version });
59
+ await this.rows.where("scope").equals(this.scope).delete();
60
+ }
61
+ });
62
+ if (!access.allowed)
63
+ throw new Error("RESPONSE_CACHE_ACCESS_REVOKED");
64
+ }
65
+ async read(key) {
66
+ if (this.closed)
67
+ throw new Error("RESPONSE_CACHE_CLOSED");
68
+ await this.synchronizeAccess();
69
+ return this.db.transaction("r", this.rows, this.epochs, async () => {
70
+ const epoch = (await this.epochs.get(this.scope))?.epoch ?? 0;
71
+ const row = await this.rows.get([this.scope, key]);
72
+ return { epoch, cached: row?.epoch === epoch ? { value: row.value, time: row.time } : undefined };
73
+ });
74
+ }
75
+ write(key, value, epoch) {
76
+ if (this.closed)
77
+ return Promise.reject(new Error("RESPONSE_CACHE_CLOSED"));
78
+ const copy = structuredClone(value), bytes = new TextEncoder().encode(JSON.stringify(copy)).byteLength;
79
+ // Count in-flight data as well as queued data; requests cannot create an
80
+ // unbounded backlog while IndexedDB is blocked by another tab.
81
+ if (bytes > 65536 || this.pending.length >= 128 || this.pending.reduce((n, w) => n + w.row.bytes, 0) + bytes > 1048576)
82
+ return Promise.reject(new Error("RESPONSE_CACHE_BACKPRESSURE"));
83
+ const promise = new Promise((resolve, reject) => this.pending.push({ row: { scope: this.scope, key, epoch, time: Date.now(), bytes, value: copy }, resolve, reject }));
84
+ this.tasks.schedule("write", () => this.flush());
85
+ return promise;
86
+ }
87
+ /** Idempotent shared-scope retirement: an old cleanup cannot erase windows
88
+ * created after the same authority version was already recovered. */
89
+ retire(version) {
90
+ if (this.closed)
91
+ return Promise.reject(new Error("RESPONSE_CACHE_CLOSED"));
92
+ if (!Number.isSafeInteger(version) || version < 1)
93
+ return Promise.reject(new Error("INVALID_RESPONSE_SCOPE_VERSION"));
94
+ const task = this.db.transaction("rw", this.rows, this.epochs, async () => {
95
+ const current = await this.epochs.get(this.scope);
96
+ if ((current?.accessVersion ?? 0) >= version)
97
+ return;
98
+ await this.epochs.put({ scope: this.scope, epoch: (current?.epoch ?? 0) + 1, accessVersion: version });
99
+ await this.rows.where("scope").equals(this.scope).delete();
100
+ });
101
+ this.invalidations.add(task);
102
+ return task.finally(() => this.invalidations.delete(task));
103
+ }
104
+ invalidate() {
105
+ if (this.closed)
106
+ return Promise.reject(new Error("RESPONSE_CACHE_CLOSED"));
107
+ const task = (async () => {
108
+ await this.db.transaction("rw", this.rows, this.epochs, async () => {
109
+ const current = await this.epochs.get(this.scope);
110
+ const epoch = (current?.epoch ?? 0) + 1;
111
+ await this.epochs.put({ scope: this.scope, epoch, accessVersion: current?.accessVersion });
112
+ await this.rows.where("scope").equals(this.scope).delete();
113
+ });
114
+ })();
115
+ this.invalidations.add(task);
116
+ return task.finally(() => this.invalidations.delete(task));
117
+ }
118
+ async flush() {
119
+ if (this.running) {
120
+ await this.running;
121
+ if (this.pending.length)
122
+ return this.flush();
123
+ return;
124
+ }
125
+ const batch = [...this.pending];
126
+ if (!batch.length)
127
+ return;
128
+ const task = (async () => {
129
+ try {
130
+ await this.synchronizeAccess();
131
+ const accepted = await this.db.transaction("rw", this.rows, this.epochs, async () => {
132
+ const epoch = (await this.epochs.get(this.scope))?.epoch ?? 0;
133
+ const valid = batch.filter(write => write.row.epoch === epoch);
134
+ const unique = new Map(valid.map(write => [write.row.key, write.row]));
135
+ await this.rows.bulkPut([...unique.values()]);
136
+ const stored = await this.rows.where("scope").equals(this.scope).toArray();
137
+ stored.sort((a, b) => b.time - a.time || a.key.localeCompare(b.key));
138
+ let bytes = 0;
139
+ const evicted = [];
140
+ stored.forEach((row, index) => { bytes += row.bytes; if (index >= 256 || bytes > 1048576)
141
+ evicted.push([this.scope, row.key]); });
142
+ await this.rows.bulkDelete(evicted);
143
+ return new Set(valid);
144
+ });
145
+ batch.forEach(write => accepted.has(write) ? write.resolve() : write.reject(new Error("RESPONSE_CACHE_INVALIDATED")));
146
+ }
147
+ catch (error) {
148
+ batch.forEach(write => write.reject(error));
149
+ throw error;
150
+ }
151
+ finally {
152
+ this.pending.splice(0, batch.length);
153
+ }
154
+ })().finally(() => { if (this.running === task)
155
+ this.running = undefined; });
156
+ this.running = task;
157
+ return task;
158
+ }
159
+ close() {
160
+ if (this.closing)
161
+ return this.closing;
162
+ this.closed = true;
163
+ this.tasks.close();
164
+ return this.closing = (async () => {
165
+ try {
166
+ await Promise.all([this.flush(), ...this.invalidations]);
167
+ }
168
+ finally {
169
+ this.db.close();
170
+ }
171
+ })();
172
+ }
173
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pmate/chat-sdk",
3
- "version": "0.12.0-next.4",
3
+ "version": "0.12.0-next.40",
4
4
  "description": "Cross-platform PMate chat input components, voice input primitives, and ASR helpers",
5
5
  "type": "module",
6
6
  "main": "./lib/index.js",