@venizia/ignis-connectors 0.2.0-0

package/dist/cjs/search/typesense/compiler.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compileTypesenseCollection = void 0;
+const core_1 = require("@venizia/ignis-helpers/core");
+const models_1 = require("../../search/core/models");
+const RESERVED_ID_FIELD_NAME = 'id';
+/** camelCase embed model-config field -> Typesense `model_config` snake_case wire key; unmapped keys pass through. */
+const EMBED_MODEL_WIRE_KEYS = {
+    name: 'model_name',
+    apiKey: 'api_key',
+    accessToken: 'access_token',
+    refreshToken: 'refresh_token',
+    clientId: 'client_id',
+    clientSecret: 'client_secret',
+    projectId: 'project_id',
+};
+/** DSL field type -> Typesense wire type. */
+const mapFieldType = (opts) => {
+    const { type } = opts;
+    switch (type) {
+        case models_1.SearchFieldTypes.STRING: {
+            return 'string';
+        }
+        case models_1.SearchFieldTypes.NUMBER: {
+            return 'float';
+        }
+        case models_1.SearchFieldTypes.BOOLEAN: {
+            return 'bool';
+        }
+        case models_1.SearchFieldTypes.GEOPOINT: {
+            return 'geopoint';
+        }
+        case models_1.SearchFieldTypes.STRING_ARRAY: {
+            return 'string[]';
+        }
+        case models_1.SearchFieldTypes.NUMBER_ARRAY: {
+            return 'float[]';
+        }
+        case models_1.SearchFieldTypes.BOOLEAN_ARRAY: {
+            return 'bool[]';
+        }
+        case models_1.SearchFieldTypes.VECTOR: {
+            return 'float[]';
+        }
+        default: {
+            // Unreachable under TSearchFieldType's typing - defensive against a widened caller.
+            throw (0, core_1.getError)({
+                message: `[compileTypesenseCollection] Unsupported search field type '${String(type)}'`,
+            });
+        }
+    }
+};
+/** camelCase model config -> Typesense `model_config` wire object; undefined entries are dropped. */
+const buildEmbedModelConfig = (opts) => {
+    const { model } = opts;
+    const modelConfig = {};
+    for (const [key, value] of Object.entries(model)) {
+        if (value === undefined) {
+            continue;
+        }
+        modelConfig[EMBED_MODEL_WIRE_KEYS[key] ?? key] = value;
+    }
+    return modelConfig;
+};
+/** Writes the vector-specific wire keys (embed/num_dim/vec_dist) onto an already compiled field. */
+const applyVectorConfig = (opts) => {
+    const { compiled, field } = opts;
+    const { vector } = field;
+    if (!vector) {
+        return;
+    }
+    if (!vector.embed) {
+        if (vector.dimensions === undefined) {
+            throw (0, core_1.getError)({
+                message: `[compileTypesenseCollection] vector field '${field.name}' requires 'dimensions' (or an 'embed' config)`,
+            });
+        }
+        compiled.num_dim = vector.dimensions;
+        compiled.vec_dist = vector.distance ?? models_1.VectorDistances.COSINE;
+        return;
+    }
+    const embed = {
+        from: vector.embed.from,
+        ['model_config']: buildEmbedModelConfig({ model: vector.embed.model }),
+    };
+    compiled.embed = embed;
+    if (vector.dimensions !== undefined) {
+        compiled.num_dim = vector.dimensions;
+    }
+};
+// searchable/filterable have no Typesense equivalent - every field is indexed by default, so both are dropped; sortable maps to `sort`, required for strings and harmless on numbers.
+const compileField = (opts) => {
+    const { field } = opts;
+    const compiled = {
+        name: field.name,
+        type: mapFieldType({ type: field.type }),
+    };
+    if (field.facet !== undefined) {
+        compiled.facet = field.facet;
+    }
+    if (field.optional !== undefined) {
+        compiled.optional = field.optional;
+    }
+    if (field.sortable !== undefined) {
+        compiled.sort = field.sortable;
+    }
+    applyVectorConfig({ compiled, field });
+    return compiled;
+};
+const mergeFields = (opts) => {
+    const { base, override } = opts;
+    if (!override || override.length === 0) {
+        return base;
+    }
+    const overrideByName = new Map(override.map(item => [item.name, item]));
+    const merged = base.map(baseField => {
+        const match = overrideByName.get(baseField.name);
+        return match ? { ...baseField, ...match } : baseField;
+    });
+    const baseNames = new Set(base.map(item => item.name));
+    const appended = override.filter(item => !baseNames.has(item.name));
+    return [...merged, ...appended];
+};
+/** engineOverrides.typesense merge order: top-level keys override last-wins; `fields` matched by name and shallow-merged, unmatched entries appended verbatim. */
+const mergeOverride = (opts) => {
+    const { schema, override } = opts;
+    // engineOverrides.typesense is a loose `object` in the neutral DSL; cast once here to a partial wire schema.
+    const { fields: overrideFields, ...restOverride } = override;
+    return {
+        ...schema,
+        ...restOverride,
+        fields: mergeFields({ base: schema.fields, override: overrideFields }),
+    };
+};
+/**
+ * A dotted field name resolves ONLY on a collection created with `enable_nested_fields`, and ignis
+ * never emits that flag - an application sets it per collection through `engineOverrides.typesense`.
+ * Since the dialect now compiles a declared dotted field rather than rejecting it outright, the
+ * mismatch would otherwise surface at QUERY time as an engine rejection, far from the declaration
+ * that caused it. Caught here, where the mistake is made, in the same spirit as the `defaultSort`
+ * checks above.
+ *
+ * Deliberately NOT auto-enabled: what `enable_nested_fields` does beyond making dotted names
+ * resolve is not established here, and emitting engine configuration on an unverified assumption
+ * is how surprises get built in. Validate, do not paper over.
+ *
+ * Read off the MERGED schema, so a dotted field appended by the override is checked too, and the
+ * flag is read wherever it was set. `enable_nested_fields` is declared on the SDK's
+ * `CollectionCreateSchema`, so no narrowing of the loose `engineOverrides` blob is needed.
+ */
+const assertNestedFieldsEnabled = (opts) => {
+    const { schema } = opts;
+    if (schema.enable_nested_fields === true) {
+        return;
+    }
+    const dotted = schema.fields.find(item => item.name.includes('.'));
+    if (!dotted) {
+        return;
+    }
+    throw (0, core_1.getError)({
+        message: `[compileTypesenseCollection] Nested field name requires enable_nested_fields | name: ${schema.name} | field: ${dotted.name} | a dotted name is a real Typesense field, but the collection must be created with the flag - set it via engineOverrides: { typesense: { enable_nested_fields: true } }`,
+    });
+};
+/** Compiles an engine-neutral `ISearchCollectionDefinition` into a Typesense `CollectionCreateSchema`. */
+const compileTypesenseCollection = (opts) => {
+    const { definition } = opts;
+    const { name, fields, defaultSort, engineOverrides } = definition;
+    const compiledFields = fields
+        .filter(item => item.name !== RESERVED_ID_FIELD_NAME)
+        .map(item => compileField({ field: item }));
+    let schema = {
+        name,
+        fields: compiledFields,
+    };
+    if (defaultSort !== undefined) {
+        const sortField = fields.find(item => item.name === defaultSort);
+        // A defaultSort naming an undeclared field would otherwise be forwarded verbatim and rejected by the engine - fail here with the field named, same as the type check.
+        if (!sortField) {
+            throw (0, core_1.getError)({
+                message: `[compileTypesenseCollection] Invalid defaultSort | references a field that does not exist in the collection | name: ${name} | defaultSort: ${defaultSort}`,
+            });
+        }
+        // Typesense's default_sorting_field accepts only a scalar numeric field, never string/array.
+        if (sortField.type !== models_1.SearchFieldTypes.NUMBER) {
+            throw (0, core_1.getError)({
+                message: `[compileTypesenseCollection] Invalid defaultSort | Typesense's default_sorting_field requires a scalar numeric field (int32/int64/float) - not string, not array | name: ${name} | defaultSort: ${defaultSort} | type: ${sortField.type}`,
+            });
+        }
+        schema.default_sorting_field = defaultSort;
+    }
+    const typesenseOverride = engineOverrides?.typesense;
+    if (typesenseOverride) {
+        schema = mergeOverride({ schema, override: typesenseOverride });
+    }
+    assertNestedFieldsEnabled({ schema });
+    return schema;
+};
+exports.compileTypesenseCollection = compileTypesenseCollection;
+//# sourceMappingURL=compiler.js.map

