@yoch/frozenminisearch 1.0.1 → 1.1.0

package/dist/es/index.d.ts

@@ -411,6 +411,21 @@ 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;
@@ -444,7 +459,7 @@ interface FrozenMemoryBreakdown {
 /**
  * Low-level parameters for {@link assembleFrozen} (custom frozen index pipelines).
  * Field types are part of the public surface for advanced assembly; typical apps use
- * {@link buildFrozenFromDocuments}, {@link FrozenMiniSearch.fromMiniSearchJson}, or binary load instead.
+ * {@link buildFrozenFromDocuments}, {@link FrozenMiniSearch.fromJson}, or binary load instead.
  */
 interface FrozenAssembleParams<T = any> {
     options: OptionsWithDefaults<T>;
@@ -456,7 +471,7 @@ interface FrozenAssembleParams<T = any> {
     fieldCount: number;
     externalIds: unknown[];
     idLookup: IdToShortIdLookup;
-    storedFields: (Record<string, unknown> | undefined)[];
+    storedFields: StoredFieldsLayout;
     fieldLengthMatrix: FieldLengthArray;
     avgFieldLength: Float32Array;
     index: FrozenTermIndex;
@@ -464,7 +479,7 @@ interface FrozenAssembleParams<T = any> {
     postings: FrozenPostingsLayout;
 }
 
-/** Lucaong MiniSearch JSON snapshot (`toJSON` / `loadJSON` wire format). */
+/** MiniSearch JSON snapshot (`toJSON` wire format, `serializationVersion` 1 or 2). */
 type SerializedIndexEntry = Record<string, number>;
 type MiniSearchSnapshot = {
     documentCount: number;
@@ -592,17 +607,26 @@ declare class FrozenMiniSearch<T = any> {
     /** Build a read-only index in one pass from documents. */
     static fromDocuments<T>(documents: readonly T[], options: Options<T>): FrozenMiniSearch<T>;
     /**
-     * Convert a lucaong MiniSearch JSON snapshot (`toJSON` / `loadJSON` wire format) into a
-     * frozen index. No runtime dependency on the `minisearch` package.
+     * Export this index as a MiniSearch wire snapshot (`serializationVersion: 2`).
+     * Use for migration or interchange with the `minisearch` package (`JSON.stringify` works via this method).
+     * Not the primary persistence format — prefer {@link saveBinarySync} for production (size and load time).
+     * Term order in `index` may differ from MiniSearch native `toJSON`; search scores stay equivalent.
+     */
+    toJSON(): MiniSearchSnapshot;
+    /**
+     * Build a new frozen index **from** a MiniSearch JSON snapshot string (import / migration).
+     * Accepts the wire format produced by MiniSearch `toJSON` or by {@link toJSON} on this class.
+     * Distinct from {@link loadBinarySync}: JSON is MiniSearch interchange, not the native frozen binary.
+     * No runtime dependency on the `minisearch` package.
      */
-    static fromMiniSearchJson<T>(json: string, options?: Options<T>): FrozenMiniSearch<T>;
+    static fromJson<T>(json: string, options?: Options<T>): FrozenMiniSearch<T>;
     /**
-     * Same as {@link fromMiniSearchJson} with a pre-parsed snapshot object.
+     * Same as {@link fromJson} with a pre-parsed snapshot object.
      * `storedFields` are shallow-copied; callers must not mutate nested values
      * after load if they intend to keep the index immutable.
      */
     static fromMiniSearchSnapshot<T>(snapshot: MiniSearchSnapshot, options?: Options<T>): FrozenMiniSearch<T>;
-    /** Accepts any object exposing `toJSON()` in lucaong MiniSearch snapshot shape. */
+    /** Accepts any object exposing `toJSON()` in MiniSearch snapshot shape. */
     static fromMiniSearch<T>(source: {
         toJSON(): MiniSearchSnapshot;
     }, options?: Options<T>): FrozenMiniSearch<T>;