@sitecore-jss/sitecore-jss-nextjs 22.1.0-canary.9 → 22.2.0-canary.2

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

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { NextResponse } from 'next/server';
-import { GraphQLPersonalizeService, getPersonalizedRewrite, } from '@sitecore-jss/sitecore-jss/personalize';
+import { GraphQLPersonalizeService, getPersonalizedRewrite, CdpHelper, DEFAULT_VARIANT, } from '@sitecore-jss/sitecore-jss/personalize';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { MiddlewareBase } from './middleware';
 import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
@@ -58,6 +58,15 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 debug.personalize('skipped (no personalization configured)');
                 return response;
             }
+            if (this.isPrefetch(req)) {
+                debug.personalize('skipped (prefetch)');
+                // Personalized, but this is a prefetch request.
+                // In this case, don't execute a personalize request; otherwise, the metrics for component A/B experiments would be inaccurate.
+                // Disable preflight caching to force revalidation on client-side navigation (personalization WILL be influenced).
+                // Note the reason we don't move this any earlier in the middleware is that we would then be sacrificing performance for non-personalized pages.
+                response.headers.set('x-middleware-cache', 'no-cache');
+                return response;
+            }
             yield this.initPersonalizeServer({
                 hostname,
                 siteName: site.name,
@@ -65,32 +74,36 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 response,
             });
             const params = this.getExperienceParams(req);
-            debug.personalize('executing experience for %s %o', personalizeInfo.contentId, params);
-            let variantId;
-            // Execute targeted experience in Personalize SDK
-            // eslint-disable-next-line no-useless-catch
-            try {
-                const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
-                variantId = personalization.variantId;
-            }
-            catch (error) {
-                throw error;
-            }
-            if (!variantId) {
-                debug.personalize('skipped (no variant identified)');
-                return response;
-            }
-            if (!personalizeInfo.variantIds.includes(variantId)) {
-                debug.personalize('skipped (invalid variant)');
+            const executions = this.getPersonalizeExecutions(personalizeInfo, language);
+            const identifiedVariantIds = [];
+            yield Promise.all(executions.map((execution) => this.personalize({
+                friendlyId: execution.friendlyId,
+                variantIds: execution.variantIds,
+                params,
+                language,
+                timeout,
+            }, req).then((personalization) => {
+                const variantId = personalization.variantId;
+                if (variantId) {
+                    if (!execution.variantIds.includes(variantId)) {
+                        debug.personalize('invalid variant %s', variantId);
+                    }
+                    else {
+                        identifiedVariantIds.push(variantId);
+                    }
+                }
+            })));
+            if (identifiedVariantIds.length === 0) {
+                debug.personalize('skipped (no variant(s) identified)');
                 return response;
             }
             // Path can be rewritten by previously executed middleware
             const basePath = (res === null || res === void 0 ? void 0 : res.headers.get('x-sc-rewrite')) || pathname;
             // Rewrite to persononalized path
-            const rewritePath = getPersonalizedRewrite(basePath, { variantId });
+            const rewritePath = getPersonalizedRewrite(basePath, identifiedVariantIds);
             response = this.rewrite(rewritePath, req, response);
-            // Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
-            // See https://github.com/vercel/next.js/issues/32727
+            // Disable preflight caching to force revalidation on client-side navigation (personalization MAY be influenced).
+            // See https://github.com/vercel/next.js/pull/32767
             response.headers.set('x-middleware-cache', 'no-cache');
             debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
@@ -129,17 +142,18 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             });
         });
     }
