@agent-teams/document-authoring 0.0.0

package/dist/documentation-observation/adapters/outbound/filesystem/markdown-document-parser.js

@@ -0,0 +1,260 @@
+import GithubSlugger from "github-slugger";
+import { toString } from "mdast-util-to-string";
+import remarkFrontmatter from "remark-frontmatter";
+import remarkGfm from "remark-gfm";
+import remarkParse from "remark-parse";
+import { unified } from "unified";
+import { visit as visitMarkdown } from "unist-util-visit";
+import { isAlias, isMap, isNode, isPair, parseDocument, visit as visitYaml } from "yaml";
+const markdownParser = unified()
+    .use(remarkParse)
+    .use(remarkGfm)
+    .use(remarkFrontmatter, ["yaml"])
+    .freeze();
+function isAstNode(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "type" in value &&
+        typeof value.type === "string");
+}
+function astProperty(value, property) {
+    return Reflect.get(value, property);
+}
+function isAstPoint(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "column" in value &&
+        typeof value.column === "number" &&
+        "line" in value &&
+        typeof value.line === "number" &&
+        "offset" in value &&
+        typeof value.offset === "number");
+}
+function isAstPosition(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "start" in value &&
+        isAstPoint(value.start) &&
+        "end" in value &&
+        isAstPoint(value.end));
+}
+function isDefinitionNode(value) {
+    return (isAstNode(value) &&
+        value.type === "definition" &&
+        typeof astProperty(value, "identifier") === "string" &&
+        typeof astProperty(value, "url") === "string");
+}
+function isHeadingNode(value) {
+    return (isAstNode(value) &&
+        value.type === "heading" &&
+        typeof astProperty(value, "depth") === "number");
+}
+function isReferenceNode(value) {
+    return (isAstNode(value) &&
+        (value.type === "imageReference" || value.type === "linkReference") &&
+        typeof astProperty(value, "identifier") === "string");
+}
+function isUrlNode(value) {
+    return (isAstNode(value) &&
+        (value.type === "image" || value.type === "link") &&
+        typeof astProperty(value, "url") === "string");
+}
+function isYamlNode(value) {
+    return isAstNode(value) && value.type === "yaml" && typeof astProperty(value, "value") === "string";
+}
+function parseMarkdown(source) {
+    const sourceOffset = source.startsWith("\uFEFF") ? 1 : 0;
+    return {
+        sourceOffset,
+        tree: markdownParser.parse(source.slice(sourceOffset))
+    };
+}
+function astPosition(node) {
+    const position = node.position;
+    if (!isAstPosition(position)) {
+        throw new Error(`Markdown AST node ${node.type} has no source position.`);
+    }
+    return position;
+}
+function markdownPosition(node, sourceOffset) {
+    const point = astPosition(node).start;
+    return {
+        column: point.column + (point.line === 1 ? sourceOffset : 0),
+        line: point.line,
+        offset: point.offset + sourceOffset
+    };
+}
+function endOffsetAfterLineEnding(source, node, sourceOffset) {
+    const endOffset = astPosition(node).end.offset + sourceOffset;
+    if (source.startsWith("\r\n", endOffset)) {
+        return endOffset + 2;
+    }
+    return source.startsWith("\n", endOffset) ? endOffset + 1 : endOffset;
+}
+function hasOpeningYamlDelimiter(source) {
+    const withoutByteOrderMark = source.startsWith("\uFEFF") ? source.slice(1) : source;
+    return /^---[ \t]*(?:\r?\n|$)/u.test(withoutByteOrderMark);
+}
+function findFrontmatter(markdown) {
+    let yaml;
+    visitMarkdown(markdown.tree, (node) => {
+        if (yaml === undefined && isYamlNode(node) && astPosition(node).start.offset === 0) {
+            yaml = node;
+        }
+    });
+    return yaml;
+}
+function forbiddenYamlFeature(document) {
+    let forbidden;
+    visitYaml(document, (_key, node) => {
+        if (forbidden !== undefined) {
+            return;
+        }
+        if (isAlias(node)) {
+            forbidden = "YAML aliases are prohibited.";
+            return;
+        }
+        if (isNode(node) && (node.anchor !== undefined || node.tag !== undefined)) {
+            forbidden = "YAML anchors and explicit tags are prohibited.";
+            return;
+        }
+        if (isPair(node) && isNode(node.key) && "value" in node.key && node.key.value === "<<") {
+            forbidden = "YAML merge keys are prohibited.";
+            return;
+        }
+        if (isMap(node) && node.items.length > 10_000) {
+            forbidden = "YAML mapping exceeds the supported size limit.";
+        }
+    });
+    return forbidden;
+}
+function frontmatterFromMarkdown(source, markdown) {
+    const yaml = findFrontmatter(markdown);
+    if (yaml === undefined) {
+        return hasOpeningYamlDelimiter(source)
+            ? {
+                endOffset: source.length,
+                kind: "invalid",
+                message: "YAML frontmatter is missing a closing delimiter."
+            }
+            : { endOffset: 0, kind: "absent" };
+    }
+    const endOffset = endOffsetAfterLineEnding(source, yaml, markdown.sourceOffset);
+    const document = parseDocument(yaml.value, {
+        customTags: [],
+        merge: false,
+        schema: "core",
+        uniqueKeys: true
+    });
+    const errors = [...document.errors, ...document.warnings];
+    if (errors.length > 0) {
+        return {
+            endOffset,
+            kind: "invalid",
+            message: errors
+                .slice(0, 4)
+                .map((error) => error.message)
+                .join("; ")
+                .slice(0, 1000)
+        };
+    }
+    const forbidden = forbiddenYamlFeature(document);
+    if (forbidden !== undefined) {
+        return { endOffset, kind: "invalid", message: forbidden };
+    }
+    return {
+        endOffset,
+        kind: "valid",
+        value: document.toJS({ maxAliasCount: 0 })
+    };
+}
+function headingsFromMarkdown(markdown) {
+    const headings = [];
+    visitMarkdown(markdown.tree, (node) => {
+        if (!isHeadingNode(node)) {
+            return;
+        }
+        headings.push({
+            depth: node.depth,
+            location: markdownPosition(node, markdown.sourceOffset),
+            text: toString(node)
+        });
+    });
+    return headings.toSorted((left, right) => left.location.offset - right.location.offset);
+}
+function githubAnchorObservation(headings) {
+    const slugger = new GithubSlugger();
+    return {
+        ids: headings.map((heading) => slugger.slug(heading.text)),
+        profile: "github"
+    };
+}
+function referenceFromNode(node, kind, rawTarget, sourceOffset) {
+    return {
+        kind,
+        location: markdownPosition(node, sourceOffset),
+        rawTarget
+    };
+}
+function collectReferenceNodes(markdown) {
+    const definitions = [];
+    const directReferences = [];
+    const referenceNodes = [];
+    visitMarkdown(markdown.tree, (node) => {
+        if (isDefinitionNode(node)) {
+            definitions.push(node);
+            return;
+        }
+        if (isUrlNode(node)) {
+            directReferences.push(referenceFromNode(node, node.type === "image" ? "image" : "link", node.url, markdown.sourceOffset));
+            return;
+        }
+        if (isReferenceNode(node)) {
+            referenceNodes.push(node);
+        }
+    });
+    return { definitions, directReferences, referenceNodes };
+}
+function referencesFromMarkdown(markdown) {
+    const { definitions, directReferences, referenceNodes } = collectReferenceNodes(markdown);
+    const effectiveDefinitions = new Map();
+    for (const definition of definitions) {
+        if (!effectiveDefinitions.has(definition.identifier)) {
+            effectiveDefinitions.set(definition.identifier, definition);
+        }
+    }
+    const referencedDefinitions = new Set();
+    const resolvedReferenceUsages = referenceNodes.flatMap((node) => {
+        const definition = effectiveDefinitions.get(node.identifier);
+        if (definition === undefined) {
+            return [];
+        }
+        referencedDefinitions.add(definition);
+        return [
+            referenceFromNode(node, node.type === "imageReference" ? "image" : "link", definition.url, markdown.sourceOffset)
+        ];
+    });
+    const unusedDefinitions = definitions.flatMap((definition) => {
+        if (effectiveDefinitions.get(definition.identifier) !== definition ||
+            referencedDefinitions.has(definition)) {
+            return [];
+        }
+        return [
+            referenceFromNode(definition, "definition", definition.url, markdown.sourceOffset)
+        ];
+    });
+    return [...directReferences, ...resolvedReferenceUsages, ...unusedDefinitions].toSorted((left, right) => left.location.offset - right.location.offset);
+}
+export function observeMarkdownDocument(repositoryPath, source) {
+    const markdown = parseMarkdown(source);
+    const headings = headingsFromMarkdown(markdown);
+    return {
+        anchorObservations: [githubAnchorObservation(headings)],
+        frontmatter: frontmatterFromMarkdown(source, markdown),
+        headings,
+        references: referencesFromMarkdown(markdown),
+        repositoryPath,
+        source
+    };
+}
+//# sourceMappingURL=markdown-document-parser.js.map

