npm - @sitecore-jss/sitecore-jss-nextjs - Versions diffs - 22.0.0-canary.8 → 22.0.0 - Mend

@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.8 → 22.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (104) hide show

package/LICENSE.txt +202 -202
package/README.md +12 -10
package/context.d.ts +1 -0
package/context.js +1 -0
package/dist/cjs/ComponentBuilder.js +63 -0
package/dist/cjs/components/BYOCWrapper.js +47 -0
package/dist/cjs/components/FEaaSWrapper.js +49 -0
package/dist/cjs/components/Link.js +5 -4
package/dist/cjs/components/NextImage.js +3 -14
package/dist/cjs/components/RichText.js +11 -15
package/dist/cjs/context/context.js +83 -0
package/dist/cjs/context/index.js +5 -0
package/dist/cjs/editing/constants.js +6 -0
package/dist/cjs/editing/editing-config-middleware.js +49 -0
package/dist/cjs/editing/editing-data-middleware.js +3 -3
package/dist/cjs/editing/editing-data-service.js +16 -8
package/dist/cjs/editing/editing-render-middleware.js +25 -11
package/dist/cjs/editing/feaas-render-middleware.js +87 -0
package/dist/cjs/editing/index.js +7 -1
package/dist/cjs/editing/render-middleware.js +27 -0
package/dist/cjs/editing/vercel-editing-data-cache.js +48 -0
package/dist/cjs/graphql/index.js +7 -0
package/dist/cjs/index.js +38 -14
package/dist/cjs/middleware/index.js +3 -5
package/dist/cjs/middleware/middleware.js +18 -2
package/dist/cjs/middleware/multisite-middleware.js +14 -8
package/dist/cjs/middleware/personalize-middleware.js +62 -56
package/dist/cjs/middleware/redirects-middleware.js +64 -21
package/dist/cjs/services/base-graphql-sitemap-service.js +7 -6
package/dist/cjs/services/component-props-service.js +6 -6
package/dist/cjs/site/index.js +5 -0
package/dist/cjs/utils/index.js +11 -0
package/dist/cjs/{utils.js → utils/utils.js} +7 -16
package/dist/esm/ComponentBuilder.js +59 -0
package/dist/esm/components/BYOCWrapper.js +42 -0
package/dist/esm/components/FEaaSWrapper.js +44 -0
package/dist/esm/components/Link.js +5 -4
package/dist/esm/components/NextImage.js +2 -12
package/dist/esm/components/RichText.js +11 -15
package/dist/esm/context/context.js +79 -0
package/dist/esm/context/index.js +1 -0
package/dist/esm/editing/constants.js +3 -0
package/dist/esm/editing/editing-config-middleware.js +45 -0
package/dist/esm/editing/editing-data-middleware.js +2 -2
package/dist/esm/editing/editing-data-service.js +14 -6
package/dist/esm/editing/editing-render-middleware.js +25 -11
package/dist/esm/editing/feaas-render-middleware.js +83 -0
package/dist/esm/editing/index.js +3 -0
package/dist/esm/editing/render-middleware.js +23 -0
package/dist/esm/editing/vercel-editing-data-cache.js +44 -0
package/dist/esm/graphql/index.js +1 -0
package/dist/esm/index.js +10 -7
package/dist/esm/middleware/index.js +1 -2
package/dist/esm/middleware/middleware.js +18 -2
package/dist/esm/middleware/multisite-middleware.js +14 -8
package/dist/esm/middleware/personalize-middleware.js +65 -59
package/dist/esm/middleware/redirects-middleware.js +64 -21
package/dist/esm/services/base-graphql-sitemap-service.js +7 -6
package/dist/esm/services/component-props-service.js +6 -6
package/dist/esm/site/index.js +1 -0
package/dist/esm/utils/index.js +2 -0
package/dist/esm/{utils.js → utils/utils.js} +7 -13
package/graphql.d.ts +1 -0
package/graphql.js +1 -0
package/package.json +15 -12
package/site.d.ts +1 -0
package/site.js +1 -0
package/types/ComponentBuilder.d.ts +61 -0
package/types/components/BYOCWrapper.d.ts +19 -0
package/types/components/ComponentPropsContext.d.ts +1 -0
package/types/components/FEaaSWrapper.d.ts +21 -0
package/types/components/Link.d.ts +2 -1
package/types/components/NextImage.d.ts +3 -3
package/types/components/Placeholder.d.ts +3 -1
package/types/components/RichText.d.ts +6 -4
package/types/context/context.d.ts +116 -0
package/types/context/index.d.ts +1 -0
package/types/editing/constants.d.ts +3 -0
package/types/editing/editing-config-middleware.d.ts +29 -0
package/types/editing/editing-data-service.d.ts +12 -4
package/types/editing/editing-render-middleware.d.ts +2 -1
package/types/editing/feaas-render-middleware.d.ts +32 -0
package/types/editing/index.d.ts +3 -0
package/types/editing/render-middleware.d.ts +15 -0
package/types/editing/vercel-editing-data-cache.d.ts +19 -0
package/types/graphql/index.d.ts +1 -0
package/types/index.d.ts +12 -9
package/types/middleware/index.d.ts +1 -2
package/types/middleware/middleware.d.ts +8 -0
package/types/middleware/multisite-middleware.d.ts +15 -0
package/types/middleware/personalize-middleware.d.ts +53 -14
package/types/middleware/redirects-middleware.d.ts +1 -1
package/types/services/base-graphql-sitemap-service.d.ts +7 -10
package/types/services/component-props-service.d.ts +2 -2
package/types/sharedTypes/component-props.d.ts +5 -1
package/types/sharedTypes/module-factory.d.ts +33 -0
package/types/site/index.d.ts +1 -0
package/types/utils/index.d.ts +2 -0
package/types/{utils.d.ts → utils/utils.d.ts} +2 -0
package/utils.d.ts +1 -0
package/utils.js +1 -0
package/types/sharedTypes/component-module.d.ts +0 -13
/package/dist/cjs/sharedTypes/{component-module.js → module-factory.js} +0 -0
/package/dist/esm/sharedTypes/{component-module.js → module-factory.js} +0 -0

