tsense 0.0.3 → 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/tsense.d.ts

@@ -1,5 +1,6 @@
 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;
@@ -19,9 +20,15 @@ export declare class TSense<Options extends CustomCollectionField, Fields extend
     private maybeArray;
     delete(): Promise<void>;
     create(): Promise<this>;
-    searchDocuments(data: Filters<Inferred>): Promise<{
+    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

@@ -147,9 +147,9 @@ export class TSense {
             return this;
         });
     }
-    searchDocuments(data) {
+    searchDocuments(data, facet) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
+            var _a, _b, _c, _d, _e;
             const res = yield this.data.client
                 .collections(this.name)
                 .documents()
@@ -160,9 +160,22 @@ export class TSense {
                 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 (_c = res.hits) !== null && _c !== void 0 ? _c : []) {
+            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) {
@@ -176,6 +189,7 @@ export class TSense {
             return {
                 data: result,
                 count: res.found,
+                facet: facet_result,
             };
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "tsense",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"exports": {