@descent-vtt/spec-brief 0.1.0

package/dist/archive.js

@@ -0,0 +1,333 @@
+/**
+ * Archival and its reverse, planned.
+ *
+ * A plan is a pure function of the corpus and a request: what would be
+ * refused and why, the text every touched file would hold afterwards, and the
+ * operations that get there. Nothing is written here. `--dry-run` prints a
+ * plan; `apply.ts` executes one as a transaction. Splitting the two is what
+ * makes the ceremony testable without a disk and previewable without risk.
+ */
+import { BANNER_CLOSE, BANNER_OPEN, lineOfField } from './brief.js';
+import { resolveDependency } from './corpus.js';
+import { readFrontMatter, removeEntry, renderScalar, setEntry } from './frontmatter.js';
+import { matchGlob, parseGlob } from './glob.js';
+import { INTEGRITY_FIELD, integrityOf } from './integrity.js';
+import { dirOf, linesLinkingTo, normalisePath, rewriteLinks } from './links.js';
+import { fillTemplate, joinLines, labelMatches, lineEnding, templateHoles } from './text.js';
+function problem(brief, rule, severity, line, message, hint) {
+    return { rule, severity, message, file: brief.file, line, brief: brief.id ?? undefined, hint };
+}
+function lineOf(brief, key) {
+    return lineOfField(brief, key) + 1;
+}
+/**
+ * Scope patterns, for matching the files a round changed. A changed path is a
+ * file, and a literal pattern matches its own path whether it is read as a
+ * file or as a directory, so the tree is not asked.
+ */
+function globs(patterns) {
+    return patterns.flatMap((p) => {
+        const parsed = parseGlob(p);
+        return parsed.ok ? [parsed.glob] : [];
+    });
+}
+/**
+ * Whether an open box carries a note that closes it: "Delegated to ...",
+ * "Rejected ...". The note belongs to the box above it, so the search stops at
+ * the first nested box: a child's note does not close its parent.
+ */
+function dispositioned(scanned, line, end, markers) {
+    const boxes = new Set(scanned.tasks.map((t) => t.line));
+    for (let i = line; i < end; i += 1) {
+        if (i > line && boxes.has(i))
+            return false;
+        const text = scanned.masked[i];
+        if (markers.some((marker) => text.includes(marker)))
+            return true;
+    }
+    return false;
+}
+/** A path inside a directory that may be the root itself. */
+function within(directory, name) {
+    return directory === '' ? name : `${directory}/${name}`;
+}
+/**
+ * Whether a path is a brief: a file directly in the live or archive directory
+ * whose name the configuration takes for a brief. Edits to briefs are the
+ * ceremony, not the round, and are left out of the scope and tree checks.
+ * Nothing else in those directories is: a README beside the briefs is work.
+ */
+function isBriefPath(path, config) {
+    const directory = dirOf(path);
+    if (directory !== normalisePath(config.briefs) && directory !== normalisePath(config.archive))
+        return false;
+    const name = path.slice(path.lastIndexOf('/') + 1);
+    const accept = parseGlob(config.files);
+    const excluded = config.exclude.some((e) => {
+        const parsed = parseGlob(e);
+        return parsed.ok && matchGlob(parsed.glob, name);
+    });
+    return accept.ok && matchGlob(accept.glob, name) && !excluded;
+}
+/** Task items that must be closed before a brief can be archived. */
+export function openTasks(brief, corpus) {
+    const { tasks: scope, dispositions } = corpus.config.archiving;
+    const inScope = scope === 'all'
+        ? brief.tasks
+        : brief.tasks.filter((task) => brief.sections.some((s) => task.line > s.heading.line && task.line < s.end && scope.some((name) => labelMatches(s.heading.text, name))));
+    return inScope.filter((task) => !task.checked && !dispositioned(brief.scan, task.line, task.end, dispositions));
+}
+function diffstat(changes) {
+    const insertions = changes.reduce((sum, c) => sum + (c.insertions ?? 0), 0);
+    const deletions = changes.reduce((sum, c) => sum + (c.deletions ?? 0), 0);
+    const files = changes.length === 1 ? '1 file changed' : `${changes.length} files changed`;
+    return `${files}, +${insertions} \u2212${deletions}`;
+}
+/**
+ * The banner's lines, markers included. A template line whose placeholders
+ * are not all filled is left out, so a round with no pull request has no
+ * pull-request sentence rather than a sentence with a hole in it. A template
+ * with nothing left writes no banner at all, markers included.
+ */
+export function renderBanner(template, values) {
+    const kept = template
+        .filter((line) => templateHoles(line).every((hole) => (values[hole] ?? '') !== ''))
+        .map((line) => fillTemplate(line, values));
+    if (kept.length === 0)
+        return [];
+    return [BANNER_OPEN, ...kept.map((line) => (line === '' ? '>' : `> ${line}`)), BANNER_CLOSE];
+}
+/**
+ * Removes a banner block and the blank line written after it. The exact
+ * reverse of {@link withBanner}, so reopening a brief leaves its blank lines
+ * as they were.
+ */
+function withoutBanner(lines, banner) {
+    if (banner === null)
+        return [...lines];
+    const after = lines[banner.end]?.trim() === '' ? banner.end + 1 : banner.end;
+    return [...lines.slice(0, banner.start), ...lines.slice(after)];
+}
+/**
+ * Inserts a banner under the front matter, after the blank line that usually
+ * follows it, and writes one blank line after the banner.
+ */
+function withBanner(lines, banner) {
+    const frontMatter = readFrontMatter(lines);
+    let at = frontMatter === null || frontMatter.close < 0 ? 0 : frontMatter.close + 1;
+    if (at > 0 && lines[at]?.trim() === '')
+        at += 1;
+    return [...lines.slice(0, at), ...banner, '', ...lines.slice(at)];
+}
+/**
+ * Sets the integrity field to the hash of everything else. The field is put in
+ * place before hashing, so the lines hashed are exactly the lines a later
+ * check sees once it takes the field back out.
+ */
+function withIntegrity(lines) {
+    const placed = setEntry(lines, readFrontMatter(lines), INTEGRITY_FIELD, 'pending');
+    const hash = integrityOf(joinLines(placed, '\n'));
+    return setEntry(placed, readFrontMatter(placed), INTEGRITY_FIELD, hash);
+}
+/** Lines written back with the source's byte-order mark, line ending and final newline, or lack of one. */
+function encodeLike(source, lines) {
+    const bom = source.charCodeAt(0) === 0xfeff ? '\ufeff' : '';
+    const eol = lineEnding(source);
+    const text = joinLines(lines, eol);
+    const finalNewline = source === '' || source.endsWith('\n');
+    return `${bom}${finalNewline ? text : text.slice(0, text.length - eol.length)}`;
+}
+/** Links other briefs hold to a file that is moving: rewritten in live briefs, reported in frozen ones. */
+function inbound(corpus, moving, to) {
+    const result = { ops: [], rewritten: [], frozen: [] };
+    for (const other of corpus.briefs) {
+        if (other === moving)
+            continue;
+        const directory = dirOf(other.file);
+        const lines = linesLinkingTo(other.scan, directory, moving.file);
+        if (lines.length === 0)
+            continue;
+        if (other.phase === 'archived') {
+            for (const line of lines)
+                result.frozen.push({ file: other.file, line: line + 1 });
+            continue;
+        }
+        const rewritten = rewriteLinks(other.scan, directory, directory, (p) => (p === moving.file ? to : p));
+        result.ops.push({ kind: 'write', path: other.file, content: encodeLike(other.source, rewritten.lines), before: other.source });
+        result.rewritten.push(other.file);
+    }
+    return result;
+}
+function donePlan(action, brief) {
+    return {
+        action,
+        brief,
+        from: brief.file,
+        to: brief.file,
+        done: true,
+        ops: [],
+        blocking: [],
+        warnings: [],
+        linksRewritten: 0,
+        inboundRewritten: [],
+        inboundFrozen: [],
+        banner: [],
+        changes: [],
+    };
+}
+export function planArchive(corpus, brief, request) {
+    if (brief.phase === 'archived')
+        return donePlan('archive', brief);
+    const { config } = corpus;
+    const archiveDir = normalisePath(config.archive);
+    const to = within(archiveDir, brief.name);
+    const blocking = [];
+    const warnings = [];
+    // Under --strict a warning is an error, here as in lint.
+    for (const finding of request.findings ?? []) {
+        const refuses = finding.severity === 'error' || (request.strict === true && finding.severity === 'warning');
+        if (finding.file === brief.file && refuses)
+            blocking.push(finding);
+    }
+    // Only a status field can say "draft", so there is one to point at.
+    const field = config.status.field;
+    if (brief.status === 'draft') {
+        blocking.push(problem(brief, 'archive-draft', 'error', lineOf(brief, field), 'is a draft, and a draft has not been executed', `set "${field}: ${config.status.active}" once the round runs`));
+    }
+    for (const task of openTasks(brief, corpus)) {
+        blocking.push(problem(brief, 'open-task', 'error', task.line + 1, `"${task.text === '' ? '(empty)' : task.text}" is neither ticked nor dispositioned`, `tick it, or say why under it with a note starting ${config.archiving.dispositions.map((d) => `"${d}"`).join(', ')}`));
+    }
+    for (const dependency of brief.dependsOn) {
+        const target = resolveDependency(corpus, dependency);
+        if (target !== undefined && target !== brief && target.phase === 'live') {
+            blocking.push(problem(brief, 'dependency-open', 'error', lineOf(brief, 'dependsOn'), `depends on ${target.id ?? target.name}, which is not archived yet`, `archive ${target.id ?? target.name} first, or drop the dependency if it was never real`));
+        }
+    }
+    const bookkeeping = (path) => isBriefPath(path, config);
+    if (request.dirty !== undefined && request.allowDirty !== true) {
+        const outside = request.dirty.filter((path) => !bookkeeping(path));
+        if (outside.length > 0) {
+            const shown = outside.slice(0, 5).join(', ') + (outside.length > 5 ? `, and ${outside.length - 5} more` : '');
+            blocking.push(problem(brief, 'dirty-tree', 'error', 1, `the working tree has uncommitted changes outside the briefs: ${shown}`, 'commit them so the recorded commit holds the round, or pass --allow-dirty'));
+        }
+    }
+    const work = (request.changes ?? []).filter((change) => !bookkeeping(change.path));
+    const protectedGlobs = globs(brief.protectedFiles);
+    const affectedGlobs = globs(brief.affectedFiles);
+    for (const change of work) {
+        if (protectedGlobs.some((g) => matchGlob(g, change.path))) {
+            blocking.push(problem(brief, 'protected-file', 'error', lineOf(brief, 'protectedFiles'), `the round changed ${change.path}, which this brief protects`, 'revert the change, or record the departure in the brief before archiving it'));
+        }
+    }
+    // A protected file is reported once, as protected, and not again as out of scope.
+    const unprotected = work.filter((c) => !protectedGlobs.some((g) => matchGlob(g, c.path)));
+    const outside = affectedGlobs.length === 0 ? [] : unprotected.filter((c) => !affectedGlobs.some((g) => matchGlob(g, c.path)));
+    if (outside.length > 0) {
+        const shown = outside.slice(0, 5).map((c) => c.path).join(', ') + (outside.length > 5 ? `, and ${outside.length - 5} more` : '');
+        const finding = problem(brief, 'out-of-scope', request.strict === true ? 'error' : 'warning', lineOf(brief, 'affectedFiles'), `the round changed ${outside.length} file(s) outside affectedFiles: ${shown}`, 'widen affectedFiles if the scope was wrong, or say why in the summary');
+        (request.strict === true ? blocking : warnings).push(finding);
+    }
+    if (corpus.briefs.some((b) => b.file === to)) {
+        blocking.push(problem(brief, 'archive-exists', 'error', 1, `${to} already exists`, 'an archived brief is never overwritten'));
+    }
+    let lines = [...brief.lines];
+    let linksRewritten = 0;
+    if (config.archiving.rewriteLinks) {
+        const rewritten = rewriteLinks(brief.scan, dirOf(brief.file), archiveDir, (p) => (p === brief.file ? to : p));
+        lines = rewritten.lines;
+        linksRewritten = rewritten.count;
+    }
+    lines = withoutBanner(lines, brief.banner);
+    const pr = request.pr;
+    const values = {
+        date: request.date,
+        summary: request.summary?.trim() ?? '',
+        pr: pr === undefined ? '' : pr.url === null ? `#${pr.number}` : `[#${pr.number}](${pr.url})`,
+        commit: request.commit?.sha.slice(0, 7) ?? '',
+        diffstat: request.commit === undefined || request.changes === undefined ? '' : diffstat(request.changes),
+        links: linksRewritten === 0
+            ? ''
+            : `Relative links were rewritten to resolve from \`${archiveDir}/\` (${linksRewritten}); no other word changed.`,
+        id: brief.id ?? '',
+        title: brief.title ?? '',
+        author: request.commit?.author ?? '',
+    };
+    const banner = renderBanner(config.archiving.banner, values);
+    if (banner.length > 0)
+        lines = withBanner(lines, banner);
+    if (config.status.field !== null) {
+        lines = setEntry(lines, readFrontMatter(lines), config.status.field, renderScalar(config.status.archived));
+    }
+    lines = removeEntry(lines, readFrontMatter(lines), INTEGRITY_FIELD);
+    if (config.archiving.freeze)
+        lines = withIntegrity(lines);
+    const incoming = inbound(corpus, brief, to);
+    return {
+        action: 'archive',
+        brief,
+        from: brief.file,
+        to,
+        done: false,
+        ops: [
+            { kind: 'write', path: to, content: encodeLike(brief.source, lines), before: null },
+            ...incoming.ops,
+            { kind: 'remove', path: brief.file, before: brief.source },
+        ],
+        blocking,
+        warnings,
+        linksRewritten,
+        inboundRewritten: incoming.rewritten,
+        inboundFrozen: incoming.frozen,
+        banner,
+        changes: request.changes ?? [],
+    };
+}
+/**
+ * Reopens an archived brief: the banner and the freeze come off, the status
+ * goes back to the live word, and the links are rewritten for the directory
+ * it returns to. What the round wrote stays in history, where it belongs.
+ */
+export function planUnarchive(corpus, brief) {
+    if (brief.phase === 'live')
+        return donePlan('unarchive', brief);
+    const { config } = corpus;
+    const briefsDir = normalisePath(config.briefs);
+    const to = within(briefsDir, brief.name);
+    const blocking = [];
+    if (corpus.briefs.some((b) => b.file === to)) {
+        blocking.push(problem(brief, 'unarchive-exists', 'error', 1, `${to} already exists`, 'rename one of them first'));
+    }
+    let lines = [...brief.lines];
+    let linksRewritten = 0;
+    if (config.archiving.rewriteLinks) {
+        const rewritten = rewriteLinks(brief.scan, dirOf(brief.file), briefsDir, (p) => (p === brief.file ? to : p));
+        lines = rewritten.lines;
+        linksRewritten = rewritten.count;
+    }
+    lines = withoutBanner(lines, brief.banner);
+    lines = removeEntry(lines, readFrontMatter(lines), INTEGRITY_FIELD);
+    if (config.status.field !== null) {
+        lines = setEntry(lines, readFrontMatter(lines), config.status.field, renderScalar(config.status.active));
+    }
+    const incoming = inbound(corpus, brief, to);
+    return {
+        action: 'unarchive',
+        brief,
+        from: brief.file,
+        to,
+        done: false,
+        ops: [
+            { kind: 'write', path: to, content: encodeLike(brief.source, lines), before: null },
+            ...incoming.ops,
+            { kind: 'remove', path: brief.file, before: brief.source },
+        ],
+        blocking,
+        warnings: [],
+        linksRewritten,
+        inboundRewritten: incoming.rewritten,
+        inboundFrozen: incoming.frozen,
+        banner: [],
+        changes: [],
+    };
+}
+//# sourceMappingURL=archive.js.map

