@ikas/storefront-models 4.0.0-alpha.9 → 4.0.0-beta.1

package/src/models/blog/category/init.ts

@@ -1,33 +0,0 @@
-import { IkasBlogCategory } from ".";
-import { createIkasBaseModel } from "../../base/init";
-
-/**
- * Initializes the given blog category.
- * @param blogCategory Blog category to initialize.
- */
-export function initIkasBlogCategory(blogCategory: IkasBlogCategory) {
-  blogCategory.image = blogCategory.imageId
-    ? { id: blogCategory.imageId, isVideo: false }
-    : undefined;
-}
-
-/**
- * Creates an empty blog category object.
- * @returns An initialized empty blog category object.
- */
-export function createIkasBlogCategory(): IkasBlogCategory {
-  const blogCategory: IkasBlogCategory = {
-    ...createIkasBaseModel(),
-    imageId: "",
-    name: "",
-    metadata: {
-      ...createIkasBaseModel(),
-      id: "",
-      slug: "",
-    },
-  };
-
-  initIkasBlogCategory(blogCategory);
-
-  return blogCategory;
-}

package/src/models/blog/index.ts

@@ -1,26 +0,0 @@
-import { IkasBaseModel } from "../base";
-import { IkasImage } from "../image";
-import { IkasBlogTag } from "./tag";
-import { IkasBlogContent } from "./content";
-import { IkasBlogMetaData } from "./meta-data";
-import { IkasBlogWriter } from "./writer";
-import { IkasBlogCategory } from "./category";
-
-export type IkasBlog = {
-  blogContent: IkasBlogContent;
-  categoryId: string;
-  imageId: string;
-  isPublished: boolean;
-  locale: string | null;
-  metadata: IkasBlogMetaData;
-  publishedAt: number | null;
-  shortDescription: string;
-  storefrontId: string;
-  tagIds: string[] | null;
-  tags: IkasBlogTag[] | null;
-  title: string;
-  writer: IkasBlogWriter;
-
-  image?: IkasImage | null;
-  category: IkasBlogCategory;
-} & IkasBaseModel;

package/src/models/blog/init.ts

@@ -1,7 +0,0 @@
-import { IkasBlog } from ".";
-import { initIkasBlogCategory } from "./category/init";
-
-export function initIkasBlog(blog: IkasBlog) {
-  initIkasBlogCategory(blog.category);
-  blog.image = blog.imageId ? { id: blog.imageId, isVideo: false } : undefined;
-}

package/src/models/blog/meta-data/index.ts

@@ -1,16 +0,0 @@
-import { IkasBaseModel } from "../../base";
-
-export type IkasBlogMetaData = {
-  canonicals?: string[] | null;
-  description?: string | null;
-  disableIndex?: boolean | null;
-  pageTitle?: string | null;
-  slug: string;
-  targetId?: string | null;
-  targetType?: IkasBlogMetaDataTargetType | null;
-} & IkasBaseModel;
-
-export enum IkasBlogMetaDataTargetType {
-  BLOG = "BLOG",
-  BLOG_CATEGORY = "BLOG_CATEGORY",
-}

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

@@ -1,5 +0,0 @@
-import { IkasBaseModel } from "../../base";
-
-export type IkasBlogTag = {
-  name: string;
-} & IkasBaseModel;

package/src/models/blog/writer/index.ts

@@ -1,4 +0,0 @@
-export type IkasBlogWriter = {
-  firstName: string;
-  lastName: string;
-};

package/src/models/brand/index.ts

@@ -1,26 +0,0 @@
-import { IkasImage } from "../image";
-import { IkasHTMLMetaData } from "../html-meta-data";
-import { IkasBaseModel } from "../base";
-import { IkasProductBrandTranslation } from "./translation";
-
-export type IkasBrand = {
-  description: string | null;
-  imageId: string | null;
-  name: string;
-  metaData: IkasHTMLMetaData | null;
-  orderType: IkasBrandOrderType | null;
-
-  image?: IkasImage | null;
-  translations?: IkasProductBrandTranslation[] | null;
-} & IkasBaseModel;
-
-export enum IkasBrandOrderType {
-  BEST_SELLER = "BEST_SELLER",
-  HIGHEST_DISCOUNT_RATIO = "HIGHEST_DISCOUNT_RATIO",
-  HIGHEST_PRICE = "HIGHEST_PRICE",
-  LOWEST_DISCOUNT_RATIO = "LOWEST_DISCOUNT_RATIO",
-  LOWEST_PRICE = "LOWEST_PRICE",
-  MANUALLY = "MANUALLY",
-  NEWEST = "NEWEST",
-  OLDEST = "OLDEST",
-}

