nestjs-typesense 0.1.0

package/dist/schema/decorators.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesenseAuto = exports.TypesenseObject = exports.TypesenseGeopoint = exports.TypesenseBool = exports.TypesenseFloat = exports.TypesenseInt64 = exports.TypesenseInt32 = exports.TypesenseString = void 0;
+exports.TypesenseSchema = TypesenseSchema;
+exports.TypesenseProp = TypesenseProp;
+exports.TypesenseArray = TypesenseArray;
+exports.getTypesenseCollection = getTypesenseCollection;
+exports.resolveCollection = resolveCollection;
+require("reflect-metadata");
+const typesense_constants_js_1 = require("../typesense.constants.js");
+const collection_js_1 = require("./collection.js");
+const field_js_1 = require("./field.js");
+/** Property decorators receive the prototype; the metadata lives on the class itself. */
+function constructorOf(prototype) {
+    return prototype.constructor;
+}
+function recordField(target, key, definition) {
+    const owner = constructorOf(target);
+    // getOwnMetadata, not getMetadata: reflect-metadata resolves through the prototype
+    // chain, so a subclass would otherwise mutate its base class's map in place.
+    let fields = Reflect.getOwnMetadata(typesense_constants_js_1.TYPESENSE_FIELDS, owner);
+    if (!fields) {
+        fields = new Map();
+        Reflect.defineMetadata(typesense_constants_js_1.TYPESENSE_FIELDS, fields, owner);
+    }
+    fields.set(key, definition);
+}
+/** Walks base class -> derived so a subclass can override an inherited field. */
+function collectFields(target) {
+    const chain = [];
+    for (let current = target; typeof current === "function" && current !== Function.prototype; current = Object.getPrototypeOf(current)) {
+        chain.unshift(current);
+    }
+    const fields = {};
+    for (const link of chain) {
+        const own = Reflect.getOwnMetadata(typesense_constants_js_1.TYPESENSE_FIELDS, link);
+        if (!own)
+            continue;
+        for (const [key, definition] of own)
+            fields[key] = definition;
+    }
+    return fields;
+}
+/**
+ * Declares a class as a Typesense collection, using the fields its properties declare.
+ *
+ * Builds the same object `defineCollection` returns — including the schema hash — so the
+ * two declaration styles are interchangeable everywhere downstream.
+ *
+ * `TSortField` defaults to `never`, which makes the class constraint `Record<never, unknown>`
+ * (i.e. no constraint) when `defaultSortingField` is omitted, and requires the named property
+ * to exist on the class when it is given.
+ */
+function TypesenseSchema(options) {
+    return (target) => {
+        const fields = collectFields(target);
+        // `id` is always emitted by toSchema, so a decorated `id` would produce a duplicate.
+        // Declaring `id: string` on the class is legitimate (it is part of the document), so
+        // drop it silently; anything else is a real mismatch and worth failing on.
+        const declaredId = fields.id;
+        if (declaredId) {
+            if (declaredId.type !== "string") {
+                throw new Error(`Collection "${options.name}" declares "id" as ${declaredId.type}; ` +
+                    "Typesense always stores id as a string. Remove the decorator — id is implicit.");
+            }
+            delete fields.id;
+        }
+        const collection = (0, collection_js_1.defineCollection)({
+            name: options.name,
+            fields,
+            ...(options.defaultSortingField ? { defaultSortingField: options.defaultSortingField } : {}),
+            ...(options.tokenSeparators ? { tokenSeparators: options.tokenSeparators } : {}),
+            ...(options.symbolsToIndex ? { symbolsToIndex: options.symbolsToIndex } : {}),
+        });
+        Reflect.defineMetadata(typesense_constants_js_1.TYPESENSE_COLLECTION, collection, target);
+        return target;
+    };
+}
+/**
+ * Declares a field, naming its Typesense type explicitly.
+ *
+ * The per-type decorators below are the same thing with the type baked in; use whichever
+ * reads better. Both reject a property whose TypeScript type disagrees with the field.
+ */
+function TypesenseProp(options) {
+    return (target, key) => {
+        recordField(target, key, (0, field_js_1.createField)(options.type, options));
+    };
+}
+function makeProp(type) {
+    return (options) => (target, key) => {
+        recordField(target, key, (0, field_js_1.createField)(type, options));
+    };
+}
+exports.TypesenseString = makeProp("string");
+exports.TypesenseInt32 = makeProp("int32");
+exports.TypesenseInt64 = makeProp("int64");
+exports.TypesenseFloat = makeProp("float");
+exports.TypesenseBool = makeProp("bool");
+exports.TypesenseGeopoint = makeProp("geopoint");
+exports.TypesenseObject = makeProp("object");
+exports.TypesenseAuto = makeProp("auto");
+/** Declares an array field. One decorator covers all seven array types. */
+function TypesenseArray(options) {
+    return (target, key) => {
+        const type = `${options.type}[]`;
+        recordField(target, key, (0, field_js_1.createField)(type, options));
+    };
+}
+/** The collection built for a decorated class, or undefined if it has no `@TypesenseSchema`. */
+function getTypesenseCollection(target) {
+    return Reflect.getOwnMetadata(typesense_constants_js_1.TYPESENSE_COLLECTION, target);
+}
+/** Normalises either declaration style to a collection. */
+function resolveCollection(source) {
+    if ((0, collection_js_1.isCollection)(source))
+        return source;
+    const collection = getTypesenseCollection(source);
+    if (!collection) {
+        const name = source.name ?? String(source);
+        throw new Error(`"${name}" is not a Typesense collection. Decorate the class with @TypesenseSchema(), ` +
+            "or pass the result of defineCollection().");
+    }
+    return collection;
+}
+//# sourceMappingURL=decorators.js.map

