@ikas/storefront-models 4.0.0-alpha.86 → 4.0.0-alpha.9

package/{build/index.d.ts → src/index.ts}

@@ -1,172 +1,213 @@
-export * from "./models/base";
-export * from "./models/base/init";
-export * from "./models/blog/category";
-export * from "./models/blog/category/init";
-export * from "./models/blog/content";
-export * from "./models/blog/meta-data";
-export * from "./models/blog/tag";
-export * from "./models/blog/writer";
-export * from "./models/blog";
-export * from "./models/blog/init";
-export * from "./models/brand/translation";
-export * from "./models/brand";
-export * from "./models/brand/init";
-export * from "./models/campaign-offer/product";
-export * from "./models/campaign-offer";
-export * from "./models/cart/available-shipping-method";
-export * from "./models/cart/campaign-offer";
-export * from "./models/cart";
-export * from "./models/category/path-item";
-export * from "./models/category/translations";
-export * from "./models/category";
-export * from "./models/category/init";
-export * from "./models/checkout";
-export * from "./models/checkout-settings/option";
-export * from "./models/checkout-settings/price";
-export * from "./models/checkout-settings";
-export * from "./models/city";
-export * from "./models/contact-form";
-export * from "./models/country";
-export * from "./models/country/location-translations";
-export * from "./models/country/init";
-export * from "./models/customer/address/city";
-export * from "./models/customer/address/country";
-export * from "./models/customer/address/district";
-export * from "./models/customer/address/state";
-export * from "./models/customer/address";
-export * from "./models/customer/attribute/option";
-export * from "./models/customer/attribute/sales-channel";
-export * from "./models/customer/attribute/translation/option";
-export * from "./models/customer/attribute/translation";
-export * from "./models/customer/attribute/value";
-export * from "./models/customer/attribute/init";
-export * from "./models/customer/attribute";
-export * from "./models/customer/review/settings";
-export * from "./models/customer/review/summary/star";
-export * from "./models/customer/review/summary";
-export * from "./models/customer/review/init";
-export * from "./models/customer/review";
-export * from "./models/customer";
-export * from "./models/customer-settings";
-export * from "./models/district";
-export * from "./models/favorite-product";
-export * from "./models/filter-category";
-export * from "./models/html-meta-data/translations";
-export * from "./models/html-meta-data/init";
-export * from "./models/html-meta-data";
-export * from "./models/image";
-export * from "./models/last-viewed-product";
-export * from "./models/merchant-settings/init";
-export * from "./models/merchant-settings";
-export * from "./models/merchant-settings/address";
-export * from "./models/merchant-settings/address/city";
-export * from "./models/merchant-settings/address/country";
-export * from "./models/merchant-settings/address/district";
-export * from "./models/merchant-settings/address/state";
-export * from "./models/merchant-settings/address/type";
-export * from "./models/order/address/city";
-export * from "./models/order/address/country";
-export * from "./models/order/address/district";
-export * from "./models/order/address/state";
-export * from "./models/order/address";
-export * from "./models/order/adjustment/applied-order-line";
-export * from "./models/order/adjustment";
-export * from "./models/order/customer";
-export * from "./models/order/gift-line";
-export * from "./models/order/invoice";
-export * from "./models/order/line-item/base-unit/unit-type";
-export * from "./models/order/line-item/base-unit";
-export * from "./models/order/line-item/discount";
-export * from "./models/order/line-item/option/value";
-export * from "./models/order/line-item/option";
-export * from "./models/order/line-item/variant/brand";
-export * from "./models/order/line-item/variant/category";
-export * from "./models/order/line-item/variant/price";
-export * from "./models/order/line-item/variant/unit";
-export * from "./models/order/line-item/variant/value";
-export * from "./models/order/line-item/variant";
-export * from "./models/order/line-item";
-export * from "./models/order/package/tracking-info";
-export * from "./models/order/package";
-export * from "./models/order/payment-method";
-export * from "./models/order/refund/line-item";
-export * from "./models/order/refund/settings";
-export * from "./models/order/refund";
-export * from "./models/order/shipping-line";
-export * from "./models/order/tax-line";
-export * from "./models/order/transaction/error";
-export * from "./models/order/transaction/payment-method-detail/installment-price";
-export * from "./models/order/transaction/payment-method-detail";
-export * from "./models/order/transaction";
-export * from "./models/order";
-export * from "./models/payment-gateway/additional-price";
-export * from "./models/payment-gateway/settings";
-export * from "./models/payment-gateway/translation";
-export * from "./models/payment-gateway/init";
-export * from "./models/payment-gateway";
-export * from "./models/product/attribute/option";
-export * from "./models/product/attribute/table-cell";
-export * from "./models/product/attribute/table-template";
-export * from "./models/product/attribute/translation";
-export * from "./models/product/attribute/init";
-export * from "./models/product/attribute";
-export * from "./models/product/attribute-value/init";
-export * from "./models/product/attribute-value";
-export * from "./models/product/back-in-stock-settings";
-export * from "./models/product/base-unit";
-export * from "./models/product/filter";
-export * from "./models/product/campaign/data";
-export * from "./models/product/campaign/filter";
-export * from "./models/product/campaign/product-buyx-then-gety";
-export * from "./models/product/campaign/product-campaign-date-range-field";
-export * from "./models/product/campaign/product-fixed-discount";
-export * from "./models/product/campaign";
-export * from "./models/product/image/init";
-export * from "./models/product/image";
-export * from "./models/product/option-set/option/init";
-export * from "./models/product/option-set/option";
-export * from "./models/product/option-set/init";
-export * from "./models/product/option-set";
-export * from "./models/product/tag";
-export * from "./models/product/variant/price";
-export * from "./models/product/variant/unit";
-export * from "./models/product/variant/init";
-export * from "./models/product/variant";
-export * from "./models/product/variant-type/init";
-export * from "./models/product/variant-type";
-export * from "./models/product/init";
-export * from "./models/product";
-export * from "./models/product-option-file";
-export * from "./models/raffle/init";
-export * from "./models/raffle/";
-export * from "./models/sales-channel";
-export * from "./models/state";
-export * from "./models/stock-location/address/city";
-export * from "./models/stock-location/address/country";
-export * from "./models/stock-location/address/district";
-export * from "./models/stock-location/address/state";
-export * from "./models/stock-location/address";
-export * from "./models/stock-location/available";
-export * from "./models/stock-location";
-export * from "./models/storefront/domain";
-export * from "./models/storefront/localization";
-export * from "./models/storefront/routing/dynamic-currency";
-export * from "./models/storefront/routing";
-export * from "./models/storefront/theme";
-export * from "./models/storefront/theme-localization";
-export * from "./models/storefront/meta-templates";
-export * from "./models/storefront";
-export * from "./models/theme-json/component/prop";
-export * from "./models/theme-json/component";
-export * from "./models/theme-json/custom-data";
-export * from "./models/theme-json/page/component";
-export * from "./models/theme-json/page";
-export * from "./models/theme-json/settings/color";
-export * from "./models/theme-json/settings/favicon";
-export * from "./models/theme-json/settings/font-family";
-export * from "./models/theme-json/settings";
-export * from "./models/theme-json";
-export * from "./models/variant-type/variant-value/init";
-export * from "./models/variant-type/variant-value";
-export * from "./models/variant-type/init";
-export * from "./models/variant-type";
+// BASE
+export * from "./models/base";
+export * from "./models/base/init";
+
+// BLOG
+export * from "./models/blog/category";
+export * from "./models/blog/category/init";
+export * from "./models/blog/content";
+export * from "./models/blog/meta-data";
+export * from "./models/blog/tag";
+export * from "./models/blog/writer";
+export * from "./models/blog";
+export * from "./models/blog/init";
+
+// BRAND
+export * from "./models/brand/translation";
+export * from "./models/brand";
+export * from "./models/brand/init";
+
+// CAMPAIGN-OFFER
+export * from "./models/campaign-offer/product";
+export * from "./models/campaign-offer";
+
+// CART
+export * from "./models/cart/available-shipping-method";
+export * from "./models/cart/campaign-offer";
+export * from "./models/cart";
+
+// CATEGORY
+export * from "./models/category/path-item";
+export * from "./models/category/translations";
+export * from "./models/category";
+export * from "./models/category/init";
+
+// CHECKOUT
+export * from "./models/checkout";
+
+// CHECKOUT-SETTINGS
+export * from "./models/checkout-settings/option";
+export * from "./models/checkout-settings/price";
+export * from "./models/checkout-settings";
+
+// CITY
+export * from "./models/city";
+
+// CONTACT-FORM
+export * from "./models/contact-form";
+
+// COUNTRY
+export * from "./models/country";
+
+// CUSTOMER
+export * from "./models/customer/address/city";
+export * from "./models/customer/address/country";
+export * from "./models/customer/address/district";
+export * from "./models/customer/address/state";
+export * from "./models/customer/address";
+export * from "./models/customer/attribute/option";
+export * from "./models/customer/attribute/sales-channel";
+export * from "./models/customer/attribute/translation/option";
+export * from "./models/customer/attribute/translation";
+export * from "./models/customer/attribute/value";
+export * from "./models/customer/attribute/init";
+export * from "./models/customer/attribute";
+export * from "./models/customer/review/settings";
+export * from "./models/customer/review/summary/star";
+export * from "./models/customer/review/summary";
+export * from "./models/customer/review/init";
+export * from "./models/customer/review";
+export * from "./models/customer";
+
+// DISTRICT
+export * from "./models/district";
+
+// FAVORITE-PRODUCT
+export * from "./models/favorite-product";
+
+// FILTER-CATEGORY
+export * from "./models/filter-category";
+
+// HTML-META-DATA
+export * from "./models/html-meta-data/translations";
+export * from "./models/html-meta-data/init";
+export * from "./models/html-meta-data";
+
+// IMAGE
+export * from "./models/image";
+
+// LAST-VIEWED-PRODUCT
+export * from "./models/last-viewed-product";
+
+// MERCHANT-SETTINGS
+export * from "./models/merchant-settings/init";
+export * from "./models/merchant-settings";
+
+// ORDER
+export * from "./models/order/address/city";
+export * from "./models/order/address/country";
+export * from "./models/order/address/district";
+export * from "./models/order/address/state";
+export * from "./models/order/address";
+export * from "./models/order/adjustment/applied-order-line";
+export * from "./models/order/adjustment";
+export * from "./models/order/customer";
+export * from "./models/order/gift-line";
+export * from "./models/order/invoice";
+export * from "./models/order/line-item/discount";
+export * from "./models/order/line-item/option/value";
+export * from "./models/order/line-item/option";
+export * from "./models/order/line-item/variant/brand";
+export * from "./models/order/line-item/variant/category";
+export * from "./models/order/line-item/variant/price";
+export * from "./models/order/line-item/variant/value";
+export * from "./models/order/line-item/variant";
+export * from "./models/order/line-item";
+export * from "./models/order/package/tracking-info";
+export * from "./models/order/package";
+export * from "./models/order/payment-method";
+export * from "./models/order/refund/line-item";
+export * from "./models/order/refund/settings";
+export * from "./models/order/refund";
+export * from "./models/order/shipping-line";
+export * from "./models/order/tax-line";
+export * from "./models/order/transaction/error";
+export * from "./models/order/transaction/payment-method-detail/installment-price";
+export * from "./models/order/transaction/payment-method-detail";
+export * from "./models/order/transaction";
+export * from "./models/order";
+
+// PAYMENT-GATEWAY
+export * from "./models/payment-gateway/additional-price";
+export * from "./models/payment-gateway/settings";
+export * from "./models/payment-gateway/translation";
+export * from "./models/payment-gateway/init";
+export * from "./models/payment-gateway";
+
+// PRODUCT
+export * from "./models/product/attribute/option";
+export * from "./models/product/attribute/table-cell";
+export * from "./models/product/attribute/table-template";
+export * from "./models/product/attribute/translation";
+export * from "./models/product/attribute/init";
+export * from "./models/product/attribute";
+export * from "./models/product/attribute-value/init";
+export * from "./models/product/attribute-value";
+export * from "./models/product/back-in-stock-settings";
+export * from "./models/product/filter";
+export * from "./models/product/campaign/data";
+export * from "./models/product/campaign/filter";
+export * from "./models/product/campaign/product-buyx-then-gety";
+export * from "./models/product/campaign/product-campaign-date-range-field";
+export * from "./models/product/campaign/product-fixed-discount";
+export * from "./models/product/campaign";
+export * from "./models/product/image/init";
+export * from "./models/product/image";
+export * from "./models/product/option-set/option/init";
+export * from "./models/product/option-set/option";
+export * from "./models/product/option-set/init";
+export * from "./models/product/option-set";
+export * from "./models/product/tag";
+export * from "./models/product/variant/price";
+export * from "./models/product/variant/init";
+export * from "./models/product/variant";
+export * from "./models/product/variant-type/init";
+export * from "./models/product/variant-type";
+export * from "./models/product/init";
+export * from "./models/product";
+
+// RAFFLE
+export * from "./models/raffle/init";
+export * from "./models/raffle/";
+
+// SALES-CHANNEL
+export * from "./models/sales-channel";
+
+// STATE
+export * from "./models/state";
+
+// STOCK-LOCATION
+export * from "./models/stock-location/address/city";
+export * from "./models/stock-location/address/country";
+export * from "./models/stock-location/address/district";
+export * from "./models/stock-location/address/state";
+export * from "./models/stock-location/address";
+export * from "./models/stock-location/available";
+export * from "./models/stock-location";
+
+// STOREFRONT
+export * from "./models/storefront/domain";
+export * from "./models/storefront/localization";
+export * from "./models/storefront/routing/dynamic-currency";
+export * from "./models/storefront/routing";
+export * from "./models/storefront/theme";
+export * from "./models/storefront/theme-localization";
+export * from "./models/storefront";
+
+// THEME-JSON
+export * from "./models/theme-json/component/prop";
+export * from "./models/theme-json/component";
+export * from "./models/theme-json/custom-data";
+export * from "./models/theme-json/page/component";
+export * from "./models/theme-json/page";
+export * from "./models/theme-json/settings/color";
+export * from "./models/theme-json/settings/favicon";
+export * from "./models/theme-json/settings/font-family";
+export * from "./models/theme-json/settings";
+export * from "./models/theme-json";
+
+// VARIANT-TYPE
+export * from "./models/variant-type/variant-value/init";
+export * from "./models/variant-type/variant-value";
+export * from "./models/variant-type/init";
+export * from "./models/variant-type";