package/dist/cjs/search/typesense/compiler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compiler.js","sourceRoot":"","sources":["../../../../src/search/typesense/compiler.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AAUvD,iDAAyE;AAKzE,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAEpC,sHAAsH;AACtH,MAAM,qBAAqB,GAA2B;IACpD,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE,SAAS;IACjB,WAAW,EAAE,cAAc;IAC3B,YAAY,EAAE,eAAe;IAC7B,QAAQ,EAAE,WAAW;IACrB,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,YAAY;CACxB,CAAC;AAEF,6CAA6C;AAC7C,MAAM,YAAY,GAAG,CAAC,IAAgC,EAA2B,EAAE;IACjF,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAEtB,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,yBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7B,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,yBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7B,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,yBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9B,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,KAAK,yBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC/B,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,KAAK,yBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YACnC,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,KAAK,yBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;YACnC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,yBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;YACpC,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,KAAK,yBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,oFAAoF;YACpF,MAAM,IAAA,eAAQ,EAAC;gBACb,OAAO,EAAE,+DAA+D,MAAM,CAAC,IAAI,CAAC,GAAG;aACxF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,qGAAqG;AACrG,MAAM,qBAAqB,GAAG,CAAC,IAE9B,EAA2B,EAAE;IAC5B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACvB,MAAM,WAAW,GAA4B,EAAE,CAAC;IAEhD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,SAAS;QACX,CAAC;QAED,WAAW,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC;IACzD,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,oGAAoG;AACpG,MAAM,iBAAiB,GAAG,CAAC,IAG1B,EAAQ,EAAE;IACT,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACjC,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAEzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAClB,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,IAAA,eAAQ,EAAC;gBACb,OAAO,EAAE,8CAA8C,KAAK,CAAC,IAAI,gDAAgD;aAClH,CAAC,CAAC;QACL,CAAC;QAED,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,wBAAe,CAAC,MAAM,CAAC;QAC9D,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAA4B;QACrC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI;QACvB,CAAC,cAAc,CAAC,EAAE,qBAAqB,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;KACvE,CAAC;IACF,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;IAEvB,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACpC,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC;IACvC,CAAC;AACH,CAAC,CAAC;AAEF,sLAAsL;AACtL,MAAM,YAAY,GAAG,CAAC,IAAuC,EAAmB,EAAE;IAChF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAEvB,MAAM,QAAQ,GAAoB;QAChC,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,IAAI,EAAE,YAAY,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;KACzC,CAAC;IAEF,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,QAAQ,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACrC,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IAED,iBAAiB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvC,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,IAGpB,EAAqB,EAAE;IACtB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAEhC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;QAClC,MAAM,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACjD,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpE,OAAO,CAAC,GAAG,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,kKAAkK;AAClK,MAAM,aAAa,GAAG,CAAC,IAGtB,EAA0B,EAAE;IAC3B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAElC,6GAA6G;IAC7G,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,YAAY,EAAE,GAC/C,QAEC,CAAC;IAEJ,OAAO;QACL,GAAG,MAAM;QACT,GAAG,YAAY;QACf,MAAM,EAAE,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;KACvE,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,yBAAyB,GAAG,CAAC,IAAwC,EAAQ,EAAE;IACnF,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAExB,IAAI,MAAM,CAAC,oBAAoB,KAAK,IAAI,EAAE,CAAC;QACzC,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAEnE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,MAAM,IAAA,eAAQ,EAAC;QACb,OAAO,EAAE,wFAAwF,MAAM,CAAC,IAAI,aAAa,MAAM,CAAC,IAAI,0KAA0K;KAC/S,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,0GAA0G;AACnG,MAAM,0BAA0B,GAAG,CAAC,IAE1C,EAA0B,EAAE;IAC3B,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;IAElE,MAAM,cAAc,GAAG,MAAM;SAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,sBAAsB,CAAC;SACpD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAE9C,IAAI,MAAM,GAA2B;QACnC,IAAI;QACJ,MAAM,EAAE,cAAc;KACvB,CAAC;IAEF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;QAEjE,sKAAsK;QACtK,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAA,eAAQ,EAAC;gBACb,OAAO,EAAE,uHAAuH,IAAI,mBAAmB,WAAW,EAAE;aACrK,CAAC,CAAC;QACL,CAAC;QAED,6FAA6F;QAC7F,IAAI,SAAS,CAAC,IAAI,KAAK,yBAAgB,CAAC,MAAM,EAAE,CAAC;YAC/C,MAAM,IAAA,eAAQ,EAAC;gBACb,OAAO,EAAE,4KAA4K,IAAI,mBAAmB,WAAW,YAAY,SAAS,CAAC,IAAI,EAAE;aACpP,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAC,qBAAqB,GAAG,WAAW,CAAC;IAC7C,CAAC;IAED,MAAM,iBAAiB,GAAG,eAAe,EAAE,SAAS,CAAC;IACrD,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,GAAG,aAAa,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAEtC,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA3CW,QAAA,0BAA0B,8BA2CrC"}

