@venizia/ignis 0.0.10-4 → 0.1.0

package/dist/connectors/meilisearch/compiler.js

@@ -0,0 +1,130 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compileMeilisearchCollection = void 0;
+const models_1 = require("../../connectors/search/models");
+const ignis_helpers_1 = require("@venizia/ignis-helpers");
+const omit_1 = __importDefault(require("lodash/omit"));
+/** Meilisearch's single reserved geo field. It is an object `{ lat, lng }`, not a named tuple. */
+const RESERVED_GEO_FIELD_NAME = '_geo';
+const RESERVED_ID_FIELD_NAME = 'id';
+/** Neutral `<provider>/<model>` name -> Meilisearch's `source` discriminator. */
+const EMBED_SOURCE_BY_PROVIDER = {
+    openai: 'openAi',
+    huggingface: 'huggingFace',
+    ollama: 'ollama',
+    rest: 'rest',
+};
+const buildEmbedder = (opts) => {
+    const { field, embed } = opts;
+    const [provider, ...modelParts] = embed.model.name.split('/');
+    const source = EMBED_SOURCE_BY_PROVIDER[provider.toLowerCase()];
+    if (!source) {
+        throw (0, ignis_helpers_1.getError)({
+            message: `[compileMeilisearchCollection] Unsupported embed provider | field: ${field} | model: ${embed.model.name} | supported: ${Object.keys(EMBED_SOURCE_BY_PROVIDER).join(', ')}`,
+        });
+    }
+    const providerConfig = (0, omit_1.default)(embed.model, ['name']);
+    const documentTemplate = embed.from.map(item => `{{doc.${item}}}`).join(' ');
+    return { source, model: modelParts.join('/'), ...providerConfig, documentTemplate };
+};
+/** `root` set = one-way (only the root maps to its synonyms); absent = multi-way (all interchangeable). */
+const buildSynonymDictionary = (opts) => {
+    const dictionary = {};
+    for (const entry of opts.synonyms) {
+        if (entry.root) {
+            dictionary[entry.root] = entry.synonyms;
+            continue;
+        }
+        for (const term of entry.synonyms) {
+            dictionary[term] = entry.synonyms.filter(other => other !== term);
+        }
+    }
+    return dictionary;
+};
+const assertGeopoint = (opts) => {
+    const { definition } = opts;
+    const geoFields = definition.fields.filter(item => item.type === models_1.SearchFieldTypes.GEOPOINT);
+    if (geoFields.length === 0) {
+        return;
+    }
+    if (geoFields.length > 1) {
+        throw (0, ignis_helpers_1.getError)({
+            message: `[compileMeilisearchCollection] Meilisearch supports exactly one geo field | collection: ${definition.name} | found: ${geoFields.map(item => item.name).join(', ')}`,
+        });
+    }
+    if (geoFields[0].name !== RESERVED_GEO_FIELD_NAME) {
+        throw (0, ignis_helpers_1.getError)({
+            message: `[compileMeilisearchCollection] Meilisearch's geo field must be named '${RESERVED_GEO_FIELD_NAME}' and shaped { lat, lng } | collection: ${definition.name} | field: ${geoFields[0].name}`,
+        });
+    }
+};
+const assertVectorDistance = (opts) => {
+    const { field } = opts;
+    const distance = field.vector?.distance;
+    if (distance === undefined || distance === models_1.VectorDistances.COSINE) {
+        return;
+    }
+    throw (0, ignis_helpers_1.getError)({
+        message: `[compileMeilisearchCollection] Meilisearch supports only cosine vector distance | field: ${field.name} | distance: ${distance}`,
+    });
+};
+/** Compiles the neutral collection DSL into a Meilisearch index plan. */
+const compileMeilisearchCollection = (opts) => {
+    const { definition } = opts;
+    const { name, fields, defaultSort, synonyms, engineOverrides } = definition;
+    assertGeopoint({ definition });
+    const searchableAttributes = [];
+    const filterableAttributes = [];
+    const sortableAttributes = [];
+    const embedders = {};
+    let primaryKey;
+    for (const item of fields) {
+        if (item.name === RESERVED_ID_FIELD_NAME) {
+            primaryKey = item.name;
+        }
+        if (item.searchable) {
+            searchableAttributes.push(item.name);
+        }
+        if (item.filterable) {
+            filterableAttributes.push(item.name);
+        }
+        if (item.sortable) {
+            sortableAttributes.push(item.name);
+        }
+        if (item.type !== models_1.SearchFieldTypes.VECTOR) {
+            continue;
+        }
+        assertVectorDistance({ field: item });
+        embedders[item.name] = item.vector?.embed
+            ? buildEmbedder({ field: item.name, embed: item.vector.embed })
+            : { source: 'userProvided', dimensions: item.vector?.dimensions };
+    }
+    if (defaultSort !== undefined && !sortableAttributes.includes(defaultSort)) {
+        throw (0, ignis_helpers_1.getError)({
+            message: `[compileMeilisearchCollection] Meilisearch has no default_sorting_field, so defaultSort must name a sortable field | collection: ${name} | defaultSort: ${defaultSort}`,
+        });
+    }
+    const settings = {
+        // An empty array would disable search entirely; `['*']` is Meilisearch's own default.
+        searchableAttributes: searchableAttributes.length > 0 ? searchableAttributes : ['*'],
+        filterableAttributes,
+        sortableAttributes,
+    };
+    if (synonyms?.length) {
+        settings['synonyms'] = buildSynonymDictionary({ synonyms });
+    }
+    if (Object.keys(embedders).length > 0) {
+        settings['embedders'] = embedders;
+    }
+    const override = engineOverrides?.meilisearch;
+    return {
+        uid: name,
+        ...(primaryKey ? { primaryKey } : {}),
+        settings: override ? { ...settings, ...override } : settings,
+    };
+};
+exports.compileMeilisearchCollection = compileMeilisearchCollection;
+//# sourceMappingURL=compiler.js.map

