npm - @sitecore-content-sdk/nextjs - Versions diffs - 0.1.0-beta.1 - Mend

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

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 (112) hide show

package/LICENSE.txt +202 -0
package/README.md +10 -0
package/dist/cjs/ComponentBuilder.js +63 -0
package/dist/cjs/components/BYOCWrapper.js +41 -0
package/dist/cjs/components/ComponentPropsContext.js +57 -0
package/dist/cjs/components/FEaaSWrapper.js +43 -0
package/dist/cjs/components/Link.js +87 -0
package/dist/cjs/components/NextImage.js +82 -0
package/dist/cjs/components/Placeholder.js +49 -0
package/dist/cjs/components/RichText.js +95 -0
package/dist/cjs/editing/constants.js +10 -0
package/dist/cjs/editing/editing-config-middleware.js +62 -0
package/dist/cjs/editing/editing-render-middleware.js +182 -0
package/dist/cjs/editing/feaas-render-middleware.js +101 -0
package/dist/cjs/editing/index.js +16 -0
package/dist/cjs/editing/render-middleware.js +43 -0
package/dist/cjs/graphql/index.js +7 -0
package/dist/cjs/index.js +119 -0
package/dist/cjs/middleware/index.js +13 -0
package/dist/cjs/middleware/middleware.js +97 -0
package/dist/cjs/middleware/multisite-middleware.js +93 -0
package/dist/cjs/middleware/personalize-middleware.js +231 -0
package/dist/cjs/middleware/redirects-middleware.js +264 -0
package/dist/cjs/monitoring/healthcheck-middleware.js +30 -0
package/dist/cjs/monitoring/index.js +5 -0
package/dist/cjs/services/base-graphql-sitemap-service.js +206 -0
package/dist/cjs/services/component-props-service.js +167 -0
package/dist/cjs/services/graphql-sitemap-service.js +64 -0
package/dist/cjs/services/mutisite-graphql-sitemap-service.js +81 -0
package/dist/cjs/sharedTypes/component-props.js +2 -0
package/dist/cjs/sharedTypes/module-factory.js +2 -0
package/dist/cjs/site/index.js +5 -0
package/dist/cjs/utils/index.js +11 -0
package/dist/cjs/utils/utils.js +42 -0
package/dist/esm/ComponentBuilder.js +59 -0
package/dist/esm/components/BYOCWrapper.js +36 -0
package/dist/esm/components/ComponentPropsContext.js +19 -0
package/dist/esm/components/FEaaSWrapper.js +38 -0
package/dist/esm/components/Link.js +48 -0
package/dist/esm/components/NextImage.js +76 -0
package/dist/esm/components/Placeholder.js +12 -0
package/dist/esm/components/RichText.js +55 -0
package/dist/esm/editing/constants.js +7 -0
package/dist/esm/editing/editing-config-middleware.js +58 -0
package/dist/esm/editing/editing-render-middleware.js +177 -0
package/dist/esm/editing/feaas-render-middleware.js +97 -0
package/dist/esm/editing/index.js +5 -0
package/dist/esm/editing/render-middleware.js +39 -0
package/dist/esm/graphql/index.js +1 -0
package/dist/esm/index.js +23 -0
package/dist/esm/middleware/index.js +5 -0
package/dist/esm/middleware/middleware.js +93 -0
package/dist/esm/middleware/multisite-middleware.js +89 -0
package/dist/esm/middleware/personalize-middleware.js +227 -0
package/dist/esm/middleware/redirects-middleware.js +257 -0
package/dist/esm/monitoring/healthcheck-middleware.js +26 -0
package/dist/esm/monitoring/index.js +1 -0
package/dist/esm/services/base-graphql-sitemap-service.js +201 -0
package/dist/esm/services/component-props-service.js +160 -0
package/dist/esm/services/graphql-sitemap-service.js +59 -0
package/dist/esm/services/mutisite-graphql-sitemap-service.js +77 -0
package/dist/esm/sharedTypes/component-props.js +1 -0
package/dist/esm/sharedTypes/module-factory.js +1 -0
package/dist/esm/site/index.js +1 -0
package/dist/esm/utils/index.js +3 -0
package/dist/esm/utils/utils.js +37 -0
package/editing.d.ts +1 -0
package/editing.js +1 -0
package/global.d.ts +21 -0
package/graphql.d.ts +1 -0
package/graphql.js +1 -0
package/middleware.d.ts +1 -0
package/middleware.js +1 -0
package/monitoring.d.ts +1 -0
package/monitoring.js +1 -0
package/package.json +92 -0
package/site.d.ts +1 -0
package/site.js +1 -0
package/types/ComponentBuilder.d.ts +59 -0
package/types/components/BYOCWrapper.d.ts +20 -0
package/types/components/ComponentPropsContext.d.ts +18 -0
package/types/components/FEaaSWrapper.d.ts +22 -0
package/types/components/Link.d.ts +10 -0
package/types/components/NextImage.d.ts +6 -0
package/types/components/Placeholder.d.ts +8 -0
package/types/components/RichText.d.ts +32 -0
package/types/editing/constants.d.ts +7 -0
package/types/editing/editing-config-middleware.d.ts +29 -0
package/types/editing/editing-render-middleware.d.ts +79 -0
package/types/editing/feaas-render-middleware.d.ts +32 -0
package/types/editing/index.d.ts +5 -0
package/types/editing/render-middleware.d.ts +24 -0
package/types/graphql/index.d.ts +1 -0
package/types/index.d.ts +24 -0
package/types/middleware/index.d.ts +5 -0
package/types/middleware/middleware.d.ts +82 -0
package/types/middleware/multisite-middleware.d.ts +39 -0
package/types/middleware/personalize-middleware.d.ts +102 -0
package/types/middleware/redirects-middleware.d.ts +57 -0
package/types/monitoring/healthcheck-middleware.d.ts +12 -0
package/types/monitoring/index.d.ts +1 -0
package/types/services/base-graphql-sitemap-service.d.ts +148 -0
package/types/services/component-props-service.d.ts +81 -0
package/types/services/graphql-sitemap-service.d.ts +51 -0
package/types/services/mutisite-graphql-sitemap-service.d.ts +42 -0
package/types/sharedTypes/component-props.d.ts +26 -0
package/types/sharedTypes/module-factory.d.ts +32 -0
package/types/site/index.d.ts +1 -0
package/types/utils/index.d.ts +3 -0
package/types/utils/utils.d.ts +8 -0
package/utils.d.ts +1 -0
package/utils.js +1 -0

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

