@sitecore-content-sdk/nextjs 0.1.0-beta.1

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@sitecore-content-sdk/nextjs",
+  "version": "0.1.0-beta.1",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "npm run clean && tsc -p tsconfig.json && tsc -p tsconfig-esm.json",
+    "clean": "del-cli dist types",
+    "lint": "eslint \"./src/**/*.tsx\" \"./src/**/*.ts\"",
+    "test": "mocha --require ./test/setup.js \"./src/**/*.test.ts\" \"./src/**/*.test.tsx\" --exit",
+    "prepublishOnly": "npm run build",
+    "coverage": "nyc npm test",
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/nextjs --entryPoints src/index.ts --entryPoints src/monitoring/index.ts --entryPoints src/editing/index.ts --entryPoints src/middleware/index.ts --entryPoints src/context/index.ts --entryPoints src/utils/index.ts --entryPoints src/site/index.ts --entryPoints src/graphql/index.ts --githubPages false"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "author": {
+    "name": "Sitecore Corporation",
+    "url": "https://jss.sitecore.com"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://jss.sitecore.com",
+  "bugs": {
+    "url": "https://github.com/sitecore/jss/issues"
+  },
+  "devDependencies": {
+    "@sitecore-cloudsdk/core": "^0.4.2",
+    "@sitecore-cloudsdk/personalize": "^0.4.2",
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/react": "^16.2.0",
+    "@types/chai": "^4.3.4",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/chai-string": "^1.4.2",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "~22.9.0",
+    "@types/prop-types": "^15.7.5",
+    "@types/react": "^18.2.45",
+    "@types/react-dom": "^18.0.10",
+    "@types/sinon": "^10.0.13",
+    "@types/sinon-chai": "^3.2.9",
+    "chai": "^4.3.7",
+    "chai-as-promised": "^7.1.1",
+    "chai-string": "^1.5.0",
+    "chalk": "^4.1.2",
+    "cross-fetch": "^4.1.0",
+    "del-cli": "^6.0.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-react": "^7.32.1",
+    "jsdom": "^26.0.0",
+    "mocha": "^11.1.0",
+    "next": "^14.2.18",
+    "nock": "14.0.0-beta.7",
+    "nyc": "^17.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "sinon": "^19.0.2",
+    "sinon-chai": "^3.7.0",
+    "ts-node": "^10.9.1",
+    "typescript": "~5.7.3"
+  },
+  "peerDependencies": {
+    "@sitecore-cloudsdk/core": "^0.4.2",
+    "@sitecore-cloudsdk/personalize": "^0.4.2",
+    "next": "^14.2.18",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "dependencies": {
+    "@sitecore-content-sdk/core": "^0.1.0-beta.1",
+    "@sitecore-content-sdk/dev-tools": "^0.1.0-beta.1",
+    "@sitecore-content-sdk/react": "^0.1.0-beta.1",
+    "@vercel/kv": "^3.0.0",
+    "prop-types": "^15.8.1",
+    "regex-parser": "^2.3.0",
+    "sync-disk-cache": "^2.1.0"
+  },
+  "description": "",
+  "types": "types/index.d.ts",
+  "gitHead": "11e6c0ce4b6bcaf8a5ddffa39a921c8dd145e603",
+  "files": [
+    "dist",
+    "types",
+    "/*.js",
+    "/*.d.ts"
+  ]
+}

package/site.d.ts

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

package/site.js

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

package/types/ComponentBuilder.d.ts

