tsense 0.0.2 → 0.0.4

package/README.md

@@ -38,6 +38,12 @@ export const UsersCollection = new TSense("users", {
 			type: "string",
 			sort: true,
 		},
+		company: {
+			type: "string",
+			override: {} as "netflix" | "google",
+			facet: true,
+			optional: true,
+		},
 		work_history: {
 			// object and object[] auto-infers enable_nested_fields
 			type: "object[]",
@@ -91,4 +97,29 @@ const results = await UsersCollection.searchDocuments({
 		],
 	},
 });
-```     
+
+/*
+   typed as
+   count: number;
+   data: {
+        id?: string | undefined;
+        phone?: string | null | undefined;
+        ...
+	}[];
+   facet: {
+        netflix: number;
+        google: number;
+		// enabled by enable_facet_total
+        total: number;
+    };
+ */
+const faceted = await UsersCollection.searchDocuments(
+	{
+		search: "john",
+	},
+	{
+		facet_by: "company",
+		enable_facet_total: true,
+	},
+);
+```

package/dist/index.d.ts

@@ -1 +1 @@
-export { TSense } from "./collection.js";
+export { TSense } from "./tsense.js";

package/dist/index.js

@@ -1 +1 @@
-export { TSense } from "./collection.js";
+export { TSense } from "./tsense.js";

package/dist/tsense.d.ts

@@ -0,0 +1,34 @@
+import type { Client } from "typesense";
+import type { CustomCollectionField, Filters, InferCollectionTypes } from "./types/core.js";
+import type { Simplify } from "./types/helpers.js";
+export declare class TSense<Options extends CustomCollectionField, Fields extends Record<string, Options>, Inferred = InferCollectionTypes<Fields>> {
+    private name;
+    private data;
+    infer: Inferred;
+    constructor(name: string, data: {
+        fields: Fields;
+        client: Client;
+        default_search_field?: NoInfer<keyof Inferred>;
+        default_sorting_field?: NoInfer<keyof Inferred>;
+        batch_size?: number;
+        enable_nested_fields?: boolean;
+    });
+    private checkNested;
+    private buildObjectFilter;
+    private buildSort;
+    private buildFilter;
+    private maybeArray;
+    delete(): Promise<void>;
+    create(): Promise<this>;
+    searchDocuments<FacetBy extends keyof Inferred, EnableFacetTotal extends boolean | undefined = undefined>(data: Filters<Inferred>, facet?: {
+        facet_by?: FacetBy;
+        enable_facet_total?: EnableFacetTotal;
+    }): Promise<{
+        count: number;
+        data: Inferred[];
+        facet: FacetBy extends keyof Inferred ? Simplify<Record<NonNullable<Inferred[FacetBy]> extends string ? NonNullable<Inferred[FacetBy]> : never, number> & (EnableFacetTotal extends true ? {
+            total: number;
+        } : {})> : never;
+    }>;
+    upsertDocuments(items: Inferred | Inferred[]): Promise<any[] | undefined>;
+}

package/dist/tsense.js

