@sitecore-content-sdk/nextjs 1.3.0-canary.9 → 1.4.0-canary.2

package/types/index.d.ts

@@ -1,24 +1,25 @@
-export { constants, NativeDataFetcher, NativeDataFetcherConfig, NativeDataFetcherResponse, NativeDataFetcherError, HTMLLink, enableDebug, debug, CacheClient, CacheOptions, MemoryCacheClient, } from '@sitecore-content-sdk/core';
-export { LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, LayoutService, LayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, getContentStylesheetLink, EditMode, RenderingType, } from '@sitecore-content-sdk/core/layout';
-export { PageMode, ErrorPage, Page } from '@sitecore-content-sdk/core/client';
-export { ComponentLayoutService } from '@sitecore-content-sdk/core/editing';
-export { mediaApi } from '@sitecore-content-sdk/core/media';
-export { DictionaryPhrases, DictionaryService, DictionaryServiceConfig, } from '@sitecore-content-sdk/core/i18n';
-export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, CdpHelper, PersonalizeService, } from '@sitecore-content-sdk/core/personalize';
-export { SitePathService, SitePathServiceConfig, RedirectsService, RedirectsServiceConfig, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectInfo, } from '@sitecore-content-sdk/core/site';
-export { StaticPath } from '@sitecore-content-sdk/core';
-export { SitemapXmlService, SitemapXmlServiceConfig, ErrorPagesService, ErrorPagesServiceConfig, RobotsQueryResult, RobotsService, RobotsServiceConfig, ErrorPages, SiteInfo, SiteResolver, SiteInfoService, SiteInfoServiceConfig, getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, } from '@sitecore-content-sdk/core/site';
-export { ComponentPropsCollection, ComponentPropsError, NextjsContentSdkComponent, GetComponentServerProps, } from './sharedTypes/component-props';
-export { SitecorePageProps } from './sharedTypes/sitecore-page-props';
-export { ComponentPropsService } from './services/component-props-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 { FEaaSClientWrapper, FEaaSServerWrapper, BYOCClientWrapper, BYOCServerWrapper, } from '@sitecore-content-sdk/react';
-export { FEaaSWrapper };
-export { BYOCWrapper };
-export { ComponentMap, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getDesignLibraryStylesheetLinks, File, FileField, RichTextField, DesignLibrary, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, PlaceholderComponentProps, SitecoreProvider, SitecoreProviderState, SitecoreProviderReactContext, withSitecore, useSitecore, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreOptions, WithSitecoreProps, WithSitecoreHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, Form, ClientEditingChromesUpdate, AppPlaceholder, AppPlaceholderProps, } from '@sitecore-content-sdk/react';
+export { constants, NativeDataFetcher, NativeDataFetcherConfig, NativeDataFetcherResponse, NativeDataFetcherError, HTMLLink, enableDebug, debug, CacheClient, CacheOptions, MemoryCacheClient, } from '@sitecore-content-sdk/core';
+export { LayoutServiceData, LayoutServicePageState, LayoutServiceContext, LayoutServiceContextData, LayoutService, LayoutServiceConfig, PlaceholderData, PlaceholdersData, RouteData, Field, Item, getChildPlaceholder, getFieldValue, ComponentRendering, ComponentFields, ComponentParams, getContentStylesheetLink, EditMode, RenderingType, } from '@sitecore-content-sdk/core/layout';
+export { PageMode, ErrorPage, Page } from '@sitecore-content-sdk/core/client';
+export { ComponentLayoutService } from '@sitecore-content-sdk/core/editing';
+export { mediaApi } from '@sitecore-content-sdk/core/media';
+export { DictionaryPhrases, DictionaryService, DictionaryServiceConfig, } from '@sitecore-content-sdk/core/i18n';
+export { personalizeLayout, getPersonalizedRewrite, getPersonalizedRewriteData, getGroomedVariantIds, normalizePersonalizedRewrite, CdpHelper, PersonalizeService, } from '@sitecore-content-sdk/core/personalize';
+export { SitePathService, SitePathServiceConfig, RedirectsService, RedirectsServiceConfig, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectInfo, } from '@sitecore-content-sdk/core/site';
+export { StaticPath } from '@sitecore-content-sdk/core';
+export { SitemapXmlService, SitemapXmlServiceConfig, ErrorPagesService, ErrorPagesServiceConfig, RobotsQueryResult, RobotsService, RobotsServiceConfig, ErrorPages, SiteInfo, SiteResolver, SiteInfoService, SiteInfoServiceConfig, getSiteRewrite, getSiteRewriteData, normalizeSiteRewrite, } from '@sitecore-content-sdk/core/site';
+export { ComponentPropsCollection, ComponentPropsError, NextjsContentSdkComponent, GetComponentServerProps, } from './sharedTypes/component-props';
+export { SitecorePageProps } from './sharedTypes/sitecore-page-props';
+export { ComponentPropsService } from './services/component-props-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 { FEaaSClientWrapper, FEaaSServerWrapper, BYOCClientWrapper, BYOCServerWrapper, } from '@sitecore-content-sdk/react';
+export { FEaaSWrapper };
+export { BYOCWrapper };
+export { ComponentMap, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, FEaaSComponent, FEaaSComponentProps, FEaaSComponentParams, fetchFEaaSComponentServerProps, BYOCComponentParams, BYOCComponent, BYOCComponentProps, getDesignLibraryStylesheetLinks, File, FileField, RichTextField, DesignLibrary, DesignLibraryApp, DefaultEmptyFieldEditingComponentImage, DefaultEmptyFieldEditingComponentText, PlaceholderComponentProps, SitecoreProvider, SitecoreProviderState, SitecoreProviderReactContext, withSitecore, useSitecore, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, WithSitecoreOptions, WithSitecoreProps, WithSitecoreHocProps, withFieldMetadata, withEmptyFieldEditingComponent, EditingScripts, Form, ClientEditingChromesUpdate, AppPlaceholder, AppPlaceholderProps, } from '@sitecore-content-sdk/react';
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAET,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,EACtB,QAAQ,EACR,WAAW,EACX,KAAK,EACL,WAAW,EACX,YAAY,EACZ,iBAAiB,GAClB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,KAAK,EACL,IAAI,EACJ,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,wBAAwB,EACxB,QAAQ,EACR,aAAa,GACd,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,GACxB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAC1B,oBAAoB,EACpB,4BAA4B,EAC5B,SAAS,EACT,kBAAkB,GACnB,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,6BAA6B,EAC7B,YAAY,GACb,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAExD,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,uBAAuB,GACxB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAEtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC1B,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,YAAY,MAAM,2BAA2B,CAAC;AAC1D,OAAO,KAAK,WAAW,MAAM,0BAA0B,CAAC;AACxD,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,CAAC;AAEvB,OAAO,EACL,YAAY,EACZ,KAAK,EACL,UAAU,EACV,eAAe,EACf,UAAU,EACV,SAAS,EACT,cAAc,EACd,IAAI,EACJ,SAAS,EACT,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,8BAA8B,EAC9B,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EAClB,+BAA+B,EAC/B,IAAI,EACJ,SAAS,EACT,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,sCAAsC,EACtC,qCAAqC,EACrC,yBAAyB,EACzB,gBAAgB,EAChB,qBAAqB,EACrB,4BAA4B,EAC5B,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,8BAA8B,EAC9B,cAAc,EACd,IAAI,EACJ,0BAA0B,EAC1B,cAAc,EACd,mBAAmB,GACpB,MAAM,6BAA6B,CAAC"}

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

