@mokly/mokly 0.8.0

package/dist/browse/document_adapter.js

@@ -0,0 +1,151 @@
+import { parse } from "parse5";
+import { validateComponentRanges } from "../components/ranges.js";
+import { hasGeneratedOwnershipHeader } from "../build/ownership.js";
+import { MoklyError } from "../errors.js";
+import { logicalMarker, parseLogicalMarker } from "../navigation/logical.js";
+import { duplicateReservedAttributeName, reservedAttributesInStartTag, } from "../navigation/reserved_attributes.js";
+import { parseBrowsingTarget, serializeBrowsingTarget, } from "../navigation/target.js";
+import { expectedPortableHref, trustedDocument } from "./trusted_document.js";
+const HTML_NAMESPACE = "http://www.w3.org/1999/xhtml";
+const SVG_NAMESPACE = "http://www.w3.org/2000/svg";
+/** Authenticate one HTML copy for presentation inside the Browse shell. */
+export function adaptBrowseDocument(content, route, catalogue) {
+    const trusted = trustedDocument(route, catalogue);
+    const document = parse(content, {
+        sourceCodeLocationInfo: true,
+    });
+    if (!trusted)
+        return stripUntrustedMetadata(content, document);
+    if (!hasGeneratedOwnershipHeader(content, trusted.sourcePath)) {
+        throw invalid(route, "trusted Browse document has a missing or mismatched ownership header");
+    }
+    if (trusted.componentView)
+        validateComponentRanges(content, trusted.componentView.ranges);
+    const replacements = [];
+    const nodes = [];
+    let baseTarget;
+    let hasBaseHref = false;
+    visit(document, (node) => {
+        nodes.push(node);
+        const duplicate = duplicateReservedAttributeName(content, node.sourceCodeLocation?.startTag);
+        if (duplicate) {
+            throw invalid(route, `duplicate reserved ${duplicate} metadata`);
+        }
+        const attributes = attributesOf(node);
+        if (node.namespaceURI === HTML_NAMESPACE &&
+            node.tagName === "base" &&
+            baseTarget === undefined &&
+            attributes.has("target")) {
+            baseTarget = attributes.get("target");
+        }
+        if (node.namespaceURI === HTML_NAMESPACE &&
+            node.tagName === "base" &&
+            attributes.has("href")) {
+            hasBaseHref = true;
+        }
+    });
+    const marked = nodes.filter((node) => attributesOf(node).has("data-mokly-link"));
+    if (hasBaseHref && marked.length > 0) {
+        throw invalid(route, "trusted Browse document contains base href with an activatable marker");
+    }
+    for (const node of nodes) {
+        const attributes = attributesOf(node);
+        if (attributes.has("data-mokly-target")) {
+            replacements.push(removeReservedAttribute(content, route, node, "data-mokly-target"));
+        }
+        const marker = attributes.get("data-mokly-link");
+        if (marker === undefined)
+            continue;
+        const destination = parseLogicalMarker(marker);
+        if (!destination || logicalMarker(destination) !== marker) {
+            throw invalid(route, `trusted marker is malformed: ${marker}`);
+        }
+        if (!isNativeLink(node)) {
+            throw invalid(route, `trusted marker is not on a native link: ${marker}`);
+        }
+        const expectedHref = expectedPortableHref(route, trusted, destination, catalogue);
+        if (attributes.get("href") !== expectedHref) {
+            throw invalid(route, `trusted marker ${marker} has a mismatched portable href`);
+        }
+        const ownTarget = attributes.has("target")
+            ? attributes.get("target")
+            : baseTarget;
+        const target = parseBrowsingTarget(ownTarget);
+        if (attributes.has("download") || target.kind === "invalid") {
+            replacements.push(removeReservedAttribute(content, route, node, "data-mokly-link"));
+            continue;
+        }
+        const serializedTarget = serializeBrowsingTarget(target);
+        if (serializedTarget) {
+            replacements.push(insertAttribute(content, route, node, `data-mokly-target="${serializedTarget}"`));
+        }
+    }
+    return applyReplacements(content, replacements);
+}
+function stripUntrustedMetadata(content, document) {
+    const replacements = [];
+    visit(document, (node) => {
+        const startTag = node.sourceCodeLocation?.startTag;
+        for (const occurrence of reservedAttributesInStartTag(content, startTag)) {
+            replacements.push(removeLocatedAttribute(content, startTag, occurrence));
+        }
+    });
+    return applyReplacements(content, replacements);
+}
+function attributesOf(node) {
+    return new Map((node.attrs ?? []).map((attribute) => [attribute.name, attribute.value]));
+}
+function isNativeLink(node) {
+    return ((node.namespaceURI === HTML_NAMESPACE &&
+        (node.tagName === "a" || node.tagName === "area")) ||
+        (node.namespaceURI === SVG_NAMESPACE && node.tagName === "a"));
+}
+function removeReservedAttribute(content, route, node, name) {
+    const startTag = node.sourceCodeLocation?.startTag;
+    const occurrence = reservedAttributesInStartTag(content, startTag).find((candidate) => candidate.name === name);
+    if (!occurrence) {
+        throw invalid(route, `cannot locate reserved ${name} metadata`);
+    }
+    return removeLocatedAttribute(content, startTag, occurrence);
+}
+function removeLocatedAttribute(content, startTag, occurrence) {
+    let startOffset = occurrence.startOffset;
+    const lowerBound = (startTag?.startOffset ?? 0) + 1;
+    while (startOffset > lowerBound &&
+        /[\t\n\f\r ]/.test(content[startOffset - 1] ?? "")) {
+        startOffset -= 1;
+    }
+    return { endOffset: occurrence.endOffset, startOffset, value: "" };
+}
+function insertAttribute(content, route, node, attribute) {
+    const startTag = node.sourceCodeLocation?.startTag;
+    if (!startTag)
+        throw invalid(route, "cannot locate a marked link start tag");
+    const source = content.slice(startTag.startOffset, startTag.endOffset);
+    const closing = source.lastIndexOf(">");
+    if (closing < 0)
+        throw invalid(route, "cannot adapt a marked link start tag");
+    const slash = source.slice(0, closing).match(/\/\s*$/)?.index;
+    const offset = startTag.startOffset + (slash ?? closing);
+    return {
+        endOffset: offset,
+        startOffset: offset,
+        value: ` ${attribute}`,
+    };
+}
+function applyReplacements(content, replacements) {
+    return replacements
+        .sort((left, right) => right.startOffset - left.startOffset)
+        .reduce((current, replacement) => `${current.slice(0, replacement.startOffset)}${replacement.value}${current.slice(replacement.endOffset)}`, content);
+}
+function invalid(route, message) {
+    return new MoklyError("build-invalid", `${route}: ${message}`);
+}
+function visit(node, callback) {
+    callback(node);
+    for (const child of node.childNodes ?? [])
+        visit(child, callback);
+    if (node.content)
+        visit(node.content, callback);
+}
+//# sourceMappingURL=document_adapter.js.map

