@sitecore-jss/sitecore-jss-nextjs 21.1.0-canary.9 → 21.1.0-canary.90

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

@@ -0,0 +1,46 @@
+import { NextResponse, NextRequest } from 'next/server';
+import { SiteInfo } from '@sitecore-jss/sitecore-jss/site';
+export type MultisiteMiddlewareConfig = {
+    /**
+     * Function used to determine if route should be excluded during execution.
+     * By default, files (pathname.includes('.')), Next.js API routes (pathname.startsWith('/api/')), and Sitecore API routes (pathname.startsWith('/sitecore/')) are ignored.
+     * This is an important performance consideration since Next.js Edge middleware runs on every request.
+     * @param {string} pathname The pathname
+     * @returns {boolean} Whether to exclude the route
+     */
+    excludeRoute?: (pathname: string) => boolean;
+    /**
+     * Function used to resolve site for given hostname
+     */
+    getSite: (hostname: string) => SiteInfo;
+    /**
+     * Fallback hostname in case `host` header is not present
+     * @default localhost
+     */
+    defaultHostname?: string;
+    /**
+     * Function used to determine if site should be resolved from sc_site cookie when present
+     */
+    useCookieResolution?: (req: NextRequest) => boolean;
+};
+/**
+ * Middleware / handler for multisite support
+ */
+export declare class MultisiteMiddleware {
+    protected config: MultisiteMiddlewareConfig;
+    private defaultHostname;
+    /**
+     * @param {MultisiteMiddlewareConfig} [config] Multisite middleware config
+     */
+    constructor(config: MultisiteMiddlewareConfig);
+    /**
+     * Gets the Next.js middleware handler with error handling
+     * @returns middleware handler
+     */
+    getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
+    protected excludeRoute(pathname: string): boolean;
+    protected extractDebugHeaders(incomingHeaders: Headers): {
+        [key: string]: string;
+    };
+    private handler;
+}

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

@@ -1,6 +1,7 @@
 import { NextResponse, NextRequest } from 'next/server';
 import { GraphQLPersonalizeServiceConfig, CdpServiceConfig, ExperienceParams } from '@sitecore-jss/sitecore-jss/personalize';
