@u1f992/vivliostyle-index 0.2.4 → 0.3.0

package/dist/instruction.js

@@ -0,0 +1,267 @@
+import { createKey, ensureEntry, insertLocator, insertXref, } from "./model.js";
+import { identityTemplate } from "./template.js";
+export class InstructionSyntaxError extends SyntaxError {
+    offset;
+    constructor(input, offset, reason) {
+        super(`${reason} at grapheme offset ${offset}: ${JSON.stringify(input)}`);
+        this.name = "InstructionSyntaxError";
+        this.offset = offset;
+    }
+}
+const graphemeSegmenter = new Intl.Segmenter("en", { granularity: "grapheme" });
+const escapableCharacters = new Set(["\\", "@", "!", "|", "(", ")", "{", "}"]);
+const tokenLexemes = {
+    related: ["|", "s", "e", "e", "a", "l", "s", "o", "{"],
+    preferred: ["|", "s", "e", "e", "{"],
+    "range-start": ["|", "("],
+    "range-end": ["|", ")"],
+    display: ["@"],
+    heading: ["!"],
+    template: ["|"],
+    "xref-end": ["}"],
+};
+const tokenTypes = [
+    "related",
+    "preferred",
+    "range-start",
+    "range-end",
+    "display",
+    "heading",
+    "template",
+    "xref-end",
+];
+const instructionTerminators = new Set([
+    "template",
+    "range-start",
+    "range-end",
+    "preferred",
+    "related",
+]);
+const xrefTerminators = new Set(["xref-end"]);
+function createParserInput(source) {
+    return {
+        source,
+        graphemes: [...graphemeSegmenter.segment(source)].map(({ segment }) => segment),
+    };
+}
+function syntaxError(input, offset, reason) {
+    throw new InstructionSyntaxError(input.source, offset, reason);
+}
+function unescapeAt(input, offset) {
+    const escapedCharacter = input.graphemes[offset + 1];
+    if (escapedCharacter === undefined || !escapableCharacters.has(escapedCharacter)) {
+        syntaxError(input, offset, "an escape must be followed by \\, @, !, |, (, ), {, or }");
+    }
+    return escapedCharacter;
+}
+function startsWith(input, offset, expected) {
+    return expected.every((character, index) => input.graphemes[offset + index] === character);
+}
+function metaTokenAt(input, offset) {
+    const type = tokenTypes.find((candidate) => startsWith(input, offset, tokenLexemes[candidate]));
+    return type === undefined ? undefined : { type, offset };
+}
+function tokenize(input) {
+    const tokens = [];
+    let offset = 0;
+    let textStart = 0;
+    const emitText = (end) => {
+        if (textStart !== end) {
+            tokens.push({
+                type: "text",
+                value: input.graphemes.slice(textStart, end).join(""),
+                offset: textStart,
+            });
+        }
+    };
+    while (offset < input.graphemes.length) {
+        if (input.graphemes[offset] === "\\") {
+            emitText(offset);
+            tokens.push({ type: "text", value: unescapeAt(input, offset), offset });
+            offset += 2;
+            textStart = offset;
+            continue;
+        }
+        const token = metaTokenAt(input, offset);
+        if (token === undefined) {
+            offset++;
+            continue;
+        }
+        emitText(offset);
+        tokens.push(token);
+        offset += tokenLexemes[token.type].length;
+        textStart = offset;
+    }
+    emitText(offset);
+    return tokens;
+}
+function currentToken(state) {
+    return state.tokens[state.position];
+}
+function consumeToken(state) {
+    const token = currentToken(state);
+    if (token !== undefined) {
+        state.position++;
+    }
+    return token;
+}
+function tokenLabel(token) {
+    return tokenLexemes[token.type].join("");
+}
+function completeAddress(input, address, offset) {
+    if (address.group === undefined || address.entry === undefined) {
+        return syntaxError(input, offset, "an entry must contain a group and one or two headings");
+    }
+    return address.subentry === undefined
+        ? { group: address.group, entry: address.entry }
+        : { group: address.group, entry: address.entry, subentry: address.subentry };
+}
+function parseHierarchy(state, terminators) {
+    const { input } = state;
+    const address = {};
+    let reading = "";
+    let html = "";
+    let hasHtml = false;
+    let offset = currentToken(state)?.offset ?? input.graphemes.length;
+    const append = (token) => {
+        if (hasHtml) {
+            html += token.value;
+        }
+        else {
+            reading += token.value;
+        }
+    };
+    const finishKey = () => {
+        if (reading === "") {
+            syntaxError(input, offset, "a reading must not be empty");
+        }
+        if (hasHtml && html === "") {
+            syntaxError(input, offset, "a display value must not be empty");
+        }
+        const key = createKey(reading, hasHtml ? html : reading);
+        if (address.group === undefined) {
+            address.group = key;
+        }
+        else if (address.entry === undefined) {
+            address.entry = key;
+        }
+        else if (address.subentry === undefined) {
+            address.subentry = key;
+        }
+        else {
+            syntaxError(input, offset, "an entry must not contain more than two headings");
+        }
+        reading = "";
+        html = "";
+        hasHtml = false;
+    };
+    for (;;) {
+        const token = currentToken(state);
+        if (token === undefined) {
+            offset = input.graphemes.length;
+            finishKey();
+            return { address: completeAddress(input, address, offset), terminator: undefined };
+        }
+        offset = token.offset;
+        if (token.type === "text") {
+            append(token);
+            consumeToken(state);
+            continue;
+        }
+        if (token.type === "display") {
+            if (hasHtml || reading === "") {
+                syntaxError(input, offset, "an unescaped @ must separate a reading and display value");
+            }
+            hasHtml = true;
+            consumeToken(state);
+            continue;
+        }
+        if (token.type === "heading") {
+            finishKey();
+            consumeToken(state);
+            continue;
+        }
+        if (terminators.has(token.type)) {
+            finishKey();
+            consumeToken(state);
+            return { address: completeAddress(input, address, offset), terminator: token };
+        }
+        syntaxError(input, offset, `unexpected ${JSON.stringify(tokenLabel(token))}`);
+    }
+}
+function parseTemplate(state) {
+    const { input } = state;
+    let template = "";
+    for (;;) {
+        const token = consumeToken(state);
+        if (token === undefined) {
+            return template;
+        }
+        if (token.type !== "text") {
+            syntaxError(input, token.offset, `an unescaped ${JSON.stringify(tokenLabel(token))} is not allowed in a template`);
+        }
+        template += token.value;
+    }
+}
+function parseTemplateSection(state) {
+    const token = currentToken(state);
+    if (token === undefined) {
+        return identityTemplate;
+    }
+    if (token.type !== "template") {
+        syntaxError(state.input, token.offset, "a template must be introduced by |");
+    }
+    consumeToken(state);
+    return parseTemplate(state);
+}
+function parseXref(state, address, type) {
+    const { address: target, terminator } = parseHierarchy(state, xrefTerminators);
+    if (terminator?.type !== "xref-end") {
+        syntaxError(state.input, state.input.graphemes.length, "a cross-reference target must end with }");
+    }
+    return { type, address, target, template: parseTemplateSection(state) };
+}
+export function parseInstruction(source) {
+    const input = createParserInput(source);
+    const state = { input, tokens: tokenize(input), position: 0 };
+    const { address, terminator } = parseHierarchy(state, instructionTerminators);
+    if (terminator === undefined) {
+        return { type: "page", address, template: identityTemplate };
+    }
+    switch (terminator.type) {
+        case "template":
+            return { type: "page", address, template: parseTemplate(state) };
+        case "range-start":
+            return { type: "range-start", address, template: parseTemplateSection(state) };
+        case "range-end": {
+            const trailingToken = currentToken(state);
+            if (trailingToken !== undefined) {
+                syntaxError(input, trailingToken.offset, "a range end must end the instruction");
+            }
+            return { type: "range-end", address };
+        }
+        case "preferred":
+            return parseXref(state, address, "preferred");
+        case "related":
+            return parseXref(state, address, "related");
+        default:
+            return syntaxError(input, terminator.offset, `unexpected ${JSON.stringify(tokenLabel(terminator))}`);
+    }
+}
+export function applyPageInstruction(builder, instruction, locationHref, error) {
+    insertLocator(ensureEntry(builder, instruction.address), {
+        location: { type: "page", href: locationHref },
+        template: instruction.template,
+        ...(error === undefined ? {} : { error }),
+    });
+}
+export function applyRangeInstruction(builder, instruction, startHref, endHref) {
+    insertLocator(ensureEntry(builder, instruction.address), {
+        location: { type: "range", start: startHref, end: endHref },
+        template: instruction.template,
+    });
+}
+export function applyXrefInstruction(builder, instruction) {
+    insertXref(ensureEntry(builder, instruction.address), instruction.type, instruction.target, instruction.template);
+}
+//# sourceMappingURL=instruction.js.map

