@sitecore-content-sdk/content 1.5.0-canary.5

package/dist/cjs/layout/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDesignLibraryStylesheetLinks = exports.GRAPHQL_LAYOUT_QUERY_NAME = exports.LayoutService = exports.getContentStylesheetLink = exports.EMPTY_DATE_FIELD_VALUE = exports.getDynamicPlaceholderPattern = exports.isDynamicPlaceholder = exports.isFieldValueEmpty = exports.getChildPlaceholder = exports.getFieldValue = exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.EditMode = exports.LayoutServicePageState = void 0;
+// layout
+var models_1 = require("./models");
+Object.defineProperty(exports, "LayoutServicePageState", { enumerable: true, get: function () { return models_1.LayoutServicePageState; } });
+Object.defineProperty(exports, "EditMode", { enumerable: true, get: function () { return models_1.EditMode; } });
+Object.defineProperty(exports, "RenderingType", { enumerable: true, get: function () { return models_1.RenderingType; } });
+Object.defineProperty(exports, "EDITING_COMPONENT_PLACEHOLDER", { enumerable: true, get: function () { return models_1.EDITING_COMPONENT_PLACEHOLDER; } });
+Object.defineProperty(exports, "EDITING_COMPONENT_ID", { enumerable: true, get: function () { return models_1.EDITING_COMPONENT_ID; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getFieldValue", { enumerable: true, get: function () { return utils_1.getFieldValue; } });
+Object.defineProperty(exports, "getChildPlaceholder", { enumerable: true, get: function () { return utils_1.getChildPlaceholder; } });
+Object.defineProperty(exports, "isFieldValueEmpty", { enumerable: true, get: function () { return utils_1.isFieldValueEmpty; } });
+Object.defineProperty(exports, "isDynamicPlaceholder", { enumerable: true, get: function () { return utils_1.isDynamicPlaceholder; } });
+Object.defineProperty(exports, "getDynamicPlaceholderPattern", { enumerable: true, get: function () { return utils_1.getDynamicPlaceholderPattern; } });
+Object.defineProperty(exports, "EMPTY_DATE_FIELD_VALUE", { enumerable: true, get: function () { return utils_1.EMPTY_DATE_FIELD_VALUE; } });
+var content_styles_1 = require("./content-styles");
+Object.defineProperty(exports, "getContentStylesheetLink", { enumerable: true, get: function () { return content_styles_1.getContentStylesheetLink; } });
+var layout_service_1 = require("./layout-service");
+Object.defineProperty(exports, "LayoutService", { enumerable: true, get: function () { return layout_service_1.LayoutService; } });
+Object.defineProperty(exports, "GRAPHQL_LAYOUT_QUERY_NAME", { enumerable: true, get: function () { return layout_service_1.GRAPHQL_LAYOUT_QUERY_NAME; } });
+var themes_1 = require("./themes");
+Object.defineProperty(exports, "getDesignLibraryStylesheetLinks", { enumerable: true, get: function () { return themes_1.getDesignLibraryStylesheetLinks; } });

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

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LayoutService = exports.GRAPHQL_LAYOUT_QUERY_NAME = void 0;
+const sitecore_service_base_1 = require("../sitecore-service-base");
+const debug_1 = __importDefault(require("../debug"));
+/**
+ * GraphQL layout query name
+ * @internal
+ */
+exports.GRAPHQL_LAYOUT_QUERY_NAME = 'ContentSdkLayoutQuery';
+/**
+ * Service that fetch layout data using Sitecore's GraphQL API.
+ * @augments LayoutServiceBase
+ * @mixes GraphQLRequestClient
+ * @public
+ */
+class LayoutService extends sitecore_service_base_1.SitecoreServiceBase {
+    /**
+     * Fetch layout data using the Sitecore GraphQL endpoint.
+     * @param {LayoutServiceConfig} serviceConfig configuration
+     */
+    constructor(serviceConfig) {
+        super(serviceConfig);
+        this.serviceConfig = serviceConfig;
+    }
+    /**
+     * Fetch layout data for an item.
+     * @param {string} itemPath item path 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, routeOptions, fetchOptions) {
+        var _a, _b;
+        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: 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, site, language) {
+        const languageVariable = language ? `, language:"${language}"` : '';
+        const layoutQuery = this.serviceConfig.formatLayoutQuery
+            ? this.serviceConfig.formatLayoutQuery(site, itemPath, language)
+            : `layout(site:"${site}", routePath:"${itemPath}"${languageVariable})`;
+        return `query ${exports.GRAPHQL_LAYOUT_QUERY_NAME} {
+      ${layoutQuery}{
+        item {
+          rendered
+        }
+      }
+    }`;
+    }
+}
+exports.LayoutService = LayoutService;

package/dist/cjs/layout/models.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EDITING_COMPONENT_ID = exports.EDITING_COMPONENT_PLACEHOLDER = exports.RenderingType = exports.EditMode = exports.LayoutServicePageState = void 0;
+/**
+ * Layout Service page state enum
+ * @public
+ */
+var LayoutServicePageState;
+(function (LayoutServicePageState) {
+    LayoutServicePageState["Preview"] = "preview";
+    LayoutServicePageState["Edit"] = "edit";
+    LayoutServicePageState["Normal"] = "normal";
+})(LayoutServicePageState || (exports.LayoutServicePageState = LayoutServicePageState = {}));
+/**
+ * Represents the edit mode for rendering content in Sitecore Editors
+ * @public
+ */
+var EditMode;
+(function (EditMode) {
+    EditMode["Metadata"] = "metadata";
+})(EditMode || (exports.EditMode = EditMode = {}));
+/**
+ * Editing rendering type
+ * @public
+ */
+var RenderingType;
+(function (RenderingType) {
+    RenderingType["Component"] = "component";
+})(RenderingType || (exports.RenderingType = RenderingType = {}));
+/**
+ * Static placeholder name used for component rendering
+ * @internal
+ */
+exports.EDITING_COMPONENT_PLACEHOLDER = 'editing-componentmode-placeholder';
+/**
+ * Id of wrapper for component rendering
+ * @internal
+ */
+exports.EDITING_COMPONENT_ID = 'editing-component';

package/dist/cjs/layout/themes.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStylesheetUrl = void 0;
+exports.getDesignLibraryStylesheetLinks = getDesignLibraryStylesheetLinks;
+const tools_1 = require("@sitecore-content-sdk/core/tools");
+const core_1 = require("@sitecore-content-sdk/core");
+const _1 = require(".");
+const { SITECORE_EDGE_URL_DEFAULT } = core_1.constants;
+/**
+ * Pattern for library ids
+ * @example -library--foo
+ */
+const STYLES_LIBRARY_ID_REGEX = /-library--([^\s]+)/;
+/**
+ * Walks through rendering tree and returns list of links of all FEAAS, BYOC or SXA Design Library Stylesheets that are used
+ * @param {LayoutServiceData} layoutData Layout service data
+ * @param {string} sitecoreEdgeContextId Sitecore Edge Context ID
+ * @param {string} [sitecoreEdgeUrl] Sitecore Edge Platform URL. Default is https://edge-platform.sitecorecloud.io
+ * @returns {HTMLLink[]} library stylesheet links
+ * @public
+ */
+function getDesignLibraryStylesheetLinks(layoutData, sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) {
+    const ids = new Set();
+    if (!layoutData.sitecore.route)
+        return [];
+    traverseComponent(layoutData.sitecore.route, ids);
+    return [...ids].map((id) => ({
+        href: (0, exports.getStylesheetUrl)(id, sitecoreEdgeContextId, sitecoreEdgeUrl),
+        rel: 'stylesheet',
+    }));
+}
+const getStylesheetUrl = (id, sitecoreEdgeContextId, sitecoreEdgeUrl = SITECORE_EDGE_URL_DEFAULT) => {
+    return `${(0, tools_1.normalizeUrl)(sitecoreEdgeUrl)}/v1/files/components/styles/${id}.css?sitecoreContextId=${sitecoreEdgeContextId}`;
+};
+exports.getStylesheetUrl = getStylesheetUrl;
+/**
+ * Traverse placeholder and components to add library ids
+ * @param {ComponentRendering[]} components
+ * @param {Set<string>} ids library ids
+ */
+const traversePlaceholder = (components, ids) => {
+    components.map((component) => {
+        return traverseComponent(component, ids);
+    });
+};
+/**
+ * Traverse component and children to add library ids
+ * @param {RouteData | ComponentRendering | HtmlElementRendering} component component data
+ * @param {Set<string>} ids library ids
+ */
+const traverseComponent = (component, ids) => {
+    var _a, _b, _c, _d, _e, _f;
+    let libraryId = undefined;
+    if ('params' in component && component.params) {
+        // LibraryID in css class name takes precedence over LibraryId attribute
+        libraryId =
+            ((_b = (_a = component.params.CSSStyles) === null || _a === void 0 ? void 0 : _a.match(STYLES_LIBRARY_ID_REGEX)) === null || _b === void 0 ? void 0 : _b[1]) ||
+                ((_d = (_c = component.params.Styles) === null || _c === void 0 ? void 0 : _c.match(STYLES_LIBRARY_ID_REGEX)) === null || _d === void 0 ? void 0 : _d[1]) ||
+                component.params.LibraryId ||
+                undefined;
+    }
+    // if params are empty we try to fall back to data source
+    if (!libraryId && 'fields' in component && component.fields) {
+        libraryId =
+            ((_e = (0, _1.getFieldValue)(component.fields, 'CSSStyles', '').match(STYLES_LIBRARY_ID_REGEX)) === null || _e === void 0 ? void 0 : _e[1]) ||
+                ((_f = (0, _1.getFieldValue)(component.fields, 'Styles', '').match(STYLES_LIBRARY_ID_REGEX)) === null || _f === void 0 ? void 0 : _f[1]) ||
+                (0, _1.getFieldValue)(component.fields, 'LibraryId', '') ||
+                undefined;
+    }
+    if (libraryId) {
+        ids.add(libraryId);
+    }
+    const placeholders = component.placeholders || {};
+    Object.keys(placeholders).forEach((placeholder) => {
+        traversePlaceholder(placeholders[placeholder], ids);
+    });
+};

package/dist/cjs/layout/utils.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EMPTY_DATE_FIELD_VALUE = exports.isDynamicPlaceholder = exports.getDynamicPlaceholderPattern = void 0;
+exports.getFieldValue = getFieldValue;
+exports.getChildPlaceholder = getChildPlaceholder;
+exports.isFieldValueEmpty = isFieldValueEmpty;
+/**
+ * @param {ComponentRendering | Fields} renderingOrFields the rendering or fields object to extract the field from
+ * @param {string} fieldName the name of the field to extract
+ * @param {T} [defaultValue] the default value to return if the field is not defined
+ * @returns {Field | T} the field value or the default value if the field is not defined
+ * @public
+ */
+// eslint-disable-next-line no-redeclare
+function getFieldValue(renderingOrFields, fieldName, defaultValue) {
+    if (!renderingOrFields || !fieldName) {
+        return defaultValue;
+    }
+    const fields = renderingOrFields;
+    const field = fields[fieldName];
+    if (field && typeof field.value !== 'undefined') {
+        return field.value;
+    }
+    const rendering = renderingOrFields;
+    if (!rendering.fields ||
+        !rendering.fields[fieldName] ||
+        typeof rendering.fields[fieldName].value === 'undefined') {
+        return defaultValue;
+    }
+    return rendering.fields[fieldName].value;
+}
+/**
+ * Gets rendering definitions in a given child placeholder under a current rendering.
+ * @param {ComponentRendering} rendering
+ * @param {string} placeholderName
+ * @returns {ComponentRendering[]} child placeholder
+ * @public
+ */
+function getChildPlaceholder(rendering, placeholderName) {
+    if (!rendering ||
+        !placeholderName ||
+        !rendering.placeholders ||
+        !rendering.placeholders[placeholderName]) {
+        return [];
+    }
+    return rendering.placeholders[placeholderName];
+}
+/**
+ * Returns a regular expression pattern for a dynamic placeholder name.
+ * @param {string} placeholder Placeholder name with a dynamic segment (e.g. 'main-{*}')
+ * @returns Regular expression pattern for the dynamic segment
+ * @internal
+ */
+const getDynamicPlaceholderPattern = (placeholder) => {
+    return new RegExp(`^${placeholder.replace(/\{\*\}+/i, '\\d+')}$`);
+};
+exports.getDynamicPlaceholderPattern = getDynamicPlaceholderPattern;
+/**
+ * Checks if the placeholder name is dynamic.
+ * @param {string} placeholder Placeholder name
+ * @returns True if the placeholder name is dynamic
+ * @internal
+ */
+const isDynamicPlaceholder = (placeholder) => placeholder.indexOf('{*}') !== -1;
+exports.isDynamicPlaceholder = isDynamicPlaceholder;
+/**
+ * The default value for an empty Date field.
+ * This value is defined as a default one by .NET
+ * @internal
+ */
+exports.EMPTY_DATE_FIELD_VALUE = '0001-01-01T00:00:00Z';
+/**
+ * Determines if the passed in field object's value is empty.
+ * @param {GenericFieldValue | Partial<Field>} field the field object.
+ * Partial<T> type is used here because _field.value_ could be required or optional for the different field types
+ * @returns True if the field value is empty
+ * @public
+ */
+function isFieldValueEmpty(field) {
+    if (!field)
+        return true;
+    const isImageFieldEmpty = (fieldValue) => !fieldValue.src;
+    const isFileFieldEmpty = (fieldValue) => !fieldValue.src;
+    const isLinkFieldEmpty = (fieldValue) => !fieldValue.href;
+    const isDateFieldEmpty = (fieldValue) => {
+        if (typeof fieldValue === 'string') {
+            return fieldValue === exports.EMPTY_DATE_FIELD_VALUE;
+        }
+        else {
+            return !(typeof (fieldValue === null || fieldValue === void 0 ? void 0 : fieldValue.getMonth) === 'function' &&
+                !isNaN(fieldValue === null || fieldValue === void 0 ? void 0 : fieldValue.getMonth()));
+        }
+    };
+    const isEmpty = (fieldValue) => {
+        if (fieldValue === null || fieldValue === undefined) {
+            return true;
+        }
+        if (typeof fieldValue === 'object') {
+            return (isImageFieldEmpty(fieldValue) &&
+                isFileFieldEmpty(fieldValue) &&
+                isLinkFieldEmpty(fieldValue) &&
+                isDateFieldEmpty(fieldValue));
+        }
+        else if (typeof fieldValue === 'number' || typeof fieldValue === 'boolean') {
+            // Avoid returning true for 0 and false values
+            return false;
+        }
+        else {
+            return !fieldValue || isDateFieldEmpty(fieldValue);
+        }
+    };
+    const dynamicField = field;
+    if (dynamicField.value !== undefined) {
+        return isEmpty(dynamicField.value);
+    }
+    return isEmpty(field);
+}

package/dist/cjs/media/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mediaApi = void 0;
+const mediaApi = __importStar(require("./media-api"));
+exports.mediaApi = mediaApi;

package/dist/cjs/media/media-api.js

@@ -0,0 +1,100 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSrcSet = exports.updateImageUrl = exports.replaceMediaUrlPrefix = exports.getRequiredParams = void 0;
+const url_parse_1 = __importDefault(require("url-parse"));
+// finds the Sitecore media URL prefix
+const mediaUrlPrefixRegex = /\/([-~]{1})\/media\//i;
+/**
+ * Get required query string params which should be merged with user params
+ * @param {object} qs layout service parsed query string
+ * @returns {object} requiredParams
+ * @public
+ */
+const getRequiredParams = (qs) => {
+    const { rev, db, la, vs, ts } = qs;
+    return { rev, db, la, vs, ts };
+};
+exports.getRequiredParams = getRequiredParams;
+/**
+ * Replace `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
+ * Can use `mediaUrlPrefix` in order to use a custom prefix.
+ * @param {string} url The URL to replace the media URL prefix in
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The URL with the media URL prefix replaced
+ * @public
+ */
+const replaceMediaUrlPrefix = (url, mediaUrlPrefix = mediaUrlPrefixRegex) => {
+    const parsed = (0, url_parse_1.default)(url, {}, true);
+    const match = mediaUrlPrefix.exec(parsed.pathname);
+    if (match && match.length > 1) {
+        // regex will provide us with /-/ or /~/ type
+        parsed.set('pathname', parsed.pathname.replace(mediaUrlPrefix, `/${match[1]}/jssmedia/`));
+    }
+    return parsed.toString();
+};
+exports.replaceMediaUrlPrefix = replaceMediaUrlPrefix;
+/**
+ * Prepares a Sitecore media URL with `params` for use by the Content SDK media handler.
+ * This is done by replacing `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
+ * Provided `params` are used as the querystring parameters for the media URL.
+ * Can use `mediaUrlPrefix` in order to use a custom prefix.
+ * If no `params` are sent, the original media URL is returned.
+ * @param {string} url The URL to prepare
+ * @param {object} [params] The querystring parameters to use
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The prepared URL
+ * @public
+ */
+const updateImageUrl = (url, params, mediaUrlPrefix = mediaUrlPrefixRegex) => {
+    if (!params || Object.keys(params).length === 0) {
+        // if params aren't supplied, no need to run it through Content SDK media handler
+        return url;
+    }
+    // polyfill node `global` in browser to workaround https://github.com/unshiftio/url-parse/issues/150
+    if (typeof window !== 'undefined' && !window.global) {
+        window.global = {};
+    }
+    const parsed = (0, url_parse_1.default)((0, exports.replaceMediaUrlPrefix)(url, mediaUrlPrefix), {}, true);
+    const requiredParams = (0, exports.getRequiredParams)(parsed.query);
+    const query = Object.assign({}, params);
+    Object.entries(requiredParams).forEach(([key, param]) => {
+        if (param) {
+            query[key] = param;
+        }
+    });
+    parsed.set('query', query);
+    return parsed.toString();
+};
+exports.updateImageUrl = updateImageUrl;
+/**
+ * Receives an array of `srcSet` parameters that are iterated and used as parameters to generate
+ * a corresponding set of updated Sitecore media URLs via @see updateImageUrl. The result is a comma-delimited
+ * list of media URLs with respective dimension parameters.
+ * @example
+ * // returns '/ipsum.jpg?h=1000&w=1000 1000w, /ipsum.jpg?mh=250&mw=250 250w'
+ * getSrcSet('/ipsum.jpg', [{ h: 1000, w: 1000 }, { mh: 250, mw: 250 } ])
+ * More information about `srcSet`: {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img}
+ * @param {string} url The URL to prepare
+ * @param {Array} srcSet The array of parameters to use
+ * @param {object} [imageParams] The querystring parameters to use
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The prepared URL
+ * @public
+ */
+const getSrcSet = (url, srcSet, imageParams, mediaUrlPrefix) => {
+    return srcSet
+        .map((params) => {
+        const newParams = Object.assign(Object.assign({}, imageParams), params);
+        const imageWidth = newParams.w || newParams.mw;
+        if (!imageWidth) {
+            return null;
+        }
+        return `${(0, exports.updateImageUrl)(url, newParams, mediaUrlPrefix)} ${imageWidth}w`;
+    })
+        .filter((value) => value)
+        .join(', ');
+};
+exports.getSrcSet = getSrcSet;

package/dist/cjs/models.js

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

package/dist/cjs/personalize/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VARIANT_PREFIX = exports.DEFAULT_VARIANT = exports.CdpHelper = exports.normalizePersonalizedRewrite = exports.getGroomedVariantIds = exports.getPersonalizedRewriteData = exports.getPersonalizedRewrite = exports.PersonalizeService = 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 personalize_service_1 = require("./personalize-service");
+Object.defineProperty(exports, "PersonalizeService", { enumerable: true, get: function () { return personalize_service_1.PersonalizeService; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getPersonalizedRewrite", { enumerable: true, get: function () { return utils_1.getPersonalizedRewrite; } });
+Object.defineProperty(exports, "getPersonalizedRewriteData", { enumerable: true, get: function () { return utils_1.getPersonalizedRewriteData; } });
+Object.defineProperty(exports, "getGroomedVariantIds", { enumerable: true, get: function () { return utils_1.getGroomedVariantIds; } });
+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; } });

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

@@ -0,0 +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
+ * @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;
+}