@sitecore-content-sdk/core 1.3.0-canary.9 → 1.4.0-canary.2

package/types/client/sitecore-client.d.ts

@@ -1,327 +1,338 @@
-import { DesignLibraryRenderPreviewData, EditingPreviewData, EditingService, ComponentLayoutService, DesignLibraryMode } from '../editing';
-import { DocumentNode } from 'graphql';
-import { GraphQLClient, GraphQLRequestClientFactory } from '../graphql-request-client';
-import { DictionaryPhrases, DictionaryService } from '../i18n';
-import { LayoutService, LayoutServiceData, RouteOptions, LayoutServicePageState } from '../layout';
-import { HTMLLink, FetchOptions, StaticPath, RetryStrategy } from '../models';
-import { PersonalizedRewriteData } from '../personalize/utils';
-import { ErrorPages, ErrorPagesService, SitePathService, SitemapXmlService } from '../site';
-import { SitecoreClientInit } from './models';
-import { RobotsService } from '../site/robots-service';
-/**
- * Error page codes
- */
-export declare enum ErrorPage {
-    NotFound = "404",
-    InternalServerError = "500"
-}
-/**
- * Page mode name
- */
-type PageModeName = LayoutServicePageState | DesignLibraryMode;
-/**
- * Represents the mode of the page
- */
-export type PageMode = {
-    /**
-     * Page mode name.
-     */
-    name: PageModeName;
-    /**
-     * Design Library related properties. Only available in Design Library mode.
-     */
-    designLibrary: {
-        /**
-         * Whether the page is in variant generation mode
-         */
-        isVariantGeneration: boolean;
-    };
-    /**
-     * Whether the page is in normal mode
-     */
-    isNormal: boolean;
-    /**
-     * Whether the page is in preview mode
-     */
-    isPreview: boolean;
-    /**
-     * Whether the page is in editing mode
-     */
-    isEditing: boolean;
-    /**
-     * Whether the page is in Design Library mode
-     */
-    isDesignLibrary: boolean;
-};
-/**
- * Represent a Page model returned from Edge endpoint
- */
-export type Page = {
-    /**
-     * Layout details and props for the page
-     */
-    layout: LayoutServiceData;
-    /**
-     * Site name for current page / route
-     */
-    siteName?: string;
-    /**
-     * Route locale
-     */
-    locale: string;
-    /**
-     * Page mode
-     */
-    mode: PageMode;
-};
-export type PageOptions = Partial<RouteOptions> & {
-    personalize?: PersonalizedRewriteData;
-};
-/**
- * Request options for the getSiteMap method
- */
-export type SitemapXmlOptions = {
-    /** The hostname from the request (e.g., 'example.com') */
-    reqHost: string;
-    /** The protocol from request headers (e.g., 'https' or 'http') */
-    reqProtocol: string | string[];
-    /** Optional sitemap identifier when requesting a specific sitemap */
-    id?: string;
-    /** The site name to resolve the sitemap for */
-    siteName?: string;
-};
-/**
- * Options for fetching robots.txt content.
- */
-export type RobotsOptions = {
-    /**
-     * The name of the site for which to fetch robots.txt content.
-     */
-    siteName: string;
-};
-/**
- * Contract for the Sitecore Client implementations
- */
-export interface BaseSitecoreClient {
-    /**
-     * Execute a raw GraphQL request using the client's configured GraphQL endpoint(s).
-     * This is a thin pass-through to the underlying {@link GraphQLClient.request},
-     * @param query GraphQL string or DocumentNode
-     * @param variables Optional variables bag
-     * @param fetchOptions Optional fetch/retry overrides (headers, retries, fetch impl, debugger)
-     */
-    getData<T = unknown>(query: string | DocumentNode, variables?: Record<string, unknown>, fetchOptions?: FetchOptions): Promise<T>;
-    /**
-     * Retrieves page layoutData and returns page details like language, layoutData and site info for current request
-     * @param {string} path current request path
-     * @param {PageOptions} pageOptions additional overrides like language, site name and personalization variants
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     * @returns {Page | null} page details when page layout is found and null when not
-     */
-    getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
-    /**
-     * Retrieves the robots.txt content for a given site name.
-     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
-     */
-    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
-    getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
-    /**
-     * Get error pages configured by SXA for a given site and locale
-     * @param {RouteOptions} [routeOptions] language and site to load error pages for
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     */
-    getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
-    /**
-     * Get preview layout details based on details from EditingPreviewData input
-     * @param {EditingPreviewData | undefined} previewData preview details like route, site, language etc used to retrieve preview page and layout
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     */
-    getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
-    /**
-     * Get error page details for a given error code
-     * @param {ErrorPage} code - The error code to get the error page for
-     * @param {Partial<RouteOptions>} [pageOptions] - The page options to get the error page for
-     * @param {FetchOptions} [fetchOptions] - Additional fetch fetch options to override GraphQL requests
-     * @returns {Promise<Page | null>} A promise that resolves to the error page details or null if not found
-     */
-    getErrorPage(code: ErrorPage, pageOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<Page | null>;
-    /**
-     * Get route paths for all pages in the site. Can be used for static site generation.
-     * @param {string[]} sites - sites to fetch routes for
-     * @param {string[]} [languages] languages to fetch routes in
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     */
-    getPagePaths(sites: string[], languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
-    /**
-     * Retrieves the links to be loaded in app's <head> element for each page.
-     * @param {LayoutServiceData} layoutData - The layout data containing styles and themes.
-     * @param {object} [options] - Optional configuration for enabling styles and themes.
-     * @param {boolean} [options.enableStyles] - Whether to include content styles.
-     * @param {boolean} [options.enableThemes] - Whether to include theme styles.
-     * @returns {HTMLLink[]} An array of `<link>` elements.
-     */
-    getHeadLinks(layoutData: LayoutServiceData, options: {
-        enableStyles?: boolean;
-        enableThemes?: boolean;
-    }): HTMLLink[];
-    /**
-     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
-     * @param { SitemapRequestConfig} reqOptions - Configuration for sitemap retrieval
-     * @param {FetchOptions} [fetchOptions] - Additional fetchOptions Additional fetch options to override GraphQL requests
-     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
-     */
-    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
-    /**
-     * Retrieves the robots.txt content for a given site name.
-     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
-     * @param {FetchOptions} fetchOptions Additional fetch options to override GraphQL requests
-     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
-     */
-    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
-}
-export interface BaseServiceOptions {
-    defaultSite: string;
-    clientFactory: GraphQLRequestClientFactory;
-    retries: {
-        count: number;
-        retryStrategy: RetryStrategy;
-    };
-}
-/**
- * This is a generic content client that can be used by any framework.
- * Use it to retrieve pages, preview data, dictionary and other data
- */
-export declare class SitecoreClient implements BaseSitecoreClient {
-    protected initOptions: SitecoreClientInit;
-    protected layoutService: LayoutService;
-    protected dictionaryService: DictionaryService;
-    protected editingService: EditingService;
-    protected clientFactory: GraphQLRequestClientFactory;
-    protected errorPagesService: ErrorPagesService;
-    protected componentService: ComponentLayoutService;
-    protected sitePathService: SitePathService;
-    protected graphQLClient: GraphQLClient;
-    /**
-     * Init SitecoreClient
-     * @param {SitecoreClientInit} initOptions initOptions for the client, containing site and Sitecore connection details
-     */
-    constructor(initOptions: SitecoreClientInit);
-    /**
-     * Normalize path regardless of type
-     * @param {string | string[]} path string or string array path
-     * @returns {string} string path
-     */
-    parsePath(path: string | string[]): string;
-    /**
-     * Execute a raw GraphQL request using the client's configured GraphQL Edge endpoint.
-     * This is a thin pass-through to the underlying {@link GraphQLClient.request},
-     * @param {string | DocumentNode} query GraphQL query
-     * @param {Record<string, unknown>} [variables] Optional variables bag
-     * @param {FetchOptions} [fetchOptions] Optional fetch overrides (e.g. fetch, headers)
-     */
-    getData<T = unknown>(query: string | DocumentNode, variables?: Record<string, unknown>, fetchOptions?: FetchOptions): Promise<T>;
-    /**
-     * Get page details for a route, with layout and other details
-     * @param {string} path route path
-     * @param {PageOptions} [pageOptions] site, language and personalization variant details for route
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     * @returns {Page | null} page details
-     */
-    getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
-    /**
-     * Retrieves the head `<link>` elements for Sitecore styles and themes.
-     * @param {LayoutServiceData} layoutData - The layout data containing styles and themes.
-     * @param {object} [options] - Optional configuration for enabling styles and themes.
-     * @param {boolean} [options.enableStyles] - Whether to include content styles.
-     * @param {boolean} [options.enableThemes] - Whether to include theme styles.
-     * @returns {HTMLLink[]} An array of `<link>` elements for stylesheets.
-     */
-    getHeadLinks(layoutData: LayoutServiceData, options?: {
-        enableStyles?: boolean;
-        enableThemes?: boolean;
-    }): HTMLLink[];
-    /**
-     * Retrieves dictionary phrases for a given site and locale.
-     * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
-     */
-    getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
-    /**
-     * Retrieves error pages for a given site and locale.
-     * @param {RouteOptions} routeOptions - Route options containing language and site name to load error pages
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     * @returns {ErrorPages | null} A promise that resolves to the error pages or null if not found.
-     */
-    getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
-    /**
-     * Retrieves preview page and layout details
-     * @param {EditingPreviewData | undefined} previewData - The editing preview data for metadata mode.
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     * @returns {Page} preview page details
-     */
-    getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
-    /**
-     * Get design library page details for Design Library mode of your app
-     * @param {DesignLibraryRenderPreviewData} designLibData preview data set in 'library' mode of the app
-     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
-     * @returns {Page} preview page for Design Library
-     */
-    getDesignLibraryData(designLibData: DesignLibraryRenderPreviewData, fetchOptions?: FetchOptions): Promise<Page>;
-    /**
-     * Get error page details for a given error code
-     * @param {ErrorPage} code - The error code to get the error page for
-     * @param {Partial<RouteOptions>} pageOptions - The page options to get the error page for
-     * @param {FetchOptions} [fetchOptions] - Additional fetch fetch options to override GraphQL requests
-     * @returns {Promise<Page | null>} A promise that resolves to the error page details or null if not found
-     */
-    getErrorPage(code: ErrorPage, pageOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<Page | null>;
-    /**
-     * Retrieves the static paths for pages based on the given languages.
-     * @param {string[]} sites - An array of site names to fetch routes for.
-     * @param {string[]} [languages] - An optional array of language codes to generate paths for.
-     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
-     * @returns {Promise<StaticPath[]>} A promise that resolves to an array of static paths.
-     */
-    getPagePaths(sites: string[], languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
-    /**
-     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
-     * @param {SitemapXmlOptions} reqOptions - Options for sitemap retrieval
-     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
-     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
-     * @throws {Error} Throws 'REDIRECT_404' if requested sitemap is not found
-     */
-    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
-    /**
-     * Retrieves the robots.txt content for a given site name.
-     * @param {string} siteName - The name of the site to retrieve the robots.txt for.
-     * @param {FetchOptions} [fetchOptions] - Optional fetch options.
-     * @returns {Promise<string | null>} A promise that resolves to the robots.txt content,
-     * or null if no content is found.
-     */
-    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
-    /**
-     * Factory methods for creating dependencies
-     * Subclasses can override these to provide custom implementations.
-     */
-    protected getGraphqlSitemapXMLService(siteName: string): SitemapXmlService;
-    protected getRobotsService(siteName: string): RobotsService;
-    protected getBaseServiceOptions(): BaseServiceOptions;
-    /**
-     * Get page mode based on mode name
-     * @param {PageModeName} mode - The mode name to get the page mode for
-     * @param { DesignLibraryVariantGeneration} generation - The variant generation mode, if applicable
-     * @returns {PageMode} The page mode
-     */
-    private getPageMode;
-    private getClientFactory;
-    private getLayoutService;
-    private getDictionaryService;
-    private getEditingService;
-    private getErrorPagesService;
-    private getComponentService;
-    private getSitePathService;
-}
-export {};
+import { DesignLibraryRenderPreviewData, EditingPreviewData, EditingService, ComponentLayoutService, DesignLibraryMode } from '../editing';
+import { DocumentNode } from 'graphql';
+import { GraphQLClient, GraphQLRequestClientFactory } from '../graphql-request-client';
+import { DictionaryPhrases, DictionaryService } from '../i18n';
+import { LayoutService, LayoutServiceData, RouteOptions, LayoutServicePageState } from '../layout';
+import { HTMLLink, FetchOptions, StaticPath, RetryStrategy } from '../models';
+import { PersonalizedRewriteData } from '../personalize/utils';
+import { ErrorPages, ErrorPagesService, SitePathService, SitemapXmlService } from '../site';
+import { SitecoreClientInit } from './models';
+import { RobotsService } from '../site/robots-service';
+/**
+ * Error page codes
+ * @public
+ */
+export declare enum ErrorPage {
+    NotFound = "404",
+    InternalServerError = "500"
+}
+/**
+ * Page mode name
+ * @public
+ */
+type PageModeName = LayoutServicePageState | DesignLibraryMode;
+/**
+ * Represents the mode of the page
+ * @public
+ */
+export type PageMode = {
+    /**
+     * Page mode name.
+     */
+    name: PageModeName;
+    /**
+     * Design Library related properties. Only available in Design Library mode.
+     */
+    designLibrary: {
+        /**
+         * Whether the page is in variant generation mode
+         */
+        isVariantGeneration: boolean;
+    };
+    /**
+     * Whether the page is in normal mode
+     */
+    isNormal: boolean;
+    /**
+     * Whether the page is in preview mode
+     */
+    isPreview: boolean;
+    /**
+     * Whether the page is in editing mode
+     */
+    isEditing: boolean;
+    /**
+     * Whether the page is in Design Library mode
+     */
+    isDesignLibrary: boolean;
+};
+/**
+ * Represent a Page model returned from Edge endpoint
+ * @public
+ */
+export type Page = {
+    /**
+     * Layout details and props for the page
+     */
+    layout: LayoutServiceData;
+    /**
+     * Site name for current page / route
+     */
+    siteName?: string;
+    /**
+     * Route locale
+     */
+    locale: string;
+    /**
+     * Page mode
+     */
+    mode: PageMode;
+};
+/**
+ * Page options
+ * @public
+ */
+export type PageOptions = Partial<RouteOptions> & {
+    personalize?: PersonalizedRewriteData;
+};
+/**
+ * Request options for the getSiteMap method
+ * @public
+ */
+export type SitemapXmlOptions = {
+    /** The hostname from the request (e.g., 'example.com') */
+    reqHost: string;
+    /** The protocol from request headers (e.g., 'https' or 'http') */
+    reqProtocol: string | string[];
+    /** Optional sitemap identifier when requesting a specific sitemap */
+    id?: string;
+    /** The site name to resolve the sitemap for */
+    siteName?: string;
+};
+/**
+ * Options for fetching robots.txt content.
+ */
+export type RobotsOptions = {
+    /**
+     * The name of the site for which to fetch robots.txt content.
+     */
+    siteName: string;
+};
+/**
+ * Contract for the Sitecore Client implementations
+ */
+export interface BaseSitecoreClient {
+    /**
+     * Execute a raw GraphQL request using the client's configured GraphQL endpoint(s).
+     * This is a thin pass-through to the underlying {@link GraphQLClient.request},
+     * @param query GraphQL string or DocumentNode
+     * @param variables Optional variables bag
+     * @param fetchOptions Optional fetch/retry overrides (headers, retries, fetch impl, debugger)
+     */
+    getData<T = unknown>(query: string | DocumentNode, variables?: Record<string, unknown>, fetchOptions?: FetchOptions): Promise<T>;
+    /**
+     * Retrieves page layoutData and returns page details like language, layoutData and site info for current request
+     * @param {string} path current request path
+     * @param {PageOptions} pageOptions additional overrides like language, site name and personalization variants
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Page | null} page details when page layout is found and null when not
+     */
+    getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
+    getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
+    /**
+     * Get error pages configured by SXA for a given site and locale
+     * @param {RouteOptions} [routeOptions] language and site to load error pages for
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     */
+    getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
+    /**
+     * Get preview layout details based on details from EditingPreviewData input
+     * @param {EditingPreviewData | undefined} previewData preview details like route, site, language etc used to retrieve preview page and layout
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     */
+    getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Get error page details for a given error code
+     * @param {ErrorPage} code - The error code to get the error page for
+     * @param {Partial<RouteOptions>} [pageOptions] - The page options to get the error page for
+     * @param {FetchOptions} [fetchOptions] - Additional fetch fetch options to override GraphQL requests
+     * @returns {Promise<Page | null>} A promise that resolves to the error page details or null if not found
+     */
+    getErrorPage(code: ErrorPage, pageOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Get route paths for all pages in the site. Can be used for static site generation.
+     * @param {string[]} sites - sites to fetch routes for
+     * @param {string[]} [languages] languages to fetch routes in
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     */
+    getPagePaths(sites: string[], languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
+    /**
+     * Retrieves the links to be loaded in app's <head> element for each page.
+     * @param {LayoutServiceData} layoutData - The layout data containing styles and themes.
+     * @param {object} [options] - Optional configuration for enabling styles and themes.
+     * @param {boolean} [options.enableStyles] - Whether to include content styles.
+     * @param {boolean} [options.enableThemes] - Whether to include theme styles.
+     * @returns {HTMLLink[]} An array of `<link>` elements.
+     */
+    getHeadLinks(layoutData: LayoutServiceData, options: {
+        enableStyles?: boolean;
+        enableThemes?: boolean;
+    }): HTMLLink[];
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param { SitemapRequestConfig} reqOptions - Configuration for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetchOptions Additional fetch options to override GraphQL requests
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     */
+    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site for which to fetch robots.txt content.
+     * @param {FetchOptions} fetchOptions Additional fetch options to override GraphQL requests
+     * @returns {Promise<string>} A promise that resolves to the robots.txt content.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
+}
+export interface BaseServiceOptions {
+    defaultSite: string;
+    clientFactory: GraphQLRequestClientFactory;
+    retries: {
+        count: number;
+        retryStrategy: RetryStrategy;
+    };
+}
+/**
+ * This is a generic content client that can be used by any framework.
+ * Use it to retrieve pages, preview data, dictionary and other data
+ * @public
+ */
+export declare class SitecoreClient implements BaseSitecoreClient {
+    protected initOptions: SitecoreClientInit;
+    protected layoutService: LayoutService;
+    protected dictionaryService: DictionaryService;
+    protected editingService: EditingService;
+    protected clientFactory: GraphQLRequestClientFactory;
+    protected errorPagesService: ErrorPagesService;
+    protected componentService: ComponentLayoutService;
+    protected sitePathService: SitePathService;
+    protected graphQLClient: GraphQLClient;
+    /**
+     * Init SitecoreClient
+     * @param {SitecoreClientInit} initOptions initOptions for the client, containing site and Sitecore connection details
+     */
+    constructor(initOptions: SitecoreClientInit);
+    /**
+     * Normalize path regardless of type
+     * @param {string | string[]} path string or string array path
+     * @returns {string} string path
+     */
+    parsePath(path: string | string[]): string;
+    /**
+     * Execute a raw GraphQL request using the client's configured GraphQL Edge endpoint.
+     * This is a thin pass-through to the underlying {@link GraphQLClient.request},
+     * @param {string | DocumentNode} query GraphQL query
+     * @param {Record<string, unknown>} [variables] Optional variables bag
+     * @param {FetchOptions} [fetchOptions] Optional fetch overrides (e.g. fetch, headers)
+     */
+    getData<T = unknown>(query: string | DocumentNode, variables?: Record<string, unknown>, fetchOptions?: FetchOptions): Promise<T>;
+    /**
+     * Get page details for a route, with layout and other details
+     * @param {string} path route path
+     * @param {PageOptions} [pageOptions] site, language and personalization variant details for route
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Page | null} page details
+     */
+    getPage(path: string | string[], pageOptions?: PageOptions, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Retrieves the head `<link>` elements for Sitecore styles and themes.
+     * @param {LayoutServiceData} layoutData - The layout data containing styles and themes.
+     * @param {object} [options] - Optional configuration for enabling styles and themes.
+     * @param {boolean} [options.enableStyles] - Whether to include content styles.
+     * @param {boolean} [options.enableThemes] - Whether to include theme styles.
+     * @returns {HTMLLink[]} An array of `<link>` elements for stylesheets.
+     */
+    getHeadLinks(layoutData: LayoutServiceData, options?: {
+        enableStyles?: boolean;
+        enableThemes?: boolean;
+    }): HTMLLink[];
+    /**
+     * Retrieves dictionary phrases for a given site and locale.
+     * @param {RouteOptions} routeOptions - Route options containing language and site name to load dictionary for
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
+     */
+    getDictionary(routeOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<DictionaryPhrases>;
+    /**
+     * Retrieves error pages for a given site and locale.
+     * @param {RouteOptions} routeOptions - Route options containing language and site name to load error pages
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {ErrorPages | null} A promise that resolves to the error pages or null if not found.
+     */
+    getErrorPages(routeOptions?: RouteOptions, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
+    /**
+     * Retrieves preview page and layout details
+     * @param {EditingPreviewData | undefined} previewData - The editing preview data for metadata mode.
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Page} preview page details
+     */
+    getPreview(previewData: EditingPreviewData | undefined, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Get design library page details for Design Library mode of your app
+     * @param {DesignLibraryRenderPreviewData} designLibData preview data set in 'library' mode of the app
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests
+     * @returns {Page} preview page for Design Library
+     */
+    getDesignLibraryData(designLibData: DesignLibraryRenderPreviewData, fetchOptions?: FetchOptions): Promise<Page>;
+    /**
+     * Get error page details for a given error code
+     * @param {ErrorPage} code - The error code to get the error page for
+     * @param {Partial<RouteOptions>} pageOptions - The page options to get the error page for
+     * @param {FetchOptions} [fetchOptions] - Additional fetch fetch options to override GraphQL requests
+     * @returns {Promise<Page | null>} A promise that resolves to the error page details or null if not found
+     */
+    getErrorPage(code: ErrorPage, pageOptions?: Partial<RouteOptions>, fetchOptions?: FetchOptions): Promise<Page | null>;
+    /**
+     * Retrieves the static paths for pages based on the given languages.
+     * @param {string[]} sites - An array of site names to fetch routes for.
+     * @param {string[]} [languages] - An optional array of language codes to generate paths for.
+     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+     * @returns {Promise<StaticPath[]>} A promise that resolves to an array of static paths.
+     */
+    getPagePaths(sites: string[], languages?: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
+    /**
+     * Retrieves sitemap XML content - either a specific sitemap or the index of all sitemaps.
+     * @param {SitemapXmlOptions} reqOptions - Options for sitemap retrieval
+     * @param {FetchOptions} [fetchOptions] - Additional fetch options.
+     * @returns {Promise<string>} Promise resolving to the sitemap XML content as string
+     * @throws {Error} Throws 'REDIRECT_404' if requested sitemap is not found
+     */
+    getSiteMap(reqOptions: SitemapXmlOptions, fetchOptions?: FetchOptions): Promise<string>;
+    /**
+     * Retrieves the robots.txt content for a given site name.
+     * @param {string} siteName - The name of the site to retrieve the robots.txt for.
+     * @param {FetchOptions} [fetchOptions] - Optional fetch options.
+     * @returns {Promise<string | null>} A promise that resolves to the robots.txt content,
+     * or null if no content is found.
+     */
+    getRobots(siteName: string, fetchOptions?: FetchOptions): Promise<string | null>;
+    /**
+     * Factory methods for creating dependencies
+     * Subclasses can override these to provide custom implementations.
+     */
+    protected getGraphqlSitemapXMLService(siteName: string): SitemapXmlService;
+    protected getRobotsService(siteName: string): RobotsService;
+    protected getBaseServiceOptions(): BaseServiceOptions;
+    /**
+     * Get page mode based on mode name
+     * @param {PageModeName} mode - The mode name to get the page mode for
+     * @param { DesignLibraryVariantGeneration} generation - The variant generation mode, if applicable
+     * @returns {PageMode} The page mode
+     */
+    private getPageMode;
+    private getClientFactory;
+    private getLayoutService;
+    private getDictionaryService;
+    private getEditingService;
+    private getErrorPagesService;
+    private getComponentService;
+    private getSitePathService;
+}
+export {};
+//# sourceMappingURL=sitecore-client.d.ts.map