package/dist/browse/document_adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document_adapter.js","sourceRoot":"","sources":["../../src/browse/document_adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,GAI7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,mBAAmB,EACnB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAsB9E,MAAM,cAAc,GAAG,8BAA8B,CAAC;AACtD,MAAM,aAAa,GAAG,4BAA4B,CAAC;AAEnD,2EAA2E;AAC3E,MAAM,UAAU,mBAAmB,CACjC,OAAe,EACf,KAAa,EACb,SAAoB;IAEpB,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,EAAE;QAC9B,sBAAsB,EAAE,IAAI;KAC7B,CAAwB,CAAC;IAC1B,IAAI,CAAC,OAAO;QAAE,OAAO,sBAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/D,IAAI,CAAC,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9D,MAAM,OAAO,CACX,KAAK,EACL,sEAAsE,CACvE,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,aAAa;QACvB,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACjE,MAAM,YAAY,GAAkB,EAAE,CAAC;IACvC,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,IAAI,UAA8B,CAAC;IACnC,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;QACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,MAAM,SAAS,GAAG,8BAA8B,CAC9C,OAAO,EACP,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAClC,CAAC;QACF,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,OAAO,CAAC,KAAK,EAAE,sBAAsB,SAAS,WAAW,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,IACE,IAAI,CAAC,YAAY,KAAK,cAAc;YACpC,IAAI,CAAC,OAAO,KAAK,MAAM;YACvB,UAAU,KAAK,SAAS;YACxB,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EACxB,CAAC;YACD,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QACD,IACE,IAAI,CAAC,YAAY,KAAK,cAAc;YACpC,IAAI,CAAC,OAAO,KAAK,MAAM;YACvB,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EACtB,CAAC;YACD,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACnC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAC1C,CAAC;IACF,IAAI,WAAW,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrC,MAAM,OAAO,CACX,KAAK,EACL,uEAAuE,CACxE,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,UAAU,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACxC,YAAY,CAAC,IAAI,CACf,uBAAuB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,CAAC,CACnE,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjD,IAAI,MAAM,KAAK,SAAS;YAAE,SAAS;QACnC,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,WAAW,IAAI,aAAa,CAAC,WAAW,CAAC,KAAK,MAAM,EAAE,CAAC;YAC1D,MAAM,OAAO,CAAC,KAAK,EAAE,gCAAgC,MAAM,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,CAAC,KAAK,EAAE,2CAA2C,MAAM,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,MAAM,YAAY,GAAG,oBAAoB,CACvC,KAAK,EACL,OAAO,EACP,WAAW,EACX,SAAS,CACV,CAAC;QACF,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,YAAY,EAAE,CAAC;YAC5C,MAAM,OAAO,CACX,KAAK,EACL,kBAAkB,MAAM,iCAAiC,CAC1D,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC;YACxC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC1B,CAAC,CAAC,UAAU,CAAC;QACf,MAAM,MAAM,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5D,YAAY,CAAC,IAAI,CACf,uBAAuB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,CAAC,CACjE,CAAC;YACF,SAAS;QACX,CAAC;QACD,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,gBAAgB,EAAE,CAAC;YACrB,YAAY,CAAC,IAAI,CACf,eAAe,CACb,OAAO,EACP,KAAK,EACL,IAAI,EACJ,sBAAsB,gBAAgB,GAAG,CAC1C,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,sBAAsB,CAAC,OAAe,EAAE,QAAkB;IACjE,MAAM,YAAY,GAAkB,EAAE,CAAC;IACvC,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;QACnD,KAAK,MAAM,UAAU,IAAI,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;YACzE,YAAY,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,YAAY,CAAC,IAAc;IAClC,OAAO,IAAI,GAAG,CACZ,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CACzE,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAc;IAClC,OAAO,CACL,CAAC,IAAI,CAAC,YAAY,KAAK,cAAc;QACnC,CAAC,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC;QACpD,CAAC,IAAI,CAAC,YAAY,KAAK,aAAa,IAAI,IAAI,CAAC,OAAO,KAAK,GAAG,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAC9B,OAAe,EACf,KAAa,EACb,IAAc,EACd,IAA2B;IAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;IACnD,MAAM,UAAU,GAAG,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CACrE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,CACvC,CAAC;IACF,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,OAAO,CAAC,KAAK,EAAE,0BAA0B,IAAI,WAAW,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,sBAAsB,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,sBAAsB,CAC7B,OAAe,EACf,QAAwC,EACxC,UAAuC;IAEvC,IAAI,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IACzC,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,WAAW,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACpD,OACE,WAAW,GAAG,UAAU;QACxB,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAClD,CAAC;QACD,WAAW,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;AACrE,CAAC;AAED,SAAS,eAAe,CACtB,OAAe,EACf,KAAa,EACb,IAAc,EACd,SAAiB;IAEjB,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;IACnD,IAAI,CAAC,QAAQ;QAAE,MAAM,OAAO,CAAC,KAAK,EAAE,uCAAuC,CAAC,CAAC;IAC7E,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,OAAO,GAAG,CAAC;QAAE,MAAM,OAAO,CAAC,KAAK,EAAE,sCAAsC,CAAC,CAAC;IAC9E,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;IAC9D,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,GAAG,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC;IACzD,OAAO;QACL,SAAS,EAAE,MAAM;QACjB,WAAW,EAAE,MAAM;QACnB,KAAK,EAAE,IAAI,SAAS,EAAE;KACvB,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,OAAe,EACf,YAA2B;IAE3B,OAAO,YAAY;SAChB,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SAC3D,MAAM,CACL,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,CACvB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,EAC3G,OAAO,CACR,CAAC;AACN,CAAC;AAED,SAAS,OAAO,CAAC,KAAa,EAAE,OAAe;IAC7C,OAAO,IAAI,UAAU,CAAC,eAAe,EAAE,GAAG,KAAK,KAAK,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,KAAK,CAAC,IAAc,EAAE,QAAkC;IAC/D,QAAQ,CAAC,IAAI,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,UAAU,IAAI,EAAE;QAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAClE,IAAI,IAAI,CAAC,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAClD,CAAC"}