package/dist/schema/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/schema/decorators.ts"],"names":[],"mappings":";;;AA4FA,0CAiCC;AAQD,sCASC;AAqCD,wCAWC;AAGD,wDAEC;AAGD,8CAYC;AAlND,4BAA0B;AAC1B,sEAAmF;AACnF,mDAA2F;AAC3F,yCAMoB;AA2BpB,yFAAyF;AACzF,SAAS,aAAa,CAAC,SAAiB;IACtC,OAAQ,SAAqC,CAAC,WAAW,CAAC;AAC5D,CAAC;AAED,SAAS,WAAW,CAAC,MAAc,EAAE,GAAW,EAAE,UAA0B;IAC1E,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACpC,mFAAmF;IACnF,6EAA6E;IAC7E,IAAI,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,yCAAgB,EAAE,KAAK,CAAyB,CAAC;IACrF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACnB,OAAO,CAAC,cAAc,CAAC,yCAAgB,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;AAC9B,CAAC;AAED,iFAAiF;AACjF,SAAS,aAAa,CAAC,MAAc;IACnC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KACE,IAAI,OAAO,GAAkB,MAAM,EACnC,OAAO,OAAO,KAAK,UAAU,IAAI,OAAO,KAAK,QAAQ,CAAC,SAAS,EAC/D,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAkB,EACzD,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,MAAM,GAAmC,EAAE,CAAC;IAClD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC,yCAAgB,EAAE,IAAI,CAAyB,CAAC;QACnF,IAAI,CAAC,GAAG;YAAE,SAAS;QACnB,KAAK,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,GAAG;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;IAChE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAWD;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAC7B,OAA2C;IAE3C,OAAO,CACL,MAAc,EACN,EAAE;QACV,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QAErC,qFAAqF;QACrF,qFAAqF;QACrF,2EAA2E;QAC3E,MAAM,UAAU,GAAG,MAAM,CAAC,EAAE,CAAC;QAC7B,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,eAAe,OAAO,CAAC,IAAI,sBAAsB,UAAU,CAAC,IAAI,IAAI;oBAClE,gFAAgF,CACnF,CAAC;YACJ,CAAC;YACD,OAAO,MAAM,CAAC,EAAE,CAAC;QACnB,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,gCAAgB,EAAC;YAClC,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,MAAM;YACN,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5F,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAChF,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9E,CAAC,CAAC;QAEH,OAAO,CAAC,cAAc,CAAC,6CAAoB,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QACjE,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,OAA2D;IAE3D,OAAO,CACL,MAAe,EACf,GAAS,EACH,EAAE;QACR,WAAW,CAAC,MAAgB,EAAE,GAAG,EAAE,IAAA,sBAAW,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACzE,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAmC,IAAW;IAC7D,OAAO,CAAoC,OAA0C,EAAE,EAAE,CACvF,CACE,MAAe,EACf,GAAS,EACH,EAAE;QACR,WAAW,CAAC,MAAgB,EAAE,GAAG,EAAE,IAAA,sBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC;AACN,CAAC;AAEY,QAAA,eAAe,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACrC,QAAA,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;AACnC,QAAA,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;AACnC,QAAA,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;AACnC,QAAA,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AACjC,QAAA,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AACzC,QAAA,eAAe,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACrC,QAAA,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAiB9C,2EAA2E;AAC3E,SAAgB,cAAc,CAG5B,OAA8D;IAC9D,OAAO,CACL,MAAe,EACf,GAAS,EACH,EAAE;QACR,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,IAAyB,CAAC;QACtD,WAAW,CAAC,MAAgB,EAAE,GAAG,EAAE,IAAA,sBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC;AACJ,CAAC;AAED,gGAAgG;AAChG,SAAgB,sBAAsB,CAAC,MAAc;IACnD,OAAO,OAAO,CAAC,cAAc,CAAC,6CAAoB,EAAE,MAAM,CAAoC,CAAC;AACjG,CAAC;AAED,2DAA2D;AAC3D,SAAgB,iBAAiB,CAAC,MAAiC;IACjE,IAAI,IAAA,4BAAY,EAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAExC,MAAM,UAAU,GAAG,sBAAsB,CAAC,MAAgB,CAAC,CAAC;IAC5D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,GAAI,MAA4B,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAClE,MAAM,IAAI,KAAK,CACb,IAAI,IAAI,+EAA+E;YACrF,2CAA2C,CAC9C,CAAC;IACJ,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/schema/field.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Typesense field types we support, mapped to the TypeScript value they hold.
+ * `object`/`object[]` stay loose on purpose — Typesense does not constrain their shape.
+ */
+export interface TypesenseFieldTypeMap {
+    string: string;
+    "string[]": string[];
+    int32: number;
+    "int32[]": number[];
+    int64: number;
+    "int64[]": number[];
+    float: number;
+    "float[]": number[];
+    bool: boolean;
+    "bool[]": boolean[];
+    geopoint: [number, number];
+    "geopoint[]": [number, number][];
+    object: Record<string, unknown>;
+    "object[]": Record<string, unknown>[];
+    auto: unknown;
+}
+export type TypesenseFieldType = keyof TypesenseFieldTypeMap;
+/**
+ * `TOptional` is threaded through as a literal (`true`/`false`) rather than widened to
+ * `boolean`, so `InferDocument` can distinguish required fields from optional ones.
+ */
+export interface TypesenseFieldOptions<TOptional extends boolean = boolean> {
+    /** Exclude from the search index. Stored and returned, but not queryable. Default true. */
+    index?: boolean;
+    /** Allow the field to be absent from a document. Default false. */
+    optional?: TOptional;
+    /** Enable faceting/aggregation on this field. Default false. */
+    facet?: boolean;
+    /** Enable sorting. Numeric fields are sortable by default; strings are not. */
+    sort?: boolean;
+}
+export interface TypesenseField<TType extends TypesenseFieldType = TypesenseFieldType, TOptional extends boolean = boolean> {
+    readonly type: TType;
+    readonly index: boolean;
+    readonly optional: TOptional;
+    readonly facet: boolean;
+    readonly sort?: boolean;
+}
+/**
+ * Builds a field descriptor. Shared by the `field.*` builders and the decorator API so
+ * both declaration styles produce byte-identical field objects (and therefore hashes).
+ */
+export declare function createField<TType extends TypesenseFieldType, TOptional extends boolean = false>(type: TType, options?: TypesenseFieldOptions<TOptional>): TypesenseField<TType, TOptional>;
+/**
+ * Field builders. Use these to declare a collection's fields:
+ *
+ *   fields: { title: field.string({ facet: true }), price: field.float() }
+ */
+export declare const field: {
+    readonly string: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"string", TOptional>;
+    readonly stringArray: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"string[]", TOptional>;
+    readonly int32: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"int32", TOptional>;
+    readonly int32Array: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"int32[]", TOptional>;
+    readonly int64: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"int64", TOptional>;
+    readonly int64Array: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"int64[]", TOptional>;
+    readonly float: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"float", TOptional>;
+    readonly floatArray: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"float[]", TOptional>;
+    readonly bool: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"bool", TOptional>;
+    readonly boolArray: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"bool[]", TOptional>;
+    readonly geopoint: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"geopoint", TOptional>;
+    readonly geopointArray: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"geopoint[]", TOptional>;
+    readonly object: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"object", TOptional>;
+    readonly objectArray: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"object[]", TOptional>;
+    readonly auto: <TOptional extends boolean = false>(o?: TypesenseFieldOptions<TOptional>) => TypesenseField<"auto", TOptional>;
+};
+//# sourceMappingURL=field.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/schema/field.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3B,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACtC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,SAAS,SAAS,OAAO,GAAG,OAAO;IACxE,2FAA2F;IAC3F,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,gEAAgE;IAChE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,+EAA+E;IAC/E,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,cAAc,CAC7B,KAAK,SAAS,kBAAkB,GAAG,kBAAkB,EACrD,SAAS,SAAS,OAAO,GAAG,OAAO;IAEnC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,KAAK,SAAS,kBAAkB,EAAE,SAAS,SAAS,OAAO,GAAG,KAAK,EAC7F,IAAI,EAAE,KAAK,EACX,OAAO,GAAE,qBAAqB,CAAC,SAAS,CAAM,GAC7C,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,CAQlC;AAED;;;;GAIG;AACH,eAAO,MAAM,KAAK;sBACP,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;2BAElE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;qBAE7E,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;0BAElE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;qBAE5E,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;0BAElE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;qBAE5E,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;0BAElE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;oBAE7E,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;yBAElE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;wBAExE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;6BAElE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;sBAE9E,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;2BAElE,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;oBAE9E,SAAS,SAAS,OAAO,cAAc,qBAAqB,CAAC,SAAS,CAAC;CAEtE,CAAC"}

