@sitecore-jss/sitecore-jss-nextjs 21.1.0-canary.99 → 22.0.0-canary.1

package/dist/esm/services/graphql-sitemap-service.js

@@ -7,13 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { GraphQLRequestClient } from '@sitecore-jss/sitecore-jss/graphql';
-import { debug } from '@sitecore-jss/sitecore-jss';
-import { getPersonalizedRewrite } from '@sitecore-jss/sitecore-jss/personalize';
-import { getSiteRewrite } from '@sitecore-jss/sitecore-jss/site';
+import { BaseGraphQLSitemapService, } from './base-graphql-sitemap-service';
 /** @private */
 export const languageError = 'The list of languages cannot be empty';
-export const sitesError = 'The list of sites cannot be empty';
+export const siteError = 'The service needs a site name';
 /**
  * @param {string} siteName to inject into error text
  * @private
@@ -21,103 +18,20 @@ export const sitesError = 'The list of sites cannot be empty';
 export function getSiteEmptyError(siteName) {
     return `Site "${siteName}" does not exist or site item tree is missing`;
 }
-const languageEmptyError = 'The language must be a non-empty string';
-/**
- * GQL query made dynamic based on schema differences between SXP and XM Cloud
- * @param {boolean} usesPersonalize flag to detrmine which variation of a query to run
- * @returns GraphQL query to fetch site paths with
- */
-const defaultQuery = (usesPersonalize) => /* GraphQL */ `
-query ${usesPersonalize ? 'PersonalizeSitemapQuery' : 'DefaultSitemapQuery'}(
-  $siteName: String!
-  $language: String!
-  $includedPaths: [String]
-  $excludedPaths: [String]
-  $pageSize: Int = 10
-  $after: String
-) {
-  site {
-    siteInfo(site: $siteName) {
-      routes(
-        language: $language
-        includedPaths: $includedPaths
-        excludedPaths: $excludedPaths
-        first: $pageSize
-        after: $after
-      ){
-        total
-        pageInfo {
-          endCursor
-          hasNext
-        }
-        results {
-          path: routePath
-          ${usesPersonalize
-    ? `
-              route {
-                personalization {
-                  variantIds
-                }
-              }`
-    : ''}
-        }
-      }
-    }
-  }
-}
-`;
 /**
  * Service that fetches the list of site pages using Sitecore's GraphQL API.
+ * Used to handle a single site
  * This list is used for SSG and Export functionality.
  * @mixes SearchQueryService<PageListQueryResult>
  */
