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

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

@@ -0,0 +1,227 @@
+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 { NextResponse } from 'next/server';
+import { GraphQLPersonalizeService, getPersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from '@sitecore-content-sdk/core/personalize';
+import { debug } from '@sitecore-content-sdk/core';
+import { MiddlewareBase } from './middleware';
+import { CloudSDK } from '@sitecore-cloudsdk/core/server';
+import { personalize } from '@sitecore-cloudsdk/personalize/server';
+/**
+ * Middleware / handler to support Sitecore Personalize
+ */
+export class PersonalizeMiddleware extends MiddlewareBase {
+    /**
+     * @param {PersonalizeMiddlewareConfig} [config] Personalize middleware config
+     */
+    constructor(config) {
+        super(config);
+        this.config = config;
+        this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            const pathname = req.nextUrl.pathname;
+            const language = this.getLanguage(req);
+            const hostname = this.getHostHeader(req) || this.defaultHostname;
+            const startTimestamp = Date.now();
+            const timeout = this.config.cdpConfig.timeout;
+            // Response will be provided if other middleware is run before us (e.g. redirects)
+            let response = res || NextResponse.next();
+            debug.personalize('personalize middleware start: %o', {
+                pathname,
+                language,
+                hostname,
+                headers: this.extractDebugHeaders(req.headers),
+            });
+            if (this.config.disabled && this.config.disabled(req, response)) {
+                debug.personalize('skipped (personalize middleware is disabled)');
+                return response;
+            }
+            if (response.redirected || // Don't attempt to personalize a redirect
+                this.isPreview(req) || // No need to personalize for preview (layout data is already prepared for preview)
+                this.excludeRoute(pathname)) {
+                debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
+                return response;
+            }
+            const site = this.getSite(req, response);
+            // Get personalization info from Experience Edge
+            const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
+            if (!personalizeInfo) {
+                // Likely an invalid route / language
+                debug.personalize('skipped (personalize info not found)');
+                return response;
+            }
+            if (personalizeInfo.variantIds.length === 0) {
+                debug.personalize('skipped (no personalization configured)');
+                return response;
+            }
+            if (this.isPrefetch(req)) {
+                debug.personalize('skipped (prefetch)');
+                // Personalized, but this is a prefetch request.
+                // In this case, don't execute a personalize request; otherwise, the metrics for component A/B experiments would be inaccurate.
+                // Disable preflight caching to force revalidation on client-side navigation (personalization WILL be influenced).
+                // Note the reason we don't move this any earlier in the middleware is that we would then be sacrificing performance for non-personalized pages.
+                response.headers.set('x-middleware-cache', 'no-cache');
+                return response;
+            }
+            yield this.initPersonalizeServer({
+                hostname,
+                siteName: site.name,
+                request: req,
+                response,
+            });
+            const params = this.getExperienceParams(req);
+            const executions = this.getPersonalizeExecutions(personalizeInfo, language);
+            const identifiedVariantIds = [];
+            yield Promise.all(executions.map((execution) => this.personalize({
+                friendlyId: execution.friendlyId,
+                variantIds: execution.variantIds,
+                params,
+                language,
+                timeout,
+            }, req).then((personalization) => {
+                const variantId = personalization.variantId;
+                if (variantId) {
+                    if (!execution.variantIds.includes(variantId)) {
+                        debug.personalize('invalid variant %s', variantId);
+                    }
+                    else {
+                        identifiedVariantIds.push(variantId);
+                    }
+                }
+            })));
+            if (identifiedVariantIds.length === 0) {
+                debug.personalize('skipped (no variant(s) identified)');
+                return response;
+            }
+            // Path can be rewritten by previously executed middleware
+            const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
+            // Rewrite to persononalized path
+            const rewritePath = getPersonalizedRewrite(basePath, identifiedVariantIds);
+            response = this.rewrite(rewritePath, req, response);
+            // Disable preflight caching to force revalidation on client-side navigation (personalization MAY be influenced).
+            // See https://github.com/vercel/next.js/pull/32767
+            response.headers.set('x-middleware-cache', 'no-cache');
+            debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
+                rewritePath,
+                headers: this.extractDebugHeaders(response.headers),
+            });
+            return response;
+        });
+        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
+        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
+        this.personalizeService = new GraphQLPersonalizeService(Object.assign(Object.assign({}, config.edgeConfig), { fetch: fetch }));
+    }
+    /**
+     * Gets the Next.js middleware handler with error handling
+     * @returns middleware handler
+     */
+    getHandler() {
+        return (req, res) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.handler(req, res);
+            }
+            catch (error) {
+                console.log('Personalize middleware failed:');
+                console.log(error);
+                return res || NextResponse.next();
+            }
+        });
+    }
+    initPersonalizeServer(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ hostname, siteName, request, response, }) {
+            yield CloudSDK(request, response, {
+                sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
+                sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
+                siteName,
+                cookieDomain: hostname,
+                enableServerCookie: true,
+            })
+                .addPersonalize({ enablePersonalizeCookie: true })
+                .initialize();
+        });
+    }
+    personalize(_a, request_1) {
+        return __awaiter(this, arguments, void 0, function* ({ params, friendlyId, language, timeout, variantIds, }, request) {
+            var _b;
+            debug.personalize('executing experience for %s %o', friendlyId, params);
+            return (yield personalize(request, {
+                channel: this.config.cdpConfig.channel || 'WEB',
+                currency: (_b = this.config.cdpConfig.currency) !== null && _b !== void 0 ? _b : 'USD',
+                friendlyId,
+                params,
+                language,
+                pageVariantIds: variantIds,
+            }, { timeout }));
+        });
+    }
+    getExperienceParams(req) {
+        const utm = {
+            campaign: req.nextUrl.searchParams.get('utm_campaign') || undefined,
+            content: req.nextUrl.searchParams.get('utm_content') || undefined,
+            medium: req.nextUrl.searchParams.get('utm_medium') || undefined,
+            source: req.nextUrl.searchParams.get('utm_source') || undefined,
+        };
+        return {
+            // It's expected that the header name "referer" is actually a misspelling of the word "referrer"
+            // req.referrer is used during fetching to determine the value of the Referer header of the request being made,
+            // used as a fallback
+            referrer: req.headers.get('referer') || req.referrer,
+            utm: utm,
+        };
+    }
+    excludeRoute(pathname) {
+        // ignore files
+        return pathname.includes('.') || super.excludeRoute(pathname);
+    }
+    /**
+     * Aggregates personalize executions based on the provided route personalize information and language
+     * @param {PersonalizeInfo} personalizeInfo the route personalize information
+     * @param {string} language the language
+     * @returns An array of personalize executions
+     */
+    getPersonalizeExecutions(personalizeInfo, language) {
+        if (personalizeInfo.variantIds.length === 0) {
+            return [];
+        }
+        const results = [];
+        return personalizeInfo.variantIds.reduce((results, variantId) => {
+            if (variantId.includes('_')) {
+                // Component-level personalization in format "<ComponentID>_<VariantID>"
+                const componentId = variantId.split('_')[0];
+                const friendlyId = CdpHelper.getComponentFriendlyId(personalizeInfo.pageId, componentId, language, this.config.scope || this.config.edgeConfig.scope);
+                const execution = results.find((x) => x.friendlyId === friendlyId);
+                if (execution) {
+                    execution.variantIds.push(variantId);
+                }
+                else {
+                    // The default/control variant (format "<ComponentID>_default") is also a valid value returned by the execution
+                    const defaultVariant = `${componentId}${DEFAULT_VARIANT}`;
+                    results.push({
+                        friendlyId,
+                        variantIds: [defaultVariant, variantId],
+                    });
+                }
+            }
+            else {
+                // Embedded (page-level) personalization in format "<VariantID>"
+                const friendlyId = CdpHelper.getPageFriendlyId(personalizeInfo.pageId, language, this.config.scope || this.config.edgeConfig.scope);
+                const execution = results.find((x) => x.friendlyId === friendlyId);
+                if (execution) {
+                    execution.variantIds.push(variantId);
+                }
+                else {
+                    results.push({
+                        friendlyId,
+                        variantIds: [variantId],
+                    });
+                }
+            }
+            return results;
+        }, results);
+    }
+}