package/src/models/brand/init.ts

@@ -1,27 +0,0 @@
-import { IkasProductBrandTranslation } from "./translation";
-import { initIkasHTMLMetaData } from "../html-meta-data/init";
-import { IkasBrand } from ".";
-
-export function initIkasBrand(brand: IkasBrand, locale: string | null) {
-  brand.image = brand.imageId ? { id: brand.imageId, isVideo: false } : null;
-  brand.metaData && initIkasHTMLMetaData(brand.metaData, locale);
-
-  if (brand.translations && locale) {
-    setTranslations(brand, brand.translations, locale);
-    delete brand.translations;
-  }
-}
-
-function setTranslations(
-  brand: IkasBrand,
-  translations: IkasProductBrandTranslation[],
-  locale: string
-) {
-  if (translations && translations.some((t) => t.locale === locale)) {
-    const localeTranslations = translations.find((t) => t.locale === locale);
-
-    if (localeTranslations?.name) brand.name = localeTranslations.name;
-    if (localeTranslations?.description)
-      brand.description = localeTranslations.description;
-  }
-}

package/src/models/brand/translation/index.ts

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

package/src/models/campaign-offer/index.ts

@@ -1,43 +0,0 @@
-import { IkasCampaignOfferProduct } from "./product";
-
-export type IkasCampaignOffer = {
-  availableSalesChannelIds: string[];
-  endDate: any | null;
-  followUpActionType: IkasCampaignOfferFollowUpActionType;
-  minimumRequiredCartAmount: number | null;
-  name: string;
-  offers: IkasCampaignOfferProduct[];
-  startDate: any | null;
-  targetPageTypes: IkasCampaignOfferTargetPageType[];
-  triggerSettings: IkasCampaignOfferTriggerSettings;
-  type: IkasCampaignOfferType;
-};
-
-export type IkasCampaignOfferTriggerSettings = {
-  filterType: IkasCampaignOfferTriggerFilterType;
-  valueList: string[];
-};
-
-export enum IkasCampaignOfferFollowUpActionType {
-  DO_NOTHING = "DO_NOTHING",
-  OPEN_CART = "OPEN_CART",
-  OPEN_CHECKOUT = "OPEN_CHECKOUT",
-}
-
-export enum IkasCampaignOfferTargetPageType {
-  CHECKOUT = "CHECKOUT",
-  POST_CHECKOUT = "POST_CHECKOUT",
-}
-
-export enum IkasCampaignOfferType {
-  CROSS_SELL = "CROSS_SELL",
-  UPSELL = "UPSELL",
-}
-
-export enum IkasCampaignOfferTriggerFilterType {
-  ALL_PRODUCTS = "ALL_PRODUCTS",
-  CATEGORY = "CATEGORY",
-  PRODUCT = "PRODUCT",
-  PRODUCT_TAG = "PRODUCT_TAG",
-  VARIANT = "VARIANT",
-}

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

@@ -1,27 +0,0 @@
-import { IkasAmountType } from "../../../models/order/adjustment";
-
-export type IkasCampaignOfferProduct = {
-  countdownMinutes: number | null;
-  description: string | null;
-  discountAmount: number | null;
-  discountType: IkasAmountType | null;
-  excludedVariantIdList: string[] | null;
-  id: string;
-  order: number;
-  productId: string;
-  showCriteria: IkasCampaignOfferProductShowCriteria | null;
-  skipOfferIfProductExistsInCart: boolean | null;
-  title: string;
-  translations: IkasCampaignOfferProductTranslation[] | null;
-};
-
-export type IkasCampaignOfferProductTranslation = {
-  description: string | null;
-  locale: string;
-  title: string;
-};
-
-export enum IkasCampaignOfferProductShowCriteria {
-  PREVIOUS_ACCEPTED = "PREVIOUS_ACCEPTED",
-  PREVIOUS_REJECTED = "PREVIOUS_REJECTED",
-}

package/src/models/cart/available-shipping-method/index.ts