@@ -0,0 +1,177 @@
+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 { LayoutServicePageState } from '@sitecore-content-sdk/core/layout';
+import { QUERY_PARAM_EDITING_SECRET, EDITING_ALLOWED_ORIGINS, } from '@sitecore-content-sdk/core/editing';
+import { getJssEditingSecret } from '../utils/utils';
+import { RenderMiddlewareBase } from './render-middleware';
+import { enforceCors, getAllowedOriginsFromEnv } from '@sitecore-content-sdk/core/utils';
+import { DEFAULT_VARIANT } from '@sitecore-content-sdk/core/personalize';
+/**
+ * Type guard for Component Library mode
+ * @param {object} data preview data to check
+ * @returns true if the data is EditingPreviewData
+ * @see EditingPreviewData
+ */
+export const isComponentLibraryPreviewData = (data) => {
+    return (typeof data === 'object' &&
+        data !== null &&
+        'mode' in data &&
+        data.mode === 'library');
+};
+/**
+ * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
+ * which is required for Sitecore editing support.
+ */
+export class EditingRenderMiddleware extends RenderMiddlewareBase {
+    /**
+     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+     */
+    constructor(config) {
+        super();
+        this.config = config;
+        this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e;
+            const { query, body, method, headers } = req;
+            debug.editing('editing render middleware start: %o', {
+                method,
+                query,
+                headers,
+                body,
+            });
+            if (!enforceCors(req, res, EDITING_ALLOWED_ORIGINS)) {
+                debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
+                return res.status(401).json({
+                    html: `<html><body>Requests from origin ${(_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin} not allowed</body></html>`,
+                });
+            }
+            // Validate secret
+            const secret = (_b = query[QUERY_PARAM_EDITING_SECRET]) !== null && _b !== void 0 ? _b : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
+            if (secret !== getJssEditingSecret()) {
+                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
+                return res.status(401).json({
+                    html: '<html><body>Missing or invalid secret</body></html>',
+                });
+            }
+            if (req.method === 'OPTIONS') {
+                debug.editing('preflight request');
+                // CORS headers are set by enforceCors
+                return res.status(204).send(null);
+            }
+            if (req.method !== 'GET') {
+                debug.editing('invalid method - sent %s expected GET', req.method);
+                res.setHeader('Allow', 'GET');
+                return res.status(405).json({
+                    html: `<html><body>Invalid request method '${req.method}'</body></html>`,
+                });
+            }
+            const startTimestamp = Date.now();
+            const mode = query.mode;
+            const defaultRequiredParams = ['sc_site', 'sc_itemid', 'sc_lang', 'route', 'mode'];
+            const componentRequiredParams = [
+                'sc_site',
+                'sc_itemid',
+                'sc_renderingId',
+                'sc_uid',
+                'sc_lang',
+                'mode',
+            ];
+            const requiredQueryParams = mode === 'library' ? componentRequiredParams : defaultRequiredParams;
+            const missingQueryParams = requiredQueryParams.filter((param) => !query[param]);
+            // Validate query parameters
+            if (missingQueryParams.length) {
+                debug.editing('missing required query parameters: %o', missingQueryParams);
+                return res.status(400).json({
+                    html: `<html><body>Missing required query parameters: ${missingQueryParams.join(', ')}</body></html>`,
+                });
+            }
+            if (mode === 'library') {
+                // dedicated route and layout to SSR component library
+                query.route = '/component-library/render';
+                res.setPreviewData({
+                    itemId: query.sc_itemid,
+                    componentUid: query.sc_uid,
+                    renderingId: query.sc_renderingId,
+                    language: query.sc_lang,
+                    site: query.sc_site,
+                    pageState: LayoutServicePageState.Normal,
+                    mode: 'library',
+                    dataSourceId: query.sc_datasourceId,
+                    version: query.sc_version,
+                }, {
+                    maxAge: 3,
+                });
+            }
+            else {
+                res.setPreviewData({
+                    site: query.sc_site,
+                    itemId: query.sc_itemid,
+                    language: query.sc_lang,
+                    // for sc_variantId we may employ multiple variants (page-layout + component level)
+                    variantIds: ((_c = query.sc_variant) === null || _c === void 0 ? void 0 : _c.split(',')) || [DEFAULT_VARIANT],
+                    version: query.sc_version,
+                    pageState: query.mode,
+                    layoutKind: query.sc_layoutKind,
+                },
+                // Cache the preview data for 3 seconds to ensure the page is rendered with the correct preview data not the cached one
+                {
+                    maxAge: 3,
+                });
+            }
+            // Cookies with the SameSite=Lax policy set by Next.js setPreviewData function causes CORS issue
+            // when Next.js preview mode is activated, resulting the page to render in normal mode instead.
+            // By replacing it with "SameSite=None; Secure", we ensure cookies are correctly sent with
+            // cross-origin requests, allowing the page to be editable. This change should be reverted
+            // once vercel addresses this open issue: https://github.com/vercel/next.js/issues/49927
+            const setCookieHeader = res.getHeader('Set-Cookie');
+            if (setCookieHeader && Array.isArray(setCookieHeader)) {
+                const modifiedCookies = setCookieHeader.map((cookie) => {
+                    const cookieIdentifiers = {
+                        __prerender_bypass: /^__prerender_bypass=/,
+                        __next_preview_data: /^__next_preview_data=/,
+                    };
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    for (const [_, regex] of Object.entries(cookieIdentifiers)) {
+                        if (cookie.match(regex)) {
+                            return cookie.replace(/SameSite=Lax/, 'SameSite=None; Secure');
+                        }
+                    }
+                    return cookie;
+                });
+                res.setHeader('Set-Cookie', modifiedCookies);
+            }
+            const route = ((_e = (_d = this.config) === null || _d === void 0 ? void 0 : _d.resolvePageUrl) === null || _e === void 0 ? void 0 : _e.call(_d, query.route)) || query.route;
+            debug.editing('editing render middleware end in %dms: redirect %o', Date.now() - startTimestamp, {
+                status: 307,
+                route,
+            });
+            // Restrict the page to be rendered only within the allowed origins
+            res.setHeader('Content-Security-Policy', this.getSCPHeader());
+            res.redirect(route);
+        });
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+    /**
+     * Gets the Content-Security-Policy header value
+     * @returns Content-Security-Policy header value
+     */
+    getSCPHeader() {
+        return `frame-ancestors 'self' ${[
+            ...getAllowedOriginsFromEnv(),
+            ...EDITING_ALLOWED_ORIGINS,
+        ].join(' ')}`;
+    }
+}

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

