@spartacus/core/src/cms/page/config/page-meta.config.d.ts

Spartacus - the core framework

import * as i0 from "@angular/core";
export declare abstract class PageMetaConfig {
    pageMeta?: PageMetaResolversConfig;
    static ɵfac: i0.ɵɵFactoryDeclaration<PageMetaConfig, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<PageMetaConfig>;
}
declare module '../../../config/config-tokens' {
    interface Config extends PageMetaConfig {
    }
}
export interface PageMetaResolversConfig {
    resolvers?: PageMetaResolverConfig[];
    /**
     * Specifies how the canonical url is created.
     */
    canonicalUrl?: CanonicalUrlOptions;
    /**
     * Enables resolvers in dev mode regardless of the CSR configuration. This
     * flag will override the disabling in CSR, which can be useful during development
     * and debugging.
     */
    enableInDevMode?: boolean;
}
export interface PageMetaResolverConfig {
    /**
     * PageMeta property
     */
    property: string;
    /**
     * The resolver method that must be provided on the resolver class.
     */
    method: string;
    /**
     * Disables specific resolvers in CSR mode. Some of the resolvers are
     * not needed in CSR app, as they're only used for crawlers who will
     * be served from SSR rendered pages.
     */
    disabledInCsr?: boolean;
}
export interface CanonicalUrlOptions {
    /**
     * Forces a trailing slash to avoid both https://www.myshop.com and https://www.myshop.com/.
     */
    forceTrailingSlash?: boolean;
    /**
     * Forces the use of `https://` in the canonical URL.
     */
    forceHttps?: boolean;
    /**
     * Forces the `www` subdomain, so that canonical URLs are always prefixed with `www.`.
     *
     * Please be aware that the logic will not detect whether your domain includes a subdomain.
     */
    forceWww?: boolean;
    /**
     * Removes query parameters from the URL to avoid page duplicates.
     *
     * This is useful in case page urls have various query parameters that are added by
     * integrations (i.e. generated links from social platform).
     *
     * The query parameter can either be removed completely, or an array of query parameter keys
     * can be provided.
     */
    removeQueryParams?: boolean | string[];
}