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/cjs/route-handler/editing-render-route-handler.js CHANGED Viewed

@@ -1,165 +1,270 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEditingRenderRouteHandlers = void 0;
-exports.getNextCookies = getNextCookies;
-const core_1 = require("@sitecore-content-sdk/core");
-const editing_1 = require("@sitecore-content-sdk/core/editing");
-const utils_1 = require("@sitecore-content-sdk/core/utils");
-const layout_1 = require("@sitecore-content-sdk/core/layout");
-const utils_2 = require("../utils/utils");
-const headers_1 = require("next/headers");
-const utils_3 = require("../editing/utils");
-const site_1 = require("@sitecore-content-sdk/core/site");
-/**
- * Helper function to handle cookie operations - can be mocked for testing
- * @returns {Promise<NextCookies>} Next cookies
- */
-function getNextCookies() {
-    return __awaiter(this, void 0, void 0, function* () {
-        // In test environment, use mock cookie store only if specifically provided
-        if (process.env.TEST === 'true' && global.__TEST_COOKIE_STORE__) {
-            return global.__TEST_COOKIE_STORE__;
-        }
-        return yield (0, headers_1.cookies)();
-    });
-}
-const createEditingRenderRouteHandlers = (options) => {
-    const dataFetcher = new core_1.NativeDataFetcher({ debugger: core_1.debug.editing });
-    const OPTIONS = (req) => {
-        var _a;
-        // init query string values
-        const query = {};
-        req.nextUrl.searchParams.forEach((value, key) => {
-            query[key] = value;
-        });
-        const expectedCorsHeaders = (0, utils_1.getEnforcedCorsHeaders)({
-            requestMethod: req.method,
-            headers: req.headers,
-            presetCorsHeader: (_a = req.headers) === null || _a === void 0 ? void 0 : _a.get('Access-Control-Allow-Origin'),
-            allowedOrigins: editing_1.EDITING_ALLOWED_ORIGINS,
-        });
-        if (!expectedCorsHeaders) {
-            core_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
-            return new Response(`<html><body>Requests from origin ${req.headers.get('origin')} not allowed</body></html>`, { status: 401 });
-        }
-        core_1.debug.editing('preflight request');
-        return new Response(null, { status: 204, headers: expectedCorsHeaders });
-    };
-    const GET = (req) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a, _b;
-        const { method, headers } = req;
-        // init query string values
-        const query = {};
-        req.nextUrl.searchParams.forEach((value, key) => {
-            query[key] = value;
-        });
-        core_1.debug.editing('editing render handler start: %o', {
-            method,
-            query,
-            headers,
-        });
-        const expectedCorsHeaders = (0, utils_1.getEnforcedCorsHeaders)({
-            requestMethod: req.method,
-            headers: headers,
-            presetCorsHeader: headers.get('Access-Control-Allow-Origin'),
-            allowedOrigins: editing_1.EDITING_ALLOWED_ORIGINS,
-        });
-        if (!expectedCorsHeaders) {
-            core_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
-            return new Response(`<html><body>Requests from origin ${req.headers.get('origin')} not allowed</body></html>`, { status: 401 });
-        }
-        const responseHeaders = expectedCorsHeaders;
-        // Validate secret
-        const secret = query[editing_1.QUERY_PARAM_EDITING_SECRET];
-        if (secret !== (0, utils_2.getEditingSecret)()) {
-            core_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_2.getEditingSecret)());
-            return Response.json({
-                html: '<html><body>Missing or invalid secret</body></html>',
-            }, { status: 401, headers: responseHeaders });
-        }
-        // enable preview
-        const draft = yield (0, headers_1.draftMode)();
-        draft.enable();
-        const startTimestamp = Date.now();
-        const mode = query.mode;
-        const requiredQueryParams = (0, utils_3.getRequiredEditingParamsList)(mode);
-        const missingQueryParams = requiredQueryParams.filter((param) => !query[param]);
-        // Validate query parameters
-        if (missingQueryParams.length) {
-            core_1.debug.editing('missing required query parameters: %o', missingQueryParams);
-            return Response.json({
-                html: `<html><body>Missing required query parameters: ${missingQueryParams.join(', ')}</body></html>`,
-            }, { status: 400, headers: responseHeaders });
-        }
-        const encodedRoute = encodeURI(query.route);
-        const route = ((_a = options === null || options === void 0 ? void 0 : options.resolvePageUrl) === null || _a === void 0 ? void 0 : _a.call(options, encodedRoute)) || encodedRoute;
-        const base = (0, utils_3.resolveServerUrl)(req);
-        const requestUrl = new URL(route, base);
-        // Restrict the page to be rendered only within the allowed origins
-        responseHeaders['Content-Security-Policy'] = (0, utils_3.getCSPHeader)();
-        const cookieStore = yield getNextCookies();
-        cookieStore.set("__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */, ((_b = cookieStore.get("__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */)) === null || _b === void 0 ? void 0 : _b.value) || '', {
-            httpOnly: true,
-            path: '/',
-            sameSite: 'none',
-            secure: true,
-        });
-        // Set Preview mode identifier cookies, if the page is rendered in Sitecore Preview mode
-        if (mode === layout_1.LayoutServicePageState.Preview) {
-            cookieStore.set(editing_1.PREVIEW_KEY, 'true', {
-                httpOnly: true,
-                path: '/',
-                sameSite: 'none',
-                secure: true,
-            });
-            cookieStore.set(site_1.SITE_KEY, query.sc_site, {
-                httpOnly: true,
-                path: '/',
-                sameSite: 'none',
-                secure: true,
-            });
-        }
-        const convertedCookies = cookieStore.getAll().map((c) => `${c.name}=${c.value}`);
-        try {
-            core_1.debug.editing('fetching page route for %s', query.route);
-            // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
-            // Additionally ,in app router preview data is passed through query string instead of preview data cookie
-            const propagatedQsParams = Object.assign(Object.assign({}, (0, utils_3.getQueryParamsForPropagation)(query)), (0, utils_3.mapEditingParams)(query));
-            // Get headers to propagate on subsequent requests
-            const propagatedHeaders = (0, utils_3.getHeadersForPropagation)(headers);
-            const html = yield (0, utils_3.getEditingRequestHtml)(requestUrl, propagatedQsParams, propagatedHeaders, convertedCookies, dataFetcher);
-            // remove nextjs preview cookies to not leak them to the browser
-            const filteredCookies = (0, utils_3.cleanupNextPreviewCookies)(convertedCookies);
-            responseHeaders['Set-Cookie'] = (filteredCookies === null || filteredCookies === void 0 ? void 0 : filteredCookies.join('; ')) || '';
-            core_1.debug.editing('editing render handler end in %dms: %o', Date.now() - startTimestamp, {
-                status: 200,
-                route,
-            });
-            responseHeaders['Content-Type'] = 'text/html; charset=utf-8';
-            return new Response(html, { status: 200, headers: responseHeaders });
-        }
-        catch (err) {
-            core_1.debug.editing('error fetching page route %s: %o', requestUrl, err);
-            core_1.debug.editing('falling back to redirect method... ');
-            core_1.debug.editing('editing render handler end in %dms: redirect %o', Date.now() - startTimestamp, {
-                status: 307,
-                route,
-            });
-            return Response.redirect(route);
-        }
-        finally {
-            yield draft.disable();
-        }
-    });
-    return { GET, OPTIONS };
-};
-exports.createEditingRenderRouteHandlers = createEditingRenderRouteHandlers;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEditingRenderRouteHandlers = void 0;
+exports.getNextCookies = getNextCookies;
+const core_1 = require("@sitecore-content-sdk/core");
+const editing_1 = require("@sitecore-content-sdk/core/editing");
+const utils_1 = require("@sitecore-content-sdk/core/utils");
+const layout_1 = require("@sitecore-content-sdk/core/layout");
+const utils_2 = require("../utils/utils");
+const headers_1 = require("next/headers");
+const utils_3 = require("../editing/utils");
+const site_1 = require("@sitecore-content-sdk/core/site");
+/**
+ * Helper function to handle cookie operations - can be mocked for testing
+ * @returns {Promise<NextCookies>} Next cookies
+ */
+function getNextCookies() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // In test environment, use mock cookie store only if specifically provided
+        if (process.env.TEST === 'true' && global.__TEST_COOKIE_STORE__) {
+            return global.__TEST_COOKIE_STORE__;
+        }
+        return yield (0, headers_1.cookies)();
+    });
+}
+/**
+ * Creates a route handler for the editing render API route (e.g. '/api/editing/render')
+ * @param {EditingHandlerOptions} options - The options for the route handler.
+ * @returns The route handler object with GET and OPTIONS methods.
+ * @public
+ */
+const createEditingRenderRouteHandlers = (options) => {
+    const dataFetcher = new core_1.NativeDataFetcher({ debugger: core_1.debug.editing });
+    const getCorsHeaders = (req) => {
+        var _a;
+        const expectedCorsHeaders = (0, utils_1.getEnforcedCorsHeaders)({
+            requestMethod: req.method,
+            headers: req.headers,
+            presetCorsHeader: (_a = req.headers) === null || _a === void 0 ? void 0 : _a.get('Access-Control-Allow-Origin'),
+            allowedOrigins: editing_1.EDITING_ALLOWED_ORIGINS,
+        });
+        if (!expectedCorsHeaders) {
+            core_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
+        }
+        return expectedCorsHeaders;
+    };
+    const getOriginNotAllowedMessage = (origin) => {
+        return `<html><body>Requests from origin ${origin} not allowed</body></html>`;
+    };
+    const validateEditingSecret = (receivedSecret) => {
+        const editingSecret = (0, utils_2.getEditingSecret)();
+        const secretIsvalid = editingSecret === receivedSecret;
+        if (!secretIsvalid) {
+            core_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', receivedSecret, editingSecret);
+        }
+        return secretIsvalid;
+    };
+    const OPTIONS = (req) => {
+        // init query string values
+        const query = {};
+        req.nextUrl.searchParams.forEach((value, key) => {
+            query[key] = value;
+        });
+        const expectedCorsHeaders = getCorsHeaders(req);
+        if (!expectedCorsHeaders) {
+            return new Response(getOriginNotAllowedMessage(req.headers.get('origin') || ''), {
+                status: 401,
+            });
+        }
+        core_1.debug.editing('preflight request');
+        return new Response(null, { status: 204, headers: expectedCorsHeaders });
+    };
+    const GET = (req) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b;
+        const { method, headers } = req;
+        // init query string values
+        const query = {};
+        req.nextUrl.searchParams.forEach((value, key) => {
+            query[key] = value;
+        });
+        core_1.debug.editing('editing render handler start: %o', {
+            method,
+            query,
+            headers,
+        });
+        const expectedCorsHeaders = getCorsHeaders(req);
+        if (!expectedCorsHeaders) {
+            return new Response(getOriginNotAllowedMessage(req.headers.get('origin') || ''), {
+                status: 401,
+            });
+        }
+        const responseHeaders = expectedCorsHeaders;
+        // Validate secret
+        if (!validateEditingSecret(query[editing_1.QUERY_PARAM_EDITING_SECRET])) {
+            return Response.json({
+                html: editing_1.INVALID_SECRET_HTML_MESSAGE,
+            }, { status: 401, headers: responseHeaders });
+        }
+        // enable preview
+        const draft = yield (0, headers_1.draftMode)();
+        draft.enable();
+        const startTimestamp = Date.now();
+        const mode = query.mode;
+        const requiredQueryParams = (0, utils_3.getRequiredEditingParamsList)(mode);
+        const missingQueryParams = requiredQueryParams.filter((param) => !query[param]);
+        // Validate query parameters
+        if (missingQueryParams.length) {
+            core_1.debug.editing('missing required query parameters: %o', missingQueryParams);
+            return Response.json({
+                html: `<html><body>Missing required query parameters: ${missingQueryParams.join(', ')}</body></html>`,
+            }, { status: 400, headers: responseHeaders });
+        }
+        const encodedRoute = encodeURI(query.route);
+        const route = ((_a = options === null || options === void 0 ? void 0 : options.resolvePageUrl) === null || _a === void 0 ? void 0 : _a.call(options, encodedRoute)) || encodedRoute;
+        const base = (0, utils_3.resolveServerUrl)(req);
+        const requestUrl = new URL(route, base);
+        // Restrict the page to be rendered only within the allowed origins
+        responseHeaders['Content-Security-Policy'] = (0, utils_3.getCSPHeader)();
+        const cookieStore = yield getNextCookies();
+        cookieStore.set("__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */, ((_b = cookieStore.get("__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */)) === null || _b === void 0 ? void 0 : _b.value) || '', {
+            httpOnly: true,
+            path: '/',
+            sameSite: 'none',
+            secure: true,
+        });
+        // Set Preview mode identifier cookies, if the page is rendered in Sitecore Preview mode
+        if (mode === layout_1.LayoutServicePageState.Preview) {
+            cookieStore.set(editing_1.PREVIEW_KEY, 'true', {
+                httpOnly: true,
+                path: '/',
+                sameSite: 'none',
+                secure: true,
+            });
+            cookieStore.set(site_1.SITE_KEY, query.sc_site, {
+                httpOnly: true,
+                path: '/',
+                sameSite: 'none',
+                secure: true,
+            });
+        }
+        const convertedCookies = cookieStore.getAll().map((c) => `${c.name}=${c.value}`);
+        try {
+            core_1.debug.editing('fetching page route for %s', query.route);
+            // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
+            // Additionally ,in app router preview data is passed through query string instead of preview data cookie
+            const propagatedQsParams = Object.assign(Object.assign({}, (0, utils_3.getQueryParamsForPropagation)(query)), (0, utils_3.mapEditingParams)(query));
+            // Get headers to propagate on subsequent requests
+            const propagatedHeaders = (0, utils_3.getHeadersForPropagation)(headers);
+            const html = yield (0, utils_3.getEditingRequestHtml)(requestUrl, propagatedQsParams, propagatedHeaders, convertedCookies, dataFetcher);
+            // remove nextjs preview cookies to not leak them to the browser
+            const filteredCookies = (0, utils_3.cleanupNextPreviewCookies)(convertedCookies);
+            responseHeaders['Set-Cookie'] = (filteredCookies === null || filteredCookies === void 0 ? void 0 : filteredCookies.join('; ')) || '';
+            core_1.debug.editing('editing render handler end in %dms: %o', Date.now() - startTimestamp, {
+                status: 200,
+                route,
+            });
+            responseHeaders['Content-Type'] = 'text/html; charset=utf-8';
+            return new Response(html, { status: 200, headers: responseHeaders });
+        }
+        catch (err) {
+            core_1.debug.editing('error fetching page route %s: %o', requestUrl, err);
+            core_1.debug.editing('falling back to redirect method... ');
+            core_1.debug.editing('editing render handler end in %dms: redirect %o', Date.now() - startTimestamp, {
+                status: 307,
+                route,
+            });
+            return Response.redirect(route);
+        }
+        finally {
+            yield draft.disable();
+        }
+    });
+    /**
+     * This POST handler serves as proxy for server action call when Design Library is rendering server component.
+     * When Design Library needs to dynamically update or render a generated variant of server component a server action {@link updateServerComponentAction} is called from the client side.
+     * The way server functions work is that the action call is made to the same URL with POST method, which in normal page render is handled internally by Next.js.
+     * However, in editing mode we are in an api route handler scenario so we need to proxy the POST request to be able to process the server action correctly.
+     * @param {NextRequest} req - The incoming request
+     */
+    const POST = (req) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const requestOrigin = req.headers.get('origin') || '';
+        const originHost = new URL(requestOrigin).host;
+        const expectedCorsHeaders = getCorsHeaders(req);
+        // Bypass CORS if:
+        // we are in local or sitecore environment - requested hostname is 'localhost'
+        // or the request is same origin (e.g. in vercel netlify environment)
+        const bypassCors = req.nextUrl.hostname === 'localhost' || req.nextUrl.host === originHost;
+        if (!bypassCors && !expectedCorsHeaders) {
+            return new Response(getOriginNotAllowedMessage(requestOrigin), {
+                status: 401,
+            });
+        }
+        // Validate secret
+        if (!validateEditingSecret(req.nextUrl.searchParams.get(editing_1.QUERY_PARAM_EDITING_SECRET) || '')) {
+            return Response.json({
+                html: editing_1.INVALID_SECRET_HTML_MESSAGE,
+            }, { status: 401, headers: expectedCorsHeaders !== null && expectedCorsHeaders !== void 0 ? expectedCorsHeaders : {} });
+        }
+        // propagate vercel protection query parameters; map query parameters for design library request
+        const query = {};
+        req.nextUrl.searchParams.forEach((value, key) => {
+            query[key] = value;
+        });
+        const propagatedQsParams = Object.assign(Object.assign({}, (0, utils_3.getQueryParamsForPropagation)(query)), (0, utils_3.mapEditingParams)(query));
+        const base = (0, utils_3.resolveServerUrl)(req);
+        const targetUrl = new URL('/', base);
+        for (const key in propagatedQsParams) {
+            if ({}.hasOwnProperty.call(propagatedQsParams, key)) {
+                propagatedQsParams[key] && targetUrl.searchParams.append(key, propagatedQsParams[key]);
+            }
+        }
+        targetUrl.searchParams.append('timestamp', Date.now().toString());
+        // enable draft mode in order to get prerender bypass cookie from request
+        const draft = yield (0, headers_1.draftMode)();
+        draft.enable();
+        // add prerender bypass cookie to forwarded request in order to enable draft mode
+        const cookieStore = yield getNextCookies();
+        const reqCookie = req.headers.get('cookie') || '';
+        const prerenderBypassCookie = `${"__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */}=${((_a = cookieStore.get("__prerender_bypass" /* PreviewCookies.PRERENDER_BYPASS */)) === null || _a === void 0 ? void 0 : _a.value) || ''}`;
+        const forwardCookie = reqCookie
+            ? `${reqCookie}; ${prerenderBypassCookie}`
+            : prerenderBypassCookie;
+        const forwardHeaders = new Headers(req.headers);
+        forwardHeaders.set('cookie', forwardCookie);
+        const forwardedResponse = yield dataFetcher.fetch(targetUrl.toString(), {
+            method: req.method,
+            headers: forwardHeaders,
+            body: req.body,
+            duplex: 'half',
+        });
+        // Filter out x-middleware headers since rewrites are not allowed in route handlers
+        // Also filter out content-encoding and content-length to avoid issues when browser reads the payload
+        const filteredHeaders = new Headers();
+        const forwardedHeaders = new Headers(forwardedResponse.headers);
+        forwardedHeaders.forEach((value, key) => {
+            if (key !== 'x-middleware-next' &&
+                key !== 'x-middleware-rewrite' &&
+                key !== 'content-encoding' &&
+                key !== 'content-length') {
+                filteredHeaders.set(key, value);
+            }
+        });
+        // Restrict the page to be rendered only within the allowed origins
+        filteredHeaders.set('Content-Security-Policy', (0, utils_3.getCSPHeader)());
+        // add expected CORS headers to response
+        Object.entries(expectedCorsHeaders !== null && expectedCorsHeaders !== void 0 ? expectedCorsHeaders : {}).forEach(([key, value]) => {
+            filteredHeaders.set(key, value);
+        });
+        // remove nextjs preview cookies to not leak them to the browser
+        const filteredCookies = (0, utils_3.cleanupNextPreviewCookies)(filteredHeaders.get('Set-Cookie'));
+        filteredHeaders.set('Set-Cookie', (filteredCookies === null || filteredCookies === void 0 ? void 0 : filteredCookies.join('; ')) || '');
+        return new Response(forwardedResponse.data, {
+            status: forwardedResponse.status,
+            statusText: forwardedResponse.statusText,
+            headers: filteredHeaders,
+        });
+    });
+    return { GET, POST, OPTIONS };
+};
+exports.createEditingRenderRouteHandlers = createEditingRenderRouteHandlers;

