nestjs-typesense 0.1.0

package/dist/collectors/typesense-collector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense-collector.d.ts","sourceRoot":"","sources":["../../src/collectors/typesense-collector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAElF;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,mBAAmB,GAAG,mBAAmB;IAC/F,yDAAyD;IACzD,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;IAE7D,0EAA0E;IAC1E,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAEhE,sEAAsE;IACtE,YAAY,CAAC,KAAK,EAAE,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAEjE,wEAAwE;IACxE,YAAY,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;CAClE"}

package/dist/collectors/typesense-collector.decorator.d.ts

@@ -0,0 +1,11 @@
+import "reflect-metadata";
+import type { TypesenseCollection } from "../schema/collection.js";
+/**
+ * Marks a provider as the collector for a collection. The class must implement
+ * `TypesenseCollector`. Applies `@Injectable()` so the class can be listed directly
+ * in a module's `providers`.
+ */
+export declare function RegisterTypesenseCollector(collection: TypesenseCollection | string): ClassDecorator;
+export declare function isTypesenseCollector(target: object): boolean;
+export declare function getCollectorCollectionName(target: object): string | undefined;
+//# sourceMappingURL=typesense-collector.decorator.d.ts.map

package/dist/collectors/typesense-collector.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense-collector.decorator.d.ts","sourceRoot":"","sources":["../../src/collectors/typesense-collector.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAGnE;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,mBAAmB,GAAG,MAAM,GACvC,cAAc,CAOhB;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE5D;AAED,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE7E"}

package/dist/collectors/typesense-collector.decorator.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterTypesenseCollector = RegisterTypesenseCollector;
+exports.isTypesenseCollector = isTypesenseCollector;
+exports.getCollectorCollectionName = getCollectorCollectionName;
+require("reflect-metadata");
+const common_1 = require("@nestjs/common");
+const typesense_constants_js_1 = require("../typesense.constants.js");
+/**
+ * Marks a provider as the collector for a collection. The class must implement
+ * `TypesenseCollector`. Applies `@Injectable()` so the class can be listed directly
+ * in a module's `providers`.
+ */
+function RegisterTypesenseCollector(collection) {
+    const name = typeof collection === "string" ? collection : collection.name;
+    return (target) => {
+        Reflect.defineMetadata(typesense_constants_js_1.TYPESENSE_COLLECTOR, name, target);
+        (0, common_1.Injectable)()(target);
+    };
+}
+function isTypesenseCollector(target) {
+    return Reflect.hasMetadata(typesense_constants_js_1.TYPESENSE_COLLECTOR, target);
+}
+function getCollectorCollectionName(target) {
+    return Reflect.getMetadata(typesense_constants_js_1.TYPESENSE_COLLECTOR, target);
+}
+//# sourceMappingURL=typesense-collector.decorator.js.map

package/dist/collectors/typesense-collector.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense-collector.decorator.js","sourceRoot":"","sources":["../../src/collectors/typesense-collector.decorator.ts"],"names":[],"mappings":";;AAUA,gEASC;AAED,oDAEC;AAED,gEAEC;AA3BD,4BAA0B;AAC1B,2CAA4C;AAE5C,sEAAgE;AAEhE;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,UAAwC;IAExC,MAAM,IAAI,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;IAE3E,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,OAAO,CAAC,cAAc,CAAC,4CAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAA,mBAAU,GAAE,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAAC,MAAc;IACjD,OAAO,OAAO,CAAC,WAAW,CAAC,4CAAmB,EAAE,MAAM,CAAC,CAAC;AAC1D,CAAC;AAED,SAAgB,0BAA0B,CAAC,MAAc;IACvD,OAAO,OAAO,CAAC,WAAW,CAAC,4CAAmB,EAAE,MAAM,CAAuB,CAAC;AAChF,CAAC"}

package/dist/collectors/typesense-collector.js

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

package/dist/collectors/typesense-collector.js.map

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

package/dist/collectors/typesense-indexer.d.ts

@@ -0,0 +1,34 @@
+import { ModulesContainer } from "@nestjs/core";
+import { TypesenseClient } from "../client/typesense.client.js";
+import { TypesenseCollections } from "../collections/typesense-collections.js";
+import type { TypesenseCollection } from "../schema/collection.js";
+export interface IndexResult {
+    collection: string;
+    indexed: number;
+    removed: number;
+}
+/**
+ * Drives the registered collectors. Call `reindex` from a CLI command or a startup task,
+ * and `sync` from a cron job for incremental catch-up.
+ */
+export declare class TypesenseIndexer {
+    private readonly modules;
+    private readonly client;
+    private readonly collections;
+    private readonly logger;
+    constructor(modules: ModulesContainer, client: TypesenseClient, collections: TypesenseCollections);
+    /** Full rebuild of one collection. Existing documents are upserted, not dropped. */
+    reindex(collection: TypesenseCollection | string, ids?: string[]): Promise<IndexResult>;
+    /** Incremental pass: everything created, updated or deleted since `since`. */
+    sync(collection: TypesenseCollection | string, since: Date): Promise<IndexResult>;
+    /** Runs `sync` for every collection that has a collector. */
+    syncAll(since: Date): Promise<IndexResult[]>;
+    private resolve;
+    private collectorFor;
+    /**
+     * Scans the Nest container for providers carrying the collector metadata. Done lazily
+     * rather than at construction so collectors declared in any module are visible.
+     */
+    private findCollector;
+}
+//# sourceMappingURL=typesense-indexer.d.ts.map

