@86d-app/search 0.0.23 → 0.0.25

package/src/__tests__/store-endpoints.test.ts

@@ -0,0 +1,392 @@
+import { createMockDataService } from "@86d-app/core/test-utils";
+import { beforeEach, describe, expect, it } from "vitest";
+import type { SearchResult } from "../service";
+import { createSearchController } from "../service-impl";
+
+/**
+ * Store endpoint integration tests for the search module.
+ *
+ * These tests verify the business logic in store-facing endpoints:
+ *
+ * 1. search: comma-separated tag parsing, response shaping (strips
+ *    internal fields like body/metadata), fire-and-forget analytics,
+ *    facets and didYouMean pass-through
+ * 2. suggest: prefix autocomplete, limit handling
+ * 3. click: analytics click recording
+ * 4. recent: session-scoped recent query history, response shaping
+ */
+
+type DataService = ReturnType<typeof createMockDataService>;
+
+// ── Simulate store endpoint logic ─────────────────────────────────────
+
+/**
+ * Simulates the search endpoint: parses tags from comma-separated
+ * string, delegates to controller, shapes response by stripping
+ * internal fields.
+ */
+async function simulateSearch(
+	data: DataService,
+	query: {
+		q: string;
+		type?: string;
+		tags?: string;
+		sort?: "relevance" | "newest" | "oldest" | "title_asc" | "title_desc";
+		fuzzy?: boolean;
+		limit?: number;
+		skip?: number;
+		sessionId?: string;
+	},
+) {
+	const controller = createSearchController(data);
+	const parsedTags = query.tags
+		? query.tags
+				.split(",")
+				.map((t) => t.trim())
+				.filter(Boolean)
+		: undefined;
+
+	const { results, total, facets, didYouMean } = await controller.search(
+		query.q,
+		{
+			entityType: query.type,
+			tags: parsedTags,
+			sort: query.sort,
+			fuzzy: query.fuzzy,
+			limit: query.limit ?? 20,
+			skip: query.skip ?? 0,
+		},
+	);
+
+	// Fire-and-forget analytics recording
+	controller.recordQuery(query.q, total, query.sessionId).catch(() => {});
+
+	return {
+		results: results.map((r: SearchResult) => ({
+			id: r.item.id,
+			entityType: r.item.entityType,
+			entityId: r.item.entityId,
+			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,
+	};
+}
+
+/**
+ * Simulates the suggest endpoint.
+ */
+async function simulateSuggest(data: DataService, q: string, limit?: number) {
+	const controller = createSearchController(data);
+	const suggestions = await controller.suggest(q, limit ?? 8);
+	return { suggestions };
+}
+
+/**
+ * Simulates the click endpoint.
+ */
+async function simulateClick(
+	data: DataService,
+	body: {
+		queryId: string;
+		term: string;
+		entityType: string;
+		entityId: string;
+		position: number;
+	},
+) {
+	const controller = createSearchController(data);
+	const click = await controller.recordClick(body);
+	return { id: click.id };
+}
+
+/**
+ * Simulates the recent endpoint: returns shaped recent queries.
+ */
+async function simulateRecent(
+	data: DataService,
+	sessionId: string,
+	limit?: number,
+) {
+	const controller = createSearchController(data);
+	const queries = await controller.getRecentQueries(sessionId, limit ?? 10);
+	return {
+		recent: queries.map((q) => ({
+			term: q.term,
+			resultCount: q.resultCount,
+			searchedAt: q.searchedAt,
+		})),
+	};
+}
+
+// ── Helpers ───────────────────────────────────────────────────────────
+
+async function seedIndexItems(data: DataService) {
+	const controller = createSearchController(data);
+	await controller.indexItem({
+		entityType: "product",
+		entityId: "prod-1",
+		title: "Red Widget",
+		body: "A fantastic red widget for everyday use",
+		tags: ["electronics", "sale"],
+		url: "/products/red-widget",
+		image: "/img/red-widget.jpg",
+	});
+	await controller.indexItem({
+		entityType: "product",
+		entityId: "prod-2",
+		title: "Blue Gadget",
+		body: "The best blue gadget on the market",
+		tags: ["electronics", "new"],
+		url: "/products/blue-gadget",
+	});
+	await controller.indexItem({
+		entityType: "page",
+		entityId: "page-1",
+		title: "About Us",
+		body: "Learn about our company",
+		tags: ["info"],
+		url: "/about",
+	});
+}
+
+// ── Tests ─────────────────────────────────────────────────────────────
+
+describe("search store endpoints", () => {
+	let data: DataService;
+
+	beforeEach(() => {
+		data = createMockDataService();
+	});
+
+	// ── search ───────────────────────────────────────────────────────
+
+	describe("search", () => {
+		it("returns results matching query", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSearch(data, { q: "widget" });
+
+			expect(result.total).toBeGreaterThan(0);
+			expect(result.results[0].title).toContain("Widget");
+		});
+
+		it("shapes response by stripping internal fields", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSearch(data, { q: "red" });
+
+			const firstResult = result.results[0];
+			// Should include these fields
+			expect(firstResult).toHaveProperty("id");
+			expect(firstResult).toHaveProperty("entityType");
+			expect(firstResult).toHaveProperty("entityId");
+			expect(firstResult).toHaveProperty("title");
+			expect(firstResult).toHaveProperty("url");
+			expect(firstResult).toHaveProperty("tags");
+			expect(firstResult).toHaveProperty("score");
+			// Should NOT include body or metadata (internal fields)
+			expect(firstResult).not.toHaveProperty("body");
+			expect(firstResult).not.toHaveProperty("metadata");
+			expect(firstResult).not.toHaveProperty("indexedAt");
+		});
+
+		it("filters by entity type", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSearch(data, {
+				q: "about",
+				type: "page",
+			});
+
+			for (const r of result.results) {
+				expect(r.entityType).toBe("page");
+			}
+		});
+
+		it("parses comma-separated tags into array", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSearch(data, {
+				q: "widget",
+				tags: "electronics, sale",
+			});
+
+			// Should find items tagged with electronics AND sale
+			expect(result.total).toBeGreaterThanOrEqual(0);
+		});
+
+		it("handles tags with extra whitespace and empty segments", async () => {
+			await seedIndexItems(data);
+
+			// "electronics,,  new, " should parse to ["electronics", "new"]
+			const result = await simulateSearch(data, {
+				q: "gadget",
+				tags: "electronics,,  new, ",
+			});
+
+			expect(result.total).toBeGreaterThanOrEqual(0);
+		});
+
+		it("returns empty results for no-match query", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSearch(data, {
+				q: "xyznonexistent",
+			});
+
+			expect(result.results).toHaveLength(0);
+			expect(result.total).toBe(0);
+		});
+
+		it("respects limit and skip pagination", async () => {
+			await seedIndexItems(data);
+			const page1 = await simulateSearch(data, {
+				q: "widget gadget about",
+				limit: 1,
+				skip: 0,
+			});
+			const page2 = await simulateSearch(data, {
+				q: "widget gadget about",
+				limit: 1,
+				skip: 1,
+			});
+
+			// Pages should return at most 1 result each
+			expect(page1.results.length).toBeLessThanOrEqual(1);
+			expect(page2.results.length).toBeLessThanOrEqual(1);
+		});
+
+		it("returns facets with result counts", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSearch(data, { q: "widget" });
+
+			expect(result.facets).toBeDefined();
+			expect(result.facets.entityTypes).toBeDefined();
+			expect(result.facets.tags).toBeDefined();
+		});
+
+		it("includes image field when present", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSearch(data, { q: "red widget" });
+
+			const redWidget = result.results.find((r) => r.entityId === "prod-1");
+			if (redWidget) {
+				expect(redWidget.image).toBe("/img/red-widget.jpg");
+			}
+
+			const blueGadget = result.results.find((r) => r.entityId === "prod-2");
+			if (blueGadget) {
+				expect(blueGadget.image).toBeUndefined();
+			}
+		});
+	});
+
+	// ── suggest ──────────────────────────────────────────────────────
+
+	describe("suggest", () => {
+		it("returns suggestions for prefix", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSuggest(data, "wid");
+
+			expect(result.suggestions).toBeDefined();
+			expect(Array.isArray(result.suggestions)).toBe(true);
+		});
+
+		it("returns empty for no-match prefix", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSuggest(data, "zzz");
+			expect(result.suggestions).toHaveLength(0);
+		});
+
+		it("respects custom limit", async () => {
+			await seedIndexItems(data);
+			const result = await simulateSuggest(data, "a", 2);
+			expect(result.suggestions.length).toBeLessThanOrEqual(2);
+		});
+	});
+
+	// ── click ────────────────────────────────────────────────────────
+
+	describe("click", () => {
+		it("records a click and returns id", async () => {
+			const result = await simulateClick(data, {
+				queryId: "q-1",
+				term: "widget",
+				entityType: "product",
+				entityId: "prod-1",
+				position: 0,
+			});
+
+			expect(result.id).toBeDefined();
+			expect(typeof result.id).toBe("string");
+		});
+
+		it("records multiple clicks for same query", async () => {
+			const click1 = await simulateClick(data, {
+				queryId: "q-1",
+				term: "widget",
+				entityType: "product",
+				entityId: "prod-1",
+				position: 0,
+			});
+			const click2 = await simulateClick(data, {
+				queryId: "q-1",
+				term: "widget",
+				entityType: "product",
+				entityId: "prod-2",
+				position: 1,
+			});
+
+			expect(click1.id).not.toBe(click2.id);
+		});
+	});
+
+	// ── recent ───────────────────────────────────────────────────────
+
+	describe("recent", () => {
+		it("returns empty for new session", async () => {
+			const result = await simulateRecent(data, "session-new");
+			expect(result.recent).toHaveLength(0);
+		});
+
+		it("returns shaped recent queries (term, resultCount, searchedAt only)", async () => {
+			const controller = createSearchController(data);
+			await controller.recordQuery("widgets", 5, "session-1");
+			await controller.recordQuery("gadgets", 3, "session-1");
+
+			const result = await simulateRecent(data, "session-1");
+			expect(result.recent.length).toBeGreaterThan(0);
+
+			const entry = result.recent[0];
+			expect(entry).toHaveProperty("term");
+			expect(entry).toHaveProperty("resultCount");
+			expect(entry).toHaveProperty("searchedAt");
+			// Should NOT include internal fields
+			expect(entry).not.toHaveProperty("id");
+			expect(entry).not.toHaveProperty("normalizedTerm");
+			expect(entry).not.toHaveProperty("sessionId");
+		});
+
+		it("scopes queries to session", async () => {
+			const controller = createSearchController(data);
+			await controller.recordQuery("widgets", 5, "session-1");
+			await controller.recordQuery("gadgets", 3, "session-2");
+
+			const result = await simulateRecent(data, "session-1");
+			expect(result.recent).toHaveLength(1);
+			expect(result.recent[0].term).toBe("widgets");
+		});
+
+		it("respects limit parameter", async () => {
+			const controller = createSearchController(data);
+			for (let i = 0; i < 5; i++) {
+				await controller.recordQuery(`term-${i}`, i, "session-1");
+			}
+
+			const result = await simulateRecent(data, "session-1", 2);
+			expect(result.recent.length).toBeLessThanOrEqual(2);
+		});
+	});
+});