package/dist/schema/field.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.field = void 0;
+exports.createField = createField;
+/**
+ * Builds a field descriptor. Shared by the `field.*` builders and the decorator API so
+ * both declaration styles produce byte-identical field objects (and therefore hashes).
+ */
+function createField(type, options = {}) {
+    return {
+        type,
+        index: options.index ?? true,
+        optional: (options.optional ?? false),
+        facet: options.facet ?? false,
+        ...(options.sort === undefined ? {} : { sort: options.sort }),
+    };
+}
+/**
+ * Field builders. Use these to declare a collection's fields:
+ *
+ *   fields: { title: field.string({ facet: true }), price: field.float() }
+ */
+exports.field = {
+    string: (o) => createField("string", o),
+    stringArray: (o) => createField("string[]", o),
+    int32: (o) => createField("int32", o),
+    int32Array: (o) => createField("int32[]", o),
+    int64: (o) => createField("int64", o),
+    int64Array: (o) => createField("int64[]", o),
+    float: (o) => createField("float", o),
+    floatArray: (o) => createField("float[]", o),
+    bool: (o) => createField("bool", o),
+    boolArray: (o) => createField("bool[]", o),
+    geopoint: (o) => createField("geopoint", o),
+    geopointArray: (o) => createField("geopoint[]", o),
+    object: (o) => createField("object", o),
+    objectArray: (o) => createField("object[]", o),
+    auto: (o) => createField("auto", o),
+};
+//# sourceMappingURL=field.js.map