@@ -0,0 +1,59 @@
+import { ComponentFactory, JssComponentType } from '@sitecore-content-sdk/react';
+import { Module, ModuleFactory } from './sharedTypes/module-factory';
+/**
+ * Represents a component that can be imported dynamically
+ */
+export type LazyModule = {
+    module: () => Promise<Module>;
+    element: (isEditing?: boolean) => JssComponentType;
+};
+/**
+ * Component is a module or a lazy module
+ */
+type Component = Module | LazyModule | JssComponentType;
+/**
+ * Configuration for ComponentBuilder
+ */
+export type ComponentBuilderConfig<Component> = {
+    /**
+     * List of components to be stored
+     */
+    components: Map<string, Component>;
+};
+/**
+ * Configuration for ComponentFactory
+ */
+type ComponentFactoryConfig = {
+    isEditing?: boolean;
+};
+/**
+ * Nextjs implementation of component builder class for building components based on the configuration.
+ */
+export declare class ComponentBuilder {
+    protected config: ComponentBuilderConfig<Component>;
+    /**
+     * List of components to be stored
+     */
+    protected components: Map<string, Component>;
+    /**
+     * SXA uses custom default export name
+     */
+    protected DEFAULT_EXPORT_NAME: string;
+    constructor(config: ComponentBuilderConfig<Component>);
+    /**
+     * Creates a new instance of module factory
+     * Module factory provides a module (file) including all exports.
+     * Module can be imported dynamically or statically.
+     * @returns {ModuleFactory} Module factory implementation
+     */
+    getModuleFactory(): ModuleFactory;
+    /**
+     * Creates a new instance of component factory
+     * Component can be imported dynamically or statically.
+     * @param {object} [config] Component factory configuration
+     * @param {boolean} [config.isEditing] Indicates if component factory is used in editing mode
+     * @returns {ComponentFactory} Component factory implementation
+     */
+    getComponentFactory({ isEditing }?: ComponentFactoryConfig): ComponentFactory;
+}
+export {};

package/types/components/BYOCWrapper.d.ts

@@ -0,0 +1,20 @@
+import { BYOCWrapper } from '@sitecore-content-sdk/react';
+import { GetStaticComponentProps, GetServerSideComponentProps } from '../sharedTypes/component-props';
+/**
+ * TODO: remove when framework agnostic forms implemented
+ * This is a repackaged version of the React BYOCWrapper component with support for
+ * server rendering in Next.js (using component-level data-fetching feature of JSS).
+ */
+/**
+ * Will be called during SSG
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getStaticProps: GetStaticComponentProps;
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getServerSideProps: GetServerSideComponentProps;
+export default BYOCWrapper;

package/types/components/ComponentPropsContext.d.ts

@@ -0,0 +1,18 @@
+import React, { ReactNode } from 'react';
+import { ComponentPropsCollection } from '../sharedTypes/component-props';
+/**
+ * Component props context which we are using in order to store data fetched on components level (getStaticProps/getServerSideProps)
+ */
+export declare const ComponentPropsReactContext: React.Context<ComponentPropsCollection>;
+/**
+ * Hook in order to get access to props related to specific component. Data comes from ComponentPropsContext.
+ * @see ComponentPropsContext
+ * @param {string | undefined} componentUid component uId
+ * @returns {ComponentData | undefined} component props
+ */
+export declare function useComponentProps<ComponentData>(componentUid: string | undefined): ComponentData | undefined;
+export type ComponentPropsContextProps = {
+    children: ReactNode;
+    value: ComponentPropsCollection;
+};
+export declare const ComponentPropsContext: ({ children, value, }: ComponentPropsContextProps) => JSX.Element;

package/types/components/FEaaSWrapper.d.ts

@@ -0,0 +1,22 @@
+import { FEaaSWrapper } from '@sitecore-content-sdk/react';
+import { GetStaticComponentProps, GetServerSideComponentProps } from '../sharedTypes/component-props';
+/**
+ * TODO: remove when framework agnostic forms implemented
+ * This is a repackaged version of the React FEaaSWrapper component with support for
+ * server rendering in Next.js (using component-level data-fetching feature of JSS).
+ */
+/**
+ * Will be called during SSG
+ * @param {ComponentRendering} rendering
+ * @param {LayoutServiceData} layoutData
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getStaticProps: GetStaticComponentProps;
+/**
+ * Will be called during SSR
+ * @param {ComponentRendering} rendering
+ * @param {LayoutServiceData} layoutData
+ * @returns {GetStaticPropsContext} context
+ */
+export declare const getServerSideProps: GetServerSideComponentProps;
+export default FEaaSWrapper;

