@akinon/next 1.44.0 → 1.45.0-rc.1

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());
@@ -84,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/')) {
@@ -203,6 +237,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,

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/middlewares/pretty-url.ts

@@ -56,6 +56,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

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.44.0",
+  "version": "1.45.0-rc.1",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -20,21 +20,22 @@
     "@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",
-    "semver": "7.5.4",
+    "redis": "4.6.13",
+    "semver": "7.6.2",
     "set-cookie-parser": "2.6.0"
   },
   "devDependencies": {
+    "@akinon/eslint-plugin-projectzero": "1.45.0-rc.1",
     "@types/react-redux": "7.1.30",
     "@types/set-cookie-parser": "2.4.7",
     "@typescript-eslint/eslint-plugin": "6.7.4",
     "@typescript-eslint/parser": "6.7.4",
     "eslint": "^8.14.0",
-    "@akinon/eslint-plugin-projectzero": "1.44.0",
     "eslint-config-prettier": "8.5.0"
   }
 }

package/plugins.d.ts

@@ -12,6 +12,7 @@ declare module '@akinon/pz-masterpass/src/utils' {
 declare module '@akinon/pz-masterpass/src/redux/reducer' {
   export const setError: any;
   export const setOtpModalVisible: any;
+  export const setCvcRequired: any;
 }
 
 declare module '@akinon/pz-otp' {

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,10 +28,11 @@ 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: {
-    errors?: any;
+    errors?: Record<string, string[]>;
     pre_order?: PreOrder;
     context_list?: CheckoutContext[];
   };
@@ -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,12 +14,13 @@ import {
   CheckoutCreditPaymentOption,
   PreOrder,
   RetailStore,
-  ShippingOption
+  ShippingOption,
+  DataSource,
+  AttributeBasedShippingOption
 } from '../../types';
 
 export interface CheckoutState {
-  // TODO: Add types
-  errors: any;
+  errors: Record<string, string[]>;
   hasGiftBox: boolean;
   canGuestPurchase: boolean;
   steps: {
@@ -37,6 +38,7 @@ export interface CheckoutState {
   addressList: Address[];
   deliveryOptions: DeliveryOption[];
   shippingOptions: ShippingOption[];
+  dataSourceShippingOptions: DataSource[];
   paymentOptions: PaymentOption[];
   creditPaymentOptions: CheckoutCreditPaymentOption[];
   selectedCreditPaymentPk: number;
@@ -47,6 +49,8 @@ export interface CheckoutState {
   selectedBankAccountPk: number;
   loyaltyBalance?: string;
   retailStores: RetailStore[];
+  attributeBasedShippingOptions: AttributeBasedShippingOption[];
+  selectedShippingOptions: Record<string, number>;
 }
 
 const initialState: CheckoutState = {
@@ -68,6 +72,7 @@ const initialState: CheckoutState = {
   addressList: [],
   deliveryOptions: [],
   shippingOptions: [],
+  dataSourceShippingOptions: [],
   paymentOptions: [],
   creditPaymentOptions: [],
   selectedCreditPaymentPk: null,
@@ -76,7 +81,9 @@ const initialState: CheckoutState = {
   installmentOptions: [],
   bankAccounts: [],
   selectedBankAccountPk: null,
-  retailStores: []
+  retailStores: [],
+  attributeBasedShippingOptions: [],
+  selectedShippingOptions: {}
 };
 
 const checkoutSlice = createSlice({
@@ -122,6 +129,9 @@ const checkoutSlice = createSlice({
     setShippingOptions(state, { payload }) {
       state.shippingOptions = payload;
     },
+    setDataSourceShippingOptions(state, { payload }) {
+      state.dataSourceShippingOptions = payload;
+    },
     setPaymentOptions(state, { payload }) {
       state.paymentOptions = payload;
     },
@@ -151,6 +161,12 @@ const checkoutSlice = createSlice({
     },
     setRetailStores(state, { payload }) {
       state.retailStores = payload;
+    },
+    setAttributeBasedShippingOptions(state, { payload }) {
+      state.attributeBasedShippingOptions = payload;
+    },
+    setSelectedShippingOptions: (state, { payload }) => {
+      state.selectedShippingOptions = payload;
     }
   }
 });
@@ -169,6 +185,7 @@ export const {
   setAddressList,
   setDeliveryOptions,
   setShippingOptions,
+  setDataSourceShippingOptions,
   setPaymentOptions,
   setCreditPaymentOptions,
   setSelectedCreditPaymentPk,
@@ -178,7 +195,9 @@ export const {
   setBankAccounts,
   setSelectedBankAccountPk,
   setLoyaltyBalance,
-  setRetailStores
+  setRetailStores,
+  setAttributeBasedShippingOptions,
+  setSelectedShippingOptions
 } = checkoutSlice.actions;
 
 export default checkoutSlice.reducer;

package/redux/reducers/config.ts

@@ -6,6 +6,8 @@ import { Config } from '../../types';
 const initialState: Config = {
   user_phone_regex: '^(05)\\d{9}$',
   user_phone_format: '05999999999',
+  user_post_code_regex: '^\\d{5}$',
+  user_post_code_format: '99999',
   country: {
     pk: 1,
     name: 'Türkiye',

package/routes/pretty-url.tsx

@@ -0,0 +1,194 @@
+import { URLS } from '@akinon/next/data/urls';
+import { Metadata, PageProps } from '@akinon/next/types';
+import logger from '@akinon/next/utils/log';
+import { notFound } from 'next/navigation';
+
+type PrettyUrlResult = {
+  matched: boolean;
+  path?: string;
+  pk?: number;
+};
+
+const resolvePrettyUrlHandler =
+  (pathname: string, ip: string | null) => async () => {
+    let results = [] as { old_path: string }[];
+    let prettyUrlResult: PrettyUrlResult = {
+      matched: false
+    };
+
+    try {
+      const requestUrl = URLS.misc.prettyUrls(`/${pathname}/`);
+
+      logger.debug(`Resolving pretty url`, { pathname, requestUrl, ip });
+
+      const start = Date.now();
+      const apiResponse = await fetch(requestUrl, {
+        next: {
+          revalidate: 0
+        }
+      });
+      const data = await apiResponse.json();
+      ({ results } = data);
+      const end = Date.now();
+      console.warn('Pretty url response time', end - start, requestUrl);
+
+      const matched = results.length > 0;
+      const [{ old_path: path } = { old_path: '' }] = results;
+      let pk;
+
+      if (matched) {
+        const pkRegex = /\/(\d+)\/$/;
+        const match = path.match(pkRegex);
+        pk = match ? parseInt(match[1]) : undefined;
+      }
+
+      prettyUrlResult = {
+        matched,
+        path,
+        pk
+      };
+
+      logger.trace('Pretty url result', { prettyUrlResult, ip });
+    } catch (error) {
+      logger.error('Error resolving pretty url', { error, pathname, ip });
+    }
+
+    return prettyUrlResult;
+  };
+
+export async function generateMetadata({ params }: PageProps) {
+  let result: Metadata = {};
+  const { prettyurl } = params;
+  const pageSlug = prettyurl
+    .filter((x) => !x.startsWith('searchparams'))
+    .join('/');
+
+  const searchParams = Object.fromEntries(
+    new URLSearchParams(
+      decodeURIComponent(
+        prettyurl
+          .find((x) => x.startsWith('searchparams'))
+          ?.replace('searchparams%7C', '')
+      ) ?? {}
+    ).entries()
+  );
+
+  const prettyUrlResult = await resolvePrettyUrlHandler(pageSlug, null)();
+
+  if (!prettyUrlResult.matched) {
+    return notFound();
+  }
+
+  const commonProps = {
+    params: {
+      ...params,
+      pk: prettyUrlResult.pk
+    },
+    searchParams
+  };
+
+  try {
+    if (prettyUrlResult.path.startsWith('/product/')) {
+      await import('@product/[pk]/page').then(async (module) => {
+        result = await module['generateMetadata']?.(commonProps);
+      });
+    }
+
+    if (prettyUrlResult.path.startsWith('/group-product/')) {
+      await import('@group-product/[pk]/page').then(async (module) => {
+        result = await module['generateMetadata']?.(commonProps);
+      });
+    }
+
+    if (prettyUrlResult.path.startsWith('/category/')) {
+      await import('@category/[pk]/page').then(async (module) => {
+        result = await module['generateMetadata']?.(commonProps);
+      });
+    }
+
+    if (prettyUrlResult.path.startsWith('/special-page/')) {
+      await import('@special-page/[pk]/page').then(async (module) => {
+        result = await module['generateMetadata']?.(commonProps);
+      });
+    }
+
+    if (prettyUrlResult.path.startsWith('/flat-page/')) {
+      await import('@flat-page/[pk]/page').then(async (module) => {
+        result = await module['generateMetadata']?.(commonProps);
+      });
+    }
+    // eslint-disable-next-line no-empty
+  } catch (error) {}
+
+  return result;
+}
+
+export const dynamic = 'force-static';
+export const revalidate = 300;
+
+export default async function Page({ params }) {
+  const { prettyurl } = params;
+  const pageSlug = prettyurl
+    .filter((x) => !x.startsWith('searchparams'))
+    .join('/');
+
+  const urlSearchParams = new URLSearchParams(
+    decodeURIComponent(
+      prettyurl
+        .find((x) => x.startsWith('searchparams'))
+        ?.replace('searchparams%7C', '')
+    ) ?? {}
+  );
+
+  const searchParams = {};
+
+  for (const [key, value] of urlSearchParams.entries() as unknown as Array<
+    [string, string]
+  >) {
+    if (!searchParams[key]) {
+      searchParams[key] = [];
+    }
+    searchParams[key].push(value);
+  }
+
+  const result = await resolvePrettyUrlHandler(pageSlug, null)();
+
+  if (!result.matched) {
+    return notFound();
+  }
+
+  const commonProps = {
+    params: {
+      ...params,
+      pk: result.pk
+    },
+    searchParams
+  };
+
+  if (result.path.startsWith('/category/')) {
+    const CategoryPage = (await import('@category/[pk]/page')).default;
+    return <CategoryPage {...commonProps} />;
+  }
+
+  if (result.path.startsWith('/product/')) {
+    const ProductPage = (await import('@product/[pk]/page')).default;
+    return <ProductPage {...commonProps} />;
+  }
+
+  if (result.path.startsWith('/group-product/')) {
+    const GroupProduct = (await import('@group-product/[pk]/page')).default;
+    return <GroupProduct {...commonProps} />;
+  }
+
+  if (result.path.startsWith('/special-page/')) {
+    const SpecialPage = (await import('@special-page/[pk]/page')).default;
+    return <SpecialPage {...commonProps} />;
+  }
+
+  if (result.path.startsWith('/flat-page/')) {
+    const FlatPage = (await import('@flat-page/[pk]/page')).default;
+    return <FlatPage {...commonProps} />;
+  }
+
+  return null;
+}

package/types/commerce/account.ts

@@ -61,4 +61,5 @@ export type ContactFormType = {
   order?: string;
   country_code?: string;
   order_needed?: boolean;
+  file?: FileList
 };

package/types/commerce/address.ts

@@ -17,7 +17,7 @@ export type AddressFormType = {
   line: string;
   postcode: string;
   company_name?: string;
-  tax_no?: number;
+  tax_no?: string;
   tax_office?: string;
   e_bill_taxpayer?: boolean;
   country_code?: string;