package/dist/archive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"archive.js","sourceRoot":"","sources":["../src/archive.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAc,WAAW,EAAE,MAAM,YAAY,CAAC;AAEhF,OAAO,EAAe,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAExF,OAAO,EAAa,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEhF,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAsD7F,SAAS,OAAO,CACd,KAAY,EACZ,IAAY,EACZ,QAAkB,EAClB,IAAY,EACZ,OAAe,EACf,IAAa;IAEb,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,IAAI,SAAS,EAAE,IAAI,EAAE,CAAC;AACjG,CAAC;AAED,SAAS,MAAM,CAAC,KAAY,EAAE,GAAW;IACvC,OAAO,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AACrC,CAAC;AAED;;;;GAIG;AACH,SAAS,KAAK,CAAC,QAA2B;IACxC,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAC5B,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,OAAa,EAAE,IAAY,EAAE,GAAW,EAAE,OAA0B;IACzF,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACxD,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAW,CAAC;QACzC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;IACnE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,6DAA6D;AAC7D,SAAS,MAAM,CAAC,SAAiB,EAAE,IAAY;IAC7C,OAAO,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,IAAI,EAAE,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,IAAY,EAAE,MAAc;IAC/C,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,SAAS,KAAK,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,SAAS,KAAK,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAC5G,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QACzC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;AAChE,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,SAAS,CAAC,KAAY,EAAE,MAAc;IACpD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/D,MAAM,OAAO,GACX,KAAK,KAAK,KAAK;QACb,CAAC,CAAC,KAAK,CAAC,KAAK;QACb,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAC1B,KAAK,CAAC,QAAQ,CAAC,IAAI,CACjB,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CACnH,CACF,CAAC;IACR,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;AAClH,CAAC;AAED,SAAS,QAAQ,CAAC,OAA8B;IAC9C,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1E,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,gBAAgB,CAAC;IAC1F,OAAO,GAAG,KAAK,MAAM,UAAU,UAAU,SAAS,EAAE,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,QAA2B,EAAE,MAAwC;IAChG,MAAM,IAAI,GAAG,QAAQ;SAClB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;SAClF,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,OAAO,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;AAC/F,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,KAAwB,EAAE,MAAuB;IACtE,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;IAC7E,OAAO,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAClE,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,KAAwB,EAAE,MAAyB;IACrE,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAC3C,IAAI,EAAE,GAAG,WAAW,KAAK,IAAI,IAAI,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,CAAC;IACnF,IAAI,EAAE,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE;QAAE,EAAE,IAAI,CAAC,CAAC;IAChD,OAAO,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,KAAwB;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;IACnF,MAAM,IAAI,GAAG,WAAW,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;AAC1E,CAAC;AAED,2GAA2G;AAC3G,SAAS,UAAU,CAAC,MAAc,EAAE,KAAwB;IAC1D,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5D,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACnC,MAAM,YAAY,GAAG,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5D,OAAO,GAAG,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;AAClF,CAAC;AAQD,2GAA2G;AAC3G,SAAS,OAAO,CAAC,MAAc,EAAE,MAAa,EAAE,EAAU;IACxD,MAAM,MAAM,GAAY,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC/D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClC,IAAI,KAAK,KAAK,MAAM;YAAE,SAAS;QAC/B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACjE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACjC,IAAI,KAAK,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YAC/B,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC;YACnF,SAAS;QACX,CAAC;QACD,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/H,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,QAAQ,CAAC,MAAsB,EAAE,KAAY;IACpD,OAAO;QACL,MAAM;QACN,KAAK;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,EAAE,EAAE,KAAK,CAAC,IAAI;QACd,IAAI,EAAE,IAAI;QACV,GAAG,EAAE,EAAE;QACP,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,EAAE;QACZ,cAAc,EAAE,CAAC;QACjB,gBAAgB,EAAE,EAAE;QACpB,aAAa,EAAE,EAAE;QACjB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,KAAY,EAAE,OAAuB;IAC/E,IAAI,KAAK,CAAC,KAAK,KAAK,UAAU;QAAE,OAAO,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAClE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC1B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,yDAAyD;IACzD,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;QAC5G,IAAI,OAAO,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IACD,oEAAoE;IACpE,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAe,CAAC;IAC5C,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,+CAA+C,EAAE,QAAQ,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,uBAAuB,CAAC,CAC/K,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QAC5C,QAAQ,CAAC,IAAI,CACX,OAAO,CACL,KAAK,EACL,WAAW,EACX,OAAO,EACP,IAAI,CAAC,IAAI,GAAG,CAAC,EACb,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,uCAAuC,EACnF,qDAAqD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACrH,CACF,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACrD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YACxE,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,cAAc,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,IAAI,6BAA6B,EAAE,WAAW,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,IAAI,qDAAqD,CAAC,CACtO,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,WAAW,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACzE,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAC/D,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC9G,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,EAAE,gEAAgE,KAAK,EAAE,EAAE,2EAA2E,CAAC,CAC/L,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnF,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACnD,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACjD,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE,CAAC;QAC1B,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC1D,QAAQ,CAAC,IAAI,CACX,OAAO,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,gBAAgB,CAAC,EAAE,qBAAqB,MAAM,CAAC,IAAI,6BAA6B,EAAE,6EAA6E,CAAC,CACzN,CAAC;QACJ,CAAC;IACH,CAAC;IACD,kFAAkF;IAClF,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1F,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9H,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACjI,MAAM,OAAO,GAAG,OAAO,CACrB,KAAK,EACL,cAAc,EACd,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAC7C,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,EAC9B,qBAAqB,OAAO,CAAC,MAAM,mCAAmC,KAAK,EAAE,EAC7E,uEAAuE,CACxE,CAAC;QACF,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,EAAE,CAAC;QAC7C,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,wCAAwC,CAAC,CAAC,CAAC;IAChI,CAAC;IAED,IAAI,KAAK,GAAa,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACvC,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9G,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;QACxB,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC;IACnC,CAAC;IACD,KAAK,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3C,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;IACtB,MAAM,MAAM,GAA2B;QACrC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;QACtC,EAAE,EAAE,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,MAAM,KAAK,EAAE,CAAC,GAAG,GAAG;QAC5F,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE;QAC7C,QAAQ,EAAE,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC;QACxG,KAAK,EACH,cAAc,KAAK,CAAC;YAClB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,mDAAmD,UAAU,QAAQ,cAAc,2BAA2B;QACpH,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE;QAClB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE;KACrC,CAAC;IACF,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzD,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACjC,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7G,CAAC;IACD,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC,CAAC;IACpE,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM;QAAE,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAE1D,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5C,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,KAAK;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,EAAE;QACF,IAAI,EAAE,KAAK;QACX,GAAG,EAAE;YACH,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE;YACnF,GAAG,QAAQ,CAAC,GAAG;YACf,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;SAC3D;QACD,QAAQ;QACR,QAAQ;QACR,cAAc;QACd,gBAAgB,EAAE,QAAQ,CAAC,SAAS;QACpC,aAAa,EAAE,QAAQ,CAAC,MAAM;QAC9B,MAAM;QACN,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;KAC/B,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,KAAY;IACxD,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM;QAAE,OAAO,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAChE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC1B,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,EAAE,CAAC;QAC7C,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,iBAAiB,EAAE,0BAA0B,CAAC,CAAC,CAAC;IACpH,CAAC;IAED,IAAI,KAAK,GAAa,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IACvC,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7G,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC;QACxB,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC;IACnC,CAAC;IACD,KAAK,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3C,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC,CAAC;IACpE,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACjC,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5C,OAAO;QACL,MAAM,EAAE,WAAW;QACnB,KAAK;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,EAAE;QACF,IAAI,EAAE,KAAK;QACX,GAAG,EAAE;YACH,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE;YACnF,GAAG,QAAQ,CAAC,GAAG;YACf,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;SAC3D;QACD,QAAQ;QACR,QAAQ,EAAE,EAAE;QACZ,cAAc;QACd,gBAAgB,EAAE,QAAQ,CAAC,SAAS;QACpC,aAAa,EAAE,QAAQ,CAAC,MAAM;QAC9B,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Archival and its reverse, planned.\n *\n * A plan is a pure function of the corpus and a request: what would be\n * refused and why, the text every touched file would hold afterwards, and the\n * operations that get there. Nothing is written here. `--dry-run` prints a\n * plan; `apply.ts` executes one as a transaction. Splitting the two is what\n * makes the ceremony testable without a disk and previewable without risk.\n */\n\nimport { BANNER_CLOSE, BANNER_OPEN, type Brief, lineOfField } from './brief.js';\nimport type { Config } from './config.js';\nimport { type Corpus, resolveDependency } from './corpus.js';\nimport { readFrontMatter, removeEntry, renderScalar, setEntry } from './frontmatter.js';\nimport type { CommitInfo, FileChange } from './git.js';\nimport { type Glob, matchGlob, parseGlob } from './glob.js';\nimport { INTEGRITY_FIELD, integrityOf } from './integrity.js';\nimport { dirOf, linesLinkingTo, normalisePath, rewriteLinks } from './links.js';\nimport type { Scan } from './markdown.js';\nimport { fillTemplate, joinLines, labelMatches, lineEnding, templateHoles } from './text.js';\nimport type { Finding, Severity } from './types.js';\n\nexport interface PullRequest {\n  readonly number: number;\n  readonly url: string | null;\n}\n\nexport interface ArchiveRequest {\n  /** `YYYY-MM-DD`. */\n  readonly date: string;\n  readonly summary?: string | undefined;\n  readonly pr?: PullRequest | undefined;\n  readonly commit?: CommitInfo | undefined;\n  /** The files the round changed, when a commit is known. */\n  readonly changes?: readonly FileChange[] | undefined;\n  /** Uncommitted paths, when the working tree was read. */\n  readonly dirty?: readonly string[] | undefined;\n  readonly allowDirty?: boolean | undefined;\n  /** Out-of-scope changes refuse the archival instead of warning. */\n  readonly strict?: boolean | undefined;\n  /** The corpus's lint findings; errors on the brief refuse the archival. */\n  readonly findings?: readonly Finding[] | undefined;\n}\n\nexport type FileOp =\n  | {\n      readonly kind: 'write';\n      readonly path: string;\n      readonly content: string;\n      /** What the file holds when the plan is made; `null` for a file that must not exist yet. */\n      readonly before: string | null;\n    }\n  | { readonly kind: 'remove'; readonly path: string; readonly before: string };\n\nexport interface Plan {\n  readonly action: 'archive' | 'unarchive';\n  readonly brief: Brief;\n  readonly from: string;\n  readonly to: string;\n  /** The brief is already where this action would put it. */\n  readonly done: boolean;\n  readonly ops: readonly FileOp[];\n  /** Why the action is refused; empty when it may proceed. */\n  readonly blocking: readonly Finding[];\n  readonly warnings: readonly Finding[];\n  readonly linksRewritten: number;\n  readonly inboundRewritten: readonly string[];\n  /** Links archived briefs hold to the old path. They are frozen and left as they are. */\n  readonly inboundFrozen: readonly { readonly file: string; readonly line: number }[];\n  readonly banner: readonly string[];\n  readonly changes: readonly FileChange[];\n}\n\nfunction problem(\n  brief: Brief,\n  rule: string,\n  severity: Severity,\n  line: number,\n  message: string,\n  hint?: string,\n): Finding {\n  return { rule, severity, message, file: brief.file, line, brief: brief.id ?? undefined, hint };\n}\n\nfunction lineOf(brief: Brief, key: string): number {\n  return lineOfField(brief, key) + 1;\n}\n\n/**\n * Scope patterns, for matching the files a round changed. A changed path is a\n * file, and a literal pattern matches its own path whether it is read as a\n * file or as a directory, so the tree is not asked.\n */\nfunction globs(patterns: readonly string[]): Glob[] {\n  return patterns.flatMap((p) => {\n    const parsed = parseGlob(p);\n    return parsed.ok ? [parsed.glob] : [];\n  });\n}\n\n/**\n * Whether an open box carries a note that closes it: \"Delegated to ...\",\n * \"Rejected ...\". The note belongs to the box above it, so the search stops at\n * the first nested box: a child's note does not close its parent.\n */\nfunction dispositioned(scanned: Scan, line: number, end: number, markers: readonly string[]): boolean {\n  const boxes = new Set(scanned.tasks.map((t) => t.line));\n  for (let i = line; i < end; i += 1) {\n    if (i > line && boxes.has(i)) return false;\n    const text = scanned.masked[i] as string;\n    if (markers.some((marker) => text.includes(marker))) return true;\n  }\n  return false;\n}\n\n/** A path inside a directory that may be the root itself. */\nfunction within(directory: string, name: string): string {\n  return directory === '' ? name : `${directory}/${name}`;\n}\n\n/**\n * Whether a path is a brief: a file directly in the live or archive directory\n * whose name the configuration takes for a brief. Edits to briefs are the\n * ceremony, not the round, and are left out of the scope and tree checks.\n * Nothing else in those directories is: a README beside the briefs is work.\n */\nfunction isBriefPath(path: string, config: Config): boolean {\n  const directory = dirOf(path);\n  if (directory !== normalisePath(config.briefs) && directory !== normalisePath(config.archive)) return false;\n  const name = path.slice(path.lastIndexOf('/') + 1);\n  const accept = parseGlob(config.files);\n  const excluded = config.exclude.some((e) => {\n    const parsed = parseGlob(e);\n    return parsed.ok && matchGlob(parsed.glob, name);\n  });\n  return accept.ok && matchGlob(accept.glob, name) && !excluded;\n}\n\n/** Task items that must be closed before a brief can be archived. */\nexport function openTasks(brief: Brief, corpus: Corpus): Brief['tasks'] {\n  const { tasks: scope, dispositions } = corpus.config.archiving;\n  const inScope =\n    scope === 'all'\n      ? brief.tasks\n      : brief.tasks.filter((task) =>\n          brief.sections.some(\n            (s) => task.line > s.heading.line && task.line < s.end && scope.some((name) => labelMatches(s.heading.text, name)),\n          ),\n        );\n  return inScope.filter((task) => !task.checked && !dispositioned(brief.scan, task.line, task.end, dispositions));\n}\n\nfunction diffstat(changes: readonly FileChange[]): string {\n  const insertions = changes.reduce((sum, c) => sum + (c.insertions ?? 0), 0);\n  const deletions = changes.reduce((sum, c) => sum + (c.deletions ?? 0), 0);\n  const files = changes.length === 1 ? '1 file changed' : `${changes.length} files changed`;\n  return `${files}, +${insertions} \\u2212${deletions}`;\n}\n\n/**\n * The banner's lines, markers included. A template line whose placeholders\n * are not all filled is left out, so a round with no pull request has no\n * pull-request sentence rather than a sentence with a hole in it. A template\n * with nothing left writes no banner at all, markers included.\n */\nexport function renderBanner(template: readonly string[], values: Readonly<Record<string, string>>): string[] {\n  const kept = template\n    .filter((line) => templateHoles(line).every((hole) => (values[hole] ?? '') !== ''))\n    .map((line) => fillTemplate(line, values));\n  if (kept.length === 0) return [];\n  return [BANNER_OPEN, ...kept.map((line) => (line === '' ? '>' : `> ${line}`)), BANNER_CLOSE];\n}\n\n/**\n * Removes a banner block and the blank line written after it. The exact\n * reverse of {@link withBanner}, so reopening a brief leaves its blank lines\n * as they were.\n */\nfunction withoutBanner(lines: readonly string[], banner: Brief['banner']): string[] {\n  if (banner === null) return [...lines];\n  const after = lines[banner.end]?.trim() === '' ? banner.end + 1 : banner.end;\n  return [...lines.slice(0, banner.start), ...lines.slice(after)];\n}\n\n/**\n * Inserts a banner under the front matter, after the blank line that usually\n * follows it, and writes one blank line after the banner.\n */\nfunction withBanner(lines: readonly string[], banner: readonly string[]): string[] {\n  const frontMatter = readFrontMatter(lines);\n  let at = frontMatter === null || frontMatter.close < 0 ? 0 : frontMatter.close + 1;\n  if (at > 0 && lines[at]?.trim() === '') at += 1;\n  return [...lines.slice(0, at), ...banner, '', ...lines.slice(at)];\n}\n\n/**\n * Sets the integrity field to the hash of everything else. The field is put in\n * place before hashing, so the lines hashed are exactly the lines a later\n * check sees once it takes the field back out.\n */\nfunction withIntegrity(lines: readonly string[]): string[] {\n  const placed = setEntry(lines, readFrontMatter(lines), INTEGRITY_FIELD, 'pending');\n  const hash = integrityOf(joinLines(placed, '\\n'));\n  return setEntry(placed, readFrontMatter(placed), INTEGRITY_FIELD, hash);\n}\n\n/** Lines written back with the source's byte-order mark, line ending and final newline, or lack of one. */\nfunction encodeLike(source: string, lines: readonly string[]): string {\n  const bom = source.charCodeAt(0) === 0xfeff ? '\\ufeff' : '';\n  const eol = lineEnding(source);\n  const text = joinLines(lines, eol);\n  const finalNewline = source === '' || source.endsWith('\\n');\n  return `${bom}${finalNewline ? text : text.slice(0, text.length - eol.length)}`;\n}\n\ninterface Inbound {\n  readonly ops: FileOp[];\n  readonly rewritten: string[];\n  readonly frozen: { file: string; line: number }[];\n}\n\n/** Links other briefs hold to a file that is moving: rewritten in live briefs, reported in frozen ones. */\nfunction inbound(corpus: Corpus, moving: Brief, to: string): Inbound {\n  const result: Inbound = { ops: [], rewritten: [], frozen: [] };\n  for (const other of corpus.briefs) {\n    if (other === moving) continue;\n    const directory = dirOf(other.file);\n    const lines = linesLinkingTo(other.scan, directory, moving.file);\n    if (lines.length === 0) continue;\n    if (other.phase === 'archived') {\n      for (const line of lines) result.frozen.push({ file: other.file, line: line + 1 });\n      continue;\n    }\n    const rewritten = rewriteLinks(other.scan, directory, directory, (p) => (p === moving.file ? to : p));\n    result.ops.push({ kind: 'write', path: other.file, content: encodeLike(other.source, rewritten.lines), before: other.source });\n    result.rewritten.push(other.file);\n  }\n  return result;\n}\n\nfunction donePlan(action: Plan['action'], brief: Brief): Plan {\n  return {\n    action,\n    brief,\n    from: brief.file,\n    to: brief.file,\n    done: true,\n    ops: [],\n    blocking: [],\n    warnings: [],\n    linksRewritten: 0,\n    inboundRewritten: [],\n    inboundFrozen: [],\n    banner: [],\n    changes: [],\n  };\n}\n\nexport function planArchive(corpus: Corpus, brief: Brief, request: ArchiveRequest): Plan {\n  if (brief.phase === 'archived') return donePlan('archive', brief);\n  const { config } = corpus;\n  const archiveDir = normalisePath(config.archive);\n  const to = within(archiveDir, brief.name);\n  const blocking: Finding[] = [];\n  const warnings: Finding[] = [];\n\n  // Under --strict a warning is an error, here as in lint.\n  for (const finding of request.findings ?? []) {\n    const refuses = finding.severity === 'error' || (request.strict === true && finding.severity === 'warning');\n    if (finding.file === brief.file && refuses) blocking.push(finding);\n  }\n  // Only a status field can say \"draft\", so there is one to point at.\n  const field = config.status.field as string;\n  if (brief.status === 'draft') {\n    blocking.push(\n      problem(brief, 'archive-draft', 'error', lineOf(brief, field), 'is a draft, and a draft has not been executed', `set \"${field}: ${config.status.active}\" once the round runs`),\n    );\n  }\n  for (const task of openTasks(brief, corpus)) {\n    blocking.push(\n      problem(\n        brief,\n        'open-task',\n        'error',\n        task.line + 1,\n        `\"${task.text === '' ? '(empty)' : task.text}\" is neither ticked nor dispositioned`,\n        `tick it, or say why under it with a note starting ${config.archiving.dispositions.map((d) => `\"${d}\"`).join(', ')}`,\n      ),\n    );\n  }\n  for (const dependency of brief.dependsOn) {\n    const target = resolveDependency(corpus, dependency);\n    if (target !== undefined && target !== brief && target.phase === 'live') {\n      blocking.push(\n        problem(brief, 'dependency-open', 'error', lineOf(brief, 'dependsOn'), `depends on ${target.id ?? target.name}, which is not archived yet`, `archive ${target.id ?? target.name} first, or drop the dependency if it was never real`),\n      );\n    }\n  }\n  const bookkeeping = (path: string): boolean => isBriefPath(path, config);\n  if (request.dirty !== undefined && request.allowDirty !== true) {\n    const outside = request.dirty.filter((path) => !bookkeeping(path));\n    if (outside.length > 0) {\n      const shown = outside.slice(0, 5).join(', ') + (outside.length > 5 ? `, and ${outside.length - 5} more` : '');\n      blocking.push(\n        problem(brief, 'dirty-tree', 'error', 1, `the working tree has uncommitted changes outside the briefs: ${shown}`, 'commit them so the recorded commit holds the round, or pass --allow-dirty'),\n      );\n    }\n  }\n\n  const work = (request.changes ?? []).filter((change) => !bookkeeping(change.path));\n  const protectedGlobs = globs(brief.protectedFiles);\n  const affectedGlobs = globs(brief.affectedFiles);\n  for (const change of work) {\n    if (protectedGlobs.some((g) => matchGlob(g, change.path))) {\n      blocking.push(\n        problem(brief, 'protected-file', 'error', lineOf(brief, 'protectedFiles'), `the round changed ${change.path}, which this brief protects`, 'revert the change, or record the departure in the brief before archiving it'),\n      );\n    }\n  }\n  // A protected file is reported once, as protected, and not again as out of scope.\n  const unprotected = work.filter((c) => !protectedGlobs.some((g) => matchGlob(g, c.path)));\n  const outside = affectedGlobs.length === 0 ? [] : unprotected.filter((c) => !affectedGlobs.some((g) => matchGlob(g, c.path)));\n  if (outside.length > 0) {\n    const shown = outside.slice(0, 5).map((c) => c.path).join(', ') + (outside.length > 5 ? `, and ${outside.length - 5} more` : '');\n    const finding = problem(\n      brief,\n      'out-of-scope',\n      request.strict === true ? 'error' : 'warning',\n      lineOf(brief, 'affectedFiles'),\n      `the round changed ${outside.length} file(s) outside affectedFiles: ${shown}`,\n      'widen affectedFiles if the scope was wrong, or say why in the summary',\n    );\n    (request.strict === true ? blocking : warnings).push(finding);\n  }\n  if (corpus.briefs.some((b) => b.file === to)) {\n    blocking.push(problem(brief, 'archive-exists', 'error', 1, `${to} already exists`, 'an archived brief is never overwritten'));\n  }\n\n  let lines: string[] = [...brief.lines];\n  let linksRewritten = 0;\n  if (config.archiving.rewriteLinks) {\n    const rewritten = rewriteLinks(brief.scan, dirOf(brief.file), archiveDir, (p) => (p === brief.file ? to : p));\n    lines = rewritten.lines;\n    linksRewritten = rewritten.count;\n  }\n  lines = withoutBanner(lines, brief.banner);\n\n  const pr = request.pr;\n  const values: Record<string, string> = {\n    date: request.date,\n    summary: request.summary?.trim() ?? '',\n    pr: pr === undefined ? '' : pr.url === null ? `#${pr.number}` : `[#${pr.number}](${pr.url})`,\n    commit: request.commit?.sha.slice(0, 7) ?? '',\n    diffstat: request.commit === undefined || request.changes === undefined ? '' : diffstat(request.changes),\n    links:\n      linksRewritten === 0\n        ? ''\n        : `Relative links were rewritten to resolve from \\`${archiveDir}/\\` (${linksRewritten}); no other word changed.`,\n    id: brief.id ?? '',\n    title: brief.title ?? '',\n    author: request.commit?.author ?? '',\n  };\n  const banner = renderBanner(config.archiving.banner, values);\n  if (banner.length > 0) lines = withBanner(lines, banner);\n  if (config.status.field !== null) {\n    lines = setEntry(lines, readFrontMatter(lines), config.status.field, renderScalar(config.status.archived));\n  }\n  lines = removeEntry(lines, readFrontMatter(lines), INTEGRITY_FIELD);\n  if (config.archiving.freeze) lines = withIntegrity(lines);\n\n  const incoming = inbound(corpus, brief, to);\n  return {\n    action: 'archive',\n    brief,\n    from: brief.file,\n    to,\n    done: false,\n    ops: [\n      { kind: 'write', path: to, content: encodeLike(brief.source, lines), before: null },\n      ...incoming.ops,\n      { kind: 'remove', path: brief.file, before: brief.source },\n    ],\n    blocking,\n    warnings,\n    linksRewritten,\n    inboundRewritten: incoming.rewritten,\n    inboundFrozen: incoming.frozen,\n    banner,\n    changes: request.changes ?? [],\n  };\n}\n\n/**\n * Reopens an archived brief: the banner and the freeze come off, the status\n * goes back to the live word, and the links are rewritten for the directory\n * it returns to. What the round wrote stays in history, where it belongs.\n */\nexport function planUnarchive(corpus: Corpus, brief: Brief): Plan {\n  if (brief.phase === 'live') return donePlan('unarchive', brief);\n  const { config } = corpus;\n  const briefsDir = normalisePath(config.briefs);\n  const to = within(briefsDir, brief.name);\n  const blocking: Finding[] = [];\n  if (corpus.briefs.some((b) => b.file === to)) {\n    blocking.push(problem(brief, 'unarchive-exists', 'error', 1, `${to} already exists`, 'rename one of them first'));\n  }\n\n  let lines: string[] = [...brief.lines];\n  let linksRewritten = 0;\n  if (config.archiving.rewriteLinks) {\n    const rewritten = rewriteLinks(brief.scan, dirOf(brief.file), briefsDir, (p) => (p === brief.file ? to : p));\n    lines = rewritten.lines;\n    linksRewritten = rewritten.count;\n  }\n  lines = withoutBanner(lines, brief.banner);\n  lines = removeEntry(lines, readFrontMatter(lines), INTEGRITY_FIELD);\n  if (config.status.field !== null) {\n    lines = setEntry(lines, readFrontMatter(lines), config.status.field, renderScalar(config.status.active));\n  }\n\n  const incoming = inbound(corpus, brief, to);\n  return {\n    action: 'unarchive',\n    brief,\n    from: brief.file,\n    to,\n    done: false,\n    ops: [\n      { kind: 'write', path: to, content: encodeLike(brief.source, lines), before: null },\n      ...incoming.ops,\n      { kind: 'remove', path: brief.file, before: brief.source },\n    ],\n    blocking,\n    warnings: [],\n    linksRewritten,\n    inboundRewritten: incoming.rewritten,\n    inboundFrozen: incoming.frozen,\n    banner: [],\n    changes: [],\n  };\n}\n"]}