package/dist/instruction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruction.js","sourceRoot":"","sources":["../src/instruction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,aAAa,EACb,UAAU,GAMX,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAwBjD,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IAC5C,MAAM,CAAS;IAExB,YAAY,KAAa,EAAE,MAAc,EAAE,MAAc;QACvD,KAAK,CAAC,GAAG,MAAM,uBAAuB,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AA+CD,MAAM,iBAAiB,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC;AAChF,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAC/E,MAAM,YAAY,GAAG;IACnB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACtD,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACpC,aAAa,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACzB,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IACvB,OAAO,EAAE,CAAC,GAAG,CAAC;IACd,OAAO,EAAE,CAAC,GAAG,CAAC;IACd,QAAQ,EAAE,CAAC,GAAG,CAAC;IACf,UAAU,EAAE,CAAC,GAAG,CAAC;CAC0C,CAAC;AAC9D,MAAM,UAAU,GAAG;IACjB,SAAS;IACT,WAAW;IACX,aAAa;IACb,WAAW;IACX,SAAS;IACT,SAAS;IACT,UAAU;IACV,UAAU;CACiC,CAAC;AAC9C,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAgB;IACpD,UAAU;IACV,aAAa;IACb,WAAW;IACX,WAAW;IACX,SAAS;CACV,CAAC,CAAC;AACH,MAAM,eAAe,GAAG,IAAI,GAAG,CAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;AAE7D,SAAS,iBAAiB,CAAC,MAAc;IACvC,OAAO;QACL,MAAM;QACN,SAAS,EAAE,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC;KAChF,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAkB,EAAE,MAAc,EAAE,MAAc;IACrE,MAAM,IAAI,sBAAsB,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,UAAU,CAAC,KAAkB,EAAE,MAAc;IACpD,MAAM,gBAAgB,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACrD,IAAI,gBAAgB,KAAK,SAAS,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACjF,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,0DAA0D,CAAC,CAAC;IACzF,CAAC;IACD,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,SAAS,UAAU,CAAC,KAAkB,EAAE,MAAc,EAAE,QAA2B;IACjF,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,SAAS,CAAC,CAAC;AAC7F,CAAC;AAED,SAAS,WAAW,CAAC,KAAkB,EAAE,MAAc;IACrD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAChG,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC3D,CAAC;AAED,SAAS,QAAQ,CAAC,KAAkB;IAClC,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE;QAC/B,IAAI,SAAS,KAAK,GAAG,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrD,MAAM,EAAE,SAAS;aAClB,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;YACrC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YACxE,MAAM,IAAI,CAAC,CAAC;YACZ,SAAS,GAAG,MAAM,CAAC;YACnB,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,EAAE,CAAC;YACT,SAAS;QACX,CAAC;QACD,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QAC1C,SAAS,GAAG,MAAM,CAAC;IACrB,CAAC;IACD,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,YAAY,CAAC,KAAkB;IACtC,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,YAAY,CAAC,KAAkB;IACtC,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CAAC,KAAgB;IAClC,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,eAAe,CACtB,KAAkB,EAClB,OAA4B,EAC5B,MAAc;IAEd,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/D,OAAO,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,uDAAuD,CAAC,CAAC;IAC7F,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,KAAK,SAAS;QACnC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE;QAChD,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;AACjF,CAAC;AAED,SAAS,cAAc,CACrB,KAAkB,EAClB,WAAuC;IAEvC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACxB,MAAM,OAAO,GAAwB,EAAE,CAAC;IACxC,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC;IAEnE,MAAM,MAAM,GAAG,CAAC,KAAgB,EAAE,EAAE;QAClC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC;QACzB,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,GAAG,EAAE;QACrB,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;YACnB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,OAAO,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAC3B,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,mCAAmC,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,CAAC,KAAK,GAAG,GAAG,CAAC;QACtB,CAAC;aAAM,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACvC,OAAO,CAAC,KAAK,GAAG,GAAG,CAAC;QACtB,CAAC;aAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,kDAAkD,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,EAAE,CAAC;QACV,OAAO,GAAG,KAAK,CAAC;IAClB,CAAC,CAAC;IAEF,SAAS,CAAC;QACR,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC;YAChC,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QACrF,CAAC;QACD,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QACtB,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,MAAM,CAAC,KAAK,CAAC,CAAC;YACd,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,SAAS;QACX,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,OAAO,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;gBAC9B,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,0DAA0D,CAAC,CAAC;YACzF,CAAC;YACD,OAAO,GAAG,IAAI,CAAC;YACf,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,SAAS;QACX,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,SAAS,EAAE,CAAC;YACZ,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,SAAS;QACX,CAAC;QACD,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,SAAS,EAAE,CAAC;YACZ,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,EAAE,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;QACjF,CAAC;QACD,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAChF,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,KAAkB;IACvC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACxB,IAAI,QAAQ,GAAG,EAAE,CAAC;IAClB,SAAS,CAAC;QACR,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,WAAW,CACT,KAAK,EACL,KAAK,CAAC,MAAM,EACZ,gBAAgB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,+BAA+B,CACjF,CAAC;QACJ,CAAC;QACD,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC;IAC1B,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAkB;IAC9C,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC9B,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC;IAC/E,CAAC;IACD,YAAY,CAAC,KAAK,CAAC,CAAC;IACpB,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,SAAS,CAAC,KAAkB,EAAE,OAAqB,EAAE,IAAc;IAC1E,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;IAC/E,IAAI,UAAU,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;QACpC,WAAW,CACT,KAAK,CAAC,KAAK,EACX,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,EAC5B,0CAA0C,CAC3C,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,MAAM,KAAK,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,KAAK,GAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAC3E,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC9E,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC/D,CAAC;IACD,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,KAAK,UAAU;YACb,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACnE,KAAK,aAAa;YAChB,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;QACjF,KAAK,WAAW,EAAE,CAAC;YACjB,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,WAAW,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,EAAE,sCAAsC,CAAC,CAAC;YACnF,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;QACxC,CAAC;QACD,KAAK,WAAW;YACd,OAAO,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QAChD,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QAC9C;YACE,OAAO,WAAW,CAChB,KAAK,EACL,UAAU,CAAC,MAAM,EACjB,cAAc,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,CACvD,CAAC;IACN,CAAC;AACH,CAAC;AAMD,MAAM,UAAU,oBAAoB,CAClC,OAAqB,EACrB,WAA4B,EAC5B,YAAoB,EACpB,KAAoB;IAEpB,aAAa,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;QACvD,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE;QAC9C,QAAQ,EAAE,WAAW,CAAC,QAAQ;QAC9B,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;KAC1C,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,OAAqB,EACrB,WAA6B,EAC7B,SAAiB,EACjB,OAAe;IAEf,aAAa,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;QACvD,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE;QAC3D,QAAQ,EAAE,WAAW,CAAC,QAAQ;KAC/B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAAqB,EAAE,WAA4B;IACtF,UAAU,CACR,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EACzC,WAAW,CAAC,IAAI,EAChB,WAAW,CAAC,MAAM,EAClB,WAAW,CAAC,QAAQ,CACrB,CAAC;AACJ,CAAC"}

