@ikas/storefront 4.0.0-alpha.59 → 4.0.0-alpha.6

package/src/models/data/last-viewed-product/index.ts

@@ -0,0 +1,14 @@
+import { IkasLastViewedProduct as ILastViewedProduct } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasLastViewedProduct implements ILastViewedProduct {
+  productId: string;
+  variantId: string;
+
+  constructor(data: ILastViewedProduct) {
+    this.productId = data.productId;
+    this.variantId = data.variantId;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,26 @@
+import {
+  IkasMerchantSettingsCurrencyFormat,
+  IkasMerchantSettings as IMerchantSettings,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasImage } from "../image";
+
+export class IkasMerchantSettings implements IMerchantSettings {
+  currencyFormats: IkasMerchantSettingsCurrencyFormat[] | null;
+  logoId: string | null;
+  merchantId: string;
+  merchantName: string;
+
+  // Extra
+  logo?: IkasImage | null;
+
+  constructor(data: IMerchantSettings) {
+    this.currencyFormats = data.currencyFormats;
+    this.logoId = data.logoId;
+    this.merchantId = data.merchantId;
+    this.merchantName = data.merchantName;
+    this.logo = data.logo ? new IkasImage(data.logo) : null;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,16 @@
+import { IkasOrderAddressCity as IOrderAddressCity } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasOrderAddressCity implements IOrderAddressCity {
+  code: string | null = null;
+  id: string | null = null;
+  name: string;
+
+  constructor(data: Partial<IOrderAddressCity> = {}) {
+    this.code = data.code || null;
+    this.id = data.id || null;
+    this.name = data.name || "";
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,20 @@
+import { IkasOrderAddressCountry as IOrderAddressCountry } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasOrderAddressCountry implements IOrderAddressCountry {
+  code: string | null = null;
+  id: string | null = null;
+  iso2: string | null = null;
+  iso3: string | null = null;
+  name: string;
+
+  constructor(data: Partial<IOrderAddressCountry> = {}) {
+    this.code = data.code || null;
+    this.id = data.id || null;
+    this.iso2 = data.iso2 || null;
+    this.iso3 = data.iso3 || null;
+    this.name = data.name || "";
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/order/address/district/index.ts

@@ -0,0 +1,16 @@
+import { IkasOrderAddressDistrict as IOrderAddressDistrict } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasOrderAddressDistrict implements IOrderAddressDistrict {
+  code: string | null = null;
+  id: string | null = null;
+  name: string | null = null;
+
+  constructor(data: Partial<IOrderAddressDistrict>) {
+    this.code = data.code || null;
+    this.id = data.id || null;
+    this.name = data.name || "";
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/order/address/index.ts

@@ -0,0 +1,96 @@
+import { IkasOrderAddressFunctions } from "@ikas/storefront-model-functions";
+import { IkasOrderAddress as IOrderAddress } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasCheckoutSettings } from "../../checkout-settings";
+import { IkasOrderAddressCity } from "./city";
+import { IkasOrderAddressCountry } from "./country";
+import { IkasOrderAddressDistrict } from "./district";
+import { IkasOrderAddressState } from "./state";
+
+type IkasOrderAddressConstructorData = {
+  checkoutSettings?: IkasCheckoutSettings | null;
+  isDistrictRequired?: boolean;
+} & IOrderAddress;
+
+export class IkasOrderAddress implements IOrderAddress {
+  addressLine1: string;
+  addressLine2: string | null = null;
+  company: string | null = null;
+  firstName: string;
+  id: string | null = null;
+  identityNumber: string | null = null;
+  isDefault: boolean;
+  lastName: string;
+  phone: string | null = null;
+  postalCode: string | null = null;
+  taxNumber: string | null = null;
+  taxOffice: string | null = null;
+
+  country: IkasOrderAddressCountry | null = null;
+  state: IkasOrderAddressState | null = null;
+  city: IkasOrderAddressCity | null = null;
+  district: IkasOrderAddressDistrict | null = null;
+
+  // Extra
+  checkoutSettings?: IkasCheckoutSettings | null = null;
+  isDistrictRequired?: boolean;
+
+  constructor(data: Partial<IkasOrderAddressConstructorData> = {}) {
+    this.addressLine1 = data.addressLine1 || "";
+    this.addressLine2 = data.addressLine2 || null;
+    this.company = data.company || null;
+    this.firstName = data.firstName || "";
+    this.id = data.id || null;
+    this.identityNumber = data.identityNumber || null;
+    this.isDefault = data.isDefault || false;
+    this.lastName = data.lastName || "";
+    this.phone = data.phone || null;
+    this.postalCode = data.postalCode || null;
+    this.taxNumber = data.taxNumber || null;
+    this.taxOffice = data.taxOffice || null;
+
+    this.country = data.country || null;
+    this.state = data.state || null;
+    this.city = data.city || null;
+    this.district = data.district || null;
+
+    this.checkoutSettings = data.checkoutSettings
+      ? new IkasCheckoutSettings(data.checkoutSettings)
+      : null;
+    this.isDistrictRequired = data.isDistrictRequired || false;
+
+    makeAutoObservable(this);
+  }
+
+  get addressText() {
+    return IkasOrderAddressFunctions.getAddressText(this);
+  }
+
+  get validationResult() {
+    if (this.checkoutSettings)
+      return IkasOrderAddressFunctions.getValidationResult(
+        this,
+        this.checkoutSettings,
+        this.isDistrictRequired || false
+      );
+  }
+
+  get isValid() {
+    if (this.checkoutSettings) {
+      return IkasOrderAddressFunctions.isValidAddress(
+        this,
+        this.checkoutSettings,
+        this.isDistrictRequired || false
+      );
+    } else {
+      return false;
+    }
+  }
+
+  toJSON() {
+    const obj = { ...this };
+    delete obj.checkoutSettings;
+    delete obj.isDistrictRequired;
+    return obj;
+  }
+}

package/src/models/data/order/address/state/index.ts

@@ -0,0 +1,16 @@
+import { IkasOrderAddressState as IOrderAddressState } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasOrderAddressState implements IOrderAddressState {
+  code: string | null;
+  id: string | null;
+  name: string | null;
+
+  constructor(data: IOrderAddressState) {
+    this.code = data.code || null;
+    this.id = data.id || null;
+    this.name = data.name || null;
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/order/adjustment/applied-order-line/index.ts

@@ -0,0 +1,20 @@
+import { IkasOrderAdjustmentAppliedOrderLine as IOrderAdjustmentAppliedOrderLine } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasOrderAdjustmentAppliedOrderLine
+  implements IOrderAdjustmentAppliedOrderLine
+{
+  amount: number;
+  appliedQuantity: number;
+  isAutoCreated: boolean | null = null;
+  orderLineId: string;
+
+  constructor(data: IOrderAdjustmentAppliedOrderLine) {
+    this.amount = data.amount;
+    this.appliedQuantity = data.appliedQuantity;
+    this.isAutoCreated = data.isAutoCreated;
+    this.orderLineId = data.orderLineId;
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/order/adjustment/index.ts

@@ -0,0 +1,39 @@
+import {
+  IkasOrderAdjustment as IOrderAdjustment,
+  IkasAmountType,
+  IkasAdjustmentType,
+  IkasCampaignType,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasOrderAdjustmentAppliedOrderLine } from "./applied-order-line";
+
+export class IkasOrderAdjustment implements IOrderAdjustment {
+  amount: number;
+  appliedOrderLines: IkasOrderAdjustmentAppliedOrderLine[] | null = null;
+  campaignId: string | null = null;
+  couponId: string | null = null;
+  name: string;
+  order: number;
+  amountType: IkasAmountType;
+  type: IkasAdjustmentType;
+  campaignType: IkasCampaignType | null = null;
+
+  constructor(data: IOrderAdjustment) {
+    this.amount = data.amount;
+    this.appliedOrderLines =
+      data.appliedOrderLines?.map(
+        (aol) => new IkasOrderAdjustmentAppliedOrderLine(aol)
+      ) || null;
+    this.campaignId = data.campaignId || null;
+    this.couponId = data.couponId || null;
+    this.name = data.name;
+    this.order = data.order;
+    this.amountType = data.amountType;
+    this.type = data.type;
+    this.campaignType = data.campaignType || null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export { IkasAmountType, IkasAdjustmentType, IkasCampaignType };

package/src/models/data/order/customer/index.ts

@@ -0,0 +1,24 @@
+import { IkasOrderCustomer as IOrderCustomer } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasOrderCustomer implements IOrderCustomer {
+  email: string | null = null;
+  firstName: string | null = null;
+  fullName: string | null = null;
+  id: string | null = null;
+  isGuestCheckout: boolean | null = null;
+  lastName: string | null = null;
+  notificationsAccepted: boolean | null = null;
+
+  constructor(data: Partial<IOrderCustomer> = {}) {
+    this.email = data.email || null;
+    this.firstName = data.firstName || null;
+    this.fullName = data.fullName || null;
+    this.id = data.id || null;
+    this.isGuestCheckout = data.isGuestCheckout || null;
+    this.lastName = data.lastName || null;
+    this.notificationsAccepted = data.notificationsAccepted || null;
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/order/gift-line/index.ts

@@ -0,0 +1,14 @@
+import { IkasOrderGiftPackageLine as IOrderGiftPackageLine } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasOrderGiftPackageLine implements IOrderGiftPackageLine {
+  price: number;
+  taxValue: number | null = null;
+
+  constructor(data: IOrderGiftPackageLine) {
+    this.price = data.price;
+    this.taxValue = data.taxValue || null;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,241 @@
+import { IkasOrderAddress } from "./address";
+import { IkasOrderShippingLine } from "./shipping-line";
+import { IkasOrderLineItem } from "./line-item";
+import { IkasOrderRefundSettings } from "./refund/settings";
+import { IkasOrderCustomer } from "./customer";
+import { IkasOrderGiftPackageLine } from "./gift-line";
+import { IkasInvoice } from "./invoice";
+import { IkasOrderPaymentMethod } from "./payment-method";
+import { IkasOrderAdjustment } from "./adjustment";
+import { IkasOrderPackage } from "./package";
+import { IkasOrderTaxLine } from "./tax-line";
+import { IkasBaseModel } from "../base";
+import {
+  IkasOrderCancelReason,
+  IkasOrderPackageStatus,
+  IkasOrderPaymentStatus,
+  IkasOrderShippingMethod,
+  IkasOrderStatus,
+} from "@ikas/storefront-models";
+import { IkasOrder as IOrder } from "@ikas/storefront-models";
+import { computed, makeObservable, observable } from "mobx";
+import { IkasOrderFunctions } from "@ikas/storefront-model-functions";
+import { formatMoney, getCurrencySymbol } from "../../../utils/currency";
+
+type IOrderConstructorData = {
+  refundSettings?: IkasOrderRefundSettings | null;
+} & IOrder;
+
+export class IkasOrder extends IkasBaseModel implements IOrder {
+  billingAddress: IkasOrderAddress | null = null;
+  cancelReason: IkasOrderCancelReason | null = null;
+  cancelledAt: number | null = null;
+  currencyCode: string;
+  customer: IkasOrderCustomer | null = null;
+  customerId: string | null = null;
+  giftPackageLines: IkasOrderGiftPackageLine[] | null = null;
+  giftPackageNote: string | null = null;
+  invoices: IkasInvoice[] | null = null;
+  isGiftPackage: boolean | null = null;
+  note: string | null = null;
+  orderAdjustments: IkasOrderAdjustment[] | null = null;
+  orderLineItems: IkasOrderLineItem[];
+  orderNumber: string | null = null;
+  orderPackageStatus: IkasOrderPackageStatus | null = null;
+  orderPackages: IkasOrderPackage[] | null = null;
+  orderPaymentStatus: IkasOrderPaymentStatus | null = null;
+  orderedAt: number | null = null;
+  paymentMethods: IkasOrderPaymentMethod[] | null = null;
+  shippingAddress: IkasOrderAddress | null = null;
+  shippingLines: IkasOrderShippingLine[] | null = null;
+  shippingMethod: IkasOrderShippingMethod;
+  status: IkasOrderStatus;
+  taxLines: IkasOrderTaxLine[] | null = null;
+  totalFinalPrice: number;
+  totalPrice: number;
+
+  // Extra
+  refundSettings?: IkasOrderRefundSettings | null;
+
+  constructor(data: IOrderConstructorData) {
+    super(data);
+
+    this.billingAddress = data.billingAddress
+      ? new IkasOrderAddress(data.billingAddress)
+      : null;
+    this.cancelReason = data.cancelReason || null;
+    this.cancelledAt = data.cancelledAt || null;
+    this.currencyCode = data.currencyCode;
+    this.customer = data.customer ? new IkasOrderCustomer(data.customer) : null;
+    this.customerId = data.customerId || null;
+    this.giftPackageLines =
+      data.giftPackageLines?.map((gpl) => new IkasOrderGiftPackageLine(gpl)) ||
+      null;
+    this.giftPackageNote = data.giftPackageNote || null;
+    this.invoices = data.invoices?.map((i) => new IkasInvoice(i)) || null;
+    this.isGiftPackage = data.isGiftPackage || null;
+    this.note = data.note || null;
+    this.orderAdjustments =
+      data.orderAdjustments?.map((oa) => new IkasOrderAdjustment(oa)) || null;
+    this.orderLineItems =
+      data.orderLineItems.map((oli) => new IkasOrderLineItem(oli)) || null;
+    this.orderNumber = data.orderNumber || null;
+    this.orderPackageStatus = data.orderPackageStatus || null;
+    this.orderPackages =
+      data.orderPackages?.map((op) => new IkasOrderPackage(op)) || null;
+    this.orderPaymentStatus = data.orderPaymentStatus || null;
+    this.orderedAt = data.orderedAt || null;
+    this.paymentMethods =
+      data.paymentMethods?.map((pm) => new IkasOrderPaymentMethod(pm)) || null;
+    this.shippingAddress = data.shippingAddress
+      ? new IkasOrderAddress(data.shippingAddress)
+      : null;
+    this.shippingMethod = data.shippingMethod;
+    this.status = data.status;
+    this.taxLines =
+      data.taxLines?.map((tl) => new IkasOrderTaxLine(tl)) || null;
+    this.totalFinalPrice = data.totalFinalPrice;
+    this.totalPrice = data.totalPrice;
+
+    this.refundSettings = data.refundSettings;
+
+    makeObservable(this, {
+      billingAddress: observable,
+      cancelReason: observable,
+      cancelledAt: observable,
+      currencyCode: observable,
+      customer: observable,
+      customerId: observable,
+      giftPackageLines: observable,
+      giftPackageNote: observable,
+      invoices: observable,
+      isGiftPackage: observable,
+      note: observable,
+      orderAdjustments: observable,
+      orderLineItems: observable,
+      orderNumber: observable,
+      orderPackageStatus: observable,
+      orderPackages: observable,
+      orderPaymentStatus: observable,
+      orderedAt: observable,
+      paymentMethods: observable,
+      shippingAddress: observable,
+      shippingLines: observable,
+      shippingMethod: observable,
+      status: observable,
+      taxLines: observable,
+      totalFinalPrice: observable,
+      totalPrice: observable,
+      refundSettings: observable,
+
+      items: computed,
+      itemCount: computed,
+      currencySymbol: computed,
+      refundableItems: computed,
+      unfullfilledItems: computed,
+      refundedItems: computed,
+      totalTax: computed,
+      formattedTotalTax: computed,
+      shippingTotal: computed,
+      formattedShippingTotal: computed,
+      formattedTotalFinalPrice: computed,
+      formattedTotalPrice: computed,
+      hasCustomer: computed,
+      hasValidCustomerEmail: computed,
+      customerFullName: computed,
+      formattedDate: computed,
+      couponAdjustment: computed,
+      nonCouponAdjustments: computed,
+    });
+  }
+
+  get items() {
+    return this.orderLineItems;
+  }
+
+  get itemCount() {
+    return this.items?.length || 0;
+  }
+
+  get currencySymbol() {
+    return getCurrencySymbol(this.currencyCode);
+  }
+
+  get refundableItems() {
+    if (!this.refundSettings) return [];
+    return IkasOrderFunctions.getRefundableItems(this, this.refundSettings).map(
+      (i) => new IkasOrderLineItem(i)
+    );
+  }
+
+  get unfullfilledItems() {
+    return IkasOrderFunctions.getUnfullfilledItems(this).map(
+      (i) => new IkasOrderLineItem(i)
+    );
+  }
+
+  get refundedItems() {
+    return IkasOrderFunctions.getRefundedItems(this).map(
+      (i) => new IkasOrderLineItem(i)
+    );
+  }
+
+  get totalTax() {
+    return IkasOrderFunctions.getTotalTax(this);
+  }
+
+  get formattedTotalTax() {
+    return formatMoney(this.totalTax, this.currencySymbol);
+  }
+
+  get shippingTotal() {
+    return IkasOrderFunctions.getShippingTotal(this);
+  }
+
+  get formattedShippingTotal() {
+    return formatMoney(this.shippingTotal, this.currencySymbol);
+  }
+
+  get formattedTotalFinalPrice() {
+    return formatMoney(this.totalFinalPrice, this.currencySymbol);
+  }
+
+  get formattedTotalPrice() {
+    return formatMoney(this.totalPrice, this.currencySymbol);
+  }
+
+  get hasCustomer() {
+    return IkasOrderFunctions.hasCustomer(this);
+  }
+
+  get hasValidCustomerEmail() {
+    return IkasOrderFunctions.hasValidCustomerEmail(this);
+  }
+
+  get customerFullName() {
+    return IkasOrderFunctions.getCustomerFullName(this);
+  }
+
+  get formattedDate() {
+    return IkasOrderFunctions.getFormattedDate(this);
+  }
+
+  get couponAdjustment() {
+    const adjustment = IkasOrderFunctions.getCouponAdjustment(this);
+    return adjustment ? new IkasOrderAdjustment(adjustment) : undefined;
+  }
+
+  get nonCouponAdjustments() {
+    return IkasOrderFunctions.getNonCouponAdjustments(this)?.map(
+      (a) => new IkasOrderAdjustment(a)
+    );
+  }
+}
+
+export {
+  IkasOrderCancelReason,
+  IkasOrderPackageStatus,
+  IkasOrderPaymentStatus,
+  IkasOrderShippingMethod,
+  IkasOrderStatus,
+};

package/src/models/data/order/invoice/index.ts

@@ -0,0 +1,29 @@
+import {
+  IkasInvoice as IInvoice,
+  IkasInvoiceType,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasInvoice implements IInvoice {
+  appId: string;
+  appName: string;
+  createdAt: number | null = null;
+  id: string;
+  invoiceNumber: string;
+  storeAppId: string;
+  type: IkasInvoiceType;
+
+  constructor(data: IInvoice) {
+    this.appId = data.appId;
+    this.appName = data.appName;
+    this.createdAt = data.createdAt || null;
+    this.id = data.id;
+    this.invoiceNumber = data.invoiceNumber;
+    this.storeAppId = data.storeAppId;
+    this.type = data.type;
+
+    makeAutoObservable(this);
+  }
+}
+
+export { IkasInvoiceType };

package/src/models/data/order/line-item/discount/index.ts

@@ -0,0 +1,23 @@
+import { IkasOrderLineDiscount as IOrderLineDiscount } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasAmountType } from "../../adjustment";
+
+export class IkasOrderLineDiscount implements IOrderLineDiscount {
+  amount: number;
+  amountType: IkasAmountType;
+  campaignOfferId: string | null = null;
+  campaignOfferProductId: string | null = null;
+  maxApplicableQuantity: number | null = null;
+  reason: string | null = null;
+
+  constructor(data: IOrderLineDiscount) {
+    this.amount = data.amount;
+    this.amountType = data.amountType;
+    this.campaignOfferId = data.campaignOfferId || null;
+    this.campaignOfferProductId = data.campaignOfferProductId || null;
+    this.maxApplicableQuantity = data.maxApplicableQuantity || null;
+    this.reason = data.reason || null;
+
+    makeAutoObservable(this);
+  }
+}