@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.3 → 21.7.0-canary.30

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"]>;
+    /**
+     * 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/editing-render-middleware.d.ts

@@ -57,7 +57,7 @@ export declare class EditingRenderMiddleware {
     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
+     * @param {Object} query Object of query parameters from incoming URL
      * @returns Object of approved query parameters
      */
     protected getQueryParamsForPropagation: (query: Partial<{

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 { 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/middleware.d.ts

@@ -28,6 +28,7 @@ export type MiddlewareBaseConfig = {
 export declare abstract class MiddlewareBase {
     protected config: MiddlewareBaseConfig;
     protected SITE_SYMBOL: string;
+    protected REWRITE_HEADER_NAME: string;
     protected defaultHostname: string;
     constructor(config: MiddlewareBaseConfig);
     /**
@@ -65,4 +66,11 @@ export declare abstract class MiddlewareBase {
      * @returns {SiteInfo} site information
      */
     protected getSite(req: NextRequest, res?: NextResponse): SiteInfo;
+    /**
+     * Create a rewrite response
+     * @param {string} rewritePath the destionation path
+     * @param {NextRequest} req the current request
+     * @param {NextResponse} res the current response
+     */
+    protected rewrite(rewritePath: string, req: NextRequest, res: NextResponse): NextResponse;
 }

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