@yoch/frozenminisearch 1.2.2 → 1.2.4

package/dist/es/index.d.ts

@@ -247,9 +247,48 @@ type VacuumConditions = {
  */
 type AutoVacuumOptions = VacuumOptions & VacuumConditions;
 
+/**
+ * Runtime stored fields. Single store field → one column (no per-doc Record at rest).
+ * Wire format stays row JSON; encode/decode can skip intermediate row arrays when layout is known.
+ */
+type StoredFieldsLayout = {
+    kind: 'none';
+} | {
+    kind: 'single';
+    field: string;
+    values: unknown[];
+} | {
+    kind: 'multi';
+    rows: (Record<string, unknown> | undefined)[];
+};
+
 declare const OR: LowercaseCombinationOperator;
 declare const AND: LowercaseCombinationOperator;
 declare const AND_NOT: LowercaseCombinationOperator;
+interface RawResultValue {
+    score: number;
+    terms: string[];
+    match: MatchInfo;
+}
+type RawResult = Map<number, RawResultValue>;
+interface FinalizeSearchParams {
+    rawResults: RawResult;
+    getExternalId: (docId: number) => unknown;
+    getStoredFields?: (docId: number) => Record<string, unknown> | undefined;
+    /** When set, copies stored fields in place (no per-doc row allocation for single-column layouts). */
+    storedFieldsLayout?: StoredFieldsLayout;
+    filter?: (result: SearchResult) => boolean;
+    skipSort?: boolean;
+}
+/** Merge search options, apply wildcard skipSort, then {@link finalizeSearchResults}. */
+declare function finalizeRawSearchResults(rawResults: RawResult, query: Query, searchOptions: SearchOptions, globalSearchOptions: SearchOptionsWithDefaults, getExternalId: (docId: number) => unknown, getStoredFields?: (docId: number) => Record<string, unknown> | undefined, storedFieldsLayout?: StoredFieldsLayout): SearchResult[];
+declare function finalizeSearchResults(params: FinalizeSearchParams): SearchResult[];
+
+type SuggestionHit = Pick<SearchResult, 'score' | 'terms'>;
+/** Aggregate search hits into ranked phrase suggestions. */
+declare function suggestFromSearchResults(hits: Iterable<SuggestionHit>): Suggestion[];
+/** Build suggestions from raw search hits without materializing full public results. */
+declare function suggestFromRawResults(rawResults: RawResult): Suggestion[];
 
 /**
  * Smallest unsigned typed array that can hold the structure's indices. Widths
@@ -425,21 +464,6 @@ interface FrozenPostingsLayout {
 /** Adaptive-width unsigned column (1/2/4 bytes per element) for field lengths and packed radix columns. */
 type FieldLengthArray = PackedIndexArray;
 
-/**
- * Runtime stored fields. Single store field → one column (no per-doc Record at rest).
- * Wire format stays row JSON; encode/decode can skip intermediate row arrays when layout is known.
- */
-type StoredFieldsLayout = {
-    kind: 'none';
-} | {
-    kind: 'single';
-    field: string;
-    values: unknown[];
-} | {
-    kind: 'multi';
-    rows: (Record<string, unknown> | undefined)[];
-};
-
 interface FrozenMemoryBreakdown {
     termCount: number;
     documentCount: number;
@@ -609,6 +633,10 @@ declare class FrozenMiniSearch<T = any> {
     has(id: unknown): boolean;
     getStoredFields(id: unknown): Record<string, unknown> | undefined;
     search(query: Query, searchOptions?: SearchOptions): SearchResult[];
+    /**
+     * Without a `filter`, aggregates suggestions from raw query hits (no full result materialization).
+     * With a `filter`, uses {@link search} so stored fields are available to the predicate.
+     */
     autoSuggest(queryString: string, options?: SearchOptions): Suggestion[];
     /** Serialize this index as a frozen binary snapshot (synchronous). */
     saveBinarySync(saveOptions?: SaveBinaryOptions): Buffer;
@@ -657,5 +685,5 @@ declare class FrozenMiniSearch<T = any> {
     private executeQuery;
 }
 
-export { AND, AND_NOT, FrozenIndexBuilder, FrozenMiniSearch, OR, assembleFrozen, buildFrozenFromDocuments, createFrozenIndexBuilder, FrozenMiniSearch as default, freezeFrozenIndexBuilder, frozenMemoryBreakdown };
+export { AND, AND_NOT, FrozenIndexBuilder, FrozenMiniSearch, OR, assembleFrozen, buildFrozenFromDocuments, createFrozenIndexBuilder, FrozenMiniSearch as default, finalizeRawSearchResults, finalizeSearchResults, freezeFrozenIndexBuilder, frozenMemoryBreakdown, suggestFromRawResults, suggestFromSearchResults };
 export type { BM25Params, BinaryCompression, CombinationOperator, FrozenAssembleParams, FrozenIndexBuilderHints, FrozenMemoryBreakdown, LogLevel, LowercaseCombinationOperator, MatchInfo, MiniSearchSnapshot, Options, Query, QueryCombination, SaveBinaryOptions, SearchOptions, SearchResult, SerializedIndexEntry, Suggestion, Wildcard };