@ikas/storefront 4.0.0-alpha.78 → 4.0.0-alpha.8

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

@@ -0,0 +1,29 @@
+import {
+  IkasPaymentGatewayAdditionalPriceType,
+  IkasPaymentGatewayTransactionFeeType,
+  IkasPaymentGatewayAdditionalPrice as IPaymentGatewayAdditionalPrice,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasPaymentGatewayAdditionalPrice
+  implements IPaymentGatewayAdditionalPrice
+{
+  amount: number;
+  amountType: IkasPaymentGatewayTransactionFeeType;
+  name: string;
+  type: IkasPaymentGatewayAdditionalPriceType;
+
+  constructor(data: IPaymentGatewayAdditionalPrice) {
+    this.amount = data.amount;
+    this.amountType = data.amountType;
+    this.name = data.name;
+    this.type = data.type;
+
+    makeAutoObservable(this);
+  }
+}
+
+export {
+  IkasPaymentGatewayAdditionalPriceType,
+  IkasPaymentGatewayTransactionFeeType,
+};

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

@@ -0,0 +1,90 @@
+import { IkasPaymentGatewayAdditionalPrice } from "./additional-price";
+import { IkasBaseModel } from "../base";
+import { IkasPaymentGatewayTranslation } from "./translation";
+import { IkasPaymentGatewaySettings } from "./settings";
+import {
+  IkasPaymentGatewayType,
+  IkasPaymentMethod,
+  IkasPaymentMethodType,
+  IkasPaymentGateway as IPaymentGateway,
+} from "@ikas/storefront-models";
+import { makeObservable, observable } from "mobx";
+import { IkasPaymentGatewayFunctions } from "@ikas/storefront-model-functions";
+import { IkasOrderShippingLine } from "../order/shipping-line";
+
+export class IkasPaymentGateway
+  extends IkasBaseModel
+  implements IPaymentGateway
+{
+  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;
+
+  constructor(data: IPaymentGateway) {
+    super(data);
+    this.additionalPrices =
+      data.additionalPrices?.map(
+        (ap) => new IkasPaymentGatewayAdditionalPrice(ap)
+      ) || null;
+    this.availableCountries = data.availableCountries || [];
+    this.code = data.code || "";
+    this.description = data.description || null;
+    this.logoUrl = data.logoUrl || null;
+    this.masterPassClientId = data.masterPassClientId || null;
+    this.name = data.name || "";
+    this.paymentGatewayProviderId = data.paymentGatewayProviderId || null;
+    this.supportedCurrencies = data.supportedCurrencies || [];
+    this.testMode = data.testMode || null;
+    this.type = data.type || IkasPaymentGatewayType.INTERNAL;
+    this.paymentMethods = data.paymentMethods || [];
+    this.paymentMethodType =
+      data.paymentMethodType || IkasPaymentMethodType.OTHER;
+    this.settings =
+      data.settings?.map((s) => new IkasPaymentGatewaySettings(s)) || null;
+    this.translations = data.translations || null;
+
+    makeObservable(this, {
+      additionalPrices: observable,
+      availableCountries: observable,
+      code: observable,
+      description: observable,
+      logoUrl: observable,
+      masterPassClientId: observable,
+      name: observable,
+      paymentGatewayProviderId: observable,
+      supportedCurrencies: observable,
+      testMode: observable,
+      type: observable,
+      paymentMethods: observable,
+      paymentMethodType: observable,
+      settings: observable,
+      translations: observable,
+    });
+  }
+
+  getCalculatedAdditionalPrices = (
+    totalFinalPrice: number,
+    shippingLines: IkasOrderShippingLine[] | null
+  ) => {
+    return IkasPaymentGatewayFunctions.getCalculatedAdditionalPrices(
+      this,
+      totalFinalPrice,
+      shippingLines
+    );
+  };
+}
+
+export { IkasPaymentGatewayType, IkasPaymentMethodType };
+export type { IkasPaymentMethod };

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

@@ -0,0 +1,21 @@
+import { IkasPaymentGatewaySettingsType } from "@ikas/storefront-models";
+import { IkasPaymentGatewaySettings as IPaymentGatewaySettings } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasPaymentGatewaySettings implements IPaymentGatewaySettings {
+  label: string;
+  order: number;
+  type: IkasPaymentGatewaySettingsType;
+  value: string | null = null;
+
+  constructor(data: IPaymentGatewaySettings) {
+    this.label = data.label;
+    this.order = data.order;
+    this.type = data.type;
+    this.value = data.value || null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export { IkasPaymentGatewaySettingsType };

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

@@ -0,0 +1,18 @@
+import { IkasPaymentGatewayTranslation as IPaymentGatewayTranslation } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasPaymentGatewayTranslation
+  implements IPaymentGatewayTranslation
+{
+  description: string | null;
+  locale: string | null;
+  name: string | null;
+
+  constructor(data: IPaymentGatewayTranslation) {
+    this.description = data.description || null;
+    this.locale = data.locale || null;
+    this.name = data.name || null;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,37 @@
+import { IkasProductAttributeTableTemplate } from "./table-template";
+import { IkasProductAttributeOption } from "./option";
+import { IkasProductAttributeTranslation } from "./translation";
+import {
+  IkasProductAttributeType,
+  IkasProductAttribute as IProductAttribute,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductAttribute implements IProductAttribute {
+  id: string;
+  name: string;
+  description: string | null = null;
+  type: IkasProductAttributeType;
+  options: IkasProductAttributeOption[] | null = null;
+  tableTemplate: IkasProductAttributeTableTemplate | null = null;
+  translations?: IkasProductAttributeTranslation[] | null = null;
+
+  constructor(data: IProductAttribute) {
+    this.id = data.id;
+    this.name = data.name;
+    this.description = data.description || null;
+    this.type = data.type || null;
+    this.options =
+      data.options?.map((o) => new IkasProductAttributeOption(o)) || null;
+    this.tableTemplate = data.tableTemplate
+      ? new IkasProductAttributeTableTemplate(data.tableTemplate)
+      : null;
+    this.translations =
+      data.translations?.map((t) => new IkasProductAttributeTranslation(t)) ||
+      null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export { IkasProductAttributeType };

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

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

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

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

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

@@ -0,0 +1,19 @@
+import { IkasProductAttributeTableCell } from "../table-cell";
+import { IkasProductAttributeTableTemplate as IProductAttributeTableTemplate } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductAttributeTableTemplate
+  implements IProductAttributeTableTemplate
+{
+  columns: IkasProductAttributeTableCell[] | null;
+  rows: IkasProductAttributeTableCell[] | null;
+
+  constructor(data: IProductAttributeTableTemplate) {
+    this.columns =
+      data.columns?.map((c) => new IkasProductAttributeTableCell(c)) || null;
+    this.rows =
+      data.rows?.map((r) => new IkasProductAttributeTableCell(r)) || null;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,39 @@
+import {
+  IkasProductAttributeTranslation as IProductAttributeTranslation,
+  IkasProductAttributeOptionTranslation as IProductAttributeOptionTranslation,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductAttributeTranslation
+  implements IProductAttributeTranslation
+{
+  description: string | null = null;
+  locale: string;
+  name: string | null = null;
+  options: IkasProductAttributeOptionTranslation[] | null = null;
+
+  constructor(data: IProductAttributeTranslation) {
+    this.description = data.description;
+    this.locale = data.locale;
+    this.name = data.name;
+    this.options =
+      data.options?.map((o) => new IkasProductAttributeOptionTranslation(o)) ||
+      null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductAttributeOptionTranslation
+  implements IProductAttributeOptionTranslation
+{
+  id: string;
+  name: string | null = null;
+
+  constructor(data: IProductAttributeOptionTranslation) {
+    this.id = data.id;
+    this.name = data.name;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,69 @@
+import { IkasImage } from "../../image";
+import { IkasProductAttribute } from "../attribute";
+import { IkasProductAttributeOption } from "../attribute/option";
+import {
+  IkasProductAttributeValue as IProductAttributeValue,
+  IkasAttributeTableCellValue as IAttributeTableCellValue,
+  IkasProductAttributeMap as IProductAttributeMap,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasProductAttributeValueFunctions } from "@ikas/storefront-model-functions";
+
+export class IkasProductAttributeValue implements IProductAttributeValue {
+  imageIds: string[] | null = null;
+  productAttributeId: string | null = null;
+  productAttributeOptionId: string | null = null;
+  value: string | null = null;
+
+  // Extra
+  images?: IkasImage[];
+  productAttribute?: IkasProductAttribute | null = null;
+  productAttributeOption?: IkasProductAttributeOption | null = null;
+
+  constructor(data: IProductAttributeValue) {
+    this.imageIds = data.imageIds;
+    this.productAttributeId = data.productAttributeId;
+    this.productAttributeOptionId = data.productAttributeOptionId;
+    this.value = data.value || null;
+
+    this.images = data.images?.map((i) => new IkasImage(i));
+    this.productAttribute = data.productAttribute
+      ? new IkasProductAttribute(data.productAttribute)
+      : null;
+    this.productAttributeOption = data.productAttributeOption
+      ? new IkasProductAttributeOption(data.productAttributeOption)
+      : null;
+
+    makeAutoObservable(this);
+  }
+
+  get tableValue() {
+    return IkasProductAttributeValueFunctions.getTableValue(this.value);
+  }
+}
+
+export class IkasAttributeTableCellValue implements IAttributeTableCellValue {
+  colId: string;
+  rowId: string;
+  value: string | null;
+
+  constructor(data: IAttributeTableCellValue) {
+    this.colId = data.colId;
+    this.rowId = data.rowId;
+    this.value = data.value;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductAttributeMap implements IProductAttributeMap {
+  attribute: IkasProductAttribute;
+  values: IkasProductAttributeValue[];
+
+  constructor(data: IProductAttributeMap) {
+    this.attribute = data.attribute;
+    this.values = data.values.map((v) => new IkasProductAttributeValue(v));
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,14 @@
+import { IkasProductBackInStockSettings as IProductBackInStockSettings } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductBackInStockSettings
+  implements IProductBackInStockSettings
+{
+  customerLoginRequired: boolean;
+
+  constructor(data: IProductBackInStockSettings) {
+    this.customerLoginRequired = data.customerLoginRequired;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,70 @@
+import {
+  IkasCampaignApplicablePrice,
+  IkasCampaignCreatedFor,
+  IkasCampaignType,
+  IkasProductCampaignData as IProductCampaignData,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasProductBuyXThenGetY } from "../product-buyx-then-gety";
+import { IkasProductCampaignDateRangeField } from "../product-campaign-date-range-field";
+import { IkasProductFixedDiscount } from "../product-fixed-discount";
+
+export class IkasProductCampaignData implements IProductCampaignData {
+  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;
+
+  constructor(data: IProductCampaignData) {
+    this.applicableCustomerGroupIds = data.applicableCustomerGroupIds || null;
+    this.applicableCustomerIds = data.applicableCustomerIds || null;
+    this.applicablePrice =
+      data.applicablePrice || IkasCampaignApplicablePrice.DISCOUNT_PRICE;
+    this.buyXThenGetY = data.buyXThenGetY
+      ? new IkasProductBuyXThenGetY(data.buyXThenGetY)
+      : new IkasProductBuyXThenGetY();
+    this.canCombineWithOtherCampaigns =
+      data.canCombineWithOtherCampaigns || false;
+    this.createdFor = data.createdFor || null;
+    this.currencyCodes = data.currencyCodes || null;
+    this.dateRange = data.dateRange
+      ? new IkasProductCampaignDateRangeField(data.dateRange)
+      : null;
+    this.deleted = data.deleted || false;
+    this.fixedDiscount = data.fixedDiscount
+      ? new IkasProductFixedDiscount(data.fixedDiscount)
+      : null;
+    this.hasCoupon = data.hasCoupon || false;
+    this.id = data.id || "";
+    this.includeDiscountedProducts = data.includeDiscountedProducts || null;
+    this.salesChannelIds = data.salesChannelIds || null;
+    this.title = data.title || "";
+    this.type = data.type || IkasCampaignType.BUY_X_THEN_GET_Y;
+    this.usageCount = data.usageCount || 0;
+    this.usageLimit = data.usageLimit || null;
+    this.usageLimitPerCustomer = data.usageLimitPerCustomer || null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export {
+  IkasCampaignApplicablePrice,
+  IkasCampaignCreatedFor,
+  IkasCampaignType,
+};

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

@@ -0,0 +1,19 @@
+import {
+  IkasCampaignFilterType,
+  IkasProductCampaignFilter as IProductCampaignFilter,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductCampaignFilter implements IProductCampaignFilter {
+  idList: string[];
+  type: IkasCampaignFilterType;
+
+  constructor(data?: IProductCampaignFilter) {
+    this.idList = data?.idList || [];
+    this.type = data?.type || IkasCampaignFilterType.PRODUCT;
+
+    makeAutoObservable(this);
+  }
+}
+
+export { IkasCampaignFilterType };

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

@@ -0,0 +1,15 @@
+import { IkasProductCampaignData } from "./data";
+import { IkasProductCampaign as IProductCampaign } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductCampaign implements IProductCampaign {
+  campaign: IkasProductCampaignData;
+  variantIds: string[];
+
+  constructor(data: IProductCampaign) {
+    this.campaign = data.campaign;
+    this.variantIds = data.variantIds;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,57 @@
+import { makeAutoObservable } from "mobx";
+import { IkasProductCampaignFilter } from "../filter";
+import {
+  IkasProductBuyX as IProductBuyX,
+  IkasProductGetY as IProductGetY,
+  IkasProductBuyXThenGetY as IProductBuyXThenGetY,
+} from "@ikas/storefront-models";
+
+export class IkasProductBuyX implements IProductBuyX {
+  amount: number;
+  applyByQuantity: boolean;
+  filter: IkasProductCampaignFilter;
+
+  constructor(data: Partial<IProductBuyX> = {}) {
+    this.amount = data.amount || 0;
+    this.applyByQuantity = data.applyByQuantity || false;
+    this.filter = data.filter
+      ? new IkasProductCampaignFilter(data.filter)
+      : new IkasProductCampaignFilter();
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductGetY implements IProductGetY {
+  amount: number;
+  discountRatio: number;
+  filter: IkasProductCampaignFilter;
+
+  constructor(data: Partial<IProductGetY> = {}) {
+    this.amount = data.amount || 0;
+    this.discountRatio = data.discountRatio || 0;
+    this.filter = data.filter
+      ? new IkasProductCampaignFilter(data.filter)
+      : new IkasProductCampaignFilter();
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductBuyXThenGetY implements IProductBuyXThenGetY {
+  buyX: IkasProductBuyX;
+  getY: IkasProductGetY;
+  maxUsagePerOrder: number;
+
+  constructor(data: Partial<IProductBuyXThenGetY> = {}) {
+    this.buyX = data.buyX
+      ? new IkasProductBuyX(data.buyX)
+      : new IkasProductBuyX();
+    this.getY = data.getY
+      ? new IkasProductGetY(data.getY)
+      : new IkasProductGetY();
+    this.maxUsagePerOrder = data.maxUsagePerOrder || 0;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,16 @@
+import { IkasProductCampaignDateRangeField as IProductCampaignDateRangeField } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductCampaignDateRangeField
+  implements IProductCampaignDateRangeField
+{
+  start: number | null = null;
+  end: number | null = null;
+
+  constructor(data: IProductCampaignDateRangeField) {
+    this.start = data.start || null;
+    this.end = data.end || null;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,40 @@
+import { IkasProductCampaignFilter } from "../filter";
+import {
+  IkasCampaignMinMaxRangeField as ICampaignMinMaxRangeField,
+  IkasProductFixedDiscount as IProductFixedDiscount,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasCampaignMinMaxRangeField implements ICampaignMinMaxRangeField {
+  min: number | null;
+  max: number | null;
+
+  constructor(data: ICampaignMinMaxRangeField) {
+    this.min = data.min || null;
+    this.max = data.max || null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductFixedDiscount implements IProductFixedDiscount {
+  amount: number | null;
+  filters: IkasProductCampaignFilter | null;
+  lineItemQuantityRange: IkasCampaignMinMaxRangeField | null;
+  priceRange: IkasCampaignMinMaxRangeField | null;
+
+  constructor(data: IProductFixedDiscount) {
+    this.amount = data.amount || null;
+    this.filters = data.filters
+      ? new IkasProductCampaignFilter(data.filters)
+      : null;
+    this.lineItemQuantityRange = data.lineItemQuantityRange
+      ? new IkasCampaignMinMaxRangeField(data.lineItemQuantityRange)
+      : null;
+    this.priceRange = data.priceRange
+      ? new IkasCampaignMinMaxRangeField(data.priceRange)
+      : null;
+
+    makeAutoObservable(this);
+  }
+}