package/dist/cjs/route-handler/index.js CHANGED Viewed

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEditingRenderRouteHandlers = exports.createEditingConfigRouteHandler = exports.createRobotsRouteHandler = exports.createSitemapRouteHandler = void 0;
-var sitemap_route_handler_1 = require("./sitemap-route-handler");
-Object.defineProperty(exports, "createSitemapRouteHandler", { enumerable: true, get: function () { return sitemap_route_handler_1.createSitemapRouteHandler; } });
-var robots_route_handler_1 = require("./robots-route-handler");
-Object.defineProperty(exports, "createRobotsRouteHandler", { enumerable: true, get: function () { return robots_route_handler_1.createRobotsRouteHandler; } });
-var editing_config_route_handler_1 = require("./editing-config-route-handler");
-Object.defineProperty(exports, "createEditingConfigRouteHandler", { enumerable: true, get: function () { return editing_config_route_handler_1.createEditingConfigRouteHandler; } });
-var editing_render_route_handler_1 = require("./editing-render-route-handler");
-Object.defineProperty(exports, "createEditingRenderRouteHandlers", { enumerable: true, get: function () { return editing_render_route_handler_1.createEditingRenderRouteHandlers; } });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEditingRenderRouteHandlers = exports.createEditingConfigRouteHandler = exports.createRobotsRouteHandler = exports.createSitemapRouteHandler = void 0;
+var sitemap_route_handler_1 = require("./sitemap-route-handler");
+Object.defineProperty(exports, "createSitemapRouteHandler", { enumerable: true, get: function () { return sitemap_route_handler_1.createSitemapRouteHandler; } });
+var robots_route_handler_1 = require("./robots-route-handler");
+Object.defineProperty(exports, "createRobotsRouteHandler", { enumerable: true, get: function () { return robots_route_handler_1.createRobotsRouteHandler; } });
+var editing_config_route_handler_1 = require("./editing-config-route-handler");
+Object.defineProperty(exports, "createEditingConfigRouteHandler", { enumerable: true, get: function () { return editing_config_route_handler_1.createEditingConfigRouteHandler; } });
+var editing_render_route_handler_1 = require("./editing-render-route-handler");
+Object.defineProperty(exports, "createEditingRenderRouteHandlers", { enumerable: true, get: function () { return editing_render_route_handler_1.createEditingRenderRouteHandlers; } });

