@ikas/storefront-models 4.0.0-alpha.10

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,30 @@
+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;
+
+  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,11 @@
+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;
+};

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

package/src/models/theme-json/custom-data/index.ts

@@ -0,0 +1,46 @@
+import { IkasProductAttributeType } from "../../..";
+import {
+  IkasThemeJsonSliderData,
+  IkasThemeJsonComponentPropType,
+} from "../component/prop";
+
+export type IkasThemeJsonCustomData = {
+  id: string;
+  name?: string | null;
+  description?: string | null;
+  typescriptName?: string | null;
+  type: IkasThemeJsonComponentPropType;
+  isRequired: boolean;
+  translations: {
+    [locale: string]: IkasThemeJsonCustomDataTranslation;
+  };
+
+  key?: string | null;
+  nestedData?: IkasThemeJsonCustomData[] | null;
+  itemCount?: number | null; // for static lists
+  attributeTypes?: IkasProductAttributeType[] | null;
+  enumOptions?: IkasThemeJsonEnumOption[] | null;
+  customDataId?: string | null;
+  sliderData: IkasThemeJsonSliderData;
+
+  isRoot: boolean;
+  parent?: IkasThemeJsonCustomData | null;
+};
+
+export type IkasThemeJsonEnumOption = {
+  id: string;
+  displayName: string;
+  value: string;
+  translations: {
+    [locale: string]: IkasThemeJsonCustomDataEnumOptionTranslation;
+  };
+};
+
+export type IkasThemeJsonCustomDataTranslation = {
+  name: string | null;
+  description: string | null;
+};
+
+export type IkasThemeJsonCustomDataEnumOptionTranslation = {
+  displayName: string | null;
+};

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

@@ -0,0 +1,12 @@
+import { IkasThemeJsonComponent } from "./component";
+import { IkasThemeJsonCustomData } from "./custom-data";
+import { IkasThemeJsonPage } from "./page";
+import { IkasThemeJsonSettings } from "./settings";
+
+export type IkasThemeJson = {
+  name: string;
+  components: IkasThemeJsonComponent[];
+  pages: IkasThemeJsonPage[];
+  settings: IkasThemeJsonSettings;
+  customData: IkasThemeJsonCustomData[];
+};

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

@@ -0,0 +1,11 @@
+export type IkasThemeJsonPageComponent = {
+  id: string;
+  componentId: string;
+
+  // Prop value for a component can either be exact values to pass to the component,
+  // or it can be a data to derive the actual value the component needs
+  // key: propName
+  // e.g for a "Text" prop ---------> text: "TextValue"
+  // e.g for a "ProductList" prop --> productList: ProductListPropValue
+  propValues: Record<string, any>;
+};

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

@@ -0,0 +1,46 @@
+import { IkasThemeJsonPageComponent } from "./component";
+
+export type IkasThemeJsonPage = {
+  id: string;
+  name: string | null;
+  type: IkasThemeJsonPageType;
+  slug: string | null;
+  pageTitle: string | null;
+  description: string | null;
+  components: IkasThemeJsonPageComponent[];
+  specifications: IkasThemeJsonPageSpecification[] | null;
+  canonicals: string[] | null;
+  disableIndex: boolean | null;
+};
+
+export type IkasThemeJsonPageSpecification = {
+  id: string;
+  components: IkasThemeJsonPageComponent[];
+};
+
+export enum IkasThemeJsonPageType {
+  INDEX = "INDEX",
+  CATEGORY = "CATEGORY",
+  BRAND = "BRAND",
+  PRODUCT = "PRODUCT",
+  CUSTOM = "CUSTOM",
+  ACCOUNT = "ACCOUNT",
+  ADDRESSES = "ADDRESSES",
+  ORDERS = "ORDERS",
+  ORDER_DETAIL = "ORDER_DETAIL",
+  LOGIN = "LOGIN",
+  REGISTER = "REGISTER",
+  FORGOT_PASSWORD = "FORGOT_PASSWORD",
+  RECOVER_PASSWORD = "RECOVER_PASSWORD",
+  CART = "CART",
+  FAVORITE_PRODUCTS = "FAVORITE_PRODUCTS",
+  SEARCH = "SEARCH",
+  NOT_FOUND = "NOT_FOUND",
+  BLOG = "BLOG",
+  BLOG_INDEX = "BLOG_INDEX",
+  BLOG_CATEGORY = "BLOG_CATEGORY",
+  CHECKOUT = "CHECKOUT",
+  RAFFLE = "RAFFLE",
+  RAFFLE_DETAIL = "RAFFLE_DETAIL",
+  RAFFLE_ACCOUNT = "RAFFLE_ACCOUNT",
+}

