@openbrf/display 0.0.0-stage → 0.1.0

package/dist/fetch-loop.js

@@ -0,0 +1,351 @@
+import { SCREEN_CONTENT_LIMITS } from "./contract.js";
+import { parseScreenContent } from "./parse.js";
+const SECOND = 1000;
+/** How long the last good content may be shown, from when it was fetched. */
+export const STALE_CONTENT_LIMIT_MS = 24 * 60 * 60 * SECOND;
+/** How long one request may take before it counts as a network failure. */
+const REQUEST_TIMEOUT_MS = 30 * SECOND;
+const RETRY_SECONDS = 60;
+/** A cache entry stamped this far in the future is a clock gone wrong, not fresh content. */
+const CLOCK_SKEW_MS = 5 * 60 * SECOND;
+/**
+ * Starts fetching screen content: at once, then `refreshSeconds` after each
+ * 200 or 304, held to 30 to 60, and 60 seconds after anything else.
+ *
+ * Each request is `GET url` with the token in `Authorization: Bearer`, the
+ * cached ETag in `If-None-Match`, no cookie (`credentials: "omit"`) and no
+ * HTTP cache (`cache: "no-store"`). Only one is ever in flight. A cache entry
+ * younger than 24 hours is shown at once, as stale, before the first answer.
+ */
+export function startFetchLoop(options) {
+    const fetchImpl = options.fetch ?? globalThis.fetch.bind(globalThis);
+    const now = () => (options.now ?? (() => new Date()))().getTime();
+    const schedule = options.setTimeout ??
+        ((callback, ms) => setTimeout(callback, ms));
+    const unschedule = options.clearTimeout ??
+        ((handle) => clearTimeout(handle));
+    let stopped = false;
+    let timer = null;
+    let inFlight = null;
+    /** After a 304 with nothing cached, the next request asks unconditionally. */
+    let unconditional = false;
+    /** The last successful fetch, remembered after the cache is cleared. */
+    let lastFetchedAt = null;
+    /** The cache entry, when it is still a document this package reads. */
+    function readCache() {
+        let entry;
+        try {
+            entry = options.cache.read();
+        }
+        catch {
+            return null;
+        }
+        if (entry === null) {
+            return null;
+        }
+        const fetchedAt = Date.parse(entry.fetchedAt);
+        try {
+            if (!Number.isFinite(fetchedAt)) {
+                throw new Error("fetchedAt is not an instant.");
+            }
+            const content = parseScreenContent(entry.content);
+            return {
+                entry: {
+                    content,
+                    etag: typeof entry.etag === "string" ? entry.etag : null,
+                    fetchedAt: entry.fetchedAt,
+                },
+                fetchedAt,
+            };
+        }
+        catch {
+            options.cache.clear();
+            return null;
+        }
+    }
+    function fresh(fetchedAt) {
+        const age = now() - fetchedAt;
+        return age > -CLOCK_SKEW_MS && age < STALE_CONTENT_LIMIT_MS;
+    }
+    function stop() {
+        stopped = true;
+        if (timer !== null) {
+            unschedule(timer);
+            timer = null;
+        }
+        inFlight?.abort();
+        inFlight = null;
+    }
+    function revoke() {
+        stop();
+        options.cache.clear();
+        options.onRevoked();
+    }
+    function next(seconds) {
+        if (stopped) {
+            return;
+        }
+        if (timer !== null) {
+            unschedule(timer);
+        }
+        timer = schedule(() => {
+            timer = null;
+            void request();
+        }, seconds * SECOND);
+    }
+    function remember(fetchedAt) {
+        lastFetchedAt = Math.max(lastFetchedAt ?? fetchedAt, fetchedAt);
+    }
+    /** Any answer but 200, 304, a revoking 401, 404 and 429. */
+    function unreachable() {
+        const cached = readCache();
+        if (cached !== null) {
+            remember(cached.fetchedAt);
+        }
+        if (cached !== null && fresh(cached.fetchedAt)) {
+            options.onContent(cached.entry.content, {
+                fetchedAt: new Date(cached.fetchedAt),
+                stale: true,
+            });
+        }
+        else {
+            options.cache.clear();
+            options.onDisconnected(lastFetchedAt === null ? null : new Date(lastFetchedAt));
+        }
+        next(RETRY_SECONDS);
+    }
+    function shown(content, fetchedAt) {
+        remember(fetchedAt);
+        options.onContent(content, {
+            fetchedAt: new Date(fetchedAt),
+            stale: false,
+        });
+        next(Math.min(SCREEN_CONTENT_LIMITS.refreshSecondsMax, Math.max(SCREEN_CONTENT_LIMITS.refreshSecondsMin, content.refreshSeconds)));
+    }
+    async function request() {
+        if (stopped || inFlight !== null) {
+            return;
+        }
+        const token = options.token();
+        if (token === null || token === "") {
+            revoke();
+            return;
+        }
+        const cached = readCache();
+        const headers = {
+            Accept: "application/json",
+            Authorization: `Bearer ${token}`,
+        };
+        if (cached !== null && cached.entry.etag !== null && !unconditional) {
+            headers["If-None-Match"] = cached.entry.etag;
+        }
+        const controller = new AbortController();
+        inFlight = controller;
+        const timeout = schedule(() => controller.abort(), REQUEST_TIMEOUT_MS);
+        let answer;
+        try {
+            const response = await fetchImpl(options.url, {
+                method: "GET",
+                headers,
+                cache: "no-store",
+                credentials: "omit",
+                mode: "cors",
+                redirect: "error",
+                signal: controller.signal,
+            });
+            answer = await read(response, now());
+        }
+        catch {
+            answer = { kind: "other" };
+        }
+        finally {
+            unschedule(timeout);
+        }
+        if (stopped || inFlight !== controller) {
+            return;
+        }
+        inFlight = null;
+        handle(answer, cached);
+    }
+    function handle(answer, cached) {
+        switch (answer.kind) {
+            case "content": {
+                const fetchedAt = now();
+                unconditional = false;
+                options.cache.write({
+                    content: answer.content,
+                    etag: answer.etag,
+                    fetchedAt: new Date(fetchedAt).toISOString(),
+                });
+                shown(answer.content, fetchedAt);
+                return;
+            }
+            case "not-modified": {
+                if (cached === null) {
+                    unconditional = true;
+                    unreachable();
+                    return;
+                }
+                const fetchedAt = now();
+                options.cache.write({
+                    ...cached.entry,
+                    fetchedAt: new Date(fetchedAt).toISOString(),
+                });
+                shown(cached.entry.content, fetchedAt);
+                return;
+            }
+            case "revoked":
+                revoke();
+                return;
+            case "paused":
+                options.cache.clear();
+                if (options.onPaused === undefined) {
+                    options.onDisconnected(null);
+                }
+                else {
+                    options.onPaused();
+                }
+                next(RETRY_SECONDS);
+                return;
+            case "slow-down": {
+                const current = readCache();
+                if (current !== null && !fresh(current.fetchedAt)) {
+                    // Slowing down does not stretch the 24 hours.
+                    unreachable();
+                    return;
+                }
+                next(answer.retryAfter);
+                return;
+            }
+            case "other":
+                unreachable();
+                return;
+        }
+    }
+    const cachedAtStart = readCache();
+    if (cachedAtStart !== null) {
+        remember(cachedAtStart.fetchedAt);
+        if (fresh(cachedAtStart.fetchedAt)) {
+            options.onContent(cachedAtStart.entry.content, {
+                fetchedAt: new Date(cachedAtStart.fetchedAt),
+                stale: true,
+            });
+        }
+        else {
+            options.cache.clear();
+        }
+    }
+    void request();
+    return {
+        stop,
+        refreshNow() {
+            if (stopped || inFlight !== null) {
+                return;
+            }
+            if (timer !== null) {
+                unschedule(timer);
+                timer = null;
+            }
+            void request();
+        },
+    };
+}
+async function read(response, now) {
+    switch (response.status) {
+        case 200: {
+            const text = await response.text();
+            if (new TextEncoder().encode(text).byteLength >
+                SCREEN_CONTENT_LIMITS.documentBytes) {
+                return { kind: "other" };
+            }
+            try {
+                return {
+                    kind: "content",
+                    content: parseScreenContent(JSON.parse(text)),
+                    etag: response.headers.get("ETag"),
+                };
+            }
+            catch {
+                return { kind: "other" };
+            }
+        }
+        case 304:
+            return { kind: "not-modified" };
+        case 401:
+            return (await revokes(response))
+                ? { kind: "revoked" }
+                : { kind: "other" };
+        case 404:
+            return { kind: "paused" };
+        case 429:
+            return {
+                kind: "slow-down",
+                retryAfter: retryAfter(response.headers.get("Retry-After"), now),
+            };
+        default:
+            return { kind: "other" };
+    }
+}
+/**
+ * Whether a 401 is the instance refusing the token: the challenge names
+ * `realm="device"`, and the body's `reason` (or the challenge's `error`) is
+ * `device-token-invalid`. Any other 401, such as one from a proxy in between,
+ * is not a reason to forget the token.
+ */
+async function revokes(response) {
+    const challenge = parseChallenge(response.headers.get("WWW-Authenticate"));
+    if (challenge === null || challenge.get("realm") !== "device") {
+        return false;
+    }
+    if (challenge.get("error") === "device-token-invalid") {
+        return true;
+    }
+    try {
+        const body = await response.json();
+        return (typeof body === "object" &&
+            body !== null &&
+            body.reason === "device-token-invalid");
+    }
+    catch {
+        return false;
+    }
+}
+/** The parameters of a `Bearer` challenge, or null when there is none. */
+function parseChallenge(header) {
+    if (header === null) {
+        return null;
+    }
+    const match = /^\s*Bearer(?:\s+(.*))?$/i.exec(header);
+    if (match === null) {
+        return null;
+    }
+    const parameters = new Map();
+    const pattern = /([A-Za-z_][\w-]*)\s*=\s*(?:"((?:[^"\\]|\\.)*)"|([^\s,]+))/g;
+    for (const parameter of (match[1] ?? "").matchAll(pattern)) {
+        const name = parameter[1];
+        if (name !== undefined) {
+            parameters.set(name.toLowerCase(), parameter[2]?.replace(/\\(.)/g, "$1") ?? parameter[3] ?? "");
+        }
+    }
+    return parameters;
+}
+/** `Retry-After` in seconds, held to 1 to 60; 60 when absent or unreadable. */
+function retryAfter(header, now) {
+    if (header === null) {
+        return RETRY_SECONDS;
+    }
+    const value = header.trim();
+    let seconds;
+    if (/^\d+$/.test(value)) {
+        seconds = Number(value);
+    }
+    else {
+        const date = Date.parse(value);
+        if (!Number.isFinite(date)) {
+            return RETRY_SECONDS;
+        }
+        seconds = Math.ceil((date - now) / SECOND);
+    }
+    return Math.min(RETRY_SECONDS, Math.max(1, seconds));
+}
+//# sourceMappingURL=fetch-loop.js.map

