foldkit-sync 0.4.0 → 0.5.0
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/README.md +793 -256
- package/dist/index.d.mts +47 -7
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +77 -24
- package/dist/index.mjs.map +1 -1
- package/package.json +4 -3
package/dist/index.d.mts
CHANGED
|
@@ -304,10 +304,24 @@ interface ReplicaStatus {
|
|
|
304
304
|
interface ReplicaSnapshot<Shared> {
|
|
305
305
|
readonly status: ReplicaStatus;
|
|
306
306
|
readonly shared: Shared;
|
|
307
|
+
/** The server-confirmed state the optimistic `shared` is built on. */
|
|
308
|
+
readonly committed: Shared;
|
|
309
|
+
/**
|
|
310
|
+
* The local sequence the next submitted operation takes. Only a successful
|
|
311
|
+
* submit moves it, so a caller that submits one Message at a time can tell
|
|
312
|
+
* from one snapshot whether `shared` already holds it.
|
|
313
|
+
*/
|
|
314
|
+
readonly nextLocalSequence: LocalSequence;
|
|
307
315
|
}
|
|
308
316
|
interface Replica<Message, Shared> {
|
|
309
317
|
/** The optimistic projection: committed state with pending operations replayed. */
|
|
310
318
|
readonly shared: Effect.Effect<Shared>;
|
|
319
|
+
/**
|
|
320
|
+
* The server-confirmed state through `cursor`, with no pending operation
|
|
321
|
+
* applied. A pending edit reaches it only once the server commits it, and a
|
|
322
|
+
* rejected one never does.
|
|
323
|
+
*/
|
|
324
|
+
readonly committed: Effect.Effect<Shared>;
|
|
311
325
|
readonly pending: Effect.Effect<ReadonlyArray<Operation>>;
|
|
312
326
|
readonly cursor: Effect.Effect<Sequence>;
|
|
313
327
|
/**
|
|
@@ -322,6 +336,8 @@ interface Replica<Message, Shared> {
|
|
|
322
336
|
* submit and exchange, so a UI can subscribe once instead of to both.
|
|
323
337
|
*/
|
|
324
338
|
readonly changes: Stream.Stream<ReplicaSnapshot<Shared>>;
|
|
339
|
+
/** The status, `shared`, `committed` and next local sequence, read from one replica state. */
|
|
340
|
+
readonly snapshot: Effect.Effect<ReplicaSnapshot<Shared>>;
|
|
325
341
|
readonly submit: (message: Message) => Effect.Effect<void, ReplicaError>;
|
|
326
342
|
/** Reconciles against the server. The `Transport` service must be provided. */
|
|
327
343
|
readonly synchronize: Effect.Effect<void, ReplicaError | TransportError, Transport>;
|
|
@@ -459,14 +475,18 @@ type FragmentMessages<Fs extends readonly SyncFragment<any, any, any, any>[]> =
|
|
|
459
475
|
* projection, the declared Messages, and a read-only Surface over the
|
|
460
476
|
* projection. Exported so a consumer can name the type.
|
|
461
477
|
*/
|
|
462
|
-
interface DefinedSync<AppModel, Fields extends Schema$1.Struct.Fields, Message, Ms extends readonly unknown[], Principal = unknown
|
|
478
|
+
interface DefinedSync<AppModel, Fields extends Schema$1.Struct.Fields, Message, Ms extends readonly unknown[], Principal = unknown,
|
|
479
|
+
/** `true` when `make` was given `authorize`, so the contract's `authorize` is present. */
|
|
480
|
+
Authorized extends boolean = false> extends Sync$1<Message, Schema$1.Struct.Type<Fields>> {
|
|
463
481
|
readonly surface: Surface<AppModel, Schema$1.Struct.Type<Fields>, MsgOf<Ms>, void>;
|
|
464
482
|
readonly projection: WritableProjection<AppModel, Fields>;
|
|
483
|
+
/** The reducer the replica replays durable Messages with: derived from `update`, or `make`'s `replay`. */
|
|
484
|
+
readonly replay: (shared: Schema$1.Struct.Type<Fields>, message: Message) => Schema$1.Struct.Type<Fields>;
|
|
465
485
|
readonly messages: Ms;
|
|
466
486
|
/** For `Module`: this contract owns the shared projection's paths and records the durable tags. */
|
|
467
487
|
readonly contract: Contract;
|
|
468
488
|
/** The durable journal's codecs, reducer, and, when declared, authorization. */
|
|
469
|
-
readonly journalContract: () => PolicyJournalContract<Operation, Schema$1.Struct.Type<Fields>, Principal>;
|
|
489
|
+
readonly journalContract: () => Authorized extends true ? PolicyJournalContract<Operation, Schema$1.Struct.Type<Fields>, Principal> & Required<Pick<PolicyJournalContract<Operation, Schema$1.Struct.Type<Fields>, Principal>, 'authorize'>> : PolicyJournalContract<Operation, Schema$1.Struct.Type<Fields>, Principal>;
|
|
470
490
|
}
|
|
471
491
|
/** The sync constructors specialized to one application. */
|
|
472
492
|
interface ApplicationSync<AppModel, F extends Schema$1.Struct.Fields, Cases extends Record<string, Schema$1.Struct.Fields>, Principal = unknown> {
|
|
@@ -487,7 +507,12 @@ interface ApplicationSync<AppModel, F extends Schema$1.Struct.Fields, Cases exte
|
|
|
487
507
|
* fragment from another application throws.
|
|
488
508
|
*/
|
|
489
509
|
readonly compose: <const Fs extends readonly SyncFragment<AppModel, any, any, any>[]>(...fragments: Fs) => SyncFragment<AppModel, FragmentFields<Fs>, FragmentMessages<Fs>, FragmentConstructors<Fs>>;
|
|
490
|
-
readonly make:
|
|
510
|
+
readonly make: {
|
|
511
|
+
<Fields extends Schema$1.Struct.Fields, Subset, Ms extends readonly MessageConstructor<AppMessage<AppModel, F, Cases>>[]>(options: MakeOptions<AppModel, Fields, Subset, Ms, Principal> & {
|
|
512
|
+
readonly authorize: AuthorizePolicy<Principal, NoInfer<Fields>, NoInfer<Ms>>;
|
|
513
|
+
}): DefinedSync<AppModel, Fields, AppMessage<AppModel, F, Cases>, Ms, Principal, true>;
|
|
514
|
+
<Fields extends Schema$1.Struct.Fields, Subset, Ms extends readonly MessageConstructor<AppMessage<AppModel, F, Cases>>[]>(options: MakeOptions<AppModel, Fields, Subset, Ms, Principal>): DefinedSync<AppModel, Fields, AppMessage<AppModel, F, Cases>, Ms, Principal>;
|
|
515
|
+
};
|
|
491
516
|
}
|
|
492
517
|
/**
|
|
493
518
|
* Specializes the sync constructors to a `Surface.application`, so
|
|
@@ -529,7 +554,17 @@ interface MountOptions<Model, Message, Shared, Resources> {
|
|
|
529
554
|
*/
|
|
530
555
|
readonly onPersistenceFailure?: ((model: Model, error: ReplicaError) => Model) | undefined;
|
|
531
556
|
}
|
|
532
|
-
|
|
557
|
+
/**
|
|
558
|
+
* The shared slice as the server has confirmed it, outside the Model. It is a
|
|
559
|
+
* source for waiting consumers, the shape `Agent.when({ source })` reads, and
|
|
560
|
+
* not a Projection: it does not render and is not derived from the Model.
|
|
561
|
+
*/
|
|
562
|
+
interface CommittedView<Shared> {
|
|
563
|
+
readonly get: () => Shared;
|
|
564
|
+
/** Told after every exchange, including one that moves no cursor (a checkpoint). */
|
|
565
|
+
readonly subscribe: (listener: () => void) => () => void;
|
|
566
|
+
}
|
|
567
|
+
interface Mounted<Model, Message, Shared = unknown> {
|
|
533
568
|
/** Sends an application Message through the runtime; the `Exit` reports a decode failure. */
|
|
534
569
|
readonly dispatch: (message: Message) => Exit.Exit<void, unknown>;
|
|
535
570
|
/** The Model after the last transition. */
|
|
@@ -542,12 +577,17 @@ interface Mounted<Model, Message> {
|
|
|
542
577
|
* finishes its work. The mount's private Messages are not reported.
|
|
543
578
|
*/
|
|
544
579
|
readonly observe: (listener: (message: Message) => void) => () => void;
|
|
580
|
+
/**
|
|
581
|
+
* The shared slice without pending local edits, for an agent that must not
|
|
582
|
+
* report an optimistic edit as done: `Agent.when({ source: mounted.committed, … })`.
|
|
583
|
+
*/
|
|
584
|
+
readonly committed: CommittedView<Shared>;
|
|
545
585
|
/** Waits for in-flight persists, then disposes the runtime. The replica stays open. */
|
|
546
586
|
readonly dispose: () => Promise<void>;
|
|
547
587
|
}
|
|
548
588
|
/** The application's Message union, as `Surface.application` types it. */
|
|
549
589
|
type MessageOf<App> = App extends RunnableApplication<any, any, any, any> ? Schema$1.Schema.Type<App['Message']> : never;
|
|
550
|
-
export declare const mount: <Model, F extends Schema$1.Struct.Fields, Cases extends Record<string, Schema$1.Struct.Fields>, Fields extends Schema$1.Struct.Fields, Ms extends readonly unknown[], Resources = never, Principal = unknown>(app: RunnableApplication<Model, F, Cases, Resources>, sync: DefinedSync<Model, Fields, MessageOf<RunnableApplication<Model, F, Cases, Resources>>, Ms, Principal>, options: MountOptions<Model, MessageOf<RunnableApplication<Model, F, Cases, Resources>>, Schema$1.Struct.Type<Fields>, Resources>) => Mounted<Model, MessageOf<RunnableApplication<Model, F, Cases, Resources
|
|
590
|
+
export declare const mount: <Model, F extends Schema$1.Struct.Fields, Cases extends Record<string, Schema$1.Struct.Fields>, Fields extends Schema$1.Struct.Fields, Ms extends readonly unknown[], Resources = never, Principal = unknown>(app: RunnableApplication<Model, F, Cases, Resources>, sync: DefinedSync<Model, Fields, MessageOf<RunnableApplication<Model, F, Cases, Resources>>, Ms, Principal>, options: MountOptions<Model, MessageOf<RunnableApplication<Model, F, Cases, Resources>>, Schema$1.Struct.Type<Fields>, Resources>) => Mounted<Model, MessageOf<RunnableApplication<Model, F, Cases, Resources>>, Schema$1.Struct.Type<Fields>>;
|
|
551
591
|
//#endregion
|
|
552
592
|
//#region src/presence.d.ts
|
|
553
593
|
/** One peer's presence. A `null` value means the peer left. */
|
|
@@ -739,7 +779,7 @@ export declare const Sync: {
|
|
|
739
779
|
/** The protocol primitive, for a client with no Foldkit application to derive from. */
|
|
740
780
|
define: <Message, Shared, MessageEncoded, SharedEncoded>(definition: SyncDefinition<Message, Shared, MessageEncoded, SharedEncoded>) => Sync$1<Message, Shared>;
|
|
741
781
|
/** Runs a Foldkit application over an open replica with one reducer. */
|
|
742
|
-
mount: <Model, F extends import("effect/Schema").Struct.Fields, Cases extends Record<string, import("effect/Schema").Struct.Fields>, Fields extends import("effect/Schema").Struct.Fields, Ms extends readonly unknown[], Resources = never, Principal = unknown>(app: import("foldkit-surface").RunnableApplication<Model, F, Cases, Resources>, sync: DefinedSync<Model, Fields, import("effect/Schema").Schema.Type<import("foldkit/message").MessageUnion<Cases>>, Ms, Principal>, options: MountOptions<Model, import("effect/Schema").Schema.Type<import("foldkit/message").MessageUnion<Cases>>, import("effect/Schema").Struct.Type<Fields>, Resources>) => Mounted<Model, import("effect/Schema").Schema.Type<import("foldkit/message").MessageUnion<Cases
|
|
782
|
+
mount: <Model, F extends import("effect/Schema").Struct.Fields, Cases extends Record<string, import("effect/Schema").Struct.Fields>, Fields extends import("effect/Schema").Struct.Fields, Ms extends readonly unknown[], Resources = never, Principal = unknown>(app: import("foldkit-surface").RunnableApplication<Model, F, Cases, Resources>, sync: DefinedSync<Model, Fields, import("effect/Schema").Schema.Type<import("foldkit/message").MessageUnion<Cases>>, Ms, Principal>, options: MountOptions<Model, import("effect/Schema").Schema.Type<import("foldkit/message").MessageUnion<Cases>>, import("effect/Schema").Struct.Type<Fields>, Resources>) => Mounted<Model, import("effect/Schema").Schema.Type<import("foldkit/message").MessageUnion<Cases>>, import("effect/Schema").Struct.Type<Fields>>;
|
|
743
783
|
/** Counters and a histogram an application can scrape. */
|
|
744
784
|
metrics: {
|
|
745
785
|
exchanges: import("effect/Metric").Counter<number>;
|
|
@@ -842,5 +882,5 @@ export declare const Sync: {
|
|
|
842
882
|
};
|
|
843
883
|
};
|
|
844
884
|
//#endregion
|
|
845
|
-
export type { ApplicationSync, AuthorizePolicy, AuthorizeRequest, Checkpoint, CommittedOperation, DefinedSync, Exchange, ExchangeFrame, ExchangeReply, FragmentMessages, JournalContract, LwwClock, LwwClockState, MakeOptions, MountOptions, MountUrl, Mounted, MsgOf, Operation, PolicyJournalContract, Presence, PresenceChannel, PresenceHub, PresenceOptions, PresencePeer, PresenceUpdate, Replica, ReplicaError, ReplicaSnapshot, ReplicaState, ReplicaStatus, SocketLike, SocketOptions, Storage, SyncDefinition, SyncFragment, TransportClient, TransportShape };
|
|
885
|
+
export type { ApplicationSync, AuthorizePolicy, AuthorizeRequest, Checkpoint, CommittedOperation, CommittedView, DefinedSync, Exchange, ExchangeFrame, ExchangeReply, FragmentMessages, JournalContract, LwwClock, LwwClockState, MakeOptions, MountOptions, MountUrl, Mounted, MsgOf, Operation, PolicyJournalContract, Presence, PresenceChannel, PresenceHub, PresenceOptions, PresencePeer, PresenceUpdate, Replica, ReplicaError, ReplicaSnapshot, ReplicaState, ReplicaStatus, SocketLike, SocketOptions, Storage, SyncDefinition, SyncFragment, TransportClient, TransportShape };
|
|
846
886
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/ids.ts","../src/errors.ts","../src/indexedDb.ts","../src/transport.ts","../src/sync.ts","../src/make.ts","../src/mount.ts","../src/presence.ts","../src/lww.ts","../src/index.ts"],"mappings":";;;;;;;;qBAGa,YAAU,SAAA,MAAA,SAAA;YACX,oBAAoB,WAAW;;qBAG9B,WAAS,SAAA,MAAA,SAAA;YACV,mBAAmB,UAAU;;qBAG5B,MAAI,SAAA,MAAA,SAAA;YACL,cAAc,KAAK;;;;;qBAMlB,UAAQ,SAAA,MAAA,SAAA;YAKT,kBAAkB,SAAS;;qBAG1B,eAAa,SAAA,MAAA,SAAA;YAKd,uBAAuB,cAAc;;;;;;qBAOpC,aAAc,kBAAgB;qBAC9B,YAAa,kBAAgB;qBAC7B,OAAQ,kBAAgB;qBACxB,WAAY,kBAAgB;qBAC5B,gBAAiB,kBAAgB;;;;;;;;qBCvCjC,qBAAqB;;;;;;qBAMrB,qCAAqC;;;;;;;qBASrC,iCAAiC;;;;;;qBAUjC,mCAAmC;;;;;;qBASnC,6BAA6B;;;;;qBAS7B,2BAA2B;;;;;;;qBAQ3B,kCAAkC;;;;;;;qBAUlC,4BAA4B;;;;;;qBAU5B,8BAA8B;;;;;;;;;;qBAa9B,oCAAoC;;;;;qBASpC,2BAA2B;;;;;;;qBAQ3B,uCAAuC;;;;;;;;;qBAavC,oBAAoB;KAKrB,eACR,eACA,cACA,2BACA,6BACA,uBACA,iCACA,qBACA,4BACA,sBACA,wBACA,8BACA;;;;UClIa;EACf,YAAY,OAAO,gBAAgB;EACnC,OAAO,gBAAgB,oCAAoC,OAAO,aAAa;;EAE/E,OAAO,OAAO;;;qBA6BH,YAAS,eAAA,OAAA,gBAAA,UAAA,2BAAA,OAAA,OAAA,SAAA,cAAA,MAAA;;;;;;;qBChCT,uBAAuB;;UAKnB;WACN;WACA;WACA,SAAS,cAAc;;UAGjB;WACN;WACA;WACA;;UAGM;WACN,WACP,gBACA,SAAS,cAAc,eACpB,OAAO,gBAAgB;;;;;;;;;;qBAUjB,kBAAkB;;qBAQlB,gBACX,UAAU,gBAAgB,SAAS,cAAc,yBAAyB,qBACzE,MAAM,MAAM;;qBAOF,mBAAoB,WAAW,oBAAkB,MAAM,MAAM;;qBAU7D,YAAa,WAAW,mBAAiB;;;;;;;;qBAWzC,cACX,QAAQ,YACR;WACW,WACP,gBACA,SAAS,cAAc,yBACV;;;UAgDF;EACf,KAAK;EACL;EACA,UAAU,WAAW;EACrB,QAAQ;;;;;EAKR,QAAQ;;UAGO;WACN;;WAEA,eAAe,gBAAgB;;WAE/B;;WAEA,YAAY,SAAS;;WAErB;;;qBAIE,eAAgB,gBAAc;;;;;;;;;;;;qBAqC9B,cAAe,SAAS,kBAAgB,MAAM,MAAM,WAAW;;;;cClKtE;cACA;;cAGA,iBAAe,SAAA;;;;;;;;;;KAUT,mBAAmB,gBAAgB;;cAGzC,iBAAe,SAAA;;;;;;;;;;;;;KAMT,4BAA4B,gBAAgB;;qBAc3C;;;;;;UASI,WAAW;WACjB,QAAQ;WACR,OAAO;;UAGD,SAAS;;WAEf,YAAY;WACZ,UAAU,cAAc;;WAExB,eAAe,cAAc;;WAE7B,aAAa,WAAW;;UAGlB,aAAa;WACnB,wBAAwB;WACxB,sBAAsB;WACtB,YAAY;WACZ,WAAW;WACX;WACA,mBAAmB;WACnB,QAAQ;WACR,WAAW;WACX,cAAc;WACd,SAAS,cAAc;;;;;;UAOjB;EACf,SAAS,QAAQ,UAAU,SAAS,cAAc,aAAa;;;UAIhD;WACN;WACA,QAAQ;;WAER;;WAEA,UAAU,cAAc;;;;;;UAOlB,gBAAgB;WACtB,QAAQ;WACR,QAAQ;;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/ids.ts","../src/errors.ts","../src/indexedDb.ts","../src/transport.ts","../src/sync.ts","../src/make.ts","../src/mount.ts","../src/presence.ts","../src/lww.ts","../src/index.ts"],"mappings":";;;;;;;;qBAGa,YAAU,SAAA,MAAA,SAAA;YACX,oBAAoB,WAAW;;qBAG9B,WAAS,SAAA,MAAA,SAAA;YACV,mBAAmB,UAAU;;qBAG5B,MAAI,SAAA,MAAA,SAAA;YACL,cAAc,KAAK;;;;;qBAMlB,UAAQ,SAAA,MAAA,SAAA;YAKT,kBAAkB,SAAS;;qBAG1B,eAAa,SAAA,MAAA,SAAA;YAKd,uBAAuB,cAAc;;;;;;qBAOpC,aAAc,kBAAgB;qBAC9B,YAAa,kBAAgB;qBAC7B,OAAQ,kBAAgB;qBACxB,WAAY,kBAAgB;qBAC5B,gBAAiB,kBAAgB;;;;;;;;qBCvCjC,qBAAqB;;;;;;qBAMrB,qCAAqC;;;;;;;qBASrC,iCAAiC;;;;;;qBAUjC,mCAAmC;;;;;;qBASnC,6BAA6B;;;;;qBAS7B,2BAA2B;;;;;;;qBAQ3B,kCAAkC;;;;;;;qBAUlC,4BAA4B;;;;;;qBAU5B,8BAA8B;;;;;;;;;;qBAa9B,oCAAoC;;;;;qBASpC,2BAA2B;;;;;;;qBAQ3B,uCAAuC;;;;;;;;;qBAavC,oBAAoB;KAKrB,eACR,eACA,cACA,2BACA,6BACA,uBACA,iCACA,qBACA,4BACA,sBACA,wBACA,8BACA;;;;UClIa;EACf,YAAY,OAAO,gBAAgB;EACnC,OAAO,gBAAgB,oCAAoC,OAAO,aAAa;;EAE/E,OAAO,OAAO;;;qBA6BH,YAAS,eAAA,OAAA,gBAAA,UAAA,2BAAA,OAAA,OAAA,SAAA,cAAA,MAAA;;;;;;;qBChCT,uBAAuB;;UAKnB;WACN;WACA;WACA,SAAS,cAAc;;UAGjB;WACN;WACA;WACA;;UAGM;WACN,WACP,gBACA,SAAS,cAAc,eACpB,OAAO,gBAAgB;;;;;;;;;;qBAUjB,kBAAkB;;qBAQlB,gBACX,UAAU,gBAAgB,SAAS,cAAc,yBAAyB,qBACzE,MAAM,MAAM;;qBAOF,mBAAoB,WAAW,oBAAkB,MAAM,MAAM;;qBAU7D,YAAa,WAAW,mBAAiB;;;;;;;;qBAWzC,cACX,QAAQ,YACR;WACW,WACP,gBACA,SAAS,cAAc,yBACV;;;UAgDF;EACf,KAAK;EACL;EACA,UAAU,WAAW;EACrB,QAAQ;;;;;EAKR,QAAQ;;UAGO;WACN;;WAEA,eAAe,gBAAgB;;WAE/B;;WAEA,YAAY,SAAS;;WAErB;;;qBAIE,eAAgB,gBAAc;;;;;;;;;;;;qBAqC9B,cAAe,SAAS,kBAAgB,MAAM,MAAM,WAAW;;;;cClKtE;cACA;;cAGA,iBAAe,SAAA;;;;;;;;;;KAUT,mBAAmB,gBAAgB;;cAGzC,iBAAe,SAAA;;;;;;;;;;;;;KAMT,4BAA4B,gBAAgB;;qBAc3C;;;;;;UASI,WAAW;WACjB,QAAQ;WACR,OAAO;;UAGD,SAAS;;WAEf,YAAY;WACZ,UAAU,cAAc;;WAExB,eAAe,cAAc;;WAE7B,aAAa,WAAW;;UAGlB,aAAa;WACnB,wBAAwB;WACxB,sBAAsB;WACtB,YAAY;WACZ,WAAW;WACX;WACA,mBAAmB;WACnB,QAAQ;WACR,WAAW;WACX,cAAc;WACd,SAAS,cAAc;;;;;;UAOjB;EACf,SAAS,QAAQ,UAAU,SAAS,cAAc,aAAa;;;UAIhD;WACN;WACA,QAAQ;;WAER;;WAEA,UAAU,cAAc;;;;;;UAOlB,gBAAgB;WACtB,QAAQ;WACR,QAAQ;;WAER,WAAW;;;;;;WAMX,mBAAmB;;UAGb,QAAQ,SAAS;;WAEvB,QAAQ,OAAO,OAAO;;;;;;WAMtB,WAAW,OAAO,OAAO;WACzB,SAAS,OAAO,OAAO,cAAc;WACrC,QAAQ,OAAO,OAAO;;;;;WAKtB,QAAQ,OAAO,OAAO;;WAEtB,eAAe,OAAO,OAAO;;;;;WAK7B,SAAS,OAAO,OAAO,gBAAgB;;WAEvC,UAAU,OAAO,OAAO,gBAAgB;WACxC,SAAS,SAAS,YAAY,OAAO,aAAa;;WAElD,aAAa,OAAO,aAAa,eAAe,gBAAgB;;;;;;;WAOhE,OAAO,OAAO,oBAAoB;WAClC,OAAO,OAAO;;UAGR,eAAe,SAAS,QAAQ,gBAAgB;WACtD,YAAY;WACZ,SAAS,SAAO,MAAM,SAAS;WAC/B,QAAQ,SAAO,MAAM,QAAQ;WAC7B,OAAO;WACP,UAAU,SAAS;WACnB,SAAS,QAAQ,QAAQ,SAAS,YAAY;;UAGxC,OAAK,SAAS;WACpB,YAAY;;;;;;WAMZ;aACE,qBAAqB,mBAAmB;aACxC,gBAAgB,gBAAgB,YAAY,eAAe;aAC3D,gBAAgB,gBAAgB,YAAY,eAAe;aAC3D,iBAAiB,mBAAmB,SAAS;;;WAG/C,uBAAuB,gBAAgB,WAAW;WAClD,cACP,WAAW,WACX,SAAS,YACN,OAAO,OAAO,QAAQ,SAAS,SAAS;;;UAI9B,gBAAgB,WAAW;WACjC;;aAEE,SAAS,WAAW,cAAc;aAClC,SAAS,mBAAmB;;WAE9B;aACE,SAAS,UAAU;aACnB,SAAS,mBAAmB;;WAE9B,aAAa;WACb,SAAS,UAAU,QAAQ,WAAW,cAAc;;;;;;;;;qBAUlD,aAAc,SAAS,QAAQ,gBAAgB,eAC1D,YAAY,eAAe,SAAS,QAAQ,gBAAgB,mBAC3D,OAAK,SAAS;;;KChNZ,mBAAmB,eAAe,kBAAkB;;KAG7C,MAAM,iCAAiC,wBAAuB,wBAAwB,KAC9F;KAGC,WACH,UACA,UAAU,SAAO,OAAO,QACxB,cAAc,eAAe,SAAO,OAAO,WACzC,SAAO,OAAO,KAAK,SAAS,UAAU,GAAG;;KAUxC,MAAM,KAAK,eAAc,wBAAwB,KAClD;WAAqB,YAAY;IAC/B;;;;;UAQW,sBAAsB,WAAW,QAAQ,mBAAmB,gBAC3E,WACA;WAES,aAAa;aACX,WAAW;aACX,WAAW;aACX,UAAU;;;;UAKN,iBAAiB,WAAW,SAAS;WAC3C,WAAW;WACX,SAAS;WACT,QAAQ;;;;;;;KAQP,gBACV,WACA,eAAe,SAAO,OAAO,QAC7B,6CAEU,KAAK,MAAM,gBACnB,SAAS,iBACP,WACA,QAAQ,MAAM;WAAgB,MAAM;IACpC,SAAO,OAAO,KAAK;UAKf,YACR,WACA,eAAe,SAAO,OAAO,QAC7B;WAES,YAAY;;WAEZ;;;;;;;WAOA,UACP,QAAQ,SAAO,OAAO,KAAK,QAAQ,UACnC,SAAS,MAAM,QAAQ,SACpB,SAAO,OAAO,KAAK,QAAQ;;WAEvB,YAAY,gBAAgB,WAAW,QAAQ,SAAS,QAAQ;;UAG1D,YACf,UACA,eAAe,SAAO,OAAO,QAC7B,QACA,oBAAoB,2BACpB,6BACQ,YAAY,WAAW,QAAQ;;WAE9B,QAAQ,mBAAmB,UAAU;;WAErC,SAAS,WAAW,eAAe,QAAQ;;;;;;;;UASrC,aACf,UACA,eAAe,SAAO,OAAO,QAC7B,QACA,oBAAoB;WAEX,QAAQ,mBAAmB,UAAU;WACrC,SAAS,WAAW,eAAe,QAAQ;;KAGjD,SAAS,oBAAoB,kDACtB,WAAW,KAAK,GAAG;KAE1B,UAAU,oBAAoB,kDACvB,WAAW,KAAK,GAAG;;KAGnB,eAAe,oBAAoB,sCAAsC,YACnF,SAAS;;KAGC,qBAAqB,oBAAoB,sCACnD,kBAAkB,UAAU;;KAGlB,iBAAiB,oBAAoB,sCAC/C,mBAAmB,6BAA6B,UAAU;;;;;;UAO3C,YACf,UACA,eAAe,SAAO,OAAO,QAC7B,SACA,+BACA;;AAEA,4CACQ,OAAK,SAAS,SAAO,OAAO,KAAK;WAChC,SAAS,QAAQ,UAAU,SAAO,OAAO,KAAK,SAAS,MAAM;WAC7D,YAAY,mBAAmB,UAAU;;WAEzC,SACP,QAAQ,SAAO,OAAO,KAAK,SAC3B,SAAS,YACN,SAAO,OAAO,KAAK;WACf,UAAU;;WAEV,UAAU;;WAEV,uBAAuB,0BAC5B,sBAAsB,WAAW,SAAO,OAAO,KAAK,SAAS,aAC3D,SACE,KAAK,sBAAsB,WAAW,SAAO,OAAO,KAAK,SAAS,4BAEtE,sBAAsB,WAAW,SAAO,OAAO,KAAK,SAAS;;;UAIlD,gBACf,UACA,UAAU,SAAO,OAAO,QACxB,cAAc,eAAe,SAAO,OAAO,SAC3C;;;;;;WAOS,gBAAgB,QAAQ,gBAAgB,UAAU,GAAG,OAAO;;WAE5D,WACP,eAAe,SAAO,OAAO,QAC7B,QACA,oBAAoB,mBAAmB,WAAW,UAAU,GAAG,WAC/D;aACS,QAAQ,mBAAmB,UAAU;aACrC,SAAS,WAAW,eAAe,QAAQ;QAChD,aAAa,UAAU,QAAQ,QAAQ;;;;;;WAMpC,gBAAgB,oBAAoB,aAAa,+BACrD,WAAW,OACX,aAAa,UAAU,eAAe,KAAK,iBAAiB,KAAK,qBAAqB;WAClF;KAEL,eAAe,SAAO,OAAO,QAC7B,QACA,oBAAoB,mBAAmB,WAAW,UAAU,GAAG,WAE/D,SAAS,YAAY,UAAU,QAAQ,QAAQ,IAAI;eACxC,WAAW,gBAAgB,WAAW,QAAQ,SAAS,QAAQ;QAEzE,YAAY,UAAU,QAAQ,WAAW,UAAU,GAAG,QAAQ,IAAI;KAEnE,eAAe,SAAO,OAAO,QAC7B,QACA,oBAAoB,mBAAmB,WAAW,UAAU,GAAG,WAE/D,SAAS,YAAY,UAAU,QAAQ,QAAQ,IAAI,aAClD,YAAY,UAAU,QAAQ,WAAW,UAAU,GAAG,QAAQ,IAAI;;;;;;;;;;;qBAsF5D,iBACX,UACA,UAAU,SAAO,OAAO,QACxB,cAAc,eAAe,SAAO,OAAO,SAE3C,KAAK,oBAAoB,UAAU,GAAG,gBACrC,gBAAgB,UAAU,GAAG;;;;;;;;;;;UC5Rf,SAAS,OAAO;WACtB,SAAS,OAAO,OAAO,KAAK,IAAI,QAAQ;WACxC,cAAc,KAAK,IAAI,QAAQ;WAC/B,iBAAiB,SAAS,eAAe;;UAGnC,aAAa,OAAO,SAAS,QAAQ;;WAE3C,SAAS,QAAQ,SAAS;;WAE1B,WAAW;WACX,OAAO,OAAO,OAAO,GAAG,YAAY,aAAa;WACjD,gBAAgB,cAAc,OAAO,SAAS;WAC9C,YAAY,MAAM,MAAM;;WAExB,MAAM,SAAS,OAAO;;;;;WAKtB,yBAAyB,OAAO,OAAO,OAAO,iBAAiB;;;;;;;UAQzD,cAAc;WACpB,WAAW;;WAEX,YAAY;;UAGN,QAAQ,OAAO,SAAS;;WAE9B,WAAW,SAAS,YAAY,KAAK;;WAErC,aAAa;;WAEb,YAAY;;;;;;WAMZ,UAAU,WAAW,SAAS;;;;;WAK9B,WAAW,cAAc;;WAEzB,eAAe;;;KAoCrB,UAAU,OACb,YAAY,0CAA0C,SAAO,OAAO,KAAK;qBAE9D,QACX,OACA,UAAU,SAAO,OAAO,QACxB,cAAc,eAAe,SAAO,OAAO,SAC3C,eAAe,SAAO,OAAO,QAC7B,+BACA,mBACA,qBAEA,KAAK,oBAAoB,OAAO,GAAG,OAAO,YAC1C,MAAM,YACJ,OACA,QACA,UAAU,oBAAoB,OAAO,GAAG,OAAO,aAC/C,IACA,YAEF,SAAS,aACP,OACA,UAAU,oBAAoB,OAAO,GAAG,OAAO,aAC/C,SAAO,OAAO,KAAK,SACnB,eAED,QACD,OACA,UAAU,oBAAoB,OAAO,GAAG,OAAO,aAC/C,SAAO,OAAO,KAAK;;;;UC/JJ,eAAe;WACrB;WACA,OAAO;;;;;;;;;;UAWD,gBAAgB;WACtB,SAAS,OAAO,OAAO,eAAe;WACtC,UAAU,QAAQ,eAAe,YAAY,OAAO;;UAG9C,gBAAgB;;WAEtB;;WAEA,KAAK,SAAS;;;;;;WAMd,cAAc,mBAAmB;WACjC,UAAU,gBAAgB;;UAGpB,aAAa;WACnB;WACA,OAAO;WACP;;UAGM,SAAS;;WAEf,MAAM,OAAO,WAAW,OAAO;;WAE/B,OAAO,OAAO;;WAEd,OAAO,OAAO,OAAO,cAAc,aAAa;;WAEhD,OAAO,OAAO;;WAEd,YAAY;;;;;WAKZ,SAAS,OAAO,OAAO,cAAc,aAAa;;WAElD,OAAO,OAAO;;;;;;;;;qBAUZ,iBAAyD,QAAM,SAAA,gBAAA,YAAA,OAAA;;;;IAhC7D;;IAEO;;;EA6II,YAAA;;IA/IX;;IAEO;;;UAuJpB,MAAA;;qBAGW,0BAA2E,aAAM,OAAA;;EAIxE,UAAA,QAAA,eAAe,YAAO,OAAA;;;UAK3B,YAAY;;EAE3B,KAAK,OAAO,QAAQ,eAAe;;EAEnC,QAAQ,QAAQ,eAAe;;qBAGpB,oBAAqB,aAAW,YAAY;;;;;qBA6C5C,wBAAyB,QACpC,QAAQ,eACP,OAAO,OAAO,gBAAgB,gBAAgB,MAAM;;qBAsB1C,gBAAiB,QAC5B,QAAQ,YACR,KAAK,YAAY,SACjB;WAAoB;;;;;cCnRhB,OAAK,SAAA;;;;cAYL,YAAU,SAAA;;;;;;KAOJ,uBAAuB,WAAW;UAE7B;;EAEf,OAAO,6BAA6B,OAAO,cAAc,MAAM,MAAM;;EAErE,OAAO,OAAO;;;;;;;;;;qBAuCH,eAAY;WAEA,YAAA;WACD,WAAA;WACF,SAAA;;;;;;;GAgErB,eAAA;;;;;;qBAOY,cAAe,OAAO,SAAS,IAAI,IAC9C,OAAO,SAAO,MAAM,OAAO,SAAS,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YC1G9B,KAAK,SAAS,UAAU,OAAa,SAAS;;qBAG7C"}
|
package/dist/index.mjs
CHANGED
|
@@ -720,7 +720,9 @@ const defineSync = (definition) => {
|
|
|
720
720
|
lastError: yield* Ref.get(lastError),
|
|
721
721
|
rejected: yield* Ref.get(rejectedOps)
|
|
722
722
|
},
|
|
723
|
-
shared: projected
|
|
723
|
+
shared: projected,
|
|
724
|
+
committed: current.committed,
|
|
725
|
+
nextLocalSequence: current.nextLocalSequence
|
|
724
726
|
};
|
|
725
727
|
})();
|
|
726
728
|
const shared = Effect.map(snapshot, (value) => value.shared);
|
|
@@ -878,6 +880,8 @@ const defineSync = (definition) => {
|
|
|
878
880
|
});
|
|
879
881
|
return {
|
|
880
882
|
shared,
|
|
883
|
+
snapshot,
|
|
884
|
+
committed: Effect.map(SynchronizedRef.get(stateRef), (state) => state.committed),
|
|
881
885
|
pending: Effect.map(SynchronizedRef.get(stateRef), (state) => state.pending),
|
|
882
886
|
cursor: Effect.map(SynchronizedRef.get(stateRef), (state) => state.cursor),
|
|
883
887
|
status,
|
|
@@ -972,10 +976,11 @@ const build = (app) => {
|
|
|
972
976
|
if (durable.owner !== app.owner) throw new Error("Sync.make: the durable subset belongs to a different application");
|
|
973
977
|
const replay = options.replay === void 0 ? derivedReplay(app, shared) : (value, message) => options.replay(value, message);
|
|
974
978
|
const durableTags = new Set(durable.constructors.map(messageTag).filter((tag) => tag !== void 0));
|
|
979
|
+
const sharedCodec = shared.schema;
|
|
975
980
|
const sync = defineSync({
|
|
976
981
|
documentId: options.documentId,
|
|
977
982
|
message: app.Message,
|
|
978
|
-
shared:
|
|
983
|
+
shared: sharedCodec,
|
|
979
984
|
empty: shared.get(app.initial),
|
|
980
985
|
durable: (message) => {
|
|
981
986
|
const tag = message._tag;
|
|
@@ -1000,13 +1005,7 @@ const build = (app) => {
|
|
|
1000
1005
|
}
|
|
1001
1006
|
};
|
|
1002
1007
|
};
|
|
1003
|
-
const readOnly = {
|
|
1004
|
-
Model: shared.schema,
|
|
1005
|
-
dependencies: shared.dependencies,
|
|
1006
|
-
requirements: [],
|
|
1007
|
-
connections: [],
|
|
1008
|
-
read: shared.get
|
|
1009
|
-
};
|
|
1008
|
+
const readOnly = Projection.fromReader(sharedCodec, shared.get, { dependencies: shared.dependencies });
|
|
1010
1009
|
const surface = Surface.make(app, options.name ?? String(options.documentId), {
|
|
1011
1010
|
model: () => readOnly,
|
|
1012
1011
|
messages: durable.constructors
|
|
@@ -1018,13 +1017,14 @@ const build = (app) => {
|
|
|
1018
1017
|
owns: shared.dependencies,
|
|
1019
1018
|
observes: shared.dependencies,
|
|
1020
1019
|
messages: [...durable.tags],
|
|
1021
|
-
|
|
1020
|
+
metadata: []
|
|
1022
1021
|
};
|
|
1023
1022
|
return {
|
|
1024
1023
|
...sync,
|
|
1025
1024
|
journalContract,
|
|
1026
1025
|
surface,
|
|
1027
1026
|
projection: shared,
|
|
1027
|
+
replay,
|
|
1028
1028
|
messages: durable.constructors,
|
|
1029
1029
|
contract
|
|
1030
1030
|
};
|
|
@@ -1058,17 +1058,50 @@ const PERSISTED = "foldkit-sync/Persisted";
|
|
|
1058
1058
|
const FAILED = "foldkit-sync/PersistenceFailed";
|
|
1059
1059
|
const NAVIGATE = "foldkit-sync/Navigate";
|
|
1060
1060
|
const NAVIGATED = "foldkit-sync/Navigated";
|
|
1061
|
-
/**
|
|
1062
|
-
|
|
1061
|
+
/**
|
|
1062
|
+
* Commits, rejections and acknowledgments change what the replica holds; a
|
|
1063
|
+
* submit only echoes a local edit. An acknowledgment that does not return the
|
|
1064
|
+
* operation moves no cursor, but it still drops the edit from the outbox.
|
|
1065
|
+
*/
|
|
1066
|
+
const sharedChanged = (previous, next) => previous === void 0 || previous.cursor !== next.cursor || next.pending < previous.pending || previous.rejected.length !== next.rejected.length || previous.rejected.some((id, index) => id !== next.rejected[index]);
|
|
1067
|
+
/**
|
|
1068
|
+
* The edits a replica whose next local sequence is `next` does not hold yet.
|
|
1069
|
+
* Submits run one at a time, so the one in flight is in the replica exactly
|
|
1070
|
+
* when its submit has moved the sequence past `started`.
|
|
1071
|
+
*/
|
|
1072
|
+
const unconfirmedEdits = (edits, next) => edits.filter((edit) => edit.started === void 0 || next <= edit.started).map((edit) => edit.message);
|
|
1063
1073
|
const mount = (app, sync, options) => {
|
|
1064
1074
|
if (options.container.id === "") throw new Error("Sync.mount: the container needs an id (`container.id = \"app\"`)");
|
|
1065
1075
|
const { replica } = options;
|
|
1066
1076
|
const durable = new Set(sync.contract.messages);
|
|
1067
|
-
const
|
|
1077
|
+
const edits = [];
|
|
1078
|
+
let tail = Promise.resolve();
|
|
1079
|
+
const install = (model) => {
|
|
1080
|
+
const snapshot = Effect.runSync(replica.snapshot);
|
|
1081
|
+
const shared = unconfirmedEdits(edits, snapshot.nextLocalSequence).reduce((value, message) => {
|
|
1082
|
+
try {
|
|
1083
|
+
return sync.replay(value, message);
|
|
1084
|
+
} catch {
|
|
1085
|
+
return value;
|
|
1086
|
+
}
|
|
1087
|
+
}, snapshot.shared);
|
|
1088
|
+
return sync.projection.set(model, shared);
|
|
1089
|
+
};
|
|
1068
1090
|
const inFlight = /* @__PURE__ */ new Set();
|
|
1069
1091
|
let latest = install(app.initial);
|
|
1070
1092
|
const modelListeners = /* @__PURE__ */ new Set();
|
|
1093
|
+
const committedListeners = /* @__PURE__ */ new Set();
|
|
1071
1094
|
const messageListeners = /* @__PURE__ */ new Set();
|
|
1095
|
+
const notifyEach = (listeners, value) => {
|
|
1096
|
+
for (const listener of [...listeners]) try {
|
|
1097
|
+
listener(value);
|
|
1098
|
+
} catch (error) {
|
|
1099
|
+
queueMicrotask(() => {
|
|
1100
|
+
throw error;
|
|
1101
|
+
});
|
|
1102
|
+
}
|
|
1103
|
+
};
|
|
1104
|
+
const notifyCommitted = () => notifyEach(committedListeners, void 0);
|
|
1072
1105
|
const update = (model, message) => {
|
|
1073
1106
|
switch (message._tag) {
|
|
1074
1107
|
case REFRESH: return { model: install(model) };
|
|
@@ -1090,25 +1123,38 @@ const mount = (app, sync, options) => {
|
|
|
1090
1123
|
}
|
|
1091
1124
|
case NAVIGATED: return { model };
|
|
1092
1125
|
default: {
|
|
1093
|
-
|
|
1126
|
+
notifyEach(messageListeners, message);
|
|
1094
1127
|
const result = app.update(model, message);
|
|
1095
1128
|
if (!durable.has(message._tag)) return result;
|
|
1129
|
+
const edit = {
|
|
1130
|
+
message,
|
|
1131
|
+
started: void 0
|
|
1132
|
+
};
|
|
1133
|
+
edits.push(edit);
|
|
1134
|
+
const previous = tail;
|
|
1135
|
+
let settle;
|
|
1136
|
+
const done = new Promise((resolve) => {
|
|
1137
|
+
settle = resolve;
|
|
1138
|
+
});
|
|
1139
|
+
tail = done;
|
|
1140
|
+
const release = () => {
|
|
1141
|
+
const index = edits.indexOf(edit);
|
|
1142
|
+
if (index !== -1) edits.splice(index, 1);
|
|
1143
|
+
inFlight.delete(done);
|
|
1144
|
+
settle();
|
|
1145
|
+
};
|
|
1096
1146
|
const persist = {
|
|
1097
1147
|
name: "foldkit-sync/persist",
|
|
1098
1148
|
effect: Effect.gen(function* () {
|
|
1099
|
-
let settle;
|
|
1100
|
-
const done = new Promise((resolve) => {
|
|
1101
|
-
settle = resolve;
|
|
1102
|
-
});
|
|
1103
1149
|
inFlight.add(done);
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1150
|
+
yield* Effect.promise(() => previous);
|
|
1151
|
+
edit.started = (yield* replica.snapshot).nextLocalSequence;
|
|
1152
|
+
const outcome = yield* Effect.result(replica.submit(edit.message));
|
|
1107
1153
|
return outcome._tag === "Success" ? { _tag: PERSISTED } : {
|
|
1108
1154
|
_tag: FAILED,
|
|
1109
1155
|
error: outcome.failure
|
|
1110
1156
|
};
|
|
1111
|
-
})
|
|
1157
|
+
}).pipe(Effect.ensuring(Effect.sync(release)))
|
|
1112
1158
|
};
|
|
1113
1159
|
return {
|
|
1114
1160
|
model: result.model,
|
|
@@ -1120,12 +1166,12 @@ const mount = (app, sync, options) => {
|
|
|
1120
1166
|
const ports = { inbound: { message: Port.inbound(app.Message) } };
|
|
1121
1167
|
const own = Subscription.make()(() => ({
|
|
1122
1168
|
message: Port.subscription(ports.inbound.message, (message) => message),
|
|
1123
|
-
refresh: Subscription.persistent(replica.statusChanges.pipe(Stream.mapAccum(() => void 0, (previous, status) => [status, sharedChanged(previous, status) ? [{ _tag: REFRESH }] : []]))),
|
|
1169
|
+
refresh: Subscription.persistent(replica.statusChanges.pipe(Stream.tap(() => Effect.sync(notifyCommitted)), Stream.mapAccum(() => void 0, (previous, status) => [status, sharedChanged(previous, status) ? [{ _tag: REFRESH }] : []]))),
|
|
1124
1170
|
latest: {
|
|
1125
1171
|
dependenciesSchema: Schema.Struct({}),
|
|
1126
1172
|
modelToDependencies: (model) => {
|
|
1127
1173
|
latest = model;
|
|
1128
|
-
|
|
1174
|
+
notifyEach(modelListeners, void 0);
|
|
1129
1175
|
return {};
|
|
1130
1176
|
},
|
|
1131
1177
|
dependenciesToStream: () => Stream.never
|
|
@@ -1172,6 +1218,13 @@ const mount = (app, sync, options) => {
|
|
|
1172
1218
|
messageListeners.add(listener);
|
|
1173
1219
|
return () => messageListeners.delete(listener);
|
|
1174
1220
|
},
|
|
1221
|
+
committed: {
|
|
1222
|
+
get: () => Effect.runSync(replica.committed),
|
|
1223
|
+
subscribe: (listener) => {
|
|
1224
|
+
committedListeners.add(listener);
|
|
1225
|
+
return () => committedListeners.delete(listener);
|
|
1226
|
+
}
|
|
1227
|
+
},
|
|
1175
1228
|
dispose: async () => {
|
|
1176
1229
|
await Promise.all([...inFlight]);
|
|
1177
1230
|
handle.dispose();
|