@ikas/storefront-models 4.0.0-alpha.10

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,96 @@
+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;
+};
+
+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",
+}
+
+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,43 @@
+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";
+
+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;
+};
+
+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);
+}

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

@@ -0,0 +1,25 @@
+import { IkasProductOption } from "./option";
+
+export type IkasProductOptionSelectValueTranslations = {
+  id: string;
+  value: string | null;
+};
+
+export type IkasProductOptionTranslations = {
+  id: string;
+  name: string | null;
+  optionalText: string | null;
+  values: IkasProductOptionSelectValueTranslations[] | null;
+};
+
+export type IkasProductOptionSetTranslations = {
+  locale: string;
+  options: IkasProductOptionTranslations[] | null;
+};
+
+export type IkasProductOptionSet = {
+  id: string;
+  name: string;
+  options: IkasProductOption[];
+  translations?: IkasProductOptionSetTranslations[] | null;
+};

package/src/models/product/option-set/init.ts

@@ -0,0 +1,77 @@
+import { IkasProductOptionSet, IkasProductOptionSetTranslations } from ".";
+import { IkasProductOption, IkasProductOptionType } from "./option";
+import { initIkasProductOption } from "./option/init";
+
+export function initIkasProductOptionSet(
+  optionSet: IkasProductOptionSet,
+  locale: string | null
+) {
+  optionSet.options.forEach((option) => {
+    option.productOptionSetId = optionSet.id;
+    initIkasProductOption(option);
+  });
+
+  if (optionSet.translations && locale) {
+    setTranslations(optionSet, optionSet.translations, locale);
+    delete optionSet.translations;
+  }
+  setChildOptions(optionSet);
+  initOptionValues(optionSet);
+}
+
+function setTranslations(
+  optionSet: IkasProductOptionSet,
+  translations: IkasProductOptionSetTranslations[],
+  locale: string
+) {
+  if (translations && translations.some((t) => t.locale === locale)) {
+    const localeTranslations = translations.find((t) => t.locale === locale);
+
+    localeTranslations?.options?.forEach((translatedOption) => {
+      const option = optionSet.options.find(
+        (o) => o.id === translatedOption.id
+      );
+
+      if (option) {
+        option.name = translatedOption.name || option.name;
+        option.optionalText =
+          translatedOption.optionalText || option.optionalText;
+
+        if (option.type === IkasProductOptionType.CHOICE) {
+          translatedOption.values?.forEach((translatedValue) => {
+            const selectValue = option.selectSettings?.values.find(
+              (sv) => sv.id === translatedValue.id
+            );
+            if (selectValue) {
+              selectValue.value = translatedValue.value || selectValue.value;
+            }
+          });
+        }
+      }
+    });
+  }
+}
+
+export function setChildOptions(optionSet: IkasProductOptionSet) {
+  optionSet.options.forEach((option) => {
+    const childOptions = optionSet.options.filter(
+      (o) => o.requiredOptionId === option.id
+    );
+    if (childOptions.length) {
+      option.childOptions = childOptions;
+    }
+  });
+}
+
+export function initOptionValues(optionSet: IkasProductOptionSet) {
+  optionSet.options.forEach((o) => initValues(o));
+}
+
+export function initValues(option: IkasProductOption) {
+  if (!option.isOptional) {
+    option.values = [];
+    if (option.childOptions) {
+      option.childOptions.forEach((co) => initValues(co));
+    }
+  }
+}

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

@@ -0,0 +1,81 @@
+import { IkasImage } from "../../../image";
+
+export enum IkasProductOptionSelectType {
+  BOX = "BOX",
+  SELECT = "SELECT",
+  SWATCH = "SWATCH",
+}
+
+export enum IkasProductOptionType {
+  CHECKBOX = "CHECKBOX",
+  CHOICE = "CHOICE",
+  COLOR_PICKER = "COLOR_PICKER",
+  DATE_PICKER = "DATE_PICKER",
+  FILE = "FILE",
+  IMAGE = "IMAGE",
+  TEXT = "TEXT",
+  TEXT_AREA = "TEXT_AREA",
+}
+
+export type IkasProductOptionOtherPrice = {
+  currencyCode: string;
+  price: number;
+};
+
+export type IkasProductOptionSelectValue = {
+  id: string;
+  order: number;
+  value: string;
+  price: number | null;
+  otherPrices: IkasProductOptionOtherPrice[] | null;
+  thumbnailImageId: string | null;
+  colorCode: string | null;
+  thumbnailImage: IkasImage | null;
+};
+
+export type IkasProductOptionSelectSettings = {
+  type: IkasProductOptionSelectType;
+  minSelect: number | null;
+  maxSelect: number | null;
+  values: IkasProductOptionSelectValue[];
+};
+
+export type IkasProductOptionDateSettings = {
+  min: Date | null;
+  max: Date | null;
+  minRelativeNextDate: number | null;
+  maxRelativeNextDate: number | null;
+};
+
+export type IkasProductOptionTextSettings = {
+  min: number | null;
+  max: number | null;
+};
+
+export type IkasProductOptionFileSettings = {
+  allowedExtensions: string[] | null;
+  minQuantity: number | null;
+  maxQuantity: number | null;
+};
+
+export type IkasProductOption = {
+  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;
+
+  // Extra
+  values: string[];
+  childOptions: IkasProductOption[];
+};