package/dist/connectors/meilisearch/compiler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compiler.js","sourceRoot":"","sources":["../../../src/connectors/meilisearch/compiler.ts"],"names":[],"mappings":";;;;;;AAMA,uDAA+E;AAC/E,0DAAkD;AAClD,uDAA+B;AAE/B,kGAAkG;AAClG,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAEvC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAapC,iFAAiF;AACjF,MAAM,wBAAwB,GAA2B;IACvD,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;CACb,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,IAGtB,EAA2B,EAAE;IAC5B,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAC9B,MAAM,CAAC,QAAQ,EAAE,GAAG,UAAU,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9D,MAAM,MAAM,GAAG,wBAAwB,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,sEAAsE,KAAK,aAAa,KAAK,CAAC,KAAK,CAAC,IAAI,iBAAiB,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SACrL,CAAC,CAAC;IACL,CAAC;IAED,MAAM,cAAc,GAAG,IAAA,cAAI,EAAC,KAAK,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IACnD,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE7E,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,cAAc,EAAE,gBAAgB,EAAE,CAAC;AACtF,CAAC,CAAC;AAEF,2GAA2G;AAC3G,MAAM,sBAAsB,GAAG,CAAC,IAA8B,EAA4B,EAAE;IAC1F,MAAM,UAAU,GAA6B,EAAE,CAAC;IAEhD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;YACxC,SAAS;QACX,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YAClC,UAAU,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,IAAiD,EAAQ,EAAE;IACjF,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,yBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE5F,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO;IACT,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,2FAA2F,UAAU,CAAC,IAAI,aAAa,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAC9K,CAAC,CAAC;IACL,CAAC;IAED,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,uBAAuB,EAAE,CAAC;QAClD,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,yEAAyE,uBAAuB,2CAA2C,UAAU,CAAC,IAAI,aAAa,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;SACpM,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAAuC,EAAQ,EAAE;IAC7E,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACvB,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC;IAExC,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,wBAAe,CAAC,MAAM,EAAE,CAAC;QAClE,OAAO;IACT,CAAC;IAED,MAAM,IAAA,wBAAQ,EAAC;QACb,OAAO,EAAE,4FAA4F,KAAK,CAAC,IAAI,gBAAgB,QAAQ,EAAE;KAC1I,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,yEAAyE;AAClE,MAAM,4BAA4B,GAAG,CAAC,IAE5C,EAAyB,EAAE;IAC1B,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;IAE5E,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAE/B,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAC1C,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAC1C,MAAM,kBAAkB,GAAa,EAAE,CAAC;IACxC,MAAM,SAAS,GAA4B,EAAE,CAAC;IAC9C,IAAI,UAA8B,CAAC;IAEnC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;YACzC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,yBAAgB,CAAC,MAAM,EAAE,CAAC;YAC1C,SAAS;QACX,CAAC;QAED,oBAAoB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAEtC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK;YACvC,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAC/D,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC;IACtE,CAAC;IAED,IAAI,WAAW,KAAK,SAAS,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAA,wBAAQ,EAAC;YACb,OAAO,EAAE,oIAAoI,IAAI,mBAAmB,WAAW,EAAE;SAClL,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAA4B;QACxC,sFAAsF;QACtF,oBAAoB,EAAE,oBAAoB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACpF,oBAAoB;QACpB,kBAAkB;KACnB,CAAC;IAEF,IAAI,QAAQ,EAAE,MAAM,EAAE,CAAC;QACrB,QAAQ,CAAC,UAAU,CAAC,GAAG,sBAAsB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtC,QAAQ,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IACpC,CAAC;IAED,MAAM,QAAQ,GAAG,eAAe,EAAE,WAAW,CAAC;IAE9C,OAAO;QACL,GAAG,EAAE,IAAI;QACT,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ;KAC7D,CAAC;AACJ,CAAC,CAAC;AAtEW,QAAA,4BAA4B,gCAsEvC"}

