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

package/dist/esm/personalize/personalize-service.js

@@ -1,20 +1,24 @@
-import debug from '../debug';
-import { isTimeoutError } from '../utils';
-import { MemoryCacheClient } from '../cache-client';
-export class PersonalizeService {
-    /**
-     * Fetch personalize data using the Sitecore GraphQL endpoint.
-     * @param {PersonalizeServiceConfig} config
-     */
-    constructor(config) {
-        this.config = config;
-        this.config.timeout = config.timeout || 400;
-        this.graphQLClient = this.getGraphQLClient();
-        this.cache = this.getCacheClient();
-    }
-    get query() {
+import debug from '../debug';
+import { isTimeoutError } from '../utils';
+import { MemoryCacheClient } from '../cache-client';
+/**
+ * Fetch personalize data using the Sitecore GraphQL endpoint.
+ * @public
+ */
+export class PersonalizeService {
+    /**
+     * Fetch personalize data using the Sitecore GraphQL endpoint.
+     * @param {PersonalizeServiceConfig} config
+     */
+    constructor(config) {
+        this.config = config;
+        this.config.timeout = config.timeout || 400;
+        this.graphQLClient = this.getGraphQLClient();
+        this.cache = this.getCacheClient();
+    }
+    get query() {
         return /* GraphQL */ `
-      query($siteName: String!, $language: String!, $itemPath: String!) {
+      query ($siteName: String!, $language: String!, $itemPath: String!) {
         layout(site: $siteName, routePath: $itemPath, language: $language) {
           item {
             id
@@ -25,74 +29,74 @@ export class PersonalizeService {
           }
         }
       }
-    `;
-    }
-    /**
-     * Get personalize information for a route
-     * @param {string} itemPath page route
-     * @param {string} language language
-     * @param {string} siteName site name
-     * @returns {Promise<PersonalizeInfo | undefined>} the personalize information or undefined (if itemPath / language not found)
-     */
-    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.personalize('fetching personalize info for %s %s %s', siteName, itemPath, language);
-        const cacheKey = this.getCacheKey(itemPath, language, siteName);
-        let data = this.cache.getCacheValue(cacheKey);
-        if (!data) {
-            try {
-                data = await this.graphQLClient.request(this.query, {
-                    siteName,
-                    itemPath,
-                    language,
-                });
-                this.cache.setCacheValue(cacheKey, data);
-            }
-            catch (error) {
-                if (isTimeoutError(error)) {
-                    return undefined;
-                }
-                throw error;
-            }
-        }
-        return ((_a = data === null || data === void 0 ? void 0 : data.layout) === null || _a === void 0 ? void 0 : _a.item)
-            ? {
-                pageId: data.layout.item.id,
-                variantIds: data.layout.item.personalization.variantIds,
-            }
-            : undefined;
-    }
-    /**
-     * 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,
-        });
-    }
-    getCacheKey(itemPath, language, siteName) {
-        return `${siteName}-${itemPath}-${language}`;
-    }
-    /**
-     * 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.personalize,
-            fetch: this.config.fetch,
-            timeout: this.config.timeout,
-        });
-    }
-}
+    `;
+    }
+    /**
+     * Get personalize information for a route
+     * @param {string} itemPath page route
+     * @param {string} language language
+     * @param {string} siteName site name
+     * @returns {Promise<PersonalizeInfo | undefined>} the personalize information or undefined (if itemPath / language not found)
+     */
+    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.personalize('fetching personalize info for %s %s %s', siteName, itemPath, language);
+        const cacheKey = this.getCacheKey(itemPath, language, siteName);
+        let data = this.cache.getCacheValue(cacheKey);
+        if (!data) {
+            try {
+                data = await this.graphQLClient.request(this.query, {
+                    siteName,
+                    itemPath,
+                    language,
+                });
+                this.cache.setCacheValue(cacheKey, data);
+            }
+            catch (error) {
+                if (isTimeoutError(error)) {
+                    return undefined;
+                }
+                throw error;
+            }
+        }
+        return ((_a = data === null || data === void 0 ? void 0 : data.layout) === null || _a === void 0 ? void 0 : _a.item)
+            ? {
+                pageId: data.layout.item.id,
+                variantIds: data.layout.item.personalization.variantIds,
+            }
+            : undefined;
+    }
+    /**
+     * 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,
+        });
+    }
+    getCacheKey(itemPath, language, siteName) {
+        return `${siteName}-${itemPath}-${language}`;
+    }
+    /**
+     * 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.personalize,
+            fetch: this.config.fetch,
+            timeout: this.config.timeout,
+        });
+    }
+}

package/dist/esm/personalize/utils.js

@@ -1,128 +1,135 @@
-export const DEFAULT_VARIANT = '_default';
-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
- */
-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
- */
-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
- */
-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
- */
-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
- */
-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, '')) || '';
-    }
-}
+/** @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/retries.js

@@ -1,38 +1,39 @@
-/**
- * Represents a default retry strategy for handling retry attempts in case of specific HTTP status codes.
- * This class implements the RetryStrategy interface and provides methods to determine whether a request
- * should be retried and calculates the delay before the next retry attempt.
- */
-export class DefaultRetryStrategy {
-    /**
-     * @param {object} options Configurable options for retry mechanism.
-     * @param {number[]} [options.statusCodes] HTTP status codes to trigger retries on. Default is [429].
-     * @param {string[]} [options.errorCodes] Node error codes to trigger retries. Default is ['ECONNRESET', 'ETIMEDOUT', 'EPROTO'].
-     * @param {number} [options.factor] Factor by which the delay increases with each retry attempt. Default is 2.
-     */
-    constructor(options = {}) {
-        this.statusCodes = options.statusCodes || [429];
-        this.errorCodes = options.errorCodes || ['ECONNRESET', 'ETIMEDOUT', 'EPROTO'];
-        this.factor = options.factor || 2;
-    }
-    shouldRetry(error, attempt, retries) {
-        var _a;
-        const isStatusCodeError = ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) !== undefined && this.statusCodes.includes(error.response.status);
-        const isNodeErrorCode = error.code !== undefined && this.errorCodes.includes(error.code);
-        return retries > 0 && attempt <= retries && (isStatusCodeError || isNodeErrorCode);
-    }
-    getDelay(error, attempt) {
-        var _a;
-        const rawHeaders = (_a = error.response) === null || _a === void 0 ? void 0 : _a.headers;
-        const retryAfterHeader = rawHeaders === null || rawHeaders === void 0 ? void 0 : rawHeaders.get('Retry-After');
-        if (retryAfterHeader !== null &&
-            retryAfterHeader !== undefined &&
-            retryAfterHeader.trim() !== '') {
-            const delaySeconds = Number.parseFloat(retryAfterHeader);
-            return delaySeconds * 1000;
-        }
-        else {
-            return Math.pow(this.factor, attempt - 1) * 1000;
-        }
-    }
-}
+/**
+ * Represents a default retry strategy for handling retry attempts in case of specific HTTP status codes.
+ * This class implements the RetryStrategy interface and provides methods to determine whether a request
+ * should be retried and calculates the delay before the next retry attempt.
+ * @public
+ */
+export class DefaultRetryStrategy {
+    /**
+     * @param {object} options Configurable options for retry mechanism.
+     * @param {number[]} [options.statusCodes] HTTP status codes to trigger retries on. Default is [429].
+     * @param {string[]} [options.errorCodes] Node error codes to trigger retries. Default is ['ECONNRESET', 'ETIMEDOUT', 'EPROTO'].
+     * @param {number} [options.factor] Factor by which the delay increases with each retry attempt. Default is 2.
+     */
+    constructor(options = {}) {
+        this.statusCodes = options.statusCodes || [429];
+        this.errorCodes = options.errorCodes || ['ECONNRESET', 'ETIMEDOUT', 'EPROTO'];
+        this.factor = options.factor || 2;
+    }
+    shouldRetry(error, attempt, retries) {
+        var _a;
+        const isStatusCodeError = ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) !== undefined && this.statusCodes.includes(error.response.status);
+        const isNodeErrorCode = error.code !== undefined && this.errorCodes.includes(error.code);
+        return retries > 0 && attempt <= retries && (isStatusCodeError || isNodeErrorCode);
+    }
+    getDelay(error, attempt) {
+        var _a;
+        const rawHeaders = (_a = error.response) === null || _a === void 0 ? void 0 : _a.headers;
+        const retryAfterHeader = rawHeaders === null || rawHeaders === void 0 ? void 0 : rawHeaders.get('Retry-After');
+        if (retryAfterHeader !== null &&
+            retryAfterHeader !== undefined &&
+            retryAfterHeader.trim() !== '') {
+            const delaySeconds = Number.parseFloat(retryAfterHeader);
+            return delaySeconds * 1000;
+        }
+        else {
+            return Math.pow(this.factor, attempt - 1) * 1000;
+        }
+    }
+}