@sitecore-content-sdk/content 1.5.0-canary.5

package/types/personalize/utils.d.ts

@@ -0,0 +1,78 @@
+/** @internal */
+export declare const DEFAULT_VARIANT = "_default";
+/** @internal */
+export declare const VARIANT_PREFIX = "_variantId_";
+/** @public */
+export type PersonalizedRewriteData = {
+    variantId: string;
+    componentVariantIds?: string[];
+};
+/**
+ * Get a personalized rewrite path for given pathname
+ * @param {string} pathname the pathname
+ * @param {string[]} variantIds the variantIds to include in the rewrite
+ * @returns {string} the rewrite path
+ * @public
+ */
+export declare function getPersonalizedRewrite(pathname: string, variantIds: string[]): string;
+/**
+ * Get personalize data from the rewrite path
+ * @param {string} pathname the pathname
+ * @returns {PersonalizedRewriteData} the personalize data from the rewrite
+ * @public
+ */
+export declare function getPersonalizedRewriteData(pathname: string): PersonalizedRewriteData;
+/**
+ * Parses a list of variantIds and divides into layout and component variants
+ * @param {string[]} variantIds the list of variant IDs for a page
+ * @returns {PersonalizedRewriteData} object with variant IDs sorted
+ * @public
+ */
+export declare function getGroomedVariantIds(variantIds: string[]): PersonalizedRewriteData;
+/**
+ * Normalize a personalized rewrite path (remove personalize data)
+ * @param {string} pathname the pathname
+ * @returns {string} the pathname with personalize data removed
+ * @public
+ */
+export declare function normalizePersonalizedRewrite(pathname: string): string;
+/**
+ * Static utility class for Sitecore CDP
+ * @public
+ */
+export declare class CdpHelper {
+    /**
+     * Gets the page variant id for CDP in the required format
+     * @param {string} pageId the page id
+     * @param {string} language the language
+     * @param {string} variantId the variant id
+     * @param {string} [scope] the scope value
+     * @returns {string} the formatted page variant id
+     */
+    static getPageVariantId(pageId: string, language: string, variantId: string, scope?: string): string;
+    /**
+     * Gets the friendly id for (page-level) Embedded Personalization in the required format `embedded_[<scope>_]<id>_<lang>`
+     * @param {string} pageId the page id
+     * @param {string} language the language
+     * @param {string} [scope] the scope value
+     * @returns {string} the friendly id
+     */
+    static getPageFriendlyId(pageId: string, language: string, scope?: string): string;
+    /**
+     * Gets the friendly id for Component A/B Testing in the required format `component_[<scope>_]<pageId>_<componentId>_<language>*`
+     * @param {string} pageId the page id
+     * @param {string} componentId the component id
+     * @param {string} language the language
+     * @param {string} [scope] the scope value
+     * @returns {string} the friendly id
+     */
+    static getComponentFriendlyId(pageId: string, componentId: string, language: string, scope?: string): string;
+    /**
+     * Normalizes the scope from the given string value
+     * Removes all non-alphanumeric characters
+     * @param {string} [scope] the scope value
+     * @returns {string} normalized scope value
+     */
+    static normalizeScope(scope?: string): string;
+}
+//# sourceMappingURL=utils.d.ts.map

package/types/personalize/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/personalize/utils.ts"],"names":[],"mappings":"AAAA,gBAAgB;AAChB,eAAO,MAAM,eAAe,aAAa,CAAC;AAC1C,gBAAgB;AAChB,eAAO,MAAM,cAAc,gBAAgB,CAAC;AAE5C,cAAc;AACd,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,CAGrF;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,uBAAuB,CAWpF;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,2BAmBxD;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CASrE;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,CACrB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,MAAM;IAWT;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM;IAOlF;;;;;;;OAOG;IACH,MAAM,CAAC,sBAAsB,CAC3B,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,KAAK,CAAC,EAAE,MAAM,GACb,MAAM;IAQT;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM;CAG9C"}

package/types/site/error-pages-service.d.ts

