vectra 0.12.3 → 0.14.0

package/README.md

@@ -1,100 +1,92 @@
-# Vectra
-
-Vectra is a local vector database for Node.js with features similar to [Pinecone](https://www.pinecone.io/) or [Qdrant](https://qdrant.tech/) but built using local files. Each Vectra index is a folder on disk. There's an `index.json` file in the folder that contains all the vectors for the index along with any indexed metadata. When you create an index you can specify which metadata properties to index and only those fields will be stored in the `index.json` file. All of the other metadata for an item will be stored on disk in a separate file keyed by a GUID.
-
-When queryng Vectra you'll be able to use the same subset of [Mongo DB query operators](https://www.mongodb.com/docs/manual/reference/operator/query/) that Pinecone supports and the results will be returned sorted by simularity. Every item in the index will first be filtered by metadata and then ranked for simularity. Even though every item is evaluated its all in memory so it should by nearly instantanious. Likely 1ms - 2ms for even a rather large index. Smaller indexes should be <1ms.
-
-Keep in mind that your entire Vectra index is loaded into memory so it's not well suited for scenarios like long term chat bot memory. Use a real vector DB for that. Vectra is intended to be used in scenarios where you have a small corpus of mostly static data that you'd like to include in your prompt. Infinite few shot examples would be a great use case for Vectra or even just a single document you want to ask questions over.
-
-Pinecone style namespaces aren't directly supported but you could easily mimic them by creating a separate Vectra index (and folder) for each namespace.
-
-## Other Language Bindings
-
-This repo contains the TypeScript/JavaScript binding for Vectra but other language bindings are being created. Since Vectra is file based, any language binding can be used to read or write a Vectra index. That means you can build a Vectra index using JS and then read it using Python.
-
--   [vectra-py](https://github.com/BMS-geodev/vectra-py) - Python version of Vectra.
-
-## Installation
-
-```
-$ npm install vectra
-```
-
-## Usage
-
-First create an instance of `LocalIndex` with the path to the folder where you want you're items stored:
-
-```typescript
-import { LocalIndex } from 'vectra';
-
-const index = new LocalIndex(path.join(__dirname, '..', 'index'));
-```
-
-Next, from inside an async function, create your index:
-
-```typescript
-if (!(await index.isIndexCreated())) {
-    await index.createIndex();
-}
-```
-
-Add some items to your index:
-
-```typescript
-import { OpenAI } from 'openai';
-
-const openai = new OpenAI({
-    apiKey: `<YOUR_KEY>`,
-});
-
-async function getVector(text: string) {
-    const response = await openai.embeddings.create({
-        'model': 'text-embedding-ada-002',
-        'input': text,
-    });
-    return response.data[0].embedding;
-}
-
-async function addItem(text: string) {
-    await index.insertItem({
-        vector: await getVector(text),
-        metadata: { text },
-    });
-}
-
-// Add items
-await addItem('apple');
-await addItem('oranges');
-await addItem('red');
-await addItem('blue');
-```
-
-Then query for items:
-
-```typescript
-async function query(text: string) {
-    const vector = await getVector(text);
-    const results = await index.queryItems(vector, 3);
-    if (results.length > 0) {
-        for (const result of results) {
-            console.log(`[${result.score}] ${result.item.metadata.text}`);
-        }
-    } else {
-        console.log(`No results found.`);
-    }
-}
-
-await query('green');
-/*
-[0.9036569942401076] blue
-[0.8758153664568566] red
-[0.8323828606103998] apple
-*/
-
-await query('banana');
-/*
-[0.9033128691220631] apple
-[0.8493374123092652] oranges
-[0.8415324469533297] blue
-*/
-```
+# Vectra: a local vector database
+
+[![npm version](https://img.shields.io/npm/v/vectra.svg)](https://www.npmjs.com/package/vectra)
+[![Build](https://github.com/Stevenic/vectra/actions/workflows/ci.yml/badge.svg)](https://github.com/Stevenic/vectra/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/Stevenic/vectra/badge.svg?branch=main)](https://coveralls.io/github/Stevenic/vectra?branch=main)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Agent Ready](https://img.shields.io/badge/Agent-Ready-blue.svg)](#agent-ready)
+
+Vectra is a local, file-backed, in-memory vector database with an optional gRPC server for cross-language access. Each index is a folder on disk — queries use MongoDB-style metadata filtering and cosine similarity ranking, with sub-millisecond latency for small indexes.
+
+## What's New in Vectra 0.14
+
+- **Browser & Electron support** — `vectra/browser` entry point with `IndexedDBStorage` and `TransformersEmbeddings`
+- **Local embeddings** — `LocalEmbeddings` and `TransformersEmbeddings` run HuggingFace models with no API key
+- **Protocol Buffers** — opt-in binary format, 40-50% smaller files
+- **gRPC server** — `vectra serve` exposes 19 RPCs for cross-language access
+- **FolderWatcher** — auto-sync directories into a document index
+- **Language bindings** — `vectra generate` scaffolds clients for 6 languages
+
+See the [Changelog](https://stevenic.github.io/vectra/changelog) for breaking changes and migration details.
+
+## Install
+
+```sh
+npm install vectra
+```
+
+## Quick Example
+
+```ts
+import { LocalDocumentIndex, OpenAIEmbeddings } from 'vectra';
+
+const docs = new LocalDocumentIndex({
+  folderPath: './my-index',
+  embeddings: new OpenAIEmbeddings({
+    apiKey: process.env.OPENAI_API_KEY!,
+    model: 'text-embedding-3-small',
+    maxTokens: 8000,
+  }),
+});
+
+if (!(await docs.isIndexCreated())) {
+  await docs.createIndex({ version: 1 });
+}
+
+await docs.upsertDocument('doc://readme', 'Vectra is a local vector database...', 'md');
+
+const results = await docs.queryDocuments('What is Vectra?', { maxDocuments: 5 });
+if (results.length > 0) {
+  const sections = await results[0].renderSections(2000, 1, true);
+  console.log(sections[0].text);
+}
+```
+
+## Documentation
+
+Full docs at **[stevenic.github.io/vectra](https://stevenic.github.io/vectra/)**:
+
+| Guide | Description |
+|-------|-------------|
+| [Getting Started](https://stevenic.github.io/vectra/getting-started) | Install, requirements, quick start with both index types |
+| [Core Concepts](https://stevenic.github.io/vectra/core-concepts) | Index types, metadata filtering, on-disk layout |
+| [Embeddings Guide](https://stevenic.github.io/vectra/embeddings) | Choose and configure an embeddings provider |
+| [Document Indexing](https://stevenic.github.io/vectra/documents) | Chunking, retrieval, hybrid search, FolderWatcher |
+| [CLI Reference](https://stevenic.github.io/vectra/cli) | All CLI commands, flags, and provider config |
+| [API Reference](https://stevenic.github.io/vectra/api-reference) | TypeScript API overview |
+| [Best Practices](https://stevenic.github.io/vectra/best-practices) | Performance tuning, troubleshooting |
+| [Storage](https://stevenic.github.io/vectra/storage) | Pluggable backends, browser/IndexedDB, serialization formats |
+| [gRPC Server](https://stevenic.github.io/vectra/grpc) | Cross-language access and language bindings |
+| [Changelog](https://stevenic.github.io/vectra/changelog) | Breaking changes and migration guides |
+| [Tutorials](https://stevenic.github.io/vectra/tutorials/) | RAG pipeline, browser app, gRPC, custom storage, folder sync |
+| [Samples](./samples/) | Runnable examples: quickstart, RAG, browser, SQLite storage, gRPC, folder watcher |
+
+## Agent Ready
+
+Vectra ships an [`llms.txt`](https://github.com/Stevenic/vectra/blob/main/llms.txt) file that gives coding agents everything they need to integrate Vectra into your project. Point your agent at it and let it do the work:
+
+```
+Read the llms.txt file at https://raw.githubusercontent.com/Stevenic/vectra/main/llms.txt
+and then add Vectra support to this project. Use LocalDocumentIndex for document
+storage and retrieval.
+```
+
+The `llms.txt` file covers all exports, index types, CLI commands, gRPC bindings, and on-disk format — enough for any coding agent to scaffold a working integration without browsing docs.
+
+## License
+
+MIT License. See [LICENSE](LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. Please review our [Code of Conduct](CODE_OF_CONDUCT.md).

package/lib/BrowserWebFetcher.d.ts

@@ -0,0 +1,75 @@
+import { TextFetcher } from './types';
+/**
+ * Configuration options for BrowserWebFetcher.
+ */
+export interface BrowserWebFetcherConfig {
+    /**
+     * Optional. Whether to convert HTML to a simplified text/markdown format.
+     * @remarks
+     * Defaults to `true`.
+     */
+    htmlToMarkdown?: boolean;
+    /**
+     * Optional. Additional headers to include in requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Optional. Request mode for fetch.
+     * @remarks
+     * Defaults to 'cors'.
+     */
+    mode?: RequestMode;
+    /**
+     * Optional. Credentials mode for fetch.
+     * @remarks
+     * Defaults to 'same-origin'.
+     */
+    credentials?: RequestCredentials;
+}
+/**
+ * Browser-compatible web fetcher using the native Fetch API.
+ * @remarks
+ * This fetcher works in browsers and Electron renderer processes.
+ * Uses DOMParser instead of cheerio for HTML parsing.
+ */
+export declare class BrowserWebFetcher implements TextFetcher {
+    private readonly _config;
+    private static readonly ALLOWED_CONTENT_TYPES;
+    /**
+     * Creates a new `BrowserWebFetcher` instance.
+     * @param config Optional configuration options.
+     */
+    constructor(config?: BrowserWebFetcherConfig);
+    /**
+     * Fetches content from a URL and passes it to the document handler.
+     * @param uri URL to fetch.
+     * @param onDocument Callback to handle the fetched document.
+     * @returns Promise that resolves to the return value of onDocument.
+     */
+    fetch(uri: string, onDocument: (uri: string, text: string, docType?: string) => Promise<boolean>): Promise<boolean>;
+    /**
+     * Converts HTML to a simplified markdown-like format using DOMParser.
+     */
+    private htmlToMarkdown;
+    /**
+     * Recursively processes DOM nodes to extract text content.
+     */
+    private processNode;
+    /**
+     * Processes child nodes of an element.
+     */
+    private processChildren;
+    /**
+     * Gets clean text content from an element.
+     */
+    private getTextContent;
+    /**
+     * Processes a table element to markdown format.
+     */
+    private processTable;
+    /**
+     * Maps MIME type to document type.
+     */
+    private getDocTypeFromMime;
+}
+//# sourceMappingURL=BrowserWebFetcher.d.ts.map

package/lib/BrowserWebFetcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserWebFetcher.d.ts","sourceRoot":"","sources":["../src/BrowserWebFetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IAEnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;CACpC;AAED;;;;;GAKG;AACH,qBAAa,iBAAkB,YAAW,WAAW;IACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAElD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAQ3C;IAEF;;;OAGG;gBACS,MAAM,CAAC,EAAE,uBAAuB;IAS5C;;;;;OAKG;IACG,KAAK,CACP,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAC9E,OAAO,CAAC,OAAO,CAAC;IAiCnB;;OAEG;IACH,OAAO,CAAC,cAAc;IA2CtB;;OAEG;IACH,OAAO,CAAC,WAAW;IA2HnB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;OAEG;IACH,OAAO,CAAC,YAAY;IAwBpB;;OAEG;IACH,OAAO,CAAC,kBAAkB;CAmB7B"}

package/lib/BrowserWebFetcher.js

@@ -0,0 +1,290 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserWebFetcher = void 0;
+/**
+ * Browser-compatible web fetcher using the native Fetch API.
+ * @remarks
+ * This fetcher works in browsers and Electron renderer processes.
+ * Uses DOMParser instead of cheerio for HTML parsing.
+ */
+class BrowserWebFetcher {
+    /**
+     * Creates a new `BrowserWebFetcher` instance.
+     * @param config Optional configuration options.
+     */
+    constructor(config) {
+        this._config = Object.assign({ htmlToMarkdown: true, mode: 'cors', credentials: 'same-origin' }, config);
+    }
+    /**
+     * Fetches content from a URL and passes it to the document handler.
+     * @param uri URL to fetch.
+     * @param onDocument Callback to handle the fetched document.
+     * @returns Promise that resolves to the return value of onDocument.
+     */
+    fetch(uri, onDocument) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield fetch(uri, {
+                method: 'GET',
+                headers: this._config.headers,
+                mode: this._config.mode,
+                credentials: this._config.credentials
+            });
+            if (!response.ok) {
+                throw new Error(`HTTP ${response.status}: ${response.statusText}`);
+            }
+            const contentType = response.headers.get('content-type') || 'text/plain';
+            const mimeType = contentType.split(';')[0].trim().toLowerCase();
+            // Validate content type
+            if (!BrowserWebFetcher.ALLOWED_CONTENT_TYPES.some(allowed => mimeType.includes(allowed))) {
+                throw new Error(`Unsupported content type: ${contentType}`);
+            }
+            const text = yield response.text();
+            // Handle HTML content
+            if (mimeType.includes('text/html') && this._config.htmlToMarkdown) {
+                const markdown = this.htmlToMarkdown(text, uri);
+                return onDocument(uri, markdown, 'md');
+            }
+            // Determine doc type from content type
+            const docType = this.getDocTypeFromMime(mimeType);
+            return onDocument(uri, text, docType);
+        });
+    }
+    /**
+     * Converts HTML to a simplified markdown-like format using DOMParser.
+     */
+    htmlToMarkdown(html, baseUrl) {
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(html, 'text/html');
+        // Remove unwanted elements
+        const removeSelectors = ['script', 'style', 'noscript', 'iframe', 'svg', 'canvas'];
+        removeSelectors.forEach(selector => {
+            doc.querySelectorAll(selector).forEach(el => el.remove());
+        });
+        // Convert relative URLs to absolute
+        doc.querySelectorAll('a[href]').forEach(el => {
+            const href = el.getAttribute('href');
+            if (href && !href.startsWith('http') && !href.startsWith('//') && !href.startsWith('#')) {
+                try {
+                    el.setAttribute('href', new URL(href, baseUrl).toString());
+                }
+                catch (_a) {
+                    // Leave as-is if URL parsing fails
+                }
+            }
+        });
+        // Process the body
+        const body = doc.body;
+        if (!body) {
+            return html;
+        }
+        const lines = [];
+        this.processNode(body, lines);
+        // Clean up the result
+        let result = lines.join('\n');
+        // Remove excessive newlines
+        result = result.replace(/\n{3,}/g, '\n\n');
+        // Trim leading/trailing whitespace
+        result = result.trim();
+        return result;
+    }
+    /**
+     * Recursively processes DOM nodes to extract text content.
+     */
+    processNode(node, lines) {
+        var _a;
+        if (node.nodeType === Node.TEXT_NODE) {
+            const text = (_a = node.textContent) === null || _a === void 0 ? void 0 : _a.trim();
+            if (text) {
+                lines.push(text);
+            }
+            return;
+        }
+        if (node.nodeType !== Node.ELEMENT_NODE) {
+            return;
+        }
+        const el = node;
+        const tagName = el.tagName.toLowerCase();
+        // Handle specific elements
+        switch (tagName) {
+            case 'h1':
+                lines.push('');
+                lines.push(`# ${this.getTextContent(el)}`);
+                lines.push('');
+                return;
+            case 'h2':
+                lines.push('');
+                lines.push(`## ${this.getTextContent(el)}`);
+                lines.push('');
+                return;
+            case 'h3':
+                lines.push('');
+                lines.push(`### ${this.getTextContent(el)}`);
+                lines.push('');
+                return;
+            case 'h4':
+                lines.push('');
+                lines.push(`#### ${this.getTextContent(el)}`);
+                lines.push('');
+                return;
+            case 'h5':
+                lines.push('');
+                lines.push(`##### ${this.getTextContent(el)}`);
+                lines.push('');
+                return;
+            case 'h6':
+                lines.push('');
+                lines.push(`###### ${this.getTextContent(el)}`);
+                lines.push('');
+                return;
+            case 'p':
+                lines.push('');
+                this.processChildren(el, lines);
+                lines.push('');
+                return;
+            case 'br':
+                lines.push('');
+                return;
+            case 'hr':
+                lines.push('');
+                lines.push('---');
+                lines.push('');
+                return;
+            case 'a':
+                const href = el.getAttribute('href');
+                const text = this.getTextContent(el);
+                if (href && text) {
+                    lines.push(`[${text}](${href})`);
+                }
+                else if (text) {
+                    lines.push(text);
+                }
+                return;
+            case 'strong':
+            case 'b':
+                lines.push(`**${this.getTextContent(el)}**`);
+                return;
+            case 'em':
+            case 'i':
+                lines.push(`*${this.getTextContent(el)}*`);
+                return;
+            case 'code':
+                lines.push(`\`${this.getTextContent(el)}\``);
+                return;
+            case 'pre':
+                lines.push('');
+                lines.push('```');
+                lines.push(this.getTextContent(el));
+                lines.push('```');
+                lines.push('');
+                return;
+            case 'blockquote':
+                lines.push('');
+                const quoteText = this.getTextContent(el);
+                quoteText.split('\n').forEach(line => {
+                    lines.push(`> ${line}`);
+                });
+                lines.push('');
+                return;
+            case 'ul':
+            case 'ol':
+                lines.push('');
+                el.querySelectorAll(':scope > li').forEach((li, index) => {
+                    const prefix = tagName === 'ol' ? `${index + 1}.` : '-';
+                    lines.push(`${prefix} ${this.getTextContent(li)}`);
+                });
+                lines.push('');
+                return;
+            case 'table':
+                lines.push('');
+                this.processTable(el, lines);
+                lines.push('');
+                return;
+            case 'img':
+                const alt = el.getAttribute('alt') || 'image';
+                const src = el.getAttribute('src');
+                if (src) {
+                    lines.push(`![${alt}](${src})`);
+                }
+                return;
+            default:
+                // For other elements, process children
+                this.processChildren(el, lines);
+        }
+    }
+    /**
+     * Processes child nodes of an element.
+     */
+    processChildren(el, lines) {
+        el.childNodes.forEach(child => {
+            this.processNode(child, lines);
+        });
+    }
+    /**
+     * Gets clean text content from an element.
+     */
+    getTextContent(el) {
+        return (el.textContent || '').replace(/\s+/g, ' ').trim();
+    }
+    /**
+     * Processes a table element to markdown format.
+     */
+    processTable(table, lines) {
+        const rows = table.querySelectorAll('tr');
+        let isFirstRow = true;
+        rows.forEach(row => {
+            const cells = row.querySelectorAll('th, td');
+            const cellContents = [];
+            cells.forEach(cell => {
+                cellContents.push(this.getTextContent(cell));
+            });
+            if (cellContents.length > 0) {
+                lines.push(`| ${cellContents.join(' | ')} |`);
+                // Add separator after header row
+                if (isFirstRow) {
+                    lines.push(`| ${cellContents.map(() => '---').join(' | ')} |`);
+                    isFirstRow = false;
+                }
+            }
+        });
+    }
+    /**
+     * Maps MIME type to document type.
+     */
+    getDocTypeFromMime(mimeType) {
+        const mimeMap = {
+            'text/html': 'html',
+            'text/plain': undefined,
+            'text/markdown': 'md',
+            'text/xml': 'xml',
+            'application/json': 'json',
+            'application/xml': 'xml',
+            'application/javascript': 'js'
+        };
+        for (const [mime, docType] of Object.entries(mimeMap)) {
+            if (mimeType.includes(mime)) {
+                return docType;
+            }
+        }
+        return undefined;
+    }
+}
+exports.BrowserWebFetcher = BrowserWebFetcher;
+BrowserWebFetcher.ALLOWED_CONTENT_TYPES = [
+    'text/html',
+    'application/json',
+    'application/xml',
+    'application/javascript',
+    'text/plain',
+    'text/markdown',
+    'text/xml'
+];
+//# sourceMappingURL=BrowserWebFetcher.js.map

package/lib/BrowserWebFetcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserWebFetcher.js","sourceRoot":"","sources":["../src/BrowserWebFetcher.ts"],"names":[],"mappings":";;;;;;;;;;;;AAiCA;;;;;GAKG;AACH,MAAa,iBAAiB;IAa1B;;;OAGG;IACH,YAAY,MAAgC;QACxC,IAAI,CAAC,OAAO,mBACR,cAAc,EAAE,IAAI,EACpB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,aAAa,IACvB,MAAM,CACZ,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACG,KAAK,CACP,GAAW,EACX,UAA6E;;YAE7E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;gBAC9B,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;gBAC7B,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;gBACvB,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;aACxC,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,QAAQ,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YACvE,CAAC;YAED,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,YAAY,CAAC;YACzE,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAEhE,wBAAwB;YACxB,IAAI,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBACvF,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,EAAE,CAAC,CAAC;YAChE,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAEnC,sBAAsB;YACtB,IAAI,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAChD,OAAO,UAAU,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC;YAED,uCAAuC;YACvC,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YAClD,OAAO,UAAU,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACK,cAAc,CAAC,IAAY,EAAE,OAAe;QAChD,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAEtD,2BAA2B;QAC3B,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACnF,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/B,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,oCAAoC;QACpC,GAAG,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACzC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACrC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtF,IAAI,CAAC;oBACD,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC/D,CAAC;gBAAC,WAAM,CAAC;oBACL,mCAAmC;gBACvC,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,mBAAmB;QACnB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAE9B,sBAAsB;QACtB,IAAI,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,4BAA4B;QAC5B,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAE3C,mCAAmC;QACnC,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAEvB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACK,WAAW,CAAC,IAAU,EAAE,KAAe;;QAC3C,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,WAAW,0CAAE,IAAI,EAAE,CAAC;YACtC,IAAI,IAAI,EAAE,CAAC;gBACP,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC;YACD,OAAO;QACX,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,OAAO;QACX,CAAC;QAED,MAAM,EAAE,GAAG,IAAe,CAAC;QAC3B,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAEzC,2BAA2B;QAC3B,QAAQ,OAAO,EAAE,CAAC;YACd,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC5C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC/C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBAChD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,GAAG;gBACJ,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;gBAChC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,GAAG;gBACJ,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBACrC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBACrC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;oBACf,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,GAAG,CAAC,CAAC;gBACrC,CAAC;qBAAM,IAAI,IAAI,EAAE,CAAC;oBACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,CAAC;gBACD,OAAO;YACX,KAAK,QAAQ,CAAC;YACd,KAAK,GAAG;gBACJ,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBAC7C,OAAO;YACX,KAAK,IAAI,CAAC;YACV,KAAK,GAAG;gBACJ,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC3C,OAAO;YACX,KAAK,MAAM;gBACP,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;gBAC7C,OAAO;YACX,KAAK,KAAK;gBACN,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;gBACpC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,YAAY;gBACb,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;gBAC1C,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBACjC,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,IAAI,CAAC;YACV,KAAK,IAAI;gBACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,EAAE,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;oBACrD,MAAM,MAAM,GAAG,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;oBACxD,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACvD,CAAC,CAAC,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,OAAO;gBACR,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACf,OAAO;YACX,KAAK,KAAK;gBACN,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC;gBAC9C,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBACnC,IAAI,GAAG,EAAE,CAAC;oBACN,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,GAAG,GAAG,CAAC,CAAC;gBACpC,CAAC;gBACD,OAAO;YACX;gBACI,uCAAuC;gBACvC,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,EAAW,EAAE,KAAe;QAChD,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC1B,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,EAAW;QAC9B,OAAO,CAAC,EAAE,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9D,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,KAAc,EAAE,KAAe;QAChD,MAAM,IAAI,GAAG,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,UAAU,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACf,MAAM,KAAK,GAAG,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,YAAY,GAAa,EAAE,CAAC;YAElC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACjB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YAEH,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,KAAK,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAE9C,iCAAiC;gBACjC,IAAI,UAAU,EAAE,CAAC;oBACb,KAAK,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC/D,UAAU,GAAG,KAAK,CAAC;gBACvB,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,kBAAkB,CAAC,QAAgB;QACvC,MAAM,OAAO,GAA2B;YACpC,WAAW,EAAE,MAAM;YACnB,YAAY,EAAE,SAAgB;YAC9B,eAAe,EAAE,IAAI;YACrB,UAAU,EAAE,KAAK;YACjB,kBAAkB,EAAE,MAAM;YAC1B,iBAAiB,EAAE,KAAK;YACxB,wBAAwB,EAAE,IAAI;SACjC,CAAC;QAEF,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACpD,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,OAAO,OAAO,CAAC;YACnB,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;;AAhTL,8CAiTC;AA9S2B,uCAAqB,GAAG;IAC5C,WAAW;IACX,kBAAkB;IAClB,iBAAiB;IACjB,wBAAwB;IACxB,YAAY;IACZ,eAAe;IACf,UAAU;CACb,CAAC"}

package/lib/FileFetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FileFetcher.d.ts","sourceRoot":"","sources":["../src/FileFetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,qBAAa,WAAY,YAAW,WAAW;IAC9B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAyB/I"}
+{"version":3,"file":"FileFetcher.d.ts","sourceRoot":"","sources":["../src/FileFetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,qBAAa,WAAY,YAAW,WAAW;IAChC,KAAK,CAChB,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,GACxF,OAAO,CAAC,OAAO,CAAC;CAkCpB"}

package/lib/FileFetcher.js

@@ -41,36 +41,46 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileFetcher = void 0;
-const fs = __importStar(require("fs/promises"));
-const path = __importStar(require("path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const path = __importStar(require("node:path"));
 class FileFetcher {
     fetch(uri, onDocument) {
         return __awaiter(this, void 0, void 0, function* () {
             // Does path exist and is it a directory?
-            let isDirectory;
+            let stat;
             try {
-                const stat = yield fs.stat(uri);
-                isDirectory = stat.isDirectory();
+                stat = yield node_fs_1.default.promises.stat(uri);
             }
             catch (_a) {
+                // Non-existent path: treat as no-op success
                 return true;
             }
-            // If directory, read all files and recurse
-            if (isDirectory) {
-                const files = yield fs.readdir(uri);
-                for (const file of files) {
+            if (stat.isDirectory()) {
+                // Read directory and recurse. If any child returns false, aggregate to false.
+                const entries = yield node_fs_1.default.promises.readdir(uri);
+                let allOk = true;
+                for (const file of entries) {
                     const filePath = path.join(uri, file);
-                    yield this.fetch(filePath, onDocument);
+                    const ok = yield this.fetch(filePath, onDocument);
+                    if (!ok) {
+                        allOk = false;
+                    }
                 }
-                return true;
+                return allOk;
             }
             else {
-                // Read file and call onDocument
-                const text = yield fs.readFile(uri, 'utf8');
-                const parts = uri.split('.');
-                return yield onDocument(uri, text, parts.length > 0 ? parts[parts.length - 1].toLowerCase() : undefined);
+                // Read file and invoke onDocument
+                const text = yield node_fs_1.default.promises.readFile(uri, 'utf8');
+                const ext = path.extname(uri);
+                const docType = ext && ext.length > 1
+                    ? ext.slice(1).toLowerCase()
+                    : path.basename(uri).toLowerCase();
+                return yield onDocument(uri, text, docType);
             }
         });
     }