package/dist/documentation-observation/adapters/outbound/filesystem/markdown-document-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-document-parser.js","sourceRoot":"","sources":["../../../../../src/documentation-observation/adapters/outbound/filesystem/markdown-document-parser.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,iBAAiB,MAAM,oBAAoB,CAAC;AACnD,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EACL,OAAO,EACP,KAAK,EACL,MAAM,EACN,MAAM,EACN,aAAa,EACb,KAAK,IAAI,SAAS,EACnB,MAAM,MAAM,CAAC;AAWd,MAAM,cAAc,GAAG,OAAO,EAAE;KAC7B,GAAG,CAAC,WAAW,CAAC;KAChB,GAAG,CAAC,SAAS,CAAC;KACd,GAAG,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,CAAC;KAChC,MAAM,EAAE,CAAC;AAiDZ,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,MAAM,IAAI,KAAK;QACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAc,EAAE,QAAgB;IACnD,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,QAAQ,IAAI,KAAK;QACjB,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;QAChC,MAAM,IAAI,KAAK;QACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,QAAQ,IAAI,KAAK;QACjB,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CACjC,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,OAAO,IAAI,KAAK;QAChB,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;QACvB,KAAK,IAAI,KAAK;QACd,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CACtB,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,CACL,SAAS,CAAC,KAAK,CAAC;QAChB,KAAK,CAAC,IAAI,KAAK,YAAY;QAC3B,OAAO,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,QAAQ;QACpD,OAAO,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,QAAQ,CAC9C,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,CACL,SAAS,CAAC,KAAK,CAAC;QAChB,KAAK,CAAC,IAAI,KAAK,SAAS;QACxB,OAAO,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,QAAQ,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,OAAO,CACL,SAAS,CAAC,KAAK,CAAC;QAChB,CAAC,KAAK,CAAC,IAAI,KAAK,gBAAgB,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,CAAC;QACnE,OAAO,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,QAAQ,CACrD,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,CACL,SAAS,CAAC,KAAK,CAAC;QAChB,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC;QACjD,OAAO,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,QAAQ,CAC9C,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,QAAQ,CAAC;AACtG,CAAC;AAED,SAAS,aAAa,CAAC,MAAc;IACnC,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,OAAO;QACL,YAAY;QACZ,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,IAAa;IAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,CAAC,IAAI,0BAA0B,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAa,EAAE,YAAoB;IAC3D,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;IACtC,OAAO;QACL,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,YAAY;KACpC,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAC/B,MAAc,EACd,IAAa,EACb,YAAoB;IAEpB,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,YAAY,CAAC;IAC9D,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;QACzC,OAAO,SAAS,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACxE,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAc;IAC7C,MAAM,oBAAoB,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACpF,OAAO,wBAAwB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,eAAe,CAAC,QAAwB;IAC/C,IAAI,IAA6B,CAAC;IAClC,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;QACpC,IAAI,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnF,IAAI,GAAG,IAAI,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,oBAAoB,CAAC,QAA0C;IACtE,IAAI,SAA6B,CAAC;IAClC,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACjC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAClB,SAAS,GAAG,8BAA8B,CAAC;YAC3C,OAAO;QACT,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,CAAC,EAAE,CAAC;YAC1E,SAAS,GAAG,gDAAgD,CAAC;YAC7D,OAAO;QACT,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YACvF,SAAS,GAAG,iCAAiC,CAAC;YAC9C,OAAO;QACT,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;YAC9C,SAAS,GAAG,gDAAgD,CAAC;QAC/D,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,uBAAuB,CAC9B,MAAc,EACd,QAAwB;IAExB,MAAM,IAAI,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IACvC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,uBAAuB,CAAC,MAAM,CAAC;YACpC,CAAC,CAAC;gBACE,SAAS,EAAE,MAAM,CAAC,MAAM;gBACxB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,kDAAkD;aAC5D;YACH,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IACvC,CAAC;IAED,MAAM,SAAS,GAAG,wBAAwB,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;IAChF,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE;QACzC,UAAU,EAAE,EAAE;QACd,KAAK,EAAE,KAAK;QACZ,MAAM,EAAE,MAAM;QACd,UAAU,EAAE,IAAI;KACjB,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO;YACL,SAAS;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,MAAM;iBACZ,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;iBACX,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;iBAC7B,IAAI,CAAC,IAAI,CAAC;iBACV,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC;SAClB,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACjD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAC5D,CAAC;IACD,OAAO;QACL,SAAS;QACT,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,CAAY;KACtD,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAwB;IAExB,MAAM,QAAQ,GAAiC,EAAE,CAAC;IAClD,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;QACpC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC;YACvD,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1F,CAAC;AAED,SAAS,uBAAuB,CAC9B,QAA+C;IAE/C,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;IACpC,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1D,OAAO,EAAE,QAAQ;KAClB,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,IAAa,EACb,IAAqC,EACrC,SAAiB,EACjB,YAAoB;IAEpB,OAAO;QACL,IAAI;QACJ,QAAQ,EAAE,gBAAgB,CAAC,IAAI,EAAE,YAAY,CAAC;QAC9C,SAAS;KACV,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAwB;IAKrD,MAAM,WAAW,GAAwB,EAAE,CAAC;IAC5C,MAAM,gBAAgB,GAAmC,EAAE,CAAC;IAC5D,MAAM,cAAc,GAAuB,EAAE,CAAC;IAC9C,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;QACpC,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvB,OAAO;QACT,CAAC;QACD,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,gBAAgB,CAAC,IAAI,CACnB,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,YAAY,CAAC,CACnG,CAAC;YACF,OAAO;QACT,CAAC;QACD,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC;AAC3D,CAAC;AAED,SAAS,sBAAsB,CAC7B,QAAwB;IAExB,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC1F,MAAM,oBAAoB,GAAG,IAAI,GAAG,EAA6B,CAAC;IAClE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACrD,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED,MAAM,qBAAqB,GAAG,IAAI,GAAG,EAAqB,CAAC;IAC3D,MAAM,uBAAuB,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC9D,MAAM,UAAU,GAAG,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtC,OAAO;YACL,iBAAiB,CACf,IAAI,EACJ,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EACjD,UAAU,CAAC,GAAG,EACd,QAAQ,CAAC,YAAY,CACtB;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC3D,IACE,oBAAoB,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,UAAU;YAC9D,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,EACrC,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO;YACL,iBAAiB,CACf,UAAU,EACV,YAAY,EACZ,UAAU,CAAC,GAAG,EACd,QAAQ,CAAC,YAAY,CACtB;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,gBAAgB,EAAE,GAAG,uBAAuB,EAAE,GAAG,iBAAiB,CAAC,CAAC,QAAQ,CACrF,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAC9D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,cAAsB,EACtB,MAAc;IAEd,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAChD,OAAO;QACL,kBAAkB,EAAE,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QACvD,WAAW,EAAE,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC;QACtD,QAAQ;QACR,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC;QAC5C,cAAc;QACd,MAAM;KACP,CAAC;AACJ,CAAC"}