-export class GraphQLSitemapService {
-    /**
-     * Gets the default query used for fetching the list of site pages
-     */
-    get query() {
-        return defaultQuery(this.options.includePersonalizedRoutes);
-    }
+export class GraphQLSitemapService extends BaseGraphQLSitemapService {
     /**
      * Creates an instance of graphQL sitemap service with the provided options
      * @param {GraphQLSitemapServiceConfig} options instance
      */
     constructor(options) {
+        super(options);
         this.options = options;
-        this.graphQLClient = this.getGraphQLClient();
-    }
-    /**
-     * Fetch sitemap which could be used for generation of static pages during `next export`.
-     * The `locale` parameter will be used in the item query, but since i18n is not supported,
-     * the output paths will not include a `language` property.
-     * @param {string} locale which application supports
-     * @returns an array of @see StaticPath objects
-     */
-    fetchExportSitemap(locale) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const formatPath = (path) => ({
-                params: {
-                    path,
-                },
-            });
-            return this.fetchSitemap([locale], formatPath);
-        });
-    }
-    /**
-     * Fetch sitemap which could be used for generation of static pages using SSG mode
-     * @param {string[]} locales locales which application supports
-     * @returns an array of @see StaticPath objects
-     */
-    fetchSSGSitemap(locales) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const formatPath = (path, locale) => ({
-                params: {
-                    path,
-                },
-                locale,
-            });
-            return this.fetchSitemap(locales, formatPath);
-        });
     }
     /**
      * Fetch a flat list of all pages that belong to the specificed site and have a
@@ -134,92 +48,12 @@ export class GraphQLSitemapService {
             if (!languages.length) {
                 throw new RangeError(languageError);
             }
-            // Get all sites
-            const sites = this.options.sites;
-            if (!sites || !sites.length) {
-                throw new RangeError(sitesError);
-            }
-            // Fetch paths for each site
-            for (let i = 0; i < sites.length; i++) {
-                const siteName = sites[i];
-                const multiSiteName = sites.length > 1 ? siteName : undefined;
-                // Fetch paths using all locales
-                yield Promise.all(languages.map((language) => __awaiter(this, void 0, void 0, function* () {
-                    if (language === '') {
-                        throw new RangeError(languageEmptyError);
-                    }
-                    debug.sitemap('fetching sitemap data for %s %s', language, siteName);
-                    const results = yield this.fetchLanguageSitePaths(language, siteName);
-                    const transformedPaths = yield this.transformLanguageSitePaths(results, formatStaticPath, language, multiSiteName);
-                    paths.push(...transformedPaths);
-                })));
+            const siteName = this.options.siteName;
+            if (!siteName) {
+                throw new RangeError(siteError);
             }
+            paths.push(...(yield this.getTranformedPaths(siteName, languages, formatStaticPath)));
             return [].concat(...paths);
         });
     }
-    transformLanguageSitePaths(sitePaths, formatStaticPath, language, multiSiteName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const formatPath = (path) => formatStaticPath(path.replace(/^\/|\/$/g, '').split('/'), language);
-            const aggregatedPaths = [];
-            sitePaths.forEach((item) => {
-                var _a, _b, _c, _d, _e, _f;
-                if (!item)
-                    return;
-                if (!multiSiteName) {
-                    aggregatedPaths.push(formatPath(item.path));
-                }
-                else {
-                    aggregatedPaths.push(formatPath(getSiteRewrite(item.path, { siteName: multiSiteName })));
-                }
-                // check for type safety's sake - personalize may be empty depending on query type
-                if ((_b = (_a = item.route) === null || _a === void 0 ? void 0 : _a.personalization) === null || _b === void 0 ? void 0 : _b.variantIds.length) {
-                    multiSiteName
-                        ? aggregatedPaths.push(...(((_d = (_c = item.route) === null || _c === void 0 ? void 0 : _c.personalization) === null || _d === void 0 ? void 0 : _d.variantIds.map((varId) => formatPath(getPersonalizedRewrite(getSiteRewrite(item.path, { siteName: multiSiteName }), {
-                            variantId: varId,
-                        })))) || {}))
-                        : aggregatedPaths.push(...(((_f = (_e = item.route) === null || _e === void 0 ? void 0 : _e.personalization) === null || _f === void 0 ? void 0 : _f.variantIds.map((varId) => formatPath(getPersonalizedRewrite(item.path, { variantId: varId })))) || {}));
-                }
-            });
-            return aggregatedPaths;
-        });
-    }
-    fetchLanguageSitePaths(language, siteName) {
-        var _a, _b, _c, _d;
-        return __awaiter(this, void 0, void 0, function* () {
-            const args = {
-                siteName: siteName,
-                language: language,
-                pageSize: this.options.pageSize,
-                includedPaths: this.options.includedPaths,
-                excludedPaths: this.options.excludedPaths,
-            };
-            let results = [];
-            let hasNext = true;
-            let after = '';
-            while (hasNext) {
-                const fetchResponse = yield this.graphQLClient.request(this.query, Object.assign(Object.assign({}, args), { after }));
-                if (!((_a = fetchResponse === null || fetchResponse === void 0 ? void 0 : fetchResponse.site) === null || _a === void 0 ? void 0 : _a.siteInfo)) {
-                    throw new RangeError(getSiteEmptyError(siteName));
-                }
-                else {
-                    results = results.concat((_b = fetchResponse.site.siteInfo.routes) === null || _b === void 0 ? void 0 : _b.results);
-                    hasNext = (_c = fetchResponse.site.siteInfo.routes) === null || _c === void 0 ? void 0 : _c.pageInfo.hasNext;
-                    after = (_d = fetchResponse.site.siteInfo.routes) === null || _d === void 0 ? void 0 : _d.pageInfo.endCursor;
-                }
-            }
-            return results;
-        });
-    }
-    /**
-     * 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
-     * want to use something else.
-     * @returns {GraphQLClient} implementation
-     */
-    getGraphQLClient() {
-        return new GraphQLRequestClient(this.options.endpoint, {
-            apiKey: this.options.apiKey,
-            debugger: debug.sitemap,
-        });
-    }
 }

package/dist/esm/services/mutisite-graphql-sitemap-service.js

