@ikas/storefront-models 4.0.0-alpha.49 → 4.0.0-alpha.50

package/src/models/order/refund/settings/index.ts

@@ -0,0 +1,5 @@
+export type IkasOrderRefundSettings = {
+  isActiveRefundSection: boolean;
+  orderRefundDayLimit: number | null;
+  refundDesc: string;
+};

package/src/models/order/shipping-line/index.ts

@@ -0,0 +1,12 @@
+import { IkasPaymentMethodType } from "../../payment-gateway";
+
+export type IkasOrderShippingLine = {
+  finalPrice: number;
+  isRefunded: boolean | null;
+  paymentMethod: IkasPaymentMethodType | null;
+  price: number;
+  shippingSettingsId: string | null;
+  shippingZoneRateId: string | null;
+  taxValue: number | null;
+  title: string;
+};

package/src/models/order/tax-line/index.ts

@@ -0,0 +1,4 @@
+export type IkasOrderTaxLine = {
+  price: number;
+  rate: number;
+};

package/src/models/order/transaction/error/index.ts

@@ -0,0 +1,5 @@
+export type IkasTransactionError = {
+  code: string | null;
+  declineCode: string | null;
+  message: string | null;
+};

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

@@ -0,0 +1,37 @@
+import { IkasPaymentMethodType } from "../../payment-gateway";
+import { IkasTransactionError } from "./error";
+import { IkasTransactionPaymentMethodDetail } from "./payment-method-detail";
+
+export type IkasOrderTransaction = {
+  amount: number | null;
+  checkoutId: string | null;
+  createdAt: number | null;
+  currencyCode: string | null;
+  currencySymbol: string | null;
+  customerId: string | null;
+  error: IkasTransactionError | null;
+  id: string | null;
+  orderId: string | null;
+  paymentGatewayId: string | null;
+  paymentGatewayName: string | null;
+  paymentMethod: IkasPaymentMethodType | null;
+  paymentMethodDetail: IkasTransactionPaymentMethodDetail | null;
+  processedAt: number | null;
+  refundReason: string | null;
+  status: IkasTransactionStatus | null;
+  type: IkasTransactionType | null;
+  updatedAt: number | null;
+};
+
+export enum IkasTransactionStatus {
+  AUTHORIZED = "AUTHORIZED",
+  FAILED = "FAILED",
+  PENDING = "PENDING",
+  SUCCESS = "SUCCESS",
+}
+
+export enum IkasTransactionType {
+  REFUND = "REFUND",
+  SALE = "SALE",
+  VOID = "VOID",
+}

package/src/models/order/transaction/payment-method-detail/index.ts

@@ -0,0 +1,25 @@
+import { IkasTransactionInstallmentPrice } from "./installment-price";
+
+export type IkasTransactionPaymentMethodDetail = {
+  bankName: string | null;
+  binNumber: string;
+  cardAssociation: IkasTransactionCardAssociation | null;
+  cardFamily: string | null;
+  cardType: IkasTransactionCardType | null;
+  installment: IkasTransactionInstallmentPrice | null;
+  lastFourDigits: string;
+  threeDSecure: boolean | null;
+};
+
+export enum IkasTransactionCardAssociation {
+  AMERICAN_EXPRESS = "AMERICAN_EXPRESS",
+  MASTER_CARD = "MASTER_CARD",
+  TROY = "TROY",
+  VISA = "VISA",
+}
+
+export enum IkasTransactionCardType {
+  CREDIT = "CREDIT",
+  DEBIT = "DEBIT",
+  PREPAID = "PREPAID",
+}

package/src/models/order/transaction/payment-method-detail/installment-price/index.ts

@@ -0,0 +1,7 @@
+export type IkasTransactionInstallmentPrice = {
+  installmentCount: number | null;
+  installmentPrice: number | null;
+  originalRate: number | null;
+  rate: number | null;
+  totalPrice: number | null;
+};

package/src/models/payment-gateway/additional-price/index.ts

