@akinon/next 1.13.1 → 1.14.0

package/types/index.ts

@@ -1,237 +1,274 @@
-import { LocaleUrlStrategy } from '../localization';
-import { PzNextRequest } from '../middlewares';
-
-declare global {
-  export interface Window {
-    dataLayer: Record<string, any>[];
-  }
-}
-
-export * from './commerce';
-export * from './gtm';
-export * from './metadata';
-
-export interface Locale {
-  label: string;
-  /**
-   * Lowercased locale value in `ISO 639-1` format or including country code in `ISO 3166-1 alpha-2` format.
-   *
-   * -- If you use uppercase characters, it will be considered as lowercase.
-   *
-   * ***
-   * @example
-   * value: 'en'
-   * value: 'en-us'
-   * value: 'tr'
-   *
-   * @see https://en.wikipedia.org/wiki/ISO_639-1
-   * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
-   */
-  value: string;
-  localePath?: string;
-  /**
-   * Corresponding Commerce API value for fetching data. It will be used in `Accept-Language` header.
-   */
-  apiValue: string;
-  rtl?: boolean;
-}
-
-export interface Currency {
-  /**
-   * It will be used for displaying currency in currency switcher.
-   * Can be symbol, code, etc.
-   *
-   * @example
-   * label: '$'
-   * label: '€'
-   * label: 'USD'
-   * label: 'US Dollar'
-   * label: '$ - USD'
-   */
-  label: string;
-  /**
-   * Lowercased currency code in `ISO 4217` format.
-   *
-   * It should match with one of the values returned from Commerce API.
-   *
-   * @example
-   * code: 'usd'
-   * code: 'eur'
-   * code: 'try'
-   *
-   * @see https://en.wikipedia.org/wiki/ISO_4217
-   */
-  code: string;
-}
-
-export interface Settings {
-  commerceUrl: string;
-  redis: {
-    defaultExpirationTime: number;
-  };
-  commonProductAttributes: Array<{
-    translationKey: string;
-    key: string;
-  }>;
-  localization: {
-    locales: Locale[];
-    currencies: Array<Currency>;
-    /**
-     * Default locale value in `ISO 639-1` format or including country code in `ISO 3166-1 alpha-2` format.
-     *
-     * It will be used for redirections and fallbacks.
-     *
-     * It should be one of the values in `locales` array.
-     */
-    defaultLocaleValue: string;
-    /**
-     * Determines url behavior according to locale.
-     *
-     * Available options:
-     * - LocaleUrlStrategy.HideDefaultLocale
-     * - LocaleUrlStrategy.HideAllLocales
-     * - LocaleUrlStrategy.ShowAllLocales
-     *
-     * @default LocaleUrlStrategy.HideDefaultLocale
-     *
-     * @example
-     * // Example configuration
-     * locales: [{ value: 'en'}, { value: 'tr' }]
-     * defaultLocaleValue: 'en'
-     * // -------------------------------
-     *
-     * LocaleUrlStrategy.HideDefaultLocale:
-     *    en -> "/women"
-     *    tr -> "/tr/women"
-     *
-     * LocaleUrlStrategy.ShowAllLocales:
-     *    en -> "/en/women"
-     *    tr -> "/tr/women"
-     *
-     * LocaleUrlStrategy.HideAllLocales:
-     *    en -> "/women"
-     *    tr -> "/women"
-     */
-    localeUrlStrategy?: LocaleUrlStrategy;
-    redirectToDefaultLocale?: boolean;
-    defaultCurrencyCode: string;
-    /**
-     * The default behavior of `getActiveCurrencyCode` function is to get active currency code from cookie named `pz-currency`.
-     *
-     * You can use this function to override existing and get currency code from cookie, header, url, etc.
-     *
-     * If return value does not match with any currency code in `currencies` array, default currency code will be used.
-     *
-     * @param req - Incoming request. You can use this to get cookie, header, url, etc.
-     * @param locale - Active locale value. E.g. 'en', 'tr', 'en-us', 'tr-tr'
-     * @param defaultCurrencyCode - Default currency code in `ISO 4217` format. E.g. 'usd', 'eur', 'try'
-     * @returns Currency code in `ISO 4217` format. E.g. 'usd', 'eur', 'try'
-     *
-     * @example
-     * getActiveCurrencyCode: ({ req, locale, defaultCurrencyCode }) => {
-     *  const [, countryCode] = locale.split('-');
-     *
-     *  if (countryCode === 'ae') {
-     *   return 'aed';
-     *  } else if (countryCode === 'qa') {
-     *    return 'qar';
-     *  }
-     *
-     *  return defaultCurrencyCode;
-     * }
-     */
-    getActiveCurrencyCode?: ({
-      req,
-      locale,
-      defaultCurrencyCode
-    }: {
-      req: PzNextRequest;
-      locale: string;
-      defaultCurrencyCode: string;
-    }) => string;
-    /**
-     * By default, pretty url resolver excludes locale from url.
-     * In some cases, you may want to create flatpages and include locale in urls.
-     * This is useful if you want to manage your flatpages for different countries by using locale value.
-     *
-     * @example
-     * // URL entered in Omnitron: /en-us/pages/about-us
-     * // Locale Strategy: LocaleUrlStrategy.ShowAllLocales
-     *
-     * // If you don't use this option, pretty url resolver will remove the locale and it will be resolved as '/pages/about-us' and you will get 404. Because there is no page with this url. But if you use this option, it will be resolved as '/en-us/pages/about-us' and you will get the page.
-     * // Following pattern will include locale for all urls including '/pages/'.
-     * localeIncludedPrettyUrlPattern: new RegExp('.+/pages/.+$')
-     */
-    localeIncludedPrettyUrlPattern?: RegExp;
-  };
-  rewrites?: Array<{
-    source: string;
-    destination: string;
-  }>;
-  checkout?: {
-    /**
-     * If there is a need to exclude certain payment options from the iframe, for instance, due to CORS issues, this option can be utilized by passing the slugs associated with the desired payment options.
-     */
-    iframeExcludedPaymentOptions?: string[];
-    extraPaymentTypes?: string[];
-  };
-}
-
-export interface CacheOptions {
-  cache?: boolean;
-  expire?: number;
-  useProxy?: boolean;
-}
-
-export interface ClientRequestOptions {
-  useTrailingSlash?: boolean;
-  useFormData?: boolean;
-  accept?: string;
-  contentType?: string;
-  responseType?: 'json' | 'text';
-}
-
-export type CDNOptions = {
-  width?: number;
-  height?: number;
-  quality?: number;
-  crop?: 'center' | 'top' | 'bottom' | 'left' | 'right';
-  upscale?: boolean;
-};
-
-export type ImageOptions = CDNOptions & {
-  sources?: Array<{ media: string; options: CDNOptions }>;
-};
-
-export type Translations = { [key: string]: object };
-
-export interface PageProps<T = any> {
-  params: T;
-  searchParams: URLSearchParams;
-}
-
-export interface LayoutProps<T = any> extends PageProps<T> {
-  children: React.ReactNode;
-}
-
-export interface RootLayoutProps<
-  T = { commerce: string; locale: string; currency: string }
-> extends LayoutProps<T> {
-  translations: Translations;
-  locale: Locale & {
-    isoCode: string;
-  };
-}
-
-export type RadioProps = React.HTMLProps<HTMLInputElement>;
-
-export interface AuthError {
-  type: string;
-  data?: any;
-}
-
-export interface IconProps extends React.ComponentPropsWithRef<'i'> {
-  name: string;
-  size?: number;
-  className?: string;
-}
+import { LocaleUrlStrategy } from '../localization';
+import { PzNextRequest } from '../middlewares';
+import { Control, FieldError } from 'react-hook-form';
+import { ReactNode } from 'react';
+
+declare global {
+  export interface Window {
+    dataLayer: Record<string, any>[];
+  }
+}
+
+export * from './commerce';
+export * from './gtm';
+export * from './metadata';
+
+export interface Locale {
+  label: string;
+  /**
+   * Lowercased locale value in `ISO 639-1` format or including country code in `ISO 3166-1 alpha-2` format.
+   *
+   * -- If you use uppercase characters, it will be considered as lowercase.
+   *
+   * ***
+   * @example
+   * value: 'en'
+   * value: 'en-us'
+   * value: 'tr'
+   *
+   * @see https://en.wikipedia.org/wiki/ISO_639-1
+   * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+   */
+  value: string;
+  localePath?: string;
+  /**
+   * Corresponding Commerce API value for fetching data. It will be used in `Accept-Language` header.
+   */
+  apiValue: string;
+  rtl?: boolean;
+}
+
+export interface Currency {
+  /**
+   * It will be used for displaying currency in currency switcher.
+   * Can be symbol, code, etc.
+   *
+   * @example
+   * label: '$'
+   * label: '€'
+   * label: 'USD'
+   * label: 'US Dollar'
+   * label: '$ - USD'
+   */
+  label: string;
+  /**
+   * Lowercased currency code in `ISO 4217` format.
+   *
+   * It should match with one of the values returned from Commerce API.
+   *
+   * @example
+   * code: 'usd'
+   * code: 'eur'
+   * code: 'try'
+   *
+   * @see https://en.wikipedia.org/wiki/ISO_4217
+   */
+  code: string;
+}
+
+export interface Settings {
+  commerceUrl: string;
+  redis: {
+    defaultExpirationTime: number;
+  };
+  commonProductAttributes: Array<{
+    translationKey: string;
+    key: string;
+  }>;
+  localization: {
+    locales: Locale[];
+    currencies: Array<Currency>;
+    /**
+     * Default locale value in `ISO 639-1` format or including country code in `ISO 3166-1 alpha-2` format.
+     *
+     * It will be used for redirections and fallbacks.
+     *
+     * It should be one of the values in `locales` array.
+     */
+    defaultLocaleValue: string;
+    /**
+     * Determines url behavior according to locale.
+     *
+     * Available options:
+     * - LocaleUrlStrategy.HideDefaultLocale
+     * - LocaleUrlStrategy.HideAllLocales
+     * - LocaleUrlStrategy.ShowAllLocales
+     *
+     * @default LocaleUrlStrategy.HideDefaultLocale
+     *
+     * @example
+     * // Example configuration
+     * locales: [{ value: 'en'}, { value: 'tr' }]
+     * defaultLocaleValue: 'en'
+     * // -------------------------------
+     *
+     * LocaleUrlStrategy.HideDefaultLocale:
+     *    en -> "/women"
+     *    tr -> "/tr/women"
+     *
+     * LocaleUrlStrategy.ShowAllLocales:
+     *    en -> "/en/women"
+     *    tr -> "/tr/women"
+     *
+     * LocaleUrlStrategy.HideAllLocales:
+     *    en -> "/women"
+     *    tr -> "/women"
+     */
+    localeUrlStrategy?: LocaleUrlStrategy;
+    redirectToDefaultLocale?: boolean;
+    defaultCurrencyCode: string;
+    /**
+     * The default behavior of `getActiveCurrencyCode` function is to get active currency code from cookie named `pz-currency`.
+     *
+     * You can use this function to override existing and get currency code from cookie, header, url, etc.
+     *
+     * If return value does not match with any currency code in `currencies` array, default currency code will be used.
+     *
+     * @param req - Incoming request. You can use this to get cookie, header, url, etc.
+     * @param locale - Active locale value. E.g. 'en', 'tr', 'en-us', 'tr-tr'
+     * @param defaultCurrencyCode - Default currency code in `ISO 4217` format. E.g. 'usd', 'eur', 'try'
+     * @returns Currency code in `ISO 4217` format. E.g. 'usd', 'eur', 'try'
+     *
+     * @example
+     * getActiveCurrencyCode: ({ req, locale, defaultCurrencyCode }) => {
+     *  const [, countryCode] = locale.split('-');
+     *
+     *  if (countryCode === 'ae') {
+     *   return 'aed';
+     *  } else if (countryCode === 'qa') {
+     *    return 'qar';
+     *  }
+     *
+     *  return defaultCurrencyCode;
+     * }
+     */
+    getActiveCurrencyCode?: ({
+      req,
+      locale,
+      defaultCurrencyCode
+    }: {
+      req: PzNextRequest;
+      locale: string;
+      defaultCurrencyCode: string;
+    }) => string;
+    /**
+     * By default, pretty url resolver excludes locale from url.
+     * In some cases, you may want to create flatpages and include locale in urls.
+     * This is useful if you want to manage your flatpages for different countries by using locale value.
+     *
+     * @example
+     * // URL entered in Omnitron: /en-us/pages/about-us
+     * // Locale Strategy: LocaleUrlStrategy.ShowAllLocales
+     *
+     * // If you don't use this option, pretty url resolver will remove the locale and it will be resolved as '/pages/about-us' and you will get 404. Because there is no page with this url. But if you use this option, it will be resolved as '/en-us/pages/about-us' and you will get the page.
+     * // Following pattern will include locale for all urls including '/pages/'.
+     * localeIncludedPrettyUrlPattern: new RegExp('.+/pages/.+$')
+     */
+    localeIncludedPrettyUrlPattern?: RegExp;
+  };
+  rewrites?: Array<{
+    source: string;
+    destination: string;
+  }>;
+  checkout?: {
+    /**
+     * If there is a need to exclude certain payment options from the iframe, for instance, due to CORS issues, this option can be utilized by passing the slugs associated with the desired payment options.
+     */
+    iframeExcludedPaymentOptions?: string[];
+    extraPaymentTypes?: string[];
+  };
+}
+
+export interface CacheOptions {
+  cache?: boolean;
+  expire?: number;
+  useProxy?: boolean;
+}
+
+export interface ClientRequestOptions {
+  useTrailingSlash?: boolean;
+  useFormData?: boolean;
+  accept?: string;
+  contentType?: string;
+  responseType?: 'json' | 'text';
+}
+
+export type CDNOptions = {
+  width?: number;
+  height?: number;
+  quality?: number;
+  crop?: 'center' | 'top' | 'bottom' | 'left' | 'right';
+  upscale?: boolean;
+};
+
+export type ImageOptions = CDNOptions & {
+  sources?: Array<{ media: string; options: CDNOptions }>;
+};
+
+export type Translations = { [key: string]: object };
+
+export interface PageProps<T = any> {
+  params: T;
+  searchParams: URLSearchParams;
+}
+
+export interface LayoutProps<T = any> extends PageProps<T> {
+  children: React.ReactNode;
+}
+
+export interface RootLayoutProps<
+  T = { commerce: string; locale: string; currency: string }
+> extends LayoutProps<T> {
+  translations: Translations;
+  locale: Locale & {
+    isoCode: string;
+  };
+}
+
+export type RadioProps = React.HTMLProps<HTMLInputElement>;
+
+export interface AuthError {
+  type: string;
+  data?: any;
+}
+
+export interface IconProps extends React.ComponentPropsWithRef<'i'> {
+  name: string;
+  size?: number;
+  className?: string;
+}
+
+export interface ButtonProps
+  extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+  appearance?: 'filled' | 'outlined' | 'ghost';
+}
+
+export interface PriceProps {
+  currencyCode?: string;
+  useCurrencySymbol?: boolean;
+  useCurrencyAfterPrice?: boolean;
+  useCurrencySpace?: boolean;
+  useNegative?: boolean;
+  useNegativeSpace?: boolean;
+}
+
+export interface InputProps extends React.HTMLProps<HTMLInputElement> {
+  label?: string;
+  labelStyle?: 'default' | 'floating';
+  error?: FieldError | undefined;
+  control?: Control<any, any>;
+  required?: boolean;
+}
+
+export interface AccordionProps {
+  isCollapse?: boolean;
+  title?: string;
+  subTitle?: string;
+  icons?: string[];
+  iconSize?: number;
+  iconColor?: string;
+  children?: ReactNode;
+  className?: string;
+  titleClassName?: string;
+  dataTestId?: string;
+}

