@venizia/ignis 0.0.10-4 → 0.1.0

package/dist/connectors/search/models/define-search-collection.d.ts

@@ -0,0 +1,64 @@
+import type { ISearchCollectionDefinition, ISearchEmbedConfig, TFieldFlags, TVectorDistance } from './types';
+import { SearchFieldTypes } from './types';
+export declare const field: {
+    id: () => {
+        name: "id";
+        type: "string";
+    };
+    string: <const N extends string, const O extends TFieldFlags = {}>(name: N, opts?: O | undefined) => {
+        name: N;
+        type: "string";
+    } & O;
+    strings: <const N extends string, const O extends TFieldFlags = {}>(name: N, opts?: O | undefined) => {
+        name: N;
+        type: "string[]";
+    } & O;
+    number: <const N extends string, const O extends TFieldFlags = {}>(name: N, opts?: O | undefined) => {
+        name: N;
+        type: "number";
+    } & O;
+    numbers: <const N extends string, const O extends TFieldFlags = {}>(name: N, opts?: O | undefined) => {
+        name: N;
+        type: "number[]";
+    } & O;
+    boolean: <const N extends string, const O extends TFieldFlags = {}>(name: N, opts?: O | undefined) => {
+        name: N;
+        type: "boolean";
+    } & O;
+    booleans: <const N extends string, const O extends TFieldFlags = {}>(name: N, opts?: O | undefined) => {
+        name: N;
+        type: "boolean[]";
+    } & O;
+    geopoint: <const N extends string, const O extends TFieldFlags = {}>(name: N, opts?: O | undefined) => {
+        name: N;
+        type: "geopoint";
+    } & O;
+    /**
+     * `vector`'s options are richer than `TFieldFlags` (dimensions/distance/embed, not the shared
+     * searchable/filterable/facet/sortable flags), so it carries its own `O` shape rather than
+     * routing through `buildField`. `O extends { optional: true } ? { optional: true } : {}`
+     * mirrors `buildField`'s spread-flags behavior: `optional` only appears in the return type
+     * (and at runtime) when the caller actually set it, keeping `TSearchDocument`'s
+     * `Exclude<.., { optional: true }>` / `Extract<.., { optional: true }>` split working for vector fields too.
+     */
+    vector: <const N extends string, const O extends {
+        dimensions?: number;
+        distance?: TVectorDistance;
+        embed?: ISearchEmbedConfig;
+        optional?: boolean;
+    }>(name: N, opts: O) => {
+        name: N;
+        type: typeof SearchFieldTypes.VECTOR;
+        vector: Omit<O, "optional">;
+    } & (O extends {
+        optional: true;
+    } ? {
+        optional: true;
+    } : object);
+};
+/**
+ * `<const T>` preserves field literals so `TSearchDocument<typeof X>` can map over them - a
+ * plain `T extends ISearchCollectionDefinition` would widen `fields` and lose every literal.
+ */
+export declare const defineSearchCollection: <const T extends ISearchCollectionDefinition>(opts: T) => T;
+//# sourceMappingURL=define-search-collection.d.ts.map

package/dist/connectors/search/models/define-search-collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-search-collection.d.ts","sourceRoot":"","sources":["../../../../src/connectors/search/models/define-search-collection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,2BAA2B,EAC3B,kBAAkB,EAElB,WAAW,EAEX,eAAe,EAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AA8B3C,eAAO,MAAM,KAAK;cACR;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE;mBAR/B,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,WAAW;;;;oBAA7C,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,WAAW;;;;mBAA7C,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,WAAW;;;;oBAA7C,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,WAAW;;;;oBAA7C,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,WAAW;;;;qBAA7C,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,WAAW;;;;qBAA7C,CAAC,SAAS,MAAM,QAAQ,CAAC,SAAS,WAAW;;;;IAkBpD;;;;;;;OAOG;mBAEK,CAAC,SAAS,MAAM,QAChB,CAAC,SAAS;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,eAAe,CAAC;QAC3B,KAAK,CAAC,EAAE,kBAAkB,CAAC;QAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,QAEK,CAAC,QACD,CAAC,KACN;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,IAAI,EAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC;QAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;KAAE,GAAG,CAAC,CAAC,SAAS;QAC7F,QAAQ,EAAE,IAAI,CAAC;KAChB,GACG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,GAClB,MAAM,CAAC;CAYZ,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,CAAC,CAAC,SAAS,2BAA2B,EAAE,MAAM,CAAC,KAAG,CAiE7F,CAAC"}

package/dist/connectors/{typesense → search}/models/define-search-collection.js

@@ -5,44 +5,49 @@ const ignis_helpers_1 = require("@venizia/ignis-helpers");
 const types_1 = require("./types");
 /**
  * `<const N, const O>` preserve the field's name/flag literals in the return type - a widened
- * `ISearchFieldDefinition` return would break `TInferSearchDocument`, which needs literal types.
+ * `ISearchFieldDefinition` return would break `TSearchDocument`, which needs literal types.
  */
 const buildField = (opts) => {
     const { name, type, flags } = opts;
     return { name, type, ...flags };
 };