package/src/admin/endpoints/get-settings.ts

@@ -1,4 +1,5 @@
 import { createAdminEndpoint } from "@86d-app/core";
+import { MeiliSearchProvider } from "../../meilisearch-provider";
 import type { SearchController } from "../../service";
 
 function maskKey(key: string): string {
@@ -15,6 +16,31 @@ interface SearchModuleOptions {
 	embeddingModel?: string;
 }
 
+async function verifyEmbeddingConnection(
+	apiKey: string,
+	baseUrl: string,
+): Promise<{ ok: true } | { ok: false; error: string }> {
+	try {
+		const res = await fetch(`${baseUrl}/models`, {
+			method: "GET",
+			headers: { Authorization: `Bearer ${apiKey}` },
+		});
+		if (res.ok) {
+			return { ok: true };
+		}
+		const text = await res.text().catch(() => "");
+		return {
+			ok: false,
+			error: `HTTP ${res.status}${text ? `: ${text.slice(0, 200)}` : ""}`,
+		};
+	} catch (err) {
+		return {
+			ok: false,
+			error: err instanceof Error ? err.message : "Connection failed",
+		};
+	}
+}
+
 export const getSettings = createAdminEndpoint(
 	"/admin/search/settings",
 	{ method: "GET" },
@@ -30,18 +56,69 @@ export const getSettings = createAdminEndpoint(
 			options?.openaiApiKey || options?.openrouterApiKey,
 		);
 
+		let meilisearchStatus: "connected" | "not_configured" | "error" =
+			"not_configured";
+		let meilisearchError: string | undefined;
+		let documentCount: number | undefined;
+
+		if (
+			meilisearchConfigured &&
+			options?.meilisearchHost &&
+			options.meilisearchApiKey
+		) {
+			const provider = new MeiliSearchProvider(
+				options.meilisearchHost,
+				options.meilisearchApiKey,
+				options.meilisearchIndexUid,
+			);
+			const healthy = await provider.isHealthy();
+			if (healthy) {
+				meilisearchStatus = "connected";
+				const stats = await provider.getStats();
+				if (stats) {
+					documentCount = stats.numberOfDocuments;
+				}
+			} else {
+				meilisearchStatus = "error";
+				meilisearchError = "MeiliSearch instance is not reachable";
+			}
+		}
+
+		let embeddingStatus: "connected" | "not_configured" | "error" =
+			"not_configured";
+		let embeddingError: string | undefined;
+
+		if (embeddingConfigured) {
+			const apiKey = options?.openaiApiKey ?? options?.openrouterApiKey ?? "";
+			const baseUrl = options?.openrouterApiKey
+				? "https://openrouter.ai/api/v1"
+				: "https://api.openai.com/v1";
+			const result = await verifyEmbeddingConnection(apiKey, baseUrl);
+			if (result.ok) {
+				embeddingStatus = "connected";
+			} else {
+				embeddingStatus = "error";
+				embeddingError = result.error;
+			}
+		}
+
 		const indexCount = await controller.getIndexCount();
 
 		return {
 			meilisearch: {
+				status: meilisearchStatus,
+				error: meilisearchError,
 				configured: meilisearchConfigured,
 				host: options?.meilisearchHost ?? null,
 				apiKey: options?.meilisearchApiKey
 					? maskKey(options.meilisearchApiKey)
 					: null,
 				indexUid: options?.meilisearchIndexUid ?? "search",
+				documentCount,
 			},
 			embeddings: {
+				status: embeddingStatus,
+				error: embeddingError,
 				configured: embeddingConfigured,
 				provider: options?.openaiApiKey
 					? "openai"

package/dist/__tests__/controllers.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=controllers.test.d.ts.map

package/dist/__tests__/controllers.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"controllers.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/controllers.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/embedding-provider.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=embedding-provider.test.d.ts.map

package/dist/__tests__/embedding-provider.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"embedding-provider.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/embedding-provider.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/endpoint-security.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=endpoint-security.test.d.ts.map

package/dist/__tests__/endpoint-security.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"endpoint-security.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/endpoint-security.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/meilisearch-provider.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=meilisearch-provider.test.d.ts.map

package/dist/__tests__/meilisearch-provider.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"meilisearch-provider.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/meilisearch-provider.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/service-impl.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=service-impl.test.d.ts.map

package/dist/__tests__/service-impl.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"service-impl.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/service-impl.test.ts"],"names":[],"mappings":""}

package/dist/admin/components/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/admin/components/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/admin/components/search-analytics.d.ts

@@ -1,2 +0,0 @@
-export declare function SearchAnalytics(): import("react").JSX.Element;
-//# sourceMappingURL=search-analytics.d.ts.map

package/dist/admin/components/search-analytics.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"search-analytics.d.ts","sourceRoot":"","sources":["../../../src/admin/components/search-analytics.tsx"],"names":[],"mappings":"AA4FA,wBAAgB,eAAe,gCA+T9B"}

package/dist/admin/endpoints/analytics.d.ts

@@ -1,15 +0,0 @@
-export declare const analyticsEndpoint: import("better-call").StrictEndpoint<"/admin/search/analytics", {
-    method: "GET";
-}, {
-    analytics: {
-        indexedItems: number;
-        totalQueries: number;
-        uniqueTerms: number;
-        avgResultCount: number;
-        zeroResultCount: number;
-        zeroResultRate: number;
-        clickThroughRate: number;
-        avgClickPosition: number;
-    };
-}>;
-//# sourceMappingURL=analytics.d.ts.map

package/dist/admin/endpoints/analytics.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/admin/endpoints/analytics.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;EAW7B,CAAC"}

package/dist/admin/endpoints/bulk-index.d.ts

@@ -1,20 +0,0 @@
-import { z } from "@86d-app/core";
-export declare const bulkIndex: import("better-call").StrictEndpoint<"/admin/search/index/bulk", {
-    method: "POST";
-    body: z.ZodObject<{
-        items: z.ZodArray<z.ZodObject<{
-            entityType: z.ZodString;
-            entityId: z.ZodString;
-            title: z.ZodString;
-            body: z.ZodOptional<z.ZodString>;
-            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            url: z.ZodString;
-            image: z.ZodOptional<z.ZodString>;
-            metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>;
-}, {
-    indexed: number;
-    errors: number;
-}>;
-//# sourceMappingURL=bulk-index.d.ts.map

package/dist/admin/endpoints/bulk-index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bulk-index.d.ts","sourceRoot":"","sources":["../../../src/admin/endpoints/bulk-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,CAAC,EAAE,MAAM,eAAe,CAAC;AAGvD,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;EA8BrB,CAAC"}

package/dist/admin/endpoints/click-analytics.d.ts

@@ -1,7 +0,0 @@
-export declare const clickAnalyticsEndpoint: import("better-call").StrictEndpoint<"/admin/search/clicks", {
-    method: "GET";
-}, {
-    clickThroughRate: number;
-    avgClickPosition: number;
-}>;
-//# sourceMappingURL=click-analytics.d.ts.map

package/dist/admin/endpoints/click-analytics.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"click-analytics.d.ts","sourceRoot":"","sources":["../../../src/admin/endpoints/click-analytics.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,sBAAsB;;;;;EAYlC,CAAC"}

package/dist/admin/endpoints/get-settings.d.ts

@@ -1,17 +0,0 @@
-export declare const getSettings: import("better-call").StrictEndpoint<"/admin/search/settings", {
-    method: "GET";
-}, {
-    meilisearch: {
-        configured: boolean;
-        host: string | null;
-        apiKey: string | null;
-        indexUid: string;
-    };
-    embeddings: {
-        configured: boolean;
-        provider: string | null;
-        model: string;
-    };
-    indexCount: number;
-}>;
-//# sourceMappingURL=get-settings.d.ts.map

package/dist/admin/endpoints/get-settings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-settings.d.ts","sourceRoot":"","sources":["../../../src/admin/endpoints/get-settings.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;EAsCvB,CAAC"}

package/dist/admin/endpoints/index-manage.d.ts

@@ -1,26 +0,0 @@
-import { z } from "@86d-app/core";
-export declare const indexItem: import("better-call").StrictEndpoint<"/admin/search/index", {
-    method: "POST";
-    body: z.ZodObject<{
-        entityType: z.ZodString;
-        entityId: z.ZodString;
-        title: z.ZodString;
-        body: z.ZodOptional<z.ZodString>;
-        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        url: z.ZodString;
-        image: z.ZodOptional<z.ZodString>;
-        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    }, z.core.$strip>;
-}, {
-    item: import("../..").SearchIndexItem;
-}>;
-export declare const removeFromIndex: import("better-call").StrictEndpoint<"/admin/search/index/remove", {
-    method: "POST";
-    body: z.ZodObject<{
-        entityType: z.ZodString;
-        entityId: z.ZodString;
-    }, z.core.$strip>;
-}, {
-    removed: boolean;
-}>;
-//# sourceMappingURL=index-manage.d.ts.map

package/dist/admin/endpoints/index-manage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-manage.d.ts","sourceRoot":"","sources":["../../../src/admin/endpoints/index-manage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,CAAC,EAAE,MAAM,eAAe,CAAC;AAGvD,eAAO,MAAM,SAAS;;;;;;;;;;;;;;EAuBrB,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;;EAiB3B,CAAC"}