-    personalize({ params, personalizeInfo, language, timeout, }, request) {
+    personalize({ params, friendlyId, language, timeout, variantIds, }, request) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const personalizationData = {
+            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',
-                friendlyId: personalizeInfo.contentId,
+                friendlyId,
                 params,
                 language,
-            };
-            return (yield personalize(request, personalizationData, { timeout }));
+                pageVariantIds: variantIds,
+            }, { timeout }));
         });
     }
     getExperienceParams(req) {
@@ -161,4 +175,50 @@ export class PersonalizeMiddleware extends MiddlewareBase {
         // ignore files
         return pathname.includes('.') || super.excludeRoute(pathname);
     }
+    /**
+     * Aggregates personalize executions based on the provided route personalize information and language
+     * @param {PersonalizeInfo} personalizeInfo the route personalize information
+     * @param {string} language the language
+     * @returns An array of personalize executions
+     */
+    getPersonalizeExecutions(personalizeInfo, language) {
+        if (personalizeInfo.variantIds.length === 0) {
+            return [];
+        }
+        const results = [];
+        return personalizeInfo.variantIds.reduce((results, variantId) => {
+            if (variantId.includes('_')) {
+                // Component-level personalization in format "<ComponentID>_<VariantID>"
+                const componentId = variantId.split('_')[0];
+                const friendlyId = CdpHelper.getComponentFriendlyId(personalizeInfo.pageId, componentId, language, this.config.scope || this.config.edgeConfig.scope);
+                const execution = results.find((x) => x.friendlyId === friendlyId);
+                if (execution) {
+                    execution.variantIds.push(variantId);
+                }
+                else {
+                    // The default/control variant (format "<ComponentID>_default") is also a valid value returned by the execution
+                    const defaultVariant = `${componentId}${DEFAULT_VARIANT}`;
+                    results.push({
+                        friendlyId,
+                        variantIds: [defaultVariant, variantId],
+                    });
+                }
+            }
+            else {
+                // Embedded (page-level) personalization in format "<VariantID>"
+                const friendlyId = CdpHelper.getPageFriendlyId(personalizeInfo.pageId, language, this.config.scope || this.config.edgeConfig.scope);
+                const execution = results.find((x) => x.friendlyId === friendlyId);
+                if (execution) {
+                    execution.variantIds.push(variantId);
+                }
+                else {
+                    results.push({
+                        friendlyId,
+                        variantIds: [variantId],
+                    });
+                }
+            }
+            return results;
+        }, results);
+    }
 }

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