@@ -0,0 +1,16 @@
+export type IkasPaymentGatewayAdditionalPrice = {
+  amount: number;
+  amountType: IkasPaymentGatewayTransactionFeeType;
+  name: string;
+  type: IkasPaymentGatewayAdditionalPriceType;
+};
+
+export enum IkasPaymentGatewayTransactionFeeType {
+  AMOUNT = "AMOUNT",
+  RATIO = "RATIO",
+}
+
+export enum IkasPaymentGatewayAdditionalPriceType {
+  DECREMENT = "DECREMENT",
+  INCREMENT = "INCREMENT",
+}

package/src/models/payment-gateway/index.ts

@@ -0,0 +1,47 @@
+import { IkasPaymentGatewayAdditionalPrice } from "./additional-price";
+import { IkasBaseModel } from "../base";
+import { IkasPaymentGatewayTranslation } from "./translation";
+import { IkasPaymentGatewaySettings } from "./settings";
+
+export type IkasPaymentGateway = {
+  additionalPrices: IkasPaymentGatewayAdditionalPrice[] | null;
+  availableCountries: string[] | null;
+  code: string;
+  description: string | null;
+  logoUrl: string | null;
+  masterPassClientId: string | null;
+  name: string;
+  paymentGatewayProviderId: string | null;
+  supportedCurrencies: string[] | null;
+  testMode: boolean | null;
+  type: IkasPaymentGatewayType;
+  paymentMethods: IkasPaymentMethod[];
+  paymentMethodType: IkasPaymentMethodType;
+  settings?: IkasPaymentGatewaySettings[] | null;
+
+  translations?: IkasPaymentGatewayTranslation[] | null;
+} & IkasBaseModel;
+
+export enum IkasPaymentMethodType {
+  APP_PAYMENT = "APP_PAYMENT",
+  BUY_ONLINE_PAY_AT_STORE = "BUY_ONLINE_PAY_AT_STORE",
+  CASH = "CASH",
+  CASH_ON_DELIVERY = "CASH_ON_DELIVERY",
+  CREDIT_CARD = "CREDIT_CARD",
+  CREDIT_CARD_ON_DELIVERY = "CREDIT_CARD_ON_DELIVERY",
+  GIFT_CARD = "GIFT_CARD",
+  MONEY_ORDER = "MONEY_ORDER",
+  OTHER = "OTHER",
+  WALLET = "WALLET",
+}
+
+export type IkasPaymentMethod = {
+  name: string;
+  logoUrl: string | null;
+};
+
+export enum IkasPaymentGatewayType {
+  EXTERNAL = "EXTERNAL",
+  INTERNAL = "INTERNAL",
+  THIRD_PARTY = "THIRD_PARTY",
+}

package/src/models/payment-gateway/init.ts

@@ -0,0 +1,26 @@
+import { IkasPaymentGateway } from ".";
+import { IkasPaymentGatewayTranslation } from "./translation";
+
+export function initIkasPaymentGateway(
+  paymentGateway: IkasPaymentGateway,
+  locale: string | null
+) {
+  if (paymentGateway.translations && locale) {
+    setTranslations(paymentGateway, paymentGateway.translations, locale);
+    delete paymentGateway.translations;
+  }
+}
+
+function setTranslations(
+  paymentGateway: IkasPaymentGateway,
+  translations: IkasPaymentGatewayTranslation[],
+  locale: string
+) {
+  if (translations && translations.some((t) => t.locale === locale)) {
+    const localeTranslations = translations.find((t) => t.locale === locale);
+
+    if (localeTranslations?.name) paymentGateway.name = localeTranslations.name;
+    if (localeTranslations?.description)
+      paymentGateway.description = localeTranslations.description;
+  }
+}

package/src/models/payment-gateway/settings/index.ts

@@ -0,0 +1,12 @@
+export type IkasPaymentGatewaySettings = {
+  label: string;
+  order: number;
+  type: IkasPaymentGatewaySettingsType;
+  value: string | null;
+};
+
+export enum IkasPaymentGatewaySettingsType {
+  NUMBER = "NUMBER",
+  PASSWORD = "PASSWORD",
+  TEXT = "TEXT",
+}

