@ikas/storefront 1.0.21 → 2.0.0-alpha.1

package/src/models/data/brand/index.ts

@@ -0,0 +1,58 @@
+import { makeAutoObservable } from "mobx";
+import { IkasImage } from "../image";
+import { IkasHTMLMetaData } from "../html-meta-data";
+import { ModelOrder } from "../category/index";
+import { IkasStorefrontConfig } from "../../../storefront";
+
+export class IkasBrand {
+  id: string;
+  name: string;
+  description: string | null = null;
+  metaData?: IkasHTMLMetaData | null = null;
+  image?: IkasImage | null = null;
+  orderType: ModelOrder | null = null;
+  translations: IkasProductBrandTranslation[] | null = null;
+
+  constructor(data: Partial<IkasBrand> = {}) {
+    this.id = data.id || Date.now() + "";
+    this.name = data.name || "";
+    this.description = data.description || null;
+    this.metaData = data.metaData
+      ? new IkasHTMLMetaData(data.metaData)
+      : undefined;
+    this.image = data.image ? new IkasImage(data.image.id) : null;
+    this.orderType = data.orderType || null;
+    this.translations = data.translations || null;
+
+    this.setTranslations();
+    makeAutoObservable(this);
+  }
+
+  get href() {
+    if (!this.metaData?.slug) return "";
+    return `/${this.metaData.slug}`;
+  }
+
+  private setTranslations() {
+    if (
+      this.translations &&
+      this.translations.some(
+        (t) => t.locale === IkasStorefrontConfig.getCurrentLocale()
+      )
+    ) {
+      const localeTranslations = this.translations.find(
+        (t) => t.locale === IkasStorefrontConfig.getCurrentLocale()
+      );
+
+      if (localeTranslations?.name) this.name = localeTranslations.name;
+      if (localeTranslations?.description)
+        this.description = localeTranslations.description;
+    }
+  }
+}
+
+type IkasProductBrandTranslation = {
+  description: string | null;
+  locale: string;
+  name: string | null;
+};

package/src/models/data/cart/index.ts

@@ -0,0 +1,82 @@
+import { getCurrencySymbol } from "../../../utils";
+import { makeAutoObservable } from "mobx";
+import { IkasOrderLineItem } from "../order/line-item";
+import { IkasProductCartLineOption } from "../product-cart-item-options";
+
+export class IkasCart {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+  dueDate?: string | null = null;
+  currencyCode: string;
+  currencySymbol: string;
+  customerId?: string | null = null;
+  itemCount: number;
+  items: IkasOrderLineItem[];
+  merchantId: string;
+  totalPrice: number;
+  salesChannelId: string;
+  storefrontId: string | null;
+  storefrontRoutingId: string | null;
+  storefrontThemeId: string | null;
+  taxLines: IkasCartTaxLine[] | null;
+
+  constructor(data: Partial<IkasCart>) {
+    this.id = data.id || "";
+    this.createdAt = data.createdAt || "";
+    this.updatedAt = data.updatedAt || "";
+    this.dueDate = data.dueDate;
+    this.currencyCode = data.currencyCode || "";
+    this.currencySymbol = getCurrencySymbol(this.currencyCode);
+    this.customerId = data.customerId;
+    this.itemCount = data.itemCount || 0;
+    this.items = data.items
+      ? data.items
+          .map((item) => new IkasOrderLineItem(item))
+          .filter((i) => !i.deleted)
+      : [];
+    this.merchantId = data.merchantId || "";
+    this.totalPrice = data.totalPrice || 0;
+    this.salesChannelId = data.salesChannelId || "";
+    this.storefrontId = data.storefrontId || null;
+    this.storefrontRoutingId = data.storefrontRoutingId || null;
+    this.storefrontThemeId = data.storefrontThemeId || null;
+    this.taxLines = data.taxLines || [];
+
+    makeAutoObservable(this);
+  }
+
+  get totalTax() {
+    return (
+      this.taxLines?.reduce((total, current) => total + current.price, 0) || 0
+    );
+  }
+}
+
+type IkasCartLineItemInput = {
+  id: string | null;
+  quantity: number;
+  variant: IkasCartLineVariantInput;
+};
+
+type IkasCartLineVariantInput = {
+  id: string;
+  name: string;
+};
+
+type IkasCartTaxLine = {
+  price: number;
+  rate: number;
+};
+
+export type IkasSaveItemToCartInput = {
+  cartId: string | null;
+  customerId: string | null;
+  item: IkasCartLineItemInput;
+  priceListId: string | null;
+  salesChannelId: string;
+  storefrontId: string;
+  storefrontRoutingId: string;
+  options: IkasProductCartLineOption[] | null;
+  storefrontThemeId: string;
+};

