feat(spotlight): add support for custom search-engines (#1200)

* feat(spotlight): add search settings link

* feat(search-engine): add to manage pages

* feat(spotlight): add children option for external search engines

* chore: revert search settings

* fix: deepsource issue

* fix: inconsistent breadcrum placement

* chore: address pull request feedback

packages/api/src/root.ts

@@ -9,6 +9,7 @@ import { integrationRouter } from "./router/integration/integration-router";
 import { inviteRouter } from "./router/invite";
 import { locationRouter } from "./router/location";
 import { logRouter } from "./router/log";
+import { searchEngineRouter } from "./router/search-engine/search-engine-router";
 import { serverSettingsRouter } from "./router/serverSettings";
 import { userRouter } from "./router/user";
 import { widgetRouter } from "./router/widgets";
@@ -21,6 +22,7 @@ export const appRouter = createTRPCRouter({
   integration: integrationRouter,
   board: boardRouter,
   app: innerAppRouter,
+  searchEngine: searchEngineRouter,
   widget: widgetRouter,
   location: locationRouter,
   log: logRouter,

packages/api/src/router/app.ts

@@ -31,7 +31,7 @@ export const appRouter = createTRPCRouter({
         limit: input.limit,
       });
     }),
-  byId: publicProcedure.input(validation.app.byId).query(async ({ ctx, input }) => {
+  byId: publicProcedure.input(validation.common.byId).query(async ({ ctx, input }) => {
     const app = await ctx.db.query.apps.findFirst({
       where: eq(apps.id, input.id),
     });
@@ -76,7 +76,7 @@ export const appRouter = createTRPCRouter({
       })
       .where(eq(apps.id, input.id));
   }),
-  delete: publicProcedure.input(validation.app.byId).mutation(async ({ ctx, input }) => {
+  delete: publicProcedure.input(validation.common.byId).mutation(async ({ ctx, input }) => {
     await ctx.db.delete(apps).where(eq(apps.id, input.id));
   }),
 });

packages/api/src/router/group.ts

@@ -8,7 +8,7 @@ import { validation, z } from "@homarr/validation";
 import { createTRPCRouter, protectedProcedure, publicProcedure } from "../trpc";
 
 export const groupRouter = createTRPCRouter({
-  getPaginated: protectedProcedure.input(validation.group.paginated).query(async ({ input, ctx }) => {
+  getPaginated: protectedProcedure.input(validation.common.paginated).query(async ({ input, ctx }) => {
     const whereQuery = input.search ? like(groups.name, `%${input.search.trim()}%`) : undefined;
     const groupCount = await ctx.db
       .select({
@@ -45,7 +45,7 @@ export const groupRouter = createTRPCRouter({
       totalCount: groupCount[0]?.count ?? 0,
     };
   }),
-  getById: protectedProcedure.input(validation.group.byId).query(async ({ input, ctx }) => {
+  getById: protectedProcedure.input(validation.common.byId).query(async ({ input, ctx }) => {
     const group = await ctx.db.query.groups.findFirst({
       where: eq(groups.id, input.id),
       with: {
@@ -156,7 +156,7 @@ export const groupRouter = createTRPCRouter({
       })
       .where(eq(groups.id, input.groupId));
   }),
-  deleteGroup: protectedProcedure.input(validation.group.byId).mutation(async ({ input, ctx }) => {
+  deleteGroup: protectedProcedure.input(validation.common.byId).mutation(async ({ input, ctx }) => {
     await throwIfGroupNotFoundAsync(ctx.db, input.id);
 
     await ctx.db.delete(groups).where(eq(groups.id, input.id));

packages/api/src/router/search-engine/search-engine-router.ts

@@ -0,0 +1,85 @@
+import { TRPCError } from "@trpc/server";
+
+import { createId, eq, like, sql } from "@homarr/db";
+import { searchEngines } from "@homarr/db/schema/sqlite";
+import { validation } from "@homarr/validation";
+
+import { createTRPCRouter, protectedProcedure } from "../../trpc";
+
+export const searchEngineRouter = createTRPCRouter({
+  getPaginated: protectedProcedure.input(validation.common.paginated).query(async ({ input, ctx }) => {
+    const whereQuery = input.search ? like(searchEngines.name, `%${input.search.trim()}%`) : undefined;
+    const searchEngineCount = await ctx.db
+      .select({
+        count: sql<number>`count(*)`,
+      })
+      .from(searchEngines)
+      .where(whereQuery);
+
+    const dbSearachEngines = await ctx.db.query.searchEngines.findMany({
+      limit: input.pageSize,
+      offset: (input.page - 1) * input.pageSize,
+      where: whereQuery,
+    });
+
+    return {
+      items: dbSearachEngines,
+      totalCount: searchEngineCount[0]?.count ?? 0,
+    };
+  }),
+  byId: protectedProcedure.input(validation.common.byId).query(async ({ ctx, input }) => {
+    const searchEngine = await ctx.db.query.searchEngines.findFirst({
+      where: eq(searchEngines.id, input.id),
+    });
+
+    if (!searchEngine) {
+      throw new TRPCError({
+        code: "NOT_FOUND",
+        message: "Search engine not found",
+      });
+    }
+
+    return searchEngine;
+  }),
+  search: protectedProcedure.input(validation.common.search).query(async ({ ctx, input }) => {
+    return await ctx.db.query.searchEngines.findMany({
+      where: like(searchEngines.short, `${input.query.toLowerCase().trim()}%`),
+      limit: input.limit,
+    });
+  }),
+  create: protectedProcedure.input(validation.searchEngine.manage).mutation(async ({ ctx, input }) => {
+    await ctx.db.insert(searchEngines).values({
+      id: createId(),
+      name: input.name,
+      short: input.short.toLowerCase(),
+      iconUrl: input.iconUrl,
+      urlTemplate: input.urlTemplate,
+      description: input.description,
+    });
+  }),
+  update: protectedProcedure.input(validation.searchEngine.edit).mutation(async ({ ctx, input }) => {
+    const searchEngine = await ctx.db.query.searchEngines.findFirst({
+      where: eq(searchEngines.id, input.id),
+    });
+
+    if (!searchEngine) {
+      throw new TRPCError({
+        code: "NOT_FOUND",
+        message: "Search engine not found",
+      });
+    }
+
+    await ctx.db
+      .update(searchEngines)
+      .set({
+        name: input.name,
+        iconUrl: input.iconUrl,
+        urlTemplate: input.urlTemplate,
+        description: input.description,
+      })
+      .where(eq(searchEngines.id, input.id));
+  }),
+  delete: protectedProcedure.input(validation.common.byId).mutation(async ({ ctx, input }) => {
+    await ctx.db.delete(searchEngines).where(eq(searchEngines.id, input.id));
+  }),
+});