@sitecore-jss/sitecore-jss-nextjs 21.6.0-canary.4 → 21.6.0-canary.41

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 { 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 { 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;

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

@@ -1,4 +1,4 @@
-import { GraphQLClient, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
+import { GraphQLClient, GraphQLRequestClientFactory, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
 /** @private */
 export declare const languageError = "The list of languages cannot be empty";
 export declare const siteError = "The service needs a site name";
@@ -68,17 +68,24 @@ export type RouteListQueryResult = {
 export interface BaseGraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariables, 'language' | 'siteName'> {
     /**
      * Your Graphql endpoint
+     * @deprecated use @param clientFactory property instead
      */
-    endpoint: string;
+    endpoint?: string;
     /**
      * The API key to use for authentication.
+     * @deprecated use @param clientFactory property instead
      */
-    apiKey: string;
+    apiKey?: string;
     /**
      * A flag for whether to include personalized routes in service output - only works on XM Cloud
      * turned off by default
      */
     includePersonalizedRoutes?: boolean;
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory?: GraphQLRequestClientFactory;
 }
 /**
  * Object model of a site page item.

package/types/sharedTypes/module-factory.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@types/react" />
 import { ComponentType } from 'react';
 import { GetServerSideComponentProps, GetStaticComponentProps } from './component-props';
 /**

package/types/utils/utils.d.ts

@@ -5,6 +5,7 @@
  * VERCEL_URL is provided by Vercel in case if we are in Preview deployment (deployment based on the custom branch),
  * preview deployment has unique url, we don't know exact url.
  * Similarly, DEPLOY_URL is provided by Netlify and would give us the deploy URL
+ * In production non-editing environments it is desirable to use relative urls, so in that case set PUBLIC_URL = ''
  */
 export declare const getPublicUrl: () => string;
 /**