package/dist/browse/trusted_document.d.ts

@@ -0,0 +1,16 @@
+import type { Viewport } from "../authoring/types.js";
+import type { LogicalTarget } from "../navigation/logical.js";
+import type { ComponentViewRecord } from "../components/manifest_types.js";
+import type { Catalogue } from "../server/catalogue.js";
+/** Manifest-derived identity for one generated Browse document. */
+export interface TrustedBrowseDocument {
+    componentView?: ComponentViewRecord;
+    colorScheme: "dark" | "light";
+    sourcePath: string;
+    viewport: Viewport;
+}
+/** Resolve a public route only when the current manifest owns it. */
+export declare function trustedDocument(route: string, catalogue: Catalogue): TrustedBrowseDocument | undefined;
+/** Derive the exact portable href expected for a trusted logical marker. */
+export declare function expectedPortableHref(sourceRoute: string, source: TrustedBrowseDocument, destination: LogicalTarget, catalogue: Catalogue): string;
+//# sourceMappingURL=trusted_document.d.ts.map

package/dist/browse/trusted_document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trusted_document.d.ts","sourceRoot":"","sources":["../../src/browse/trusted_document.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD,mEAAmE;AACnE,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,qEAAqE;AACrE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,SAAS,GACnB,qBAAqB,GAAG,SAAS,CAmBnC;AAED,4EAA4E;AAC5E,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,qBAAqB,EAC7B,WAAW,EAAE,aAAa,EAC1B,SAAS,EAAE,SAAS,GACnB,MAAM,CAsCR"}

