@sitecore-jss/sitecore-jss-nextjs 21.1.0-canary.99 → 22.0.0-canary.2

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

@@ -10,40 +10,39 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { NextResponse } from 'next/server';
 import { getSiteRewrite } from '@sitecore-jss/sitecore-jss/site';
 import { debug } from '@sitecore-jss/sitecore-jss';
+import { MiddlewareBase } from './middleware';
 /**
  * Middleware / handler for multisite support
  */
-export class MultisiteMiddleware {
+export class MultisiteMiddleware extends MiddlewareBase {
     /**
      * @param {MultisiteMiddlewareConfig} [config] Multisite middleware config
      */
     constructor(config) {
+        super(config);
         this.config = config;
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
+            var _a;
             const pathname = req.nextUrl.pathname;
-            const hostHeader = (_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0];
-            const hostname = hostHeader || this.defaultHostname;
+            const language = this.getLanguage(req);
+            const hostname = this.getHostHeader(req) || this.defaultHostname;
             debug.multisite('multisite middleware start: %o', {
                 pathname,
+                language,
                 hostname,
             });
-            if (!hostHeader) {
-                debug.multisite(`host header is missing, default ${hostname} is used`);
-            }
             // Response will be provided if other middleware is run before us
             let response = res || NextResponse.next();
-            if (this.excludeRoute(pathname) ||
-                (this.config.excludeRoute && this.config.excludeRoute(pathname))) {
-                debug.multisite('skipped (route excluded)');
+            if (this.isPreview(req) || this.excludeRoute(pathname)) {
+                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('sc_site') ||
+            const siteName = req.nextUrl.searchParams.get(this.SITE_SYMBOL) ||
                 (this.config.useCookieResolution &&
                     this.config.useCookieResolution(req) &&
-                    ((_b = req.cookies.get('sc_site')) === null || _b === void 0 ? void 0 : _b.value)) ||
-                this.config.getSite(hostname).name;
+                    ((_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 = getSiteRewrite(pathname, {
                 siteName,
@@ -53,7 +52,7 @@ export class MultisiteMiddleware {
             rewriteUrl.pathname = rewritePath;
             response = NextResponse.rewrite(rewriteUrl);
             // Share site name with the following executed middlewares
-            response.cookies.set('sc_site', siteName);
+            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', {
@@ -64,7 +63,6 @@ export class MultisiteMiddleware {
             });
             return response;
         });
-        this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
      * Gets the Next.js middleware handler with error handling
@@ -82,19 +80,4 @@ export class MultisiteMiddleware {
             }
         });
     }
-    excludeRoute(pathname) {
-        if (pathname.includes('.') || // Ignore files
-            pathname.startsWith('/api/') || // Ignore Next.js API calls
-            pathname.startsWith('/sitecore/') || // Ignore Sitecore API calls
-            pathname.startsWith('/_next') // Ignore next service calls
-        ) {
-            return true;
-        }
-        return false;
-    }
-    extractDebugHeaders(incomingHeaders) {
-        const headers = {};
-        incomingHeaders.forEach((value, key) => (headers[key] = value));
-        return headers;
-    }
 }

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

@@ -8,32 +8,30 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { NextResponse, userAgent } from 'next/server';
-import { GraphQLPersonalizeService, CdpService, getPersonalizedRewrite, } from '@sitecore-jss/sitecore-jss/personalize';
+import { GraphQLPersonalizeService, CdpService, getPersonalizedRewrite, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
 import { debug, NativeDataFetcher } from '@sitecore-jss/sitecore-jss';
+import { MiddlewareBase } from './middleware';
 /**
  * Middleware / handler to support Sitecore Personalize
  */
-export class PersonalizeMiddleware {
+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* () {
-            var _a, _b;
-            const hostHeader = (_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0];
-            const hostname = hostHeader || this.defaultHostname;
             const pathname = req.nextUrl.pathname;
-            const language = req.nextUrl.locale || req.nextUrl.defaultLocale || 'en';
-            const siteName = ((_b = res === null || res === void 0 ? void 0 : res.cookies.get('sc_site')) === null || _b === void 0 ? void 0 : _b.value) || this.config.getSite(hostname).name;
+            const language = this.getLanguage(req);
+            const hostname = this.getHostHeader(req) || this.defaultHostname;
             let browserId = this.getBrowserId(req);
             debug.personalize('personalize middleware start: %o', {
                 pathname,
                 language,
+                hostname,
+                browserId,
             });
-            if (!hostHeader) {
-                debug.personalize(`host header is missing, default ${hostname} is used`);
-            }
             // 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)) {
@@ -42,13 +40,13 @@ export class PersonalizeMiddleware {
             }
             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) ||
-                (this.config.excludeRoute && this.config.excludeRoute(pathname))) {
+                this.excludeRoute(pathname)) {
                 debug.personalize('skipped (%s)', response.redirected ? 'redirected' : this.isPreview(req) ? 'preview' : 'route excluded');
                 return response;
             }
+            const site = this.getSite(req, res);
             // Get personalization info from Experience Edge
-            const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, siteName);
+            const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
             if (!personalizeInfo) {
                 // Likely an invalid route / language
                 debug.personalize('skipped (personalize info not found)');
@@ -68,7 +66,9 @@ export class PersonalizeMiddleware {
             // Execute targeted experience in CDP
             const { ua } = userAgent(req);
             const params = this.getExperienceParams(req);
-            const pointOfSale = this.config.getPointOfSale(language);
+            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);
             if (!variantId) {
                 debug.personalize('skipped (no variant identified)');
@@ -94,7 +94,7 @@ export class PersonalizeMiddleware {
             // Set browserId cookie on the response
             this.setBrowserId(response, browserId);
             // Share site name with the following executed middlewares
-            response.cookies.set('sc_site', siteName);
+            response.cookies.set(this.SITE_SYMBOL, site.name);
             debug.personalize('personalize middleware end: %o', {
                 rewritePath,
                 browserId,
@@ -114,7 +114,6 @@ export class PersonalizeMiddleware {
                 });
                 return (url, data) => fetcher.fetch(url, data);
             } }));
-        this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
      * Gets the Next.js middleware handler with error handling
@@ -156,29 +155,4 @@ export class PersonalizeMiddleware {
             },
         };
     }
-    excludeRoute(pathname) {
-        if (pathname.includes('.') || // Ignore files
-            pathname.startsWith('/api/') || // Ignore Next.js API calls
-            pathname.startsWith('/sitecore/') || // Ignore Sitecore API calls
-            pathname.startsWith('/_next') // Ignore next service calls
-        ) {
-            return true;
-        }
-        return false;
-    }
-    isPreview(req) {
-        var _a, _b;
-        return (((_a = req.cookies.get('__prerender_bypass')) === null || _a === void 0 ? void 0 : _a.value) || ((_b = req.cookies.get('__next_preview_data')) === null || _b === void 0 ? void 0 : _b.value));
-    }
-    /**
-     * Safely extract all headers for debug logging
-     * Necessary to avoid middleware issue https://github.com/vercel/next.js/issues/39765
-     * @param {Headers} incomingHeaders Incoming headers
-     * @returns Object with headers as key/value pairs
-     */
-    extractDebugHeaders(incomingHeaders) {
-        const headers = {};
-        incomingHeaders.forEach((value, key) => (headers[key] = value));
-        return headers;
-    }
 }

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