@@ -144,13 +144,14 @@ export class BaseGraphQLSitemapService {
             const formatPath = (path) => formatStaticPath(path.replace(/^\/|\/$/g, '').split('/'), language);
             const aggregatedPaths = [];
             sitePaths.forEach((item) => {
-                var _a, _b, _c, _d;
+                var _a, _b, _c;
                 if (!item)
                     return;
                 aggregatedPaths.push(formatPath(item.path));
-                // check for type safety's sake - personalize may be empty depending on query type
-                if ((_b = (_a = item.route) === null || _a === void 0 ? void 0 : _a.personalization) === null || _b === void 0 ? void 0 : _b.variantIds.length) {
-                    aggregatedPaths.push(...(((_d = (_c = item.route) === null || _c === void 0 ? void 0 : _c.personalization) === null || _d === void 0 ? void 0 : _d.variantIds.map((varId) => formatPath(getPersonalizedRewrite(item.path, { variantId: varId })))) || {}));
+                const variantIds = (_c = (_b = (_a = item.route) === null || _a === void 0 ? void 0 : _a.personalization) === null || _b === void 0 ? void 0 : _b.variantIds) === null || _c === void 0 ? void 0 : _c.filter((variantId) => !variantId.includes('_') // exclude component A/B test variants
+                );
+                if (variantIds === null || variantIds === void 0 ? void 0 : variantIds.length) {
+                    aggregatedPaths.push(...variantIds.map((varId) => formatPath(getPersonalizedRewrite(item.path, [varId]))));
                 }
             });
             return aggregatedPaths;

package/dist/esm/utils/index.js

@@ -1,2 +1,3 @@
 export { getPublicUrl, handleEditorFastRefresh } from './utils';
-export { tryParseEnvValue, isEditorActive, resetEditorChromes, resolveUrl, } from '@sitecore-jss/sitecore-jss/utils';
+export { tryParseEnvValue, resolveUrl } from '@sitecore-jss/sitecore-jss/utils';
+export { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/editing';

package/dist/esm/utils/utils.js

@@ -1,4 +1,4 @@
-import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/utils';
+import { isEditorActive, resetEditorChromes } from '@sitecore-jss/sitecore-jss/editing';
 /**
  * Get the publicUrl.
  * This is used primarily to enable compatibility with Sitecore editors.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "22.1.0-canary.9",
+  "version": "22.2.0-canary.2",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -14,7 +14,7 @@
     "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"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "author": {
     "name": "Sitecore Corporation",
@@ -29,13 +29,13 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
-    "@sitecore-cloudsdk/personalize": "^0.3.0",
+    "@sitecore-cloudsdk/personalize": "^0.3.1",
     "@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": "~18.11.18",
+    "@types/node": "~20.14.2",
     "@types/prop-types": "^15.7.5",
     "@types/react": "^18.2.22",
     "@types/react-dom": "^18.0.10",
@@ -65,25 +65,24 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
-    "@sitecore-cloudsdk/events": "^0.3.0",
-    "@sitecore-cloudsdk/personalize": "^0.3.0",
+    "@sitecore-cloudsdk/events": "^0.3.1",
+    "@sitecore-cloudsdk/personalize": "^0.3.1",
     "next": "^14.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^22.1.0-canary.9",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^22.1.0-canary.9",
-    "@sitecore-jss/sitecore-jss-react": "^22.1.0-canary.9",
+    "@sitecore-jss/sitecore-jss": "^22.2.0-canary.2",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^22.2.0-canary.2",
+    "@sitecore-jss/sitecore-jss-react": "^22.2.0-canary.2",
     "@vercel/kv": "^0.2.1",
-    "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
     "sync-disk-cache": "^2.1.0"
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "9b249f8d03fb9d74e74f74f3040fc2668137bdcc",
+  "gitHead": "ba1b71ef1209c0e3bdd3557d315a0e2a46ba4580",
   "files": [
     "dist",
     "types",

package/types/ComponentBuilder.d.ts

@@ -1,18 +1,16 @@
-/// <reference types="@types/react" />
-import { ComponentFactory } from '@sitecore-jss/sitecore-jss-react';
+import { ComponentFactory, JssComponentType } from '@sitecore-jss/sitecore-jss-react';
 import { Module, ModuleFactory } from './sharedTypes/module-factory';
-import { ComponentType } from 'react';
 /**
  * Represents a component that can be imported dynamically
  */
 export type LazyModule = {
     module: () => Promise<Module>;
-    element: (isEditing?: boolean) => ComponentType;
+    element: (isEditing?: boolean) => JssComponentType;
 };
 /**
  * Component is a module or a lazy module
  */
-type Component = Module | LazyModule | ComponentType;
+type Component = Module | LazyModule | JssComponentType;
 /**
  * Configuration for ComponentBuilder
  */

package/types/components/Placeholder.d.ts

@@ -1,4 +1,9 @@
 /// <reference types="@types/react" />
 import React from 'react';
-import { PlaceholderComponentProps } from '@sitecore-jss/sitecore-jss-react';
-export declare const Placeholder: (props: PlaceholderComponentProps) => React.JSX.Element;
+import { PlaceholderComponentProps, WithSitecoreContextProps, EnhancedOmit } from '@sitecore-jss/sitecore-jss-react';
+/**
+ * React Placeholder component wrapped by withSitecoreContext, so these properties shouldn't be passed to the Next.js Placeholder.
+ */
+type PlaceholderProps = EnhancedOmit<PlaceholderComponentProps, keyof WithSitecoreContextProps>;
+export declare const Placeholder: (props: PlaceholderProps) => React.JSX.Element;
+export {};

package/types/components/RichText.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="@types/react" />
+import React from 'react';
 import PropTypes from 'prop-types';
 import { RichTextProps as ReactRichTextProps } from '@sitecore-jss/sitecore-jss-react';
 export type RichTextProps = ReactRichTextProps & {
@@ -19,9 +21,13 @@ export declare const RichText: {
         field: PropTypes.Requireable<PropTypes.InferProps<{
             value: PropTypes.Requireable<string>;
             editable: PropTypes.Requireable<string>;
+            metadata: PropTypes.Requireable<{
+                [x: string]: any;
+            }>;
         }>>;
         tag: PropTypes.Requireable<string>;
         editable: PropTypes.Requireable<boolean>;
+        emptyFieldEditingComponent: PropTypes.Requireable<NonNullable<React.ComponentClass<unknown, any> | React.FC<unknown>>>;
         internalLinksSelector: PropTypes.Requireable<string>;
     };
     displayName: string;

package/types/editing/constants.d.ts

@@ -1,3 +1,12 @@
 export declare const QUERY_PARAM_EDITING_SECRET = "secret";
-export declare const QUERY_PARAM_PROTECTION_BYPASS_SITECORE = "x-sitecore-protection-bypass";
-export declare const QUERY_PARAM_PROTECTION_BYPASS_VERCEL = "x-vercel-protection-bypass";
+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";
+/**
+ * Headers that should be passed along to (Editing Chromes handler) SSR request.
+ * 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-config-middleware.d.ts

@@ -1,4 +1,5 @@
 import { NextApiRequest, NextApiResponse } from 'next';
+import { EditMode } from '@sitecore-jss/sitecore-jss/layout';
 import { Metadata } from '@sitecore-jss/sitecore-jss-dev-tools';
 export type EditingConfigMiddlewareConfig = {
     /**
@@ -9,6 +10,12 @@ export type EditingConfigMiddlewareConfig = {
      * Application metadata
      */
     metadata: Metadata;
+    /**
+     * Determines which editing mode should be used by Pages.
+     * Can be either 'chromes' or 'metadata'.
+     * By default its 'metadata'
+     */
+    pagesEditMode?: EditMode;
 };
 /**
  * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')

package/types/editing/editing-data-service.d.ts

@@ -4,6 +4,7 @@ import { EditingDataCache } from './editing-data-cache';
 import { PreviewData } from 'next';
 /**
  * Data for Next.js Preview (Editing) mode
+ * Used in Chromes Edit Mode only
  */
 export interface EditingPreviewData {
     key: string;

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

@@ -1,16 +1,23 @@
 import { NextApiRequest, NextApiResponse } from 'next';
 import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
-import { EditingData } from './editing-data';
+import { EditMode, LayoutServicePageState } from '@sitecore-jss/sitecore-jss/layout';
 import { EditingDataService } from './editing-data-service';
 import { RenderMiddlewareBase } from './render-middleware';
-export interface EditingRenderMiddlewareConfig {
+/**
+ * Configuration for the Editing Render Middleware.
+ */
+export type EditingRenderMiddlewareConfig = {
     /**
+     * -- Edit Mode Chromes --
+     *
      * The `AxiosDataFetcher` instance to use for API requests.
      * @default new AxiosDataFetcher()
      * @see AxiosDataFetcher
      */
     dataFetcher?: AxiosDataFetcher;
     /**
+     * -- Edit Mode Chromes --
+     *
      * The `EditingDataService` instance to use.
      * This would typically only be necessary if you've got a custom `EditingDataService` instance (e.g. using a custom API route).
      * By default, this is `editingDataService` (the `EditingDataService` default instance).
@@ -20,16 +27,25 @@ export interface EditingRenderMiddlewareConfig {
      */
     editingDataService?: EditingDataService;
     /**
+     * -- Edit Mode Chromes / Metadata --
+     *
      * Function used to determine route/page URL to render.
      * This may be necessary for certain custom Next.js routing configurations.
-     * @param {string} serverUrl The root server URL e.g. 'http://localhost:3000'
+     * @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
-     * @default `${serverUrl}${itemPath}`
+     * @default `${serverUrl}${itemPath}` In Edit Mode Chromes
+     * @default `${itemPath}` In XMCloud Pages for Edit Mode Metadata
      * @see resolveServerUrl
      */
-    resolvePageUrl?: (serverUrl: string, itemPath: string) => string;
+    resolvePageUrl?: (args: {
+        serverUrl?: string;
+        itemPath: string;
+    }) => string;
     /**
+     * -- Edit Mode Chromes --
+     *
      * Function used to determine the root server URL. This is used for the route/page and subsequent data API requests.
      * By default, the host header is used, with https protocol on Vercel (due to serverless function architecture) and http protocol elsewhere.
      * @param {NextApiRequest} req The current request.
@@ -37,30 +53,29 @@ export interface EditingRenderMiddlewareConfig {
      * @see resolvePageUrl
      */
     resolveServerUrl?: (req: NextApiRequest) => string;
-}
+};
 /**
- * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
- * which is required for Sitecore editing support.
+ * Configuration for the Editing Chromes Handler.
  */
-export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
+export type EditingRenderMiddlewareChromesConfig = EditingRenderMiddlewareConfig;
+/**
+ * Handler for the Editing Chromes POST requests.
+ * This handler is responsible for rendering the page and returning the HTML content that is provided via request.
+ */
+export declare class ChromesHandler extends RenderMiddlewareBase {
+    config?: EditingRenderMiddlewareConfig | undefined;
     private editingDataService;
     private dataFetcher;
     private resolvePageUrl;
     private resolveServerUrl;
-    /**
-     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
-     */
-    constructor(config?: EditingRenderMiddlewareConfig);
-    /**
-     * Gets the Next.js API route handler
-     * @returns route handler
-     */
-    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
-    private handler;
+    constructor(config?: EditingRenderMiddlewareConfig | undefined);
+    render(req: NextApiRequest, res: NextApiResponse): Promise<void>;
     /**
      * Default page URL resolution.
-     * @param {string} serverUrl
-     * @param {string} itemPath
+     * @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
      */
     private defaultResolvePageUrl;
     /**
@@ -74,8 +89,81 @@ export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
      * @param {NextApiRequest} req
      */
     private defaultResolveServerUrl;
+    private extractEditingData;
+}
+/**
+ * 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;
+};
+/**
+ * Next.js API request with Metadata query parameters.
+ */
+type MetadataNextApiRequest = NextApiRequest & {
+    query: MetadataQueryParams;
+};
+/**
+ * Data for Next.js Preview (Editing) Metadata Edit Mode.
+ */
+export type EditingMetadataPreviewData = {
+    site: string;
+    itemId: string;
+    language: string;
+    editMode: EditMode.Metadata;
+    pageState: Exclude<LayoutServicePageState, 'Normal'>;
+    variantIds: string[];
+    version?: string;
+};
+/**
+ * Type guard for EditingMetadataPreviewData
+ * @param {Object} data preview data to check
+ * @returns true if the data is EditingMetadataPreviewData
+ * @see EditingMetadataPreviewData
+ */
+export declare const isEditingMetadataPreviewData: (data: unknown) => data is EditingMetadataPreviewData;
+/**
+ * Handler for the Editing Metadata GET requests.
+ * This handler is responsible for redirecting the request to the page route.
+ * The page fetches the layout, dictionary and renders the page.
+ */
+export declare class MetadataHandler {
+    config: EditingRenderMiddlewareMetadataConfig;
+    constructor(config: EditingRenderMiddlewareMetadataConfig);
+    render(req: MetadataNextApiRequest, res: NextApiResponse): void;
+    /**
+     * Gets the Content-Security-Policy header value
+     * @returns Content-Security-Policy header value
+     */
+    getSCPHeader(): string;
 }
 /**
- * @param {NextApiRequest} req
+ * 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 declare function extractEditingData(req: NextApiRequest): EditingData;
+export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
+    config?: EditingRenderMiddlewareConfig | undefined;
+    /**
+     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+     */
+    constructor(config?: EditingRenderMiddlewareConfig | undefined);
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}
+export {};

package/types/editing/index.d.ts

@@ -1,7 +1,8 @@
+export { GraphQLEditingService } from '@sitecore-jss/sitecore-jss/editing';
 export { EditingData } from './editing-data';
 export { EditingDataCache, EditingDataDiskCache } from './editing-data-cache';
 export { EditingDataMiddleware, EditingDataMiddlewareConfig } from './editing-data-middleware';
-export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, } from './editing-render-middleware';
+export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, EditingMetadataPreviewData, isEditingMetadataPreviewData, } from './editing-render-middleware';
 export { EditingPreviewData, EditingDataService, BasicEditingDataService, BasicEditingDataServiceConfig, ServerlessEditingDataService, ServerlessEditingDataServiceConfig, editingDataService, } from './editing-data-service';
 export { VercelEditingDataCache } from './vercel-editing-data-cache';
 export { FEAASRenderMiddleware, FEAASRenderMiddlewareConfig } from './feaas-render-middleware';

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

@@ -1,3 +1,4 @@
+import { IncomingHttpHeaders } from 'http';
 /**
  * Base class for middleware that handles pages and components rendering in Sitecore Editors.
  */
@@ -12,4 +13,12 @@ export declare abstract class RenderMiddlewareBase {
     }>) => {
         [key: string]: string;
     };
