npm - @sitecore-content-sdk/nextjs - Versions diffs - 1.3.0-canary.9 → 1.4.0-canary.2 - Mend

@sitecore-content-sdk/nextjs 1.3.0-canary.9 → 1.4.0-canary.2

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

package/README.md +11 -11
package/dist/cjs/client/index.js +10 -10
package/dist/cjs/client/models.js +2 -2
package/dist/cjs/client/sitecore-nextjs-client.js +160 -156
package/dist/cjs/components/BYOCWrapper.js +31 -30
package/dist/cjs/components/ComponentPropsContext.js +66 -59
package/dist/cjs/components/FEaaSWrapper.js +33 -32
package/dist/cjs/components/Link.js +117 -90
package/dist/cjs/components/NextImage.js +66 -62
package/dist/cjs/components/Placeholder.js +55 -50
package/dist/cjs/components/RichText.js +133 -128
package/dist/cjs/config/define-config.js +26 -25
package/dist/cjs/config/index.js +5 -5
package/dist/cjs/config-cli/define-cli-config.js +40 -39
package/dist/cjs/config-cli/index.js +5 -5
package/dist/cjs/editing/codegen/import-map.js +129 -118
package/dist/cjs/editing/codegen/index.js +6 -6
package/dist/cjs/editing/constants.js +10 -10
package/dist/cjs/editing/editing-config-middleware.js +70 -69
package/dist/cjs/editing/editing-render-middleware.js +145 -144
package/dist/cjs/editing/feaas-render-middleware.js +102 -101
package/dist/cjs/editing/index.js +19 -19
package/dist/cjs/editing/render-middleware.js +46 -46
package/dist/cjs/editing/utils.js +260 -257
package/dist/cjs/index.js +132 -131
package/dist/cjs/middleware/app-router-multisite-middleware.js +41 -20
package/dist/cjs/middleware/index.js +30 -30
package/dist/cjs/middleware/locale-middleware.js +85 -84
package/dist/cjs/middleware/middleware.js +195 -192
package/dist/cjs/middleware/multisite-middleware.js +141 -118
package/dist/cjs/middleware/personalize-middleware.js +240 -236
package/dist/cjs/middleware/redirects-middleware.js +323 -297
package/dist/cjs/middleware/robots-middleware.js +45 -44
package/dist/cjs/middleware/sitemap-middleware.js +50 -49
package/dist/cjs/monitoring/healthcheck-middleware.js +31 -30
package/dist/cjs/monitoring/index.js +5 -5
package/dist/cjs/route-handler/editing-config-route-handler.js +110 -106
package/dist/cjs/route-handler/editing-render-route-handler.js +270 -165
package/dist/cjs/route-handler/index.js +11 -11
package/dist/cjs/route-handler/robots-route-handler.js +69 -68
package/dist/cjs/route-handler/sitemap-route-handler.js +66 -65
package/dist/cjs/search/index.js +17 -0
package/dist/cjs/services/component-props-service.js +142 -138
package/dist/cjs/sharedTypes/component-props.js +2 -2
package/dist/cjs/sharedTypes/sitecore-page-props.js +2 -2
package/dist/cjs/site/index.js +5 -5
package/dist/cjs/tools/codegen/import-map.js +15 -0
package/dist/cjs/tools/component-props.loader.js +95 -95
package/dist/cjs/tools/generate-map.js +317 -317
package/dist/cjs/tools/index.js +14 -13
package/dist/cjs/tools/templating/byoc-component.js +36 -36
package/dist/cjs/tools/templating/constants.js +7 -7
package/dist/cjs/tools/templating/default-component.js +35 -35
package/dist/cjs/tools/templating/utils.js +200 -0
package/dist/cjs/utils/index.js +14 -14
package/dist/cjs/utils/utils.js +82 -73
package/dist/esm/client/index.js +2 -2
package/dist/esm/client/models.js +1 -1
package/dist/esm/client/sitecore-nextjs-client.js +156 -152
package/dist/esm/components/BYOCWrapper.js +27 -26
package/dist/esm/components/ComponentPropsContext.js +28 -21
package/dist/esm/components/FEaaSWrapper.js +29 -28
package/dist/esm/components/Link.js +78 -51
package/dist/esm/components/NextImage.js +60 -56
package/dist/esm/components/Placeholder.js +18 -13
package/dist/esm/components/RichText.js +96 -91
package/dist/esm/config/define-config.js +21 -20
package/dist/esm/config/index.js +1 -1
package/dist/esm/config-cli/define-cli-config.js +36 -35
package/dist/esm/config-cli/index.js +1 -1
package/dist/esm/editing/codegen/import-map.js +92 -81
package/dist/esm/editing/codegen/index.js +1 -1
package/dist/esm/editing/constants.js +7 -7
package/dist/esm/editing/editing-config-middleware.js +66 -65
package/dist/esm/editing/editing-render-middleware.js +141 -140
package/dist/esm/editing/feaas-render-middleware.js +98 -97
package/dist/esm/editing/index.js +6 -6
package/dist/esm/editing/render-middleware.js +42 -42
package/dist/esm/editing/utils.js +246 -243
package/dist/esm/index.js +25 -25
package/dist/esm/middleware/app-router-multisite-middleware.js +37 -16
package/dist/esm/middleware/index.js +11 -11
package/dist/esm/middleware/locale-middleware.js +81 -80
package/dist/esm/middleware/middleware.js +189 -186
package/dist/esm/middleware/multisite-middleware.js +137 -114
package/dist/esm/middleware/personalize-middleware.js +236 -232
package/dist/esm/middleware/redirects-middleware.js +316 -290
package/dist/esm/middleware/robots-middleware.js +41 -40
package/dist/esm/middleware/sitemap-middleware.js +46 -45
package/dist/esm/monitoring/healthcheck-middleware.js +27 -26
package/dist/esm/monitoring/index.js +1 -1
package/dist/esm/route-handler/editing-config-route-handler.js +106 -102
package/dist/esm/route-handler/editing-render-route-handler.js +265 -160
package/dist/esm/route-handler/index.js +4 -4
package/dist/esm/route-handler/robots-route-handler.js +65 -64
package/dist/esm/route-handler/sitemap-route-handler.js +63 -62
package/dist/esm/search/index.js +1 -0
package/dist/esm/services/component-props-service.js +135 -131
package/dist/esm/sharedTypes/component-props.js +1 -1
package/dist/esm/sharedTypes/sitecore-page-props.js +1 -1
package/dist/esm/site/index.js +1 -1
package/dist/esm/tools/codegen/import-map.js +11 -0
package/dist/esm/tools/component-props.loader.js +59 -59
package/dist/esm/tools/generate-map.js +279 -279
package/dist/esm/tools/index.js +3 -2
package/dist/esm/tools/templating/byoc-component.js +30 -30
package/dist/esm/tools/templating/constants.js +4 -4
package/dist/esm/tools/templating/default-component.js +29 -29
package/dist/esm/tools/templating/utils.js +190 -0
package/dist/esm/utils/index.js +3 -3
package/dist/esm/utils/utils.js +74 -65
package/package.json +87 -13
package/search.d.ts +1 -0
package/types/client/index.d.ts +3 -2
package/types/client/index.d.ts.map +1 -0
package/types/client/models.d.ts +9 -8
package/types/client/models.d.ts.map +1 -0
package/types/client/sitecore-nextjs-client.d.ts +68 -63
package/types/client/sitecore-nextjs-client.d.ts.map +1 -0
package/types/components/BYOCWrapper.d.ts +16 -14
package/types/components/BYOCWrapper.d.ts.map +1 -0
package/types/components/ComponentPropsContext.d.ts +30 -18
package/types/components/ComponentPropsContext.d.ts.map +1 -0
package/types/components/FEaaSWrapper.d.ts +17 -15
package/types/components/FEaaSWrapper.d.ts.map +1 -0
package/types/components/Link.d.ts +25 -15
package/types/components/Link.d.ts.map +1 -0
package/types/components/NextImage.d.ts +11 -6
package/types/components/NextImage.d.ts.map +1 -0
package/types/components/Placeholder.d.ts +14 -8
package/types/components/Placeholder.d.ts.map +1 -0
package/types/components/RichText.d.ts +35 -25
package/types/components/RichText.d.ts.map +1 -0
package/types/config/define-config.d.ts +42 -38
package/types/config/define-config.d.ts.map +1 -0
package/types/config/index.d.ts +2 -1
package/types/config/index.d.ts.map +1 -0
package/types/config-cli/define-cli-config.d.ts +10 -8
package/types/config-cli/define-cli-config.d.ts.map +1 -0
package/types/config-cli/index.d.ts +2 -1
package/types/config-cli/index.d.ts.map +1 -0
package/types/editing/codegen/import-map.d.ts +15 -3
package/types/editing/codegen/import-map.d.ts.map +1 -0
package/types/editing/codegen/index.d.ts +3 -2
package/types/editing/codegen/index.d.ts.map +1 -0
package/types/editing/constants.d.ts +8 -7
package/types/editing/constants.d.ts.map +1 -0
package/types/editing/editing-config-middleware.d.ts +37 -31
package/types/editing/editing-config-middleware.d.ts.map +1 -0
package/types/editing/editing-render-middleware.d.ts +47 -44
package/types/editing/editing-render-middleware.d.ts.map +1 -0
package/types/editing/feaas-render-middleware.d.ts +35 -32
package/types/editing/feaas-render-middleware.d.ts.map +1 -0
package/types/editing/index.d.ts +7 -6
package/types/editing/index.d.ts.map +1 -0
package/types/editing/render-middleware.d.ts +26 -25
package/types/editing/render-middleware.d.ts.map +1 -0
package/types/editing/utils.d.ts +110 -106
package/types/editing/utils.d.ts.map +1 -0
package/types/index.d.ts +25 -24
package/types/index.d.ts.map +1 -0
package/types/middleware/app-router-multisite-middleware.d.ts +28 -13
package/types/middleware/app-router-multisite-middleware.d.ts.map +1 -0
package/types/middleware/index.d.ts +12 -11
package/types/middleware/index.d.ts.map +1 -0
package/types/middleware/locale-middleware.d.ts +35 -32
package/types/middleware/locale-middleware.d.ts.map +1 -0
package/types/middleware/middleware.d.ts +135 -127
package/types/middleware/middleware.d.ts.map +1 -0
package/types/middleware/multisite-middleware.d.ts +54 -37
package/types/middleware/multisite-middleware.d.ts.map +1 -0
package/types/middleware/personalize-middleware.d.ts +81 -65
package/types/middleware/personalize-middleware.d.ts.map +1 -0
package/types/middleware/redirects-middleware.d.ts +68 -65
package/types/middleware/redirects-middleware.d.ts.map +1 -0
package/types/middleware/robots-middleware.d.ts +15 -13
package/types/middleware/robots-middleware.d.ts.map +1 -0
package/types/middleware/sitemap-middleware.d.ts +16 -14
package/types/middleware/sitemap-middleware.d.ts.map +1 -0
package/types/monitoring/healthcheck-middleware.d.ts +14 -12
package/types/monitoring/healthcheck-middleware.d.ts.map +1 -0
package/types/monitoring/index.d.ts +2 -1
package/types/monitoring/index.d.ts.map +1 -0
package/types/route-handler/editing-config-route-handler.d.ts +30 -24
package/types/route-handler/editing-config-route-handler.d.ts.map +1 -0
package/types/route-handler/editing-render-route-handler.d.ts +33 -25
package/types/route-handler/editing-render-route-handler.d.ts.map +1 -0
package/types/route-handler/index.d.ts +5 -4
package/types/route-handler/index.d.ts.map +1 -0
package/types/route-handler/robots-route-handler.d.ts +30 -28
package/types/route-handler/robots-route-handler.d.ts.map +1 -0
package/types/route-handler/sitemap-route-handler.d.ts +30 -28
package/types/route-handler/sitemap-route-handler.d.ts.map +1 -0
package/types/search/index.d.ts +2 -0
package/types/search/index.d.ts.map +1 -0
package/types/services/component-props-service.d.ts +62 -57
package/types/services/component-props-service.d.ts.map +1 -0
package/types/sharedTypes/component-props.d.ts +62 -47
package/types/sharedTypes/component-props.d.ts.map +1 -0
package/types/sharedTypes/sitecore-page-props.d.ts +14 -9
package/types/sharedTypes/sitecore-page-props.d.ts.map +1 -0
package/types/site/index.d.ts +2 -1
package/types/site/index.d.ts.map +1 -0
package/types/tools/codegen/import-map.d.ts +10 -0
package/types/tools/codegen/import-map.d.ts.map +1 -0
package/types/tools/component-props.loader.d.ts +8 -7
package/types/tools/component-props.loader.d.ts.map +1 -0
package/types/tools/generate-map.d.ts +26 -24
package/types/tools/generate-map.d.ts.map +1 -0
package/types/tools/index.d.ts +4 -2
package/types/tools/index.d.ts.map +1 -0
package/types/tools/templating/byoc-component.d.ts +3 -2
package/types/tools/templating/byoc-component.d.ts.map +1 -0
package/types/tools/templating/constants.d.ts +5 -4
package/types/tools/templating/constants.d.ts.map +1 -0
package/types/tools/templating/default-component.d.ts +3 -2
package/types/tools/templating/default-component.d.ts.map +1 -0
package/types/tools/templating/utils.d.ts +44 -0
package/types/tools/templating/utils.d.ts.map +1 -0
package/types/utils/index.d.ts +4 -3
package/types/utils/index.d.ts.map +1 -0
package/types/utils/utils.d.ts +34 -24
package/types/utils/utils.d.ts.map +1 -0
package/client.js +0 -1
package/codegen.js +0 -1
package/config-cli.js +0 -1
package/config.js +0 -1
package/editing.js +0 -1
package/middleware.js +0 -1
package/monitoring.js +0 -1
package/route-handler.js +0 -1
package/site.js +0 -1
package/tools.js +0 -1
package/utils.js +0 -1

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