+/** Curries `buildField` over a fixed field type - the shared shape behind `field.string/strings/number/numbers/boolean/booleans/geopoint`. */
+const makeFieldBuilder = (type) => (name, opts) => {
+    return buildField({ name, type, flags: opts });
+};
 exports.field = {
     id: () => {
         return { name: 'id', type: types_1.SearchFieldTypes.STRING };
     },
-    string: (name, opts) => {
-        return buildField({ name, type: types_1.SearchFieldTypes.STRING, flags: opts });
-    },
-    strings: (name, opts) => {
-        return buildField({ name, type: types_1.SearchFieldTypes.STRING_ARRAY, flags: opts });
-    },
-    number: (name, opts) => {
-        return buildField({ name, type: types_1.SearchFieldTypes.NUMBER, flags: opts });
-    },
-    numbers: (name, opts) => {
-        return buildField({ name, type: types_1.SearchFieldTypes.NUMBER_ARRAY, flags: opts });
-    },
-    boolean: (name, opts) => {
-        return buildField({ name, type: types_1.SearchFieldTypes.BOOLEAN, flags: opts });
-    },
-    booleans: (name, opts) => {
-        return buildField({ name, type: types_1.SearchFieldTypes.BOOLEAN_ARRAY, flags: opts });
-    },
-    geopoint: (name, opts) => {
-        return buildField({ name, type: types_1.SearchFieldTypes.GEOPOINT, flags: opts });
+    string: makeFieldBuilder(types_1.SearchFieldTypes.STRING),
+    strings: makeFieldBuilder(types_1.SearchFieldTypes.STRING_ARRAY),
+    number: makeFieldBuilder(types_1.SearchFieldTypes.NUMBER),
+    numbers: makeFieldBuilder(types_1.SearchFieldTypes.NUMBER_ARRAY),
+    boolean: makeFieldBuilder(types_1.SearchFieldTypes.BOOLEAN),
+    booleans: makeFieldBuilder(types_1.SearchFieldTypes.BOOLEAN_ARRAY),
+    geopoint: makeFieldBuilder(types_1.SearchFieldTypes.GEOPOINT),
+    /**
+     * `vector`'s options are richer than `TFieldFlags` (dimensions/distance/embed, not the shared
+     * searchable/filterable/facet/sortable flags), so it carries its own `O` shape rather than
+     * routing through `buildField`. `O extends { optional: true } ? { optional: true } : {}`
+     * mirrors `buildField`'s spread-flags behavior: `optional` only appears in the return type
+     * (and at runtime) when the caller actually set it, keeping `TSearchDocument`'s
+     * `Exclude<.., { optional: true }>` / `Extract<.., { optional: true }>` split working for vector fields too.
+     */
+    vector: (name, opts) => {
+        const { optional: isOptional, ...vector } = opts;
+        const base = { name, type: types_1.SearchFieldTypes.VECTOR, vector };
+        // A single cast is unavoidable here: the conditional-optional branch can't be proven from the
+        // runtime `isOptional ? { ...base, optional: isOptional } : base` shape without widening `O`.
+        return (isOptional ? { ...base, optional: isOptional } : base);
     },
 };
 /**
- * `<const T>` preserves field literals so `TInferSearchDocument<typeof X>` can map over them - a
+ * `<const T>` preserves field literals so `TSearchDocument<typeof X>` can map over them - a
  * plain `T extends ISearchCollectionDefinition` would widen `fields` and lose every literal.
  */
 const defineSearchCollection = (opts) => {
-    const { name, fields, defaultSort, engineOverrides } = opts;
+    const { name, fields, defaultSort, synonyms, engineOverrides } = opts;
     if (!name || name.trim().length === 0) {
         throw (0, ignis_helpers_1.getError)({
             message: `[defineSearchCollection] Invalid name | name must be non-empty | name: ${String(name)}`,
@@ -82,9 +87,20 @@ const defineSearchCollection = (opts) => {
             });
         }
     }
+    if (synonyms) {
+        const seenSynonymIds = new Set();
+        for (const synonym of synonyms) {
+            if (seenSynonymIds.has(synonym.id)) {
+                throw (0, ignis_helpers_1.getError)({
+                    message: `[defineSearchCollection] Duplicate synonym id | name: ${name} | id: ${synonym.id}`,
+                });
+            }
+            seenSynonymIds.add(synonym.id);
+        }
+    }
     // The runtime result is only structurally an ISearchCollectionDefinition; the cast back to the
-    // caller's literal T is deliberate - `id` is guaranteed at the type level via TInferSearchDocument.
-    return { name, fields: resolvedFields, defaultSort, engineOverrides };
+    // caller's literal T is deliberate - `id` is guaranteed at the type level via TSearchDocument.
+    return { name, fields: resolvedFields, defaultSort, synonyms, engineOverrides };
 };
 exports.defineSearchCollection = defineSearchCollection;
 //# sourceMappingURL=define-search-collection.js.map

package/dist/connectors/search/models/define-search-collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-search-collection.js","sourceRoot":"","sources":["../../../../src/connectors/search/models/define-search-collection.ts"],"names":[],"mappings":";;;AAAA,0DAAkD;AAUlD,mCAA2C;AAE3C;;;GAGG;AACH,MAAM,UAAU,GAAG,CAIjB,IAID,EAA6B,EAAE;IAC9B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAEnC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,KAAK,EAA+B,CAAC;AAC/D,CAAC,CAAC;AAEF,8IAA8I;AAC9I,MAAM,gBAAgB,GACpB,CAA8B,IAAQ,EAAE,EAAE,CAC1C,CACE,IAAO,EACP,IAAQ,EACmB,EAAE;IAC7B,OAAO,UAAU,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AACjD,CAAC,CAAC;AAES,QAAA,KAAK,GAAG;IACnB,EAAE,EAAE,GAAmC,EAAE;QACvC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,wBAAgB,CAAC,MAAM,EAAE,CAAC;IACvD,CAAC;IACD,MAAM,EAAE,gBAAgB,CAAC,wBAAgB,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,gBAAgB,CAAC,wBAAgB,CAAC,YAAY,CAAC;IACxD,MAAM,EAAE,gBAAgB,CAAC,wBAAgB,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,gBAAgB,CAAC,wBAAgB,CAAC,YAAY,CAAC;IACxD,OAAO,EAAE,gBAAgB,CAAC,wBAAgB,CAAC,OAAO,CAAC;IACnD,QAAQ,EAAE,gBAAgB,CAAC,wBAAgB,CAAC,aAAa,CAAC;IAC1D,QAAQ,EAAE,gBAAgB,CAAC,wBAAgB,CAAC,QAAQ,CAAC;IACrD;;;;;;;OAOG;IACH,MAAM,EAAE,CASN,IAAO,EACP,IAAO,EAKG,EAAE;QACZ,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;QACjD,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,wBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;QAE7D,8FAA8F;QAC9F,8FAA8F;QAC9F,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAIG,CAAC;IACnE,CAAC;CACF,CAAC;AAEF;;;GAGG;AACI,MAAM,sBAAsB,GAAG,CAA8C,IAAO,EAAK,EAAE;IAChG,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;IAEtE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,0EAA0E,MAAM,CAAC,IAAI,CAAC,EAAE;SAClG,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,oFAAoF,IAAI,EAAE;SACpG,CAAC,CAAC;IACL,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,KAAK,MAAM,eAAe,IAAI,MAAM,EAAE,CAAC;QACrC,IAAI,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,MAAM,IAAA,wBAAQ,EAAC;gBACb,OAAO,EAAE,yDAAyD,IAAI,aAAa,eAAe,CAAC,IAAI,EAAE;aAC1G,CAAC,CAAC;QACL,CAAC;QAED,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACxD,IAAI,cAAc,GAAsC,MAAM,CAAC;IAE/D,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,cAAc,GAAG,CAAC,aAAK,CAAC,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC;IAC3C,CAAC;SAAM,IAAI,OAAO,CAAC,IAAI,KAAK,wBAAgB,CAAC,MAAM,EAAE,CAAC;QACpD,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,uFAAuF,IAAI,YAAY,OAAO,CAAC,IAAI,EAAE;SAC/H,CAAC,CAAC;IACL,CAAC;IAED,uFAAuF;IACvF,oGAAoG;IACpG,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;QAEzE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAA,wBAAQ,EAAC;gBACb,OAAO,EAAE,0EAA0E,IAAI,mBAAmB,WAAW,EAAE;aACxH,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;QACzC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;gBACnC,MAAM,IAAA,wBAAQ,EAAC;oBACb,OAAO,EAAE,yDAAyD,IAAI,UAAU,OAAO,CAAC,EAAE,EAAE;iBAC7F,CAAC,CAAC;YACL,CAAC;YAED,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,+FAA+F;IAC/F,+FAA+F;IAC/F,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAO,CAAC;AACvF,CAAC,CAAC;AAjEW,QAAA,sBAAsB,0BAiEjC"}

package/dist/connectors/search/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/connectors/search/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC"}

package/dist/connectors/search/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/connectors/search/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,6DAA2C;AAC3C,0CAAwB;AACxB,mDAAiC"}

package/dist/connectors/search/models/types.d.ts

@@ -0,0 +1,117 @@
+import type { TConstValue } from '@venizia/ignis-helpers';
+/** Engine-neutral field type vocabulary for the search-collection DSL. */
+export declare class SearchFieldTypes {
+    static readonly STRING = "string";
+    static readonly NUMBER = "number";
+    static readonly BOOLEAN = "boolean";
+    static readonly GEOPOINT = "geopoint";
+    static readonly STRING_ARRAY = "string[]";
+    static readonly NUMBER_ARRAY = "number[]";
+    static readonly BOOLEAN_ARRAY = "boolean[]";
+    static readonly VECTOR = "vector";
+    static readonly SCHEME_SET: Set<string>;
+    static isValid(value: string): value is TSearchFieldType;
+}
+export type TSearchFieldType = TConstValue<typeof SearchFieldTypes>;
+/** Distance metrics a `vector` field may declare. An engine that supports fewer rejects the rest in its compiler. */
+export declare class VectorDistances {
+    static readonly COSINE = "cosine";
+    static readonly INNER_PRODUCT = "ip";
+    static readonly L2 = "l2";
+    static readonly SCHEME_SET: Set<string>;
+    static isValid(value: string): value is TVectorDistance;
+}
+export type TVectorDistance = TConstValue<typeof VectorDistances>;
+/**
+ * Embedding-model config for a server-side auto-embedded vector field, where the engine generates
+ * and queries the embedding rather than the caller supplying it. Two families, one shape:
+ * - Local built-in model (runs on the engine, no key): just `name`, e.g. 'ts/all-MiniLM-L6-v2'.
+ * - Remote provider (OpenAI/Google/Azure/GCP Vertex): `name` (e.g. 'google/embedding-gecko-001') plus
+ *   `apiKey` and/or the provider's auth fields.
+ * Each engine's compiler maps these camelCase keys onto its own wire vocabulary. Source `apiKey`
+ * and the other secrets from env - never hardcode them into a committed schema.
+ */
+export interface ISearchEmbedModelConfig {
+    /** Built-in (`ts/...`) or remote (`openai/...`, `google/...`, `azure/...`). */
+    name: string;
+    /** Remote providers (OpenAI, Google, Azure). */
+    apiKey?: string;
+    /** Azure / self-hosted endpoints. */
+    url?: string;
+    accessToken?: string;
+    refreshToken?: string;
+    clientId?: string;
+    clientSecret?: string;
+    projectId?: string;
+    /** Escape for any provider field not modeled above; pass it already in the target engine's wire form. */
+    [key: string]: unknown;
+}
+export interface ISearchEmbedConfig {
+    from: string[];
+    model: ISearchEmbedModelConfig;
+}
+export interface ISearchFieldDefinition {
+    name: string;
+    type: TSearchFieldType;
+    searchable?: boolean;
+    filterable?: boolean;
+    facet?: boolean;
+    sortable?: boolean;
+    optional?: boolean;
+    vector?: {
+        dimensions?: number;
+        distance?: TVectorDistance;
+        embed?: ISearchEmbedConfig;
+    };
+}
+/** Per-field builder flags accepted by `field.*` helpers (./define-search-collection.ts). */
+export type TFieldFlags = Pick<ISearchFieldDefinition, 'searchable' | 'filterable' | 'facet' | 'sortable' | 'optional'>;
+/** A synonym set. `root` set = one-way (query for root also matches synonyms); absent = multi-way (all interchangeable). */
+export interface ISynonym {
+    id: string;
+    synonyms: string[];
+    root?: string;
+}
+export interface ISearchCollectionDefinition {
+    name: string;
+    fields: readonly ISearchFieldDefinition[];
+    defaultSort?: string;
+    /** Declarative synonym sets provisioned alongside the collection (see `BaseSearchDataSource.provisionCollections`). */
+    synonyms?: ISynonym[];
+    engineOverrides?: {
+        typesense?: object;
+        meilisearch?: object;
+        opensearch?: object;
+        elasticsearch?: object;
+    } & {
+        [engine: string]: object | undefined;
+    };
+}
+export type TSearchSchema = Record<string, ISearchCollectionDefinition>;
+/** Maps a DSL field-type literal to its TypeScript runtime type - the scalar/array counterpart of `TSearchFieldType`. */
+export type TSearchFieldTsType<T extends TSearchFieldType> = T extends 'string' ? string : T extends 'number' ? number : T extends 'boolean' ? boolean : T extends 'geopoint' ? [number, number] : T extends 'string[]' ? string[] : T extends 'number[]' ? number[] : T extends 'boolean[]' ? boolean[] : T extends 'vector' ? number[] : never;
+/**
+ * Compile-time document shape for a `defineSearchCollection` literal - the search-branch parity to postgres's `typeof User.schema` inference.
+ * Uses `Exclude<T['fields'][number], { optional: true }>` rather than `Extract<..., { optional?: false }>`: the latter is a TS "weak type" and rejects field literals with no `optional` key at all.
+ * A vector field carrying `vector.embed` is server auto-embedded - the engine generates and queries it, so it is omitted entirely from the document shape (neither the required nor optional remap admits it); a vector field without `embed` is client-provided and infers as `number[]`.
+ */
+export type TSearchDocument<T extends ISearchCollectionDefinition> = {
+    id: string;
+} & {
+    [F in Exclude<T['fields'][number], {
+        optional: true;
+    }> as F['name'] extends 'id' ? never : F extends {
+        vector: {
+            embed: object;
+        };
+    } ? never : F['name']]: TSearchFieldTsType<F['type']>;
+} & {
+    [F in Extract<T['fields'][number], {
+        optional: true;
+    }> as F['name'] extends 'id' ? never : F extends {
+        vector: {
+            embed: object;
+        };
+    } ? never : F['name']]?: TSearchFieldTsType<F['type']>;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/connectors/search/models/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/connectors/search/models/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE1D,0EAA0E;AAC1E,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,QAAQ,CAAC,MAAM,YAAY;IAClC,MAAM,CAAC,QAAQ,CAAC,MAAM,YAAY;IAClC,MAAM,CAAC,QAAQ,CAAC,OAAO,aAAa;IACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,cAAc;IACtC,MAAM,CAAC,QAAQ,CAAC,YAAY,cAAc;IAC1C,MAAM,CAAC,QAAQ,CAAC,YAAY,cAAc;IAC1C,MAAM,CAAC,QAAQ,CAAC,aAAa,eAAe;IAC5C,MAAM,CAAC,QAAQ,CAAC,MAAM,YAAY;IAElC,MAAM,CAAC,QAAQ,CAAC,UAAU,cASvB;IAEH,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,gBAAgB;CAGzD;AAED,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEpE,qHAAqH;AACrH,qBAAa,eAAe;IAC1B,MAAM,CAAC,QAAQ,CAAC,MAAM,YAAY;IAClC,MAAM,CAAC,QAAQ,CAAC,aAAa,QAAQ;IACrC,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ;IAE1B,MAAM,CAAC,QAAQ,CAAC,UAAU,cAA+D;IAEzF,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,eAAe;CAGxD;AAED,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yGAAyG;IACzG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,uBAAuB,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,gBAAgB,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,eAAe,CAAC;QAAC,KAAK,CAAC,EAAE,kBAAkB,CAAA;KAAE,CAAC;CAC1F;AAED,6FAA6F;AAC7F,MAAM,MAAM,WAAW,GAAG,IAAI,CAC5B,sBAAsB,EACtB,YAAY,GAAG,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAChE,CAAC;AAEF,4HAA4H;AAC5H,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,sBAAsB,EAAE,CAAC;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,uHAAuH;IACvH,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;IAItB,eAAe,CAAC,EAAE;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;KAAE,CAAC;CAC9C;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;AAExE,yHAAyH;AACzH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,IAAI,CAAC,SAAS,QAAQ,GAC3E,MAAM,GACN,CAAC,SAAS,QAAQ,GAChB,MAAM,GACN,CAAC,SAAS,SAAS,GACjB,OAAO,GACP,CAAC,SAAS,UAAU,GAClB,CAAC,MAAM,EAAE,MAAM,CAAC,GAChB,CAAC,SAAS,UAAU,GAClB,MAAM,EAAE,GACR,CAAC,SAAS,UAAU,GAClB,MAAM,EAAE,GACR,CAAC,SAAS,WAAW,GACnB,OAAO,EAAE,GACT,CAAC,SAAS,QAAQ,GAChB,MAAM,EAAE,GACR,KAAK,CAAC;AAExB;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,2BAA2B,IAAI;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG;KAElF,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,IAAI,GAC3E,KAAK,GACL,CAAC,SAAS;QAAE,MAAM,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GACrC,KAAK,GACL,CAAC,CAAC,MAAM,CAAC,GACd,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CACjC,GAAG;KAEA,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,IAAI,GAC3E,KAAK,GACL,CAAC,SAAS;QAAE,MAAM,EAAE;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GACrC,KAAK,GACL,CAAC,CAAC,MAAM,CAAC,CAChB,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CAClC,CAAC"}

package/dist/connectors/{typesense → search}/models/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchFieldTypes = void 0;
+exports.VectorDistances = exports.SearchFieldTypes = void 0;
 /** Engine-neutral field type vocabulary for the search-collection DSL. */
 class SearchFieldTypes {
     static { this.STRING = 'string'; }
@@ -10,6 +10,7 @@ class SearchFieldTypes {
     static { this.STRING_ARRAY = 'string[]'; }
     static { this.NUMBER_ARRAY = 'number[]'; }
     static { this.BOOLEAN_ARRAY = 'boolean[]'; }
+    static { this.VECTOR = 'vector'; }
     static { this.SCHEME_SET = new Set([
         this.STRING,
         this.NUMBER,
@@ -18,10 +19,22 @@ class SearchFieldTypes {
         this.STRING_ARRAY,
         this.NUMBER_ARRAY,
         this.BOOLEAN_ARRAY,
+        this.VECTOR,
     ]); }
     static isValid(value) {
         return this.SCHEME_SET.has(value);
     }
 }
 exports.SearchFieldTypes = SearchFieldTypes;
+/** Distance metrics a `vector` field may declare. An engine that supports fewer rejects the rest in its compiler. */
+class VectorDistances {
+    static { this.COSINE = 'cosine'; }
+    static { this.INNER_PRODUCT = 'ip'; }
+    static { this.L2 = 'l2'; }
+    static { this.SCHEME_SET = new Set([this.COSINE, this.INNER_PRODUCT, this.L2]); }
+    static isValid(value) {
+        return this.SCHEME_SET.has(value);
+    }
+}
+exports.VectorDistances = VectorDistances;
 //# sourceMappingURL=types.js.map

package/dist/connectors/search/models/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/connectors/search/models/types.ts"],"names":[],"mappings":";;;AAEA,0EAA0E;AAC1E,MAAa,gBAAgB;aACX,WAAM,GAAG,QAAQ,CAAC;aAClB,WAAM,GAAG,QAAQ,CAAC;aAClB,YAAO,GAAG,SAAS,CAAC;aACpB,aAAQ,GAAG,UAAU,CAAC;aACtB,iBAAY,GAAG,UAAU,CAAC;aAC1B,iBAAY,GAAG,UAAU,CAAC;aAC1B,kBAAa,GAAG,WAAW,CAAC;aAC5B,WAAM,GAAG,QAAQ,CAAC;aAElB,eAAU,GAAG,IAAI,GAAG,CAAS;QAC3C,IAAI,CAAC,MAAM;QACX,IAAI,CAAC,MAAM;QACX,IAAI,CAAC,OAAO;QACZ,IAAI,CAAC,QAAQ;QACb,IAAI,CAAC,YAAY;QACjB,IAAI,CAAC,YAAY;QACjB,IAAI,CAAC,aAAa;QAClB,IAAI,CAAC,MAAM;KACZ,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;;AAvBH,4CAwBC;AAID,qHAAqH;AACrH,MAAa,eAAe;aACV,WAAM,GAAG,QAAQ,CAAC;aAClB,kBAAa,GAAG,IAAI,CAAC;aACrB,OAAE,GAAG,IAAI,CAAC;aAEV,eAAU,GAAG,IAAI,GAAG,CAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzF,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;;AATH,0CAUC"}

package/dist/connectors/{typesense → search}/models/zod-derivation.d.ts

@@ -1,6 +1,6 @@
 import { z } from '@hono/zod-openapi';
-import { TSchemaType } from '../../../base/models';
-import { ISearchCollectionDefinition } from './types';
+import type { TSchemaType } from '../../../base/models';
+import type { ISearchCollectionDefinition } from './types';
 export declare const deriveSearchDocumentSchema: (opts: {
     definition: ISearchCollectionDefinition;
     type: TSchemaType;

package/dist/connectors/search/models/zod-derivation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod-derivation.d.ts","sourceRoot":"","sources":["../../../../src/connectors/search/models/zod-derivation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AAItC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,OAAO,KAAK,EAAE,2BAA2B,EAA0B,MAAM,SAAS,CAAC;AAyDnF,eAAO,MAAM,0BAA0B,GAAI,MAAM;IAC/C,UAAU,EAAE,2BAA2B,CAAC;IACxC,IAAI,EAAE,WAAW,CAAC;CACnB,KAAG,CAAC,CAAC,UAoBL,CAAC"}

package/dist/connectors/{typesense → search}/models/zod-derivation.js

@@ -1,8 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deriveSearchDocumentSchema = void 0;
 const zod_openapi_1 = require("@hono/zod-openapi");
 const ignis_helpers_1 = require("@venizia/ignis-helpers");
+const omit_1 = __importDefault(require("lodash/omit"));
 const models_1 = require("../../../base/models");
 const types_1 = require("./types");
 const buildBaseFieldSchema = (field) => {
@@ -28,6 +32,9 @@ const buildBaseFieldSchema = (field) => {
         case types_1.SearchFieldTypes.BOOLEAN_ARRAY: {
             return zod_openapi_1.z.array(zod_openapi_1.z.boolean());
         }
+        case types_1.SearchFieldTypes.VECTOR: {
+            return zod_openapi_1.z.array(zod_openapi_1.z.number());
+        }
         default: {
             throw (0, ignis_helpers_1.getError)({
                 message: `[deriveSearchDocumentSchema] Unsupported field type | field: ${field.name} | type: ${field.type}`,
@@ -35,12 +42,20 @@ const buildBaseFieldSchema = (field) => {
         }
     }
 };
+// A vector field carrying `vector.embed` is server auto-embedded (mirrors TSearchDocument's
+// embed exclusion) - it is never part of client-supplied input/output, so it is dropped from the shape entirely.
 const buildFieldSchema = (field) => {
+    if (field.type === types_1.SearchFieldTypes.VECTOR && field.vector?.embed) {
+        return undefined;
+    }
     const baseSchema = buildBaseFieldSchema(field);
     return field.optional ? baseSchema.optional() : baseSchema;
 };
 const buildShape = (fields) => {
-    return Object.fromEntries(fields.map(field => [field.name, buildFieldSchema(field)]));
+    const entries = fields
+        .map(field => [field.name, buildFieldSchema(field)])
+        .filter((entry) => entry[1] !== undefined);
+    return Object.fromEntries(entries);
 };
 const deriveSearchDocumentSchema = (opts) => {
     const { definition, type } = opts;
@@ -53,8 +68,7 @@ const deriveSearchDocumentSchema = (opts) => {
             return zod_openapi_1.z.object({ ...shape, id: zod_openapi_1.z.string() });
         }
         case models_1.SchemaTypes.UPDATE: {
-            const { id: _id, ...rest } = shape;
-            return zod_openapi_1.z.object(rest).partial();
+            return zod_openapi_1.z.object((0, omit_1.default)(shape, ['id'])).partial();
         }
         default: {
             throw (0, ignis_helpers_1.getError)({

package/dist/connectors/search/models/zod-derivation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod-derivation.js","sourceRoot":"","sources":["../../../../src/connectors/search/models/zod-derivation.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAsC;AACtC,0DAAkD;AAClD,uDAA+B;AAG/B,0CAA4C;AAE5C,mCAA2C;AAE3C,MAAM,oBAAoB,GAAG,CAAC,KAA6B,EAAgB,EAAE;IAC3E,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,wBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7B,OAAO,eAAC,CAAC,MAAM,EAAE,CAAC;QACpB,CAAC;QACD,KAAK,wBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7B,OAAO,eAAC,CAAC,MAAM,EAAE,CAAC;QACpB,CAAC;QACD,KAAK,wBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9B,OAAO,eAAC,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC;QACD,KAAK,wBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC/B,OAAO,eAAC,CAAC,KAAK,CAAC,CAAC,eAAC,CAAC,MAAM,EAAE,EAAE,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3C,CAAC;QACD,KAAK,wBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YACnC,OAAO,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,KAAK,wBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YACnC,OAAO,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,KAAK,wBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;YACpC,OAAO,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9B,CAAC;QACD,KAAK,wBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7B,OAAO,eAAC,CAAC,KAAK,CAAC,eAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,wBAAQ,EAAC;gBACb,OAAO,EAAE,gEAAgE,KAAK,CAAC,IAAI,YAAY,KAAK,CAAC,IAAI,EAAE;aAC5G,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,4FAA4F;AAC5F,iHAAiH;AACjH,MAAM,gBAAgB,GAAG,CAAC,KAA6B,EAA4B,EAAE;IACnF,IAAI,KAAK,CAAC,IAAI,KAAK,wBAAgB,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QAClE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE/C,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,MAAyC,EAAgC,EAAE;IAC7F,MAAM,OAAO,GAAG,MAAM;SACnB,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAU,CAAC;SAC5D,MAAM,CAAC,CAAC,KAAK,EAAmC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IAE9E,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC;AAEK,MAAM,0BAA0B,GAAG,CAAC,IAG1C,EAAgB,EAAE;IACjB,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAClC,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAE5C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,oBAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YACxB,OAAO,eAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,oBAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YACxB,OAAO,eAAC,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,eAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAChD,CAAC;QACD,KAAK,oBAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YACxB,OAAO,eAAC,CAAC,MAAM,CAAC,IAAA,cAAI,EAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACjD,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAA,wBAAQ,EAAC;gBACb,OAAO,EAAE,gGAAgG,UAAU,CAAC,IAAI,YAAY,IAAI,EAAE;aAC3I,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAvBW,QAAA,0BAA0B,8BAuBrC"}

package/dist/connectors/search/repositories/common/constants.d.ts

@@ -0,0 +1,176 @@
+import { z } from '@hono/zod-openapi';
+import type { TConstValue } from '@venizia/ignis-helpers';
+import type { ISearchQuery } from './types';
+/** Discriminant values for `TSearchInput.mode` - which search strategy `ReadableSearchRepository.search()` runs. */
+export declare class SearchModes {
+    static readonly KEYWORD = "keyword";
+    static readonly SEMANTIC = "semantic";
+    static readonly HYBRID = "hybrid";
+    static readonly RAW = "raw";
+    static readonly SCHEME_SET: Set<string>;
+    static isValid(input: string): input is TSearchMode;
+}
+export type TSearchMode = TConstValue<typeof SearchModes>;
+export declare const SearchInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    facetBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    facetQuery: z.ZodOptional<z.ZodString>;
+    maxFacetValues: z.ZodOptional<z.ZodNumber>;
+    highlightFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightFullFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightStartTag: z.ZodOptional<z.ZodString>;
+    highlightEndTag: z.ZodOptional<z.ZodString>;
+    snippetThreshold: z.ZodOptional<z.ZodNumber>;
+    groupBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    groupLimit: z.ZodOptional<z.ZodNumber>;
+    groupMissingValues: z.ZodOptional<z.ZodBoolean>;
+    queryByWeights: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    engineParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    mode: z.ZodLiteral<"keyword">;
+    query: z.ZodOptional<z.ZodString>;
+    queryBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    filter: z.ZodOptional<z.ZodObject<{
+        where: z.ZodOptional<z.ZodUnion<readonly [z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>, z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<any, string>>, z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>>]>>;
+        fields: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodArray<z.ZodString>]>>;
+        order: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        offset: z.ZodOptional<z.ZodNumber>;
+        skip: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    distanceThreshold: z.ZodOptional<z.ZodNumber>;
+    ef: z.ZodOptional<z.ZodNumber>;
+    facetBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    facetQuery: z.ZodOptional<z.ZodString>;
+    maxFacetValues: z.ZodOptional<z.ZodNumber>;
+    highlightFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightFullFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightStartTag: z.ZodOptional<z.ZodString>;
+    highlightEndTag: z.ZodOptional<z.ZodString>;
+    snippetThreshold: z.ZodOptional<z.ZodNumber>;
+    groupBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    groupLimit: z.ZodOptional<z.ZodNumber>;
+    groupMissingValues: z.ZodOptional<z.ZodBoolean>;
+    queryByWeights: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    engineParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    mode: z.ZodLiteral<"semantic">;
+    vectorField: z.ZodString;
+    nearVector: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    queryText: z.ZodOptional<z.ZodString>;
+    k: z.ZodOptional<z.ZodNumber>;
+    filter: z.ZodOptional<z.ZodObject<{
+        where: z.ZodOptional<z.ZodUnion<readonly [z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>, z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<any, string>>, z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>>]>>;
+        fields: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodArray<z.ZodString>]>>;
+        order: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        offset: z.ZodOptional<z.ZodNumber>;
+        skip: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    distanceThreshold: z.ZodOptional<z.ZodNumber>;
+    ef: z.ZodOptional<z.ZodNumber>;
+    facetBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    facetQuery: z.ZodOptional<z.ZodString>;
+    maxFacetValues: z.ZodOptional<z.ZodNumber>;
+    highlightFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightFullFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightStartTag: z.ZodOptional<z.ZodString>;
+    highlightEndTag: z.ZodOptional<z.ZodString>;
+    snippetThreshold: z.ZodOptional<z.ZodNumber>;
+    groupBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    groupLimit: z.ZodOptional<z.ZodNumber>;
+    groupMissingValues: z.ZodOptional<z.ZodBoolean>;
+    queryByWeights: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    engineParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    mode: z.ZodLiteral<"hybrid">;
+    query: z.ZodString;
+    queryBy: z.ZodArray<z.ZodString>;
+    vectorField: z.ZodString;
+    nearVector: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    alpha: z.ZodOptional<z.ZodNumber>;
+    k: z.ZodOptional<z.ZodNumber>;
+    filter: z.ZodOptional<z.ZodObject<{
+        where: z.ZodOptional<z.ZodUnion<readonly [z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>, z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<any, string>>, z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>>]>>;
+        fields: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodBoolean>, z.ZodArray<z.ZodString>]>>;
+        order: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        offset: z.ZodOptional<z.ZodNumber>;
+        skip: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    mode: z.ZodLiteral<"raw">;
+    params: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, z.core.$strip>], "mode">;
+export type TSearchInput = z.infer<typeof SearchInputSchema>;
+/**
+ * A single collection's query within a multi-search. Uses the SAME friendly field names as
+ * single-collection `search()` - `query` (not `q`), `queryBy: string[]`, and the array-shaped
+ * `commonSearchParamsShape` (`facetBy`/`highlightFields`/...) - so the two APIs read identically.
+ * `filterBy` is a raw engine filter string: a cross-collection search has no per-collection model to
+ * translate a `TFilter` against. The datasource maps every entry to snake_case wire via the dialect.
+ */
+export declare const MultiSearchEntrySchema: z.ZodObject<{
+    facetBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    facetQuery: z.ZodOptional<z.ZodString>;
+    maxFacetValues: z.ZodOptional<z.ZodNumber>;
+    highlightFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightFullFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    highlightStartTag: z.ZodOptional<z.ZodString>;
+    highlightEndTag: z.ZodOptional<z.ZodString>;
+    snippetThreshold: z.ZodOptional<z.ZodNumber>;
+    groupBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    groupLimit: z.ZodOptional<z.ZodNumber>;
+    groupMissingValues: z.ZodOptional<z.ZodBoolean>;
+    queryByWeights: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    engineParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    collection: z.ZodString;
+    query: z.ZodOptional<z.ZodString>;
+    queryBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    filterBy: z.ZodOptional<z.ZodString>;
+    sortBy: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    perPage: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    includeFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    excludeFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    vectorQuery: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TMultiSearchEntry = z.infer<typeof MultiSearchEntrySchema>;
+/**
+ * Friendly multi-search params -> `ISearchQuery`: list fields are comma-joined, everything else
+ * passes through under its neutral name. The dialect then maps the result to the engine's wire
+ * format, so single `search()` and `multiSearch()` share one friendly-to-wire path. Also used for
+ * `commonParams`.
+ */
+export declare const toSearchQueryParams: (input: Record<string, unknown>) => Partial<ISearchQuery>;
+/** Cross-collection multi-search input: friendly `searches` entries plus the union flag. */
+export declare const MultiSearchInputSchema: z.ZodObject<{
+    searches: z.ZodArray<z.ZodObject<{
+        facetBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        facetQuery: z.ZodOptional<z.ZodString>;
+        maxFacetValues: z.ZodOptional<z.ZodNumber>;
+        highlightFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        highlightFullFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        highlightStartTag: z.ZodOptional<z.ZodString>;
+        highlightEndTag: z.ZodOptional<z.ZodString>;
+        snippetThreshold: z.ZodOptional<z.ZodNumber>;
+        groupBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        groupLimit: z.ZodOptional<z.ZodNumber>;
+        groupMissingValues: z.ZodOptional<z.ZodBoolean>;
+        queryByWeights: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        engineParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        collection: z.ZodString;
+        query: z.ZodOptional<z.ZodString>;
+        queryBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        filterBy: z.ZodOptional<z.ZodString>;
+        sortBy: z.ZodOptional<z.ZodString>;
+        page: z.ZodOptional<z.ZodNumber>;
+        perPage: z.ZodOptional<z.ZodNumber>;
+        offset: z.ZodOptional<z.ZodNumber>;
+        includeFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        excludeFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        vectorQuery: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    union: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type TMultiSearchInput = z.infer<typeof MultiSearchInputSchema>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/connectors/search/repositories/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../src/connectors/search/repositories/common/constants.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,CAAC,EAAE,MAAM,mBAAmB,CAAC;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,oHAAoH;AACpH,qBAAa,WAAW;IACtB,MAAM,CAAC,QAAQ,CAAC,OAAO,aAAa;IACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,cAAc;IACtC,MAAM,CAAC,QAAQ,CAAC,MAAM,YAAY;IAClC,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAE5B,MAAM,CAAC,QAAQ,CAAC,UAAU,cAAiE;IAE3F,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,WAAW;CAGpD;AACD,MAAM,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,WAAW,CAAC,CAAC;AAwG1D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAK5B,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE7D;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;iBAe2C,CAAC;AAC/E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAcvE;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,OAAO,CAAC,YAAY,CAaxF,CAAC;AAEF,4FAA4F;AAC5F,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAO/B,CAAC;AACL,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}