@akinon/next 1.118.0 → 1.119.0-rc.1

package/data/urls.ts

@@ -183,7 +183,11 @@ export const product = {
   breadcrumbUrl: (menuitemmodel: string) =>
     `/menus/generate_breadcrumb/?item=${menuitemmodel}&generator_name=menu_item`,
   bundleProduct: (productPk: string, queryString: string) =>
-    `/bundle-product/${productPk}/?${queryString}`
+    `/bundle-product/${productPk}/?${queryString}`,
+  similarProducts: (params?: string) =>
+    `/similar-products${params ? `?${params}` : ''}`,
+  similarProductsList: (params?: string) =>
+    `/similar-product-list${params ? `?${params}` : ''}`
 };
 
 export const wishlist = {

package/lib/cache-handler.mjs

@@ -364,11 +364,17 @@ CacheHandler.onCreation(async () => {
     };
   }
 
-  const redisHandler = createRedisHandler({
+  const redisOptions = {
     client,
     timeoutMs: CACHE_CONFIG.redis.timeoutMs,
     keyExpirationStrategy: 'EXPIREAT'
-  });
+  };
+
+  if (process.env.CACHE_PASSWORD) {
+    redisOptions.password = process.env.CACHE_PASSWORD;
+  }
+
+  const redisHandler = createRedisHandler(redisOptions);
 
   const localHandler = createLruHandler(CACHE_CONFIG.lru);
 

package/lib/cache.ts

@@ -155,9 +155,14 @@ export class Cache {
           process.env.CACHE_PORT
         }/${process.env.CACHE_BUCKET ?? '0'}`;
 
-        const client: RedisClientType = createClient({
-          url: redisUrl
-        });
+        const options = {
+          url: redisUrl,
+          ...(process.env.CACHE_PASSWORD && {
+            password: process.env.CACHE_PASSWORD
+          })
+        };
+
+        const client: RedisClientType = createClient(options);
 
         client.on('error', (error) => {
           logger.error('Redis client error', { redisUrl, error });

package/middlewares/bfcache-headers.ts

@@ -0,0 +1,18 @@
+import { NextMiddleware } from 'next/server';
+
+const withBfcacheHeaders = (middleware: NextMiddleware): NextMiddleware => {
+  return async (req, event) => {
+    const response = await middleware(req, event);
+
+    if (process.env.BF_CACHE === 'true' && response) {
+      response.headers.set(
+        'Cache-Control',
+        'private, no-cache, max-age=0, must-revalidate'
+      );
+    }
+
+    return response;
+  };
+};
+
+export default withBfcacheHeaders;

package/middlewares/complete-gpay.ts

@@ -4,6 +4,7 @@ import { Buffer } from 'buffer';
 import logger from '../utils/log';
 import { getUrlPathWithLocale } from '../utils/localization';
 import { PzNextRequest } from '.';
+import { getCheckoutPath } from '../utils';
 
 const streamToString = async (stream: ReadableStream<Uint8Array> | null) => {
   if (stream) {
@@ -40,7 +41,8 @@ const withCompleteGpay =
       return middleware(req, event);
     }
 
-    const requestUrl = `${Settings.commerceUrl}/orders/checkout/${url.search}`;
+    const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+    const requestUrl = `${Settings.commerceUrl}${getCheckoutPath(isPostCheckout)}${url.search}`;
     const requestHeaders = {
       'X-Requested-With': 'XMLHttpRequest',
       'Content-Type': 'application/x-www-form-urlencoded',
@@ -108,10 +110,9 @@ const withCompleteGpay =
         });
 
         // Add error cookie
-        errorResponse.headers.append(
-          'Set-Cookie',
-          `pz-pos-error=${JSON.stringify(errors)}; path=/;`
-        );
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
 
         return errorResponse;
       }

package/middlewares/complete-masterpass.ts

@@ -5,6 +5,7 @@ import logger from '../utils/log';
 import { getUrlPathWithLocale } from '../utils/localization';
 import { PzNextRequest } from '.';
 import { ServerVariables } from '../utils/server-variables';
+import { getCheckoutPath } from '../utils';
 
 const streamToString = async (stream: ReadableStream<Uint8Array> | null) => {
   if (stream) {
@@ -41,7 +42,8 @@ const withCompleteMasterpass =
       return middleware(req, event);
     }
 
-    const requestUrl = `${Settings.commerceUrl}/orders/checkout/${url.search}`;
+    const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+    const requestUrl = `${Settings.commerceUrl}${getCheckoutPath(isPostCheckout)}${url.search}`;
     const requestHeaders = {
       'X-Requested-With': 'XMLHttpRequest',
       'Content-Type': 'application/x-www-form-urlencoded',
@@ -109,10 +111,9 @@ const withCompleteMasterpass =
         });
 
         // Add error cookie
-        errorResponse.headers.append(
-          'Set-Cookie',
-          `pz-pos-error=${JSON.stringify(errors)}; path=/;`
-        );
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
 
         return errorResponse;
       }

package/middlewares/complete-wallet.ts

@@ -4,6 +4,7 @@ import { Buffer } from 'buffer';
 import logger from '../utils/log';
 import { getUrlPathWithLocale } from '../utils/localization';
 import { PzNextRequest } from '.';
+import { getCheckoutPath } from '../utils';
 
 const streamToString = async (stream: ReadableStream<Uint8Array> | null) => {
   if (stream) {
@@ -39,7 +40,8 @@ const withCompleteWallet =
       return middleware(req, event);
     }
 
-    const requestUrl = `${Settings.commerceUrl}/orders/checkout/${url.search}`;
+    const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+    const requestUrl = `${Settings.commerceUrl}${getCheckoutPath(isPostCheckout)}${url.search}`;
     const requestHeaders = {
       'X-Requested-With': 'XMLHttpRequest',
       'Content-Type': 'application/x-www-form-urlencoded',
@@ -105,10 +107,9 @@ const withCompleteWallet =
         });
 
         // Add error cookie
-        errorResponse.headers.append(
-          'Set-Cookie',
-          `pz-pos-error=${JSON.stringify(errors)}; path=/;`
-        );
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
 
         return errorResponse;
       }

package/middlewares/default.ts

@@ -14,7 +14,8 @@ import {
   withUrlRedirection,
   withCompleteWallet,
   withWalletCompleteRedirection,
-  withMasterpassRestCallback
+  withMasterpassRestCallback,
+  withBfcacheHeaders
 } from '.';
 import { urlLocaleMatcherRegex } from '../utils';
 import withCurrency from './currency';
@@ -25,6 +26,8 @@ import { getUrlPathWithLocale } from '../utils/localization';
 import getRootHostname from '../utils/get-root-hostname';
 import { LocaleUrlStrategy } from '../localization';
 
+const POST_CHECKOUT_COOKIE_MAX_AGE_MS = 1000 * 60 * 30; // 30 minutes
+
 const withPzDefault =
   (middleware: NextMiddleware) =>
   async (req: PzNextRequest, event: NextFetchEvent) => {
@@ -101,6 +104,7 @@ const withPzDefault =
     if (
       req.nextUrl.pathname.includes('/orders/hooks/') ||
       req.nextUrl.pathname.includes('/orders/checkout-with-token/') ||
+      req.nextUrl.pathname.includes('/orders/post-checkout-redirect/') ||
       req.nextUrl.pathname.includes('/hooks/cash_register/complete/') ||
       req.nextUrl.pathname.includes('/hooks/cash_register/pre_order/')
     ) {
@@ -128,8 +132,13 @@ const withPzDefault =
     }
 
     if (req.nextUrl.pathname.startsWith('/orders/redirection/')) {
+      const queryString = searchParams.toString();
       return NextResponse.rewrite(
-        new URL(`${encodeURI(Settings.commerceUrl)}/orders/redirection/`)
+        new URL(
+          `${encodeURI(Settings.commerceUrl)}/orders/redirection/${
+            queryString ? `?${queryString}` : ''
+          }`
+        )
       );
     }
 
@@ -147,21 +156,35 @@ const withPzDefault =
       );
     }
 
-    // If commerce redirects to /orders/checkout/ without locale
+    // If commerce redirects to /orders/checkout/ or /orders/post-checkout/ without locale
+    const isPostCheckout = !!req.nextUrl.pathname.match(
+      new RegExp('^/orders/post-checkout/$')
+    );
+    const checkoutLocalePath = getUrlPathWithLocale(
+      '/orders/checkout/',
+      req.cookies.get('pz-locale')?.value
+    );
     if (
-      req.nextUrl.pathname.match(new RegExp('^/orders/checkout/$')) &&
-      req.nextUrl.searchParams.size === 0 &&
-      getUrlPathWithLocale(
-        '/orders/checkout/',
-        req.cookies.get('pz-locale')?.value
-      ) !== req.nextUrl.pathname
+      (isPostCheckout && req.nextUrl.searchParams.size === 0) ||
+      (req.nextUrl.pathname.match(new RegExp('^/orders/checkout/$')) &&
+        req.nextUrl.searchParams.size === 0 &&
+        checkoutLocalePath !== req.nextUrl.pathname)
     ) {
-      const redirectUrlWithLocale = `${url.origin}${getUrlPathWithLocale(
-        '/orders/checkout/',
-        req.cookies.get('pz-locale')?.value
-      )}`;
+      const response = NextResponse.redirect(
+        `${url.origin}${checkoutLocalePath}`,
+        303
+      );
+
+      if (isPostCheckout) {
+        response.cookies.set('pz-post-checkout-flow', 'true', {
+          path: '/',
+          sameSite: 'none',
+          secure: true,
+          expires: new Date(Date.now() + POST_CHECKOUT_COOKIE_MAX_AGE_MS)
+        });
+      }
 
-      return NextResponse.redirect(redirectUrlWithLocale, 303);
+      return response;
     }
 
     // Dynamically handle any payment gateway without specifying names
@@ -233,10 +256,11 @@ const withPzDefault =
                           withCompleteWallet(
                             withWalletCompleteRedirection(
                               withMasterpassRestCallback(
-                                async (
-                                  req: PzNextRequest,
-                                  event: NextFetchEvent
-                                ) => {
+                                withBfcacheHeaders(
+                                  async (
+                                    req: PzNextRequest,
+                                    event: NextFetchEvent
+                                  ) => {
                                   let middlewareResult: NextResponse | void =
                                     NextResponse.next();
 
@@ -420,6 +444,25 @@ const withPzDefault =
                                       );
                                     }
 
+                                    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',
@@ -457,7 +500,7 @@ const withPzDefault =
                                   }
 
                                   return middlewareResult;
-                                }
+                                })
                               )
                             )
                           )

package/middlewares/index.ts

@@ -12,6 +12,7 @@ import withSavedCardRedirection from './saved-card-redirection';
 import withCompleteWallet from './complete-wallet';
 import withWalletCompleteRedirection from './wallet-complete-redirection';
 import withMasterpassRestCallback from './masterpass-rest-callback';
+import withBfcacheHeaders from './bfcache-headers';
 import { NextRequest } from 'next/server';
 
 export {
@@ -28,7 +29,8 @@ export {
   withSavedCardRedirection,
   withCompleteWallet,
   withWalletCompleteRedirection,
-  withMasterpassRestCallback
+  withMasterpassRestCallback,
+  withBfcacheHeaders
 };
 
 export interface PzNextRequest extends NextRequest {

package/middlewares/masterpass-rest-callback.ts

@@ -3,6 +3,7 @@ import Settings from 'settings';
 import logger from '../utils/log';
 import { getUrlPathWithLocale } from '../utils/localization';
 import { PzNextRequest } from '.';
+import { getCheckoutPath } from '../utils';
 
 const withMasterpassRestCallback =
   (middleware: NextMiddleware) =>
@@ -19,7 +20,9 @@ const withMasterpassRestCallback =
     }
 
     try {
-      const requestUrl = new URL('/orders/checkout/', Settings.commerceUrl);
+      const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+      const requestUrl = new URL(getCheckoutPath(isPostCheckout), Settings.commerceUrl);
+
       url.searchParams.forEach((value, key) => {
         requestUrl.searchParams.set(key, value);
       });
@@ -56,18 +59,20 @@ const withMasterpassRestCallback =
           ip
         });
 
-        return NextResponse.redirect(
+        const errorResponse = NextResponse.redirect(
           `${url.origin}${getUrlPathWithLocale(
             '/orders/checkout/',
             req.cookies.get('pz-locale')?.value
           )}`,
-          {
-            status: 303,
-            headers: {
-              'Set-Cookie': `pz-pos-error=${encodeURIComponent(JSON.stringify(errors))}; path=/;`
-            }
-          }
+          303
         );
+
+        // Add error cookie
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
+
+        return errorResponse;
       }
 
       const redirectUrl =

package/middlewares/redirection-payment.ts

@@ -4,6 +4,7 @@ import Settings from 'settings';
 import logger from '../utils/log';
 import { PzNextRequest } from '.';
 import { getUrlPathWithLocale } from '../utils/localization';
+import { getCheckoutPath } from '../utils';
 
 const streamToString = async (stream: ReadableStream<Uint8Array> | null) => {
   if (stream) {
@@ -41,7 +42,8 @@ const withRedirectionPayment =
       return middleware(req, event);
     }
 
-    const requestUrl = `${Settings.commerceUrl}/orders/checkout/${url.search}`;
+    const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+    const requestUrl = `${Settings.commerceUrl}${getCheckoutPath(isPostCheckout)}${url.search}`;
     const requestHeaders = {
       'X-Requested-With': 'XMLHttpRequest',
       'Content-Type': 'application/x-www-form-urlencoded',
@@ -109,10 +111,9 @@ const withRedirectionPayment =
         });
 
         // Add error cookie
-        errorResponse.headers.append(
-          'Set-Cookie',
-          `pz-pos-error=${JSON.stringify(errors)}; path=/;`
-        );
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
 
         return errorResponse;
       }

package/middlewares/saved-card-redirection.ts

@@ -5,6 +5,7 @@ import logger from '../utils/log';
 import { getUrlPathWithLocale } from '../utils/localization';
 import { PzNextRequest } from '.';
 import { ServerVariables } from '../utils/server-variables';
+import { getCheckoutPath } from '../utils';
 
 const streamToString = async (stream: ReadableStream<Uint8Array> | null) => {
   if (stream) {
@@ -41,7 +42,8 @@ const withSavedCardRedirection =
       return middleware(req, event);
     }
 
-    const requestUrl = `${Settings.commerceUrl}/orders/checkout/${url.search}`;
+    const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+    const requestUrl = `${Settings.commerceUrl}${getCheckoutPath(isPostCheckout)}${url.search}`;
     const requestHeaders = {
       'X-Requested-With': 'XMLHttpRequest',
       'Content-Type': 'application/x-www-form-urlencoded',
@@ -109,10 +111,9 @@ const withSavedCardRedirection =
         });
 
         // Add error cookie
-        errorResponse.headers.append(
-          'Set-Cookie',
-          `pz-pos-error=${JSON.stringify(errors)}; path=/;`
-        );
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
 
         return errorResponse;
       }

package/middlewares/three-d-redirection.ts

@@ -4,6 +4,7 @@ import { Buffer } from 'buffer';
 import logger from '../utils/log';
 import { getUrlPathWithLocale } from '../utils/localization';
 import { PzNextRequest } from '.';
+import { getCheckoutPath } from '../utils';
 
 const streamToString = async (stream: ReadableStream<Uint8Array> | null) => {
   if (stream) {
@@ -40,7 +41,8 @@ const withThreeDRedirection =
       return middleware(req, event);
     }
 
-    const requestUrl = `${Settings.commerceUrl}/orders/checkout/${url.search}`;
+    const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+    const requestUrl = `${Settings.commerceUrl}${getCheckoutPath(isPostCheckout)}${url.search}`;
     const requestHeaders = {
       'X-Requested-With': 'XMLHttpRequest',
       'Content-Type': 'application/x-www-form-urlencoded',
@@ -108,10 +110,9 @@ const withThreeDRedirection =
         });
 
         // Add error cookie
-        errorResponse.headers.append(
-          'Set-Cookie',
-          `pz-pos-error=${JSON.stringify(errors)}; path=/;`
-        );
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
 
         return errorResponse;
       }

package/middlewares/wallet-complete-redirection.ts

@@ -4,6 +4,7 @@ import { Buffer } from 'buffer';
 import logger from '../utils/log';
 import { getUrlPathWithLocale } from '../utils/localization';
 import { PzNextRequest } from '.';
+import { getCheckoutPath } from '../utils';
 
 const streamToString = async (stream: ReadableStream<Uint8Array> | null) => {
   if (stream) {
@@ -39,7 +40,8 @@ const withWalletCompleteRedirection =
       return middleware(req, event);
     }
 
-    const requestUrl = `${Settings.commerceUrl}/orders/checkout/${url.search}`;
+    const isPostCheckout = req.cookies.get('pz-post-checkout-flow')?.value === 'true';
+    const requestUrl = `${Settings.commerceUrl}${getCheckoutPath(isPostCheckout)}${url.search}`;
     const requestHeaders = {
       'X-Requested-With': 'XMLHttpRequest',
       'Content-Type': 'application/x-www-form-urlencoded',
@@ -129,10 +131,9 @@ const withWalletCompleteRedirection =
         });
 
         // Add error cookie
-        errorResponse.headers.append(
-          'Set-Cookie',
-          `pz-pos-error=${JSON.stringify(errors)}; path=/;`
-        );
+        errorResponse.cookies.set('pz-pos-error', JSON.stringify(errors), {
+          path: '/'
+        });
 
         return errorResponse;
       }

package/package.json

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

package/plugins.d.ts

@@ -37,6 +37,16 @@ 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;
 }

package/plugins.js

@@ -16,6 +16,7 @@ module.exports = [
   'pz-tabby-extension',
   'pz-apple-pay',
   'pz-tamara-extension',
+  'pz-similar-products',
   'pz-cybersource-uc',
   'pz-hepsipay',
   'pz-flow-payment',

package/redux/middlewares/checkout.ts

@@ -204,15 +204,25 @@ export const contextListMiddleware: Middleware = ({
             (ctx) => ctx.page_name === 'DeliveryOptionSelectionPage'
           )
         ) {
+          const isCreditCardPayment =
+            preOrder?.payment_option?.payment_type === 'credit_card' ||
+            preOrder?.payment_option?.payment_type === 'masterpass';
+
           if (context.page_context.card_type) {
             dispatch(setCardType(context.page_context.card_type));
+          } else if (isCreditCardPayment) {
+            dispatch(setCardType(null));
           }
 
           if (
             context.page_context.installments &&
             preOrder?.payment_option?.payment_type !== 'masterpass_rest'
           ) {
-            dispatch(setInstallmentOptions(context.page_context.installments));
+            if (!isCreditCardPayment || context.page_context.card_type) {
+              dispatch(
+                setInstallmentOptions(context.page_context.installments)
+              );
+            }
           }
         }
 

package/redux/middlewares/pre-order/installment-option.ts

@@ -14,9 +14,17 @@ export const installmentOptionMiddleware: Middleware = ({
       return result;
     }
 
-    const { installmentOptions } = getState().checkout;
+    const { installmentOptions, cardType } = getState().checkout;
     const { endpoints: apiEndpoints } = checkoutApi;
 
+    const isCreditCardPayment =
+      preOrder?.payment_option?.payment_type === 'credit_card' ||
+      preOrder?.payment_option?.payment_type === 'masterpass';
+
+    if (isCreditCardPayment && !cardType) {
+      return result;
+    }
+
     if (
       !preOrder?.installment &&
       preOrder?.payment_option?.payment_type !== 'saved_card' &&

package/types/index.ts

@@ -83,6 +83,12 @@ export interface Settings {
   };
   usePrettyUrlRoute?: boolean;
   commerceUrl: string;
+  /**
+   * This option allows you to track Sentry events on the client side, in addition to server and edge environments.
+   *
+   * It overrides process.env.NEXT_PUBLIC_SENTRY_DSN and process.env.SENTRY_DSN.
+   */
+  sentryDsn?: string;
   redis: {
     defaultExpirationTime: number;
   };

package/utils/get-checkout-path.ts

@@ -0,0 +1,3 @@
+export const getCheckoutPath = (isPostCheckout: boolean): string => {
+  return isPostCheckout ? '/orders/post-checkout/' : '/orders/checkout/';
+};

package/utils/index.ts

@@ -7,6 +7,7 @@ export * from './get-currency';
 export * from './menu-generator';
 export * from './generate-commerce-search-params';
 export * from './get-currency-label';
+export * from './get-checkout-path';
 
 export function getCookie(name: string) {
   if (typeof document === 'undefined') {
@@ -194,7 +195,9 @@ export const urlLocaleMatcherRegex = new RegExp(
 
 export const getPosError = () => {
   const cookieValue = getCookie('pz-pos-error');
-  const error = JSON.parse(cookieValue ? decodeURIComponent(cookieValue) : '{}');
+  const error = JSON.parse(
+    cookieValue ? decodeURIComponent(cookieValue) : '{}'
+  );
 
   // delete 'pz-pos-error' cookie when refreshing or closing page
   window.addEventListener('beforeunload', () => {
@@ -204,6 +207,23 @@ export const getPosError = () => {
   return error;
 };
 
+export const checkPaymentWillRedirect = (response: {
+  context_list?: Array<{
+    page_name: string;
+    page_context?: { context_data?: { redirect_url?: string } };
+  }>;
+  redirect_url?: string;
+  errors?: unknown;
+}): boolean => {
+  if (!response) return false;
+
+  const hasThankYouPage = response.context_list?.some(
+    (c) => c.page_name === 'ThankYouPage'
+  );
+
+  return Boolean(hasThankYouPage || response.redirect_url);
+};
+
 export const urlSchemes = [
   'http',
   'tel:',