package/dist/browse/trusted_document.js

@@ -0,0 +1,56 @@
+import path from "node:path";
+import { encodeUrlPath } from "../config/paths.js";
+import { MoklyError } from "../errors.js";
+import { generatedViews } from "../components/views.js";
+/** Resolve a public route only when the current manifest owns it. */
+export function trustedDocument(route, catalogue) {
+    for (const entry of catalogue.manifest.entries) {
+        if (entry.kind === "page" && entry.route === route)
+            return {
+                colorScheme: "light",
+                sourcePath: entry.sourcePath,
+                viewport: "desktop",
+            };
+        for (const view of generatedViews(entry)) {
+            if (view.path === route)
+                return {
+                    colorScheme: view.colorScheme,
+                    sourcePath: entry.sourcePath,
+                    viewport: view.viewport,
+                    ...(view.usage ? { componentView: view.usage } : {}),
+                };
+        }
+    }
+    return undefined;
+}
+/** Derive the exact portable href expected for a trusted logical marker. */
+export function expectedPortableHref(sourceRoute, source, destination, catalogue) {
+    const entry = catalogue.byId.get(destination.id);
+    const screen = entry?.kind === "screen" || entry?.kind === "component"
+        ? entry
+        : entry?.kind === "use-case" && entry.steps[0]
+            ? catalogue.byId.get(entry.steps[0].screenId)
+            : undefined;
+    if (entry?.kind !== "page" &&
+        screen?.kind !== "screen" &&
+        screen?.kind !== "component") {
+        throw invalid(sourceRoute, `trusted marker links to an invalid id: ${destination.id}`);
+    }
+    const views = screen
+        ? generatedViews(screen).filter((view) => view.viewport === source.viewport &&
+            (screen.kind !== "component" ||
+                view.variantId === screen.variants[0].id))
+        : [];
+    const targetRoute = entry?.kind === "page"
+        ? entry.route
+        : (views.find((view) => view.colorScheme === source.colorScheme)?.path ??
+            views[0].path);
+    const relative = path.posix.relative(path.posix.dirname(sourceRoute), targetRoute);
+    const encoded = encodeUrlPath(relative);
+    const portable = encoded.startsWith(".") ? encoded : `./${encoded}`;
+    return `${portable}${destination.fragment ? `#${destination.fragment}` : ""}`;
+}
+function invalid(route, message) {
+    return new MoklyError("build-invalid", `${route}: ${message}`);
+}
+//# sourceMappingURL=trusted_document.js.map