package/types/components/Link.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { LinkProps as ReactLinkProps } from '@sitecore-content-sdk/react';
+export type LinkProps = ReactLinkProps & {
+    /**
+     * If `href` match with `internalLinkMatcher` regexp, then it's internal link and NextLink will be rendered
+     * @default /^\//g
+     */
+    internalLinkMatcher?: RegExp;
+};
+export declare const Link: React.ForwardRefExoticComponent<Omit<LinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;

package/types/components/NextImage.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { ImageProps } from '@sitecore-content-sdk/react';
+import { ImageProps as NextImageProperties } from 'next/image';
+type NextImageProps = ImageProps & Partial<NextImageProperties>;
+export declare const NextImage: React.FC<NextImageProps>;
+export {};

package/types/components/Placeholder.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { PlaceholderComponentProps, WithSitecoreContextProps, EnhancedOmit } from '@sitecore-content-sdk/react';
+/**
+ * React Placeholder component wrapped by withSitecoreContext, so these properties shouldn't be passed to the Next.js Placeholder.
+ */
+type PlaceholderProps = EnhancedOmit<PlaceholderComponentProps, keyof WithSitecoreContextProps>;
+export declare const Placeholder: (props: PlaceholderProps) => React.JSX.Element;
+export {};

package/types/components/RichText.d.ts

@@ -0,0 +1,32 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { RichTextProps as ReactRichTextProps } from '@sitecore-content-sdk/react';
+export type RichTextProps = ReactRichTextProps & {
+    /**
+     * Selector which should be used in order to prefetch it and attach event listeners
+     * @default 'a[href^="/"]'
+     */
+    internalLinksSelector?: string;
+    /**
+     * Controls the prefetch of internal links. This can be beneficial if you have RichText fields
+     * with large numbers of internal links in them.
+     * @default true
+     */
+    prefetchLinks?: boolean;
+};
+export declare const RichText: {
+    (props: RichTextProps): JSX.Element;
+    propTypes: {
+        field: PropTypes.Requireable<PropTypes.InferProps<{
+            value: PropTypes.Requireable<string>;
+            metadata: PropTypes.Requireable<{
+                [x: string]: any;
+            }>;
+        }>>;
+        tag: PropTypes.Requireable<string>;
+        editable: PropTypes.Requireable<boolean>;
+        emptyFieldEditingComponent: PropTypes.Requireable<NonNullable<React.ComponentClass<unknown, any> | React.FC<unknown>>>;
+        internalLinksSelector: PropTypes.Requireable<string>;
+    };
+    displayName: string;
+};

package/types/editing/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = "x-vercel-protection-bypass";
+export declare const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = "x-vercel-set-bypass-cookie";
+/**
+ * Headers that should be passed along to (Editing Chromes handler) SSR request.
+ * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
+ */
+export declare const EDITING_PASS_THROUGH_HEADERS: string[];

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

@@ -0,0 +1,29 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+import { Metadata } from '@sitecore-content-sdk/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

