@sitecore-content-sdk/core 1.5.0 → 2.0.0-canary.10

package/dist/esm/personalize/utils.js

@@ -1,135 +0,0 @@
-/** @internal */
-export const DEFAULT_VARIANT = '_default';
-/** @internal */
-export const VARIANT_PREFIX = '_variantId_';
-/**
- * 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 function getPersonalizedRewrite(pathname, variantIds) {
-    const path = pathname.endsWith('/') ? pathname.slice(0, -1) : pathname;
-    return `${path}${variantIds.map((variantId) => `/${VARIANT_PREFIX}${variantId}`).join('')}`;
-}
-/**
- * Get personalize data from the rewrite path
- * @param {string} pathname the pathname
- * @returns {PersonalizedRewriteData} the personalize data from the rewrite
- * @public
- */
-export function getPersonalizedRewriteData(pathname) {
-    const segments = pathname.split('/');
-    const variantIds = [];
-    segments.forEach((segment) => {
-        const result = segment.match(`${VARIANT_PREFIX}(.*$)`);
-        if (result) {
-            variantIds.push(result[1]);
-        }
-    });
-    return getGroomedVariantIds(variantIds);
-}
-/**
- * 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 function getGroomedVariantIds(variantIds) {
-    const data = {
-        variantId: DEFAULT_VARIANT,
-        componentVariantIds: [],
-    };
-    variantIds.forEach((variantId) => {
-        var _a;
-        if (variantId.includes('_')) {
-            // Component-level personalization in format "<ComponentID>_<VariantID>"
-            // There can be multiple
-            (_a = data.componentVariantIds) === null || _a === void 0 ? void 0 : _a.push(variantId);
-        }
-        else {
-            // Embedded (page-level) personalization in format "<VariantID>"
-            // There should be only one
-            data.variantId = variantId;
-        }
-    });
-    return data;
-}
-/**
- * Normalize a personalized rewrite path (remove personalize data)
- * @param {string} pathname the pathname
- * @returns {string} the pathname with personalize data removed
- * @public
- */
-export function normalizePersonalizedRewrite(pathname) {
-    if (!pathname.includes(VARIANT_PREFIX)) {
-        return pathname;
-    }
-    let segments = pathname.split('/');
-    segments = segments.filter((segment) => !segment.includes(VARIANT_PREFIX));
-    const result = segments.join('/');
-    // return root path if all segments were personalize data
-    return result ? result : '/';
-}
-/**
- * Static utility class for Sitecore CDP
- * @public
- */
-export 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, language, variantId, scope) {
-        const formattedPageId = pageId.replace(/[{}-]/g, '');
-        const formattedLanguage = language.replace('-', '_');
-        const scopeId = scope ? `${this.normalizeScope(scope)}_` : '';
-        let formattedVariantId = variantId;
-        if (!variantId || variantId === DEFAULT_VARIANT) {
-            formattedVariantId = 'default';
-        }
-        return `${scopeId}${formattedPageId}_${formattedLanguage}_${formattedVariantId}`.toLowerCase();
-    }
-    /**
-     * 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, language, scope) {
-        const formattedPageId = pageId.replace(/[{}-]/g, '');
-        const formattedLanguage = language.replace('-', '_');
-        const scopeId = scope ? `${this.normalizeScope(scope)}_` : '';
-        return `embedded_${scopeId}${formattedPageId}_${formattedLanguage}`.toLowerCase();
-    }
-    /**
-     * 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, componentId, language, scope) {
-        const formattedPageId = pageId.replace(/[{}-]/g, '');
-        const formattedComponentId = componentId.replace(/[{}-]/g, '');
-        const formattedLanguage = language.replace('-', '_');
-        const scopeId = scope ? `${this.normalizeScope(scope)}_` : '';
-        return `component_${scopeId}${formattedPageId}_${formattedComponentId}_${formattedLanguage}*`.toLowerCase();
-    }
-    /**
-     * 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) {
-        return (scope === null || scope === void 0 ? void 0 : scope.replace(/[^a-zA-Z0-9]+/g, '')) || '';
-    }
-}

package/dist/esm/site/error-pages-service.js

@@ -1,75 +0,0 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-// The default query for request error handling
-const defaultQuery = /* GraphQL */ `
-  query ErrorPagesQuery($siteName: String!, $language: String!) {
-    site {
-      siteInfo(site: $siteName) {
-        errorHandling(language: $language) {
-          notFoundPage {
-            rendered
-          }
-          notFoundPagePath
-          serverErrorPage {
-            rendered
-          }
-          serverErrorPagePath
-        }
-      }
-    }
-  }
-`;
-/**
- * Service that fetch the error pages data using Sitecore's GraphQL API.
- * @public
- */
-export class ErrorPagesService {
-    /**
-     * Creates an instance of graphQL error pages service with the provided options
-     * @param {ErrorPagesServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * 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.
-     */
-    async fetchErrorPages(siteName, locale, fetchOptions) {
-        const language = locale || this.options.language;
-        if (!siteName) {
-            throw new Error(siteNameError);
-        }
-        return this.graphQLClient.request(this.query, {
-            siteName,
-            language,
-        }, fetchOptions)
-            .then((result) => result.site.siteInfo ? result.site.siteInfo.errorHandling : null)
-            .catch((e) => Promise.reject(e));
-    }
-    /**
-     * 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() {
-        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.errorpages,
-            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/esm/site/index.js

@@ -1,8 +0,0 @@
-export { RobotsService } from './robots-service';
-export { REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectsService, } from './redirects-service';
-export { SitemapXmlService, } from './sitemap-xml-service';
-export { ErrorPagesService } from './error-pages-service';
-export { SiteInfoService } from './siteinfo-service';
-export { SitePathService } from './sitepath-service';
-export { getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, SITE_PREFIX, SITE_KEY, } from './utils';
-export { SiteResolver } from './site-resolver';

package/dist/esm/site/models.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/site/redirects-service.js

@@ -1,101 +0,0 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-import { MemoryCacheClient } from '../cache-client';
-/**
- * Redirect type for 301 redirects
- * @public
- */
-export const REDIRECT_TYPE_301 = 'REDIRECT_301';
-/**
- * Redirect type for 302 redirects
- * @public
- */
-export const REDIRECT_TYPE_302 = 'REDIRECT_302';
-/**
- * Redirect type for server transfer
- * @public
- */
-export const REDIRECT_TYPE_SERVER_TRANSFER = 'SERVER_TRANSFER';
-// The default query for request redirects of site
-const defaultQuery = /* GraphQL */ `
-  query RedirectsQuery($siteName: String!) {
-    site {
-      siteInfo(site: $siteName) {
-        redirects {
-          pattern
-          target
-          redirectType
-          isQueryStringPreserved
-          locale
-        }
-      }
-    }
-  }
-`;
-/**
- * The RedirectsService class is used to query the Content SDK redirects using Graphql endpoint
- * @public
- */
-export class RedirectsService {
-    /**
-     * Creates an instance of graphQL redirects service with the provided options
-     * @param {RedirectsServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-        this.cache = this.getCacheClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * 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.
-     */
-    async fetchRedirects(siteName, fetchOptions) {
-        var _a, _b;
-        if (!siteName) {
-            throw new Error(siteNameError);
-        }
-        const cacheKey = `redirects-${siteName}`;
-        let data = this.cache.getCacheValue(cacheKey);
-        if (!data) {
-            data = await this.graphQLClient.request(this.query, {
-                siteName,
-            }, fetchOptions);
-            this.cache.setCacheValue(cacheKey, data);
-        }
-        return ((_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.redirects) || [];
-    }
-    /**
-     * 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.redirects,
-            fetch: this.options.fetch,
-        });
-    }
-    /**
-     * Gets cache client implementation
-     * Override this method if custom cache needs to be used
-     * @returns CacheClient instance
-     */
-    getCacheClient() {
-        var _a, _b;
-        return new MemoryCacheClient({
-            cacheEnabled: (_a = this.options.cacheEnabled) !== null && _a !== void 0 ? _a : true,
-            cacheTimeout: (_b = this.options.cacheTimeout) !== null && _b !== void 0 ? _b : 10,
-        });
-    }
-}

package/dist/esm/site/robots-service.js

@@ -1,67 +0,0 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-// The default query for request robots.txt
-const defaultQuery = /* GraphQL */ `
-  query RobotsQuery($siteName: String!) {
-    site {
-      siteInfo(site: $siteName) {
-        robots
-      }
-    }
-  }
-`;
-/**
- * Service that fetch the robots.txt data using Sitecore's GraphQL API.
- * @public
- */
-export class RobotsService {
-    /**
-     * Creates an instance of graphQL robots.txt service with the provided options
-     * @param {RobotsServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * 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.
-     */
-    async fetchRobots(fetchOptions) {
-        const siteName = this.options.siteName;
-        if (!siteName) {
-            throw new Error(siteNameError);
-        }
-        const robotsResult = this.graphQLClient.request(this.query, {
-            siteName,
-        }, fetchOptions);
-        try {
-            return robotsResult.then((result) => {
-                var _a, _b;
-                return (_b = (_a = result === null || result === void 0 ? void 0 : result.site) === null || _a === void 0 ? void 0 : _a.siteInfo) === null || _b === void 0 ? void 0 : _b.robots;
-            });
-        }
-        catch (e) {
-            return Promise.reject(e);
-        }
-    }
-    /**
-     * 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.robots,
-        });
-    }
-}

package/dist/esm/site/site-resolver.js

@@ -1,69 +0,0 @@
-// Delimiters for multi-value hostnames
-const DELIMITERS = /\||,|;/g;
-/**
- * Resolves site based on the provided host or site name
- * @public
- */
-export class SiteResolver {
-    /**
-     * @param {SiteInfo[]} sites Array of sites to be used in resolution
-     */
-    constructor(sites) {
-        this.sites = sites;
-        /**
-         * 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
-         */
-        this.getByHost = (hostName) => {
-            for (const [hostname, site] of this.getHostMap()) {
-                if (this.matchesPattern(hostName, hostname)) {
-                    return site;
-                }
-            }
-            throw new Error(`Could not resolve site for host ${hostName}`);
-        };
-        /**
-         * Resolve site by site name
-         * @param {string} siteName the site name
-         * @returns {SiteInfo} the resolved site or undefined if not found
-         */
-        this.getByName = (siteName) => {
-            const siteInfo = this.sites.find((info) => info.name.toLocaleLowerCase() === siteName.toLocaleLowerCase());
-            return siteInfo;
-        };
-        this.getHostMap = () => {
-            const map = new Map();
-            // First collect unique hostnames.
-            // For sites with same hostname defined, priority is given to the first encountered.
-            this.sites.forEach((site) => {
-                const hostnames = site.hostName.replace(/\s/g, '').toLocaleLowerCase().split(DELIMITERS);
-                hostnames.forEach((hostname) => {
-                    if (!map.has(hostname)) {
-                        map.set(hostname, site);
-                    }
-                });
-            });
-            // Now order by specificity.
-            // This equivalates to sorting from longest to shortest with the assumption
-            // that your match is less specific as wildcards are introduced.
-            // E.g. order.eu.site.com → *.eu.site.com → *.site.com → *
-            // In case of a tie (e.g. *.site.com vs i.site.com), prefer one with less wildcards.
-            return new Map(Array.from(map).sort((a, b) => {
-                if (a[0].length === b[0].length) {
-                    return (a[0].match(/\*/g) || []).length - (b[0].match(/\*/g) || []).length;
-                }
-                return b[0].length - a[0].length;
-            }));
-        };
-    }
-    // b[0].match(/\*/g) || []).length
-    matchesPattern(hostname, pattern) {
-        // dots should be treated as chars
-        // stars should be treated as wildcards
-        const regExpPattern = pattern.replace(/\./g, '\\.').replace(/\*/g, '.*');
-        const regExp = new RegExp(`^${regExpPattern}$`, 'gi');
-        return !!hostname.match(regExp);
-    }
-}

package/dist/esm/site/siteinfo-service.js

@@ -1,87 +0,0 @@
-import debug from '../debug';
-import { MemoryCacheClient } from '../cache-client';
-const siteQuery = /* GraphQL */ `
-  query {
-    site {
-      siteInfoCollection {
-        name
-        hostName: hostname
-        language
-      }
-    }
-  }
-`;
-/**
- * Service to fetch site information
- * @public
- */
-export class SiteInfoService {
-    /**
-     * Creates an instance of graphQL service to retrieve site configuration list from Sitecore
-     * @param {SiteInfoServiceConfig} config instance
-     */
-    constructor(config) {
-        this.config = config;
-        this.graphQLClient = this.getGraphQLClient();
-        this.cache = this.getCacheClient();
-    }
-    /**
-     * site query is available on XM Cloud and XP 10.4+
-     */
-    get siteQuery() {
-        return siteQuery;
-    }
-    async fetchSiteInfo(fetchOptions) {
-        var _a, _b;
-        const cachedResult = this.cache.getCacheValue(this.getCacheKey());
-        if (cachedResult) {
-            return cachedResult;
-        }
-        if (process.env.SITECORE) {
-            debug.multisite('Skipping site information fetch (building on XM Cloud)');
-            return [];
-        }
-        const response = await this.graphQLClient.request(this.siteQuery, {}, fetchOptions);
-        const results = (_b = (_a = response === null || response === void 0 ? void 0 : response.site) === null || _a === void 0 ? void 0 : _a.siteInfoCollection) === null || _b === void 0 ? void 0 : _b.reduce((result, current) => {
-            // filter out built in website
-            current.name !== 'website' &&
-                result.push({
-                    name: current.name,
-                    hostName: current.hostName,
-                    language: current.language,
-                });
-            return result;
-        }, []);
-        this.cache.setCacheValue(this.getCacheKey(), results);
-        return results;
-    }
-    /**
-     * Gets cache client implementation
-     * Override this method if custom cache needs to be used
-     * @returns CacheClient instance
-     */
-    getCacheClient() {
-        var _a, _b;
-        return new MemoryCacheClient({
-            cacheEnabled: (_a = this.config.cacheEnabled) !== null && _a !== void 0 ? _a : true,
-            cacheTimeout: (_b = this.config.cacheTimeout) !== null && _b !== void 0 ? _b : 10,
-        });
-    }
-    /**
-     * 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.config.clientFactory) {
-            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
-        }
-        return this.config.clientFactory({
-            debugger: debug.multisite,
-        });
-    }
-    getCacheKey() {
-        return 'siteinfo-service-cache';
-    }
-}

package/dist/esm/site/sitemap-xml-service.js

@@ -1,85 +0,0 @@
-import { siteNameError } from '../constants';
-import debug from '../debug';
-const PREFIX_NAME_SITEMAP = 'sitemap';
-// The default query for request sitemaps
-const defaultQuery = /* GraphQL */ `
-  query SitemapQuery($siteName: String!) {
-    site {
-      siteInfo(site: $siteName) {
-        sitemap
-      }
-    }
-  }
-`;
-/**
- * Service that fetch the sitemaps data using Sitecore's GraphQL API.
- * @public
- */
-export class SitemapXmlService {
-    /**
-     * Creates an instance of graphQL sitemaps service with the provided options
-     * @param {SitemapXmlServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    get query() {
-        return defaultQuery;
-    }
-    /**
-     * 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.
-     */
-    async fetchSitemaps(fetchOptions) {
-        const siteName = this.options.siteName;
-        if (!siteName) {
-            throw new Error(siteNameError);
-        }
-        const sitemapResult = this.graphQLClient.request(this.query, {
-            siteName,
-        }, fetchOptions);
-        try {
-            return sitemapResult.then((result) => result.site.siteInfo.sitemap);
-        }
-        catch (e) {
-            return Promise.reject(e);
-        }
-    }
-    /**
-     * 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
-     */
-    async getSitemap(id) {
-        let searchSitemap;
-        if (id === undefined) {
-            return undefined;
-        }
-        else if (id === '') {
-            searchSitemap = `${PREFIX_NAME_SITEMAP}.xml`;
-        }
-        else {
-            const normalizedId = id.startsWith('-') ? id.slice(1) : id;
-            searchSitemap = `${PREFIX_NAME_SITEMAP}-${normalizedId}.xml`;
-        }
-        const sitemaps = await this.fetchSitemaps();
-        return sitemaps.find((sitemap) => sitemap.includes(searchSitemap));
-    }
-    /**
-     * 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.sitemap,
-        });
-    }
-}