Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

1.5 KB
Raw Blame
/*
 *  Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

import { useMemo } from 'react';

import {
  ICompilationTemplateBuiltin,
  ICompilationTemplateSection,
} from '@/interfaces/database/compilation-template';
import { isConfigMetaKey, sortSectionNames } from '../utils';

export const useBuiltinTemplate = (
  builtins: ICompilationTemplateBuiltin[],
  kind: string,
) => {
  const builtinTemplate = useMemo(
    () => builtins.find((template) => template.kind === kind),
    [builtins, kind],
  );

  const sectionNames = useMemo(() => {
    const names = Object.keys(builtinTemplate?.config ?? {}).filter((key) => {
      if (isConfigMetaKey(key)) return false;
      const section = builtinTemplate?.config?.[key];
      return (
        section &&
        typeof section === 'object' &&
        Array.isArray((section as ICompilationTemplateSection).fields)
      );
    });
    return sortSectionNames(names);
  }, [builtinTemplate]);

  return { builtinTemplate, sectionNames };
};