package/dist/documentation-observation/adapters/outbound/filesystem/markdown-reference-target.d.ts

@@ -0,0 +1,15 @@
+type UnsafeReferenceReason = "absolute-path" | "invalid-encoding";
+export type MarkdownReferenceTarget = {
+    readonly kind: "external";
+} | {
+    readonly kind: "local";
+    readonly fragment: string;
+    readonly target: string;
+} | {
+    readonly kind: "unsafe";
+    readonly reason: UnsafeReferenceReason;
+};
+export declare function parseMarkdownReferenceTarget(rawTarget: string): MarkdownReferenceTarget;
+export declare function stripMarkdownReferenceQuery(target: string): string;
+export {};
+//# sourceMappingURL=markdown-reference-target.d.ts.map

package/dist/documentation-observation/adapters/outbound/filesystem/markdown-reference-target.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-reference-target.d.ts","sourceRoot":"","sources":["../../../../../src/documentation-observation/adapters/outbound/filesystem/markdown-reference-target.ts"],"names":[],"mappings":"AAAA,KAAK,qBAAqB,GAAG,eAAe,GAAG,kBAAkB,CAAC;AAElE,MAAM,MAAM,uBAAuB,GAC/B;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;CAAE,GAC7B;IACE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;CACxC,CAAC;AAgDN,wBAAgB,4BAA4B,CAC1C,SAAS,EAAE,MAAM,GAChB,uBAAuB,CAiBzB;AAED,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAGlE"}

