@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.8 → 22.0.0

package/dist/cjs/utils/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveUrl = exports.resetEditorChromes = exports.isEditorActive = exports.tryParseEnvValue = exports.handleEditorFastRefresh = exports.getPublicUrl = void 0;
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getPublicUrl", { enumerable: true, get: function () { return utils_1.getPublicUrl; } });
+Object.defineProperty(exports, "handleEditorFastRefresh", { enumerable: true, get: function () { return utils_1.handleEditorFastRefresh; } });
+var utils_2 = require("@sitecore-jss/sitecore-jss/utils");
+Object.defineProperty(exports, "tryParseEnvValue", { enumerable: true, get: function () { return utils_2.tryParseEnvValue; } });
+Object.defineProperty(exports, "isEditorActive", { enumerable: true, get: function () { return utils_2.isEditorActive; } });
+Object.defineProperty(exports, "resetEditorChromes", { enumerable: true, get: function () { return utils_2.resetEditorChromes; } });
+Object.defineProperty(exports, "resolveUrl", { enumerable: true, get: function () { return utils_2.resolveUrl; } });

package/dist/cjs/{utils.js → utils/utils.js}

@@ -1,10 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getJssEditingSecret = exports.handleEditorFastRefresh = exports.getPublicUrl = void 0;
-const chalk_1 = __importDefault(require("chalk"));
 const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
 /**
  * Get the publicUrl.
@@ -12,25 +8,20 @@ const utils_1 = require("@sitecore-jss/sitecore-jss/utils");
  * This is set to http://localhost:3000 by default.
  * VERCEL_URL is provided by Vercel in case if we are in Preview deployment (deployment based on the custom branch),
  * preview deployment has unique url, we don't know exact url.
+ * Similarly, DEPLOY_URL is provided by Netlify and would give us the deploy URL
+ * In production non-editing environments it is desirable to use relative urls, so in that case set PUBLIC_URL = ''
  */
 const getPublicUrl = () => {
-    if (process.env.VERCEL_URL)
-        return `https://${process.env.VERCEL_URL}`;
     let url = process.env.PUBLIC_URL;
     if (url === undefined) {
-        console.warn(`${chalk_1.default.yellow.bold('Warning:')} An PUBLIC_URL environment variable is not defined. Falling back to http://localhost:3000.`);
+        if (process.env.NETLIFY && process.env.DEPLOY_URL)
+            return process.env.DEPLOY_URL;
+        if (process.env.VERCEL_URL)
+            return `https://${process.env.VERCEL_URL}`;
         url = 'http://localhost:3000';
     }
-    else {
-        try {
-            new URL(url);
-        }
-        catch (error) {
-            throw new Error(`The PUBLIC_URL environment variable '${url}' is not a valid URL.`);
-        }
-    }
     // Ensure no trailing slash
-    return url.toString().replace(/\/$/, '');
+    return url.replace(/\/$/, '');
 };
 exports.getPublicUrl = getPublicUrl;
 /**

package/dist/esm/ComponentBuilder.js

@@ -0,0 +1,59 @@
+/**
+ * Nextjs implementation of component builder class for building components based on the configuration.
+ */
+export class ComponentBuilder {
+    constructor(config) {
+        this.config = config;
+        /**
+         * SXA uses custom default export name
+         */
+        this.DEFAULT_EXPORT_NAME = 'Default';
+        this.components = new Map([...config.components]);
+    }
+    /**
+     * Creates a new instance of module factory
+     * Module factory provides a module (file) including all exports.
+     * Module can be imported dynamically or statically.
+     * @returns {ModuleFactory} Module factory implementation
+     */
+    getModuleFactory() {
+        return (componentName) => {
+            const component = this.components.get(componentName);
+            if (!component)
+                return null;
+            // check if module should be imported dynamically
+            if (component.module) {
+                return component.module();
+            }
+            return component;
+        };
+    }
+    /**
+     * Creates a new instance of component factory
+     * Component can be imported dynamically or statically.
+     * @param {Object} [config] Component factory configuration
+     * @param {boolean} [config.isEditing] Indicates if component factory is used in editing mode
+     * @returns {ComponentFactory} Component factory implementation
+     */
+    getComponentFactory({ isEditing } = {}) {
+        return (componentName, exportName) => {
+            const component = this.components.get(componentName);
+            if (!component)
+                return null;
+            // check if component should be imported dynamically
+            if (component.element) {
+                // Editing mode doesn't work well with dynamic components in nextjs: dynamic components are not displayed without refresh after a rendering is added.
+                // This happens beacuse Sitecore editors simply insert updated HTML generated on server side. This conflicts with nextjs dynamic logic as no HTML gets rendered for dynamic component
+                // So we use require() to obtain dynamic components in editing mode while preserving dynamic logic for non-editing scenarios
+                // As we need to be able to seamlessly work with dynamic components in both editing and normal modes, different componentFactory functions will be passed to app
+                return component.element(isEditing);
+            }
+            if (exportName && exportName !== this.DEFAULT_EXPORT_NAME) {
+                return component[exportName];
+            }
+            return (component.Default ||
+                component.default ||
+                component);
+        };
+    }
+}