@@ -0,0 +1,64 @@
+import { GraphQLRequestClientFactory } from '@sitecore-content-sdk/core';
+import { FetchOptions, GraphQLClient } from '../client';
+import { LayoutServiceData } from '../layout';
+import { GraphQLServiceConfig } from '../sitecore-service-base';
+/**
+ * Configuration for @see ErrorPagesService instances
+ * @public
+ */
+export interface ErrorPagesServiceConfig extends GraphQLServiceConfig {
+    /**
+     * The language
+     */
+    language: string;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+}
+/**
+ * Object model of Error Pages result
+ * @public
+ */
+export type ErrorPages = {
+    notFoundPage: {
+        rendered: LayoutServiceData;
+    };
+    notFoundPagePath: string;
+    serverErrorPage: {
+        rendered: LayoutServiceData;
+    };
+    serverErrorPagePath: string;
+};
+/**
+ * Service that fetch the error pages data using Sitecore's GraphQL API.
+ * @public
+ */
+export declare class ErrorPagesService {
+    options: ErrorPagesServiceConfig;
+    private graphQLClient;
+    /**
+     * Creates an instance of graphQL error pages service with the provided options
+     * @param {ErrorPagesServiceConfig} options instance
+     */
+    constructor(options: ErrorPagesServiceConfig);
+    protected get query(): string;
+    /**
+     * Fetch list of error pages for the site
+     * @param {string} siteName  The site name
+     * @param {string} locale  The language
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @returns {ErrorPages} list of url's error pages
+     * @throws {Error} if the siteName is empty.
+     */
+    fetchErrorPages(siteName: string, locale?: string, fetchOptions?: FetchOptions): Promise<ErrorPages | null>;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+}
+//# sourceMappingURL=error-pages-service.d.ts.map

package/types/site/error-pages-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-pages-service.d.ts","sourceRoot":"","sources":["../../src/site/error-pages-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAExD,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAuBhE;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,YAAY,EAAE;QAAE,QAAQ,EAAE,iBAAiB,CAAA;KAAE,CAAC;IAC9C,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE;QAAE,QAAQ,EAAE,iBAAiB,CAAA;KAAE,CAAC;IACjD,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AASF;;;GAGG;AACH,qBAAa,iBAAiB;IAOT,OAAO,EAAE,uBAAuB;IANnD,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACgB,OAAO,EAAE,uBAAuB;IAInD,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;;;OAOG;IACG,eAAe,CACnB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,EACf,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAqB7B;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAW5C"}

package/types/site/index.d.ts

@@ -0,0 +1,10 @@
+export { RobotsQueryResult, RobotsService, RobotsServiceConfig } from './robots-service';
+export { RedirectInfo, RedirectsQueryResult, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectsService, RedirectsServiceConfig, } from './redirects-service';
+export { SitemapQueryResult, SitemapXmlService, SitemapXmlServiceConfig, } from './sitemap-xml-service';
+export { ErrorPages, ErrorPagesService, ErrorPagesServiceConfig } from './error-pages-service';
+export { SiteInfoService, SiteInfoServiceConfig } from './siteinfo-service';
+export { SitePathService, SitePathServiceConfig } from './sitepath-service';
+export { SiteInfo } from './models';
+export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SiteRewriteData, SITE_PREFIX, SITE_KEY, } from './utils';
+export { SiteResolver } from './site-resolver';
+//# sourceMappingURL=index.d.ts.map

package/types/site/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/site/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACzF,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,6BAA6B,EAC7B,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAE/F,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE5E,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,QAAQ,GACT,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC"}

package/types/site/models.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Object model of Site Info result
+ * @public
+ */
+export type SiteInfo = {
+    /**
+     * Additional user-defined properties
+     */
+    [key: string]: unknown;
+    /**
+     * Site name
+     */
+    name: string;
+    /**
+     * Site host name. May include multiple values (separated by '|') and wildcards ('*')
+     */
+    hostName: string;
+    /**
+     * Site default language
+     */
+    language: string;
+};
+//# sourceMappingURL=models.d.ts.map

package/types/site/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/site/models.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/types/site/redirects-service.d.ts

