@ikas/storefront 1.0.21 → 2.0.0-alpha.1

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

@@ -0,0 +1,65 @@
+import { IkasCustomerAddress } from "./address";
+import { makeAutoObservable } from "mobx";
+
+export class IkasCustomer {
+  id: string;
+  firstName: string;
+  lastName: string;
+  email: string;
+  phone?: string | null = null;
+  isEmailVerified: boolean;
+  isPhoneVerified: boolean;
+  accountStatus: IkasCustomerAccountStatus;
+  addresses: IkasCustomerAddress[];
+  subscriptionStatus: IkasCustomerEmailSubscriptionStatus | null;
+
+  constructor(data: Partial<IkasCustomer>) {
+    this.id = data.id || "";
+    this.firstName = data.firstName || "";
+    this.lastName = data.lastName || "";
+    this.email = data.email || "";
+    this.phone = data.phone;
+    this.isEmailVerified = data.isEmailVerified || false;
+    this.isPhoneVerified = data.isPhoneVerified || false;
+    this.accountStatus =
+      data.accountStatus || IkasCustomerAccountStatus.ACTIVE_ACCOUNT;
+    this.addresses = data.addresses
+      ? data.addresses.map((a) => new IkasCustomerAddress(a))
+      : [];
+    this.subscriptionStatus = data.subscriptionStatus || null;
+
+    makeAutoObservable(this);
+  }
+
+  get isSubscribed() {
+    return (
+      this.subscriptionStatus ===
+        IkasCustomerEmailSubscriptionStatus.SUBSCRIBED ||
+      this.subscriptionStatus ===
+        IkasCustomerEmailSubscriptionStatus.PENDING_CONFIRMATION
+    );
+  }
+
+  get basicInfo() {
+    return {
+      id: this.id,
+      firstName: this.firstName,
+      lastName: this.lastName,
+      email: this.email,
+      phone: this.phone,
+    };
+  }
+}
+
+export enum IkasCustomerAccountStatus {
+  ACTIVE_ACCOUNT = "ACTIVE_ACCOUNT",
+  DECLINED_ACCOUNT_INVITATION = "DECLINED_ACCOUNT_INVITATION",
+  DISABLED_ACCOUNT = "DISABLED_ACCOUNT",
+  INVITED_TO_CREATE_ACCOUNT = "INVITED_TO_CREATE_ACCOUNT",
+}
+
+export enum IkasCustomerEmailSubscriptionStatus {
+  NOT_SUBSCRIBED = "NOT_SUBSCRIBED",
+  PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
+  SUBSCRIBED = "SUBSCRIBED",
+}

package/src/models/data/customer-review/index.ts

@@ -0,0 +1,43 @@
+import { makeAutoObservable } from "mobx";
+
+export class IkasCustomerReview {
+  comment: string;
+  createdAt: string;
+  customerId: string;
+  deleted: boolean;
+  id: string;
+  orderId: string;
+  orderNumber: string;
+  productId: string;
+  salesChannelId: string;
+  star: number;
+  status: CustomerReviewStatusEnum;
+  storefrontId: string;
+  title: string;
+  updatedAt: string;
+
+  constructor(data: Partial<IkasCustomerReview>) {
+    this.comment = data.comment || "";
+    this.createdAt = data.createdAt || "";
+    this.customerId = data.customerId || "";
+    this.deleted = data.deleted || false;
+    this.id = data.id || "";
+    this.orderId = data.orderId || "";
+    this.orderNumber = data.orderNumber || "";
+    this.productId = data.productId || "";
+    this.salesChannelId = data.salesChannelId || "";
+    this.star = data.star || 0;
+    this.status = data.status || CustomerReviewStatusEnum.APPROVED;
+    this.storefrontId = data.storefrontId || "";
+    this.title = data.title || "";
+    this.updatedAt = data.updatedAt || "";
+
+    makeAutoObservable(this);
+  }
+}
+
+enum CustomerReviewStatusEnum {
+  APPROVED = "APPROVED",
+  REJECTED = "REJECTED",
+  WAITING = "WAITING",
+}

package/src/models/data/customer-review-settings/index.ts

@@ -0,0 +1,4 @@
+export type IkasCustomerReviewSettings = {
+  customerLoginRequired: boolean;
+  customerPurchaseRequired: boolean;
+};

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

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

package/src/models/data/favorite-product/index.ts