@@ -10,29 +10,43 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import regexParser from 'regex-parser';
 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';
 /**
  * Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
  * compares with current url and redirects to target url
  */
-export class RedirectsMiddleware {
+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* () {
-            var _a;
-            const hostname = this.getHostname(req);
-            const siteName = ((_a = res === null || res === void 0 ? void 0 : res.cookies.get('sc_site')) === null || _a === void 0 ? void 0 : _a.value) || this.config.getSite(hostname).name;
+            const pathname = req.nextUrl.pathname;
+            const language = this.getLanguage(req);
+            const hostname = this.getHostHeader(req) || this.defaultHostname;
+            let site;
+            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())) ||
-                    this.excludeRoute(req.nextUrl.pathname) ||
-                    (this.config.excludeRoute && this.config.excludeRoute(req.nextUrl.pathname))) {
+                if (this.config.disabled && this.config.disabled(req, NextResponse.next())) {
+                    debug.redirects('skipped (redirects middleware is disabled)');
+                    return res || NextResponse.next();
+                }
+                if (this.isPreview(req) || this.excludeRoute(pathname)) {
+                    debug.redirects('skipped (%s)', this.isPreview(req) ? 'preview' : 'route excluded');
                     return res || NextResponse.next();
                 }
+                site = this.getSite(req, res);
                 // Find the redirect from result of RedirectService
-                const existsRedirect = yield this.getExistsRedirect(req, siteName);
+                const existsRedirect = yield this.getExistsRedirect(req, site.name);
                 if (!existsRedirect) {
+                    debug.redirects('skipped (redirect does not exist)');
                     return res || NextResponse.next();
                 }
                 const url = req.nextUrl.clone();
@@ -67,14 +81,20 @@ export class RedirectsMiddleware {
             });
             const response = yield createResponse();
             // Share site name with the following executed middlewares