package/dist/schema/field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.js","sourceRoot":"","sources":["../../src/schema/field.ts"],"names":[],"mappings":";;;AAsDA,kCAWC;AAfD;;;GAGG;AACH,SAAgB,WAAW,CACzB,IAAW,EACX,UAA4C,EAAE;IAE9C,OAAO;QACL,IAAI;QACJ,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;QAC5B,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAc;QAClD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK;QAC7B,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;KAC9D,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACU,QAAA,KAAK,GAAG;IACnB,MAAM,EAAE,CAAoC,CAAoC,EAAE,EAAE,CAClF,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1B,WAAW,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACvF,WAAW,CAAC,UAAU,EAAE,CAAC,CAAC;IAC5B,KAAK,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACjF,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;IACzB,UAAU,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACtF,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3B,KAAK,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACjF,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;IACzB,UAAU,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACtF,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3B,KAAK,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACjF,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;IACzB,UAAU,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACtF,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3B,IAAI,EAAE,CAAoC,CAAoC,EAAE,EAAE,CAChF,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IACxB,SAAS,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACrF,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1B,QAAQ,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACpF,WAAW,CAAC,UAAU,EAAE,CAAC,CAAC;IAC5B,aAAa,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACzF,WAAW,CAAC,YAAY,EAAE,CAAC,CAAC;IAC9B,MAAM,EAAE,CAAoC,CAAoC,EAAE,EAAE,CAClF,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1B,WAAW,EAAE,CAAoC,CAAoC,EAAE,EAAE,CACvF,WAAW,CAAC,UAAU,EAAE,CAAC,CAAC;IAC5B,IAAI,EAAE,CAAoC,CAAoC,EAAE,EAAE,CAChF,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;CAChB,CAAC"}

