shared-reducer 4.0.2 → 5.0.1

package/README.md

@@ -15,16 +15,15 @@ npm install --save shared-reducer json-immutability-helper
 
 ## Usage (Backend)
 
-This project is compatible with
-[websocket-express](https://github.com/davidje13/websocket-express),
+This project is compatible with [websocket-express](https://github.com/davidje13/websocket-express),
 but can also be used in isolation.
 
 ### With websocket-express
 
-```js
+```javascript
 import {
   Broadcaster,
-  websocketHandler,
+  WebsocketHandlerFactory,
   InMemoryModel,
   ReadWrite,
 } from 'shared-reducer/backend';
@@ -32,60 +31,57 @@ import context from 'json-immutability-helper';
 import { WebSocketExpress } from 'websocket-express';
 
 const model = new InMemoryModel();
-const broadcaster = Broadcaster.for(model)
-  .withReducer(context)
-  .build();
+const broadcaster = new Broadcaster(model, context);
 model.set('a', { foo: 'v1' });
 
 const app = new WebSocketExpress();
 const server = app.listen(0, 'localhost');
 
-const handler = websocketHandler(broadcaster);
-app.ws('/:id', handler((req) => req.params.id, () => ReadWrite));
+const handlerFactory = new WebsocketHandlerFactory(broadcaster);
+app.ws('/:id', handlerFactory.handler((req) => req.params.id, () => ReadWrite));
+
+const server = app.listen();
+
+// later, to shutdown gracefully:
+// send a close signal to all clients and wait up to 1 second for acknowledgement:
+await handlerFactory.close(1000);
+server.close();
 ```
 
-For real use-cases, you will probably want to add authentication middleware
-to the expressjs chain, and you may want to give some users read-only and
-others read-write access, which can be achieved in the second lambda.
+For real use-cases, you will probably want to add authentication middleware to the expressjs chain,
+and you may want to give some users read-only and others read-write access, which can be achieved in
+the second lambda.
 
 ### Alone
 
-```js
+```javascript
 import { Broadcaster, InMemoryModel } from 'shared-reducer/backend';
 import context from 'json-immutability-helper';
 
 const model = new InMemoryModel();
-const broadcaster = Broadcaster.for(model)
-  .withReducer(context)
-  .build();
+const broadcaster = new Broadcaster(model, context);
 model.set('a', { foo: 'v1' });
 
 // ...
 
-const subscription = await broadcaster.subscribe(
-  'a',
-  (change, meta) => { /*...*/ },
-);
+const subscription = await broadcaster.subscribe('a');
 
 const begin = subscription.getInitialData();
+subscription.listen((change, meta) => { /*...*/ });
 await subscription.send(['=', { foo: 'v2' }]);
 // callback provided earlier is invoked
 
 await subscription.close();
 ```
 
-## Persisting data
+### Persisting data
 
 A convenience wrapper is provided for use with
-[collection-storage](https://github.com/davidje13/collection-storage),
-or you can write your own implementation of the `Model` interface to
-link any backend.
+[collection-storage](https://github.com/davidje13/collection-storage), or you can write your own
+implementation of the `Model` interface to link any backend.
 
-```js
-import {
-  Broadcaster,
-  CollectionStorageModel,
-} from 'shared-reducer/backend';
+```javascript
+import { Broadcaster, CollectionStorageModel } from 'shared-reducer/backend';
 import context from 'json-immutability-helper';
 import CollectionStorage from 'collection-storage';
 
@@ -97,29 +93,38 @@ const model = new CollectionStorageModel(
   // or throws if invalid (protects stored data from malicious changes)
   MY_VALIDATOR,
 );
-const broadcaster = Broadcaster.for(model)
-  .withReducer(context)
-  .build();
+const broadcaster = new Broadcaster(model, context);
 ```
 
-Note that the provided validator MUST verify structural integrity (e.g.
-ensuring no unexpected fields are added or types are changed).
+Note that the provided validator MUST verify structural integrity (e.g. ensuring no unexpected
+fields are added or types are changed).
 
 ## Usage (Frontend)
 
 ```javascript
-import { SharedReducer, actionsHandledCallback, actionsSyncedCallback } from 'shared-reducer/frontend';
+import { SharedReducer } from 'shared-reducer/frontend';
 import context from 'json-immutability-helper';
 
-const reducer = SharedReducer
-  .for('ws://destination', (state) => {
-    console.log('latest state is', state);
-  })
-  .withReducer(context)
-  .withToken('my-token')
-  .withErrorHandler((error) => { console.log('connection lost', error); })
-  .withWarningHandler((warning) => { console.log('latest change failed', warning); })
-  .build();
+const reducer = new SharedReducer(context, () => ({
+  url: 'ws://destination',
+  token: 'my-token',
+}));
+
+reducer.addStateListener((state) => {
+  console.log('latest state is', state);
+});
+
+reducer.addEventListener('connected', () => {
+  console.log('connected / reconnected');
+});
+
+reducer.addEventListener('disconnected', (e) => {
+  console.log('connection lost', e.detail.code, e.detail.reason);
+});
+
+reducer.addEventListener('warning', (e) => {
+  console.log('latest change failed', e.detail);
+});
 
 const dispatch = reducer.dispatch;
 
@@ -129,23 +134,22 @@ dispatch([
 
 dispatch([
   (state) => {
-    return {
-      a: ['=', Math.pow(2, state.a)],
-    };
+    return [{ a: ['=', Math.pow(2, state.a)] }];
   },
 ]);
 
 dispatch([
-  actionsHandledCallback((state) => {
+  (state) => {
     console.log('state after handling is', state);
-  }),
+    return [];
+  },
 ]);
 
-dispatch([
-  actionsSyncedCallback((state) => {
-    console.log('state after syncing is', state);
-  }),
-]);
+dispatch(
+  [{ a: ['add', 1] }],
+  (state) => console.log('state after syncing is', state),
+  (message) => console.warn('failed to sync', message),
+);
 
 dispatch([
   { a: ['add', 1] },
@@ -155,8 +159,7 @@ dispatch([
 
 ### Specs
 
-The specs need to match whichever reducer you are using. In the examples
-above, that is
+The specs need to match whichever reducer you are using. In the examples above, that is
 [json-immutability-helper](https://github.com/davidje13/json-immutability-helper).
 
 ## WebSocket protocol
@@ -165,101 +168,86 @@ The websocket protocol is minimal:
 
 ### Client-to-server
 
-`<token>`:
-The authentication token is sent as the first message when the connection is
-established. This is plaintext. The server should respond by either terminating
-the connection (if the token is deemed invalid), or with an `init` event which
-defines the latest state in its entirety. If no token is specified using
-`withToken`, no message will be sent (when not using authentication, it is
-assumed the server will send the `init` event unprompted).
+- `<token>`: The authentication token is sent as the first message when the connection is
+  established. This is plaintext. The server should respond by either terminating the connection (if
+  the token is deemed invalid), or with an `init` event which defines the latest state in its
+  entirety. If no token is specified using `withToken`, no message will be sent (when not using
+  authentication, it is assumed the server will send the `init` event unprompted).
+
+- `P` (ping): Can be sent periodically to keep the connection alive. The server sends a "Pong"
+  message in response immediately.
 
-`P` (ping):
-Can be sent periodically to keep the connection alive. The server sends a
-"Pong" message in response immediately.
+- `{"change": <spec>, "id": <id>}`: Defines a delta. This may contain the aggregate result of many
+  operations performed on the client. The ID is an opaque identifier which is reflected back to the
+  same client in the confirmation message. Other clients will not receive the ID.
 
-`{"change": <spec>, "id": <id>}`:
-Defines a delta. This may contain the aggregate result of many operations
-performed on the client. The ID is an opaque identifier which is reflected
-back to the same client in the confirmation message. Other clients will not
-receive the ID.
+- `x` (close ack): Sent by the client in response to `X` (closing). Indicates that the client will
+  not send any more messages on this connection (but may still be expecting some responses to
+  existing messages).
 
 ### Server-to-client
 
-`p` (pong):
-Reponse to a ping. May also be sent unsolicited.
+- `p` (pong): Reponse to a ping. May also be sent unsolicited.
 
-`{"init": <state>}`:
-The first message sent by the server, in response to a successful
-connection.
+- `{"init": <state>}`: The first message sent by the server, in response to a successful connection.
 
-`{"change": <spec>}`:
-Sent whenever another client has changed the server state.
+- `{"change": <spec>}`: Sent whenever another client has changed the server state.
 
-`{"change": <spec>, "id": <id>}`:
-Sent whenever the current client has changed the server state. Note that
-the spec and ID will match the client-sent values.
+- `{"change": <spec>, "id": <id>}`: Sent whenever the current client has changed the server state.
+  Note that the spec and ID will match the client-sent values.
 
-The IDs sent by different clients can coincide, so the ID is only reflected
-to the client which sent the spec.
+  The IDs sent by different clients can coincide, so the ID is only reflected to the client which
+  sent the spec.
 
-`{"error": <message>, "id": <id>}`:
-Sent if the server rejects a client-initiated change.
+- `{"error": <message>, "id": <id>}`: Sent if the server rejects a client-initiated change.
 
-If this is returned, the server state will not have changed (i.e. the
-entire spec failed).
+  If this is returned, the server state will not have changed (i.e. the entire spec failed).
+
+- `X` (closing): Sent when the server is about to shut down. The client should respond with `x` and
+  not send any more messages on the current connection. Any currently in-flight messages will be
+  acknowledged on a best-effort basis by the server. The server might not wait for the acknowledging
+  `x` message before closing the connection.
 
 ### Specs
 
-The specs need to match whichever reducer you are using. In the examples
-above, that is
+The specs need to match whichever reducer you are using. In the examples above, that is
 [json-immutability-helper](https://github.com/davidje13/json-immutability-helper).
 
 ## Alternative reducer
 
-To enable different features of `json-immutability-helper`, you can
-customise it before passing it to `withReducer`. For example, to
-enable list commands such as `updateWhere` and mathematical commands
-such as Reverse Polish Notation (`rpn`):
-
-### Backend
+To enable different features of `json-immutability-helper`, you can customise it before passing it
+to the constructor. For example, to enable list commands such as `updateWhere` and mathematical
+commands such as Reverse Polish Notation (`rpn`):
 
-```js
+```javascript
+// Backend
 import { Broadcaster, InMemoryModel } from 'shared-reducer/backend';
 import listCommands from 'json-immutability-helper/commands/list';
 import mathCommands from 'json-immutability-helper/commands/math';
 import context from 'json-immutability-helper';
 
-const broadcaster = Broadcaster.for(new InMemoryModel())
-  .withReducer(context.with(listCommands, mathCommands))
-  .build();
-```
-
-If you want to use an entirely different reducer, create a wrapper
-and pass it to `withReducer`:
-
-```js
-import { Broadcaster, InMemoryModel } from 'shared-reducer/backend';
-
+const broadcaster = new Broadcaster(
+  new InMemoryModel(),
+  context.with(listCommands, mathCommands),
+);
 ```
 
-### Frontend
-
-```js
+```javascript
+// Frontend
 import { SharedReducer } from 'shared-reducer/frontend';
 import listCommands from 'json-immutability-helper/commands/list';
 import mathCommands from 'json-immutability-helper/commands/math';
 import context from 'json-immutability-helper';
 
-const reducer = SharedReducer
-  .for('ws://destination', (state) => {})
-  .withReducer(context.with(listCommands, mathCommands))
-  .build();
+const reducer = new SharedReducer(
+  context.with(listCommands, mathCommands),
+  () => ({ url: 'ws://destination' }),
+);
 ```
 
-If you want to use an entirely different reducer, create a wrapper
-and pass it to `withReducer`:
+If you want to use an entirely different reducer, create a wrapper:
 
-```js
+```javascript
 import context from 'json-immutability-helper';
 
 const myReducer = {
@@ -273,31 +261,29 @@ const myReducer = {
   },
 };
 
-// backend
-const broadcaster = Broadcaster.for(new InMemoryModel())
-  .withReducer(myReducer)
-  .build();
+// Backend
+const broadcaster = new Broadcaster(new InMemoryModel(), myReducer);
 
-// frontend
-const reducer = SharedReducer
-  .for('ws://destination', (state) => {})
-  .withReducer(myReducer)
-  .build();
+// Frontend
+const reducer = new SharedReducer(myReducer, () => ({ url: 'ws://destination' }));
 ```
 
-Be careful when using your own reducer to avoid introducing
-security vulnerabilities; the functions will be called with
-untrusted input, so should be careful to avoid attacks such
-as code injection or prototype pollution.
+Be careful when using your own reducer to avoid introducing security vulnerabilities; the functions
+will be called with untrusted input, so should be careful to avoid attacks such as code injection or
+prototype pollution.
 
 ## Other customisations (Backend)
 
-The `Broadcaster` builder has other settable properties:
+The `Broadcaster` constructor can also take some optional arguments:
+
+```javascript
+new Broadcaster(model, reducer[, options]);
+```
 
-- `withSubscribers`: specify a custom keyed broadcaster, used
-  for communicating changes to all consumers. Required interface:
+- `options.subscribers`: specify a custom keyed broadcaster, used for communicating changes to all
+consumers. Required interface:
 
-  ```js
+  ```javascript
   {
     add(key, listener) {
       // add the listener function to key
@@ -314,15 +300,14 @@ The `Broadcaster` builder has other settable properties:
 
   All functions can be asynchronous or synchronous.
 
-  The main use-case for overriding this would be to share
-  messages between multiple servers for load balancing, but
-  note that in most cases you probably want to load balance
-  _documents_ rather than _users_ for better scalability.
+  The main use-case for overriding this would be to share messages between multiple servers for load
+  balancing, but note that in most cases you probably want to load balance _documents_ rather than
+  _users_ for better scalability.
 
-- `withTaskQueues`: specify a custom task queue, used to ensure
-  operations happen in the correct order. Required interface:
+- `options.taskQueues`: specify a custom task queue, used to ensure operations happen in the correct
+  order. Required interface:
 
-  ```js
+  ```javascript
   {
     push(key, task) {
       // add the (possibly asynchronous) task to the queue
@@ -331,33 +316,80 @@ The `Broadcaster` builder has other settable properties:
   }
   ```
 
-  The default implementation will execute the task if it is
-  the first task in a particular queue. If there is already
-  a task in the queue, it will be stored and executed once
-  the existing tasks have finished. Once all tasks for a
-  particular key have finished, it will remove the queue.
+  The default implementation will execute the task if it is the first task in a particular queue. If
+  there is already a task in the queue, it will be stored and executed once the existing tasks have
+  finished. Once all tasks for a particular key have finished, it will remove the queue.
 
-  As with `withSubscribers`, the main reason to override
-  this is to provide consistency if multiple servers are
-  able to modify the same document simultaneously.
+  As with `subscribers`, the main reason to override this is to provide consistency if multiple
+  servers are able to modify the same document simultaneously.
 
-- `withIdProvider`: specify a custom unique ID provider.
-  Required interface:
+- `options.idProvider`: specify a custom unique ID provider. Must be a function which returns a
+  unique string ID when called. Can be asynchronous.
 
-  ```js
-  {
-    get() {
-      // return a unique string (must be synchronous)
-    },
-  }
-  ```
+  The returned ID is used internally and passed through the configured `taskQueues` to identify the
+  source of a change. It is not revealed to users. The default implementation uses a fixed random
+  prefix followed by an incrementing number, which should be sufficient for most use cases.
+
+## Other customisations (Frontend)
+
+If the connection is lost, the frontend will attempt to reconnect automatically. By default this
+uses an exponential backoff with a small amount of randomness, as well as attempting to connect if
+the page regains focus or the computer rejoins a network. You can fully customise this behaviour:
+
+```javascript
+import { SharedReducer, OnlineScheduler, exponentialDelay } from 'shared-reducer/frontend';
+
+const reducer = new SharedReducer(context, () => ({ url: 'ws://destination' }), {
+  scheduler: new OnlineScheduler(
+    exponentialDelay({
+      base: 2,
+      initialDelay: 200,
+      maxDelay: 10 * 60 * 1000,
+      randomness: 0.3,
+    }),
+    20 * 1000, // timeout for each connection attempt
+  ),
+});
+```
+
+The `exponentialDelay` helper returns:
+
+```
+min(initialDelay * (base ^ attempt), maxDelay) * (1 - random(randomness))
+```
+
+All delay values are in milliseconds.
+
+You can also provide a custom function instead of `exponentialDelay`; it will be given the current
+attempt number (0-based), and should return the number of milliseconds to wait before triggering the
+attempt.
+
+Finally, by default when reconnecting `SharedReducer` will replay all messages which have not been
+confirmed (`AT_LEAST_ONCE` delivery). You can change this to `AT_MOST_ONCE` or a custom mechanism:
+
+```javascript
+import { SharedReducer, AT_MOST_ONCE } from 'shared-reducer/frontend';
+
+const reducer = new SharedReducer(context, () => ({ url: 'ws://destination' }), {
+  deliveryStrategy: AT_MOST_ONCE,
+});
+```
+
+Custom strategies can be defined as functions:
+
+```javascript
+function myCustomDeliveryStrategy(serverState, spec, hasSent) {
+  return true; // re-send all (equivalent to AT_LEAST_ONCE)
+}
+```
+
+- `serverState` is the new state from the server after reconnecting.
+- `spec` is a spec that has not been confirmed as delivered to the server.
+- `hasSent` is `true` if the spec has already been sent to the server (but no delivery confirmation
+  was received). It is `false` if the message was never sent to the server.
 
-  The returned ID is used internally and passed through
-  the configured `taskQueues` to identify the source of
-  a change. It is not revealed to users. The default
-  implementation uses a fixed random prefix followed by
-  an incrementing number, which should be sufficient for
-  most use cases.
+Note that the function will be invoked multiple times (once for each change that is pending). It
+should return `true` for messages to resend, and `false` for messages to drop.
 
 ## Older versions
 

package/backend/index.d.ts

@@ -1,33 +1,30 @@
-declare class UniqueIdProvider {
-    private readonly _shared;
-    private _unique;
-    get(): string;
-}
+type MaybePromise<T> = Promise<T> | T;
 
-type Task<T> = () => Promise<T>;
-interface TaskQueue<T> extends EventTarget {
-    push(task: Task<T>): Promise<T>;
+type Task<T> = () => MaybePromise<T>;
+interface TaskQueue extends EventTarget {
+    push<T>(task: Task<T>): Promise<T>;
+    active(): boolean;
 }
-type TaskQueueFactory<T> = () => TaskQueue<T>;
+type TaskQueueFactory = () => TaskQueue;
 
-declare class TaskQueueMap<T> {
+declare class TaskQueueMap<K> {
     private readonly _queueFactory;
     private readonly _queues;
-    constructor(_queueFactory?: () => TaskQueue<T>);
-    push(key: string, task: Task<T>): Promise<T>;
+    constructor(_queueFactory?: () => TaskQueue);
+    push<T>(key: K, task: Task<T>): Promise<T>;
 }
 
 type TopicListener<T> = (message: T) => void;
 interface Topic<T> {
-    add(fn: TopicListener<T>): Promise<void> | void;
-    remove(fn: TopicListener<T>): Promise<boolean> | boolean;
-    broadcast(message: T): Promise<void> | void;
+    add(fn: TopicListener<T>): MaybePromise<void>;
+    remove(fn: TopicListener<T>): MaybePromise<boolean>;
+    broadcast(message: T): MaybePromise<void>;
 }
 
-interface TopicMap<T> {
-    add(key: string, fn: TopicListener<T>): Promise<void> | void;
-    remove(key: string, fn: TopicListener<T>): Promise<void> | void;
-    broadcast(key: string, message: T): Promise<void> | void;
+interface TopicMap<K, T> {
+    add(key: K, fn: TopicListener<T>): MaybePromise<void>;
+    remove(key: K, fn: TopicListener<T>): MaybePromise<void>;
+    broadcast(key: K, message: T): MaybePromise<void>;
 }
 
 declare class PermissionError extends Error {
@@ -37,19 +34,21 @@ interface Permission<T, SpecT> {
     validateWrite(newValue: T, oldValue: T): void;
 }
 
-interface Model<T> {
+interface Model<ID, T> {
     validate(v: unknown): Readonly<T>;
-    read(id: string): Promise<Readonly<T> | null | undefined> | Readonly<T> | null | undefined;
-    write(id: string, newValue: T, oldValue: T): Promise<void> | void;
+    read(id: ID): MaybePromise<Readonly<T> | null | undefined>;
+    write(id: ID, newValue: T, oldValue: T): MaybePromise<void>;
 }
 
 interface Context<T, SpecT> {
     update: (input: T, spec: SpecT) => T;
 }
+type Listener<SpecT, MetaT> = (message: ChangeInfo<SpecT>, meta: MetaT | undefined) => void;
 interface Subscription<T, SpecT, MetaT> {
-    getInitialData: () => Readonly<T>;
-    send: (change: SpecT, meta?: MetaT) => Promise<void>;
-    close: () => Promise<void>;
+    getInitialData(): Readonly<T>;
+    listen(onChange: Listener<SpecT, MetaT>): void;
+    send(change: SpecT, meta?: MetaT): Promise<void>;
+    close(): Promise<void>;
 }
 type Identifier = string | null;
 type ChangeInfo<SpecT> = {
@@ -64,67 +63,88 @@ interface TopicMessage<SpecT> {
     source: Identifier;
     meta?: unknown;
 }
-interface BroadcasterBuilder<T, SpecT> {
-    withReducer<SpecT2 extends SpecT>(context: Context<T, SpecT2>): BroadcasterBuilder<T, SpecT2>;
-    withSubscribers(subscribers: TopicMap<TopicMessage<SpecT>>): this;
-    withTaskQueues(taskQueues: TaskQueueMap<void>): this;
-    withIdProvider(idProvider: UniqueIdProvider): this;
-    build(): Broadcaster<T, SpecT>;
-}
+type ID = string;
 declare class Broadcaster<T, SpecT> {
     private readonly _model;
     private readonly _context;
     private readonly _subscribers;
     private readonly _taskQueues;
     private readonly _idProvider;
-    private constructor();
-    static for<T2>(model: Model<T2>): BroadcasterBuilder<T2, unknown>;
-    subscribe<MetaT>(id: string, onChange: (message: ChangeInfo<SpecT>, meta: MetaT | undefined) => void, permission?: Permission<T, SpecT>): Promise<Subscription<T, SpecT, MetaT> | null>;
-    update(id: string, change: SpecT, permission?: Permission<T, SpecT>): Promise<void>;
+    constructor(_model: Model<ID, T>, _context: Context<T, SpecT>, options?: {
+        subscribers?: TopicMap<ID, TopicMessage<SpecT>>;
+        taskQueues?: TaskQueueMap<ID>;
+        idProvider?: () => MaybePromise<string>;
+    });
+    subscribe<MetaT = void>(id: ID, permission?: Permission<T, SpecT>): Promise<Subscription<T, SpecT, MetaT> | null>;
+    update(id: ID, change: SpecT, permission?: Permission<T, SpecT>): Promise<void>;
     private _internalApplyChange;
     private _internalQueueChange;
 }
 
 declare const PING = "P";
 declare const PONG = "p";
-type MaybePromise<T> = Promise<T> | T;
+declare const CLOSE = "X";
+declare const CLOSE_ACK = "x";
 interface ServerWebSocket {
     on(event: 'close', listener: () => void): void;
     on(event: 'message', listener: (data: unknown, isBinary?: boolean) => void): void;
+    on(event: 'pong', listener: () => void): void;
+    ping(): void;
     send(message: string): void;
+    terminate(): void;
 }
 interface WSResponse {
     accept(): Promise<ServerWebSocket>;
-    sendError(httpStatus: number): void;
+    sendError(httpStatus: number, wsStatus?: number): void;
     beginTransaction(): void;
     endTransaction(): void;
 }
-declare const websocketHandler: <T, SpecT>(broadcaster: Broadcaster<T, SpecT>) => <Req, Res extends WSResponse>(idGetter: (req: Req, res: Res) => MaybePromise<string>, permissionGetter: (req: Req, res: Res) => MaybePromise<Permission<T, SpecT>>) => (req: Req, res: Res) => Promise<void>;
+interface WebsocketHandlerOptions {
+    pingInterval?: number;
+    pongTimeout?: number;
+}
+declare class WebsocketHandlerFactory<T, SpecT> {
+    private readonly broadcaster;
+    private readonly closers;
+    private readonly _pingInterval;
+    private readonly _pongTimeout;
+    private closing;
+    constructor(broadcaster: Broadcaster<T, SpecT>, options?: WebsocketHandlerOptions);
+    activeConnections(): number;
+    softClose(timeout: number): Promise<void>;
+    handler<Req, Res extends WSResponse>(idGetter: (req: Req, res: Res) => MaybePromise<string>, permissionGetter: (req: Req, res: Res) => MaybePromise<Permission<T, SpecT>>): (req: Req, res: Res) => Promise<void>;
+}
+
+declare const UniqueIdProvider: () => () => string;
 
 interface Collection<T> {
     get<K extends keyof T & string>(searchAttribute: K, searchValue: T[K]): Promise<Readonly<T> | null>;
     update<K extends keyof T & string>(searchAttribute: K, searchValue: T[K], update: Partial<T>): Promise<void>;
 }
-declare class CollectionStorageModel<T extends object> implements Model<T> {
+type ErrorMapper = (e: unknown) => unknown;
+declare class CollectionStorageModel<T extends object, K extends keyof T & string> implements Model<T[K], T> {
     private readonly _collection;
     private readonly _idCol;
     readonly validate: (v: unknown) => T;
     private readonly _readErrorIntercept;
     private readonly _writeErrorIntercept;
-    constructor(_collection: Collection<T>, _idCol: keyof T & string, validate: (v: unknown) => T, _readErrorIntercept?: (e: Error) => Error, _writeErrorIntercept?: (e: Error) => Error);
-    read(id: string): Promise<Readonly<T> | null>;
-    write(id: string, newValue: T, oldValue: T): Promise<void>;
+    constructor(_collection: Collection<T>, _idCol: keyof T & string, validate: (v: unknown) => T, options?: {
+        readErrorIntercept?: ErrorMapper;
+        writeErrorIntercept?: ErrorMapper;
+    });
+    read(id: T[K]): Promise<Readonly<T> | null>;
+    write(id: T[K], newValue: T, oldValue: T): Promise<void>;
 }
 
-declare class InMemoryModel<T> implements Model<T> {
-    readonly read: (id: string) => Readonly<T> | undefined;
+declare class InMemoryModel<ID, T> implements Model<ID, T> {
+    readonly read: (id: ID) => Readonly<T> | undefined;
     readonly validate: (v: unknown) => T;
     private readonly _memory;
     constructor(validator?: (x: unknown) => T);
-    set(id: string, value: T): void;
-    get(id: string): Readonly<T> | undefined;
-    delete(id: string): void;
-    write(id: string, newValue: T, oldValue: T): void;
+    set(id: ID, value: T): void;
+    get(id: ID): Readonly<T> | undefined;
+    delete(id: ID): void;
+    write(id: ID, newValue: T, oldValue: T): void;
 }
 
 declare const ReadOnly: Permission<unknown, unknown>;
@@ -137,11 +157,12 @@ declare class ReadWriteStruct<T extends object> implements Permission<T, unknown
     validateWrite(newValue: T, oldValue: T): void;
 }
 
-declare class AsyncTaskQueue<T> extends EventTarget implements TaskQueue<T> {
+declare class AsyncTaskQueue extends EventTarget implements TaskQueue {
     private readonly _queue;
     private _running;
-    push(task: Task<T>): Promise<T>;
+    push<T>(task: Task<T>): Promise<T>;
     private _internalConsumeQueue;
+    active(): boolean;
 }
 
 declare class InMemoryTopic<T> implements Topic<T> {
@@ -151,13 +172,13 @@ declare class InMemoryTopic<T> implements Topic<T> {
     broadcast(message: T): void;
 }
 
-declare class TrackingTopicMap<T> implements TopicMap<T> {
+declare class TrackingTopicMap<K, T> implements TopicMap<K, T> {
     private readonly _topicFactory;
     private readonly _data;
-    constructor(_topicFactory: (key: string) => Topic<T>);
-    add(key: string, fn: TopicListener<T>): Promise<void>;
-    remove(key: string, fn: TopicListener<T>): Promise<void>;
-    broadcast(key: string, message: T): Promise<void>;
+    constructor(_topicFactory: (key: K) => Topic<T>);
+    add(key: K, fn: TopicListener<T>): Promise<void>;
+    remove(key: K, fn: TopicListener<T>): Promise<void>;
+    broadcast(key: K, message: T): Promise<void>;
 }
 
-export { AsyncTaskQueue, Broadcaster, type ChangeInfo, CollectionStorageModel, type Context, InMemoryModel, InMemoryTopic, type Model, PING, PONG, type Permission, PermissionError, ReadOnly, ReadWrite, ReadWriteStruct, type Subscription, type Task, type TaskQueue, type TaskQueueFactory, TaskQueueMap, type Topic, type TopicMap, type TopicMessage, TrackingTopicMap, UniqueIdProvider, websocketHandler };
+export { AsyncTaskQueue, Broadcaster, CLOSE, CLOSE_ACK, type ChangeInfo, CollectionStorageModel, type Context, InMemoryModel, InMemoryTopic, type Model, PING, PONG, type Permission, PermissionError, ReadOnly, ReadWrite, ReadWriteStruct, type Subscription, type Task, type TaskQueue, type TaskQueueFactory, TaskQueueMap, type Topic, type TopicMap, type TopicMessage, TrackingTopicMap, UniqueIdProvider, WebsocketHandlerFactory };

package/backend/index.js

@@ -1 +1 @@
-"use strict";var t=require("node:crypto");class e{t=t.randomUUID().substring(0,8);i=0;get(){const t=this.i;return this.i++,`${this.t}-${t}`}}class r extends EventTarget{o=[];h=!1;push(t){return new Promise(((e,r)=>{this.o.push({task:t,resolve:e,reject:r}),this.h||this.u()}))}async u(){for(this.h=!0;this.o.length>0;){const{task:t,resolve:e,reject:r}=this.o.shift();let s=null,i=!1;try{s=await t(),i=!0}catch(t){r(t)}i&&e(s)}this.h=!1,this.dispatchEvent(new CustomEvent("drain"))}}class s{l;p=new Map;constructor(t=()=>new r){this.l=t}push(t,e){let r=this.p.get(t);return r||(r=this.l(),r.addEventListener("drain",(()=>{this.p.delete(t)})),this.p.set(t,r)),r.push(e)}}class i{v;_=new Map;constructor(t){this.v=t}async add(t,e){let r=this._.get(t);r||(r=this.v(t),this._.set(t,r)),await r.add(e)}async remove(t,e){const r=this._.get(t);if(r){await r.remove(e)||this._.delete(t)}}async broadcast(t,e){const r=this._.get(t);r&&await r.broadcast(e)}}class n{m=new Set;add(t){this.m.add(t)}remove(t){return this.m.delete(t),this.m.size>0}broadcast(t){this.m.forEach((e=>e(t)))}}const a={validateWrite(){}};class o{O;j;m;C;S;constructor(t,e,r,s,i){this.O=t,this.j=e,this.m=r,this.C=s,this.S=i}static for(t){let r,a,c,h;return{withReducer(t){return r=t,this},withSubscribers(t){return a=t,this},withTaskQueues(t){return c=t,this},withIdProvider(t){return h=t,this},build(){if(!r)throw new Error("must set broadcaster context");return new o(t,r,a||new i((()=>new n)),c||new s,h||new e)}}}async subscribe(t,e,r=a){let s=await this.O.read(t);if(null==s)return null;const i=this.S.get(),n=({message:t,source:r,meta:s})=>{r===i?e(t,s):t.change&&e(t,void 0)};return this.m.add(t,n),{getInitialData:()=>{if(null===s)throw new Error("Already fetched initialData");const t=s;return s=null,t},send:(e,s)=>this.I(t,e,r,i,s),close:async()=>{await this.m.remove(t,n)}}}update(t,e,r=a){return this.I(t,e,r,null,void 0)}async q(t,e,r,s,i){try{const s=await this.O.read(t);if(!s)throw new Error("Deleted");r.validateWriteSpec?.(e);const i=this.j.update(s,e),n=this.O.validate(i);r.validateWrite(n,s),await this.O.write(t,n,s)}catch(e){return void this.m.broadcast(t,{message:{error:e instanceof Error?e.message:"Internal error"},source:s,meta:i})}this.m.broadcast(t,{message:{change:e},source:s,meta:i})}async I(t,e,r,s,i){return this.C.push(t,(()=>this.q(t,e,r,s,i)))}}function c(t){if("object"!=typeof(e=t)||null===e||Array.isArray(e))throw new Error("Must specify change and optional id");var e;const{id:r,change:s}=t;if(void 0===r)return{change:s};if("number"!=typeof r)throw new Error("if specified, id must be a number");return{change:s,id:r}}function h(t){return{error:t instanceof Error?t.message:"Internal error"}}const u=t=>t;class l extends Error{}const d="Cannot modify data",w={validateWriteSpec(){throw new l(d)},validateWrite(){throw new l(d)}};exports.AsyncTaskQueue=r,exports.Broadcaster=o,exports.CollectionStorageModel=class{J;N;validate;P;$;constructor(t,e,r,s=u,i=u){this.J=t,this.N=e,this.validate=r,this.P=s,this.$=i}async read(t){try{return await this.J.get(this.N,t)}catch(t){throw this.P(t)}}async write(t,e,r){const s={};Object.entries(e).forEach((([t,e])=>{const i=t;e!==(Object.prototype.hasOwnProperty.call(r,i)?r[i]:void 0)&&(s[i]?Object.defineProperty(s,i,{value:e,configurable:!0,enumerable:!0,writable:!0}):s[i]=e)}));try{await this.J.update(this.N,t,s)}catch(t){throw this.$(t)}}},exports.InMemoryModel=class{read=this.get;validate;k=new Map;constructor(t=t=>t){this.validate=t}set(t,e){this.k.set(t,e)}get(t){return this.k.get(t)}delete(t){this.k.delete(t)}write(t,e,r){if(r!==this.k.get(t))throw new Error("Unexpected previous value");this.k.set(t,e)}},exports.InMemoryTopic=n,exports.PING="P",exports.PONG="p",exports.PermissionError=l,exports.ReadOnly=w,exports.ReadWrite=a,exports.ReadWriteStruct=class{M;constructor(t=[]){this.M=t}validateWrite(t,e){Object.keys(e).forEach((e=>{const r=e;if(!Object.prototype.hasOwnProperty.call(t,r)&&this.M.includes(r))throw new l(`Cannot remove field ${r}`)})),Object.keys(t).forEach((r=>{const s=r;if(this.M.includes(s)){if(!Object.prototype.hasOwnProperty.call(e,s))throw new l(`Cannot add field ${s}`);if(t[s]!==e[s])throw new l(`Cannot edit field ${s}`)}}))}},exports.TaskQueueMap=s,exports.TrackingTopicMap=i,exports.UniqueIdProvider=e,exports.websocketHandler=t=>(e,r)=>async(s,i)=>{const n=await i.accept(),a=(t,e)=>{const r=void 0!==e?{id:e,...t}:t;n.send(JSON.stringify(r))};let o;try{const n=await e(s,i),c=await r(s,i);o=await t.subscribe(n,a,c)}catch(t){return void n.send(JSON.stringify(h(t)))}o?(n.on("close",o.close),n.on("message",((t,e)=>{try{if(e)return;const r=String(t);if("P"===r)return void n.send("p");const s=function(t){return c(JSON.parse(t))}(r);i.beginTransaction(),o.send(s.change,s.id).finally((()=>i.endTransaction()))}catch(t){n.send(JSON.stringify(h(t)))}})),n.send(JSON.stringify({init:o.getInitialData()}))):i.sendError(404)};
+"use strict";var t=require("node:crypto");const e=()=>{const e=t.randomUUID().substring(0,8);let s=0;return()=>{const t=s++;return`${e}-${t}`}};class s extends EventTarget{t=[];i=!1;push(t){return new Promise(((e,s)=>{this.t.push((async()=>{try{e(await t())}catch(t){s(t)}})),this.i||this.o()}))}async o(){for(this.i=!0;this.t.length>0;)await this.t.shift()();this.i=!1,this.dispatchEvent(new CustomEvent("drain"))}active(){return this.i}}class r{h;l=new Map;constructor(t=()=>new s){this.h=t}push(t,e){let s=this.l.get(t);if(!s){const e=this.h(),r=()=>{e.active()||(this.l.delete(t),e.removeEventListener("drain",r))};e.addEventListener("drain",r),this.l.set(t,e),s=e}return s.push(e)}}class i{u;p=new Map;constructor(t){this.u=t}async add(t,e){let s=this.p.get(t);s||(s=this.u(t),this.p.set(t,s)),await s.add(e)}async remove(t,e){const s=this.p.get(t);if(s){await s.remove(e)||this.p.delete(t)}}async broadcast(t,e){const s=this.p.get(t);s&&await s.broadcast(e)}}class n{m=new Set;add(t){this.m.add(t)}remove(t){return this.m.delete(t),this.m.size>0}broadcast(t){this.m.forEach((e=>e(t)))}}const o={validateWrite(){}};const a=t=>t;class c extends Error{}const h="Cannot modify data",l={validateWriteSpec(){throw new c(h)},validateWrite(){throw new c(h)}};exports.AsyncTaskQueue=s,exports.Broadcaster=class{v;_;m;S;C;constructor(t,s,o={}){this.v=t,this._=s,this.m=o.subscribers??new i((()=>new n)),this.S=o.taskQueues??new r,this.C=o.idProvider??e()}async subscribe(t,e=o){let s={T:0},r="";const i=t=>{2===s.T?t.source===r?s.O(t.message,t.meta):t.message.change&&s.O(t.message,void 0):1===s.T&&s.t.push(t)};try{if(await this.S.push(t,(async()=>{const e=await this.v.read(t);null!=e&&(s={T:1,P:e,t:[]},await this.m.add(t,i))})),0===s.T)return null;r=await this.C()}catch(e){throw await this.m.remove(t,i),e}return{getInitialData(){if(1!==s.T)throw new Error("Already started");return s.P},listen(t){if(1!==s.T)throw new Error("Already started");const e=s.t;s={T:2,O:t},e.forEach(i)},send:(s,i)=>this.j(t,s,e,r,i),close:async()=>{await this.m.remove(t,i)}}}update(t,e,s=o){return this.j(t,e,s,null,void 0)}async I(t,e,s,r,i){try{const r=await this.v.read(t);if(!r)throw new Error("Deleted");s.validateWriteSpec?.(e);const i=this._.update(r,e),n=this.v.validate(i);s.validateWrite(n,r),await this.v.write(t,n,r)}catch(e){return void this.m.broadcast(t,{message:{error:e instanceof Error?e.message:"Internal error"},source:r,meta:i})}this.m.broadcast(t,{message:{change:e},source:r,meta:i})}async j(t,e,s,r,i){return this.S.push(t,(()=>this.I(t,e,s,r,i)))}},exports.CLOSE="X",exports.CLOSE_ACK="x",exports.CollectionStorageModel=class{W;k;validate;q;$;constructor(t,e,s,r={}){this.W=t,this.k=e,this.validate=s,this.q=r.readErrorIntercept??a,this.$=r.writeErrorIntercept??a}async read(t){try{return await this.W.get(this.k,t)}catch(t){throw this.q(t)}}async write(t,e,s){const r={};Object.entries(e).forEach((([t,e])=>{const i=t;e!==(Object.prototype.hasOwnProperty.call(s,i)?s[i]:void 0)&&(r[i]?Object.defineProperty(r,i,{value:e,configurable:!0,enumerable:!0,writable:!0}):r[i]=e)}));try{await this.W.update(this.k,t,r)}catch(t){throw this.$(t)}}},exports.InMemoryModel=class{read=this.get;validate;A=new Map;constructor(t=t=>t){this.validate=t}set(t,e){this.A.set(t,e)}get(t){return this.A.get(t)}delete(t){this.A.delete(t)}write(t,e,s){if(s!==this.A.get(t))throw new Error("Unexpected previous value");this.A.set(t,e)}},exports.InMemoryTopic=n,exports.PING="P",exports.PONG="p",exports.PermissionError=c,exports.ReadOnly=l,exports.ReadWrite=o,exports.ReadWriteStruct=class{J;constructor(t=[]){this.J=t}validateWrite(t,e){for(const s of this.J){const r=Object.prototype.hasOwnProperty.call(e,s),i=Object.prototype.hasOwnProperty.call(t,s);if(r!==i)throw new c(r?`Cannot remove field ${String(s)}`:`Cannot add field ${String(s)}`);if(i&&e[s]!==t[s])throw new c(`Cannot edit field ${String(s)}`)}}},exports.TaskQueueMap=r,exports.TrackingTopicMap=i,exports.UniqueIdProvider=e,exports.WebsocketHandlerFactory=class{broadcaster;closers=new Set;M;N;closing=!1;constructor(t,e={}){this.broadcaster=t,this.M=e.pingInterval??25e3,this.N=e.pongTimeout??3e4}activeConnections(){return this.closers.size}async softClose(t){this.closing=!0;let e=null;await Promise.race([Promise.all([...this.closers].map((t=>t()))),new Promise((s=>{e=setTimeout(s,t)}))]),null!==e&&clearTimeout(e)}handler(t,e){const s=async(s,r)=>{const i=await t(s,r),n=await e(s,r),o=await this.broadcaster.subscribe(i,n);return o||(r.sendError(404),null)};return async(t,e)=>{if(this.closing)return void e.sendError(503,1012);const r=await s(t,e).catch((t=>(console.warn("WebSocket init error",t),e.sendError(500),null)));if(r)try{const t=await e.accept();let s=0,i=()=>null;const n=()=>(this.closers.delete(n),t.send("X"),s=1,new Promise((t=>{i=t})));t.on("close",(()=>{s=2,clearTimeout(c),r.close().catch((()=>null)),this.closers.delete(n),i()}));const o=()=>{r.close().catch((()=>null)),this.closers.delete(n),t.terminate(),i()},a=()=>{t.ping(),clearTimeout(c),c=setTimeout(o,this.N)};if(t.on("pong",(()=>{clearTimeout(c),c=setTimeout(a,this.M)})),t.on("message",(async(n,o)=>{clearTimeout(c),c=setTimeout(a,this.M);try{if(o)throw new Error("Binary messages are not supported");const a=String(n);if("P"===a)return void t.send("p");if("x"===a){if(1!==s)throw new Error("Unexpected close ack message");return s=2,void i()}if(2===s)throw new Error("Unexpected message after close ack");const c=function(t){const e=JSON.parse(t);if("object"!=typeof e||!e||Array.isArray(e))throw new Error("Must specify change and optional id");const{id:s,change:r}=e;if(void 0===s)return{change:r};if("number"!=typeof s)throw new Error("if specified, id must be a number");return{change:r,id:s}}(a);e.beginTransaction();try{await r.send(c.change,c.id)}finally{e.endTransaction()}}catch(e){t.send(JSON.stringify({error:e instanceof Error?e.message:"Internal error"}))}})),this.closing)return e.sendError(503,1012),void r.close().catch((()=>null));t.send(JSON.stringify({init:r.getInitialData()})),r.listen(((e,s)=>{const r=void 0!==s?{id:s,...e}:e;t.send(JSON.stringify(r))}));let c=setTimeout(a,this.M);this.closers.add(n)}catch(t){console.warn("WebSocket error",t),e.sendError(500),r.close().catch((()=>null))}}}};

package/backend/index.mjs

@@ -1 +1 @@
-import{randomUUID as t}from"node:crypto";class e{t=t().substring(0,8);i=0;get(){const t=this.i;return this.i++,`${this.t}-${t}`}}class r extends EventTarget{o=[];h=!1;push(t){return new Promise(((e,r)=>{this.o.push({task:t,resolve:e,reject:r}),this.h||this.u()}))}async u(){for(this.h=!0;this.o.length>0;){const{task:t,resolve:e,reject:r}=this.o.shift();let s=null,i=!1;try{s=await t(),i=!0}catch(t){r(t)}i&&e(s)}this.h=!1,this.dispatchEvent(new CustomEvent("drain"))}}class s{l;v=new Map;constructor(t=()=>new r){this.l=t}push(t,e){let r=this.v.get(t);return r||(r=this.l(),r.addEventListener("drain",(()=>{this.v.delete(t)})),this.v.set(t,r)),r.push(e)}}class i{m;p=new Map;constructor(t){this.m=t}async add(t,e){let r=this.p.get(t);r||(r=this.m(t),this.p.set(t,r)),await r.add(e)}async remove(t,e){const r=this.p.get(t);if(r){await r.remove(e)||this.p.delete(t)}}async broadcast(t,e){const r=this.p.get(t);r&&await r.broadcast(e)}}class n{_=new Set;add(t){this._.add(t)}remove(t){return this._.delete(t),this._.size>0}broadcast(t){this._.forEach((e=>e(t)))}}const a={validateWrite(){}};class o{O;j;_;C;S;constructor(t,e,r,s,i){this.O=t,this.j=e,this._=r,this.C=s,this.S=i}static for(t){let r,a,c,h;return{withReducer(t){return r=t,this},withSubscribers(t){return a=t,this},withTaskQueues(t){return c=t,this},withIdProvider(t){return h=t,this},build(){if(!r)throw new Error("must set broadcaster context");return new o(t,r,a||new i((()=>new n)),c||new s,h||new e)}}}async subscribe(t,e,r=a){let s=await this.O.read(t);if(null==s)return null;const i=this.S.get(),n=({message:t,source:r,meta:s})=>{r===i?e(t,s):t.change&&e(t,void 0)};return this._.add(t,n),{getInitialData:()=>{if(null===s)throw new Error("Already fetched initialData");const t=s;return s=null,t},send:(e,s)=>this.I(t,e,r,i,s),close:async()=>{await this._.remove(t,n)}}}update(t,e,r=a){return this.I(t,e,r,null,void 0)}async J(t,e,r,s,i){try{const s=await this.O.read(t);if(!s)throw new Error("Deleted");r.validateWriteSpec?.(e);const i=this.j.update(s,e),n=this.O.validate(i);r.validateWrite(n,s),await this.O.write(t,n,s)}catch(e){return void this._.broadcast(t,{message:{error:e instanceof Error?e.message:"Internal error"},source:s,meta:i})}this._.broadcast(t,{message:{change:e},source:s,meta:i})}async I(t,e,r,s,i){return this.C.push(t,(()=>this.J(t,e,r,s,i)))}}function c(t){if("object"!=typeof(e=t)||null===e||Array.isArray(e))throw new Error("Must specify change and optional id");var e;const{id:r,change:s}=t;if(void 0===r)return{change:s};if("number"!=typeof r)throw new Error("if specified, id must be a number");return{change:s,id:r}}const h="P",u="p",l=t=>(e,r)=>async(s,i)=>{const n=await i.accept(),a=(t,e)=>{const r=void 0!==e?{id:e,...t}:t;n.send(JSON.stringify(r))};let o;try{const n=await e(s,i),c=await r(s,i);o=await t.subscribe(n,a,c)}catch(t){return void n.send(JSON.stringify(d(t)))}o?(n.on("close",o.close),n.on("message",((t,e)=>{try{if(e)return;const r=String(t);if("P"===r)return void n.send("p");const s=function(t){return c(JSON.parse(t))}(r);i.beginTransaction(),o.send(s.change,s.id).finally((()=>i.endTransaction()))}catch(t){n.send(JSON.stringify(d(t)))}})),n.send(JSON.stringify({init:o.getInitialData()}))):i.sendError(404)};function d(t){return{error:t instanceof Error?t.message:"Internal error"}}const w=t=>t;class f{N;P;validate;$;k;constructor(t,e,r,s=w,i=w){this.N=t,this.P=e,this.validate=r,this.$=s,this.k=i}async read(t){try{return await this.N.get(this.P,t)}catch(t){throw this.$(t)}}async write(t,e,r){const s={};Object.entries(e).forEach((([t,e])=>{const i=t;e!==(Object.prototype.hasOwnProperty.call(r,i)?r[i]:void 0)&&(s[i]?Object.defineProperty(s,i,{value:e,configurable:!0,enumerable:!0,writable:!0}):s[i]=e)}));try{await this.N.update(this.P,t,s)}catch(t){throw this.k(t)}}}class y extends Error{}class v{read=this.get;validate;q=new Map;constructor(t=t=>t){this.validate=t}set(t,e){this.q.set(t,e)}get(t){return this.q.get(t)}delete(t){this.q.delete(t)}write(t,e,r){if(r!==this.q.get(t))throw new Error("Unexpected previous value");this.q.set(t,e)}}const b="Cannot modify data",m={validateWriteSpec(){throw new y(b)},validateWrite(){throw new y(b)}};class p{M;constructor(t=[]){this.M=t}validateWrite(t,e){Object.keys(e).forEach((e=>{const r=e;if(!Object.prototype.hasOwnProperty.call(t,r)&&this.M.includes(r))throw new y(`Cannot remove field ${r}`)})),Object.keys(t).forEach((r=>{const s=r;if(this.M.includes(s)){if(!Object.prototype.hasOwnProperty.call(e,s))throw new y(`Cannot add field ${s}`);if(t[s]!==e[s])throw new y(`Cannot edit field ${s}`)}}))}}export{r as AsyncTaskQueue,o as Broadcaster,f as CollectionStorageModel,v as InMemoryModel,n as InMemoryTopic,h as PING,u as PONG,y as PermissionError,m as ReadOnly,a as ReadWrite,p as ReadWriteStruct,s as TaskQueueMap,i as TrackingTopicMap,e as UniqueIdProvider,l as websocketHandler};
+import{randomUUID as t}from"node:crypto";const e=()=>{const e=t().substring(0,8);let s=0;return()=>{const t=s++;return`${e}-${t}`}};class s extends EventTarget{t=[];i=!1;push(t){return new Promise(((e,s)=>{this.t.push((async()=>{try{e(await t())}catch(t){s(t)}})),this.i||this.o()}))}async o(){for(this.i=!0;this.t.length>0;)await this.t.shift()();this.i=!1,this.dispatchEvent(new CustomEvent("drain"))}active(){return this.i}}class r{h;l=new Map;constructor(t=()=>new s){this.h=t}push(t,e){let s=this.l.get(t);if(!s){const e=this.h(),r=()=>{e.active()||(this.l.delete(t),e.removeEventListener("drain",r))};e.addEventListener("drain",r),this.l.set(t,e),s=e}return s.push(e)}}class i{u;m=new Map;constructor(t){this.u=t}async add(t,e){let s=this.m.get(t);s||(s=this.u(t),this.m.set(t,s)),await s.add(e)}async remove(t,e){const s=this.m.get(t);if(s){await s.remove(e)||this.m.delete(t)}}async broadcast(t,e){const s=this.m.get(t);s&&await s.broadcast(e)}}class n{p=new Set;add(t){this.p.add(t)}remove(t){return this.p.delete(t),this.p.size>0}broadcast(t){this.p.forEach((e=>e(t)))}}const a={validateWrite(){}};class o{_;v;p;S;C;constructor(t,s,a={}){this._=t,this.v=s,this.p=a.subscribers??new i((()=>new n)),this.S=a.taskQueues??new r,this.C=a.idProvider??e()}async subscribe(t,e=a){let s={T:0},r="";const i=t=>{2===s.T?t.source===r?s.O(t.message,t.meta):t.message.change&&s.O(t.message,void 0):1===s.T&&s.t.push(t)};try{if(await this.S.push(t,(async()=>{const e=await this._.read(t);null!=e&&(s={T:1,P:e,t:[]},await this.p.add(t,i))})),0===s.T)return null;r=await this.C()}catch(e){throw await this.p.remove(t,i),e}return{getInitialData(){if(1!==s.T)throw new Error("Already started");return s.P},listen(t){if(1!==s.T)throw new Error("Already started");const e=s.t;s={T:2,O:t},e.forEach(i)},send:(s,i)=>this.j(t,s,e,r,i),close:async()=>{await this.p.remove(t,i)}}}update(t,e,s=a){return this.j(t,e,s,null,void 0)}async I(t,e,s,r,i){try{const r=await this._.read(t);if(!r)throw new Error("Deleted");s.validateWriteSpec?.(e);const i=this.v.update(r,e),n=this._.validate(i);s.validateWrite(n,r),await this._.write(t,n,r)}catch(e){return void this.p.broadcast(t,{message:{error:e instanceof Error?e.message:"Internal error"},source:r,meta:i})}this.p.broadcast(t,{message:{change:e},source:r,meta:i})}async j(t,e,s,r,i){return this.S.push(t,(()=>this.I(t,e,s,r,i)))}}const c="P",h="p",l="X",u="x";class w{broadcaster;closers=new Set;W;k;closing=!1;constructor(t,e={}){this.broadcaster=t,this.W=e.pingInterval??25e3,this.k=e.pongTimeout??3e4}activeConnections(){return this.closers.size}async softClose(t){this.closing=!0;let e=null;await Promise.race([Promise.all([...this.closers].map((t=>t()))),new Promise((s=>{e=setTimeout(s,t)}))]),null!==e&&clearTimeout(e)}handler(t,e){const s=async(s,r)=>{const i=await t(s,r),n=await e(s,r),a=await this.broadcaster.subscribe(i,n);return a||(r.sendError(404),null)};return async(t,e)=>{if(this.closing)return void e.sendError(503,1012);const r=await s(t,e).catch((t=>(console.warn("WebSocket init error",t),e.sendError(500),null)));if(r)try{const t=await e.accept();let s=0,i=()=>null;const n=()=>(this.closers.delete(n),t.send("X"),s=1,new Promise((t=>{i=t})));t.on("close",(()=>{s=2,clearTimeout(c),r.close().catch((()=>null)),this.closers.delete(n),i()}));const a=()=>{r.close().catch((()=>null)),this.closers.delete(n),t.terminate(),i()},o=()=>{t.ping(),clearTimeout(c),c=setTimeout(a,this.k)};if(t.on("pong",(()=>{clearTimeout(c),c=setTimeout(o,this.W)})),t.on("message",(async(n,a)=>{clearTimeout(c),c=setTimeout(o,this.W);try{if(a)throw new Error("Binary messages are not supported");const o=String(n);if("P"===o)return void t.send("p");if("x"===o){if(1!==s)throw new Error("Unexpected close ack message");return s=2,void i()}if(2===s)throw new Error("Unexpected message after close ack");const c=function(t){const e=JSON.parse(t);if("object"!=typeof e||!e||Array.isArray(e))throw new Error("Must specify change and optional id");const{id:s,change:r}=e;if(void 0===s)return{change:r};if("number"!=typeof s)throw new Error("if specified, id must be a number");return{change:r,id:s}}(o);e.beginTransaction();try{await r.send(c.change,c.id)}finally{e.endTransaction()}}catch(e){t.send(JSON.stringify({error:e instanceof Error?e.message:"Internal error"}))}})),this.closing)return e.sendError(503,1012),void r.close().catch((()=>null));t.send(JSON.stringify({init:r.getInitialData()})),r.listen(((e,s)=>{const r=void 0!==s?{id:s,...e}:e;t.send(JSON.stringify(r))}));let c=setTimeout(o,this.W);this.closers.add(n)}catch(t){console.warn("WebSocket error",t),e.sendError(500),r.close().catch((()=>null))}}}}const d=t=>t;class f{$;q;validate;A;J;constructor(t,e,s,r={}){this.$=t,this.q=e,this.validate=s,this.A=r.readErrorIntercept??d,this.J=r.writeErrorIntercept??d}async read(t){try{return await this.$.get(this.q,t)}catch(t){throw this.A(t)}}async write(t,e,s){const r={};Object.entries(e).forEach((([t,e])=>{const i=t;e!==(Object.prototype.hasOwnProperty.call(s,i)?s[i]:void 0)&&(r[i]?Object.defineProperty(r,i,{value:e,configurable:!0,enumerable:!0,writable:!0}):r[i]=e)}));try{await this.$.update(this.q,t,r)}catch(t){throw this.J(t)}}}class m extends Error{}class y{read=this.get;validate;M=new Map;constructor(t=t=>t){this.validate=t}set(t,e){this.M.set(t,e)}get(t){return this.M.get(t)}delete(t){this.M.delete(t)}write(t,e,s){if(s!==this.M.get(t))throw new Error("Unexpected previous value");this.M.set(t,e)}}const p="Cannot modify data",g={validateWriteSpec(){throw new m(p)},validateWrite(){throw new m(p)}};class _{N;constructor(t=[]){this.N=t}validateWrite(t,e){for(const s of this.N){const r=Object.prototype.hasOwnProperty.call(e,s),i=Object.prototype.hasOwnProperty.call(t,s);if(r!==i)throw new m(r?`Cannot remove field ${String(s)}`:`Cannot add field ${String(s)}`);if(i&&e[s]!==t[s])throw new m(`Cannot edit field ${String(s)}`)}}}export{s as AsyncTaskQueue,o as Broadcaster,l as CLOSE,u as CLOSE_ACK,f as CollectionStorageModel,y as InMemoryModel,n as InMemoryTopic,c as PING,h as PONG,m as PermissionError,g as ReadOnly,a as ReadWrite,_ as ReadWriteStruct,r as TaskQueueMap,i as TrackingTopicMap,e as UniqueIdProvider,w as WebsocketHandlerFactory};

package/frontend/index.d.ts

@@ -2,55 +2,107 @@ interface Context<T, SpecT> {
     update: (input: T, spec: SpecT) => T;
     combine: (specs: SpecT[]) => SpecT;
 }
-declare class SyncCallback<T> {
-    readonly sync: (state: T) => void;
-    readonly reject: (message: string) => void;
-    constructor(sync: (state: T) => void, reject: (message: string) => void);
-}
-type SpecGenerator<T, SpecT> = (state: T) => SpecSource<T, SpecT>[] | null | undefined;
-type SpecSource<T, SpecT> = SpecT | SpecGenerator<T, SpecT> | SyncCallback<T> | null | undefined;
+type SpecGenerator<T, SpecT> = (state: T) => SpecSource<T, SpecT>[];
+type SpecSource<T, SpecT> = SpecT | SpecGenerator<T, SpecT> | null;
 type DispatchSpec<T, SpecT> = SpecSource<T, SpecT>[];
-type Dispatch<T, SpecT> = (specs: DispatchSpec<T, SpecT> | null | undefined) => void;
+interface Dispatch<T, SpecT> {
+    sync(specs?: DispatchSpec<T, SpecT>): Promise<T>;
+    (specs: DispatchSpec<T, SpecT>, syncedCallback?: (state: T) => void, errorCallback?: (error: string) => void): void;
+}
+
+interface Scheduler {
+    trigger(fn: (signal: AbortSignal) => Promise<void>): void;
+    schedule(fn: (signal: AbortSignal) => Promise<void>): void;
+    stop(): void;
+}
+
+type MaybePromise<T> = Promise<T> | T;
+
+type Handler = (signal: AbortSignal) => MaybePromise<void>;
+type DelayGetter = (attempt: number) => number;
+declare class OnlineScheduler implements Scheduler {
+    private readonly _delayGetter;
+    private readonly _connectTimeLimit;
+    private _timeout;
+    private _stop;
+    private _handler;
+    private _attempts;
+    constructor(_delayGetter: DelayGetter, _connectTimeLimit: number);
+    trigger(handler: Handler): void;
+    schedule(handler: Handler): void;
+    stop(): void;
+    private _attempt;
+    private _remove;
+}
+interface ExponentialDelayConfig {
+    base?: number;
+    initialDelay: number;
+    maxDelay: number;
+    randomness?: number;
+}
+declare const exponentialDelay: ({ base, initialDelay, maxDelay, randomness }: ExponentialDelayConfig) => DelayGetter;
 
-declare function actionsHandledCallback<T>(callback?: (state: T) => void): ((state: T) => null) | null;
+type EventHandler<E extends Event> = ((e: E) => void) | {
+    handleEvent(e: E): void;
+};
+declare class TypedEventTarget<Events extends Record<string, Event>> extends EventTarget {
+    addEventListener<K extends keyof Events & string>(type: K, callback: EventHandler<Events[K]> | null, options?: AddEventListenerOptions | boolean): void;
+    removeEventListener<K extends keyof Events & string>(type: K, callback: EventHandler<Events[K]> | null, options?: EventListenerOptions | boolean): void;
+    dispatchEvent<K extends keyof Events & string>(event: TypedEvent<K, Events[K]>): boolean;
+}
+type TypedEvent<Type extends string, T extends Event> = T & {
+    readonly type: Type;
+};
+
+interface ConnectionInfo {
+    url: string;
+    token?: string | undefined;
+}
+type ConnectionGetter = (signal: AbortSignal) => MaybePromise<ConnectionInfo>;
+interface DisconnectDetail {
+    code: number;
+    reason: string;
+}
 
-declare function actionsSyncedCallback<T>(resolve?: (state: T) => void, reject?: (message: string) => void): SyncCallback<T> | null;
+type DeliveryStrategy<T, SpecT> = (serverState: T, spec: SpecT, hasSent: boolean) => boolean;
+declare const AT_LEAST_ONCE: DeliveryStrategy<unknown, unknown>;
+declare const AT_MOST_ONCE: DeliveryStrategy<unknown, unknown>;
 
-interface SharedReducerBuilder<T, SpecT> {
-    withReducer<SpecT2 extends SpecT>(context: Context<T, SpecT2>): SharedReducerBuilder<T, SpecT2>;
-    withToken(token: string): this;
-    withErrorHandler(handler: (error: string) => void): this;
-    withWarningHandler(handler: (error: string) => void): this;
-    build(): SharedReducer<T, SpecT>;
+interface SharedReducerOptions<T, SpecT> {
+    scheduler?: Scheduler | undefined;
+    deliveryStrategy?: DeliveryStrategy<T, SpecT> | undefined;
 }
-declare class SharedReducer<T, SpecT> {
+type SharedReducerEvents = {
+    connected: CustomEvent<void>;
+    disconnected: CustomEvent<DisconnectDetail>;
+    warning: CustomEvent<Error>;
+};
+declare class SharedReducer<T, SpecT> extends TypedEventTarget<SharedReducerEvents> {
     private readonly _context;
-    private readonly _changeHandler;
-    private readonly _warningHandler;
-    private readonly _connection;
-    private _latestStates;
-    private _currentChange;
-    private _currentSyncCallbacks;
-    private _localChanges;
-    private _pendingChanges;
+    private readonly _ws;
+    private _paused;
+    private _state;
+    private readonly _tracker;
+    private readonly _listeners;
     private readonly _dispatchLock;
-    private readonly _nextId;
-    private constructor();
-    static for<T2>(wsUrl: string, changeHandler?: (state: T2) => void): SharedReducerBuilder<T2, unknown>;
-    close(): void;
-    dispatch: Dispatch<T, SpecT>;
-    addSyncCallback(resolve: (state: T) => void, reject?: (message: string) => void): void;
-    syncedState(): Promise<T>;
-    getState(): T | undefined;
-    private _sendCurrentChange;
-    private _addCurrentChange;
-    private _applySpecs;
-    private _popLocalChange;
-    private _handleErrorMessage;
+    constructor(_context: Context<T, SpecT>, connectionGetter: ConnectionGetter, { scheduler, deliveryStrategy, }?: SharedReducerOptions<T, SpecT>);
+    readonly dispatch: Dispatch<T, SpecT>;
+    private _apply;
+    private readonly _share;
     private _handleInitMessage;
     private _handleChangeMessage;
-    private _handleMessage;
-    private _computeLocal;
+    private _handleErrorMessage;
+    private _handleGracefulClose;
+    private readonly _handleMessage;
+    addStateListener(listener: (state: Readonly<T>) => void): void;
+    removeStateListener(listener: (state: Readonly<T>) => void): void;
+    private _setLocalState;
+    getState(): Readonly<T> | undefined;
+    private _warn;
+    private readonly _handleConnected;
+    private readonly _handleConnectionFailure;
+    private readonly _handleDisconnected;
+    close(): void;
 }
 
-export { type Context, type Dispatch, type DispatchSpec, SharedReducer, actionsHandledCallback, actionsSyncedCallback };
+export { AT_LEAST_ONCE, AT_MOST_ONCE, type Context, type DeliveryStrategy, type Dispatch, type DispatchSpec, OnlineScheduler, type Scheduler, SharedReducer, type SharedReducerOptions, exponentialDelay };

package/frontend/index.js

@@ -1 +1 @@
-"use strict";class t{sync;reject;constructor(t,s){this.sync=t,this.reject=s}}const s=()=>null;function i(i,e){return i||e?new t(i||s,e||s):null}class e{t;h;l;o=null;constructor(t,s=void 0,i,e=void 0){this.t=i,this.h=e,this.l=new WebSocket(t),this.l.addEventListener("message",this.u),this.l.addEventListener("error",this._),this.l.addEventListener("close",this.p),s&&this.l.addEventListener("open",(()=>this.l.send(s)),{once:!0}),this.C()}send(t){this.l.send(JSON.stringify(t))}close(){this.l.close(),null!==this.o&&clearTimeout(this.o)}C(){null!==this.o&&clearTimeout(this.o),this.o=setTimeout(this.v,2e4)}v=()=>{this.l.send("P")};u=({data:t})=>{this.C(),"p"!==t&&this.t(JSON.parse(t))};_=()=>{this.h?.("Failed to connect")};p=()=>{null!==this.o&&clearTimeout(this.o)}}class n{m;S;k;I;O=null;P;T=[];j=[];M=[];N=function(t){let s=!1;return i=>{if(s)throw new Error(t);try{return s=!0,i()}finally{s=!1}}}("Cannot dispatch recursively");H=function(){let t=1;return()=>t++}();constructor(t,s,i,n,h,r){this.m=t,this.S=n,this.k=r,this.I=new e(s,i,this.u,h)}static for(t,s){let i,e,h,r;return{withReducer(t){return i=t,this},withToken(t){return e=t,this},withErrorHandler(t){return h=t,this},withWarningHandler(t){return r=t,this},build(){if(!i)throw new Error("must set broadcaster context");return new n(i,t,e,s,h,r)}}}close(){this.I.close(),this.O=null,this.P=void 0,this.T=[],this.j=[],this.M=[]}dispatch=t=>{if(t&&t.length)if(this.O){const s=this.J(this.O,t);s!==this.O&&(this.O=s,this.S?.(s.local))}else this.M.push(...t)};addSyncCallback(t,s){this.dispatch([i(t,s)])}syncedState(){return new Promise(((t,s)=>{this.addSyncCallback(t,s)}))}getState(){return this.O?.local}$=()=>{if(void 0===this.P)return;const t=this.H(),s=this.P,i=this.T;this.P=void 0,this.T=[],this.j.push({change:s,id:t,syncCallbacks:i}),this.I.send({change:s,id:t})};A(t){void 0===this.P?(this.P=t,setTimeout(this.$,0)):this.P=this.m.combine([this.P,t])}J(s,i){if(!i.length)return s;const{state:e,delta:n}=this.N((()=>function(s,i,e,n){let h=i;const r=[],l=[];function o(){if(l.length>0){const t=s.combine(l);r.push(t),h=s.update(h,t),l.length=0}}return function(t,s){let i={vs:t,i:0,prev:null};for(;i;)if(i.i>=i.vs.length)i=i.prev;else{const t=s(i.vs[i.i]);i.i+=1,t&&t.length&&(i={vs:t,i:0,prev:i})}}(e,(s=>s instanceof t?(o(),n(s,h),null):"function"==typeof s?(o(),s(h)):(s&&l.push(s),null))),o(),{state:h,delta:s.combine(r)}}(this.m,s.local,i,((t,i)=>{i===s.local&&void 0===this.P?t.sync(s.local):this.T.push(t)}))));return e===s.local?s:(this.A(n),{server:s.server,local:e})}L(t){const s=void 0===t?-1:this.j.findIndex((s=>s.id===t));return-1===s?{localChange:null,index:s}:{localChange:this.j.splice(s,1)[0],index:s}}W(t){const{localChange:s}=this.L(t.id);s?(this.k?.(`API rejected update: ${t.error}`),this.O&&(this.O=this.q(this.O.server),this.S?.(this.O.local)),s.syncCallbacks.forEach((s=>s.reject(t.error)))):this.k?.(`API sent error: ${t.error}`)}F(t){this.O=this.J(this.q(t.init),this.M),this.M.length=0,this.S?.(this.O.local)}R(t){if(!this.O)return void this.k?.(`Ignoring change before init: ${JSON.stringify(t)}`);const{localChange:s,index:i}=this.L(t.id),e=this.m.update(this.O.server,t.change);0===i?this.O={server:e,local:this.O.local}:(this.O=this.q(e),this.S?.(this.O.local));const n=this.O.local;s?.syncCallbacks.forEach((t=>t.sync(n)))}u=t=>{Object.prototype.hasOwnProperty.call(t,"change")?this.R(t):Object.prototype.hasOwnProperty.call(t,"init")?this.F(t):Object.prototype.hasOwnProperty.call(t,"error")?this.W(t):this.k?.(`Ignoring unknown API message: ${JSON.stringify(t)}`)};q(t){let s=t;if(this.j.length>0){const t=this.m.combine(this.j.map((({change:t})=>t)));s=this.m.update(s,t)}return void 0!==this.P&&(s=this.m.update(s,this.P)),{server:t,local:s}}}exports.SharedReducer=n,exports.actionsHandledCallback=function(t){return t?s=>(t(s),null):null},exports.actionsSyncedCallback=i;
+"use strict";class t{t;i;h=null;o=null;l=null;u=0;constructor(t,s){this.t=t,this.i=s,this._=this._.bind(this)}trigger(t){this.stop(),this.l=t,this._()}schedule(t){this.l!==t&&(this.o&&this.stop(),this.l=t,null===this.h&&("hidden"===global.document?.visibilityState?global.addEventListener?.("visibilitychange",this._):(global.addEventListener?.("online",this._),this.h=setTimeout(this._,this.t(this.u))),global.addEventListener?.("pageshow",this._),global.addEventListener?.("focus",this._),++this.u))}stop(){this.l=null,this.o?.(),this.o=null,this.m()}async _(){if(this.o||!this.l)return;this.m();const t=new AbortController;let s=()=>null;this.o=()=>{s(),t.abort()};try{await Promise.race([this.l(t.signal),new Promise(((t,e)=>{const i=setTimeout(e,this.i);s=()=>clearTimeout(i)}))]),this.l=null,this.u=0}catch(s){if(!t.signal.aborted){t.abort();const s=this.l;s&&(this.l=null,this.schedule(s))}}finally{s(),this.o=null}}m(){null!==this.h&&(clearTimeout(this.h),this.h=null,global.removeEventListener?.("online",this._),global.removeEventListener?.("pageshow",this._),global.removeEventListener?.("visibilitychange",this._),global.removeEventListener?.("focus",this._))}}const s=({base:t=2,initialDelay:s,maxDelay:e,randomness:i=0})=>n=>Math.min(Math.pow(t,n)*s,e)*(1-Math.random()*i);function e(t,s,e){const i=[],n=[];function h(){if(n.length>0){const e=t.combine(n);i.push(e),s=t.update(s,e),n.length=0}}return function(t,s){let e={p:t,v:0,C:null};for(;e;)if(e.v>=e.p.length)e=e.C;else{const t=s(e.p[e.v]);++e.v,t&&t.length&&(e={p:t,v:0,C:e})}}(e,(t=>{if("function"==typeof t){h();return t(s)}return t&&n.push(t),null})),h(),{S:s,T:t.combine(i)}}class i extends EventTarget{addEventListener(t,s,e){super.addEventListener(t,s,e)}removeEventListener(t,s,e){super.removeEventListener(t,s,e)}dispatchEvent(t){return super.dispatchEvent(t)}}const n=(t,s)=>new CustomEvent(t,{detail:s});class h extends i{$;k;I=null;P=!1;constructor(t,s){super(),this.$=t,this.k=s,this.L=this.L.bind(this),this.k.trigger(this.L)}async L(t){const{url:s,token:e}=await this.$(t);t.throwIfAborted();const i=new AbortController,h=i.signal;await new Promise(((u,d)=>{const _=new WebSocket(s);let g=!0;const f=t=>{i.abort(),_.close(),g?(g=!1,this.dispatchEvent(n("connectionfailure",t)),d(new Error(`handshake failed: ${t.code} ${t.reason}`))):(this.I=null,this.dispatchEvent(n("disconnected",t)),this.P||this.k.schedule(this.L))};e&&_.addEventListener("open",(()=>_.send(e)),{once:!0,signal:h}),_.addEventListener("message",(t=>{t.data!==c&&(g&&(g=!1,this.I=_,this.dispatchEvent(n("connected")),u()),this.dispatchEvent(n("message",t.data)))}),{signal:h}),_.addEventListener("close",f,{signal:h}),_.addEventListener("error",(()=>f(o)),{signal:h}),t.addEventListener("abort",(()=>f(r)),{signal:h}),function(t){const s=new AbortController;let e=null;const i=()=>{null!==e&&(clearTimeout(e),e=null),t.send(l)},n=()=>{null!==e&&clearTimeout(e),e=setTimeout(i,a)},h=()=>{null!==e&&(clearTimeout(e),e=null),s.abort()};t.addEventListener("open",n,{once:!0,signal:s.signal}),t.addEventListener("message",n,{signal:s.signal}),t.addEventListener("close",h,{signal:s.signal}),t.addEventListener("error",h,{signal:s.signal}),global.addEventListener?.("offline",i,{signal:s.signal})}(_)})).catch((t=>{throw i.abort(),t}))}isConnected(){return null!==this.I}send=t=>{if(!this.I)throw new Error("connection lost");this.I.send(t)};close(){this.P=!0,this.k.stop(),this.I?.close()}}const o={code:0,reason:"client side error"},r={code:0,reason:"handshake timeout"},l="P",c="p",a=2e4,u=()=>!0;class d{M;A;O=[];j=function(){let t=1;return()=>t++}();constructor(t,s){this.M=t,this.A=s}D(t){this.O.push({J:void 0,N:t,F:[],G:[]})}q(t,s,e){if(s||e)if(this.O.length){const t=this.O[this.O.length-1];t.F.push(s??_),t.G.push(e??_)}else s&&Promise.resolve(t).then(s)}U(t){let s=0;for(let e=0;e<this.O.length;++e){const i=this.O[e];this.A(t,i.N,void 0!==i.J)?(i.J=void 0,this.O[e-s]=i):(i.G.forEach((t=>t("message possibly lost"))),++s)}this.O.length-=s}W(t){for(let t=0,s=0;t<=this.O.length;++t){const e=this.O[t];if(!e||void 0!==e.J||e.F.length>0||e.G.length>0){const e=t-s;if(e>1){const i=this.O[t-1],n=this.O.splice(s,e,i);i.N=this.M.combine(n.map((t=>t.N))),t-=e-1}s=t+1}}for(const s of this.O)void 0===s.J&&(s.J=this.j(),t(JSON.stringify({change:s.N,id:s.J})))}X(t){const s=void 0===t?-1:this.O.findIndex((s=>s.J===t));return-1===s?{B:null,H:!1}:{B:this.O.splice(s,1)[0],H:0===s}}K(t){if(!this.O.length)return t;const s=this.M.combine(this.O.map((({N:t})=>t)));return this.M.update(t,s)}}const _=()=>null;const g={code:0,reason:"graceful shutdown"},f=s({base:2,initialDelay:1e3,maxDelay:6e5,randomness:.3});exports.AT_LEAST_ONCE=u,exports.AT_MOST_ONCE=(t,s,e)=>!e,exports.OnlineScheduler=t,exports.SharedReducer=class extends i{M;I;R=!0;S={V:0,Y:[]};Z;tt=new Set;st=function(t){let s=!1;return e=>{if(s)throw new Error(t);try{return s=!0,e()}finally{s=!1}}}("Cannot dispatch recursively");constructor(s,e,{scheduler:i=new t(f,2e4),deliveryStrategy:n=u}={}){super(),this.M=s,this.Z=new d(s,n),this.I=new h(e,i),this.I.addEventListener("message",this.et),this.I.addEventListener("connected",this.it),this.I.addEventListener("connectionfailure",this.nt),this.I.addEventListener("disconnected",this.ht)}dispatch=function(t){return Object.assign(t,{sync:(s=[])=>new Promise(((e,i)=>t(s,e,(t=>i(new Error(t))))))})}(((t,s,e)=>{if(!t.length&&!s&&!e)return;const i={ot:t,F:s,G:e};switch(this.S.V){case-1:throw new Error("closed");case 0:this.S.Y.push(i);break;case 1:this.rt(this.lt(this.S.ct,[i])),this.dt.ut()}}));lt(t,s){return this.st((()=>{for(const{ot:i,F:n,G:h}of s){if(i.length){const{S:s,T:n}=e(this.M,t,i);t=s,this.Z.D(n)}this.Z.q(t,n,h)}return t}))}dt=function(t){let s=null;const e=()=>{null!==s&&(clearTimeout(s),s=null)},i=()=>{e(),t()};return{_t:i,ut:()=>{null===s&&(s=setTimeout(i,0))},o:e}}((()=>{this.I.isConnected()&&!this.R&&this.Z.W(this.I.send)}));gt(t){if(-1!==this.S.V){if(this.R=!1,0===this.S.V){const s=this.lt(t.init,this.S.Y);this.S={V:1,ft:t.init,ct:s},this.rt(s,!0)}else this.S.ft=t.init,this.Z.U(t.init),this.rt(this.Z.K(t.init));this.dt._t()}else this.wt(`Ignoring init after closing: ${JSON.stringify(t)}`)}vt(t){if(1!==this.S.V)return void this.wt(`Ignoring change before init: ${JSON.stringify(t)}`);const s=this.S.ft=this.M.update(this.S.ft,t.change),{B:e,H:i}=this.Z.X(t.id);i||this.rt(this.Z.K(s)),e?.F.forEach((t=>t(s)))}bt(t){if(1!==this.S.V)return void this.wt(`Ignoring error before init: ${JSON.stringify(t)}`);const{B:s}=this.Z.X(t.id);s?(this.wt(`API rejected update: ${t.error}`),s?.G.forEach((s=>s(t.error))),this.rt(this.Z.K(this.S.ft))):this.wt(`API sent error: ${t.error}`)}yt(){this.I.send("x"),this.R?this.wt("Unexpected extra close message"):(this.R=!0,this.dispatchEvent(n("disconnected",g)))}et=t=>{if("X"===t.detail)return void this.yt();const s=JSON.parse(t.detail);"change"in s?this.vt(s):"init"in s?this.gt(s):"error"in s?this.bt(s):this.wt(`Ignoring unknown API message: ${t.detail}`)};addStateListener(t){this.tt.add(t),1===this.S.V&&t(this.S.ct)}removeStateListener(t){this.tt.delete(t)}rt(t,s=!1){if(1!==this.S.V)throw new Error("invalid state");if(s||this.S.ct!==t){this.S.ct=t;for(const s of this.tt)s(t)}}getState(){return 1===this.S.V?this.S.ct:void 0}wt(t){this.dispatchEvent(n("warning",new Error(t)))}it=()=>{this.dispatchEvent(n("connected"))};nt=t=>{this.dispatchEvent(n("warning",new Error(`connection failure: ${t.detail.code} ${t.detail.reason}`)))};ht=t=>{this.R||(this.R=!0,this.dispatchEvent(n("disconnected",t.detail)))};close(){this.R=!0,this.S={V:-1},this.I.close(),this.dt.o(),this.tt.clear(),this.I.removeEventListener("message",this.et),this.I.removeEventListener("connected",this.it),this.I.removeEventListener("connectionfailure",this.nt),this.I.removeEventListener("disconnected",this.ht)}},exports.exponentialDelay=s;

package/frontend/index.mjs

@@ -1 +1 @@
-function t(t){return t?s=>(t(s),null):null}class s{sync;reject;constructor(t,s){this.sync=t,this.reject=s}}const i=()=>null;function e(t,e){return t||e?new s(t||i,e||i):null}class n{t;h;l;o=null;constructor(t,s=void 0,i,e=void 0){this.t=i,this.h=e,this.l=new WebSocket(t),this.l.addEventListener("message",this.u),this.l.addEventListener("error",this._),this.l.addEventListener("close",this.C),s&&this.l.addEventListener("open",(()=>this.l.send(s)),{once:!0}),this.p()}send(t){this.l.send(JSON.stringify(t))}close(){this.l.close(),null!==this.o&&clearTimeout(this.o)}p(){null!==this.o&&clearTimeout(this.o),this.o=setTimeout(this.v,2e4)}v=()=>{this.l.send("P")};u=({data:t})=>{this.p(),"p"!==t&&this.t(JSON.parse(t))};_=()=>{this.h?.("Failed to connect")};C=()=>{null!==this.o&&clearTimeout(this.o)}}class h{m;S;k;I;O=null;P;T=[];j=[];M=[];N=function(t){let s=!1;return i=>{if(s)throw new Error(t);try{return s=!0,i()}finally{s=!1}}}("Cannot dispatch recursively");H=function(){let t=1;return()=>t++}();constructor(t,s,i,e,h,r){this.m=t,this.S=e,this.k=r,this.I=new n(s,i,this.u,h)}static for(t,s){let i,e,n,r;return{withReducer(t){return i=t,this},withToken(t){return e=t,this},withErrorHandler(t){return n=t,this},withWarningHandler(t){return r=t,this},build(){if(!i)throw new Error("must set broadcaster context");return new h(i,t,e,s,n,r)}}}close(){this.I.close(),this.O=null,this.P=void 0,this.T=[],this.j=[],this.M=[]}dispatch=t=>{if(t&&t.length)if(this.O){const s=this.J(this.O,t);s!==this.O&&(this.O=s,this.S?.(s.local))}else this.M.push(...t)};addSyncCallback(t,s){this.dispatch([e(t,s)])}syncedState(){return new Promise(((t,s)=>{this.addSyncCallback(t,s)}))}getState(){return this.O?.local}$=()=>{if(void 0===this.P)return;const t=this.H(),s=this.P,i=this.T;this.P=void 0,this.T=[],this.j.push({change:s,id:t,syncCallbacks:i}),this.I.send({change:s,id:t})};A(t){void 0===this.P?(this.P=t,setTimeout(this.$,0)):this.P=this.m.combine([this.P,t])}J(t,i){if(!i.length)return t;const{state:e,delta:n}=this.N((()=>function(t,i,e,n){let h=i;const r=[],l=[];function o(){if(l.length>0){const s=t.combine(l);r.push(s),h=t.update(h,s),l.length=0}}return function(t,s){let i={vs:t,i:0,prev:null};for(;i;)if(i.i>=i.vs.length)i=i.prev;else{const t=s(i.vs[i.i]);i.i+=1,t&&t.length&&(i={vs:t,i:0,prev:i})}}(e,(t=>t instanceof s?(o(),n(t,h),null):"function"==typeof t?(o(),t(h)):(t&&l.push(t),null))),o(),{state:h,delta:t.combine(r)}}(this.m,t.local,i,((s,i)=>{i===t.local&&void 0===this.P?s.sync(t.local):this.T.push(s)}))));return e===t.local?t:(this.A(n),{server:t.server,local:e})}L(t){const s=void 0===t?-1:this.j.findIndex((s=>s.id===t));return-1===s?{localChange:null,index:s}:{localChange:this.j.splice(s,1)[0],index:s}}W(t){const{localChange:s}=this.L(t.id);s?(this.k?.(`API rejected update: ${t.error}`),this.O&&(this.O=this.q(this.O.server),this.S?.(this.O.local)),s.syncCallbacks.forEach((s=>s.reject(t.error)))):this.k?.(`API sent error: ${t.error}`)}F(t){this.O=this.J(this.q(t.init),this.M),this.M.length=0,this.S?.(this.O.local)}R(t){if(!this.O)return void this.k?.(`Ignoring change before init: ${JSON.stringify(t)}`);const{localChange:s,index:i}=this.L(t.id),e=this.m.update(this.O.server,t.change);0===i?this.O={server:e,local:this.O.local}:(this.O=this.q(e),this.S?.(this.O.local));const n=this.O.local;s?.syncCallbacks.forEach((t=>t.sync(n)))}u=t=>{Object.prototype.hasOwnProperty.call(t,"change")?this.R(t):Object.prototype.hasOwnProperty.call(t,"init")?this.F(t):Object.prototype.hasOwnProperty.call(t,"error")?this.W(t):this.k?.(`Ignoring unknown API message: ${JSON.stringify(t)}`)};q(t){let s=t;if(this.j.length>0){const t=this.m.combine(this.j.map((({change:t})=>t)));s=this.m.update(s,t)}return void 0!==this.P&&(s=this.m.update(s,this.P)),{server:t,local:s}}}export{h as SharedReducer,t as actionsHandledCallback,e as actionsSyncedCallback};
+class t{t;i;h=null;o=null;l=null;u=0;constructor(t,s){this.t=t,this.i=s,this._=this._.bind(this)}trigger(t){this.stop(),this.l=t,this._()}schedule(t){this.l!==t&&(this.o&&this.stop(),this.l=t,null===this.h&&("hidden"===global.document?.visibilityState?global.addEventListener?.("visibilitychange",this._):(global.addEventListener?.("online",this._),this.h=setTimeout(this._,this.t(this.u))),global.addEventListener?.("pageshow",this._),global.addEventListener?.("focus",this._),++this.u))}stop(){this.l=null,this.o?.(),this.o=null,this.m()}async _(){if(this.o||!this.l)return;this.m();const t=new AbortController;let s=()=>null;this.o=()=>{s(),t.abort()};try{await Promise.race([this.l(t.signal),new Promise(((t,e)=>{const i=setTimeout(e,this.i);s=()=>clearTimeout(i)}))]),this.l=null,this.u=0}catch(s){if(!t.signal.aborted){t.abort();const s=this.l;s&&(this.l=null,this.schedule(s))}}finally{s(),this.o=null}}m(){null!==this.h&&(clearTimeout(this.h),this.h=null,global.removeEventListener?.("online",this._),global.removeEventListener?.("pageshow",this._),global.removeEventListener?.("visibilitychange",this._),global.removeEventListener?.("focus",this._))}}const s=({base:t=2,initialDelay:s,maxDelay:e,randomness:i=0})=>n=>Math.min(Math.pow(t,n)*s,e)*(1-Math.random()*i);function e(t,s,e){const i=[],n=[];function h(){if(n.length>0){const e=t.combine(n);i.push(e),s=t.update(s,e),n.length=0}}return function(t,s){let e={p:t,v:0,C:null};for(;e;)if(e.v>=e.p.length)e=e.C;else{const t=s(e.p[e.v]);++e.v,t&&t.length&&(e={p:t,v:0,C:e})}}(e,(t=>{if("function"==typeof t){h();return t(s)}return t&&n.push(t),null})),h(),{S:s,T:t.combine(i)}}class i extends EventTarget{addEventListener(t,s,e){super.addEventListener(t,s,e)}removeEventListener(t,s,e){super.removeEventListener(t,s,e)}dispatchEvent(t){return super.dispatchEvent(t)}}const n=(t,s)=>new CustomEvent(t,{detail:s});class h extends i{$;k;I=null;P=!1;constructor(t,s){super(),this.$=t,this.k=s,this.L=this.L.bind(this),this.k.trigger(this.L)}async L(t){const{url:s,token:e}=await this.$(t);t.throwIfAborted();const i=new AbortController,h=i.signal;await new Promise(((u,d)=>{const _=new WebSocket(s);let g=!0;const f=t=>{i.abort(),_.close(),g?(g=!1,this.dispatchEvent(n("connectionfailure",t)),d(new Error(`handshake failed: ${t.code} ${t.reason}`))):(this.I=null,this.dispatchEvent(n("disconnected",t)),this.P||this.k.schedule(this.L))};e&&_.addEventListener("open",(()=>_.send(e)),{once:!0,signal:h}),_.addEventListener("message",(t=>{t.data!==c&&(g&&(g=!1,this.I=_,this.dispatchEvent(n("connected")),u()),this.dispatchEvent(n("message",t.data)))}),{signal:h}),_.addEventListener("close",f,{signal:h}),_.addEventListener("error",(()=>f(o)),{signal:h}),t.addEventListener("abort",(()=>f(r)),{signal:h}),function(t){const s=new AbortController;let e=null;const i=()=>{null!==e&&(clearTimeout(e),e=null),t.send(l)},n=()=>{null!==e&&clearTimeout(e),e=setTimeout(i,a)},h=()=>{null!==e&&(clearTimeout(e),e=null),s.abort()};t.addEventListener("open",n,{once:!0,signal:s.signal}),t.addEventListener("message",n,{signal:s.signal}),t.addEventListener("close",h,{signal:s.signal}),t.addEventListener("error",h,{signal:s.signal}),global.addEventListener?.("offline",i,{signal:s.signal})}(_)})).catch((t=>{throw i.abort(),t}))}isConnected(){return null!==this.I}send=t=>{if(!this.I)throw new Error("connection lost");this.I.send(t)};close(){this.P=!0,this.k.stop(),this.I?.close()}}const o={code:0,reason:"client side error"},r={code:0,reason:"handshake timeout"},l="P",c="p",a=2e4,u=()=>!0,d=(t,s,e)=>!e;class _{M;A;O=[];j=function(){let t=1;return()=>t++}();constructor(t,s){this.M=t,this.A=s}D(t){this.O.push({J:void 0,N:t,F:[],G:[]})}q(t,s,e){if(s||e)if(this.O.length){const t=this.O[this.O.length-1];t.F.push(s??g),t.G.push(e??g)}else s&&Promise.resolve(t).then(s)}U(t){let s=0;for(let e=0;e<this.O.length;++e){const i=this.O[e];this.A(t,i.N,void 0!==i.J)?(i.J=void 0,this.O[e-s]=i):(i.G.forEach((t=>t("message possibly lost"))),++s)}this.O.length-=s}W(t){for(let t=0,s=0;t<=this.O.length;++t){const e=this.O[t];if(!e||void 0!==e.J||e.F.length>0||e.G.length>0){const e=t-s;if(e>1){const i=this.O[t-1],n=this.O.splice(s,e,i);i.N=this.M.combine(n.map((t=>t.N))),t-=e-1}s=t+1}}for(const s of this.O)void 0===s.J&&(s.J=this.j(),t(JSON.stringify({change:s.N,id:s.J})))}X(t){const s=void 0===t?-1:this.O.findIndex((s=>s.J===t));return-1===s?{B:null,H:!1}:{B:this.O.splice(s,1)[0],H:0===s}}K(t){if(!this.O.length)return t;const s=this.M.combine(this.O.map((({N:t})=>t)));return this.M.update(t,s)}}const g=()=>null;class f extends i{M;I;R=!0;S={V:0,Y:[]};Z;tt=new Set;st=function(t){let s=!1;return e=>{if(s)throw new Error(t);try{return s=!0,e()}finally{s=!1}}}("Cannot dispatch recursively");constructor(s,e,{scheduler:i=new t(w,2e4),deliveryStrategy:n=u}={}){super(),this.M=s,this.Z=new _(s,n),this.I=new h(e,i),this.I.addEventListener("message",this.et),this.I.addEventListener("connected",this.it),this.I.addEventListener("connectionfailure",this.nt),this.I.addEventListener("disconnected",this.ht)}dispatch=function(t){return Object.assign(t,{sync:(s=[])=>new Promise(((e,i)=>t(s,e,(t=>i(new Error(t))))))})}(((t,s,e)=>{if(!t.length&&!s&&!e)return;const i={ot:t,F:s,G:e};switch(this.S.V){case-1:throw new Error("closed");case 0:this.S.Y.push(i);break;case 1:this.rt(this.lt(this.S.ct,[i])),this.dt.ut()}}));lt(t,s){return this.st((()=>{for(const{ot:i,F:n,G:h}of s){if(i.length){const{S:s,T:n}=e(this.M,t,i);t=s,this.Z.D(n)}this.Z.q(t,n,h)}return t}))}dt=function(t){let s=null;const e=()=>{null!==s&&(clearTimeout(s),s=null)},i=()=>{e(),t()};return{_t:i,ut:()=>{null===s&&(s=setTimeout(i,0))},o:e}}((()=>{this.I.isConnected()&&!this.R&&this.Z.W(this.I.send)}));gt(t){if(-1!==this.S.V){if(this.R=!1,0===this.S.V){const s=this.lt(t.init,this.S.Y);this.S={V:1,ft:t.init,ct:s},this.rt(s,!0)}else this.S.ft=t.init,this.Z.U(t.init),this.rt(this.Z.K(t.init));this.dt._t()}else this.wt(`Ignoring init after closing: ${JSON.stringify(t)}`)}vt(t){if(1!==this.S.V)return void this.wt(`Ignoring change before init: ${JSON.stringify(t)}`);const s=this.S.ft=this.M.update(this.S.ft,t.change),{B:e,H:i}=this.Z.X(t.id);i||this.rt(this.Z.K(s)),e?.F.forEach((t=>t(s)))}bt(t){if(1!==this.S.V)return void this.wt(`Ignoring error before init: ${JSON.stringify(t)}`);const{B:s}=this.Z.X(t.id);s?(this.wt(`API rejected update: ${t.error}`),s?.G.forEach((s=>s(t.error))),this.rt(this.Z.K(this.S.ft))):this.wt(`API sent error: ${t.error}`)}yt(){this.I.send("x"),this.R?this.wt("Unexpected extra close message"):(this.R=!0,this.dispatchEvent(n("disconnected",m)))}et=t=>{if("X"===t.detail)return void this.yt();const s=JSON.parse(t.detail);"change"in s?this.vt(s):"init"in s?this.gt(s):"error"in s?this.bt(s):this.wt(`Ignoring unknown API message: ${t.detail}`)};addStateListener(t){this.tt.add(t),1===this.S.V&&t(this.S.ct)}removeStateListener(t){this.tt.delete(t)}rt(t,s=!1){if(1!==this.S.V)throw new Error("invalid state");if(s||this.S.ct!==t){this.S.ct=t;for(const s of this.tt)s(t)}}getState(){return 1===this.S.V?this.S.ct:void 0}wt(t){this.dispatchEvent(n("warning",new Error(t)))}it=()=>{this.dispatchEvent(n("connected"))};nt=t=>{this.dispatchEvent(n("warning",new Error(`connection failure: ${t.detail.code} ${t.detail.reason}`)))};ht=t=>{this.R||(this.R=!0,this.dispatchEvent(n("disconnected",t.detail)))};close(){this.R=!0,this.S={V:-1},this.I.close(),this.dt.o(),this.tt.clear(),this.I.removeEventListener("message",this.et),this.I.removeEventListener("connected",this.it),this.I.removeEventListener("connectionfailure",this.nt),this.I.removeEventListener("disconnected",this.ht)}}const m={code:0,reason:"graceful shutdown"},w=s({base:2,initialDelay:1e3,maxDelay:6e5,randomness:.3});export{u as AT_LEAST_ONCE,d as AT_MOST_ONCE,t as OnlineScheduler,f as SharedReducer,s as exponentialDelay};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shared-reducer",
-  "version": "4.0.2",
+  "version": "5.0.1",
   "description": "shared state management",
   "author": "David Evans",
   "license": "MIT",
@@ -47,14 +47,14 @@
     "@rollup/plugin-terser": "0.4.x",
     "@rollup/plugin-typescript": "11.x",
     "collection-storage": "3.x",
-    "json-immutability-helper": "3.x",
+    "json-immutability-helper": "4.x",
     "lean-test": "2.x",
     "prettier": "3.3.3",
     "rollup": "4.x",
     "rollup-plugin-dts": "6.x",
     "superwstest": "2.x",
     "tslib": "2.7.x",
-    "typescript": "5.5.x",
+    "typescript": "5.6.x",
     "websocket-express": "3.x"
   }
 }