package/dist/documentation-observation/adapters/outbound/filesystem/markdown-reference-target.js

@@ -0,0 +1,59 @@
+function splitTargetAndFragment(rawTarget) {
+    let escapedCharacter = false;
+    for (let index = 0; index < rawTarget.length; index += 1) {
+        const character = rawTarget[index];
+        if (escapedCharacter) {
+            escapedCharacter = false;
+            continue;
+        }
+        if (character === "\\") {
+            escapedCharacter = true;
+            continue;
+        }
+        if (character === "#") {
+            return {
+                fragment: rawTarget.slice(index + 1),
+                target: rawTarget.slice(0, index)
+            };
+        }
+    }
+    return { fragment: "", target: rawTarget };
+}
+function decodeMarkdownDestination(value) {
+    try {
+        return decodeURIComponent(value.replace(/\\(.)/gu, "$1"));
+    }
+    catch {
+        return undefined;
+    }
+}
+function isExternalReference(target) {
+    return target.startsWith("//") || /^[A-Za-z][A-Za-z0-9+.-]*:/u.test(target);
+}
+function isFileOrDriveAbsoluteReference(target) {
+    return (target.toLowerCase().startsWith("file:") ||
+        /^[A-Za-z]:[\\/]/u.test(target));
+}
+export function parseMarkdownReferenceTarget(rawTarget) {
+    const split = splitTargetAndFragment(rawTarget);
+    const target = decodeMarkdownDestination(split.target);
+    const fragment = decodeMarkdownDestination(split.fragment);
+    if (target === undefined || fragment === undefined) {
+        return { kind: "unsafe", reason: "invalid-encoding" };
+    }
+    if (isFileOrDriveAbsoluteReference(target)) {
+        return { kind: "unsafe", reason: "absolute-path" };
+    }
+    if (isExternalReference(target)) {
+        return { kind: "external" };
+    }
+    if (target.includes("\\") || target.startsWith("/")) {
+        return { kind: "unsafe", reason: "absolute-path" };
+    }
+    return { fragment, kind: "local", target };
+}
+export function stripMarkdownReferenceQuery(target) {
+    const queryStart = target.indexOf("?");
+    return queryStart === -1 ? target : target.slice(0, queryStart);
+}
+//# sourceMappingURL=markdown-reference-target.js.map