package/dist/typesense.constants.d.ts

@@ -0,0 +1,9 @@
+export declare const TYPESENSE_MODULE_OPTIONS: unique symbol;
+export declare const TYPESENSE_CLIENT: unique symbol;
+export declare const TYPESENSE_COLLECTIONS: unique symbol;
+export declare const TYPESENSE_COLLECTOR = "typesense:collector";
+/** Per-class map of decorated property name -> field descriptor. */
+export declare const TYPESENSE_FIELDS = "typesense:fields";
+/** The collection built from a class decorated with `@TypesenseCollection`. */
+export declare const TYPESENSE_COLLECTION = "typesense:collection";
+//# sourceMappingURL=typesense.constants.d.ts.map

package/dist/typesense.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense.constants.d.ts","sourceRoot":"","sources":["../src/typesense.constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB,eAAqC,CAAC;AAC3E,eAAO,MAAM,gBAAgB,eAA6B,CAAC;AAC3D,eAAO,MAAM,qBAAqB,eAAkC,CAAC;AACrE,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AACzD,oEAAoE;AACpE,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AACnD,+EAA+E;AAC/E,eAAO,MAAM,oBAAoB,yBAAyB,CAAC"}

package/dist/typesense.constants.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TYPESENSE_COLLECTION = exports.TYPESENSE_FIELDS = exports.TYPESENSE_COLLECTOR = exports.TYPESENSE_COLLECTIONS = exports.TYPESENSE_CLIENT = exports.TYPESENSE_MODULE_OPTIONS = void 0;
+exports.TYPESENSE_MODULE_OPTIONS = Symbol("TYPESENSE_MODULE_OPTIONS");
+exports.TYPESENSE_CLIENT = Symbol("TYPESENSE_CLIENT");
+exports.TYPESENSE_COLLECTIONS = Symbol("TYPESENSE_COLLECTIONS");
+exports.TYPESENSE_COLLECTOR = "typesense:collector";
+/** Per-class map of decorated property name -> field descriptor. */
+exports.TYPESENSE_FIELDS = "typesense:fields";
+/** The collection built from a class decorated with `@TypesenseCollection`. */
+exports.TYPESENSE_COLLECTION = "typesense:collection";
+//# sourceMappingURL=typesense.constants.js.map

package/dist/typesense.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense.constants.js","sourceRoot":"","sources":["../src/typesense.constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,wBAAwB,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAC9D,QAAA,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAC9C,QAAA,qBAAqB,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAC;AACxD,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AACzD,oEAAoE;AACvD,QAAA,gBAAgB,GAAG,kBAAkB,CAAC;AACnD,+EAA+E;AAClE,QAAA,oBAAoB,GAAG,sBAAsB,CAAC"}

