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

package/dist/cjs/personalize/layout-personalizer.js

@@ -1,97 +1,98 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.personalizeLayout = personalizeLayout;
-exports.personalizePlaceholder = personalizePlaceholder;
-exports.personalizeComponent = personalizeComponent;
-const constants_1 = require("../constants");
-const transformToHiddenRenderingVariant = (component) => (Object.assign(Object.assign({}, component), { componentName: constants_1.HIDDEN_RENDERING_NAME, experiences: {} }));
-/**
- * Apply personalization to layout data. This will recursively go through all placeholders/components, check experiences nodes and replace default with object from specific experience.
- * @param {LayoutServiceData} layout Layout data
- * @param {string} variantId variant id
- * @param {string[]} [componentVariantIds] component variant ids
- */
-function personalizeLayout(layout, variantId, componentVariantIds) {
-    var _a;
-    // Add (page-level) variantId to Sitecore context so that it is accessible here
-    layout.sitecore.context.variantId = variantId;
-    const placeholders = ((_a = layout.sitecore.route) === null || _a === void 0 ? void 0 : _a.placeholders) || {};
-    if (Object.keys(placeholders).length === 0) {
-        return undefined;
-    }
-    const isEditing = layout.sitecore.context.pageEditing;
-    if (placeholders) {
-        Object.keys(placeholders).forEach((placeholder) => {
-            placeholders[placeholder] = personalizePlaceholder(placeholders[placeholder], [variantId, ...(componentVariantIds || [])], isEditing);
-        });
-    }
-    return placeholders;
-}
-/**
- * @param {Array} components components within placeholder
- * @param {string[]} variantIds variant ids
- * @param {boolean} isEditing indicates if page is rendered in metadata edit mode
- * @returns {ComponentRendering[]} components with personalization applied
- */
-function personalizePlaceholder(components, variantIds, isEditing) {
-    return components
-        .map((component) => {
-        const rendering = component;
-        if (rendering.experiences !== undefined) {
-            return personalizeComponent(rendering, variantIds, isEditing);
-        }
-        else if (rendering.placeholders) {
-            const placeholders = rendering.placeholders;
-            Object.keys(placeholders).forEach((placeholder) => {
-                placeholders[placeholder] = personalizePlaceholder(placeholders[placeholder], variantIds, isEditing);
-            });
-        }
-        return component;
-    })
-        .filter(Boolean);
-}
-/**
- * @param {ComponentRenderingWithExperiences} component component with experiences
- * @param {string[]} variantIds variant ids
- * @param {boolean} isEditing indicates if page is rendered in metadata edit mode
- * @returns {ComponentRendering | null} component with personalization applied or null if hidden
- */
-function personalizeComponent(component, variantIds, isEditing) {
-    // Check if we have a page/component experience matching any of the variants (there should be at most 1)
-    const match = Object.keys(component.experiences).find((variantId) => variantIds.includes(variantId));
-    const variant = match && component.experiences[match];
-    // variant and componentName can be undefined or null
-    if (!variant && !component.componentName) {
-        // DEFAULT IS HIDDEN
-        if (isEditing) {
-            component = transformToHiddenRenderingVariant(component);
-        }
-        else {
-            return null;
-        }
-    }
-    else if (variant && variant.componentName === null && variant.dataSource === null) {
-        // VARIANT IS HIDDEN
-        if (isEditing) {
-            component = transformToHiddenRenderingVariant(component);
-        }
-        else {
-            return null;
-        }
-    }
-    else if (variant) {
-        component = variant;
-    }
-    // remove unused experiences from layout data
-    if (component.experiences) {
-        component.experiences = {};
-    }
-    if (!component.placeholders)
-        return component;
-    Object.keys(component === null || component === void 0 ? void 0 : component.placeholders).forEach((placeholder) => {
-        if (component.placeholders) {
-            component.placeholders[placeholder] = personalizePlaceholder(component.placeholders[placeholder], variantIds);
-        }
-    });
-    return component;
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.personalizeLayout = personalizeLayout;
+exports.personalizePlaceholder = personalizePlaceholder;
+exports.personalizeComponent = personalizeComponent;
+const constants_1 = require("../constants");
+const transformToHiddenRenderingVariant = (component) => (Object.assign(Object.assign({}, component), { componentName: constants_1.HIDDEN_RENDERING_NAME, experiences: {} }));
+/**
+ * Apply personalization to layout data. This will recursively go through all placeholders/components, check experiences nodes and replace default with object from specific experience.
+ * @param {LayoutServiceData} layout Layout data
+ * @param {string} variantId variant id
+ * @param {string[]} [componentVariantIds] component variant ids
+ * @public
+ */
+function personalizeLayout(layout, variantId, componentVariantIds) {
+    var _a;
+    // Add (page-level) variantId to Sitecore context so that it is accessible here
+    layout.sitecore.context.variantId = variantId;
+    const placeholders = ((_a = layout.sitecore.route) === null || _a === void 0 ? void 0 : _a.placeholders) || {};
+    if (Object.keys(placeholders).length === 0) {
+        return undefined;
+    }
+    const isEditing = layout.sitecore.context.pageEditing;
+    if (placeholders) {
+        Object.keys(placeholders).forEach((placeholder) => {
+            placeholders[placeholder] = personalizePlaceholder(placeholders[placeholder], [variantId, ...(componentVariantIds || [])], isEditing);
+        });
+    }
+    return placeholders;
+}
+/**
+ * @param {Array} components components within placeholder
+ * @param {string[]} variantIds variant ids
+ * @param {boolean} isEditing indicates if page is rendered in metadata edit mode
+ * @returns {ComponentRendering[]} components with personalization applied
+ */
+function personalizePlaceholder(components, variantIds, isEditing) {
+    return components
+        .map((component) => {
+        const rendering = component;
+        if (rendering.experiences !== undefined) {
+            return personalizeComponent(rendering, variantIds, isEditing);
+        }
+        else if (rendering.placeholders) {
+            const placeholders = rendering.placeholders;
+            Object.keys(placeholders).forEach((placeholder) => {
+                placeholders[placeholder] = personalizePlaceholder(placeholders[placeholder], variantIds, isEditing);
+            });
+        }
+        return component;
+    })
+        .filter(Boolean);
+}
+/**
+ * @param {ComponentRenderingWithExperiences} component component with experiences
+ * @param {string[]} variantIds variant ids
+ * @param {boolean} isEditing indicates if page is rendered in metadata edit mode
+ * @returns {ComponentRendering | null} component with personalization applied or null if hidden
+ */
+function personalizeComponent(component, variantIds, isEditing) {
+    // Check if we have a page/component experience matching any of the variants (there should be at most 1)
+    const match = Object.keys(component.experiences).find((variantId) => variantIds.includes(variantId));
+    const variant = match && component.experiences[match];
+    // variant and componentName can be undefined or null
+    if (!variant && !component.componentName) {
+        // DEFAULT IS HIDDEN
+        if (isEditing) {
+            component = transformToHiddenRenderingVariant(component);
+        }
+        else {
+            return null;
+        }
+    }
+    else if (variant && variant.componentName === null && variant.dataSource === null) {
+        // VARIANT IS HIDDEN
+        if (isEditing) {
+            component = transformToHiddenRenderingVariant(component);
+        }
+        else {
+            return null;
+        }
+    }
+    else if (variant) {
+        component = variant;
+    }
+    // remove unused experiences from layout data
+    if (component.experiences) {
+        component.experiences = {};
+    }
+    if (!component.placeholders)
+        return component;
+    Object.keys(component === null || component === void 0 ? void 0 : component.placeholders).forEach((placeholder) => {
+        if (component.placeholders) {
+            component.placeholders[placeholder] = personalizePlaceholder(component.placeholders[placeholder], variantIds);
+        }
+    });
+    return component;
+}

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

@@ -1,26 +1,30 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PersonalizeService = void 0;
-const debug_1 = __importDefault(require("../debug"));
-const utils_1 = require("../utils");
-const cache_client_1 = require("../cache-client");
-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() {
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersonalizeService = void 0;
+const debug_1 = __importDefault(require("../debug"));
+const utils_1 = require("../utils");
+const cache_client_1 = require("../cache-client");
+/**
+ * Fetch personalize data using the Sitecore GraphQL endpoint.
+ * @public
+ */
+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
@@ -31,75 +35,75 @@ 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_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);
-        if (!data) {
-            try {
-                data = await this.graphQLClient.request(this.query, {
-                    siteName,
-                    itemPath,
-                    language,
-                });
-                this.cache.setCacheValue(cacheKey, data);
-            }
-            catch (error) {
-                if ((0, utils_1.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 cache_client_1.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_1.default.personalize,
-            fetch: this.config.fetch,
-            timeout: this.config.timeout,
-        });
-    }
-}
-exports.PersonalizeService = 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_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);
+        if (!data) {
+            try {
+                data = await this.graphQLClient.request(this.query, {
+                    siteName,
+                    itemPath,
+                    language,
+                });
+                this.cache.setCacheValue(cacheKey, data);
+            }
+            catch (error) {
+                if ((0, utils_1.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 cache_client_1.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_1.default.personalize,
+            fetch: this.config.fetch,
+            timeout: this.config.timeout,
+        });
+    }
+}
+exports.PersonalizeService = PersonalizeService;