@akinon/next 2.0.135-rc.0 → 2.0.135

package/middlewares/default.ts

@@ -18,11 +18,7 @@ import {
   withBfcacheHeaders
 } from '.';
 import { getCsrfCookieFlags, urlLocaleMatcherRegex } from '../utils';
-import {
-  getPzSegmentsConfig,
-  encodePzValue,
-  isLegacyMode
-} from '../utils/pz-segments';
+import { getPzSegmentsConfig, encodePzValue, isLegacyMode } from '../utils/pz-segments';
 import withCurrency from './currency';
 import withLocale from './locale';
 import logger from '../utils/log';
@@ -30,6 +26,10 @@ import { user } from '../data/urls';
 import { getUrlPathWithLocale } from '../utils/localization';
 import getRootHostname from '../utils/get-root-hostname';
 import { LocaleUrlStrategy } from '../localization';
+import {
+  THEME_EDITOR_HEALTH_PATH,
+  themeEditorHealthResponse
+} from '../utils/theme-editor-health';
 
 const POST_CHECKOUT_COOKIE_MAX_AGE_MS = 1000 * 60 * 30; // 30 minutes
 
@@ -91,6 +91,13 @@ const withPzDefault =
       return NextResponse.json({ status: 'ok' });
     }
 
+    // Whether the theme editor can drive this storefront's preview — asked
+    // by the editor before it relies on the preview. Answered here, ahead of
+    // locale and route handling, because every brand's matcher skips /api.
+    if (url.pathname === THEME_EDITOR_HEALTH_PATH) {
+      return themeEditorHealthResponse(req);
+    }
+
     if (url.pathname.startsWith('/metrics')) {
       return new NextResponse(null, { status: 200 });
     }