package/dist/location.d.ts

@@ -0,0 +1,2 @@
+export declare function createLocationHref(sourcePath: string, targetPath: string, id: string): string;
+//# sourceMappingURL=location.d.ts.map

package/dist/location.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.d.ts","sourceRoot":"","sources":["../src/location.ts"],"names":[],"mappings":"AAcA,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAM7F"}

package/dist/location.js

@@ -0,0 +1,17 @@
+import upath from "upath";
+const htmlExtensions = new Set([".html", ".htm", ".xhtml"]);
+function encodeRelativePath(path) {
+    return path.split("/").map(encodeURIComponent).join("/");
+}
+function toHtmlPath(path) {
+    return htmlExtensions.has(upath.extname(path).toLowerCase())
+        ? path
+        : upath.changeExt(path, ".html");
+}
+export function createLocationHref(sourcePath, targetPath, id) {
+    const relativePath = sourcePath === targetPath
+        ? ""
+        : encodeRelativePath(upath.relative(upath.dirname(targetPath), toHtmlPath(sourcePath)));
+    return `${relativePath}#${encodeURIComponent(id)}`;
+}
+//# sourceMappingURL=location.js.map

package/dist/location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../src/location.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE5D,SAAS,kBAAkB,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QAC1D,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,UAAkB,EAAE,UAAkB,EAAE,EAAU;IACnF,MAAM,YAAY,GAChB,UAAU,KAAK,UAAU;QACvB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC5F,OAAO,GAAG,YAAY,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;AACrD,CAAC"}