package/dist/collectors/typesense-indexer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense-indexer.d.ts","sourceRoot":"","sources":["../../src/collectors/typesense-indexer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAInE,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,qBACa,gBAAgB;IAIzB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAL9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqC;gBAGzC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,eAAe,EACvB,WAAW,EAAE,oBAAoB;IAGpD,oFAAoF;IAC9E,OAAO,CAAC,UAAU,EAAE,mBAAmB,GAAG,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;IAe7F,8EAA8E;IACxE,IAAI,CAAC,UAAU,EAAE,mBAAmB,GAAG,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IAsBvF,6DAA6D;IACvD,OAAO,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAWlD,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,YAAY;IAUpB;;;OAGG;IACH,OAAO,CAAC,aAAa;CAYtB"}

package/dist/collectors/typesense-indexer.js

@@ -0,0 +1,110 @@
+"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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var TypesenseIndexer_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesenseIndexer = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const typesense_client_js_1 = require("../client/typesense.client.js");
+const typesense_collections_js_1 = require("../collections/typesense-collections.js");
+const typesense_collector_decorator_js_1 = require("./typesense-collector.decorator.js");
+/**
+ * Drives the registered collectors. Call `reindex` from a CLI command or a startup task,
+ * and `sync` from a cron job for incremental catch-up.
+ */
+let TypesenseIndexer = TypesenseIndexer_1 = class TypesenseIndexer {
+    modules;
+    client;
+    collections;
+    logger = new common_1.Logger(TypesenseIndexer_1.name);
+    constructor(modules, client, collections) {
+        this.modules = modules;
+        this.client = client;
+        this.collections = collections;
+    }
+    /** Full rebuild of one collection. Existing documents are upserted, not dropped. */
+    async reindex(collection, ids) {
+        const resolved = this.resolve(collection);
+        const collector = this.collectorFor(resolved.name);
+        let indexed = 0;
+        for await (const batch of collector.fetchAll(ids)) {
+            const documents = collector.transform(batch);
+            await this.client.upsert(resolved, documents);
+            indexed += documents.length;
+        }
+        this.logger.log(`Reindexed ${indexed} document(s) into "${resolved.name}"`);
+        return { collection: resolved.name, indexed, removed: 0 };
+    }
+    /** Incremental pass: everything created, updated or deleted since `since`. */
+    async sync(collection, since) {
+        const resolved = this.resolve(collection);
+        const collector = this.collectorFor(resolved.name);
+        let indexed = 0;
+        let removed = 0;
+        for await (const batch of collector.fetchChanged(since)) {
+            const documents = collector.transform(batch);
+            await this.client.upsert(resolved, documents);
+            indexed += documents.length;
+        }
+        if (collector.fetchRemoved) {
+            for await (const ids of collector.fetchRemoved(since)) {
+                await this.client.delete(resolved, ids);
+                removed += ids.length;
+            }
+        }
+        return { collection: resolved.name, indexed, removed };
+    }
+    /** Runs `sync` for every collection that has a collector. */
+    async syncAll(since) {
+        const results = [];
+        for (const collection of this.collections.all()) {
+            if (!this.findCollector(collection.name))
+                continue;
+            results.push(await this.sync(collection, since));
+        }
+        return results;
+    }
+    resolve(collection) {
+        return typeof collection === "string" ? this.collections.get(collection) : collection;
+    }
+    collectorFor(name) {
+        const collector = this.findCollector(name);
+        if (!collector) {
+            throw new Error(`No collector registered for collection "${name}". Decorate a provider with @RegisterTypesenseCollector().`);
+        }
+        return collector;
+    }
+    /**
+     * Scans the Nest container for providers carrying the collector metadata. Done lazily
+     * rather than at construction so collectors declared in any module are visible.
+     */
+    findCollector(name) {
+        for (const module of this.modules.values()) {
+            for (const provider of module.providers.values()) {
+                const instance = provider.instance;
+                if (!instance || typeof instance !== "object")
+                    continue;
+                if ((0, typesense_collector_decorator_js_1.getCollectorCollectionName)(instance.constructor) === name) {
+                    return instance;
+                }
+            }
+        }
+        return undefined;
+    }
+};
+exports.TypesenseIndexer = TypesenseIndexer;
+exports.TypesenseIndexer = TypesenseIndexer = TypesenseIndexer_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [core_1.ModulesContainer,
+        typesense_client_js_1.TypesenseClient,
+        typesense_collections_js_1.TypesenseCollections])
+], TypesenseIndexer);
+//# sourceMappingURL=typesense-indexer.js.map

