yrby-client 0.4.1 → 0.4.3
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.
- package/dist/actioncable_provider.d.ts +12 -3
- package/dist/actioncable_provider.d.ts.map +1 -1
- package/dist/actioncable_provider.js +67 -16
- package/dist/actioncable_provider.js.map +1 -1
- package/dist/cjs/actioncable_provider.d.ts +73 -0
- package/dist/cjs/actioncable_provider.js +67 -16
- package/dist/cjs/base64.d.ts +2 -0
- package/dist/cjs/index.d.ts +7 -0
- package/dist/cjs/reliable_sync.d.ts +58 -0
- package/dist/cjs/y_protocol_session.d.ts +82 -0
- package/dist/cjs/y_protocol_session.js +31 -3
- package/dist/y_protocol_session.d.ts +9 -2
- package/dist/y_protocol_session.d.ts.map +1 -1
- package/dist/y_protocol_session.js +31 -3
- package/dist/y_protocol_session.js.map +1 -1
- package/package.json +25 -10
|
@@ -18,13 +18,22 @@ export interface CableSubscription {
|
|
|
18
18
|
send(data: unknown): unknown;
|
|
19
19
|
/** AnyCable client-to-client broadcast; absent on plain ActionCable. */
|
|
20
20
|
whisper?(data: unknown): unknown;
|
|
21
|
+
/** Teardown. Present on both @rails/actioncable and @anycable/web. */
|
|
21
22
|
unsubscribe?(): void;
|
|
22
23
|
}
|
|
23
|
-
/**
|
|
24
|
+
/**
|
|
25
|
+
* The minimal slice of an ActionCable/AnyCable consumer this provider uses.
|
|
26
|
+
*
|
|
27
|
+
* Deliberately loose so the consumers from both `@rails/actioncable` and
|
|
28
|
+
* `@anycable/web` are directly assignable -- no adapter or casts. `create` is
|
|
29
|
+
* widened to the channel/params shapes both libs accept, with an optional mixin
|
|
30
|
+
* (the handlers object). There's no `subscriptions.remove`: the provider tears
|
|
31
|
+
* down via `subscription.unsubscribe()` (universal), and @anycable has no such
|
|
32
|
+
* method anyway.
|
|
33
|
+
*/
|
|
24
34
|
export interface CableConsumer {
|
|
25
35
|
subscriptions: {
|
|
26
|
-
create(
|
|
27
|
-
remove(subscription: CableSubscription): void;
|
|
36
|
+
create(channel: string | object, mixin?: object): CableSubscription;
|
|
28
37
|
};
|
|
29
38
|
}
|
|
30
39
|
export type ActionCableProviderOptions = Pick<YProtocolSessionOptions, "resendInterval" | "onError">;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actioncable_provider.d.ts","sourceRoot":"","sources":["../src/actioncable_provider.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,gBAAgB,EAAe,KAAK,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEtG,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,cAAc,CAAC;AAEpF,kDAAkD;AAClD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,oFAAoF;AACpF,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,wEAAwE;IACxE,OAAO,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IACjC,WAAW,CAAC,IAAI,IAAI,CAAC;CACtB;AAED
|
|
1
|
+
{"version":3,"file":"actioncable_provider.d.ts","sourceRoot":"","sources":["../src/actioncable_provider.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,gBAAgB,EAAe,KAAK,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEtG,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,cAAc,CAAC;AAEpF,kDAAkD;AAClD,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,oFAAoF;AACpF,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,wEAAwE;IACxE,OAAO,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IACjC,sEAAsE;IACtE,WAAW,CAAC,IAAI,IAAI,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE;QACb,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;KACrE,CAAC;CACH;AAED,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,uBAAuB,EAAE,gBAAgB,GAAG,SAAS,CAAC,CAAC;AAUrG,qBAAa,mBAAmB;;IAC9B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;gBAWjC,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,aAAa,EACvB,WAAW,EAAE,MAAM,EACnB,aAAa,GAAE,MAAW,EAC1B,IAAI,GAAE,0BAA+B;IAiBvC,mFAAmF;IACnF,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,4EAA4E;IAC5E,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAI3C,6DAA6D;IAC7D,IAAI,MAAM,IAAI,cAAc,CAE3B;IAED,oEAAoE;IACpE,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAAG,MAAM,IAAI;IAKlE,OAAO,IAAI,IAAI;IAyDf,UAAU,IAAI,IAAI;IAmBlB,OAAO,IAAI,IAAI;CAwFhB"}
|
|
@@ -29,6 +29,8 @@ export class ActionCableProvider {
|
|
|
29
29
|
#status = "disconnected";
|
|
30
30
|
#statusListeners = new Set();
|
|
31
31
|
#onUnload = null;
|
|
32
|
+
#onRestore = null;
|
|
33
|
+
#stashedPresence = null;
|
|
32
34
|
constructor(doc, consumer, channelName, channelParams = {}, opts = {}) {
|
|
33
35
|
this.doc = doc;
|
|
34
36
|
this.consumer = consumer;
|
|
@@ -81,9 +83,11 @@ export class ActionCableProvider {
|
|
|
81
83
|
const provider = this;
|
|
82
84
|
this.#subscription = this.consumer.subscriptions.create({ channel: this.channelName, ...this.channelParams }, {
|
|
83
85
|
received(message) {
|
|
84
|
-
// Reliable-delivery ack: confirm + prune the local queue.
|
|
86
|
+
// Reliable-delivery ack: confirm + prune the local queue. `dropped`
|
|
87
|
+
// marks a settle-without-record (unhealable gap) — the session prunes
|
|
88
|
+
// either way but surfaces the drop via onError("ack-dropped").
|
|
85
89
|
if (message && message.ack !== undefined) {
|
|
86
|
-
provider.session.ack(message.ack);
|
|
90
|
+
provider.session.ack(message.ack, message.dropped === true);
|
|
87
91
|
return;
|
|
88
92
|
}
|
|
89
93
|
const awarenessPayload = message && message.awareness;
|
|
@@ -119,6 +123,13 @@ export class ActionCableProvider {
|
|
|
119
123
|
provider.session.onDisconnect(); // pause retransmits, clear remote presence
|
|
120
124
|
provider.#refreshStatus(); // subscription still set -> "connecting" (retrying)
|
|
121
125
|
},
|
|
126
|
+
rejected() {
|
|
127
|
+
// The channel refused the subscription (auth, missing doc). Surface
|
|
128
|
+
// it and tear down — otherwise the provider sits at "connecting"
|
|
129
|
+
// forever, silently queueing edits. The app decides what's next.
|
|
130
|
+
provider.#onError(new Error("subscription rejected by the server"), "rejected");
|
|
131
|
+
provider.disconnect();
|
|
132
|
+
},
|
|
122
133
|
});
|
|
123
134
|
this.#installUnloadHandler();
|
|
124
135
|
this.#refreshStatus(); // -> "connecting"
|
|
@@ -135,7 +146,11 @@ export class ActionCableProvider {
|
|
|
135
146
|
this.#connected = false;
|
|
136
147
|
this.#subscription = null;
|
|
137
148
|
this.#removeUnloadHandler();
|
|
138
|
-
|
|
149
|
+
// Universal teardown: both @rails/actioncable and @anycable/web subscriptions
|
|
150
|
+
// expose unsubscribe() (Rails' just calls consumer.subscriptions.remove(this)
|
|
151
|
+
// internally). @anycable has NO consumer.subscriptions.remove, so calling that
|
|
152
|
+
// would throw there.
|
|
153
|
+
queueMicrotask(() => sub.unsubscribe?.());
|
|
139
154
|
this.#refreshStatus(); // -> "disconnected"
|
|
140
155
|
}
|
|
141
156
|
destroy() {
|
|
@@ -159,21 +174,41 @@ export class ActionCableProvider {
|
|
|
159
174
|
for (const listener of this.#statusListeners)
|
|
160
175
|
listener({ status: next });
|
|
161
176
|
}
|
|
162
|
-
//
|
|
163
|
-
//
|
|
164
|
-
//
|
|
165
|
-
//
|
|
177
|
+
// Presence teardown/restore around page lifecycle:
|
|
178
|
+
// - `pagehide`: remove local presence while the socket is still live so peers
|
|
179
|
+
// drop our cursor now (bfcache-safe; the awareness timeout is the backstop).
|
|
180
|
+
// - `pageshow` with `persisted`: the user came BACK (bfcache restore), so put
|
|
181
|
+
// their presence back — editors set awareness once at setup, so without
|
|
182
|
+
// this they'd rejoin as a ghost with no cursor.
|
|
166
183
|
#installUnloadHandler() {
|
|
167
184
|
if (typeof window === "undefined" || this.#onUnload)
|
|
168
185
|
return;
|
|
169
|
-
this.#onUnload = () =>
|
|
186
|
+
this.#onUnload = () => {
|
|
187
|
+
this.#stashedPresence = this.awareness.getLocalState();
|
|
188
|
+
this.session.removeLocalAwareness();
|
|
189
|
+
};
|
|
190
|
+
this.#onRestore = (event) => {
|
|
191
|
+
if (!event.persisted || !this.#stashedPresence)
|
|
192
|
+
return;
|
|
193
|
+
if (this.awareness.getLocalState() === null) {
|
|
194
|
+
this.awareness.setLocalState(this.#stashedPresence);
|
|
195
|
+
}
|
|
196
|
+
this.#stashedPresence = null;
|
|
197
|
+
};
|
|
170
198
|
window.addEventListener("pagehide", this.#onUnload);
|
|
199
|
+
window.addEventListener("pageshow", this.#onRestore);
|
|
171
200
|
}
|
|
172
201
|
#removeUnloadHandler() {
|
|
173
|
-
if (typeof window === "undefined"
|
|
202
|
+
if (typeof window === "undefined")
|
|
174
203
|
return;
|
|
175
|
-
|
|
176
|
-
|
|
204
|
+
if (this.#onUnload) {
|
|
205
|
+
window.removeEventListener("pagehide", this.#onUnload);
|
|
206
|
+
this.#onUnload = null;
|
|
207
|
+
}
|
|
208
|
+
if (this.#onRestore) {
|
|
209
|
+
window.removeEventListener("pageshow", this.#onRestore);
|
|
210
|
+
this.#onRestore = null;
|
|
211
|
+
}
|
|
177
212
|
}
|
|
178
213
|
// Send one raw protocol frame over the cable. Awareness frames are whispered
|
|
179
214
|
// when AnyCable exposes `subscription.whisper`; otherwise they fall back to a
|
|
@@ -186,12 +221,28 @@ export class ActionCableProvider {
|
|
|
186
221
|
return;
|
|
187
222
|
const update = toBase64(frame);
|
|
188
223
|
const isAwareness = frame[0] === MessageType.Awareness;
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
224
|
+
// Route transport failures (sync throws, or @anycable/web's rejected
|
|
225
|
+
// promises) to onError instead of letting them escape into update
|
|
226
|
+
// handlers. A failed send is recoverable: reliable frames stay queued
|
|
227
|
+
// until acked, and awareness is best-effort anyway.
|
|
228
|
+
try {
|
|
229
|
+
if (isAwareness && typeof sub.whisper === "function") {
|
|
230
|
+
this.#observe(sub.whisper({ awareness: update }));
|
|
231
|
+
return;
|
|
232
|
+
}
|
|
233
|
+
const payload = id === undefined ? { update } : { update, id };
|
|
234
|
+
this.#observe(sub.send(payload));
|
|
235
|
+
}
|
|
236
|
+
catch (error) {
|
|
237
|
+
this.#onError(error, "send");
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
// Attach a rejection handler when a transport returns a promise, so failures
|
|
241
|
+
// surface via onError instead of as unhandled rejections.
|
|
242
|
+
#observe(result) {
|
|
243
|
+
if (result instanceof Promise) {
|
|
244
|
+
result.catch((error) => this.#onError(error, "send"));
|
|
192
245
|
}
|
|
193
|
-
const payload = id === undefined ? { update } : { update, id };
|
|
194
|
-
sub.send(payload);
|
|
195
246
|
}
|
|
196
247
|
}
|
|
197
248
|
//# sourceMappingURL=actioncable_provider.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actioncable_provider.js","sourceRoot":"","sources":["../src/actioncable_provider.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,kFAAkF;AAClF,kFAAkF;AAClF,qEAAqE;AACrE,gDAAgD;AAChD,EAAE;AACF,6EAA6E;AAC7E,gFAAgF;AAChF,qCAAqC;AACrC,EAAE;AACF,iFAAiF;AACjF,oFAAoF;AACpF,wEAAwE;AACxE,kFAAkF;AAClF,2DAA2D;AAC3D,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAgC,MAAM,yBAAyB,CAAC;AACtG,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"actioncable_provider.js","sourceRoot":"","sources":["../src/actioncable_provider.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,kFAAkF;AAClF,kFAAkF;AAClF,qEAAqE;AACrE,gDAAgD;AAChD,EAAE;AACF,6EAA6E;AAC7E,gFAAgF;AAChF,qCAAqC;AACrC,EAAE;AACF,iFAAiF;AACjF,oFAAoF;AACpF,wEAAwE;AACxE,kFAAkF;AAClF,2DAA2D;AAC3D,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAgC,MAAM,yBAAyB,CAAC;AACtG,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAoDlD,MAAM,OAAO,mBAAmB;IACrB,GAAG,CAAM;IACT,QAAQ,CAAgB;IACxB,WAAW,CAAS;IACpB,aAAa,CAAS;IACtB,SAAS,CAAY;IACrB,OAAO,CAAmB;IACnC,aAAa,GAA6B,IAAI,CAAC;IAC/C,QAAQ,CAA4C;IACpD,UAAU,GAAG,KAAK,CAAC;IACnB,OAAO,GAAmB,cAAc,CAAC;IACzC,gBAAgB,GAAG,IAAI,GAAG,EAAgC,CAAC;IAC3D,SAAS,GAAwB,IAAI,CAAC;IACtC,UAAU,GAAkD,IAAI,CAAC;IACjE,gBAAgB,GAAmC,IAAI,CAAC;IAExD,YACE,GAAQ,EACR,QAAuB,EACvB,WAAmB,EACnB,gBAAwB,EAAE,EAC1B,OAAmC,EAAE;QAErC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QAEhG,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC,GAAG,EAAE;YACvC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;SAC3C,CAAC,CAAC;IACL,CAAC;IAED,mFAAmF;IACnF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,4EAA4E;IAC5E,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,MAAkB;QAClC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,6DAA6D;IAC7D,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,oEAAoE;IACpE,cAAc,CAAC,QAAsC;QACnD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CACrD,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,EACpD;YACE,QAAQ,CAAC,OAAqB;gBAC5B,oEAAoE;gBACpE,sEAAsE;gBACtE,+DAA+D;gBAC/D,IAAI,OAAO,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;oBACzC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;oBAC5D,OAAO;gBACT,CAAC;gBACD,MAAM,gBAAgB,GAAG,OAAO,IAAI,OAAO,CAAC,SAAS,CAAC;gBACtD,MAAM,OAAO,GAAG,OAAO,IAAI,CAAC,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;gBAChE,IAAI,OAAO,OAAO,KAAK,QAAQ;oBAAE,OAAO;gBACxC,oEAAoE;gBACpE,4DAA4D;gBAC5D,IAAI,KAAiB,CAAC;gBACtB,IAAI,CAAC;oBACH,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC9B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;oBACrC,OAAO;gBACT,CAAC;gBACD,IAAI,gBAAgB,KAAK,SAAS,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;oBACzE,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,kDAAkD,CAAC,EAAE,UAAU,CAAC,CAAC;oBAC7F,OAAO;gBACT,CAAC;gBACD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC9C,IAAI,KAAK;oBAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,uCAAuC;gBACpF,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC,mDAAmD;YAChF,CAAC;YACD,SAAS;gBACP,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;gBAC3B,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,sCAAsC;gBACpE,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,CAAC;YACD,YAAY;gBACV,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC;gBAC5B,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,2CAA2C;gBAC5E,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC,oDAAoD;YACjF,CAAC;YACD,QAAQ;gBACN,oEAAoE;gBACpE,iEAAiE;gBACjE,iEAAiE;gBACjE,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,qCAAqC,CAAC,EAAE,UAAU,CAAC,CAAC;gBAChF,QAAQ,CAAC,UAAU,EAAE,CAAC;YACxB,CAAC;SACF,CACF,CAAC;QACF,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7B,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,kBAAkB;IAC3C,CAAC;IAED,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,OAAO;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/B,0EAA0E;QAC1E,2EAA2E;QAC3E,iCAAiC;QACjC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACpC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,8EAA8E;QAC9E,8EAA8E;QAC9E,+EAA+E;QAC/E,qBAAqB;QACrB,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,oBAAoB;IAC7C,CAAC;IAED,OAAO;QACL,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,yBAAyB;QACnD,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,OAAO,cAAc,CAAC;QAC/C,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO,YAAY,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC;IACtD,CAAC;IAED,cAAc;QACZ,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACnC,IAAI,IAAI,KAAK,IAAI,CAAC,OAAO;YAAE,OAAO;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,gBAAgB;YAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,mDAAmD;IACnD,8EAA8E;IAC9E,+EAA+E;IAC/E,8EAA8E;IAC9E,0EAA0E;IAC1E,kDAAkD;IAClD,qBAAqB;QACnB,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5D,IAAI,CAAC,SAAS,GAAG,GAAG,EAAE;YACpB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACtC,CAAC,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,CAAC,KAA0B,EAAE,EAAE;YAC/C,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,gBAAgB;gBAAE,OAAO;YACvD,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC;gBAC5C,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACtD,CAAC;YACD,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC/B,CAAC,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACvD,CAAC;IAED,oBAAoB;QAClB,IAAI,OAAO,MAAM,KAAK,WAAW;YAAE,OAAO;QAC1C,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACvD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACxD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACzB,CAAC;IACH,CAAC;IAED,6EAA6E;IAC7E,8EAA8E;IAC9E,8EAA8E;IAC9E,6EAA6E;IAC7E,+CAA+C;IAC/C,KAAK,CAAC,KAAiB,EAAE,EAAsB;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/B,IAAI,CAAC,GAAG;YAAE,OAAO;QACjB,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC;QACvD,qEAAqE;QACrE,kEAAkE;QAClE,sEAAsE;QACtE,oDAAoD;QACpD,IAAI,CAAC;YACH,IAAI,WAAW,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;gBACrD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;gBAClD,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YAC/D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACnC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,6EAA6E;IAC7E,0DAA0D;IAC1D,QAAQ,CAAC,MAAe;QACtB,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;YAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;CACF"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { YProtocolSession, type YProtocolSessionOptions } from "./y_protocol_session.js";
|
|
2
|
+
import { Awareness } from "y-protocols/awareness";
|
|
3
|
+
import type { Doc } from "yjs";
|
|
4
|
+
/**
|
|
5
|
+
* Connection lifecycle, folded into one signal (no separate "sync" event):
|
|
6
|
+
* connecting (subscription created, transport not up yet), connected (transport
|
|
7
|
+
* up, exchanging sync steps; UI: "syncing"), synced (caught up), and disconnected
|
|
8
|
+
* (torn down via disconnect()/destroy()). A dropped transport that ActionCable
|
|
9
|
+
* will retry shows as "connecting", not "disconnected".
|
|
10
|
+
*/
|
|
11
|
+
export type ProviderStatus = "connecting" | "connected" | "synced" | "disconnected";
|
|
12
|
+
/** Payload passed to onStatusChange listeners. */
|
|
13
|
+
export interface StatusEvent {
|
|
14
|
+
status: ProviderStatus;
|
|
15
|
+
}
|
|
16
|
+
/** The minimal slice of an ActionCable/AnyCable subscription this provider uses. */
|
|
17
|
+
export interface CableSubscription {
|
|
18
|
+
send(data: unknown): unknown;
|
|
19
|
+
/** AnyCable client-to-client broadcast; absent on plain ActionCable. */
|
|
20
|
+
whisper?(data: unknown): unknown;
|
|
21
|
+
/** Teardown. Present on both @rails/actioncable and @anycable/web. */
|
|
22
|
+
unsubscribe?(): void;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* The minimal slice of an ActionCable/AnyCable consumer this provider uses.
|
|
26
|
+
*
|
|
27
|
+
* Deliberately loose so the consumers from both `@rails/actioncable` and
|
|
28
|
+
* `@anycable/web` are directly assignable -- no adapter or casts. `create` is
|
|
29
|
+
* widened to the channel/params shapes both libs accept, with an optional mixin
|
|
30
|
+
* (the handlers object). There's no `subscriptions.remove`: the provider tears
|
|
31
|
+
* down via `subscription.unsubscribe()` (universal), and @anycable has no such
|
|
32
|
+
* method anyway.
|
|
33
|
+
*/
|
|
34
|
+
export interface CableConsumer {
|
|
35
|
+
subscriptions: {
|
|
36
|
+
create(channel: string | object, mixin?: object): CableSubscription;
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
export type ActionCableProviderOptions = Pick<YProtocolSessionOptions, "resendInterval" | "onError">;
|
|
40
|
+
export declare class ActionCableProvider {
|
|
41
|
+
#private;
|
|
42
|
+
readonly doc: Doc;
|
|
43
|
+
readonly consumer: CableConsumer;
|
|
44
|
+
readonly channelName: string;
|
|
45
|
+
readonly channelParams: object;
|
|
46
|
+
readonly awareness: Awareness;
|
|
47
|
+
readonly session: YProtocolSession;
|
|
48
|
+
constructor(doc: Doc, consumer: CableConsumer, channelName: string, channelParams?: object, opts?: ActionCableProviderOptions);
|
|
49
|
+
/** True once the document has caught up with the server (received a SyncStep2). */
|
|
50
|
+
get synced(): boolean;
|
|
51
|
+
/** True while there are unacknowledged local document updates in flight. */
|
|
52
|
+
get hasPending(): boolean;
|
|
53
|
+
/**
|
|
54
|
+
* Apply a bootstrap/restore update (initial HTTP state, a server snapshot, an
|
|
55
|
+
* import) without re-sending it to the server as a local edit. Call it once per
|
|
56
|
+
* chunk of already-durable state when seeding the doc, before `connect()`:
|
|
57
|
+
*
|
|
58
|
+
* provider.applyRemoteUpdate(fromBase64(initialState));
|
|
59
|
+
* priorUpdates.forEach((u) => provider.applyRemoteUpdate(fromBase64(u)));
|
|
60
|
+
* provider.connect();
|
|
61
|
+
*
|
|
62
|
+
* See {@link YProtocolSession.applyRemoteUpdate} for why a bare `Y.applyUpdate`
|
|
63
|
+
* would be re-broadcast as a pending change instead.
|
|
64
|
+
*/
|
|
65
|
+
applyRemoteUpdate(update: Uint8Array): void;
|
|
66
|
+
/** Current connection status. See {@link ProviderStatus}. */
|
|
67
|
+
get status(): ProviderStatus;
|
|
68
|
+
/** Subscribe to status changes. Returns an unsubscribe function. */
|
|
69
|
+
onStatusChange(listener: (event: StatusEvent) => void): () => void;
|
|
70
|
+
connect(): void;
|
|
71
|
+
disconnect(): void;
|
|
72
|
+
destroy(): void;
|
|
73
|
+
}
|
|
@@ -32,6 +32,8 @@ class ActionCableProvider {
|
|
|
32
32
|
#status = "disconnected";
|
|
33
33
|
#statusListeners = new Set();
|
|
34
34
|
#onUnload = null;
|
|
35
|
+
#onRestore = null;
|
|
36
|
+
#stashedPresence = null;
|
|
35
37
|
constructor(doc, consumer, channelName, channelParams = {}, opts = {}) {
|
|
36
38
|
this.doc = doc;
|
|
37
39
|
this.consumer = consumer;
|
|
@@ -84,9 +86,11 @@ class ActionCableProvider {
|
|
|
84
86
|
const provider = this;
|
|
85
87
|
this.#subscription = this.consumer.subscriptions.create({ channel: this.channelName, ...this.channelParams }, {
|
|
86
88
|
received(message) {
|
|
87
|
-
// Reliable-delivery ack: confirm + prune the local queue.
|
|
89
|
+
// Reliable-delivery ack: confirm + prune the local queue. `dropped`
|
|
90
|
+
// marks a settle-without-record (unhealable gap) — the session prunes
|
|
91
|
+
// either way but surfaces the drop via onError("ack-dropped").
|
|
88
92
|
if (message && message.ack !== undefined) {
|
|
89
|
-
provider.session.ack(message.ack);
|
|
93
|
+
provider.session.ack(message.ack, message.dropped === true);
|
|
90
94
|
return;
|
|
91
95
|
}
|
|
92
96
|
const awarenessPayload = message && message.awareness;
|
|
@@ -122,6 +126,13 @@ class ActionCableProvider {
|
|
|
122
126
|
provider.session.onDisconnect(); // pause retransmits, clear remote presence
|
|
123
127
|
provider.#refreshStatus(); // subscription still set -> "connecting" (retrying)
|
|
124
128
|
},
|
|
129
|
+
rejected() {
|
|
130
|
+
// The channel refused the subscription (auth, missing doc). Surface
|
|
131
|
+
// it and tear down — otherwise the provider sits at "connecting"
|
|
132
|
+
// forever, silently queueing edits. The app decides what's next.
|
|
133
|
+
provider.#onError(new Error("subscription rejected by the server"), "rejected");
|
|
134
|
+
provider.disconnect();
|
|
135
|
+
},
|
|
125
136
|
});
|
|
126
137
|
this.#installUnloadHandler();
|
|
127
138
|
this.#refreshStatus(); // -> "connecting"
|
|
@@ -138,7 +149,11 @@ class ActionCableProvider {
|
|
|
138
149
|
this.#connected = false;
|
|
139
150
|
this.#subscription = null;
|
|
140
151
|
this.#removeUnloadHandler();
|
|
141
|
-
|
|
152
|
+
// Universal teardown: both @rails/actioncable and @anycable/web subscriptions
|
|
153
|
+
// expose unsubscribe() (Rails' just calls consumer.subscriptions.remove(this)
|
|
154
|
+
// internally). @anycable has NO consumer.subscriptions.remove, so calling that
|
|
155
|
+
// would throw there.
|
|
156
|
+
queueMicrotask(() => sub.unsubscribe?.());
|
|
142
157
|
this.#refreshStatus(); // -> "disconnected"
|
|
143
158
|
}
|
|
144
159
|
destroy() {
|
|
@@ -162,21 +177,41 @@ class ActionCableProvider {
|
|
|
162
177
|
for (const listener of this.#statusListeners)
|
|
163
178
|
listener({ status: next });
|
|
164
179
|
}
|
|
165
|
-
//
|
|
166
|
-
//
|
|
167
|
-
//
|
|
168
|
-
//
|
|
180
|
+
// Presence teardown/restore around page lifecycle:
|
|
181
|
+
// - `pagehide`: remove local presence while the socket is still live so peers
|
|
182
|
+
// drop our cursor now (bfcache-safe; the awareness timeout is the backstop).
|
|
183
|
+
// - `pageshow` with `persisted`: the user came BACK (bfcache restore), so put
|
|
184
|
+
// their presence back — editors set awareness once at setup, so without
|
|
185
|
+
// this they'd rejoin as a ghost with no cursor.
|
|
169
186
|
#installUnloadHandler() {
|
|
170
187
|
if (typeof window === "undefined" || this.#onUnload)
|
|
171
188
|
return;
|
|
172
|
-
this.#onUnload = () =>
|
|
189
|
+
this.#onUnload = () => {
|
|
190
|
+
this.#stashedPresence = this.awareness.getLocalState();
|
|
191
|
+
this.session.removeLocalAwareness();
|
|
192
|
+
};
|
|
193
|
+
this.#onRestore = (event) => {
|
|
194
|
+
if (!event.persisted || !this.#stashedPresence)
|
|
195
|
+
return;
|
|
196
|
+
if (this.awareness.getLocalState() === null) {
|
|
197
|
+
this.awareness.setLocalState(this.#stashedPresence);
|
|
198
|
+
}
|
|
199
|
+
this.#stashedPresence = null;
|
|
200
|
+
};
|
|
173
201
|
window.addEventListener("pagehide", this.#onUnload);
|
|
202
|
+
window.addEventListener("pageshow", this.#onRestore);
|
|
174
203
|
}
|
|
175
204
|
#removeUnloadHandler() {
|
|
176
|
-
if (typeof window === "undefined"
|
|
205
|
+
if (typeof window === "undefined")
|
|
177
206
|
return;
|
|
178
|
-
|
|
179
|
-
|
|
207
|
+
if (this.#onUnload) {
|
|
208
|
+
window.removeEventListener("pagehide", this.#onUnload);
|
|
209
|
+
this.#onUnload = null;
|
|
210
|
+
}
|
|
211
|
+
if (this.#onRestore) {
|
|
212
|
+
window.removeEventListener("pageshow", this.#onRestore);
|
|
213
|
+
this.#onRestore = null;
|
|
214
|
+
}
|
|
180
215
|
}
|
|
181
216
|
// Send one raw protocol frame over the cable. Awareness frames are whispered
|
|
182
217
|
// when AnyCable exposes `subscription.whisper`; otherwise they fall back to a
|
|
@@ -189,12 +224,28 @@ class ActionCableProvider {
|
|
|
189
224
|
return;
|
|
190
225
|
const update = (0, base64_js_1.toBase64)(frame);
|
|
191
226
|
const isAwareness = frame[0] === y_protocol_session_js_1.MessageType.Awareness;
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
227
|
+
// Route transport failures (sync throws, or @anycable/web's rejected
|
|
228
|
+
// promises) to onError instead of letting them escape into update
|
|
229
|
+
// handlers. A failed send is recoverable: reliable frames stay queued
|
|
230
|
+
// until acked, and awareness is best-effort anyway.
|
|
231
|
+
try {
|
|
232
|
+
if (isAwareness && typeof sub.whisper === "function") {
|
|
233
|
+
this.#observe(sub.whisper({ awareness: update }));
|
|
234
|
+
return;
|
|
235
|
+
}
|
|
236
|
+
const payload = id === undefined ? { update } : { update, id };
|
|
237
|
+
this.#observe(sub.send(payload));
|
|
238
|
+
}
|
|
239
|
+
catch (error) {
|
|
240
|
+
this.#onError(error, "send");
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
// Attach a rejection handler when a transport returns a promise, so failures
|
|
244
|
+
// surface via onError instead of as unhandled rejections.
|
|
245
|
+
#observe(result) {
|
|
246
|
+
if (result instanceof Promise) {
|
|
247
|
+
result.catch((error) => this.#onError(error, "send"));
|
|
195
248
|
}
|
|
196
|
-
const payload = id === undefined ? { update } : { update, id };
|
|
197
|
-
sub.send(payload);
|
|
198
249
|
}
|
|
199
250
|
}
|
|
200
251
|
exports.ActionCableProvider = ActionCableProvider;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export { ReliableSync } from "./reliable_sync.js";
|
|
2
|
+
export type { ReliableSyncOptions, TimerHandle } from "./reliable_sync.js";
|
|
3
|
+
export { YProtocolSession, MessageType } from "./y_protocol_session.js";
|
|
4
|
+
export type { YProtocolSessionOptions } from "./y_protocol_session.js";
|
|
5
|
+
export { ActionCableProvider } from "./actioncable_provider.js";
|
|
6
|
+
export type { ActionCableProviderOptions, ProviderStatus, StatusEvent, CableConsumer, CableSubscription, } from "./actioncable_provider.js";
|
|
7
|
+
export { toBase64, fromBase64 } from "./base64.js";
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/** An opaque timer handle (number in browsers, Timeout in Node). */
|
|
2
|
+
export type TimerHandle = unknown;
|
|
3
|
+
export interface ReliableSyncOptions {
|
|
4
|
+
/**
|
|
5
|
+
* Transmit one update. `update` is the raw merged update bytes; `id` is the
|
|
6
|
+
* cumulative sequence to ack against.
|
|
7
|
+
*/
|
|
8
|
+
send: (update: Uint8Array, id: number) => void;
|
|
9
|
+
/** Merge an array of update byte-arrays into one (typically Y.mergeUpdates). */
|
|
10
|
+
merge: (updates: Uint8Array[]) => Uint8Array;
|
|
11
|
+
/** Milliseconds between retransmits of the unacked tail (default 1000). */
|
|
12
|
+
resendInterval?: number;
|
|
13
|
+
/** Injectable timer hooks (default to globals); handy for tests. */
|
|
14
|
+
setInterval?: (handler: () => void, ms: number) => TimerHandle;
|
|
15
|
+
clearInterval?: (handle: TimerHandle) => void;
|
|
16
|
+
}
|
|
17
|
+
interface Pending {
|
|
18
|
+
seq: number;
|
|
19
|
+
update: Uint8Array;
|
|
20
|
+
}
|
|
21
|
+
export declare class ReliableSync {
|
|
22
|
+
#private;
|
|
23
|
+
/** Unacked local updates, in order. */
|
|
24
|
+
pending: Pending[];
|
|
25
|
+
constructor(opts: ReliableSyncOptions);
|
|
26
|
+
/** True while there are unacknowledged local updates. */
|
|
27
|
+
get hasPending(): boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Record a local document update. It is queued and the unacked tail is
|
|
30
|
+
* flushed; the update remains retained until the server acknowledges it.
|
|
31
|
+
*/
|
|
32
|
+
enqueue(update: Uint8Array): void;
|
|
33
|
+
/**
|
|
34
|
+
* Send the whole unacked tail as one merged delta. The id is the highest seq
|
|
35
|
+
* in the batch, so a single { ack } cumulatively confirms everything up to it.
|
|
36
|
+
* No-op while disconnected (the tail is replayed on the next onConnect).
|
|
37
|
+
*/
|
|
38
|
+
flush(): void;
|
|
39
|
+
/**
|
|
40
|
+
* Confirm delivery up to `id`: prune every queued update with seq <= id.
|
|
41
|
+
* Acks arrive over the wire, so validate before pruning. A malformed value
|
|
42
|
+
* (NaN/string/negative) or an impossible future id must not silently drop the
|
|
43
|
+
* queue; invalid acks are ignored.
|
|
44
|
+
*/
|
|
45
|
+
onAck(id: number): void;
|
|
46
|
+
/** Transport (re)connected: replay the unacked tail and resume retransmits. */
|
|
47
|
+
onConnect(): void;
|
|
48
|
+
/** Transport dropped: keep the queue (for reconnect replay), pause the timer. */
|
|
49
|
+
onDisconnect(): void;
|
|
50
|
+
/**
|
|
51
|
+
* One retransmit tick. Exposed for deterministic testing; normally driven by
|
|
52
|
+
* the internal timer.
|
|
53
|
+
*/
|
|
54
|
+
onTick(): void;
|
|
55
|
+
/** Stop timers and drop references. Call when the provider is destroyed. */
|
|
56
|
+
destroy(): void;
|
|
57
|
+
}
|
|
58
|
+
export {};
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { Doc } from "yjs";
|
|
2
|
+
import { type Awareness } from "y-protocols/awareness";
|
|
3
|
+
import { type TimerHandle } from "./reliable_sync.js";
|
|
4
|
+
export declare const MessageType: {
|
|
5
|
+
readonly Sync: 0;
|
|
6
|
+
readonly Awareness: 1;
|
|
7
|
+
};
|
|
8
|
+
export interface YProtocolSessionOptions {
|
|
9
|
+
/**
|
|
10
|
+
* Transmit one raw protocol frame. `id` is set only for reliable document
|
|
11
|
+
* updates (tag it onto your envelope so the server can ack). Awareness frames
|
|
12
|
+
* are identifiable by their first byte (`MessageType.Awareness`) if a transport
|
|
13
|
+
* needs to route them separately.
|
|
14
|
+
*/
|
|
15
|
+
send: (frame: Uint8Array, id: number | undefined) => void;
|
|
16
|
+
/** Optional awareness/presence. When omitted, awareness frames are ignored. */
|
|
17
|
+
awareness?: Awareness | null;
|
|
18
|
+
/** Forwarded to ReliableSync. */
|
|
19
|
+
resendInterval?: number;
|
|
20
|
+
/**
|
|
21
|
+
* Called when an incoming frame can't be decoded/applied (malformed bytes,
|
|
22
|
+
* truncated message, unexpected structure). The frame is dropped and the
|
|
23
|
+
* session keeps running. `context` names where it happened (e.g. "receive").
|
|
24
|
+
* Defaults to a `console.warn`.
|
|
25
|
+
*/
|
|
26
|
+
onError?: (error: unknown, context: string) => void;
|
|
27
|
+
/** Injectable timer hooks (forwarded to ReliableSync); handy for tests. */
|
|
28
|
+
setInterval?: (handler: () => void, ms: number) => TimerHandle;
|
|
29
|
+
clearInterval?: (handle: TimerHandle) => void;
|
|
30
|
+
}
|
|
31
|
+
export declare class YProtocolSession {
|
|
32
|
+
#private;
|
|
33
|
+
readonly doc: Doc;
|
|
34
|
+
readonly awareness: Awareness | null;
|
|
35
|
+
constructor(doc: Doc, opts: YProtocolSessionOptions);
|
|
36
|
+
/** True once we've received the server's SyncStep2 (the document is caught up). */
|
|
37
|
+
get synced(): boolean;
|
|
38
|
+
/** True while there are unacknowledged local document updates in flight. */
|
|
39
|
+
get hasPending(): boolean;
|
|
40
|
+
/** Transport connected: send the opening handshake and replay the unacked tail. */
|
|
41
|
+
onConnect(): void;
|
|
42
|
+
/** Transport dropped: pause retransmits (queue kept) and clear remote presence. */
|
|
43
|
+
onDisconnect(): void;
|
|
44
|
+
/**
|
|
45
|
+
* Broadcast that our local presence is gone (sets local state to null, which
|
|
46
|
+
* emits a removal awareness frame through `send`). Call this while the
|
|
47
|
+
* transport is still live so peers drop our cursor immediately instead of
|
|
48
|
+
* waiting for the awareness timeout. A no-op when there's no local state.
|
|
49
|
+
*/
|
|
50
|
+
removeLocalAwareness(): void;
|
|
51
|
+
/**
|
|
52
|
+
* A reliable-delivery `{ ack: id }` envelope arrived. `dropped` is set when
|
|
53
|
+
* the server settled the update WITHOUT recording it (rejected as an
|
|
54
|
+
* unhealable causal gap after repeated resyncs). The queue is pruned either
|
|
55
|
+
* way — retransmitting an unhealable update would loop forever — but a
|
|
56
|
+
* dropped settle is surfaced via onError ("ack-dropped") so the app can warn
|
|
57
|
+
* or reload instead of silently reporting synced over lost data.
|
|
58
|
+
*/
|
|
59
|
+
ack(id: number, dropped?: boolean): void;
|
|
60
|
+
/**
|
|
61
|
+
* Apply an update without treating it as a local edit, so it isn't queued for
|
|
62
|
+
* re-delivery to the server. Use it for bootstrap/restore: initial state loaded
|
|
63
|
+
* over HTTP, a server snapshot, an import. These are bytes the server already
|
|
64
|
+
* has.
|
|
65
|
+
*
|
|
66
|
+
* The session re-sends any doc update whose origin isn't itself (that's how a
|
|
67
|
+
* keystroke becomes an outbound frame), so a bare `Y.applyUpdate(doc, update)`
|
|
68
|
+
* would look like a local edit and get echoed back on the next connect. Going
|
|
69
|
+
* through here applies under the session's own origin, which the outbound
|
|
70
|
+
* filter skips. Safe to call before `onConnect()`: the state folds into the
|
|
71
|
+
* SyncStep1 handshake instead of being re-sent.
|
|
72
|
+
*/
|
|
73
|
+
applyRemoteUpdate(update: Uint8Array): void;
|
|
74
|
+
/**
|
|
75
|
+
* Decode and apply one incoming binary protocol frame (document sync or
|
|
76
|
+
* awareness). Returns a reply frame to transmit (e.g. SyncStep2 answering a
|
|
77
|
+
* SyncStep1), or null if there's nothing to send.
|
|
78
|
+
*/
|
|
79
|
+
receive(frame: Uint8Array): Uint8Array | null;
|
|
80
|
+
/** Detach doc/awareness listeners and stop retransmits. */
|
|
81
|
+
destroy(): void;
|
|
82
|
+
}
|
|
@@ -136,9 +136,19 @@ class YProtocolSession {
|
|
|
136
136
|
this.awareness.setLocalState(null); // fires "update" -> sends the removal frame
|
|
137
137
|
}
|
|
138
138
|
}
|
|
139
|
-
/**
|
|
140
|
-
|
|
139
|
+
/**
|
|
140
|
+
* A reliable-delivery `{ ack: id }` envelope arrived. `dropped` is set when
|
|
141
|
+
* the server settled the update WITHOUT recording it (rejected as an
|
|
142
|
+
* unhealable causal gap after repeated resyncs). The queue is pruned either
|
|
143
|
+
* way — retransmitting an unhealable update would loop forever — but a
|
|
144
|
+
* dropped settle is surfaced via onError ("ack-dropped") so the app can warn
|
|
145
|
+
* or reload instead of silently reporting synced over lost data.
|
|
146
|
+
*/
|
|
147
|
+
ack(id, dropped = false) {
|
|
141
148
|
this.#delivery.onAck(id);
|
|
149
|
+
if (dropped) {
|
|
150
|
+
this.#onError(new Error(`server dropped update ${id} as an unhealable causal gap; it was settled but NOT recorded`), "ack-dropped");
|
|
151
|
+
}
|
|
142
152
|
}
|
|
143
153
|
/**
|
|
144
154
|
* Apply an update without treating it as a local edit, so it isn't queued for
|
|
@@ -235,7 +245,25 @@ class YProtocolSession {
|
|
|
235
245
|
break;
|
|
236
246
|
}
|
|
237
247
|
case exports.MessageType.Awareness:
|
|
238
|
-
|
|
248
|
+
// Validate the payload's CONTENTS, not just the envelope.
|
|
249
|
+
// applyAwarenessUpdate mutates state entry by entry and only notifies
|
|
250
|
+
// listeners at the end — a bad entry mid-payload would leave earlier
|
|
251
|
+
// entries applied with no event fired. Dry-running every entry here
|
|
252
|
+
// makes the real apply infallible (and catches trailing garbage
|
|
253
|
+
// inside the blob).
|
|
254
|
+
{
|
|
255
|
+
const payload = decoding.readVarUint8Array(decoder);
|
|
256
|
+
const inner = decoding.createDecoder(payload);
|
|
257
|
+
const count = decoding.readVarUint(inner);
|
|
258
|
+
for (let i = 0; i < count; i++) {
|
|
259
|
+
decoding.readVarUint(inner); // clientID
|
|
260
|
+
decoding.readVarUint(inner); // clock
|
|
261
|
+
JSON.parse(decoding.readVarString(inner)); // state (null on removal)
|
|
262
|
+
}
|
|
263
|
+
if (decoding.hasContent(inner)) {
|
|
264
|
+
throw new Error("awareness payload has trailing bytes");
|
|
265
|
+
}
|
|
266
|
+
}
|
|
239
267
|
break;
|
|
240
268
|
default:
|
|
241
269
|
return null; // a y-protocols type yrby doesn't speak: ignore
|
|
@@ -48,8 +48,15 @@ export declare class YProtocolSession {
|
|
|
48
48
|
* waiting for the awareness timeout. A no-op when there's no local state.
|
|
49
49
|
*/
|
|
50
50
|
removeLocalAwareness(): void;
|
|
51
|
-
/**
|
|
52
|
-
|
|
51
|
+
/**
|
|
52
|
+
* A reliable-delivery `{ ack: id }` envelope arrived. `dropped` is set when
|
|
53
|
+
* the server settled the update WITHOUT recording it (rejected as an
|
|
54
|
+
* unhealable causal gap after repeated resyncs). The queue is pruned either
|
|
55
|
+
* way — retransmitting an unhealable update would loop forever — but a
|
|
56
|
+
* dropped settle is surfaced via onError ("ack-dropped") so the app can warn
|
|
57
|
+
* or reload instead of silently reporting synced over lost data.
|
|
58
|
+
*/
|
|
59
|
+
ack(id: number, dropped?: boolean): void;
|
|
53
60
|
/**
|
|
54
61
|
* Apply an update without treating it as a local edit, so it isn't queued for
|
|
55
62
|
* re-delivery to the server. Use it for bootstrap/restore: initial state loaded
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"y_protocol_session.d.ts","sourceRoot":"","sources":["../src/y_protocol_session.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,GAAG,EAA6B,MAAM,KAAK,CAAC;AAIrD,OAAO,EAIL,KAAK,SAAS,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIpE,eAAO,MAAM,WAAW;;;CAAqC,CAAC;AAE9D,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;IAC1D,+EAA+E;IAC/E,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC7B,iCAAiC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACpD,2EAA2E;IAC3E,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,WAAW,CAAC;IAC/D,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C;AAID,qBAAa,gBAAgB;;IAC3B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;gBASzB,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,uBAAuB;IA6CnD,mFAAmF;IACnF,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,4EAA4E;IAC5E,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,mFAAmF;IACnF,SAAS,IAAI,IAAI;IAQjB,mFAAmF;IACnF,YAAY,IAAI,IAAI;IASpB;;;;;OAKG;IACH,oBAAoB,IAAI,IAAI;IAM5B
|
|
1
|
+
{"version":3,"file":"y_protocol_session.d.ts","sourceRoot":"","sources":["../src/y_protocol_session.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,GAAG,EAA6B,MAAM,KAAK,CAAC;AAIrD,OAAO,EAIL,KAAK,SAAS,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAIpE,eAAO,MAAM,WAAW;;;CAAqC,CAAC;AAE9D,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;IAC1D,+EAA+E;IAC/E,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC7B,iCAAiC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACpD,2EAA2E;IAC3E,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,WAAW,CAAC;IAC/D,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C;AAID,qBAAa,gBAAgB;;IAC3B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;gBASzB,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,uBAAuB;IA6CnD,mFAAmF;IACnF,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,4EAA4E;IAC5E,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,mFAAmF;IACnF,SAAS,IAAI,IAAI;IAQjB,mFAAmF;IACnF,YAAY,IAAI,IAAI;IASpB;;;;;OAKG;IACH,oBAAoB,IAAI,IAAI;IAM5B;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,UAAQ,GAAG,IAAI;IAUtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAI3C;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI;IA8B7C,2DAA2D;IAC3D,OAAO,IAAI,IAAI;CA0EhB"}
|
|
@@ -100,9 +100,19 @@ export class YProtocolSession {
|
|
|
100
100
|
this.awareness.setLocalState(null); // fires "update" -> sends the removal frame
|
|
101
101
|
}
|
|
102
102
|
}
|
|
103
|
-
/**
|
|
104
|
-
|
|
103
|
+
/**
|
|
104
|
+
* A reliable-delivery `{ ack: id }` envelope arrived. `dropped` is set when
|
|
105
|
+
* the server settled the update WITHOUT recording it (rejected as an
|
|
106
|
+
* unhealable causal gap after repeated resyncs). The queue is pruned either
|
|
107
|
+
* way — retransmitting an unhealable update would loop forever — but a
|
|
108
|
+
* dropped settle is surfaced via onError ("ack-dropped") so the app can warn
|
|
109
|
+
* or reload instead of silently reporting synced over lost data.
|
|
110
|
+
*/
|
|
111
|
+
ack(id, dropped = false) {
|
|
105
112
|
this.#delivery.onAck(id);
|
|
113
|
+
if (dropped) {
|
|
114
|
+
this.#onError(new Error(`server dropped update ${id} as an unhealable causal gap; it was settled but NOT recorded`), "ack-dropped");
|
|
115
|
+
}
|
|
106
116
|
}
|
|
107
117
|
/**
|
|
108
118
|
* Apply an update without treating it as a local edit, so it isn't queued for
|
|
@@ -199,7 +209,25 @@ export class YProtocolSession {
|
|
|
199
209
|
break;
|
|
200
210
|
}
|
|
201
211
|
case MessageType.Awareness:
|
|
202
|
-
|
|
212
|
+
// Validate the payload's CONTENTS, not just the envelope.
|
|
213
|
+
// applyAwarenessUpdate mutates state entry by entry and only notifies
|
|
214
|
+
// listeners at the end — a bad entry mid-payload would leave earlier
|
|
215
|
+
// entries applied with no event fired. Dry-running every entry here
|
|
216
|
+
// makes the real apply infallible (and catches trailing garbage
|
|
217
|
+
// inside the blob).
|
|
218
|
+
{
|
|
219
|
+
const payload = decoding.readVarUint8Array(decoder);
|
|
220
|
+
const inner = decoding.createDecoder(payload);
|
|
221
|
+
const count = decoding.readVarUint(inner);
|
|
222
|
+
for (let i = 0; i < count; i++) {
|
|
223
|
+
decoding.readVarUint(inner); // clientID
|
|
224
|
+
decoding.readVarUint(inner); // clock
|
|
225
|
+
JSON.parse(decoding.readVarString(inner)); // state (null on removal)
|
|
226
|
+
}
|
|
227
|
+
if (decoding.hasContent(inner)) {
|
|
228
|
+
throw new Error("awareness payload has trailing bytes");
|
|
229
|
+
}
|
|
230
|
+
}
|
|
203
231
|
break;
|
|
204
232
|
default:
|
|
205
233
|
return null; // a y-protocols type yrby doesn't speak: ignore
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"y_protocol_session.js","sourceRoot":"","sources":["../src/y_protocol_session.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,kFAAkF;AAClF,2EAA2E;AAC3E,gFAAgF;AAChF,uEAAuE;AACvE,EAAE;AACF,8EAA8E;AAC9E,8EAA8E;AAC9E,wEAAwE;AACxE,sCAAsC;AACtC,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AACrD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACrG,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,GAEtB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAoB,MAAM,oBAAoB,CAAC;AAEpE,2EAA2E;AAC3E,2EAA2E;AAC3E,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAW,CAAC;AA4B9D,MAAM,OAAO,gBAAgB;IAClB,GAAG,CAAM;IACT,SAAS,CAAmB;IAErC,KAAK,CAAkC;IACvC,QAAQ,CAA4C;IACpD,OAAO,GAAG,KAAK,CAAC;IAChB,SAAS,CAAe;IACxB,YAAY,CAAgD;IAC5D,kBAAkB,CAAsD;IAExE,YAAY,GAAQ,EAAE,IAA6B;QACjD,MAAM,EACJ,IAAI,EACJ,SAAS,GAAG,IAAI,EAChB,cAAc,EACd,OAAO,EACP,WAAW,EAAE,aAAa,EAC1B,aAAa,EAAE,eAAe,GAC/B,GAAG,IAAI,IAAK,EAA8B,CAAC;QAC5C,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;QACnE,IAAI,OAAO,IAAI,KAAK,UAAU;YAAE,MAAM,IAAI,SAAS,CAAC,sDAAsD,CAAC,CAAC;QAE5G,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QAE3F,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC;YAChC,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YAC/D,cAAc;YACd,WAAW,EAAE,aAAa;YAC1B,aAAa,EAAE,eAAe;SAC/B,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,CAAC,MAAkB,EAAE,MAAe,EAAE,EAAE;YAC1D,IAAI,MAAM,KAAK,IAAI;gBAAE,OAAO,CAAC,8CAA8C;YAC3E,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,kBAAkB,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAmB,EAAE,MAAe,EAAE,EAAE;gBAC1F,wEAAwE;gBACxE,qEAAqE;gBACrE,oEAAoE;gBACpE,0BAA0B;gBAC1B,IAAI,MAAM,KAAK,IAAI;oBAAE,OAAO;gBAC5B,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC/C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,kBAAkB;YAC1E,CAAC,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,mFAAmF;IACnF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,4EAA4E;IAC5E,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;IACnC,CAAC;IAED,mFAAmF;IACnF,SAAS;QACP,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,SAAS,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC;YAC9D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;IAC7B,CAAC;IAED,mFAAmF;IACnF,YAAY;QACV,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC7F,IAAI,MAAM,CAAC,MAAM;gBAAE,qBAAqB,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,oBAAoB;QAClB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC;YAC9D,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,4CAA4C;QAClF,CAAC;IACH,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"y_protocol_session.js","sourceRoot":"","sources":["../src/y_protocol_session.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,kFAAkF;AAClF,2EAA2E;AAC3E,gFAAgF;AAChF,uEAAuE;AACvE,EAAE;AACF,8EAA8E;AAC9E,8EAA8E;AAC9E,wEAAwE;AACxE,sCAAsC;AACtC,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AACrD,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACrG,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,GAEtB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAoB,MAAM,oBAAoB,CAAC;AAEpE,2EAA2E;AAC3E,2EAA2E;AAC3E,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAW,CAAC;AA4B9D,MAAM,OAAO,gBAAgB;IAClB,GAAG,CAAM;IACT,SAAS,CAAmB;IAErC,KAAK,CAAkC;IACvC,QAAQ,CAA4C;IACpD,OAAO,GAAG,KAAK,CAAC;IAChB,SAAS,CAAe;IACxB,YAAY,CAAgD;IAC5D,kBAAkB,CAAsD;IAExE,YAAY,GAAQ,EAAE,IAA6B;QACjD,MAAM,EACJ,IAAI,EACJ,SAAS,GAAG,IAAI,EAChB,cAAc,EACd,OAAO,EACP,WAAW,EAAE,aAAa,EAC1B,aAAa,EAAE,eAAe,GAC/B,GAAG,IAAI,IAAK,EAA8B,CAAC;QAC5C,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;QACnE,IAAI,OAAO,IAAI,KAAK,UAAU;YAAE,MAAM,IAAI,SAAS,CAAC,sDAAsD,CAAC,CAAC;QAE5G,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QAE3F,IAAI,CAAC,SAAS,GAAG,IAAI,YAAY,CAAC;YAChC,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YAC/D,cAAc;YACd,WAAW,EAAE,aAAa;YAC1B,aAAa,EAAE,eAAe;SAC/B,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,CAAC,MAAkB,EAAE,MAAe,EAAE,EAAE;YAC1D,IAAI,MAAM,KAAK,IAAI;gBAAE,OAAO,CAAC,8CAA8C;YAC3E,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,kBAAkB,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAmB,EAAE,MAAe,EAAE,EAAE;gBAC1F,wEAAwE;gBACxE,qEAAqE;gBACrE,oEAAoE;gBACpE,0BAA0B;gBAC1B,IAAI,MAAM,KAAK,IAAI;oBAAE,OAAO;gBAC5B,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC/C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,kBAAkB;YAC1E,CAAC,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,mFAAmF;IACnF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,4EAA4E;IAC5E,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;IACnC,CAAC;IAED,mFAAmF;IACnF,SAAS;QACP,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,SAAS,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC;YAC9D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;IAC7B,CAAC;IAED,mFAAmF;IACnF,YAAY;QACV,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC7F,IAAI,MAAM,CAAC,MAAM;gBAAE,qBAAqB,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,oBAAoB;QAClB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC;YAC9D,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,4CAA4C;QAClF,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAAO,GAAG,KAAK;QAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,CACX,IAAI,KAAK,CAAC,yBAAyB,EAAE,+DAA+D,CAAC,EACrG,aAAa,CACd,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,MAAkB;QAClC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAiB;QACvB,2EAA2E;QAC3E,8EAA8E;QAC9E,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,aAAa,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC;YAExC,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC9C,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YAC3C,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;oBACtB,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;oBACjD,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;oBACnE,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,QAAQ,KAAK,mBAAmB;wBAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;oBAC3E,MAAM;gBACR,CAAC;gBACD,KAAK,WAAW,CAAC,SAAS;oBACxB,IAAI,IAAI,CAAC,SAAS;wBAAE,oBAAoB,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;oBACpG,MAAM;gBACR;oBACE,OAAO,IAAI,CAAC,CAAC,wEAAwE;YACzF,CAAC;YACD,OAAO,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,2DAA2D;IAC3D,OAAO;QACL,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1C,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,kBAAkB;YAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,eAAe;QACb,MAAM,CAAC,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;QACnC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAC3C,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED,YAAY,CAAC,MAAkB;QAC7B,MAAM,CAAC,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;QACnC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAC3C,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED,eAAe,CAAC,OAAiB;QAC/B,MAAM,CAAC,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;QACnC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QAChD,QAAQ,CAAC,kBAAkB,CAAC,CAAC,EAAE,qBAAqB,CAAC,IAAI,CAAC,SAAsB,EAAE,OAAO,CAAC,CAAC,CAAC;QAC5F,OAAO,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED,cAAc,CAAC,KAAiB;QAC9B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC3C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;gBACtB,MAAM,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;gBAC7B,IAAI,CAAC;oBACH,MAAM,cAAc,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;oBAChD,QAAQ,CAAC,YAAY,CAAC,cAAc,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;oBACxD,eAAe,CAAC,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;gBAC7D,CAAC;wBAAS,CAAC;oBACT,UAAU,CAAC,OAAO,EAAE,CAAC;gBACvB,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,SAAS;gBACxB,0DAA0D;gBAC1D,sEAAsE;gBACtE,qEAAqE;gBACrE,oEAAoE;gBACpE,gEAAgE;gBAChE,oBAAoB;gBACpB,CAAC;oBACC,MAAM,OAAO,GAAG,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;oBACpD,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;oBAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;oBAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;wBAC/B,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW;wBACxC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ;wBACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,0BAA0B;oBACvE,CAAC;oBACD,IAAI,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC/B,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;oBAC1D,CAAC;gBACH,CAAC;gBACD,MAAM;YACR;gBACE,OAAO,IAAI,CAAC,CAAC,gDAAgD;QACjE,CAAC;QACD,yEAAyE;QACzE,6EAA6E;QAC7E,sEAAsE;QACtE,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "yrby-client",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.3",
|
|
4
4
|
"description": "JavaScript client for the yrby y-websocket protocol: a ready-made ActionCable/AnyCable provider, a transport-agnostic protocol session (sync steps, encode/decode, awareness), and a reliable-delivery core (ack-tracked queue, sync-since-last-ack, retransmit + reconnect replay). Written in TypeScript with bundled types; ESM + CommonJS, usable from plain JS.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -8,19 +8,34 @@
|
|
|
8
8
|
"types": "./dist/index.d.ts",
|
|
9
9
|
"exports": {
|
|
10
10
|
".": {
|
|
11
|
-
"
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
"import": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
},
|
|
15
|
+
"require": {
|
|
16
|
+
"types": "./dist/cjs/index.d.ts",
|
|
17
|
+
"default": "./dist/cjs/index.js"
|
|
18
|
+
}
|
|
14
19
|
},
|
|
15
20
|
"./reliable": {
|
|
16
|
-
"
|
|
17
|
-
|
|
18
|
-
|
|
21
|
+
"import": {
|
|
22
|
+
"types": "./dist/reliable_sync.d.ts",
|
|
23
|
+
"default": "./dist/reliable_sync.js"
|
|
24
|
+
},
|
|
25
|
+
"require": {
|
|
26
|
+
"types": "./dist/cjs/reliable_sync.d.ts",
|
|
27
|
+
"default": "./dist/cjs/reliable_sync.js"
|
|
28
|
+
}
|
|
19
29
|
},
|
|
20
30
|
"./base64": {
|
|
21
|
-
"
|
|
22
|
-
|
|
23
|
-
|
|
31
|
+
"import": {
|
|
32
|
+
"types": "./dist/base64.d.ts",
|
|
33
|
+
"default": "./dist/base64.js"
|
|
34
|
+
},
|
|
35
|
+
"require": {
|
|
36
|
+
"types": "./dist/cjs/base64.d.ts",
|
|
37
|
+
"default": "./dist/cjs/base64.js"
|
|
38
|
+
}
|
|
24
39
|
}
|
|
25
40
|
},
|
|
26
41
|
"files": [
|