@akinon/next 1.43.0-rc.1 → 1.43.0-rc.11

package/CHANGELOG.md

@@ -1,5 +1,99 @@
 # @akinon/next
 
+## 1.43.0-rc.11
+
+### Minor Changes
+
+- 6c25f66: ZERO-2551: Check CACHE_HOST variable
+
+## 1.43.0-rc.10
+
+### Minor Changes
+
+- d6edb1d: ZERO-2551: Fix searchparams handling for list and other routes
+
+## 1.43.0-rc.9
+
+### Minor Changes
+
+- bc2b411: ZERO-2825: Add attribute-based shipping options to checkout page
+
+## 1.43.0-rc.8
+
+### Minor Changes
+
+- 70279e7: ZERO-2817: Add metrics endpoint in default middleware
+- 9d94f7e: ZERO-2820: update parent pk usage for menu generator
+
+## 1.43.0-rc.7
+
+### Minor Changes
+
+- 7bd3d99: ZERO-2801: Refactor locale middleware to handle single locale configuration
+
+## 1.43.0-rc.6
+
+### Minor Changes
+
+- 90282b5: ZERO-2729: Audit packages for yarn and npm and also update app-template
+- 572d2e8: ZERO-2667: Add iframe support for redirection payment methods
+- a4c8d6a: ZERO-2663: Fix the image url for gif and svgs and return them without options
+- fda5b92: ZERO-2725: fix invalid import
+- 2d9b2b2: ZERO-2816: Add segment to headers
+- c53ea3e: ZERO-2609: Reset additional form fields when selectedFormType is not company
+- 8d9ac9a: ZERO-2794: Add field to order type
+- e9541a1: ZERO-2816: Add headers to url
+- c53ef7b: ZERO-2668: The Link component has been updated to improve the logic for handling href values. Previously, if the href was not a string or started with 'http', it would return the href as is. Now, if the href is not provided, it will default to '#' to prevent any potential errors. Additionally, if the href is a string and does not start with 'http', it will be formatted with the locale and pathname, based on the localeUrlStrategy and defaultLocaleValue. This ensures that the correct href is generated based on the localization settings.
+- 64699d3: ZERO-2761: Fix invalid import for plugin module
+- 0d3a913: ZERO-2725: Update decimal scale in Price component
+- 1448a96: ZERO-2612: add errors type in CheckoutState
+- d3474c6: ZERO-2655: Add data source shipping option
+- 75080fd: ZERO-2630: Add max limit to postcode area
+- 17f8752: ZERO-2816: Make the incoming currency lowercase
+- 91265bb: ZERO-2551: Improve pretty url and caching performance
+- bbe18b9: ZERO-2575: Fix build error
+- d409996: ZERO-2781: Refactor buildClientRequestUrl function to support caching and options
+- 94b6928: ZERO-2551: Add cache handler check in url-redirection middleware
+- 98bb8dc: ZERO-2706: Cache getTranlations method
+- 46b7aad: ZERO-2775: Add condition and logger for menuitemmodel data
+- dcc8a15: ZERO-2694: added build step to RC branch pipeline
+- fad2768: ZERO-2739: add gpay to payment plugin map
+- dff0d59: ZERO-2659: add formData support to proxy api requests
+- eecb282: ZERO-2607: Update address-related functions to include invalidateTag option
+- 4a163f2: ZERO-2761: Add condition for basket summary
+- beb499e: ZERO-2551: Add new tsconfig paths
+- 146ea39: ZERO-2774: Update imports
+- f2c92d5: ZERO-2816: Update cookie name
+- c47be30: ZERO-2744: Update Order and OrderItem types
+- e9a46ac: ZERO-2738: add CVC input to registered cards in Masterpass
+- f046f8e: ZERO-2575: update version for react-number-format
+- 86d2531: ZERO-2693: resolve dependency collision warning for eslint-config-next
+- 3f9b8d7: ZERO-2761: Update plugins.js for akinon-next
+
+## 1.43.0-rc.5
+
+### Minor Changes
+
+- 17f8752: ZERO-2816: Make the incoming currency lowercase
+
+## 1.43.0-rc.4
+
+### Minor Changes
+
+- 3f9b8d7: ZERO-2761: Update plugins.js for akinon-next
+
+## 1.43.0-rc.3
+
+### Minor Changes
+
+- 64699d3: ZERO-2761: Fix invalid import for plugin module
+
+## 1.43.0-rc.2
+
+### Minor Changes
+
+- f2c92d5: ZERO-2816: Update cookie name
+
 ## 1.43.0-rc.1
 
 ### Minor Changes

