@sitecore-content-sdk/core 0.1.0-beta.13 → 0.1.0-beta.16

package/client.d.ts

@@ -0,0 +1 @@
+export * from './types/client/index';

package/client.js

@@ -0,0 +1 @@
+module.exports = require('./dist/cjs/client/index');

package/dist/cjs/client/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.languageError = exports.siteNameError = void 0;
+/** @private */
+exports.siteNameError = 'The site name must be a non-empty string';
+/** @private */
+exports.languageError = 'The language must be a non-empty string';

package/dist/cjs/{graphql → client}/index.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEdgeProxyFormsUrl = exports.getEdgeProxyContentUrl = exports.DefaultRetryStrategy = exports.SearchQueryService = exports.GraphQLRequestClient = exports.getAppRootId = void 0;
-var app_root_query_1 = require("./app-root-query");
-Object.defineProperty(exports, "getAppRootId", { enumerable: true, get: function () { return app_root_query_1.getAppRootId; } });
+exports.createGraphQLClientFactory = exports.SitecoreClient = exports.getEdgeProxyFormsUrl = exports.getEdgeProxyContentUrl = exports.DefaultRetryStrategy = exports.GraphQLRequestClient = void 0;
 var graphql_request_client_1 = require("../graphql-request-client");
 Object.defineProperty(exports, "GraphQLRequestClient", { enumerable: true, get: function () { return graphql_request_client_1.GraphQLRequestClient; } });
-var search_service_1 = require("./search-service");
-Object.defineProperty(exports, "SearchQueryService", { enumerable: true, get: function () { return search_service_1.SearchQueryService; } });
 var retries_1 = require("../retries");
 Object.defineProperty(exports, "DefaultRetryStrategy", { enumerable: true, get: function () { return retries_1.DefaultRetryStrategy; } });
 var graphql_edge_proxy_1 = require("./graphql-edge-proxy");
 Object.defineProperty(exports, "getEdgeProxyContentUrl", { enumerable: true, get: function () { return graphql_edge_proxy_1.getEdgeProxyContentUrl; } });
 Object.defineProperty(exports, "getEdgeProxyFormsUrl", { enumerable: true, get: function () { return graphql_edge_proxy_1.getEdgeProxyFormsUrl; } });