package/dist/documentation-observation/adapters/outbound/filesystem/markdown-reference-target.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-reference-target.js","sourceRoot":"","sources":["../../../../../src/documentation-observation/adapters/outbound/filesystem/markdown-reference-target.ts"],"names":[],"mappings":"AAmBA,SAAS,sBAAsB,CAAC,SAAiB;IAC/C,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACzD,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,gBAAgB,EAAE,CAAC;YACrB,gBAAgB,GAAG,KAAK,CAAC;YACzB,SAAS;QACX,CAAC;QACD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACvB,gBAAgB,GAAG,IAAI,CAAC;YACxB,SAAS;QACX,CAAC;QACD,IAAI,SAAS,KAAK,GAAG,EAAE,CAAC;YACtB,OAAO;gBACL,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;gBACpC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;aAClC,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAC7C,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAa;IAC9C,IAAI,CAAC;QACH,OAAO,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAc;IACzC,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,4BAA4B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,8BAA8B,CAAC,MAAc;IACpD,OAAO,CACL,MAAM,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;QACxC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAChC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,SAAiB;IAEjB,MAAM,KAAK,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,yBAAyB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC3D,IAAI,MAAM,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;IACxD,CAAC;IACD,IAAI,8BAA8B,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3C,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;IACrD,CAAC;IACD,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACpD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;IACrD,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,MAAc;IACxD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;AAClE,CAAC"}

package/dist/documentation-observation/application/model/markdown-document.d.ts

