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

package/dist/cjs/site/sitepath-service.js

@@ -1,29 +1,29 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SitePathService = exports.sitesError = exports.siteError = exports.languageError = void 0;
-exports.getSiteEmptyError = getSiteEmptyError;
-const debug_1 = __importDefault(require("../debug"));
-const personalize_1 = require("../personalize");
-const site_1 = require("../site");
-/** @private */
-exports.languageError = 'The list of languages cannot be empty';
-exports.siteError = 'The service needs a site name';
-exports.sitesError = 'The list of sites cannot be empty';
-/**
- * @param {string} siteName to inject into error text
- * @private
- */
-function getSiteEmptyError(siteName) {
-    return `Site "${siteName}" does not exist or site item tree is missing`;
-}
-/**
- * GQL query made dynamic based whether personalization is enabled or not
- * @param {boolean} usesPersonalize flag to detrmine which variation of a query to run
- * @returns GraphQL query to fetch site paths with
- */
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitePathService = exports.sitesError = exports.siteError = exports.languageError = void 0;
+exports.getSiteEmptyError = getSiteEmptyError;
+const debug_1 = __importDefault(require("../debug"));
+const personalize_1 = require("../personalize");
+const site_1 = require("../site");
+/** @private */
+exports.languageError = 'The list of languages cannot be empty';
+exports.siteError = 'The service needs a site name';
+exports.sitesError = 'The list of sites cannot be empty';
+/**
+ * @param {string} siteName to inject into error text
+ * @private
+ */
+function getSiteEmptyError(siteName) {
+    return `Site "${siteName}" does not exist or site item tree is missing`;
+}
+/**
+ * GQL query made dynamic based whether personalization is enabled or not
+ * @param {boolean} usesPersonalize flag to detrmine which variation of a query to run
+ * @returns GraphQL query to fetch site paths with
+ */
 const defaultQuery = (usesPersonalize) => /* GraphQL */ `
 query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
   $siteName: String!
@@ -49,152 +49,153 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
         }
         results {
           path: routePath
-          ${usesPersonalize
+          ${usesPersonalize
     ? `
               route {
                 personalization {
                   variantIds
                 }
-              }`
+              }`
     : ''}
         }
       }
     }
   }
 }