@@ -1,13 +1,28 @@
-import { MultisiteMiddleware } from './multisite-middleware';
-/**
- * Middleware/handler for enabling multisite support in the Next.js App Router.
- */
-export declare class AppRouterMultisiteMiddleware extends MultisiteMiddleware {
-    /**
-     * Generates a site-specific rewrite path for app router based on the provided pathname and site name.
-     * @param {string} pathname - The pathname to be rewritten.
-     * @param {string} siteName - The name of the site.
-     * @returns The rewritten path as a string.
-     */
-    protected getSiteRewrite(pathname: string, siteName: string): string;
-}
+import { NextResponse } from 'next/server';
+import { MultisiteMiddleware } from './multisite-middleware';
+/**
+ * Middleware/handler for enabling multisite support in the Next.js App Router.
+ * @public
+ */
+export declare class AppRouterMultisiteMiddleware extends MultisiteMiddleware {
+    /**
+     * Warns when multisite is disabled in App Router.
+     * The middleware will still run to prevent routing errors.
+     * @param {NextResponse} _res response (unused, kept for method signature compatibility)
+     */
+    protected shouldWarnWhenDisabled(_res: NextResponse): void;
+    /**
+     * In App Router, we cannot skip the middleware even if enabled is false,
+     * because the route structure requires the [site] segment.
+     * @returns {boolean} always returns false (never skip) for App Router
+     */
+    protected shouldSkipWhenDisabled(): boolean;
+    /**
+     * Generates a site-specific rewrite path for app router based on the provided pathname and site name.
+     * @param {string} pathname - The pathname to be rewritten.
+     * @param {string} siteName - The name of the site.
+     * @returns The rewritten path as a string.
+     */
+    protected getSiteRewrite(pathname: string, siteName: string): string;
+}
+//# sourceMappingURL=app-router-multisite-middleware.d.ts.map