package/dist/cjs/route-handler/robots-route-handler.js CHANGED Viewed

@@ -1,68 +1,69 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRobotsRouteHandler = void 0;
-const site_1 = require("@sitecore-content-sdk/core/site");
-const core_1 = require("@sitecore-content-sdk/core");
-const cache_1 = require("next/cache");
-/**
- * Creates a route handler to serve the robots.txt file.
- * @param {RouteHandlerOptions} options - The options for the route handler.
- * @returns The route handler.
- */
-const createRobotsRouteHandler = (options) => {
-    const { client, sites, revalidate = 60 } = options;
-    const siteResolver = new site_1.SiteResolver(sites);
-    const getRobots = (0, cache_1.unstable_cache)((site) => __awaiter(void 0, void 0, void 0, function* () {
-        return client.getRobots(site);
-    }), ['robots'], {
-        revalidate,
-        tags: ['robots'],
-    });
-    const GET = (req) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a;
-        try {
-            const startTimestamp = Date.now();
-            const hostName = ((_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0]) || 'localhost';
-            const site = siteResolver.getByHost(hostName);
-            core_1.debug.robots('robots route handler start: %o', {
-                hostName,
-                siteName: site.name,
-            });
-            const robotsContent = yield getRobots(site.name);
-            if (!robotsContent) {
-                core_1.debug.robots('robots route handler end in %dms', Date.now() - startTimestamp);
-                return new Response('User-agent: *\nDisallow: /', {
-                    status: 404,
-                    headers: {
-                        'Content-Type': 'text/plain',
-                    },
-                });
-            }
-            core_1.debug.robots('robots route handler end in %dms', Date.now() - startTimestamp);
-            return new Response(robotsContent, {
-                status: 200,
-                headers: {
-                    'Content-Type': 'text/plain',
-                },
-            });
-        }
-        catch (error) {
-            console.log('Robots route handler failed:');
-            console.log(error);
-            return new Response('Internal Server Error', {
-                status: 500,
-            });
-        }
-    });
-    return { GET };
-};
-exports.createRobotsRouteHandler = createRobotsRouteHandler;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRobotsRouteHandler = void 0;
+const site_1 = require("@sitecore-content-sdk/core/site");
+const core_1 = require("@sitecore-content-sdk/core");
+const cache_1 = require("next/cache");
+/**
+ * Creates a route handler to serve the robots.txt file.
+ * @param {RouteHandlerOptions} options - The options for the route handler.
+ * @returns The route handler object with GET method.
+ * @public
+ */
+const createRobotsRouteHandler = (options) => {
+    const { client, sites, revalidate = 60 } = options;
+    const siteResolver = new site_1.SiteResolver(sites);
+    const getRobots = (0, cache_1.unstable_cache)((site) => __awaiter(void 0, void 0, void 0, function* () {
+        return client.getRobots(site);
+    }), ['robots'], {
+        revalidate,
+        tags: ['robots'],
+    });
+    const GET = (req) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        try {
+            const startTimestamp = Date.now();
+            const hostName = ((_a = req.headers.get('host')) === null || _a === void 0 ? void 0 : _a.split(':')[0]) || 'localhost';
+            const site = siteResolver.getByHost(hostName);
+            core_1.debug.robots('robots route handler start: %o', {
+                hostName,
+                siteName: site.name,
+            });
+            const robotsContent = yield getRobots(site.name);
+            if (!robotsContent) {
+                core_1.debug.robots('robots route handler end in %dms', Date.now() - startTimestamp);
+                return new Response('User-agent: *\nDisallow: /', {
+                    status: 404,
+                    headers: {
+                        'Content-Type': 'text/plain',
+                    },
+                });
+            }
+            core_1.debug.robots('robots route handler end in %dms', Date.now() - startTimestamp);
+            return new Response(robotsContent, {
+                status: 200,
+                headers: {
+                    'Content-Type': 'text/plain',
+                },
+            });
+        }
+        catch (error) {
+            console.log('Robots route handler failed:');
+            console.log(error);
+            return new Response('Internal Server Error', {
+                status: 500,
+            });
+        }
+    });
+    return { GET };
+};
+exports.createRobotsRouteHandler = createRobotsRouteHandler;