@@ -0,0 +1,15 @@
+import { makeAutoObservable } from "mobx";
+
+export class IkasFavoriteProduct {
+  id: string;
+  customerId: string;
+  productId: string;
+
+  constructor(data: Partial<IkasFavoriteProduct>) {
+    this.id = data.id || "";
+    this.customerId = data.customerId || "";
+    this.productId = data.productId || "";
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/html-meta-data/index.ts

@@ -0,0 +1,56 @@
+import { makeAutoObservable } from "mobx";
+import { IkasStorefrontConfig } from "../../../storefront";
+
+export class IkasHTMLMetaData {
+  slug: string;
+  pageTitle: string | null;
+  description: string | null;
+  targetType: IkasHTMLMetaDataTargetType | null;
+  targetId: string | null;
+  redirectTo?: string | null = null;
+  translations?: IkasHTMLMetaDataTranslations[] | null = null;
+
+  constructor(data: Partial<IkasHTMLMetaData> = {}) {
+    this.slug = data.slug || "";
+    this.pageTitle = data.pageTitle || null;
+    this.description = data.description || null;
+    this.targetType = data.targetType || null;
+    this.targetId = data.targetId || null;
+    this.redirectTo = data.redirectTo;
+    this.translations = data.translations || null;
+
+    this.setTranslations();
+    makeAutoObservable(this);
+  }
+
+  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?.pageTitle)
+        this.pageTitle = localeTranslations.pageTitle;
+      if (localeTranslations?.description)
+        this.description = localeTranslations.description;
+    }
+  }
+}
+
+export enum IkasHTMLMetaDataTargetType {
+  PRODUCT = "PRODUCT",
+  CATEGORY = "CATEGORY",
+  BRAND = "BRAND",
+  PAGE = "PAGE",
+}
+
+type IkasHTMLMetaDataTranslations = {
+  description: string | null;
+  locale: string;
+  pageTitle: string | null;
+};

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

@@ -0,0 +1,34 @@
+import { makeAutoObservable } from "mobx";
+import { decodeBase64 } from "../../../utils";
+import { IkasStorefrontConfig } from "../../../storefront";
+
+export class IkasImage {
+  id: string; // Might be a single imageId or merchantId/imageId
+
+  constructor(id: string) {
+    this.id = id;
+    makeAutoObservable(this);
+  }
+
+  get editorApiKey() {
+    if (typeof window !== "undefined") return (window as any).editorApiKey;
+  }
+
+  get src() {
+    return this.getSrc(1080);
+  }
+
+  get thumbnailSrc() {
+    return this.getSrc(180);
+  }
+
+  getSrc(size: number) {
+    if (this.id.includes("/"))
+      return `${process.env.NEXT_PUBLIC_IMG_BASE_URL}images/${this.id}/image_${size}.webp`;
+
+    const merchantId = decodeBase64(
+      this.editorApiKey || IkasStorefrontConfig.config.apiKey || ""
+    );
+    return `${process.env.NEXT_PUBLIC_IMG_BASE_URL}images/${merchantId}/${this.id}/image_${size}.webp`;
+  }
+}

package/src/models/data/index.ts

@@ -0,0 +1,55 @@
+export * from "./blog";
+export { IkasBrand } from "./brand";
+export { IkasCategory, IkasFilterCategory, IkasCategoryPath } from "./category";
+export * from "./checkout";
+export type { IkasCity } from "./city";
+export * from "./customer/address";
+export { IkasCustomer } from "./customer";
+export { IkasCustomerReview } from "./customer-review";
+export type { IkasCustomerReviewSettings } from "./customer-review-settings";
+export type { IkasCountry } from "./country";
+export type { IkasDistrict } from "./district";
+export { IkasHTMLMetaData, IkasHTMLMetaDataTargetType } from "./html-meta-data";
+export { IkasImage } from "./image";
+export * from "./installment-info";
+export type {
+  IkasInstallmentInfo,
+  IkasInstallmentPrice,
+  IkasInstallmentInfoInput,
+} from "./installment-info";
+export * from "./merchant-settings";
+export * from "./order";
+export { IkasOrderLineItem } from "./order/line-item";
+export { IkasOrderRefundSettings } from "./order/refund/settings";
+export { IkasOrderLineOptions } from "./order/line-item/options";
+export { IkasOrderLineOptionsValue } from "./order/line-item/options/options-value";
+export { IkasProduct, IkasProductType } from "./product";
+export { IkasProductVariantType } from "./product/variant-type";
+export { IkasProductVariant } from "./product/variant";
+export { IkasProductPrice } from "./product/variant/price";
+export {
+  IkasProductAttribute,
+  IkasProductAttributeType,
+} from "./product-attribute";
+export { IkasProductAttributeValue } from "./product/attribute-value";
+export type {
+  IkasAttributeTableCellValue,
+  IkasProductAttributeMap,
+} from "./product/attribute-value";
+export * from "./product-filter";
+export { IkasFavoriteProduct } from "./favorite-product";
+export { IkasContactForm } from "./contact-form";
+export type { IkasState } from "./state";
+export * from "./variant-type";
+export { IkasVariantValue } from "./variant-type/variant-value";
+export {
+  IkasOrderTransaction,
+  IkasTransactionStatusEnum,
+  IkasTransactionTypeEnum,
+} from "./order-transaction";
+export * from "./product-option-set";
+export {
+  IkasRaffle,
+  IkasRaffleParticipant,
+  IkasRaffleMetaData,
+} from "./raffle";