package/dist/esm/middleware/redirects-middleware.js

@@ -0,0 +1,257 @@
+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 '@sitecore-content-sdk/core';
+import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-content-sdk/core/site';
+import { areURLSearchParamsEqual, escapeNonSpecialQuestionMarks, isRegexOrUrl, mergeURLSearchParams, } from '@sitecore-content-sdk/core/utils';
+import { NextResponse } from 'next/server';
+import regexParser from 'regex-parser';
+import { MiddlewareBase } from './middleware';
+const REGEXP_CONTEXT_SITE_LANG = new RegExp(/\$siteLang/, 'i');
+const REGEXP_ABSOLUTE_URL = new RegExp('^(?:[a-z]+:)?//', 'i');
+/**
+ * Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
+ * compares with current url and redirects to target url
+ */
+export class RedirectsMiddleware extends MiddlewareBase {
+    /**
+     * @param {RedirectsMiddlewareConfig} [config] redirects middleware config
+     */
+    constructor(config) {
+        super(config);
+        this.config = config;
+        this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            const pathname = req.nextUrl.pathname;
+            const language = this.getLanguage(req);
+            const hostname = this.getHostHeader(req) || this.defaultHostname;
+            let site;
+            const startTimestamp = Date.now();
+            debug.redirects('redirects middleware start: %o', {
+                pathname,
+                language,
+                hostname,
+            });
+            const createResponse = () => __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                const response = res || NextResponse.next();
+                if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
+                    debug.redirects('skipped (redirects middleware is disabled)');
+                    return response;
+                }
+                if (this.isPreview(req) || this.excludeRoute(pathname)) {
+                    debug.redirects('skipped (%s)', this.isPreview(req) ? 'preview' : 'route excluded');
+                    return response;
+                }
+                // Skip prefetch requests from Next.js, which are not original client requests
+                // as they load unnecessary requests that burden the redirects middleware with meaningless traffic
+                if (this.isPrefetch(req)) {
+                    debug.redirects('skipped (prefetch)');
+                    response.headers.set('x-middleware-cache', 'no-cache');
+                    return response;
+                }
+                site = this.getSite(req, res);
+                // Find the redirect from result of RedirectService
+                const existsRedirect = yield this.getExistsRedirect(req, site.name);
+                if (!existsRedirect) {
+                    debug.redirects('skipped (redirect does not exist)');
+                    return response;
+                }
+                // Find context site language and replace token
+                if (REGEXP_CONTEXT_SITE_LANG.test(existsRedirect.target) &&
+                    !(REGEXP_ABSOLUTE_URL.test(existsRedirect.target) &&
+                        existsRedirect.target.includes(hostname))) {
+                    existsRedirect.target = existsRedirect.target.replace(REGEXP_CONTEXT_SITE_LANG, site.language);
+                    req.nextUrl.locale = site.language;
+                }
+                const url = this.normalizeUrl(req.nextUrl.clone());
+                if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
+                    url.href = existsRedirect.target;
+                }
+                else {
+                    const isUrl = isRegexOrUrl(existsRedirect.pattern) === 'url';
+                    const targetParts = existsRedirect.target.split('/');
+                    const urlFirstPart = targetParts[1];
+                    if (this.locales.includes(urlFirstPart)) {
+                        req.nextUrl.locale = urlFirstPart;
+                        existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
+                    }
+                    const targetSegments = isUrl
+                        ? existsRedirect.target.split('?')
+                        : url.pathname.replace(/\/*$/gi, '') + existsRedirect.matchedQueryString;
+                    const [targetPath, targetQueryString] = isUrl
+                        ? targetSegments
+                        : targetSegments
+                            .replace(regexParser(existsRedirect.pattern), existsRedirect.target)
+                            .replace(/^\/\//, '/')
+                            .split('?');
+                    const mergedQueryString = existsRedirect.isQueryStringPreserved
+                        ? mergeURLSearchParams(new URLSearchParams((_a = url.search) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQueryString || ''))
+                        : targetQueryString || '';
+                    const prepareNewURL = new URL(`${targetPath}${mergedQueryString ? '?' + mergedQueryString : ''}`, url.origin);
+                    url.href = prepareNewURL.href;
+                    url.pathname = prepareNewURL.pathname;
+                    url.search = prepareNewURL.search;
+                    url.locale = req.nextUrl.locale;
+                }
+                /** return Response redirect with http code of redirect type */
+                switch (existsRedirect.redirectType) {
+                    case REDIRECT_TYPE_301: {
+                        return this.createRedirectResponse(url, response, 301, 'Moved Permanently');
+                    }
+                    case REDIRECT_TYPE_302: {
+                        return this.createRedirectResponse(url, response, 302, 'Found');
+                    }
+                    case REDIRECT_TYPE_SERVER_TRANSFER: {
+                        return this.rewrite(url.href, req, response);
+                    }
+                    default:
+                        return response;
+                }
+            });
+            const response = yield createResponse();
+            debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
+                redirected: response.redirected,
+                status: response.status,
+                url: response.url,
+                headers: this.extractDebugHeaders(response.headers),
+            });
+            return response;
+        });
+        // NOTE: we provide native fetch for compatibility on Next.js Edge Runtime
+        // (underlying default 'cross-fetch' is not currently compatible: https://github.com/lquixada/cross-fetch/issues/78)
+        this.redirectsService = new GraphQLRedirectsService(Object.assign(Object.assign({}, config), { fetch: fetch }));
+        this.locales = config.locales;
+    }
+    /**
+     * Gets the Next.js middleware handler with error handling
+     * @returns route handler
+     */
+    getHandler() {
+        return (req, res) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.handler(req, res);
+            }
+            catch (error) {
+                console.log('Redirect middleware failed:');
+                console.log(error);
+                return res || NextResponse.next();
+            }
+        });
+    }
+    /**
+     * Method returns RedirectInfo when matches
+     * @param {NextRequest} req request
+     * @param {string} siteName site name
+     * @returns Promise<RedirectInfo | undefined>
+     * @private
+     */
+    getExistsRedirect(req, siteName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { pathname: targetURL, search: targetQS = '', locale } = this.normalizeUrl(req.nextUrl.clone());
+            const normalizedPath = targetURL.replace(/\/*$/gi, '');
+            const redirects = yield this.redirectsService.fetchRedirects(siteName);
+            const language = this.getLanguage(req);
+            const modifyRedirects = structuredClone(redirects);
+            let matchedQueryString;
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    var _a;
+                    if (isRegexOrUrl(redirect.pattern) === 'url') {
+                        const parseUrlPattern = redirect.pattern.endsWith('/')
+                            ? redirect.pattern.slice(0, -1).split('?')
+                            : redirect.pattern.split('?');
+                        return ((parseUrlPattern[0] === normalizedPath ||
+                            parseUrlPattern[0] === `/${locale}${normalizedPath}`) &&
+                            areURLSearchParamsEqual(new URLSearchParams((_a = parseUrlPattern[1]) !== null && _a !== void 0 ? _a : ''), new URLSearchParams(targetQS)));
+                    }
+                    // Modify the redirect pattern to ignore the language prefix in the path
+                    // And escapes non-special "?" characters in a string or regex.
+                    redirect.pattern = escapeNonSpecialQuestionMarks(redirect.pattern.replace(new RegExp(`^[^]?/${language}/`, 'gi'), ''));
+                    // Prepare the redirect pattern as a regular expression, making it more flexible for matching URLs
+                    redirect.pattern = `/^\/${redirect.pattern
+                        .replace(/^\/|\/$/g, '') // Removes leading and trailing slashes
+                        .replace(/^\^\/|\/\$$/g, '') // Removes unnecessary start (^) and end ($) anchors
+                        .replace(/^\^|\$$/g, '') // Further cleans up anchors
+                        .replace(/\$\/gi$/g, '')}[\/]?$/i`; // Ensures the pattern allows an optional trailing slash
+                    matchedQueryString = [
+                        regexParser(redirect.pattern).test(`${normalizedPath}${targetQS}`),
+                        regexParser(redirect.pattern).test(`/${locale}${normalizedPath}${targetQS}`),
+                    ].some(Boolean)
+                        ? targetQS
+                        : undefined;
+                    // Save the matched query string (if found) into the redirect object
+                    redirect.matchedQueryString = matchedQueryString || '';
+                    return (!!(regexParser(redirect.pattern).test(targetURL) ||
+                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${targetURL}`) ||
+                        matchedQueryString) && (redirect.locale ? redirect.locale.toLowerCase() === locale.toLowerCase() : true));
+                })
+                : undefined;
+        });
+    }
+    /**
+     * When a user clicks on a link generated by the Link component from next/link,
+     * Next.js adds special parameters in the route called path.
+     * This method removes these special parameters.
+     * @param {NextURL} url
+     * @returns {string} normalize url
+     */
+    normalizeUrl(url) {
+        if (!url.search) {
+            return url;
+        }
+        /**
+         * Prepare special parameters for exclusion.
+         */
+        const splittedPathname = url.pathname
+            .split('/')
+            .filter((route) => route)
+            .map((route) => `path=${route}`);
+        /**
+         * Remove special parameters(Next.JS)
+         * Example: /about/contact/us
+         * When a user clicks on this link, Next.js should generate a link for the middleware, formatted like this:
+         * http://host/about/contact/us?path=about&path=contact&path=us
+         */
+        const newQueryString = url.search
+            .replace(/^\?/, '')
+            .split('&')
+            .filter((param) => {
+            if (!splittedPathname.includes(param)) {
+                return param;
+            }
+            return false;
+        })
+            .join('&');
+        const newUrl = new URL(`${url.pathname}?${newQueryString}`, url.origin);
+        url.search = newUrl.search;
+        url.pathname = newUrl.pathname;
+        url.href = newUrl.href;
+        return url;
+    }
+    /**
+     * Helper function to create a redirect response and remove the x-middleware-next header.
+     * @param {NextURL} url The URL to redirect to.
+     * @param {Response} res The response object.
+     * @param {number} status The HTTP status code of the redirect.
+     * @param {string} statusText The status text of the redirect.
+     * @returns {NextResponse<unknown>} The redirect response.
+     */
+    createRedirectResponse(url, res, status, statusText) {
+        const redirect = NextResponse.redirect(url, {
+            status,
+            statusText,
+            headers: res === null || res === void 0 ? void 0 : res.headers,
+        });
+        if (res === null || res === void 0 ? void 0 : res.headers) {
+            redirect.headers.delete('x-middleware-next');
+            redirect.headers.delete('x-middleware-rewrite');
+        }
+        return redirect;
+    }
+}

package/dist/esm/monitoring/healthcheck-middleware.js

@@ -0,0 +1,26 @@
+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());
+    });
+};
+/**
+ * Middleware / handler for use in healthcheck Next.js API route (e.g. '/api/healthz').
+ */
+export class HealthcheckMiddleware {
+    constructor() {
+        this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
+            res.status(200).send('Healthy');
+        });
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+}

package/dist/esm/monitoring/index.js

@@ -0,0 +1 @@
+export { HealthcheckMiddleware } from './healthcheck-middleware';