@agent-teams/engineering-foundation 0.4.1 → 0.6.0

package/dist/documentation-observation/adapters/outbound/filesystem/filesystem-markdown-tree-observer.js

@@ -0,0 +1,233 @@
+import { extname, resolve } from "node:path";
+import { compareBinaryStrings } from "../../../../binary-string-comparator.js";
+import { CapabilityInputError } from "../../../../capability-runtime.js";
+import { assertNotCancelled } from "../../../../strict-yaml.js";
+import { FilesystemMarkdownDocumentReader, MAX_MARKDOWN_BYTES } from "./filesystem-markdown-document-reader.js";
+import { isMissingMarkdownFilesystemError, markdownPathTraversesSymbolicLink, nodeFilesystemMarkdownOperations, throwMarkdownFilesystemUnavailable } from "./filesystem-markdown-filesystem.js";
+import { createFilesystemMarkdownRepositoryContext, isWithinMarkdownRepository, markdownRepositoryPath } from "./filesystem-markdown-paths.js";
+const SKIPPED_DIRECTORY_NAMES = new Set([".git", "node_modules"]);
+const MAX_MARKDOWN_DOCUMENTS = 10_000;
+const MAX_MARKDOWN_ISSUES = 10_000;
+const MAX_MARKDOWN_REFERENCES = 100_000;
+const MAX_MARKDOWN_TOTAL_BYTES = 32 * 1024 * 1024;
+function resourceLimit(message) {
+    throw new CapabilityInputError({
+        code: "DOCUMENTATION_RESOURCE_LIMIT_EXCEEDED",
+        message,
+        phase: "documentation-observation",
+        retryable: false
+    });
+}
+function addIssue(collector, issue) {
+    if (collector.issues.length >= MAX_MARKDOWN_ISSUES) {
+        resourceLimit(`Markdown observation exceeds ${MAX_MARKDOWN_ISSUES} issues.`);
+    }
+    collector.issues.push(issue);
+}
+async function walkConfiguredRoot(walk, root) {
+    const { collector, filesystem, repository: context, signal } = walk;
+    const absoluteRoot = resolve(context.canonicalRoot, root);
+    if (!isWithinMarkdownRepository(context.canonicalRoot, absoluteRoot)) {
+        addIssue(collector, {
+            kind: "symbolic-link",
+            message: "Configured Markdown root escapes the consumer repository.",
+            repositoryPath: root
+        });
+        return;
+    }
+    if (await markdownPathTraversesSymbolicLink(context.canonicalRoot, absoluteRoot, filesystem, signal)) {
+        addIssue(collector, {
+            kind: "symbolic-link",
+            message: "Configured Markdown root traverses a symbolic link.",
+            repositoryPath: root
+        });
+        return;
+    }
+    let metadata;
+    try {
+        metadata = await filesystem.lstat(absoluteRoot);
+    }
+    catch (error) {
+        assertNotCancelled(signal);
+        if (isMissingMarkdownFilesystemError(error)) {
+            addIssue(collector, {
+                kind: "root-missing",
+                message: "Configured Markdown root does not exist.",
+                repositoryPath: root
+            });
+            return;
+        }
+        throwMarkdownFilesystemUnavailable(error, "inspecting a configured Markdown root");
+    }
+    assertNotCancelled(signal);
+    if (metadata.isSymbolicLink()) {
+        addIssue(collector, {
+            kind: "symbolic-link",
+            message: "Configured Markdown root must not be a symbolic link.",
+            repositoryPath: root
+        });
+        return;
+    }
+    if (!metadata.isDirectory()) {
+        addIssue(collector, {
+            kind: "root-not-directory",
+            message: "Configured Markdown root must be a directory.",
+            repositoryPath: root
+        });
+        return;
+    }
+    await walkDirectory(walk, absoluteRoot, root);
+}
+async function inspectDirectoryEntry(walk, candidate) {
+    const { collector, filesystem, reader, repository: context, signal } = walk;
+    const candidateRepositoryPath = markdownRepositoryPath(context.canonicalRoot, candidate);
+    if (collector.documents.has(candidateRepositoryPath)) {
+        return;
+    }
+    let metadata;
+    try {
+        metadata = await filesystem.lstat(candidate);
+    }
+    catch (error) {
+        assertNotCancelled(signal);
+        if (isMissingMarkdownFilesystemError(error)) {
+            return;
+        }
+        throwMarkdownFilesystemUnavailable(error, "inspecting a Markdown source entry");
+    }
+    assertNotCancelled(signal);
+    if (metadata.isSymbolicLink()) {
+        addIssue(collector, {
+            kind: "symbolic-link",
+            message: "Markdown source tree must not contain symbolic links.",
+            repositoryPath: candidateRepositoryPath
+        });
+        return;
+    }
+    if (metadata.isDirectory()) {
+        await walkDirectory(walk, candidate);
+        return;
+    }
+    if (!metadata.isFile() || extname(candidate).toLowerCase() !== ".md") {
+        return;
+    }
+    if (metadata.size > MAX_MARKDOWN_BYTES) {
+        addIssue(collector, {
+            kind: "source-too-large",
+            message: `Markdown source exceeds ${MAX_MARKDOWN_BYTES} bytes.`,
+            repositoryPath: candidateRepositoryPath
+        });
+        return;
+    }
+    const estimatedDocumentBytes = collector.estimatedDocumentBytes + metadata.size;
+    if (collector.documents.size >= MAX_MARKDOWN_DOCUMENTS ||
+        estimatedDocumentBytes > MAX_MARKDOWN_TOTAL_BYTES) {
+        resourceLimit(`Markdown observation exceeds ${MAX_MARKDOWN_DOCUMENTS} documents or ${MAX_MARKDOWN_TOTAL_BYTES} bytes.`);
+    }
+    const document = await reader.read(context, candidate, signal);
+    if (document === undefined) {
+        try {
+            await filesystem.lstat(candidate);
+        }
+        catch (error) {
+            assertNotCancelled(signal);
+            if (isMissingMarkdownFilesystemError(error)) {
+                return;
+            }
+            throwMarkdownFilesystemUnavailable(error, "rechecking a Markdown source entry");
+        }
+        assertNotCancelled(signal);
+        addIssue(collector, {
+            kind: "source-unreadable",
+            message: "Markdown source could not be read.",
+            repositoryPath: candidateRepositoryPath
+        });
+        return;
+    }
+    const nextDocumentBytes = collector.documentBytes + Buffer.byteLength(document.source, "utf8");
+    if (nextDocumentBytes > MAX_MARKDOWN_TOTAL_BYTES) {
+        resourceLimit(`Markdown observation exceeds ${MAX_MARKDOWN_TOTAL_BYTES} bytes after contained reads.`);
+    }
+    const nextReferenceCount = collector.documentReferences + document.references.length;
+    if (nextReferenceCount > MAX_MARKDOWN_REFERENCES) {
+        resourceLimit(`Markdown observation exceeds ${MAX_MARKDOWN_REFERENCES} references.`);
+    }
+    collector.documentBytes = nextDocumentBytes;
+    collector.documentReferences = nextReferenceCount;
+    collector.estimatedDocumentBytes = estimatedDocumentBytes;
+    collector.documents.set(document.repositoryPath, document);
+}
+async function walkDirectory(walk, directory, configuredRoot) {
+    const { collector, filesystem, signal } = walk;
+    assertNotCancelled(signal);
+    if (await markdownPathTraversesSymbolicLink(walk.repository.canonicalRoot, directory, filesystem, signal)) {
+        addIssue(collector, {
+            kind: "symbolic-link",
+            message: "Markdown source directory became a symbolic link during observation.",
+            repositoryPath: markdownRepositoryPath(walk.repository.canonicalRoot, directory)
+        });
+        return;
+    }
+    let entries;
+    try {
+        entries = await filesystem.readdir(directory, { withFileTypes: true });
+    }
+    catch (error) {
+        assertNotCancelled(signal);
+        if (isMissingMarkdownFilesystemError(error)) {
+            if (configuredRoot !== undefined) {
+                addIssue(collector, {
+                    kind: "root-missing",
+                    message: "Configured Markdown root does not exist.",
+                    repositoryPath: configuredRoot
+                });
+            }
+            return;
+        }
+        throwMarkdownFilesystemUnavailable(error, "reading a Markdown source directory");
+    }
+    assertNotCancelled(signal);
+    if (await markdownPathTraversesSymbolicLink(walk.repository.canonicalRoot, directory, filesystem, signal)) {
+        addIssue(collector, {
+            kind: "symbolic-link",
+            message: "Markdown source directory changed during observation.",
+            repositoryPath: markdownRepositoryPath(walk.repository.canonicalRoot, directory)
+        });
+        return;
+    }
+    for (const entry of entries.toSorted((left, right) => compareBinaryStrings(left.name, right.name))) {
+        assertNotCancelled(signal);
+        if (!SKIPPED_DIRECTORY_NAMES.has(entry.name)) {
+            await inspectDirectoryEntry(walk, resolve(directory, entry.name));
+        }
+    }
+}
+export async function observeFilesystemMarkdownTree(request, reader, filesystem = nodeFilesystemMarkdownOperations) {
+    assertNotCancelled(request.signal);
+    reader.reset();
+    const context = await createFilesystemMarkdownRepositoryContext(request.consumerRoot, filesystem, request.signal);
+    assertNotCancelled(request.signal);
+    const collector = {
+        documentBytes: 0,
+        documentReferences: 0,
+        estimatedDocumentBytes: 0,
+        documents: new Map(),
+        issues: []
+    };
+    const walk = {
+        collector,
+        filesystem,
+        reader,
+        repository: context,
+        ...(request.signal === undefined ? {} : { signal: request.signal })
+    };
+    for (const root of request.roots.toSorted()) {
+        await walkConfiguredRoot(walk, root);
+    }
+    return {
+        documents: [...collector.documents.values()].toSorted((left, right) => compareBinaryStrings(left.repositoryPath, right.repositoryPath)),
+        issues: collector.issues.toSorted((left, right) => compareBinaryStrings(left.repositoryPath, right.repositoryPath) ||
+            compareBinaryStrings(left.kind, right.kind))
+    };
+}
+//# sourceMappingURL=filesystem-markdown-tree-observer.js.map