package/src/models/data/category/index.ts

@@ -0,0 +1,130 @@
+import { makeAutoObservable } from "mobx";
+import { IkasImage } from "../image";
+import { IkasHTMLMetaData } from "../html-meta-data";
+import { IkasStorefrontConfig } from "../../../storefront";
+
+export class IkasCategory {
+  id: string;
+  name: string;
+  description: string | null = null;
+  parentId: string | null;
+  metaData?: IkasHTMLMetaData | null = null;
+  image?: IkasImage | null = null;
+  path: IkasCategoryPath[];
+  orderType: ModelOrder | null = null;
+  translations: IkasCategoryTranslation[] | null = null;
+
+  constructor(data: Partial<IkasCategory> = {}) {
+    this.id = data.id || Date.now() + "";
+    this.name = data.name || "";
+    this.description = data.description || null;
+    this.parentId = data.parentId || null;
+    this.metaData = data.metaData
+      ? new IkasHTMLMetaData(data.metaData)
+      : undefined;
+    this.image = data.image ? new IkasImage(data.image.id) : null;
+    this.path = data.path ? data.path.map((p) => new IkasCategoryPath(p)) : [];
+    this.orderType = data.orderType || null;
+    this.translations = data.translations || null;
+
+    this.setTranslations();
+    makeAutoObservable(this);
+  }
+
+  get href() {
+    if (!this.metaData?.slug) return "";
+    return `/${this.metaData.slug}`;
+  }
+
+  private setTranslations() {
+    if (
+      this.translations &&
+      this.translations.some(
+        (t) => t.locale === IkasStorefrontConfig.getCurrentLocale()
+      )
+    ) {
+      const localeTranslations = this.translations.find(
+        (t) => t.locale === IkasStorefrontConfig.getCurrentLocale()
+      );
+
+      if (localeTranslations?.name) this.name = localeTranslations.name;
+      if (localeTranslations?.description)
+        this.description = localeTranslations.description;
+    }
+  }
+}
+
+export class IkasCategoryPath {
+  id: string;
+  name: string;
+  slug?: string | null;
+
+  constructor(data: Partial<IkasCategoryPath>) {
+    this.id = data.id || "";
+    this.name = data.name || "";
+    this.slug = data.slug || "";
+
+    makeAutoObservable(this);
+  }
+
+  get href() {
+    if (!this.slug) return "";
+    return `/${this.slug}`;
+  }
+}
+
+export class IkasFilterCategory {
+  id: string;
+  name: string;
+  slug?: string | null;
+  resultCount?: number | null;
+
+  // Extra
+  private _isSelected = false;
+
+  constructor(data: Partial<IkasFilterCategory>) {
+    this.id = data.id || "";
+    this.name = data.name || "";
+    this.slug = data.slug || "";
+    this.resultCount =
+      data.resultCount !== undefined && data.resultCount !== null
+        ? data.resultCount
+        : null;
+    this._isSelected = data.isSelected || false;
+
+    makeAutoObservable(this);
+  }
+
+  get isSelected() {
+    return this._isSelected;
+  }
+
+  get href() {
+    if (!this.slug) return "";
+    return `/${this.slug}`;
+  }
+
+  toJSON() {
+    return {
+      ...this,
+      isSelected: this._isSelected,
+    };
+  }
+}
+
+export enum ModelOrder {
+  BEST_SELLER = "BEST_SELLER",
+  HIGHEST_DISCOUNT_RATIO = "HIGHEST_DISCOUNT_RATIO",
+  HIGHEST_PRICE = "HIGHEST_PRICE",
+  LOWEST_DISCOUNT_RATIO = "LOWEST_DISCOUNT_RATIO",
+  LOWEST_PRICE = "LOWEST_PRICE",
+  MANUALLY = "MANUALLY",
+  NEWEST = "NEWEST",
+  OLDEST = "OLDEST",
+}
+
+type IkasCategoryTranslation = {
+  description: string | null;
+  locale: string;
+  name: string | null;
+};