package/dist/esm/components/BYOCWrapper.js

@@ -0,0 +1,42 @@
+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 { BYOCWrapper, fetchBYOCComponentServerProps, } from '@sitecore-jss/sitecore-jss-react';
+import { constants } from '@sitecore-jss/sitecore-jss';
+/**
+ * This is a repackaged version of the React BYOCWrapper component with support for
+ * server rendering in Next.js (using component-level data-fetching feature of JSS).
+ */
+/**
+ * Will be called during SSG
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export const getStaticProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield fetchBYOCComponentServerProps(params);
+    return result;
+});
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export const getServerSideProps = (rendering) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield fetchBYOCComponentServerProps(params);
+    return result;
+});
+export default BYOCWrapper;

package/dist/esm/components/FEaaSWrapper.js

@@ -0,0 +1,44 @@
+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 { FEaaSWrapper, fetchFEaaSComponentServerProps, } from '@sitecore-jss/sitecore-jss-react';
+import { constants } from '@sitecore-jss/sitecore-jss';
+/**
+ * This is a repackaged version of the React FEaaSWrapper component with support for
+ * server rendering in Next.js (using component-level data-fetching feature of JSS).
+ */
+/**
+ * Will be called during SSG
+ * @param {ComponentRendering} rendering
+ * @param {LayoutServiceData} layoutData
+ * @returns {GetStaticPropsContext} context
+ */
+export const getStaticProps = (rendering, layoutData) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield fetchFEaaSComponentServerProps(params, layoutData.sitecore.context.pageState);
+    return result;
+});
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @param {LayoutServiceData} layoutData
+ * @returns {GetStaticPropsContext} context
+ */
+export const getServerSideProps = (rendering, layoutData) => __awaiter(void 0, void 0, void 0, function* () {
+    if (process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED) {
+        return null;
+    }
+    const params = rendering.params || {};
+    const result = yield fetchFEaaSComponentServerProps(params, layoutData.sitecore.context.pageState);
+    return result;
+});
+export default FEaaSWrapper;

package/dist/esm/components/Link.js