package/components/plugin-module.tsx

@@ -137,7 +137,7 @@ export default function PluginModule({
             } else if (plugin === Plugin.Akifast) {
               promise = import(`${'@akinon/pz-akifast'}`);
             } else if (plugin === Plugin.MultiBasket) {
-              promise = import('@akinon/pz-multi-basket');
+              promise = import(`${'@akinon/pz-multi-basket'}`);
             }
           } catch (error) {
             logger.error(error);

package/data/client/checkout.ts

@@ -676,6 +676,25 @@ export const checkoutApi = api.injectEndpoints({
           notes
         }
       })
+    }),
+    setAttributeBasedShippingOptions: build.mutation<
+      CheckoutResponse,
+      Record<string, number>
+    >({
+      query: (options) => ({
+        url: buildClientRequestUrl(checkout.setAttributeBasedShippingOption, {
+          useFormData: true
+        }),
+        method: 'POST',
+        body: {
+          attribute_based_shipping_options: JSON.stringify(options)
+        }
+      }),
+      async onQueryStarted(arg, { dispatch, queryFulfilled }) {
+        dispatch(setShippingStepBusy(true));
+        await queryFulfilled;
+        dispatch(setShippingStepBusy(false));
+      }
     })
   }),
   overrideExisting: false
@@ -711,5 +730,6 @@ export const {
   useCompleteLoyaltyPaymentMutation,
   useGetCheckoutLoyaltyBalanceQuery,
   usePayWithLoyaltyBalanceMutation,
-  useSetOrderNoteMutation
+  useSetOrderNoteMutation,
+  useSetAttributeBasedShippingOptionsMutation
 } = checkoutApi;

package/data/urls.ts

@@ -110,7 +110,9 @@ export const checkout = {
   completeLoyaltyPayment: '/orders/checkout/?page=LoyaltyPaymentSelectedPage',
   loyaltyMoneyUsage: '/orders/checkout/?page=LoyaltyMoneyUsagePage',
   setOrderNote: '/orders/checkout/?page=OrderNotePage',
-  couponSelectionPage: '/orders/checkout/?page=CouponSelectionPage'
+  couponSelectionPage: '/orders/checkout/?page=CouponSelectionPage',
+  setAttributeBasedShippingOption:
+    '/orders/checkout/?page=AttributeBasedShippingOptionSelectionPage'
 };
 
 export const flatpage = {

package/middlewares/default.ts

@@ -69,6 +69,10 @@ const withPzDefault =
       return NextResponse.json({ status: 'ok' });
     }
 