package/types/middleware/app-router-multisite-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-router-multisite-middleware.d.ts","sourceRoot":"","sources":["../../src/middleware/app-router-multisite-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,mBAAmB;IACnE;;;;OAIG;IAEH,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAS1D;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,IAAI,OAAO;IAI3C;;;;;OAKG;IACH,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;CAIrE"}

package/types/middleware/index.d.ts

@@ -1,11 +1,12 @@
-export { debug } from '@sitecore-content-sdk/core';
-export { MiddlewareBase, MiddlewareBaseConfig, Middleware, defineMiddleware } from './middleware';
-export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
-export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
-export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';
-export { AppRouterMultisiteMiddleware } from './app-router-multisite-middleware';
-export { SitemapMiddleware } from './sitemap-middleware';
-export { RobotsMiddleware } from './robots-middleware';
-export { LocaleMiddleware, LocaleMiddlewareConfig } from './locale-middleware';
-export { PersonalizeService, PersonalizeServiceConfig, } from '@sitecore-content-sdk/core/personalize';
-export { RedirectsService, RedirectsServiceConfig, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectInfo, } from '@sitecore-content-sdk/core/site';
+export { debug } from '@sitecore-content-sdk/core';
+export { MiddlewareBase, MiddlewareBaseConfig, Middleware, defineMiddleware } from './middleware';
+export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-middleware';
+export { PersonalizeMiddleware, PersonalizeMiddlewareConfig } from './personalize-middleware';
+export { MultisiteMiddleware, MultisiteMiddlewareConfig } from './multisite-middleware';
+export { AppRouterMultisiteMiddleware } from './app-router-multisite-middleware';
+export { SitemapMiddleware } from './sitemap-middleware';
+export { RobotsMiddleware } from './robots-middleware';
+export { LocaleMiddleware, LocaleMiddlewareConfig } from './locale-middleware';
+export { PersonalizeService, PersonalizeServiceConfig, } from '@sitecore-content-sdk/core/personalize';
+export { RedirectsService, RedirectsServiceConfig, REDIRECT_TYPE_301, REDIRECT_TYPE_302, REDIRECT_TYPE_SERVER_TRANSFER, RedirectInfo, } from '@sitecore-content-sdk/core/site';
+//# sourceMappingURL=index.d.ts.map

package/types/middleware/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/middleware/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAClG,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAC9F,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACL,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,6BAA6B,EAC7B,YAAY,GACb,MAAM,iCAAiC,CAAC"}

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

