@akinon/next 1.55.0 → 1.56.0-rc.0

package/routes/pretty-url.tsx

@@ -0,0 +1,192 @@
+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 = new URLSearchParams(
+    decodeURIComponent(
+      prettyurl
+        .find((x) => x.startsWith('searchparams'))
+        ?.replace('searchparams%7C', '')
+    ) ?? {}
+  );
+
+  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: new URLSearchParams(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;

package/types/commerce/b2b.ts

@@ -72,7 +72,7 @@ export type BasketItemType = {
   divisions: BasketItemDivision[];
   product: ProductB2b;
   product_remote_id: number;
-}
+};
 
 export type BasketParams = {
   division: string;
@@ -91,7 +91,7 @@ export type CreateQuotationParams = {
 export type UpdateProductParams = {
   product_remote_id: number;
   division: number;
-  quantity: number
+  quantity: number;
 };
 
 export type DeleteProductParams = {
@@ -115,3 +115,13 @@ export type DraftResponse = {
   total_amount: number;
   total_quantity: number;
 };
+
+export type BasketStatusResponse = {
+  is_ready: boolean;
+  status: string;
+  url: string;
+};
+
+export type ExportBasketResponse = {
+  cache_key: string;
+};

package/types/commerce/checkout.ts

@@ -34,6 +34,23 @@ export interface ShippingOption {
   slug: string;
 }
 
+export interface DataSource {
+  pk: number;
+  name: string;
+  data_source_shipping_options: DataSourceShippingOption[];
+}
+
+export interface DataSourceShippingOption {
+  pk: number;
+  shipping_amount: string;
+  shipping_option_name: string;
+  shipping_option_logo: string | null;
+  data_source: {
+    pk: number;
+    title: string | null;
+  };
+}
+
 export interface CheckoutAddressType {
   label: string;
   text: string;
@@ -79,6 +96,8 @@ export interface PreOrder {
   retail_store?: RetailStore;
   gift_box?: GiftBox;
   credit_payment_option?: CheckoutCreditPaymentOption;
+  data_source_shipping_options: any;
+  attribute_based_shipping_options?: AttributeBasedShippingOption[];
   bags?: Product[];
   bags_fee?: string;
 }
@@ -120,6 +139,7 @@ export interface CheckoutContext {
     redirect_url?: string;
     context_data?: any;
     balance?: string;
+    attribute_based_shipping_options?: AttributeBasedShippingOption[];
     [key: string]: any;
   };
 }
@@ -145,3 +165,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/types/commerce/order.ts

@@ -114,6 +114,7 @@ export interface Order {
     pk: number;
     name: string;
     slug: string;
+    logo: string;
     [key: string]: any;
   };
 }

package/types/index.ts

@@ -68,9 +68,17 @@ export interface Currency {
    * @see https://en.wikipedia.org/wiki/ISO_4217
    */
   code: string;
+  /**
+   * Number of decimal places to display.
+   *
+   * @example
+   * decimalScale: 3
+   */
+  decimalScale?: number;
 }
 
 export interface Settings {
+  usePrettyUrlRoute?: boolean;
   commerceUrl: string;
   redis: {
     defaultExpirationTime: number;
@@ -183,7 +191,9 @@ export interface Settings {
     masterpassJsUrl?: string;
   };
   customNotFoundEnabled: boolean;
+  useOptimizedTranslations?: boolean;
   plugins?: Record<string, Record<string, any>>;
+  includedProxyHeaders?: string[];
 }
 
 export interface CacheOptions {
@@ -215,7 +225,7 @@ export type ImageOptions = CDNOptions & {
 export type Translations = { [key: string]: object };
 
 export interface PageProps<T = any> {
-  params: T;
+  params: T & { locale: string; currency: string };
   searchParams: URLSearchParams;
 }
 
@@ -224,7 +234,11 @@ export interface LayoutProps<T = any> extends PageProps<T> {
 }
 
 export interface RootLayoutProps<
-  T = { commerce: string; locale: string; currency: string }
+  T = {
+    commerce: string;
+    locale: string;
+    currency: string;
+  }
 > extends LayoutProps<T> {
   translations: Translations;
   locale: Locale & {
@@ -250,6 +264,8 @@ export interface ButtonProps
   appearance?: 'filled' | 'outlined' | 'ghost';
 }
 
+export type FileInputProps = React.HTMLProps<HTMLInputElement>;
+
 export interface PriceProps {
   currencyCode?: string;
   useCurrencySymbol?: boolean;

package/utils/app-fetch.ts

@@ -1,18 +1,26 @@
 import Settings from 'settings';
-import { ServerVariables } from './server-variables';
 import logger from '../utils/log';
 import { headers, cookies } from 'next/headers';
+import { ServerVariables } from './server-variables';
 
 export enum FetchResponseType {
   JSON = 'json',
   TEXT = 'text'
 }
 
-const appFetch = async <T>(
-  url: RequestInfo,
-  init: RequestInit = {},
+const appFetch = async <T>({
+  url,
+  locale,
+  currency,
+  init = {},
   responseType = FetchResponseType.JSON
-): Promise<T> => {
+}: {
+  url: RequestInfo;
+  locale: string;
+  currency: string;
+  init?: RequestInit;
+  responseType?: FetchResponseType;
+}): Promise<T> => {
   let response: T;
   let status: number;
   let ip = '';
@@ -24,7 +32,7 @@ const appFetch = async <T>(
 
     const commerceUrl = Settings.commerceUrl;
     const currentLocale = Settings.localization.locales.find(
-      (locale) => locale.value === ServerVariables.locale
+      (l) => l.value === locale
     );
 
     if (commerceUrl === 'default') {
@@ -36,14 +44,15 @@ const appFetch = async <T>(
 
     init.headers = {
       ...(init.headers ?? {}),
+      ...(ServerVariables.globalHeaders ?? {}),
       'Accept-Language': currentLocale.apiValue,
-      'x-currency': ServerVariables.currency,
+      'x-currency': currency,
       'x-forwarded-for': ip,
       cookie: nextCookies.toString()
     };
 
     init.next = {
-      revalidate: 60
+      revalidate: Settings.usePrettyUrlRoute ? 0 : 60
     };
 
     logger.debug(`FETCH START ${url}`, { requestURL, init, ip });

package/utils/generate-commerce-search-params.ts

@@ -1,6 +1,8 @@
 import logger from './log';
 
-export const generateCommerceSearchParams = (searchParams?: URLSearchParams) => {
+export const generateCommerceSearchParams = (
+  searchParams?: URLSearchParams
+) => {
   if (!searchParams) {
     return null;
   }

package/utils/index.ts

@@ -63,18 +63,33 @@ export function getTranslateFn(path: string, translations: any) {
 
 export function buildClientRequestUrl(
   path: string,
-  options?: ClientRequestOptions
+  options?: ClientRequestOptions & { cache?: boolean }
 ) {
   let url = `/api/client${path}`;
 
+  let hasQuery = url.includes('?');
+
   if (options) {
-    if (url.includes('?')) {
-      url += '&';
-    } else {
-      url += '?';
+    const { cache, ...otherOptions } = options;
+
+    if (Object.keys(otherOptions).length > 0) {
+      if (hasQuery) {
+        url += '&';
+      } else {
+        url += '?';
+        hasQuery = true;
+      }
+      url += `options=${encodeURIComponent(JSON.stringify(otherOptions))}`;
     }
 
-    url += `options=${encodeURIComponent(JSON.stringify(options))}`;
+    if (cache === false) {
+      if (hasQuery) {
+        url += '&';
+      } else {
+        url += '?';
+      }
+      url += `t=${Date.now()}`;
+    }
   }
 
   return url;
@@ -102,6 +117,12 @@ export function buildCDNUrl(url: string, config?: CDNOptions) {
     ''
   );
 
+  const noOptionFileExtension = url?.split('.').pop()?.toLowerCase() ?? '';
+
+  if (noOptionFileExtension === 'svg' || noOptionFileExtension === 'gif') {
+    return url;
+  }
+
   let options = '';
 
   if (config) {

package/utils/redirection-iframe.ts

@@ -0,0 +1,85 @@
+const iframeURLChange = (iframe, callback) => {
+  iframe.addEventListener('load', () => {
+    setTimeout(() => {
+      if (iframe?.contentWindow?.location) {
+        callback(iframe.contentWindow.location);
+      }
+    }, 0);
+  });
+};
+
+const removeIframe = async () => {
+  const iframeSelector = document.querySelector(
+    '.checkout-payment-redirection-iframe-wrapper'
+  );
+
+  const redirectionPaymentWrapper = document.querySelector(
+    '.checkout-redirection-payment-wrapper'
+  );
+
+  const form = redirectionPaymentWrapper.querySelector('form') as HTMLElement;
+
+  if (!iframeSelector) {
+    return;
+  }
+
+  iframeSelector.remove();
+
+  if (form) {
+    form.style.display = 'block';
+  }
+
+  location.reload();
+};
+
+export const showRedirectionIframe = (redirectUrl: string) => {
+  const iframeWrapper = document.createElement('div');
+  const iframe = document.createElement('iframe');
+  const closeButton = document.createElement('div');
+  const redirectionPaymentWrapper = document.querySelector(
+    '.checkout-redirection-payment-wrapper'
+  );
+  const form = redirectionPaymentWrapper.querySelector('form') as HTMLElement;
+
+  iframeWrapper.className = 'checkout-payment-redirection-iframe-wrapper';
+  closeButton.className = 'close-button';
+
+  iframe.setAttribute('src', redirectUrl);
+  closeButton.innerHTML = '&#x2715';
+  closeButton.addEventListener('click', removeIframe);
+
+  iframeWrapper.append(iframe, closeButton);
+
+  if (form) {
+    form.style.display = 'none';
+  }
+
+  redirectionPaymentWrapper.appendChild(iframeWrapper);
+
+  iframeURLChange(iframe, (location) => {
+    if (location.origin !== window.location.origin) {
+      return false;
+    }
+
+    const searchParams = new URLSearchParams(location.search);
+    const isOrderCompleted = location.href.includes('/orders/completed');
+
+    if (isOrderCompleted) {
+      (window.parent as any)?.postMessage?.(
+        JSON.stringify({
+          url: location.pathname
+        })
+      );
+    }
+
+    if (
+      searchParams.has('success') ||
+      isOrderCompleted ||
+      location.href.includes('/orders/checkout')
+    ) {
+      setTimeout(() => {
+        removeIframe();
+      }, 0);
+    }
+  });
+};

package/utils/server-translation.ts

@@ -8,7 +8,6 @@ import logger from './log';
 
 export const translations: Translations = {};
 
-// TODO: Read translations from cache
 export async function getTranslations(locale_: string) {
   try {
     const locale = settings.localization.locales.find(
@@ -55,3 +54,14 @@ export async function getTranslations(locale_: string) {
 export function t(path: string) {
   return getTranslateFn(path, translations);
 }
+
+export async function t_(path: string, locale?: string) {
+  let translations_ = translations;
+
+  if (settings.useOptimizedTranslations && locale) {
+    const { getTranslations } = require('translations');
+    translations_ = await getTranslations(locale);
+  }
+
+  return getTranslateFn(path, translations_);
+}

package/utils/server-variables.ts

@@ -5,5 +5,6 @@ const { locales, defaultLocaleValue, defaultCurrencyCode } =
 
 export const ServerVariables = {
   locale: locales.find((l) => l.value === defaultLocaleValue)?.value ?? '',
-  currency: defaultCurrencyCode
+  currency: defaultCurrencyCode,
+  globalHeaders: {}
 };

package/with-pz-config.js

@@ -8,6 +8,7 @@ const defaultConfig = {
   transpilePackages: ['@akinon/next', ...pzPlugins.map((p) => `@akinon/${p}`)],
   skipTrailingSlashRedirect: true,
   poweredByHeader: false,
+  cacheMaxMemorySize: 0,
   env: {
     NEXT_PUBLIC_SENTRY_DSN: process.env.SENTRY_DSN
   },
@@ -56,7 +57,8 @@ const defaultConfig = {
       ...pzPlugins.reduce((acc, plugin) => {
         acc[`@akinon/${plugin}`] = false;
         return acc;
-      }, {})
+      }, {}),
+      translations: false
     };
     return config;
   },
@@ -65,7 +67,12 @@ const defaultConfig = {
   }
 };
 
-const withPzConfig = (myNextConfig = {}) => {
+const withPzConfig = (
+  myNextConfig = {},
+  options = {
+    useCacheHandler: false
+  }
+) => {
   let extendedConfig = deepMerge({}, defaultConfig, myNextConfig);
 
   const originalPzHeadersFunction = defaultConfig.headers;
@@ -91,6 +98,10 @@ const withPzConfig = (myNextConfig = {}) => {
     return [...pzRewrites, ...myRewrites];
   };
 
+  if (options.useCacheHandler && process.env.CACHE_HOST) {
+    extendedConfig.cacheHandler = require.resolve('./lib/cache-handler.mjs');
+  }
+
   return extendedConfig;
 };