+    if (url.pathname.startsWith('/metrics')) {
+      return new NextResponse(null, { status: 200 });
+    }
+
     if (req.nextUrl.pathname.startsWith('/.well-known')) {
       const url = new URL(`${Settings.commerceUrl}${req.nextUrl.pathname}`);
       const req_ = await fetch(url.toString());
@@ -85,7 +89,7 @@ const withPzDefault =
       req.nextUrl.pathname.includes('/orders/checkout-with-token/')
     ) {
       const segment = url.searchParams.get('segment');
-      const currency = url.searchParams.get('currency');
+      const currency = url.searchParams.get('currency')?.toLowerCase();
 
       const headers = {};
 
@@ -114,7 +118,11 @@ const withPzDefault =
       }
 
       if (currency) {
-        response.cookies.set('pz-external-currency', 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;
@@ -231,7 +239,12 @@ const withPzDefault =
 
                             if (
                               Settings.usePrettyUrlRoute &&
-                              url.searchParams.toString().length > 0
+                              url.searchParams.toString().length > 0 &&
+                              !Object.entries(ROUTES).find(([, value]) =>
+                                new RegExp(`^${value}$`).test(
+                                  pathnameWithoutLocale
+                                )
+                              )
                             ) {
                               url.pathname =
                                 url.pathname +

package/middlewares/locale.ts

@@ -5,22 +5,6 @@ import { LocaleUrlStrategy } from '../localization';
 import { urlLocaleMatcherRegex } from '../utils';
 import logger from '../utils/log';
 
-const getMatchedLocale = (pathname: string) => {
-  let matchedLocale = pathname.match(urlLocaleMatcherRegex)?.[0] ?? '';
-  matchedLocale = matchedLocale.replace('/', '');
-
-  if (!matchedLocale.length) {
-    if (
-      settings.localization.localeUrlStrategy !==
-      LocaleUrlStrategy.ShowAllLocales
-    ) {
-      matchedLocale = settings.localization.defaultLocaleValue;
-    }
-  }
-
-  return matchedLocale;
-};
-
 const withLocale =
   (middleware: NextMiddleware) =>
   async (req: PzNextRequest, event: NextFetchEvent) => {
@@ -28,12 +12,12 @@ const withLocale =
 
     try {
       const url = req.nextUrl.clone();
-      const matchedLocale = getMatchedLocale(url.pathname);
-      let { localeUrlStrategy, defaultLocaleValue, redirectToDefaultLocale } =
-        settings.localization;
-
-      localeUrlStrategy =
-        localeUrlStrategy ?? LocaleUrlStrategy.HideDefaultLocale;
+      const {
+        locales,
+        localeUrlStrategy,
+        defaultLocaleValue,
+        redirectToDefaultLocale
+      } = settings.localization;
 
       if (!defaultLocaleValue) {
         logger.error('Default locale value is not defined in settings.', {
@@ -45,16 +29,34 @@ const withLocale =
       }
 
       if (
-        !matchedLocale?.length &&
-        localeUrlStrategy === LocaleUrlStrategy.ShowAllLocales &&
-        redirectToDefaultLocale &&
-        req.method === 'GET'
+        locales.length === 1 &&
+        localeUrlStrategy === LocaleUrlStrategy.ShowAllLocales
       ) {
-        url.pathname = `/${defaultLocaleValue}${url.pathname}`;
-        return NextResponse.redirect(url);
-      }
+        const singleLocale = locales[0].value;
+        const pathParts = url.pathname.split('/').filter(Boolean);
 
-      req.middlewareParams.rewrites.locale = matchedLocale;
+        if (pathParts[0] === singleLocale) {
+          url.pathname = '/' + pathParts.slice(1).join('/');
+          return NextResponse.redirect(url);
+        }
+
+        req.middlewareParams.rewrites.locale = singleLocale;
+      } else {
+        const matchedLocale =
+          url.pathname.match(urlLocaleMatcherRegex)?.[0]?.replace('/', '') ||
+          '';
+        if (
+          !matchedLocale &&
+          localeUrlStrategy === LocaleUrlStrategy.ShowAllLocales &&
+          redirectToDefaultLocale &&
+          req.method === 'GET'
+        ) {
+          url.pathname = `/${defaultLocaleValue}${url.pathname}`;
+          return NextResponse.redirect(url);
+        }
+        req.middlewareParams.rewrites.locale =
+          matchedLocale || defaultLocaleValue;
+      }
     } catch (error) {
       logger.error('withLocale error', {
         error,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "1.43.0-rc.1",
+  "version": "1.43.0-rc.11",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -30,7 +30,7 @@
     "set-cookie-parser": "2.6.0"
   },
   "devDependencies": {
-    "@akinon/eslint-plugin-projectzero": "1.43.0-rc.1",
+    "@akinon/eslint-plugin-projectzero": "1.43.0-rc.11",
     "@types/react-redux": "7.1.30",
     "@types/set-cookie-parser": "2.4.7",
     "@typescript-eslint/eslint-plugin": "6.7.4",

package/plugins.js

@@ -10,5 +10,6 @@ module.exports = [
   'pz-credit-payment',
   'pz-masterpass',
   'pz-b2b',
-  'pz-akifast'
+  'pz-akifast',
+  'pz-multi-basket'
 ];

package/redux/middlewares/checkout.ts

@@ -18,7 +18,8 @@ import {
   setShippingOptions,
   setDataSourceShippingOptions,
   setShippingStepCompleted,
-  setCreditPaymentOptions
+  setCreditPaymentOptions,
+  setAttributeBasedShippingOptions
 } from '../../redux/reducers/checkout';
 import { RootState, TypedDispatch } from 'redux/store';
 import { checkoutApi } from '../../data/client/checkout';
@@ -77,7 +78,8 @@ export const preOrderMiddleware: Middleware = ({
       shippingOptions,
       dataSourceShippingOptions,
       paymentOptions,
-      installmentOptions
+      installmentOptions,
+      attributeBasedShippingOptions
     } = getState().checkout;
     const { endpoints: apiEndpoints } = checkoutApi;
 
@@ -144,6 +146,24 @@ export const preOrderMiddleware: Middleware = ({
       );
     }
 
+    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));
     }
@@ -249,6 +269,14 @@ export const contextListMiddleware: Middleware = ({
           );
         }
 
+        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));
         }

package/redux/reducers/checkout.ts

@@ -15,7 +15,8 @@ import {
   PreOrder,
   RetailStore,
   ShippingOption,
-  DataSource
+  DataSource,
+  AttributeBasedShippingOption
 } from '../../types';
 
 export interface CheckoutState {
@@ -48,6 +49,8 @@ export interface CheckoutState {
   selectedBankAccountPk: number;
   loyaltyBalance?: string;
   retailStores: RetailStore[];
+  attributeBasedShippingOptions: AttributeBasedShippingOption[];
+  selectedShippingOptions: Record<string, number>;
 }
 
 const initialState: CheckoutState = {
@@ -78,7 +81,9 @@ const initialState: CheckoutState = {
   installmentOptions: [],
   bankAccounts: [],
   selectedBankAccountPk: null,
-  retailStores: []
+  retailStores: [],
+  attributeBasedShippingOptions: [],
+  selectedShippingOptions: {}
 };
 
 const checkoutSlice = createSlice({
@@ -156,6 +161,12 @@ const checkoutSlice = createSlice({
     },
     setRetailStores(state, { payload }) {
       state.retailStores = payload;
+    },
+    setAttributeBasedShippingOptions(state, { payload }) {
+      state.attributeBasedShippingOptions = payload;
+    },
+    setSelectedShippingOptions: (state, { payload }) => {
+      state.selectedShippingOptions = payload;
     }
   }
 });
@@ -184,7 +195,9 @@ export const {
   setBankAccounts,
   setSelectedBankAccountPk,
   setLoyaltyBalance,
-  setRetailStores
+  setRetailStores,
+  setAttributeBasedShippingOptions,
+  setSelectedShippingOptions
 } = checkoutSlice.actions;
 
 export default checkoutSlice.reducer;

package/types/commerce/checkout.ts

@@ -96,6 +96,7 @@ export interface PreOrder {
   gift_box?: GiftBox;
   credit_payment_option?: CheckoutCreditPaymentOption;
   data_source_shipping_options: any;
+  attribute_based_shipping_options?: AttributeBasedShippingOption[];
 }
 
 export interface GuestLoginFormParams {
@@ -135,6 +136,7 @@ export interface CheckoutContext {
     redirect_url?: string;
     context_data?: any;
     balance?: string;
+    attribute_based_shipping_options?: AttributeBasedShippingOption[];
     [key: string]: any;
   };
 }
@@ -160,3 +162,13 @@ export interface BankAccount {
   pk: number;
   sort_order: number;
 }
+
+export interface AttributeBasedShippingOption {
+  pk: number;
+  shipping_amount: string | null;
+  shipping_option_name: string | null;
+  shipping_option_logo: string | null;
+  attribute_value: string | null;
+  attribute_key: string;
+  [key: string]: any;
+}

package/utils/menu-generator.ts

@@ -13,8 +13,8 @@ export const menuGenerator = (arr: MenuItemType[]) => {
     });
 
     Object.values(data).forEach((item) => {
-      if (item.parent) {
-        data[item.parent.pk].children.push(item);
+      if (item.parent_pk) {
+        data[item.parent_pk].children.push(item);
       } else {
         tree.push(item);
       }

package/with-pz-config.js

@@ -97,7 +97,7 @@ const withPzConfig = (
     return [...pzRewrites, ...myRewrites];
   };
 
-  if (options.useCacheHandler) {
+  if (options.useCacheHandler && process.env.CACHE_HOST) {
     extendedConfig.cacheHandler = require.resolve('./lib/cache-handler.mjs');
   }