@outfitter/index 0.2.1 → 0.2.3

package/dist/fts5.d.ts

@@ -1,4 +1,4 @@
-import { createIndex } from "./shared/@outfitter/index-ewvzd5f9";
-import "./shared/@outfitter/index-m0h11hv5";
-import "./shared/@outfitter/index-mmgx1j0h";
+import { createIndex } from "./shared/@outfitter/index-ykxa3yhb.js";
+import "./shared/@outfitter/index-011azjav.js";
+import "./shared/@outfitter/index-dxk50kvh.js";
 export { createIndex };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { createIndex } from "./shared/@outfitter/index-ewvzd5f9";
-import { Index, IndexDocument, IndexMetadata, IndexOptions, SearchQuery, SearchResult, TokenizerType } from "./shared/@outfitter/index-m0h11hv5";
-import { INDEX_VERSION } from "./shared/@outfitter/index-3xe3cd6r";
-import { IndexMigrationRegistry, createMigrationRegistry } from "./shared/@outfitter/index-mmgx1j0h";
+import { createIndex } from "./shared/@outfitter/index-ykxa3yhb.js";
+import { INDEX_VERSION } from "./shared/@outfitter/index-3xe3cd6r.js";
+import { Index, IndexDocument, IndexMetadata, IndexOptions, SearchQuery, SearchResult, TokenizerType } from "./shared/@outfitter/index-011azjav.js";
+import { IndexMigrationRegistry, createMigrationRegistry } from "./shared/@outfitter/index-dxk50kvh.js";
 export { createMigrationRegistry, createIndex, TokenizerType, SearchResult, SearchQuery, IndexOptions, IndexMigrationRegistry, IndexMetadata, IndexDocument, Index, INDEX_VERSION };

package/dist/index.js

@@ -2,13 +2,13 @@
 import {
   createIndex
 } from "./shared/@outfitter/index-gf30ny51.js";
-import"./shared/@outfitter/index-8fwmfq7d.js";
-import {
-  INDEX_VERSION
-} from "./shared/@outfitter/index-bbzmc40h.js";
 import {
   createMigrationRegistry
 } from "./shared/@outfitter/index-1me624ny.js";
