@medusajs/types 2.20.1 → 2.20.2-preview-20260904113944

package/dist/search/index-definition.d.ts

@@ -75,7 +75,7 @@ export interface SearchIndexSettings {
 }
 /**
  * A change to apply to a search index, as returned by an index definition's
- * `consume` function.
+ * `consume` or `seed` function.
  */
 export type SearchMutation = {
     /**
@@ -134,6 +134,18 @@ export interface SearchSeedContext extends SearchIngestionContext {
      * The `last_key` of an interrupted run, when resuming one.
      */
     last_key?: string;
+    /**
+     * Set for the catch-up pass that runs after a full seed, to pick up
+     * anything that changed while that seed was running.
+     */
+    catchup?: {
+        /**
+         * Only rows updated at or after this date matter to the catch-up pass.
+         * Query with `withDeleted: true` and yield a `delete` mutation for a row
+         * whose `deleted_at` is set, an `upsert` otherwise.
+         */
+        since: Date;
+    };
 }
 /**
  * One search index, declared. The module owns everything around it: creating and
@@ -179,10 +191,11 @@ export interface SearchIndexDefinition {
      */
     consume?: (event: Event<any>, context: SearchIngestionContext) => Promise<SearchMutation[]>;
     /**
-     * Yields the index's documents in batches. Ran when there is no data in the
-     * index or on reindex.
+     * Yields mutations in batches — the same shape `consume` returns, so a
+     * seed can express a delete, not just an upsert. Ran when there is no data
+     * in the index, on reindex, and for the catch-up pass after a full seed.
      */
-    seed: (context: SearchSeedContext) => AsyncIterable<SearchDocument[]>;
+    seed: (context: SearchSeedContext) => AsyncIterable<SearchMutation[]>;
 }
 /**
  * An index definition with the module's defaults applied and a provider resolved.
@@ -206,8 +219,10 @@ export interface ResolvedSearchIndexDefinition extends SearchIndexDefinition {
      */
     definition_hash: string;
     /**
-     * The concrete index the provider reads and writes. Differs from `name` under
-     * an index prefix, or while a `swap` builds into a replacement.
+     * The root physical index name, derived from `name` and the module's
+     * `index_prefix`. Never queried directly: each version of this index gets its
+     * own physical index derived from this root, and the module resolves which
+     * one is currently active before reading or writing.
      */
     physical_name: string;
 }

