@brass-build/client 0.4.0 → 0.5.0

package/dist/document-set-subscription.d.ts

@@ -0,0 +1,56 @@
+import type { DocumentListing, ListDocumentsQuery } from './documents-namespace.js';
+import type { InputReference } from './hosted-ui.js';
+import type { SubscribeOptions, WsTopicCallback } from './ws-client.js';
+/** The slice of the socket client a subscription uses. */
+export interface DocumentSetSocket {
+    subscribe(topic: string, callback: WsTopicCallback, options?: SubscribeOptions): () => void;
+}
+/**
+ * The feed topic that covers each reference: `organization:<id>`,
+ * `project:<id>`, or `reference:<id>` for a document, which fires when the
+ * document or anything filed under it changes.
+ */
+export declare function feedTopicsFor(refs: readonly InputReference[]): string[];
+/** Whether a frame on a feed could have moved what a listing answers: any
+ *  data frame does, whatever its type, since the listing decides. */
+export declare function frameCouldMoveSet(frame: unknown): boolean;
+/** Whether two listings differ, keyed by `doc_id`: a document joined, left,
+ *  or has a different `updated_at` or work `status`. */
+export declare function listingsDiffer(previous: readonly DocumentListing[], next: readonly DocumentListing[]): boolean;
+/**
+ * How long a trigger waits before listing, so a burst of frames (a move
+ * stamps the document and nudges both containers) is one listing.
+ */
+export declare const RELIST_COALESCE_MS = 250;
+/** The longest the first listing waits for its feeds to be established. */
+export declare const FEED_WAIT_MS = 3000;
+/**
+ * Watch the set `query` lists and call `listener` whenever a listing differs
+ * from the last one, starting from `initial`. Returns the stop function.
+ */
+export declare function watchDocumentSet(args: {
+    query: ListDocumentsQuery;
+    list: (query: ListDocumentsQuery) => Promise<DocumentListing[]>;
+    socket: DocumentSetSocket | undefined;
+    listener: () => void;
+    initial: DocumentListing[];
+}): () => void;
+/** A listing, as `Brass.documents.list` returns it. */
+export interface DocumentList {
+    /** The set as it stood when it was listed. */
+    readonly documents: DocumentListing[];
+    /** Whether the set has moved since: a document joined it, left it, or
+     *  changed (its `updated_at` or work `status`). List again to see how. */
+    readonly changed: boolean;
+    /** Fires once, when the set moves. The set is watched only while a
+     *  listener is registered and until `close`; throws after `close`. */
+    onChanged(cb: () => void): () => void;
+    close(): void;
+}
+export declare function createDocumentList(args: {
+    documents: DocumentListing[];
+    query: ListDocumentsQuery;
+    list: (query: ListDocumentsQuery) => Promise<DocumentListing[]>;
+    socket: DocumentSetSocket | undefined;
+}): DocumentList;
+//# sourceMappingURL=document-set-subscription.d.ts.map

package/dist/document-set-subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-set-subscription.d.ts","sourceRoot":"","sources":["../src/document-set-subscription.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAExE,0DAA0D;AAC1D,MAAM,WAAW,iBAAiB;IAChC,SAAS,CACP,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE,gBAAgB,GACzB,MAAM,IAAI,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,cAAc,EAAE,GAAG,MAAM,EAAE,CAYvE;AAcD;qEACqE;AACrE,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAIzD;AAED;wDACwD;AACxD,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,eAAe,EAAE,EACpC,IAAI,EAAE,SAAS,eAAe,EAAE,GAC/B,OAAO,CAOT;AASD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAEtC,2EAA2E;AAC3E,eAAO,MAAM,YAAY,OAAQ,CAAC;AAElC;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE;IACrC,KAAK,EAAE,kBAAkB,CAAC;IAC1B,IAAI,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAChE,MAAM,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACtC,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,OAAO,EAAE,eAAe,EAAE,CAAC;CAC5B,GAAG,MAAM,IAAI,CA8Fb;AAED,uDAAuD;AACvD,MAAM,WAAW,YAAY;IAC3B,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,EAAE,eAAe,EAAE,CAAC;IACtC;8EAC0E;IAC1E,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;0EACsE;IACtE,SAAS,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IACtC,KAAK,IAAI,IAAI,CAAC;CACf;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE;IACvC,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,IAAI,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAChE,MAAM,EAAE,iBAAiB,GAAG,SAAS,CAAC;CACvC,GAAG,YAAY,CAwDf"}

package/dist/document-set-subscription.js