package/dist/messages.d.ts

@@ -0,0 +1,24 @@
+import type { VFile } from "vfile";
+import type { EntryAddress, UnresolvedXref } from "./model.ts";
+import type { Target } from "./target.ts";
+export type MessageArguments = Parameters<VFile["message"]>;
+export declare const messages: {
+    anonymousFile: MessageArguments;
+    invalidIndexReference: (reference: string) => MessageArguments;
+    missingTargetFragment: (reference: string) => MessageArguments;
+    missingInstruction: (reference: string) => MessageArguments;
+    invalidInstruction: (error: unknown, instructionSource: string) => MessageArguments;
+    unmatchedRangeStart: (target: Target, address: EntryAddress) => MessageArguments;
+    unmatchedRangeEnd: (target: Target, address: EntryAddress) => MessageArguments;
+    invalidXref: (xref: UnresolvedXref) => MessageArguments;
+    targetNotInEntries: (target: Target) => MessageArguments;
+    entryProcessorMismatch: (documentPath: string) => MessageArguments;
+    documentNotInEntries: (documentPath: string) => MessageArguments;
+    unsupportedLanguage: (language: string) => MessageArguments;
+    missingIndexTarget: (target: Target) => MessageArguments;
+    missingIndexRole: (target: Target) => MessageArguments;
+    unknownIndexProfile: (target: Target, profile: string) => MessageArguments;
+};
+export declare function addMessage(messagesByDocument: Map<string, MessageArguments[]>, documentPath: string, message: MessageArguments): void;
+export declare function emitMessages(file: VFile, documentMessages: readonly MessageArguments[]): void;
+//# sourceMappingURL=messages.d.ts.map

package/dist/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAGnC,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AAsB5D,eAAO,MAAM,QAAQ;IACnB,aAAa,EAIR,gBAAgB;IACrB,qBAAqB,cAAc,MAAM,KAAG,gBAAgB;IAK5D,qBAAqB,cAAc,MAAM,KAAG,gBAAgB;IAK5D,kBAAkB,cAAc,MAAM,KAAG,gBAAgB;IAKzD,kBAAkB,UAAU,OAAO,qBAAqB,MAAM,KAAG,gBAAgB;IAOjF,mBAAmB,WAAW,MAAM,WAAW,YAAY,KAAG,gBAAgB;IAK9E,iBAAiB,WAAW,MAAM,WAAW,YAAY,KAAG,gBAAgB;IAK5E,WAAW,SAAS,cAAc,KAAG,gBAAgB;IAKrD,kBAAkB,WAAW,MAAM,KAAG,gBAAgB;IAKtD,sBAAsB,iBAAiB,MAAM,KAAG,gBAAgB;IAKhE,oBAAoB,iBAAiB,MAAM,KAAG,gBAAgB;IAK9D,mBAAmB,aAAa,MAAM,KAAG,gBAAgB;IAKzD,kBAAkB,WAAW,MAAM,KAAG,gBAAgB;IAKtD,gBAAgB,WAAW,MAAM,KAAG,gBAAgB;IAKpD,mBAAmB,WAAW,MAAM,WAAW,MAAM,KAAG,gBAAgB;CAKzE,CAAC;AAEF,wBAAgB,UAAU,CACxB,kBAAkB,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,EACnD,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,gBAAgB,GACxB,IAAI,CAON;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,gBAAgB,EAAE,SAAS,gBAAgB,EAAE,GAAG,IAAI,CAI7F"}

package/dist/messages.js

