@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.6 → 21.7.0-canary.61

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

@@ -0,0 +1,29 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+import { Metadata } from '@sitecore-jss/sitecore-jss-dev-tools';
+export type EditingConfigMiddlewareConfig = {
+    /**
+     * Components available in the application
+     */
+    components: string[] | Map<string, unknown>;
+    /**
+     * Application metadata
+     */
+    metadata: Metadata;
+};
+/**
+ * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
+ * provides configuration information to determine feature compatibility on Pages side.
+ */
+export declare class EditingConfigMiddleware {
+    protected config: EditingConfigMiddlewareConfig;
+    /**
+     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
+     */
+    constructor(config: EditingConfigMiddlewareConfig);
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}

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

@@ -2,6 +2,7 @@ import { NextApiRequest, NextApiResponse } from 'next';
 import { AxiosDataFetcher } from '@sitecore-jss/sitecore-jss';
 import { EditingData } from './editing-data';
 import { EditingDataService } from './editing-data-service';
+import { RenderMiddlewareBase } from './render-middleware';
 export interface EditingRenderMiddlewareConfig {
     /**
      * The `AxiosDataFetcher` instance to use for API requests.
@@ -41,7 +42,7 @@ export interface EditingRenderMiddlewareConfig {
  * 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 class EditingRenderMiddleware {
+export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
     private editingDataService;
     private dataFetcher;
     private resolvePageUrl;
@@ -55,16 +56,6 @@ 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/editing/feaas-render-middleware.d.ts

@@ -0,0 +1,32 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+import { RenderMiddlewareBase } from './render-middleware';
+/**
+ * Configuration for `FEAASRenderMiddleware`.
+ */
+export interface FEAASRenderMiddlewareConfig {
+    /**
+     * Defines FEAAS page route to render.
+     * This may be necessary for certain custom Next.js routing configurations.
+     * @default /feaas/render
+     */
+    pageUrl?: string;
+}
+/**
+ * Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
+ * which is required for Sitecore editing support.
+ */
+export declare class FEAASRenderMiddleware extends RenderMiddlewareBase {
+    protected config?: FEAASRenderMiddlewareConfig | undefined;
+    private pageUrl;
+    private defaultPageUrl;
+    /**
+     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+     */
+    constructor(config?: FEAASRenderMiddlewareConfig | undefined);
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}

package/types/editing/index.d.ts

@@ -4,3 +4,5 @@ export { EditingDataMiddleware, EditingDataMiddlewareConfig } from './editing-da
 export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, } 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';
+export { EditingConfigMiddleware, EditingConfigMiddlewareConfig, } from './editing-config-middleware';

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

@@ -0,0 +1,15 @@
+/**
+ * Base class for middleware that handles pages and components rendering in Sitecore Editors.
+ */
+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
+     * @returns Object of approved query parameters
+     */
+    protected getQueryParamsForPropagation: (query: Partial<{
+        [key: string]: string | string[];
+    }>) => {
+        [key: string]: string;
+    };
+}

package/types/graphql/index.d.ts

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

package/types/index.d.ts

@@ -8,11 +8,11 @@ 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 { 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';
@@ -32,4 +32,5 @@ import * as BYOCWrapper from './components/BYOCWrapper';
 export { FEaaSWrapper };
 export { BYOCWrapper };
 export { ComponentBuilder, ComponentBuilderConfig } from './ComponentBuilder';
-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';
+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, 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';

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(hostName: string, 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/revalidate/index.d.ts

@@ -0,0 +1 @@
+export { RevalidateMiddleware } from './revalidate-middleware';

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

@@ -0,0 +1,115 @@
+import { NextApiResponse, NextApiRequest } from 'next';
+import { GraphQLRequestClientFactory } from '@sitecore-jss/sitecore-jss/graphql';
+declare enum EntityDefinition {
+    LayoutData = "LayoutData",
+    Item = "Item"
+}
+/**
+ * Object model of each updated entity returned from the webhook payload
+ */
+export type Entity = {
+    identifier: string;
+    entity_definition: EntityDefinition;
+    operation: string;
+    entity_culture: string;
+};
+/**
+ * Object model for updated paths returned from the webhook payload
+ */
+export type UpdatedPaths = {
+    path: string;
+    language: string;
+};
+/**
+ *  Object model for personalized results from GraphqlPersonalizeService
+ */
+export type PersonalizedResult = {
+    path: string;
+    variantId: string;
+};
+export type RevalidateConfig = {
+    /**
+     * 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;
+    /**
+     * Indicates whether multisite functionality is enabled.
+     * Default is false
+     */
+    multiSite?: boolean;
+    /**
+     * Indicates whether personalization is enabled.
+     * Default is false
+     */
+    personalize?: boolean;
+    /**
+     * Function to handle language prefixes for different locales.
+     * @param language - The language to generate the prefix for.
+     * @returns The language prefix or null.
+     */
+    localePrefix?: (language: string) => string | null;
+};
+/**
+ * Middleware / handler for on-demand ISR (e.g. '/api/revalidate').
+ */
+export declare class RevalidateMiddleware {
+    protected config: RevalidateConfig;
+    private personalizeService;
+    constructor(config: RevalidateConfig);
+    /**
+     * Generates a Next.js API route handler that executes a revalidation process.
+     * @returns The route handler function for handling Next.js API requests.
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    /**
+     * Gets personalized results for the updated paths
+     * @param {UpdatedPaths[]} filteredUpdates Updated paths
+     */
+    getPersonalizedResults(filteredUpdates: UpdatedPaths[]): Promise<{
+        personalized: PersonalizedResult[];
+        nonPersonalized: {
+            path: string;
+        }[];
+    }>;
+    protected isEmpty(data: UpdatedPaths[]): boolean;
+    /**
+     * Extracts the paths from the updated paths
+     * @param {UpdatedPaths[]} filteredUpdates Updated paths
+     * @returns {string[]} paths
+     */
+    protected extractPaths(filteredUpdates: UpdatedPaths[]): string[];
+    /**
+     * Gets the site name from the path name
+     * @param {string} pathname Path name
+     * @returns {string} site name
+     */
+    protected getSiteName(pathname: string): string;
+    /**
+     * Gets the path name from the full path
+     * @param {string} fullPath Full path
+     * @returns {string} path name
+     */
+    protected getPathName(fullPath: string): string;
+    protected extractSiteName(path: string): string;
+    /**
+     * Filters out the updated paths and language from the request body
+     * @param {NextApiRequest} req Next.js API request
+     * @returns {UpdatedPaths[]} updated paths
+     */
+    protected getFilteredUpdates(req: NextApiRequest): UpdatedPaths[];
+    protected handleMultiSitePersonalization(personalizeInfo: {
+        personalized: PersonalizedResult[];
+        nonPersonalized: {
+            path: string;
+        }[];
+    }, pathsToRevalidate: string[], getPathName: (x: string) => string, getSiteName: (x: string) => string): void;
+    protected handleNonMultiSitePersonalization(personalizeInfo: {
+        personalized: PersonalizedResult[];
+        nonPersonalized: {
+            path: string;
+        }[];
+    }, pathsToRevalidate: string[], getPathName: (x: string) => string): void;
+    private handler;
+}
+export {};

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;
 /**