-            response.cookies.set('sc_site', siteName);
+            // Don't need to set when middleware is disabled
+            site && response.cookies.set(this.SITE_SYMBOL, site.name);
+            debug.redirects('redirects middleware end: %o', {
+                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;
-        this.defaultHostname = config.defaultHostname || 'localhost';
     }
     /**
      * Gets the Next.js API route handler
@@ -83,21 +103,6 @@ export class RedirectsMiddleware {
     getHandler() {
         return this.handler;
     }
-    excludeRoute(pathname) {
-        if (pathname.includes('.') || // Ignore files
-            pathname.startsWith('/api/') || // Ignore Next.js API calls
-            pathname.startsWith('/sitecore/') || // Ignore Sitecore API calls
-            pathname.startsWith('/_next') // Ignore next service calls
-        ) {
-            return true;
-        }
-        return false;
-    }
-    getHostname(req) {
-        var _a;
-        const hostHeader = (_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0];
-        return hostHeader || this.defaultHostname;
-    }
     /**
      * Method returns RedirectInfo when matches
      * @param {NextRequest} req request

package/dist/esm/services/base-graphql-sitemap-service.js

@@ -0,0 +1,199 @@
+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 { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss/graphql';
+import { debug } from '@sitecore-jss/sitecore-jss';
+import { getPersonalizedRewrite } from '@sitecore-jss/sitecore-jss/personalize';
+/** @private */
+export const languageError = 'The list of languages cannot be empty';
+export const siteError = 'The service needs a site name';
+/**
+ * @param {string} siteName to inject into error text
+ * @private
+ */
+export function getSiteEmptyError(siteName) {
+    return `Site "${siteName}" does not exist or site item tree is missing`;
+}
+const languageEmptyError = 'The language must be a non-empty string';
+/**
+ * GQL query made dynamic based on schema differences between SXP and XM Cloud
+ * @param {boolean} usesPersonalize flag to detrmine which variation of a query to run
+ * @returns GraphQL query to fetch site paths with
+ */
+const defaultQuery = (usesPersonalize) => /* GraphQL */ `
+query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
+  $siteName: String!
+  $language: String!
+  $includedPaths: [String]
+  $excludedPaths: [String]
+  $pageSize: Int = 10
+  $after: String
+) {
+  site {
+    siteInfo(site: $siteName) {
+      routes(
+        language: $language
+        includedPaths: $includedPaths
+        excludedPaths: $excludedPaths
+        first: $pageSize
+        after: $after
+      ){
+        total
+        pageInfo {
+          endCursor
+          hasNext
+        }
+        results {
+          path: routePath
+          ${usesPersonalize
+    ? `
+              route {
+                personalization {
+                  variantIds
+                }
+              }`
+    : ''}
+        }
+      }
+    }
+  }
+}
+`;
+/**
+ * Service that fetches the list of site pages using Sitecore's GraphQL API.
+ * Used to handle a single site
+ * This list is used for SSG and Export functionality.
+ * @mixes SearchQueryService<PageListQueryResult>
+ */
+export class BaseGraphQLSitemapService {
+    /**
+     * GraphQL client accessible by descendant classes when needed
+     */
+    get graphQLClient() {
+        return this._graphQLClient;
+    }
+    /**
+     * Gets the default query used for fetching the list of site pages
+     */
+    get query() {
+        return defaultQuery(this.options.includePersonalizedRoutes);
+    }
+    /**
+     * Creates an instance of graphQL sitemap service with the provided options
+     * @param {GraphQLSitemapServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this._graphQLClient = this.getGraphQLClient();
+    }
+    /**
+     * Fetch sitemap which could be used for generation of static pages during `next export`.
+     * The `locale` parameter will be used in the item query, but since i18n is not supported,
+     * the output paths will not include a `language` property.
+     * @param {string} locale which application supports
+     * @returns an array of @see StaticPath objects
+     */
+    fetchExportSitemap(locale) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const formatPath = (path) => ({
+                params: {
+                    path,
+                },
+            });
+            return this.fetchSitemap([locale], formatPath);
+        });
+    }
+    /**
+     * Fetch sitemap which could be used for generation of static pages using SSG mode
+     * @param {string[]} locales locales which application supports
+     * @returns an array of @see StaticPath objects
+     */
+    fetchSSGSitemap(locales) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const formatPath = (path, locale) => ({
+                params: {
+                    path,
+                },
+                locale,
+            });
+            return this.fetchSitemap(locales, formatPath);
+        });
+    }
+    getTranformedPaths(siteName, languages, formatStaticPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const paths = new Array();
+            yield Promise.all(languages.map((language) => __awaiter(this, void 0, void 0, function* () {
+                if (language === '') {
+                    throw new RangeError(languageEmptyError);
+                }
+                debug.sitemap('fetching sitemap data for %s %s', language, siteName);
+                const results = yield this.fetchLanguageSitePaths(language, siteName);
+                const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language);
+                paths.push(...transformedPaths);
+            })));
+            return paths;
+        });
+    }
+    transformLanguageSitePaths(sitePaths, formatStaticPath, language) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const formatPath = (path) => formatStaticPath(path.replace(/^\/|\/$/g, '').split('/'), language);
+            const aggregatedPaths = [];
+            sitePaths.forEach((item) => {
+                var _a, _b, _c, _d;
+                if (!item)
+                    return;
+                aggregatedPaths.push(formatPath(item.path));
+                // check for type safety's sake - personalize may be empty depending on query type
+                if ((_b = (_a = item.route) === null || _a === void 0 ? void 0 : _a.personalization) === null || _b === void 0 ? void 0 : _b.variantIds.length) {
+                    aggregatedPaths.push(...(((_d = (_c = item.route) === null || _c === void 0 ? void 0 : _c.personalization) === null || _d === void 0 ? void 0 : _d.variantIds.map((varId) => formatPath(getPersonalizedRewrite(item.path, { variantId: varId })))) || {}));
+                }
+            });
+            return aggregatedPaths;
+        });
+    }
+    fetchLanguageSitePaths(language, siteName) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const args = {
+                siteName: siteName,
+                language: language,
+                pageSize: this.options.pageSize,
+                includedPaths: this.options.includedPaths,
+                excludedPaths: this.options.excludedPaths,
+            };
+            let results = [];
+            let hasNext = true;
+            let after = '';
+            while (hasNext) {
+                const fetchResponse = yield this.graphQLClient.request(this.query, Object.assign(Object.assign({}, args), { after }));
+                if (!((_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.site) === null || _a === void 0 ? void 0 : _a.siteInfo)) {
+                    throw new RangeError(getSiteEmptyError(siteName));
+                }
+                else {
+                    results = results.concat((_b = fetchResponse.site.siteInfo.routes) === null || _b === void 0 ? void 0 : _b.results);
+                    hasNext = (_c = fetchResponse.site.siteInfo.routes) === null || _c === void 0 ? void 0 : _c.pageInfo.hasNext;
+                    after = (_d = fetchResponse.site.siteInfo.routes) === null || _d === void 0 ? void 0 : _d.pageInfo.endCursor;
+                }
+            }
+            return results;
+        });
+    }
+    /**
+     * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
+     * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
+     * want to use something else.
+     * @returns {GraphQLClient} implementation
+     */
+    getGraphQLClient() {
+        return new GraphQLRequestClient(this.options.endpoint, {
+            apiKey: this.options.apiKey,
+            debugger: debug.sitemap,
+        });
+    }
+}