+import {
+  INDEX_VERSION
+} from "./shared/@outfitter/index-bbzmc40h.js";
+import"./shared/@outfitter/index-8fwmfq7d.js";
 export {
   createMigrationRegistry,
   createIndex,

package/dist/migrations.d.ts

@@ -1,2 +1,2 @@
-import { IndexMigrationContext, IndexMigrationRegistry, MigrationRegistry, createMigrationRegistry } from "./shared/@outfitter/index-mmgx1j0h";
+import { IndexMigrationContext, IndexMigrationRegistry, MigrationRegistry, createMigrationRegistry } from "./shared/@outfitter/index-dxk50kvh.js";
 export { createMigrationRegistry, MigrationRegistry, IndexMigrationRegistry, IndexMigrationContext };

package/dist/shared/@outfitter/{index-m0h11hv5.d.ts → index-011azjav.d.ts}

@@ -1,4 +1,4 @@
-import { IndexMigrationRegistry } from "./index-mmgx1j0h";
+import { IndexMigrationRegistry } from "./index-dxk50kvh.js";
 import { Result, StorageError } from "@outfitter/contracts";
 /**
 * FTS5 tokenizer options for text analysis.
@@ -23,6 +23,10 @@ type TokenizerType = "unicode61" | "porter" | "trigram";
 * ```
 */
 interface IndexOptions {
+	/**
+	* Optional migration registry for upgrading older index versions.
+	*/
+	migrations?: IndexMigrationRegistry;
 	/**
 	* Absolute path to the SQLite database file.
 	* The file will be created if it does not exist.
@@ -46,23 +50,19 @@ interface IndexOptions {
 	* 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;
+	/** File format version */
+	version: number;
 }
 /**
 * A document to be indexed in the FTS5 index.
@@ -81,10 +81,10 @@ interface IndexMetadata {
 * ```
 */
 interface IndexDocument {
-	/** Unique identifier for this document */
-	id: string;
 	/** Searchable text content */
 	content: string;
+	/** Unique identifier for this document */
+	id: string;
 	/**
 	* Optional metadata associated with the document.
 	* Stored as JSON and returned with search results.
@@ -115,8 +115,6 @@ interface IndexDocument {
 * ```
 */
 interface SearchQuery {
-	/** FTS5 query string */
-	query: string;
 	/**
 	* Maximum number of results to return.
 	* @defaultValue 25
@@ -127,6 +125,8 @@ interface SearchQuery {
 	* @defaultValue 0
 	*/
 	offset?: number;
+	/** FTS5 query string */
+	query: string;
 }
 /**
 * A single search result from an FTS5 query.
@@ -154,23 +154,23 @@ interface SearchQuery {
 * ```
 */
 interface SearchResult<T = unknown> {
+	/** Full document content */
+	content: string;
+	/**
+	* Matching snippets from the content.
+	* Uses FTS5 snippet() function for context-aware highlights.
+	*/
+	highlights?: string[];
 	/** Document ID */
 	id: string;
+	/** Document metadata (if present) */
+	metadata?: T;
 	/**
 	* 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.
@@ -219,13 +219,16 @@ interface Index<T = unknown> {
 	*/
 	addMany(docs: IndexDocument[]): Promise<Result<void, StorageError>>;
 	/**
-	* Search the index using FTS5 query syntax.
-	* Returns results ranked by BM25 relevance score.
+	* Remove all documents from the index.
 	*
-	* @param query - Search query parameters
-	* @returns Result containing array of search results or StorageError
+	* @returns Result indicating success or StorageError
 	*/
-	search(query: SearchQuery): Promise<Result<SearchResult<T>[], StorageError>>;
+	clear(): Promise<Result<void, StorageError>>;
+	/**
+	* Close the index and release resources.
+	* The index should not be used after calling close().
+	*/
+	close(): void;
 	/**
 	* Remove a document from the index by ID.
 	* No error is returned if the document does not exist.
@@ -235,15 +238,12 @@ interface Index<T = unknown> {
 	*/
 	remove(id: string): Promise<Result<void, StorageError>>;
 	/**
-	* Remove all documents from the index.
+	* Search the index using FTS5 query syntax.
+	* Returns results ranked by BM25 relevance score.
 	*
-	* @returns Result indicating success or StorageError
-	*/
-	clear(): Promise<Result<void, StorageError>>;
-	/**
-	* Close the index and release resources.
-	* The index should not be used after calling close().
+	* @param query - Search query parameters
+	* @returns Result containing array of search results or StorageError
 	*/
-	close(): void;
+	search(query: SearchQuery): Promise<Result<SearchResult<T>[], StorageError>>;
 }
 export { TokenizerType, IndexOptions, IndexMetadata, IndexDocument, SearchQuery, SearchResult, Index };

package/dist/shared/@outfitter/{index-ewvzd5f9.d.ts → index-ykxa3yhb.d.ts}

@@ -1,4 +1,4 @@
-import { Index, IndexOptions } from "./index-m0h11hv5";
+import { Index, IndexOptions } from "./index-011azjav.js";
 /**
 * Creates an FTS5 full-text search index.
 *

package/dist/types.d.ts

@@ -1,3 +1,3 @@
-import { Index, IndexDocument, IndexMetadata, IndexOptions, SearchQuery, SearchResult, TokenizerType } from "./shared/@outfitter/index-m0h11hv5";
-import "./shared/@outfitter/index-mmgx1j0h";
+import { Index, IndexDocument, IndexMetadata, IndexOptions, SearchQuery, SearchResult, TokenizerType } from "./shared/@outfitter/index-011azjav.js";
+import "./shared/@outfitter/index-dxk50kvh.js";
 export { TokenizerType, SearchResult, SearchQuery, IndexOptions, IndexMetadata, IndexDocument, Index };

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-import { INDEX_META_KEY, INDEX_META_TABLE, INDEX_VERSION } from "./shared/@outfitter/index-3xe3cd6r";
+import { INDEX_META_KEY, INDEX_META_TABLE, INDEX_VERSION } from "./shared/@outfitter/index-3xe3cd6r.js";
 export { INDEX_VERSION, INDEX_META_TABLE, INDEX_META_KEY };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outfitter/index",
   "description": "SQLite FTS5 full-text search indexing for Outfitter",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "type": "module",
   "files": [
     "dist"
@@ -48,11 +48,12 @@
     "lint:fix": "biome lint --write ./src",
     "test": "bun test",
     "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "prepublishOnly": "bun ../../scripts/check-publish-manifest.ts"
   },
   "dependencies": {
-    "@outfitter/contracts": "0.3.0",
-    "@outfitter/file-ops": "0.2.1"
+    "@outfitter/contracts": "0.4.1",
+    "@outfitter/file-ops": "0.2.3"
   },
   "devDependencies": {
     "@types/bun": "latest",

package/dist/shared/@outfitter/{index-mmgx1j0h.d.ts → index-dxk50kvh.d.ts}

@@ -2,8 +2,8 @@ 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>;
+	register(fromVersion: number, toVersion: number, migrate: (context: TContext) => Result<void, StorageError>): void;
 }
 interface IndexMigrationContext {
 	readonly db: Database;