+var sitecore_client_1 = require("./sitecore-client");
+Object.defineProperty(exports, "SitecoreClient", { enumerable: true, get: function () { return sitecore_client_1.SitecoreClient; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "createGraphQLClientFactory", { enumerable: true, get: function () { return utils_1.createGraphQLClientFactory; } });

package/dist/cjs/client/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/client/sitecore-client.js

@@ -0,0 +1,265 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitecoreClient = void 0;
+const editing_1 = require("../editing");
+const i18n_1 = require("../i18n");
+const layout_1 = require("../layout");
+const utils_1 = require("../personalize/utils");
+const layout_personalizer_1 = require("../personalize/layout-personalizer");
+const site_1 = require("../site");
+const utils_2 = require("./utils");
+/**
+ * This is a generic content client that can be used by any framework.
+ * Use it to retrieve pages, preview data, dictionary and other data
+ */
+class SitecoreClient {
+    /**
+     * Init SitecoreClient
+     * @param {SitecoreClientInit} initOptions initOptions for the client, containing site and Sitecore connection details
+     */
+    constructor(initOptions) {
+        this.initOptions = initOptions;
+        this.clientFactory = this.getClientFactory();
+        this.siteResolver = this.getSiteResolver();
+        const baseServiceOptions = this.getBaseServiceOptions();
+        this.layoutService = this.getLayoutService(baseServiceOptions);
+        this.dictionaryService = this.getDictionaryService(baseServiceOptions);
+        this.editingService = this.getEditingService();
+        this.errorPagesService = this.getErrorPagesService();
+        this.componentService = this.getComponentService();
+        this.sitePathService = this.getSitePathService();
+        this.siteResolver = new site_1.SiteResolver(initOptions.sites);
+        this.editingService = new editing_1.GraphQLEditingService({ clientFactory: this.clientFactory });
+    }
+    /**
+     * Resolve site by hostname
+     * @param {string} hostname site hostname
+     * @returns {SiteInfo} site details matching the hostname
+     */
+    resolveSite(hostname) {
+        const site = this.siteResolver.getByHost(hostname);
+        return site;
+    }
+    /**
+     * Normalize path regardless of type
+     * @param {string | string[]} path string or string array path
+     * @returns {string} string path
+     */
+    parsePath(path) {
+        // join array path, while clearing extra slashes and ensure first slash
+        return typeof path === 'string'
+            ? path.startsWith('/')
+                ? path
+                : `/${path}`
+            : `/${path
+                .filter((part) => part !== '/')
+                .map((part) => part.replace(/^\/+/, '').replace(/\/+$/, ''))
+                .join('/')}`;
+    }
+    /**
+     * 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 (like retries and fetch)
+     * @returns {Page | null} page details
+     */
+    async getPage(path, pageOptions, fetchOptions) {
+        var _a, _b, _c;
+        const computedPath = this.parsePath(path);
+        const locale = (_a = pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.locale) !== null && _a !== void 0 ? _a : this.initOptions.defaultLanguage;
+        const site = (_b = pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.site) !== null && _b !== void 0 ? _b : this.initOptions.defaultSite;
+        // Fetch layout data, passing on req/res for SSR
+        const layout = await this.layoutService.fetchLayoutData(computedPath, {
+            locale,
+            site,
+        }, fetchOptions);
+        if (!layout.sitecore.route) {
+            return null;
+        }
+        else {
+            const siteInfo = this.siteResolver.getByName(site);
+            // Initialize links to be inserted on the page
+            if ((_c = pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.personalize) === null || _c === void 0 ? void 0 : _c.variantId) {
+                // Modify layoutData to use specific variant(s) instead of default
+                // This will also set the variantId on the Sitecore context so that it is accessible here
+                (0, layout_personalizer_1.personalizeLayout)(layout, pageOptions.personalize.variantId, pageOptions.personalize.componentVariantIds);
+            }
+            return {
+                layout,
+                site: siteInfo,
+                locale,
+            };
+        }
+    }
+    /**
+     * 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, options = {}) {
+        const { enableStyles = true, enableThemes = true } = options;
+        const { contextId, edgeUrl } = this.initOptions.api.edge;
+        const headLinks = [];
+        if (enableStyles) {
+            const contentStyles = (0, layout_1.getContentStylesheetLink)(layoutData, contextId, edgeUrl);
+            if (contentStyles)
+                headLinks.push(contentStyles);
+        }
+        if (enableThemes) {
+            headLinks.push(...(0, layout_1.getComponentLibraryStylesheetLinks)(layoutData, contextId, edgeUrl));
+        }
+        return headLinks;
+    }
+    /**
+     * Retrieves dictionary phrases for a given site and locale.
+     * @param {PageOptions} pageOptions - Route options containing language and site name to load dictionary for
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @returns {DictionaryPhrases} A promise that resolves to the dictionary phrases.
+     */
+    async getDictionary(pageOptions, fetchOptions) {
+        const locale = (pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.locale) || this.initOptions.defaultLanguage;
+        const site = (pageOptions === null || pageOptions === void 0 ? void 0 : pageOptions.site) || this.initOptions.defaultSite;
+        return await this.dictionaryService.fetchDictionaryData(locale, site, fetchOptions);
+    }
+    /**
+     * 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 (like retries and fetch)
+     * @returns {ErrorPages | null} A promise that resolves to the error pages or null if not found.
+     */
+    async getErrorPages(routeOptions, fetchOptions) {
+        const locale = (routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.locale) || this.initOptions.defaultLanguage;
+        const site = (routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.site) || this.initOptions.defaultSite;
+        return await this.errorPagesService.fetchErrorPages(site, locale, fetchOptions);
+    }
+    /**
+     * 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 (like retries and fetch)
+     * @returns {Page} preview page details
+     */
+    async getPreview(previewData, fetchOptions) {
+        if (!previewData) {
+            console.error('Preview data missing');
+            return null;
+        }
+        // If we're in Pages preview (editing) mode, prefetch the editing data
+        const { site, itemId, language, version, variantIds, layoutKind, } = previewData;
+        const data = await this.editingService.fetchEditingData({
+            siteName: site,
+            itemId,
+            language,
+            version,
+            layoutKind,
+        }, fetchOptions);
+        if (!data) {
+            throw new Error(`Unable to fetch editing data for preview ${JSON.stringify(previewData)}`);
+        }
+        const page = {
+            locale: language,
+            layout: data.layoutData,
+            headLinks: this.getHeadLinks(data.layoutData),
+            dictionary: data.dictionary,
+            site: data.layoutData.sitecore.context.site,
+        };
+        const personalizeData = (0, utils_1.getGroomedVariantIds)(variantIds);
+        (0, layout_personalizer_1.personalizeLayout)(page.layout, personalizeData.variantId, personalizeData.componentVariantIds);
+        return page;
+    }
+    /**
+     * Get component library page details for Component Library mode of your app
+     * @param {ComponentLibraryRenderPreviewData} componentLibData preview data set in 'library' mode of the app
+     * @param {FetchOptions} [fetchOptions] Additional fetch fetch options to override GraphQL requests (like retries and fetch)
+     * @returns {Page} preview page for Component Library
+     */
+    async getComponentLibraryData(componentLibData, fetchOptions) {
+        if (!this.initOptions.api.local) {
+            throw new Error('Component Library requires Sitecore apiHost and apiKey to be provided');
+        }
+        const { itemId, componentUid, site, language, renderingId, dataSourceId, version, } = componentLibData;
+        const componentData = await this.componentService.fetchComponentData({
+            siteName: site,
+            itemId,
+            language,
+            componentUid,
+            renderingId,
+            dataSourceId,
+            version,
+        });
+        const dictionaryData = await this.editingService.fetchDictionaryData({
+            siteName: site,
+            language,
+        }, fetchOptions);
+        if (!componentData) {
+            throw new Error(`Unable to fetch editing data for preview ${JSON.stringify(componentLibData)}`);
+        }
+        const page = {
+            locale: componentLibData.language,
+            layout: componentData,
+            headLinks: this.getHeadLinks(componentData),
+            dictionary: dictionaryData,
+        };
+        return page;
+    }
+    /**
+     * Retrieves the static paths for pages based on the given languages.
+     * @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.
+     */
+    async getPagePaths(languages, fetchOptions) {
+        return this.sitePathService.fetchSiteRoutes(languages || [], fetchOptions);
+    }
+    /**
+     * Factory methods for creating dependencies
+     * Subclasses can override these to provide custom implementations.
+     */
+    getBaseServiceOptions() {
+        return {
+            defaultSite: this.initOptions.defaultSite,
+            clientFactory: this.clientFactory,
+            retries: this.initOptions.retries,
+        };
+    }
+    getClientFactory() {
+        const graphQLOptions = {
+            api: this.initOptions.api,
+            retries: this.initOptions.retries.count,
+            retryStrategy: this.initOptions.retries.retryStrategy,
+        };
+        return (0, utils_2.createGraphQLClientFactory)(graphQLOptions);
+    }
+    getSiteResolver() {
+        return new site_1.SiteResolver(this.initOptions.sites);
+    }
+    getLayoutService(baseOptions) {
+        return new layout_1.GraphQLLayoutService(Object.assign(Object.assign({}, baseOptions), { formatLayoutQuery: this.initOptions.layout.formatLayoutQuery }));
+    }
+    getDictionaryService(baseOptions) {
+        return new i18n_1.GraphQLDictionaryService(Object.assign(Object.assign({}, baseOptions), { cacheEnabled: this.initOptions.dictionary.caching.enabled, cacheTimeout: this.initOptions.dictionary.caching.timeout }));
+    }
+    getEditingService() {
+        return new editing_1.GraphQLEditingService({ clientFactory: this.clientFactory });
+    }
+    getErrorPagesService() {
+        return new site_1.GraphQLErrorPagesService(Object.assign(Object.assign({}, this.initOptions), { language: this.initOptions.defaultLanguage, clientFactory: this.clientFactory }));
+    }
+    getComponentService() {
+        var _a, _b;
+        return new editing_1.RestComponentLayoutService({
+            apiHost: (_a = this.initOptions.api.local) === null || _a === void 0 ? void 0 : _a.apiHost,
+            apiKey: (_b = this.initOptions.api.local) === null || _b === void 0 ? void 0 : _b.apiKey,
+            siteName: this.initOptions.defaultSite,
+        });
+    }
+    getSitePathService() {
+        return new site_1.GraphQLSitePathService({
+            clientFactory: this.clientFactory,
+            sites: this.siteResolver.sites,
+        });
+    }
+}
+exports.SitecoreClient = SitecoreClient;

package/dist/cjs/client/utils.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGraphQLClientFactory = void 0;
+const graphql_request_client_1 = require("../graphql-request-client");
+const graphql_edge_proxy_1 = require("./graphql-edge-proxy");
+/**
+ * Creates a new GraphQLRequestClientFactory instance
+ * @param {FetchOptions} options jss config
+ * @returns GraphQLRequestClientFactory instance
+ */
+const createGraphQLClientFactory = (options) => {
+    var _a, _b, _c, _d, _e, _f;
+    let clientConfig;
+    if ((_b = (_a = options.api) === null || _a === void 0 ? void 0 : _a.edge) === null || _b === void 0 ? void 0 : _b.contextId) {
+        clientConfig = {
+            endpoint: (0, graphql_edge_proxy_1.getEdgeProxyContentUrl)(options.api.edge.contextId, options.api.edge.edgeUrl),
+        };
+    }
+    else if (((_d = (_c = options.api) === null || _c === void 0 ? void 0 : _c.local) === null || _d === void 0 ? void 0 : _d.apiKey) && ((_f = (_e = options.api) === null || _e === void 0 ? void 0 : _e.local) === null || _f === void 0 ? void 0 : _f.apiHost)) {
+        clientConfig = {
+            endpoint: `${options.api.local.apiHost}${options.api.local.path}`,
+            apiKey: options.api.local.apiKey,
+        };
+    }
+    else {
+        throw new Error('Please configure and use either your sitecoreEdgeContextId, or your graphQLEndpoint and sitecoreApiKey.');
+    }
+    return graphql_request_client_1.GraphQLRequestClient.createClientFactory(Object.assign(Object.assign({}, clientConfig), options));
+};
+exports.createGraphQLClientFactory = createGraphQLClientFactory;

package/dist/cjs/editing/graphql-editing-service.js

@@ -89,9 +89,10 @@ class GraphQLEditingService {
      * @param {string} variables.language - The language to fetch layout data for.
      * @param {string} [variables.version] - The version of the item (optional).
      * @param {LayoutKind} [variables.layoutKind] - The final or shared layout variant.
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
      * @returns {Promise} The layout data and dictionary phrases.
      */
-    async fetchEditingData({ siteName, itemId, language, version, layoutKind = models_1.LayoutKind.Final, }) {
+    async fetchEditingData({ siteName, itemId, language, version, layoutKind = models_1.LayoutKind.Final }, fetchOptions) {
         var _a, _b, _c;
         debug_1.default.editing('fetching editing data for %s %s %s %s', siteName, itemId, language, version, layoutKind);
         if (!siteName) {
@@ -100,7 +101,7 @@ class GraphQLEditingService {
         if (!language) {
             throw new RangeError('The language must be a non-empty string');
         }
-        let dictionaryResults = [];
+        let initDictionary = [];
         let hasNext = true;
         let after = '';
         const editingData = await this.graphQLClient.request(exports.query, {
@@ -108,20 +109,24 @@ class GraphQLEditingService {
             itemId,
             version,
             language,
-        }, {
-            headers: {
+        }, Object.assign(Object.assign({}, fetchOptions), { headers: {
                 sc_layoutKind: layoutKind,
-            },
-        });
+            } }));
         if ((_b = (_a = editingData === null || editingData === void 0 ? void 0 : editingData.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.dictionary) {
-            dictionaryResults = editingData.site.siteInfo.dictionary.results;
+            initDictionary = editingData.site.siteInfo.dictionary.results;
             hasNext = editingData.site.siteInfo.dictionary.pageInfo.hasNext;
             after = editingData.site.siteInfo.dictionary.pageInfo.endCursor;
         }
         else {
             hasNext = false;
         }
-        const dictionary = await this.fetchDictionaryData({ siteName, language }, dictionaryResults, hasNext, after);
+        const dictionary = await this.fetchDictionaryData({
+            siteName,
+            language,
+            initDictionary,
+            hasNext,
+            after,
+        }, fetchOptions);
         return {
             layoutData: ((_c = editingData === null || editingData === void 0 ? void 0 : editingData.item) === null || _c === void 0 ? void 0 : _c.rendered) || {
                 sitecore: {
@@ -132,16 +137,17 @@ class GraphQLEditingService {
             dictionary,
         };
     }
-    async fetchDictionaryData({ siteName, language, }, initDictionary = [], hasNext = true, after) {
+    async fetchDictionaryData({ siteName, language, initDictionary, hasNext, after, }, fetchOptions) {
         var _a, _b;
-        let dictionaryResults = initDictionary;
+        hasNext = hasNext !== undefined ? hasNext : true;
+        let dictionaryResults = initDictionary || [];
         const dictionary = {};
         while (hasNext) {
             const data = await this.graphQLClient.request(exports.dictionaryQuery, {
                 siteName,
                 language,
                 after,
-            });
+            }, fetchOptions);
             if ((_b = (_a = data === null || data === void 0 ? void 0 : data.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.dictionary) {
                 dictionaryResults = dictionaryResults.concat(data.site.siteInfo.dictionary.results);
                 hasNext = data.site.siteInfo.dictionary.pageInfo.hasNext;

package/dist/cjs/graphql-request-client.js

@@ -55,15 +55,17 @@ class GraphQLRequestClient {
     /**
      * Execute graphql request
      * @param {string | DocumentNode} query graphql query
-     * @param {object} [variables] graphql variables
      * @param {RequestOptions} [options] Options for configuring a GraphQL request.
      */
     async request(query, variables, options) {
         let attempt = 1;
         const retryer = async () => {
+            const retries = (options === null || options === void 0 ? void 0 : options.retries) || this.retries;
+            const retryStrategy = (options === null || options === void 0 ? void 0 : options.retryStrategy) || this.retryStrategy;
+            const debug = (options === null || options === void 0 ? void 0 : options.debugger) || this.debug;
             // Note we don't have access to raw request/response with graphql-request
             // but we should log whatever we have.
-            this.debug('request: %o', {
+            debug('request: %o', {
                 url: this.endpoint,
                 headers: Object.assign(Object.assign({}, this.headers), options === null || options === void 0 ? void 0 : options.headers),
                 query,
@@ -84,12 +86,12 @@ class GraphQLRequestClient {
             }, async (error) => {
                 var _a, _b;
                 (_a = this.abortTimeout) === null || _a === void 0 ? void 0 : _a.clear();
-                this.debug('response error: %o', error.response || error.message || error);
+                debug('response error: %o', error.response || error.message || error);
                 const status = ((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) || error.code;
-                const shouldRetry = this.retryStrategy.shouldRetry(error, attempt, this.retries);
+                const shouldRetry = retryStrategy.shouldRetry(error, attempt, retries);
                 if (shouldRetry) {
-                    const delayMs = this.retryStrategy.getDelay(error, attempt);
-                    this.debug('Error: %s. Retrying in %dms (attempt %d).', status, delayMs, attempt);
+                    const delayMs = retryStrategy.getDelay(error, attempt);
+                    debug('Error: %s. Retrying in %dms (attempt %d).', status, delayMs, attempt);
                     attempt++;
                     return new Promise((resolve) => setTimeout(resolve, delayMs)).then(retryer);
                 }

package/dist/cjs/i18n/graphql-dictionary-service.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GraphQLDictionaryService = exports.queryError = void 0;
 const cache_client_1 = require("../cache-client");
-const app_root_query_1 = require("../graphql/app-root-query");
+const constants_1 = require("../client/constants");
 const debug_1 = __importDefault(require("../debug"));
 /** @private */
 exports.queryError = 'Valid value for rootItemId not provided and failed to auto-resolve app root item.';
@@ -51,46 +51,37 @@ class GraphQLDictionaryService {
     /**
      * Fetches dictionary data for internalization. Uses search query by default
      * @param {string} language the language to fetch
+     * @param {string} site site name to fetch data for.
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
      * @returns {Promise<DictionaryPhrases>} dictionary phrases
      * @throws {Error} if the app root was not found for the specified site and language.
      */
-    async fetchDictionaryData(language) {
-        const cacheKey = this.options.siteName + language;
+    async fetchDictionaryData(language, site, fetchOptions) {
+        var _a, _b;
+        const cacheKey = site + language;
         const cachedValue = this.getCacheValue(cacheKey);
         if (cachedValue) {
-            debug_1.default.dictionary('using cached dictionary data for %s %s', language, this.options.siteName);
+            debug_1.default.dictionary('using cached dictionary data for %s %s', language, site);
             return cachedValue;
         }
-        const phrases = await this.fetchWithSiteQuery(language);
-        this.setCacheValue(cacheKey, phrases);
-        return phrases;
-    }
-    /**
-     * Fetches dictionary data with site query
-     * This is the default behavior for XMCloud deployments. Uses `siteQuery` to retrieve data.
-     * @param {string} language the language to fetch
-     * @returns {Promise<DictionaryPhrases>} dictionary phrases
-     */
-    async fetchWithSiteQuery(language) {
-        var _a, _b;
         const phrases = {};
-        debug_1.default.dictionary('fetching dictionary data for %s %s', language, this.options.siteName);
+        debug_1.default.dictionary('fetching dictionary data for %s %s', language, site);
         let results = [];
         let hasNext = true;
         let after = '';
-        if (!this.options.siteName) {
-            throw new RangeError(app_root_query_1.siteNameError);
+        if (!site) {
+            throw new RangeError(constants_1.siteNameError);
         }
         if (!language) {
-            throw new RangeError(app_root_query_1.languageError);
+            throw new RangeError(constants_1.languageError);
         }
         while (hasNext) {
             const fetchResponse = await this.graphQLClient.request(siteQuery, {
-                siteName: this.options.siteName,
+                siteName: site,
                 language,
                 pageSize: this.options.pageSize,
                 after,
-            });
+            }, fetchOptions);
             if ((_b = (_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.dictionary) {
                 results = results.concat(fetchResponse.site.siteInfo.dictionary.results);
                 after = fetchResponse.site.siteInfo.dictionary.pageInfo.endCursor;
@@ -101,6 +92,7 @@ class GraphQLDictionaryService {
             }
         }
         results.forEach((item) => (phrases[item.key] = item.value));
+        this.setCacheValue(cacheKey, phrases);
         return phrases;
     }
     /**
@@ -137,13 +129,14 @@ class GraphQLDictionaryService {
      * @returns {GraphQLClient} implementation
      */
     getGraphQLClient() {
+        var _a, _b;
         if (!this.options.clientFactory) {
             throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
         }
         return this.options.clientFactory({
             debugger: debug_1.default.dictionary,
-            retries: this.options.retries,
-            retryStrategy: this.options.retryStrategy,
+            retries: (_a = this.options.retries) === null || _a === void 0 ? void 0 : _a.count,
+            retryStrategy: (_b = this.options.retries) === null || _b === void 0 ? void 0 : _b.retryStrategy,
         });
     }
 }

package/dist/cjs/layout/graphql-layout-service.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GraphQLLayoutService = exports.GRAPHQL_LAYOUT_QUERY_NAME = void 0;
-const layout_service_1 = require("./layout-service");
 const debug_1 = __importDefault(require("../debug"));
+const layout_service_1 = require("./layout-service");
 exports.GRAPHQL_LAYOUT_QUERY_NAME = 'JssLayoutQuery';
 /**
  * Service that fetch layout data using Sitecore's GraphQL API.
@@ -18,51 +18,39 @@ class GraphQLLayoutService extends layout_service_1.LayoutServiceBase {
      * @param {GraphQLLayoutServiceConfig} serviceConfig configuration
      */
     constructor(serviceConfig) {
-        super();
+        super(serviceConfig);
         this.serviceConfig = serviceConfig;
-        this.graphQLClient = this.getGraphQLClient();
     }
     /**
      * Fetch layout data for an item.
      * @param {string} itemPath item path to fetch layout data for.
-     * @param {string} [language] the language to fetch layout data for.
+     * @param {RouteOptions} [routeOptions] Request options like language and site to retrieve data for
+     * @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
      * @returns {Promise<LayoutServiceData>} layout service data
      */
-    async fetchLayoutData(itemPath, language) {
+    async fetchLayoutData(itemPath, routeOptions, fetchOptions) {
         var _a, _b;
-        const query = this.getLayoutQuery(itemPath, language);
-        debug_1.default.layout('fetching layout data for %s %s %s', itemPath, language, this.serviceConfig.siteName);
-        const data = await this.graphQLClient.request(query);
+        const site = routeOptions.site;
+        const query = this.getLayoutQuery(itemPath, site, routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.locale);
+        debug_1.default.layout('fetching layout data for %s %s %s', itemPath, routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.locale, site);
+        const data = await this.graphQLClient.request(query, {}, fetchOptions);
         // If `rendered` is empty -> not found
         return (((_b = (_a = data === null || data === void 0 ? void 0 : data.layout) === null || _a === void 0 ? void 0 : _a.item) === null || _b === void 0 ? void 0 : _b.rendered) || {
-            sitecore: { context: { pageEditing: false, language }, route: null },
-        });
-    }
-    /**
-     * Gets a GraphQL client that can make requests to the API.
-     * @returns {GraphQLClient} implementation
-     */
-    getGraphQLClient() {
-        if (!this.serviceConfig.clientFactory) {
-            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
-        }
-        return this.serviceConfig.clientFactory({
-            debugger: debug_1.default.layout,
-            retries: this.serviceConfig.retries,
-            retryStrategy: this.serviceConfig.retryStrategy,
+            sitecore: { context: { pageEditing: false, language: routeOptions === null || routeOptions === void 0 ? void 0 : routeOptions.locale }, route: null },
         });
     }
     /**
      * Returns GraphQL Layout query
      * @param {string} itemPath page route
+     * @param {string} [site] site name
      * @param {string} [language] language
      * @returns {string} GraphQL query
      */
-    getLayoutQuery(itemPath, language) {
+    getLayoutQuery(itemPath, site, language) {
         const languageVariable = language ? `, language:"${language}"` : '';
         const layoutQuery = this.serviceConfig.formatLayoutQuery
-            ? this.serviceConfig.formatLayoutQuery(this.serviceConfig.siteName, itemPath, language)
-            : `layout(site:"${this.serviceConfig.siteName}", routePath:"${itemPath}"${languageVariable})`;
+            ? this.serviceConfig.formatLayoutQuery(site, itemPath, language)
+            : `layout(site:"${site}", routePath:"${itemPath}"${languageVariable})`;
         return `query ${exports.GRAPHQL_LAYOUT_QUERY_NAME} {
       ${layoutQuery}{
         item {

package/dist/cjs/layout/layout-service.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LayoutServiceBase = void 0;
+const sitecore_service_base_1 = require("../sitecore-service-base");
 /**
  * Base abstraction to implement custom layout service
  */
-class LayoutServiceBase {
+class LayoutServiceBase extends sitecore_service_base_1.SitecoreServiceBase {
 }
 exports.LayoutServiceBase = LayoutServiceBase;

package/dist/cjs/personalize/graphql-personalize-service.js

@@ -42,6 +42,8 @@ class GraphQLPersonalizeService {
      */
     async getPersonalizeInfo(itemPath, language, siteName) {
         var _a;
+        // while other graphql services can use fetchOptions, personalize is more sensitive
+        // we don't allow retries in it since we need to be fast
         debug_1.default.personalize('fetching personalize info for %s %s %s', siteName, itemPath, language);
         const cacheKey = this.getCacheKey(itemPath, language, siteName);
         let data = this.cache.getCacheValue(cacheKey);

package/dist/cjs/personalize/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_VARIANT = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getGroomedVariantIds = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.GraphQLPersonalizeService = exports.personalizeLayout = void 0;
+exports.VARIANT_PREFIX = exports.DEFAULT_VARIANT = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getGroomedVariantIds = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.GraphQLPersonalizeService = exports.personalizeLayout = void 0;
 var layout_personalizer_1 = require("./layout-personalizer");
 Object.defineProperty(exports, "personalizeLayout", { enumerable: true, get: function () { return layout_personalizer_1.personalizeLayout; } });
 var graphql_personalize_service_1 = require("./graphql-personalize-service");
@@ -12,3 +12,4 @@ Object.defineProperty(exports, "getGroomedVariantIds", { enumerable: true, get:
 Object.defineProperty(exports, "normalizePersonalizedRewrite", { enumerable: true, get: function () { return utils_1.normalizePersonalizedRewrite; } });
 Object.defineProperty(exports, "CdpHelper", { enumerable: true, get: function () { return utils_1.CdpHelper; } });
 Object.defineProperty(exports, "DEFAULT_VARIANT", { enumerable: true, get: function () { return utils_1.DEFAULT_VARIANT; } });
+Object.defineProperty(exports, "VARIANT_PREFIX", { enumerable: true, get: function () { return utils_1.VARIANT_PREFIX; } });