@@ -0,0 +1,79 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+import { LayoutServicePageState } from '@sitecore-content-sdk/core/layout';
+import { EditingRenderQueryParams, LayoutKind } from '@sitecore-content-sdk/core/editing';
+import { RenderMiddlewareBase } from './render-middleware';
+/**
+ * Configuration for the Editing Render Middleware.
+ */
+export type EditingRenderMiddlewareConfig = {
+    /**
+     * Function used to determine route/page URL to render.
+     * This may be necessary for certain custom Next.js routing configurations.
+     * @param {string} itemPath The Sitecore relative item path e.g. '/styleguide'
+     * @returns {string} The URL to render
+     * @default `${itemPath}`
+     */
+    resolvePageUrl?: (itemPath: string) => string;
+};
+/**
+ * Next.js API request with editing request query parameters.
+ */
+export type EditingNextApiRequest = NextApiRequest & {
+    query: EditingRenderQueryParams;
+};
+/**
+ * Data for Next.js Preview (Editing) Mode.
+ */
+export type EditingPreviewData = {
+    site: string;
+    itemId: string;
+    language: string;
+    pageState: Exclude<LayoutServicePageState, 'Normal'>;
+    variantIds: string[];
+    version?: string;
+    layoutKind?: LayoutKind;
+};
+/**
+ * Data for Component Library rendering mode
+ */
+export interface ComponentLibraryRenderPreviewData {
+    site: string;
+    itemId: string;
+    renderingId: string;
+    componentUid: string;
+    language: string;
+    pageState: LayoutServicePageState;
+    mode?: 'library';
+    variant?: string;
+    version?: string;
+    dataSourceId?: string;
+}
+/**
+ * Type guard for Component Library mode
+ * @param {object} data preview data to check
+ * @returns true if the data is EditingPreviewData
+ * @see EditingPreviewData
+ */
+export declare const isComponentLibraryPreviewData: (data: unknown) => data is ComponentLibraryRenderPreviewData;
+/**
+ * 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 extends RenderMiddlewareBase {
+    config?: EditingRenderMiddlewareConfig | undefined;
+    /**
+     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+     */
+    constructor(config?: EditingRenderMiddlewareConfig | undefined);
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler(): (req: EditingNextApiRequest, res: NextApiResponse) => Promise<void>;
+    /**
+     * Gets the Content-Security-Policy header value
+     * @returns Content-Security-Policy header value
+     */
+    private getSCPHeader;
+    private handler;
+}

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

@@ -0,0 +1,5 @@
+export { GraphQLEditingService } from '@sitecore-content-sdk/core/editing';
+export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, isComponentLibraryPreviewData, EditingPreviewData, } from './editing-render-middleware';
+export { FEAASRenderMiddleware, FEAASRenderMiddlewareConfig } from './feaas-render-middleware';
+export { EditingConfigMiddleware, EditingConfigMiddlewareConfig, } from './editing-config-middleware';
+export { RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-content-sdk/core/layout';

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

@@ -0,0 +1,24 @@
+import { IncomingHttpHeaders } from 'http';
+/**
+ * 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;
+    };
+    /**
+     * Get headers that should be passed along to subsequent requests
+     * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
+     * @returns Object of approved headers
+     */
+    protected getHeadersForPropagation: (headers: IncomingHttpHeaders) => {
+        [key: string]: string;
+    };
+}

package/types/graphql/index.d.ts

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

package/types/index.d.ts

@@ -0,0 +1,24 @@
+export { constants, NativeDataFetcher, NativeDataFetcherConfig, NativeDataFetcherResponse, NativeDataFetcherError, HTMLLink, enableDebug, debug, CacheClient, CacheOptions, MemoryCacheClient, } from '@sitecore-content-sdk/core';
+export { LayoutService, LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, GraphQLLayoutService, GraphQLLayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, getContentStylesheetLink, EditMode, } from '@sitecore-content-sdk/core/layout';
+export { RestComponentLayoutService } from '@sitecore-content-sdk/core/editing';
+export { mediaApi } from '@sitecore-content-sdk/core/media';
+export { DictionaryPhrases, DictionaryService, GraphQLDictionaryService, GraphQLDictionaryServiceConfig, } from '@sitecore-content-sdk/core/i18n';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, CdpHelper, } from '@sitecore-content-sdk/core/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 { GraphQLSitemapService, GraphQLSitemapServiceConfig, } from './services/graphql-sitemap-service';
+export { MultisiteGraphQLSitemapService, MultisiteGraphQLSitemapServiceConfig, } from './services/mutisite-graphql-sitemap-service';
+export { GraphQLSitemapXmlService, GraphQLSitemapXmlServiceConfig, GraphQLErrorPagesService, GraphQLErrorPagesServiceConfig, RobotsQueryResult, GraphQLRobotsService, GraphQLRobotsServiceConfig, ErrorPages, SiteInfo, SiteResolver, GraphQLSiteInfoService, GraphQLSiteInfoServiceConfig, getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, } from '@sitecore-content-sdk/core/site';
+export { StaticPath } from './services/graphql-sitemap-service';
+export { ComponentPropsReactContext, ComponentPropsContextProps, ComponentPropsContext, useComponentProps, } from './components/ComponentPropsContext';
+export { Link, LinkProps } from './components/Link';
+export { RichText, RichTextProps } from './components/RichText';
+export { Placeholder } from './components/Placeholder';
+export { NextImage } from './components/NextImage';
+import * as FEaaSWrapper from './components/FEaaSWrapper';
+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, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getComponentLibraryStylesheetLinks, File, FileField, RichTextField, ComponentLibraryLayout, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreContextOptions, WithSitecoreContextProps, WithSitecoreContextHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, } from '@sitecore-content-sdk/react';