package/dist/search/index-definition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index-definition.d.ts","sourceRoot":"","sources":["../../src/search/index-definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAEzC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE;QACf;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAA;QAEjB;;WAEG;QACH,0BAA0B,CAAC,EAAE,MAAM,CAAA;QAEnC;;WAEG;QACH,2BAA2B,CAAC,EAAE,MAAM,CAAA;QAEpC;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAA;KAClC,CAAA;IAED;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAE7B;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;KAC5B,CAAA;IAED;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;IAED;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC3D;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB;IACE;;;OAGG;IACH,MAAM,EAAE,QAAQ,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,cAAc,EAAE,CAAA;CAC5B;AACH;;;;;GAKG;GACD;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,aAAa,CAAA;CAAE,CAAA;AAEhD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,mBAAmB,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAA;IAE1B;;OAEG;IACH,KAAK,EAAE,qBAAqB,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,sBAAsB;IAC/D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAE7C;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EACjB,OAAO,EAAE,sBAAsB,KAC5B,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE9B;;;OAGG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,aAAa,CAAC,cAAc,EAAE,CAAC,CAAA;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,mBAAmB,CAAA;IAE7B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB"}
+{"version":3,"file":"index-definition.d.ts","sourceRoot":"","sources":["../../src/search/index-definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAEzC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE;QACf;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAA;QAEjB;;WAEG;QACH,0BAA0B,CAAC,EAAE,MAAM,CAAA;QAEnC;;WAEG;QACH,2BAA2B,CAAC,EAAE,MAAM,CAAA;QAEpC;;WAEG;QACH,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAA;KAClC,CAAA;IAED;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAE7B;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;KAC5B,CAAA;IAED;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;IAED;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC3D;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB;IACE;;;OAGG;IACH,MAAM,EAAE,QAAQ,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,cAAc,EAAE,CAAA;CAC5B;AACH;;;;;GAKG;GACD;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,aAAa,CAAA;CAAE,CAAA;AAEhD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,mBAAmB,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,eAAe,CAAA;IAE1B;;OAEG;IACH,KAAK,EAAE,qBAAqB,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,sBAAsB;IAC/D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE;QACR;;;;WAIG;QACH,KAAK,EAAE,IAAI,CAAA;KACZ,CAAA;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;IAE7C;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EACjB,OAAO,EAAE,sBAAsB,KAC5B,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE9B;;;;OAIG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,aAAa,CAAC,cAAc,EAAE,CAAC,CAAA;CACtE;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,mBAAmB,CAAA;IAE7B;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB"}

package/dist/search/migration.d.ts

@@ -7,8 +7,8 @@
  */
 export type SearchIndexMigrationAction = {
     /**
-     * The index does not exist yet. Nothing is serving it, so it is built
-     * directly under its live name and filled in place.
+     * No version of this index has ever gone live. A new version is built,
+     * to be filled and made active at application start.
      */
     action: "create";
     /**
@@ -16,46 +16,50 @@ export type SearchIndexMigrationAction = {
      */
     index: string;
     /**
-     * The physical index to create it under.
+     * The physical index the new version is built under.
      */
     physical_name: string;
     /**
-     * A hash of the definition the index is created from.
+     * A hash of the definition the version is created from.
      */
     definition_hash: string;
+    /**
+     * The new version's number.
+     */
+    version: number;
 } | {
     /**
-     * The definition changed. Only the build happens here; filling the result
-     * and putting it in front of reads happens at application start.
-     *
-     * On a provider with `swapIndex`, the new schema is built alongside the
-     * live index and aliased over once seeded, so reads never see a half-built
-     * index. Without one there is nowhere to build, so the live index is
-     * replaced in place and holds nothing until the seed runs — which
-     * `physical_name === live_physical_name` is the signal for.
+     * The definition changed. A new version is built alongside the version
+     * currently serving reads. Only the build happens here — filling the new
+     * version and making it active happens at application start.
      */
     action: "migrate";
-    /** The index being built. Derived from `definition_hash` when swapping. */
-    physical_name: string;
-    /** The index serving reads now. */
-    live_physical_name: string;
     /**
      * The name of the index being migrated.
      */
     index: string;
     /**
-     * A hash of the definition the index is migrated to.
+     * The physical index the new version is built under.
+     */
+    physical_name: string;
+    /**
+     * A hash of the definition the new version is built from.
      */
     definition_hash: string;
     /**
-     * A hash of the definition the index currently serving reads was built from.
+     * The new version's number.
      */
-    live_definition_hash: string;
-    /** The provider the definition now binds to. */
+    version: number;
+    /** The physical index of the version currently serving reads. */
+    active_physical_name: string;
+    /** A hash of the definition the active version was built from. */
+    active_definition_hash: string;
+    /** The provider the new version is built on. */
     provider: string;
     /**
-     * The provider that currently holds this index. Set only when it differs
-     * from `provider`, so execute can drop the previous engine's data.
+     * The provider that holds the version currently serving reads. Set only
+     * when it differs from `provider`, so a later migration knows to clean up
+     * the previous engine's data once this version becomes active.
      */
     previous_provider?: string;
 } | {

package/dist/search/migration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/search/migration.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAClC;IACE;;;OAGG;IACH,MAAM,EAAE,QAAQ,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB,GACD;IACE;;;;;;;;;OASG;IACH,MAAM,EAAE,SAAS,CAAA;IACjB,2EAA2E;IAC3E,aAAa,EAAE,MAAM,CAAA;IACrB,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAE5B,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,GACD;IACE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA"}
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../src/search/migration.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAClC;IACE;;;OAGG;IACH,MAAM,EAAE,QAAQ,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB,GACD;IACE;;;;OAIG;IACH,MAAM,EAAE,SAAS,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf,iEAAiE;IACjE,oBAAoB,EAAE,MAAM,CAAA;IAE5B,kEAAkE;IAClE,sBAAsB,EAAE,MAAM,CAAA;IAE9B,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B,GACD;IACE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA"}

package/dist/search/provider.d.ts

@@ -11,7 +11,7 @@ export interface ProviderSearchQuery extends Omit<SearchQuery, "entity" | "field
     /**
      * The resolved definition of the index to query. Use its `physical_name` as
      * the index to query, since it differs from the index's name under an index
-     * prefix or while a swap builds a replacement.
+     * prefix or between versions.
      */
     index: ResolvedSearchIndexDefinition;
     /**
@@ -41,11 +41,11 @@ export interface SearchDeleteDocumentsInput {
     filters: SearchFilters;
 }
 /**
- * Contract implemented by a search engine provider. Optional methods
- * (`swapIndex` and `waitForTask`) are omitted from the abstract class on
- * purpose — define only those your engine can back. `searchMany` has a default
- * that runs `search` concurrently; override it to pack queries into one
- * engine round-trip.
+ * Contract implemented by a search engine provider. The optional
+ * `waitForTask` method is omitted from the abstract class on purpose — define
+ * it only if your engine applies writes asynchronously. `searchMany` has a
+ * default that runs `search` concurrently; override it to pack queries into
+ * one engine round-trip.
  */
 export interface ISearchProvider {
     /**
@@ -104,7 +104,7 @@ export interface ISearchProvider {
     }): Promise<SearchTask>;
     /**
      * This method deletes an index and everything in it. The Search Module calls it
-     * to clean up an index it replaced, such as the index left behind by a swap.
+     * to clean up an old version of an index once a newer one has taken over.
      *
      * @param {object} input - The index to delete.
      * @param {string} input.index - The index's physical name.
@@ -147,50 +147,17 @@ export interface ISearchProvider {
      * }
      */
     listIndexes(): Promise<SearchIndexInfo[]>;
-    /**
-     * This method points a logical index at a different physical index, which the
-     * Search Module uses to reindex without downtime: it seeds a shadow index, then
-     * swaps it in.
-     *
-     * Implementing this method is optional. When it's not implemented, the module
-     * reindexes in place instead, leaving the index incomplete while it's seeded.
-     *
-     * @param {object} input - The swap to perform.
-     * @param {string} input.alias - The logical index name that must serve reads.
-     * @param {string} input.index - The physical index it must point to.
-     * @returns {Promise<SearchTask>} The swap's task.
-     *
-     * @example
-     * class MySearchProviderService extends AbstractSearchProviderService {
-     *   // ...
-     *   async swapIndex({
-     *     alias,
-     *     index,
-     *   }: {
-     *     alias: string
-     *     index: string
-     *   }): Promise<SearchTypes.SearchTask> {
-     *     await this.client.updateAlias(alias, index)
-     *
-     *     return { index, status: "succeeded" }
-     *   }
-     * }
-     */
-    swapIndex?(input: {
-        alias: string;
-        index: string;
-    }): Promise<SearchTask>;
     /**
      * This method adds documents to an index, replacing any that already exist under the same
      * ID. The Search Module uses it both for direct writes and for seeding, where it's called
      * once per batch.
      *
      * If your engine applies writes later rather than inline, return a task with an `id` and
-     * implement `waitForTask`, so the module can wait before swapping a new index in.
+     * implement `waitForTask`, so the module can wait before making a new version active.
      *
      * Write to `input.index` but read schema information from `input.definition`:
-     * during a swap, `input.index` is the shadow index being seeded, whereas the
-     * definition is that of the logical index.
+     * while a new version is being seeded, `input.index` is that version's
+     * physical index, whereas the definition is that of the logical index.
      *
      * @param {object} input - The documents to write.
      * @param {string} input.index - The index's physical name. This is the index to
@@ -224,8 +191,9 @@ export interface ISearchProvider {
         index: string;
         /**
          * The logical definition whose documents are being written. `index` can
-         * point at a shadow physical index during a swap, so providers must use
-         * this value for schema information and `index` for the destination.
+         * point at a version's physical index while it is being seeded, so
+         * providers must use this value for schema information and `index` for
+         * the destination.
          */
         definition: ResolvedSearchIndexDefinition;
         documents: SearchDocument[];
@@ -290,7 +258,7 @@ export interface ISearchProvider {
      * Compile `input.filters` to your engine's filter syntax, and reject the
      * operators it can't express rather than approximating them. Also, use
      * `input.index.physical_name` as the index to query, not `input.index.name`,
-     * since the two differ under an index prefix or during a swap.
+     * since the two differ under an index prefix or between versions.
      *
      * @param {ProviderSearchQuery} input - The query, the resolved index
      * definition, and the attributes to return.
@@ -352,7 +320,7 @@ export interface ISearchProvider {
     searchMany?(inputs: ProviderSearchQuery[]): Promise<SearchResult[]>;
     /**
      * This method waits until a deferred write is applied. The Search Module uses it
-     * to wait for a seed to be applied before swapping the new index in.
+     * to wait for a seed to be applied before making the new version active.
      *
      * Implement it if your engine acknowledges writes and applies them later. When
      * it's not implemented, the module assumes a write is applied once

package/dist/search/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/search/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC;;;GAGG;AACH,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC9C;;;;OAIG;IACH,KAAK,EAAE,6BAA6B,CAAA;IAEpC;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAEhC;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,OAAO,EAAE,aAAa,CAAA;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,WAAW,CAAC,KAAK,EAAE;QACjB,KAAK,EAAE,6BAA6B,CAAA;KACrC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE1D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,SAAS,CAAC,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,eAAe,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,MAAM,CAAA;QACb;;;;WAIG;QACH,UAAU,EAAE,6BAA6B,CAAA;QACzC,SAAS,EAAE,cAAc,EAAE,CAAA;KAC5B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,UAAU,CAAC,CAAC,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,WAAW,CAAC,CACV,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAChC,OAAO,CAAC,UAAU,CAAC,CAAA;CACvB"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/search/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC;;;GAGG;AACH,MAAM,WAAW,mBACf,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC9C;;;;OAIG;IACH,KAAK,EAAE,6BAA6B,CAAA;IAEpC;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAEhC;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,OAAO,EAAE,aAAa,CAAA;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,WAAW,CAAC,KAAK,EAAE;QACjB,KAAK,EAAE,6BAA6B,CAAA;KACrC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,WAAW,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE1D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,eAAe,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,MAAM,CAAA;QACb;;;;;WAKG;QACH,UAAU,EAAE,6BAA6B,CAAA;QACzC,SAAS,EAAE,cAAc,EAAE,CAAA;KAC5B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,UAAU,CAAC,CAAC,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,WAAW,CAAC,CACV,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAChC,OAAO,CAAC,UAAU,CAAC,CAAA;CACvB"}

package/dist/search/query.d.ts

@@ -156,7 +156,8 @@ export interface SearchOptions {
      */
     match_strategy?: SearchMatchStrategy;
     /**
-     * Whether to match terms that are misspelled by a character or two.
+     * Whether to match terms that are misspelled by a character or two. Applied
+     * only when the query includes a free-text `q`; otherwise it is ignored.
      */
     typo_tolerance?: boolean;
     /**
@@ -172,9 +173,13 @@ export interface SearchOptions {
      */
     disjunctive_facets?: boolean;
     /**
-     * How the matched terms are highlighted in the returned hits.
+     * How the matched terms are highlighted in the returned hits. Applied only
+     * when the query includes a free-text `q`; otherwise it is ignored.
+     *
+     * `true` highlights every field the query searches on. Pass an object to pick
+     * fields, tags, or snippet cropping.
      */
-    highlight?: SearchHighlightOptions;
+    highlight?: boolean | SearchHighlightOptions;
     /**
      * Return at most one hit per distinct value of this field.
      */

package/dist/search/query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/search/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,gBAAgB,WAAW,CAAA;AAExC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAA;AAE1C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AAExD;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,CAAA;AAEhE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,GACD;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,OAAO,CAAA;IAEb;;OAEG;IACH,MAAM,EAAE;QACN;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAA;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;QAEtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,GACD;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAEL;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAEhB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAA;IAElC;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAA;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,kBAAkB,CAAC,EAAE,CAAA;IAExC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,sBAAsB,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAE5B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAA;IAE3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IACzD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,aAAa,CAAA;CAC/B"}
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/search/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,gBAAgB,WAAW,CAAA;AAExC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAA;AAE1C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AAExD;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,CAAA;AAEhE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,GACD;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,OAAO,CAAA;IAEb;;OAEG;IACH,MAAM,EAAE;QACN;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAA;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;QAEtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,GACD;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAA;CACd,CAAA;AAEL;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAEhB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAA;IAElC;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAA;IAEpC;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,kBAAkB,CAAC,EAAE,CAAA;IAExC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAE5B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAA;IAE3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IACzD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,aAAa,CAAA;CAC/B"}

package/dist/search/schema.d.ts

@@ -1,7 +1,7 @@
 import { SchemaPropertyMetadata, SchemaPropertyType } from "../schema";
 import { SearchDocument } from "./common";
 import { SearchFacetKind, SearchFieldDefinition, SearchFieldKind } from "./field";
-import { SearchIndexDefinition, SearchSeedContext } from "./index-definition";
+import { SearchIndexDefinition, SearchMutation, SearchSeedContext } from "./index-definition";
 /**
  * Schema of search index fields — key-value pairs of search properties.
  *
@@ -91,12 +91,22 @@ export interface SearchFieldsSchemaLike {
  * schema from `search.define({ ... })`.
  */
 export type SearchIndexFieldsInput = SearchFieldsSchemaLike;
+/**
+ * A `seed` mutation, with `upsert`'s documents type-checked against the
+ * declared `search.define(...)` schema.
+ */
+export type SearchIndexSeedMutation<Fields extends SearchIndexFieldsInput> = {
+    action: "upsert";
+    documents: InferSearchDocumentType<Fields>[];
+} | Extract<SearchMutation, {
+    action: "delete";
+}>;
 /**
  * Definition accepted by `defineSearchIndex` before fields are normalized.
  * `seed` is type-checked against the declared `search.define(...)` schema.
  */
 export type SearchIndexDefinitionInput<Fields extends SearchIndexFieldsInput = SearchIndexFieldsInput> = Omit<SearchIndexDefinition, "fields" | "seed"> & {
     fields: Fields;
-    seed: (context: SearchSeedContext) => AsyncIterable<InferSearchDocumentType<Fields>[]>;
+    seed: (context: SearchSeedContext) => AsyncIterable<SearchIndexSeedMutation<Fields>[]>;
 };
 //# sourceMappingURL=schema.d.ts.map

package/dist/search/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/search/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EAChB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAE7E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;AAElE;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,CAAC,GAAG;IACxE,QAAQ,EAAE;QACR,IAAI,EAAE,eAAe,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;IACD,UAAU,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,eAAe,EAAE,CAAA;KAAE,CAAA;IACnD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;CAChD,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,SAAS,EAAE,CAAC,CAAA;IACZ,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAA;CACpD,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAEzB;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,kBAAkB,CAAC,GAAG,CAAC,IAClE,CAAC,CAAC,SAAS,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,GACjE,IAAI,CAAA;AAER;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,YAAY,IAAI;KAC/D,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC1D,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,sBAAsB,IACvE,MAAM,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,SAAS,YAAY,CAAA;CAAE,GACxD,sBAAsB,CAAC,MAAM,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAC/C,cAAc,CAAA;AAEpB;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CAClD;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAA;AAE3D;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CACpC,MAAM,SAAS,sBAAsB,GAAG,sBAAsB,IAC5D,IAAI,CAAC,qBAAqB,EAAE,QAAQ,GAAG,MAAM,CAAC,GAAG;IACnD,MAAM,EAAE,MAAM,CAAA;IAEd,IAAI,EAAE,CACJ,OAAO,EAAE,iBAAiB,KACvB,aAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;CACtD,CAAA"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/search/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,eAAe,EAChB,MAAM,SAAS,CAAA;AAChB,OAAO,EACL,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EAClB,MAAM,oBAAoB,CAAA;AAE3B;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAA;AAElE;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,GAAG,IAAI,sBAAsB,CAAC,CAAC,CAAC,GAAG;IACxE,QAAQ,EAAE;QACR,IAAI,EAAE,eAAe,CAAA;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAA;IACD,UAAU,CAAC,EAAE,OAAO,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,eAAe,EAAE,CAAA;KAAE,CAAA;IACnD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;CAChD,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC,SAAS,EAAE,CAAC,CAAA;IACZ,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAA;CACpD,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAEzB;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,kBAAkB,CAAC,GAAG,CAAC,IAClE,CAAC,CAAC,SAAS,iBAAiB,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,GACjE,IAAI,CAAA;AAER;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,YAAY,IAAI;KAC/D,CAAC,IAAI,MAAM,MAAM,CAAC,CAAC,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC1D,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,sBAAsB,IACvE,MAAM,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,SAAS,YAAY,CAAA;CAAE,GACxD,sBAAsB,CAAC,MAAM,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAC/C,cAAc,CAAA;AAEpB;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CAClD;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,CAAA;AAE3D;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,sBAAsB,IACrE;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAA;CAAE,GAClE,OAAO,CAAC,cAAc,EAAE;IAAE,MAAM,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAA;AAEjD;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CACpC,MAAM,SAAS,sBAAsB,GAAG,sBAAsB,IAC5D,IAAI,CAAC,qBAAqB,EAAE,QAAQ,GAAG,MAAM,CAAC,GAAG;IACnD,MAAM,EAAE,MAAM,CAAA;IAGd,IAAI,EAAE,CACJ,OAAO,EAAE,iBAAiB,KACvB,aAAa,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;CACtD,CAAA"}

package/dist/search/service.d.ts

@@ -10,13 +10,10 @@ import { SearchResult } from "./result";
 /**
  * The strategy used to rebuild a search index:
  *
- * - `swap` seeds a shadow index and aliases over on completion, keeping the live
- * index serving throughout.
- * - `in_place` upserts into the live index, which is cheaper but leaves stale
- * documents behind for anything the seed no longer produces.
- *
- * `swap` requires a provider that implements `swapIndex`. The module falls back
- * to `in_place` for providers that don't.
+ * - `swap` seeds a new version of the index and makes it active on completion,
+ * keeping the current version serving reads throughout.
+ * - `in_place` upserts into the active version directly, which is cheaper but
+ * leaves stale documents behind for anything the seed no longer produces.
  */
 export type SearchReindexStrategy = "swap" | "in_place";
 /**
@@ -249,8 +246,9 @@ export interface ISearchModuleService extends IModuleService {
     listRetrievableFields(index: string): string[];
     /**
      * This method retrieves an index's definition with the module's defaults
-     * applied: the provider it resolved to, the physical index behind it, and the
-     * `primary_key` its documents are keyed by, which is what a hit's `id` holds.
+     * applied: the provider it resolved to, the root physical index name its
+     * versions are derived from, and the `primary_key` its documents are keyed
+     * by, which is what a hit's `id` holds.
      *
      * @param {string} index - The name of the index.
      * @returns {ResolvedSearchIndexDefinition} The resolved index definition.

package/dist/search/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/search/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,UAAU,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,qBAAqB,CAAA;IAEhC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,KAAK,EAAE,WAAW,GACjB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,eAAe,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,MAAM,CAAA;QACb,SAAS,EAAE,cAAc,EAAE,CAAA;KAC5B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,eAAe,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,aAAa,CAAA;KACvB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAEhD;;;;;;;;;OASG;IACH,WAAW,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAA;IAE5C;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE9C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,6BAA6B,CAAA;IAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAEjE;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC,CAAA;IAEjE;;;;;;;;;;;;;;;;OAgBG;IACH,yBAAyB,CACvB,OAAO,EAAE,0BAA0B,EAAE,GACpC,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/search/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oBAAoB,CAAA;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,UAAU,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,qBAAqB,CAAA;IAEhC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,KAAK,EAAE,WAAW,GACjB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,eAAe,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,MAAM,CAAA;QACb,SAAS,EAAE,cAAc,EAAE,CAAA;KAC5B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,eAAe,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,aAAa,CAAA;KACvB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAEhD;;;;;;;;;OASG;IACH,WAAW,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAA;IAE5C;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE9C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,6BAA6B,CAAA;IAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAEjE;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC,CAAA;IAEjE;;;;;;;;;;;;;;;;OAgBG;IACH,yBAAyB,CACvB,OAAO,EAAE,0BAA0B,EAAE,GACpC,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medusajs/types",
-  "version": "2.20.1",
+  "version": "2.20.2-preview-20260904113944",
   "description": "Medusa Types definition",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,7 +38,7 @@
     "bignumber.js": "^9.1.2"
   },
   "devDependencies": {
-    "@medusajs/deps": "2.20.1"
+    "@medusajs/deps": "2.20.2-preview-20260904113944"
   },
   "peerDependencies": {
     "ioredis": "^5.4.1",