package/dist/fetch-loop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-loop.js","sourceRoot":"","sources":["../src/fetch-loop.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAgEhD,MAAM,MAAM,GAAG,IAAI,CAAC;AACpB,6EAA6E;AAC7E,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;AAC5D,2EAA2E;AAC3E,MAAM,kBAAkB,GAAG,EAAE,GAAG,MAAM,CAAC;AACvC,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,6FAA6F;AAC7F,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,OAAyB;IACtD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACrE,MAAM,GAAG,GAAG,GAAW,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;IAC1E,MAAM,QAAQ,GACZ,OAAO,CAAC,UAAU;QAClB,CAAC,CAAC,QAAoB,EAAE,EAAU,EAAW,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IAC5E,MAAM,UAAU,GACd,OAAO,CAAC,YAAY;QACpB,CAAC,CAAC,MAAe,EAAQ,EAAE,CACzB,YAAY,CAAC,MAAuC,CAAC,CAAC,CAAC;IAE3D,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,KAAK,GAAY,IAAI,CAAC;IAC1B,IAAI,QAAQ,GAA2B,IAAI,CAAC;IAC5C,8EAA8E;IAC9E,IAAI,aAAa,GAAG,KAAK,CAAC;IAC1B,wEAAwE;IACxE,IAAI,aAAa,GAAkB,IAAI,CAAC;IAExC,uEAAuE;IACvE,SAAS,SAAS;QAIhB,IAAI,KAAiC,CAAC;QACtC,IAAI,CAAC;YACH,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAClD,OAAO;gBACL,KAAK,EAAE;oBACL,OAAO;oBACP,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;oBACxD,SAAS,EAAE,KAAK,CAAC,SAAS;iBAC3B;gBACD,SAAS;aACV,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,SAAS,KAAK,CAAC,SAAiB;QAC9B,MAAM,GAAG,GAAG,GAAG,EAAE,GAAG,SAAS,CAAC;QAC9B,OAAO,GAAG,GAAG,CAAC,aAAa,IAAI,GAAG,GAAG,sBAAsB,CAAC;IAC9D,CAAC;IAED,SAAS,IAAI;QACX,OAAO,GAAG,IAAI,CAAC;QACf,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,UAAU,CAAC,KAAK,CAAC,CAAC;YAClB,KAAK,GAAG,IAAI,CAAC;QACf,CAAC;QACD,QAAQ,EAAE,KAAK,EAAE,CAAC;QAClB,QAAQ,GAAG,IAAI,CAAC;IAClB,CAAC;IAED,SAAS,MAAM;QACb,IAAI,EAAE,CAAC;QACP,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACtB,OAAO,CAAC,SAAS,EAAE,CAAC;IACtB,CAAC;IAED,SAAS,IAAI,CAAC,OAAe;QAC3B,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,UAAU,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;QACD,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE;YACpB,KAAK,GAAG,IAAI,CAAC;YACb,KAAK,OAAO,EAAE,CAAC;QACjB,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC;IACvB,CAAC;IAED,SAAS,QAAQ,CAAC,SAAiB;QACjC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,IAAI,SAAS,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC;IAED,4DAA4D;IAC5D,SAAS,WAAW;QAClB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;QAC3B,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/C,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE;gBACtC,SAAS,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;gBACrC,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO,CAAC,cAAc,CACpB,aAAa,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,CACxD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,CAAC;IACtB,CAAC;IAED,SAAS,KAAK,CAAC,OAAsB,EAAE,SAAiB;QACtD,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE;YACzB,SAAS,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC;YAC9B,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;QACH,IAAI,CACF,IAAI,CAAC,GAAG,CACN,qBAAqB,CAAC,iBAAiB,EACvC,IAAI,CAAC,GAAG,CACN,qBAAqB,CAAC,iBAAiB,EACvC,OAAO,CAAC,cAAc,CACvB,CACF,CACF,CAAC;IACJ,CAAC;IAED,KAAK,UAAU,OAAO;QACpB,IAAI,OAAO,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACnC,MAAM,EAAE,CAAC;YACT,OAAO;QACT,CAAC;QACD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;QAC3B,MAAM,OAAO,GAA2B;YACtC,MAAM,EAAE,kBAAkB;YAC1B,aAAa,EAAE,UAAU,KAAK,EAAE;SACjC,CAAC;QACF,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACpE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;QAC/C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,QAAQ,GAAG,UAAU,CAAC;QACtB,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,kBAAkB,CAAC,CAAC;QACvE,IAAI,MAAc,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE;gBAC5C,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,OAAO;gBACjB,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,CAAC,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAC7B,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;QACD,IAAI,OAAO,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,QAAQ,GAAG,IAAI,CAAC;QAChB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzB,CAAC;IAED,SAAS,MAAM,CACb,MAAc,EACd,MAAgE;QAEhE,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,SAAS,EAAE,CAAC;gBACf,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;gBACxB,aAAa,GAAG,KAAK,CAAC;gBACtB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;oBAClB,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,SAAS,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE;iBAC7C,CAAC,CAAC;gBACH,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBACjC,OAAO;YACT,CAAC;YACD,KAAK,cAAc,EAAE,CAAC;gBACpB,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;oBACpB,aAAa,GAAG,IAAI,CAAC;oBACrB,WAAW,EAAE,CAAC;oBACd,OAAO;gBACT,CAAC;gBACD,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;gBACxB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;oBAClB,GAAG,MAAM,CAAC,KAAK;oBACf,SAAS,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE;iBAC7C,CAAC,CAAC;gBACH,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBACvC,OAAO;YACT,CAAC;YACD,KAAK,SAAS;gBACZ,MAAM,EAAE,CAAC;gBACT,OAAO;YACT,KAAK,QAAQ;gBACX,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBACtB,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACnC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBAC/B,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,CAAC;gBACD,IAAI,CAAC,aAAa,CAAC,CAAC;gBACpB,OAAO;YACT,KAAK,WAAW,EAAE,CAAC;gBACjB,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;gBAC5B,IAAI,OAAO,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBAClD,8CAA8C;oBAC9C,WAAW,EAAE,CAAC;oBACd,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBACxB,OAAO;YACT,CAAC;YACD,KAAK,OAAO;gBACV,WAAW,EAAE,CAAC;gBACd,OAAO;QACX,CAAC;IACH,CAAC;IAED,MAAM,aAAa,GAAG,SAAS,EAAE,CAAC;IAClC,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QAC3B,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE;gBAC7C,SAAS,EAAE,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;gBAC5C,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IACD,KAAK,OAAO,EAAE,CAAC;IAEf,OAAO;QACL,IAAI;QACJ,UAAU;YACR,IAAI,OAAO,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACjC,OAAO;YACT,CAAC;YACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,UAAU,CAAC,KAAK,CAAC,CAAC;gBAClB,KAAK,GAAG,IAAI,CAAC;YACf,CAAC;YACD,KAAK,OAAO,EAAE,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAUD,KAAK,UAAU,IAAI,CAAC,QAAkB,EAAE,GAAW;IACjD,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,KAAK,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,IACE,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU;gBACzC,qBAAqB,CAAC,aAAa,EACnC,CAAC;gBACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;YAC3B,CAAC;YACD,IAAI,CAAC;gBACH,OAAO;oBACL,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC7C,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;iBACnC,CAAC;YACJ,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;YAC3B,CAAC;QACH,CAAC;QACD,KAAK,GAAG;YACN,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;QAClC,KAAK,GAAG;YACN,OAAO,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC9B,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE;gBACrB,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QACxB,KAAK,GAAG;YACN,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,KAAK,GAAG;YACN,OAAO;gBACL,IAAI,EAAE,WAAW;gBACjB,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,GAAG,CAAC;aACjE,CAAC;QACJ;YACE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CAAC,QAAkB;IACvC,MAAM,SAAS,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC9D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,sBAAsB,EAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAI,GAAY,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC5C,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;YACxB,IAAI,KAAK,IAAI;YACZ,IAA6B,CAAC,MAAM,KAAK,sBAAsB,CACjE,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,0EAA0E;AAC1E,SAAS,cAAc,CAAC,MAAqB;IAC3C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,0BAA0B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC7C,MAAM,OAAO,GAAG,4DAA4D,CAAC;IAC7E,KAAK,MAAM,SAAS,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3D,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,UAAU,CAAC,GAAG,CACZ,IAAI,CAAC,WAAW,EAAE,EAClB,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAC5D,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,+EAA+E;AAC/E,SAAS,UAAU,CAAC,MAAqB,EAAE,GAAW;IACpD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,aAAa,CAAC;IACvB,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,OAAe,CAAC;IACpB,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,aAAa,CAAC;QACvB,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AACvD,CAAC"}