package/dist/cjs/search/typesense/connector.d.ts

@@ -0,0 +1,219 @@
+import type { IAliasInfo, IImportResult, ISearchAliasScoped, ISearchCollectionScoped, ISearchDocumentScoped, ISearchResult, ISearchSynonymSetScoped } from '../../search/core';
+import { BaseSearchConnector } from '../../search/core';
+import type { ISynonym } from '../../search/core/models';
+import { Client } from 'typesense';
+import type { IMultiSearchResult, ITypesenseConnectorOptions, IUnionSearchResult, TCollectionCreateSchema, TCollectionFieldSchema, TCollectionSchema, TDocumentSchema, TImportResponse, TSearchOptions, TSearchParams, TTypesenseDirtyValue, TTypesenseImportAction } from './types';
+interface ITypesenseDocumentsApi {
+    create(document: unknown, options?: unknown): Promise<unknown>;
+    upsert(document: unknown, options?: unknown): Promise<unknown>;
+    update(document: unknown, options: unknown): Promise<unknown>;
+    delete(query?: unknown): Promise<unknown>;
+    import(documents: unknown[], options?: unknown): Promise<unknown>;
+    search(searchParameters: unknown, options?: unknown): Promise<unknown>;
+    export(options?: unknown): Promise<unknown>;
+}
+interface ITypesenseDocumentApi {
+    retrieve(): Promise<unknown>;
+    update(partialDocument: unknown, options?: unknown): Promise<unknown>;
+    delete(options?: unknown): Promise<unknown>;
+}
+interface ITypesenseSynonymSetApi {
+    upsert(params: unknown): Promise<unknown>;
+    retrieve(): Promise<unknown>;
+    delete(): Promise<unknown>;
+}
+interface ITypesenseSynonymSetsApi {
+    retrieve(): Promise<unknown>;
+}
+interface ITypesenseCollectionApi {
+    documents(): ITypesenseDocumentsApi;
+    documents(documentId: string): ITypesenseDocumentApi;
+    retrieve(): Promise<unknown>;
+    update(schema: unknown): Promise<unknown>;
+    delete(options?: unknown): Promise<unknown>;
+    exists(): Promise<boolean>;
+}
+interface ITypesenseCollectionsApi {
+    create(schema: unknown, options?: unknown): Promise<unknown>;
+    retrieve(options?: unknown): Promise<unknown>;
+}
+interface ITypesenseAliasApi {
+    retrieve(): Promise<unknown>;
+}
+interface ITypesenseAliasesApi {
+    upsert(name: string, mapping: unknown): Promise<unknown>;
+}
+export interface ITypesenseClientLike {
+    collections(): ITypesenseCollectionsApi;
+    collections(collectionName: string): ITypesenseCollectionApi;
+    aliases(): ITypesenseAliasesApi;
+    aliases(aliasName: string): ITypesenseAliasApi;
+    synonymSets(): ITypesenseSynonymSetsApi;
+    synonymSets(synonymSetName: string): ITypesenseSynonymSetApi;
+    health: {
+        retrieve(): Promise<unknown>;
+    };
+    multiSearch: {
+        perform(searchRequests: unknown, commonParams?: unknown, options?: unknown): Promise<unknown>;
+    };
+}
+/** Typesense engine connector - built/injected by TypesenseDataSource, which exposes the raw client via getClient(). */
+export declare class TypesenseConnector extends BaseSearchConnector {
+    private readonly client;
+    constructor(opts: ITypesenseConnectorOptions & {
+        client?: ITypesenseClientLike;
+    });
+    getClient(): Client;
+    protected isNotFoundError(opts: {
+        error: unknown;
+    }): boolean;
+    readonly collection: ISearchCollectionScoped<TCollectionCreateSchema, TCollectionSchema, TCollectionFieldSchema>;
+    readonly alias: ISearchAliasScoped;
+    readonly synonymSet: ISearchSynonymSetScoped;
+    readonly document: ISearchDocumentScoped;
+    getHealth(): Promise<{
+        ok: boolean;
+    }>;
+    createCollection(opts: {
+        schema: TCollectionCreateSchema;
+    }): Promise<TCollectionSchema | void>;
+    ensureCollection(opts: {
+        schema: TCollectionCreateSchema;
+    }): Promise<TCollectionSchema>;
+    getCollection(opts: {
+        name: string;
+    }): Promise<TCollectionSchema>;
+    listCollections(): Promise<TCollectionSchema[]>;
+    collectionExists(opts: {
+        name: string;
+    }): Promise<boolean>;
+    patchCollectionSchema(opts: {
+        name: string;
+        fields: TCollectionFieldSchema[];
+    }): Promise<void>;
+    deleteCollection(opts: {
+        name: string;
+    }): Promise<boolean>;
+    upsertAlias(opts: {
+        name: string;
+        collection: string;
+    }): Promise<void>;
+    getAlias(opts: {
+        name: string;
+    }): Promise<IAliasInfo | null>;
+    upsertSynonymSet(opts: {
+        name: string;
+        items: ISynonym[];
+    }): Promise<void>;
+    getSynonymSet(opts: {
+        name: string;
+    }): Promise<ISynonym[] | null>;
+    listSynonymSets(): Promise<string[]>;
+    deleteSynonymSet(opts: {
+        name: string;
+    }): Promise<boolean>;
+    linkSynonymSets(opts: {
+        collection: string;
+        synonymSets: string[];
+    }): Promise<void>;
+    createDocument<T extends object>(opts: {
+        collection: string;
+        document: T;
+    }): Promise<T>;
+    getDocument<T extends object>(opts: {
+        collection: string;
+        id: string;
+    }): Promise<T>;
+    /** Typesense's `found` is exhaustive, so a `per_page: 0` search is already an exact count - no separate endpoint needed. */
+    countDocuments(opts: {
+        collection: string;
+        filterBy?: string;
+    }): Promise<number>;
+    upsertDocument<T extends object>(opts: {
+        collection: string;
+        document: T;
+    }): Promise<T>;
+    updateDocument<T extends object>(opts: {
+        collection: string;
+        id: string;
+        document: Partial<T>;
+    }): Promise<T>;
+    deleteDocument(opts: {
+        collection: string;
+        id: string;
+    }): Promise<boolean>;
+    /** Appends one batch's per-row responses to `responses` and returns that batch's success/fail split. */
+    private tallyImportResponses;
+    importDocuments<T extends object>(opts: {
+        collection: string;
+        documents: T[];
+        action?: TTypesenseImportAction;
+        batchSize?: number;
+        dirtyValues?: TTypesenseDirtyValue;
+    }): Promise<IImportResult<TImportResponse>>;
+    updateByFilter<T extends object>(opts: {
+        collection: string;
+        document: Partial<T>;
+        filterBy: string;
+    }): Promise<{
+        updatedCount: number;
+    }>;
+    deleteByFilter(opts: {
+        collection: string;
+        filterBy: string;
+        batchSize?: number;
+        ignoreNotFound?: boolean;
+    }): Promise<number>;
+    deleteAllDocuments(opts: {
+        collection: string;
+    }): Promise<boolean>;
+    exportDocuments(opts: {
+        collection: string;
+        filterBy?: string;
+        includeFields?: string[];
+    }): Promise<string>;
+    /**
+     * The single transport. Every engine search - one collection or many - is one POST to
+     * `/multi_search`.
+     *
+     * `/multi_search` is a strict superset of GET single-search: it accepts the same per-entry
+     * params, and it carries them in the BODY. GET is capped near 4000 characters of query string,
+     * which a `filter_by` built from an authorization scope exceeds at roughly ninety ids - so a
+     * user with many permitted scopes could not search at all. Choosing between the two at runtime
+     * would mean deciding on URL length, which is only knowable after building the query; there is
+     * no decision point here, so there is nothing to decide wrongly.
+     */
+    private executeMultiSearch;
+    search<T extends TDocumentSchema = TDocumentSchema>(opts: {
+        collection: string;
+        params: TSearchParams;
+        options?: TSearchOptions;
+    }): Promise<ISearchResult<T>>;
+    /**
+     * Refuses a page that cannot be served honestly, rather than serving part of it.
+     *
+     * Grouped results are refused outright: groups span windows, so concatenating duplicates them
+     * and taking the first window drops the rest. Merging by key would mean re-deriving `group_limit`
+     * ordering the engine never produced - inventing an answer, which is the failure class this
+     * whole change exists to remove.
+     */
+    private assertSplittablePage;
+    multiSearch<T extends TDocumentSchema = TDocumentSchema>(opts: {
+        searches: Array<{
+            collection: string;
+        } & Partial<TSearchParams>>;
+        union: true;
+        commonParams?: Partial<TSearchParams>;
+        options?: TSearchOptions;
+    }): Promise<IUnionSearchResult<T>>;
+    multiSearch<T extends TDocumentSchema = TDocumentSchema>(opts: {
+        searches: Array<{
+            collection: string;
+        } & Partial<TSearchParams>>;
+        union?: false;
+        commonParams?: Partial<TSearchParams>;
+        options?: TSearchOptions;
+    }): Promise<IMultiSearchResult<T>>;
+}
+export {};
+//# sourceMappingURL=connector.d.ts.map