@@ -14,7 +14,11 @@ import PropTypes from 'prop-types';
 import NextLink from 'next/link';
 import { Link as ReactLink, LinkPropTypes, } from '@sitecore-jss/sitecore-jss-react';
 export const Link = forwardRef((props, ref) => {
-    const { field, editable, children, internalLinkMatcher = /^\//g, showLinkTextWithChildrenPresent } = props, htmlLinkProps = __rest(props, ["field", "editable", "children", "internalLinkMatcher", "showLinkTextWithChildrenPresent"]);
+    const { field, editable = true, children, internalLinkMatcher = /^\//g, showLinkTextWithChildrenPresent } = props, htmlLinkProps = __rest(props, ["field", "editable", "children", "internalLinkMatcher", "showLinkTextWithChildrenPresent"]);
+    if (!field ||
+        (!field.editable && !field.value && !field.href)) {
+        return null;
+    }
     const value = (field.href
         ? field
         : field.value);
@@ -34,8 +38,5 @@ export const Link = forwardRef((props, ref) => {
     delete reactLinkProps.internalLinkMatcher;
     return React.createElement(ReactLink, Object.assign({}, reactLinkProps, { ref: ref }));
 });
-Link.defaultProps = {
-    editable: true,
-};
 Link.displayName = 'NextLink';
 Link.propTypes = Object.assign({ internalLinkMatcher: PropTypes.instanceOf(RegExp) }, LinkPropTypes);

package/dist/esm/components/NextImage.js

@@ -14,14 +14,8 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import { getEEMarkup, } from '@sitecore-jss/sitecore-jss-react';
 import Image from 'next/image';
-export const sitecoreLoader = ({ src, width }) => {
-    const [root, paramString] = src.split('?');
-    const params = new URLSearchParams(paramString);
-    params.set('mw', width.toString());
-    return `${root}?${params}`;
-};
 export const NextImage = (_a) => {
-    var { editable, imageParams, field, mediaUrlPrefix, fill, priority } = _a, otherProps = __rest(_a, ["editable", "imageParams", "field", "mediaUrlPrefix", "fill", "priority"]);
+    var { editable = true, imageParams, field, mediaUrlPrefix, fill, priority } = _a, otherProps = __rest(_a, ["editable", "imageParams", "field", "mediaUrlPrefix", "fill", "priority"]);
     // next handles src and we use a custom loader,
     // throw error if these are present
     if (otherProps.src) {
@@ -55,9 +49,8 @@ export const NextImage = (_a) => {
         delete imageProps.width;
         delete imageProps.height;
     }
-    const loader = (otherProps.loader ? otherProps.loader : sitecoreLoader);
     if (attrs) {
-        return React.createElement(Image, Object.assign({ alt: "", loader: loader }, imageProps));
+        return React.createElement(Image, Object.assign({ alt: "" }, imageProps));
     }
     return null; // we can't handle the truth
 };
@@ -75,7 +68,4 @@ NextImage.propTypes = {
     mediaUrlPrefix: PropTypes.instanceOf(RegExp),
     imageParams: PropTypes.objectOf(PropTypes.oneOfType([PropTypes.number.isRequired, PropTypes.string.isRequired]).isRequired),
 };
-NextImage.defaultProps = {
-    editable: true,
-};
 NextImage.displayName = 'NextImage';

package/dist/esm/components/RichText.js

@@ -15,9 +15,9 @@ import { useRouter } from 'next/router';
 import { RichText as ReactRichText, RichTextPropTypes, } from '@sitecore-jss/sitecore-jss-react';
 const prefetched = {};
 export const RichText = (props) => {
-    const { internalLinksSelector = 'a[href^="/"]' } = props, rest = __rest(props, ["internalLinksSelector"]);
+    const { internalLinksSelector = 'a[href^="/"]', prefetchLinks = true, editable = true } = props, rest = __rest(props, ["internalLinksSelector", "prefetchLinks", "editable"]);
     const hasText = props.field && props.field.value;
-    const isEditing = props.editable && props.field && props.field.editable;
+    const isEditing = editable && props.field && props.field.editable;
     const router = useRouter();
     const richTextRef = useRef(null);
     useEffect(() => {
@@ -25,12 +25,12 @@ export const RichText = (props) => {
         if (hasText && !isEditing) {
             initializeLinks();
         }
-    }, []);
+    }, [hasText]);
     const routeHandler = (ev) => {
-        if (!ev.target)
+        if (!ev.currentTarget)
             return;
         ev.preventDefault();
-        const pathname = ev.target.href;
+        const pathname = ev.currentTarget.href;
         router.push(pathname, pathname, { locale: false });
     };
     const initializeLinks = () => {
@@ -40,20 +40,16 @@ export const RichText = (props) => {
         if (!internalLinks || !internalLinks.length)
             return;
         internalLinks.forEach((link) => {
-            if (link.target !== '_blank') {
-                if (!prefetched[link.pathname]) {
-                    router.prefetch(link.pathname, undefined, { locale: false });
-                    prefetched[link.pathname] = true;
-                }
-                link.addEventListener('click', routeHandler, false);
+            if (link.target === '_blank')
+                return;
+            if (prefetchLinks && !prefetched[link.pathname]) {
+                router.prefetch(link.pathname, undefined, { locale: false });
+                prefetched[link.pathname] = true;
             }
+            link.addEventListener('click', routeHandler, false);
         });
     };
     return React.createElement(ReactRichText, Object.assign({ ref: richTextRef }, rest));
 };
 RichText.propTypes = Object.assign({ internalLinksSelector: PropTypes.string }, RichTextPropTypes);
-RichText.defaultProps = {
-    tag: 'div',
-    editable: true,
-};
 RichText.displayName = 'NextRichText';

package/dist/esm/context/context.js

@@ -0,0 +1,79 @@
+import { LayoutServicePageState } from '@sitecore-jss/sitecore-jss-react';
+/**
+ * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
+ */
+export class Context {
+    constructor(props) {
+        this.props = props;
+        /**
+         * Indicates whether the Context and SDK(s) have been initialized
+         */
+        this.isInitialized = false;
+        /**
+         * Software Development Kits (SDKs) to be initialized
+         */
+        this.sdks = {};
+        /**
+         * Promises for the SDKs
+         */
+        this.sdkPromises = {};
+        this.sdkErrors = {};
+        /**
+         * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
+         *
+         * @param {string} name SDK name
+         * @returns initialized SDK
+         */
+        this.getSDK = (name) => {
+            if (!this.sdkPromises[name]) {
+                return Promise.reject(`Unknown SDK '${String(name)}'`);
+            }
+            else {
+                return this.sdkPromises[name].then((result) => {
+                    return ((this.sdkErrors[name] && Promise.reject(this.sdkErrors[name])) || Promise.resolve(result));
+                });
+            }
+        };
+        this.sitecoreEdgeUrl = props.sitecoreEdgeUrl;
+        this.sitecoreEdgeContextId = props.sitecoreEdgeContextId;
+        this.siteName = props.siteName;
+        this.pageState = LayoutServicePageState.Normal;
+    }
+    init(props = {}) {
+        // Context and SDKs are initialized only once
+        if (this.isInitialized)
+            return;
+        this.isInitialized = true;
+        if (props.siteName) {
+            this.siteName = props.siteName;
+        }
+        if (props.pageState) {
+            this.pageState = props.pageState;
+        }
+        // iterate over the SDKs and initialize them
+        for (const sdkName of Object.keys(this.props.sdks)) {
+            this.initSDK(sdkName);
+        }
+    }
+    /**
+     * Initializes the Software Development Kit (SDK)
+     *
+     * @param {T} name SDK name
+     * @returns {void}
+     */
+    initSDK(name) {
+        this.sdkPromises[name] = new Promise((resolve) => {
+            this.props.sdks[name]
+                .init(this)
+                .then(() => {
+                this.sdks[name] = this.props.sdks[name].sdk;
+                resolve(this.sdks[name]);
+            })
+                .catch((e) => {
+                // if init rejects, we mark SDK as failed - so getSDK call would reject with a reason
+                this.sdkErrors[name] = e;
+                resolve(undefined);
+            });
+        });
+    }
+}

package/dist/esm/context/index.js

@@ -0,0 +1 @@
+export { Context } from './context';

package/dist/esm/editing/constants.js

@@ -0,0 +1,3 @@
+export const QUERY_PARAM_EDITING_SECRET = 'secret';
+export const QUERY_PARAM_PROTECTION_BYPASS_SITECORE = 'x-sitecore-protection-bypass';
+export const QUERY_PARAM_PROTECTION_BYPASS_VERCEL = 'x-vercel-protection-bypass';

package/dist/esm/editing/editing-config-middleware.js

@@ -0,0 +1,45 @@
+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 { QUERY_PARAM_EDITING_SECRET } from './constants';
+import { getJssEditingSecret } from '../utils/utils';
+import { debug } from '@sitecore-jss/sitecore-jss';
+/**
+ * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
+ * provides configuration information to determine feature compatibility on Pages side.
+ */
+export class EditingConfigMiddleware {
+    /**
+     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
+     */
+    constructor(config) {
+        this.config = config;
+        this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
+            const secret = _req.query[QUERY_PARAM_EDITING_SECRET];
+            if (secret !== getJssEditingSecret()) {
+                debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
+                return res.status(401).json({ message: 'Missing or invalid editing secret' });
+            }
+            const components = Array.isArray(this.config.components)
+                ? this.config.components
+                : Array.from(this.config.components.keys());
+            return res.status(200).json({
+                components,
+                packages: this.config.metadata.packages,
+            });
+        });
+    }
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler() {
+        return this.handler;
+    }
+}

package/dist/esm/editing/editing-data-middleware.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { editingDataDiskCache } from './editing-data-cache';
 import { isEditingData } from './editing-data';
-import { QUERY_PARAM_EDITING_SECRET } from './editing-data-service';
-import { getJssEditingSecret } from '../utils';
+import { QUERY_PARAM_EDITING_SECRET } from './constants';
+import { getJssEditingSecret } from '../utils/utils';
 /**
  * Middleware / handler for use in the editing data Next.js API dynamic route (e.g. '/api/editing/data/[key]')
  * which is required for Sitecore editing support.

package/dist/esm/editing/editing-data-service.js

@@ -7,10 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { QUERY_PARAM_EDITING_SECRET } from './constants';
 import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
 import { editingDataDiskCache } from './editing-data-cache';
-import { getJssEditingSecret } from '../utils';
-export const QUERY_PARAM_EDITING_SECRET = 'secret';
+import { getJssEditingSecret } from '../utils/utils';
 /**
  * Unique key generator.
  * Need more than just the item GUID since requests are made "live" during editing in EE.
@@ -93,13 +93,14 @@ export class ServerlessEditingDataService {
      * @param {string} serverUrl The server url to use for subsequent data API requests
      * @returns {Promise} The {@link EditingPreviewData} containing the generated key and serverUrl to use for retrieval
      */
-    setEditingData(data, serverUrl) {
+    setEditingData(data, serverUrl, params) {
         return __awaiter(this, void 0, void 0, function* () {
             const key = this.generateKey(data);
-            const url = this.getUrl(serverUrl, key);
+            const url = this.getUrl(serverUrl, key, params);
             const previewData = {
                 key,
                 serverUrl,
+                params,
             };
             debug.editing('storing editing data for %o: %o', previewData, data);
             return this.dataFetcher.put(url, data).then(() => {
@@ -118,20 +119,27 @@ export class ServerlessEditingDataService {
             if (!(editingPreviewData === null || editingPreviewData === void 0 ? void 0 : editingPreviewData.serverUrl)) {
                 return undefined;
             }
-            const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key);
+            const url = this.getUrl(editingPreviewData.serverUrl, editingPreviewData.key, editingPreviewData.params);
             debug.editing('retrieving editing data for %o', previewData);
             return this.dataFetcher.get(url).then((response) => {
                 return response.data;
             });
         });
     }
-    getUrl(serverUrl, key) {
+    getUrl(serverUrl, key, params) {
         var _a;
         // Example URL format:
         //  http://localhost:3000/api/editing/data/52961eea-bafd-5287-a532-a72e36bd8a36-qkb4e3fv5x?secret=1234secret
         const apiRoute = (_a = this.apiRoute) === null || _a === void 0 ? void 0 : _a.replace('[key]', key);
         const url = new URL(apiRoute, serverUrl);
         url.searchParams.append(QUERY_PARAM_EDITING_SECRET, getJssEditingSecret());
+        if (params) {
+            for (const key in params) {
+                if ({}.hasOwnProperty.call(params, key)) {
+                    url.searchParams.append(key, params[key]);
+                }
+            }
+        }
         return url.toString();
     }
 }

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

@@ -11,21 +11,25 @@ import { STATIC_PROPS_ID, SERVER_PROPS_ID } from 'next/constants';
 import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
 import { EDITING_COMPONENT_ID, RenderingType } from '@sitecore-jss/sitecore-jss/layout';
 import { parse } from 'node-html-parser';
-import { editingDataService, QUERY_PARAM_EDITING_SECRET, } from './editing-data-service';
-import { getJssEditingSecret } from '../utils';
+import { editingDataService } from './editing-data-service';
+import { QUERY_PARAM_EDITING_SECRET } from './constants';
+import { getJssEditingSecret } from '../utils/utils';
+import { RenderMiddlewareBase } from './render-middleware';
 /**
  * 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 {
+export class EditingRenderMiddleware extends RenderMiddlewareBase {
     /**
      * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
      */
     constructor(config) {
         var _a, _b, _c, _d;
+        super();
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
             var _e, _f;
             const { method, query, body, headers } = req;
+            const startTimestamp = Date.now();
             debug.editing('editing render middleware start: %o', {
                 method,
                 query,
@@ -52,21 +56,28 @@ export class EditingRenderMiddleware {
                 const editingData = extractEditingData(req);
                 // Resolve server URL
                 const serverUrl = this.resolveServerUrl(req);
+                // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
+                const params = this.getQueryParamsForPropagation(query);
                 // Stash for use later on (i.e. within getStatic/ServerSideProps).
                 // Note we can't set this directly in setPreviewData since it's stored as a cookie (2KB limit)
                 // https://nextjs.org/docs/advanced-features/preview-mode#previewdata-size-limits)
-                const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl);
+                const previewData = yield this.editingDataService.setEditingData(editingData, serverUrl, params);
                 // Enable Next.js Preview Mode, passing our preview data (i.e. editingData cache key)
                 res.setPreviewData(previewData);
                 // Grab the Next.js preview cookies to send on to the render request
                 const cookies = res.getHeader('Set-Cookie');
-                // Make actual render request for page route, passing on preview cookies.
+                // 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 in Axios (no amount of cache headers seemed to do it)
-                const requestUrl = this.resolvePageUrl(serverUrl, editingData.path);
                 debug.editing('fetching page route for %s', editingData.path);
-                const queryStringCharacter = requestUrl.indexOf('?') === -1 ? '?' : '&';
+                const requestUrl = new URL(this.resolvePageUrl(serverUrl, editingData.path));
+                for (const key in params) {
+                    if ({}.hasOwnProperty.call(params, key)) {
+                        requestUrl.searchParams.append(key, params[key]);
+                    }
+                }
+                requestUrl.searchParams.append('timestamp', Date.now().toString());
                 const pageRes = yield this.dataFetcher
-                    .get(`${requestUrl}${queryStringCharacter}timestamp=${Date.now()}`, {
+                    .get(requestUrl.toString(), {
                     headers: {
                         Cookie: cookies.join(';'),
                     },
@@ -81,7 +92,7 @@ export class EditingRenderMiddleware {
                 });
                 let html = pageRes.data;
                 if (!html || html.length === 0) {
-                    throw new Error(`Failed to render html for ${requestUrl}`);
+                    throw new Error(`Failed to render html for ${editingData.path}`);
                 }
                 // replace phkey attribute with key attribute so that newly added renderings
                 // show correct placeholders, so save and refresh won't be needed after adding each rendering
@@ -97,11 +108,14 @@ export class EditingRenderMiddleware {
                     // Handle component rendering. Extract component markup only
                     html = (_f = parse(html).getElementById(EDITING_COMPONENT_ID)) === null || _f === void 0 ? void 0 : _f.innerHTML;
                     if (!html)
-                        throw new Error(`Failed to render component for ${requestUrl}`);
+                        throw new Error(`Failed to render component for ${editingData.path}`);
                 }
                 const body = { html };
                 // Return expected JSON result
-                debug.editing('editing render middleware end: %o', { status: 200, body });
+                debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
+                    status: 200,
+                    body,
+                });
                 res.status(200).json(body);
             }
             catch (err) {