/*
 * Copyright 2021 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 { SitemapConfig } from '@adobe/helix-shared-config';
import { AdminContext, PathInfo } from './index';

/**
 * Retrieves the sitemap from the underlying storage and stores it in the context as sitemapConfig.
 * @param {AdminContext} ctx the context
 * @param {PathInfo} info path info
 * @param {boolean} optional if {@code true}, no error is thrown if the config can't be retrieved
 * @returns {Promise<SitemapConfig>} the sitemap configuration
 */
export function fetchSitemap(ctx: AdminContext, info:PathInfo, optional:boolean):Promise<SitemapConfig>;