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

package/dist/index.d.ts

@@ -1,304 +1,5 @@
-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>;
-declare function createMigrationRegistry<TContext>(): MigrationRegistry<TContext>;
-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;
-}
-/**
-* Metadata stored alongside the index to track version and provenance.
-*/
-interface IndexMetadata {
-	/** File format version */
-	version: number;
-	/** When this index was created */
-	created: string;
-	/** Tool that created the index */
-	tool: string;
-	/** Tool version that created the index */
-	toolVersion: string;
-}
-/**
-* 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>;
-/**
-* @outfitter/index - Versioning constants
-*/
-declare const INDEX_VERSION = 1;
+import { createIndex } from "./shared/@outfitter/index-ewvzd5f9";
+import { INDEX_VERSION } from "./shared/@outfitter/index-3xe3cd6r";
+import { Index, IndexDocument, IndexMetadata, IndexOptions, SearchQuery, SearchResult, TokenizerType } from "./shared/@outfitter/index-m0h11hv5";
+import { IndexMigrationRegistry, createMigrationRegistry } from "./shared/@outfitter/index-mmgx1j0h";
 export { createMigrationRegistry, createIndex, TokenizerType, SearchResult, SearchQuery, IndexOptions, IndexMigrationRegistry, IndexMetadata, IndexDocument, Index, INDEX_VERSION };

package/dist/index.js

@@ -1,14 +1,14 @@
 // @bun
-import {
-  createMigrationRegistry
-} from "./migrations.js";
-import"./types.js";
 import {
   createIndex
-} from "./fts5.js";
+} from "./shared/@outfitter/index-gf30ny51.js";
+import {
+  createMigrationRegistry
+} from "./shared/@outfitter/index-1me624ny.js";
 import {
   INDEX_VERSION
-} from "./version.js";
+} from "./shared/@outfitter/index-bbzmc40h.js";
+import"./shared/@outfitter/index-8fwmfq7d.js";
 export {
   createMigrationRegistry,
   createIndex,

package/dist/migrations.d.ts

@@ -1,13 +1,2 @@
-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>;
-declare function createMigrationRegistry<TContext>(): MigrationRegistry<TContext>;
+import { IndexMigrationContext, IndexMigrationRegistry, MigrationRegistry, createMigrationRegistry } from "./shared/@outfitter/index-mmgx1j0h";
 export { createMigrationRegistry, MigrationRegistry, IndexMigrationRegistry, IndexMigrationContext };

package/dist/migrations.js

@@ -1,47 +1,7 @@
 // @bun
-// packages/index/src/migrations.ts
-import { Result } from "@outfitter/contracts";
-function createStorageError(message, cause) {
-  return {
-    _tag: "StorageError",
-    message,
-    cause
-  };
-}
-function createMigrationRegistry() {
-  const steps = new Map;
-  return {
-    register(fromVersion, toVersion, migrate) {
-      steps.set(fromVersion, { to: toVersion, migrate });
-    },
-    migrate(context, fromVersion, toVersion) {
-      if (fromVersion === toVersion) {
-        return Result.ok(undefined);
-      }
-      let current = fromVersion;
-      const visited = new Set;
-      while (current < toVersion) {
-        if (visited.has(current)) {
-          return Result.err(createStorageError(`Detected migration loop at version ${current}`));
-        }
-        visited.add(current);
-        const step = steps.get(current);
-        if (!step) {
-          return Result.err(createStorageError(`No migration registered from version ${current}`));
-        }
-        const result = step.migrate(context);
-        if (result.isErr()) {
-          return result;
-        }
-        current = step.to;
-      }
-      if (current !== toVersion) {
-        return Result.err(createStorageError(`Migration ended at version ${current} instead of ${toVersion}`));
-      }
-      return Result.ok(undefined);
-    }
-  };
-}
+import {
+  createMigrationRegistry
+} from "./shared/@outfitter/index-1me624ny.js";
 export {
   createMigrationRegistry
 };

package/dist/shared/@outfitter/index-1me624ny.js

@@ -0,0 +1,46 @@
+// @bun
+// packages/index/src/migrations.ts
+import { Result } from "@outfitter/contracts";
+function createStorageError(message, cause) {
+  return {
+    _tag: "StorageError",
+    message,
+    cause
+  };
+}
+function createMigrationRegistry() {
+  const steps = new Map;
+  return {
+    register(fromVersion, toVersion, migrate) {
+      steps.set(fromVersion, { to: toVersion, migrate });
+    },
+    migrate(context, fromVersion, toVersion) {
+      if (fromVersion === toVersion) {
+        return Result.ok(undefined);
+      }
+      let current = fromVersion;
+      const visited = new Set;
+      while (current < toVersion) {
+        if (visited.has(current)) {
+          return Result.err(createStorageError(`Detected migration loop at version ${current}`));
+        }
+        visited.add(current);
+        const step = steps.get(current);
+        if (!step) {
+          return Result.err(createStorageError(`No migration registered from version ${current}`));
+        }
+        const result = step.migrate(context);
+        if (result.isErr()) {
+          return result;
+        }
+        current = step.to;
+      }
+      if (current !== toVersion) {
+        return Result.err(createStorageError(`Migration ended at version ${current} instead of ${toVersion}`));
+      }
+      return Result.ok(undefined);
+    }
+  };
+}
+
+export { createMigrationRegistry };

package/dist/shared/@outfitter/index-3xe3cd6r.d.ts

@@ -0,0 +1,7 @@
+/**
+* @outfitter/index - Versioning constants
+*/
+declare const INDEX_VERSION = 1;
+declare const INDEX_META_TABLE = "__outfitter_index_meta";
+declare const INDEX_META_KEY = "header";
+export { INDEX_VERSION, INDEX_META_TABLE, INDEX_META_KEY };

package/dist/shared/@outfitter/index-8fwmfq7d.js

@@ -0,0 +1 @@
+// @bun

package/dist/shared/@outfitter/index-bbzmc40h.js

@@ -0,0 +1,7 @@
+// @bun
+// packages/index/src/version.ts
+var INDEX_VERSION = 1;
+var INDEX_META_TABLE = "__outfitter_index_meta";
+var INDEX_META_KEY = "header";
+
+export { INDEX_VERSION, INDEX_META_TABLE, INDEX_META_KEY };

package/dist/shared/@outfitter/index-ewvzd5f9.d.ts

@@ -0,0 +1,42 @@
+import { Index, IndexOptions } from "./index-m0h11hv5";
+/**
+* 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>;
+export { createIndex };