@@ -1,140 +1,141 @@
-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, NativeDataFetcher } from '@sitecore-content-sdk/core';
-import { QUERY_PARAM_EDITING_SECRET, EDITING_ALLOWED_ORIGINS, } from '@sitecore-content-sdk/core/editing';
-import { LayoutServicePageState } from '@sitecore-content-sdk/core/layout';
-import { getEditingSecret } from '../utils/utils';
-import { RenderMiddlewareBase } from './render-middleware';
-import { getEnforcedCorsHeaders } from '@sitecore-content-sdk/core/utils';
-import { getPreviewCookies, getRequiredEditingParamsList, mapEditingParams, cleanupNextPreviewCookies, getQueryParamsForPropagation, getHeadersForPropagation, getEditingRequestHtml, getCSPHeader, resolveServerUrl, } from './utils';
-/**
- * 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 { body, method, headers, query } = req;
-            debug.editing('editing render middleware start: %o', {
-                method,
-                query,
-                headers,
-                body,
-            });
-            const corsHeaders = getEnforcedCorsHeaders({
-                requestMethod: req.method,
-                headers: req.headers,
-                presetCorsHeader: headers['Access-Control-Allow-Origin'],
-                allowedOrigins: EDITING_ALLOWED_ORIGINS,
-            });
-            if (!corsHeaders) {
-                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>`,
-                });
-            }
-            Object.keys(corsHeaders).forEach((key) => {
-                res.setHeader(key, corsHeaders[key]);
-            });
-            // Validate secret
-            const secret = query[QUERY_PARAM_EDITING_SECRET];
-            if (secret !== getEditingSecret()) {
-                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getEditingSecret());
-                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 requiredQueryParams = getRequiredEditingParamsList(mode);
-            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>`,
-                });
-            }
-            const previewDataParams = mapEditingParams(query);
-            res.setPreviewData(Object.assign(Object.assign({}, previewDataParams), { variantIds: (_b = previewDataParams.variantIds) === null || _b === void 0 ? void 0 : _b.split(',') }), {
-                maxAge: 3,
-            });
-            // Set Preview mode identifier cookie, if the page is rendered in Sitecore Preview mode
-            if (mode === LayoutServicePageState.Preview) {
-                const cookies = res.getHeader('Set-Cookie');
-                const previewCookies = getPreviewCookies(query.sc_site);
-                res.setHeader('Set-Cookie', [...cookies, ...previewCookies]);
-            }
-            // Restrict the page to be rendered only within the allowed origins
-            res.setHeader('Content-Security-Policy', getCSPHeader());
-            const encodedRoute = encodeURI(query.route);
-            const route = ((_d = (_c = this.config) === null || _c === void 0 ? void 0 : _c.resolvePageUrl) === null || _d === void 0 ? void 0 : _d.call(_c, encodedRoute)) || encodedRoute;
-            const base = ((_e = this.config) === null || _e === void 0 ? void 0 : _e.sitecoreInternalEditingHostUrl) || resolveServerUrl(req);
-            const requestUrl = new URL(route, base);
-            const cookies = res.getHeader('Set-Cookie');
-            // Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
-            // Note timestamp effectively disables caching the request (no amount of cache headers seemed to do it)
-            try {
-                debug.editing('fetching page route for %s', query.route);
-                // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
-                const propagatedQsParams = getQueryParamsForPropagation(query);
-                // Get headers to propagate on subsequent requests
-                const propagatedHeaders = getHeadersForPropagation(headers);
-                const html = yield getEditingRequestHtml(requestUrl, propagatedQsParams, propagatedHeaders, cookies, this.dataFetcher);
-                // remove preview cookies to not leak them to the browser
-                if (cookies && Array.isArray(cookies)) {
-                    const filteredCookies = cleanupNextPreviewCookies(cookies);
-                    filteredCookies && res.setHeader('Set-Cookie', filteredCookies);
-                }
-                debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
-                    status: 200,
-                    route,
-                });
-                res.status(200).send(html);
-            }
-            catch (err) {
-                const error = err;
-                console.error(error);
-                if (error.response) {
-                    console.info(
-                    // eslint-disable-next-line quotes
-                    "Hint: for non-standard server or Next.js route configurations, you may need to override 'resolvePageUrl' or set the 'sitecoreInternalEditingHostUrl' (or SITECORE_INTERNAL_EDITING_HOST_URL env variable) available on the 'EditingRenderMiddleware' config.");
-                }
-                res.status(500).send(`<html><body>${error}</body></html>`);
-            }
-        });
-        this.dataFetcher = new NativeDataFetcher({ debugger: debug.editing });
-    }
-    /**
-     * Gets the Next.js API route handler
-     * @returns route handler
-     */
-    getHandler() {
-        return this.handler;
-    }
-}
+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, NativeDataFetcher } from '@sitecore-content-sdk/core';
+import { QUERY_PARAM_EDITING_SECRET, INVALID_SECRET_HTML_MESSAGE, EDITING_ALLOWED_ORIGINS, } from '@sitecore-content-sdk/core/editing';
+import { LayoutServicePageState } from '@sitecore-content-sdk/core/layout';
+import { getEditingSecret } from '../utils/utils';
+import { RenderMiddlewareBase } from './render-middleware';
+import { getEnforcedCorsHeaders } from '@sitecore-content-sdk/core/utils';
+import { getPreviewCookies, getRequiredEditingParamsList, mapEditingParams, cleanupNextPreviewCookies, getQueryParamsForPropagation, getHeadersForPropagation, getEditingRequestHtml, getCSPHeader, resolveServerUrl, } from './utils';
+/**
+ * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
+ * which is required for Sitecore editing support.
+ * @public
+ */
+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 { body, method, headers, query } = req;
+            debug.editing('editing render middleware start: %o', {
+                method,
+                query,
+                headers,
+                body,
+            });
+            const corsHeaders = getEnforcedCorsHeaders({
+                requestMethod: req.method,
+                headers: req.headers,
+                presetCorsHeader: headers['Access-Control-Allow-Origin'],
+                allowedOrigins: EDITING_ALLOWED_ORIGINS,
+            });
+            if (!corsHeaders) {
+                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>`,
+                });
+            }
+            Object.keys(corsHeaders).forEach((key) => {
+                res.setHeader(key, corsHeaders[key]);
+            });
+            // Validate secret
+            const secret = query[QUERY_PARAM_EDITING_SECRET];
+            if (secret !== getEditingSecret()) {
+                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getEditingSecret());
+                return res.status(401).json({
+                    html: INVALID_SECRET_HTML_MESSAGE,
+                });
+            }
+            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 requiredQueryParams = getRequiredEditingParamsList(mode);
+            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>`,
+                });
+            }
+            const previewDataParams = mapEditingParams(query);
+            res.setPreviewData(Object.assign(Object.assign({}, previewDataParams), { variantIds: (_b = previewDataParams.variantIds) === null || _b === void 0 ? void 0 : _b.split(',') }), {
+                maxAge: 3,
+            });
+            // Set Preview mode identifier cookie, if the page is rendered in Sitecore Preview mode
+            if (mode === LayoutServicePageState.Preview) {
+                const cookies = res.getHeader('Set-Cookie');
+                const previewCookies = getPreviewCookies(query.sc_site);
+                res.setHeader('Set-Cookie', [...cookies, ...previewCookies]);
+            }
+            // Restrict the page to be rendered only within the allowed origins
+            res.setHeader('Content-Security-Policy', getCSPHeader());
+            const encodedRoute = encodeURI(query.route);
+            const route = ((_d = (_c = this.config) === null || _c === void 0 ? void 0 : _c.resolvePageUrl) === null || _d === void 0 ? void 0 : _d.call(_c, encodedRoute)) || encodedRoute;
+            const base = ((_e = this.config) === null || _e === void 0 ? void 0 : _e.sitecoreInternalEditingHostUrl) || resolveServerUrl(req);
+            const requestUrl = new URL(route, base);
+            const cookies = res.getHeader('Set-Cookie');
+            // Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
+            // Note timestamp effectively disables caching the request (no amount of cache headers seemed to do it)
+            try {
+                debug.editing('fetching page route for %s', query.route);
+                // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
+                const propagatedQsParams = getQueryParamsForPropagation(query);
+                // Get headers to propagate on subsequent requests
+                const propagatedHeaders = getHeadersForPropagation(headers);
+                const html = yield getEditingRequestHtml(requestUrl, propagatedQsParams, propagatedHeaders, cookies, this.dataFetcher);
+                // remove preview cookies to not leak them to the browser
+                if (cookies && Array.isArray(cookies)) {
+                    const filteredCookies = cleanupNextPreviewCookies(cookies);
+                    filteredCookies && res.setHeader('Set-Cookie', filteredCookies);
+                }
+                debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
+                    status: 200,
+                    route,
+                });
+                res.status(200).send(html);
+            }
+            catch (err) {
+                const error = err;
+                console.error(error);
+                if (error.response) {
+                    console.info(
+                    // eslint-disable-next-line quotes
+                    "Hint: for non-standard server or Next.js route configurations, you may need to override 'resolvePageUrl' or set the 'sitecoreInternalEditingHostUrl' (or SITECORE_INTERNAL_EDITING_HOST_URL env variable) available on the 'EditingRenderMiddleware' config.");
+                }
+                res.status(500).send(`<html><body>${error}</body></html>`);
+            }
+        });
+        this.dataFetcher = new NativeDataFetcher({ debugger: debug.editing });
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+}

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