@@ -0,0 +1,240 @@
+// What lets a listing notice that its set moved (`DocumentList.onChanged`).
+//
+// A feed frame is a trigger and the listing is the truth. The socket feeds
+// that cover a query's references say THAT something in their scope moved;
+// the listing decides what the set is, so folder ancestry, archive members,
+// type matching and the reader's own access are decided in one place, the
+// server's listing, and never re-derived from frames here.
+/**
+ * The feed topic that covers each reference: `organization:<id>`,
+ * `project:<id>`, or `reference:<id>` for a document, which fires when the
+ * document or anything filed under it changes.
+ */
+export function feedTopicsFor(refs) {
+    const topics = new Set();
+    for (const ref of refs) {
+        if (ref.extent === 'organization') {
+            topics.add(`organization:${ref.organization_id}`);
+        }
+        else if (ref.extent === 'project' && ref.project_id) {
+            topics.add(`project:${ref.project_id}`);
+        }
+        else if (ref.extent === 'document' && ref.doc_id) {
+            topics.add(`reference:${ref.doc_id}`);
+        }
+    }
+    return [...topics];
+}
+// Frames the socket client hands a topic's callback that report on the
+// subscription itself rather than on anything in its scope.
+const CONTROL_FRAMES = new Set([
+    'subscribed',
+    'subscribed_ack',
+    'unsubscribed',
+    'not_subscribed',
+    'server_ended',
+    'error',
+    'pong',
+]);
+/** Whether a frame on a feed could have moved what a listing answers: any
+ *  data frame does, whatever its type, since the listing decides. */
+export function frameCouldMoveSet(frame) {
+    if (frame === null || typeof frame !== 'object')
+        return false;
+    const type = frame.type;
+    return typeof type === 'string' && !CONTROL_FRAMES.has(type);
+}
+/** Whether two listings differ, keyed by `doc_id`: a document joined, left,
+ *  or has a different `updated_at` or work `status`. */
+export function listingsDiffer(previous, next) {
+    if (previous.length !== next.length)
+        return true;
+    const before = new Map(previous.map((d) => [d.doc_id, d]));
+    return next.some((doc) => {
+        const was = before.get(doc.doc_id);
+        return was === undefined || was.updated_at !== doc.updated_at || !sameStatus(was.status, doc.status);
+    });
+}
+// An import that fails writes its status without moving the stamp, so the
+// status is compared as well.
+function sameStatus(a, b) {
+    if (a === undefined || b === undefined)
+        return a === b;
+    return a.pending === b.pending && a.blocking === b.blocking && a.message === b.message;
+}
+/**
+ * How long a trigger waits before listing, so a burst of frames (a move
+ * stamps the document and nudges both containers) is one listing.
+ */
+export const RELIST_COALESCE_MS = 250;
+/** The longest the first listing waits for its feeds to be established. */
+export const FEED_WAIT_MS = 3_000;
+/**
+ * Watch the set `query` lists and call `listener` whenever a listing differs
+ * from the last one, starting from `initial`. Returns the stop function.
+ */
+export function watchDocumentSet(args) {
+    const { query, list, socket, listener } = args;
+    let stopped = false;
+    let last = args.initial;
+    let inFlight = false;
+    let again = false;
+    let timer = null;
+    const relist = async () => {
+        if (stopped)
+            return;
+        if (inFlight) {
+            // A frame that lands while a listing is out may describe a write that
+            // listing already missed, so one more follows it.
+            again = true;
+            return;
+        }
+        inFlight = true;
+        try {
+            const next = await list(query);
+            if (stopped)
+                return;
+            const moved = listingsDiffer(last, next);
+            last = next;
+            if (moved)
+                listener();
+        }
+        catch (error) {
+            // The watch keeps its last answer and lists again on the next trigger.
+            if (!stopped)
+                console.error('Brass.documents.list:', error);
+        }
+        finally {
+            inFlight = false;
+            if (again && !stopped) {
+                again = false;
+                schedule();
+            }
+        }
+    };
+    const schedule = () => {
+        // Before the first listing, that listing answers whatever moved.
+        if (stopped || !firstListed || timer !== null)
+            return;
+        timer = setTimeout(() => {
+            timer = null;
+            void relist();
+        }, RELIST_COALESCE_MS);
+    };
+    // The first listing waits for the feeds to be established, so a write
+    // landing between that listing and the subscription cannot fall between
+    // them. A feed the socket refuses, or one that never answers, stops being
+    // waited for rather than holding the first answer back.
+    const awaiting = new Set();
+    let firstListed = false;
+    const listFirst = () => {
+        if (firstListed)
+            return;
+        firstListed = true;
+        if (firstTimer !== null)
+            clearTimeout(firstTimer);
+        void relist();
+    };
+    const settled = (topic) => {
+        awaiting.delete(topic);
+        if (awaiting.size === 0)
+            listFirst();
+    };
+    const unsubscribes = [];
+    const topics = socket ? feedTopicsFor(query.from ?? []) : [];
+    for (const topic of topics)
+        awaiting.add(topic);
+    let firstTimer = topics.length > 0 ? setTimeout(listFirst, FEED_WAIT_MS) : null;
+    for (const topic of topics) {
+        unsubscribes.push(socket.subscribe(topic, (frame) => {
+            if (frameCouldMoveSet(frame))
+                schedule();
+        }, {
+            onSubscribed: ({ resubscribed }) => {
+                // Frames fanned out while the socket was down are gone, so a
+                // re-established feed is answered with a listing.
+                if (resubscribed)
+                    schedule();
+                else
+                    settled(topic);
+            },
+            onEnded: () => settled(topic),
+        }));
+    }
+    if (topics.length === 0)
+        listFirst();
+    return () => {
+        if (stopped)
+            return;
+        stopped = true;
+        if (timer !== null)
+            clearTimeout(timer);
+        if (firstTimer !== null)
+            clearTimeout(firstTimer);
+        for (const unsubscribe of unsubscribes)
+            unsubscribe();
+    };
+}
+export function createDocumentList(args) {
+    let changed = false;
+    let closed = false;
+    let stopWatching = null;
+    const listeners = new Set();
+    const stopWatch = () => {
+        stopWatching?.();
+        stopWatching = null;
+    };
+    const markChanged = () => {
+        if (changed || closed)
+            return;
+        changed = true;
+        stopWatch();
+        const fire = [...listeners];
+        listeners.clear();
+        for (const cb of fire) {
+            try {
+                cb();
+            }
+            catch (err) {
+                console.error('Brass: an onChanged listener threw', err);
+            }
+        }
+    };
+    const set = {
+        documents: args.documents,
+        get changed() {
+            return changed;
+        },
+        onChanged(cb) {
+            if (closed)
+                throw new Error('DocumentList is closed');
+            if (changed) {
+                queueMicrotask(() => {
+                    if (!closed)
+                        cb();
+                });
+                return () => { };
+            }
+            listeners.add(cb);
+            stopWatching ??= watchDocumentSet({
+                query: args.query,
+                list: args.list,
+                socket: args.socket,
+                initial: args.documents,
+                listener: markChanged,
+            });
+            return () => {
+                listeners.delete(cb);
+                if (listeners.size === 0)
+                    stopWatch();
+            };
+        },
+        close() {
+            closed = true;
+            listeners.clear();
+            stopWatch();
+        },
+    };
+    return set;
+}
+//# sourceMappingURL=document-set-subscription.js.map