package/dist/collectors/typesense-indexer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesense-indexer.js","sourceRoot":"","sources":["../../src/collectors/typesense-indexer.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAAoD;AACpD,uCAAgD;AAChD,uEAAgE;AAChE,sFAA+E;AAE/E,yFAAgF;AAShF;;;GAGG;AAEI,IAAM,gBAAgB,wBAAtB,MAAM,gBAAgB;IAIR;IACA;IACA;IALF,MAAM,GAAG,IAAI,eAAM,CAAC,kBAAgB,CAAC,IAAI,CAAC,CAAC;IAE5D,YACmB,OAAyB,EACzB,MAAuB,EACvB,WAAiC;QAFjC,YAAO,GAAP,OAAO,CAAkB;QACzB,WAAM,GAAN,MAAM,CAAiB;QACvB,gBAAW,GAAX,WAAW,CAAsB;IACjD,CAAC;IAEJ,oFAAoF;IACpF,KAAK,CAAC,OAAO,CAAC,UAAwC,EAAE,GAAc;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,OAAO,GAAG,CAAC,CAAC;QAEhB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAClD,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC9C,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,OAAO,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QAC5E,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IAC5D,CAAC;IAED,8EAA8E;IAC9E,KAAK,CAAC,IAAI,CAAC,UAAwC,EAAE,KAAW;QAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,OAAO,GAAG,CAAC,CAAC;QAEhB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC7C,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC9C,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC;QAC9B,CAAC;QAED,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;YAC3B,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;gBACxC,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC;YACxB,CAAC;QACH,CAAC;QAED,OAAO,EAAE,UAAU,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IACzD,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,OAAO,CAAC,KAAW;QACvB,MAAM,OAAO,GAAkB,EAAE,CAAC;QAElC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,SAAS;YACnD,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,OAAO,CAAC,UAAwC;QACtD,OAAO,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;IACxF,CAAC;IAEO,YAAY,CAAC,IAAY;QAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,2CAA2C,IAAI,4DAA4D,CAC5G,CAAC;QACJ,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACK,aAAa,CAAC,IAAY;QAChC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YAC3C,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;gBACjD,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAA8B,CAAC;gBACzD,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;oBAAE,SAAS;gBACxD,IAAI,IAAA,6DAA0B,EAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC;oBAC9D,OAAO,QAA8B,CAAC;gBACxC,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF,CAAA;AA1FY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,mBAAU,GAAE;qCAKiB,uBAAgB;QACjB,qCAAe;QACV,+CAAoB;GANzC,gBAAgB,CA0F5B"}

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+export type { SearchParams, SearchResult } from "./client/typesense.client.js";
+export { TypesenseClient } from "./client/typesense.client.js";
+export { TypesenseCollections } from "./collections/typesense-collections.js";
+export { getCollectorCollectionName, isTypesenseCollector, RegisterTypesenseCollector, } from "./collectors/typesense-collector.decorator.js";
+export type { TypesenseCollector } from "./collectors/typesense-collector.js";
+export type { IndexResult } from "./collectors/typesense-indexer.js";
+export { TypesenseIndexer } from "./collectors/typesense-indexer.js";
+export type { InferDocument, InvalidCollectionFields, TypesenseCollection, TypesenseCollectionDefinition, TypesenseCollectionSchema, TypesenseFieldRecord, } from "./schema/collection.js";
+export { defineCollection, isCollection, toSchema } from "./schema/collection.js";
+export type { TypesenseArrayElementType, TypesenseCollectionSource, TypesenseDocumentClass, TypesenseSchemaOptions, } from "./schema/decorators.js";
+export { getTypesenseCollection, resolveCollection, TypesenseArray, TypesenseAuto, TypesenseBool, TypesenseFloat, TypesenseGeopoint, TypesenseInt32, TypesenseInt64, TypesenseObject, TypesenseProp, TypesenseSchema, TypesenseString, } from "./schema/decorators.js";
+export type { TypesenseField, TypesenseFieldOptions, TypesenseFieldType, TypesenseFieldTypeMap, } from "./schema/field.js";
+export { createField, field } from "./schema/field.js";
+export { TYPESENSE_CLIENT, TYPESENSE_COLLECTION, TYPESENSE_COLLECTIONS, TYPESENSE_COLLECTOR, TYPESENSE_FIELDS, TYPESENSE_MODULE_OPTIONS, } from "./typesense.constants.js";
+export type { TypesenseModuleAsyncOptions } from "./typesense.module.js";
+export { TypesenseModule } from "./typesense.module.js";
+export type { TypesenseMigrationStrategy, TypesenseModuleOptions, } from "./typesense.module-options.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAC9E,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,EACpB,0BAA0B,GAC3B,MAAM,+CAA+C,CAAC;AACvD,YAAY,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,YAAY,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,YAAY,EACV,aAAa,EACb,uBAAuB,EACvB,mBAAmB,EACnB,6BAA6B,EAC7B,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClF,YAAY,EACV,yBAAyB,EACzB,yBAAyB,EACzB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,GAChB,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EACL,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,YAAY,EACV,0BAA0B,EAC1B,sBAAsB,GACvB,MAAM,+BAA+B,CAAC"}