package/dist/documentation-observation/adapters/outbound/filesystem/filesystem-markdown-tree-observer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesystem-markdown-tree-observer.js","sourceRoot":"","sources":["../../../../../src/documentation-observation/adapters/outbound/filesystem/filesystem-markdown-tree-observer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAOhE,OAAO,EACL,gCAAgC,EAChC,kBAAkB,EACnB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EACL,gCAAgC,EAChC,iCAAiC,EACjC,gCAAgC,EAChC,kCAAkC,EAEnC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,yCAAyC,EACzC,0BAA0B,EAC1B,sBAAsB,EAEvB,MAAM,gCAAgC,CAAC;AAExC,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;AAClE,MAAM,sBAAsB,GAAG,MAAM,CAAC;AACtC,MAAM,mBAAmB,GAAG,MAAM,CAAC;AACnC,MAAM,uBAAuB,GAAG,OAAO,CAAC;AACxC,MAAM,wBAAwB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAUlD,SAAS,aAAa,CAAC,OAAe;IACpC,MAAM,IAAI,oBAAoB,CAAC;QAC7B,IAAI,EAAE,uCAAuC;QAC7C,OAAO;QACP,KAAK,EAAE,2BAA2B;QAClC,SAAS,EAAE,KAAK;KACjB,CAAC,CAAC;AACL,CAAC;AAUD,SAAS,QAAQ,CACf,SAA2C,EAC3C,KAA+B;IAE/B,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,IAAI,mBAAmB,EAAE,CAAC;QACnD,aAAa,CAAC,gCAAgC,mBAAmB,UAAU,CAAC,CAAC;IAC/E,CAAC;IACD,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC/B,IAA6B,EAC7B,IAAY;IAEZ,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACpE,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAC1D,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC;QACrE,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,2DAA2D;YACpE,cAAc,EAAE,IAAI;SACrB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IACE,MAAM,iCAAiC,CACrC,OAAO,CAAC,aAAa,EACrB,YAAY,EACZ,UAAU,EACV,MAAM,CACP,EACD,CAAC;QACD,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,qDAAqD;YAC9D,cAAc,EAAE,IAAI;SACrB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,IAAI,QAAQ,CAAC;IACb,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,gCAAgC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,QAAQ,CAAC,SAAS,EAAE;gBAClB,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,0CAA0C;gBACnD,cAAc,EAAE,IAAI;aACrB,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,kCAAkC,CAAC,KAAK,EAAE,uCAAuC,CAAC,CAAC;IACrF,CAAC;IACD,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC3B,IAAI,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC;QAC9B,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,uDAAuD;YAChE,cAAc,EAAE,IAAI;SACrB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QAC5B,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,+CAA+C;YACxD,cAAc,EAAE,IAAI;SACrB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,MAAM,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;AAChD,CAAC;AAED,KAAK,UAAU,qBAAqB,CAClC,IAA6B,EAC7B,SAAiB;IAEjB,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC5E,MAAM,uBAAuB,GAAG,sBAAsB,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IACzF,IAAI,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACrD,OAAO;IACT,CAAC;IACD,IAAI,QAAQ,CAAC;IACb,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,gCAAgC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;QACD,kCAAkC,CAAC,KAAK,EAAE,oCAAoC,CAAC,CAAC;IAClF,CAAC;IACD,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC3B,IAAI,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC;QAC9B,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,uDAAuD;YAChE,cAAc,EAAE,uBAAuB;SACxC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QAC3B,MAAM,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACrC,OAAO;IACT,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE,CAAC;QACrE,OAAO;IACT,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,GAAG,kBAAkB,EAAE,CAAC;QACvC,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,2BAA2B,kBAAkB,SAAS;YAC/D,cAAc,EAAE,uBAAuB;SACxC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,MAAM,sBAAsB,GAAG,SAAS,CAAC,sBAAsB,GAAG,QAAQ,CAAC,IAAI,CAAC;IAChF,IACE,SAAS,CAAC,SAAS,CAAC,IAAI,IAAI,sBAAsB;QAClD,sBAAsB,GAAG,wBAAwB,EACjD,CAAC;QACD,aAAa,CACX,gCAAgC,sBAAsB,iBAAiB,wBAAwB,SAAS,CACzG,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC3B,IAAI,gCAAgC,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5C,OAAO;YACT,CAAC;YACD,kCAAkC,CAAC,KAAK,EAAE,oCAAoC,CAAC,CAAC;QAClF,CAAC;QACD,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,oCAAoC;YAC7C,cAAc,EAAE,uBAAuB;SACxC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,MAAM,iBAAiB,GACrB,SAAS,CAAC,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvE,IAAI,iBAAiB,GAAG,wBAAwB,EAAE,CAAC;QACjD,aAAa,CACX,gCAAgC,wBAAwB,+BAA+B,CACxF,CAAC;IACJ,CAAC;IACD,MAAM,kBAAkB,GACtB,SAAS,CAAC,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;IAC5D,IAAI,kBAAkB,GAAG,uBAAuB,EAAE,CAAC;QACjD,aAAa,CACX,gCAAgC,uBAAuB,cAAc,CACtE,CAAC;IACJ,CAAC;IACD,SAAS,CAAC,aAAa,GAAG,iBAAiB,CAAC;IAC5C,SAAS,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAClD,SAAS,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;IAC1D,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;AAC7D,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,IAA6B,EAC7B,SAAiB,EACjB,cAAuB;IAEvB,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAC/C,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC3B,IACE,MAAM,iCAAiC,CACrC,IAAI,CAAC,UAAU,CAAC,aAAa,EAC7B,SAAS,EACT,UAAU,EACV,MAAM,CACP,EACD,CAAC;QACD,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,sEAAsE;YAC/E,cAAc,EAAE,sBAAsB,CACpC,IAAI,CAAC,UAAU,CAAC,aAAa,EAC7B,SAAS,CACV;SACF,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,gCAAgC,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;gBACjC,QAAQ,CAAC,SAAS,EAAE;oBAClB,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,0CAA0C;oBACnD,cAAc,EAAE,cAAc;iBAC/B,CAAC,CAAC;YACL,CAAC;YACD,OAAO;QACT,CAAC;QACD,kCAAkC,CAAC,KAAK,EAAE,qCAAqC,CAAC,CAAC;IACnF,CAAC;IACD,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC3B,IACE,MAAM,iCAAiC,CACrC,IAAI,CAAC,UAAU,CAAC,aAAa,EAC7B,SAAS,EACT,UAAU,EACV,MAAM,CACP,EACD,CAAC;QACD,QAAQ,CAAC,SAAS,EAAE;YAClB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,uDAAuD;YAChE,cAAc,EAAE,sBAAsB,CACpC,IAAI,CAAC,UAAU,CAAC,aAAa,EAC7B,SAAS,CACV;SACF,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACnD,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAC5C,EAAE,CAAC;QACF,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC3B,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,MAAM,qBAAqB,CACzB,IAAI,EACJ,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAC/B,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,OAAyC,EACzC,MAAwC,EACxC,UAAU,GAAiC,gCAAgC;IAE3E,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,CAAC,KAAK,EAAE,CAAC;IACf,MAAM,OAAO,GAAG,MAAM,yCAAyC,CAC7D,OAAO,CAAC,YAAY,EACpB,UAAU,EACV,OAAO,CAAC,MAAM,CACf,CAAC;IACF,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,SAAS,GAAqC;QAClD,aAAa,EAAE,CAAC;QAChB,kBAAkB,EAAE,CAAC;QACrB,sBAAsB,EAAE,CAAC;QACzB,SAAS,EAAE,IAAI,GAAG,EAAE;QACpB,MAAM,EAAE,EAAE;KACX,CAAC;IACF,MAAM,IAAI,GAA4B;QACpC,SAAS;QACT,UAAU;QACV,MAAM;QACN,UAAU,EAAE,OAAO;QACnB,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;KACpE,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC5C,MAAM,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,OAAO;QACL,SAAS,EAAE,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACpE,oBAAoB,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,CAChE;QACD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAChD,oBAAoB,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC;YAC/D,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAC5C;KACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,3 @@
+import type { MarkdownDocumentObservation } from "../../../application/model/markdown-document.js";
+export declare function observeMarkdownDocument(repositoryPath: string, source: string): MarkdownDocumentObservation;
+//# sourceMappingURL=markdown-document-parser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-document-parser.d.ts","sourceRoot":"","sources":["../../../../../src/documentation-observation/adapters/outbound/filesystem/markdown-document-parser.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAEV,2BAA2B,EAK5B,MAAM,iDAAiD,CAAC;AAgXzD,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,GACb,2BAA2B,CAW7B"}

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"}