package/dist/connectors/meilisearch/connector.d.ts

@@ -0,0 +1,225 @@
+import type { IImportResult, ISearchCollectionScoped, ISearchDocumentScoped, ISearchResult, ISearchSwapScoped, ISearchSynonymScoped } from '../../connectors/search';
+import { BaseSearchConnector } from '../../connectors/search';
+import type { ISynonym } from '../../connectors/search/models';
+import { Meilisearch } from 'meilisearch';
+import type { IMeilisearchIndexPlan } from './compiler';
+import type { IMeilisearchConnectorOptions } from './types';
+interface IMeilisearchTask {
+    taskUid: number;
+    status: string;
+    error?: unknown;
+    /** A finished task reports what it actually did, e.g. `deletedDocuments` on a documentDeletion. */
+    details?: Record<string, unknown>;
+}
+interface IMeilisearchDocumentsPage {
+    results: unknown[];
+    total: number;
+}
+/** Narrow structural view of the client surface this connector needs - the real client and the in-test fake both satisfy it. */
+interface IMeilisearchIndexApi {
+    addDocuments(documents: unknown[], options?: unknown): Promise<IMeilisearchTask>;
+    updateDocuments(documents: unknown[], options?: unknown): Promise<IMeilisearchTask>;
+    getDocument(id: string, options?: unknown): Promise<unknown>;
+    getDocuments(params: unknown): Promise<IMeilisearchDocumentsPage>;
+    deleteDocument(id: string): Promise<IMeilisearchTask>;
+    deleteDocuments(params: unknown): Promise<IMeilisearchTask>;
+    deleteAllDocuments(): Promise<IMeilisearchTask>;
+    search(query: string | null, params?: unknown): Promise<unknown>;
+    updateSettings(settings: unknown): Promise<IMeilisearchTask>;
+    getSettings(): Promise<Record<string, unknown>>;
+    updateSynonyms(synonyms: Record<string, string[]>): Promise<IMeilisearchTask>;
+    resetSynonyms(): Promise<IMeilisearchTask>;
+}
+export interface IMeilisearchClientLike {
+    index(uid: string): IMeilisearchIndexApi;
+    createIndex(uid: string, options?: unknown): Promise<IMeilisearchTask>;
+    getIndex(uid: string): Promise<unknown>;
+    getIndexes(params?: unknown): Promise<{
+        results: unknown[];
+    }>;
+    deleteIndex(uid: string): Promise<IMeilisearchTask>;
+    swapIndexes(pairs: Array<{
+        indexes: string[];
+    }>): Promise<IMeilisearchTask>;
+    getTask(taskUid: number): Promise<IMeilisearchTask>;
+    health(): Promise<{
+        status: string;
+    }>;
+    multiSearch(params: unknown): Promise<unknown>;
+}
+/** Meilisearch-backed search connector. Every write awaits its task, so `create()` resolves only once the document is retrievable. */
+export declare class MeilisearchConnector extends BaseSearchConnector {
+    private readonly client;
+    private readonly rawClient?;
+    private readonly taskTimeoutMs;
+    private readonly taskIntervalMs;
+    private readonly primaryKeyByCollection;
+    constructor(opts: IMeilisearchConnectorOptions & {
+        client?: IMeilisearchClientLike;
+    });
+    /** The raw SDK client - the escape hatch for anything this connector does not model (fire-and-forget writes, federation, facet search). */
+    getClient(): Meilisearch;
+    protected isNotFoundError(opts: {
+        error: unknown;
+    }): boolean;
+    readonly collection: ISearchCollectionScoped<IMeilisearchIndexPlan, unknown, never>;
+    /** Meilisearch has no alias layer; a zero-downtime reindex swaps two index uids atomically. */
+    readonly swap: ISearchSwapScoped;
+    /** A flat per-index dictionary. There is no named, linkable synonym-set resource. */
+    readonly synonyms: ISearchSynonymScoped;
+    readonly document: ISearchDocumentScoped;
+    getHealth(): Promise<{
+        ok: boolean;
+    }>;
+    /**
+     * Every Meilisearch write returns a task uid and is invisible to search until the task reaches
+     * `succeeded`. The SDK's own `waitForTask` defaults to a 5 s timeout - far too short for a bulk
+     * import - so the connector polls itself against a caller-configured ceiling.
+     */
+    private waitForTask;
+    /**
+     * Every Meilisearch write returns a task uid and only becomes visible once that task succeeds. This
+     * runs the write, awaits its task to completion, and returns the FINISHED task - callers that read
+     * `details` (e.g. deleteByFilter's `deletedDocuments`) get the terminal record.
+     */
+    private awaitWrite;
+    createCollection(opts: {
+        schema: IMeilisearchIndexPlan;
+    }): Promise<void>;
+    /** Create-if-absent, then apply settings. Both steps await their task, so the index is queryable on return. */
+    ensureCollection(opts: {
+        schema: IMeilisearchIndexPlan;
+    }): Promise<unknown>;
+    getCollection(opts: {
+        name: string;
+    }): Promise<unknown>;
+    listCollections(): Promise<unknown[]>;
+    collectionExists(opts: {
+        name: string;
+    }): Promise<boolean>;
+    /** Meilisearch is schemaless: there is no field schema to patch. Settings are applied by ensureCollection. */
+    patchCollectionSchema(): Promise<void>;
+    deleteCollection(opts: {
+        name: string;
+    }): Promise<boolean>;
+    swapIndexes(opts: {
+        pairs: Array<[string, string]>;
+    }): Promise<void>;
+    setSynonyms(opts: {
+        collection: string;
+        items: ISynonym[];
+    }): Promise<void>;
+    getSynonyms(opts: {
+        collection: string;
+    }): Promise<ISynonym[]>;
+    resetSynonyms(opts: {
+        collection: string;
+    }): Promise<void>;
+    getDocument<T extends object>(opts: {
+        collection: string;
+        id: string;
+    }): Promise<T>;
+    /**
+     * Exact and uncapped. `pagination.maxTotalHits` bounds the SEARCH route only - Meilisearch's own
+     * documentation states it "has no effect on the get documents" endpoints - so reading `total` from
+     * `documents/fetch` is what keeps `count()` from quietly lying on large filtered sets.
+     */
+    countDocuments(opts: {
+        collection: string;
+        filterBy?: string;
+    }): Promise<number>;
+    /**
+     * Create-only, matching the neutral contract (and Typesense, whose `documents().create()` rejects a
+     * duplicate id). Meilisearch has no conditional insert - `addDocuments` is add-or-REPLACE - so the id
+     * is checked first. That check is NOT atomic: two concurrent creates of the same id can both pass it,
+     * and the second write wins. Callers needing last-write-wins should use `upsert` and say so.
+     */
+    createDocument<T extends object>(opts: {
+        collection: string;
+        document: T;
+    }): Promise<T>;
+    private documentExists;
+    /** Add-or-replace by primary key. Awaits the task, so the document is retrievable when this resolves. */
+    upsertDocument<T extends object>(opts: {
+        collection: string;
+        document: T;
+    }): Promise<T>;
+    /**
+     * Merge-update by primary key: fields absent from the patch are preserved. Meilisearch's write
+     * returns only a task, never the row, so the merged document must be read back - one extra round
+     * trip versus Typesense, and NOT atomic: a concurrent write landing between the task succeeding and
+     * this read means the returned document is not necessarily what this call wrote.
+     */
+    updateDocument<T extends object>(opts: {
+        collection: string;
+        id: string;
+        document: Partial<T>;
+    }): Promise<T>;
+    /**
+     * Meilisearch has no update-by-filter endpoint. `documents/edit` would do it server-side, but it is
+     * gated behind an experimental flag, is documented as breaking between minor versions, and has an
+     * open correctness bug - so this pages ids out of the uncapped `documents/fetch` route and merges
+     * them back in batches. NOT atomic: a concurrent write to a matched document may be overwritten.
+     */
+    updateByFilter<T extends object>(opts: {
+        collection: string;
+        document: Partial<T>;
+        filterBy: string;
+    }): Promise<{
+        updatedCount: number;
+    }>;
+    /** Walks `documents/fetch` until exhausted. Not bounded by `pagination.maxTotalHits`. */
+    private fetchAllDocuments;
+    private collectMatchingIds;
+    deleteDocument(opts: {
+        collection: string;
+        id: string;
+    }): Promise<boolean>;
+    /**
+     * Delete-by-filter IS native here (unlike update-by-filter). The count is read from the FINISHED
+     * task's `details.deletedDocuments` - a pre-count would be wrong in both directions if a concurrent
+     * write added or removed a matching document between counting and deleting.
+     */
+    deleteByFilter(opts: {
+        collection: string;
+        filterBy: string;
+    }): Promise<number>;
+    deleteAllDocuments(opts: {
+        collection: string;
+    }): Promise<boolean>;
+    /**
+     * Batches through addDocuments, awaiting each batch's task before starting the next. Meilisearch
+     * import is batch-atomic, so `count.fail` is structurally always 0: a batch either lands whole or
+     * throws. A thrown import means the batches after the failure point did not land - the error's
+     * `details` carry `processedCount` so callers can resume from there.
+     */
+    importDocuments<T extends object>(opts: {
+        collection: string;
+        documents: T[];
+        batchSize?: number;
+    }): Promise<IImportResult<unknown>>;
+    /** Newline-delimited JSON, matching the Typesense connector's export contract. */
+    exportDocuments(opts: {
+        collection: string;
+        filterBy?: string;
+        includeFields?: string[];
+    }): Promise<string>;
+    search<TDocument extends object = object>(opts: {
+        collection: string;
+        params: unknown;
+    }): Promise<ISearchResult<TDocument>>;
+    /**
+     * Batched, non-federated: N queries in one round trip, N result sets back. `commonParams` are
+     * defaults - a per-query param always wins over them, so a query's own `q` is never clobbered.
+     */
+    multiSearch(opts: {
+        searches: unknown[];
+        union?: boolean;
+        commonParams?: unknown;
+        options?: unknown;
+    }): Promise<unknown>;
+    /** Meilisearch infers the primary key from the first document; the compiler pins it, and the index reports it. */
+    private resolvePrimaryKey;
+}
+export {};
+//# sourceMappingURL=connector.d.ts.map