package/dist/index.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesenseModule = exports.TYPESENSE_MODULE_OPTIONS = exports.TYPESENSE_FIELDS = exports.TYPESENSE_COLLECTOR = exports.TYPESENSE_COLLECTIONS = exports.TYPESENSE_COLLECTION = exports.TYPESENSE_CLIENT = exports.field = exports.createField = exports.TypesenseString = exports.TypesenseSchema = exports.TypesenseProp = exports.TypesenseObject = exports.TypesenseInt64 = exports.TypesenseInt32 = exports.TypesenseGeopoint = exports.TypesenseFloat = exports.TypesenseBool = exports.TypesenseAuto = exports.TypesenseArray = exports.resolveCollection = exports.getTypesenseCollection = exports.toSchema = exports.isCollection = exports.defineCollection = exports.TypesenseIndexer = exports.RegisterTypesenseCollector = exports.isTypesenseCollector = exports.getCollectorCollectionName = exports.TypesenseCollections = exports.TypesenseClient = void 0;
+var typesense_client_js_1 = require("./client/typesense.client.js");
+Object.defineProperty(exports, "TypesenseClient", { enumerable: true, get: function () { return typesense_client_js_1.TypesenseClient; } });
+var typesense_collections_js_1 = require("./collections/typesense-collections.js");
+Object.defineProperty(exports, "TypesenseCollections", { enumerable: true, get: function () { return typesense_collections_js_1.TypesenseCollections; } });
+var typesense_collector_decorator_js_1 = require("./collectors/typesense-collector.decorator.js");
+Object.defineProperty(exports, "getCollectorCollectionName", { enumerable: true, get: function () { return typesense_collector_decorator_js_1.getCollectorCollectionName; } });
+Object.defineProperty(exports, "isTypesenseCollector", { enumerable: true, get: function () { return typesense_collector_decorator_js_1.isTypesenseCollector; } });
+Object.defineProperty(exports, "RegisterTypesenseCollector", { enumerable: true, get: function () { return typesense_collector_decorator_js_1.RegisterTypesenseCollector; } });
+var typesense_indexer_js_1 = require("./collectors/typesense-indexer.js");
+Object.defineProperty(exports, "TypesenseIndexer", { enumerable: true, get: function () { return typesense_indexer_js_1.TypesenseIndexer; } });
+var collection_js_1 = require("./schema/collection.js");
+Object.defineProperty(exports, "defineCollection", { enumerable: true, get: function () { return collection_js_1.defineCollection; } });
+Object.defineProperty(exports, "isCollection", { enumerable: true, get: function () { return collection_js_1.isCollection; } });
+Object.defineProperty(exports, "toSchema", { enumerable: true, get: function () { return collection_js_1.toSchema; } });
+var decorators_js_1 = require("./schema/decorators.js");
+Object.defineProperty(exports, "getTypesenseCollection", { enumerable: true, get: function () { return decorators_js_1.getTypesenseCollection; } });
+Object.defineProperty(exports, "resolveCollection", { enumerable: true, get: function () { return decorators_js_1.resolveCollection; } });
+Object.defineProperty(exports, "TypesenseArray", { enumerable: true, get: function () { return decorators_js_1.TypesenseArray; } });
+Object.defineProperty(exports, "TypesenseAuto", { enumerable: true, get: function () { return decorators_js_1.TypesenseAuto; } });
+Object.defineProperty(exports, "TypesenseBool", { enumerable: true, get: function () { return decorators_js_1.TypesenseBool; } });
+Object.defineProperty(exports, "TypesenseFloat", { enumerable: true, get: function () { return decorators_js_1.TypesenseFloat; } });
+Object.defineProperty(exports, "TypesenseGeopoint", { enumerable: true, get: function () { return decorators_js_1.TypesenseGeopoint; } });
+Object.defineProperty(exports, "TypesenseInt32", { enumerable: true, get: function () { return decorators_js_1.TypesenseInt32; } });
+Object.defineProperty(exports, "TypesenseInt64", { enumerable: true, get: function () { return decorators_js_1.TypesenseInt64; } });
+Object.defineProperty(exports, "TypesenseObject", { enumerable: true, get: function () { return decorators_js_1.TypesenseObject; } });
+Object.defineProperty(exports, "TypesenseProp", { enumerable: true, get: function () { return decorators_js_1.TypesenseProp; } });
+Object.defineProperty(exports, "TypesenseSchema", { enumerable: true, get: function () { return decorators_js_1.TypesenseSchema; } });
+Object.defineProperty(exports, "TypesenseString", { enumerable: true, get: function () { return decorators_js_1.TypesenseString; } });
+var field_js_1 = require("./schema/field.js");
+Object.defineProperty(exports, "createField", { enumerable: true, get: function () { return field_js_1.createField; } });
+Object.defineProperty(exports, "field", { enumerable: true, get: function () { return field_js_1.field; } });
+var typesense_constants_js_1 = require("./typesense.constants.js");
+Object.defineProperty(exports, "TYPESENSE_CLIENT", { enumerable: true, get: function () { return typesense_constants_js_1.TYPESENSE_CLIENT; } });
+Object.defineProperty(exports, "TYPESENSE_COLLECTION", { enumerable: true, get: function () { return typesense_constants_js_1.TYPESENSE_COLLECTION; } });
+Object.defineProperty(exports, "TYPESENSE_COLLECTIONS", { enumerable: true, get: function () { return typesense_constants_js_1.TYPESENSE_COLLECTIONS; } });
+Object.defineProperty(exports, "TYPESENSE_COLLECTOR", { enumerable: true, get: function () { return typesense_constants_js_1.TYPESENSE_COLLECTOR; } });
+Object.defineProperty(exports, "TYPESENSE_FIELDS", { enumerable: true, get: function () { return typesense_constants_js_1.TYPESENSE_FIELDS; } });
+Object.defineProperty(exports, "TYPESENSE_MODULE_OPTIONS", { enumerable: true, get: function () { return typesense_constants_js_1.TYPESENSE_MODULE_OPTIONS; } });
+var typesense_module_js_1 = require("./typesense.module.js");
+Object.defineProperty(exports, "TypesenseModule", { enumerable: true, get: function () { return typesense_module_js_1.TypesenseModule; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,oEAA+D;AAAtD,sHAAA,eAAe,OAAA;AACxB,mFAA8E;AAArE,gIAAA,oBAAoB,OAAA;AAC7B,kGAIuD;AAHrD,8IAAA,0BAA0B,OAAA;AAC1B,wIAAA,oBAAoB,OAAA;AACpB,8IAAA,0BAA0B,OAAA;AAI5B,0EAAqE;AAA5D,wHAAA,gBAAgB,OAAA;AASzB,wDAAkF;AAAzE,iHAAA,gBAAgB,OAAA;AAAE,6GAAA,YAAY,OAAA;AAAE,yGAAA,QAAQ,OAAA;AAOjD,wDAcgC;AAb9B,uHAAA,sBAAsB,OAAA;AACtB,kHAAA,iBAAiB,OAAA;AACjB,+GAAA,cAAc,OAAA;AACd,8GAAA,aAAa,OAAA;AACb,8GAAA,aAAa,OAAA;AACb,+GAAA,cAAc,OAAA;AACd,kHAAA,iBAAiB,OAAA;AACjB,+GAAA,cAAc,OAAA;AACd,+GAAA,cAAc,OAAA;AACd,gHAAA,eAAe,OAAA;AACf,8GAAA,aAAa,OAAA;AACb,gHAAA,eAAe,OAAA;AACf,gHAAA,eAAe,OAAA;AAQjB,8CAAuD;AAA9C,uGAAA,WAAW,OAAA;AAAE,iGAAA,KAAK,OAAA;AAC3B,mEAOkC;AANhC,0HAAA,gBAAgB,OAAA;AAChB,8HAAA,oBAAoB,OAAA;AACpB,+HAAA,qBAAqB,OAAA;AACrB,6HAAA,mBAAmB,OAAA;AACnB,0HAAA,gBAAgB,OAAA;AAChB,kIAAA,wBAAwB,OAAA;AAG1B,6DAAwD;AAA/C,sHAAA,eAAe,OAAA"}

package/dist/schema/collection.d.ts

@@ -0,0 +1,87 @@
+import type { TypesenseField, TypesenseFieldType, TypesenseFieldTypeMap } from "./field.js";
+/**
+ * Constraint for a collection's field map.
+ *
+ * The `optional` flag is left as `any` rather than `boolean` on purpose: a `boolean` here
+ * widens the literal `true`/`false` carried by each field during inference, which would
+ * collapse the required/optional split that `InferDocument` depends on.
+ */
+export type TypesenseFieldRecord = Record<string, TypesenseField<TypesenseFieldType, any>>;
+/** Resolves a field declaration to its TypeScript value type, honouring `optional`. */
+type FieldValue<TField extends TypesenseField> = TypesenseFieldTypeMap[TField["type"]];
+type RequiredKeys<TFields extends TypesenseFieldRecord> = {
+    [K in keyof TFields]: TFields[K]["optional"] extends true ? never : K;
+}[keyof TFields];
+type OptionalKeys<TFields extends TypesenseFieldRecord> = {
+    [K in keyof TFields]: TFields[K]["optional"] extends true ? K : never;
+}[keyof TFields];
+/**
+ * The document shape for a collection, inferred from its field declarations.
+ * `id` is always present — Typesense requires it and we always index it.
+ */
+export type InferDocument<TCollection extends TypesenseCollection> = {
+    id: string;
+} & {
+    [K in RequiredKeys<TCollection["fields"]>]: FieldValue<TCollection["fields"][K]>;
+} & {
+    [K in OptionalKeys<TCollection["fields"]>]?: FieldValue<TCollection["fields"][K]>;
+};
+export interface TypesenseCollectionDefinition<TFields> {
+    /** Collection name in Typesense. Also the key used to resolve collectors. */
+    name: string;
+    fields: TFields;
+    /** Must name an int32/int64/float field. Typesense uses it to order unranked results. */
+    defaultSortingField?: keyof TFields & string;
+    /** Fields whose tokens are used for typo-tolerant matching by default. */
+    tokenSeparators?: string[];
+    symbolsToIndex?: string[];
+}
+/**
+ * Returned instead of a collection when `fields` was not built with the `field.*` helpers.
+ * Surfaces as a type error at the definition site with a readable message.
+ */
+export interface InvalidCollectionFields<TMessage extends string> {
+    readonly __typesenseError: TMessage;
+}
+export interface TypesenseCollection<TFields extends TypesenseFieldRecord = TypesenseFieldRecord> {
+    readonly name: string;
+    readonly fields: TFields;
+    readonly defaultSortingField?: string;
+    readonly tokenSeparators?: string[];
+    readonly symbolsToIndex?: string[];
+    /** Stable hash of the schema. Changes whenever the shape changes. */
+    readonly hash: string;
+}
+/** Serialised form handed to the Typesense HTTP API. */
+export interface TypesenseCollectionSchema {
+    name: string;
+    fields: {
+        name: string;
+        type: string;
+        index: boolean;
+        optional: boolean;
+        facet: boolean;
+        sort?: boolean;
+    }[];
+    default_sorting_field?: string;
+    token_separators?: string[];
+    symbols_to_index?: string[];
+}
+export declare function toSchema(collection: TypesenseCollection): TypesenseCollectionSchema;
+/**
+ * Declares a collection. The returned object carries a schema hash used to detect drift
+ * between the code definition and the live collection at bootstrap.
+ */
+/**
+ * Declares a collection. The returned object carries a schema hash used to detect drift
+ * between the code definition and the live collection at bootstrap.
+ *
+ * `TFields` is intentionally unconstrained. A constraint mentioning `TypesenseField` becomes
+ * the inference target for each property and resets the field's `optional` flag to `boolean`,
+ * which would collapse the required/optional split in `InferDocument`. Validation therefore
+ * happens in the return type, where it cannot interfere with inference.
+ */
+export declare function defineCollection<TFields>(definition: TypesenseCollectionDefinition<TFields>): TFields extends TypesenseFieldRecord ? TypesenseCollection<TFields> : InvalidCollectionFields<"`fields` must be declared with the `field.*` builders">;
+export declare function isCollection(value: unknown): value is TypesenseCollection;
+export {};
+//# sourceMappingURL=collection.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../src/schema/collection.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAE5F;;;;;;GAMG;AAEH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,CAAC;AAE3F,uFAAuF;AACvF,KAAK,UAAU,CAAC,MAAM,SAAS,cAAc,IAAI,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAEvF,KAAK,YAAY,CAAC,OAAO,SAAS,oBAAoB,IAAI;KACvD,CAAC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,CAAC;CACtE,CAAC,MAAM,OAAO,CAAC,CAAC;AAEjB,KAAK,YAAY,CAAC,OAAO,SAAS,oBAAoB,IAAI;KACvD,CAAC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK;CACtE,CAAC,MAAM,OAAO,CAAC,CAAC;AAEjB;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,WAAW,SAAS,mBAAmB,IAAI;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG;KACnF,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;CACjF,GAAG;KACD,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;CAClF,CAAC;AAEF,MAAM,WAAW,6BAA6B,CAAC,OAAO;IACpD,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,yFAAyF;IACzF,mBAAmB,CAAC,EAAE,MAAM,OAAO,GAAG,MAAM,CAAC;IAC7C,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,QAAQ,SAAS,MAAM;IAC9D,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,oBAAoB,GAAG,oBAAoB;IAC9F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IACnC,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,wDAAwD;AACxD,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,OAAO,CAAC;QACf,QAAQ,EAAE,OAAO,CAAC;QAClB,KAAK,EAAE,OAAO,CAAC;QACf,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB,EAAE,CAAC;IACJ,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,wBAAgB,QAAQ,CAAC,UAAU,EAAE,mBAAmB,GAAG,yBAAyB,CAsBnF;AAED;;;GAGG;AACH;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EACtC,UAAU,EAAE,6BAA6B,CAAC,OAAO,CAAC,GACjD,OAAO,SAAS,oBAAoB,GACnC,mBAAmB,CAAC,OAAO,CAAC,GAC5B,uBAAuB,CAAC,uDAAuD,CAAC,CAiBnF;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAOzE"}

package/dist/schema/collection.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toSchema = toSchema;
+exports.defineCollection = defineCollection;
+exports.isCollection = isCollection;
+const node_crypto_1 = require("node:crypto");
+function toSchema(collection) {
+    const fields = Object.entries(collection.fields)
+        // Sort by name so the emitted schema — and therefore the hash — is order-independent.
+        .sort(([a], [b]) => a.localeCompare(b))
+        .map(([name, f]) => ({
+        name,
+        type: f.type,
+        index: f.index,
+        optional: f.optional,
+        facet: f.facet,
+        ...(f.sort === undefined ? {} : { sort: f.sort }),
+    }));
+    return {
+        name: collection.name,
+        fields: [{ name: "id", type: "string", index: true, optional: false, facet: false }, ...fields],
+        ...(collection.defaultSortingField
+            ? { default_sorting_field: collection.defaultSortingField }
+            : {}),
+        ...(collection.tokenSeparators ? { token_separators: collection.tokenSeparators } : {}),
+        ...(collection.symbolsToIndex ? { symbols_to_index: collection.symbolsToIndex } : {}),
+    };
+}
+/**
+ * Declares a collection. The returned object carries a schema hash used to detect drift
+ * between the code definition and the live collection at bootstrap.
+ */
+/**
+ * Declares a collection. The returned object carries a schema hash used to detect drift
+ * between the code definition and the live collection at bootstrap.
+ *
+ * `TFields` is intentionally unconstrained. A constraint mentioning `TypesenseField` becomes
+ * the inference target for each property and resets the field's `optional` flag to `boolean`,
+ * which would collapse the required/optional split in `InferDocument`. Validation therefore
+ * happens in the return type, where it cannot interfere with inference.
+ */
+function defineCollection(definition) {
+    const collection = {
+        name: definition.name,
+        fields: definition.fields,
+        ...(definition.defaultSortingField
+            ? { defaultSortingField: definition.defaultSortingField }
+            : {}),
+        ...(definition.tokenSeparators ? { tokenSeparators: definition.tokenSeparators } : {}),
+        ...(definition.symbolsToIndex ? { symbolsToIndex: definition.symbolsToIndex } : {}),
+        hash: "",
+    };
+    const hash = (0, node_crypto_1.createHash)("sha256")
+        .update(JSON.stringify(toSchema(collection)))
+        .digest("hex");
+    return { ...collection, hash: hash.slice(0, 16) };
+}
+function isCollection(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        typeof value.name === "string" &&
+        typeof value.hash === "string");
+}
+//# sourceMappingURL=collection.js.map

package/dist/schema/collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection.js","sourceRoot":"","sources":["../../src/schema/collection.ts"],"names":[],"mappings":";;AA+EA,4BAsBC;AAeD,4CAqBC;AAED,oCAOC;AAlJD,6CAAyC;AA+EzC,SAAgB,QAAQ,CAAC,UAA+B;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC;QAC9C,sFAAsF;SACrF,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;SACtC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACnB,IAAI;QACJ,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;KAClD,CAAC,CAAC,CAAC;IAEN,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,CAAC;QAC/F,GAAG,CAAC,UAAU,CAAC,mBAAmB;YAChC,CAAC,CAAC,EAAE,qBAAqB,EAAE,UAAU,CAAC,mBAAmB,EAAE;YAC3D,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAC9B,UAAkD;IAIlD,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,MAAM,EAAE,UAAU,CAAC,MAAM;QACzB,GAAG,CAAC,UAAU,CAAC,mBAAmB;YAChC,CAAC,CAAC,EAAE,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,EAAE;YACzD,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtF,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,IAAI,EAAE,EAAE;KACyB,CAAC;IAEpC,MAAM,IAAI,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC;SAC9B,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;SAC5C,MAAM,CAAC,KAAK,CAAC,CAAC;IAEjB,OAAO,EAAE,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAW,CAAC;AAC7D,CAAC;AAED,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,OAAQ,KAA6B,CAAC,IAAI,KAAK,QAAQ;QACvD,OAAQ,KAA6B,CAAC,IAAI,KAAK,QAAQ,CACxD,CAAC;AACJ,CAAC"}

package/dist/schema/decorators.d.ts

@@ -0,0 +1,73 @@
+import "reflect-metadata";
+import { type TypesenseCollection } from "./collection.js";
+import { type TypesenseFieldOptions, type TypesenseFieldType, type TypesenseFieldTypeMap } from "./field.js";
+/** A class decorated with `@TypesenseSchema`. */
+export type TypesenseDocumentClass = abstract new (...args: never[]) => object;
+/** Either declaration style is accepted wherever a collection is expected. */
+export type TypesenseCollectionSource = TypesenseCollection | TypesenseDocumentClass;
+/**
+ * The property shape a field decorator demands of the class it annotates.
+ *
+ * This is what makes the decorators type-safe: `TOptional` and the field type both come
+ * from the same decorator call, so TypeScript can check the annotated property against
+ * them and reject a disagreement (as TS1240) at the declaration site. Splitting optionality
+ * into a separate stacked decorator would break this — the two calls are checked
+ * independently, so neither could see the other's flag.
+ */
+type PropTarget<TKey extends string, TType extends TypesenseFieldType, TOptional extends boolean> = TOptional extends true ? {
+    [K in TKey]?: TypesenseFieldTypeMap[TType];
+} : {
+    [K in TKey]: TypesenseFieldTypeMap[TType];
+};
+export interface TypesenseSchemaOptions<TSortField extends string = string> {
+    /** Collection name in Typesense. Also the key used to resolve collectors. */
+    name: string;
+    /** Must name a decorated property. Typesense uses it to order unranked results. */
+    defaultSortingField?: TSortField;
+    tokenSeparators?: string[];
+    symbolsToIndex?: string[];
+}
+/**
+ * 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.
+ */
+export declare function TypesenseSchema<TSortField extends string = never>(options: TypesenseSchemaOptions<TSortField>): <TClass extends abstract new (...args: never[]) => Record<TSortField, unknown>>(target: TClass) => TClass;
+/**
+ * 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.
+ */
+export declare function TypesenseProp<TType extends TypesenseFieldType, TOptional extends boolean = false>(options: TypesenseFieldOptions<TOptional> & {
+    type: TType;
+}): <TKey extends string, TTarget extends PropTarget<TKey, TType, TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseString: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "string", TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseInt32: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "int32", TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseInt64: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "int64", TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseFloat: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "float", TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseBool: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "bool", TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseGeopoint: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "geopoint", TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseObject: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "object", TOptional>>(target: TTarget, key: TKey) => void;
+export declare const TypesenseAuto: <TOptional extends boolean = false>(options?: TypesenseFieldOptions<TOptional> | undefined) => <TKey extends string, TTarget extends PropTarget<TKey, "auto", TOptional>>(target: TTarget, key: TKey) => void;
+/**
+ * Scalars that have an array counterpart. `auto` is absent from this union because
+ * `TypesenseFieldTypeMap` has no `auto[]` key — the exclusion is structural, not hardcoded.
+ */
+export type TypesenseArrayElementType = "string" | "int32" | "int64" | "float" | "bool" | "geopoint" | "object";
+type ArrayOf<TElement extends TypesenseArrayElementType> = `${TElement}[]` & TypesenseFieldType;
+/** Declares an array field. One decorator covers all seven array types. */
+export declare function TypesenseArray<TElement extends TypesenseArrayElementType, TOptional extends boolean = false>(options: TypesenseFieldOptions<TOptional> & {
+    type: TElement;
+}): <TKey extends string, TTarget extends PropTarget<TKey, ArrayOf<TElement>, TOptional>>(target: TTarget, key: TKey) => void;
+/** The collection built for a decorated class, or undefined if it has no `@TypesenseSchema`. */
+export declare function getTypesenseCollection(target: object): TypesenseCollection | undefined;
+/** Normalises either declaration style to a collection. */
+export declare function resolveCollection(source: TypesenseCollectionSource): TypesenseCollection;
+export {};
+//# sourceMappingURL=decorators.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/schema/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAkC,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC3F,OAAO,EAGL,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,YAAY,CAAC;AAEpB,iDAAiD;AACjD,MAAM,MAAM,sBAAsB,GAAG,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,MAAM,CAAC;AAE/E,8EAA8E;AAC9E,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAErF;;;;;;;;GAQG;AACH,KAAK,UAAU,CACb,IAAI,SAAS,MAAM,EACnB,KAAK,SAAS,kBAAkB,EAChC,SAAS,SAAS,OAAO,IACvB,SAAS,SAAS,IAAI,GACtB;KAAG,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,qBAAqB,CAAC,KAAK,CAAC;CAAE,GAC9C;KAAG,CAAC,IAAI,IAAI,GAAG,qBAAqB,CAAC,KAAK,CAAC;CAAE,CAAC;AAyClD,MAAM,WAAW,sBAAsB,CAAC,UAAU,SAAS,MAAM,GAAG,MAAM;IACxE,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,mBAAmB,CAAC,EAAE,UAAU,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,UAAU,SAAS,MAAM,GAAG,KAAK,EAC/D,OAAO,EAAE,sBAAsB,CAAC,UAAU,CAAC,IAEnC,MAAM,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,EACnF,QAAQ,MAAM,KACb,MAAM,CA4BV;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,SAAS,kBAAkB,EAAE,SAAS,SAAS,OAAO,GAAG,KAAK,EAC/F,OAAO,EAAE,qBAAqB,CAAC,SAAS,CAAC,GAAG;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,IAEnD,IAAI,SAAS,MAAM,EAAE,OAAO,SAAS,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,CAAC,EAC7E,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAAI,CAGR;AAYD,eAAO,MAAM,eAAe,GATlB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,8CAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAK0C,CAAC;AAClD,eAAO,MAAM,cAAc,GAVjB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,6CAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAMwC,CAAC;AAChD,eAAO,MAAM,cAAc,GAXjB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,6CAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAOwC,CAAC;AAChD,eAAO,MAAM,cAAc,GAZjB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,6CAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAQwC,CAAC;AAChD,eAAO,MAAM,aAAa,GAbhB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,4CAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IASsC,CAAC;AAC9C,eAAO,MAAM,iBAAiB,GAdpB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,gDAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAU8C,CAAC;AACtD,eAAO,MAAM,eAAe,GAflB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,8CAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAW0C,CAAC;AAClD,eAAO,MAAM,aAAa,GAhBhB,SAAS,SAAS,OAAO,sEAC9B,IAAI,SAAS,MAAM,EAAE,OAAO,4CAA2C,EACtE,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAYsC,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,OAAO,GACP,OAAO,GACP,OAAO,GACP,MAAM,GACN,UAAU,GACV,QAAQ,CAAC;AAEb,KAAK,OAAO,CAAC,QAAQ,SAAS,yBAAyB,IAAI,GAAG,QAAQ,IAAI,GAAG,kBAAkB,CAAC;AAEhG,2EAA2E;AAC3E,wBAAgB,cAAc,CAC5B,QAAQ,SAAS,yBAAyB,EAC1C,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,OAAO,EAAE,qBAAqB,CAAC,SAAS,CAAC,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,IACtD,IAAI,SAAS,MAAM,EAAE,OAAO,SAAS,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,EACzF,QAAQ,OAAO,EACf,KAAK,IAAI,KACR,IAAI,CAIR;AAED,gGAAgG;AAChG,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAEtF;AAED,2DAA2D;AAC3D,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,yBAAyB,GAAG,mBAAmB,CAYxF"}