@@ -0,0 +1,69 @@
+export type MarkdownAnchorProfile = "github" | "none";
+export type MarkdownReferenceKind = "definition" | "image" | "link";
+export interface MarkdownPosition {
+    readonly column: number;
+    readonly line: number;
+    readonly offset: number;
+}
+export interface MarkdownHeadingObservation {
+    readonly depth: number;
+    readonly location: MarkdownPosition;
+    readonly text: string;
+}
+export interface MarkdownAnchorObservation {
+    readonly ids: readonly string[];
+    readonly profile: MarkdownAnchorProfile;
+}
+export interface MarkdownReferenceObservation {
+    readonly kind: MarkdownReferenceKind;
+    readonly location: MarkdownPosition;
+    readonly rawTarget: string;
+}
+export type MarkdownFrontmatterObservation = {
+    readonly endOffset: 0;
+    readonly kind: "absent";
+} | {
+    readonly endOffset: number;
+    readonly kind: "invalid";
+    readonly message: string;
+} | {
+    readonly endOffset: number;
+    readonly kind: "valid";
+    readonly value: unknown;
+};
+export interface MarkdownDocumentObservation {
+    readonly anchorObservations: readonly MarkdownAnchorObservation[];
+    readonly frontmatter: MarkdownFrontmatterObservation;
+    readonly headings: readonly MarkdownHeadingObservation[];
+    readonly references: readonly MarkdownReferenceObservation[];
+    readonly repositoryPath: string;
+    readonly source: string;
+}
+export type MarkdownObservationIssueKind = "root-missing" | "root-not-directory" | "source-invalid" | "source-too-large" | "source-unreadable" | "symbolic-link";
+export interface MarkdownObservationIssue {
+    readonly kind: MarkdownObservationIssueKind;
+    readonly message: string;
+    readonly repositoryPath: string;
+}
+export interface MarkdownRepositoryObservation {
+    readonly documents: readonly MarkdownDocumentObservation[];
+    readonly issues: readonly MarkdownObservationIssue[];
+}
+export type MarkdownReferenceResolution = {
+    readonly kind: "external";
+} | {
+    readonly kind: "file";
+    readonly markdownDocument?: MarkdownDocumentObservation;
+    readonly repositoryPath: string;
+    readonly fragment: string;
+} | {
+    readonly kind: "missing";
+    readonly reason: "directory-readme-missing" | "target-missing";
+    readonly repositoryPath: string;
+} | {
+    readonly kind: "unsafe";
+    readonly reason: "absolute-path" | "invalid-encoding" | "repository-escape" | "symbolic-link";
+};
+export declare function anchorsForMarkdownDocument(document: MarkdownDocumentObservation, profile: MarkdownAnchorProfile): readonly string[];
+export declare function markdownSourceWithoutFrontmatter(document: MarkdownDocumentObservation): string;
+//# sourceMappingURL=markdown-document.d.ts.map

package/dist/documentation-observation/application/model/markdown-document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-document.d.ts","sourceRoot":"","sources":["../../../../src/documentation-observation/application/model/markdown-document.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEtD,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC;AAEpE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,GAAG,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC;CACzC;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAC;IACrC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,8BAA8B,GACtC;IACE,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB,GACD;IACE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,GACD;IACE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB,CAAC;AAEN,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,kBAAkB,EAAE,SAAS,yBAAyB,EAAE,CAAC;IAClE,QAAQ,CAAC,WAAW,EAAE,8BAA8B,CAAC;IACrD,QAAQ,CAAC,QAAQ,EAAE,SAAS,0BAA0B,EAAE,CAAC;IACzD,QAAQ,CAAC,UAAU,EAAE,SAAS,4BAA4B,EAAE,CAAC;IAC7D,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,4BAA4B,GACpC,cAAc,GACd,oBAAoB,GACpB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,CAAC;AAEpB,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,IAAI,EAAE,4BAA4B,CAAC;IAC5C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,2BAA2B,EAAE,CAAC;IAC3D,QAAQ,CAAC,MAAM,EAAE,SAAS,wBAAwB,EAAE,CAAC;CACtD;AAED,MAAM,MAAM,2BAA2B,GACnC;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,2BAA2B,CAAC;IACxD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,0BAA0B,GAAG,gBAAgB,CAAC;IAC/D,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,MAAM,EACX,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,CAAC;CACrB,CAAC;AAEN,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,2BAA2B,EACrC,OAAO,EAAE,qBAAqB,GAC7B,SAAS,MAAM,EAAE,CAMnB;AAED,wBAAgB,gCAAgC,CAC9C,QAAQ,EAAE,2BAA2B,GACpC,MAAM,CAER"}

package/dist/documentation-observation/application/model/markdown-document.js

@@ -0,0 +1,10 @@
+export function anchorsForMarkdownDocument(document, profile) {
+    if (profile === "none") {
+        return [];
+    }
+    return document.anchorObservations.find((observation) => observation.profile === profile)?.ids ?? [];
+}
+export function markdownSourceWithoutFrontmatter(document) {
+    return document.source.slice(document.frontmatter.endOffset);
+}
+//# sourceMappingURL=markdown-document.js.map