+    /**
+     * Get headers that should be passed along to subsequent requests
+     * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
+     * @returns Object of approved headers
+     */
+    protected getHeadersForPropagation: (headers: IncomingHttpHeaders) => {
+        [key: string]: string | string[];
+    };
 }

package/types/index.d.ts

@@ -1,9 +1,9 @@
 export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
-export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, RestLayoutService, RestLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, getContentStylesheetLink, } from '@sitecore-jss/sitecore-jss/layout';
+export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, RestLayoutService, RestLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, HtmlElementRendering, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, getContentStylesheetLink, EditMode, } from '@sitecore-jss/sitecore-jss/layout';
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, TrackingRequestOptions, CampaignInstance, GoalInstance, OutcomeInstance, EventInstance, PageViewInstance, } from '@sitecore-jss/sitecore-jss/tracking';
 export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, RestDictionaryService, RestDictionaryServiceConfig, } from '@sitecore-jss/sitecore-jss/i18n';
-export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
 export { ComponentPropsCollection, ComponentPropsError, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
 export { ModuleFactory, Module } from './sharedTypes/module-factory';
 export { ComponentPropsService } from './services/component-props-service';
@@ -16,7 +16,6 @@ export { ComponentPropsReactContext, ComponentPropsContextProps, ComponentPropsC
 export { Link, LinkProps } from './components/Link';
 export { RichText, RichTextProps } from './components/RichText';
 export { Placeholder } from './components/Placeholder';
-export { EditingComponentPlaceholder } from './components/EditingComponentPlaceholder';
 export { NextImage } from './components/NextImage';
 import * as FEaaSWrapper from './components/FEaaSWrapper';
 import * as BYOCWrapper from './components/BYOCWrapper';
@@ -24,4 +23,4 @@ export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
 export { Context, ContextConfig, SDK } from './context';
-export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getComponentLibraryStylesheetLinks, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';
+export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getComponentLibraryStylesheetLinks, File, FileField, RichTextField, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreContextOptions, WithSitecoreContextProps, WithSitecoreContextHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-jss/sitecore-jss-react';

package/types/middleware/middleware.d.ts

@@ -37,6 +37,12 @@ export declare abstract class MiddlewareBase {
      * @returns {boolean} is preview
      */
     protected isPreview(req: NextRequest): boolean;
+    /**
+     * Determines if the request is a Next.js (next/link) prefetch request
+     * @param {NextRequest} req request
+     * @returns {boolean} is prefetch
+     */
+    protected isPrefetch(req: NextRequest): boolean;
     protected excludeRoute(pathname: string): boolean | undefined;
     /**
      * Safely extract all headers for debug logging