@sitecore-jss/sitecore-jss-nextjs 22.3.0 → 22.3.1-canary.11

package/dist/cjs/ComponentBuilder.js

@@ -34,7 +34,7 @@ class ComponentBuilder {
     /**
      * Creates a new instance of component factory
      * Component can be imported dynamically or statically.
-     * @param {Object} [config] Component factory configuration
+     * @param {object} [config] Component factory configuration
      * @param {boolean} [config.isEditing] Indicates if component factory is used in editing mode
      * @returns {ComponentFactory} Component factory implementation
      */

package/dist/cjs/components/Link.js

@@ -42,6 +42,10 @@ const react_1 = __importStar(require("react"));
 const prop_types_1 = __importDefault(require("prop-types"));
 const link_1 = __importDefault(require("next/link"));
 const sitecore_jss_react_1 = require("@sitecore-jss/sitecore-jss-react");
+/**
+ * Matches relative URLs that end with a file extension.
+ */
+const FILE_EXTENSION_MATCHER = /^\/.*\.\w+$/;
 exports.Link = (0, react_1.forwardRef)((props, ref) => {
     const { field, editable = true, children, internalLinkMatcher = /^\//g, showLinkTextWithChildrenPresent } = props, htmlLinkProps = __rest(props, ["field", "editable", "children", "internalLinkMatcher", "showLinkTextWithChildrenPresent"]);
     if (!field ||
@@ -59,8 +63,10 @@ exports.Link = (0, react_1.forwardRef)((props, ref) => {
     const isEditing = editable && (field.editable || field.metadata);
     if (href && !isEditing) {
         const text = showLinkTextWithChildrenPresent || !children ? value.text || value.href : null;
-        // determine if a link is a route or not.
-        if (internalLinkMatcher.test(href)) {
+        const isMatching = internalLinkMatcher.test(href);
+        const isFileUrl = FILE_EXTENSION_MATCHER.test(href);
+        // determine if a link is a route or not. File extensions are not routes and should not be pre-fetched.
+        if (isMatching && !isFileUrl) {
             return (react_1.default.createElement(link_1.default, Object.assign({ href: { pathname: href, query: querystring, hash: anchor }, key: "link", locale: false, title: value.title, target: value.target, className: value.class }, htmlLinkProps, { ref: ref }),
                 text,
                 children));

package/dist/cjs/editing/constants.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EDITING_ALLOWED_ORIGINS = exports.EDITING_PASS_THROUGH_HEADERS = exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = exports.QUERY_PARAM_VERCEL_PROTECTION_BYPASS = exports.QUERY_PARAM_EDITING_SECRET = void 0;
-exports.QUERY_PARAM_EDITING_SECRET = 'secret';
+exports.EDITING_PASS_THROUGH_HEADERS = exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = exports.QUERY_PARAM_VERCEL_PROTECTION_BYPASS = void 0;
 exports.QUERY_PARAM_VERCEL_PROTECTION_BYPASS = 'x-vercel-protection-bypass';
 exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
 /**
@@ -9,7 +8,3 @@ exports.QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
  * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
  */
 exports.EDITING_PASS_THROUGH_HEADERS = ['authorization', 'cookie'];
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-exports.EDITING_ALLOWED_ORIGINS = ['https://pages.sitecorecloud.io'];

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

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditingConfigMiddleware = void 0;
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const utils_1 = require("../utils/utils");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
@@ -26,8 +26,8 @@ class EditingConfigMiddleware {
     constructor(config) {
         this.config = config;
         this.handler = (_req, res) => __awaiter(this, void 0, void 0, function* () {
-            const secret = _req.query[constants_1.QUERY_PARAM_EDITING_SECRET];
-            if (!(0, utils_2.enforceCors)(_req, res, constants_1.EDITING_ALLOWED_ORIGINS)) {
+            const secret = _req.query[editing_1.QUERY_PARAM_EDITING_SECRET];
+            if (!(0, utils_2.enforceCors)(_req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res.status(401).json({ message: 'Invalid origin' });
             }
@@ -35,6 +35,12 @@ class EditingConfigMiddleware {
                 sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
                 return res.status(401).json({ message: 'Missing or invalid editing secret' });
             }
+            // Handle preflight request
+            if (_req.method === 'OPTIONS') {
+                sitecore_jss_1.debug.editing('preflight request');
+                // CORS headers are set by enforceCors
+                return res.status(204).send(null);
+            }
             const components = Array.isArray(this.config.components)
                 ? this.config.components
                 : Array.from(this.config.components.keys());

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

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditingDataMiddleware = void 0;
 const editing_data_cache_1 = require("./editing-data-cache");
 const editing_data_1 = require("./editing-data");
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const utils_1 = require("../utils/utils");
 const utils_2 = require("@sitecore-jss/sitecore-jss/utils");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
@@ -28,9 +28,9 @@ class EditingDataMiddleware {
         var _a, _b;
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
             const { method, query, body } = req;
-            const secret = query[constants_1.QUERY_PARAM_EDITING_SECRET];
+            const secret = query[editing_1.QUERY_PARAM_EDITING_SECRET];
             const key = query[this.queryParamKey];
-            if (!(0, utils_2.enforceCors)(req, res, constants_1.EDITING_ALLOWED_ORIGINS)) {
+            if (!(0, utils_2.enforceCors)(req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res.status(401).json({ message: 'Invalid origin' });
             }

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

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.editingDataService = exports.ServerlessEditingDataService = exports.BasicEditingDataService = exports.generateKey = void 0;
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const editing_data_cache_1 = require("./editing-data-cache");
 const utils_1 = require("../utils/utils");
@@ -137,7 +137,7 @@ class ServerlessEditingDataService {
         //  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(constants_1.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
+        url.searchParams.append(editing_1.QUERY_PARAM_EDITING_SECRET, (0, utils_1.getJssEditingSecret)());
         if (params) {
             for (const key in params) {
                 if ({}.hasOwnProperty.call(params, key)) {

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

@@ -13,8 +13,8 @@ exports.EditingRenderMiddleware = exports.MetadataHandler = exports.isEditingMet
 const constants_1 = require("next/constants");
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
 const layout_1 = require("@sitecore-jss/sitecore-jss/layout");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const editing_data_service_1 = require("./editing-data-service");
-const constants_2 = require("./constants");
 const utils_1 = require("../utils/utils");
 const render_middleware_1 = require("./render-middleware");
 const utils_2 = require("@sitecore-jss/sitecore-jss/utils");
@@ -30,7 +30,7 @@ class ChromesHandler extends render_middleware_1.RenderMiddlewareBase {
         this.config = config;
         /**
          * Default page URL resolution.
-         * @param {Object} args Arguments for resolving the page URL
+         * @param {object} args Arguments for resolving the page URL
          * @param {string} args.serverUrl The root server URL e.g. 'http://localhost:3000'
          * @param {string} args.itemPath The Sitecore relative item path e.g. '/styleguide'
          * @returns {string} The URL to render
@@ -173,7 +173,7 @@ class ChromesHandler extends render_middleware_1.RenderMiddlewareBase {
 exports.ChromesHandler = ChromesHandler;
 /**
  * Type guard for EditingMetadataPreviewData
- * @param {Object} data preview data to check
+ * @param {object} data preview data to check
  * @returns true if the data is EditingMetadataPreviewData
  * @see EditingMetadataPreviewData
  */
@@ -265,7 +265,10 @@ class MetadataHandler {
      * @returns Content-Security-Policy header value
      */
     getSCPHeader() {
-        return `frame-ancestors 'self' ${[(0, utils_2.getAllowedOriginsFromEnv)(), ...constants_2.EDITING_ALLOWED_ORIGINS].join(' ')}`;
+        return `frame-ancestors 'self' ${[
+            ...(0, utils_2.getAllowedOriginsFromEnv)(),
+            ...editing_1.EDITING_ALLOWED_ORIGINS,
+        ].join(' ')}`;
     }
 }
 exports.MetadataHandler = MetadataHandler;
@@ -289,14 +292,14 @@ class EditingRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                 headers,
                 body,
             });
-            if (!(0, utils_2.enforceCors)(req, res, constants_2.EDITING_ALLOWED_ORIGINS)) {
+            if (!(0, utils_2.enforceCors)(req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res.status(401).json({
                     html: `<html><body>Requests from origin ${(_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin} not allowed</body></html>`,
                 });
             }
             // Validate secret
-            const secret = (_b = query[constants_2.QUERY_PARAM_EDITING_SECRET]) !== null && _b !== void 0 ? _b : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
+            const secret = (_b = query[editing_1.QUERY_PARAM_EDITING_SECRET]) !== null && _b !== void 0 ? _b : body === null || body === void 0 ? void 0 : body.jssEditingSecret;
             if (secret !== (0, utils_1.getJssEditingSecret)()) {
                 sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
                 return res.status(401).json({
@@ -314,6 +317,11 @@ class EditingRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                     yield handler.render(req, res);
                     break;
                 }
+                case 'OPTIONS': {
+                    sitecore_jss_1.debug.editing('preflight request');
+                    // CORS headers are set by enforceCors
+                    return res.status(204).send(null);
+                }
                 default:
                     sitecore_jss_1.debug.editing('invalid method - sent %s expected GET/POST', req.method);
                     res.setHeader('Allow', 'GET, POST');

package/dist/cjs/editing/feaas-render-middleware.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FEAASRenderMiddleware = void 0;
 const sitecore_jss_1 = require("@sitecore-jss/sitecore-jss");
-const constants_1 = require("./constants");
+const editing_1 = require("@sitecore-jss/sitecore-jss/editing");
 const utils_1 = require("../utils/utils");
 const render_middleware_1 = require("./render-middleware");
 const utils_2 = require("@sitecore-jss/sitecore-jss/utils");
@@ -37,23 +37,29 @@ class FEAASRenderMiddleware extends render_middleware_1.RenderMiddlewareBase {
                 query,
                 headers,
             });
-            if (!(0, utils_2.enforceCors)(req, res, constants_1.EDITING_ALLOWED_ORIGINS)) {
+            if (!(0, utils_2.enforceCors)(req, res, editing_1.EDITING_ALLOWED_ORIGINS)) {
                 sitecore_jss_1.debug.editing('invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable');
                 return res
                     .status(401)
                     .send(`<html><body>Requests from origin ${(_b = req.headers) === null || _b === void 0 ? void 0 : _b.origin} are not allowed</body></html>`);
             }
-            if (method !== 'GET') {
-                sitecore_jss_1.debug.editing('invalid method - sent %s expected GET', method);
-                res.setHeader('Allow', 'GET');
+            if (!method || !['GET', 'OPTIONS'].includes(method)) {
+                sitecore_jss_1.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[constants_1.QUERY_PARAM_EDITING_SECRET];
+            const secret = query[editing_1.QUERY_PARAM_EDITING_SECRET];
             if (secret !== (0, utils_1.getJssEditingSecret)()) {
                 sitecore_jss_1.debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, (0, utils_1.getJssEditingSecret)());
                 return res.status(401).send('<html><body>Missing or invalid secret</body></html>');
             }
+            // Handle preflight request
+            if (method === 'OPTIONS') {
+                sitecore_jss_1.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);

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

@@ -9,7 +9,7 @@ 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
+         * @param {object} query Object of query parameters from incoming URL
          * @returns Object of approved query parameters
          */
         this.getQueryParamsForPropagation = (query) => {

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

@@ -135,8 +135,8 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
             }
         });
     }
-    initPersonalizeServer({ hostname, siteName, request, response, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    initPersonalizeServer(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ hostname, siteName, request, response, }) {
             yield (0, server_2.CloudSDK)(request, response, {
                 sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
                 sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
@@ -148,13 +148,13 @@ class PersonalizeMiddleware extends middleware_1.MiddlewareBase {
                 .initialize();
         });
     }
-    personalize({ params, friendlyId, language, timeout, variantIds, }, request) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
+    personalize(_a, request_1) {
+        return __awaiter(this, arguments, void 0, function* ({ params, friendlyId, language, timeout, variantIds, }, request) {
+            var _b;
             sitecore_jss_1.debug.personalize('executing experience for %s %o', friendlyId, params);
             return (yield (0, server_3.personalize)(request, {
                 channel: this.config.cdpConfig.channel || 'WEB',
-                currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
+                currency: (_b = this.config.cdpConfig.currency) !== null && _b !== void 0 ? _b : 'USD',
                 friendlyId,
                 params,
                 language,

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

@@ -98,7 +98,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
                     url.search = prepareNewURL.search;
                     url.locale = req.nextUrl.locale;
                 }
-                /** return Response redirect with http code of redirect type **/
+                /** return Response redirect with http code of redirect type */
                 switch (existsRedirect.redirectType) {
                     case site_1.REDIRECT_TYPE_301: {
                         return this.createRedirectResponse(url, res, 301, 'Moved Permanently');
@@ -272,7 +272,7 @@ class RedirectsMiddleware extends middleware_1.MiddlewareBase {
     /**
      * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
      * It constructs all possible query parameter permutations and tests them against the pattern.
-     * @param {Object} params - The parameters for the URL match.
+     * @param {object} params - The parameters for the URL match.
      * @param {string} params.pathname - The current URL pathname.
      * @param {string} params.queryString - The current URL query string.
      * @param {string} params.pattern - The regex pattern to test the constructed URLs against.

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

@@ -75,6 +75,14 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
  * @mixes SearchQueryService<PageListQueryResult>
  */
 class BaseGraphQLSitemapService {
+    /**
+     * Creates an instance of graphQL sitemap service with the provided options
+     * @param {GraphQLSitemapServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this._graphQLClient = this.getGraphQLClient();
+    }
     /**
      * GraphQL client accessible by descendant classes when needed
      */
@@ -87,14 +95,6 @@ class BaseGraphQLSitemapService {
     get query() {
         return defaultQuery(this.options.includePersonalizedRoutes);
     }
-    /**
-     * Creates an instance of graphQL sitemap service with the provided options
-     * @param {GraphQLSitemapServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this._graphQLClient = this.getGraphQLClient();
-    }
     /**
      * Fetch sitemap which could be used for generation of static pages during `next export`.
      * The `locale` parameter will be used in the item query, but since i18n is not supported,
@@ -162,8 +162,8 @@ class BaseGraphQLSitemapService {
         });
     }
     fetchLanguageSitePaths(language, siteName) {
-        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             const args = {
                 siteName: siteName,
                 language: language,

package/dist/cjs/services/component-props-service.js

@@ -56,8 +56,8 @@ class ComponentPropsService {
      * @returns {Promise<ComponentPropsCollection>} component props
      */
     fetchComponentProps(fetchFunctionFactory, layoutData, context) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             // Array of side effect functions
             const requests = yield this.collectRequests({
                 placeholders: (_a = layoutData.sitecore.route) === null || _a === void 0 ? void 0 : _a.placeholders,
@@ -71,7 +71,7 @@ class ComponentPropsService {
     /**
      * Go through layout service data, check all renderings using displayName, which should make some side effects.
      * Write result in requests variable
-     * @param {Object} params params
+     * @param {object} params params
      * @param {PlaceholdersData} [params.placeholders]
      * @param {FetchFunctionFactory<NextContext>} params.fetchFunctionFactory
      * @param {LayoutServiceData} params.layoutData
@@ -151,7 +151,6 @@ class ComponentPropsService {
      * flatRenderings(placeholders);
      *
      * RESULT: [{ uid: 1 }, { uid: 2 }, { uid: 11 }, { uid: 22 }]
-     *
      * @param {PlaceholdersData} placeholders placeholders
      * @returns {ComponentRendering[]} renderings
      */

package/dist/cjs/utils/utils.js

@@ -29,7 +29,6 @@ exports.getPublicUrl = getPublicUrl;
  * 1. Subscribe on events provided by webpack.
  * 2. Reset editor chromes when build is finished
  * @param {boolean} [forceReload] force page reload instead of reset chromes
- * @default forceReload false
  */
 const handleEditorFastRefresh = (forceReload = false) => {
     if (process.env.NODE_ENV !== 'development' || !(0, editing_1.isEditorActive)()) {

package/dist/esm/ComponentBuilder.js

@@ -31,7 +31,7 @@ export class ComponentBuilder {
     /**
      * Creates a new instance of component factory
      * Component can be imported dynamically or statically.
-     * @param {Object} [config] Component factory configuration
+     * @param {object} [config] Component factory configuration
      * @param {boolean} [config.isEditing] Indicates if component factory is used in editing mode
      * @returns {ComponentFactory} Component factory implementation
      */

package/dist/esm/components/Link.js

@@ -13,6 +13,10 @@ import React, { forwardRef } from 'react';
 import PropTypes from 'prop-types';
 import NextLink from 'next/link';
 import { Link as ReactLink, LinkPropTypes, } from '@sitecore-jss/sitecore-jss-react';
+/**
+ * Matches relative URLs that end with a file extension.
+ */
+const FILE_EXTENSION_MATCHER = /^\/.*\.\w+$/;
 export const Link = forwardRef((props, ref) => {
     const { field, editable = true, children, internalLinkMatcher = /^\//g, showLinkTextWithChildrenPresent } = props, htmlLinkProps = __rest(props, ["field", "editable", "children", "internalLinkMatcher", "showLinkTextWithChildrenPresent"]);
     if (!field ||
@@ -30,8 +34,10 @@ export const Link = forwardRef((props, ref) => {
     const isEditing = editable && (field.editable || field.metadata);
     if (href && !isEditing) {
         const text = showLinkTextWithChildrenPresent || !children ? value.text || value.href : null;
-        // determine if a link is a route or not.
-        if (internalLinkMatcher.test(href)) {
+        const isMatching = internalLinkMatcher.test(href);
+        const isFileUrl = FILE_EXTENSION_MATCHER.test(href);
+        // determine if a link is a route or not. File extensions are not routes and should not be pre-fetched.
+        if (isMatching && !isFileUrl) {
             return (React.createElement(NextLink, Object.assign({ href: { pathname: href, query: querystring, hash: anchor }, key: "link", locale: false, title: value.title, target: value.target, className: value.class }, htmlLinkProps, { ref: ref }),
                 text,
                 children));

package/dist/esm/editing/constants.js

@@ -1,4 +1,3 @@
-export const QUERY_PARAM_EDITING_SECRET = 'secret';
 export const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = 'x-vercel-protection-bypass';
 export const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie';
 /**
@@ -6,7 +5,3 @@ export const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = 'x-vercel-set-bypass-cookie'
  * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
  */
 export const EDITING_PASS_THROUGH_HEADERS = ['authorization', 'cookie'];
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-export const EDITING_ALLOWED_ORIGINS = ['https://pages.sitecorecloud.io'];

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

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
+import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-jss/sitecore-jss/editing';
 import { getJssEditingSecret } from '../utils/utils';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { EditMode } from '@sitecore-jss/sitecore-jss/layout';
@@ -32,6 +32,12 @@ export class EditingConfigMiddleware {
                 debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
                 return res.status(401).json({ message: 'Missing or invalid editing secret' });
             }
+            // Handle preflight request
+            if (_req.method === 'OPTIONS') {
+                debug.editing('preflight request');
+                // CORS headers are set by enforceCors
+                return res.status(204).send(null);
+            }
             const components = Array.isArray(this.config.components)
                 ? this.config.components
                 : Array.from(this.config.components.keys());

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

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { editingDataDiskCache } from './editing-data-cache';
 import { isEditingData } from './editing-data';
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
+import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-jss/sitecore-jss/editing';
 import { getJssEditingSecret } from '../utils/utils';
 import { enforceCors } from '@sitecore-jss/sitecore-jss/utils';
 import { debug } from '@sitecore-jss/sitecore-jss';

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

@@ -7,7 +7,7 @@ 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 { QUERY_PARAM_EDITING_SECRET } from '@sitecore-jss/sitecore-jss/editing';
 import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
 import { editingDataDiskCache } from './editing-data-cache';
 import { getJssEditingSecret } from '../utils/utils';

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

@@ -10,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { STATIC_PROPS_ID, SERVER_PROPS_ID } from 'next/constants';
 import { AxiosDataFetcher, debug } from '@sitecore-jss/sitecore-jss';
 import { EditMode } from '@sitecore-jss/sitecore-jss/layout';
+import { QUERY_PARAM_EDITING_SECRET, EDITING_ALLOWED_ORIGINS, } from '@sitecore-jss/sitecore-jss/editing';
 import { editingDataService } from './editing-data-service';
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
 import { getJssEditingSecret } from '../utils/utils';
 import { RenderMiddlewareBase } from './render-middleware';
 import { enforceCors, getAllowedOriginsFromEnv } from '@sitecore-jss/sitecore-jss/utils';
@@ -27,7 +27,7 @@ export class ChromesHandler extends RenderMiddlewareBase {
         this.config = config;
         /**
          * Default page URL resolution.
-         * @param {Object} args Arguments for resolving the page URL
+         * @param {object} args Arguments for resolving the page URL
          * @param {string} args.serverUrl The root server URL e.g. 'http://localhost:3000'
          * @param {string} args.itemPath The Sitecore relative item path e.g. '/styleguide'
          * @returns {string} The URL to render
@@ -169,7 +169,7 @@ export class ChromesHandler extends RenderMiddlewareBase {
 }
 /**
  * Type guard for EditingMetadataPreviewData
- * @param {Object} data preview data to check
+ * @param {object} data preview data to check
  * @returns true if the data is EditingMetadataPreviewData
  * @see EditingMetadataPreviewData
  */
@@ -260,7 +260,10 @@ export class MetadataHandler {
      * @returns Content-Security-Policy header value
      */
     getSCPHeader() {
-        return `frame-ancestors 'self' ${[getAllowedOriginsFromEnv(), ...EDITING_ALLOWED_ORIGINS].join(' ')}`;
+        return `frame-ancestors 'self' ${[
+            ...getAllowedOriginsFromEnv(),
+            ...EDITING_ALLOWED_ORIGINS,
+        ].join(' ')}`;
     }
 }
 /**
@@ -308,6 +311,11 @@ export class EditingRenderMiddleware extends RenderMiddlewareBase {
                     yield handler.render(req, res);
                     break;
                 }
+                case 'OPTIONS': {
+                    debug.editing('preflight request');
+                    // CORS headers are set by enforceCors
+                    return res.status(204).send(null);
+                }
                 default:
                     debug.editing('invalid method - sent %s expected GET/POST', req.method);
                     res.setHeader('Allow', 'GET, POST');

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

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { debug } from '@sitecore-jss/sitecore-jss';
-import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET } from './constants';
+import { EDITING_ALLOWED_ORIGINS, QUERY_PARAM_EDITING_SECRET, } from '@sitecore-jss/sitecore-jss/editing';
 import { getJssEditingSecret } from '../utils/utils';
 import { RenderMiddlewareBase } from './render-middleware';
 import { enforceCors } from '@sitecore-jss/sitecore-jss/utils';
@@ -40,9 +40,9 @@ export class FEAASRenderMiddleware extends RenderMiddlewareBase {
                     .status(401)
                     .send(`<html><body>Requests from origin ${(_b = req.headers) === null || _b === void 0 ? void 0 : _b.origin} are not allowed</body></html>`);
             }
-            if (method !== 'GET') {
-                debug.editing('invalid method - sent %s expected GET', method);
-                res.setHeader('Allow', 'GET');
+            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
@@ -51,6 +51,12 @@ export class FEAASRenderMiddleware extends RenderMiddlewareBase {
                 debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getJssEditingSecret());
                 return res.status(401).send('<html><body>Missing or invalid secret</body></html>');
             }
+            // Handle preflight request
+            if (method === 'OPTIONS') {
+                debug.editing('preflight request');
+                // CORS headers are set by enforceCors
+                return res.status(204).send(null);
+            }
             try {
                 // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
                 const params = this.getQueryParamsForPropagation(query);

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

@@ -6,7 +6,7 @@ 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
+         * @param {object} query Object of query parameters from incoming URL
          * @returns Object of approved query parameters
          */
         this.getQueryParamsForPropagation = (query) => {

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

@@ -132,8 +132,8 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             }
         });
     }
-    initPersonalizeServer({ hostname, siteName, request, response, }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    initPersonalizeServer(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ hostname, siteName, request, response, }) {
             yield CloudSDK(request, response, {
                 sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
                 sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
@@ -145,13 +145,13 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 .initialize();
         });
     }
-    personalize({ params, friendlyId, language, timeout, variantIds, }, request) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
+    personalize(_a, request_1) {
+        return __awaiter(this, arguments, void 0, function* ({ params, friendlyId, language, timeout, variantIds, }, request) {
+            var _b;
             debug.personalize('executing experience for %s %o', friendlyId, params);
             return (yield personalize(request, {
                 channel: this.config.cdpConfig.channel || 'WEB',
-                currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
+                currency: (_b = this.config.cdpConfig.currency) !== null && _b !== void 0 ? _b : 'USD',
                 friendlyId,
                 params,
                 language,

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

@@ -92,7 +92,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
                     url.search = prepareNewURL.search;
                     url.locale = req.nextUrl.locale;
                 }
-                /** return Response redirect with http code of redirect type **/
+                /** return Response redirect with http code of redirect type */
                 switch (existsRedirect.redirectType) {
                     case REDIRECT_TYPE_301: {
                         return this.createRedirectResponse(url, res, 301, 'Moved Permanently');
@@ -266,7 +266,7 @@ export class RedirectsMiddleware extends MiddlewareBase {
     /**
      * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
      * It constructs all possible query parameter permutations and tests them against the pattern.
-     * @param {Object} params - The parameters for the URL match.
+     * @param {object} params - The parameters for the URL match.
      * @param {string} params.pathname - The current URL pathname.
      * @param {string} params.queryString - The current URL query string.
      * @param {string} params.pattern - The regex pattern to test the constructed URLs against.

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

@@ -71,6 +71,14 @@ query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
  * @mixes SearchQueryService<PageListQueryResult>
  */
 export class BaseGraphQLSitemapService {
+    /**
+     * Creates an instance of graphQL sitemap service with the provided options
+     * @param {GraphQLSitemapServiceConfig} options instance
+     */
+    constructor(options) {
+        this.options = options;
+        this._graphQLClient = this.getGraphQLClient();
+    }
     /**
      * GraphQL client accessible by descendant classes when needed
      */
@@ -83,14 +91,6 @@ export class BaseGraphQLSitemapService {
     get query() {
         return defaultQuery(this.options.includePersonalizedRoutes);
     }
-    /**
-     * Creates an instance of graphQL sitemap service with the provided options
-     * @param {GraphQLSitemapServiceConfig} options instance
-     */
-    constructor(options) {
-        this.options = options;
-        this._graphQLClient = this.getGraphQLClient();
-    }
     /**
      * Fetch sitemap which could be used for generation of static pages during `next export`.
      * The `locale` parameter will be used in the item query, but since i18n is not supported,
@@ -158,8 +158,8 @@ export class BaseGraphQLSitemapService {
         });
     }
     fetchLanguageSitePaths(language, siteName) {
-        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             const args = {
                 siteName: siteName,
                 language: language,

package/dist/esm/services/component-props-service.js

@@ -50,8 +50,8 @@ export class ComponentPropsService {
      * @returns {Promise<ComponentPropsCollection>} component props
      */
     fetchComponentProps(fetchFunctionFactory, layoutData, context) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             // Array of side effect functions
             const requests = yield this.collectRequests({
                 placeholders: (_a = layoutData.sitecore.route) === null || _a === void 0 ? void 0 : _a.placeholders,
@@ -65,7 +65,7 @@ export class ComponentPropsService {
     /**
      * Go through layout service data, check all renderings using displayName, which should make some side effects.
      * Write result in requests variable
-     * @param {Object} params params
+     * @param {object} params params
      * @param {PlaceholdersData} [params.placeholders]
      * @param {FetchFunctionFactory<NextContext>} params.fetchFunctionFactory
      * @param {LayoutServiceData} params.layoutData
@@ -145,7 +145,6 @@ export class ComponentPropsService {
      * flatRenderings(placeholders);
      *
      * RESULT: [{ uid: 1 }, { uid: 2 }, { uid: 11 }, { uid: 22 }]
-     *
      * @param {PlaceholdersData} placeholders placeholders
      * @returns {ComponentRendering[]} renderings
      */

package/dist/esm/utils/utils.js

@@ -25,7 +25,6 @@ export const getPublicUrl = () => {
  * 1. Subscribe on events provided by webpack.
  * 2. Reset editor chromes when build is finished
  * @param {boolean} [forceReload] force page reload instead of reset chromes
- * @default forceReload false
  */
 export const handleEditorFastRefresh = (forceReload = false) => {
     if (process.env.NODE_ENV !== 'development' || !isEditorActive()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.3.0",
+  "version": "22.3.1-canary.11",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -11,10 +11,10 @@
     "test": "mocha --require ./test/setup.js \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "author": {
     "name": "Sitecore Corporation",
@@ -29,16 +29,16 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
-    "@sitecore-cloudsdk/core": "^0.4.1",
-    "@sitecore-cloudsdk/personalize": "^0.4.1",
+    "@sitecore-cloudsdk/core": "^0.4.2",
+    "@sitecore-cloudsdk/personalize": "^0.4.2",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-string": "^1.4.2",
     "@types/enzyme": "^3.10.12",
     "@types/mocha": "^10.0.1",
-    "@types/node": "~20.14.2",
+    "@types/node": "~22.9.0",
     "@types/prop-types": "^15.7.5",
-    "@types/react": "^18.2.22",
+    "@types/react": "^18.2.45",
     "@types/react-dom": "^18.0.10",
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.9",
@@ -51,11 +51,11 @@
     "cross-fetch": "^3.1.5",
     "del-cli": "^5.0.0",
     "enzyme": "^3.11.0",
-    "eslint": "^8.32.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-react": "^7.32.1",
     "jsdom": "^21.1.0",
     "mocha": "^10.2.0",
-    "next": "^14.2.7",
+    "next": "^14.2.18",
     "nock": "^13.3.0",
     "nyc": "^15.1.0",
     "react": "^18.2.0",
@@ -63,19 +63,19 @@
     "sinon": "^15.0.1",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.1",
-    "typescript": "~4.9.4"
+    "typescript": "~5.4.0"
   },
   "peerDependencies": {
-    "@sitecore-cloudsdk/core": "^0.4.1",
-    "@sitecore-cloudsdk/personalize": "^0.4.1",
-    "next": "^14.2.7",
+    "@sitecore-cloudsdk/core": "^0.4.2",
+    "@sitecore-cloudsdk/personalize": "^0.4.2",
+    "next": "^14.2.18",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "22.3.0",
-    "@sitecore-jss/sitecore-jss-dev-tools": "22.3.0",
-    "@sitecore-jss/sitecore-jss-react": "22.3.0",
+    "@sitecore-jss/sitecore-jss": "^22.3.1-canary.11",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^22.3.1-canary.11",
+    "@sitecore-jss/sitecore-jss-react": "^22.3.1-canary.11",
     "@vercel/kv": "^0.2.1",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -83,7 +83,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "81b0239517966b6d0debdf6da3f12a98228c4d0c",
+  "gitHead": "e0fc3cbbe09cd16d73934faa4807de2867cd3126",
   "files": [
     "dist",
     "types",

package/types/ComponentBuilder.d.ts

@@ -50,7 +50,7 @@ export declare class ComponentBuilder {
     /**
      * Creates a new instance of component factory
      * Component can be imported dynamically or statically.
-     * @param {Object} [config] Component factory configuration
+     * @param {object} [config] Component factory configuration
      * @param {boolean} [config.isEditing] Indicates if component factory is used in editing mode
      * @returns {ComponentFactory} Component factory implementation
      */

package/types/editing/constants.d.ts

@@ -1,4 +1,3 @@
-export declare const QUERY_PARAM_EDITING_SECRET = "secret";
 export declare const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = "x-vercel-protection-bypass";
 export declare const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = "x-vercel-set-bypass-cookie";
 /**
@@ -6,7 +5,3 @@ export declare const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = "x-vercel-set-bypass
  * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
  */
 export declare const EDITING_PASS_THROUGH_HEADERS: string[];
-/**
- * Default allowed origins for editing requests. This is used to enforce CORS, CSP headers.
- */
-export declare const EDITING_ALLOWED_ORIGINS: string[];

package/types/editing/editing-render-middleware.d.ts

@@ -1,7 +1,7 @@
 import { NextApiRequest, NextApiResponse } from 'next';
 import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
 import { EditMode, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
-import { LayoutKind } from '@sitecore-jss/sitecore-jss/editing';
+import { RenderMetadataQueryParams, LayoutKind } from '@sitecore-jss/sitecore-jss/editing';
 import { EditingDataService } from './editing-data-service';
 import { RenderMiddlewareBase } from './render-middleware';
 /**
@@ -32,7 +32,7 @@ export type EditingRenderMiddlewareConfig = {
      *
      * Function used to determine route/page URL to render.
      * This may be necessary for certain custom Next.js routing configurations.
-     * @param {Object} args Arguments for resolving the page URL
+     * @param {object} args Arguments for resolving the page URL
      * @param {string} args.serverUrl The root server URL e.g. 'http://localhost:3000'. Available in Chromes Edit Mode only.
      * @param {string} itemPath The Sitecore relative item path e.g. '/styleguide'
      * @returns {string} The URL to render
@@ -73,7 +73,7 @@ export declare class ChromesHandler extends RenderMiddlewareBase {
     render(req: NextApiRequest, res: NextApiResponse): Promise<void>;
     /**
      * Default page URL resolution.
-     * @param {Object} args Arguments for resolving the page URL
+     * @param {object} args Arguments for resolving the page URL
      * @param {string} args.serverUrl The root server URL e.g. 'http://localhost:3000'
      * @param {string} args.itemPath The Sitecore relative item path e.g. '/styleguide'
      * @returns {string} The URL to render
@@ -96,26 +96,11 @@ export declare class ChromesHandler extends RenderMiddlewareBase {
  * Configuration for the Editing Metadata Handler.
  */
 export type EditingRenderMiddlewareMetadataConfig = Pick<EditingRenderMiddlewareConfig, 'resolvePageUrl'>;
-/**
- * Query parameters appended to the page route URL
- * Appended when XMCloud Pages preview (editing) Metadata Edit Mode is used
- */
-export type MetadataQueryParams = {
-    secret: string;
-    sc_lang: string;
-    sc_itemid: string;
-    sc_site: string;
-    route: string;
-    mode: Exclude<LayoutServicePageState, 'normal'>;
-    sc_variant?: string;
-    sc_version?: string;
-    sc_layoutKind?: LayoutKind;
-};
 /**
  * Next.js API request with Metadata query parameters.
  */
 type MetadataNextApiRequest = NextApiRequest & {
-    query: MetadataQueryParams;
+    query: RenderMetadataQueryParams;
 };
 /**
  * Data for Next.js Preview (Editing) Metadata Edit Mode.
@@ -132,7 +117,7 @@ export type EditingMetadataPreviewData = {
 };
 /**
  * Type guard for EditingMetadataPreviewData
- * @param {Object} data preview data to check
+ * @param {object} data preview data to check
  * @returns true if the data is EditingMetadataPreviewData
  * @see EditingMetadataPreviewData
  */

package/types/editing/render-middleware.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { IncomingHttpHeaders } from 'http';
 /**
  * Base class for middleware that handles pages and components rendering in Sitecore Editors.
@@ -5,7 +6,7 @@ import { IncomingHttpHeaders } from 'http';
 export declare abstract class RenderMiddlewareBase {
     /**
      * 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
+     * @param {object} query Object of query parameters from incoming URL
      * @returns Object of approved query parameters
      */
     protected getQueryParamsForPropagation: (query: Partial<{

package/types/middleware/redirects-middleware.d.ts

@@ -57,7 +57,7 @@ export declare class RedirectsMiddleware extends MiddlewareBase {
     /**
      * Checks if the current URL query matches the provided pattern, considering all permutations of query parameters.
      * It constructs all possible query parameter permutations and tests them against the pattern.
-     * @param {Object} params - The parameters for the URL match.
+     * @param {object} params - The parameters for the URL match.
      * @param {string} params.pathname - The current URL pathname.
      * @param {string} params.queryString - The current URL query string.
      * @param {string} params.pattern - The regex pattern to test the constructed URLs against.

package/types/services/base-graphql-sitemap-service.d.ts

@@ -27,7 +27,8 @@ interface SiteRouteQueryVariables {
      * Optional. Paths starting with these provided prefixes will be excluded from returned results.
      */
     excludedPaths?: string[];
-    /** common variable for all GraphQL queries
+    /**
+     * common variable for all GraphQL queries
      * it will be used for every type of query to regulate result batch size
      * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
      * @default 100
@@ -96,6 +97,11 @@ export type StaticPath = {
 export declare abstract class BaseGraphQLSitemapService {
     options: BaseGraphQLSitemapServiceConfig;
     private _graphQLClient;
+    /**
+     * Creates an instance of graphQL sitemap service with the provided options
+     * @param {GraphQLSitemapServiceConfig} options instance
+     */
+    constructor(options: BaseGraphQLSitemapServiceConfig);
     /**
      * GraphQL client accessible by descendant classes when needed
      */
@@ -104,11 +110,6 @@ export declare abstract class BaseGraphQLSitemapService {
      * Gets the default query used for fetching the list of site pages
      */
     protected get query(): string;
-    /**
-     * Creates an instance of graphQL sitemap service with the provided options
-     * @param {GraphQLSitemapServiceConfig} options instance
-     */
-    constructor(options: BaseGraphQLSitemapServiceConfig);
     /**
      * Fetch sitemap which could be used for generation of static pages during `next export`.
      * The `locale` parameter will be used in the item query, but since i18n is not supported,

package/types/services/component-props-service.d.ts

@@ -41,7 +41,7 @@ export declare class ComponentPropsService {
     /**
      * Go through layout service data, check all renderings using displayName, which should make some side effects.
      * Write result in requests variable
-     * @param {Object} params params
+     * @param {object} params params
      * @param {PlaceholdersData} [params.placeholders]
      * @param {FetchFunctionFactory<NextContext>} params.fetchFunctionFactory
      * @param {LayoutServiceData} params.layoutData
@@ -73,7 +73,6 @@ export declare class ComponentPropsService {
      * flatRenderings(placeholders);
      *
      * RESULT: [{ uid: 1 }, { uid: 2 }, { uid: 11 }, { uid: 22 }]
-     *
      * @param {PlaceholdersData} placeholders placeholders
      * @returns {ComponentRendering[]} renderings
      */

package/types/utils/utils.d.ts

@@ -13,7 +13,6 @@ export declare const getPublicUrl: () => string;
  * 1. Subscribe on events provided by webpack.
  * 2. Reset editor chromes when build is finished
  * @param {boolean} [forceReload] force page reload instead of reset chromes
- * @default forceReload false
  */
 export declare const handleEditorFastRefresh: (forceReload?: boolean) => void;
 export declare const getJssEditingSecret: () => string;