package/dist/cjs/search/typesense/connector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector.d.ts","sourceRoot":"","sources":["../../../../src/search/typesense/connector.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,uBAAuB,EACxB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,KAAK,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAoOjB,UAAU,sBAAsB;IAC9B,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/D,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/D,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9D,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAClE,MAAM,CAAC,gBAAgB,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvE,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7C;AACD,UAAU,qBAAqB;IAC7B,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,CAAC,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACtE,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7C;AACD,UAAU,uBAAuB;IAC/B,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5B;AACD,UAAU,wBAAwB;IAChC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9B;AACD,UAAU,uBAAuB;IAC/B,SAAS,IAAI,sBAAsB,CAAC;IACpC,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,qBAAqB,CAAC;IACrD,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5B;AACD,UAAU,wBAAwB;IAChC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7D,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/C;AACD,UAAU,kBAAkB;IAC1B,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC9B;AACD,UAAU,oBAAoB;IAC5B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1D;AACD,MAAM,WAAW,oBAAoB;IACnC,WAAW,IAAI,wBAAwB,CAAC;IACxC,WAAW,CAAC,cAAc,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAC7D,OAAO,IAAI,oBAAoB,CAAC;IAChC,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAC/C,WAAW,IAAI,wBAAwB,CAAC;IACxC,WAAW,CAAC,cAAc,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAC7D,MAAM,EAAE;QAAE,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;KAAE,CAAC;IACzC,WAAW,EAAE;QACX,OAAO,CAAC,cAAc,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;KAC/F,CAAC;CACH;AAED,wHAAwH;AACxH,qBAAa,kBAAmB,SAAQ,mBAAmB;IACzD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAuB;gBAElC,IAAI,EAAE,0BAA0B,GAAG;QAAE,MAAM,CAAC,EAAE,oBAAoB,CAAA;KAAE;IA+BhF,SAAS,IAAI,MAAM;IAInB,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO;IAI5D,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAC1C,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,CACvB,CAQC;IAEF,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAGhC;IAEF,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAM1C;IAEF,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAoBtC;IAEI,SAAS,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,CAAC;IAYrC,gBAAgB,CAAC,IAAI,EAAE;QAC3B,MAAM,EAAE,uBAAuB,CAAC;KACjC,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAqB/B,gBAAgB,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,uBAAuB,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAiBvF,aAAa,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBjE,eAAe,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAW/C,gBAAgB,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1D,qBAAqB,CAAC,IAAI,EAAE;QAChC,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,sBAAsB,EAAE,CAAC;KAClC,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBX,gBAAgB,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB1D,WAAW,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtE,QAAQ,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IA8B5D,gBAAgB,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB1E,aAAa,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,IAAI,CAAC;IAqBjE,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAepC,gBAAgB,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA0B1D,eAAe,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBnF,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAiCvF,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAmBzF,4HAA4H;IACtH,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBhF,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAqBvF,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;IA0BR,cAAc,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAyBhF,wGAAwG;IACxG,OAAO,CAAC,oBAAoB;IAsBtB,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAC5C,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,CAAC,EAAE,CAAC;QACf,MAAM,CAAC,EAAE,sBAAsB,CAAC;QAChC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,oBAAoB,CAAC;KACpC,GAAG,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IA2ErC,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;IA0B/B,cAAc,CAAC,IAAI,EAAE;QACzB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,GAAG,OAAO,CAAC,MAAM,CAAC;IA8Bb,kBAAkB,CAAC,IAAI,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA6BlE,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;IA+BnB;;;;;;;;;;OAUG;YACW,kBAAkB;IA2B1B,MAAM,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,EAAE,IAAI,EAAE;QAC9D,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,aAAa,CAAC;QACtB,OAAO,CAAC,EAAE,cAAc,CAAC;KAC1B,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IA4E7B;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IA4BtB,WAAW,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,EAAE,IAAI,EAAE;QACnE,QAAQ,EAAE,KAAK,CAAC;YAAE,UAAU,EAAE,MAAM,CAAA;SAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;QACjE,KAAK,EAAE,IAAI,CAAC;QACZ,YAAY,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,CAAC,EAAE,cAAc,CAAC;KAC1B,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAC5B,WAAW,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,EAAE,IAAI,EAAE;QACnE,QAAQ,EAAE,KAAK,CAAC;YAAE,UAAU,EAAE,MAAM,CAAA;SAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,YAAY,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QACtC,OAAO,CAAC,EAAE,cAAc,CAAC;KAC1B,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;CA2BnC"}