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

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,22 @@
+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 { IkasProductVariantUnit } from "./unit";
+
+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[];
+  unit: IkasProductVariantUnit | null;
+};

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,9 @@
+export type IkasProductPrice = {
+  buyPrice: number | null;
+  currency: string | null;
+  currencySymbol: string | null;
+  discountPrice: number | null;
+  priceListId: string | null;
+  sellPrice: number;
+  unitPrice: number | null;
+};

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

@@ -0,0 +1,6 @@
+import { IkasProductUnitType } from "../../../order/line-item/base-unit";
+
+export type IkasProductVariantUnit = {
+  amount: number | null;
+  type: IkasProductUnitType;
+};

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

@@ -0,0 +1,7 @@
+import { IkasVariantType } from "../../variant-type";
+
+export type IkasProductVariantType = {
+  order: number;
+  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/product-option-file/index.ts

@@ -0,0 +1,5 @@
+export type IkasProductOptionFileUrl = {
+  fields: any;
+  optionUrl: string;
+  url: string;
+};

package/src/models/raffle/index.ts

@@ -0,0 +1,77 @@
+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;
+  requiredCustomerAccount: boolean;
+  status: boolean;
+  variants: IkasRaffleAppliedProduct[] | null;
+  products: IkasProduct[];
+  verificationType: IkasRaffleVerificationType;
+};
+
+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;
+  isDeliveredCargo: boolean | null;
+
+  raffle: IkasRaffle | null;
+  status: IkasRaffleParticipantStatus | null;
+  extraData: Record<string, any> | null;
+  appliedProduct: IkasRaffleAppliedProduct;
+};
+
+export type IkasRaffleAppliedProduct = {
+  productId: string;
+  variantId: string;
+};
+
+export enum IkasRaffleParticipantStatus {
+  COMPLETED = "COMPLETED",
+  IN_PROGRESS = "IN_PROGRESS",
+  LOSER = "LOSER",
+  WINNER = "WINNER",
+}

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;
+};

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

@@ -0,0 +1,14 @@
+import { IkasStockLocationAddressCity } from "./city";
+import { IkasStockLocationAddressCountry } from "./country";
+import { IkasStockLocationAddressDistrict } from "./district";
+import { IkasStockLocationAddressState } from "./state";
+
+export type IkasStockLocationAddress = {
+  address: string | null;
+  city: IkasStockLocationAddressCity | null;
+  country: IkasStockLocationAddressCountry | null;
+  district: IkasStockLocationAddressDistrict | null;
+  phone: string | null;
+  postalCode: string | null;
+  state: IkasStockLocationAddressState | null;
+};

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

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

package/src/models/stock-location/available/index.ts

@@ -0,0 +1,9 @@
+import { IkasStockLocationType } from "..";
+import { IkasStockLocationAddress } from "../address";
+
+export type IkasAvailableStockLocation = {
+  address: IkasStockLocationAddress | null;
+  id: string;
+  name: string;
+  type: IkasStockLocationType | null;
+};

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

@@ -0,0 +1,26 @@
+import { IkasStockLocationAddress } from "./address";
+
+export type IkasStockLocation = {
+  address: IkasStockLocationAddress | null;
+  deliveryTime: IkasStockLocationDeliveryTime | null;
+  description: string | null;
+  isRemindOutOfStockEnabled: boolean | null;
+  name: string;
+  outOfStockMailList: string[] | null;
+  type: IkasStockLocationType | null;
+  id: string;
+};
+
+export enum IkasStockLocationDeliveryTime {
+  TWO_IN_FOUR_DAYS = "TWO_IN_FOUR_DAYS",
+  WITHIN_FOUR_HOURS = "WITHIN_FOUR_HOURS",
+  WITHIN_ONE_HOUR = "WITHIN_ONE_HOUR",
+  WITHIN_PLUS_FIVE_DAYS = "WITHIN_PLUS_FIVE_DAYS",
+  WITHIN_TWENTY_FOUR_HOURS = "WITHIN_TWENTY_FOUR_HOURS",
+  WITHIN_TWO_HOURS = "WITHIN_TWO_HOURS",
+}
+
+export enum IkasStockLocationType {
+  PHYSICAL = "PHYSICAL",
+  VIRTUAL = "VIRTUAL",
+}

package/src/models/storefront/domain/index.ts

@@ -0,0 +1,7 @@
+export type IkasStorefrontDomain = {
+  id: string;
+  merchantDomainId: string;
+  name: string;
+  redirectDomainName: string | null;
+  isDefault: boolean | null;
+};

package/src/models/storefront/index.ts

@@ -0,0 +1,31 @@
+import { IkasStorefrontLocalization } from "./localization";
+import { IkasStorefrontDomain } from "./domain";
+import { IkasStorefrontRouting } from "./routing";
+import { IkasStorefrontTheme } from "./theme";
+
+export enum IkasStorefrontStatus {
+  WAITING = "WAITING",
+  READY = "READY",
+}
+
+export type IkasStorefront = {
+  id: string;
+  name: string;
+  status: IkasStorefrontStatus;
+
+  mainStorefrontThemeId: string | null;
+  pickUpStockLocationIds: string[] | null;
+  emailSettingsId: string | null;
+  salesChannelId: string | null;
+  fbpId: string | null;
+  gtmId: string | null;
+  analytics4Id: string | null;
+  universalAnalyticsId: string | null;
+  tiktokPixelId: string | null;
+  token: string | null;
+
+  localizations: IkasStorefrontLocalization[];
+  routings: IkasStorefrontRouting[];
+  domains: IkasStorefrontDomain[];
+  themes: IkasStorefrontTheme[];
+};