@@ -0,0 +1,77 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { getSiteRewrite } from '@sitecore-jss/sitecore-jss/site';
+import { BaseGraphQLSitemapService, languageError, } from './base-graphql-sitemap-service';
+export const sitesError = 'The list of sites cannot be empty';
+/**
+ * Service that fetches the list of site pages using Sitecore's GraphQL API.
+ * Used to handle multiple sites
+ * This list is used for SSG and Export functionality.
+ * @mixes SearchQueryService<PageListQueryResult>
+ */
+export class MultisiteGraphQLSitemapService extends BaseGraphQLSitemapService {
+    /**
+     * Creates an instance of graphQL sitemap service with the provided options
+     * @param {MultisiteGraphQLSitemapServiceConfig} options instance
+     */
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
+    /**
+     * Fetch a flat list of all pages that belong to all the requested sites and have a
+     * version in the specified language(s).
+     * @param {string[]} languages Fetch pages that have versions in this language(s).
+     * @param {Function} formatStaticPath Function for transforming the raw search results into (@see StaticPath) types.
+     * @returns list of pages
+     * @throws {RangeError} if the list of languages is empty.
+     * @throws {RangeError} if the any of the languages is an empty string.
+     */
+    fetchSitemap(languages, formatStaticPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const paths = new Array();
+            if (!languages.length) {
+                throw new RangeError(languageError);
+            }
+            // Get all sites
+            const sites = this.options.sites;
+            if (!sites || !sites.length) {
+                throw new RangeError(sitesError);
+            }
+            // Fetch paths for each site
+            for (let i = 0; i < sites.length; i++) {
+                const siteName = sites[i];
+                // Fetch paths using all locales
+                paths.push(...(yield this.getTranformedPaths(siteName, languages, formatStaticPath)));
+            }
+            return [].concat(...paths);
+        });
+    }
+    /**
+     * Fetch and return site paths for multisite implementation, with prefixes included
+     * @param {string} language path language
+     * @param {string} siteName site name
+     * @returns modified paths
+     */
+    fetchLanguageSitePaths(language, siteName) {
+        const _super = Object.create(null, {
+            fetchLanguageSitePaths: { get: () => super.fetchLanguageSitePaths }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield _super.fetchLanguageSitePaths.call(this, language, siteName);
+            results.forEach((item) => {
+                if (item) {
+                    item.path = getSiteRewrite(item.path, { siteName: siteName });
+                }
+            });
+            return results;
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-nextjs",
-  "version": "21.1.0-canary.99",
+  "version": "22.0.0-canary.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -70,9 +70,9 @@
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.1.0-canary.99",
-    "@sitecore-jss/sitecore-jss-dev-tools": "^21.1.0-canary.99",
-    "@sitecore-jss/sitecore-jss-react": "^21.1.0-canary.99",
+    "@sitecore-jss/sitecore-jss": "^22.0.0-canary.1",
+    "@sitecore-jss/sitecore-jss-dev-tools": "^22.0.0-canary.1",
+    "@sitecore-jss/sitecore-jss-react": "^22.0.0-canary.1",
     "node-html-parser": "^6.1.4",
     "prop-types": "^15.8.1",
     "regex-parser": "^2.2.11",
@@ -80,7 +80,7 @@
   },
   "description": "",
   "types": "types/index.d.ts",
-  "gitHead": "5b1755d4be55645818169d278dd204543d1351d8",
+  "gitHead": "8f7ef1bee3508c70baae3c3b583908395609be52",
   "files": [
     "dist",
     "types",

package/types/index.d.ts

@@ -1,16 +1,17 @@
 export { constants, HttpDataFetcher, HttpResponse, AxiosResponse, AxiosDataFetcher, AxiosDataFetcherConfig, NativeDataFetcher, NativeDataFetcherConfig, enableDebug, } from '@sitecore-jss/sitecore-jss';
-export { isEditorActive, resetEditorChromes, resolveUrl } from '@sitecore-jss/sitecore-jss/utils';
+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 { 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, } from '@sitecore-jss/sitecore-jss/personalize';
+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 { ComponentPropsService } from './services/component-props-service';
 export { DisconnectedSitemapService } from './services/disconnected-sitemap-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-jss/sitecore-jss/site';
 export { StaticPath } from './services/graphql-sitemap-service';
 export { ComponentPropsReactContext, ComponentPropsContextProps, ComponentPropsContext, useComponentProps, } from './components/ComponentPropsContext';
@@ -20,4 +21,4 @@ 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, FEaaSComponent, FEaaSComponentProps, File, FileField, RichTextField, VisitorIdentification, PlaceholderComponentProps, SitecoreContext, SitecoreContextState, SitecoreContextValue, SitecoreContextReactContext, withSitecoreContext, useSitecoreContext, withEditorChromes, withPlaceholder, withDatasourceCheck, ImageSizeParameters, ComponentConsumerProps, WithSitecoreContextOptions, WithSitecoreContextProps, } from '@sitecore-jss/sitecore-jss-react';
+export { ComponentFactory, Image, ImageField, ImageFieldValue, ImageProps, LinkField, LinkFieldValue, Text, TextField, DateField, EditFrame, FEaaSComponent, FEaaSComponentProps, 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

@@ -2,3 +2,4 @@ export { RedirectsMiddleware, RedirectsMiddlewareConfig } from './redirects-midd
 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

@@ -0,0 +1,68 @@
+import { SiteInfo, SiteResolver } from '@sitecore-jss/sitecore-jss/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 defaultHostname: string;
+    constructor(config: MiddlewareBaseConfig);
+    /**
+     * Determines if mode is preview
+     * @param {NextRequest} req request
+     * @returns {boolean} is preview
+     */
+    protected isPreview(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;
+}

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

@@ -1,23 +1,6 @@
 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;
+import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
+export type MultisiteMiddlewareConfig = Omit<MiddlewareBaseConfig, 'disabled'> & {
     /**
      * Function used to determine if site should be resolved from sc_site cookie when present
      */
@@ -26,9 +9,8 @@ export type MultisiteMiddlewareConfig = {
 /**
  * Middleware / handler for multisite support
  */
-export declare class MultisiteMiddleware {
+export declare class MultisiteMiddleware extends MiddlewareBase {
     protected config: MultisiteMiddlewareConfig;
-    private defaultHostname;
     /**
      * @param {MultisiteMiddlewareConfig} [config] Multisite middleware config
      */
@@ -38,9 +20,5 @@ export declare class MultisiteMiddleware {
      * @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,15 +1,8 @@
 import { NextResponse, NextRequest } from 'next/server';
 import { GraphQLPersonalizeServiceConfig, CdpServiceConfig, ExperienceParams } from '@sitecore-jss/sitecore-jss/personalize';
+import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
 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.
-     * 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 personalization
-     */
-    excludeRoute?: (pathname: string) => boolean;
+export type PersonalizeMiddlewareConfig = MiddlewareBaseConfig & {
     /**
      * Configuration for your Sitecore Experience Edge endpoint
      */
@@ -19,35 +12,20 @@ export type PersonalizeMiddlewareConfig = {
      */
     cdpConfig: Omit<CdpServiceConfig, 'dataFetcherResolver'>;
     /**
-     * function used to resolve correct point of sale for current locale during a request
-     * @param {string} locale locale at the time of request
-     */
-    getPointOfSale: (locale: string) => string;
-    /**
-     * 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
+     * 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
      */
-    defaultHostname?: string;
+    getPointOfSale?: (site: SiteInfo, language: string) => string;
 };
 /**
  * Middleware / handler to support Sitecore Personalize
  */
-export declare class PersonalizeMiddleware {
+export declare class PersonalizeMiddleware extends MiddlewareBase {
     protected config: PersonalizeMiddlewareConfig;
     private personalizeService;
     private cdpService;
-    private defaultHostname;
     /**
      * @param {PersonalizeMiddlewareConfig} [config] Personalize middleware config
      */
@@ -61,16 +39,5 @@ export declare class PersonalizeMiddleware {
     protected getBrowserId(req: NextRequest): string | undefined;
     protected setBrowserId(res: NextResponse, browserId: string): void;
     protected getExperienceParams(req: NextRequest): ExperienceParams;
-    protected excludeRoute(pathname: string): boolean;
-    protected isPreview(req: NextRequest): string | 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;
-    };
     private handler;
 }

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

@@ -1,44 +1,24 @@
 import { NextResponse, NextRequest } from 'next/server';
-import { GraphQLRedirectsServiceConfig, SiteInfo } from '@sitecore-jss/sitecore-jss/site';
+import { GraphQLRedirectsServiceConfig } from '@sitecore-jss/sitecore-jss/site';
+import { MiddlewareBase, MiddlewareBaseConfig } from './middleware';
 /**
  * extended RedirectsMiddlewareConfig config type for RedirectsMiddleware
  */
-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;
+export type RedirectsMiddlewareConfig = Omit<GraphQLRedirectsServiceConfig, 'fetch'> & MiddlewareBaseConfig & {
     /**
-     * fallback hostname in case `host` header is not present
-     * @default localhost
+     * These are all the locales you support in your application.
+     * These should match those in your next.config.js (i18n.locales).
      */
-    defaultHostname?: string;
+    locales: 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 {
+export declare class RedirectsMiddleware extends MiddlewareBase {
     protected config: RedirectsMiddlewareConfig;
     private redirectsService;
     private locales;
-    private defaultHostname;
     /**
      * @param {RedirectsMiddlewareConfig} [config] redirects middleware config
      */
@@ -48,8 +28,6 @@ export declare class RedirectsMiddleware {
      * @returns route handler
      */
     getHandler(): (req: NextRequest, res?: NextResponse) => Promise<NextResponse>;
-    protected excludeRoute(pathname: string): boolean;
-    protected getHostname(req: NextRequest): string;
     private handler;
     /**
      * Method returns RedirectInfo when matches