package/src/models/payment-gateway/translation/index.ts

@@ -0,0 +1,5 @@
+export type IkasPaymentGatewayTranslation = {
+  description: string | null;
+  locale: string | null;
+  name: string | null;
+};

package/src/models/product/attribute/index.ts

@@ -0,0 +1,26 @@
+import { IkasProductAttributeTableTemplate } from "./table-template";
+import { IkasProductAttributeOption } from "./option";
+import { IkasProductAttributeTranslation } from "./translation";
+
+export type IkasProductAttribute = {
+  id: string;
+  name: string;
+  description: string | null;
+  type: IkasProductAttributeType;
+  options: IkasProductAttributeOption[] | null;
+  tableTemplate: IkasProductAttributeTableTemplate | null;
+  translations?: IkasProductAttributeTranslation[] | null;
+};
+
+export enum IkasProductAttributeType {
+  CHOICE = "CHOICE",
+  MULTIPLE_CHOICE = "MULTIPLE_CHOICE",
+  TEXT = "TEXT",
+  BOOLEAN = "BOOLEAN",
+  NUMERIC = "NUMERIC",
+  DATETIME = "DATETIME",
+  HTML = "HTML",
+  TABLE = "TABLE",
+  IMAGE = "IMAGE",
+  PRODUCT = "PRODUCT",
+}

package/src/models/product/attribute/init.ts

@@ -0,0 +1,34 @@
+import { IkasProductAttribute } from ".";
+import { IkasProductAttributeTranslation } from "./translation";
+
+export function initIkasProductAttribute(
+  attribute: IkasProductAttribute,
+  locale: string | null
+) {
+  if (attribute.translations && locale) {
+    setTranslations(attribute, attribute.translations, locale);
+    delete attribute.translations;
+  }
+}
+
+function setTranslations(
+  attribute: IkasProductAttribute,
+  translations: IkasProductAttributeTranslation[],
+  locale: string
+) {
+  if (translations && translations.some((t) => t.locale === locale)) {
+    const localeTranslations = translations.find((t) => t.locale === locale);
+
+    if (localeTranslations?.name) attribute.name = localeTranslations.name;
+    if (localeTranslations?.description)
+      attribute.description = localeTranslations.description;
+    if (localeTranslations?.options) {
+      attribute.options?.forEach((o) => {
+        const translatedVV = localeTranslations.options?.find(
+          (to) => to.id === o.id
+        );
+        if (translatedVV && translatedVV.name) o.name = translatedVV.name;
+      });
+    }
+  }
+}

package/src/models/product/attribute/option/index.ts

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

package/src/models/product/attribute/table-cell/index.ts

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

package/src/models/product/attribute/table-template/index.ts

@@ -0,0 +1,6 @@
+import { IkasProductAttributeTableCell } from "../table-cell";
+
+export type IkasProductAttributeTableTemplate = {
+  columns: IkasProductAttributeTableCell[] | null;
+  rows: IkasProductAttributeTableCell[] | null;
+};

package/src/models/product/attribute/translation/index.ts

@@ -0,0 +1,11 @@
+export type IkasProductAttributeTranslation = {
+  description: string | null;
+  locale: string;
+  name: string | null;
+  options: IkasProductAttributeOptionTranslation[] | null;
+};
+
+export type IkasProductAttributeOptionTranslation = {
+  id: string;
+  name: string | null;
+};

package/src/models/product/attribute-value/index.ts

@@ -0,0 +1,26 @@
+import { IkasImage } from "../../image";
+import { IkasProductAttribute } from "../attribute";
+import { IkasProductAttributeOption } from "../attribute/option";
+
+export type IkasProductAttributeValue = {
+  imageIds: string[] | null;
+  productAttributeId: string | null;
+  productAttributeOptionId: string | null;
+  value: string | null;
+
+  // Extra
+  images?: IkasImage[];
+  productAttribute?: IkasProductAttribute | null;
+  productAttributeOption?: IkasProductAttributeOption | null;
+};
+
+export type IkasAttributeTableCellValue = {
+  colId: string;
+  rowId: string;
+  value: string | null;
+};
+
+export type IkasProductAttributeMap = {
+  attribute: IkasProductAttribute;
+  values: IkasProductAttributeValue[];
+};