@@ -1,97 +1,98 @@
-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 { getEditingSecret } 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 !== getEditingSecret()) {
-                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getEditingSecret());
-                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;
-    }
-}
+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, INVALID_SECRET_HTML_MESSAGE, } from '@sitecore-content-sdk/core/editing';
+import { getEditingSecret } 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.
+ * @public
+ */
+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 !== getEditingSecret()) {
+                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getEditingSecret());
+                return res.status(401).send(INVALID_SECRET_HTML_MESSAGE);
+            }
+            // 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 CHANGED Viewed

@@ -1,6 +1,6 @@
-export { EditingService } from '@sitecore-content-sdk/core/editing';
-export { EditingRenderMiddleware, } from './editing-render-middleware';
-export { isDesignLibraryPreviewData, getQueryParamsForPropagation, getHeadersForPropagation, } from './utils';
-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';
+export { EditingService } from '@sitecore-content-sdk/core/editing';
+export { EditingRenderMiddleware, } from './editing-render-middleware';
+export { isDesignLibraryPreviewData, getQueryParamsForPropagation, getHeadersForPropagation, } from './utils';
+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 CHANGED Viewed

@@ -1,42 +1,42 @@
-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.
- * @deprecated getQueryParamsForPropagation and getHeadersForPropagation methods have been moved to separate exports
- */
-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.get
-                    ? headers.get(header)
-                    : headers[header];
-                if (value) {
-                    acc[header] = Array.isArray(value) ? value.join(', ') : value;
-                }
-                return acc;
-            }, {});
-            return filteredHeaders;
-        };
-    }
-}
+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.
+ * @internal
+ */
+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.get
+                    ? headers.get(header)
+                    : headers[header];
+                if (value) {
+                    acc[header] = Array.isArray(value) ? value.join(', ') : value;
+                }
+                return acc;
+            }, {});
+            return filteredHeaders;
+        };
+    }
+}