package/src/models/storefront/localization/index.tsx

@@ -0,0 +1,6 @@
+export type IkasStorefrontLocalization = {
+  id: string;
+  isDefault: boolean;
+  locale: string;
+  name: string;
+};

package/src/models/storefront/routing/dynamic-currency/index.ts

@@ -0,0 +1,4 @@
+export type IkasStorefrontDynamicCurrencySettings = {
+  roundingFormat: string | null;
+  targetCurrencyCode: string;
+};

package/src/models/storefront/routing/index.tsx

@@ -0,0 +1,13 @@
+import { IkasStorefrontDynamicCurrencySettings } from "./dynamic-currency";
+
+export type IkasStorefrontRouting = {
+  id: string;
+  countryCodes: string[] | null;
+  domain: string | null;
+  locale: string;
+  path: string | null;
+  priceListId: string | null;
+  dynamicCurrencySettings: IkasStorefrontDynamicCurrencySettings | null;
+  currencyCode: string | null;
+  currencySymbol: string | null;
+};

package/src/models/storefront/theme/index.tsx

@@ -0,0 +1,13 @@
+export enum IkasStorefrontThemeStatus {
+  WAITING = "WAITING",
+  READY = "READY",
+}
+
+export type IkasStorefrontTheme = {
+  id: string;
+  isMainTheme: boolean;
+  name: string;
+  status: IkasStorefrontThemeStatus;
+  themeId: string;
+  themeVersionId: string;
+};

package/src/models/storefront/theme-localization/index.tsx

@@ -0,0 +1,13 @@
+import { IkasThemeJson } from "../../theme-json";
+
+export type IkasStorefrontThemeLocalization = {
+  id: string;
+  locale: string;
+  storefrontId: string;
+  storefrontThemeId: string;
+  themeJson: IkasThemeJson;
+
+  privacyPolicy: string | null;
+  returnPolicy: string | null;
+  termsOfService: string | null;
+};

package/src/models/theme-json/component/index.ts

@@ -0,0 +1,19 @@
+import { IkasThemeJsonComponentProp } from "./prop";
+
+export type IkasThemeJsonComponent = {
+  id: string;
+  dir: string;
+  displayName: string;
+  description: string;
+  props: IkasThemeJsonComponentProp[];
+  isHeader: boolean;
+  isFooter: boolean;
+  translations: {
+    [locale: string]: IkasThemeJsonComponentTranslation;
+  };
+};
+
+export type IkasThemeJsonComponentTranslation = {
+  displayName: string | null;
+  description: string | null;
+};

package/src/models/theme-json/component/prop/index.ts

@@ -0,0 +1,65 @@
+import { IkasProductAttributeType } from "../../../..";
+
+export type IkasThemeJsonComponentProp = {
+  id: string;
+  name: string;
+  displayName: string;
+  description: string;
+  type: IkasThemeJsonComponentPropType;
+  isRequired: boolean;
+  customDataId?: string | null;
+  requiredPropId?: string;
+  requiredEnumOptionId?: string;
+  requiredEnumOptionValue?: string;
+  attributeTypes?: IkasProductAttributeType[] | null;
+  sliderData: IkasThemeJsonSliderData;
+  translations: {
+    [locale: string]: IkasPropTranslation;
+  };
+};
+
+export type IkasThemeJsonSliderData = {
+  min?: number;
+  max?: number;
+  interval?: number;
+  unit?: string;
+};
+
+export enum IkasThemeJsonComponentPropType {
+  TEXT = "TEXT",
+  RICH_TEXT = "RICH_TEXT",
+  BOOLEAN = "BOOLEAN",
+  IMAGE = "IMAGE",
+  IMAGE_LIST = "IMAGE_LIST",
+  LINK = "LINK",
+  LIST_OF_LINK = "LIST_OF_LINK",
+  PRODUCT_DETAIL = "PRODUCT_DETAIL",
+  PRODUCT_LIST = "PRODUCT_LIST",
+  PRODUCT_ATTRIBUTE = "PRODUCT_ATTRIBUTE",
+  PRODUCT_ATTRIBUTE_LIST = "PRODUCT_ATTRIBUTE_LIST",
+  BRAND = "BRAND",
+  BRAND_LIST = "BRAND_LIST",
+  CATEGORY = "CATEGORY",
+  CATEGORY_LIST = "CATEGORY_LIST",
+  COLOR = "COLOR",
+  CUSTOM = "CUSTOM",
+  COMPONENT = "COMPONENT",
+  COMPONENT_LIST = "COMPONENT_LIST",
+  BLOG = "BLOG",
+  BLOG_LIST = "BLOG_LIST",
+  BLOG_CATEGORY = "BLOG_CATEGORY",
+  BLOG_CATEGORY_LIST = "BLOG_CATEGORY_LIST",
+  RAFFLE = "RAFFLE",
+  RAFFLE_LIST = "RAFFLE_LIST",
+  SLIDER = "SLIDER",
+
+  OBJECT = "OBJECT",
+  STATIC_LIST = "STATIC_LIST",
+  DYNAMIC_LIST = "DYNAMIC_LIST",
+  ENUM = "ENUM",
+}
+
+export type IkasPropTranslation = {
+  displayName: string | null;
+  description: string | null;
+};