@@ -0,0 +1,114 @@
+import { InstructionSyntaxError } from "./instruction.js";
+const rule = (ruleId) => `vivliostyle-index:${ruleId}`;
+const formatTarget = (target) => `${target.path}#${target.fragment}`;
+const formatEntryAddress = ({ group, entry, subentry }) => {
+    const parts = [`group=${JSON.stringify(group)}`, `entry=${JSON.stringify(entry)}`];
+    if (subentry !== undefined) {
+        parts.push(`subentry=${JSON.stringify(subentry)}`);
+    }
+    return parts.join(",");
+};
+const formatUnresolvedXref = ({ target, missing }) => {
+    const parts = [`group=${JSON.stringify(target.group)}`];
+    if (missing !== "group") {
+        parts.push(`entry=${JSON.stringify(target.entry)}`);
+    }
+    if (missing === "subentry") {
+        parts.push(`subentry=${JSON.stringify(target.subentry)}`);
+    }
+    return parts.join(",");
+};
+export const messages = {
+    anonymousFile: [
+        "cannot extract index entries from anonymous files or render indexes into anonymous files",
+        undefined,
+        rule("anonymous-file"),
+    ],
+    invalidIndexReference: (reference) => [
+        `invalid index reference: ${reference}`,
+        undefined,
+        rule("invalid-index-reference"),
+    ],
+    missingTargetFragment: (reference) => [
+        `index reference has no target fragment: ${reference}`,
+        undefined,
+        rule("missing-target-fragment"),
+    ],
+    missingInstruction: (reference) => [
+        `index reference has no q instruction: ${reference}`,
+        undefined,
+        rule("missing-instruction"),
+    ],
+    invalidInstruction: (error, instructionSource) => [
+        error instanceof InstructionSyntaxError
+            ? error.message
+            : `cannot parse index instruction: ${instructionSource}`,
+        undefined,
+        rule("instruction-parse-error"),
+    ],
+    unmatchedRangeStart: (target, address) => [
+        `range start for entry ${formatEntryAddress(address)} of index target ${formatTarget(target)} has no matching range end. the range start is treated as a page locator.`,
+        undefined,
+        rule("unmatched-range-start"),
+    ],
+    unmatchedRangeEnd: (target, address) => [
+        `range end for entry ${formatEntryAddress(address)} of index target ${formatTarget(target)} has no matching range start. the range end is treated as a page locator.`,
+        undefined,
+        rule("unmatched-range-end"),
+    ],
+    invalidXref: (xref) => [
+        `index does not contain ${formatUnresolvedXref(xref)}. the cross-reference target will not resolve.`,
+        undefined,
+        rule("invalid-xref"),
+    ],
+    targetNotInEntries: (target) => [
+        `index target ${formatTarget(target)} is not included in entries`,
+        undefined,
+        rule("target-not-in-entries"),
+    ],
+    entryProcessorMismatch: (documentPath) => [
+        `the entry processor and the build produced different index data for ${documentPath}. locators into it may not resolve.`,
+        undefined,
+        rule("entry-processor-mismatch"),
+    ],
+    documentNotInEntries: (documentPath) => [
+        `document ${documentPath} is not included in entries. its index instructions are ignored.`,
+        undefined,
+        rule("document-not-in-entries"),
+    ],
+    unsupportedLanguage: (language) => [
+        `cannot sort by language ${JSON.stringify(language)}. the index is sorted without it.`,
+        undefined,
+        rule("unsupported-language"),
+    ],
+    missingIndexTarget: (target) => [
+        `index target ${formatTarget(target)} does not exist`,
+        undefined,
+        rule("missing-index-target"),
+    ],
+    missingIndexRole: (target) => [
+        `index target ${formatTarget(target)} does not carry the doc-index role. the index is not rendered.`,
+        undefined,
+        rule("missing-index-role"),
+    ],
+    unknownIndexProfile: (target, profile) => [
+        `index target ${formatTarget(target)} names unknown profile ${JSON.stringify(profile)}. the default profile is used.`,
+        undefined,
+        rule("unknown-index-profile"),
+    ],
+};
+export function addMessage(messagesByDocument, documentPath, message) {
+    const documentMessages = messagesByDocument.get(documentPath);
+    if (documentMessages) {
+        documentMessages.push(message);
+    }
+    else {
+        messagesByDocument.set(documentPath, [message]);
+    }
+}
+export function emitMessages(file, documentMessages) {
+    for (const message of documentMessages) {
+        file.message(...message);
+    }
+}
+//# sourceMappingURL=messages.js.map