package/dist/typesense.module-options.d.ts

@@ -0,0 +1,24 @@
+import type { ConfigurationOptions } from "typesense/lib/Typesense/Configuration.js";
+import type { TypesenseCollectionSource } from "./schema/decorators.js";
+/**
+ * What to do at bootstrap when a collection's declared schema no longer matches
+ * the one Typesense is holding.
+ *
+ * - `off`      never touch the live collection; log the drift only.
+ * - `create`   create collections that do not exist yet; leave drifted ones alone. (default)
+ * - `alter`    additionally add new fields and drop removed ones in place.
+ * - `recreate` drop and rebuild the collection. Destroys its documents — pair with a reindex.
+ */
+export type TypesenseMigrationStrategy = "off" | "create" | "alter" | "recreate";
+export interface TypesenseModuleOptions extends ConfigurationOptions {
+    /**
+     * Collections this application owns. Registered and migrated at bootstrap.
+     * Accepts `defineCollection()` results and `@TypesenseSchema()` classes alike.
+     */
+    collections?: TypesenseCollectionSource[];
+    /** Default `create`. */
+    migrations?: TypesenseMigrationStrategy;
+    /** Called on client transport errors instead of throwing. Useful for OTel/Sentry capture. */
+    onError?: (error: unknown) => void;
+}
+//# sourceMappingURL=typesense.module-options.d.ts.map

package/dist/typesense.module-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense.module-options.d.ts","sourceRoot":"","sources":["../src/typesense.module-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AACrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAExE;;;;;;;;GAQG;AACH,MAAM,MAAM,0BAA0B,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;AAEjF,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;IAClE;;;OAGG;IACH,WAAW,CAAC,EAAE,yBAAyB,EAAE,CAAC;IAC1C,wBAAwB;IACxB,UAAU,CAAC,EAAE,0BAA0B,CAAC;IACxC,6FAA6F;IAC7F,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACpC"}

package/dist/typesense.module-options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=typesense.module-options.js.map

package/dist/typesense.module-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense.module-options.js","sourceRoot":"","sources":["../src/typesense.module-options.ts"],"names":[],"mappings":""}

package/dist/typesense.module.d.ts

@@ -0,0 +1,13 @@
+import { type DynamicModule, type Type } from "@nestjs/common";
+import type { TypesenseModuleOptions } from "./typesense.module-options.js";
+export interface TypesenseModuleAsyncOptions {
+    imports?: DynamicModule["imports"];
+    inject?: (string | symbol | Type<unknown>)[];
+    useFactory: (...args: never[]) => Promise<TypesenseModuleOptions> | TypesenseModuleOptions;
+}
+export declare class TypesenseModule {
+    static forRoot(options: TypesenseModuleOptions): DynamicModule;
+    static forRootAsync(options: TypesenseModuleAsyncOptions): DynamicModule;
+    private static build;
+}
+//# sourceMappingURL=typesense.module.d.ts.map

package/dist/typesense.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense.module.d.ts","sourceRoot":"","sources":["../src/typesense.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAiC,KAAK,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAK9F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAE5E,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACnC,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;IAC7C,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC,sBAAsB,CAAC,GAAG,sBAAsB,CAAC;CAC5F;AAID,qBAEa,eAAe;IAC1B,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,sBAAsB,GAAG,aAAa;IAI9D,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,2BAA2B,GAAG,aAAa;IAWxE,OAAO,CAAC,MAAM,CAAC,KAAK;CAWrB"}

package/dist/typesense.module.js

