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

package/src/models/country/init.ts

@@ -0,0 +1,16 @@
+import { IkasCountry } from "./index";
+import { IkasLocationTranslations } from "./location-translations";
+
+export function initIkasCountry(country: IkasCountry, locale: string | null) {
+  if (country.locationTranslations && locale) {
+    setTranslations(country, locale);
+    delete country.locationTranslations;
+  }
+}
+
+function setTranslations(country: IkasCountry, locale: string) {
+  country.name =
+    (country.locationTranslations &&
+      country.locationTranslations[locale as keyof IkasLocationTranslations]) ||
+    country.name;
+}

package/src/models/country/location-translations/index.ts

@@ -0,0 +1,5 @@
+export type IkasLocationTranslations = {
+  de: string | null;
+  en: string;
+  tr: string;
+};

package/src/models/merchant-settings/address/city/index.ts

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

package/src/models/merchant-settings/address/country/index.ts

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

package/src/models/merchant-settings/address/district/index.ts

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

package/src/models/merchant-settings/address/index.ts

@@ -0,0 +1,22 @@
+import { IkasMerchantAddressCity } from "./city";
+import { IkasMerchantAddressCountry } from "./country";
+import { IkasMerchantAddressDistrict } from "./district";
+import { IkasMerchantAddressState } from "./state";
+import { IkasMerchantSettingsAddressTypeEnum } from "./type";
+
+export type IkasMerchantAddress = {
+  addressLine1: string | null;
+  addressLine2: string | null;
+  city: IkasMerchantAddressCity | null;
+  country: IkasMerchantAddressCountry | null;
+  district: IkasMerchantAddressDistrict | null;
+  firstName: string | null;
+  identityNumber: string | null;
+  lastName: string | null;
+  postalCode: string | null;
+  state: IkasMerchantAddressState | null;
+  taxOffice: string | null;
+  title: string | null;
+  type: IkasMerchantSettingsAddressTypeEnum | null;
+  vkn: string | null;
+};

package/src/models/merchant-settings/address/state/index.ts

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

package/src/models/merchant-settings/address/type/index.ts

@@ -0,0 +1,4 @@
+export enum IkasMerchantSettingsAddressTypeEnum {
+  CORPORATE = "CORPORATE",
+  INDIVIDUAL = "INDIVIDUAL",
+}

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

@@ -1,10 +1,13 @@
 import { IkasImage } from "../image";
