tsense 0.0.3 → 0.0.5

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,25 @@ 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 { CustomCollectionField, SearchFilters, InferCollectionTypes, InferFacetResponse } 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,10 @@ export declare class TSense<Options extends CustomCollectionField, Fields extend
     private maybeArray;
     delete(): Promise<void>;
     create(): Promise<this>;
-    searchDocuments(data: Filters<Inferred>): Promise<{
+    searchDocuments<Filter extends SearchFilters<Inferred>>(data: Filter): Promise<{
         count: number;
         data: Inferred[];
+        facet: Simplify<InferFacetResponse<Inferred, Filter>>;
     }>;
     upsertDocuments(items: Inferred | Inferred[]): Promise<any[] | undefined>;
 }

package/dist/tsense.js

@@ -149,7 +149,7 @@ export class TSense {
     }
     searchDocuments(data) {
         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,23 @@ export class TSense {
                 filter_by: this.buildFilter(data).join("&&"),
                 page: data.page,
                 limit: data.limit,
+                facet_by: data === null || data === void 0 ? void 0 : data.facet_by,
             });
+            const facet_result = (data === null || data === void 0 ? void 0 : data.facet_by)
+                ? data.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 (data === null || data === void 0 ? void 0 : data.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 +190,7 @@ export class TSense {
             return {
                 data: result,
                 count: res.found,
+                facet: facet_result,
             };
         });
     }

package/dist/types/core.d.ts

@@ -28,20 +28,19 @@ type TypesenseToTS = {
     "string*": unknown;
 };
 type ValidFieldType = keyof TypesenseToTS;
+type MaybeOptional<Field, Result> = Field extends {
+    optional: true;
+} ? Result | null | undefined : Result;
 export type InferCollectionTypes<Fields> = Simplify<{
     id?: string;
 } & UndefinedToOptional<{
-    [K in keyof Fields]: Fields[K] extends ValidFieldType ? TypesenseToTS[Fields[K]] : Fields[K] extends {
+    [K in keyof Fields]: MaybeOptional<Fields[K], Fields[K] extends {
         override: infer Override;
-    } ? Fields[K] extends {
-        optional: true;
-    } ? Override | null | undefined : Override : Fields[K] extends {
+    } ? Override : Fields[K] extends ValidFieldType ? TypesenseToTS[Fields[K]] : Fields[K] extends {
         type: infer T;
-    } ? T extends ValidFieldType ? Fields[K] extends {
-        optional: true;
-    } ? TypesenseToTS[T] | null | undefined : TypesenseToTS[T] : never : Fields[K] extends `${infer RealType}?` ? RealType extends ValidFieldType ? TypesenseToTS[RealType] | null | undefined : never : never;
+    } ? T extends ValidFieldType ? TypesenseToTS[T] : never : Fields[K] extends `${infer RealType}?` ? RealType extends ValidFieldType ? TypesenseToTS[RealType] | null | undefined : never : never>;
 }>>;
-type OrderBy<Inferred, Options = keyof Inferred | "score"> = Options | Options[] | (Options extends infer Q ? Q extends string ? `${Q} ${"asc" | "desc"}` : never : never)[];
+type OrderBy<Inferred, Options = keyof Inferred | "score"> = Options | Options[] | (Options extends string ? `${Options} ${"asc" | "desc"}` : never)[];
 type SingleFilter<Inferred> = Partial<{
     [K in keyof Inferred]: BaseIfArray<Inferred[K]> | NonNullable<BaseIfArray<Inferred[K]>>[] | {
         not?: string | string[] | boolean | null;
@@ -53,7 +52,7 @@ type SingleFilter<Inferred> = Partial<{
 type RecursiveFilter<Inferred> = SingleFilter<Inferred> & {
     OR?: RecursiveFilter<Inferred>[];
 };
-export type Filters<Inferred> = {
+export type SearchFilters<Inferred> = {
     search?: string;
     filter?: RecursiveFilter<Inferred>;
     order_by?: OrderBy<Inferred> | undefined;
@@ -62,5 +61,14 @@ export type Filters<Inferred> = {
     limit?: number;
     search_keys?: (keyof Inferred)[];
     highlight?: boolean;
+    facet_by?: NoInfer<keyof Inferred>;
+    enable_facet_total?: boolean;
 };
+export type InferFacetResponse<Inferred, Filter> = Filter extends {
+    facet_by: infer FacetBy;
+} ? FacetBy extends keyof Inferred ? Record<NonNullable<Inferred[FacetBy]> extends string ? NonNullable<Inferred[FacetBy]> : never, number> & (Filter extends {
+    enable_facet_total: true;
+} ? {
+    total: number;
+} : {}) : never : never;
 export {};

package/package.json

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