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

package/src/models/data/product/option-set/option/index.ts

@@ -0,0 +1,245 @@
+import {
+  IkasProductOptionSelectType,
+  IkasProductOptionType,
+  IkasProductOptionOtherPrice as IProductOptionOtherPrice,
+  IkasProductOptionSelectValue as IProductOptionSelectValue,
+  IkasProductOptionSelectSettings as IProductOptionSelectSettings,
+  IkasProductOptionDateSettings as IProductOptionDateSettings,
+  IkasProductOptionTextSettings as IProductOptionTextSettings,
+  IkasProductOptionFileSettings as IProductOptionFileSettings,
+  IkasProductOption as IProductOption,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasImage } from "../../../image";
+import _sortBy from "lodash/sortBy";
+import { IkasProductOptionFunctions } from "@ikas/storefront-model-functions";
+import { uploadProductOptionFile } from "@ikas/storefront-api";
+
+export class IkasProductOptionOtherPrice implements IProductOptionOtherPrice {
+  currencyCode: string;
+  price: number;
+
+  constructor(data: IProductOptionOtherPrice) {
+    this.currencyCode = data.currencyCode;
+    this.price = data.price;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductOptionSelectValue implements IProductOptionSelectValue {
+  id: string;
+  order: number;
+  value: string;
+  price: number | null;
+  otherPrices: IkasProductOptionOtherPrice[] | null;
+  thumbnailImageId: string | null;
+  colorCode: string | null;
+  thumbnailImage: IkasImage | null;
+
+  constructor(data: Partial<IProductOptionSelectValue> = {}) {
+    this.id = data.id || "";
+    this.order = data.order || 0;
+    this.value = data.value || "";
+    this.price = data.price || null;
+    this.otherPrices = data.otherPrices || null;
+    this.thumbnailImageId = data.thumbnailImageId || null;
+    this.colorCode = data.colorCode || null;
+    this.thumbnailImage = data.thumbnailImage
+      ? new IkasImage(data.thumbnailImage)
+      : null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductOptionSelectSettings
+  implements IProductOptionSelectSettings
+{
+  type: IkasProductOptionSelectType;
+  minSelect: number | null;
+  maxSelect: number | null;
+  values: IkasProductOptionSelectValue[];
+
+  constructor(data: Partial<IProductOptionSelectSettings> = {}) {
+    this.type = data.type || IkasProductOptionSelectType.BOX;
+    this.minSelect =
+      data.minSelect !== null && data.minSelect !== undefined
+        ? data.minSelect
+        : null;
+    this.maxSelect =
+      data.maxSelect !== null && data.maxSelect !== undefined
+        ? data.maxSelect
+        : null;
+    this.values = _sortBy(
+      data.values?.map((o) => new IkasProductOptionSelectValue(o)) || [],
+      "order"
+    );
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductOptionDateSettings
+  implements IProductOptionDateSettings
+{
+  min: Date | null;
+  max: Date | null;
+  minRelativeNextDate: number | null;
+  maxRelativeNextDate: number | null;
+
+  constructor(data: Partial<IProductOptionDateSettings>) {
+    this.min = data.min || null;
+    this.max = data.max || null;
+    this.minRelativeNextDate =
+      data.minRelativeNextDate !== undefined ? data.minRelativeNextDate : null;
+    this.maxRelativeNextDate =
+      data.maxRelativeNextDate !== undefined ? data.maxRelativeNextDate : null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductOptionTextSettings
+  implements IProductOptionTextSettings
+{
+  min: number | null;
+  max: number | null;
+
+  constructor(data: Partial<IProductOptionTextSettings> = {}) {
+    this.min = data.min !== null && data.min !== undefined ? data.min : null;
+    this.max = data.max !== null && data.max !== undefined ? data.max : null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductOptionFileSettings {
+  allowedExtensions: string[] | null;
+  minQuantity: number | null;
+  maxQuantity: number | null;
+
+  constructor(data: Partial<IProductOptionFileSettings>) {
+    this.allowedExtensions = data.allowedExtensions || null;
+    this.minQuantity =
+      data.minQuantity !== null && data.minQuantity !== undefined
+        ? data.minQuantity
+        : null;
+    this.maxQuantity =
+      data.maxQuantity !== null && data.maxQuantity !== undefined
+        ? data.maxQuantity
+        : null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasProductOption implements IProductOption {
+  id: string;
+  productOptionSetId: string;
+  name: string;
+  order: number;
+  type: IkasProductOptionType;
+  selectSettings: IkasProductOptionSelectSettings | null;
+  textSettings: IkasProductOptionTextSettings | null;
+  fileSettings: IkasProductOptionFileSettings | null;
+  dateSettings: IkasProductOptionDateSettings | null;
+  price: number | null;
+  otherPrices: IkasProductOptionOtherPrice[] | null;
+  isOptional: boolean;
+  optionalText: string | null;
+  requiredOptionId: string | null;
+  requiredOptionValueIds: string[] | null;
+
+  private _values: string[] = [];
+  private _childOptions: IkasProductOption[] = [];
+
+  constructor(data: Partial<IProductOption>) {
+    this.id = data.id || "";
+    this.productOptionSetId = data.productOptionSetId || "";
+    this.name = data.name || "";
+    this.order = data.order || 0;
+    this.type = data.type || IkasProductOptionType.CHOICE;
+    this.selectSettings = data.selectSettings
+      ? new IkasProductOptionSelectSettings(data.selectSettings || {})
+      : null;
+    this.textSettings = data.textSettings
+      ? new IkasProductOptionTextSettings(data.textSettings || {})
+      : null;
+
+    this.fileSettings = data.fileSettings
+      ? new IkasProductOptionFileSettings(data.fileSettings || {})
+      : null;
+    this.dateSettings = data.dateSettings
+      ? new IkasProductOptionDateSettings(data.dateSettings || {})
+      : null;
+    this.price = data.price || null;
+    this.otherPrices = data.otherPrices || null;
+    this.isOptional = data.isOptional || false;
+    this.optionalText = data.optionalText || null;
+    this.requiredOptionId = data.requiredOptionId || null;
+    this.requiredOptionValueIds = data.requiredOptionValueIds || null;
+
+    this.values = data.values || [];
+    //@ts-ignore
+    this.childOptions = data.childOptions || [];
+
+    makeAutoObservable(this);
+  }
+
+  get displayedChildOptions() {
+    return IkasProductOptionFunctions.getDisplayedChildOptions(this).map(
+      (o) => new IkasProductOption(o)
+    );
+  }
+
+  productOptionFileUpload = async (files: File[]) => {
+    if (files.length === 0) return [];
+    if (
+      this.fileSettings &&
+      this.fileSettings.maxQuantity &&
+      this.fileSettings.maxQuantity < files.length
+    )
+      return [];
+
+    let fileIds = await Promise.all(
+      files.map((file) => uploadProductOptionFile(file, this))
+    );
+    fileIds = fileIds.filter((id) => id !== null);
+    return fileIds;
+  };
+
+  get hasValidValues() {
+    return IkasProductOptionFunctions.hasValidValues(this);
+  }
+
+  get values() {
+    return this._values;
+  }
+
+  set values(values: string[]) {
+    this._values = values;
+    if (!values.length) {
+      this.childOptions.forEach((co) => (co.values = []));
+    }
+  }
+
+  get childOptions() {
+    return this._childOptions;
+  }
+
+  set childOptions(options: IkasProductOption[]) {
+    this._childOptions = options;
+  }
+
+  initValues = () => {
+    if (!this.isOptional) {
+      this.values = [];
+      if (this.childOptions) {
+        this.childOptions.forEach((co) => co.initValues());
+      }
+    }
+  };
+}
+
+export { IkasProductOptionSelectType, IkasProductOptionType };

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

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

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

@@ -0,0 +1,104 @@
+import { IkasProductPrice } from "./price";
+import { IkasVariantValue } from "../../variant-type/variant-value";
+import { IkasProductAttributeValue } from "../attribute-value";
+import { IkasProductCampaign } from "../campaign";
+import { IkasProductImage } from "../image";
+import { IkasProductVariant as IProductVariant } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { IkasProductVariantFunctions } from "@ikas/storefront-model-functions";
+import { IkasStorefrontConfig } from "@ikas/storefront-config";
+import {
+  listProductBackInStockRemind,
+  saveProductBackInStockRemind,
+} from "@ikas/storefront-api";
+
+export class IkasProductVariant implements IProductVariant {
+  id: string;
+  sku: string | null;
+  barcodeList: string[] | null;
+  variantValues: IkasVariantValue[];
+  attributes: IkasProductAttributeValue[];
+  price: IkasProductPrice;
+  stock: number;
+  isActive: boolean;
+  productId: string;
+  sellIfOutOfStock: boolean;
+  images: IkasProductImage[] | null;
+  campaigns?: IkasProductCampaign[];
+  private _backInStockReminderSaved = false;
+
+  constructor(data: Partial<IProductVariant> = {}) {
+    this.id = data.id || Date.now() + "";
+    this.productId = data.productId || "";
+    this.sku = data.sku || null;
+    this.barcodeList = data.barcodeList || [];
+    this.variantValues = data.variantValues
+      ? data.variantValues.map((vv) => new IkasVariantValue(vv))
+      : [];
+    this.images = data.images
+      ? data.images.map((i) => new IkasProductImage(i))
+      : [];
+    this.attributes = data.attributes
+      ? data.attributes.map((a) => new IkasProductAttributeValue(a))
+      : [];
+    this.price = data.price
+      ? new IkasProductPrice(data.price)
+      : new IkasProductPrice();
+    this.stock = data.stock || 0;
+    this.isActive = data.isActive !== undefined ? data.isActive : true;
+    this.campaigns = data.campaigns || [];
+    this.sellIfOutOfStock = data.sellIfOutOfStock || false;
+
+    makeAutoObservable(this);
+  }
+
+  get mainImage() {
+    const _image = IkasProductVariantFunctions.getMainImage(this);
+    return _image ? new IkasProductImage(_image) : undefined;
+  }
+
+  get hasStock() {
+    return IkasProductVariantFunctions.hasStock(this);
+  }
+
+  get isBackInStockEnabled() {
+    return IkasStorefrontConfig.isBackInStockEnabled();
+  }
+
+  get isBackInStockCustomerLoginRequired() {
+    return IkasStorefrontConfig.isCustomerLoginRequiredForBackInStock();
+  }
+
+  get isBackInStockReminderSaved() {
+    return this._backInStockReminderSaved;
+  }
+
+  async saveBackInStockReminder(email: string) {
+    const listResponse = await listProductBackInStockRemind({
+      email: { eq: email },
+      productId: { eq: this.productId },
+      variantId: { eq: this.id },
+    });
+
+    if (listResponse && listResponse.data?.length) {
+      this._backInStockReminderSaved = true;
+      return false;
+    } else {
+      const saveResponse = await saveProductBackInStockRemind({
+        input: {
+          email,
+          productId: this.productId,
+          variantId: this.id,
+        },
+      });
+
+      if (saveResponse.isSuccess) {
+        this._backInStockReminderSaved = true;
+        return true;
+      } else {
+        this._backInStockReminderSaved = false;
+        return false;
+      }
+    }
+  }
+}

package/src/models/data/product/variant/price/index.ts

@@ -0,0 +1,58 @@
+import { IkasProductPriceFunctions } from "@ikas/storefront-model-functions";
+import { IkasProductPrice as IProductPrice } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+import { getCurrencySymbol, formatMoney } from "../../../../../utils/currency";
+
+export class IkasProductPrice implements IProductPrice {
+  buyPrice: number | null = null;
+  currency: string | null = null;
+  discountPrice: number | null = null;
+  priceListId: string | null = null;
+  sellPrice: number;
+
+  constructor(data?: IProductPrice) {
+    this.buyPrice = data?.buyPrice ?? null;
+    this.currency = data?.currency ?? null;
+    this.discountPrice = data?.discountPrice ?? null;
+    this.priceListId = data?.priceListId ?? null;
+    this.sellPrice = data?.sellPrice ?? 0;
+
+    makeAutoObservable(this);
+  }
+
+  get currencySymbol() {
+    return getCurrencySymbol(this.currency || "");
+  }
+
+  get finalPrice() {
+    return IkasProductPriceFunctions.getFinalPrice(this);
+  }
+
+  get formattedFinalPrice() {
+    return formatMoney(this.finalPrice, this.currencySymbol);
+  }
+
+  get formattedBuyPrice() {
+    return formatMoney(this.buyPrice || 0, this.currencySymbol);
+  }
+
+  get formattedDiscountPrice() {
+    return formatMoney(this.discountPrice || 0, this.currencySymbol);
+  }
+
+  get formattedSellPrice() {
+    return formatMoney(this.sellPrice || 0, this.currencySymbol);
+  }
+
+  get hasDiscount() {
+    return IkasProductPriceFunctions.hasDiscount(this);
+  }
+
+  get discountAmount() {
+    return IkasProductPriceFunctions.getDiscountAmount(this);
+  }
+
+  get discountPercentage() {
+    return IkasProductPriceFunctions.getDiscountPercentage(this);
+  }
+}

package/src/models/data/product/variant-type/index.ts

@@ -0,0 +1,17 @@
+import { IkasVariantType } from "../../variant-type";
+import { IkasProductVariantType as IProductVariantType } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasProductVariantType implements IProductVariantType {
+  variantType: IkasVariantType;
+  variantValueIds: string[];
+
+  constructor(data: Partial<IkasProductVariantType>) {
+    this.variantType = data.variantType
+      ? new IkasVariantType(data.variantType)
+      : new IkasVariantType();
+    this.variantValueIds = data.variantValueIds || [];
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/product/variant-type/init.ts

@@ -0,0 +1,15 @@
+import { IkasProductVariantType } from ".";
+import { IkasVariantValue } from "../../variant-type/variant-value";
+
+export function initIkasProductVariantType(
+  variantType: IkasProductVariantType
+) {
+  const orderedVariantValues: IkasVariantValue[] = [];
+  variantType.variantValueIds.forEach((vvId) => {
+    const variantValue = variantType.variantType.values.find(
+      (vv) => vv.id === vvId
+    );
+    if (variantValue) orderedVariantValues.push(variantValue);
+  });
+  variantType.variantType.values = orderedVariantValues;
+}

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

@@ -0,0 +1,155 @@
+import { makeAutoObservable } from "mobx";
+import { IkasProduct } from "../product";
+import {
+  IkasRaffleDateRangeField as IRaffleDateRangeField,
+  IkasRaffle as IRaffle,
+  IkasRaffleMetaData as IRaffleMetaData,
+  IkasRaffleParticipant as IRaffleParticipant,
+  IkasRaffleAppliedProduct as IRaffleAppliedProduct,
+  IkasRaffleVerificationType,
+  IkasRaffleMetadataTargetType,
+} from "@ikas/storefront-models";
+import { IkasRaffleFunctions } from "@ikas/storefront-model-functions";
+
+export { IkasRaffleVerificationType, IkasRaffleMetadataTargetType };
+
+export class IkasRaffleDateRangeField implements IRaffleDateRangeField {
+  start: number | null;
+  end: number | null;
+
+  constructor(data: Partial<IkasRaffleDateRangeField>) {
+    this.start = data.start || null;
+    this.end = data.end || null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasRaffle implements IRaffle {
+  id: string;
+  createdAt: number;
+  updatedAt: number;
+  deleted: boolean | null;
+  dateRange: IkasRaffleDateRangeField | null;
+  metadata: IkasRaffleMetaData | null;
+  name: string;
+  participantCount?: number | null;
+  requiredCustomerAccount: boolean;
+  status: boolean;
+  variants: IkasRaffleAppliedProduct[] | null;
+  products: IkasProduct[];
+  verificationType: IkasRaffleVerificationType;
+  isCustomerWinner: boolean | null;
+
+  constructor(data: Partial<IkasRaffle> = {}) {
+    this.id = data.id || Date.now() + "";
+    this.createdAt = data.createdAt || Date.now();
+    this.updatedAt = data.updatedAt || Date.now();
+    this.deleted = data.deleted || null;
+    this.name = data.name || "";
+    this.participantCount = data.participantCount || 0;
+    this.requiredCustomerAccount = data.requiredCustomerAccount || false;
+    this.status = data.status || false;
+    this.verificationType =
+      data.verificationType || IkasRaffleVerificationType.EMAIL;
+    this.isCustomerWinner = data.isCustomerWinner || null;
+
+    this.dateRange = data.dateRange
+      ? new IkasRaffleDateRangeField(data.dateRange)
+      : null;
+    this.metadata = data.metadata
+      ? new IkasRaffleMetaData(data.metadata)
+      : null;
+    this.variants =
+      data.variants?.map((v) => new IkasRaffleAppliedProduct(v)) || [];
+    this.products = data.products?.map((p) => new IkasProduct(p)) || [];
+  }
+
+  get isRaffleAvailable() {
+    return IkasRaffleFunctions.isRaffleAvailable(this);
+  }
+}
+
+export class IkasRaffleMetaData implements IRaffleMetaData {
+  id: string;
+  createdAt: number;
+  updatedAt: number;
+  deleted: boolean | null;
+  description: string | null;
+  pageTitle: string | null;
+  slug: string;
+  targetId: string | null;
+  targetType: IkasRaffleMetadataTargetType | null;
+  canonicals: string[] | null = null;
+  disableIndex: boolean | null = null;
+
+  constructor(data: Partial<IkasRaffleMetaData>) {
+    this.id = data.id || Date.now() + "";
+    this.createdAt = data.createdAt || Date.now();
+    this.updatedAt = data.updatedAt || Date.now();
+    this.deleted = data.deleted || null;
+    this.description = data.description || "";
+    this.pageTitle = data.pageTitle || "";
+    this.slug = data.slug || "";
+    this.targetId = data.targetId || "";
+    this.targetType = data.targetType || IkasRaffleMetadataTargetType.RAFFLE;
+    this.canonicals = data.canonicals ?? null;
+    this.disableIndex = data.disableIndex ?? null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasRaffleParticipant implements IRaffleParticipant {
+  id: string | null = null;
+  createdAt: number | null = null;
+  updatedAt: number | null = null;
+  deleted: boolean | null = null;
+  customerId: string | null = null;
+  raffleId: string;
+  firstName: string;
+  lastName: string;
+  fullName: string | null = null;
+  email: string;
+  applicationDate: number;
+  phone: string | null = null;
+  isWinner: boolean | null = null;
+
+  extraData: Record<string, any> | null = null;
+  appliedProduct: IkasRaffleAppliedProduct;
+
+  constructor(data: Partial<IkasRaffleParticipant>) {
+    this.id = data.id || null;
+    this.createdAt = data.createdAt || Date.now();
+    this.updatedAt = data.updatedAt || Date.now();
+    this.deleted = data.deleted || false;
+    this.customerId = data.customerId || null;
+    this.raffleId = data.raffleId || "";
+    this.firstName = data.firstName || "";
+    this.lastName = data.lastName || "";
+    this.fullName = data.fullName || null;
+    this.email = data.email || "";
+    this.applicationDate = data.applicationDate || 0;
+    this.phone = data.phone || null;
+    this.isWinner = data.isWinner || null;
+
+    this.extraData = data.extraData || {};
+    this.appliedProduct = new IkasRaffleAppliedProduct(
+      data.appliedProduct || {}
+    );
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasRaffleAppliedProduct implements IRaffleAppliedProduct {
+  productId: string;
+  variantId: string;
+
+  constructor(data: Partial<IkasRaffleAppliedProduct>) {
+    this.productId = data.productId || "";
+    this.variantId = data.variantId || "";
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/sales-channel/index.ts

@@ -0,0 +1,56 @@
+import {
+  IkasSalesChannel as ISalesChannel,
+  IkasSalesChannelStockLocation as ISalesChannelStockLocation,
+  IkasSalesChannelPaymentGateway as ISalesChannelPaymentGateway,
+} from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasSalesChannel implements ISalesChannel {
+  id: string;
+  name: string;
+  priceListId: string | null = null;
+  stockLocations: IkasSalesChannelStockLocation[] | null = null;
+  paymentGateways: IkasSalesChannelPaymentGateway[] | null = null;
+
+  constructor(data: ISalesChannel) {
+    this.id = data.id;
+    this.name = data.name;
+    this.priceListId = data.priceListId || null;
+    this.stockLocations =
+      data.stockLocations?.map((s) => new IkasSalesChannelStockLocation(s)) ||
+      null;
+    this.paymentGateways =
+      data.paymentGateways?.map((p) => new IkasSalesChannelPaymentGateway(p)) ||
+      null;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasSalesChannelStockLocation
+  implements ISalesChannelStockLocation
+{
+  id: string;
+  order: number;
+
+  constructor(data: ISalesChannelStockLocation) {
+    this.id = data.id;
+    this.order = data.order;
+
+    makeAutoObservable(this);
+  }
+}
+
+export class IkasSalesChannelPaymentGateway
+  implements ISalesChannelPaymentGateway
+{
+  id: string;
+  order: number;
+
+  constructor(data: ISalesChannelStockLocation) {
+    this.id = data.id;
+    this.order = data.order;
+
+    makeAutoObservable(this);
+  }
+}

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

@@ -0,0 +1,18 @@
+import { IkasBaseModel } from "../base";
+import { IkasState as IState } from "@ikas/storefront-models";
+import { makeAutoObservable } from "mobx";
+
+export class IkasState extends IkasBaseModel implements IState {
+  countryId: string;
+  name: string;
+  stateCode: string | null;
+
+  constructor(data: IState) {
+    super(data);
+    this.countryId = data.countryId;
+    this.name = data.name;
+    this.stateCode = data.stateCode;
+
+    makeAutoObservable(this);
+  }
+}

package/src/models/data/stock-location/address/city/index.ts

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