+import { IkasMerchantAddress } from "./address";
 
 export type IkasMerchantSettings = {
+  address: IkasMerchantAddress | null;
   currencyFormats: IkasMerchantSettingsCurrencyFormat[] | null;
   logoId: string | null;
   merchantId: string;
   merchantName: string;
+  phone: string | null;
 
   // Extra
   logo?: IkasImage | null;

package/src/models/order/index.ts

@@ -15,6 +15,7 @@ export type IkasOrder = {
   cancelReason: IkasOrderCancelReason | null;
   cancelledAt: number | null;
   currencyCode: string;
+  currencySymbol: string | null;
   customer: IkasOrderCustomer | null;
   customerId: string | null;
   giftPackageLines: IkasOrderGiftPackageLine[] | null;
@@ -87,4 +88,5 @@ export enum IkasOrderShippingMethod {
   CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
   NO_SHIPMENT = "NO_SHIPMENT",
   SHIPMENT = "SHIPMENT",
+  DIGITAL_DELIVERY = "DIGITAL_DELIVERY",
 }

package/src/models/order/line-item/base-unit/index.ts

@@ -0,0 +1,22 @@
+import { IkasOrderLineVariantUnitType } from "./unit-type";
+
+export type IkasOrderLineBaseUnit = {
+  baseAmount: number;
+  type: IkasProductUnitType;
+  unit: IkasOrderLineVariantUnitType | null;
+};
+
+export enum IkasProductUnitType {
+  CENTILITER = "CENTILITER",
+  CENTIMETER = "CENTIMETER",
+  CUBIC_METERS = "CUBIC_METERS",
+  CUSTOM = "CUSTOM",
+  GRAM = "GRAM",
+  KILOGRAM = "KILOGRAM",
+  LITER = "LITER",
+  METER = "METER",
+  MILLIGRAM = "MILLIGRAM",
+  MILLILITER = "MILLILITER",
+  MILLIMETER = "MILLIMETER",
+  SQUARE_METERS = "SQUARE_METERS",
+}

package/src/models/order/line-item/base-unit/unit-type/index.ts

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

package/src/models/order/line-item/index.ts

@@ -5,9 +5,11 @@ import { IkasBaseModel } from "../../base";
 
 export type IkasOrderLineItem = {
   currencyCode: string | null;
+  currencySymbol: string | null;
   discount: IkasOrderLineDiscount | null;
   discountPrice: number | null;
   finalPrice: number | null;
+  finalUnitPrice: number | null;
   options: IkasOrderLineItemOption[] | null;
   originalOrderLineItemId: string | null;
   price: number;
@@ -16,6 +18,7 @@ export type IkasOrderLineItem = {
   statusUpdatedAt: number | null;
   stockLocationId: string | null;
   taxValue: number | null;
+  unitPrice: number | null;
   variant: IkasOrderLineVariant;
   orderedAt: number;
 } & IkasBaseModel;

package/src/models/order/line-item/variant/index.ts

@@ -3,9 +3,12 @@ import { IkasOrderLineVariantBrand } from "./brand";
 import { IkasOrderLineVariantCategory } from "./category";
 import { IkasOrderLineVariantPrice } from "./price";
 import { IkasImage } from "../../../image";
+import { IkasOrderLineBaseUnit } from "../base-unit";
+import { IkasOrderLineVariantUnit } from "./unit";
 
 export type IkasOrderLineVariant = {
   barcodeList: string[] | null;
+  baseUnit: IkasOrderLineBaseUnit | null;
   brand: IkasOrderLineVariantBrand | null;
   categories: IkasOrderLineVariantCategory[] | null;
   id: string | null;
@@ -18,6 +21,7 @@ export type IkasOrderLineVariant = {
   tagIds: string[] | null;
   taxValue: number | null;
   type: number | null;
+  unit: IkasOrderLineVariantUnit | null;
   weight: number | null;
   variantValues: IkasOrderLineVariantVariantValue[] | null;
 

package/src/models/order/line-item/variant/price/index.ts

@@ -4,4 +4,5 @@ export type IkasOrderLineVariantPrice = {
   discountPrice: number | null;
   priceListId: string | null;
   sellPrice: number;
+  unitPrice: number | null;
 };

package/src/models/order/line-item/variant/unit/index.ts

@@ -0,0 +1,6 @@
+import { IkasProductUnitType } from "../../base-unit";
+
+export type IkasOrderLineVariantUnit = {
+  amount: number;
+  type: IkasProductUnitType;
+};

package/src/models/order/transaction/index.ts

@@ -7,6 +7,7 @@ export type IkasOrderTransaction = {
   checkoutId: string | null;
   createdAt: number | null;
   currencyCode: string | null;
+  currencySymbol: string | null;
   customerId: string | null;
   error: IkasTransactionError | null;
   id: string | null;
@@ -20,9 +21,6 @@ export type IkasOrderTransaction = {
   status: IkasTransactionStatus | null;
   type: IkasTransactionType | null;
   updatedAt: number | null;
-
-  // Extra
-  currencySymbol?: string | null;
 };
 
 export enum IkasTransactionStatus {

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

@@ -21,4 +21,6 @@ export enum IkasProductAttributeType {
   DATETIME = "DATETIME",
   HTML = "HTML",
   TABLE = "TABLE",
+  IMAGE = "IMAGE",
+  PRODUCT = "PRODUCT",
 }

package/src/models/product/base-unit/index.ts

@@ -0,0 +1,12 @@
+import { IkasProductUnitType } from "../../order/line-item/base-unit";
+
+export type IkasProductBaseUnit = {
+  baseAmount: number | null;
+  type: IkasProductUnitType;
+  unit: IkasProductUnit;
+};
+
+export type IkasProductUnit = {
+  id: string;
+  name: string;
+};

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

@@ -44,6 +44,7 @@ export type IkasProductFilterSettings = {
   showCollapsedOnDesktop: boolean;
   showCollapsedOnMobile: boolean;
   sortType: IkasProductFilterSortType;
+  customSortedValues: string[] | null;
 };
 
 export type IkasProductFacetInput = {
@@ -76,6 +77,7 @@ export enum IkasProductFilterSortType {
   ALPHABETICAL_DESC = "ALPHABETICAL_DESC",
   PRODUCT_COUNT_ASC = "PRODUCT_COUNT_ASC",
   PRODUCT_COUNT_DESC = "PRODUCT_COUNT_DESC",
+  CUSTOM_SORT = "CUSTOM_SORT",
 }
 
 export enum IkasProductStockFilterValue {

package/src/models/product/index.ts

@@ -7,6 +7,7 @@ import { IkasHTMLMetaData } from "../html-meta-data";
 import { IkasProductTag } from "./tag";
 import { IkasVariantValue } from "../variant-type/variant-value";
 import { IkasVariantType } from "../variant-type";
+import { IkasProductBaseUnit } from "./base-unit";
 
 export type IkasProduct = {
   id: string;
@@ -22,6 +23,7 @@ export type IkasProduct = {
   attributes: IkasProductAttributeValue[];
   variantTypes: IkasProductVariantType[];
   productOptionSetId: string | null;
+  baseUnit: IkasProductBaseUnit | null;
 };
 
 export enum IkasProductType {

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

@@ -3,6 +3,7 @@ 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;
@@ -17,4 +18,5 @@ export type IkasProductVariant = {
   sellIfOutOfStock: boolean;
   images: IkasProductImage[] | null;
   campaigns?: IkasProductCampaign[];
+  unit: IkasProductVariantUnit | null;
 };

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

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

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

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

@@ -18,13 +18,11 @@ export type IkasRaffle = {
   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 {
@@ -58,8 +56,10 @@ export type IkasRaffleParticipant = {
   email: string;
   applicationDate: number;
   phone: string | null;
-  isWinner: boolean | null;
+  isDeliveredCargo: boolean | null;
 
+  raffle: IkasRaffle | null;
+  status: IkasRaffleParticipantStatus | null;
   extraData: Record<string, any> | null;
   appliedProduct: IkasRaffleAppliedProduct;
 };
@@ -68,3 +68,10 @@ export type IkasRaffleAppliedProduct = {
   productId: string;
   variantId: string;
 };
+
+export enum IkasRaffleParticipantStatus {
+  COMPLETED = "COMPLETED",
+  IN_PROGRESS = "IN_PROGRESS",
+  LOSER = "LOSER",
+  WINNER = "WINNER",
+}

package/src/models/storefront/index.ts

@@ -22,6 +22,7 @@ export type IkasStorefront = {
   analytics4Id: string | null;
   universalAnalyticsId: string | null;
   tiktokPixelId: string | null;
+  token: string | null;
 
   localizations: IkasStorefrontLocalization[];
   routings: IkasStorefrontRouting[];

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

@@ -8,4 +8,6 @@ export type IkasStorefrontRouting = {
   path: string | null;
   priceListId: string | null;
   dynamicCurrencySettings: IkasStorefrontDynamicCurrencySettings | null;
+  currencyCode: string | null;
+  currencySymbol: string | null;
 };