@@ -0,0 +1,91 @@
+import { GraphQLClient, GraphQLRequestClientFactory, CacheClient, CacheOptions, FetchOptions } from '@sitecore-content-sdk/core';
+/**
+ * Redirect type for 301 redirects
+ * @public
+ */
+export declare const REDIRECT_TYPE_301 = "REDIRECT_301";
+/**
+ * Redirect type for 302 redirects
+ * @public
+ */
+export declare const REDIRECT_TYPE_302 = "REDIRECT_302";
+/**
+ * Redirect type for server transfer
+ * @public
+ */
+export declare const REDIRECT_TYPE_SERVER_TRANSFER = "SERVER_TRANSFER";
+/**
+ * Object model of Redirect Info result
+ * @public
+ */
+export type RedirectInfo = {
+    pattern: string;
+    target: string;
+    redirectType: string;
+    isQueryStringPreserved: boolean;
+    isLanguagePreserved?: boolean;
+    locale: string;
+};
+/**
+ * Configuration for @see RedirectsService instances
+ * @public
+ */
+export type RedirectsServiceConfig = CacheOptions & {
+    /**
+     * Override fetch method. Uses 'GraphQLRequestClient' default otherwise.
+     */
+    fetch?: typeof fetch;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+};
+/**
+ * The schema of data returned in response to redirects array request
+ * @public
+ */
+export type RedirectsQueryResult = {
+    site: {
+        siteInfo: {
+            redirects: RedirectInfo[];
+        } | null;
+    };
+};
+/**
+ * The RedirectsService class is used to query the Content SDK redirects using Graphql endpoint
+ * @public
+ */
+export declare class RedirectsService {
+    private options;
+    private graphQLClient;
+    private cache;
+    /**
+     * Creates an instance of graphQL redirects service with the provided options
+     * @param {RedirectsServiceConfig} options instance
+     */
+    constructor(options: RedirectsServiceConfig);
+    protected get query(): string;
+    /**
+     * Fetch an array of redirects from API
+     * @param {string} siteName site name
+     * @returns Promise<RedirectInfo[]>
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @throws {Error} if the siteName is empty.
+     */
+    fetchRedirects(siteName: string, fetchOptions?: FetchOptions): Promise<RedirectInfo[]>;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+    /**
+     * Gets cache client implementation
+     * Override this method if custom cache needs to be used
+     * @returns CacheClient instance
+     */
+    protected getCacheClient(): CacheClient<RedirectsQueryResult>;
+}
+//# sourceMappingURL=redirects-service.d.ts.map

package/types/site/redirects-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirects-service.d.ts","sourceRoot":"","sources":["../../src/site/redirects-service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,2BAA2B,EAC3B,WAAW,EACX,YAAY,EAEZ,YAAY,EACb,MAAM,4BAA4B,CAAC;AAIpC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,6BAA6B,oBAAoB,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,EAAE,OAAO,CAAC;IAChC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAoBF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,YAAY,GAAG;IAClD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE;QAAE,QAAQ,EAAE;YAAE,SAAS,EAAE,YAAY,EAAE,CAAA;SAAE,GAAG,IAAI,CAAA;KAAE,CAAC;CAC1D,CAAC;AAEF;;;GAGG;AACH,qBAAa,gBAAgB;IAQf,OAAO,CAAC,OAAO;IAP3B,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,KAAK,CAAoC;IAEjD;;;OAGG;gBACiB,OAAO,EAAE,sBAAsB;IAKnD,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;;OAMG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAsB5F;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;IAW3C;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,WAAW,CAAC,oBAAoB,CAAC;CAM9D"}

package/types/site/robots-service.d.ts

@@ -0,0 +1,57 @@
+import { GraphQLRequestClientFactory } from '@sitecore-content-sdk/core';
+import { FetchOptions, GraphQLClient } from '../client';
+/**
+ * Configuration for @see RobotsService instances
+ * @public
+ */
+export type RobotsServiceConfig = {
+    /**
+     * The Content SDK application name
+     */
+    siteName: string;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+};
+/**
+ * The schema of data returned in response to robots.txt request
+ * @public
+ */
+export type RobotsQueryResult = {
+    site: {
+        siteInfo: {
+            robots: string;
+        };
+    };
+};
+/**
+ * Service that fetch the robots.txt data using Sitecore's GraphQL API.
+ * @public
+ */
+export declare class RobotsService {
+    options: RobotsServiceConfig;
+    private graphQLClient;
+    /**
+     * Creates an instance of graphQL robots.txt service with the provided options
+     * @param {RobotsServiceConfig} options instance
+     */
+    constructor(options: RobotsServiceConfig);
+    protected get query(): string;
+    /**
+     * Fetch a data of robots.txt from API
+     * @param {FetchOptions} fetchOptions - The fetch options to be used for the request.
+     * @returns text of robots.txt
+     * @throws {Error} if the siteName is empty.
+     */
+    fetchRobots(fetchOptions?: FetchOptions): Promise<string>;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+}
+//# sourceMappingURL=robots-service.d.ts.map

