@86d-app/search 0.0.3 → 0.0.6

package/src/service.ts

@@ -29,9 +29,37 @@ export interface SearchSynonym {
 	createdAt: Date;
 }
 
+export interface SearchClick {
+	id: string;
+	queryId: string;
+	term: string;
+	entityType: string;
+	entityId: string;
+	position: number;
+	clickedAt: Date;
+}
+
+export type SearchSortField =
+	| "relevance"
+	| "newest"
+	| "oldest"
+	| "title_asc"
+	| "title_desc";
+
+export interface SearchFacets {
+	entityTypes: Array<{ type: string; count: number }>;
+	tags: Array<{ tag: string; count: number }>;
+}
+
 export interface SearchResult {
 	item: SearchIndexItem;
 	score: number;
+	highlights?: SearchHighlight | undefined;
+}
+
+export interface SearchHighlight {
+	title?: string | undefined;
+	body?: string | undefined;
 }
 
 export interface SearchAnalyticsSummary {
@@ -40,6 +68,8 @@ export interface SearchAnalyticsSummary {
 	avgResultCount: number;
 	zeroResultCount: number;
 	zeroResultRate: number;
+	clickThroughRate: number;
+	avgClickPosition: number;
 }
 
 export interface PopularTerm {
@@ -60,16 +90,37 @@ export interface SearchController extends ModuleController {
 		metadata?: Record<string, unknown> | undefined;
 	}): Promise<SearchIndexItem>;
 
+	bulkIndex(
+		items: Array<{
+			entityType: string;
+			entityId: string;
+			title: string;
+			body?: string | undefined;
+			tags?: string[] | undefined;
+			url: string;
+			image?: string | undefined;
+			metadata?: Record<string, unknown> | undefined;
+		}>,
+	): Promise<{ indexed: number; errors: number }>;
+
 	removeFromIndex(entityType: string, entityId: string): Promise<boolean>;
 
 	search(
 		query: string,
 		options?: {
 			entityType?: string | undefined;
+			tags?: string[] | undefined;
+			sort?: SearchSortField | undefined;
+			fuzzy?: boolean | undefined;
 			limit?: number | undefined;
 			skip?: number | undefined;
 		},
-	): Promise<{ results: SearchResult[]; total: number }>;
+	): Promise<{
+		results: SearchResult[];
+		total: number;
+		facets: SearchFacets;
+		didYouMean?: string | undefined;
+	}>;
 
 	suggest(prefix: string, limit?: number): Promise<string[]>;
 
@@ -79,6 +130,14 @@ export interface SearchController extends ModuleController {
 		sessionId?: string | undefined,
 	): Promise<SearchQuery>;
 
+	recordClick(params: {
+		queryId: string;
+		term: string;
+		entityType: string;
+		entityId: string;
+		position: number;
+	}): Promise<SearchClick>;
+
 	getRecentQueries(sessionId: string, limit?: number): Promise<SearchQuery[]>;
 
 	getPopularTerms(limit?: number): Promise<PopularTerm[]>;

package/src/store/endpoints/click.ts

@@ -0,0 +1,21 @@
+import { createStoreEndpoint, sanitizeText, z } from "@86d-app/core";
+import type { SearchController } from "../../service";
+
+export const clickEndpoint = createStoreEndpoint(
+	"/search/click",
+	{
+		method: "POST",
+		body: z.object({
+			queryId: z.string().min(1).max(200),
+			term: z.string().min(1).max(500).transform(sanitizeText),
+			entityType: z.string().min(1).max(100).transform(sanitizeText),
+			entityId: z.string().min(1).max(200),
+			position: z.number().int().min(0).max(1000),
+		}),
+	},
+	async (ctx) => {
+		const controller = ctx.context.controllers.search as SearchController;
+		const click = await controller.recordClick(ctx.body);
+		return { id: click.id };
+	},
+);

package/src/store/endpoints/index.ts

@@ -1,3 +1,4 @@
+import { clickEndpoint } from "./click";
 import { recentEndpoint } from "./recent";
 import { searchEndpoint } from "./search";
 import { storeSearch } from "./store-search";
@@ -8,4 +9,5 @@ export const storeEndpoints = {
 	"/search": searchEndpoint,
 	"/search/suggest": suggestEndpoint,
 	"/search/recent": recentEndpoint,
+	"/search/click": clickEndpoint,
 };

package/src/store/endpoints/search.ts

@@ -1,25 +1,49 @@
-import { createStoreEndpoint, z } from "@86d-app/core";
-import type { SearchController } from "../../service";
+import { createStoreEndpoint, sanitizeText, z } from "@86d-app/core";
+import type { SearchController, SearchSortField } from "../../service";
+
+const sortFields = [
+	"relevance",
+	"newest",
+	"oldest",
+	"title_asc",
+	"title_desc",
+] as const;
 
 export const searchEndpoint = createStoreEndpoint(
 	"/search",
 	{
 		method: "GET",
 		query: z.object({
-			q: z.string().min(1).max(500),
-			type: z.string().optional(),
+			q: z.string().min(1).max(500).transform(sanitizeText),
+			type: z.string().max(100).optional(),
+			tags: z.string().max(2000).optional(),
+			sort: z.enum(sortFields).optional(),
+			fuzzy: z.coerce.boolean().optional(),
 			limit: z.coerce.number().int().min(1).max(100).optional(),
 			skip: z.coerce.number().int().min(0).optional(),
-			sessionId: z.string().optional(),
+			sessionId: z.string().max(200).optional(),
 		}),
 	},
 	async (ctx) => {
 		const controller = ctx.context.controllers.search as SearchController;
-		const { results, total } = await controller.search(ctx.query.q, {
-			entityType: ctx.query.type,
-			limit: ctx.query.limit ?? 20,
-			skip: ctx.query.skip ?? 0,
-		});
+		const parsedTags = ctx.query.tags
+			? ctx.query.tags
+					.split(",")
+					.map((t) => t.trim())
+					.filter(Boolean)
+			: undefined;
+
+		const { results, total, facets, didYouMean } = await controller.search(
+			ctx.query.q,
+			{
+				entityType: ctx.query.type,
+				tags: parsedTags,
+				sort: ctx.query.sort as SearchSortField | undefined,
+				fuzzy: ctx.query.fuzzy,
+				limit: ctx.query.limit ?? 20,
+				skip: ctx.query.skip ?? 0,
+			},
+		);
 
 		// Record query for analytics (fire-and-forget)
 		controller
@@ -34,9 +58,13 @@ export const searchEndpoint = createStoreEndpoint(
 				title: r.item.title,
 				url: r.item.url,
 				image: r.item.image,
+				tags: r.item.tags,
 				score: r.score,
+				highlights: r.highlights,
 			})),
 			total,
+			facets,
+			didYouMean,
 		};
 	},
 );

package/src/store/endpoints/suggest.ts

@@ -1,4 +1,4 @@
-import { createStoreEndpoint, z } from "@86d-app/core";
+import { createStoreEndpoint, sanitizeText, z } from "@86d-app/core";
 import type { SearchController } from "../../service";
 
 export const suggestEndpoint = createStoreEndpoint(
@@ -6,7 +6,7 @@ export const suggestEndpoint = createStoreEndpoint(
 	{
 		method: "GET",
 		query: z.object({
-			q: z.string().min(1).max(200),
+			q: z.string().min(1).max(200).transform(sanitizeText),
 			limit: z.coerce.number().int().min(1).max(20).optional(),
 		}),
 	},

package/vitest.config.ts

@@ -0,0 +1,2 @@
+import { defineConfig } from "vitest/config";
+export default defineConfig({ test: { environment: "node" } });