package/src/models/product/attribute-value/init.ts

@@ -0,0 +1,7 @@
+import { IkasProductAttributeValue } from ".";
+
+export function initIkasProductAttributeValue(
+  value: IkasProductAttributeValue
+) {
+  value.images = value.imageIds?.map((i) => ({ id: i, isVideo: false }));
+}

package/src/models/product/back-in-stock-settings/index.ts

@@ -0,0 +1,3 @@
+export type IkasProductBackInStockSettings = {
+  customerLoginRequired: boolean;
+};

package/src/models/product/base-unit/index.ts

@@ -0,0 +1,12 @@
+import { IkasProductUnitType } from "../../order/line-item/base-unit";
+
+export type IkasProductBaseUnit = {
+  baseAmount: number | null;
+  type: IkasProductUnitType;
+  unit: IkasProductUnit;
+};
+
+export type IkasProductUnit = {
+  id: string;
+  name: string;
+};

package/src/models/product/campaign/data/index.ts

@@ -0,0 +1,43 @@
+import { IkasProductBuyXThenGetY } from "../product-buyx-then-gety";
+import { IkasProductCampaignDateRangeField } from "../product-campaign-date-range-field";
+import { IkasProductFixedDiscount } from "../product-fixed-discount";
+
+export type IkasProductCampaignData = {
+  applicableCustomerGroupIds: string[] | null;
+  applicableCustomerIds: string[] | null;
+  applicablePrice: IkasCampaignApplicablePrice;
+  buyXThenGetY: IkasProductBuyXThenGetY;
+  canCombineWithOtherCampaigns: boolean;
+  createdFor: IkasCampaignCreatedFor | null;
+  currencyCodes: [string] | null;
+  dateRange: IkasProductCampaignDateRangeField | null;
+  deleted: boolean;
+  fixedDiscount: IkasProductFixedDiscount | null;
+  hasCoupon: boolean;
+  id: string;
+  includeDiscountedProducts: boolean | null;
+  salesChannelIds: string[] | null;
+  title: string;
+  type: IkasCampaignType;
+  usageCount: number;
+  usageLimit: number | null;
+  usageLimitPerCustomer: number | null;
+};
+
+export enum IkasCampaignApplicablePrice {
+  DISCOUNT_PRICE = "DISCOUNT_PRICE",
+  SELL_PRICE = "SELL_PRICE",
+}
+
+export enum IkasCampaignCreatedFor {
+  ABANDONED_CHECKOUT = "ABANDONED_CHECKOUT",
+  CART = "CART",
+  CUSTOMER_REVIEW = "CUSTOMER_REVIEW",
+}
+
+export enum IkasCampaignType {
+  BUY_X_THEN_GET_Y = "BUY_X_THEN_GET_Y",
+  FIXED_AMOUNT = "FIXED_AMOUNT",
+  FREE_SHIPPING = "FREE_SHIPPING",
+  RATIO = "FREE_SHIPPING",
+}

package/src/models/product/campaign/filter/index.ts

@@ -0,0 +1,12 @@
+export type IkasProductCampaignFilter = {
+  idList: string[];
+  type: IkasCampaignFilterType;
+};
+
+export enum IkasCampaignFilterType {
+  CATEGORY = "CATEGORY",
+  PRODUCT = "PRODUCT",
+  PRODUCT_BRAND = "PRODUCT_BRAND",
+  PRODUCT_TAG = "PRODUCT_TAG",
+  VARIANT = "VARIANT",
+}

package/src/models/product/campaign/index.ts

@@ -0,0 +1,6 @@
+import { IkasProductCampaignData } from "./data";
+
+export type IkasProductCampaign = {
+  campaign: IkasProductCampaignData;
+  variantIds: string[];
+};

package/src/models/product/campaign/product-buyx-then-gety/index.ts