package/dist/document-set-subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-set-subscription.js","sourceRoot":"","sources":["../src/document-set-subscription.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,4EAA4E;AAC5E,0EAA0E;AAC1E,2DAA2D;AAkB3D;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAA+B;IAC3D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;YAClC,MAAM,CAAC,GAAG,CAAC,gBAAgB,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC;QACpD,CAAC;aAAM,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACtD,MAAM,CAAC,GAAG,CAAC,WAAW,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,GAAG,CAAC,MAAM,KAAK,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACnD,MAAM,CAAC,GAAG,CAAC,aAAa,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC;AACrB,CAAC;AAED,uEAAuE;AACvE,4DAA4D;AAC5D,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC7B,YAAY;IACZ,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,cAAc;IACd,OAAO;IACP,MAAM;CACP,CAAC,CAAC;AAEH;qEACqE;AACrE,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,IAAI,GAAI,KAA4B,CAAC,IAAI,CAAC;IAChD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAED;wDACwD;AACxD,MAAM,UAAU,cAAc,CAC5B,QAAoC,EACpC,IAAgC;IAEhC,IAAI,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IACjD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACvG,CAAC,CAAC,CAAC;AACL,CAAC;AAED,0EAA0E;AAC1E,8BAA8B;AAC9B,SAAS,UAAU,CAAC,CAA4B,EAAE,CAA4B;IAC5E,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,SAAS;QAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACvD,OAAO,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;AACzF,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAEtC,2EAA2E;AAC3E,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC;AAElC;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAMhC;IACC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAC/C,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;IACxB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,KAAK,GAAyC,IAAI,CAAC;IAEvD,MAAM,MAAM,GAAG,KAAK,IAAmB,EAAE;QACvC,IAAI,OAAO;YAAE,OAAO;QACpB,IAAI,QAAQ,EAAE,CAAC;YACb,sEAAsE;YACtE,kDAAkD;YAClD,KAAK,GAAG,IAAI,CAAC;YACb,OAAO;QACT,CAAC;QACD,QAAQ,GAAG,IAAI,CAAC;QAChB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,OAAO;gBAAE,OAAO;YACpB,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACzC,IAAI,GAAG,IAAI,CAAC;YACZ,IAAI,KAAK;gBAAE,QAAQ,EAAE,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,uEAAuE;YACvE,IAAI,CAAC,OAAO;gBAAE,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;gBAAS,CAAC;YACT,QAAQ,GAAG,KAAK,CAAC;YACjB,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;gBACtB,KAAK,GAAG,KAAK,CAAC;gBACd,QAAQ,EAAE,CAAC;YACb,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,GAAS,EAAE;QAC1B,iEAAiE;QACjE,IAAI,OAAO,IAAI,CAAC,WAAW,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO;QACtD,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YACtB,KAAK,GAAG,IAAI,CAAC;YACb,KAAK,MAAM,EAAE,CAAC;QAChB,CAAC,EAAE,kBAAkB,CAAC,CAAC;IACzB,CAAC,CAAC;IAEF,sEAAsE;IACtE,wEAAwE;IACxE,0EAA0E;IAC1E,wDAAwD;IACxD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,SAAS,GAAG,GAAS,EAAE;QAC3B,IAAI,WAAW;YAAE,OAAO;QACxB,WAAW,GAAG,IAAI,CAAC;QACnB,IAAI,UAAU,KAAK,IAAI;YAAE,YAAY,CAAC,UAAU,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,CAAC;IAChB,CAAC,CAAC;IACF,MAAM,OAAO,GAAG,CAAC,KAAa,EAAQ,EAAE;QACtC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;YAAE,SAAS,EAAE,CAAC;IACvC,CAAC,CAAC;IAEF,MAAM,YAAY,GAAsB,EAAE,CAAC;IAC3C,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,KAAK,MAAM,KAAK,IAAI,MAAM;QAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAChD,IAAI,UAAU,GACZ,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,YAAY,CAAC,IAAI,CACf,MAAO,CAAC,SAAS,CACf,KAAK,EACL,CAAC,KAAK,EAAE,EAAE;YACR,IAAI,iBAAiB,CAAC,KAAK,CAAC;gBAAE,QAAQ,EAAE,CAAC;QAC3C,CAAC,EACD;YACE,YAAY,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;gBACjC,6DAA6D;gBAC7D,kDAAkD;gBAClD,IAAI,YAAY;oBAAE,QAAQ,EAAE,CAAC;;oBACxB,OAAO,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;SAC9B,CACF,CACF,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,SAAS,EAAE,CAAC;IAErC,OAAO,GAAG,EAAE;QACV,IAAI,OAAO;YAAE,OAAO;QACpB,OAAO,GAAG,IAAI,CAAC;QACf,IAAI,KAAK,KAAK,IAAI;YAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,UAAU,KAAK,IAAI;YAAE,YAAY,CAAC,UAAU,CAAC,CAAC;QAClD,KAAK,MAAM,WAAW,IAAI,YAAY;YAAE,WAAW,EAAE,CAAC;IACxD,CAAC,CAAC;AACJ,CAAC;AAeD,MAAM,UAAU,kBAAkB,CAAC,IAKlC;IACC,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,YAAY,GAAwB,IAAI,CAAC;IAC7C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAc,CAAC;IACxC,MAAM,SAAS,GAAG,GAAS,EAAE;QAC3B,YAAY,EAAE,EAAE,CAAC;QACjB,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC,CAAC;IACF,MAAM,WAAW,GAAG,GAAS,EAAE;QAC7B,IAAI,OAAO,IAAI,MAAM;YAAE,OAAO;QAC9B,OAAO,GAAG,IAAI,CAAC;QACf,SAAS,EAAE,CAAC;QACZ,MAAM,IAAI,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;QAC5B,SAAS,CAAC,KAAK,EAAE,CAAC;QAClB,KAAK,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC;YACtB,IAAI,CAAC;gBACH,EAAE,EAAE,CAAC;YACP,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,MAAM,GAAG,GAAiB;QACxB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,IAAI,OAAO;YACT,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,SAAS,CAAC,EAAE;YACV,IAAI,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YACtD,IAAI,OAAO,EAAE,CAAC;gBACZ,cAAc,CAAC,GAAG,EAAE;oBAClB,IAAI,CAAC,MAAM;wBAAE,EAAE,EAAE,CAAC;gBACpB,CAAC,CAAC,CAAC;gBACH,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;YAClB,CAAC;YACD,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClB,YAAY,KAAK,gBAAgB,CAAC;gBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,OAAO,EAAE,IAAI,CAAC,SAAS;gBACvB,QAAQ,EAAE,WAAW;aACtB,CAAC,CAAC;YACH,OAAO,GAAG,EAAE;gBACV,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBACrB,IAAI,SAAS,CAAC,IAAI,KAAK,CAAC;oBAAE,SAAS,EAAE,CAAC;YACxC,CAAC,CAAC;QACJ,CAAC;QACD,KAAK;YACH,MAAM,GAAG,IAAI,CAAC;YACd,SAAS,CAAC,KAAK,EAAE,CAAC;YAClB,SAAS,EAAE,CAAC;QACd,CAAC;KACF,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/document-signals.d.ts