-`;
-/**
- * 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>
- */
-class SitePathService {
-    /**
-     * Creates an instance of graphQL sitemap service with the provided options
-     * @param {SitePathServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this._graphQLClient = this.getGraphQLClient();
-    }
-    /**
-     * GraphQL client accessible by descendant classes when needed
-     */
-    get graphQLClient() {
-        return this._graphQLClient;
-    }
-    /**
-     * Gets the default query used for fetching the list of site pages
-     */
-    get query() {
-        return defaultQuery(this.options.includePersonalizedRoutes);
-    }
-    /**
-     * 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.
-     */
-    async fetchSiteRoutes(sites, languages, fetchOptions) {
-        const formatPath = (path, locale) => ({
-            params: {
-                path,
-            },
-            locale,
-        });
-        const paths = new Array();
-        if (!languages.length) {
-            throw new RangeError(exports.languageError);
-        }
-        // Get all sites
-        if (!sites || !sites.length) {
-            throw new RangeError(exports.sitesError);
-        }
-        // Fetch paths for each site
-        for (let i = 0; i < sites.length; i++) {
-            for (const language of languages) {
-                // Fetch paths using all locales
-                const sitePaths = await this.fetchLanguageSitePaths(language, sites[i], fetchOptions);
-                const transformedPaths = await this.transformLanguageSitePaths(sitePaths, formatPath, language);
-                paths.push(...transformedPaths);
-            }
-        }
-        return [].concat(...paths);
-    }
-    async transformLanguageSitePaths(sitePaths, formatStaticPath, language) {
-        const toSegments = (p) => decodeURI(p)
-            .replace(/^\/|\/$/g, '')
-            .split('/');
-        const aggregatedPaths = [];
-        sitePaths.forEach((item) => {
-            var _a, _b, _c;
-            if (!item)
-                return;
-            aggregatedPaths.push(formatStaticPath(toSegments(item.path), language));
-            const variantIds = (_c = (_b = (_a = item.route) === null || _a === void 0 ? void 0 : _a.personalization) === null || _b === void 0 ? void 0 : _b.variantIds) === null || _c === void 0 ? void 0 : _c.filter((variantId) => !variantId.includes('_') // exclude component A/B test
-            );
-            if (variantIds === null || variantIds === void 0 ? void 0 : variantIds.length) {
-                aggregatedPaths.push(...variantIds.map((varId) => formatStaticPath(toSegments((0, personalize_1.getPersonalizedRewrite)(item.path, [varId])), language)));
-            }
-        });
-        return aggregatedPaths;
-    }
-    /**
-     * 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
-     */
-    getGraphQLClient() {
-        if (!this.options.clientFactory) {
-            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
-        }
-        return this.options.clientFactory({
-            debugger: debug_1.default.sitemap,
-        });
-    }
-    /**
-     * 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
-     */
-    async fetchLanguageSitePaths(language, siteName, fetchOptions) {
-        var _a, _b, _c, _d;
-        const args = {
-            siteName: siteName,
-            language: language,
-            pageSize: this.options.pageSize,
-            includedPaths: this.options.includedPaths,
-            excludedPaths: this.options.excludedPaths,
-        };
-        let results = [];
-        let hasNext = true;
-        let after = '';
-        debug_1.default.sitemap('fetching sitemap data for %s %s', language, siteName);
-        while (hasNext) {
-            const fetchResponse = await this.graphQLClient.request(this.query, Object.assign(Object.assign({}, args), { after }), fetchOptions);
-            if (!((_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.site) === null || _a === void 0 ? void 0 : _a.siteInfo)) {
-                throw new RangeError(getSiteEmptyError(siteName));
-            }
-            else {
-                results = results.concat((_b = fetchResponse.site.siteInfo.routes) === null || _b === void 0 ? void 0 : _b.results);
-                hasNext = (_c = fetchResponse.site.siteInfo.routes) === null || _c === void 0 ? void 0 : _c.pageInfo.hasNext;
-                after = (_d = fetchResponse.site.siteInfo.routes) === null || _d === void 0 ? void 0 : _d.pageInfo.endCursor;
-            }
-        }
-        results.forEach((item) => {
-            if (item) {
-                item.path = (0, site_1.getSiteRewrite)(item.path, { siteName: siteName });
-            }
-        });
-        return results;
-    }
-}
-exports.SitePathService = SitePathService;
+`;
+/**
+ * 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
+ */
+class SitePathService {
+    /**
+     * Creates an instance of graphQL sitemap service with the provided options
+     * @param {SitePathServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this._graphQLClient = this.getGraphQLClient();
+    }
+    /**
+     * GraphQL client accessible by descendant classes when needed
+     */
+    get graphQLClient() {
+        return this._graphQLClient;
+    }
+    /**
+     * Gets the default query used for fetching the list of site pages
+     */
+    get query() {
+        return defaultQuery(this.options.includePersonalizedRoutes);
+    }
+    /**
+     * 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.
+     */
+    async fetchSiteRoutes(sites, languages, fetchOptions) {
+        const formatPath = (path, locale) => ({
+            params: {
+                path,
+            },
+            locale,
+        });
+        const paths = new Array();
+        if (!languages.length) {
+            throw new RangeError(exports.languageError);
+        }
+        // Get all sites
+        if (!sites || !sites.length) {
+            throw new RangeError(exports.sitesError);
+        }
+        // Fetch paths for each site
+        for (let i = 0; i < sites.length; i++) {
+            for (const language of languages) {
+                // Fetch paths using all locales
+                const sitePaths = await this.fetchLanguageSitePaths(language, sites[i], fetchOptions);
+                const transformedPaths = await this.transformLanguageSitePaths(sitePaths, formatPath, language);
+                paths.push(...transformedPaths);
+            }
+        }
+        return [].concat(...paths);
+    }
+    async transformLanguageSitePaths(sitePaths, formatStaticPath, language) {
+        const toSegments = (p) => decodeURI(p)
+            .replace(/^\/|\/$/g, '')
+            .split('/');
+        const aggregatedPaths = [];
+        sitePaths.forEach((item) => {
+            var _a, _b, _c;
+            if (!item)
+                return;
+            aggregatedPaths.push(formatStaticPath(toSegments(item.path), language));
+            const variantIds = (_c = (_b = (_a = item.route) === null || _a === void 0 ? void 0 : _a.personalization) === null || _b === void 0 ? void 0 : _b.variantIds) === null || _c === void 0 ? void 0 : _c.filter((variantId) => !variantId.includes('_') // exclude component A/B test
+            );
+            if (variantIds === null || variantIds === void 0 ? void 0 : variantIds.length) {
+                aggregatedPaths.push(...variantIds.map((varId) => formatStaticPath(toSegments((0, personalize_1.getPersonalizedRewrite)(item.path, [varId])), language)));
+            }
+        });
+        return aggregatedPaths;
+    }
+    /**
+     * 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
+     */
+    getGraphQLClient() {
+        if (!this.options.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
+        }
+        return this.options.clientFactory({
+            debugger: debug_1.default.sitemap,
+        });
+    }
+    /**
+     * 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
+     */
+    async fetchLanguageSitePaths(language, siteName, fetchOptions) {
+        var _a, _b, _c, _d;
+        const args = {
+            siteName: siteName,
+            language: language,
+            pageSize: this.options.pageSize,
+            includedPaths: this.options.includedPaths,
+            excludedPaths: this.options.excludedPaths,
+        };
+        let results = [];
+        let hasNext = true;
+        let after = '';
+        debug_1.default.sitemap('fetching sitemap data for %s %s', language, siteName);
+        while (hasNext) {
+            const fetchResponse = await this.graphQLClient.request(this.query, Object.assign(Object.assign({}, args), { after }), fetchOptions);
+            if (!((_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.site) === null || _a === void 0 ? void 0 : _a.siteInfo)) {
+                throw new RangeError(getSiteEmptyError(siteName));
+            }
+            else {
+                results = results.concat((_b = fetchResponse.site.siteInfo.routes) === null || _b === void 0 ? void 0 : _b.results);
+                hasNext = (_c = fetchResponse.site.siteInfo.routes) === null || _c === void 0 ? void 0 : _c.pageInfo.hasNext;
+                after = (_d = fetchResponse.site.siteInfo.routes) === null || _d === void 0 ? void 0 : _d.pageInfo.endCursor;
+            }
+        }
+        results.forEach((item) => {
+            if (item) {
+                item.path = (0, site_1.getSiteRewrite)(item.path, { siteName: siteName });
+            }
+        });
+        return results;
+    }
+}
+exports.SitePathService = SitePathService;