package/dist/connectors/meilisearch/connector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector.d.ts","sourceRoot":"","sources":["../../../src/connectors/meilisearch/connector.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAI3D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAExD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAY5D,UAAU,gBAAgB;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,mGAAmG;IACnG,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,UAAU,yBAAyB;IACjC,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gIAAgI;AAChI,UAAU,oBAAoB;IAC5B,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACjF,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpF,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7D,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAClE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACtD,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,kBAAkB,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAChD,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE,cAAc,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7D,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAChD,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC9E,aAAa,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,oBAAoB,CAAC;IACzC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACvE,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,CAAA;KAAE,CAAC,CAAC;IAC9D,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpD,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5E,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpD,MAAM,IAAI,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACtC,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAChD;AA0GD,sIAAsI;AACtI,qBAAa,oBAAqB,SAAQ,mBAAmB;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;IAChD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAc;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA6B;gBAExD,IAAI,EAAE,4BAA4B,GAAG;QAAE,MAAM,CAAC,EAAE,sBAAsB,CAAA;KAAE;IA+BpF,2IAA2I;IAC3I,SAAS,IAAI,WAAW;IAUxB,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO;IAI5D,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAC,qBAAqB,EAAE,OAAO,EAAE,KAAK,CAAC,CAQjF;IAEF,+FAA+F;IAC/F,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAE9B;IAEF,qFAAqF;IACrF,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAIrC;IAEF,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAoBtC;IAEI,SAAS,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,CAAC;IAY3C;;;;OAIG;YACW,WAAW;IA4CzB;;;;OAIG;YACW,UAAU;IASlB,gBAAgB,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,qBAAqB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA4B9E,+GAA+G;IACzG,gBAAgB,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,qBAAqB,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAkB3E,aAAa,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBvD,eAAe,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAYrC,gBAAgB,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAoBhE,8GAA8G;IAC9G,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAQhC,gBAAgB,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAuB1D,WAAW,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBpE,WAAW,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B3E,WAAW,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAuB9D,aAAa,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAc1D,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAoBzF;;;;OAIG;IACG,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAyBtF;;;;;OAKG;IACG,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;YAsB/E,cAAc;IAoB5B,yGAAyG;IACnG,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAqB7F;;;;;OAKG;IACG,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAC3C,UAAU,EAAE,MAAM,CAAC;QACnB,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;KACtB,GAAG,OAAO,CAAC,CAAC,CAAC;IAmCd;;;;;OAKG;IACG,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAC3C,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACrB,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAqCrC,yFAAyF;YAC3E,iBAAiB;YAkCjB,kBAAkB;IAuB1B,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBhF;;;;OAIG;IACG,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IA2B/E,kBAAkB,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBxE;;;;;OAKG;IACG,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAC5C,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,CAAC,EAAE,CAAC;QACf,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAyDnC,kFAAkF;IAC5E,eAAe,CAAC,IAAI,EAAE;QAC1B,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;KAC1B,GAAG,OAAO,CAAC,MAAM,CAAC;IAqBb,MAAM,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE;QACpD,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,OAAO,CAAC;KACjB,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IA2BrC;;;OAGG;IACG,WAAW,CAAC,IAAI,EAAE;QACtB,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BpB,kHAAkH;YACpG,iBAAiB;CAyBhC"}