package/dist/esm/editing/feaas-render-middleware.js ADDED Viewed

@@ -0,0 +1,83 @@
+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-jss/sitecore-jss';
+import { QUERY_PARAM_EDITING_SECRET } from './constants';
+import { getJssEditingSecret } from '../utils/utils';
+import { RenderMiddlewareBase } from './render-middleware';
+/**
+ * Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
+ * which is required for Sitecore editing support.
+ */
+export class FEAASRenderMiddleware extends RenderMiddlewareBase {
+    /**
+     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+     */
+    constructor(config) {
+        var _a;
+        super();
+        this.config = config;
+        this.defaultPageUrl = '/feaas/render';
+        this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            const { method, query, headers } = req;
+            const startTimestamp = Date.now();
+            debug.editing('feaas render middleware start: %o', {
+                method,
+                query,
+                headers,
+            });
+            if (method !== 'GET') {
+                debug.editing('invalid method - sent %s expected GET', method);
+                res.setHeader('Allow', 'GET');
+                return res.status(405).send(`<html><body>Invalid request method '${method}'</body></html>`);
+            }
+            // Validate secret
+            const secret = query[QUERY_PARAM_EDITING_SECRET];
+            if (secret !== getJssEditingSecret()) {
+                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
+                return res.status(401).send('<html><body>Missing or invalid secret</body></html>');
+            }
+            try {
+                // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
+                const params = this.getQueryParamsForPropagation(query);
+                // Enable Next.js Preview Mode
+                res.setPreviewData({});
+                const queryParams = new URLSearchParams();
+                for (const key in params) {
+                    if ({}.hasOwnProperty.call(params, key)) {
+                        queryParams.append(key, params[key]);
+                    }
+                }
+                // Pass "feaasSrc" in case a FEAASComponent is being requested
+                if (query.feaasSrc) {
+                    queryParams.append('feaasSrc', query.feaasSrc);
+                }
+                const redirectUrl = this.pageUrl + (queryParams.toString() ? `?${queryParams.toString()}` : '');
+                debug.editing('redirecting to page route %s', redirectUrl);
+                debug.editing('feaas render middleware end in %dms', Date.now() - startTimestamp);
+                res.redirect(redirectUrl);
+            }
+            catch (err) {
+                const error = err;
+                console.info(
+                // eslint-disable-next-line quotes
+                "Hint: for non-standard server or Next.js route configurations, you may need to override the 'pageUrl' available on the 'FEAASRenderMiddleware' config.");
+                res.status(500).send(`<html><body>${error}</body></html>`);
+            }
+        });
+        this.pageUrl = (_a = config === null || config === void 0 ? void 0 : config.pageUrl) !== null && _a !== void 0 ? _a : this.defaultPageUrl;
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+}