package/dist/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAM1D,MAAM,IAAI,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,qBAAqB,MAAM,EAAE,CAAC;AACvE,MAAM,YAAY,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;AACrF,MAAM,kBAAkB,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAgB,EAAU,EAAE;IAC9E,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACnF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC,CAAC;AACF,MAAM,oBAAoB,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,EAAkB,EAAU,EAAE;IAC3E,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxD,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,aAAa,EAAE;QACb,0FAA0F;QAC1F,SAAS;QACT,IAAI,CAAC,gBAAgB,CAAC;KACH;IACrB,qBAAqB,EAAE,CAAC,SAAiB,EAAoB,EAAE,CAAC;QAC9D,4BAA4B,SAAS,EAAE;QACvC,SAAS;QACT,IAAI,CAAC,yBAAyB,CAAC;KAChC;IACD,qBAAqB,EAAE,CAAC,SAAiB,EAAoB,EAAE,CAAC;QAC9D,2CAA2C,SAAS,EAAE;QACtD,SAAS;QACT,IAAI,CAAC,yBAAyB,CAAC;KAChC;IACD,kBAAkB,EAAE,CAAC,SAAiB,EAAoB,EAAE,CAAC;QAC3D,yCAAyC,SAAS,EAAE;QACpD,SAAS;QACT,IAAI,CAAC,qBAAqB,CAAC;KAC5B;IACD,kBAAkB,EAAE,CAAC,KAAc,EAAE,iBAAyB,EAAoB,EAAE,CAAC;QACnF,KAAK,YAAY,sBAAsB;YACrC,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,mCAAmC,iBAAiB,EAAE;QAC1D,SAAS;QACT,IAAI,CAAC,yBAAyB,CAAC;KAChC;IACD,mBAAmB,EAAE,CAAC,MAAc,EAAE,OAAqB,EAAoB,EAAE,CAAC;QAChF,yBAAyB,kBAAkB,CAAC,OAAO,CAAC,oBAAoB,YAAY,CAAC,MAAM,CAAC,2EAA2E;QACvK,SAAS;QACT,IAAI,CAAC,uBAAuB,CAAC;KAC9B;IACD,iBAAiB,EAAE,CAAC,MAAc,EAAE,OAAqB,EAAoB,EAAE,CAAC;QAC9E,uBAAuB,kBAAkB,CAAC,OAAO,CAAC,oBAAoB,YAAY,CAAC,MAAM,CAAC,2EAA2E;QACrK,SAAS;QACT,IAAI,CAAC,qBAAqB,CAAC;KAC5B;IACD,WAAW,EAAE,CAAC,IAAoB,EAAoB,EAAE,CAAC;QACvD,0BAA0B,oBAAoB,CAAC,IAAI,CAAC,gDAAgD;QACpG,SAAS;QACT,IAAI,CAAC,cAAc,CAAC;KACrB;IACD,kBAAkB,EAAE,CAAC,MAAc,EAAoB,EAAE,CAAC;QACxD,gBAAgB,YAAY,CAAC,MAAM,CAAC,6BAA6B;QACjE,SAAS;QACT,IAAI,CAAC,uBAAuB,CAAC;KAC9B;IACD,sBAAsB,EAAE,CAAC,YAAoB,EAAoB,EAAE,CAAC;QAClE,uEAAuE,YAAY,qCAAqC;QACxH,SAAS;QACT,IAAI,CAAC,0BAA0B,CAAC;KACjC;IACD,oBAAoB,EAAE,CAAC,YAAoB,EAAoB,EAAE,CAAC;QAChE,YAAY,YAAY,kEAAkE;QAC1F,SAAS;QACT,IAAI,CAAC,yBAAyB,CAAC;KAChC;IACD,mBAAmB,EAAE,CAAC,QAAgB,EAAoB,EAAE,CAAC;QAC3D,2BAA2B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,mCAAmC;QACtF,SAAS;QACT,IAAI,CAAC,sBAAsB,CAAC;KAC7B;IACD,kBAAkB,EAAE,CAAC,MAAc,EAAoB,EAAE,CAAC;QACxD,gBAAgB,YAAY,CAAC,MAAM,CAAC,iBAAiB;QACrD,SAAS;QACT,IAAI,CAAC,sBAAsB,CAAC;KAC7B;IACD,gBAAgB,EAAE,CAAC,MAAc,EAAoB,EAAE,CAAC;QACtD,gBAAgB,YAAY,CAAC,MAAM,CAAC,gEAAgE;QACpG,SAAS;QACT,IAAI,CAAC,oBAAoB,CAAC;KAC3B;IACD,mBAAmB,EAAE,CAAC,MAAc,EAAE,OAAe,EAAoB,EAAE,CAAC;QAC1E,gBAAgB,YAAY,CAAC,MAAM,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,gCAAgC;QACrH,SAAS;QACT,IAAI,CAAC,uBAAuB,CAAC;KAC9B;CACF,CAAC;AAEF,MAAM,UAAU,UAAU,CACxB,kBAAmD,EACnD,YAAoB,EACpB,OAAyB;IAEzB,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC9D,IAAI,gBAAgB,EAAE,CAAC;QACrB,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;SAAM,CAAC;QACN,kBAAkB,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAW,EAAE,gBAA6C;IACrF,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC"}

package/dist/model.d.ts