package/dist/browse/trusted_document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trusted_document.js","sourceRoot":"","sources":["../../src/browse/trusted_document.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAWxD,qEAAqE;AACrE,MAAM,UAAU,eAAe,CAC7B,KAAa,EACb,SAAoB;IAEpB,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK;YAChD,OAAO;gBACL,WAAW,EAAE,OAAO;gBACpB,UAAU,EAAE,KAAK,CAAC,UAAU;gBAC5B,QAAQ,EAAE,SAAS;aACpB,CAAC;QACJ,KAAK,MAAM,IAAI,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;gBACrB,OAAO;oBACL,WAAW,EAAE,IAAI,CAAC,WAAW;oBAC7B,UAAU,EAAE,KAAK,CAAC,UAAU;oBAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACrD,CAAC;QACN,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,oBAAoB,CAClC,WAAmB,EACnB,MAA6B,EAC7B,WAA0B,EAC1B,SAAoB;IAEpB,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACjD,MAAM,MAAM,GACV,KAAK,EAAE,IAAI,KAAK,QAAQ,IAAI,KAAK,EAAE,IAAI,KAAK,WAAW;QACrD,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,KAAK,EAAE,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5C,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;YAC7C,CAAC,CAAC,SAAS,CAAC;IAClB,IACE,KAAK,EAAE,IAAI,KAAK,MAAM;QACtB,MAAM,EAAE,IAAI,KAAK,QAAQ;QACzB,MAAM,EAAE,IAAI,KAAK,WAAW,EAC5B,CAAC;QACD,MAAM,OAAO,CACX,WAAW,EACX,0CAA0C,WAAW,CAAC,EAAE,EAAE,CAC3D,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,MAAM;QAClB,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,CAC3B,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ;YACjC,CAAC,MAAM,CAAC,IAAI,KAAK,WAAW;gBAC1B,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC,CAC/C;QACH,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,WAAW,GACf,KAAK,EAAE,IAAI,KAAK,MAAM;QACpB,CAAC,CAAC,KAAK,CAAC,KAAK;QACb,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,KAAK,MAAM,CAAC,WAAW,CAAC,EAAE,IAAI;YACpE,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC,CAAC;IACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAC/B,WAAW,CACZ,CAAC;IACF,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;IACpE,OAAO,GAAG,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAChF,CAAC;AAED,SAAS,OAAO,CAAC,KAAa,EAAE,OAAe;IAC7C,OAAO,IAAI,UAAU,CAAC,eAAe,EAAE,GAAG,KAAK,KAAK,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC"}

package/dist/browser/browse.js