@@ -1,32 +1,35 @@
-import { NextResponse, NextRequest } from 'next/server';
-import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
-/**
- * Locale middleware config
- */
-export type LocaleMiddlewareConfig = MiddlewareBaseConfig & {
-    /**
-     * List of locales supported by the application
-     */
-    locales: string[];
-};
-/**
- * Middleware/handler for handling locale-based routing in the Next.js App Router.
- * This middleware is responsible for extracting the locale from the request path and rewriting it if necessary.
- * It also sets the locale header in the response.
- */
-export declare class LocaleMiddleware extends MiddlewareBase {
-    protected config: LocaleMiddlewareConfig;
-    /**
-     * @param {LocaleMiddlewareConfig} config Locale middleware config
-     */
-    constructor(config: LocaleMiddlewareConfig);
-    handle: (req: NextRequest, res: NextResponse) => Promise<NextResponse>;
-    protected disabled(req: NextRequest, res: NextResponse): boolean | undefined;
-    /**
-     * Extract locale from path
-     * @param {string} path request path
-     * @returns {string | undefined} the locale if found
-     */
-    protected getLocaleFromPath(path: string): string | undefined;
-    private setLocaleHeader;
-}
+import { NextResponse, NextRequest } from 'next/server';
+import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+/**
+ * The interface for the Locale middleware configuration.
+ * @public
+ */
+export type LocaleMiddlewareConfig = MiddlewareBaseConfig & {
+    /**
+     * List of locales supported by the application
+     */
+    locales: string[];
+};
+/**
+ * Middleware/handler for handling locale-based routing in the Next.js App Router.
+ * This middleware is responsible for extracting the locale from the request path and rewriting it if necessary.
+ * It also sets the locale header in the response.
+ * @public
+ */
+export declare class LocaleMiddleware extends MiddlewareBase {
+    protected config: LocaleMiddlewareConfig;
+    /**
+     * @param {LocaleMiddlewareConfig} config Locale middleware config
+     */
+    constructor(config: LocaleMiddlewareConfig);
+    handle: (req: NextRequest, res: NextResponse) => Promise<NextResponse>;
+    protected disabled(req: NextRequest, res: NextResponse): boolean | undefined;
+    /**
+     * Extract locale from path
+     * @param {string} path request path
+     * @returns {string | undefined} the locale if found
+     */
+    protected getLocaleFromPath(path: string): string | undefined;
+    private setLocaleHeader;
+}
+//# sourceMappingURL=locale-middleware.d.ts.map

package/types/middleware/locale-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"locale-middleware.d.ts","sourceRoot":"","sources":["../../src/middleware/locale-middleware.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGxD,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAsB,MAAM,cAAc,CAAC;AAExF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG;IAC1D;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAItC,SAAS,CAAC,MAAM,EAAE,sBAAsB;IAHpD;;OAEG;gBACmB,MAAM,EAAE,sBAAsB;IAIpD,MAAM,GAAU,KAAK,WAAW,EAAE,KAAK,YAAY,KAAG,OAAO,CAAC,YAAY,CAAC,CA6CzE;IAEF,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS;IAK5E;;;;OAIG;IACH,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAM7D,OAAO,CAAC,eAAe;CAGxB"}

package/types/middleware/middleware.d.ts