package/src/models/data/checkout/index.ts

@@ -0,0 +1,222 @@
+import { makeAutoObservable } from "mobx";
+import { IkasOrderAddress } from "../order/address";
+import { IkasOrderShippingLine } from "../order/shipping-line";
+import { IkasCart } from "../cart";
+import { IkasOrderAdjustment } from "../order";
+import {
+  IkasPaymentGateway,
+  IkasPaymentMethodAdditionalPriceType,
+} from "../payment-gateway";
+import { IkasOrderGiftPackageLine } from "../order/gift-line";
+import { formatDate } from "../../../utils/helper";
+
+export class IkasCheckout {
+  id?: string | null = null;
+  createdAt?: string | null = null;
+  updatedAt?: string | null = null;
+  cartId?: string | null = null;
+  cart?: IkasCart | null = null;
+  orderId?: string | null = null;
+  orderNumber?: string | null = null;
+  merchantId?: string | null = null;
+  shippingSettingsId?: string | null = null;
+  shippingZoneRateId?: string | null = null;
+  availableShippingMethods: IkasAvailableShippingMethod[];
+  customer?: IkasCheckoutCustomer | null = null;
+  billingAddress?: IkasOrderAddress | null = null;
+  shippingAddress?: IkasOrderAddress | null = null;
+  shippingLines?: IkasOrderShippingLine[] | null = null;
+  shippingMethod?: IkasShippingMethod | null = null;
+  status?: IkasCheckoutStatus | null = null;
+  couponCode?: string | null = null;
+  recoverEmailStatus?: IkasCheckoutRecoveryEmailStatus | null = null;
+  recoveryStatus?: IkasCheckoutRecoveryStatus | null = null;
+  totalFinalPrice?: number | null = null;
+  adjustments?: IkasOrderAdjustment[] | null = null;
+  note: string | null = null;
+
+  isGiftPackage: boolean;
+  giftPackageLines: IkasOrderGiftPackageLine[] | null = null;
+  giftPackageNote: string | null = null;
+
+  // Extra
+  appliedCouponCode?: string | null = null;
+  selectedPaymentGateway?: IkasPaymentGateway | null = null;
+
+  constructor(data: Partial<IkasCheckout> = {}) {
+    this.id = data.id;
+    this.createdAt = data.createdAt;
+    this.updatedAt = data.updatedAt;
+    this.cartId = data.cartId;
+    this.cart = data.cart ? new IkasCart(data.cart) : undefined;
+    this.orderId = data.orderId;
+    this.orderNumber = data.orderNumber;
+    this.merchantId = data.merchantId;
+    this.shippingSettingsId = data.shippingSettingsId;
+    this.shippingZoneRateId = data.shippingZoneRateId;
+    this.availableShippingMethods = data.availableShippingMethods || [];
+    this.customer = data.customer
+      ? new IkasCheckoutCustomer(data.customer)
+      : null;
+    this.billingAddress = data.billingAddress
+      ? new IkasOrderAddress(data.billingAddress)
+      : null;
+    this.shippingAddress = data.shippingAddress
+      ? new IkasOrderAddress(data.shippingAddress)
+      : null;
+    this.shippingLines = data.shippingLines || [];
+    this.shippingMethod = data.shippingMethod || IkasShippingMethod.NO_SHIPMENT;
+    this.status = data.status || IkasCheckoutStatus.OPEN;
+    this.couponCode = data.couponCode;
+    this.appliedCouponCode = data.couponCode;
+    this.recoverEmailStatus = data.recoverEmailStatus;
+    this.recoveryStatus = data.recoveryStatus;
+    this.totalFinalPrice = data.totalFinalPrice;
+    this.adjustments = data.adjustments;
+    this.note = data.note || null;
+    this.isGiftPackage = data.isGiftPackage || false;
+    this.giftPackageLines = data.giftPackageLines || null;
+    this.giftPackageNote = data.giftPackageNote || null;
+
+    makeAutoObservable(this);
+  }
+
+  get isComplete() {
+    return !!this.orderId;
+  }
+
+  get totalTax() {
+    return this.cart?.totalTax || 0;
+  }
+
+  get shippingTotal() {
+    return (
+      this.shippingLines?.reduce(
+        (total, current) => total + current.price,
+        0
+      ) || 0
+    );
+  }
+
+  get hasCustomer() {
+    return !!this.customer?.id;
+  }
+
+  get hasValidCustomer() {
+    return !!this.customer?.email;
+  }
+
+  get customerFullName() {
+    return `${this.customer?.firstName || ""} ${this.customer?.lastName || ""}`;
+  }
+
+  get customerEmail() {
+    return `${this.customer?.email || ""}`;
+  }
+
+  get dateStr() {
+    const newDate = new Date();
+    newDate.setTime(parseFloat(this.updatedAt!));
+    return formatDate(newDate);
+  }
+
+  get $totalFinalPrice() {
+    const calculatedAdditionalPrices = this.selectedPaymentGateway?.getCalculatedAdditionalPrices(
+      this.totalFinalPrice || 0,
+      this.shippingLines || null
+    );
+
+    let total = this.totalFinalPrice || 0;
+
+    calculatedAdditionalPrices?.forEach((additionalPrice) => {
+      if (
+        additionalPrice.type === IkasPaymentMethodAdditionalPriceType.DECREMENT
+      )
+        total -= additionalPrice.amount;
+      else total += additionalPrice.amount;
+    });
+
+    return total;
+  }
+
+  get couponAdjustment() {
+    return this.adjustments?.find((a) => !!a.couponId);
+  }
+
+  get nonCouponAdjustments() {
+    return this.adjustments?.filter((a) => !a.couponId);
+  }
+}
+
+export class IkasCheckoutCustomer {
+  id?: string;
+  email?: string;
+  firstName?: string;
+  lastName?: string;
+  notificationsAccepted?: boolean | null;
+
+  constructor(data: Partial<IkasCheckoutCustomer>) {
+    this.id = data.id || "";
+    this.email = data.email || "";
+    this.firstName = data.firstName || "";
+    this.lastName = data.lastName || "";
+    this.notificationsAccepted = data.notificationsAccepted || false;
+
+    makeAutoObservable(this);
+  }
+}
+
+export enum IkasShippingMethod {
+  CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
+  NO_SHIPMENT = "NO_SHIPMENT",
+  SHIPMENT = "SHIPMENT",
+}
+
+export enum IkasCheckoutStatus {
+  COMPLETED = "COMPLETED",
+  OPEN = "OPEN",
+}
+
+export enum IkasCheckoutRecoveryEmailStatus {
+  NOT_SENT = "NOT_SENT",
+  SENT = "SENT",
+}
+
+export enum IkasCheckoutRecoveryStatus {
+  NOT_RECOVERED = "NOT_RECOVERED",
+  RECOVERED = "RECOVERED",
+}
+
+export enum IkasPaymentMethod {
+  BUY_ONLINE_PAY_AT_STORE = "BUY_ONLINE_PAY_AT_STORE",
+  CASH = "CASH",
+  CASH_ON_DELIVERY = "CASH_ON_DELIVERY",
+  CREDIT_CARD = "CREDIT_CARD",
+  GIFT_CARD = "GIFT_CARD",
+  MONEY_ORDER = "MONEY_ORDER",
+  OTHER = "OTHER",
+}
+
+export type IkasPaymentMethodDetail = {
+  cardHolderName: string;
+  cardNumber: string;
+  cvv: string;
+  expiredMonth: number;
+  expiredYear: number;
+  installmentCount: number;
+  threeDSecure: boolean;
+};
+
+export enum IkasShippingMethodEnum {
+  CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
+  NO_SHIPMENT = "NO_SHIPMENT",
+  SHIPMENT = "SHIPMENT",
+}
+
+export type IkasAvailableShippingMethod = {
+  price: number;
+  rateName: string;
+  shippingMethod: IkasShippingMethodEnum;
+  shippingSettingsId: string;
+  shippingZoneRateId: string;
+};