@@ -0,0 +1,97 @@
+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 { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-content-sdk/core/editing';
+import { getJssEditingSecret } from '../utils/utils';
+import { RenderMiddlewareBase } from './render-middleware';
+import { enforceCors } from '@sitecore-content-sdk/core/utils';
+/**
+ * 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* () {
+            var _a;
+            const { method, query, headers } = req;
+            const startTimestamp = Date.now();
+            debug.editing('feaas render middleware start: %o', {
+                method,
+                query,
+                headers,
+            });
+            if (!enforceCors(req, res, EDITING_ALLOWED_ORIGINS)) {
+                debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
+                return res
+                    .status(401)
+                    .send(`<html><body>Requests from origin ${(_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin} are not allowed</body></html>`);
+            }
+            if (!method || !['GET', 'OPTIONS'].includes(method)) {
+                debug.editing('invalid method - sent %s expected GET,OPTIONS', method);
+                res.setHeader('Allow', 'GET, OPTIONS');
+                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>');
+            }
+            // Handle preflight request
+            if (method === 'OPTIONS') {
+                debug.editing('preflight request');
+                // CORS headers are set by enforceCors
+                return res.status(204).send(null);
+            }
+            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 ADDED Viewed

@@ -0,0 +1,5 @@
+export { GraphQLEditingService } from '@sitecore-content-sdk/core/editing';
+export { EditingRenderMiddleware, isComponentLibraryPreviewData, } from './editing-render-middleware';
+export { FEAASRenderMiddleware } from './feaas-render-middleware';
+export { EditingConfigMiddleware, } from './editing-config-middleware';
+export { RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-content-sdk/core/layout';

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

@@ -0,0 +1,39 @@
+import { QUERY_PARAM_VERCEL_PROTECTION_BYPASS, QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE, EDITING_PASS_THROUGH_HEADERS, } 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_VERCEL_PROTECTION_BYPASS]) {
+                params[QUERY_PARAM_VERCEL_PROTECTION_BYPASS] = query[QUERY_PARAM_VERCEL_PROTECTION_BYPASS];
+            }
+            if (query[QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE]) {
+                params[QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE] = query[QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE];
+            }
+            return params;
+        };
+        /**
+         * Get headers that should be passed along to subsequent requests
+         * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
+         * @returns Object of approved headers
+         */
+        this.getHeadersForPropagation = (headers) => {
+            // Filter and normalize headers
+            const filteredHeaders = EDITING_PASS_THROUGH_HEADERS.reduce((acc, header) => {
+                const value = headers[header];
+                if (value) {
+                    acc[header] = Array.isArray(value) ? value.join(', ') : value;
+                }
+                return acc;
+            }, {});
+            return filteredHeaders;
+        };
+    }
+}

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

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