@@ -0,0 +1,261 @@
+// src/client/browse.ts
+import { installDiffs } from "./diffs.js";
+import { installWorkspace } from "./workspace.js";
+import { createBrowserDetailsPreference } from "./browse_details.js";
+import { createBrowserNavPreference } from "./browse_navigation.js";
+import {
+  collapseFrame,
+  expandedFrame,
+  handleAddressClick,
+  handleFrameClick
+} from "./browse_frames.js";
+import {
+  captureRegionScrolls,
+  currentColorScheme,
+  currentViewport,
+  restoreRegionScrolls,
+  setColorScheme,
+  setDrawer,
+  setViewport
+} from "./browse_state.js";
+import {
+  applyNavVisibility,
+  selectAndRevealRoute
+} from "./browse_navigation_state.js";
+import { applyPreviewFragmentQuery } from "./preview_fragment.js";
+import { isSameBrowseDocument, NavigationSequencer } from "./navigation.js";
+import { applyNavigationEvidence } from "./browse_evidence.js";
+import { fetchBrowseDestination } from "./browse_fetch.js";
+import {
+  beginNavigation,
+  finishNavigation,
+  readPageStamp
+} from "./browse_update_state.js";
+import { browseLinkTarget } from "./browse_links.js";
+import { handleBrowseControl } from "./browse_controls.js";
+import { copyText } from "./clipboard.js";
+import { attachFrameNavigation } from "./frame_navigation.js";
+import { documentFrameHref, normalizeStaticAlias } from "./static_delivery.js";
+import {
+  handleTagControlClick,
+  handleTagPickerKeydown,
+  syncTagChips
+} from "./tag_filter.js";
+function initBrowseShell(doc, win) {
+  const shell = doc.querySelector("[data-mokly-shell]");
+  const main = doc.querySelector("[data-mokly-view]");
+  if (!shell || !main) return;
+  normalizeStaticAlias(doc, win);
+  applyPreviewFragmentQuery(doc, win.location.search);
+  const detailsPreference = createBrowserDetailsPreference(win);
+  const navPreference = createBrowserNavPreference(win);
+  detailsPreference.apply(doc);
+  navPreference.apply(doc);
+  if (win.history.scrollRestoration) win.history.scrollRestoration = "manual";
+  const sequencer = new NavigationSequencer();
+  let restoringHistory = false;
+  let displayedUrl = new URL(win.location.href);
+  const rememberDocument = () => {
+    sequencer.cancel();
+    finishNavigation(doc);
+    restoringHistory = false;
+    displayedUrl = new URL(win.location.href);
+  };
+  const diffs = installDiffs(doc, win);
+  let disposeWorkspace = installWorkspace(
+    doc,
+    win,
+    diffs.update,
+    rememberDocument
+  );
+  const persistScroll = () => {
+    win.history.replaceState(
+      { scrolls: captureRegionScrolls(doc) },
+      "",
+      win.location.href
+    );
+  };
+  let scrollFramePending = false;
+  persistScroll();
+  doc.addEventListener(
+    "scroll",
+    () => {
+      if (restoringHistory || scrollFramePending) return;
+      persistScroll();
+      scrollFramePending = true;
+      win.requestAnimationFrame(() => {
+        scrollFramePending = false;
+      });
+    },
+    { capture: true, passive: true }
+  );
+  doc.addEventListener(
+    "toggle",
+    (event) => {
+      const group = event.target instanceof HTMLDetailsElement ? event.target : void 0;
+      if (!group?.hasAttribute("data-nav-disclosure")) return;
+      if (group.dataset["filterOpen"] !== void 0) return;
+      navPreference.remember(doc);
+    },
+    true
+  );
+  const announce = (message) => {
+    const status = doc.getElementById("mb-status");
+    if (status) status.textContent = message;
+  };
+  const navigate = async (url, push, restoreScrolls) => {
+    if (push) restoringHistory = false;
+    const slot = sequencer.begin();
+    beginNavigation(doc);
+    const destination = await fetchBrowseDestination(doc, win, url, slot);
+    if (!destination || !slot.isCurrent()) return;
+    const { parsed, view: nextMain, url: finalUrl } = destination;
+    const nextStamp = readPageStamp(parsed);
+    const viewport = currentViewport(doc);
+    disposeWorkspace();
+    for (const frame of main.querySelectorAll("iframe")) frame.remove();
+    collapseFrame(doc, expandedFrame(doc));
+    if (push) persistScroll();
+    diffs.reset();
+    main.innerHTML = nextMain.innerHTML;
+    const baseline = nextMain.getAttribute("data-mokly-baseline");
+    if (baseline) main.setAttribute("data-mokly-baseline", baseline);
+    else main.removeAttribute("data-mokly-baseline");
+    if (nextStamp) {
+      applyNavigationEvidence(doc, parsed);
+      doc.documentElement.setAttribute(
+        "data-mokly-update-version",
+        String(nextStamp.version)
+      );
+    }
+    displayedUrl = new URL(finalUrl, win.location.href);
+    attachFrameNavigation(doc, frameActions);
+    applyPreviewFragmentQuery(doc, new URL(finalUrl, win.location.href).search);
+    detailsPreference.apply(doc);
+    setViewport(doc, viewport);
+    setColorScheme(doc, currentColorScheme(doc));
+    doc.title = parsed.title || doc.title;
+    if (push)
+      win.history.pushState(
+        { scrolls: {} },
+        "",
+        finalUrl
+      );
+    disposeWorkspace = installWorkspace(
+      doc,
+      win,
+      diffs.update,
+      rememberDocument
+    );
+    selectAndRevealRoute(
+      doc,
+      new URL(finalUrl, win.location.href).pathname,
+      win.location.href,
+      "navigation"
+    );
+    syncTagChips(doc);
+    finishNavigation(doc);
+    setDrawer(shell, false);
+    restoreRegionScrolls(doc, restoreScrolls ?? {});
+    if (!push) {
+      await new Promise(
+        (resolve) => win.requestAnimationFrame(() => resolve())
+      );
+      if (!slot.isCurrent()) return;
+      restoreRegionScrolls(doc, restoreScrolls ?? {});
+      restoringHistory = false;
+    }
+    main.focus({ preventScroll: true });
+    announce(`Loaded ${doc.title}`);
+  };
+  const frameActions = {
+    navigate: (href) => {
+      const target = documentFrameHref(doc, href);
+      if (target) void navigate(target, true);
+    },
+    open: (href, target) => {
+      const url = documentFrameHref(doc, href);
+      if (url) win.open(url, target, "noopener");
+    }
+  };
+  doc.addEventListener("click", (event) => {
+    const target = event.target instanceof Element ? event.target : void 0;
+    if (!target) return;
+    if (handleTagControlClick(doc, target)) return;
+    const summary = target.closest("summary");
+    const details = summary?.parentElement;
+    if (details instanceof HTMLDetailsElement && details.matches("[data-mokly-details]")) {
+      detailsPreference.rememberActivation(details);
+    }
+    const idChip = target.closest("button[data-copy-id]");
+    if (idChip) {
+      const id = idChip.dataset["copyId"] ?? "";
+      if (id !== "") {
+        copyText(doc, id);
+        announce(`Copied ID ${id}`);
+      }
+      return;
+    }
+    if (handleBrowseControl(doc, target, diffs.update)) return;
+    if (handleFrameClick(doc, target)) {
+      event.preventDefault();
+      return;
+    }
+    if (handleAddressClick(doc, target, (text) => copyText(doc, text))) {
+      event.preventDefault();
+      return;
+    }
+    const url = browseLinkTarget(event, target, win.location);
+    if (!url) return;
+    event.preventDefault();
+    void navigate(url, true);
+  });
+  doc.addEventListener("keydown", (event) => {
+    const target = event.target instanceof Element ? event.target : void 0;
+    if (handleTagPickerKeydown(doc, event.key, target)) {
+      event.preventDefault();
+      return;
+    }
+    if (event.key === "Escape") collapseFrame(doc, expandedFrame(doc));
+  });
+  doc.addEventListener("input", (event) => {
+    const target = event.target instanceof Element ? event.target : void 0;
+    if (!target?.matches("[data-mokly-search]")) return;
+    applyNavVisibility(doc, "reveal-matches");
+    syncTagChips(doc);
+  });
+  doc.addEventListener(
+    "toggle",
+    (event) => {
+      const target = event.target;
+      if (target instanceof HTMLDetailsElement && target.matches("[data-mokly-details]")) {
+        detailsPreference.remember(target.open);
+      }
+    },
+    true
+  );
+  win.addEventListener("popstate", (event) => {
+    const state = event.state;
+    const scrolls = state && typeof state.scrolls === "object" && state.scrolls !== null ? state.scrolls : void 0;
+    if (isSameBrowseDocument(displayedUrl, new URL(win.location.href))) {
+      sequencer.cancel();
+      finishNavigation(doc);
+      restoringHistory = false;
+      if (scrolls) restoreRegionScrolls(doc, scrolls);
+      return;
+    }
+    restoringHistory = true;
+    void navigate(win.location.href, false, scrolls);
+  });
+  attachFrameNavigation(doc, frameActions);
+  selectAndRevealRoute(
+    doc,
+    win.location.pathname,
+    win.location.href,
+    "navigation"
+  );
+  syncTagChips(doc);
+}
+if (typeof document !== "undefined" && typeof window !== "undefined") {
+  initBrowseShell(document, window);
+}

