@equinor/fusion-framework-cli-plugin-ai-index 1.0.6 → 2.0.0

package/dist/esm/utils/git/status.js

@@ -1,8 +1,14 @@
 import { resolveProjectRoot, getGit } from './git-client.js';
 /**
- * Get git status information for debugging
- * @param cwd - Working directory
- * @returns Git status information
+ * Retrieves a summary of the current git working-tree status.
+ *
+ * Returns the current branch name, abbreviated HEAD commit, and counts of
+ * staged / unstaged changes. Useful for informational output in CLI commands.
+ *
+ * @param cwd - Working directory for git operations. Defaults to `process.cwd()`.
+ * @returns An object with branch, commit, and file-change counts.
+ * @throws {Error} If the working directory is not inside a git repository or
+ *   the git client cannot be initialised.
  */
 export const getGitStatus = async (cwd = process.cwd()) => {
     const projectRoot = resolveProjectRoot(cwd);

package/dist/esm/utils/git/status.js.map

@@ -1 +1 @@
-{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../../src/utils/git/status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,MAAc,OAAO,CAAC,GAAG,EAAE,EAO1B,EAAE;IACH,MAAM,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAClC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QAEvD,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC;QACxC,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;QAC/C,MAAM,aAAa,GACjB,YAAY,CAAC,QAAQ,CAAC,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC;QAE7F,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE;YACrB,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE;YACrB,UAAU,EAAE,WAAW,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC;YAChD,WAAW;YACX,aAAa;SACd,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACtF,CAAC;IACJ,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../../src/utils/git/status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,MAAc,OAAO,CAAC,GAAG,EAAE,EAO1B,EAAE;IACH,MAAM,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAClC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QAEvD,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC;QACxC,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;QAC/C,MAAM,aAAa,GACjB,YAAY,CAAC,QAAQ,CAAC,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC;QAE7F,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE;YACrB,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE;YACrB,UAAU,EAAE,WAAW,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC;YAChD,WAAW;YACX,aAAa;SACd,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACtF,CAAC;IACJ,CAAC;AACH,CAAC,CAAC"}

package/dist/esm/utils/markdown/parser.js

@@ -4,9 +4,8 @@ import { default as grayMatter } from 'gray-matter';
 import { RecursiveCharacterTextSplitter } from '@langchain/textsplitters';
 import { generateChunkId } from '../generate-chunk-id.js';
 const markdownConfig = {
-    chunkSize: 3000,
+    chunkSize: 2000,
     chunkOverlap: 300,
-    keepSeparator: true,
     separators: [
         '\n# ',
         '\n## ',
@@ -15,23 +14,51 @@ const markdownConfig = {
         '\n##### ',
         '\n###### ',
         '\n```',
+        '\n```\n',
         '\n---\n',
         '\n\n',
+        '\n',
     ],
+    keepSeparator: true,
 };
 /**
- * Check if a file is a markdown or MDX file
- * @param filePath - File path to check
- * @returns True if file has .md or .mdx extension
+ * Checks whether a file path has a Markdown (`.md`) or MDX (`.mdx`) extension.
+ *
+ * @param filePath - Absolute or relative file path.
+ * @returns `true` when the extension is `.md` or `.mdx`.
  */
 export const isMarkdownFile = (filePath) => {
     return filePath.endsWith('.md') || filePath.endsWith('.mdx');
 };
 /**
- * Parse markdown or MDX content into document chunks
- * @param content - Markdown or MDX content string
- * @param source - Source file path
- * @returns Array of markdown documents
+ * Validates that a text chunk contains meaningful content.
+ *
+ * Filters out empty strings and chunks consisting solely of code-fence
+ * markers (e.g. ` ``` ` or ` ```ts `).
+ *
+ * @param chunk - Content chunk to validate.
+ * @returns `true` if the chunk has substantive content.
+ */
+const isValidChunk = (chunk) => {
+    const trimmed = chunk.trim();
+    if (!trimmed)
+        return false;
+    // Skip chunks that are only code fence markers
+    if (/^`{3,}[\w-]*$/.test(trimmed))
+        return false;
+    return true;
+};
+/**
+ * Parses Markdown or MDX content into chunked vector-store documents.
+ *
+ * Extracts YAML frontmatter via `gray-matter`, splits the body using
+ * {@link RecursiveCharacterTextSplitter}, and returns one
+ * {@link MarkdownDocument} per valid chunk.
+ *
+ * @template T - Additional frontmatter attributes.
+ * @param content - Raw Markdown / MDX string.
+ * @param source - Relative source file path used as the document key.
+ * @returns Array of chunked Markdown documents.
  */
 export const parseMarkdown = async (content, source) => {
     const { content: markdownContent, data } = grayMatter(content);
@@ -43,7 +70,14 @@ export const parseMarkdown = async (content, source) => {
     });
     const textSplitter = new RecursiveCharacterTextSplitter(markdownConfig);
     const chunks = await textSplitter.splitText(markdownContent);
-    return chunks.map((chunk, _index) => ({
+    // Filter out empty chunks and chunks that are just code fence markers
+    const validChunks = chunks.filter((chunk) => {
+        if (!isValidChunk(chunk)) {
+            return false;
+        }
+        return true;
+    });
+    return validChunks.map((chunk, _index) => ({
         id: generateChunkId(source, _index),
         pageContent: chunk,
         metadata: {
@@ -53,9 +87,15 @@ export const parseMarkdown = async (content, source) => {
     }));
 };
 /**
- * Parse a markdown or MDX file into document chunks
- * @param file - Source file object
- * @returns Array of markdown documents with root path metadata
+ * Reads a Markdown or MDX file from disk and parses it into chunked documents.
+ *
+ * Delegates to {@link parseMarkdown} after reading the file content, then
+ * enriches each resulting document with the `rootPath` from the source file.
+ *
+ * @template T - Additional frontmatter attributes.
+ * @param file - Source file descriptor with path and optional project root.
+ * @returns Array of Markdown documents with root-path metadata.
+ * @throws {AssertionError} If the file does not have a `.md` or `.mdx` extension.
  */
 export const parseMarkdownFile = async (file) => {
     assert(isMarkdownFile(file.path), `File ${file.path} is not a markdown or MDX file`);

package/dist/esm/utils/markdown/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../../src/utils/markdown/parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAI1E,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,cAAc,GAAG;IACrB,SAAS,EAAE,IAAI;IACf,YAAY,EAAE,GAAG;IACjB,aAAa,EAAE,IAAI;IACnB,UAAU,EAAE;QACV,MAAM;QACN,OAAO;QACP,QAAQ;QACR,SAAS;QACT,UAAU;QACV,WAAW;QACX,OAAO;QACP,SAAS;QACT,MAAM;KACP;CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAW,EAAE;IAC1D,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,OAAe,EACf,MAAc,EACkB,EAAE;IAClC,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CACpD,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;QACzB,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,IAAI,EAAE,UAAU;KACU,CAC7B,CAAC;IACF,MAAM,YAAY,GAAG,IAAI,8BAA8B,CAAC,cAAc,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC7D,OAAO,MAAM,CAAC,GAAG,CACf,CAAC,KAAK,EAAE,MAAM,EAAuB,EAAE,CAAC,CAAC;QACvC,EAAE,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC;QACnC,WAAW,EAAE,KAAK;QAClB,QAAQ,EAAE;YACR,MAAM;YACN,UAAU,EAAE,kBAAuD;SACpE;KACF,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAGpC,IAAgB,EACgB,EAAE;IAClC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;IACrF,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAI,OAAO,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC/B,GAAG,QAAQ;QACX,QAAQ,EAAE;YACR,GAAG,QAAQ,CAAC,QAAQ;YACpB,QAAQ,EAAE,IAAI,CAAC,WAAW;SAC3B;KACF,CAAC,CAAC,CAAC;AACN,CAAC,CAAC"}
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../../src/utils/markdown/parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0BAA0B,CAAC;AAI1E,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,cAAc,GAAG;IACrB,SAAS,EAAE,IAAI;IACf,YAAY,EAAE,GAAG;IACjB,UAAU,EAAE;QACV,MAAM;QACN,OAAO;QACP,QAAQ;QACR,SAAS;QACT,UAAU;QACV,WAAW;QACX,OAAO;QACP,SAAS;QACT,SAAS;QACT,MAAM;QACN,IAAI;KACL;IACD,aAAa,EAAE,IAAI;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAW,EAAE;IAC1D,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,YAAY,GAAG,CAAC,KAAa,EAAW,EAAE;IAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAC3B,+CAA+C;IAC/C,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAChD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,OAAe,EACf,MAAc,EACkB,EAAE;IAClC,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAC/D,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CACpD,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC;QACzB,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,IAAI,EAAE,UAAU;KACU,CAC7B,CAAC;IACF,MAAM,YAAY,GAAG,IAAI,8BAA8B,CAAC,cAAc,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAE7D,sEAAsE;IACtE,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1C,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC,GAAG,CACpB,CAAC,KAAK,EAAE,MAAM,EAAuB,EAAE,CAAC,CAAC;QACvC,EAAE,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC;QACnC,WAAW,EAAE,KAAK;QAClB,QAAQ,EAAE;YACR,MAAM;YACN,UAAU,EAAE,kBAAuD;SACpE;KACF,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAGpC,IAAgB,EACgB,EAAE;IAClC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,IAAI,CAAC,IAAI,gCAAgC,CAAC,CAAC;IACrF,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAI,OAAO,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC/B,GAAG,QAAQ;QACX,QAAQ,EAAE;YACR,GAAG,QAAQ,CAAC,QAAQ;YACpB,QAAQ,EAAE,IAAI,CAAC,WAAW;SAC3B;KACF,CAAC,CAAC,CAAC;AACN,CAAC,CAAC"}

package/dist/esm/utils/package-resolver.js

@@ -1,19 +1,23 @@
 import { dirname } from 'node:path';
 import { readPackageUp } from 'read-package-up';
 /**
- * Map of package base directories to package.json
+ * In-memory cache mapping package root directories to their parsed `package.json`.
+ * Avoids repeated file-system lookups when processing many files from the same package.
  */
 const packageMap = new Map();
 /**
- * Resolves which package a file path belongs to.
- * First checks the cache map, then uses read-package-up if no match found.
+ * Resolves the nearest `package.json` for a given file path.
  *
- * @param filePath - Absolute or relative file path (e.g., '/path/to/packages/cli/src/index.ts')
- * @returns Package.json if found, undefined otherwise
+ * Uses an in-memory cache keyed by the package’s directory to avoid
+ * redundant file-system lookups when many files share the same package.
+ *
+ * @param filePath - Absolute path to a source file.
+ * @returns The parsed `PackageJson` if found, or `undefined`.
  *
  * @example
  * ```ts
- * const packageJson = await resolvePackage('/path/to/packages/cli/src/index.ts');
+ * const pkg = await resolvePackage('/repo/packages/cli/src/index.ts');
+ * console.log(pkg?.name); // '@equinor/fusion-framework-cli'
  * ```
  */
 export async function resolvePackage(filePath) {

package/dist/esm/utils/package-resolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"package-resolver.js","sourceRoot":"","sources":["../../../src/utils/package-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAoB,MAAM,iBAAiB,CAAC;AAElE;;GAEG;AACH,MAAM,UAAU,GAAG,IAAI,GAAG,EAAuB,CAAC;AAElD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,QAAgB;IACnD,yDAAyD;IACzD,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5C,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACrC,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAChD,IAAI,WAAW,EAAE,CAAC;gBAChB,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,0DAA0D;IAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvE,IAAI,MAAM,EAAE,CAAC;QACX,oEAAoE;QACpE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,EAAE,WAAW,CAAC;AAC7B,CAAC"}
+{"version":3,"file":"package-resolver.js","sourceRoot":"","sources":["../../../src/utils/package-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAoB,MAAM,iBAAiB,CAAC;AAElE;;;GAGG;AACH,MAAM,UAAU,GAAG,IAAI,GAAG,EAAuB,CAAC;AAElD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,QAAgB;IACnD,yDAAyD;IACzD,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5C,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACrC,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAChD,IAAI,WAAW,EAAE,CAAC;gBAChB,OAAO,WAAW,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IAED,8CAA8C;IAC9C,0DAA0D;IAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvE,IAAI,MAAM,EAAE,CAAC;QACX,oEAAoE;QACpE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,EAAE,WAAW,CAAC;AAC7B,CAAC"}

package/dist/esm/utils/ts-doc/constants.js

@@ -1,6 +1,9 @@
 import { SyntaxKind } from 'ts-morph';
 /**
- * Supported TSDoc node kinds for top-level processing
+ * Top-level TypeScript syntax kinds that the TSDoc extractor inspects.
+ *
+ * Only nodes matching one of these kinds are considered for document
+ * extraction; all other descendants are skipped.
  */
 export const nodeKinds = [
     SyntaxKind.FunctionDeclaration,

package/dist/esm/utils/ts-doc/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/utils/ts-doc/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,UAAU,CAAC,mBAAmB;IAC9B,UAAU,CAAC,gBAAgB;IAC3B,UAAU,CAAC,oBAAoB;IAC/B,UAAU,CAAC,oBAAoB;IAC/B,UAAU,CAAC,iBAAiB;IAC5B,UAAU,CAAC,eAAe;CAC3B,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/utils/ts-doc/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,UAAU,CAAC,mBAAmB;IAC9B,UAAU,CAAC,gBAAgB;IAC3B,UAAU,CAAC,oBAAoB;IAC/B,UAAU,CAAC,oBAAoB;IAC/B,UAAU,CAAC,iBAAiB;IAC5B,UAAU,CAAC,eAAe;CAC3B,CAAC"}

package/dist/esm/utils/ts-doc/extractors.js

@@ -28,11 +28,16 @@ const createTypescriptDocument = (sourceFile, pageContent, tsKind, tsName, optio
     };
 };
 /**
- * Extracts a TSDoc document from a class node, including TSDoc, constructor, and public member signatures.
- * @param classNode - The ClassDeclaration node to process.
- * @param sourceFile - The source file containing the node.
- * @param options - Optional parsing configuration.
- * @returns A TypeScript document with TSDoc and class interface, or null if no TSDoc is found.
+ * Extracts a vector-store document from a TypeScript class declaration.
+ *
+ * Collects the class-level TSDoc comment, constructor signature (if documented),
+ * and all public members with TSDoc into a single document whose `pageContent`
+ * mirrors a minimal class interface.
+ *
+ * @param classNode - The `ts-morph` {@link ClassDeclaration} node to inspect.
+ * @param sourceFile - The project source file that contains the class.
+ * @param _options - Optional parsing configuration.
+ * @returns A {@link TypescriptDocument}, or `null` when the class has no TSDoc.
  */
 export const extractDocumentFromClassNode = (classNode, sourceFile, _options) => {
     // Find TSDoc comment (/** ... */)
@@ -92,12 +97,19 @@ export const extractDocumentFromClassNode = (classNode, sourceFile, _options) =>
     return createTypescriptDocument(sourceFile, pageContent, classNode.getKindName(), className, _options);
 };
 /**
- * Extracts a TSDoc document from a single node.
- * @param node - The TypeScript node to process.
- * @param sourceFile - The source file containing the node.
+ * Extracts a vector-store document from a single TypeScript AST node.
+ *
+ * Handles function declarations, variable statements (arrow / function
+ * expressions), interfaces, type aliases, enums, and classes. Delegates
+ * to {@link extractDocumentFromClassNode} for class declarations.
+ *
+ * @param node - The `ts-morph` AST node to inspect.
+ * @param sourceFile - The project source file that contains the node.
  * @param options - Optional parsing configuration.
- * @param nodeOptions - Optional node-specific configuration (e.g., skipKindCheck for VariableStatement).
- * @returns A TypeScript document with TSDoc metadata, or null if no TSDoc is found.
+ * @param nodeOptions - Optional flags (e.g. `skipKindCheck`) to override default
+ *   kind filtering.
+ * @returns A {@link TypescriptDocument}, or `null` when the node has no TSDoc or
+ *   is not a supported kind.
  */
 export const extractDocumentFromNode = (node, sourceFile, options, nodeOptions) => {
     const kind = node.getKind();
@@ -157,10 +169,12 @@ export const extractDocumentFromNode = (node, sourceFile, options, nodeOptions)
     return createTypescriptDocument(sourceFile, pageContent, node.getKindName(), nodeName, options);
 };
 /**
- * Processes a TypeScript source file to extract TSDoc documents.
- * @param sourceFile - The source file to process.
+ * Walks a TypeScript source file and extracts a {@link TypescriptDocument}
+ * for every top-level declaration that carries a TSDoc comment.
+ *
+ * @param sourceFile - The `ts-morph` source file to traverse.
  * @param options - Optional parsing configuration.
- * @returns An array of TypeScript documents with TSDoc metadata.
+ * @returns Array of extracted documents (one per documented declaration).
  */
 export const processSourceFile = (sourceFile, options) => {
     const documents = [];

package/dist/esm/utils/ts-doc/extractors.js.map

@@ -1 +1 @@
-{"version":3,"file":"extractors.js","sourceRoot":"","sources":["../../../../src/utils/ts-doc/extractors.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,IAAI,GAKL,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;GASG;AACH,MAAM,wBAAwB,GAAG,CAC/B,UAA6B,EAC7B,WAAmB,EACnB,MAAc,EACd,MAAc,EACd,OAA2B,EACP,EAAE;IACtB,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC5D,OAAO;QACL,EAAE,EAAE,eAAe,CAAC,MAAM,CAAC;QAC3B,WAAW;QACX,QAAQ,EAAE;YACR,MAAM;YACN,GAAG,CAAC,OAAO,EAAE,WAAW,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;YAC9D,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,MAAM;gBACf,OAAO,EAAE,MAAM;aAChB;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,SAA2B,EAC3B,UAA6B,EAC7B,QAA4B,EACD,EAAE;IAC7B,kCAAkC;IAClC,MAAM,eAAe,GAAG,SAAS;SAC9B,uBAAuB,EAAE;SACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;IAC7C,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,gBAAgB,CAAC;IAE1D,wDAAwD;IACxD,MAAM,cAAc,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC;IACtG,IAAI,WAAW,GAAG,GAAG,UAAU,KAAK,cAAc,EAAE,CAAC;IAErD,wCAAwC;IACxC,MAAM,eAAe,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,qCAAqC;IAC7F,IAAI,eAAe,EAAE,CAAC;QACpB,MAAM,0BAA0B,GAAG,eAAe;aAC/C,uBAAuB,EAAE;aACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QACtD,IAAI,0BAA0B,EAAE,CAAC;YAC/B,MAAM,qBAAqB,GAAG,0BAA0B,CAAC,OAAO,EAAE,CAAC;YACnE,MAAM,oBAAoB,GAAG,eAAe;iBACzC,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;iBACxC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBACb,IAAI,EAAE,CAAC;YACV,WAAW,IAAI,OAAO,qBAAqB,OAAO,oBAAoB,EAAE,CAAC;QAC3E,CAAC;IACH,CAAC;IAED,+CAA+C;IAC/C,MAAM,aAAa,GAAG;QACpB,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChF,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;KACpF,CAAC;IAEF,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAC/B,MAAM,qBAAqB,GAAG,MAAM;aACjC,uBAAuB,EAAE;aACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QACtD,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,OAAO,EAAE,CAAC;YACzD,IAAI,eAAe,GAAG,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,iBAAiB,EAAE,CAAC;gBACtD,eAAe,GAAI,MAA4B;qBAC5C,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;qBACxC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;qBACb,IAAI,EAAE,CAAC;YACZ,CAAC;iBAAM,IAAI,MAAM,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,mBAAmB,EAAE,CAAC;gBAC/D,eAAe,GAAI,MAA8B;qBAC9C,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;qBACxC,IAAI,EAAE,CAAC;YACZ,CAAC;YACD,WAAW,IAAI,OAAO,gBAAgB,OAAO,eAAe,EAAE,CAAC;QACjE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,WAAW,IAAI,KAAK,CAAC;IAErB,OAAO,wBAAwB,CAC7B,UAAU,EACV,WAAW,EACX,SAAS,CAAC,WAAW,EAAE,EACvB,SAAS,EACT,QAAQ,CACT,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAU,EACV,UAA6B,EAC7B,OAA2B,EAC3B,WAAyC,EACd,EAAE;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAE5B,+DAA+D;IAC/D,IAAI,CAAC,WAAW,EAAE,aAAa,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qCAAqC;IACrC,IAAI,IAAI,KAAK,UAAU,CAAC,gBAAgB,EAAE,CAAC;QACzC,OAAO,4BAA4B,CAAC,IAAwB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED,kEAAkE;IAClE,IAAI,IAAI,KAAK,UAAU,CAAC,iBAAiB,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAI,IAA0B;aAC5C,eAAe,EAAE;aACjB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAE/D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,EAAE,CAAC;QACjD,IACE,CAAC,WAAW;YACZ,CAAC,CACC,WAAW,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,aAAa;gBAClD,WAAW,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,kBAAkB,CACxD,EACD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,mDAAmD;QACnD,MAAM,eAAe,GAAG,IAAI;aACzB,uBAAuB,EAAE;aACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAEtD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,sBAAsB,CAAC;QACjE,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;QAE7C,uDAAuD;QACvD,OAAO,wBAAwB,CAC7B,UAAU,EACV,UAAU,EACV,WAAW,CAAC,WAAW,EAAE,EACzB,QAAQ,EACR,OAAO,CACR,CAAC;IACJ,CAAC;IAED,2BAA2B;IAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC;IAE9E,kCAAkC;IAClC,MAAM,eAAe,GAAG,IAAI;SACzB,uBAAuB,EAAE;SACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;IAC7C,IAAI,WAAW,GAAG,UAAU,CAAC;IAE7B,yDAAyD;IACzD,IAAI,IAAI,KAAK,UAAU,CAAC,oBAAoB,IAAI,IAAI,KAAK,UAAU,CAAC,oBAAoB,EAAE,CAAC;QACzF,WAAW,GAAG,GAAG,UAAU,KAAK,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;IACnD,CAAC;IACD,kEAAkE;SAC7D,IAAI,IAAI,KAAK,UAAU,CAAC,mBAAmB,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC,CAAC,yBAAyB;IACxC,CAAC;IAED,OAAO,wBAAwB,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAClG,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,UAA6B,EAC7B,OAA2B,EACL,EAAE;IACxB,MAAM,SAAS,GAAyB,EAAE,CAAC;IAE3C,UAAU,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE;QACpC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QACpE,IAAI,QAAQ,EAAE,CAAC;YACb,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}
+{"version":3,"file":"extractors.js","sourceRoot":"","sources":["../../../../src/utils/ts-doc/extractors.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,IAAI,GAKL,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;GASG;AACH,MAAM,wBAAwB,GAAG,CAC/B,UAA6B,EAC7B,WAAmB,EACnB,MAAc,EACd,MAAc,EACd,OAA2B,EACP,EAAE;IACtB,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC5D,OAAO;QACL,EAAE,EAAE,eAAe,CAAC,MAAM,CAAC;QAC3B,WAAW;QACX,QAAQ,EAAE;YACR,MAAM;YACN,GAAG,CAAC,OAAO,EAAE,WAAW,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;YAC9D,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,MAAM;gBACf,OAAO,EAAE,MAAM;aAChB;SACF;KACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAC1C,SAA2B,EAC3B,UAA6B,EAC7B,QAA4B,EACD,EAAE;IAC7B,kCAAkC;IAClC,MAAM,eAAe,GAAG,SAAS;SAC9B,uBAAuB,EAAE;SACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;IAC7C,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,gBAAgB,CAAC;IAE1D,wDAAwD;IACxD,MAAM,cAAc,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC;IACtG,IAAI,WAAW,GAAG,GAAG,UAAU,KAAK,cAAc,EAAE,CAAC;IAErD,wCAAwC;IACxC,MAAM,eAAe,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,qCAAqC;IAC7F,IAAI,eAAe,EAAE,CAAC;QACpB,MAAM,0BAA0B,GAAG,eAAe;aAC/C,uBAAuB,EAAE;aACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QACtD,IAAI,0BAA0B,EAAE,CAAC;YAC/B,MAAM,qBAAqB,GAAG,0BAA0B,CAAC,OAAO,EAAE,CAAC;YACnE,MAAM,oBAAoB,GAAG,eAAe;iBACzC,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;iBACxC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBACb,IAAI,EAAE,CAAC;YACV,WAAW,IAAI,OAAO,qBAAqB,OAAO,oBAAoB,EAAE,CAAC;QAC3E,CAAC;IACH,CAAC;IAED,+CAA+C;IAC/C,MAAM,aAAa,GAAG;QACpB,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChF,GAAG,SAAS,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;KACpF,CAAC;IAEF,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAC/B,MAAM,qBAAqB,GAAG,MAAM;aACjC,uBAAuB,EAAE;aACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QACtD,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,OAAO,EAAE,CAAC;YACzD,IAAI,eAAe,GAAG,EAAE,CAAC;YACzB,IAAI,MAAM,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,iBAAiB,EAAE,CAAC;gBACtD,eAAe,GAAI,MAA4B;qBAC5C,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;qBACxC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;qBACb,IAAI,EAAE,CAAC;YACZ,CAAC;iBAAM,IAAI,MAAM,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,mBAAmB,EAAE,CAAC;gBAC/D,eAAe,GAAI,MAA8B;qBAC9C,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;qBACxC,IAAI,EAAE,CAAC;YACZ,CAAC;YACD,WAAW,IAAI,OAAO,gBAAgB,OAAO,eAAe,EAAE,CAAC;QACjE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,WAAW,IAAI,KAAK,CAAC;IAErB,OAAO,wBAAwB,CAC7B,UAAU,EACV,WAAW,EACX,SAAS,CAAC,WAAW,EAAE,EACvB,SAAS,EACT,QAAQ,CACT,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAU,EACV,UAA6B,EAC7B,OAA2B,EAC3B,WAAyC,EACd,EAAE;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAE5B,+DAA+D;IAC/D,IAAI,CAAC,WAAW,EAAE,aAAa,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qCAAqC;IACrC,IAAI,IAAI,KAAK,UAAU,CAAC,gBAAgB,EAAE,CAAC;QACzC,OAAO,4BAA4B,CAAC,IAAwB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED,kEAAkE;IAClE,IAAI,IAAI,KAAK,UAAU,CAAC,iBAAiB,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAI,IAA0B;aAC5C,eAAe,EAAE;aACjB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAE/D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,EAAE,CAAC;QACjD,IACE,CAAC,WAAW;YACZ,CAAC,CACC,WAAW,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,aAAa;gBAClD,WAAW,CAAC,OAAO,EAAE,KAAK,UAAU,CAAC,kBAAkB,CACxD,EACD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,mDAAmD;QACnD,MAAM,eAAe,GAAG,IAAI;aACzB,uBAAuB,EAAE;aACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAEtD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,sBAAsB,CAAC;QACjE,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;QAE7C,uDAAuD;QACvD,OAAO,wBAAwB,CAC7B,UAAU,EACV,UAAU,EACV,WAAW,CAAC,WAAW,EAAE,EACzB,QAAQ,EACR,OAAO,CACR,CAAC;IACJ,CAAC;IAED,2BAA2B;IAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,sBAAsB,CAAC;IAE9E,kCAAkC;IAClC,MAAM,eAAe,GAAG,IAAI;SACzB,uBAAuB,EAAE;SACzB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;IAC7C,IAAI,WAAW,GAAG,UAAU,CAAC;IAE7B,yDAAyD;IACzD,IAAI,IAAI,KAAK,UAAU,CAAC,oBAAoB,IAAI,IAAI,KAAK,UAAU,CAAC,oBAAoB,EAAE,CAAC;QACzF,WAAW,GAAG,GAAG,UAAU,KAAK,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;IACnD,CAAC;IACD,kEAAkE;SAC7D,IAAI,IAAI,KAAK,UAAU,CAAC,mBAAmB,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC,CAAC,yBAAyB;IACxC,CAAC;IAED,OAAO,wBAAwB,CAAC,UAAU,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAClG,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,UAA6B,EAC7B,OAA2B,EACL,EAAE;IACxB,MAAM,SAAS,GAAyB,EAAE,CAAC;IAE3C,UAAU,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE;QACpC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QACpE,IAAI,QAAQ,EAAE,CAAC;YACb,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}

package/dist/esm/utils/ts-doc/parser.js

@@ -3,18 +3,23 @@ import { readFileSync } from 'node:fs';
 import { Project } from 'ts-morph';
 import { processSourceFile } from './extractors.js';
 /**
- * Checks if a file is a TypeScript or TSX file based on its extension.
- * @param filePath - The path to the file.
- * @returns True if the file ends with .ts or .tsx, false otherwise.
+ * Checks whether a file path has a TypeScript (`.ts`) or TSX (`.tsx`) extension.
+ *
+ * @param filePath - Absolute or relative file path.
+ * @returns `true` if the file extension is `.ts` or `.tsx`.
  */
 export const isTypescriptFile = (filePath) => {
     return filePath.endsWith('.ts') || filePath.endsWith('.tsx');
 };
 /**
- * Parses TSDoc from a string of TypeScript code.
- * @param content - The TypeScript code content.
+ * Parses TSDoc comments from an in-memory TypeScript code string.
+ *
+ * Creates a temporary `ts-morph` project, analyses the source, and returns
+ * one {@link TypescriptDocument} per documented top-level declaration.
+ *
+ * @param content - TypeScript source code to parse.
  * @param options - Optional parsing configuration.
- * @returns An array of TypeScript documents with TSDoc metadata.
+ * @returns Array of extracted TypeScript documents with TSDoc metadata.
  */
 export const parseTsDocSync = (content, options) => {
     const project = new Project({ useInMemoryFileSystem: true });
@@ -22,11 +27,15 @@ export const parseTsDocSync = (content, options) => {
     return processSourceFile(sourceFile, options);
 };
 /**
- * Parses TSDoc from a TypeScript file by path.
- * @param file - The source file object.
+ * Parses TSDoc comments from a TypeScript file on disk.
+ *
+ * Reads the file synchronously, creates a `ts-morph` project, and returns
+ * one {@link TypescriptDocument} per documented top-level declaration.
+ *
+ * @param file - Source file descriptor with path and optional project root.
  * @param options - Optional parsing configuration.
- * @returns An array of TypeScript documents with TSDoc metadata.
- * @throws If the file is not a TypeScript file.
+ * @returns Array of extracted TypeScript documents.
+ * @throws {AssertionError} If the file does not have a `.ts` or `.tsx` extension.
  */
 export const parseTsDocFromFileSync = (file, options) => {
     assert(isTypescriptFile(file.path), `File ${file.path} is not a TypeScript file`);

package/dist/esm/utils/ts-doc/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../../src/utils/ts-doc/parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAInC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAW,EAAE;IAC5D,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,OAAe,EACf,OAA2B,EACL,EAAE;IACxB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAChE,OAAO,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,IAAgB,EAChB,OAA2B,EACL,EAAE;IACxB,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,IAAI,CAAC,IAAI,2BAA2B,CAAC,CAAC;IAClF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CACzC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,EAC9B,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAChC,CAAC;IACF,OAAO,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC,CAAC"}
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../../src/utils/ts-doc/parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAInC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAW,EAAE;IAC5D,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,OAAe,EACf,OAA2B,EACL,EAAE;IACxB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAChE,OAAO,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,IAAgB,EAChB,OAA2B,EACL,EAAE;IACxB,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,IAAI,CAAC,IAAI,2BAA2B,CAAC,CAAC;IAClF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CACzC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,EAC9B,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAChC,CAAC;IACF,OAAO,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAChD,CAAC,CAAC"}

package/dist/esm/version.js

@@ -1,3 +1,3 @@
 // Generated by genversion.
-export const version = '1.0.6';
+export const version = '2.0.0';
 //# sourceMappingURL=version.js.map