import * as _nuxt_schema from '@nuxt/schema';
import { FetchOptions } from 'ofetch';

interface ModuleOptions$1 extends SitemapDefinition {
    /**
     * Whether the sitemap.xml should be generated.
     *
     * @default true
     */
    enabled: boolean;
    /**
     * Enables debug logs and a debug endpoint.
     *
     * @default false
     */
    debug: boolean;
    /**
     * Should lastmod be automatically added to the sitemap.
     *
     * Warning: This may not be following best practices for sitemaps.
     *
     * @see https://nuxtseo.com/sitemap/guides/best-practices.
     * @default false
     */
    autoLastmod: boolean;
    /**
     * Should pages be automatically added to the sitemap.
     *
     * @default true
     * @deprecated If set to false, use `excludeAppSources: ['pages', 'route-rules', 'prerender']` instead. Otherwise, remove this.
     */
    inferStaticPagesAsRoutes: boolean;
    /**
     * Sources to exclude from the sitemap.
     */
    excludeAppSources: true | (AppSourceContext[]);
    /**
     * Multiple sitemap support for large sites.
     *
     * @default false
     */
    sitemaps?: boolean | MultiSitemapsInput;
    /**
     * Path to the xsl that styles sitemap.xml.
     *
     * Set to `false` to disable styling.
     *
     * @default /__sitemap__/style.xsl
     */
    xsl: string | false;
    /**
     * Toggle the tips displayed in the xsl.
     *
     * @default true
     */
    xslTips: boolean;
    /**
     * Customised the columns displayed in the xsl.
     *
     * @default [{ label: 'URL', width: '50%', select: 'string' }, { label: 'Last Modified', width: '25%', select: 'lastmod' }, { label: 'Change Frequency', width: '25%', select: 'changefreq' }]
     */
    xslColumns?: {
        label: string;
        width: `${string}%`;
        select?: string;
    }[];
    /**
     * When prerendering, should images be automatically be discovered and added to the sitemap.
     *
     * @default true
     */
    discoverImages: boolean;
    /**
     * When chunking the sitemaps into multiple files, how many entries should each file contain.
     *
     * Set to `false` to disabling chunking completely.
     *
     * @default 1000
     */
    defaultSitemapsChunkSize: number | false;
    /**
     * Modify the cache behavior.
     *
     * Passing a boolean will enable or disable the runtime cache with the default options.
     *
     * Providing a record will allow you to configure the runtime cache fully.
     *
     * @default true
     * @see https://nitro.unjs.io/guide/storage#mountpoints
     * @example { driver: 'redis', host: 'localhost', port: 6379, password: 'password' }
     */
    runtimeCacheStorage: boolean | (Record<string, any> & {
        driver: string;
    });
    /**
     * Automatically add alternative links to the sitemap based on a prefix list.
     * Is used by @nuxtjs/i18n to automatically add alternative links to the sitemap.
     */
    autoI18n?: boolean | AutoI18nConfig;
    /**
     * Enable when your nuxt/content files match your pages. This will automatically add sitemap content to the sitemap.
     *
     * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
     */
    strictNuxtContentPaths: boolean;
    /**
     * Should the sitemap.xml display credits for the module.
     *
     * @default true
     */
    credits: boolean;
    /**
     * How long, in milliseconds, should the sitemap be cached for.
     *
     * @default 1 hour
     *
     * @deprecated use cacheMaxAgeSeconds
     */
    cacheTtl?: number | false;
    /**
     * How long, in seconds, should the sitemap be cached for.
     *
     * @default 600
     */
    cacheMaxAgeSeconds: number | false;
    /**
     * Should the entries be sorted by loc.
     *
     * @default true
     */
    sortEntries: boolean;
    /**
     * Warm up the sitemap route(s) cache when Nitro starts.
     *
     * May be implemented by default in a future minor version.
     *
     * @experimental Will be enabled by default in v5 (if stable)
     */
    experimentalWarmUp?: boolean;
    /**
     * Send the Sitemap as a compressed stream supporting gzip, brolti, etc.
     *
     * @experimental Will be enabled by default in v5 (if stable)
     */
    experimentalCompression?: boolean;
}
interface IndexSitemapRemotes {
    index?: (string | SitemapIndexEntry)[];
}
interface MultiSitemapEntry {
    [key: string]: Partial<SitemapDefinition>;
}
type MultiSitemapsInput = Partial<MultiSitemapEntry & IndexSitemapRemotes>;
type MaybeFunction<T> = T | (() => T);
type MaybePromise<T> = T | Promise<T>;
type SitemapUrlInput = SitemapUrl | string;
interface SitemapSourceBase {
    context: {
        name: string;
        description?: string;
        tips?: string[];
    };
    fetch?: string | [string, FetchOptions];
    urls?: SitemapUrlInput[];
    sourceType?: 'app' | 'user';
}
interface SitemapSourceResolved extends Omit<SitemapSourceBase, 'urls'> {
    urls: SitemapUrlInput[];
    error?: any;
    timeTakenMs?: number;
}
type AppSourceContext = 'nuxt:pages' | 'nuxt:prerender' | 'nuxt:route-rules' | '@nuxtjs/i18n:pages' | '@nuxt/content:document-driven';
type SitemapSourceInput = string | SitemapSourceBase | SitemapSourceResolved;
type NormalisedLocales = {
    code: string;
    iso?: string;
    domain?: string;
}[];
interface AutoI18nConfig {
    differentDomains?: boolean;
    locales: NormalisedLocales;
    defaultLocale: string;
    strategy: 'prefix' | 'prefix_except_default' | 'prefix_and_default' | 'no_prefix';
}
interface SitemapIndexEntry {
    sitemap: string;
    lastmod?: string;
}
type FilterInput = (string | RegExp | {
    regex: string;
});
type ResolvedSitemapUrl = Omit<SitemapUrl, 'url'> & Required<Pick<SitemapUrl, 'loc'>>;
interface SitemapDefinition {
    /**
     * A collection include patterns for filtering which URLs end up in the sitemap.
     */
    include?: FilterInput[];
    /**
     * A collection exclude patterns for filtering which URLs end up in the sitemap.
     */
    exclude?: FilterInput[];
    /**
     * Should the sitemap be generated using global sources.
     *
     * This is enabled by default when using a single sitemap. Otherwise, it will be opt-in.
     */
    includeAppSources?: boolean;
    /**
     * The root sitemap name.
     * Only works when multiple sitemaps option `sitemaps` isn't used.
     *
     * @default `sitemap.xml`
     */
    sitemapName: string;
    /**
     * A resolvable collection of URLs to include in the sitemap.
     *
     * Will be resolved when the sitemap is generated.
     */
    urls?: MaybeFunction<MaybePromise<SitemapUrlInput[]>>;
    /**
     * Default options for all URLs in the sitemap.
     */
    defaults?: Omit<SitemapUrl, 'loc'>;
    /**
     * Additional sources of URLs to include in the sitemap.
     */
    sources?: SitemapSourceInput[];
    /**
     * The endpoint to fetch dynamic URLs from.
     *
     * @deprecated use `sources`
     */
    dynamicUrlsApiEndpoint?: string | false;
    /**
     * @internal
     */
    _route?: string;
}
interface SitemapRenderCtx {
    sitemapName: string;
    urls: ResolvedSitemapUrl[];
}
interface SitemapOutputHookCtx {
    sitemapName: string;
    sitemap: string;
}
type Changefreq = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
interface SitemapUrl {
    loc: string;
    lastmod?: string | Date;
    changefreq?: Changefreq;
    priority?: 0 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1;
    alternatives?: Array<AlternativeEntry>;
    news?: GoogleNewsEntry;
    images?: Array<ImageEntry>;
    videos?: Array<VideoEntry>;
    _i18nTransform?: boolean;
    _sitemap?: string;
    /**
     * @deprecated use `loc`
     */
    url?: string;
}
interface AlternativeEntry {
    hreflang: string;
    href: string | URL;
}
interface GoogleNewsEntry {
    /**
     * The title of the news article.
     * @example "Companies A, B in Merger Talks"
     */
    title: string;
    /**
     * The article publication date in W3C format. Specify the original date and time when the article was first
     * published on your site. Don't specify the time when you added the article to your sitemap.
     * @example "2008-12-23"
     */
    publication_date: Date | string;
    publication: {
        /**
         * The <news:name> tag is the name of the news publication.
         * It must exactly match the name as it appears on your articles on news.google.com, omitting anything in parentheses.
         * @example "The Example Times"
         */
        name: string;
        /**
         * The <news:language> tag is the language of your publication. Use an ISO 639 language code (two or three letters).
         * @example en
         */
        language: string;
    };
}
interface ImageEntry {
    loc: string | URL;
    caption?: string;
    geoLocation?: string;
    title?: string;
    license?: string | URL;
}
interface VideoEntry {
    title: string;
    thumbnail_loc: string | URL;
    description: string;
    content_loc?: string | URL;
    player_loc?: string | URL;
    duration?: number;
    expiration_date?: Date | string;
    rating?: number;
    view_count?: number;
    publication_date?: Date | string;
    family_friendly?: 'yes' | 'no' | boolean;
    restriction?: Restriction;
    platform?: Platform;
    price?: ({
        price?: number | string;
        currency?: string;
        type?: 'rent' | 'purchase' | 'package' | 'subscription';
    })[];
    requires_subscription?: 'yes' | 'no' | boolean;
    uploader?: {
        uploader: string;
        info?: string | URL;
    };
    live?: 'yes' | 'no' | boolean;
    tag?: string | string[];
}
interface Restriction {
    relationship: 'allow' | 'deny';
    restriction: string;
}
interface Platform {
    relationship: 'allow' | 'deny';
    platform: string;
}

interface ModuleOptions extends ModuleOptions$1 {
}
interface ModuleHooks {
    /**
     * @deprecated use `sitemap:resolved` or `sitemap:output`
     */
    'sitemap:prerender': (ctx: SitemapRenderCtx) => Promise<void> | void;
    'sitemap:resolved': (ctx: SitemapRenderCtx) => Promise<void> | void;
    'sitemap:output': (ctx: SitemapOutputHookCtx) => Promise<void> | void;
}
declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;

export { type ModuleHooks, type ModuleOptions, _default as default };