package/dist/esm/editing/index.js CHANGED Viewed

@@ -2,3 +2,6 @@ export { EditingDataDiskCache } from './editing-data-cache';
 export { EditingDataMiddleware } from './editing-data-middleware';
 export { EditingRenderMiddleware, } from './editing-render-middleware';
 export { BasicEditingDataService, ServerlessEditingDataService, editingDataService, } from './editing-data-service';
+export { VercelEditingDataCache } from './vercel-editing-data-cache';
+export { FEAASRenderMiddleware } from './feaas-render-middleware';
+export { EditingConfigMiddleware, } from './editing-config-middleware';

package/dist/esm/editing/render-middleware.js ADDED Viewed

@@ -0,0 +1,23 @@
+import { QUERY_PARAM_PROTECTION_BYPASS_SITECORE, QUERY_PARAM_PROTECTION_BYPASS_VERCEL, } from './constants';
+/**
+ * Base class for middleware that handles pages and components rendering in Sitecore Editors.
+ */
+export class RenderMiddlewareBase {
+    constructor() {
+        /**
+         * Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
+         * @param {Object} query Object of query parameters from incoming URL
+         * @returns Object of approved query parameters
+         */
+        this.getQueryParamsForPropagation = (query) => {
+            const params = {};
+            if (query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
+                params[QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
+            }
+            if (query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
+                params[QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
+            }
+            return params;
+        };
+    }
+}

package/dist/esm/editing/vercel-editing-data-cache.js ADDED Viewed

@@ -0,0 +1,44 @@
+import { createClient } from '@vercel/kv';
+import { debug } from '@sitecore-jss/sitecore-jss';
+/**
+ * Implementation of editing cache for Vercel deployments
+ * Uses Vercel KV database and client to store data
+ * Set TTL for cache data in constructor (default: 60 seconds)
+ */
+export class VercelEditingDataCache {
+    /**
+     * @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
+     * @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
+     */
+    constructor(redisUrl, redisToken) {
+        this.defaultTtl = 120;
+        if (!redisUrl || !redisToken) {
+            throw Error('API URL or token are missing, ensure you have set the KV or Upstash storage correctly.');
+        }
+        this.redisCache = createClient({
+            url: redisUrl,
+            token: redisToken,
+        });
+    }
+    set(key, editingData) {
+        debug.editing(`Putting editing data for ${key} into redis storage...`);
+        return new Promise((resolve, reject) => {
+            this.redisCache
+                .set(key, JSON.stringify(editingData), { ex: this.defaultTtl })
+                .then(() => resolve())
+                .catch((err) => reject(err));
+        });
+    }
+    get(key) {
+        debug.editing(`Getting editing data for ${key} from redis storage...`);
+        return new Promise((resolve, reject) => {
+            this.redisCache
+                .get(key)
+                .then((entry) => {
+                const result = (entry || undefined);
+                this.redisCache.expire(key, 0).then(() => resolve(result));
+            })
+                .catch((err) => reject(err));
+        });
+    }
+}

package/dist/esm/graphql/index.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { DefaultRetryStrategy, GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';

package/dist/esm/index.js CHANGED Viewed

@@ -1,21 +1,24 @@
-export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, } from '@sitecore-jss/sitecore-jss';
-export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue, } from '@sitecore-jss/sitecore-jss/utils';
-export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
+export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
+export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, getContentStylesheetLink, } from '@sitecore-jss/sitecore-jss/layout';
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
 export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
