@sitecore-content-sdk/nextjs 0.1.0-beta.4 → 0.1.0-beta.6

package/dist/cjs/middleware/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MultisiteMiddleware = exports.PersonalizeMiddleware = exports.RedirectsMiddleware = exports.MiddlewareBase = exports.debug = void 0;
+exports.MultisiteMiddleware = exports.PersonalizeMiddleware = exports.RedirectsMiddleware = exports.defineMiddleware = exports.Middleware = exports.MiddlewareBase = exports.debug = void 0;
 var core_1 = require("@sitecore-content-sdk/core");
 Object.defineProperty(exports, "debug", { enumerable: true, get: function () { return core_1.debug; } });
 var middleware_1 = require("./middleware");
 Object.defineProperty(exports, "MiddlewareBase", { enumerable: true, get: function () { return middleware_1.MiddlewareBase; } });
+Object.defineProperty(exports, "Middleware", { enumerable: true, get: function () { return middleware_1.Middleware; } });
+Object.defineProperty(exports, "defineMiddleware", { enumerable: true, get: function () { return middleware_1.defineMiddleware; } });
 var redirects_middleware_1 = require("./redirects-middleware");
 Object.defineProperty(exports, "RedirectsMiddleware", { enumerable: true, get: function () { return redirects_middleware_1.RedirectsMiddleware; } });
 var personalize_middleware_1 = require("./personalize-middleware");

package/dist/cjs/middleware/middleware.js

@@ -1,9 +1,29 @@
 "use strict";
+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());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MiddlewareBase = void 0;
+exports.defineMiddleware = exports.MiddlewareBase = exports.Middleware = void 0;
+const core_1 = require("@sitecore-content-sdk/core");
 const server_1 = require("next/server");
-class MiddlewareBase {
+/**
+ * Middleware class to be extended by all middleware implementations
+ */
+class Middleware {
+}
+exports.Middleware = Middleware;
+/**
+ * Base middleware class with common methods
+ */
+class MiddlewareBase extends Middleware {
     constructor(config) {
+        super();
         this.config = config;
         this.SITE_SYMBOL = 'sc_site';
         this.REWRITE_HEADER_NAME = 'x-sc-rewrite';
@@ -29,12 +49,12 @@ class MiddlewareBase {
         req.headers.get('purpose') === 'prefetch' || req.headers.get('Next-Router-Prefetch') === '1' // Pages Router // App Router
         );
     }
-    excludeRoute(pathname) {
-        var _a, _b;
+    disabled(req, res) {
+        const { pathname } = req.nextUrl;
         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))));
+            (this.config.disabled && this.config.disabled(req, res)));
     }
     /**
      * Safely extract all headers for debug logging
@@ -95,3 +115,26 @@ class MiddlewareBase {
     }
 }
 exports.MiddlewareBase = MiddlewareBase;
+/**
+ * Define a middleware with a list of middlewares
+ * @param {Middleware[]} middlewares List of middlewares to execute
+ */
+const defineMiddleware = (...middlewares) => {
+    return {
+        /**
+         * Execute all middlewares
+         * @param {NextRequest} req request
+         * @param {NextFetchEvent} ev fetch event
+         * @param {NextResponse} [res] response
+         */
+        exec: (req, ev, res) => __awaiter(void 0, void 0, void 0, function* () {
+            const response = res || server_1.NextResponse.next();
+            core_1.debug.common('middleware start');
+            const start = Date.now();
+            const middlewareResponse = yield middlewares.reduce((p, middleware) => p.then((res) => middleware.handle(req, res, ev)), Promise.resolve(response));
+            core_1.debug.common('middleware end in %dms', Date.now() - start);
+            return middlewareResponse;
+        }),
+    };
+};
+exports.defineMiddleware = defineMiddleware;

package/dist/cjs/middleware/multisite-middleware.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MultisiteMiddleware = void 0;
-const server_1 = require("next/server");
 const site_1 = require("@sitecore-content-sdk/core/site");
 const core_1 = require("@sitecore-content-sdk/core");
 const middleware_1 = require("./middleware");