package/src/models/data/checkout-settings/index.ts

@@ -0,0 +1,48 @@
+export class IkasCheckoutSettings {
+  id: string;
+  createdAt: number;
+  updatedAt: number;
+  phoneRequirement: IkasCheckoutRequirementEnum | null;
+  identityNumberRequirement: IkasCheckoutRequirementEnum | null;
+  isAccountRequired: boolean;
+  isTermsAndConditionsDefaultChecked: boolean;
+  showTermsAndConditionsCheckbox: boolean;
+  showCheckoutNote: boolean;
+  storefrontId: string;
+  giftPackagePriceList: IkasCheckoutSettingsPrice[] | null;
+  isGiftPackageEnabled: boolean;
+  isShowPostalCode: boolean;
+
+  constructor(data: Partial<IkasCheckoutSettings> = {}) {
+    this.id = data.id || "";
+    this.createdAt = data.createdAt || 0;
+    this.updatedAt = data.updatedAt || 0;
+    this.phoneRequirement =
+      data.phoneRequirement || IkasCheckoutRequirementEnum.OPTIONAL;
+    this.identityNumberRequirement =
+      data.identityNumberRequirement || IkasCheckoutRequirementEnum.INVISIBLE;
+    this.isAccountRequired = data.isAccountRequired || false;
+    this.isTermsAndConditionsDefaultChecked =
+      data.isTermsAndConditionsDefaultChecked || false;
+    this.showTermsAndConditionsCheckbox =
+      data.showTermsAndConditionsCheckbox !== undefined
+        ? data.showTermsAndConditionsCheckbox
+        : true;
+    this.showCheckoutNote = data.showCheckoutNote || false;
+    this.storefrontId = data.storefrontId || "";
+    this.giftPackagePriceList = data.giftPackagePriceList || null;
+    this.isGiftPackageEnabled = data.isGiftPackageEnabled || false;
+    this.isShowPostalCode = data.isShowPostalCode || false;
+  }
+}
+
+export enum IkasCheckoutRequirementEnum {
+  INVISIBLE = "INVISIBLE",
+  MANDATORY = "MANDATORY",
+  OPTIONAL = "OPTIONAL",
+}
+
+export type IkasCheckoutSettingsPrice = {
+  currencyCode: string;
+  price: number;
+};