@@ -0,0 +1,42 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var TypesenseModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesenseModule = void 0;
+const common_1 = require("@nestjs/common");
+const typesense_client_js_1 = require("./client/typesense.client.js");
+const typesense_collections_js_1 = require("./collections/typesense-collections.js");
+const typesense_indexer_js_1 = require("./collectors/typesense-indexer.js");
+const typesense_constants_js_1 = require("./typesense.constants.js");
+const EXPORTS = [typesense_client_js_1.TypesenseClient, typesense_collections_js_1.TypesenseCollections, typesense_indexer_js_1.TypesenseIndexer];
+let TypesenseModule = TypesenseModule_1 = class TypesenseModule {
+    static forRoot(options) {
+        return TypesenseModule_1.build({ provide: typesense_constants_js_1.TYPESENSE_MODULE_OPTIONS, useValue: options });
+    }
+    static forRootAsync(options) {
+        return TypesenseModule_1.build({
+            provide: typesense_constants_js_1.TYPESENSE_MODULE_OPTIONS,
+            useFactory: options.useFactory,
+            inject: options.inject ?? [],
+        }, options.imports);
+    }
+    static build(optionsProvider, imports) {
+        return {
+            module: TypesenseModule_1,
+            imports: imports ?? [],
+            providers: [optionsProvider, ...EXPORTS],
+            exports: EXPORTS,
+        };
+    }
+};
+exports.TypesenseModule = TypesenseModule;
+exports.TypesenseModule = TypesenseModule = TypesenseModule_1 = __decorate([
+    (0, common_1.Global)(),
+    (0, common_1.Module)({})
+], TypesenseModule);
+//# sourceMappingURL=typesense.module.js.map

package/dist/typesense.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense.module.js","sourceRoot":"","sources":["../src/typesense.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA8F;AAC9F,sEAA+D;AAC/D,qFAA8E;AAC9E,4EAAqE;AACrE,qEAAoE;AASpE,MAAM,OAAO,GAAG,CAAC,qCAAe,EAAE,+CAAoB,EAAE,uCAAgB,CAAC,CAAC;AAInE,IAAM,eAAe,uBAArB,MAAM,eAAe;IAC1B,MAAM,CAAC,OAAO,CAAC,OAA+B;QAC5C,OAAO,iBAAe,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,iDAAwB,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAoC;QACtD,OAAO,iBAAe,CAAC,KAAK,CAC1B;YACE,OAAO,EAAE,iDAAwB;YACjC,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;SAC7B,EACD,OAAO,CAAC,OAAO,CAChB,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,KAAK,CAClB,eAAyB,EACzB,OAAkC;QAElC,OAAO;YACL,MAAM,EAAE,iBAAe;YACvB,OAAO,EAAE,OAAO,IAAI,EAAE;YACtB,SAAS,EAAE,CAAC,eAAe,EAAE,GAAG,OAAO,CAAC;YACxC,OAAO,EAAE,OAAO;SACjB,CAAC;IACJ,CAAC;CACF,CAAA;AA3BY,0CAAe;0BAAf,eAAe;IAF3B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,eAAe,CA2B3B"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "nestjs-typesense",
+  "version": "0.1.0",
+  "description": "An unofficial NestJS module for Typesense: typed collection schemas, declarative collection migrations, and database-agnostic index syncing.",
+  "keywords": [
+    "nestjs",
+    "typesense",
+    "search",
+    "nestjs-module",
+    "full-text-search",
+    "postgres"
+  ],
+  "license": "MIT",
+  "author": "Ebenezer Domey <domeyeben4@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EbenDomey/nestjs-typesense.git"
+  },
+  "bugs": {
+    "url": "https://github.com/EbenDomey/nestjs-typesense/issues"
+  },
+  "homepage": "https://github.com/EbenDomey/nestjs-typesense#readme",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:integration": "npm run build && vitest run -c vitest.integration.config.ts",
+    "lint": "biome lint --write",
+    "format": "biome check --write --linter-enabled=false",
+    "prepare": "husky || true",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^10.0.0 || ^11.0.0",
+    "reflect-metadata": "^0.1.13 || ^0.2.0",
+    "typesense": "^1.8.0 || ^2.0.0 || ^3.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.0.0",
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/testing": "^11.0.1",
+    "@types/node": "^22.0.0",
+    "husky": "^9.1.7",
+    "reflect-metadata": "^0.2.2",
+    "typescript": "^5.6.0",
+    "typesense": "^3.0.6",
+    "vitest": "^2.0.0"
+  }
+}