@outfitter/index 0.1.0-rc.1 → 0.1.0-rc.2

package/dist/fts5.d.ts

@@ -1,286 +1,4 @@
-import { Database } from "bun:sqlite";
-import { StorageError } from "@outfitter/contracts";
-import { Result } from "@outfitter/contracts";
-interface MigrationRegistry<TContext> {
-	register(fromVersion: number, toVersion: number, migrate: (context: TContext) => Result<void, StorageError>): void;
-	migrate(context: TContext, fromVersion: number, toVersion: number): Result<void, StorageError>;
-}
-interface IndexMigrationContext {
-	readonly db: Database;
-}
-type IndexMigrationRegistry = MigrationRegistry<IndexMigrationContext>;
-import { Result as Result2, StorageError as StorageError2 } from "@outfitter/contracts";
-/**
-* FTS5 tokenizer options for text analysis.
-*
-* - `unicode61`: Default tokenizer with Unicode support (recommended for most use cases)
-* - `porter`: Applies Porter stemming algorithm for English text (finds related word forms)
-* - `trigram`: Splits text into 3-character sequences (good for substring matching)
-*/
-type TokenizerType = "unicode61" | "porter" | "trigram";
-/**
-* Options for creating an FTS5 index.
-*
-* @example
-* ```typescript
-* const options: IndexOptions = {
-*   path: "/path/to/index.db",
-*   tableName: "documents",
-*   tokenizer: "porter",
-* };
-*
-* const index = createIndex(options);
-* ```
-*/
-interface IndexOptions {
-	/**
-	* Absolute path to the SQLite database file.
-	* The file will be created if it does not exist.
-	*/
-	path: string;
-	/**
-	* Name of the FTS5 virtual table.
-	* @defaultValue "documents"
-	*/
-	tableName?: string;
-	/**
-	* FTS5 tokenizer for text analysis.
-	* @defaultValue "unicode61"
-	*/
-	tokenizer?: TokenizerType;
-	/**
-	* Optional tool identifier recorded in index metadata.
-	*/
-	tool?: string;
-	/**
-	* Optional tool version recorded in index metadata.
-	*/
-	toolVersion?: string;
-	/**
-	* Optional migration registry for upgrading older index versions.
-	*/
-	migrations?: IndexMigrationRegistry;
-}
-/**
-* A document to be indexed in the FTS5 index.
-*
-* Documents have a unique ID, searchable content, and optional metadata.
-* The metadata is stored as JSON and can be used to attach additional
-* information that is returned with search results.
-*
-* @example
-* ```typescript
-* const doc: IndexDocument = {
-*   id: "note-123",
-*   content: "This is the searchable text content",
-*   metadata: { title: "My Note", createdAt: Date.now() },
-* };
-* ```
-*/
-interface IndexDocument {
-	/** Unique identifier for this document */
-	id: string;
-	/** Searchable text content */
-	content: string;
-	/**
-	* Optional metadata associated with the document.
-	* Stored as JSON and returned with search results.
-	*/
-	metadata?: Record<string, unknown>;
-}
-/**
-* Query parameters for searching the FTS5 index.
-*
-* Uses FTS5 query syntax which supports:
-* - Simple terms: `search term`
-* - Phrases: `"exact phrase"`
-* - Boolean operators: `term1 AND term2`, `term1 OR term2`, `NOT term`
-* - Prefix matching: `term*`
-* - Grouping: `(term1 OR term2) AND term3`
-*
-* @example
-* ```typescript
-* // Simple search
-* const query1: SearchQuery = { query: "typescript" };
-*
-* // Phrase search with pagination
-* const query2: SearchQuery = {
-*   query: '"error handling"',
-*   limit: 10,
-*   offset: 20,
-* };
-* ```
-*/
-interface SearchQuery {
-	/** FTS5 query string */
-	query: string;
-	/**
-	* Maximum number of results to return.
-	* @defaultValue 25
-	*/
-	limit?: number;
-	/**
-	* Number of results to skip (for pagination).
-	* @defaultValue 0
-	*/
-	offset?: number;
-}
-/**
-* A single search result from an FTS5 query.
-*
-* Results include the document ID, BM25 relevance score, content,
-* and any associated metadata. Optional highlights show matching
-* snippets from the content.
-*
-* @typeParam T - Type of the metadata (defaults to `unknown`)
-*
-* @example
-* ```typescript
-* interface NoteMetadata {
-*   title: string;
-*   tags: string[];
-* }
-*
-* const result: SearchResult<NoteMetadata> = {
-*   id: "note-123",
-*   score: 0.85,
-*   content: "Full document content...",
-*   metadata: { title: "My Note", tags: ["typescript"] },
-*   highlights: ["...matching <b>snippet</b>..."],
-* };
-* ```
-*/
-interface SearchResult<T = unknown> {
-	/** Document ID */
-	id: string;
-	/**
-	* BM25 relevance ranking score.
-	* Higher scores indicate better matches.
-	* Note: FTS5 BM25 returns negative values (closer to 0 = better match).
-	*/
-	score: number;
-	/** Full document content */
-	content: string;
-	/** Document metadata (if present) */
-	metadata?: T;
-	/**
-	* Matching snippets from the content.
-	* Uses FTS5 snippet() function for context-aware highlights.
-	*/
-	highlights?: string[];
-}
-/**
-* The FTS5 index interface for full-text search operations.
-*
-* Provides methods for adding, searching, and removing documents
-* from an SQLite FTS5 index. All operations return `Result` types
-* for explicit error handling.
-*
-* @typeParam T - Type of document metadata (defaults to `unknown`)
-*
-* @example
-* ```typescript
-* const index = createIndex<NoteMetadata>({ path: "./index.db" });
-*
-* // Add documents
-* await index.add({ id: "1", content: "Hello world", metadata: { title: "Greeting" } });
-*
-* // Search
-* const results = await index.search({ query: "hello" });
-* if (results.isOk()) {
-*   for (const result of results.value) {
-*     console.log(result.id, result.score);
-*   }
-* }
-*
-* // Cleanup
-* index.close();
-* ```
-*/
-interface Index<T = unknown> {
-	/**
-	* Add a single document to the index.
-	* If a document with the same ID exists, it will be replaced.
-	*
-	* @param doc - Document to add
-	* @returns Result indicating success or StorageError
-	*/
-	add(doc: IndexDocument): Promise<Result2<void, StorageError2>>;
-	/**
-	* Add multiple documents to the index in a single transaction.
-	* More efficient than calling add() multiple times.
-	* If a document with the same ID exists, it will be replaced.
-	*
-	* @param docs - Array of documents to add
-	* @returns Result indicating success or StorageError
-	*/
-	addMany(docs: IndexDocument[]): Promise<Result2<void, StorageError2>>;
-	/**
-	* Search the index using FTS5 query syntax.
-	* Returns results ranked by BM25 relevance score.
-	*
-	* @param query - Search query parameters
-	* @returns Result containing array of search results or StorageError
-	*/
-	search(query: SearchQuery): Promise<Result2<SearchResult<T>[], StorageError2>>;
-	/**
-	* Remove a document from the index by ID.
-	* No error is returned if the document does not exist.
-	*
-	* @param id - Document ID to remove
-	* @returns Result indicating success or StorageError
-	*/
-	remove(id: string): Promise<Result2<void, StorageError2>>;
-	/**
-	* Remove all documents from the index.
-	*
-	* @returns Result indicating success or StorageError
-	*/
-	clear(): Promise<Result2<void, StorageError2>>;
-	/**
-	* Close the index and release resources.
-	* The index should not be used after calling close().
-	*/
-	close(): void;
-}
-/**
-* Creates an FTS5 full-text search index.
-*
-* Uses SQLite FTS5 virtual table for fast full-text search with BM25 ranking.
-* The database is configured with WAL mode for better concurrency.
-*
-* @typeParam T - Type of document metadata (defaults to `unknown`)
-* @param options - Index options including database path and table configuration
-* @returns An Index instance for managing documents and searching
-*
-* @example
-* ```typescript
-* // Create an index with default settings
-* const index = createIndex({ path: "./data/index.db" });
-*
-* // Add documents
-* await index.add({
-*   id: "doc-1",
-*   content: "Hello world",
-*   metadata: { title: "Greeting" },
-* });
-*
-* // Search
-* const results = await index.search({ query: "hello" });
-*
-* // Cleanup
-* index.close();
-* ```
-*
-* @example
-* ```typescript
-* // Create an index with Porter stemmer for English text
-* const index = createIndex({
-*   path: "./data/notes.db",
-*   tableName: "notes_fts",
-*   tokenizer: "porter",
-* });
-* ```
-*/
-declare function createIndex<T = unknown>(options: IndexOptions): Index<T>;
+import { createIndex } from "./shared/@outfitter/index-ewvzd5f9";
+import "./shared/@outfitter/index-m0h11hv5";
+import "./shared/@outfitter/index-mmgx1j0h";
 export { createIndex };