package/types/middleware/index.d.ts

@@ -0,0 +1,5 @@
+export { debug } from '@sitecore-content-sdk/core';
+export { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
+export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
+export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';

package/types/middleware/middleware.d.ts

@@ -0,0 +1,82 @@
+import { SiteInfo, SiteResolver } from '@sitecore-content-sdk/core/site';
+import { NextRequest, NextResponse } from 'next/server';
+export type MiddlewareBaseConfig = {
+    /**
+     * function, determines if middleware should be turned off, based on cookie, header, or other considerations
+     * @param {NextRequest} [req] request object from middleware handler
+     * @param {NextResponse} [res] response object from middleware handler
+     */
+    disabled?: (req?: NextRequest, res?: NextResponse) => boolean;
+    /**
+     * Function used to determine if route should be excluded.
+     * 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;
+    /**
+     * Fallback hostname in case `host` header is not present
+     * @default localhost
+     */
+    defaultHostname?: string;
+    /**
+     * Site resolution implementation by name/hostname
+     */
+    siteResolver: SiteResolver;
+};
+export declare abstract class MiddlewareBase {
+    protected config: MiddlewareBaseConfig;
+    protected SITE_SYMBOL: string;
+    protected REWRITE_HEADER_NAME: string;
+    protected defaultHostname: string;
+    constructor(config: MiddlewareBaseConfig);
+    /**
+     * Determines if mode is preview
+     * @param {NextRequest} req request
+     * @returns {boolean} is preview
+     */
+    protected isPreview(req: NextRequest): boolean;
+    /**
+     * Determines if the request is a Next.js (next/link) prefetch request
+     * @param {NextRequest} req request
+     * @returns {boolean} is prefetch
+     */
+    protected isPrefetch(req: NextRequest): boolean;
+    protected excludeRoute(pathname: string): boolean | undefined;
+    /**
+     * Safely extract all headers for debug logging
+     * Necessary to avoid middleware issue https://github.com/vercel/next.js/issues/39765
+     * @param {Headers} incomingHeaders Incoming headers
+     * @returns Object with headers as key/value pairs
+     */
+    protected extractDebugHeaders(incomingHeaders: Headers): {
+        [key: string]: string;
+    };
+    /**
+     * Provides used language
+     * @param {NextRequest} req request
+     * @returns {string} language
+     */
+    protected getLanguage(req: NextRequest): string;
+    /**
+     * Extract 'host' header
+     * @param {NextRequest} req request
+     */
+    protected getHostHeader(req: NextRequest): string | undefined;
+    /**
+     * Get site information.
+     * Can not be used in **Preview** mode, since site will not be resolved
+     * @param {NextRequest} req request
+     * @param {NextResponse} [res] response
+     * @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

@@ -0,0 +1,39 @@
+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
+     */
+    useCookieResolution?: (req: NextRequest) => boolean;
+};
+/**
+ * Middleware / handler for multisite support
+ */
+export declare class MultisiteMiddleware extends MiddlewareBase {
+    protected config: MultisiteMiddlewareConfig;
+    /**
+     * @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 | undefined;
+    private handler;
+}