@sitecore-content-sdk/core 0.1.0-beta.1

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

@@ -0,0 +1,107 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import debug from '../debug';
+import { isTimeoutError } from '../utils';
+import { MemoryCacheClient } from '../cache-client';
+export class GraphQLPersonalizeService {
+    /**
+     * Fetch personalize data using the Sitecore GraphQL endpoint.
+     * @param {GraphQLPersonalizeServiceConfig} 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!) {
+        layout(site: $siteName, routePath: $itemPath, language: $language) {
+          item {
+            id
+            version
+            personalization {
+              variantIds
+            }
+          }
+        }
+      }
+    `;
+    }
+    /**
+     * 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)
+     */
+    getPersonalizeInfo(itemPath, language, siteName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            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 = yield 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/index.js

@@ -0,0 +1,3 @@
+export { personalizeLayout } from './layout-personalizer';
+export { GraphQLPersonalizeService, } from './graphql-personalize-service';
+export { getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from './utils';

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

@@ -0,0 +1,92 @@
+import { HIDDEN_RENDERING_NAME } from '../constants';
+const transformToHiddenRenderingVariant = (component) => (Object.assign(Object.assign({}, component), { componentName: 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
+ */
+export 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
+ */
+export 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
+ */
+export 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/esm/personalize/utils.js

@@ -0,0 +1,128 @@
+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.startsWith('/') ? pathname : '/' + pathname;
+    return `${variantIds.map((variantId) => `/${VARIANT_PREFIX}${variantId}`).join('')}${path}`;
+}
+/**
+ * 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, '')) || '';
+    }
+}

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

@@ -0,0 +1,82 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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.
+ */
+export class GraphQLErrorPagesService {
+    /**
+     * Creates an instance of graphQL error pages service with the provided options
+     * @param {GraphQLErrorPagesServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this.graphQLClient = this.getGraphQLClient();
+    }
+    get query() {
+        return defaultQuery;
+    }
+    /**
+     * Fetch list of error pages for the site
+     * @returns {ErrorPages} list of url's error pages
+     * @throws {Error} if the siteName is empty.
+     */
+    fetchErrorPages() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const siteName = this.options.siteName;
+            const language = this.options.language;
+            if (!siteName) {
+                throw new Error(siteNameError);
+            }
+            return this.graphQLClient.request(this.query, {
+                siteName,
+                language,
+            })
+                .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() {
+        if (!this.options.clientFactory) {
+            throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
+        }
+        return this.options.clientFactory({
+            debugger: debug.errorpages,
+            retries: this.options.retries,
+            retryStrategy: this.options.retryStrategy,
+        });
+    }
+}

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

@@ -0,0 +1,98 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { siteNameError } from '../constants';
+import debug from '../debug';
+import { MemoryCacheClient } from '../cache-client';
+export const REDIRECT_TYPE_301 = 'REDIRECT_301';
+export const REDIRECT_TYPE_302 = 'REDIRECT_302';
+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 GraphQLRedirectsService class is used to query the JSS redirects using Graphql endpoint
+ */
+export class GraphQLRedirectsService {
+    /**
+     * Creates an instance of graphQL redirects service with the provided options
+     * @param {GraphQLRedirectsServiceConfig} 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[]>
+     * @throws {Error} if the siteName is empty.
+     */
+    fetchRedirects(siteName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            if (!siteName) {
+                throw new Error(siteNameError);
+            }
+            const cacheKey = `redirects-${siteName}`;
+            let data = this.cache.getCacheValue(cacheKey);
+            if (!data) {
+                data = yield this.graphQLClient.request(this.query, {
+                    siteName,
+                });
+                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/graphql-robots-service.js

@@ -0,0 +1,76 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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.
+ */
+export class GraphQLRobotsService {
+    /**
+     * Creates an instance of graphQL robots.txt service with the provided options
+     * @param {GraphQLRobotsServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this.graphQLClient = this.getGraphQLClient();
+    }
+    get query() {
+        return defaultQuery;
+    }
+    /**
+     * Fetch a data of robots.txt from API
+     * @returns text of robots.txt
+     * @throws {Error} if the siteName is empty.
+     */
+    fetchRobots() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const siteName = this.options.siteName;
+            if (!siteName) {
+                throw new Error(siteNameError);
+            }
+            const robotsResult = this.graphQLClient.request(this.query, {
+                siteName,
+            });
+            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,
+        });
+    }
+}