@@ -1,127 +1,135 @@
-import { SiteInfo, SiteResolver } from '@sitecore-content-sdk/core/site';
-import { GraphQLRequestClientFactory } from '@sitecore-content-sdk/core';
-import { NextRequest, NextFetchEvent, NextResponse } from 'next/server';
-import { GraphQLClientOptions } from '@sitecore-content-sdk/core/client';
-export declare const REWRITE_HEADER_NAME = "x-sc-rewrite";
-export declare const LOCALE_HEADER_NAME = "x-sc-locale";
-export type MiddlewareBaseConfig = {
-    /**
-     * function, determines if middleware execution should be skipped, based on cookie, header, or other considerations
-     * @param {NextRequest} req request object from middleware handler
-     * @param {NextResponse} res response object from middleware handler
-     */
-    skip?: (req: NextRequest, res: NextResponse) => boolean;
-    /**
-     * Fallback hostname in case `host` header is not present
-     * @default localhost
-     */
-    defaultHostname?: string;
-    /**
-     * Fallback language in locale cannot be extracted from request URL
-     * @default 'en'
-     */
-    defaultLanguage?: string;
-    /**
-     * Site resolution implementation by name/hostname
-     */
-    sites: SiteInfo[];
-};
-/**
- * Middleware class to be extended by all middleware implementations
- */
-export declare abstract class Middleware {
-    /**
-     * Handler method to execute middleware logic
-     * @param {NextRequest} req request
-     * @param {NextResponse} res response
-     * @param {NextFetchEvent} ev fetch event
-     */
-    abstract handle(req: NextRequest, res: NextResponse, ev: NextFetchEvent): Promise<NextResponse>;
-}
-/**
- * Base middleware class with common methods
- */
-export declare abstract class MiddlewareBase extends Middleware {
-    protected config: MiddlewareBaseConfig;
-    protected defaultHostname: string;
-    protected siteResolver: SiteResolver;
-    constructor(config: MiddlewareBaseConfig);
-    /**
-     * Determines if mode is preview
-     * @param {NextRequest} req request
-     * @returns {boolean} is preview
-     */
-    protected isPreview(req: NextRequest): boolean;
-    /**
-     * Determines if the application is using the app router based on the locale header
-     * @param {NextResponse} res response
-     * @returns {boolean} true if app router is used
-     */
-    protected isAppRouter(res: NextResponse): 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 disabled(req: NextRequest, res: NextResponse): 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
-     * @param {NextResponse} res response
-     * @returns {string} language
-     */
-    protected getLanguage(req: NextRequest, res?: NextResponse): string;
-    /**
-     * Extract language from locale header of the response
-     * set by LocaleMiddleware for app router application
-     * @param {NextResponse} res response
-     * @returns {string | undefined} language or undefined if not found
-     */
-    protected getLanguageFromHeader(res?: NextResponse): string | undefined;
-    /**
-     * Extract 'host' header
-     * @param {NextRequest} req request
-     */
-    protected getHostHeader(req: NextRequest): string | undefined;
-    /**
-     * Get site information. If site name is stored in cookie, use it, otherwise resolve by hostname
-     * - If site can't be resolved by site name cookie use default site info based on provided parameters
-     * - If site can't be resolved by hostname throw an error
-     * @param {NextRequest} req request
-     * @param {NextResponse} [res] response
-     * @returns {SiteInfo} site information
-     */
-    protected getSite(req: NextRequest, res?: NextResponse): SiteInfo;
-    protected getClientFactory(graphQLOptions: GraphQLClientOptions): GraphQLRequestClientFactory;
-    /**
-     * Create a rewrite response
-     * @param {string} rewritePath the destionation path
-     * @param {NextRequest} req the current request
-     * @param {NextResponse} res the current response
-     * @param {boolean} [skipHeader] don't write 'x-sc-rewrite' header
-     */
-    protected rewrite(rewritePath: string, req: NextRequest, res: NextResponse, skipHeader?: boolean): NextResponse;
-}
-/**
- * Define a middleware with a list of middlewares
- * @param {Middleware[]} middlewares List of middlewares to execute
- */
-export declare const defineMiddleware: (...middlewares: Middleware[]) => {
-    /**
-     * Execute all middlewares
-     * @param {NextRequest} req request
-     * @param {NextFetchEvent} ev fetch event
-     * @param {NextResponse} [res] response
-     */
-    exec: (req: NextRequest, ev: NextFetchEvent, res?: NextResponse) => Promise<NextResponse<unknown>>;
-};
+import { SiteInfo, SiteResolver } from '@sitecore-content-sdk/core/site';
+import { GraphQLRequestClientFactory } from '@sitecore-content-sdk/core';
+import { NextRequest, NextFetchEvent, NextResponse } from 'next/server';
+import { GraphQLClientOptions } from '@sitecore-content-sdk/core/client';
+export declare const REWRITE_HEADER_NAME = "x-sc-rewrite";
+export declare const LOCALE_HEADER_NAME = "x-sc-locale";
+/**
+ * The interface for the Middleware configuration.
+ * @public
+ */
+export type MiddlewareBaseConfig = {
+    /**
+     * function, determines if middleware execution should be skipped, based on cookie, header, or other considerations
+     * @param {NextRequest} req request object from middleware handler
+     * @param {NextResponse} res response object from middleware handler
+     */
+    skip?: (req: NextRequest, res: NextResponse) => boolean;
+    /**
+     * Fallback hostname in case `host` header is not present
+     * @default localhost
+     */
+    defaultHostname?: string;
+    /**
+     * Fallback language in locale cannot be extracted from request URL
+     * @default 'en'
+     */
+    defaultLanguage?: string;
+    /**
+     * Site resolution implementation by name/hostname
+     */
+    sites: SiteInfo[];
+};
+/**
+ * Middleware class to be extended by all middleware implementations
+ * @public
+ */
+export declare abstract class Middleware {
+    /**
+     * Handler method to execute middleware logic
+     * @param {NextRequest} req request
+     * @param {NextResponse} res response
+     * @param {NextFetchEvent} ev fetch event
+     */
+    abstract handle(req: NextRequest, res: NextResponse, ev: NextFetchEvent): Promise<NextResponse>;
+}
+/**
+ * Base middleware class with common methods
+ * @public
+ */
+export declare abstract class MiddlewareBase extends Middleware {
+    protected config: MiddlewareBaseConfig;
+    protected defaultHostname: string;
+    protected siteResolver: SiteResolver;
+    constructor(config: MiddlewareBaseConfig);
+    /**
+     * Determines if mode is preview
+     * @param {NextRequest} req request
+     * @returns {boolean} is preview
+     */
+    protected isPreview(req: NextRequest): boolean;
+    /**
+     * Determines if the application is using the app router based on the locale header
+     * @param {NextResponse} res response
+     * @returns {boolean} true if app router is used
+     */
+    protected isAppRouter(res: NextResponse): 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 disabled(req: NextRequest, res: NextResponse): 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
+     * @param {NextResponse} res response
+     * @returns {string} language
+     */
+    protected getLanguage(req: NextRequest, res?: NextResponse): string;
+    /**
+     * Extract language from locale header of the response
+     * set by LocaleMiddleware for app router application
+     * @param {NextResponse} res response
+     * @returns {string | undefined} language or undefined if not found
+     */
+    protected getLanguageFromHeader(res?: NextResponse): string | undefined;
+    /**
+     * Extract 'host' header
+     * @param {NextRequest} req request
+     */
+    protected getHostHeader(req: NextRequest): string | undefined;
+    /**
+     * Get site information. If site name is stored in cookie, use it, otherwise resolve by hostname
+     * - If site can't be resolved by site name cookie use default site info based on provided parameters
+     * - If site can't be resolved by hostname throw an error
+     * @param {NextRequest} req request
+     * @param {NextResponse} [res] response
+     * @returns {SiteInfo} site information
+     */
+    protected getSite(req: NextRequest, res?: NextResponse): SiteInfo;
+    protected getClientFactory(graphQLOptions: GraphQLClientOptions): GraphQLRequestClientFactory;
+    /**
+     * Create a rewrite response
+     * @param {string} rewritePath the destionation path
+     * @param {NextRequest} req the current request
+     * @param {NextResponse} res the current response
+     * @param {boolean} [skipHeader] don't write 'x-sc-rewrite' header
+     */
+    protected rewrite(rewritePath: string, req: NextRequest, res: NextResponse, skipHeader?: boolean): NextResponse;
+}
+/**
+ * Define a middleware with a list of middlewares
+ * @param {Middleware[]} middlewares List of middlewares to execute
+ * @public
+ */
+export declare const defineMiddleware: (...middlewares: Middleware[]) => {
+    /**
+     * Execute all middlewares
+     * @param {NextRequest} req request
+     * @param {NextFetchEvent} ev fetch event
+     * @param {NextResponse} [res] response
+     */
+    exec: (req: NextRequest, ev: NextFetchEvent, res?: NextResponse) => Promise<NextResponse<unknown>>;
+};
+//# sourceMappingURL=middleware.d.ts.map