package/dist/fit.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Fitting a slide to the canvas.
+ *
+ * The contract lets a slide hold more than one canvas can show at a size read
+ * from across a stairwell: eight events, twelve resources, an agenda of forty
+ * items, sixty table rows, a hundred and twenty doors, two thousand characters
+ * of news in as many paragraphs and lines as it likes. Nothing a slide holds is
+ * cut off; a slide the canvas cannot hold is shown a page at a time:
+ *
+ * 1. A slide's list is shown as many of its items as the canvas holds whole.
+ * 2. A page still too tall, such as one long event or a news item, is set
+ *    smaller, down to `MIN_SCALE` of its size.
+ * 3. A page too tall even then continues on the next page, its text broken
+ *    between two words, or a word longer than a page holds between two of its
+ *    characters.
+ *
+ * It measures the slide in the page, so it does nothing where nothing is laid
+ * out: before the element has a size, and under a DOM without layout.
+ */
+/** The attribute on a slide's list that may be shown a page at a time. */
+export declare const PAGED_LIST_ATTRIBUTE = "data-obrf-display-paged";
+/**
+ * The attribute on an element of a slide whose text is all on other pages of
+ * it. The stylesheet takes it out of the page, except a table's cell, which
+ * stays empty to keep its row's columns.
+ */
+export declare const ELSEWHERE_ATTRIBUTE = "data-obrf-display-elsewhere";
+/** Which page of the slide is shown, of how many, and whether it fits. */
+export interface SlideFit {
+    page: number;
+    pages: number;
+    /**
+     * False when the page still holds more than it shows: a single character
+     * too wide or too tall for the canvas even at `MIN_SCALE`.
+     */
+    fits: boolean;
+}
+/**
+ * Fits a slide that is on the stage, showing page `page` of it (the last page
+ * when it has fewer). `unit` is the canvas's unit in pixels, a hundredth of
+ * its shorter side, or 0 when it has no size.
+ */
+export declare function fitSlide(slide: HTMLElement, unit: number, page: number): SlideFit;
+//# sourceMappingURL=fit.d.ts.map

