Skip to content

A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration.

3.4 KB
Raw Blame
"use client";

import { useEffect } from "react";

import { clientApi } from "@homarr/api/client";
import { queryCacheDefaultStaleTimeMs } from "@homarr/api/query-cache";
import { useSession } from "@homarr/auth/client";

import { spotlightOpenEvent } from "../open";

const catalogQueryOptions = (enabled = true) => ({
  enabled,
  refetchOnWindowFocus: false,
  staleTime: queryCacheDefaultStaleTimeMs,
});

export const useAppsCatalogQuery = (enabled = true) => {
  const { status } = useSession();
  return clientApi.app.selectable.useQuery(undefined, catalogQueryOptions(enabled && status === "authenticated"));
};

export const useBoardsCatalogQuery = () => {
  const { status } = useSession();
  return clientApi.board.catalog.useQuery(undefined, catalogQueryOptions(status !== "loading"));
};

export const useIntegrationsCatalogQuery = (enabled = true) => {
  const { status } = useSession();
  return clientApi.integration.all.useQuery(undefined, catalogQueryOptions(enabled && status === "authenticated"));
};

export const useSearchEnginesCatalogQuery = () => {
  const { status } = useSession();
  return clientApi.searchEngine.catalog.useQuery(undefined, catalogQueryOptions(status !== "loading"));
};

export const useSpotlightCatalogs = () => {
  const { data: session, status } = useSession();
  const isAuthenticated = status === "authenticated";
  const isSessionResolved = status !== "loading";
  const canBrowseApps =
    session?.user.permissions.includes("board-modify-all") === true ||
    session?.user.permissions.includes("app-modify-all") === true;

  const appsQuery = useAppsCatalogQuery(isAuthenticated && canBrowseApps);
  const boardsQuery = useBoardsCatalogQuery();
  const integrationsQuery = useIntegrationsCatalogQuery(isAuthenticated);
  const searchEnginesQuery = useSearchEnginesCatalogQuery();

  useEffect(() => {
    const refreshCatalogs = () => {
      if (canBrowseApps) void appsQuery.refetch();
      if (isSessionResolved) void boardsQuery.refetch();
      if (isAuthenticated) void integrationsQuery.refetch();
      if (isSessionResolved) void searchEnginesQuery.refetch();
    };

    window.addEventListener(spotlightOpenEvent, refreshCatalogs);
    return () => window.removeEventListener(spotlightOpenEvent, refreshCatalogs);
  }, [
    appsQuery,
    boardsQuery,
    canBrowseApps,
    integrationsQuery,
    isAuthenticated,
    isSessionResolved,
    searchEnginesQuery,
  ]);
};

export const filterCatalog = <TOption>(
  options: TOption[],
  query: string,
  getSearchableValues: (option: TOption) => string[],
  limit = 8,
) => {
  const normalizedQuery = query.trim().toLowerCase();
  if (normalizedQuery.length === 0) return options.slice(0, limit);

  return options
    .map((option, index) => {
      const values = getSearchableValues(option).map((value) => value.toLowerCase());
      const score = values.reduce((currentScore, value) => {
        if (value === normalizedQuery) return Math.min(currentScore, 0);
        if (value.startsWith(normalizedQuery)) return Math.min(currentScore, 1);
        if (value.includes(normalizedQuery)) return Math.min(currentScore, 2);
        return currentScore;
      }, Number.POSITIVE_INFINITY);

      return { option, index, score };
    })
    .filter(({ score }) => Number.isFinite(score))
    .toSorted((first, second) => first.score - second.score || first.index - second.index)
    .slice(0, limit)
    .map(({ option }) => option);
};