package/types/middleware/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../src/middleware/middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,QAAQ,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACnF,OAAO,EAAS,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAEL,oBAAoB,EACrB,MAAM,mCAAmC,CAAC;AAG3C,eAAO,MAAM,mBAAmB,iBAAiB,CAAC;AAClD,eAAO,MAAM,kBAAkB,gBAAgB,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;OAIG;IACH,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC;IACxD;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,8BAAsB,UAAU;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;CAChG;AAED;;;GAGG;AACH,8BAAsB,cAAe,SAAQ,UAAU;IAIzC,SAAS,CAAC,MAAM,EAAE,oBAAoB;IAHlD,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC;gBAEf,MAAM,EAAE,oBAAoB;IAMlD;;;;OAIG;IACH,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,WAAW;IAOpC;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO;IAIjD;;;;OAIG;IACH,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO;IAmB/C,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY;IAWtD;;;;;OAKG;IACH,SAAS,CAAC,mBAAmB,CAAC,eAAe,EAAE,OAAO;;;IAMtD;;;;;OAKG;IACH,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,MAAM;IAUnE;;;;;OAKG;IACH,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAIvE;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,WAAW;IAIxC;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,QAAQ;IAoBjE,SAAS,CAAC,gBAAgB,CAAC,cAAc,EAAE,oBAAoB,GAAG,2BAA2B;IAI7F;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,CACf,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,YAAY,EACjB,UAAU,CAAC,EAAE,OAAO,GACnB,YAAY;CAahB;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,GAAG,aAAa,UAAU,EAAE;IAEzD;;;;;OAKG;gBACe,WAAW,MAAM,cAAc,QAAQ,YAAY;CAiBxE,CAAC"}

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