package/dist/fts5.js

@@ -1,252 +1,8 @@
 // @bun
 import {
-  INDEX_META_KEY,
-  INDEX_META_TABLE,
-  INDEX_VERSION
-} from "./version.js";
-
-// packages/index/src/fts5.ts
-import { Database } from "bun:sqlite";
-import { existsSync, mkdirSync } from "fs";
-import { dirname } from "path";
-import { Result } from "@outfitter/contracts";
-var DEFAULT_TABLE_NAME = "documents";
-var DEFAULT_TOKENIZER = "unicode61";
-var DEFAULT_LIMIT = 25;
-var DEFAULT_OFFSET = 0;
-var VALID_TOKENIZERS = {
-  unicode61: true,
-  porter: true,
-  trigram: true
-};
-var TABLE_NAME_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
-var DEFAULT_TOOL = "outfitter-index";
-var DEFAULT_TOOL_VERSION = "0.0.0";
-function createStorageError(message, cause) {
-  return {
-    _tag: "StorageError",
-    message,
-    cause
-  };
-}
-function assertValidTableName(tableName) {
-  if (!TABLE_NAME_PATTERN.test(tableName)) {
-    throw new Error(`Invalid table name: ${tableName}`);
-  }
-}
-function assertValidTokenizer(tokenizer) {
-  if (!Object.hasOwn(VALID_TOKENIZERS, tokenizer)) {
-    throw new Error(`Invalid tokenizer: ${tokenizer}`);
-  }
-  return tokenizer;
-}
-function getUserVersion(db) {
-  const row = db.query("PRAGMA user_version").get();
-  return row?.user_version ?? 0;
-}
-function setUserVersion(db, version) {
-  if (!Number.isInteger(version) || version < 0) {
-    throw new Error(`Invalid user_version: ${version}`);
-  }
-  db.run(`PRAGMA user_version = ${version}`);
-}
-function ensureMetaTable(db) {
-  db.run(`CREATE TABLE IF NOT EXISTS ${INDEX_META_TABLE} (key TEXT PRIMARY KEY, value TEXT NOT NULL)`);
-}
-function readIndexMetadata(db) {
-  try {
-    const row = db.query(`SELECT value FROM ${INDEX_META_TABLE} WHERE key = ?`).get(INDEX_META_KEY);
-    if (!row) {
-      return null;
-    }
-    const parsed = JSON.parse(row.value);
-    return parsed;
-  } catch {
-    return null;
-  }
-}
-function writeIndexMetadata(db, metadata) {
-  ensureMetaTable(db);
-  db.run(`INSERT OR REPLACE INTO ${INDEX_META_TABLE} (key, value) VALUES (?, ?)`, [INDEX_META_KEY, JSON.stringify(metadata)]);
-}
-function createIndex(options) {
-  const tableName = options.tableName ?? DEFAULT_TABLE_NAME;
-  assertValidTableName(tableName);
-  const tokenizer = assertValidTokenizer(options.tokenizer ?? DEFAULT_TOKENIZER);
-  const tool = options.tool ?? DEFAULT_TOOL;
-  const toolVersion = options.toolVersion ?? DEFAULT_TOOL_VERSION;
-  const dir = dirname(options.path);
-  if (!existsSync(dir)) {
-    mkdirSync(dir, { recursive: true });
-  }
-  const db = new Database(options.path);
-  db.run("PRAGMA journal_mode=WAL");
-  const currentVersion = getUserVersion(db);
-  if (currentVersion === 0) {
-    const metadata = {
-      version: INDEX_VERSION,
-      created: new Date().toISOString(),
-      tool,
-      toolVersion
-    };
-    setUserVersion(db, INDEX_VERSION);
-    writeIndexMetadata(db, metadata);
-  } else if (currentVersion !== INDEX_VERSION) {
-    if (!options.migrations) {
-      throw new Error(`Index version ${currentVersion} does not match ${INDEX_VERSION}. Provide migrations or rebuild the index.`);
-    }
-    const context = { db };
-    const result = options.migrations.migrate(context, currentVersion, INDEX_VERSION);
-    if (result.isErr()) {
-      throw new Error(`Failed to migrate index: ${result.error.message}`);
-    }
-    const existing = readIndexMetadata(db);
-    const metadata = {
-      version: INDEX_VERSION,
-      created: existing?.created ?? new Date().toISOString(),
-      tool,
-      toolVersion
-    };
-    setUserVersion(db, INDEX_VERSION);
-    writeIndexMetadata(db, metadata);
-  } else if (!readIndexMetadata(db)) {
-    const metadata = {
-      version: INDEX_VERSION,
-      created: new Date().toISOString(),
-      tool,
-      toolVersion
-    };
-    writeIndexMetadata(db, metadata);
-  }
-  db.run(`
-		CREATE VIRTUAL TABLE IF NOT EXISTS ${tableName}
-		USING fts5(
-			id UNINDEXED,
-			content,
-			metadata UNINDEXED,
-			tokenize='${tokenizer}'
-		)
-	`);
-  let isClosed = false;
-  function checkClosed() {
-    if (isClosed) {
-      return Result.err(createStorageError("Index is closed"));
-    }
-    return Result.ok(undefined);
-  }
-  return {
-    async add(doc) {
-      const closedCheck = checkClosed();
-      if (closedCheck.isErr()) {
-        return closedCheck;
-      }
-      try {
-        const metadataJson = doc.metadata ? JSON.stringify(doc.metadata) : null;
-        db.run(`DELETE FROM ${tableName} WHERE id = ?`, [doc.id]);
-        db.run(`INSERT INTO ${tableName} (id, content, metadata) VALUES (?, ?, ?)`, [doc.id, doc.content, metadataJson]);
-        return Result.ok(undefined);
-      } catch (error) {
-        return Result.err(createStorageError(error instanceof Error ? error.message : "Failed to add document", error));
-      }
-    },
-    async addMany(docs) {
-      const closedCheck = checkClosed();
-      if (closedCheck.isErr()) {
-        return closedCheck;
-      }
-      try {
-        db.run("BEGIN TRANSACTION");
-        try {
-          const deleteStmt = db.prepare(`DELETE FROM ${tableName} WHERE id = ?`);
-          const insertStmt = db.prepare(`INSERT INTO ${tableName} (id, content, metadata) VALUES (?, ?, ?)`);
-          for (const doc of docs) {
-            const metadataJson = doc.metadata ? JSON.stringify(doc.metadata) : null;
-            deleteStmt.run(doc.id);
-            insertStmt.run(doc.id, doc.content, metadataJson);
-          }
-          deleteStmt.finalize();
-          insertStmt.finalize();
-          db.run("COMMIT");
-          return Result.ok(undefined);
-        } catch (error) {
-          db.run("ROLLBACK");
-          throw error;
-        }
-      } catch (error) {
-        return Result.err(createStorageError(error instanceof Error ? error.message : "Failed to add documents", error));
-      }
-    },
-    async search(query) {
-      const closedCheck = checkClosed();
-      if (closedCheck.isErr()) {
-        return closedCheck;
-      }
-      const limit = query.limit ?? DEFAULT_LIMIT;
-      const offset = query.offset ?? DEFAULT_OFFSET;
-      try {
-        const rows = db.query(`
-					SELECT
-						id,
-						content,
-						metadata,
-						bm25(${tableName}) as score,
-						snippet(${tableName}, 1, '<b>', '</b>', '...', 32) as highlight
-					FROM ${tableName}
-					WHERE ${tableName} MATCH ?
-					ORDER BY bm25(${tableName}) ASC
-					LIMIT ? OFFSET ?
-				`).all(query.query, limit, offset);
-        const results = rows.map((row) => {
-          const result = {
-            id: row.id,
-            content: row.content,
-            score: row.score,
-            highlights: [row.highlight]
-          };
-          if (row.metadata) {
-            try {
-              result.metadata = JSON.parse(row.metadata);
-            } catch {}
-          }
-          return result;
-        });
-        return Result.ok(results);
-      } catch (error) {
-        return Result.err(createStorageError(error instanceof Error ? error.message : "Search failed", error));
-      }
-    },
-    async remove(id) {
-      const closedCheck = checkClosed();
-      if (closedCheck.isErr()) {
-        return closedCheck;
-      }
-      try {
-        db.run(`DELETE FROM ${tableName} WHERE id = ?`, [id]);
-        return Result.ok(undefined);
-      } catch (error) {
-        return Result.err(createStorageError(error instanceof Error ? error.message : "Failed to remove document", error));
-      }
-    },
-    async clear() {
-      const closedCheck = checkClosed();
-      if (closedCheck.isErr()) {
-        return closedCheck;
-      }
-      try {
-        db.run(`DELETE FROM ${tableName}`);
-        return Result.ok(undefined);
-      } catch (error) {
-        return Result.err(createStorageError(error instanceof Error ? error.message : "Failed to clear index", error));
-      }
-    },
-    close() {
-      if (!isClosed) {
-        isClosed = true;
-        db.close();
-      }
-    }
-  };
-}
+  createIndex
+} from "./shared/@outfitter/index-gf30ny51.js";
+import"./shared/@outfitter/index-bbzmc40h.js";
 export {
   createIndex
 };