package/src/models/theme-json/settings/color/index.ts

@@ -0,0 +1,13 @@
+export type IkasThemeJsonColor = {
+  id: string;
+  displayName: string;
+  key: string;
+  color: string;
+  translations: {
+    [locale: string]: IkasThemeJsonColorTranslation;
+  };
+};
+
+export type IkasThemeJsonColorTranslation = {
+  displayName: string | null;
+};

package/src/models/theme-json/settings/favicon/index.ts

@@ -0,0 +1,3 @@
+export type IkasThemeJsonFavicon = {
+  id: string | null;
+};

package/src/models/theme-json/settings/font-family/index.ts

@@ -0,0 +1,4 @@
+export type IkasThemeJsonFontFamily = {
+  name: string | null;
+  variants: string[] | null;
+};

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

@@ -0,0 +1,16 @@
+import { IkasThemeJsonColor } from "./color";
+import { IkasThemeJsonFavicon } from "./favicon";
+import { IkasThemeJsonFontFamily } from "./font-family";
+
+export type IkasThemeJsonSettings = {
+  colors: IkasThemeJsonColor[];
+  favicon: IkasThemeJsonFavicon;
+  stockPreference: IkasThemeJsonStockPreference;
+  fontFamily: IkasThemeJsonFontFamily;
+};
+
+export enum IkasThemeJsonStockPreference {
+  HIDE_OUT_OF_STOCK = "HIDE_OUT_OF_STOCK",
+  SHOW_ALL = "SHOW_ALL",
+  SHOW_OUT_OF_STOCK_AT_END = "SHOW_OUT_OF_STOCK_AT_END",
+}

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

@@ -0,0 +1,25 @@
+import { IkasVariantValue } from "./variant-value";
+
+export type IkasVariantType = {
+  id: string;
+  name: string;
+  selectionType: IkasVariantSelectionType;
+  values: IkasVariantValue[];
+  translations?: IkasVariantTypeTranslation[] | null;
+};
+
+export enum IkasVariantSelectionType {
+  CHOICE = "CHOICE",
+  COLOR = "COLOR",
+}
+
+export type IkasVariantTypeTranslation = {
+  locale: string;
+  name: string | null;
+  values: IkasVariantValueTranslation[] | null;
+};
+
+export type IkasVariantValueTranslation = {
+  id: string;
+  name: string | null;
+};

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

@@ -0,0 +1,37 @@
+import { IkasVariantType, IkasVariantTypeTranslation } from ".";
+import { initIkasVariantValue } from "./variant-value/init";
+
+export function initIkasVariantType(
+  variantType: IkasVariantType,
+  locale: string | null
+) {
+  variantType.values.forEach((v) => {
+    v.variantTypeId = variantType.id;
+    initIkasVariantValue(v);
+  });
+
+  if (variantType.translations && locale) {
+    setTranslations(variantType, variantType.translations, locale);
+    delete variantType.translations;
+  }
+}
+
+function setTranslations(
+  variantType: IkasVariantType,
+  translations: IkasVariantTypeTranslation[],
+  locale: string
+) {
+  if (translations && translations.some((t) => t.locale === locale)) {
+    const localeTranslations = translations.find((t) => t.locale === locale);
+
+    if (localeTranslations?.name) variantType.name = localeTranslations.name;
+    if (localeTranslations?.values) {
+      variantType.values.forEach((vv) => {
+        const translatedVV = localeTranslations.values?.find(
+          (tvv) => tvv.id === vv.id
+        );
+        if (translatedVV && translatedVV.name) vv.name = translatedVV.name;
+      });
+    }
+  }
+}

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

@@ -0,0 +1,12 @@
+import { IkasImage } from "../../image";
+
+export type IkasVariantValue = {
+  id: string;
+  name: string;
+  colorCode: string | null;
+  thumbnailImageId: string | null;
+  variantTypeId: string;
+
+  // Extra
+  thumbnailImage?: IkasImage;
+};

package/src/models/variant-type/variant-value/init.ts

@@ -0,0 +1,5 @@
+import { IkasVariantValue } from ".";
+
+export function initIkasVariantValue(variantValue: IkasVariantValue) {
+  variantValue.thumbnailImage = { id: variantValue.id, isVideo: false };
+}