@@ -1,13 +0,0 @@
-export type IkasAvailableShippingMethod = {
-  price: number;
-  rateName: string;
-  shippingMethod: IkasShippingMethod;
-  shippingSettingsId: string;
-  shippingZoneRateId: string;
-};
-
-export enum IkasShippingMethod {
-  CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
-  NO_SHIPMENT = "NO_SHIPMENT",
-  SHIPMENT = "SHIPMENT",
-}

package/src/models/cart/campaign-offer/index.ts

@@ -1,24 +0,0 @@
-import { IkasBaseModel } from "../../base";
-import {
-  IkasCampaignOffer,
-  IkasCampaignOfferTargetPageType,
-} from "../../campaign-offer";
-
-export type IkasCartCampaignOffer = {
-  appliedOrderLineId: string | null;
-  campaignOfferId: string;
-  campaignOffer: IkasCampaignOffer | null;
-  campaignOfferProductId: string | null;
-  offerEndDate: number | null;
-  offerStartDate: number;
-  status: IkasCartCampaignOfferStatus;
-  targetPageTypes: IkasCampaignOfferTargetPageType[];
-  triggerSourceOrderLineId: string;
-} & IkasBaseModel;
-
-export enum IkasCartCampaignOfferStatus {
-  ACCEPTED = "ACCEPTED",
-  REJECTED = "REJECTED",
-  REMOVED = "REMOVED",
-  WAITING_FOR_ACTION = "WAITING_FOR_ACTION",
-}

package/src/models/cart/index.ts

@@ -1,12 +0,0 @@
-import { IkasCartCampaignOffer } from "./campaign-offer";
-import { IkasAvailableShippingMethod } from "./available-shipping-method";
-import { IkasOrder } from "../order";
-
-export type IkasCart = {
-  availableShippingMethods: IkasAvailableShippingMethod[] | null;
-  campaignOffers: IkasCartCampaignOffer[] | null;
-  couponCode: string | null;
-  shippingSettingsId: string | null;
-  shippingZoneRateId: string | null;
-  stockLocationId: string | null;
-} & IkasOrder;

package/src/models/category/index.ts

@@ -1,30 +0,0 @@
-import { IkasImage } from "../image";
-import { IkasHTMLMetaData } from "../html-meta-data";
-import { IkasBaseModel } from "../base";
-import { IkasCategoryPathItem } from "./path-item";
-import { IkasCategoryTranslation } from "./translations";
-
-export type IkasCategory = {
-  categoryPath: string[] | null;
-  description: string | null;
-  imageId: string | null;
-  name: string;
-  parentId: string | null;
-  metaData: IkasHTMLMetaData | null;
-  categoryPathItems: IkasCategoryPathItem[];
-  orderType: IkasCategoryProductsOrderType | null;
-
-  image?: IkasImage | null;
-  translations?: IkasCategoryTranslation[] | null;
-} & IkasBaseModel;
-
-export enum IkasCategoryProductsOrderType {
-  BEST_SELLER = "BEST_SELLER",
-  HIGHEST_DISCOUNT_RATIO = "HIGHEST_DISCOUNT_RATIO",
-  HIGHEST_PRICE = "HIGHEST_PRICE",
-  LOWEST_DISCOUNT_RATIO = "LOWEST_DISCOUNT_RATIO",
-  LOWEST_PRICE = "LOWEST_PRICE",
-  MANUALLY = "MANUALLY",
-  NEWEST = "NEWEST",
-  OLDEST = "OLDEST",
-}

package/src/models/category/init.ts

@@ -1,33 +0,0 @@
-import { IkasCategory } from ".";
-import { IkasCategoryTranslation } from "./translations";
-import { initIkasHTMLMetaData } from "../html-meta-data/init";
-
-export function initIkasCategory(
-  category: IkasCategory,
-  locale: string | null
-) {
-  category.image = category.imageId
-    ? { id: category.imageId, isVideo: false }
-    : undefined;
-
-  category.metaData && initIkasHTMLMetaData(category.metaData, locale);
-
-  if (category.translations && locale) {
-    setTranslations(category, category.translations, locale);
-    delete category.translations;
-  }
-}
-
-function setTranslations(
-  category: IkasCategory,
-  translations: IkasCategoryTranslation[],
-  locale: string
-) {
-  if (translations && translations.some((t) => t.locale === locale)) {
-    const localeTranslations = translations.find((t) => t.locale === locale);
-
-    if (localeTranslations?.name) category.name = localeTranslations.name;
-    if (localeTranslations?.description)
-      category.description = localeTranslations.description;
-  }
-}