-export declare type PersonalizeMiddlewareConfig = {
+import { SiteInfo } from '@sitecore-jss/sitecore-jss/site';
+export type PersonalizeMiddlewareConfig = {
     /**
      * Function used to determine if route should be excluded from personalization.
      * By default, files (pathname.includes('.')), Next.js API routes (pathname.startsWith('/api/')), and Sitecore API routes (pathname.startsWith('/sitecore/')) are ignored.
@@ -29,6 +30,15 @@ export declare type PersonalizeMiddlewareConfig = {
      * @returns {boolean} false by default
      */
     disabled?: (req?: NextRequest, res?: NextResponse) => boolean;
+    /**
+     * function used to resolve site for given hostname
+     */
+    getSite: (hostname: string) => SiteInfo;
+    /**
+     * fallback hostname in case `host` header is not present
+     * @default localhost
+     */
+    defaultHostname?: string;
 };
 /**
  * Middleware / handler to support Sitecore Personalize
@@ -37,6 +47,7 @@ export declare class PersonalizeMiddleware {
     protected config: PersonalizeMiddlewareConfig;
     private personalizeService;
     private cdpService;
+    private defaultHostname;
     /**
      * @param {PersonalizeMiddlewareConfig} [config] Personalize middleware config
      */

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

@@ -1,18 +1,44 @@
 import { NextResponse, NextRequest } from 'next/server';
-import { GraphQLRedirectsServiceConfig } from '@sitecore-jss/sitecore-jss/site';
+import { GraphQLRedirectsServiceConfig, SiteInfo } from '@sitecore-jss/sitecore-jss/site';
 /**
  * extended RedirectsMiddlewareConfig config type for RedirectsMiddleware
  */
-export declare type RedirectsMiddlewareConfig = Omit<GraphQLRedirectsServiceConfig, 'fetch'> & {
+export type RedirectsMiddlewareConfig = Omit<GraphQLRedirectsServiceConfig, 'fetch'> & {
     locales: string[];
+    /**
+     * Function used to determine if route should be excluded from RedirectsMiddleware.
+     * By default, files (pathname.includes('.')), Next.js API routes (pathname.startsWith('/api/')), and Sitecore API routes (pathname.startsWith('/sitecore/')) are ignored.
+     * This is an important performance consideration since Next.js Edge middleware runs on every request.
+     * @param {string} pathname The pathname
+     * @returns {boolean} Whether to exclude the route from RedirectsMiddleware
+     */
+    excludeRoute?: (pathname: string) => boolean;
+    /**
+     * function, determines if middleware should be turned off, based on cookie, header, or other considerations
+     *  @param {NextRequest} [req] optional: request object from middleware handler
+     *  @param {NextResponse} [res] optional: response object from middleware handler
+     * @returns {boolean} false by default
+     */
+    disabled?: (req?: NextRequest, res?: NextResponse) => boolean;
+    /**
+     * function used to resolve site for given hostname
+     */
+    getSite: (hostname: string) => SiteInfo;
+    /**
+     * fallback hostname in case `host` header is not present
+     * @default localhost
+     */
+    defaultHostname?: string;
 };
 /**
  * Middleware / handler fetches all redirects from Sitecore instance by grapqhl service
  * compares with current url and redirects to target url
  */
 export declare class RedirectsMiddleware {
+    protected config: RedirectsMiddlewareConfig;
     private redirectsService;
     private locales;
+    private defaultHostname;
     /**
      * @param {RedirectsMiddlewareConfig} [config] redirects middleware config
      */
@@ -21,11 +47,14 @@ export declare class RedirectsMiddleware {
      * Gets the Next.js API route handler
      * @returns route handler
      */
-    getHandler(): (req: NextRequest) => Promise<NextResponse>;
+    getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
+    protected excludeRoute(pathname: string): boolean;
+    protected getHostname(req: NextRequest): string;
     private handler;
     /**
      * Method returns RedirectInfo when matches
-     * @param {NextRequest} req
+     * @param {NextRequest} req request
+     * @param {string} siteName site name
      * @returns Promise<RedirectInfo | undefined>
      * @private
      */

package/types/monitoring/healthcheck-middleware.d.ts

@@ -0,0 +1,12 @@
+import { NextApiResponse, NextApiRequest } from 'next';
+/**
+ * Middleware / handler for use in healthcheck Next.js API route (e.g. '/api/healthz').
+ */
+export declare class HealthcheckMiddleware {
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}

package/types/monitoring/index.d.ts

@@ -0,0 +1 @@
+export { HealthcheckMiddleware } from './healthcheck-middleware';

package/types/services/component-props-service.d.ts

@@ -2,18 +2,18 @@ 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';
-export declare type FetchComponentPropsArguments<NextContext> = {
+export type FetchComponentPropsArguments<NextContext> = {
     layoutData: LayoutServiceData;
     context: NextContext;
     componentModule: ComponentModule;
 };
-export declare type ComponentPropsRequest<NextContext> = {
+export type ComponentPropsRequest<NextContext> = {
     fetch: ComponentPropsFetchFunction<NextContext>;
     layoutData: LayoutServiceData;
     rendering: ComponentRendering;
     context: NextContext;
 };
-declare type FetchFunctionFactory<NextContext> = (componentName: string) => Promise<ComponentPropsFetchFunction<NextContext> | undefined>;
+type FetchFunctionFactory<NextContext> = (componentName: string) => Promise<ComponentPropsFetchFunction<NextContext> | undefined>;
 export declare class ComponentPropsService {
     /**
      * SSR mode

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

@@ -1,6 +1,7 @@
 import { GraphQLClient, PageInfo } from '@sitecore-jss/sitecore-jss/graphql';
 /** @private */
 export declare const languageError = "The list of languages cannot be empty";
+export declare const sitesError = "The list of sites cannot be empty";
 /**
  * @param {string} siteName to inject into error text
  * @private
@@ -53,7 +54,7 @@ export interface SiteRouteQueryResult<T> {
 /**
  * The schema of data returned in response to a routes list query request
  */
-export declare type RouteListQueryResult = {
+export type RouteListQueryResult = {
     path: string;
     route?: {
         personalization?: {
@@ -64,7 +65,7 @@ export declare type RouteListQueryResult = {
 /**
  * Configuration options for @see GraphQLSitemapService instances
  */
-export interface GraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariables, 'language'> {
+export interface GraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariables, 'language' | 'siteName'> {
     /**
      * Your Graphql endpoint
      */
@@ -73,6 +74,10 @@ export interface GraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariable
      * The API key to use for authentication.
      */
     apiKey: string;
+    /**
+     * Names of the configured sites
+     */
+    sites: string[];
     /**
      * A flag for whether to include personalized routes in service output - only works on XM Cloud
      * turned off by default
@@ -82,7 +87,7 @@ export interface GraphQLSitemapServiceConfig extends Omit<SiteRouteQueryVariable
 /**
  * Object model of a site page item.
  */
-export declare type StaticPath = {
+export type StaticPath = {
     params: {
         path: string[];
     };
@@ -129,8 +134,8 @@ export declare class GraphQLSitemapService {
      * @throws {RangeError} if the any of the languages is an empty string.
      */
     protected fetchSitemap(languages: string[], formatStaticPath: (path: string[], language: string) => StaticPath): Promise<StaticPath[]>;
-    protected transformLanguageSitePaths(sitePaths: RouteListQueryResult[], formatStaticPath: (path: string[], language: string) => StaticPath, language: string): Promise<StaticPath[]>;
-    protected fetchLanguageSitePaths(language: string): Promise<RouteListQueryResult[]>;
+    protected transformLanguageSitePaths(sitePaths: RouteListQueryResult[], formatStaticPath: (path: string[], language: string) => StaticPath, language: string, multiSiteName?: string): Promise<StaticPath[]>;
+    protected fetchLanguageSitePaths(language: string, siteName: string): Promise<RouteListQueryResult[]>;
     /**
      * Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
      * library for fetching graphql data (@see GraphQLRequestClient). Override this method if you

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

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

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

@@ -3,20 +3,20 @@ import { ComponentRendering, LayoutServiceData } from '@sitecore-jss/sitecore-js
 /**
  * Shape of component props storage
  */
-export declare type ComponentPropsCollection = {
+export type ComponentPropsCollection = {
     [componentUid: string]: unknown;
 };
 /**
  * Type of side effect function which could be invoked on component level (getStaticProps/getServerSideProps)
  */
-export declare type ComponentPropsFetchFunction<NextContext, FetchedProps = unknown> = {
+export type ComponentPropsFetchFunction<NextContext, FetchedProps = unknown> = {
     (rendering: ComponentRendering, layoutData: LayoutServiceData, context: NextContext): Promise<FetchedProps>;
 };
 /**
  * Shape of getServerSideProps function on component level
  */
-export declare type GetServerSideComponentProps = ComponentPropsFetchFunction<GetServerSidePropsContext>;
+export type GetServerSideComponentProps = ComponentPropsFetchFunction<GetServerSidePropsContext>;
 /**
  * Shape of getStaticProps function on component level
  */
-export declare type GetStaticComponentProps = ComponentPropsFetchFunction<GetStaticPropsContext>;
+export type GetStaticComponentProps = ComponentPropsFetchFunction<GetStaticPropsContext>;