@@ -0,0 +1,19 @@
+import { IkasProductCampaignFilter } from "../filter";
+
+export type IkasProductBuyX = {
+  amount: number;
+  applyByQuantity: boolean;
+  filter: IkasProductCampaignFilter;
+};
+
+export type IkasProductGetY = {
+  amount: number;
+  discountRatio: number;
+  filter: IkasProductCampaignFilter;
+};
+
+export type IkasProductBuyXThenGetY = {
+  buyX: IkasProductBuyX;
+  getY: IkasProductGetY;
+  maxUsagePerOrder: number;
+};

package/src/models/product/campaign/product-campaign-date-range-field/index.ts

@@ -0,0 +1,4 @@
+export type IkasProductCampaignDateRangeField = {
+  start: number | null;
+  end: number | null;
+};

package/src/models/product/campaign/product-fixed-discount/index.ts

@@ -0,0 +1,13 @@
+import { IkasProductCampaignFilter } from "../filter";
+
+export type IkasCampaignMinMaxRangeField = {
+  min: number | null;
+  max: number | null;
+};
+
+export type IkasProductFixedDiscount = {
+  amount: number | null;
+  filters: IkasProductCampaignFilter | null;
+  lineItemQuantityRange: IkasCampaignMinMaxRangeField | null;
+  priceRange: IkasCampaignMinMaxRangeField | null;
+};

package/src/models/product/filter/index.ts

@@ -0,0 +1,98 @@
+import { IkasImage } from "../../image";
+
+export type IkasProductFilter = {
+  id: string;
+  key: string;
+  name: string;
+  order: number;
+  type: IkasProductFilterType;
+  displayType: IkasProductFilterDisplayType;
+  isMultiSelect: boolean;
+  isFacetFilter: boolean | null;
+  values?: IkasApplicableProductFilterValue[] | null;
+  customValues?: string[] | null;
+  settings?: IkasProductFilterSettings | null;
+
+  // Extra
+  numberRange?: IkasFilterRangeValue | null; // Selected range value for the number slider
+  numberRangeLimit?: IkasFilterRangeValue | null; // Limits for the number range slider
+  numberRangeListOptions?: IkasProductFilterNumberRangeListOption[] | null; // List options for the number range select
+};
+
+export type IkasApplicableProductFilterValue = {
+  id: string;
+  key: string;
+  name: string;
+  colorCode?: string | null;
+  thumbnailImageId?: string | null;
+  thumbnailImage?: IkasImage | null;
+  resultCount?: number | null;
+
+  // Extra
+  isSelected: boolean;
+};
+
+export type IkasProductFilterValue = {
+  id: string;
+  type: IkasProductFilterType;
+  displayType: IkasProductFilterDisplayType;
+  valueList: string[];
+};
+
+export type IkasProductFilterSettings = {
+  useAndFilter?: boolean | null;
+  showCollapsedOnDesktop: boolean;
+  showCollapsedOnMobile: boolean;
+  sortType: IkasProductFilterSortType;
+  customSortedValues: string[] | null;
+};
+
+export type IkasProductFacetInput = {
+  id: string;
+  type: IkasProductFilterType;
+  displayType: IkasProductFilterDisplayType;
+};
+
+export enum IkasProductFilterType {
+  ATTRIBUTE = "ATTRIBUTE",
+  BRAND = "BRAND",
+  DISCOUNT_RATIO = "DISCOUNT_RATIO",
+  PRICE = "PRICE",
+  STOCK_STATUS = "STOCK_STATUS",
+  TAG = "TAG",
+  VARIANT_TYPE = "VARIANT_TYPE",
+}
+
+export enum IkasProductFilterDisplayType {
+  BOX = "BOX",
+  DATE_RANGE = "DATE_RANGE",
+  LIST = "LIST",
+  NUMBER_RANGE_LIST = "NUMBER_RANGE_LIST",
+  NUMBER_RANGE = "NUMBER_RANGE",
+  SWATCH = "SWATCH",
+}
+
+export enum IkasProductFilterSortType {
+  ALPHABETICAL_ASC = "ALPHABETICAL_ASC",
+  ALPHABETICAL_DESC = "ALPHABETICAL_DESC",
+  PRODUCT_COUNT_ASC = "PRODUCT_COUNT_ASC",
+  PRODUCT_COUNT_DESC = "PRODUCT_COUNT_DESC",
+  CUSTOM_SORT = "CUSTOM_SORT",
+}
+
+export enum IkasProductStockFilterValue {
+  IN_STOCK = "in-stock",
+  OUT_OF_STOCK = "out-of-stock",
+}
+
+export type IkasFilterRangeValue = {
+  from: number;
+  to: number | undefined | null;
+};
+
+export type IkasProductFilterNumberRangeListOption = {
+  from: number;
+  to: number | undefined | null;
+  key: string;
+  isSelected: boolean;
+};

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