package/types/site/robots-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"robots-service.d.ts","sourceRoot":"","sources":["../../src/site/robots-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAexD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,IAAI,EAAE;QAAE,QAAQ,EAAE;YAAE,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAAC;AAE3E;;;GAGG;AACH,qBAAa,aAAa;IAOL,OAAO,EAAE,mBAAmB;IAN/C,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACgB,OAAO,EAAE,mBAAmB;IAI/C,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;OAKG;IACG,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAuB/D;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAS5C"}

package/types/site/site-resolver.d.ts

@@ -0,0 +1,28 @@
+import { SiteInfo } from './models';
+/**
+ * Resolves site based on the provided host or site name
+ * @public
+ */
+export declare class SiteResolver {
+    readonly sites: SiteInfo[];
+    /**
+     * @param {SiteInfo[]} sites Array of sites to be used in resolution
+     */
+    constructor(sites: SiteInfo[]);
+    /**
+     * Resolve site by host name
+     * @param {string} hostName the host name
+     * @returns {SiteInfo} the resolved site
+     * @throws {Error} if a matching site is not found
+     */
+    getByHost: (hostName: string) => SiteInfo;
+    /**
+     * Resolve site by site name
+     * @param {string} siteName the site name
+     * @returns {SiteInfo} the resolved site or undefined if not found
+     */
+    getByName: (siteName: string) => SiteInfo | undefined;
+    protected getHostMap: () => Map<string, SiteInfo>;
+    protected matchesPattern(hostname: string, pattern: string): boolean;
+}
+//# sourceMappingURL=site-resolver.d.ts.map

package/types/site/site-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-resolver.d.ts","sourceRoot":"","sources":["../../src/site/site-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAKpC;;;GAGG;AACH,qBAAa,YAAY;IAIX,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE;IAHtC;;OAEG;gBACkB,KAAK,EAAE,QAAQ,EAAE;IAEtC;;;;;OAKG;IACI,SAAS,GAAI,UAAU,MAAM,KAAG,QAAQ,CAO7C;IAEF;;;;OAIG;IACI,SAAS,GAAI,UAAU,MAAM,0BAMlC;IAEF,SAAS,CAAC,UAAU,QAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CA2B9C;IAEF,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;CASrE"}

package/types/site/siteinfo-service.d.ts