package/dist/fit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fit.d.ts","sourceRoot":"","sources":["../src/fit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,0EAA0E;AAC1E,eAAO,MAAM,oBAAoB,4BAA4B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,gCAAgC,CAAC;AAOjE,0EAA0E;AAC1E,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAaD;;;;GAIG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,QAAQ,CAwCV"}

package/dist/fit.js

@@ -0,0 +1,257 @@
+/**
+ * Fitting a slide to the canvas.
+ *
+ * The contract lets a slide hold more than one canvas can show at a size read
+ * from across a stairwell: eight events, twelve resources, an agenda of forty
+ * items, sixty table rows, a hundred and twenty doors, two thousand characters
+ * of news in as many paragraphs and lines as it likes. Nothing a slide holds is
+ * cut off; a slide the canvas cannot hold is shown a page at a time:
+ *
+ * 1. A slide's list is shown as many of its items as the canvas holds whole.
+ * 2. A page still too tall, such as one long event or a news item, is set
+ *    smaller, down to `MIN_SCALE` of its size.
+ * 3. A page too tall even then continues on the next page, its text broken
+ *    between two words, or a word longer than a page holds between two of its
+ *    characters.
+ *
+ * It measures the slide in the page, so it does nothing where nothing is laid
+ * out: before the element has a size, and under a DOM without layout.
+ */
+/** The attribute on a slide's list that may be shown a page at a time. */
+export const PAGED_LIST_ATTRIBUTE = "data-obrf-display-paged";
+/**
+ * The attribute on an element of a slide whose text is all on other pages of
+ * it. The stylesheet takes it out of the page, except a table's cell, which
+ * stays empty to keep its row's columns.
+ */
+export const ELSEWHERE_ATTRIBUTE = "data-obrf-display-elsewhere";
+/** The smallest a slide is set, as a share of its size. */
+const MIN_SCALE = 0.6;
+const SCALE_STEP = 0.05;
+/**
+ * Fits a slide that is on the stage, showing page `page` of it (the last page
+ * when it has fewer). `unit` is the canvas's unit in pixels, a hundredth of
+ * its shorter side, or 0 when it has no size.
+ */
+export function fitSlide(slide, unit, page) {
+    const list = slide.querySelector(`[${PAGED_LIST_ATTRIBUTE}]`);
+    const items = list === null
+        ? []
+        : Array.from(list.children);
+    restore(slide, items);
+    if (unit <= 0 || !overflows(slide)) {
+        return { page: 0, pages: 1, fits: true };
+    }
+    const pages = [];
+    for (const [from, to] of itemPages(slide, items)) {
+        restore(slide, items);
+        show(items, from, to);
+        const scaled = shrink(slide, unit);
+        if (!overflows(slide)) {
+            pages.push({ from, to, unit: scaled, text: null });
+            continue;
+        }
+        const parts = textPages(slide, textFlow(slide));
+        for (const text of parts.length > 0 ? parts : [null]) {
+            pages.push({ from, to, unit: scaled, text });
+        }
+    }
+    const shown = Math.min(Math.max(0, page), pages.length - 1);
+    const chosen = pages[shown] ?? {
+        from: 0,
+        to: items.length,
+        unit: null,
+        text: null,
+    };
+    restore(slide, items);
+    show(items, chosen.from, chosen.to);
+    if (chosen.unit !== null) {
+        slide.style.setProperty("--obrf-display-u", chosen.unit);
+    }
+    if (chosen.text !== null) {
+        textFlow(slide).show(...chosen.text);
+    }
+    return { page: shown, pages: pages.length, fits: !overflows(slide) };
+}
+/** Shows the items from `from` up to `to`, and hides the rest. */
+function show(items, from, to) {
+    items.forEach((item, index) => {
+        item.hidden = index < from || index >= to;
+    });
+}
+/** The ranges of the list's items a page each holds whole: all of it when it has one item or none. */
+function itemPages(slide, items) {
+    if (items.length <= 1) {
+        return [[0, items.length]];
+    }
+    const pages = [];
+    for (let start = 0; start < items.length;) {
+        const count = fitting(slide, items, start);
+        pages.push([start, start + count]);
+        start += count;
+    }
+    return pages;
+}
+/** How many items from `start` the slide holds whole: at least one. */
+function fitting(slide, items, start) {
+    let low = 1;
+    let high = items.length - start;
+    while (low < high) {
+        const count = Math.ceil((low + high) / 2);
+        show(items, start, start + count);
+        if (overflows(slide)) {
+            high = count - 1;
+        }
+        else {
+            low = count;
+        }
+    }
+    return low;
+}
+/** Sets the slide smaller until it fits or reaches `MIN_SCALE`, and hands back the unit it set. */
+function shrink(slide, unit) {
+    let set = null;
+    for (let scale = 1 - SCALE_STEP; overflows(slide) && scale >= MIN_SCALE - SCALE_STEP / 2; scale -= SCALE_STEP) {
+        set = `${unit * scale}px`;
+        slide.style.setProperty("--obrf-display-u", set);
+    }
+    return set;
+}
+/**
+ * The pages of text the slide holds, each at least one character. A page ends
+ * between two words. A word longer than a page holds starts on the page it
+ * comes to, is broken between two of its characters, and goes on on the next.
+ */
+function textPages(slide, flow) {
+    const pages = [];
+    for (let start = 0; start < flow.length;) {
+        const words = flow.wordEnds.filter((wordEnd) => wordEnd > start);
+        let end = furthest(slide, flow, start, words);
+        const next = words.find((wordEnd) => wordEnd > end);
+        flow.show(start, end);
+        if (overflows(slide)) {
+            // The page is one word, and the word longer than it.
+            end = furthest(slide, flow, start, flow.characterEnds(start, end));
+        }
+        else if (next !== undefined) {
+            // The next word would be longer than a page even on a page of its own.
+            flow.show(end, next);
+            if (overflows(slide)) {
+                end = furthest(slide, flow, start, [
+                    end,
+                    ...flow.characterEnds(end, next),
+                ]);
+            }
+        }
+        pages.push([start, end]);
+        start = end;
+    }
+    return pages;
+}
+/** The furthest of `ends` the slide holds its text up to from `start`: at least the first. */
+function furthest(slide, flow, start, ends) {
+    let low = 0;
+    let high = ends.length - 1;
+    while (low < high) {
+        const middle = Math.ceil((low + high) / 2);
+        flow.show(start, ends[middle] ?? flow.length);
+        if (overflows(slide)) {
+            high = middle - 1;
+        }
+        else {
+            low = middle;
+        }
+    }
+    return ends[low] ?? flow.length;
+}
+/** Each text node's own text, while a page shows part of it. */
+const originals = new WeakMap();
+function textNodes(slide) {
+    const nodes = [];
+    const walker = slide.ownerDocument.createTreeWalker(slide, NodeFilter.SHOW_TEXT);
+    for (let node = walker.nextNode(); node !== null; node = walker.nextNode()) {
+        nodes.push(node);
+    }
+    return nodes;
+}
+/** Puts every text back, shows every element and item, and sets the slide at the canvas's unit. */
+function restore(slide, items) {
+    slide.style.removeProperty("--obrf-display-u");
+    for (const node of textNodes(slide)) {
+        const text = originals.get(node);
+        if (text !== undefined && node.data !== text) {
+            node.data = text;
+        }
+    }
+    for (const node of Array.from(slide.querySelectorAll(`[${ELSEWHERE_ATTRIBUTE}]`))) {
+        node.removeAttribute(ELSEWHERE_ATTRIBUTE);
+    }
+    show(items, 0, items.length);
+}
+function textFlow(slide) {
+    const texts = [];
+    const wordEnds = [];
+    let whole = "";
+    for (const node of textNodes(slide)) {
+        if (node.parentElement?.closest("[hidden]") != null) {
+            continue;
+        }
+        const text = originals.get(node) ?? node.data;
+        originals.set(node, text);
+        // A word ends where the next one starts, so that a page ends after the
+        // space or line break that follows its last word.
+        const ends = Array.from(text.matchAll(/\S+\s*/g), (match) => whole.length + match.index + match[0].length);
+        if (ends.length > 0) {
+            texts.push({ node, text, first: whole.length });
+            wordEnds.push(...ends);
+            whole += text;
+        }
+    }
+    return {
+        length: whole.length,
+        wordEnds,
+        characterEnds(from, to) {
+            const part = whole.slice(from, to);
+            if (typeof Intl.Segmenter === "function") {
+                return Array.from(new Intl.Segmenter().segment(part), ({ index, segment }) => from + index + segment.length);
+            }
+            // A browser without it breaks between two code points.
+            const ends = [];
+            let end = from;
+            for (const character of part) {
+                end += character.length;
+                ends.push(end);
+            }
+            return ends;
+        },
+        show(from, to) {
+            const holding = new Set();
+            const empty = new Set();
+            for (const { node, text, first } of texts) {
+                const start = Math.max(from - first, 0);
+                const end = Math.min(to - first, text.length);
+                const shown = start >= end ? "" : text.slice(start, end);
+                node.data = end < text.length ? shown.trimEnd() : shown;
+                for (let element = node.parentElement; element !== null && element !== slide; element = element.parentElement) {
+                    (shown === "" ? empty : holding).add(element);
+                }
+            }
+            for (const element of new Set([...empty, ...holding])) {
+                element.toggleAttribute(ELSEWHERE_ATTRIBUTE, !holding.has(element));
+            }
+        },
+    };
+}
+/**
+ * Whether the slide, or a box in it that clips its own text, holds more than
+ * it shows.
+ */
+function overflows(slide) {
+    const boxes = [
+        slide,
+        ...Array.from(slide.querySelectorAll(".obrf-display-copy")),
+    ];
+    return boxes.some((box) => box.scrollHeight > box.clientHeight + 1 ||
+        box.scrollWidth > box.clientWidth + 1);
+}
+//# sourceMappingURL=fit.js.map