package/src/models/base/index.ts

@@ -0,0 +1,6 @@
+export type IkasBaseModel = {
+  id: string;
+  createdAt: number;
+  updatedAt: number;
+  deleted?: boolean | null;
+};

package/src/models/base/init.ts

@@ -0,0 +1,14 @@
+import { IkasBaseModel } from ".";
+
+/**
+ * Creates an empty base model object
+ * @returns An initialized empty base model object.
+ */
+export function createIkasBaseModel(): IkasBaseModel {
+  return {
+    id: "",
+    createdAt: Date.now(),
+    updatedAt: Date.now(),
+    deleted: false,
+  };
+}

package/{build/models/blog/category/index.d.ts → src/models/blog/category/index.ts}

@@ -1,9 +1,11 @@
-import { IkasImage } from "../../image";
-import { IkasBaseModel } from "../../base";
-import { IkasBlogMetaData } from "../meta-data";
-export declare type IkasBlogCategory = {
-    imageId: string;
-    metadata: IkasBlogMetaData;
-    name: string;
-    image?: IkasImage | null;
-} & IkasBaseModel;
+import { IkasImage } from "../../image";
+import { IkasBaseModel } from "../../base";
+import { IkasBlogMetaData } from "../meta-data";
+
+export type IkasBlogCategory = {
+  imageId: string;
+  metadata: IkasBlogMetaData;
+  name: string;
+
+  image?: IkasImage | null;
+} & IkasBaseModel;

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

@@ -0,0 +1,33 @@
+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/{build/models/blog/tag/index.d.ts → src/models/blog/content/index.ts}

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

package/src/models/blog/index.ts

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,16 @@
+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

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

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

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

package/src/models/brand/index.ts

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,27 @@
+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

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