@@ -0,0 +1,64 @@
+import { FetchOptions, GraphQLClient } from '@sitecore-content-sdk/core';
+import { GraphQLRequestClientFactory, CacheClient, CacheOptions } from '@sitecore-content-sdk/core';
+import { SiteInfo } from './models';
+/**
+ * Configuration for @see SiteInfoService instances
+ * @public
+ */
+export type SiteInfoServiceConfig = CacheOptions & {
+    /**
+     * common variable for all GraphQL queries
+     * it will be used for every type of query to regulate result batch size
+     * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+};
+/**
+ * Object model of Site Info result
+ * @public
+ */
+export type GraphQLSiteInfoResult = {
+    name: string;
+    hostName: string;
+    language: string;
+};
+/**
+ * Service to fetch site information
+ * @public
+ */
+export declare class SiteInfoService {
+    private config;
+    private graphQLClient;
+    private cache;
+    /**
+     * Creates an instance of graphQL service to retrieve site configuration list from Sitecore
+     * @param {SiteInfoServiceConfig} config instance
+     */
+    constructor(config: SiteInfoServiceConfig);
+    /**
+     * site query is available on XM Cloud and XP 10.4+
+     */
+    protected get siteQuery(): string;
+    fetchSiteInfo(fetchOptions?: FetchOptions): Promise<SiteInfo[]>;
+    /**
+     * Gets cache client implementation
+     * Override this method if custom cache needs to be used
+     * @returns CacheClient instance
+     */
+    protected getCacheClient(): CacheClient<SiteInfo[]>;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+    private getCacheKey;
+}
+//# sourceMappingURL=siteinfo-service.d.ts.map

package/types/site/siteinfo-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"siteinfo-service.d.ts","sourceRoot":"","sources":["../../src/site/siteinfo-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,YAAY,EAAqB,MAAM,4BAA4B,CAAC;AAEvH,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAcpC;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG;IACjD;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAQF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,qBAAa,eAAe;IAQd,OAAO,CAAC,MAAM;IAP1B,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,KAAK,CAA0B;IAEvC;;;OAGG;gBACiB,MAAM,EAAE,qBAAqB;IAKjD;;OAEG;IACH,SAAS,KAAK,SAAS,IAAI,MAAM,CAEhC;IAEK,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8BrE;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;IAOnD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;IAU3C,OAAO,CAAC,WAAW;CAGpB"}

package/types/site/sitemap-xml-service.d.ts

@@ -0,0 +1,63 @@
+import { FetchOptions, GraphQLClient } from '../client';
+import { GraphQLRequestClientFactory } from '@sitecore-content-sdk/core';
+/**
+ * Configuration for @see SitemapXmlService instances
+ * @public
+ */
+export type SitemapXmlServiceConfig = {
+    /**
+     * The Content SDK application name
+     */
+    siteName: string;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+};
+/**
+ * The schema of data returned in response to sitemaps request
+ * @public
+ */
+export type SitemapQueryResult = {
+    site: {
+        siteInfo: {
+            sitemap: string[];
+        };
+    };
+};
+/**
+ * Service that fetch the sitemaps data using Sitecore's GraphQL API.
+ * @public
+ */
+export declare class SitemapXmlService {
+    options: SitemapXmlServiceConfig;
+    private graphQLClient;
+    /**
+     * Creates an instance of graphQL sitemaps service with the provided options
+     * @param {SitemapXmlServiceConfig} options instance
+     */
+    constructor(options: SitemapXmlServiceConfig);
+    protected get query(): string;
+    /**
+     * Fetch list of sitemaps for the site
+     * @returns {string[]} list of sitemap paths
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
+     * @throws {Error} if the siteName is empty.
+     */
+    fetchSitemaps(fetchOptions?: FetchOptions): Promise<string[]>;
+    /**
+     * Get sitemap file path for sitemap id
+     * @param {string} id the sitemap id (can be empty for default 'sitemap.xml' file)
+     * @returns {string | undefined} the sitemap file path or undefined if one doesn't exist
+     */
+    getSitemap(id: string): Promise<string | undefined>;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+}
+//# sourceMappingURL=sitemap-xml-service.d.ts.map

package/types/site/sitemap-xml-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-xml-service.d.ts","sourceRoot":"","sources":["../../src/site/sitemap-xml-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAiBzE;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,IAAI,EAAE;QAAE,QAAQ,EAAE;YAAE,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAAC;AAE/E;;;GAGG;AACH,qBAAa,iBAAiB;IAOT,OAAO,EAAE,uBAAuB;IANnD,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACgB,OAAO,EAAE,uBAAuB;IAInD,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;OAKG;IACG,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAqBnE;;;;OAIG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAiBzD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAS5C"}

package/types/site/sitepath-service.d.ts

@@ -0,0 +1,137 @@
+import { FetchOptions, GraphQLClient, GraphQLRequestClientFactory, PageInfo } from '../client';
+import { StaticPath } from '../models';
+/** @private */
+export declare const languageError = "The list of languages cannot be empty";
+export declare const siteError = "The service needs a site name";
+export declare const sitesError = "The list of sites cannot be empty";
+/**
+ * @param {string} siteName to inject into error text
+ * @private
+ */
+export declare function getSiteEmptyError(siteName: string): string;
+/**
+ * type for input variables for the site routes query
+ */
+interface SiteRouteQueryVariables {
+    /**
+     * Required. Name of a site to fetch sitemap for
+     */
+    siteName: string;
+    /**
+     * Required. The language to return routes/pages for.
+     */
+    language: string;
+    /**
+     * Optional. Only paths starting with these provided prefixes will be returned.
+     */
+    includedPaths?: string[];
+    /**
+     * Optional. Paths starting with these provided prefixes will be excluded from returned results.
+     */
+    excludedPaths?: string[];
+    /**
+     * common variable for all GraphQL queries
+     * it will be used for every type of query to regulate result batch size
+     * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
+     * @default 100
+     */
+    pageSize?: number;
+}
+/**
+ * Schema of data returned in response to a "site" query request
+ * @template T The type of objects being requested.
+ */
+export interface SiteRouteQueryResult<T> {
+    site: {
+        siteInfo: {
+            routes: {
+                /**
+                 * Data needed to paginate the site results
+                 */
+                pageInfo: PageInfo;
+                results: T[];
+            };
+        };
+    };
+}
+/**
+ * The schema of data returned in response to a routes list query request
+ */
+export type RouteListQueryResult = {
+    path: string;
+    route?: {
+        personalization?: {
+            variantIds: string[];
+        };
+    };
+};
+/**
+ * Configuration options for @see SitePathService instances
+ * @public
+ */
+export interface SitePathServiceConfig extends Omit<SiteRouteQueryVariables, 'language' | 'siteName'> {
+    /**
+     * A flag for whether to include personalized routes in service output.
+     * Only works on XM Cloud for pages using Embedded Personalization (not Component A/B testing).
+     * Turned off by default.
+     */
+    includePersonalizedRoutes?: boolean;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+}
+/**
+ * Service that fetches the list of site pages using Sitecore's GraphQL API.
+ * Used to handle a single site
+ * This list is used for SSG and Export functionality.
+ * @mixes SearchQueryService<PageListQueryResult>
+ * @public
+ */
+export declare class SitePathService {
+    options: SitePathServiceConfig;
+    private _graphQLClient;
+    /**
+     * Creates an instance of graphQL sitemap service with the provided options
+     * @param {SitePathServiceConfig} options instance
+     */
+    constructor(options: SitePathServiceConfig);
+    /**
+     * GraphQL client accessible by descendant classes when needed
+     */
+    protected get graphQLClient(): GraphQLClient;
+    /**
+     * Gets the default query used for fetching the list of site pages
+     */
+    protected get query(): string;
+    /**
+     * Fetch a flat list of all pages that belong to all the requested sites and have a
+     * version in the specified language(s).
+     * @param {string[]} sites Fetch pages for these sites.
+     * @param {string[]} languages Fetch pages that have versions in this language(s).
+     * @param {FetchOptions} fetchOptions Options to override graphQL client details like retries and fetch implementation
+     * @returns list of pages
+     * @throws {RangeError} if the list of languages is empty.
+     * @throws {RangeError} if the any of the languages is an empty string.
+     */
+    fetchSiteRoutes(sites: string[], languages: string[], fetchOptions?: FetchOptions): Promise<StaticPath[]>;
+    protected transformLanguageSitePaths(sitePaths: RouteListQueryResult[], formatStaticPath: (path: string[], language: string) => StaticPath, language: string): Promise<StaticPath[]>;
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    protected getGraphQLClient(): GraphQLClient;
+    /**
+     * Fetch and return site paths for multisite implementation, with prefixes included
+     * @param {string} language path language
+     * @param {string} siteName site name
+     * @param {FetchOptions} fetchOptions Options to override graphQL client details like retries and fetch implementation
+     * @returns modified paths
+     */
+    protected fetchLanguageSitePaths(language: string, siteName: string, fetchOptions?: FetchOptions): Promise<RouteListQueryResult[]>;
+}
+export {};
+//# sourceMappingURL=sitepath-service.d.ts.map

package/types/site/sitepath-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitepath-service.d.ts","sourceRoot":"","sources":["../../src/site/sitepath-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,2BAA2B,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAKvC,eAAe;AACf,eAAO,MAAM,aAAa,0CAA0C,CAAC;AACrE,eAAO,MAAM,SAAS,kCAAkC,CAAC;AACzD,eAAO,MAAM,UAAU,sCAAsC,CAAC;AAE9D;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,UAEjD;AAgDD;;GAEG;AACH,UAAU,uBAAuB;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC;IACrC,IAAI,EAAE;QACJ,QAAQ,EAAE;YACR,MAAM,EAAE;gBACN;;mBAEG;gBACH,QAAQ,EAAE,QAAQ,CAAC;gBACnB,OAAO,EAAE,CAAC,EAAE,CAAC;aACd,CAAC;SACH,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE;QACN,eAAe,CAAC,EAAE;YAChB,UAAU,EAAE,MAAM,EAAE,CAAC;SACtB,CAAC;KACH,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,qBACf,SAAQ,IAAI,CAAC,uBAAuB,EAAE,UAAU,GAAG,UAAU,CAAC;IAC9D;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C;AAED;;;;;;GAMG;AACH,qBAAa,eAAe;IAOP,OAAO,EAAE,qBAAqB;IANjD,OAAO,CAAC,cAAc,CAAgB;IAEtC;;;OAGG;gBACgB,OAAO,EAAE,qBAAqB;IAIjD;;OAEG;IACH,SAAS,KAAK,aAAa,kBAE1B;IAED;;OAEG;IACH,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;;;;;OASG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,EAAE,MAAM,EAAE,EACnB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,UAAU,EAAE,CAAC;cAkCR,0BAA0B,CACxC,SAAS,EAAE,oBAAoB,EAAE,EACjC,gBAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,KAAK,UAAU,EAClE,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,EAAE,CAAC;IA6BxB;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;IAU3C;;;;;;OAMG;cACa,sBAAsB,CACpC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,oBAAoB,EAAE,CAAC;CAwCnC"}