@sitecore-jss/sitecore-jss-nextjs 21.6.0-canary.3 → 21.6.0-canary.31

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

@@ -11,7 +11,8 @@ 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 { editingDataService } from './editing-data-service';
+import { QUERY_PARAM_EDITING_SECRET, QUERY_PARAM_PROTECTION_BYPASS_SITECORE, QUERY_PARAM_PROTECTION_BYPASS_VERCEL, } from './constants';
 import { getJssEditingSecret } from '../utils/utils';
 /**
  * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
@@ -23,6 +24,21 @@ export class EditingRenderMiddleware {
      */
     constructor(config) {
         var _a, _b, _c, _d;
+        /**
+         * Gets query parameters that should be passed along to subsequent requests
+         * @param query Object of query parameters from incoming URL
+         * @returns Object of approved query parameters
+         */
+        this.getQueryParamsForPropagation = (query) => {
+            const params = {};
+            if (query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE]) {
+                params[QUERY_PARAM_PROTECTION_BYPASS_SITECORE] = query[QUERY_PARAM_PROTECTION_BYPASS_SITECORE];
+            }
+            if (query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL]) {
+                params[QUERY_PARAM_PROTECTION_BYPASS_VERCEL] = query[QUERY_PARAM_PROTECTION_BYPASS_VERCEL];
+            }
+            return params;
+        };
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
             var _e, _f;
             const { method, query, body, headers } = req;
@@ -53,21 +69,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(';'),
                     },
@@ -82,7 +105,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
@@ -98,7 +121,7 @@ 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

package/dist/esm/graphql/index.js