package/dist/documentation-observation/application/model/markdown-document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-document.js","sourceRoot":"","sources":["../../../../src/documentation-observation/application/model/markdown-document.ts"],"names":[],"mappings":"AA+FA,MAAM,UAAU,0BAA0B,CACxC,QAAqC,EACrC,OAA8B;IAE9B,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,OAAO,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;AACvG,CAAC;AAED,MAAM,UAAU,gCAAgC,CAC9C,QAAqC;IAErC,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;AAC/D,CAAC"}

package/dist/documentation-observation/application/ports/markdown-repository.d.ts

@@ -0,0 +1,18 @@
+import type { MarkdownDocumentObservation, MarkdownReferenceResolution, MarkdownRepositoryObservation } from "../model/markdown-document.js";
+export interface ObserveMarkdownRepositoryRequest {
+    readonly consumerRoot: string;
+    readonly excludedPrefixes?: readonly string[];
+    readonly roots: readonly string[];
+    readonly signal?: AbortSignal;
+}
+export interface ResolveMarkdownReferenceRequest {
+    readonly consumerRoot: string;
+    readonly rawTarget: string;
+    readonly signal?: AbortSignal;
+    readonly source: MarkdownDocumentObservation;
+}
+export interface MarkdownRepository {
+    observe(request: ObserveMarkdownRepositoryRequest): Promise<MarkdownRepositoryObservation>;
+    resolveReference(request: ResolveMarkdownReferenceRequest): Promise<MarkdownReferenceResolution>;
+}
+//# sourceMappingURL=markdown-repository.d.ts.map

package/dist/documentation-observation/application/ports/markdown-repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-repository.d.ts","sourceRoot":"","sources":["../../../../src/documentation-observation/application/ports/markdown-repository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC9B,MAAM,+BAA+B,CAAC;AAEvC,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9C,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,2BAA2B,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CACL,OAAO,EAAE,gCAAgC,GACxC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C,gBAAgB,CACd,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,2BAA2B,CAAC,CAAC;CACzC"}

package/dist/documentation-observation/application/ports/markdown-repository.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=markdown-repository.js.map

package/dist/documentation-observation/application/ports/markdown-repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-repository.js","sourceRoot":"","sources":["../../../../src/documentation-observation/application/ports/markdown-repository.ts"],"names":[],"mappings":""}

package/dist/errors.d.ts