package/dist/cjs/site/utils.js

@@ -1,47 +1,55 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SITE_KEY = exports.SITE_PREFIX = void 0;
-exports.getSiteRewrite = getSiteRewrite;
-exports.getSiteRewriteData = getSiteRewriteData;
-exports.normalizeSiteRewrite = normalizeSiteRewrite;
-exports.SITE_PREFIX = '_site_';
-/**
- * Site key for cookie and query string parameter access
- */
-exports.SITE_KEY = 'sc_site';
-/**
- * Get a site rewrite path for given pathname
- * @param {string} pathname the pathname
- * @param {SiteRewriteData} data the site data to include in the rewrite
- * @returns {string} the rewrite path
- */
-function getSiteRewrite(pathname, data) {
-    const path = pathname.startsWith('/') ? pathname : '/' + pathname;
-    return `/${exports.SITE_PREFIX}${data.siteName}${path}`;
-}
-/**
- * Get site data from the rewrite path
- * @param {string} pathname the pathname
- * @param {string} defaultSiteName the default site name
- * @returns {SiteRewriteData} the site data from the rewrite
- */
-function getSiteRewriteData(pathname, defaultSiteName) {
-    const data = {
-        siteName: defaultSiteName,
-    };
-    const path = pathname.endsWith('/') ? pathname : pathname + '/';
-    const result = path.match(`${exports.SITE_PREFIX}(.*?)\\/`);
-    if (result && result[1] !== '') {
-        data.siteName = result[1];
-    }
-    return data;
-}
-/**
- * Normalize a site rewrite path (remove site data)
- * @param {string} pathname the pathname
- * @returns {string} the pathname with site data removed
- */
-function normalizeSiteRewrite(pathname) {
-    const result = pathname.match(`${exports.SITE_PREFIX}.*?(?:\\/|$)`);
-    return result === null ? pathname : pathname.replace(result[0], '');
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SITE_KEY = exports.SITE_PREFIX = void 0;
+exports.getSiteRewrite = getSiteRewrite;
+exports.getSiteRewriteData = getSiteRewriteData;
+exports.normalizeSiteRewrite = normalizeSiteRewrite;
+/**
+ * Site prefix for rewrite path
+ * @public
+ */
+exports.SITE_PREFIX = '_site_';
+/**
+ * Site key for cookie and query string parameter access
+ * @public
+ */
+exports.SITE_KEY = 'sc_site';
+/**
+ * Get a site rewrite path for given pathname
+ * @param {string} pathname the pathname
+ * @param {SiteRewriteData} data the site data to include in the rewrite
+ * @returns {string} the rewrite path
+ * @public
+ */
+function getSiteRewrite(pathname, data) {
+    const path = pathname.startsWith('/') ? pathname : '/' + pathname;
+    return `/${exports.SITE_PREFIX}${data.siteName}${path}`;
+}
+/**
+ * Get site data from the rewrite path
+ * @param {string} pathname the pathname
+ * @param {string} defaultSiteName the default site name
+ * @returns {SiteRewriteData} the site data from the rewrite
+ * @public
+ */
+function getSiteRewriteData(pathname, defaultSiteName) {
+    const data = {
+        siteName: defaultSiteName,
+    };
+    const path = pathname.endsWith('/') ? pathname : pathname + '/';
+    const result = path.match(`${exports.SITE_PREFIX}(.*?)\\/`);
+    if (result && result[1] !== '') {
+        data.siteName = result[1];
+    }
+    return data;
+}
+/**
+ * Normalize a site rewrite path (remove site data)
+ * @param {string} pathname the pathname
+ * @returns {string} the pathname with site data removed
+ * @public
+ */
+function normalizeSiteRewrite(pathname) {
+    const result = pathname.match(`${exports.SITE_PREFIX}.*?(?:\\/|$)`);
+    return result === null ? pathname : pathname.replace(result[0], '');
+}

package/dist/cjs/sitecore-service-base.js

@@ -1,36 +1,36 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SitecoreServiceBase = void 0;
-const debug_1 = __importDefault(require("./debug"));
-/**
- * Base abstraction to implement custom layout service
- */
-class SitecoreServiceBase {
-    /**
-     * Fetch layout data using the Sitecore GraphQL endpoint.
-     * @param {GraphQLServiceConfig} serviceConfig configuration
-     */
-    constructor(serviceConfig) {
-        this.serviceConfig = serviceConfig;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    /**
-     * Gets a GraphQL client that can make requests to the API.
-     * @returns {GraphQLClient} implementation
-     */
-    getGraphQLClient() {
-        var _a, _b;
-        if (!this.serviceConfig.clientFactory) {
-            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
-        }
-        return this.serviceConfig.clientFactory({
-            debugger: this.serviceConfig.debugger || debug_1.default.http,
-            retries: (_a = this.serviceConfig.retries) === null || _a === void 0 ? void 0 : _a.count,
-            retryStrategy: (_b = this.serviceConfig.retries) === null || _b === void 0 ? void 0 : _b.retryStrategy,
-        });
-    }
-}
-exports.SitecoreServiceBase = SitecoreServiceBase;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitecoreServiceBase = void 0;
+const debug_1 = __importDefault(require("./debug"));
+/**
+ * Base abstraction to implement custom layout service
+ */
+class SitecoreServiceBase {
+    /**
+     * Fetch layout data using the Sitecore GraphQL endpoint.
+     * @param {GraphQLServiceConfig} serviceConfig configuration
+     */
+    constructor(serviceConfig) {
+        this.serviceConfig = serviceConfig;
+        this.graphQLClient = this.getGraphQLClient();
+    }
+    /**
+     * Gets a GraphQL client that can make requests to the API.
+     * @returns {GraphQLClient} implementation
+     */
+    getGraphQLClient() {
+        var _a, _b;
+        if (!this.serviceConfig.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
+        }
+        return this.serviceConfig.clientFactory({
+            debugger: this.serviceConfig.debugger || debug_1.default.http,
+            retries: (_a = this.serviceConfig.retries) === null || _a === void 0 ? void 0 : _a.count,
+            retryStrategy: (_b = this.serviceConfig.retries) === null || _b === void 0 ? void 0 : _b.retryStrategy,
+        });
+    }
+}
+exports.SitecoreServiceBase = SitecoreServiceBase;