@@ -0,0 +1 @@
+export { GraphQLRequestClient, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 export { constants, AxiosDataFetcher, NativeDataFetcher, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
 // we will remove the root exports for these later
 // we cannot mark exports as deprected directly, so we're using this hack instead
+import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
 import { isEditorActive as isEditorActiveDep, resetEditorChromes as resetEditorChromesDep, resolveUrl as resolveUrlDep, tryParseEnvValue as tryParseEnvValueDep, } from '@sitecore-jss/sitecore-jss/utils';
 import { handleEditorFastRefresh as handleEditorFastRefreshDep, getPublicUrl as getPublicUrlDep, } from './utils';
 /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
@@ -12,14 +13,18 @@ const { isEditorActiveDep: isEditorActive, resetEditorChromesDep: resetEditorChr
     handleEditorFastRefreshDep,
     getPublicUrlDep,
 };
+/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
+const { GraphQLRequestClientDep: GraphQLRequestClient } = {
+    GraphQLRequestClientDep,
+};
+export { GraphQLRequestClient };
 export { handleEditorFastRefresh, getPublicUrl };
 export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
 export { LayoutServicePageState, GraphQLLayoutService, RestLayoutService, getChildPlaceholder, getFieldValue, RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-jss/sitecore-jss/layout';
 export { mediaApi } from '@sitecore-jss/sitecore-jss/media';
 export { trackingApi, } from '@sitecore-jss/sitecore-jss/tracking';
 export { GraphQLDictionaryService, RestDictionaryService, } from '@sitecore-jss/sitecore-jss/i18n';
-export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
-export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-jss/sitecore-jss/personalize';
 export { ComponentPropsService } from './services/component-props-service';
 export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
 export { GraphQLSitemapService, } from './services/graphql-sitemap-service';
@@ -36,4 +41,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder } from './ComponentBuilder';
+export { Context } from './context';
 export { Image, Text, DateField, EditFrame, FEaaSComponent, fetchFEaaSComponentServerProps, BYOCComponent, getFEAASLibraryStylesheetLinks, File, VisitorIdentification, SitecoreContext, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, } from '@sitecore-jss/sitecore-jss-react';

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

@@ -8,10 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { NextResponse } from 'next/server';
-import { GraphQLPersonalizeService, getPersonalizedRewrite, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
+import { GraphQLPersonalizeService, getPersonalizedRewrite, } from '@sitecore-jss/sitecore-jss/personalize';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { MiddlewareBase } from './middleware';
-import { initServer } from '@sitecore/engage';
+import { init, personalize } from '@sitecore-cloudsdk/personalize/server';
 /**
  * Middleware / handler to support Sitecore Personalize
  */
@@ -23,7 +23,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
         super(config);
         this.config = config;
         this.handler = (req, res) => __awaiter(this, void 0, void 0, function* () {
-            var _a;
             const pathname = req.nextUrl.pathname;
             const language = this.getLanguage(req);
             const hostname = this.getHostHeader(req) || this.defaultHostname;
@@ -48,16 +47,6 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 return response;
             }
             const site = this.getSite(req, response);
-            const engageServer = this.initializeEngageServer(site, language);
-            // creates the browser ID cookie on the server side
-            // and includes the cookie in the response header
-            try {
-                yield engageServer.handleCookie(req, response, timeout);
-            }
-            catch (error) {
-                debug.personalize('skipped (browser id generation failed)');
-                throw error;
-            }
             // Get personalization info from Experience Edge
             const personalizeInfo = yield this.personalizeService.getPersonalizeInfo(pathname, language, site.name);
             if (!personalizeInfo) {
@@ -69,20 +58,20 @@ export class PersonalizeMiddleware extends MiddlewareBase {
                 debug.personalize('skipped (no personalization configured)');
                 return response;
             }
+            yield this.initPersonalizeServer({
+                hostname,
+                siteName: site.name,
+                request: req,
+                response,
+            });
             const params = this.getExperienceParams(req);
             debug.personalize('executing experience for %s %s %o', personalizeInfo.contentId, params);
-            const personalizationData = {
-                channel: this.config.cdpConfig.channel || 'WEB',
-                currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USA',
-                friendlyId: personalizeInfo.contentId,
-                params,
-                language,
-            };
             let variantId;
-            // Execute targeted experience in CDP
+            // Execute targeted experience in Personalize SDK
             // eslint-disable-next-line no-useless-catch
             try {
-                variantId = (yield engageServer.personalize(personalizationData, req, timeout)).variantId;
+                const personalization = yield this.personalize({ personalizeInfo, params, language, timeout }, req);
+                variantId = personalization.variantId;
             }
             catch (error) {
                 throw error;
@@ -101,15 +90,22 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             const rewritePath = getPersonalizedRewrite(basePath, { variantId });
             // Note an absolute URL is required: https://nextjs.org/docs/messages/middleware-relative-urls
             const rewriteUrl = req.nextUrl.clone();
+            // Preserve cookies from previous response
+            const cookies = response.cookies.getAll();
             rewriteUrl.pathname = rewritePath;
-            response = NextResponse.rewrite(rewriteUrl);
+            response = NextResponse.rewrite(rewriteUrl, response);
             // Disable preflight caching to force revalidation on client-side navigation (personalization may be influenced)
             // See https://github.com/vercel/next.js/issues/32727
             response.headers.set('x-middleware-cache', 'no-cache');
-            // Share rewrite path with following executed middlewares
+            // Share rewrite path with following executed middleware
             response.headers.set('x-sc-rewrite', rewritePath);
             // Share site name with the following executed middlewares
             response.cookies.set(this.SITE_SYMBOL, site.name);
+            // Restore cookies from previous response since
+            // browserId cookie gets omitted after rewrite
+            cookies.forEach((cookie) => {
+                response.cookies.set(cookie);
+            });
             debug.personalize('personalize middleware end in %dms: %o', Date.now() - startTimestamp, {
                 rewritePath,
                 headers: this.extractDebugHeaders(response.headers),
@@ -136,16 +132,29 @@ export class PersonalizeMiddleware extends MiddlewareBase {
             }
         });
     }
-    initializeEngageServer(site, language) {
-        const engageServer = initServer({
-            clientKey: this.config.cdpConfig.clientKey,
-            targetURL: this.config.cdpConfig.endpoint,
-            pointOfSale: this.config.getPointOfSale
-                ? this.config.getPointOfSale(site, language)
-                : PosResolver.resolve(site, language),
-            forceServerCookieMode: true,
+    initPersonalizeServer({ hostname, siteName, request, response, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield init({
+                sitecoreEdgeUrl: this.config.cdpConfig.sitecoreEdgeUrl,
+                sitecoreEdgeContextId: this.config.cdpConfig.sitecoreEdgeContextId,
+                siteName,
+                cookieDomain: hostname,
+                enableServerCookie: true,
+            }, request, response);
+        });
+    }
+    personalize({ params, personalizeInfo, language, timeout, }, request) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const personalizationData = {
+                channel: this.config.cdpConfig.channel || 'WEB',
+                currency: (_a = this.config.cdpConfig.currency) !== null && _a !== void 0 ? _a : 'USD',
+                friendlyId: personalizeInfo.contentId,
+                params,
+                language,
+            };
+            return (yield personalize(personalizationData, request, timeout));
         });
-        return engageServer;
     }
     getExperienceParams(req) {
         const utm = {

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

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss/graphql';
+import { GraphQLRequestClient, } from '@sitecore-jss/sitecore-jss/graphql';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { getPersonalizedRewrite } from '@sitecore-jss/sitecore-jss/personalize';
 /** @private */
@@ -191,6 +191,14 @@ export class BaseGraphQLSitemapService {
      * @returns {GraphQLClient} implementation
      */
     getGraphQLClient() {
+        if (!this.options.endpoint) {
+            if (!this.options.clientFactory) {
+                throw new Error('You should provide either an endpoint and apiKey, or a clientFactory.');
+            }
+            return this.options.clientFactory({
+                debugger: debug.sitemap,
+            });
+        }
         return new GraphQLRequestClient(this.options.endpoint, {
             apiKey: this.options.apiKey,
             debugger: debug.sitemap,

package/graphql.d.ts

@@ -0,0 +1 @@
+export * from './types/graphql/index';

package/graphql.js

@@ -0,0 +1 @@
+module.exports = require('./dist/cjs/graphql/index');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "21.6.0-canary.3",
+  "version": "21.6.0-canary.31",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -11,7 +11,7 @@
     "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 --githubPages false"
+    "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": ">=12",
@@ -30,7 +30,7 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "devDependencies": {
-    "@sitecore/engage": "^1.4.0",
+    "@sitecore-cloudsdk/personalize": "^0.1.1",
     "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-string": "^1.4.2",
@@ -66,15 +66,16 @@
     "typescript": "~4.9.4"
   },
   "peerDependencies": {
-    "@sitecore/engage": "^1.4.0",
+    "@sitecore-cloudsdk/events": "^0.1.1",
+    "@sitecore-cloudsdk/personalize": "^0.1.1",
     "next": "^13.4.16",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.6.0-canary.3",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^21.6.0-canary.3",
-    "@sitecore-jss/sitecore-jss-react": "^21.6.0-canary.3",
+    "@sitecore-jss/sitecore-jss": "^21.6.0-canary.31",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^21.6.0-canary.31",
+    "@sitecore-jss/sitecore-jss-react": "^21.6.0-canary.31",
     "@vercel/kv": "^0.2.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
@@ -83,7 +84,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "ef2bbc94d52ebedc67edaa9195d94a59e11e1f09",
+  "gitHead": "db032a6fdbcba3627412f55865ab660bb7aa5900",
   "files": [
     "dist",
     "types",

package/types/ComponentBuilder.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@types/react" />
 import { ComponentFactory } from '@sitecore-jss/sitecore-jss-react';
 import { Module, ModuleFactory } from './sharedTypes/module-factory';
 import { ComponentType } from 'react';

package/types/components/ComponentPropsContext.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@types/react" />
 import React, { ReactNode } from 'react';
 import { ComponentPropsCollection } from '../sharedTypes/component-props';
 /**

package/types/components/Link.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@types/react" />
 import React from 'react';
 import { LinkProps as ReactLinkProps } from '@sitecore-jss/sitecore-jss-react';
 export type LinkProps = ReactLinkProps & {

package/types/components/NextImage.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@types/react" />
 import React from 'react';
 import { ImageProps } from '@sitecore-jss/sitecore-jss-react';
 import { ImageLoader, ImageProps as NextImageProperties } from 'next/image';

package/types/components/Placeholder.d.ts

@@ -1,3 +1,4 @@
+/// <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;

package/types/context/context.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Software Development Kit (SDK) instance
+ */
+export type SDK<SDKType = unknown> = {
+    /**
+     * The Software Development Kit (SDK) library instance
+     */
+    sdk: SDKType;
+    /**
+     * Initializes the Software Development Kit (SDK)
+     */
+    init: (props: InitSDKProps) => Promise<void>;
+};
+/**
+ * Software Development Kits (SDKs) to be initialized
+ */
+type SDKModulesType = Record<string, SDK>;
+/**
+ * Properties that are passed to the Context.
+ */
+export interface ContextInitProps {
+    /**
+     * Your Sitecore site name
+     */
+    siteName?: string;
+}
+/**
+ * Configuration that is passed to the Context.
+ */
+export interface ContextConfig<SDKModules extends SDKModulesType> {
+    /**
+     * Your Sitecore Edge URL
+     */
+    sitecoreEdgeUrl: string;
+    /**
+     * Your Sitecore Edge Context ID
+     */
+    sitecoreEdgeContextId: string;
+    /**
+     * Your Sitecore site name
+     */
+    siteName: string;
+    /**
+     * Software Development Kits (SDKs) to be initialized
+     */
+    sdks: {
+        [module in keyof SDKModules]: SDKModules[module];
+    };
+}
+/**
+ * Properties that are passed to the Software Development Kit (SDK) initialization function.
+ */
+type InitSDKProps = Omit<ContextConfig<SDKModulesType>, 'sdks'>;
+/**
+ * Context instance that is used to initialize the application Context and associated Software Development Kits (SDKs).
+ */
+export declare class Context<SDKModules extends SDKModulesType> {
+    protected props: ContextConfig<SDKModules>;
+    /**
+     * Indicates whether the Context and SDK(s) have been initialized
+     */
+    isInitialized: boolean;
+    /**
+     * The Sitecore Edge URL
+     */
+    readonly sitecoreEdgeUrl: string;
+    /**
+     * The Sitecore Edge Context ID
+     */
+    readonly sitecoreEdgeContextId: string;
+    /**
+     * The Sitecore site name
+     */
+    siteName: string;
+    /**
+     * Software Development Kits (SDKs) to be initialized
+     */
+    readonly sdks: {
+        [module in keyof SDKModules]?: SDKModules[module]['sdk'];
+    };
+    /**
+     * Promises for the SDKs
+     */
+    protected sdkPromises: {
+        [module in keyof SDKModules]?: Promise<SDKModules[module]['sdk']>;
+    };
+    constructor(props: ContextConfig<SDKModules>);
+    init(props?: ContextInitProps): void;
+    /**
+     * Retrieves the Software Development Kit (SDK) instance, ensuring it is initialized before returning
+     *
+     * @param {string} name SDK name
+     * @returns initialized SDK
+     */
+    getSDK<T extends keyof SDKModules>(name: T): Promise<SDKModules[T]['sdk']> | undefined;
+    /**
+     * Initializes the Software Development Kit (SDK)
+     *
+     * @param {T} name SDK name
+     * @returns {void}
+     */
+    protected initSDK<T extends keyof SDKModules>(name: T): void;
+}
+export {};

package/types/context/index.d.ts

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

package/types/editing/constants.d.ts

@@ -0,0 +1,3 @@
+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";

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

@@ -2,13 +2,15 @@ import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
 import { EditingData } from './editing-data';
 import { EditingDataCache } from './editing-data-cache';
 import { PreviewData } from 'next';
-export declare const QUERY_PARAM_EDITING_SECRET = "secret";
 /**
  * Data for Next.js Preview (Editing) mode
  */
 export interface EditingPreviewData {
     key: string;
     serverUrl?: string;
+    params?: {
+        [key: string]: string;
+    };
 }
 /**
  * Defines an editing data service implementation
@@ -20,7 +22,9 @@ export interface EditingDataService {
      * @param {string} serverUrl The server url e.g. which can be used for further API requests
      * @returns The {@link EditingPreviewData} containing the information to use for retrieval
      */
-    setEditingData(data: EditingData, serverUrl: string): Promise<EditingPreviewData>;
+    setEditingData(data: EditingData, serverUrl: string, params?: {
+        [key: string]: string;
+    }): Promise<EditingPreviewData>;
     /**
      * Retrieves Sitecore editor payload data
      * @param {PreviewData} previewData Editing preview data containing the information to use for retrieval
@@ -107,14 +111,18 @@ export declare class ServerlessEditingDataService implements EditingDataService
      * @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: EditingData, serverUrl: string): Promise<EditingPreviewData>;
+    setEditingData(data: EditingData, serverUrl: string, params?: {
+        [key: string]: string;
+    }): Promise<EditingPreviewData>;
     /**
      * Retrieves Sitecore editor payload data by key
      * @param {PreviewData} previewData Editing preview data containing the key and serverUrl to use for retrieval
      * @returns {Promise} The {@link EditingData}
      */
     getEditingData(previewData: PreviewData): Promise<EditingData | undefined>;
-    protected getUrl(serverUrl: string, key: string): string;
+    protected getUrl(serverUrl: string, key: string, params?: {
+        [key: string]: string;
+    }): string;
 }
 /**
  * The `EditingDataService` default instance.

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

@@ -55,6 +55,16 @@ export declare class EditingRenderMiddleware {
      * @returns route handler
      */
     getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    /**
+     * Gets query parameters that should be passed along to subsequent requests
+     * @param query Object of query parameters from incoming URL
+     * @returns Object of approved query parameters
+     */
+    protected getQueryParamsForPropagation: (query: Partial<{
+        [key: string]: string | string[];
+    }>) => {
+        [key: string]: string;
+    };
     private handler;
     /**
      * Default page URL resolution.

package/types/graphql/index.d.ts

@@ -0,0 +1 @@
+export { GraphQLRequestClient, GraphQLRequestClientFactory, GraphQLRequestClientFactoryConfig, getEdgeProxyContentUrl, } from '@sitecore-jss/sitecore-jss/graphql';

package/types/index.d.ts

@@ -1,15 +1,18 @@
 export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, debug, } from '@sitecore-jss/sitecore-jss';
+import { GraphQLRequestClient as GraphQLRequestClientDep } from './graphql';
 import { resolveUrl as resolveUrlDep } from '@sitecore-jss/sitecore-jss/utils';
 /** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/utils' instead */
 declare const isEditorActive: () => boolean, resetEditorChromes: () => void, resolveUrl: typeof resolveUrlDep, tryParseEnvValue: <T>(envValue: string | undefined, defaultValue: T) => T, handleEditorFastRefresh: (forceReload?: boolean) => void, getPublicUrl: () => string;
+/** @deprecated use import from '@sitecore-jss/sitecore-jss-nextjs/graphql' instead */
+declare const GraphQLRequestClient: typeof GraphQLRequestClientDep;
+export { GraphQLRequestClient };
 export { handleEditorFastRefresh, getPublicUrl };
 export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue };
 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, } 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, PosResolver, } from '@sitecore-jss/sitecore-jss/personalize';
-export { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, 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';
@@ -29,4 +32,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 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, getFEAASLibraryStylesheetLinks, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';

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

@@ -1,17 +1,16 @@
 import { NextResponse, NextRequest } from 'next/server';
-import { GraphQLPersonalizeServiceConfig } from '@sitecore-jss/sitecore-jss/personalize';
-import { SiteInfo } from '@sitecore-jss/sitecore-jss/site';
+import { GraphQLPersonalizeServiceConfig, PersonalizeInfo } from '@sitecore-jss/sitecore-jss/personalize';
 import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
-import { EngageServer } from '@sitecore/engage';
 export type CdpServiceConfig = {
     /**
-     * Your Sitecore CDP API endpoint
+     * Your Sitecore Edge Platform endpoint
+     * Default is https://edge-platform.sitecorecloud.io
      */
-    endpoint: string;
+    sitecoreEdgeUrl?: string;
     /**
-     * The client key to use for authentication
+     * Your unified Sitecore Edge Context Id
      */
-    clientKey: string;
+    sitecoreEdgeContextId: string;
     /**
      * The Sitecore CDP channel to use for events. Uses 'WEB' by default.
      */
@@ -34,13 +33,6 @@ export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
      * Configuration for your Sitecore CDP endpoint
      */
     cdpConfig: CdpServiceConfig;
-    /**
-     * function to resolve point of sale for a site
-     * @param {Siteinfo} site to get info from
-     * @param {string} language to get info for
-     * @returns point of sale value for site/language combination
-     */
-    getPointOfSale?: (site: SiteInfo, language: string) => string;
 };
 /**
  * Object model of Experience Context data
@@ -70,7 +62,20 @@ export declare class PersonalizeMiddleware extends MiddlewareBase {
      * @returns middleware handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
-    protected initializeEngageServer(site: SiteInfo, language: string): EngageServer;
+    protected initPersonalizeServer({ hostname, siteName, request, response, }: {
+        hostname: string;
+        siteName: string;
+        request: NextRequest;
+        response: NextResponse;
+    }): Promise<void>;
+    protected personalize({ params, personalizeInfo, language, timeout, }: {
+        personalizeInfo: PersonalizeInfo;
+        params: ExperienceParams;
+        language: string;
+        timeout?: number;
+    }, request: NextRequest): Promise<{
+        variantId: string;
+    }>;
     protected getExperienceParams(req: NextRequest): ExperienceParams;
     protected excludeRoute(pathname: string): boolean | undefined;
     private handler;