-export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
-export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
 export { ComponentPropsService } from './services/component-props-service';
 export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
 export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
 export { MultisiteGraphQLSitemapService, } from './services/mutisite-graphql-sitemap-service';
 export { GraphQLSitemapXmlService, GraphQLErrorPagesService, GraphQLRobotsService, SiteResolver, GraphQLSiteInfoService, getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, } from '@sitecore-jss/sitecore-jss/site';
 export { ComponentPropsReactContext, ComponentPropsContext, useComponentProps, } from './components/ComponentPropsContext';
-export { handleEditorFastRefresh, getPublicUrl } from './utils';
 export { Link } from './components/Link';
 export { RichText } from './components/RichText';
 export { Placeholder } from './components/Placeholder';
 export { EditingComponentPlaceholder } from './components/EditingComponentPlaceholder';
 export { NextImage } from './components/NextImage';
-export { Image, Text, DateField, EditFrame, FEaaSComponent, getFEAASLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';
+import * as FEaaSWrapper from './components/FEaaSWrapper';
+import * as BYOCWrapper from './components/BYOCWrapper';
+export { FEaaSWrapper };
+export { BYOCWrapper };
+export { ComponentBuilder } from './ComponentBuilder';
+export { Context } from './context';
+export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';

package/dist/esm/middleware/index.js CHANGED Viewed

@@ -1,5 +1,4 @@
+export { debug } from '@sitecore-jss/sitecore-jss';
 export { RedirectsMiddleware } from './redirects-middleware';
 export { PersonalizeMiddleware } from './personalize-middleware';
 export { MultisiteMiddleware } from './multisite-middleware';
-export { SiteResolver } from '@sitecore-jss/sitecore-jss/site';
-export { tryParseEnvValue } from '@sitecore-jss/sitecore-jss/utils';

package/dist/esm/middleware/middleware.js CHANGED Viewed

@@ -1,7 +1,9 @@
+import { NextResponse } from 'next/server';
 export class MiddlewareBase {
     constructor(config) {
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
+        this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
         this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
@@ -15,8 +17,7 @@ export class MiddlewareBase {
     }
     excludeRoute(pathname) {
         var _a, _b;
-        return (pathname.includes('.') || // Ignore files
-            pathname.startsWith('/api/') || // Ignore Next.js API calls
+        return (pathname.startsWith('/api/') || // Ignore Next.js API calls
             pathname.startsWith('/sitecore/') || // Ignore Sitecore API calls
             pathname.startsWith('/_next') || // Ignore next service calls
             (((_a = this.config) === null || _a === void 0 ? void 0 : _a.excludeRoute) && ((_b = this.config) === null || _b === void 0 ? void 0 : _b.excludeRoute(pathname))));
@@ -63,4 +64,19 @@ export class MiddlewareBase {
         const hostname = this.getHostHeader(req) || this.defaultHostname;
         return this.config.siteResolver.getByHost(hostname);
     }
+    /**
+     * Create a rewrite response
+     * @param {string} rewritePath the destionation path
+     * @param {NextRequest} req the current request
+     * @param {NextResponse} res the current response
+     */
+    rewrite(rewritePath, req, res) {
+        // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
+        const rewriteUrl = req.nextUrl.clone();
+        rewriteUrl.pathname = rewritePath;
+        const response = NextResponse.rewrite(rewriteUrl, res);
+        // Share rewrite path with following executed middlewares
+        response.headers.set(this.REWRITE_HEADER_NAME, rewritePath);
+        return response;
+    }
 }

package/dist/esm/middleware/multisite-middleware.js CHANGED Viewed

@@ -26,6 +26,7 @@ export class MultisiteMiddleware extends MiddlewareBase {
             const pathname = req.nextUrl.pathname;
             const language = this.getLanguage(req);
             const hostname = this.getHostHeader(req) || this.defaultHostname;
+            const startTimestamp = Date.now();
             debug.multisite('multisite middleware start: %o', {
                 pathname,
                 language,
@@ -47,15 +48,16 @@ export class MultisiteMiddleware extends MiddlewareBase {
             const rewritePath = getSiteRewrite(pathname, {
                 siteName,
             });
-            // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
-            const rewriteUrl = req.nextUrl.clone();
-            rewriteUrl.pathname = rewritePath;
-            response = NextResponse.rewrite(rewriteUrl);
+            response = this.rewrite(rewritePath, req, response);
+            // default site cookie attributes
+            const defaultCookieAttributes = {
+                secure: true,
+                httpOnly: true,
+                sameSite: 'none',
+            };
             // Share site name with the following executed middlewares
-            response.cookies.set(this.SITE_SYMBOL, siteName);
-            // Share rewrite path with following executed middlewares
-            response.headers.set('x-sc-rewrite', rewritePath);
-            debug.multisite('multisite middleware end: %o', {
+            response.cookies.set(this.SITE_SYMBOL, siteName, defaultCookieAttributes);
+            debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
                 siteName,
                 headers: this.extractDebugHeaders(response.headers),
@@ -80,4 +82,8 @@ export class MultisiteMiddleware extends MiddlewareBase {
             }
         });
     }
+    excludeRoute(pathname) {
+        // ignore files
+        return pathname.includes('.') || super.excludeRoute(pathname);
+    }
 }

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

@@ -7,10 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { NextResponse, userAgent } from 'next/server';
-import { GraphQLPersonalizeService, CdpService, getPersonalizedRewrite, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
-import { debug, NativeDataFetcher } from '@sitecore-jss/sitecore-jss';
+import { NextResponse } from 'next/server';
+import { GraphQLPersonalizeService, getPersonalizedRewrite, } from '@sitecore-jss/sitecore-jss/personalize';
+import { debug } from '@sitecore-jss/sitecore-jss';
 import { MiddlewareBase } from './middleware';
+import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -25,15 +26,16 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             const pathname = req.nextUrl.pathname;
             const language = this.getLanguage(req);
             const hostname = this.getHostHeader(req) || this.defaultHostname;
-            let browserId = this.getBrowserId(req);
+            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,
-                browserId,
+                headers: this.extractDebugHeaders(req.headers),
             });
-            // Response will be provided if other middleware is run before us (e.g. redirects)
-            let response = res || NextResponse.next();
             if (this.config.disabled && this.config.disabled(req, response)) {
                 debug.personalize('skipped (personalize middleware is disabled)');
                 return response;
@@ -44,7 +46,7 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
                 return response;
             }
-            const site = this.getSite(req, res);
+            const site = this.getSite(req, response);
             // Get personalization info from Experience Edge
             const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
             if (!personalizeInfo) {
@@ -56,20 +58,24 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 debug.personalize('skipped (no personalization configured)');
                 return response;
             }
-            if (!browserId) {
-                browserId = yield this.cdpService.generateBrowserId();
-                if (!browserId) {
-                    debug.personalize('skipped (browser id generation failed)');
-                    return response;
-                }
-            }
-            // Execute targeted experience in CDP
-            const { ua } = userAgent(req);
+            yield this.initPersonalizeServer({
+                hostname,
+                siteName: site.name,
+                request: req,
+                response,
+            });
             const params = this.getExperienceParams(req);
-            const pointOfSale = this.config.getPointOfSale
-                ? this.config.getPointOfSale(site, language)
-                : PosResolver.resolve(site, language);
-            const variantId = yield this.cdpService.executeExperience(personalizeInfo.contentId, browserId, ua, pointOfSale, params);
+            debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
+            let variantId;
+            // Execute targeted experience in Personalize SDK
+            // eslint-disable-next-line no-useless-catch
+            try {
+                const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
+                variantId = personalization.variantId;
+            }
+            catch (error) {
+                throw error;
+            }
             if (!variantId) {
                 debug.personalize('skipped (no variant identified)');
                 return response;
@@ -82,22 +88,12 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
             // Rewrite to persononalized path
             const rewritePath = getPersonalizedRewrite(basePath, { variantId });
-            // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
-            const rewriteUrl = req.nextUrl.clone();
-            rewriteUrl.pathname = rewritePath;
-            response = NextResponse.rewrite(rewriteUrl);
+            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/issues/32727
             response.headers.set('x-middleware-cache', 'no-cache');
-            // Share rewrite path with following executed middlewares
-            response.headers.set('x-sc-rewrite', rewritePath);
-            // Set browserId cookie on the response
-            this.setBrowserId(response, browserId);
-            // Share site name with the following executed middlewares
-            response.cookies.set(this.SITE_SYMBOL, site.name);
-            debug.personalize('personalize middleware end: %o', {
+            debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
-                browserId,
                 headers: this.extractDebugHeaders(response.headers),
             });
             return response;
@@ -105,15 +101,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
         // 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 }));
-        // NOTE: same here, we provide NativeDataFetcher for compatibility on Next.js Edge Runtime
-        this.cdpService = new CdpService(Object.assign(Object.assign({}, config.cdpConfig), { dataFetcherResolver: ({ timeout, headers, }) => {
-                const fetcher = new NativeDataFetcher({
-                    debugger: debug.personalize,
-                    timeout,
-                    headers,
-                });
-                return (url, data) => fetcher.fetch(url, data);
-            } }));
     }
     /**
      * Gets the Next.js middleware handler with error handling
@@ -131,28 +118,47 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             }
         });
     }
-    get browserIdCookieName() {
-        // Each user should have saved identifier to connect between session, CDP uses bid cookies + local storage
-        return `BID_${this.config.cdpConfig.clientKey}`;
+    initPersonalizeServer({ hostname, siteName, request, response, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield init(request, response, {
+                sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
+                sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
+                siteName,
+                cookieDomain: hostname,
+                enableServerCookie: true,
+            });
+        });
     }
-    getBrowserId(req) {
+    personalize({ params, personalizeInfo, language, timeout, }, request) {
         var _a;
-        return ((_a = req.cookies.get(this.browserIdCookieName)) === null || _a === void 0 ? void 0 : _a.value) || undefined;
-    }
-    setBrowserId(res, browserId) {
-        const expiryDate = new Date(new Date().setFullYear(new Date().getFullYear() + 2));
-        const options = { expires: expiryDate, secure: true };
-        res.cookies.set(this.browserIdCookieName, browserId, options);
+        return __awaiter(this, void 0, void 0, function* () {
+            const personalizationData = {
+                channel: this.config.cdpConfig.channel || 'WEB',
+                currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
+                friendlyId: personalizeInfo.contentId,
+                params,
+                language,
+            };
+            return (yield personalize(request, personalizationData, { 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 {
-            referrer: req.referrer,
-            utm: {
-                campaign: req.nextUrl.searchParams.get('utm_campaign'),
-                content: req.nextUrl.searchParams.get('utm_content'),
-                medium: req.nextUrl.searchParams.get('utm_medium'),
-                source: req.nextUrl.searchParams.get('utm_source'),
-            },
+            // 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);
+    }
 }

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

@@ -12,6 +12,8 @@ import { NextResponse } from 'next/server';
 import { GraphQLRedirectsService, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, } from '@sitecore-jss/sitecore-jss/site';
 import { debug } from '@sitecore-jss/sitecore-jss';
 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
@@ -28,13 +30,14 @@ export class RedirectsMiddleware extends MiddlewareBase {
             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* () {
-                if (this.config.disabled && this.config.disabled(req, NextResponse.next())) {
+                if (this.config.disabled && this.config.disabled(req, res || NextResponse.next())) {
                     debug.redirects('skipped (redirects middleware is disabled)');
                     return res || NextResponse.next();
                 }
@@ -49,41 +52,59 @@ export class RedirectsMiddleware extends MiddlewareBase {
                     debug.redirects('skipped (redirect does not exist)');
                     return res || NextResponse.next();
                 }
+                // 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);
+                }
                 const url = req.nextUrl.clone();
-                const absoluteUrlRegex = new RegExp('^(?:[a-z]+:)?//', 'i');
-                if (absoluteUrlRegex.test(existsRedirect.target)) {
+                if (REGEXP_ABSOLUTE_URL.test(existsRedirect.target)) {
                     url.href = existsRedirect.target;
-                    url.locale = req.nextUrl.locale;
                 }
                 else {
+                    const source = `${url.pathname}${url.search}`;
                     url.search = existsRedirect.isQueryStringPreserved ? url.search : '';
                     const urlFirstPart = existsRedirect.target.split('/')[1];
                     if (this.locales.includes(urlFirstPart)) {
                         url.locale = urlFirstPart;
-                        url.pathname = existsRedirect.target.replace(`/${urlFirstPart}`, '');
+                        existsRedirect.target = existsRedirect.target.replace(`/${urlFirstPart}`, '');
                     }
-                    else {
-                        url.pathname = existsRedirect.target;
+                    const target = source
+                        .replace(regexParser(existsRedirect.pattern), existsRedirect.target)
+                        .replace(/^\/\//, '/')
+                        .split('?');
+                    url.pathname = target[0];
+                    if (target[1]) {
+                        const newParams = new URLSearchParams(target[1]);
+                        for (const [key, val] of newParams.entries()) {
+                            url.searchParams.append(key, val);
+                        }
                     }
                 }
                 const redirectUrl = decodeURIComponent(url.href);
                 /** return Response redirect with http code of redirect type **/
                 switch (existsRedirect.redirectType) {
                     case REDIRECT_TYPE_301:
-                        return NextResponse.redirect(redirectUrl, 301);
+                        return NextResponse.redirect(redirectUrl, {
+                            status: 301,
+                            statusText: 'Moved Permanently',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case REDIRECT_TYPE_302:
-                        return NextResponse.redirect(redirectUrl, 302);
+                        return NextResponse.redirect(redirectUrl, {
+                            status: 302,
+                            statusText: 'Found',
+                            headers: res === null || res === void 0 ? void 0 : res.headers,
+                        });
                     case REDIRECT_TYPE_SERVER_TRANSFER:
-                        return NextResponse.rewrite(redirectUrl);
+                        return NextResponse.rewrite(redirectUrl, res);
                     default:
-                        return NextResponse.next();
+                        return res || NextResponse.next();
                 }
             });
             const response = yield createResponse();
-            // Share site name with the following executed middlewares
-            // Don't need to set when middleware is disabled
-            site && response.cookies.set(this.SITE_SYMBOL, site.name);
-            debug.redirects('redirects middleware end: %o', {
+            debug.redirects('redirects middleware end in %dms: %o', Date.now() - startTimestamp, {
                 redirected: response.redirected,
                 status: response.status,
                 url: response.url,
@@ -97,11 +118,20 @@ export class RedirectsMiddleware extends MiddlewareBase {
         this.locales = config.locales;
     }
     /**
-     * Gets the Next.js API route handler
+     * Gets the Next.js middleware handler with error handling
      * @returns route handler
      */
     getHandler() {
-        return this.handler;
+        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
@@ -113,10 +143,23 @@ export class RedirectsMiddleware extends MiddlewareBase {
     getExistsRedirect(req, siteName) {
         return __awaiter(this, void 0, void 0, function* () {
             const redirects = yield this.redirectsService.fetchRedirects(siteName);
-            return redirects.length
-                ? redirects.find((redirect) => {
-                    return ((regexParser(redirect.pattern.toLowerCase()).test(req.nextUrl.pathname.toLowerCase()) ||
-                        regexParser(redirect.pattern.toLowerCase()).test(`/${req.nextUrl.locale}${req.nextUrl.pathname}`.toLowerCase())) &&
+            const tragetURL = req.nextUrl.pathname;
+            const targetQS = req.nextUrl.search || '';
+            const language = this.getLanguage(req);
+            const modifyRedirects = structuredClone(redirects);
+            return modifyRedirects.length
+                ? modifyRedirects.find((redirect) => {
+                    redirect.pattern = redirect.pattern.replace(RegExp(`^[^]?/${language}/`, 'gi'), '');
+                    redirect.pattern = `/^\/${redirect.pattern
+                        .replace(/^\/|\/$/g, '')
+                        .replace(/^\^\/|\/\$$/g, '')
+                        .replace(/^\^|\$$/g, '')
+                        .replace(/(?<!\\)\?/g, '\\?')
+                        .replace(/\$\/gi$/g, '')}[\/]?$/gi`;
+                    return ((regexParser(redirect.pattern).test(tragetURL) ||
+                        regexParser(redirect.pattern).test(`${tragetURL}${targetQS}`) ||
+                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}`) ||
+                        regexParser(redirect.pattern).test(`/${req.nextUrl.locale}${tragetURL}${targetQS}`)) &&
                         (redirect.locale
                             ? redirect.locale.toLowerCase() === req.nextUrl.locale.toLowerCase()
                             : true));