@@ -0,0 +1,6 @@
+export type DocumentAuthoringErrorCode = "CONSUMER_INVALID";
+export declare class DocumentAuthoringError extends Error {
+    readonly code: DocumentAuthoringErrorCode;
+    constructor(code: DocumentAuthoringErrorCode, message: string, options?: ErrorOptions);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;AAE5D,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,QAAQ,CAAC,IAAI,EAAE,0BAA0B,CAAC;IAE1C,YAAY,IAAI,EAAE,0BAA0B,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAIpF;CACF"}

package/dist/errors.js

@@ -0,0 +1,9 @@
+export class DocumentAuthoringError extends Error {
+    code;
+    constructor(code, message, options) {
+        super(message, options);
+        this.name = "DocumentAuthoringError";
+        this.code = code;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IACtC,IAAI,CAA6B;IAE1C,YAAY,IAAgC,EAAE,OAAe,EAAE,OAAsB;QACnF,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}

package/dist/filesystem-path-safety.d.ts

@@ -0,0 +1,11 @@
+export type ContainedFileReadFailure = "changed" | "escape" | "invalid" | "missing" | "symlink" | "unavailable";
+export declare class ContainedFileReadError extends Error {
+    readonly failure: ContainedFileReadFailure;
+    constructor(kind: ContainedFileReadFailure);
+}
+export declare function readContainedRegularFile(input: {
+    readonly candidate: string;
+    readonly maxBytes: number;
+    readonly root: string;
+}): Promise<Buffer>;
+//# sourceMappingURL=filesystem-path-safety.d.ts.map

package/dist/filesystem-path-safety.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesystem-path-safety.d.ts","sourceRoot":"","sources":["../src/filesystem-path-safety.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,wBAAwB,GAChC,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,CAAC;AAE7E,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,QAAQ,CAAC,OAAO,EAAE,wBAAwB,CAAC;IAC3C,YAAY,IAAI,EAAE,wBAAwB,EAIzC;CACF;AA8ED,wBAAsB,wBAAwB,CAAC,KAAK,EAAE;IACpD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC,MAAM,CAAC,CA2BlB"}

package/dist/filesystem-path-safety.js

@@ -0,0 +1,122 @@
+import { constants } from "node:fs";
+import { lstat, open, realpath, stat } from "node:fs/promises";
+import { isAbsolute, join, relative, resolve, sep } from "node:path";
+export class ContainedFileReadError extends Error {
+    failure;
+    constructor(kind) {
+        super(`Contained file read failed: ${kind}.`);
+        this.name = "ContainedFileReadError";
+        this.failure = kind;
+    }
+}
+function code(error) {
+    return typeof error === "object" && error !== null && "code" in error
+        ? String(error.code) : undefined;
+}
+function contained(root, candidate) {
+    const relation = relative(root, candidate);
+    return relation === "" || (!isAbsolute(relation) && relation !== ".." &&
+        !relation.startsWith(`..${sep}`));
+}
+function failure(error, afterOpen) {
+    if (error instanceof ContainedFileReadError) {
+        return error;
+    }
+    const observed = code(error);
+    if (observed === "ELOOP") {
+        return new ContainedFileReadError("symlink");
+    }
+    if (observed === "ENOENT" || observed === "ENOTDIR") {
+        return new ContainedFileReadError(afterOpen ? "changed" : "missing");
+    }
+    if (observed === "EISDIR") {
+        return new ContainedFileReadError("invalid");
+    }
+    return new ContainedFileReadError("unavailable");
+}
+async function assertNoSymlinks(root, candidate) {
+    if (!contained(root, candidate)) {
+        throw new ContainedFileReadError("escape");
+    }
+    let current = root;
+    for (const segment of relative(root, candidate).split(sep).filter(Boolean)) {
+        current = join(current, segment);
+        let metadata;
+        try {
+            metadata = await lstat(current);
+        }
+        catch (error) {
+            throw failure(error, false);
+        }
+        if (metadata.isSymbolicLink()) {
+            throw new ContainedFileReadError("symlink");
+        }
+    }
+}
+async function readStableFile(handle, root, candidate, maxBytes) {
+    const before = await handle.stat({ bigint: true });
+    if (!before.isFile() || before.size < 0n || before.size > BigInt(maxBytes)) {
+        throw new ContainedFileReadError("invalid");
+    }
+    const bytes = Buffer.alloc(Number(before.size));
+    let offset = 0;
+    while (offset < bytes.length) {
+        const result = await handle.read(bytes, offset, bytes.length - offset, offset);
+        if (result.bytesRead === 0) {
+            break;
+        }
+        offset += result.bytesRead;
+    }
+    const after = await handle.stat({ bigint: true });
+    await assertNoSymlinks(root, candidate);
+    const named = await stat(await realpath(candidate), { bigint: true });
+    const same = before.dev === after.dev && before.ino === after.ino &&
+        before.size === after.size && before.mtimeNs === after.mtimeNs &&
+        before.ctimeNs === after.ctimeNs && before.dev === named.dev &&
+        before.ino === named.ino && before.size === named.size && offset === bytes.length;
+    if (!same) {
+        throw new ContainedFileReadError("changed");
+    }
+    return bytes;
+}
+export async function readContainedRegularFile(input) {
+    if (!Number.isSafeInteger(input.maxBytes) || input.maxBytes < 0) {
+        throw new ContainedFileReadError("invalid");
+    }
+    const lexicalRoot = resolve(input.root);
+    const lexicalCandidate = resolve(input.candidate);
+    if (!contained(lexicalRoot, lexicalCandidate)) {
+        throw new ContainedFileReadError("escape");
+    }
+    let root;
+    try {
+        root = await realpath(lexicalRoot);
+        if (!(await stat(root)).isDirectory()) {
+            throw new ContainedFileReadError("invalid");
+        }
+    }
+    catch (error) {
+        throw failure(error, false);
+    }
+    const candidate = resolve(root, relative(lexicalRoot, lexicalCandidate));
+    await assertNoSymlinks(root, candidate);
+    const flags = constants.O_RDONLY |
+        (process.platform === "win32" ? 0 : constants.O_NOFOLLOW | constants.O_NONBLOCK);
+    let handle;
+    try {
+        handle = await open(candidate, flags);
+    }
+    catch (error) {
+        throw failure(error, false);
+    }
+    try {
+        return await readStableFile(handle, root, candidate, input.maxBytes);
+    }
+    catch (error) {
+        throw failure(error, true);
+    }
+    finally {
+        await handle.close().catch(() => { });
+    }
+}
+//# sourceMappingURL=filesystem-path-safety.js.map