package/dist/browser/browse_controls.js

@@ -0,0 +1,40 @@
+// src/client/browse_controls.ts
+import { applyNavVisibility } from "./browse_navigation_state.js";
+import { setColorScheme, setDrawer, setViewport } from "./browse_state.js";
+function handleBrowseControl(doc, target, updateDiffs) {
+  if (target.closest("[data-mokly-menu]")) {
+    const shell = doc.querySelector("[data-mokly-shell]");
+    if (shell) setDrawer(shell, shell.dataset["drawer"] !== "open");
+    return true;
+  }
+  if (target.closest("[data-mokly-collapse]")) {
+    for (const group of doc.querySelectorAll(
+      "details[data-nav-disclosure]"
+    ))
+      group.open = false;
+    return true;
+  }
+  const scheme = target.closest("[data-color-scheme-option]")?.getAttribute("data-color-scheme-option");
+  if (scheme === "dark" || scheme === "light") {
+    setColorScheme(doc, scheme);
+    updateDiffs();
+    return true;
+  }
+  const viewport = target.closest("[data-viewport-option]")?.getAttribute("data-viewport-option");
+  if (viewport) {
+    setViewport(doc, viewport);
+    updateDiffs();
+    return true;
+  }
+  const filter = target.closest("[data-filter]");
+  if (filter) {
+    for (const option of doc.querySelectorAll("[data-filter]"))
+      option.setAttribute("aria-pressed", String(option === filter));
+    applyNavVisibility(doc, "reveal-matches");
+    return true;
+  }
+  return false;
+}
+export {
+  handleBrowseControl
+};