package/dist/brief.d.ts

@@ -0,0 +1,60 @@
+/**
+ * One brief, read: its identity, its front matter, its sections and its task
+ * items. A pure function of a file's path and text.
+ */
+import type { Config } from './config.js';
+import { type FrontMatter } from './frontmatter.js';
+import { type Scan, type Section, type TaskItem } from './markdown.js';
+import type { Phase, Status } from './types.js';
+export declare const BANNER_OPEN = "<!-- spec-brief:banner -->";
+export declare const BANNER_CLOSE = "<!-- /spec-brief:banner -->";
+/** Front-matter keys spec-brief itself reads, in the spelling it documents. */
+export declare const BUILT_IN_FIELDS: readonly string[];
+export interface FieldProblem {
+    readonly field: string;
+    /** 0-based line. */
+    readonly line: number;
+    readonly message: string;
+}
+export interface Brief {
+    /** `null` when no id can be read, which a rule reports. */
+    readonly id: string | null;
+    /** Repository-relative path. */
+    readonly file: string;
+    /** The file name. */
+    readonly name: string;
+    readonly phase: Phase;
+    /** The file exactly as read, byte-order mark and line endings included. */
+    readonly source: string;
+    /** The text parsed: the source without a byte-order mark. */
+    readonly text: string;
+    readonly lines: readonly string[];
+    readonly frontMatter: FrontMatter | null;
+    /** 0-based first line after the front matter. */
+    readonly bodyStart: number;
+    readonly scan: Scan;
+    readonly sections: readonly Section[];
+    readonly tasks: readonly TaskItem[];
+    readonly title: string | null;
+    readonly status: Status | null;
+    readonly statusWord: string | null;
+    readonly type: string | null;
+    readonly wave: number | null;
+    readonly dependsOn: readonly string[];
+    readonly affectedFiles: readonly string[];
+    readonly protectedFiles: readonly string[];
+    readonly integrity: string | null;
+    /** The frozen banner's lines, markers included, end exclusive. */
+    readonly banner: {
+        readonly start: number;
+        readonly end: number;
+    } | null;
+    readonly problems: readonly FieldProblem[];
+}
+/** The id a file name carries: everything before the separator, or the whole stem. */
+export declare function idFromName(name: string, separator: string): string;
+export declare function parseBrief(file: string, text: string, config: Config, phase: Phase): Brief;
+/** The 0-based line a front-matter key is declared on, or the first line when it is absent. */
+export declare function lineOfField(brief: Brief, field: string): number;
+/** Keys spec-brief knows, compared the way front matter compares them. */
+export declare function knownFields(config: Config): Set<string>;