package/src/models/data/city/index.ts

@@ -0,0 +1,4 @@
+export type IkasCity = {
+  id: string;
+  name: string;
+};

package/src/models/data/contact-form/index.ts

@@ -0,0 +1,17 @@
+import { makeAutoObservable } from "mobx";
+
+export class IkasContactForm {
+  email: string;
+  firstName: string;
+  lastName: string;
+  message: string;
+
+  constructor(data: Partial<IkasContactForm>) {
+    this.email = data.email || "";
+    this.firstName = data.firstName || "";
+    this.lastName = data.lastName || "";
+    this.message = data.message || "";
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/country/index.ts

@@ -0,0 +1,8 @@
+export type IkasCountry = {
+  id: string;
+  name: string;
+  native: string;
+  iso2?: string;
+  iso3?: string;
+  phoneCode?: string;
+};

package/src/models/data/customer/address/index.tsx

@@ -0,0 +1,135 @@
+import { makeAutoObservable } from "mobx";
+import { validatePhoneNumber } from "../../../../utils";
+import {
+  IkasCheckoutRequirementEnum,
+  IkasCheckoutSettings,
+} from "../../checkout-settings";
+
+export class IkasCustomerAddress {
+  id?: string | null = null;
+  title?: string | null = null;
+  addressLine1?: string | null = null;
+  addressLine2?: string | null = null;
+  country?: IkasCustomerAddressCountry | null = null;
+  state?: IkasCustomerAddressState | null = null;
+  city?: IkasCustomerAddressCity | null = null;
+  district?: IkasCustomerAddressDistrict | null = null;
+  isDefault?: boolean | null = null;
+  company?: string | null = null;
+  firstName?: string | null = null;
+  lastName?: string | null = null;
+  phone?: string | null = null;
+  postalCode?: string | null = null;
+  identityNumber?: string | null = null;
+  taxNumber?: string | null = null;
+  taxOffice?: string | null = null;
+
+  // Extra
+  checkoutSettings?: IkasCheckoutSettings;
+  isDistrictRequired?: boolean = false;
+
+  constructor(data: Partial<IkasCustomerAddress> = {}) {
+    this.id = data.id || null;
+    this.title = data.title || null;
+    this.addressLine1 = data.addressLine1 || null;
+    this.addressLine2 = data.addressLine2 || null;
+    this.country = data.country || null;
+    this.state = data.state || null;
+    this.city = data.city || null;
+    this.district = data.district || null;
+    this.isDefault = data.isDefault || null;
+    this.company = data.company || null;
+    this.firstName = data.firstName || null;
+    this.lastName = data.lastName || null;
+    this.phone = data.phone || null;
+    this.postalCode = data.postalCode || null;
+    this.identityNumber = data.identityNumber || null;
+    this.taxNumber = data.taxNumber || null;
+    this.taxOffice = data.taxOffice || null;
+
+    makeAutoObservable(this);
+  }
+
+  get addressText() {
+    const strings: string[] = [];
+
+    if (this.addressLine1) strings.push(this.addressLine1);
+    if (this.addressLine2) strings.push(this.addressLine2);
+    if (this.postalCode) strings.push(this.postalCode);
+    if (this.district && this.district.name) strings.push(this.district.name);
+    if (this.city && this.city.name) strings.push(this.city.name);
+    if (this.state && this.state.name && this.state.name !== "Default")
+      strings.push(this.state.name);
+    if (this.country && this.country.name) strings.push(this.country.name);
+
+    return strings.join(", ");
+  }
+
+  get validationResult(): IkasAddressValidationResult {
+    const isValidPhone =
+      !!this.phone &&
+      this.phone.length >= 10 &&
+      validatePhoneNumber(this.phone);
+
+    const results = {
+      firstName: !!this.firstName,
+      lastName: !!this.lastName,
+      addressLine1: !!this.addressLine1,
+      country: !!this.country,
+      state: !!this.state,
+      city: !!this.city,
+      district: this.isDistrictRequired ? !!this.district?.id : true,
+      phone:
+        this.checkoutSettings?.phoneRequirement ===
+          IkasCheckoutRequirementEnum.MANDATORY ||
+        (this.checkoutSettings?.phoneRequirement ===
+          IkasCheckoutRequirementEnum.OPTIONAL &&
+          this.phone)
+          ? isValidPhone
+          : true,
+      identityNumber:
+        this.checkoutSettings?.identityNumberRequirement ===
+        IkasCheckoutRequirementEnum.MANDATORY
+          ? !!this.identityNumber
+          : true,
+      title: !!this.title,
+    };
+
+    return results;
+  }
+
+  get isValid() {
+    return Object.values(this.validationResult).every((result) => result);
+  }
+
+  toJSON() {
+    const obj = { ...this };
+    delete obj.checkoutSettings;
+    delete obj.isDistrictRequired;
+    return obj;
+  }
+}
+
+type IkasCustomerAddressLocation = {
+  id?: string;
+  name?: string;
+  code?: string;
+};
+
+export type IkasCustomerAddressCountry = IkasCustomerAddressLocation;
+export type IkasCustomerAddressCity = IkasCustomerAddressLocation;
+export type IkasCustomerAddressDistrict = IkasCustomerAddressLocation;
+export type IkasCustomerAddressState = IkasCustomerAddressLocation;
+
+export type IkasAddressValidationResult = {
+  firstName: boolean;
+  lastName: boolean;
+  addressLine1: boolean;
+  country: boolean;
+  state: boolean;
+  city: boolean;
+  district: boolean;
+  phone: boolean;
+  identityNumber: boolean;
+  title: boolean;
+};