package/src/models/category/path-item/index.ts

@@ -1,9 +0,0 @@
-import { IkasHTMLMetaData } from "../../html-meta-data";
-import { IkasBaseModel } from "../../base";
-
-export type IkasCategoryPathItem = {
-  metaData: IkasHTMLMetaData | null;
-  description: string | null;
-  imageId: string | null;
-  name: string;
-} & IkasBaseModel;

package/src/models/category/translations/index.ts

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

package/src/models/checkout/index.ts

@@ -1,3 +0,0 @@
-import { IkasCart } from "../cart";
-
-export type IkasCheckout = {} & IkasCart;

package/src/models/checkout-settings/index.ts

@@ -1,24 +0,0 @@
-import { IkasBaseModel } from "../base";
-import { IkasCheckoutOption } from "./option";
-import { IkasCheckoutSettingsPrice } from "./price";
-
-export type IkasCheckoutSettings = {
-  giftPackagePriceList: IkasCheckoutSettingsPrice[] | null;
-  identityNumberRequirement: IkasCheckoutRequirement;
-  isAccountRequired: boolean;
-  isGiftPackageEnabled: boolean | null;
-  isShowPostalCode: boolean | null;
-  isTermsAndConditionsDefaultChecked: boolean | null;
-  options: IkasCheckoutOption[] | null;
-  phoneRequirement: IkasCheckoutRequirement;
-  postalCodeRequirement: IkasCheckoutRequirement | null;
-  showCheckoutNote: boolean | null;
-  showTermsAndConditionsCheckbox: boolean;
-  storefrontId: string;
-} & IkasBaseModel;
-
-export enum IkasCheckoutRequirement {
-  INVISIBLE = "INVISIBLE",
-  MANDATORY = "MANDATORY",
-  OPTIONAL = "OPTIONAL",
-}

package/src/models/checkout-settings/option/index.ts

@@ -1,4 +0,0 @@
-export type IkasCheckoutOption = {
-  name: string;
-  required: boolean;
-};

package/src/models/checkout-settings/price/index.ts

@@ -1,4 +0,0 @@
-export type IkasCheckoutSettingsPrice = {
-  currencyCode: string;
-  price: number;
-};

package/src/models/city/index.ts

@@ -1,11 +0,0 @@
-import { IkasBaseModel } from "../base";
-
-export type IkasCity = {
-  cityCode: string | null;
-  countryId: string;
-  latitude: string | null;
-  longitude: string | null;
-  name: string;
-  order: number | null;
-  stateId: string;
-} & IkasBaseModel;

package/src/models/contact-form/index.ts

@@ -1,7 +0,0 @@
-export type IkasContactForm = {
-  email: string;
-  firstName: string;
-  lastName: string;
-  message: string;
-  referer: string;
-};

package/src/models/country/index.ts

@@ -1,15 +0,0 @@
-import { IkasBaseModel } from "../base";
-
-export type IkasCountry = {
-  capital: string | null;
-  currency: string | null;
-  emoji: string | null;
-  emojiString: string | null;
-  iso2: string | null;
-  iso3: string | null;
-  name: string;
-  native: string | null;
-  phoneCode: string | null;
-  region: string | null;
-  subregion: string | null;
-} & IkasBaseModel;

package/src/models/customer/address/city/index.ts

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

package/src/models/customer/address/country/index.ts

@@ -1,7 +0,0 @@
-export type IkasCustomerAddressCountry = {
-  code: string | null;
-  id: string | null;
-  iso2: string | null;
-  iso3: string | null;
-  name: string;
-};

package/src/models/customer/address/district/index.ts

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

package/src/models/customer/address/index.tsx