package/types/metadata.ts

@@ -1,7 +1,7 @@
-import { Metadata as NextMetaData } from 'next';
-
-export interface Metadata extends NextMetaData {
-  alternates?: NextMetaData['alternates'] & {
-    languages?: Record<string, string>;
-  };
-}
+import { Metadata as NextMetaData } from 'next';
+
+export interface Metadata extends NextMetaData {
+  alternates?: NextMetaData['alternates'] & {
+    languages?: Record<string, string>;
+  };
+}

package/types/next-auth.d.ts

@@ -1,24 +1,24 @@
-import NextAuth from 'next-auth';
-
-declare module 'next-auth' {
-  interface User {
-    id?: number;
-    pk: number;
-    firstName: string;
-    lastName: string;
-    email: string;
-    phone: string;
-    emailAllowed: boolean;
-    smsAllowed: boolean;
-    dateJoined: string;
-    lastLogin: string;
-    dateOfBirth: string;
-    token: string;
-    hashedEmail: string;
-    gender: string;
-  }
-
-  interface Session {
-    user: User;
-  }
-}
+import NextAuth from 'next-auth';
+
+declare module 'next-auth' {
+  interface User {
+    id?: number;
+    pk: number;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone: string;
+    emailAllowed: boolean;
+    smsAllowed: boolean;
+    dateJoined: string;
+    lastLogin: string;
+    dateOfBirth: string;
+    token: string;
+    hashedEmail: string;
+    gender: string;
+  }
+
+  interface Session {
+    user: User;
+  }
+}