@akinon/next 1.55.0 → 1.56.0-rc.1

package/hocs/server/with-segment-defaults.tsx

@@ -2,7 +2,6 @@ import settings from 'settings';
 import { LayoutProps, PageProps, RootLayoutProps } from '../../types';
 import { redirect } from 'next/navigation';
 import { ServerVariables } from '../../utils/server-variables';
-import { getTranslations } from '../../utils/server-translation';
 import { ROUTES } from 'routes';
 import logger from '../../utils/log';
 
@@ -50,7 +49,11 @@ const addRootLayoutProps = async (componentProps: RootLayoutProps) => {
     return redirect(ROUTES.HOME);
   }
 
+  const { getTranslations } = settings.useOptimizedTranslations
+    ? require('translations')
+    : require('../../utils/server-translation');
   const translations = await getTranslations(params.locale);
+
   componentProps.translations = translations;
 
   const locale = settings.localization.locales.find(

package/hooks/index.ts

@@ -8,4 +8,5 @@ export * from './use-media-query';
 export * from './use-on-click-outside';
 export * from './use-mobile-iframe-handler';
 export * from './use-payment-options';
-export * from './use-pagination';
+export * from './use-pagination';
+export * from './use-message-listener';

package/hooks/use-message-listener.ts

@@ -0,0 +1,24 @@
+import { useEffect } from 'react';
+
+export const useMessageListener = () => {
+  useEffect(() => {
+    const handleMessage = (event: MessageEvent) => {
+      if (event.origin !== window.location.origin) {
+        return;
+      }
+
+      if (event.data && typeof event.data === 'string') {
+        const messageData = JSON.parse(event.data);
+        if (messageData?.url) {
+          window.location.href = messageData.url;
+        }
+      }
+    };
+
+    window.addEventListener('message', handleMessage);
+
+    return () => {
+      window.removeEventListener('message', handleMessage);
+    };
+  }, []);
+};

package/hooks/use-pagination.ts

@@ -116,7 +116,7 @@ export default function usePagination(
       urlSearchParams.set('page', (Number(state.page) - 1).toString());
       return `${pathname}?${urlSearchParams.toString()}`;
     }
-    return '#';
+    return null;
   }, [state.page, pathname, urlSearchParams]);
 
   const next = useMemo(() => {
@@ -124,7 +124,7 @@ export default function usePagination(
       urlSearchParams.set('page', (Number(state.page) + 1).toString());
       return `${pathname}?${urlSearchParams.toString()}`;
     }
-    return '#';
+    return null;
   }, [state.page, state.last, pathname, urlSearchParams]);
 
   return {

package/hooks/use-payment-options.ts

@@ -18,7 +18,8 @@ export const usePaymentOptions = () => {
     pay_on_delivery: 'pz-pay-on-delivery',
     bkm_express: 'pz-bkm',
     credit_payment: 'pz-credit-payment',
-    masterpass: 'pz-masterpass'
+    masterpass: 'pz-masterpass',
+    gpay: 'pz-gpay'
   };
 
   const isInitialTypeIncluded = (type: string) => initialTypes.has(type);

package/lib/cache-handler.mjs

@@ -0,0 +1,33 @@
+import { CacheHandler } from '@neshca/cache-handler';
+import createLruHandler from '@neshca/cache-handler/local-lru';
+import createRedisHandler from '@neshca/cache-handler/redis-stack';
+import { createClient } from 'redis';
+
+CacheHandler.onCreation(async () => {
+  const redisUrl = `redis://${process.env.CACHE_HOST}:${
+    process.env.CACHE_PORT
+  }/${process.env.CACHE_BUCKET ?? '0'}`;
+
+  const client = createClient({
+    url: redisUrl
+  });
+
+  client.on('error', (error) => {
+    console.error('Redis client error', { redisUrl, error });
+  });
+
+  await client.connect();
+
+  const redisHandler = await createRedisHandler({
+    client,
+    timeoutMs: 5000
+  });
+
+  const localHandler = createLruHandler();
+
+  return {
+    handlers: [redisHandler, localHandler]
+  };
+});
+
+export default CacheHandler;

package/lib/cache.ts

@@ -3,7 +3,6 @@ import { RedisClientType } from 'redis';
 import Settings from 'settings';
 import { CacheOptions } from '../types';
 import logger from '../utils/log';
-import { ServerVariables } from '../utils/server-variables';
 
 const hashCacheKey = (object?: Record<string, string>) => {
   if (!object) {
@@ -59,10 +58,8 @@ export const CacheKey = {
 export class Cache {
   static PROXY_URL = `${process.env.NEXT_PUBLIC_URL}/api/cache`;
 
-  static formatKey(key: string) {
-    return encodeURIComponent(
-      `${Settings.commerceUrl}_${ServerVariables.locale}_${key}`
-    );
+  static formatKey(key: string, locale: string) {
+    return encodeURIComponent(`${Settings.commerceUrl}_${locale}_${key}`);
   }
 
   static clientPool: Pool<RedisClientType> = createPool(
@@ -155,9 +152,14 @@ export class Cache {
 
   static async wrap<T = any>(
     key: string,
+    locale: string,
     handler: () => Promise<T>,
     options?: CacheOptions
   ): Promise<T> {
+    if (Settings.usePrettyUrlRoute) {
+      return await handler();
+    }
+
     const requiredVariables = [
       process.env.CACHE_HOST,
       process.env.CACHE_PORT,
@@ -174,7 +176,7 @@ export class Cache {
     };
 
     const _options = Object.assign(defaultOptions, options);
-    const formattedKey = Cache.formatKey(key);
+    const formattedKey = Cache.formatKey(key, locale);
 
     logger.debug('Cache wrap', { key, formattedKey, _options });
 

package/middlewares/default.ts

@@ -88,14 +88,44 @@ const withPzDefault =
       req.nextUrl.pathname.includes('/orders/hooks/') ||
       req.nextUrl.pathname.includes('/orders/checkout-with-token/')
     ) {
-      return NextResponse.rewrite(
+      const segment = url.searchParams.get('segment');
+      const currency = url.searchParams.get('currency')?.toLowerCase();
+
+      const headers = {};
+
+      if (segment) {
+        headers['X-Segment-Id'] = segment;
+      }
+
+      if (currency) {
+        headers['x-currency'] = currency;
+      }
+
+      const response = NextResponse.rewrite(
         new URL(
           `${Settings.commerceUrl}${req.nextUrl.pathname.replace(
             urlLocaleMatcherRegex,
             ''
           )}`
-        )
+        ),
+        {
+          headers
+        }
       );
+
+      if (segment) {
+        response.cookies.set('pz-segment', segment);
+      }
+
+      if (currency) {
+        response.cookies.set('pz-currency', currency, {
+          sameSite: 'none',
+          secure: true,
+          expires: new Date(Date.now() + 1000 * 60 * 60 * 24 * 7) // 7 days
+        });
+      }
+
+      return response;
     }
 
     if (req.nextUrl.pathname.startsWith('/orders/redirection/')) {
@@ -189,10 +219,41 @@ const withPzDefault =
                               ''
                             );
 
+                            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 originalUrl = new URL(req.url);
+                              customRewriteUrlDiff =
+                                rewriteUrl.pathname.replace(
+                                  originalUrl.pathname,
+                                  ''
+                                );
+                            }
+
                             url.basePath = `/${commerceUrl}`;
                             url.pathname = `/${
                               locale.length ? `${locale}/` : ''
-                            }${currency}${prettyUrl ?? pathnameWithoutLocale}`;
+                            }${currency}/${customRewriteUrlDiff}${
+                              prettyUrl ?? pathnameWithoutLocale
+                            }`.replace(/\/+/g, '/');
 
                             if (
                               !req.middlewareParams.found &&
@@ -207,6 +268,20 @@ const withPzDefault =
                               );
                             }
 
+                            if (
+                              Settings.usePrettyUrlRoute &&
+                              url.searchParams.toString().length > 0 &&
+                              !Object.entries(ROUTES).find(([, value]) =>
+                                new RegExp(`^${value}/?$`).test(
+                                  pathnameWithoutLocale
+                                )
+                              )
+                            ) {
+                              url.pathname =
+                                url.pathname +
+                                `searchparams|${url.searchParams.toString()}`;
+                            }
+
                             Settings.rewrites.forEach((rewrite) => {
                               url.pathname = url.pathname.replace(
                                 rewrite.source,
@@ -214,11 +289,6 @@ const withPzDefault =
                               );
                             });
 
-                            middlewareResult = (await middleware(
-                              req,
-                              event
-                            )) as NextResponse | void;
-
                             // 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.
@@ -231,6 +301,15 @@ const withPzDefault =
                                   '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.

package/middlewares/pretty-url.ts

@@ -43,9 +43,14 @@ const resolvePrettyUrlHandler =
     return prettyUrlResult;
   };
 
-const resolvePrettyUrl = async (pathname: string, ip: string | null) => {
+const resolvePrettyUrl = async (
+  pathname: string,
+  locale: string,
+  ip: string | null
+) => {
   return Cache.wrap(
     CacheKey.PrettyUrl(pathname),
+    locale,
     resolvePrettyUrlHandler(pathname, ip),
     {
       useProxy: true
@@ -56,6 +61,10 @@ const resolvePrettyUrl = async (pathname: string, ip: string | null) => {
 const withPrettyUrl =
   (middleware: NextMiddleware) =>
   async (req: PzNextRequest, event: NextFetchEvent) => {
+    if (Settings.usePrettyUrlRoute) {
+      return middleware(req, event);
+    }
+
     const url = req.nextUrl.clone();
     const matchedLanguagePrefix = url.pathname.match(
       urlLocaleMatcherRegex
@@ -84,6 +93,7 @@ const withPrettyUrl =
       )
         ? url.pathname
         : prettyUrlPathname,
+      matchedLanguagePrefix,
       ip
     );
 

package/middlewares/url-redirection.ts

@@ -11,6 +11,10 @@ import { ROUTES } from 'routes';
 const withUrlRedirection =
   (middleware: NextMiddleware) =>
   async (req: PzNextRequest, event: NextFetchEvent) => {
+    if (settings.usePrettyUrlRoute) {
+      return middleware(req, event);
+    }
+
     const url = req.nextUrl.clone();
     const ip = req.headers.get('x-forwarded-for') ?? '';
     const pathnameWithoutLocale = url.pathname.replace(

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "1.55.0",
+  "version": "1.56.0-rc.1",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -20,16 +20,17 @@
     "@opentelemetry/sdk-trace-node": "1.19.0",
     "@opentelemetry/semantic-conventions": "1.19.0",
     "@reduxjs/toolkit": "1.9.7",
+    "@neshca/cache-handler": "1.5.1",
     "cross-spawn": "7.0.3",
     "generic-pool": "3.9.0",
     "react-redux": "8.1.3",
     "react-string-replace": "1.1.1",
-    "redis": "4.5.1",
+    "redis": "4.6.13",
     "semver": "7.6.2",
     "set-cookie-parser": "2.6.0"
   },
   "devDependencies": {
-    "@akinon/eslint-plugin-projectzero": "1.55.0",
+    "@akinon/eslint-plugin-projectzero": "1.56.0-rc.1",
     "@types/react-redux": "7.1.30",
     "@types/set-cookie-parser": "2.4.7",
     "@typescript-eslint/eslint-plugin": "6.7.4",

package/redux/middlewares/checkout.ts

@@ -16,8 +16,10 @@ import {
   setPreOrder,
   setRetailStores,
   setShippingOptions,
+  setDataSourceShippingOptions,
   setShippingStepCompleted,
-  setCreditPaymentOptions
+  setCreditPaymentOptions,
+  setAttributeBasedShippingOptions
 } from '../../redux/reducers/checkout';
 import { RootState, TypedDispatch } from 'redux/store';
 import { checkoutApi } from '../../data/client/checkout';
@@ -26,6 +28,7 @@ import { getCookie, setCookie } from '../../utils';
 import settings from 'settings';
 import { LocaleUrlStrategy } from '../../localization';
 import { showMobile3dIframe } from '../../utils/mobile-3d-iframe';
+import { showRedirectionIframe } from '../../utils/redirection-iframe';
 
 interface CheckoutResult {
   payload: {
@@ -73,8 +76,10 @@ export const preOrderMiddleware: Middleware = ({
       deliveryOptions,
       addressList: addresses,
       shippingOptions,
+      dataSourceShippingOptions,
       paymentOptions,
-      installmentOptions
+      installmentOptions,
+      attributeBasedShippingOptions
     } = getState().checkout;
     const { endpoints: apiEndpoints } = checkoutApi;
 
@@ -125,6 +130,40 @@ export const preOrderMiddleware: Middleware = ({
       dispatch(apiEndpoints.setShippingOption.initiate(shippingOptions[0].pk));
     }
 
+    if (
+      dataSourceShippingOptions.length > 0 &&
+      !preOrder.data_source_shipping_options
+    ) {
+      const selectedDataSourceShippingOptionsPks =
+        dataSourceShippingOptions.map(
+          (opt) => opt.data_source_shipping_options[0].pk
+        );
+
+      dispatch(
+        apiEndpoints.setDataSourceShippingOptions.initiate(
+          selectedDataSourceShippingOptionsPks
+        )
+      );
+    }
+
+    if (
+      Object.keys(attributeBasedShippingOptions).length > 0 &&
+      !preOrder.attribute_based_shipping_options
+    ) {
+      const initialSelectedOptions: Record<string, number> = Object.fromEntries(
+        Object.entries(attributeBasedShippingOptions).map(([key, options]) => [
+          key,
+          options[0].pk
+        ])
+      );
+
+      dispatch(
+        apiEndpoints.setAttributeBasedShippingOptions.initiate(
+          initialSelectedOptions
+        )
+      );
+    }
+
     if (!preOrder.payment_option && paymentOptions.length > 0) {
       dispatch(apiEndpoints.setPaymentOption.initiate(paymentOptions[0].pk));
     }
@@ -163,6 +202,7 @@ export const contextListMiddleware: Middleware = ({
     if (result?.payload?.context_list) {
       result.payload.context_list.forEach((context) => {
         const redirectUrl = context.page_context.redirect_url;
+        const isIframe = context.page_context.is_frame ?? false;
 
         if (redirectUrl) {
           const currentLocale = getCookie('pz-locale');
@@ -181,16 +221,19 @@ export const contextListMiddleware: Middleware = ({
           }
 
           const urlObj = new URL(url, window.location.origin);
-          urlObj.searchParams.set('t', new Date().getTime().toString());
-
-          if (
-            (isMobileApp ||
-              /iPad|iPhone|iPod|Android/i.test(navigator.userAgent)) &&
+          const isMobileDevice =
+            isMobileApp ||
+            /iPad|iPhone|iPod|Android/i.test(navigator.userAgent);
+          const isIframePaymentOptionExcluded =
             !settings.checkout?.iframeExcludedPaymentOptions?.includes(
               result.payload?.pre_order?.payment_option?.slug
-            )
-          ) {
+            );
+          urlObj.searchParams.set('t', new Date().getTime().toString());
+
+          if (isMobileDevice && !isIframePaymentOptionExcluded) {
             showMobile3dIframe(urlObj.toString());
+          } else if (isIframe && !isIframePaymentOptionExcluded) {
+            showRedirectionIframe(urlObj.toString());
           } else {
             window.location.href = urlObj.toString();
           }
@@ -220,12 +263,28 @@ export const contextListMiddleware: Middleware = ({
           dispatch(setShippingOptions(context.page_context.shipping_options));
         }
 
+        if (context.page_context.data_sources) {
+          dispatch(
+            setDataSourceShippingOptions(context.page_context.data_sources)
+          );
+        }
+
+        if (context.page_context.attribute_based_shipping_options) {
+          dispatch(
+            setAttributeBasedShippingOptions(
+              context.page_context.attribute_based_shipping_options
+            )
+          );
+        }
+
         if (context.page_context.payment_options) {
           dispatch(setPaymentOptions(context.page_context.payment_options));
         }
 
         if (context.page_context.credit_payment_options) {
-          dispatch(setCreditPaymentOptions(context.page_context.credit_payment_options));
+          dispatch(
+            setCreditPaymentOptions(context.page_context.credit_payment_options)
+          );
         }
 
         if (context.page_context.payment_choices) {

package/redux/reducers/checkout.ts

@@ -14,7 +14,9 @@ import {
   CheckoutCreditPaymentOption,
   PreOrder,
   RetailStore,
-  ShippingOption
+  ShippingOption,
+  DataSource,
+  AttributeBasedShippingOption
 } from '../../types';
 
 export interface CheckoutState {
@@ -36,6 +38,7 @@ export interface CheckoutState {
   addressList: Address[];
   deliveryOptions: DeliveryOption[];
   shippingOptions: ShippingOption[];
+  dataSourceShippingOptions: DataSource[];
   paymentOptions: PaymentOption[];
   creditPaymentOptions: CheckoutCreditPaymentOption[];
   selectedCreditPaymentPk: number;
@@ -46,6 +49,8 @@ export interface CheckoutState {
   selectedBankAccountPk: number;
   loyaltyBalance?: string;
   retailStores: RetailStore[];
+  attributeBasedShippingOptions: AttributeBasedShippingOption[];
+  selectedShippingOptions: Record<string, number>;
 }
 
 const initialState: CheckoutState = {
@@ -67,6 +72,7 @@ const initialState: CheckoutState = {
   addressList: [],
   deliveryOptions: [],
   shippingOptions: [],
+  dataSourceShippingOptions: [],
   paymentOptions: [],
   creditPaymentOptions: [],
   selectedCreditPaymentPk: null,
@@ -75,7 +81,9 @@ const initialState: CheckoutState = {
   installmentOptions: [],
   bankAccounts: [],
   selectedBankAccountPk: null,
-  retailStores: []
+  retailStores: [],
+  attributeBasedShippingOptions: [],
+  selectedShippingOptions: {}
 };
 
 const checkoutSlice = createSlice({
@@ -121,6 +129,9 @@ const checkoutSlice = createSlice({
     setShippingOptions(state, { payload }) {
       state.shippingOptions = payload;
     },
+    setDataSourceShippingOptions(state, { payload }) {
+      state.dataSourceShippingOptions = payload;
+    },
     setPaymentOptions(state, { payload }) {
       state.paymentOptions = payload;
     },
@@ -150,6 +161,12 @@ const checkoutSlice = createSlice({
     },
     setRetailStores(state, { payload }) {
       state.retailStores = payload;
+    },
+    setAttributeBasedShippingOptions(state, { payload }) {
+      state.attributeBasedShippingOptions = payload;
+    },
+    setSelectedShippingOptions: (state, { payload }) => {
+      state.selectedShippingOptions = payload;
     }
   }
 });
@@ -168,6 +185,7 @@ export const {
   setAddressList,
   setDeliveryOptions,
   setShippingOptions,
+  setDataSourceShippingOptions,
   setPaymentOptions,
   setCreditPaymentOptions,
   setSelectedCreditPaymentPk,
@@ -177,7 +195,9 @@ export const {
   setBankAccounts,
   setSelectedBankAccountPk,
   setLoyaltyBalance,
-  setRetailStores
+  setRetailStores,
+  setAttributeBasedShippingOptions,
+  setSelectedShippingOptions
 } = checkoutSlice.actions;
 
 export default checkoutSlice.reducer;