@@ -1,27 +0,0 @@
-import { IkasBaseModel } from "../../base";
-import { IkasCheckoutSettings } from "../../checkout-settings";
-import { IkasCustomerAttributeValue } from "../attribute/value";
-import { IkasCustomerAddressCity } from "./city";
-import { IkasCustomerAddressCountry } from "./country";
-import { IkasCustomerAddressDistrict } from "./district";
-import { IkasCustomerAddressState } from "./state";
-
-export type IkasCustomerAddress = {
-  addressLine1: string;
-  addressLine2: string | null;
-  attributes: IkasCustomerAttributeValue[] | null;
-  company: string | null;
-  firstName: string;
-  identityNumber: string | null;
-  isDefault: boolean | null;
-  lastName: string;
-  phone: string | null;
-  postalCode: string | null;
-  taxNumber: string | null;
-  taxOffice: string | null;
-  title: string;
-  country: IkasCustomerAddressCountry | null;
-  state: IkasCustomerAddressState | null;
-  city: IkasCustomerAddressCity | null;
-  district: IkasCustomerAddressDistrict | null;
-} & IkasBaseModel;

package/src/models/customer/address/state/index.ts

@@ -1,5 +0,0 @@
-export interface IkasCustomerAddressState {
-  code: string | null;
-  id: string | null;
-  name: string | null;
-}

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

@@ -1,22 +0,0 @@
-import { IkasBaseModel } from "../../base";
-import { IkasCustomerAttributeOption } from "./option";
-import { IkasCustomerAttributeSalesChannel } from "./sales-channel";
-import { IkasCustomerAttributeTranslation } from "./translation";
-
-export type IkasCustomerAttribute = {
-  description: string | null;
-  name: string;
-  type: IkasCustomerAttributeType;
-  options: IkasCustomerAttributeOption[] | null;
-  salesChannels: IkasCustomerAttributeSalesChannel[] | null;
-  translations?: IkasCustomerAttributeTranslation[] | null;
-} & IkasBaseModel;
-
-export enum IkasCustomerAttributeType {
-  BOOLEAN = "BOOLEAN",
-  CHOICE = "CHOICE",
-  DATETIME = "DATETIME",
-  MULTIPLE_CHOICE = "MULTIPLE_CHOICE",
-  NUMERIC = "NUMERIC",
-  TEXT = "TEXT",
-}

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

@@ -1,34 +0,0 @@
-import { IkasCustomerAttribute } from ".";
-import { IkasCustomerAttributeTranslation } from "./translation";
-
-export function initIkasCustomerAttribute(
-  attribute: IkasCustomerAttribute,
-  locale: string | null
-) {
-  if (attribute.translations && locale) {
-    setTranslations(attribute, attribute.translations, locale);
-    delete attribute.translations;
-  }
-}
-
-function setTranslations(
-  attribute: IkasCustomerAttribute,
-  translations: IkasCustomerAttributeTranslation[],
-  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/customer/attribute/option/index.ts

@@ -1,7 +0,0 @@
-export type IkasCustomerAttributeOption = {
-  createdAt: number | null;
-  deleted: boolean | null;
-  id: string;
-  name: string;
-  updatedAt: number | null;
-};

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

@@ -1,18 +0,0 @@
-export type IkasCustomerAttributeSalesChannel = {
-  permission: IkasCustomerAttributePermission;
-  registerPageRequirement: IkasCustomerAttributeRegisterPageRequirement;
-  salesChannelId: string;
-  storefrontId: string;
-};
-
-export enum IkasCustomerAttributePermission {
-  INVISIBLE = "INVISIBLE",
-  READ = "READ",
-  WRITE = "WRITE",
-}
-
-export enum IkasCustomerAttributeRegisterPageRequirement {
-  INVISIBLE = "INVISIBLE",
-  MANDATORY = "MANDATORY",
-  OPTIONAL = "OPTIONAL",
-}

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

@@ -1,8 +0,0 @@
-import { IkasCustomerAttributeOptionTranslation } from "./option";
-
-export type IkasCustomerAttributeTranslation = {
-  description: string | null;
-  locale: string;
-  name: string | null;
-  options: IkasCustomerAttributeOptionTranslation[] | null;
-};

package/src/models/customer/attribute/translation/option/index.ts

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

package/src/models/customer/attribute/value/index.ts

@@ -1,12 +0,0 @@
-import { IkasCustomerAttribute } from "..";
-import { IkasCustomerAttributeOption } from "../option";
-
-export type IkasCustomerAttributeValue = {
-  customerAttributeId: string | null;
-  customerAttributeOptionId: string | null;
-  value: string | null;
-
-  // Extra
-  customerAttribute: IkasCustomerAttribute | null;
-  customerAttributeOption: IkasCustomerAttributeOption | null;
-};