package/src/models/data/installment-info/index.ts

@@ -0,0 +1,34 @@
+export type IkasInstallmentInfo = {
+  bankName: string | null;
+  binNumber: string;
+  cardAssociation: IkasCardAssociation;
+  cardFamily: string | null;
+  cardType: IkasCardType;
+  installmentPrices: IkasInstallmentPrice[];
+  price: number;
+};
+
+export type IkasInstallmentPrice = {
+  installmentCount: number | null;
+  installmentPrice: number | null;
+  totalPrice: number | null;
+};
+
+export type IkasInstallmentInfoInput = {
+  binNumber: string;
+  paymentGatewayId: string;
+  price: number;
+};
+
+export enum IkasCardAssociation {
+  AMERICAN_EXPRESS = "AMERICAN_EXPRESS",
+  MASTER_CARD = "MASTER_CARD",
+  TROY = "TROY",
+  VISA = "VISA",
+}
+
+export enum IkasCardType {
+  CREDIT = "CREDIT",
+  DEBIT = "DEBIT",
+  PREPAID = "PREPAID",
+}

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

@@ -0,0 +1,14 @@
+import { IkasImage } from "../image";
+export class IkasMerchantSettings {
+  id: string;
+  logoId: string;
+  merchantName: string;
+  logo: IkasImage;
+
+  constructor(data: Partial<IkasMerchantSettings> = {}) {
+    this.id = data.id || "";
+    this.logoId = data.logoId || "";
+    this.merchantName = data.merchantName || "";
+    this.logo = new IkasImage(this.logoId);
+  }
+}

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

@@ -0,0 +1,138 @@
+import { makeAutoObservable } from "mobx";
+import { validatePhoneNumber } from "../../../../utils";
+import {
+  IkasCheckoutRequirementEnum,
+  IkasCheckoutSettings,
+} from "../../checkout-settings";
+
+export class IkasOrderAddress {
+  id?: string | null = null;
+  title?: string | null = null;
+  addressLine1?: string | null = null;
+  addressLine2?: string | null = null;
+  country?: IkasOrderAddressCountry | null = null;
+  state?: IkasOrderAddressState | null = null;
+  city?: IkasOrderAddressCity | null = null;
+  district?: IkasOrderAddressDistrict | 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<IkasOrderAddress> = {}) {
+    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;
+
+    this.checkoutSettings = data.checkoutSettings;
+    this.isDistrictRequired = data.isDistrictRequired || false;
+
+    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,
+    };
+
+    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 IkasOrderAddressLocation = {
+  id?: string;
+  name?: string;
+  code?: string;
+  iso2?: string;
+  iso3?: string;
+};
+
+export type IkasOrderAddressCountry = IkasOrderAddressLocation;
+export type IkasOrderAddressCity = IkasOrderAddressLocation;
+export type IkasOrderAddressDistrict = IkasOrderAddressLocation;
+export type IkasOrderAddressState = IkasOrderAddressLocation;
+
+export type IkasAddressValidationResult = {
+  firstName: boolean;
+  lastName: boolean;
+  addressLine1: boolean;
+  country: boolean;
+  state: boolean;
+  city: boolean;
+  district: boolean;
+  phone: boolean;
+  identityNumber: boolean;
+};

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

@@ -0,0 +1,17 @@
+export type IkasOrderAdjustment = {
+  amount: number;
+  amountType: IkasAmountTypeEnum;
+  name: string;
+  order: number;
+  type: IkasAdjustmentEnum;
+};
+
+export enum IkasAmountTypeEnum {
+  AMOUNT = "AMOUNT",
+  RATIO = "RATIO",
+}
+
+enum IkasAdjustmentEnum {
+  DECREMENT = "DECREMENT",
+  INCREMENT = "INCREMENT",
+}

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

@@ -0,0 +1,4 @@
+export type IkasOrderGiftPackageLine = {
+  price: number;
+  taxValue: number | null;
+};