package/dist/esm/index.js ADDED Viewed

@@ -0,0 +1,23 @@
+export { constants,
+// generic data access
+NativeDataFetcher, enableDebug, debug, MemoryCacheClient, } from '@sitecore-content-sdk/core';
+export { LayoutServicePageState, GraphQLLayoutService, getChildPlaceholder, getFieldValue, getContentStylesheetLink, EditMode, } from '@sitecore-content-sdk/core/layout';
+export { RestComponentLayoutService } from '@sitecore-content-sdk/core/editing';
+export { mediaApi } from '@sitecore-content-sdk/core/media';
+export { GraphQLDictionaryService, } from '@sitecore-content-sdk/core/i18n';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-content-sdk/core/personalize';
+export { ComponentPropsService } from './services/component-props-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-content-sdk/core/site';
+export { ComponentPropsReactContext, ComponentPropsContext, useComponentProps, } from './components/ComponentPropsContext';
+export { Link } from './components/Link';
+export { RichText } from './components/RichText';
+export { Placeholder } from './components/Placeholder';
+export { NextImage } from './components/NextImage';
+import * as FEaaSWrapper from './components/FEaaSWrapper';
+import * as BYOCWrapper from './components/BYOCWrapper';
+export { FEaaSWrapper };
+export { BYOCWrapper };
+export { ComponentBuilder } from './ComponentBuilder';
+export { Image, Text, DateField, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getComponentLibraryStylesheetLinks, File, ComponentLibraryLayout, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-content-sdk/react';

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

@@ -0,0 +1,5 @@
+export { debug } from '@sitecore-content-sdk/core';
+export { MiddlewareBase } from './middleware';
+export { RedirectsMiddleware } from './redirects-middleware';
+export { PersonalizeMiddleware } from './personalize-middleware';
+export { MultisiteMiddleware } from './multisite-middleware';

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

@@ -0,0 +1,93 @@
+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';
+    }
+    /**
+     * Determines if mode is preview
+     * @param {NextRequest} req request
+     * @returns {boolean} is preview
+     */
+    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));
+    }
+    /**
+     * Determines if the request is a Next.js (next/link) prefetch request
+     * @param {NextRequest} req request
+     * @returns {boolean} is prefetch
+     */
+    isPrefetch(req) {
+        return (
+        // eslint-disable-next-line prettier/prettier
+        req.headers.get('purpose') === 'prefetch' || req.headers.get('Next-Router-Prefetch') === '1' // Pages Router // App Router
+        );
+    }
+    excludeRoute(pathname) {
+        var _a, _b;
+        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))));
+    }
+    /**
+     * 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;
+    }
+    /**
+     * Provides used language
+     * @param {NextRequest} req request
+     * @returns {string} language
+     */
+    getLanguage(req) {
+        return req.nextUrl.locale || req.nextUrl.defaultLocale || 'en';
+    }
+    /**
+     * Extract 'host' header
+     * @param {NextRequest} req request
+     */
+    getHostHeader(req) {
+        var _a;
+        return (_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0];
+    }
+    /**
+     * Get site information.
+     * Can not be used in **Preview** mode, since site will not be resolved
+     * @param {NextRequest} req request
+     * @param {NextResponse} [res] response
+     * @returns {SiteInfo} site information
+     */
+    getSite(req, res) {
+        var _a;
+        const siteNameCookie = (_a = res === null || res === void 0 ? void 0 : res.cookies.get(this.SITE_SYMBOL)) === null || _a === void 0 ? void 0 : _a.value;
+        if (siteNameCookie)
+            return this.config.siteResolver.getByName(siteNameCookie);
+        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 ADDED Viewed

@@ -0,0 +1,89 @@
+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 { getSiteRewrite } from '@sitecore-content-sdk/core/site';
+import { debug } from '@sitecore-content-sdk/core';
+import { MiddlewareBase } from './middleware';
+/**
+ * Middleware / handler for multisite support
+ */
+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;
+            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,
+                hostname,
+            });
+            // Response will be provided if other middleware is run before us
+            let response = res || NextResponse.next();
+            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(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 = 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);
+            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);
+            }
+            catch (error) {
+                console.log('Multisite middleware failed:');
+                console.log(error);
+                return res || NextResponse.next();
+            }
+        });
+    }
+    excludeRoute(pathname) {
+        // ignore files
+        return pathname.includes('.') || super.excludeRoute(pathname);
+    }
+}