@@ -0,0 +1,10 @@
+import { IkasImage } from "../../image";
+
+export type IkasProductImage = {
+  imageId: string | null;
+  isMain: boolean;
+  isVideo: boolean | null;
+  order: number;
+
+  image?: IkasImage | null;
+};

package/src/models/product/image/init.ts

@@ -0,0 +1,7 @@
+import { IkasProductImage } from ".";
+
+export function initIkasProductImage(productImage: IkasProductImage) {
+  productImage.image = productImage.imageId
+    ? { id: productImage.imageId, isVideo: productImage.isVideo || false }
+    : null;
+}

package/src/models/product/index.ts

@@ -0,0 +1,45 @@
+import { IkasCategory } from "../category";
+import { IkasProductVariant } from "./variant";
+import { IkasProductAttributeValue } from "./attribute-value";
+import { IkasProductVariantType } from "./variant-type";
+import { IkasBrand } from "../brand";
+import { IkasHTMLMetaData } from "../html-meta-data";
+import { IkasProductTag } from "./tag";
+import { IkasVariantValue } from "../variant-type/variant-value";
+import { IkasVariantType } from "../variant-type";
+import { IkasProductBaseUnit } from "./base-unit";
+
+export type IkasProduct = {
+  id: string;
+  name: string;
+  type: IkasProductType;
+  description: string;
+  shortDescription: string;
+  metaData: IkasHTMLMetaData | null;
+  brand: IkasBrand | null;
+  categories: IkasCategory[];
+  tags: IkasProductTag[] | null;
+  variants: IkasProductVariant[];
+  attributes: IkasProductAttributeValue[];
+  variantTypes: IkasProductVariantType[];
+  productOptionSetId: string | null;
+  baseUnit: IkasProductBaseUnit | null;
+};
+
+export enum IkasProductType {
+  PHYSICAL = "PHYSICAL",
+  DIGITAL = "DIGITAL",
+  MEMBERSHIP = "MEMBERSHIP",
+}
+
+export type IkasDisplayedVariantValue = {
+  variant: IkasProductVariant; // TODO remove?
+  variantValue: IkasVariantValue;
+  hasStock: boolean;
+  isSelected: boolean;
+};
+
+export type IkasDisplayedVariantType = {
+  variantType: IkasVariantType;
+  displayedVariantValues: IkasDisplayedVariantValue[];
+};

package/src/models/product/init.ts

@@ -0,0 +1,16 @@
+import type { IkasProduct } from ".";
+import { initIkasProductVariantType } from "./variant-type/init";
+import { initIkasProductVariant } from "./variant/init";
+import { initIkasProductAttributeValue } from "./attribute-value/init";
+import { initIkasBrand } from "../brand/init";
+import { initIkasCategory } from "../category/init";
+import { initIkasHTMLMetaData } from "../html-meta-data/init";
+
+export function initIkasProduct(product: IkasProduct, locale: string | null) {
+  product.metaData && initIkasHTMLMetaData(product.metaData, locale);
+  product.brand && initIkasBrand(product.brand, locale);
+  product.categories.forEach((c) => initIkasCategory(c, locale));
+  product.variants.forEach(initIkasProductVariant);
+  product.attributes.forEach(initIkasProductAttributeValue);
+  product.variantTypes.forEach(initIkasProductVariantType);
+}