@akinon/next 1.0.0

package/types/commerce/misc.ts

@@ -0,0 +1,127 @@
+import { District } from './address';
+export interface Config {
+  user_phone_regex: string;
+  user_phone_format: string;
+  country: {
+    pk: number;
+    name: string;
+    code: string;
+  };
+}
+
+export interface RetailStore {
+  address: string;
+  name: string;
+  pk: number;
+  district: District;
+  township: {
+    name: string;
+    pk: number;
+    city: {
+      country: number;
+      name: string;
+      pk: number;
+    };
+  };
+}
+
+export type Pagination = {
+  current_page: number;
+  num_pages: number;
+  page_size: number;
+  total_count: number;
+};
+
+export type EmailSubscriptionType = {
+  email: string;
+  subscribe_contract: boolean;
+};
+
+export type ImageType = {
+  data_type?: 'image';
+  url?: string;
+  value?: string;
+};
+
+export interface Error {
+  status: number;
+  data: {
+    error_code: string;
+    non_field_errors: string;
+  };
+}
+
+export type Discount = {
+  description: string;
+  discount: string;
+};
+
+export type MenuItemExtraContentImageType = {
+  kwargs: {
+    value: {
+      image: {
+        url: string;
+        value: string;
+      };
+    };
+  };
+  value: {
+    image: string;
+    link_text: string;
+    title: string;
+    url: string;
+  };
+};
+
+export type MenuItemExtraContentStoryType = {
+  value: {
+    url: string;
+    alt: string;
+    image: string;
+  };
+  kwargs: {
+    data_type: 'nested';
+    value: {
+      image: ImageType;
+    };
+  };
+};
+
+export type MenuItemExtraContentType = {
+  attributes: {
+    category_id: number;
+    images: Array<MenuItemExtraContentImageType>;
+    [key: string]: any;
+  };
+  include_parent: boolean;
+  numchild: number;
+  [key: string]: any;
+};
+
+export type MenuItemType = {
+  extra_context: MenuItemExtraContentType;
+  generator_name: 'menu_item';
+  label: string;
+  level: number;
+  parent: null | MenuItemType;
+  parent_pk: null | string;
+  children: null | MenuItemType[];
+  path: string;
+  pk: string;
+  sort_order: number;
+  url: string;
+};
+
+export type ForgotPasswordFormType = {
+  email: string;
+};
+
+export interface UpsellDetail {
+  message: string;
+  params: {
+    partial_percentage: number;
+    required: number;
+    partial: number;
+    remaining: number;
+  };
+}

package/types/commerce/order.ts

@@ -0,0 +1,108 @@
+import { Product } from './product';
+import { Address } from './address';
+
+export interface OrderStatus {
+  value: string;
+  label: string;
+}
+
+export interface Currency {
+  value: string;
+  label: string;
+}
+
+export interface PaymentOption {
+  name: string;
+  payment_type: string;
+  payment_type_label: string;
+  pk: number;
+  slug: string;
+}
+
+export interface OrderItem {
+  id: number;
+  status: OrderStatus;
+  price_currency: Currency;
+  product: Product;
+  is_cancelled: boolean;
+  is_cancellable: boolean;
+  is_refundable: boolean;
+  is_tradable: boolean;
+  available_easy_return_shipping_companies: {
+    pk: number;
+    shipping_company: {
+      value: string;
+      label: string;
+    };
+  }[];
+  active_cancellation_request: [
+    {
+      easy_return: {
+        code: string;
+      };
+    }
+  ];
+  created_date: string;
+  modified_date: string;
+  price: string;
+  tax_rate: string;
+  retail_price: string;
+  order: number;
+  length: number;
+  quantity: string;
+  unit_price: string;
+  total_amount: string;
+}
+
+export interface Order {
+  id: number;
+  status: OrderStatus;
+  currency: Currency;
+  orderitem_set: OrderItem[];
+  discountitem_set: [
+    {
+      amount: string;
+      cancel_amount: string;
+      code: null;
+      created_date: string;
+      modified_date: string;
+      name: string;
+      offer_type: string;
+      order: number;
+      pk: number;
+      promotion: number;
+      session_offer_type: null;
+    }
+  ];
+  is_cancelled: boolean;
+  is_cancellable: boolean;
+  is_refundable: boolean;
+  shipping_address: Address;
+  billing_address: Address;
+  client_type: string;
+  payment_option: PaymentOption;
+  amount_without_discount: string;
+  is_payable: boolean;
+  created_date: string;
+  modified_date: string;
+  number: string;
+  amount: string;
+  discount_amount: string;
+  shipping_amount: string;
+  refund_amount: string;
+  discount_refund_amount: string;
+  shipping_refund_amount: string;
+  remote_addr: string;
+  has_gift_box: boolean;
+  language_code: string;
+  user_email: string;
+  shipping_option_slug: string;
+  payment_option_slug: string;
+  installment_count: 1;
+  installment_interest_amount: string;
+  user: number;
+  basket: number;
+  shipping_option: number;
+  tracking_number: string;
+  tracking_url: string;
+}