package/src/models/product/option-set/option/init.ts

@@ -0,0 +1,13 @@
+import { IkasProductOption, IkasProductOptionSelectSettings } from ".";
+import _sortBy from "lodash/sortBy";
+
+export function initIkasProductOption(option: IkasProductOption) {
+  if (option.selectSettings)
+    initProductOptionSelectSettings(option.selectSettings);
+}
+
+function initProductOptionSelectSettings(
+  settings: IkasProductOptionSelectSettings
+) {
+  settings.values = _sortBy(settings.values || [], "order");
+}

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

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

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

@@ -0,0 +1,20 @@
+import { IkasProductPrice } from "./price";
+import { IkasVariantValue } from "../../variant-type/variant-value";
+import { IkasProductAttributeValue } from "../attribute-value";
+import { IkasProductCampaign } from "../campaign";
+import { IkasProductImage } from "../image";
+
+export type IkasProductVariant = {
+  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[];
+};

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

@@ -0,0 +1,10 @@
+import { initIkasProductImage } from "../image/init";
+import { initIkasProductAttributeValue } from "../attribute-value/init";
+import _sortBy from "lodash/sortBy";
+import { IkasProductVariant } from ".";
+
+export function initIkasProductVariant(variant: IkasProductVariant) {
+  variant.images?.forEach(initIkasProductImage);
+  variant.images = _sortBy(variant.images, "order");
+  variant.attributes.forEach(initIkasProductAttributeValue);
+}

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

@@ -0,0 +1,7 @@
+export type IkasProductPrice = {
+  buyPrice: number | null;
+  currency: string | null;
+  discountPrice: number | null;
+  priceListId: string | null;
+  sellPrice: number;
+};

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

@@ -0,0 +1,6 @@
+import { IkasVariantType } from "../../variant-type";
+
+export type IkasProductVariantType = {
+  variantType: IkasVariantType;
+  variantValueIds: string[];
+};

package/src/models/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/raffle/index.ts

@@ -0,0 +1,70 @@
+import { IkasProduct } from "../product";
+
+export type IkasRaffleDateRangeField = {
+  start: number | null;
+  end: number | null;
+};
+
+export enum IkasRaffleVerificationType {
+  EMAIL = "EMAIL",
+  MERSIS = "MERSIS",
+}
+
+export type IkasRaffle = {
+  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;
+};
+
+export enum IkasRaffleMetadataTargetType {
+  RAFFLE = "RAFFLE",
+}
+
+export type IkasRaffleMetaData = {
+  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;
+  disableIndex: boolean | null;
+};
+
+export type IkasRaffleParticipant = {
+  id: string | null;
+  createdAt: number | null;
+  updatedAt: number | null;
+  deleted: boolean | null;
+  customerId: string | null;
+  raffleId: string;
+  firstName: string;
+  lastName: string;
+  fullName: string | null;
+  email: string;
+  applicationDate: number;
+  phone: string | null;
+  isWinner: boolean | null;
+
+  extraData: Record<string, any> | null;
+  appliedProduct: IkasRaffleAppliedProduct;
+};
+
+export type IkasRaffleAppliedProduct = {
+  productId: string;
+  variantId: string;
+};

package/src/models/raffle/init.ts

@@ -0,0 +1,6 @@
+import { IkasRaffle } from ".";
+import { initIkasProduct } from "../product/init";
+
+export function initIkasRaffle(raffle: IkasRaffle, locale: string | null) {
+  raffle.products.map((p) => initIkasProduct(p, locale));
+}

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

@@ -0,0 +1,17 @@
+export type IkasSalesChannel = {
+  id: string;
+  name: string;
+  priceListId: string | null;
+  stockLocations: IkasSalesChannelStockLocation[] | null;
+  paymentGateways: IkasSalesChannelPaymentGateway[] | null;
+};
+
+export type IkasSalesChannelStockLocation = {
+  id: string;
+  order: number;
+};
+
+export type IkasSalesChannelPaymentGateway = {
+  id: string;
+  order: number;
+};

package/src/models/state/index.ts

@@ -0,0 +1,7 @@
+import { IkasBaseModel } from "../base";
+
+export type IkasState = {
+  countryId: string;
+  name: string;
+  stateCode: string | null;
+} & IkasBaseModel;

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

@@ -0,0 +1,5 @@
+export type IkasStockLocationAddressCity = {
+  code: string | null;
+  id: string | null;
+  name: string;
+};

package/src/models/stock-location/address/country/index.ts

@@ -0,0 +1,5 @@
+export type IkasStockLocationAddressCountry = {
+  code: string | null;
+  id: string | null;
+  name: string;
+};

package/src/models/stock-location/address/district/index.ts

@@ -0,0 +1,5 @@
+export type IkasStockLocationAddressDistrict = {
+  code: string | null;
+  id: string | null;
+  name: string | null;
+};