@@ -1,43 +1,84 @@
-export type IndexId = string;
-export type ResolvedKey = [string, string];
-export type UnresolvedKey = [string, null];
-export type Key = ResolvedKey | UnresolvedKey;
-export type HasKey<TKey extends Key> = {
-    key: TKey;
+declare const keyBrand: unique symbol;
+export type Key = Readonly<{
+    reading: string;
+    html: string;
+    [keyBrand]: unknown;
+}>;
+export type HasKey = {
+    key: Key;
 };
-type PageLocator = string;
-type RangeLocator = [PageLocator, PageLocator];
-type Locator = PageLocator | RangeLocator;
-type MainEntryReference<TKey extends Key> = [TKey, TKey];
-type SubentryReference<TKey extends Key> = [TKey, TKey, TKey];
-export type Reference<TKey extends Key> = MainEntryReference<TKey> | SubentryReference<TKey>;
-declare const sequentialIdBrand: unique symbol;
-type SequentialId = string & {
-    [sequentialIdBrand]: unknown;
+type PageLocation = Readonly<{
+    type: "page";
+    href: string;
+}>;
+type RangeLocation = Readonly<{
+    type: "range";
+    start: string;
+    end: string;
+}>;
+export type EntryAddress = Readonly<{
+    group: Key;
+    entry: Key;
+    subentry?: Key;
+}>;
+export type UnresolvedXref = Readonly<{
+    target: EntryAddress;
+    missing: keyof EntryAddress;
+}>;
+export type IndexError = "invalid-xref" | "unmatched-range-start" | "unmatched-range-end";
+export type LocatorError = Extract<IndexError, "unmatched-range-start" | "unmatched-range-end">;
+export type XrefError = Extract<IndexError, "invalid-xref">;
+export type Locator = Readonly<{
+    location: PageLocation | RangeLocation;
+    template: string;
+    error?: LocatorError;
+}>;
+export type Xref = Readonly<{
+    target: EntryAddress;
+    template: string;
+    error?: XrefError;
+}>;
+export type XrefType = "preferred" | "related";
+export type Subentry = Readonly<{
+    key: Key;
+    locators: readonly Locator[];
+    xrefPreferred: readonly Xref[];
+    xrefRelated: readonly Xref[];
+}>;
+export type Entry = Subentry & Readonly<{
+    subentries: readonly Subentry[];
+}>;
+export type Group = Readonly<{
+    key: Key;
+    entries: readonly Entry[];
+}>;
+export type Index = Readonly<{
+    groups: readonly Group[];
+}>;
+export type SubentryBuilder = {
+    key: Key;
+    locators: Locator[];
+    xrefPreferred: Xref[];
+    xrefRelated: Xref[];
 };
-type HasLocators = {
-    locators: [SequentialId, Locator, boolean][];
+export type EntryBuilder = SubentryBuilder & {
+    subentries: Map<string, SubentryBuilder>;
 };
-export declare function insertLocator(entry: HasLocators, locator: [Locator, boolean]): void;
-type HasReferences<TKey extends Key> = {
-    see: [SequentialId, ...Reference<TKey>][];
-    seeAlso: [SequentialId, ...Reference<TKey>][];
+export type GroupBuilder = {
+    key: Key;
+    entries: Map<string, EntryBuilder>;
 };
-export declare function insertReference<TKey extends Key>(entry: HasReferences<TKey>, type: "see" | "seeAlso", reference: Reference<TKey>): void;
-export type EntryBase<TKey extends Key> = HasLocators & HasReferences<TKey>;
-export type Subentry<TKey extends Key> = HasKey<TKey> & EntryBase<TKey>;
-export type ParentOf<T> = {
-    children: T[];
+export type IndexBuilder = {
+    groups: Map<string, GroupBuilder>;
 };
-export type MainEntry<TKey extends Key> = HasKey<TKey> & EntryBase<TKey> & ParentOf<Subentry<TKey>>;
-export type Group<TKey extends Key> = HasKey<TKey> & ParentOf<MainEntry<TKey>>;
-export type Index<TKey extends Key> = {
-    id: IndexId;
-} & ParentOf<Group<TKey>>;
-export declare function ensureIndex<TKey extends Key>(indexes: Index<TKey>[], id: IndexId): Index<TKey>;
-export declare function toHastChildren(value: string): string;
-export declare function hastChildrenToText(hastJson: string): string;
-export declare function getChild<TKey extends Key, TChild extends HasKey<TKey>>(parent: ParentOf<TChild>, key: TKey): TChild | undefined;
-export declare function ensureChild<TKey extends Key, TChild extends HasKey<TKey>>(parent: ParentOf<TChild>, key: TKey, init: Omit<TChild, "key">): TChild;
+export declare function createIndexBuilder(): IndexBuilder;
+export declare function createKey(reading: string, html: string): Key;
+export declare const addressKey: (address: EntryAddress) => string;
+export declare function ensureEntry(builder: IndexBuilder, address: EntryAddress): EntryBuilder | SubentryBuilder;
+export declare function insertLocator(entry: EntryBuilder | SubentryBuilder, locator: Locator): void;
+export declare function insertXref(entry: EntryBuilder | SubentryBuilder, type: XrefType, target: EntryAddress, template: string): void;
+export declare function findUnresolvedXref(builder: IndexBuilder, target: EntryAddress): UnresolvedXref | undefined;
+export declare function labelInvalidXrefs(builder: IndexBuilder): ReadonlyMap<string, UnresolvedXref>;
+export declare function finalizeIndex(builder: IndexBuilder): Index;
 export {};
 //# sourceMappingURL=model.d.ts.map

package/dist/model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3C,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC3C,MAAM,MAAM,GAAG,GAAG,WAAW,GAAG,aAAa,CAAC;AAC9C,MAAM,MAAM,MAAM,CAAC,IAAI,SAAS,GAAG,IAAI;IAAE,GAAG,EAAE,IAAI,CAAA;CAAE,CAAC;AAErD,KAAK,WAAW,GAAG,MAAM,CAAC;AAC1B,KAAK,YAAY,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAC/C,KAAK,OAAO,GAAG,WAAW,GAAG,YAAY,CAAC;AAE1C,KAAK,kBAAkB,CAAC,IAAI,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACzD,KAAK,iBAAiB,CAAC,IAAI,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9D,MAAM,MAAM,SAAS,CAAC,IAAI,SAAS,GAAG,IAClC,kBAAkB,CAAC,IAAI,CAAC,GACxB,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAE5B,QAAA,MAAM,iBAAiB,eAAW,CAAC;AACnC,KAAK,YAAY,GAAG,MAAM,GAAG;IAAE,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAO9D,KAAK,WAAW,GAAG;IAAE,QAAQ,EAAE,CAAC,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAA;CAAE,CAAC;AACpE,wBAAgB,aAAa,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,QAE5E;AAED,KAAK,aAAa,CAAC,IAAI,SAAS,GAAG,IAAI;IACrC,GAAG,EAAE,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;IAC1C,OAAO,EAAE,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;CAC/C,CAAC;AACF,wBAAgB,eAAe,CAAC,IAAI,SAAS,GAAG,EAC9C,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,EAC1B,IAAI,EAAE,KAAK,GAAG,SAAS,EACvB,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,QAG3B;AAED,MAAM,MAAM,SAAS,CAAC,IAAI,SAAS,GAAG,IAAI,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;AAC5E,MAAM,MAAM,QAAQ,CAAC,IAAI,SAAS,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;AACxE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;IAAE,QAAQ,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC;AAC5C,MAAM,MAAM,SAAS,CAAC,IAAI,SAAS,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GACpD,SAAS,CAAC,IAAI,CAAC,GACf,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3B,MAAM,MAAM,KAAK,CAAC,IAAI,SAAS,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AAE/E,MAAM,MAAM,KAAK,CAAC,IAAI,SAAS,GAAG,IAAI;IAAE,EAAE,EAAE,OAAO,CAAA;CAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9E,wBAAgB,WAAW,CAAC,IAAI,SAAS,GAAG,EAC1C,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EACtB,EAAE,EAAE,OAAO,GACV,KAAK,CAAC,IAAI,CAAC,CAKb;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,UAE3C;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,UAMlD;AAED,wBAAgB,QAAQ,CAAC,IAAI,SAAS,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,IAAI,CAAC,EACpE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EACxB,GAAG,EAAE,IAAI,sBAOV;AAED,wBAAgB,WAAW,CAAC,IAAI,SAAS,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,IAAI,CAAC,EACvE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EACxB,GAAG,EAAE,IAAI,EACT,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,UAW1B"}
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,QAAQ,eAAW,CAAC;AAC1B,MAAM,MAAM,GAAG,GAAG,QAAQ,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC,CAAC;AACH,MAAM,MAAM,MAAM,GAAG;IAAE,GAAG,EAAE,GAAG,CAAA;CAAE,CAAC;AAElC,KAAK,YAAY,GAAG,QAAQ,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC,CAAC;AACH,KAAK,aAAa,GAAG,QAAQ,CAAC;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb,CAAC,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC;IAClC,KAAK,EAAE,GAAG,CAAC;IACX,KAAK,EAAE,GAAG,CAAC;IACX,QAAQ,CAAC,EAAE,GAAG,CAAC;CAChB,CAAC,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IACpC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,MAAM,YAAY,CAAC;CAC7B,CAAC,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,uBAAuB,GAAG,qBAAqB,CAAC;AAC1F,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,EAAE,uBAAuB,GAAG,qBAAqB,CAAC,CAAC;AAChG,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;AAE5D,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC;IAC7B,QAAQ,EAAE,YAAY,GAAG,aAAa,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB,CAAC,CAAC;AAEH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC;IAC1B,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAE/C,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC9B,GAAG,EAAE,GAAG,CAAC;IACT,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;IAC7B,aAAa,EAAE,SAAS,IAAI,EAAE,CAAC;IAC/B,WAAW,EAAE,SAAS,IAAI,EAAE,CAAC;CAC9B,CAAC,CAAC;AACH,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAAE,UAAU,EAAE,SAAS,QAAQ,EAAE,CAAA;CAAE,CAAC,CAAC;AAC7E,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,OAAO,EAAE,SAAS,KAAK,EAAE,CAAA;CAAE,CAAC,CAAC;AACtE,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC;IAAE,MAAM,EAAE,SAAS,KAAK,EAAE,CAAA;CAAE,CAAC,CAAC;AAE3D,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,GAAG,CAAC;IACT,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,aAAa,EAAE,IAAI,EAAE,CAAC;IACtB,WAAW,EAAE,IAAI,EAAE,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,eAAe,GAAG;IAAE,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;CAAE,CAAC;AAC1F,MAAM,MAAM,YAAY,GAAG;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;CAAE,CAAC;AAC5E,MAAM,MAAM,YAAY,GAAG;IAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;CAAE,CAAC;AAEjE,wBAAgB,kBAAkB,IAAI,YAAY,CAEjD;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,CAE5D;AAMD,eAAO,MAAM,UAAU,YAAa,YAAY,KAAG,MAK/C,CAAC;AA4BL,wBAAgB,WAAW,CACzB,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,YAAY,GACpB,YAAY,GAAG,eAAe,CAMhC;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAE3F;AAOD,wBAAgB,UAAU,CACxB,KAAK,EAAE,YAAY,GAAG,eAAe,EACrC,IAAI,EAAE,QAAQ,EACd,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,MAAM,GACf,IAAI,CAEN;AAED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,YAAY,GACnB,cAAc,GAAG,SAAS,CAa5B;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,YAAY,GAAG,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAoC5F;AASD,wBAAgB,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,KAAK,CAU1D"}