package/types/commerce/product.ts

@@ -0,0 +1,110 @@
+import { Category } from './category';
+
+type Values<T> = T[keyof T];
+
+export interface Product {
+  absolute_url: string;
+  attribute_set: number;
+  attributes: {
+    [key: string]: any;
+  };
+  attributes_kwargs: any;
+  base_code: string;
+  basket_offers: {
+    kwargs: { show_benefit_products: boolean };
+    label: string;
+    listing_kwargs: {
+      [key: string]: any;
+    };
+    pk: number;
+  };
+  currency_type: string;
+  data_source: null;
+  extra_attributes: {
+    [key: string]: any;
+  };
+  form_schema: null;
+  image?: string;
+  in_stock: boolean;
+  is_ready_to_basket: boolean;
+  name: string;
+  pk: number;
+  price: string;
+  price_type: string;
+  product_type: string;
+  productimage_set: Array<{
+    created_date: Date;
+    image: string;
+    order: number;
+    pk: number;
+    specialimage_set: Array<{
+      [key: string]: any;
+    }>;
+    status: string;
+  }>;
+  productvideo_set: Array<{
+    [key: string]: any;
+  }>;
+  retail_price: string;
+  sku: string;
+  stock: number;
+  unit_type: string;
+  created_date: string;
+  modified_date: string;
+  description?: string;
+  quantity: string;
+}
+
+export interface FavoriteItem {
+  pk: number;
+  product: Product;
+}
+
+export type VariantOption = {
+  in_stock: boolean;
+  is_selectable: boolean;
+  is_selectable_without_stock: boolean;
+  is_selected: boolean;
+  label: string;
+  order: string;
+  product: Product;
+  value: string;
+};
+
+export type StockResultType = [
+  {
+    address: string;
+    latitude: string;
+    longitude: string;
+    name: string;
+    stock: string;
+    store_hours: Array<any>;
+  }
+];
+
+export type FindInStoreFormType = {
+  store: string;
+  variant: string;
+  productPk: string;
+};
+
+export interface ProductCategoryResult {
+  count: number;
+  next: string;
+  previous: null | string;
+  results: Category[];
+}
+
+export type VariantType = {
+  attribute_key: Values<any>;
+  attribute_name: string;
+  options: Array<VariantOption>;
+};
+
+export type ProductResult = {
+  in_stock: boolean;
+  product: Product;
+  group_products?: Array<Product>;
+  selected_variant?: Product | null;
+  variants?: Array<VariantType>;
+};

package/types/commerce/widget.ts

