/*
 * Copyright 2023 Adobe. All rights reserved.
 * This file is licensed to you 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 REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
import { AdminContext, PathInfo } from './index';
import {HelixConfig} from "../types/helix-config";

/**
 * Retrieves the helix-config.json which is an aggregate from fstab.yaml and head.html.
 *
 * @param {AdminContext} ctx the context
 * @param {PathInfo} info path info
 * @param {boolean} optional if {@code true} returns null if not found
 * @returns {Promise<HelixConfig>} the helix-config or {@code null} if optional and not found.
 */
export function fetchHelixConfig(ctx, info, optional): Promise<HelixConfig>;