@@ -336,98 +343,98 @@ const withPzDefault =
                                     req: PzNextRequest,
                                     event: NextFetchEvent
                                   ) => {
-                                    let middlewareResult: NextResponse | void =
-                                      NextResponse.next();
-
-                                    try {
-                                      const { locale, prettyUrl, currency } =
-                                        req.middlewareParams.rewrites;
-                                      const { defaultLocaleValue } =
-                                        Settings.localization;
-                                      const url = req.nextUrl.clone();
-                                      const pathnameWithoutLocale =
-                                        url.pathname.replace(
-                                          urlLocaleMatcherRegex,
-                                          ''
-                                        );
-
-                                      middlewareResult = (await middleware(
-                                        req,
-                                        event
-                                      )) as NextResponse | void;
-
-                                      let customRewriteUrlDiff = '';
+                                  let middlewareResult: NextResponse | void =
+                                    NextResponse.next();
+
+                                  try {
+                                    const { locale, prettyUrl, currency } =
+                                      req.middlewareParams.rewrites;
+                                    const { defaultLocaleValue } =
+                                      Settings.localization;
+                                    const url = req.nextUrl.clone();
+                                    const pathnameWithoutLocale =
+                                      url.pathname.replace(
+                                        urlLocaleMatcherRegex,
+                                        ''
+                                      );
 
-                                      if (
-                                        middlewareResult instanceof
-                                          NextResponse &&
-                                        middlewareResult.headers.get(
-                                          'pz-override-response'
-                                        ) &&
+                                    middlewareResult = (await middleware(
+                                      req,
+                                      event
+                                    )) as NextResponse | void;
+
+                                    let customRewriteUrlDiff = '';
+
+                                    if (
+                                      middlewareResult instanceof
+                                        NextResponse &&
+                                      middlewareResult.headers.get(
+                                        'pz-override-response'
+                                      ) &&
+                                      middlewareResult.headers.get(
+                                        'x-middleware-rewrite'
+                                      )
+                                    ) {
+                                      const rewriteUrl = new URL(
                                         middlewareResult.headers.get(
                                           'x-middleware-rewrite'
                                         )
-                                      ) {
-                                        const rewriteUrl = new URL(
-                                          middlewareResult.headers.get(
-                                            'x-middleware-rewrite'
-                                          )
+                                      );
+                                      const originalUrl = new URL(req.url);
+                                      customRewriteUrlDiff =
+                                        rewriteUrl.pathname.replace(
+                                          originalUrl.pathname,
+                                          ''
                                         );
-                                        const originalUrl = new URL(req.url);
-                                        customRewriteUrlDiff =
-                                          rewriteUrl.pathname.replace(
-                                            originalUrl.pathname,
-                                            ''
-                                          );
-                                      }
+                                    }
 
-                                      let ordersPrefix: string;
+                                    let ordersPrefix: string;
 
-                                      if (isLegacyMode(Settings)) {
-                                        url.basePath = `/${commerceUrl}`;
-                                        url.pathname = `/${
-                                          locale.length ? `${locale}/` : ''
-                                        }${currency}/${customRewriteUrlDiff}${
+                                    if (isLegacyMode(Settings)) {
+                                      url.basePath = `/${commerceUrl}`;
+                                      url.pathname =
+                                        `/${locale.length ? `${locale}/` : ''}${currency}/${customRewriteUrlDiff}${
                                           prettyUrl ?? pathnameWithoutLocale
                                         }`.replace(/\/+/g, '/');
-                                        ordersPrefix = `/${currency}/orders`;
-                                      } else {
-                                        const pzConfig =
-                                          getPzSegmentsConfig(Settings);
-                                        const fullUrlPath =
-                                          `${customRewriteUrlDiff}${
-                                            prettyUrl ?? pathnameWithoutLocale
-                                          }`.replace(/\/+/g, '/');
-                                        const fullUrl = `${req.nextUrl.origin}${fullUrlPath}`;
-                                        const resolvedLocale =
-                                          locale?.length > 0
-                                            ? locale
-                                            : Settings.localization
-                                                .defaultLocaleValue;
-                                        const resolveContext = {
-                                          req,
-                                          event,
-                                          url,
-                                          locale: resolvedLocale,
-                                          currency,
-                                          pathname: pathnameWithoutLocale
-                                        };
-                                        const customSegments =
-                                          pzConfig.segments.filter(
-                                            (seg) =>
-                                              seg.name !== 'locale' &&
-                                              seg.name !== 'currency' &&
-                                              seg.name !== 'url'
-                                          );
-                                        const segmentValues: Record<
-                                          string,
-                                          string
-                                        > = {
-                                          locale: resolvedLocale,
-                                          currency,
-                                          url: encodeURIComponent(fullUrl),
-                                          ...Object.fromEntries(
-                                            customSegments.map((seg) => [
+                                      ordersPrefix = `/${currency}/orders`;
+                                    } else {
+                                      const pzConfig =
+                                        getPzSegmentsConfig(Settings);
+                                      const fullUrlPath =
+                                        `${customRewriteUrlDiff}${
+                                          prettyUrl ?? pathnameWithoutLocale
+                                        }`.replace(/\/+/g, '/');
+                                      const fullUrl = `${req.nextUrl.origin}${fullUrlPath}`;
+                                      const resolvedLocale =
+                                        locale?.length > 0
+                                          ? locale
+                                          : Settings.localization
+                                              .defaultLocaleValue;
+                                      const resolveContext = {
+                                        req,
+                                        event,
+                                        url,
+                                        locale: resolvedLocale,
+                                        currency,
+                                        pathname: pathnameWithoutLocale
+                                      };
+                                      const customSegments = pzConfig.segments
+                                        .filter(
+                                          (seg) =>
+                                            seg.name !== 'locale' &&
+                                            seg.name !== 'currency' &&
+                                            seg.name !== 'url'
+                                        );
+                                      const segmentValues: Record<
+                                        string,
+                                        string
+                                      > = {
+                                        locale: resolvedLocale,
+                                        currency,
+                                        url: encodeURIComponent(fullUrl),
+                                        ...Object.fromEntries(
+                                          customSegments
+                                            .map((seg) => [
                                               seg.name,
                                               req.middlewareParams.rewrites[
                                                 seg.name
@@ -436,121 +443,105 @@ const withPzDefault =
                                                   ? seg.resolve(resolveContext)
                                                   : '')
                                             ])
-                                          )
-                                        };
+                                        )
+                                      };
+
+                                      const pzValue = encodePzValue(
+                                        segmentValues,
+                                        pzConfig
+                                      );
 
-                                        const pzValue = encodePzValue(
-                                          segmentValues,
-                                          pzConfig
+                                      url.pathname =
+                                        `/${pzValue}/${fullUrlPath}`.replace(
+                                          /\/+/g,
+                                          '/'
                                         );
+                                      ordersPrefix = `/${pzValue}/orders`;
+                                    }
 
-                                        url.pathname =
-                                          `/${pzValue}/${fullUrlPath}`.replace(
-                                            /\/+/g,
-                                            '/'
-                                          );
-                                        ordersPrefix = `/${pzValue}/orders`;
-                                      }
+                                    if (
+                                      Settings.usePrettyUrlRoute &&
+                                      url.searchParams.toString().length > 0 &&
+                                      !Object.entries(ROUTES).find(
+                                        ([, value]) =>
+                                          new RegExp(`^${value}/?$`).test(
+                                            pathnameWithoutLocale
+                                          )
+                                      )
+                                    ) {
+                                      url.pathname =
+                                        url.pathname +
+                                        (/\/$/.test(url.pathname) ? '' : '/') +
+                                        `searchparams|${encodeURIComponent(
+                                          url.searchParams.toString()
+                                        )}`;
+                                    }
+
+                                    Settings.rewrites.forEach((rewrite) => {
+                                      url.pathname = url.pathname.replace(
+                                        rewrite.source,
+                                        rewrite.destination
+                                      );
+                                    });
 
+                                    // if middleware.ts has a return value for current url
+                                    if (
+                                      middlewareResult instanceof NextResponse
+                                    ) {
+                                      // pz-override-response header is used to prevent 404 page for custom responses.
                                       if (
-                                        Settings.usePrettyUrlRoute &&
-                                        url.searchParams.toString().length >
-                                          0 &&
-                                        !Object.entries(ROUTES).find(
-                                          ([, value]) =>
-                                            new RegExp(`^${value}/?$`).test(
-                                              pathnameWithoutLocale
-                                            )
-                                        )
+                                        middlewareResult.headers.get(
+                                          'pz-override-response'
+                                        ) !== 'true'
                                       ) {
-                                        url.pathname =
-                                          url.pathname +
-                                          (/\/$/.test(url.pathname)
-                                            ? ''
-                                            : '/') +
-                                          `searchparams|${encodeURIComponent(
-                                            url.searchParams.toString()
-                                          )}`;
-                                      }
-
-                                      Settings.rewrites.forEach((rewrite) => {
-                                        url.pathname = url.pathname.replace(
-                                          rewrite.source,
-                                          rewrite.destination
+                                        middlewareResult.headers.set(
+                                          'x-middleware-rewrite',
+                                          url.href
                                         );
-                                      });
-
-                                      // if middleware.ts has a return value for current url
-                                      if (
-                                        middlewareResult instanceof NextResponse
+                                      } else if (
+                                        middlewareResult.headers.get(
+                                          'x-middleware-rewrite'
+                                        ) &&
+                                        middlewareResult.headers.get(
+                                          'pz-override-response'
+                                        ) === 'true'
                                       ) {
-                                        // pz-override-response header is used to prevent 404 page for custom responses.
-                                        if (
-                                          middlewareResult.headers.get(
-                                            'pz-override-response'
-                                          ) !== 'true'
-                                        ) {
-                                          middlewareResult.headers.set(
-                                            'x-middleware-rewrite',
-                                            url.href
-                                          );
-                                        } else if (
-                                          middlewareResult.headers.get(
-                                            'x-middleware-rewrite'
-                                          ) &&
-                                          middlewareResult.headers.get(
-                                            'pz-override-response'
-                                          ) === 'true'
-                                        ) {
-                                          middlewareResult =
-                                            NextResponse.rewrite(url);
-                                        }
-                                      } else {
-                                        // if middleware.ts doesn't have a return value.
-                                        // e.g. NextResponse.next() doesn't exist in middleware.ts
-
                                         middlewareResult =
                                           NextResponse.rewrite(url);
                                       }
+                                    } else {
+                                      // if middleware.ts doesn't have a return value.
+                                      // e.g. NextResponse.next() doesn't exist in middleware.ts
 
-                                      const { localeUrlStrategy } =
-                                        Settings.localization;
-
-                                      const fallbackHost =
-                                        req.headers.get('x-forwarded-host') ||
-                                        req.headers.get('host');
-                                      const hostname =
-                                        process.env.NEXT_PUBLIC_URL ||
-                                        `https://${fallbackHost}`;
-                                      const rootHostname =
-                                        localeUrlStrategy ===
-                                        LocaleUrlStrategy.Subdomain
-                                          ? getRootHostname(hostname)
-                                          : null;
-
-                                      if (
-                                        !url.pathname.startsWith(ordersPrefix)
-                                      ) {
-                                        middlewareResult.cookies.set(
-                                          'pz-locale',
-                                          locale?.length > 0
-                                            ? locale
-                                            : defaultLocaleValue,
-                                          {
-                                            domain: rootHostname,
-                                            sameSite: 'none',
-                                            secure: true,
-                                            expires: new Date(
-                                              Date.now() +
-                                                1000 * 60 * 60 * 24 * 7
-                                            ) // 7 days
-                                          }
-                                        );
-                                      }
+                                      middlewareResult =
+                                        NextResponse.rewrite(url);
+                                    }
 
+                                    const { localeUrlStrategy } =
+                                      Settings.localization;
+
+                                    const fallbackHost =
+                                      req.headers.get('x-forwarded-host') ||
+                                      req.headers.get('host');
+                                    const hostname =
+                                      process.env.NEXT_PUBLIC_URL ||
+                                      `https://${fallbackHost}`;
+                                    const rootHostname =
+                                      localeUrlStrategy ===
+                                      LocaleUrlStrategy.Subdomain
+                                        ? getRootHostname(hostname)
+                                        : null;
+
+                                    if (
+                                      !url.pathname.startsWith(
+                                        ordersPrefix
+                                      )
+                                    ) {
                                       middlewareResult.cookies.set(
-                                        'pz-currency',
-                                        currency,
+                                        'pz-locale',
+                                        locale?.length > 0
+                                          ? locale
+                                          : defaultLocaleValue,
                                         {
                                           domain: rootHostname,
                                           sameSite: 'none',
@@ -560,89 +551,102 @@ const withPzDefault =
                                           ) // 7 days
                                         }
                                       );
+                                    }
 
-                                      if (
-                                        req.cookies.get('pz-locale') &&
-                                        req.cookies.get('pz-locale').value !==
-                                          locale
-                                      ) {
-                                        logger.debug('Locale changed', {
-                                          locale,
-                                          oldLocale:
-                                            req.cookies.get('pz-locale')?.value,
-                                          ip
-                                        });
+                                    middlewareResult.cookies.set(
+                                      'pz-currency',
+                                      currency,
+                                      {
+                                        domain: rootHostname,
+                                        sameSite: 'none',
+                                        secure: true,
+                                        expires: new Date(
+                                          Date.now() + 1000 * 60 * 60 * 24 * 7
+                                        ) // 7 days
                                       }
+                                    );
+
+                                    if (
+                                      req.cookies.get('pz-locale') &&
+                                      req.cookies.get('pz-locale').value !==
+                                        locale
+                                    ) {
+                                      logger.debug('Locale changed', {
+                                        locale,
+                                        oldLocale:
+                                          req.cookies.get('pz-locale')?.value,
+                                        ip
+                                      });
+                                    }
 
-                                      middlewareResult.headers.set(
-                                        'pz-url',
-                                        req.nextUrl.toString()
+                                    middlewareResult.headers.set(
+                                      'pz-url',
+                                      req.nextUrl.toString()
+                                    );
+
+                                    if (req.cookies.get('pz-set-currency')) {
+                                      middlewareResult.cookies.delete(
+                                        'pz-set-currency'
                                       );
+                                    }
 
-                                      if (req.cookies.get('pz-set-currency')) {
+                                    if (
+                                      req.cookies.get('pz-post-checkout-flow')
+                                    ) {
+                                      if (
+                                        pathnameWithoutLocale.startsWith(
+                                          '/orders/completed/'
+                                        ) ||
+                                        pathnameWithoutLocale.startsWith(
+                                          '/basket'
+                                        )
+                                      ) {
                                         middlewareResult.cookies.delete(
-                                          'pz-set-currency'
+                                          'pz-post-checkout-flow'
                                         );
                                       }
+                                    }
 
-                                      if (
-                                        req.cookies.get('pz-post-checkout-flow')
-                                      ) {
-                                        if (
-                                          pathnameWithoutLocale.startsWith(
-                                            '/orders/completed/'
-                                          ) ||
-                                          pathnameWithoutLocale.startsWith(
-                                            '/basket'
-                                          )
-                                        ) {
-                                          middlewareResult.cookies.delete(
-                                            'pz-post-checkout-flow'
-                                          );
-                                        }
-                                      }
+                                    if (process.env.ACC_APP_VERSION) {
+                                      middlewareResult.headers.set(
+                                        'acc-app-version',
+                                        process.env.ACC_APP_VERSION
+                                      );
+                                    }
 
-                                      if (process.env.ACC_APP_VERSION) {
-                                        middlewareResult.headers.set(
-                                          'acc-app-version',
-                                          process.env.ACC_APP_VERSION
-                                        );
-                                      }
+                                    // Set CSRF token if not set
+                                    try {
+                                      const url = `${Settings.commerceUrl}${user.csrfToken}`;
 
-                                      // Set CSRF token if not set
-                                      try {
-                                        const url = `${Settings.commerceUrl}${user.csrfToken}`;
-
-                                        if (!req.cookies.get('csrftoken')) {
-                                          const { csrf_token } = await (
-                                            await fetch(url)
-                                          ).json();
-                                          middlewareResult.cookies.set(
-                                            'csrftoken',
-                                            csrf_token,
-                                            {
-                                              path: '/',
-                                              domain: rootHostname,
-                                              ...getCsrfCookieFlags()
-                                            }
-                                          );
-                                        }
-                                      } catch (error) {
-                                        logger.error('CSRF Error', {
-                                          error,
-                                          ip
-                                        });
+                                      if (!req.cookies.get('csrftoken')) {
+                                        const { csrf_token } = await (
+                                          await fetch(url)
+                                        ).json();
+                                        middlewareResult.cookies.set(
+                                          'csrftoken',
+                                          csrf_token,
+                                          {
+                                            path: '/',
+                                            domain: rootHostname,
+                                            ...getCsrfCookieFlags()
+                                          }
+                                        );
                                       }
                                     } catch (error) {
-                                      logger.error('withPzDefault Error', {
+                                      logger.error('CSRF Error', {
                                         error,
                                         ip
                                       });
                                     }
-
-                                    return middlewareResult;
+                                  } catch (error) {
+                                    logger.error('withPzDefault Error', {
+                                      error,
+                                      ip
+                                    });
                                   }
-                                )
+
+                                  return middlewareResult;
+                                })
                               )
                             )
                           )

package/middlewares/pretty-url.ts

@@ -86,9 +86,7 @@ const withPrettyUrl =
     const matchedLanguagePrefix = url.pathname.match(
       urlLocaleMatcherRegex
     )?.[0];
-    const prettyUrlPathname = matchedLanguagePrefix
-      ? url.pathname.replace(matchedLanguagePrefix, '')
-      : url.pathname;
+    const prettyUrlPathname = url.pathname.replace(matchedLanguagePrefix, '');
     const isValidPrettyUrlPath = (pathname: string) => {
       return (
         new RegExp(/^\/[a-zA-Z0-9/]+(?:-[a-zA-Z0-9/]+)*$/).test(pathname) &&

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "2.0.135-rc.0",
+  "version": "2.0.135",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -36,7 +36,7 @@
     "set-cookie-parser": "2.6.0"
   },
   "devDependencies": {
-    "@akinon/eslint-plugin-projectzero": "2.0.135-rc.0",
+    "@akinon/eslint-plugin-projectzero": "2.0.135",
     "@babel/core": "7.26.10",
     "@babel/preset-env": "7.26.9",
     "@babel/preset-typescript": "7.27.0",

package/plugins.d.ts

@@ -37,16 +37,6 @@ declare module '@akinon/pz-cybersource-uc/src/redux/middleware' {
   export default middleware as any;
 }
 
-declare module '@akinon/pz-apple-pay' {}
-
-declare module '@akinon/pz-similar-products' {
-  export const SimilarProductsModal: any;
-  export const SimilarProductsFilterSidebar: any;
-  export const SimilarProductsResultsGrid: any;
-  export const SimilarProductsPlugin: any;
-  export const SimilarProductsButtonPlugin: any;
-}
-
 declare module '@akinon/pz-cybersource-uc/src/redux/reducer' {
   export default reducer as any;
 }