@@ -41,6 +41,7 @@ export interface DrivePublishTarget {
     detail: string;
     publishing: boolean;
     publishFailed: boolean;
+    unpublishable: boolean;
 }
 export declare class GoneSignal {
     private readonly _emitter;
@@ -51,9 +52,14 @@ export declare class GoneSignal {
 }
 export declare class WorkStatusSignal {
     private readonly _emitter;
+    private _work;
+    private _notice;
     get status(): DocumentWorkStatus | null;
+    get work(): DocumentWorkStatus | null;
+    get notice(): DocumentWorkStatus | null;
     on(cb: DocumentStatusListener): DocumentStatusUnsubscribe;
     emit(status: DocumentWorkStatus): void;
+    setNotice(notice: DocumentWorkStatus | null): void;
     clearListeners(): void;
 }
 export declare class DriveStatusSignal {

package/dist/document-signals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document-signals.d.ts","sourceRoot":"","sources":["../src/document-signals.ts"],"names":[],"mappings":"AAeA,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,OAAO,CAAC;AAErD,MAAM,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;AACxE,MAAM,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC;AAOjD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IAMjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAC1E,MAAM,MAAM,yBAAyB,GAAG,MAAM,IAAI,CAAC;AAMnD,MAAM,MAAM,0BAA0B,GAClC,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,UAAU,CAAC;AAKf,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,aAAa,CAAC;AAO7D,MAAM,WAAW,mBAAmB;IAGlC,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,0BAA0B,CAAC;IAGlC,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAGtB,MAAM,EAAE,OAAO,CAAC;IAIhB,kBAAkB,EAAE,OAAO,CAAC;IAI5B,eAAe,EAAE,oBAAoB,CAAC;IAEtC,GAAG,EAAE,MAAM,CAAC;IAEZ,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;IAMhB,UAAU,EAAE,OAAO,CAAC;IACpB;;;iEAG6D;IAC7D,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,2BAA2B,GAAG,CACxC,MAAM,EAAE,mBAAmB,KACxB,IAAI,CAAC;AACV,MAAM,MAAM,8BAA8B,GAAG,MAAM,IAAI,CAAC;AAUxD,MAAM,WAAW,kBAAkB;IAEjC,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAGlB,aAAa,EAAE,MAAM,CAAC;IAEtB,MAAM,EAAE,MAAM,CAAC;IAGf,UAAU,EAAE,OAAO,CAAC;IAGpB,aAAa,EAAE,OAAO,CAAC;CACxB;AAcD,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAOtB;IAEH,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED,EAAE,CAAC,EAAE,EAAE,oBAAoB,GAAG,uBAAuB;IAIrD,IAAI,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAMtC,cAAc,IAAI,IAAI;CAGvB;AAKD,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAMtB;IAEH,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED,EAAE,CAAC,EAAE,EAAE,sBAAsB,GAAG,yBAAyB;IAIzD,IAAI,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAItC,cAAc,IAAI,IAAI;CAGvB;AAOD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAOtB;IAEH,IAAI,MAAM,IAAI,mBAAmB,GAAG,IAAI,CAEvC;IAED,EAAE,CAAC,EAAE,EAAE,2BAA2B,GAAG,8BAA8B;IAInE,IAAI,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAIvC,cAAc,IAAI,IAAI;CAGvB;AAKD,MAAM,WAAW,iBAAiB;IAEhC,UAAU,EAAE,OAAO,CAAC;IAGpB,MAAM,EAAE,OAAO,CAAC;IAGhB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAgBD,qBAAa,wBAAwB;IACnC,OAAO,CAAC,OAAO,CAAmC;IAClD,OAAO,CAAC,MAAM,CAAsC;IACpD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyB;IAEpD,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED,IAAI,KAAK,IAAI,iBAAiB,CAE7B;IAED,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,GAAG,IAAI;IAY5C,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAKxC,OAAO,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAUnC,cAAc,IAAI,IAAI;IAOtB,OAAO,CAAC,OAAO;CAGhB"}
+{"version":3,"file":"document-signals.d.ts","sourceRoot":"","sources":["../src/document-signals.ts"],"names":[],"mappings":"AAeA,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,OAAO,CAAC;AAErD,MAAM,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;AACxE,MAAM,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC;AAOjD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IAMjB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;AAC1E,MAAM,MAAM,yBAAyB,GAAG,MAAM,IAAI,CAAC;AAMnD,MAAM,MAAM,0BAA0B,GAClC,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,UAAU,CAAC;AAKf,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,aAAa,CAAC;AAO7D,MAAM,WAAW,mBAAmB;IAGlC,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,0BAA0B,CAAC;IAKlC,OAAO,EAAE,OAAO,CAAC;IAEjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAGtB,MAAM,EAAE,OAAO,CAAC;IAIhB,kBAAkB,EAAE,OAAO,CAAC;IAS5B,eAAe,EAAE,oBAAoB,CAAC;IAEtC,GAAG,EAAE,MAAM,CAAC;IAEZ,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;IAMhB,UAAU,EAAE,OAAO,CAAC;IACpB;;;iEAG6D;IAC7D,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,2BAA2B,GAAG,CACxC,MAAM,EAAE,mBAAmB,KACxB,IAAI,CAAC;AACV,MAAM,MAAM,8BAA8B,GAAG,MAAM,IAAI,CAAC;AAUxD,MAAM,WAAW,kBAAkB;IAEjC,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAGlB,aAAa,EAAE,MAAM,CAAC;IAEtB,MAAM,EAAE,MAAM,CAAC;IAGf,UAAU,EAAE,OAAO,CAAC;IAGpB,aAAa,EAAE,OAAO,CAAC;IAGvB,aAAa,EAAE,OAAO,CAAC;CACxB;AAcD,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAOtB;IAEH,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED,EAAE,CAAC,EAAE,EAAE,oBAAoB,GAAG,uBAAuB;IAIrD,IAAI,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAMtC,cAAc,IAAI,IAAI;CAGvB;AAeD,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAMtB;IACH,OAAO,CAAC,KAAK,CAAmC;IAChD,OAAO,CAAC,OAAO,CAAmC;IAElD,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED,IAAI,IAAI,IAAI,kBAAkB,GAAG,IAAI,CAEpC;IAED,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED,EAAE,CAAC,EAAE,EAAE,sBAAsB,GAAG,yBAAyB;IAIzD,IAAI,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAStC,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,GAAG,IAAI;IAMlD,cAAc,IAAI,IAAI;CAGvB;AAOD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAOtB;IAEH,IAAI,MAAM,IAAI,mBAAmB,GAAG,IAAI,CAEvC;IAED,EAAE,CAAC,EAAE,EAAE,2BAA2B,GAAG,8BAA8B;IAInE,IAAI,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAIvC,cAAc,IAAI,IAAI;CAGvB;AAKD,MAAM,WAAW,iBAAiB;IAEhC,UAAU,EAAE,OAAO,CAAC;IAGpB,MAAM,EAAE,OAAO,CAAC;IAGhB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAgBD,qBAAa,wBAAwB;IACnC,OAAO,CAAC,OAAO,CAAmC;IAClD,OAAO,CAAC,MAAM,CAAsC;IACpD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAyB;IAEpD,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED,IAAI,KAAK,IAAI,iBAAiB,CAE7B;IAED,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,IAAI,GAAG,IAAI;IAY5C,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAKxC,OAAO,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAUnC,cAAc,IAAI,IAAI;IAOtB,OAAO,CAAC,OAAO;CAGhB"}

package/dist/document-signals.js

@@ -41,9 +41,18 @@ export class GoneSignal {
         this._emitter.clear();
     }
 }
+const NO_WORK_STATUS = { message: '', pending: false, blocking: false };
 // Latest-retained, re-emit-per-phase signal for `doc_status`. Not one-shot:
 // phases arrive repeatedly until terminal (`pending: false`), and the latest
 // is retained so a late subscriber still sees the final state.
+//
+// A notice is the SDK's own status, raised over the platform's work rather
+// than replacing it: `status` reads the notice while one is up, and `work`
+// keeps answering what the platform reported, which is what every SDK-side
+// decision about pending work reads. A work status arriving under a notice
+// still reaches the listeners (the SDK's own import waiters attach here and
+// wait for a terminal one), and the notice is re-emitted straight after it so
+// the last thing a listener hears matches `status`.
 export class WorkStatusSignal {
     _emitter = createEmitter({
         fireOnAttach: true,
@@ -52,14 +61,34 @@ export class WorkStatusSignal {
             console.error('[Brass] onStatus listener threw:', err);
         },
     });
+    _work = null;
+    _notice = null;
     get status() {
-        return this._emitter.retained ?? null;
+        return this._notice ?? this._work;
+    }
+    get work() {
+        return this._work;
+    }
+    get notice() {
+        return this._notice;
     }
     on(cb) {
         return this._emitter.on(cb);
     }
     emit(status) {
+        this._work = status;
         this._emitter.emit(status);
+        if (this._notice !== null)
+            this._emitter.emit(this._notice);
+    }
+    // Raise or clear the notice. Clearing hands listeners the work status it
+    // covered, or a terminal empty one when there is none, since a listener
+    // takes a status rather than `null`.
+    setNotice(notice) {
+        if (notice === this._notice)
+            return;
+        this._notice = notice;
+        this._emitter.emit(notice ?? this._work ?? NO_WORK_STATUS);
     }
     clearListeners() {
         this._emitter.clear();
@@ -162,6 +191,7 @@ function driveStatusEqual(a, b) {
         a.detail === b.detail &&
         a.broken === b.broken &&
         a.pushReplacesRemote === b.pushReplacesRemote &&
+        a.keepsPriorVersions === b.keepsPriorVersions &&
         a.mirrorDirection === b.mirrorDirection &&
         a.ref === b.ref &&
         a.refUpdatedAt === b.refUpdatedAt &&

package/dist/document-signals.js.map

@@ -1 +1 @@
-{"version":3,"file":"document-signals.js","sourceRoot":"","sources":["../src/document-signals.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,2EAA2E;AAC3E,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,4DAA4D;AAC5D,yEAAyE;AAEzE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAmI7C,6EAA6E;AAC7E,yEAAyE;AACzE,wEAAwE;AACxE,8EAA8E;AAC9E,2EAA2E;AAC3E,qBAAqB;AAErB,6EAA6E;AAC7E,8EAA8E;AAC9E,+EAA+E;AAC/E,8EAA8E;AAC9E,sDAAsD;AACtD,MAAM,OAAO,UAAU;IACJ,QAAQ,GAAG,aAAa,CAAqB;QAC5D,YAAY,EAAE,IAAI;QAClB,MAAM,EAAE,SAAS;QACjB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,sEAAsE;YACtE,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAC;QACvD,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;IACxC,CAAC;IAED,EAAE,CAAC,EAAwB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,MAA0B;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,sEAAsE;IACtE,6EAA6E;IAC7E,cAAc;QACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACF;AAED,4EAA4E;AAC5E,6EAA6E;AAC7E,+DAA+D;AAC/D,MAAM,OAAO,gBAAgB;IACV,QAAQ,GAAG,aAAa,CAAqB;QAC5D,YAAY,EAAE,IAAI;QAClB,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;QACzD,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;IACxC,CAAC;IAED,EAAE,CAAC,EAA0B;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,MAA0B;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACF;AAED,sEAAsE;AACtE,oEAAoE;AACpE,8EAA8E;AAC9E,+EAA+E;AAC/E,sDAAsD;AACtD,MAAM,OAAO,iBAAiB;IACX,QAAQ,GAAG,aAAa,CAAsB;QAC7D,YAAY,EAAE,IAAI;QAClB,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,gBAAgB;QACxB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAC;QAC9D,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;IACxC,CAAC;IAED,EAAE,CAAC,EAA+B;QAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,MAA2B;QAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACF;AAgBD,MAAM,eAAe,GAAsB;IACzC,UAAU,EAAE,KAAK;IACjB,MAAM,EAAE,KAAK;IACb,MAAM,EAAE,IAAI;CACb,CAAC;AAEF,6EAA6E;AAC7E,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,wEAAwE;AACxE,yEAAyE;AACzE,wEAAwE;AACxE,+DAA+D;AAC/D,MAAM,OAAO,wBAAwB;IAC3B,OAAO,GAA8B,IAAI,CAAC;IAC1C,MAAM,GAAsB,eAAe,CAAC;IACnC,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;IAEpD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,GAAG,CAAC,MAAiC;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,wEAAwE;QACxE,iEAAiE;QACjE,IAAI,CAAC,MAAM,GAAG;YACZ,UAAU,EAAE,MAAM,EAAE,UAAU,KAAK,IAAI;YACvC,MAAM,EAAE,MAAM,EAAE,aAAa,KAAK,IAAI;YACtC,MAAM,EAAE,IAAI;SACb,CAAC;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED,QAAQ,CAAC,KAAwB;QAC/B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,EAAc;QACpB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACxB,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,yEAAyE;IACzE,gBAAgB;IAChB,cAAc;QACZ,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED,mEAAmE;IACnE,wEAAwE;IACxE,iEAAiE;IACzD,OAAO;QACb,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,UAAU;YAAE,EAAE,EAAE,CAAC;IACzC,CAAC;CACF;AAED,uEAAuE;AACvE,8EAA8E;AAC9E,4DAA4D;AAC5D,SAAS,gBAAgB,CACvB,CAAsB,EACtB,CAAsB;IAEtB,OAAO,CACL,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;QAC3B,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;QAC3B,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;QACnB,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO;QACvB,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;QACnB,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QACrB,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QACrB,CAAC,CAAC,kBAAkB,KAAK,CAAC,CAAC,kBAAkB;QAC7C,CAAC,CAAC,eAAe,KAAK,CAAC,CAAC,eAAe;QACvC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG;QACf,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,YAAY;QACjC,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,UAAU;QAC7B,CAAC,CAAC,gBAAgB,KAAK,CAAC,CAAC,gBAAgB;QACzC,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;QACzB,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CACxB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"document-signals.js","sourceRoot":"","sources":["../src/document-signals.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,2EAA2E;AAC3E,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,4DAA4D;AAC5D,yEAAyE;AAEzE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AA6I7C,6EAA6E;AAC7E,yEAAyE;AACzE,wEAAwE;AACxE,8EAA8E;AAC9E,2EAA2E;AAC3E,qBAAqB;AAErB,6EAA6E;AAC7E,8EAA8E;AAC9E,+EAA+E;AAC/E,8EAA8E;AAC9E,sDAAsD;AACtD,MAAM,OAAO,UAAU;IACJ,QAAQ,GAAG,aAAa,CAAqB;QAC5D,YAAY,EAAE,IAAI;QAClB,MAAM,EAAE,SAAS;QACjB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,sEAAsE;YACtE,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAC;QACvD,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;IACxC,CAAC;IAED,EAAE,CAAC,EAAwB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,MAA0B;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,sEAAsE;IACtE,6EAA6E;IAC7E,cAAc;QACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACF;AAED,MAAM,cAAc,GAAuB,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAE5F,4EAA4E;AAC5E,6EAA6E;AAC7E,+DAA+D;AAC/D,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,2EAA2E;AAC3E,2EAA2E;AAC3E,4EAA4E;AAC5E,8EAA8E;AAC9E,oDAAoD;AACpD,MAAM,OAAO,gBAAgB;IACV,QAAQ,GAAG,aAAa,CAAqB;QAC5D,YAAY,EAAE,IAAI;QAClB,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;QACzD,CAAC;KACF,CAAC,CAAC;IACK,KAAK,GAA8B,IAAI,CAAC;IACxC,OAAO,GAA8B,IAAI,CAAC;IAElD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC;IACpC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,EAAE,CAAC,EAA0B;QAC3B,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,MAA0B;QAC7B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI;YAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,yEAAyE;IACzE,wEAAwE;IACxE,qCAAqC;IACrC,SAAS,CAAC,MAAiC;QACzC,IAAI,MAAM,KAAK,IAAI,CAAC,OAAO;YAAE,OAAO;QACpC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,IAAI,cAAc,CAAC,CAAC;IAC7D,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACF;AAED,sEAAsE;AACtE,oEAAoE;AACpE,8EAA8E;AAC9E,+EAA+E;AAC/E,sDAAsD;AACtD,MAAM,OAAO,iBAAiB;IACX,QAAQ,GAAG,aAAa,CAAsB;QAC7D,YAAY,EAAE,IAAI;QAClB,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,gBAAgB;QACxB,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAC;QAC9D,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC;IACxC,CAAC;IAED,EAAE,CAAC,EAA+B;QAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,MAA2B;QAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,cAAc;QACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACF;AAgBD,MAAM,eAAe,GAAsB;IACzC,UAAU,EAAE,KAAK;IACjB,MAAM,EAAE,KAAK;IACb,MAAM,EAAE,IAAI;CACb,CAAC;AAEF,6EAA6E;AAC7E,EAAE;AACF,2EAA2E;AAC3E,2EAA2E;AAC3E,wEAAwE;AACxE,yEAAyE;AACzE,wEAAwE;AACxE,+DAA+D;AAC/D,MAAM,OAAO,wBAAwB;IAC3B,OAAO,GAA8B,IAAI,CAAC;IAC1C,MAAM,GAAsB,eAAe,CAAC;IACnC,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;IAEpD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,GAAG,CAAC,MAAiC;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,wEAAwE;QACxE,iEAAiE;QACjE,IAAI,CAAC,MAAM,GAAG;YACZ,UAAU,EAAE,MAAM,EAAE,UAAU,KAAK,IAAI;YACvC,MAAM,EAAE,MAAM,EAAE,aAAa,KAAK,IAAI;YACtC,MAAM,EAAE,IAAI;SACb,CAAC;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED,QAAQ,CAAC,KAAwB;QAC/B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,EAAc;QACpB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACxB,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,yEAAyE;IACzE,gBAAgB;IAChB,cAAc;QACZ,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED,mEAAmE;IACnE,wEAAwE;IACxE,iEAAiE;IACzD,OAAO;QACb,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,UAAU;YAAE,EAAE,EAAE,CAAC;IACzC,CAAC;CACF;AAED,uEAAuE;AACvE,8EAA8E;AAC9E,4DAA4D;AAC5D,SAAS,gBAAgB,CACvB,CAAsB,EACtB,CAAsB;IAEtB,OAAO,CACL,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;QAC3B,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;QAC3B,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;QACnB,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO;QACvB,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;QACnB,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QACrB,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QACrB,CAAC,CAAC,kBAAkB,KAAK,CAAC,CAAC,kBAAkB;QAC7C,CAAC,CAAC,kBAAkB,KAAK,CAAC,CAAC,kBAAkB;QAC7C,CAAC,CAAC,eAAe,KAAK,CAAC,CAAC,eAAe;QACvC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG;QACf,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,YAAY;QACjC,CAAC,CAAC,UAAU,KAAK,CAAC,CAAC,UAAU;QAC7B,CAAC,CAAC,gBAAgB,KAAK,CAAC,CAAC,gBAAgB;QACzC,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;QACzB,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CACxB,CAAC;AACJ,CAAC"}

package/dist/document-streams.d.ts

@@ -1,7 +1,9 @@
 import type { Document, DocumentMutator, DocumentSubscriber, DocumentUnsubscribe, EntityProxy, RootKind } from './documents.js';
 import type { DocumentStreamInfo } from './documents-namespace.js';
 import type { DocumentGoneListener, DocumentGoneUnsubscribe, DocumentStatusListener, DocumentStatusUnsubscribe, DocumentWorkStatus } from './document-signals.js';
-import type { ListHandle, MapHandle, OrderedMapHandle, TextHandle } from './handle-types.js';
+import type { InputDocumentHandlers, InputDocumentOptions } from './input-documents.js';
+import type { ListHandle, MapHandle, MutateOptions, OrderedMapHandle, TextHandle } from './handle-types.js';
+import type { InputReference } from './hosted-ui.js';
 export interface StreamRuntime {
     list(): Promise<DocumentStreamInfo[]>;
     create(name: string): Promise<DocumentStreamInfo>;
@@ -13,7 +15,11 @@ export declare class DocumentStream {
     map<T = unknown>(key: string): MapHandle<T>;
     list<T = unknown>(key: string): ListHandle<T>;
     orderedMap<T = unknown>(mapKey: string, orderKey: string): OrderedMapHandle<T>;
-    mutate<E extends object = EntityProxy>(fn: (d: DocumentMutator<E>) => void): void;
+    mutate<E extends object = EntityProxy>(fn: (d: DocumentMutator<E>) => void, options?: MutateOptions): void;
+    /** Records the documents `key` depends on for this stream; see
+     *  `Document.dependsOn`. A reference to any stream of this document is
+     *  refused. */
+    dependsOn(key: string, refs: readonly InputReference[] | null): void;
     roots(): Record<string, RootKind>;
     text(key: string): TextHandle;
     toJSON(): Record<string, unknown>;
@@ -21,11 +27,39 @@ export declare class DocumentStream {
     get readOnly(): boolean;
     get savingCount(): number;
     get atCapacity(): boolean;
+    /**
+     * The work in flight on this stream, or `null` when there is none. Render
+     * `message` verbatim.
+     */
     get status(): DocumentWorkStatus | null;
+    /**
+     * Calls `cb` with every work-status update for this stream, and once on
+     * attach when a status is already known. Returns an unsubscribe.
+     */
     onStatus(cb: DocumentStatusListener): DocumentStatusUnsubscribe;
     onGone(cb: DocumentGoneListener): DocumentGoneUnsubscribe;
+    /** The input files of a key this stream records references under;
+     *  see `Document.subscribeInputDocuments`. A stream's keys are its own,
+     *  apart from the document's and every other stream's. */
+    subscribeInputDocuments(key: string, handlers: InputDocumentHandlers, options?: InputDocumentOptions): () => void;
+    /**
+     * Reverts this stream's part of the newest undo step that touched it,
+     * leaving the document's other streams as they are.
+     * @deprecated Call `doc.undo()`, which reverts the newest step in every
+     * stream it touched.
+     */
     undo(): boolean;
+    /**
+     * Re-applies this stream's part of the step it most recently undid.
+     * @deprecated Call `doc.redo()`.
+     */
     redo(): boolean;
+    /**
+     * Ends the document's open undo step, so the next local edit in any stream
+     * starts a new one.
+     * @deprecated Call `doc.createCheckpoint()` at the end of each user action,
+     * which also ends the step.
+     */
     sealUndoStep(): void;
 }
 //# sourceMappingURL=document-streams.d.ts.map

package/dist/document-streams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document-streams.d.ts","sourceRoot":"","sources":["../src/document-streams.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,WAAW,EACX,QAAQ,EACT,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EACV,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,gBAAgB,EAChB,UAAU,EACX,MAAM,mBAAmB,CAAC;AAO3B,MAAM,WAAW,aAAa;IAC5B,IAAI,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,qBAAa,cAAc;IAGzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAQtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IAWrC,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAI3C,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IAI7C,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAI9E,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW,EACnC,EAAE,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,GAClC,IAAI;IAIP,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;IAIjC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IAI7B,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAIjC,SAAS,CAAC,EAAE,EAAE,kBAAkB,GAAG,mBAAmB;IAWtD,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAMD,IAAI,WAAW,IAAI,MAAM,CAExB;IAKD,IAAI,UAAU,IAAI,OAAO,CAExB;IAID,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAID,QAAQ,CAAC,EAAE,EAAE,sBAAsB,GAAG,yBAAyB;IAM/D,MAAM,CAAC,EAAE,EAAE,oBAAoB,GAAG,uBAAuB;IAOzD,IAAI,IAAI,OAAO;IAIf,IAAI,IAAI,OAAO;IAUf,YAAY,IAAI,IAAI;CAoErB"}
+{"version":3,"file":"document-streams.d.ts","sourceRoot":"","sources":["../src/document-streams.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,WAAW,EACX,QAAQ,EACT,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EACV,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,gBAAgB,EAChB,UAAU,EACX,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAQrD,MAAM,WAAW,aAAa;IAC5B,IAAI,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAClD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,qBAAa,cAAc;IAGzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAQtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IAWrC,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAI3C,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IAI7C,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAI9E,MAAM,CAAC,CAAC,SAAS,MAAM,GAAG,WAAW,EACnC,EAAE,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,EACnC,OAAO,CAAC,EAAE,aAAa,GACtB,IAAI;IAIP;;mBAEe;IACf,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,cAAc,EAAE,GAAG,IAAI,GAAG,IAAI;IAUpE,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;IAIjC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IAI7B,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAIjC,SAAS,CAAC,EAAE,EAAE,kBAAkB,GAAG,mBAAmB;IAWtD,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAYD,IAAI,WAAW,IAAI,MAAM,CAExB;IAKD,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,kBAAkB,GAAG,IAAI,CAEtC;IAED;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,sBAAsB,GAAG,yBAAyB;IAM/D,MAAM,CAAC,EAAE,EAAE,oBAAoB,GAAG,uBAAuB;IAqBzD;;8DAE0D;IAC1D,uBAAuB,CACrB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,qBAAqB,EAC/B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,MAAM,IAAI;IASb;;;;;OAKG;IACH,IAAI,IAAI,OAAO;IAIf;;;OAGG;IACH,IAAI,IAAI,OAAO;IAIf;;;;;OAKG;IACH,YAAY,IAAI,IAAI;CAoErB"}

package/dist/document-streams.js

@@ -38,8 +38,19 @@ export class DocumentStream {
     orderedMap(mapKey, orderKey) {
         return this._inner.orderedMap(mapKey, orderKey);
     }
-    mutate(fn) {
-        this._inner.mutate(fn);
+    mutate(fn, options) {
+        this._inner.mutate(fn, options);
+    }
+    /** Records the documents `key` depends on for this stream; see
+     *  `Document.dependsOn`. A reference to any stream of this document is
+     *  refused. */
+    dependsOn(key, refs) {
+        this._inner.dependsOn(key, refs);
+    }
+    /** @internal Records what this reader read for the key `status` reports
+     *  on this stream; see `Document.markRead`. */
+    markRead(status, options) {
+        this._inner.markRead(status, options);
     }
     roots() {
         return this._inner.roots();
@@ -62,6 +73,11 @@ export class DocumentStream {
     get readOnly() {
         return this._inner.readOnly;
     }
+    /** @internal This stream's line's `updated_at` as it was opened; see
+     *  `Document.updatedAt`. */
+    get updatedAt() {
+        return this._inner.updatedAt;
+    }
     // Locally-issued ops on this stream the server has not acked yet. This
     // stream's own line: `doc.savingCount` is the one that adds the streams up,
     // and the default stream's inner IS the document, so reading that here would
@@ -75,13 +91,17 @@ export class DocumentStream {
     get atCapacity() {
         return this._inner.atCapacity;
     }
-    // The latest opaque work-status for this stream, or `null` when no slow
-    // server-side work is in flight. Render `message` verbatim.
+    /**
+     * The work in flight on this stream, or `null` when there is none. Render
+     * `message` verbatim.
+     */
     get status() {
         return this._inner.status;
     }
-    // Subscribe to this stream's work-status updates. Fires once on attach when
-    // a status is already known.
+    /**
+     * Calls `cb` with every work-status update for this stream, and once on
+     * attach when a status is already known. Returns an unsubscribe.
+     */
     onStatus(cb) {
         return this._inner.onStatus(cb);
     }
@@ -90,21 +110,52 @@ export class DocumentStream {
     onGone(cb) {
         return this._inner.onGone(cb);
     }
-    // Per-stream undo/redo: each stream keeps its own local-edit stack
-    // (its edits are its own CRDT commits). The doc-level `doc.undo()`
-    // covers only the default stream.
+    /** @internal On a frozen copy: whether this stream has moved since it was
+     *  read. Each stream is its own line, so each is watched on its own. */
+    get changed() {
+        return this._inner.changed;
+    }
+    /** @internal */
+    onChanged(cb) {
+        return this._inner.onChanged(cb);
+    }
+    /** @internal Typed on `ReadOnlyStream`: loads this stream as it stands now
+     *  on a frozen copy. */
+    reload() {
+        return this._inner.reload();
+    }
+    /** The input files of a key this stream records references under;
+     *  see `Document.subscribeInputDocuments`. A stream's keys are its own,
+     *  apart from the document's and every other stream's. */
+    subscribeInputDocuments(key, handlers, options) {
+        return this._inner.subscribeInputDocuments(key, handlers, options);
+    }
+    /** @internal The status of a key this stream records references under. */
+    subscribeInputStatus(key, cb) {
+        return this._inner.subscribeInputStatus(key, cb);
+    }
+    /**
+     * Reverts this stream's part of the newest undo step that touched it,
+     * leaving the document's other streams as they are.
+     * @deprecated Call `doc.undo()`, which reverts the newest step in every
+     * stream it touched.
+     */
     undo() {
-        return this._inner.undo();
+        return this._inner._replayOwnUndoStep('undo');
     }
+    /**
+     * Re-applies this stream's part of the step it most recently undid.
+     * @deprecated Call `doc.redo()`.
+     */
     redo() {
-        return this._inner.redo();
-    }
-    // Seal the stream's open undo group, so the next local edit starts a
-    // fresh undo step. Local and synchronous (no server call). Call it
-    // when a user operation completes: commits group into one step until
-    // sealed (the same same-stroke collapsing the doc-level undo has), so
-    // an app that never seals gets one giant step per session. The
-    // cross-stream operation recipe in `docs/streams.md` is built on this.
+        return this._inner._replayOwnUndoStep('redo');
+    }
+    /**
+     * Ends the document's open undo step, so the next local edit in any stream
+     * starts a new one.
+     * @deprecated Call `doc.createCheckpoint()` at the end of each user action,
+     * which also ends the step.
+     */
     sealUndoStep() {
         this._inner._sealUndoStep();
     }