@@ -1,37 +1,54 @@
-import { NextResponse, NextRequest } from 'next/server';
-import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
-import { SitecoreConfig } from '../config';
-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 = MiddlewareBaseConfig & SitecoreConfig['multisite'];
-/**
- * Middleware / handler for multisite support
- */
-export declare class MultisiteMiddleware extends MiddlewareBase {
-    protected config: MultisiteMiddlewareConfig;
-    /**
-     * @param {MultisiteMiddlewareConfig} [config] Multisite middleware config
-     */
-    constructor(config: MultisiteMiddlewareConfig);
-    handle: (req: NextRequest, res: NextResponse) => Promise<NextResponse>;
-    protected disabled(req: NextRequest, res: NextResponse): boolean | undefined;
-    /**
-     * Generates a site-specific rewrite path based on the provided pathname and site name.
-     * @param {string} pathname - The pathname to be rewritten.
-     * @param {string} siteName - The name of the site.
-     * @returns The rewritten path as a string.
-     */
-    protected getSiteRewrite(pathname: string, siteName: string): string;
-}
+import { NextResponse, NextRequest } from 'next/server';
+import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+import { SitecoreConfig } from '../config';
+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;
+};
+/**
+ * The interface for the MultisiteMiddleware configuration.
+ * @public
+ */
+export type MultisiteMiddlewareConfig = MiddlewareBaseConfig & SitecoreConfig['multisite'];
+/**
+ * Middleware / handler for multisite support
+ * @public
+ */
+export declare class MultisiteMiddleware extends MiddlewareBase {
+    protected config: MultisiteMiddlewareConfig;
+    /**
+     * @param {MultisiteMiddlewareConfig} [config] Multisite middleware config
+     */
+    constructor(config: MultisiteMiddlewareConfig);
+    handle: (req: NextRequest, res: NextResponse) => Promise<NextResponse>;
+    protected disabled(req: NextRequest, res: NextResponse): boolean | undefined;
+    /**
+     * Called when multisite is disabled. Override this method in subclasses to show router-specific warnings.
+     * @param {NextResponse} _res response
+     */
+    protected shouldWarnWhenDisabled(_res: NextResponse): void;
+    /**
+     * Determines if middleware should be skipped when multisite is disabled.
+     * Override in subclasses to provide router-specific behavior.
+     * @returns {boolean} true if middleware should be skipped when disabled
+     */
+    protected shouldSkipWhenDisabled(): boolean;
+    /**
+     * Generates a site-specific rewrite path based on the provided pathname and site name.
+     * @param {string} pathname - The pathname to be rewritten.
+     * @param {string} siteName - The name of the site.
+     * @returns The rewritten path as a string.
+     */
+    protected getSiteRewrite(pathname: string, siteName: string): string;
+}
+//# sourceMappingURL=multisite-middleware.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"multisite-middleware.d.ts","sourceRoot":"","sources":["../../src/middleware/multisite-middleware.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGxD,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAuB,MAAM,cAAc,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAG3C,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;CACjE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;AAE3F;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,cAAc;IAIzC,SAAS,CAAC,MAAM,EAAE,yBAAyB;IAHvD;;OAEG;gBACmB,MAAM,EAAE,yBAAyB;IAIvD,MAAM,GAAU,KAAK,WAAW,EAAE,KAAK,YAAY,KAAG,OAAO,CAAC,YAAY,CAAC,CA2FzE;IAEF,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS;IAK5E;;;OAGG;IAEH,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAI1D;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,IAAI,OAAO;IAI3C;;;;;OAKG;IACH,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;CAKrE"}