@@ -0,0 +1,215 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const requiresNested = ["object", "object[]"];
+export class TSense {
+    constructor(name, data) {
+        this.name = name;
+        this.data = data;
+        this.infer = undefined;
+    }
+    checkNested(fields) {
+        if (this.data.enable_nested_fields) {
+            return;
+        }
+        for (const field of fields) {
+            requiresNested.includes(field.type);
+            this.data.enable_nested_fields = true;
+            return;
+        }
+    }
+    buildObjectFilter(key, value) {
+        if (Array.isArray(value)) {
+            return `(${key}:[${value.join(",")}])`;
+        }
+        if ("not" in value) {
+            return `${key}:!=${value.not}`;
+        }
+        const min = value.min != null ? value.min : undefined;
+        const max = value.max != null ? value.max : undefined;
+        if (min != null && max != null) {
+            return `${key}:[${min}..${max}]`;
+        }
+        if (max != null) {
+            return `${key}:<=${max}`;
+        }
+        if (min != null) {
+            return `${key}:>=${min}`;
+        }
+    }
+    buildSort(data) {
+        var _a;
+        if (!data.order_by) {
+            return;
+        }
+        const order = [];
+        for (const key of this.maybeArray(data.order_by)) {
+            const splitted = key.split(" ");
+            let direction = splitted.at(-1);
+            if (direction !== "asc" && direction !== "desc") {
+                direction = (_a = data.direction) !== null && _a !== void 0 ? _a : "desc";
+            }
+            // safeguard
+            if (splitted[0] === "undefined") {
+                continue;
+            }
+            if (splitted[0] === "score") {
+                splitted[0] = "_text_match";
+            }
+            order.push(`${splitted[0]}:${direction}`);
+        }
+        return order.join(",");
+    }
+    buildFilter(data) {
+        var _a;
+        const filter = [];
+        for (const entry of Object.entries((_a = data.filter) !== null && _a !== void 0 ? _a : {})) {
+            const [key, value] = entry;
+            if (value == null)
+                continue;
+            if (key === "OR") {
+                const orFilter = [];
+                for (const condition of value) {
+                    const filter = this.buildFilter({ filter: condition });
+                    orFilter.push(`(${filter.join("||")})`);
+                }
+                filter.push(`(${orFilter.join("||")})`);
+                continue;
+            }
+            switch (typeof value) {
+                case "string":
+                case "number":
+                case "boolean":
+                    filter.push(`${key}:=${value}`);
+                    break;
+                case "object": {
+                    const built = this.buildObjectFilter(key, value);
+                    if (built) {
+                        filter.push(built);
+                    }
+                    break;
+                }
+                default: {
+                    break;
+                }
+            }
+        }
+        return filter;
+    }
+    maybeArray(d) {
+        if (Array.isArray(d)) {
+            return d;
+        }
+        return [d];
+    }
+    delete() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.data.client.collections(this.name).delete();
+        });
+    }
+    create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fields = [];
+            for (const [name, field] of Object.entries(this.data.fields)) {
+                const isSimpleField = typeof field === "string";
+                if (isSimpleField) {
+                    const isOptional = field[field.length - 1] === "?";
+                    const realType = isOptional ? field.slice(0, -1) : field;
+                    fields.push({
+                        name,
+                        type: realType,
+                        optional: isOptional,
+                    });
+                    continue;
+                }
+                fields.push({
+                    name,
+                    type: field.type,
+                    optional: field.optional,
+                    facet: field.facet,
+                    index: field.index,
+                    sort: field.sort,
+                });
+            }
+            this.checkNested(fields);
+            yield this.data.client.collections().create({
+                name: this.name,
+                fields,
+                default_sorting_field: this.data.default_sorting_field,
+                enable_nested_fields: this.data.enable_nested_fields,
+            });
+            return this;
+        });
+    }
+    searchDocuments(data, facet) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e;
+            const res = yield this.data.client
+                .collections(this.name)
+                .documents()
+                .search({
+                q: (_a = data.search) !== null && _a !== void 0 ? _a : "",
+                query_by: (_b = data.search_keys) !== null && _b !== void 0 ? _b : [this.data.default_search_field],
+                sort_by: this.buildSort(data),
+                filter_by: this.buildFilter(data).join("&&"),
+                page: data.page,
+                limit: data.limit,
+                facet_by: facet === null || facet === void 0 ? void 0 : facet.facet_by,
+            });
+            const facet_result = (facet === null || facet === void 0 ? void 0 : facet.facet_by)
+                ? facet.enable_facet_total
+                    ? { total: 0 }
+                    : {}
+                : undefined;
+            if ((_d = (_c = res.facet_counts) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.counts) {
+                for (const iter of res.facet_counts[0].counts) {
+                    facet_result[iter.value] = iter.count;
+                    if (facet === null || facet === void 0 ? void 0 : facet.enable_facet_total)
+                        facet_result.total += iter.count;
+                }
+            }
+            const result = [];
+            for (const hit of (_e = res.hits) !== null && _e !== void 0 ? _e : []) {
+                if (data.highlight) {
+                    for (const [key, value] of Object.entries(hit.highlight)) {
+                        if (value) {
+                            // @ts-expect-error
+                            hit.document[key] = value.snippet;
+                        }
+                    }
+                }
+                result.push(hit.document);
+            }
+            return {
+                data: result,
+                count: res.found,
+                facet: facet_result,
+            };
+        });
+    }
+    upsertDocuments(items) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const parsed = [];
+            for (const item of this.maybeArray(items)) {
+                parsed.push(JSON.stringify(item));
+            }
+            if (!parsed.length) {
+                return;
+            }
+            const res = yield this.data.client
+                .collections(this.name)
+                .documents()
+                .import(parsed.join("\n"), {
+                action: "upsert",
+                batch_size: this.data.batch_size,
+            });
+            return res.split("\n").map((v) => JSON.parse(v));
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "tsense",
-	"version": "0.0.2",
+	"version": "0.0.4",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"exports": {
@@ -12,6 +12,7 @@
 	"files": [
 		"dist"
 	],
+	"sideEffects": false,
 	"description": "Opinionated, fully typed typesense client",
 	"license": "MIT",
 	"keywords": [