SCM-Manager/scm-ui/ui-api/src/search.ts

/*
 * MIT License
 *
 * Copyright (c) 2020-present Cloudogu GmbH and Contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import { ApiResult, ApiResultWithFetching, useIndexJsonResource, useIndexLinks } from "./base";
import { Link, QueryResult, SearchableType } from "@scm-manager/ui-types";
import { apiClient } from "./apiclient";
import { createQueryString } from "./utils";
import { useQueries, useQuery } from "react-query";
import { useEffect, useState } from "react";

export type SearchOptions = {
  type: string;
  page?: number;
  pageSize?: number;
};

const defaultSearchOptions: SearchOptions = {
  type: "repository",
};

const isString = (str: string | undefined): str is string => !!str;

export const useSearchTypes = () => {
  return useSearchLinks()
    .map((link) => link.name)
    .filter(isString);
};

export const useSearchableTypes = () => useIndexJsonResource<SearchableType[]>("searchableTypes");

export const useSearchCounts = (types: string[], query: string) => {
  const searchLinks = useSearchLinks();
  const queries = useQueries(
    types.map((type) => ({
      queryKey: ["search", type, query, "count"],
      queryFn: () =>
        apiClient.get(`${findLink(searchLinks, type)}?q=${query}&countOnly=true`).then((response) => response.json()),
    }))
  );
  const result: { [type: string]: ApiResultWithFetching<number> } = {};
  queries.forEach((q, i) => {
    result[types[i]] = {
      isLoading: q.isLoading,
      isFetching: q.isFetching,
      error: q.error as Error,
      data: (q.data as QueryResult)?.totalHits,
    };
  });
  return result;
};

const findLink = (links: Link[], name: string) => {
  for (const l of links) {
    if (l.name === name) {
      return l.href;
    }
  }
  throw new Error(`could not find search link for ${name}`);
};

const useSearchLinks = () => {
  const links = useIndexLinks();
  const searchLinks = links["search"];
  if (!searchLinks) {
    throw new Error("could not find search links in index");
  }

  if (!Array.isArray(searchLinks)) {
    throw new Error("search links returned in wrong format, array is expected");
  }
  return searchLinks as Link[];
};

const useSearchLink = (name: string) => {
  const searchLinks = useSearchLinks();
  return findLink(searchLinks, name);
};

export const useSearch = (query: string, optionParam = defaultSearchOptions): ApiResult<QueryResult> => {
  const options = { ...defaultSearchOptions, ...optionParam };
  const link = useSearchLink(options.type);

  const queryParams: Record<string, string> = {};
  queryParams.q = query;
  if (options.page) {
    queryParams.page = options.page.toString();
  }
  if (options.pageSize) {
    queryParams.pageSize = options.pageSize.toString();
  }
  return useQuery<QueryResult, Error>(
    ["search", options.type, queryParams],
    () => apiClient.get(`${link}?${createQueryString(queryParams)}`).then((response) => response.json()),
    {
      enabled: query.length > 1,
    }
  );
};

const useObserveAsync = <D extends any[], R, E = Error>(fn: (...args: D) => Promise<R>, deps: D) => {
  const [data, setData] = useState<R>();
  const [isLoading, setLoading] = useState(false);
  const [error, setError] = useState<E>();
  useEffect(() => {
    setLoading(true);
    fn(...deps)
      .then(setData)
      .catch(setError)
      .finally(() => setLoading(false));
  }, deps);
  return { data, isLoading, error };
};

const supportedLanguages = ["de", "en"];

const pickLang = (language: string) => {
  if (!supportedLanguages.includes(language)) {
    return "en";
  }
  return language;
};

export const useSearchHelpContent = (language: string) =>
  useObserveAsync(
    (lang) => import(`./help/search/modal.${pickLang(lang)}`).then((module) => module.default),
    [language]
  );
export const useSearchSyntaxContent = (language: string) =>
  useObserveAsync(
    (lang) => import(`./help/search/syntax.${pickLang(lang)}`).then((module) => module.default),
    [language]
  );