package/dist/brief.js

@@ -0,0 +1,152 @@
+/**
+ * One brief, read: its identity, its front matter, its sections and its task
+ * items. A pure function of a file's path and text.
+ */
+import { findEntry, isNull, keyName, readFrontMatter } from './frontmatter.js';
+import { scan, sectionsOf, titleOf } from './markdown.js';
+import { splitLines, stripBom } from './text.js';
+export const BANNER_OPEN = '<!-- spec-brief:banner -->';
+export const BANNER_CLOSE = '<!-- /spec-brief:banner -->';
+/** Front-matter keys spec-brief itself reads, in the spelling it documents. */
+export const BUILT_IN_FIELDS = [
+    'id',
+    'title',
+    'type',
+    'status',
+    'date',
+    'wave',
+    'dependsOn',
+    'affectedFiles',
+    'protectedFiles',
+    'integrity',
+];
+function valueText(value) {
+    if (value.kind === 'unsupported')
+        return { problem: value.reason };
+    if (value.kind === 'list')
+        return { problem: 'must be a single value, not a list' };
+    return isNull(value.scalar) ? null : value.scalar.text;
+}
+function valueList(value) {
+    if (value.kind === 'unsupported')
+        return { problem: value.reason };
+    if (value.kind === 'scalar')
+        return isNull(value.scalar) ? [] : [value.scalar.text];
+    const empty = value.items.find((item) => isNull(item) || item.text.trim() === '');
+    if (empty !== undefined)
+        return { problem: 'must not contain an empty item' };
+    return value.items.map((item) => item.text.trim());
+}
+/** The id a file name carries: everything before the separator, or the whole stem. */
+export function idFromName(name, separator) {
+    const stem = name.replace(/\.md$/i, '');
+    const at = stem.indexOf(separator);
+    return at > 0 ? stem.slice(0, at) : stem;
+}
+function statusFrom(word, config, phase) {
+    if (config.status.field === null)
+        return phase === 'archived' ? 'archived' : 'active';
+    if (word === null)
+        return null;
+    const lower = word.toLowerCase();
+    if (lower === config.status.archived.toLowerCase())
+        return 'archived';
+    if (lower === config.status.active.toLowerCase())
+        return 'active';
+    if (config.status.draft !== null && lower === config.status.draft.toLowerCase())
+        return 'draft';
+    return null;
+}
+export function parseBrief(file, text, config, phase) {
+    const content = stripBom(text);
+    const lines = splitLines(content);
+    const frontMatter = readFrontMatter(lines);
+    const bodyStart = frontMatter === null || frontMatter.close < 0 ? 0 : frontMatter.close + 1;
+    const scanned = scan(lines, bodyStart);
+    const problems = [];
+    const name = file.slice(file.lastIndexOf('/') + 1);
+    const text1 = (field) => {
+        const entry = findEntry(frontMatter, field);
+        if (entry === undefined)
+            return null;
+        const value = valueText(entry.value);
+        if (value !== null && typeof value === 'object') {
+            problems.push({ field, line: entry.line, message: `"${entry.key}" ${value.problem}` });
+            return null;
+        }
+        return value;
+    };
+    const list = (field) => {
+        const entry = findEntry(frontMatter, field);
+        if (entry === undefined)
+            return [];
+        const value = valueList(entry.value);
+        if (!Array.isArray(value)) {
+            problems.push({ field, line: entry.line, message: `"${entry.key}" ${value.problem}` });
+            return [];
+        }
+        return value;
+    };
+    const waveText = text1('wave');
+    let wave = null;
+    const waveEntry = findEntry(frontMatter, 'wave');
+    if (waveText !== null && waveEntry !== undefined) {
+        const quoted = waveEntry.value.kind === 'scalar' && waveEntry.value.scalar.quoted;
+        if (!quoted && /^\d{1,9}$/.test(waveText))
+            wave = Number(waveText);
+        else
+            problems.push({ field: 'wave', line: waveEntry.line, message: `"wave" must be a whole number, not "${waveText}"` });
+    }
+    const statusWord = config.status.field === null ? null : text1(config.status.field);
+    const frontTitle = text1('title');
+    const heading = titleOf(scanned);
+    const id = config.id.source === 'filename' ? idFromName(name, config.id.separator) : text1('id');
+    // A marker is a comment on a line of its own. Quoted in a code block it is
+    // text: the prose mask keeps code and blanks comments, so a real marker is
+    // a line whose prose is empty.
+    const marker = (line, text) => lines[line].trim() === text && scanned.prose[line].trim() === '';
+    let banner = null;
+    const open = lines.findIndex((_, i) => i >= bodyStart && marker(i, BANNER_OPEN));
+    if (open >= 0) {
+        const close = lines.findIndex((_, i) => i > open && marker(i, BANNER_CLOSE));
+        if (close > open)
+            banner = { start: open, end: close + 1 };
+    }
+    return {
+        id: id === null || id.trim() === '' ? null : id.trim(),
+        file,
+        name,
+        phase,
+        source: text,
+        text: content,
+        lines,
+        frontMatter,
+        bodyStart,
+        scan: scanned,
+        sections: sectionsOf(scanned),
+        tasks: scanned.tasks,
+        title: frontTitle ?? (heading === undefined || heading.text === '' ? null : heading.text),
+        status: statusFrom(statusWord, config, phase),
+        statusWord,
+        type: text1('type'),
+        wave,
+        dependsOn: list('dependsOn'),
+        affectedFiles: list('affectedFiles'),
+        protectedFiles: list('protectedFiles'),
+        integrity: text1('integrity'),
+        banner,
+        problems,
+    };
+}
+/** The 0-based line a front-matter key is declared on, or the first line when it is absent. */
+export function lineOfField(brief, field) {
+    return findEntry(brief.frontMatter, field)?.line ?? 0;
+}
+/** Keys spec-brief knows, compared the way front matter compares them. */
+export function knownFields(config) {
+    const names = [...BUILT_IN_FIELDS, ...config.fields];
+    if (config.status.field !== null)
+        names.push(config.status.field);
+    return new Set(names.map(keyName));
+}
+//# sourceMappingURL=brief.js.map