@@ -24,70 +23,63 @@ class MultisiteMiddleware extends middleware_1.MiddlewareBase {
     constructor(config) {
         super(config);
         this.config = config;
-        this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+        this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const pathname = req.nextUrl.pathname;
-            const language = this.getLanguage(req);
-            const hostname = this.getHostHeader(req) || this.defaultHostname;
-            const startTimestamp = Date.now();
-            core_1.debug.multisite('multisite middleware start: %o', {
-                pathname,
-                language,
-                hostname,
-            });
-            // Response will be provided if other middleware is run before us
-            let response = res || server_1.NextResponse.next();
-            if (this.isPreview(req) || this.excludeRoute(pathname)) {
-                core_1.debug.multisite('skipped (%s)', this.isPreview(req) ? 'preview' : 'route excluded');
-                return response;
-            }
-            // Site name can be forced by query string parameter or cookie
-            const siteName = req.nextUrl.searchParams.get(this.SITE_SYMBOL) ||
-                (this.config.useCookieResolution &&
-                    this.config.useCookieResolution(req) &&
-                    ((_a = req.cookies.get(this.SITE_SYMBOL)) === null || _a === void 0 ? void 0 : _a.value)) ||
-                this.config.siteResolver.getByHost(hostname).name;
-            // Rewrite to site specific path
-            const rewritePath = (0, site_1.getSiteRewrite)(pathname, {
-                siteName,
-            });
-            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, defaultCookieAttributes);
-            core_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
-                rewritePath,
-                siteName,
-                headers: this.extractDebugHeaders(response.headers),
-                cookies: response.cookies,
-            });
-            return response;
-        });
-    }
-    /**
-     * 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);
+                const pathname = req.nextUrl.pathname;
+                const language = this.getLanguage(req);
+                const hostname = this.getHostHeader(req) || this.defaultHostname;
+                const startTimestamp = Date.now();
+                core_1.debug.multisite('multisite middleware start: %o', {
+                    pathname,
+                    language,
+                    hostname,
+                });
+                if (this.disabled(req, res)) {
+                    core_1.debug.multisite('skipped (multisite middleware is disabled)');
+                    return res;
+                }
+                if (this.isPreview(req)) {
+                    core_1.debug.multisite('skipped (preview)');
+                    return res;
+                }
+                // Site name can be forced by query string parameter or cookie
+                const siteName = req.nextUrl.searchParams.get(this.SITE_SYMBOL) ||
+                    (this.config.useCookieResolution &&
+                        this.config.useCookieResolution(req) &&
+                        ((_a = req.cookies.get(this.SITE_SYMBOL)) === null || _a === void 0 ? void 0 : _a.value)) ||
+                    this.config.siteResolver.getByHost(hostname).name;
+                // Rewrite to site specific path
+                const rewritePath = (0, site_1.getSiteRewrite)(pathname, {
+                    siteName,
+                });
+                const response = this.rewrite(rewritePath, req, res);
+                // 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, defaultCookieAttributes);
+                core_1.debug.multisite('multisite middleware end in %dms: %o', Date.now() - startTimestamp, {
+                    rewritePath,
+                    siteName,
+                    headers: this.extractDebugHeaders(response.headers),
+                    cookies: response.cookies,
+                });
+                return response;
             }
             catch (error) {
                 console.log('Multisite middleware failed:');
                 console.log(error);
-                return res || server_1.NextResponse.next();
+                return res;
             }
         });
     }
-    excludeRoute(pathname) {
+    disabled(req, res) {
         // ignore files
-        return pathname.includes('.') || super.excludeRoute(pathname);
+        return req.nextUrl.pathname.includes('.') || super.disabled(req, res);
     }
 }
 exports.MultisiteMiddleware = MultisiteMiddleware;

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

@@ -10,12 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PersonalizeMiddleware = void 0;
-const server_1 = require("next/server");
 const personalize_1 = require("@sitecore-content-sdk/core/personalize");
 const core_1 = require("@sitecore-content-sdk/core");
 const middleware_1 = require("./middleware");
-const server_2 = require("@sitecore-cloudsdk/core/server");
-const server_3 = require("@sitecore-cloudsdk/personalize/server");
+const server_1 = require("@sitecore-cloudsdk/core/server");
+const server_2 = require("@sitecore-cloudsdk/personalize/server");
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -26,118 +25,107 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
     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 || server_1.NextResponse.next();
-            core_1.debug.personalize('personalize middleware start: %o', {
-                pathname,
-                language,
-                hostname,
-                headers: this.extractDebugHeaders(req.headers),
-            });
-            if (this.config.disabled && this.config.disabled(req, response)) {
-                core_1.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)) {
-                core_1.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
-                core_1.debug.personalize('skipped (personalize info not found)');
-                return response;
-            }
-            if (personalizeInfo.variantIds.length === 0) {
-                core_1.debug.personalize('skipped (no personalization configured)');
-                return response;
-            }
-            if (this.isPrefetch(req)) {
-                core_1.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)) {
-                        core_1.debug.personalize('invalid variant %s', variantId);
-                    }
-                    else {
-                        identifiedVariantIds.push(variantId);
+        this.handle = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                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;
+                core_1.debug.personalize('personalize middleware start: %o', {
+                    pathname,
+                    language,
+                    hostname,
+                    headers: this.extractDebugHeaders(req.headers),
+                });
+                if (this.disabled(req, res)) {
+                    core_1.debug.personalize('skipped (personalize middleware is disabled)');
+                    return res;
+                }
+                if (res.redirected || // Don't attempt to personalize a redirect
+                    this.isPreview(req) // No need to personalize for preview (layout data is already prepared for preview)
+                ) {
+                    core_1.debug.personalize('skipped (%s)', res.redirected ? 'redirected' : 'preview');
+                    return res;
+                }
+                const site = this.getSite(req, res);
+                // Get personalization info from Experience Edge
+                const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
+                if (!personalizeInfo) {
+                    // Likely an invalid route / language
+                    core_1.debug.personalize('skipped (personalize info not found)');
+                    return res;
+                }
+                if (personalizeInfo.variantIds.length === 0) {
+                    core_1.debug.personalize('skipped (no personalization configured)');
+                    return res;
+                }
+                if (this.isPrefetch(req)) {
+                    core_1.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.
+                    res.headers.set('x-middleware-cache', 'no-cache');
+                    return res;
+                }
+                yield this.initPersonalizeServer({
+                    hostname,
+                    siteName: site.name,
+                    request: req,
+                    response: res,
+                });
+                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)) {
+                            core_1.debug.personalize('invalid variant %s', variantId);
+                        }
+                        else {
+                            identifiedVariantIds.push(variantId);
+                        }
                     }
+                })));
+                if (identifiedVariantIds.length === 0) {
+                    core_1.debug.personalize('skipped (no variant(s) identified)');
+                    return res;
                 }
-            })));
-            if (identifiedVariantIds.length === 0) {
-                core_1.debug.personalize('skipped (no variant(s) identified)');
+                // 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 = (0, personalize_1.getPersonalizedRewrite)(basePath, identifiedVariantIds);
+                const response = this.rewrite(rewritePath, req, res);
+                // 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');
+                core_1.debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
+                    rewritePath,
+                    headers: this.extractDebugHeaders(response.headers),
+                });
                 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 = (0, personalize_1.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');
-            core_1.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 personalize_1.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 || server_1.NextResponse.next();
+                return res;
             }
         });
+        // 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 personalize_1.GraphQLPersonalizeService(Object.assign(Object.assign({}, config.edgeConfig), { fetch: fetch }));
     }
     initPersonalizeServer(_a) {
         return __awaiter(this, arguments, void 0, function* ({ hostname, siteName, request, response, }) {
-            yield (0, server_2.CloudSDK)(request, response, {
+            yield (0, server_1.CloudSDK)(request, response, {
                 sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
                 sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
                 siteName,
@@ -152,7 +140,7 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
         return __awaiter(this, arguments, void 0, function* ({ params, friendlyId, language, timeout, variantIds, }, request) {
             var _b;
             core_1.debug.personalize('executing experience for %s %o', friendlyId, params);
-            return (yield (0, server_3.personalize)(request, {
+            return (yield (0, server_2.personalize)(request, {
                 channel: this.config.cdpConfig.channel || 'WEB',
                 currency: (_b = this.config.cdpConfig.currency) !== null && _b !== void 0 ? _b : 'USD',
                 friendlyId,
@@ -177,9 +165,9 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
             utm: utm,
         };
     }
-    excludeRoute(pathname) {
+    disabled(req, res) {
         // ignore files
-        return pathname.includes('.') || super.excludeRoute(pathname);
+        return req.nextUrl.pathname.includes('.') || super.disabled(req, res);
     }
     /**
      * Aggregates personalize executions based on the provided route personalize information and language