package/dist/browser/browse_details.js

@@ -0,0 +1,56 @@
+// src/client/browse_details.ts
+var DETAILS_DISCLOSURE_KEY = "mokly:details-disclosure";
+var DetailsDisclosurePreference = class {
+  #storage;
+  #open;
+  constructor(storage = void 0) {
+    this.#storage = storage;
+    this.#open = this.read();
+  }
+  /** The last explicit choice, shared by the icon inspector and legacy details. */
+  get preferredOpen() {
+    return this.#open;
+  }
+  /** Apply an explicit preference to the current route's details panel. */
+  apply(doc) {
+    const details = doc.querySelector(
+      "[data-mokly-details]"
+    );
+    if (details && this.#open !== void 0) details.open = this.#open;
+  }
+  /** Record a user disclosure change for later routes and page loads. */
+  remember(open) {
+    this.#open = open;
+    try {
+      this.#storage?.setItem(DETAILS_DISCLOSURE_KEY, open ? "open" : "closed");
+    } catch {
+    }
+  }
+  /** Record the state produced by a summary activation before a later task. */
+  rememberActivation(details) {
+    const openBeforeActivation = details.open;
+    queueMicrotask(() => {
+      if (details.open !== openBeforeActivation) this.remember(details.open);
+    });
+  }
+  read() {
+    try {
+      const value = this.#storage?.getItem(DETAILS_DISCLOSURE_KEY);
+      if (value === "open") return true;
+      if (value === "closed") return false;
+    } catch {
+    }
+    return void 0;
+  }
+};
+function createBrowserDetailsPreference(win) {
+  try {
+    return new DetailsDisclosurePreference(win.localStorage);
+  } catch {
+    return new DetailsDisclosurePreference();
+  }
+}
+export {
+  DetailsDisclosurePreference,
+  createBrowserDetailsPreference
+};