@sitecore-jss/sitecore-jss-nextjs 22.0.0-canary.8 → 22.0.0

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/editing/vercel-editing-data-cache.d.ts

@@ -0,0 +1,19 @@
+import { VercelKV } from '@vercel/kv';
+import { EditingDataCache } from './editing-data-cache';
+import { EditingData } from './editing-data';
+/**
+ * Implementation of editing cache for Vercel deployments
+ * Uses Vercel KV database and client to store data
+ * Set TTL for cache data in constructor (default: 60 seconds)
+ */
+export declare class VercelEditingDataCache implements EditingDataCache {
+    protected redisCache: VercelKV;
+    private defaultTtl;
+    /**
+     * @param {string} redisUrl KV endpoint URL. Usually stored in process.env.KV_REST_API_URL
+     * @param {string} redisToken KV endpoint tokem. Usually stored in process.env.KV_REST_API_TOKEN
+     */
+    constructor(redisUrl: string | undefined, redisToken: string | undefined);
+    set(key: string, editingData: EditingData): Promise<void>;
+    get(key: string): Promise<EditingData | undefined>;
+}

package/types/graphql/index.d.ts

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

package/types/index.d.ts

@@ -1,13 +1,11 @@
-export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, HTMLLink, enableDebug, } from '@sitecore-jss/sitecore-jss';
-export { isEditorActive, resetEditorChromes, resolveUrl, tryParseEnvValue, } from '@sitecore-jss/sitecore-jss/utils';
-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 { 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 { 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 { ComponentPropsCollection, GetStaticComponentProps, GetServerSideComponentProps, } from './sharedTypes/component-props';
-export { ComponentModule } from './sharedTypes/component-module';
+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';
 export { DisconnectedSitemapService } from './services/disconnected-sitemap-service';
 export { GraphQLSitemapService, GraphQLSitemapServiceConfig, } from './services/graphql-sitemap-service';
@@ -15,10 +13,15 @@ export { MultisiteGraphQLSitemapService, MultisiteGraphQLSitemapServiceConfig, }
 export { GraphQLSitemapXmlService, GraphQLSitemapXmlServiceConfig, GraphQLErrorPagesService, GraphQLErrorPagesServiceConfig, RobotsQueryResult, GraphQLRobotsService, GraphQLRobotsServiceConfig, ErrorPages, SiteInfo, SiteResolver, GraphQLSiteInfoService, GraphQLSiteInfoServiceConfig, getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, } from '@sitecore-jss/sitecore-jss/site';
 export { StaticPath } from './services/graphql-sitemap-service';
 export { ComponentPropsReactContext, ComponentPropsContextProps, ComponentPropsContext, useComponentProps, } from './components/ComponentPropsContext';
-export { handleEditorFastRefresh, getPublicUrl } from './utils';
 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';
-export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, 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';
+import * as FEaaSWrapper from './components/FEaaSWrapper';
+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, 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/index.d.ts

@@ -1,5 +1,4 @@
+export { debug } from '@sitecore-jss/sitecore-jss';
 export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
 export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
 export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';
-export { SiteResolver, SiteInfo } from '@sitecore-jss/sitecore-jss/site';
-export { tryParseEnvValue } from '@sitecore-jss/sitecore-jss/utils';

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

@@ -1,5 +1,19 @@
 import { NextResponse, NextRequest } from 'next/server';
 import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+export type CookieAttributes = {
+    /**
+     * the Secure attribute of the site cookie
+     */
+    secure: boolean;
+    /**
+     * the HttpOnly attribute of the site cookie
+     */
+    httpOnly: boolean;
+    /**
+     * the SameSite attribute of the site cookie
+     */
+    sameSite?: true | false | 'lax' | 'strict' | 'none' | undefined;
+};
 export type MultisiteMiddlewareConfig = Omit<MiddlewareBaseConfig, 'disabled'> & {
     /**
      * Function used to determine if site should be resolved from sc_site cookie when present
@@ -20,5 +34,6 @@ export declare class MultisiteMiddleware extends MiddlewareBase {
      * @returns middleware handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
+    protected excludeRoute(pathname: string): boolean | undefined;
     private handler;
 }

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

@@ -1,7 +1,29 @@
 import { NextResponse, NextRequest } from 'next/server';
-import { GraphQLPersonalizeServiceConfig, CdpServiceConfig, ExperienceParams } from '@sitecore-jss/sitecore-jss/personalize';
+import { GraphQLPersonalizeServiceConfig, PersonalizeInfo } from '@sitecore-jss/sitecore-jss/personalize';
 import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
-import { SiteInfo } from '@sitecore-jss/sitecore-jss/site';
+export type CdpServiceConfig = {
+    /**
+     * Your Sitecore Edge Platform endpoint
+     * Default is https://edge-platform.sitecorecloud.io
+     */
+    sitecoreEdgeUrl?: string;
+    /**
+     * Your unified Sitecore Edge Context Id
+     */
+    sitecoreEdgeContextId: string;
+    /**
+     * The Sitecore CDP channel to use for events. Uses 'WEB' by default.
+     */
+    channel?: string;
+    /**
+     * Currency for CDP request. Uses 'USA' as default.
+     */
+    currency?: string;
+    /**
+     * Timeout (ms) for CDP request. Default is 400.
+     */
+    timeout?: number;
+};
 export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
     /**
      * Configuration for your Sitecore Experience Edge endpoint
@@ -10,14 +32,20 @@ export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
     /**
      * Configuration for your Sitecore CDP endpoint
      */
-    cdpConfig: Omit<CdpServiceConfig, 'dataFetcherResolver'>;
-    /**
-     * 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;
+    cdpConfig: CdpServiceConfig;
+};
+/**
+ * Object model of Experience Context data
+ */
+export type ExperienceParams = {
+    referrer: string;
+    utm: {
+        [key: string]: string | undefined;
+        campaign: string | undefined;
+        source: string | undefined;
+        medium: string | undefined;
+        content: string | undefined;
+    };
 };
 /**
  * Middleware / handler to support Sitecore Personalize
@@ -25,7 +53,6 @@ export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
 export declare class PersonalizeMiddleware extends MiddlewareBase {
     protected config: PersonalizeMiddlewareConfig;
     private personalizeService;
-    private cdpService;
     /**
      * @param {PersonalizeMiddlewareConfig} [config] Personalize middleware config
      */
@@ -35,9 +62,21 @@ export declare class PersonalizeMiddleware extends MiddlewareBase {
      * @returns middleware handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
-    protected get browserIdCookieName(): string;
-    protected getBrowserId(req: NextRequest): string | undefined;
-    protected setBrowserId(res: NextResponse, browserId: string): void;
+    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/middleware/redirects-middleware.d.ts

@@ -24,7 +24,7 @@ export declare class RedirectsMiddleware extends MiddlewareBase {
      */
     constructor(config: RedirectsMiddlewareConfig);
     /**
-     * Gets the Next.js API route handler
+     * Gets the Next.js middleware handler with error handling
      * @returns route handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;

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";
@@ -30,7 +30,7 @@ interface SiteRouteQueryVariables {
     /** common variable for all GraphQL queries
      * it will be used for every type of query to regulate result batch size
      * Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
-     * @default 10
+     * @default 100
      */
     pageSize?: number;
 }
@@ -66,19 +66,16 @@ export type RouteListQueryResult = {
  * Configuration options for @see GraphQLSitemapService instances
  */
 export interface BaseGraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariables, 'language' | 'siteName'> {
-    /**
-     * Your Graphql endpoint
-     */
-    endpoint: string;
-    /**
-     * The API key to use for authentication.
-     */
-    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/services/component-props-service.d.ts

@@ -1,11 +1,11 @@
 import { GetServerSidePropsContext, GetStaticPropsContext } from 'next';
 import { LayoutServiceData, ComponentRendering, PlaceholdersData } from '@sitecore-jss/sitecore-jss/layout';
 import { ComponentPropsCollection, ComponentPropsFetchFunction } from '../sharedTypes/component-props';
-import { ComponentModule } from '../sharedTypes/component-module';
+import { ModuleFactory } from '../sharedTypes/module-factory';
 export type FetchComponentPropsArguments<NextContext> = {
     layoutData: LayoutServiceData;
     context: NextContext;
-    componentModule: ComponentModule;
+    moduleFactory: ModuleFactory;
 };
 export type ComponentPropsRequest<NextContext> = {
     fetch: ComponentPropsFetchFunction<NextContext>;

package/types/sharedTypes/component-props.d.ts

@@ -1,10 +1,14 @@
 import { GetServerSidePropsContext, GetStaticPropsContext } from 'next';
 import { ComponentRendering, LayoutServiceData } from '@sitecore-jss/sitecore-jss/layout';
+export type ComponentPropsError = {
+    error: string;
+    componentName: string;
+};
 /**
  * Shape of component props storage
  */
 export type ComponentPropsCollection = {
-    [componentUid: string]: unknown;
+    [componentUid: string]: unknown | ComponentPropsError;
 };
 /**
  * Type of side effect function which could be invoked on component level (getStaticProps/getServerSideProps)

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

@@ -0,0 +1,33 @@
+/// <reference types="@types/react" />
+import { ComponentType } from 'react';
+import { GetServerSideComponentProps, GetStaticComponentProps } from './component-props';
+/**
+ * Represents a module (file)
+ */
+export type Module = {
+    /**
+     * Default SXA export
+     */
+    Default?: ComponentType;
+    /**
+     * Default Next.js export
+     */
+    default?: ComponentType;
+    /**
+     * function for component level data fetching in SSR mode
+     */
+    getServerSideProps?: GetServerSideComponentProps;
+    /**
+     * function for component level data fetching in SSG mode
+     */
+    getStaticProps?: GetStaticComponentProps;
+} & {
+    /**
+     * Custom exports
+     */
+    [key: string]: ComponentType;
+};
+/**
+ * Represents a module factory
+ */
+export type ModuleFactory = (componentName: string) => Module | Promise<Module> | null;

package/types/site/index.d.ts

@@ -0,0 +1 @@
+export { SiteResolver, SiteInfo } from '@sitecore-jss/sitecore-jss/site';

package/types/utils/index.d.ts

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

package/types/{utils.d.ts → utils/utils.d.ts}

@@ -4,6 +4,8 @@
  * This is set to http://localhost:3000 by default.
  * 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;
 /**

package/utils.d.ts

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

package/utils.js

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

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

@@ -1,13 +0,0 @@
-/// <reference types="react" />
-import { GetServerSideComponentProps, GetStaticComponentProps } from './component-props';
-export type Module = {
-    default: React.Component;
-    getServerSideProps?: GetServerSideComponentProps;
-    getStaticProps?: GetStaticComponentProps;
-};
-/**
- * @returns `undefined` module not found
- * @returns `Module` regular module
- * @returns `Promise<Module>` when module should be lazy loaded
- */
-export type ComponentModule = (componentName: string) => Module | Promise<Module> | undefined;