@@ -0,0 +1,28 @@
+import { ImageType } from './misc';
+import { Product } from './product';
+
+export type WidgetType = {
+  kwargs?: {
+    data_type?: 'nested';
+    value?: {
+      image?: ImageType;
+      mobile_image?: ImageType;
+    };
+  };
+  value?: {
+    alt?: string;
+    image?: string;
+    mobile_image?: string;
+    url?: string;
+    item_slug?: string;
+    title?: string;
+  };
+};
+
+export type WidgetResultType<T> = {
+  attributes?: T;
+  products?: Array<Product>;
+  name?: string;
+  slug?: string;
+  template?: string;
+};

package/types/gtm.ts

@@ -0,0 +1,16 @@
+export interface GTMEvent {
+  Action: string;
+  Category?: string;
+  Label: string;
+  Value?: number;
+  ecommerce: Record<string, any>;
+  event: `ee${string}`;
+}
+
+export interface GTMUserType {
+  pk: number;
+  hashedEmail: string;
+  dateJoined: string;
+  gender: string;
+  emailAllowed: boolean;
+}

package/types/index.ts

@@ -0,0 +1,207 @@
+import { LocaleUrlStrategy } from '../localization';
+import { PzNextRequest } from '../middlewares';
+
+declare global {
+  export interface Window {
+    dataLayer: Record<string, any>[];
+  }
+}
+
+export * from './commerce';
+export * from './gtm';
+
+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;
+  };
+  rewrites?: Array<{
+    source: string;
+    destination: 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 interface AuthError {
+  type: string;
+  data?: any;
+}

package/types/next-auth.d.ts

@@ -0,0 +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;
+  }
+}

package/utils/app-fetch.ts

@@ -0,0 +1,62 @@
+import Settings from 'settings';
+import { ServerVariables } from './server-variables';
+import logger from '../utils/log';
+
+export enum FetchResponseType {
+  JSON = 'json',
+  TEXT = 'text'
+}
+
+const appFetch = async <T>(
+  url: RequestInfo,
+  init: RequestInit = {},
+  responseType = FetchResponseType.JSON
+) => {
+  let response: T;
+  let status: number;
+
+  try {
+    const commerceUrl = Settings.commerceUrl;
+    const currentLocale = Settings.localization.locales.find(
+      (locale) => locale.value === ServerVariables.locale
+    );
+
+    if (commerceUrl === 'default') {
+      logger.error('Commerce URL is not set. Current value is "default"');
+      return undefined;
+    }
+
+    const requestURL = `${decodeURIComponent(commerceUrl)}${url}`;
+
+    init.headers = {
+      ...(init.headers ?? {}),
+      'Accept-Language': currentLocale.apiValue,
+      'x-currency': ServerVariables.currency
+    };
+
+    init.next = {
+      revalidate: 60
+    };
+
+    logger.debug(`FETCH START ${url}`, { requestURL, init });
+    const req = await fetch(requestURL, init);
+    status = req.status;
+    logger.debug(`FETCH END ${url}`, { status: req.status });
+
+    const rawData = await req.text();
+
+    if (responseType === FetchResponseType.JSON) {
+      response = JSON.parse(rawData);
+    } else {
+      response = rawData as unknown as T;
+    }
+
+    logger.trace(`FETCH RESPONSE`, { url, response });
+  } catch (error) {
+    logger.error(`FETCH FAILED`, { url, status, error });
+  }
+
+  return response;
+};
+
+export default appFetch;

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

@@ -0,0 +1,22 @@
+import logger from './log';
+
+export const generateCommerceSearchParams = (searchParams?: URLSearchParams) => {
+  if (!searchParams) {
+    return null;
+  }
+
+  const urlSerchParams = new URLSearchParams(searchParams);
+
+  Object.entries(searchParams).forEach(([key, value]) => {
+    if (typeof value === 'object') {
+      urlSerchParams.delete(key);
+      value.forEach((val) => {
+        urlSerchParams.append(key, val);
+      });
+    }
+  });
+
+  logger.debug(`generateCommerceSearchParams: ${urlSerchParams.toString()}`);
+
+  return `?${urlSerchParams.toString()}`;
+};