@ikas/storefront 0.1.24-alpha.8 → 0.2.0-alpha.10

package/build/__generated__/global-types.d.ts

@@ -248,6 +248,21 @@ export declare enum ProductFilterTypeEnum {
     TAG = "TAG",
     VARIANT_TYPE = "VARIANT_TYPE"
 }
+export declare enum ProductOptionSelectTypeEnum {
+    BOX = "BOX",
+    SELECT = "SELECT",
+    SWATCH = "SWATCH"
+}
+export declare enum ProductOptionTypeEnum {
+    CHECKBOX = "CHECKBOX",
+    CHOICE = "CHOICE",
+    COLOR_PICKER = "COLOR_PICKER",
+    DATE_PICKER = "DATE_PICKER",
+    FILE = "FILE",
+    IMAGE = "IMAGE",
+    TEXT = "TEXT",
+    TEXT_AREA = "TEXT_AREA"
+}
 export declare enum ProductSearchShowStockOptionEnum {
     HIDE_OUT_OF_STOCK = "HIDE_OUT_OF_STOCK",
     SHOW_ALL = "SHOW_ALL",
@@ -362,6 +377,20 @@ export interface CreateCustomerEmailSubscriptionInput {
     id?: string | null;
     updatedAt?: any | null;
 }
+export interface CreateCustomerReviewInput {
+    comment?: string | null;
+    createdAt?: any | null;
+    customerId?: string | null;
+    deleted?: boolean | null;
+    id?: string | null;
+    orderId?: string | null;
+    orderNumber?: string | null;
+    productId: string;
+    salesChannelId: string;
+    star: number;
+    title?: string | null;
+    updatedAt?: any | null;
+}
 export interface CreateSaleTransactionWithCheckoutInput {
     checkoutId: string;
     paymentGatewayId: string;
@@ -387,10 +416,21 @@ export interface CustomerAddressStateInput {
     id?: string | null;
     name?: string | null;
 }
+export interface DateFilterInput {
+    eq?: any | null;
+    gt?: any | null;
+    gte?: any | null;
+    in?: any[] | null;
+    lt?: any | null;
+    lte?: any | null;
+}
 export interface HTMLMetaDataTargetTypeEnumFilter {
     eq?: HTMLMetaDataTargetTypeEnum | null;
     in?: HTMLMetaDataTargetTypeEnum[] | null;
 }
+export interface ListCustomerReviewInput {
+    salesChannelId: string;
+}
 export interface OrderAddressCityInput {
     code?: string | null;
     id?: string | null;
@@ -462,6 +502,11 @@ export interface PaymentMethodDetailInput {
     installmentCount: number;
     threeDSecure: boolean;
 }
+export interface ProductBackInStockRemindInput {
+    email: string;
+    productId: string;
+    variantId: string;
+}
 export interface ProductItemInput {
     createdAt?: any | null;
     deleted?: boolean | null;

package/build/analytics/analytics.d.ts

@@ -1,4 +1,4 @@
-import { IkasProductDetail, IkasOrderLineItem, IkasCheckout, IkasCategory, IkasThemePageType, IkasOrderTransaction } from "../models/index";
+import { IkasProductDetail, IkasOrderLineItem, IkasCheckout, IkasCategory, IkasThemePageType, IkasOrderTransaction, IkasBrand } from "../models/index";
 import { CheckoutStep } from "../components/checkout/model";
 import { IkasCart } from "../models/data/cart/index";
 import { IkasEventSubscriber } from "./events";
@@ -24,12 +24,13 @@ export declare class Analytics {
     static disableHTML(): void;
     static addToWishlist(productId: string): void;
     static search(searchKeyword: string): void;
-    static completeRegistration(email: string): void;
+    static completeRegistration(email: string, customerId?: string): void;
     static customerLogin(): Promise<void>;
     static customerLogout(): Promise<void>;
     static customerVisit(): Promise<void>;
     static viewCart(cart: IkasCart | null | undefined): void;
     static viewCategory(categoryPath: string, category: IkasCategory): void;
+    static viewBrand(brand: IkasBrand): void;
     static viewSearchResults(searchKeyword: string, productDetails: IkasProductDetail[]): void;
     static viewListing(productDetails: IkasProductDetail[]): void;
     static contactForm(form: IkasContactForm): void;

package/build/analytics/events.d.ts

@@ -21,6 +21,7 @@ export declare enum IkasEventType {
     CUSTOMER_VISIT = "CUSTOMER_VISIT",
     VIEW_CART = "VIEW_CART",
     VIEW_CATEGORY = "VIEW_CATEGORY",
+    VIEW_BRAND = "VIEW_BRAND",
     VIEW_SEARCH_RESULTS = "VIEW_SEARCH_RESULTS",
     VIEW_LISTING = "VIEW_LISTING",
     CONTACT_FORM = "CONTACT_FORM"

package/build/analytics/ikas.d.ts

@@ -0,0 +1,133 @@
+import { CheckoutStep } from "../components/checkout/model";
+import { IkasBrand, IkasCategory, IkasCheckout, IkasOrderLineItem, IkasProductDetail, IkasThemePageType } from "../models/index";
+import { IkasCart } from "../models/data/cart/index";
+declare enum StorefrontEventType {
+    SESSION_START = 1,
+    PAGE_VIEW = 2,
+    PRODUCT_VIEW = 3,
+    ADD_TO_CART = 4,
+    VIEW_CART = 5,
+    ORDER_SUCCESS = 6,
+    BEGIN_CHECKOUT = 7,
+    CHECKOUT_STEP = 8,
+    CUSTOMER_REGISTER = 9,
+    CUSTOMER_VISIT = 10,
+    CUSTOMER_LOGIN = 11,
+    BRAND_VIEW = 12,
+    CATEGORY_VIEW = 13
+}
+declare enum StorefrontEventPageType {
+    INDEX = 1,
+    CATEGORY = 2,
+    BRAND = 3,
+    PRODUCT = 4,
+    CUSTOM = 5,
+    ACCOUNT = 6,
+    ADDRESSES = 7,
+    ORDERS = 8,
+    ORDER_DETAIL = 9,
+    LOGIN = 10,
+    REGISTER = 11,
+    FORGOT_PASSWORD = 12,
+    RECOVER_PASSWORD = 13,
+    CART = 14,
+    FAVORITE_PRODUCTS = 15,
+    SEARCH = 16,
+    NOT_FOUND = 17,
+    BLOG = 18,
+    BLOG_INDEX = 19,
+    BLOG_CATEGORY = 20,
+    CHECKOUT = 21
+}
+interface Event {
+    t: StorefrontEventType;
+    d: EventPayload;
+    ts: number;
+}
+interface EventPayload {
+    u: string;
+    r?: string;
+    utm?: UTMData;
+    pt?: StorefrontEventPageType;
+    d?: EventPayloadDetail;
+    m?: Record<string, string>;
+}
+interface UTMData {
+    ca?: string;
+    c?: string;
+    m?: string;
+    s?: string;
+    t?: string;
+}
+interface EventPayloadDetail {
+    br?: BrandDetail;
+    ctg?: CategoryDetail;
+    pr?: ProductDetail;
+    crt?: CartDetail;
+    crtItm?: CartItemDetail;
+    chk?: CheckoutDetail;
+    cst?: CustomerDetail;
+}
+interface BrandDetail {
+    id: string;
+}
+interface CategoryDetail {
+    id: string;
+}
+interface ProductDetail {
+    id: string;
+    vid: string;
+}
+interface CartDetail {
+    id: string;
+    c: number;
+}
+interface CartItemDetail {
+    id: string;
+    c: number;
+}
+interface CheckoutDetail {
+    id: string;
+    s?: string;
+}
+interface CustomerDetail {
+    id?: string;
+    e?: string;
+    c?: boolean;
+}
+export default class IkasAnalytics {
+    static SESSION_ID_KEY: string;
+    static VISITOR_ID_KEY: string;
+    static EXPIRY_LENGTH: number;
+    static sessionId?: string | null;
+    static visitorId?: string | null;
+    static createSessionId(): void;
+    static checkSessionId(): void;
+    static checkVisitorId(): void;
+    static getPageType(pageType: IkasThemePageType): StorefrontEventPageType | undefined;
+    static getCustomerData(): {
+        id: string | undefined;
+        e: string | undefined;
+        c: boolean;
+    };
+    static getCommonEventData(): {
+        u: string;
+        r: string;
+        pt: StorefrontEventPageType | undefined;
+    };
+    static sendEvents(events: Event[]): Promise<void>;
+    static sessionStart(): Promise<void>;
+    static pageView(pageType: IkasThemePageType): Promise<void>;
+    static productView(productDetail: IkasProductDetail): Promise<void>;
+    static addToCart(item: IkasOrderLineItem, quantity: number, cart: IkasCart): Promise<void>;
+    static viewCart(cart: IkasCart): Promise<void>;
+    static orderSuccess(checkout: IkasCheckout): Promise<void>;
+    static beginCheckout(checkout: IkasCheckout): Promise<void>;
+    static checkoutStep(checkout: IkasCheckout, step: CheckoutStep): Promise<void>;
+    static customerRegister(): Promise<void>;
+    static customerLogin(): Promise<void>;
+    static customerVisit(): Promise<void>;
+    static viewBrand(brand: IkasBrand): Promise<void>;
+    static viewCategory(category: IkasCategory): Promise<void>;
+}
+export {};

package/build/api/back-in-stock-reminder/__generated__/listProductBackInStockRemind.d.ts

@@ -0,0 +1,24 @@
+import { StringFilterInput, DateFilterInput } from "../../../__generated__/global-types";
+export interface listProductBackInStockRemind_listProductBackInStockRemind {
+    __typename: "ProductBackInStockRemind";
+    createdAt: any | null;
+    customerId: string;
+    deleted: boolean | null;
+    email: string;
+    id: string;
+    productId: string;
+    storefrontId: string;
+    updatedAt: any | null;
+    variantId: string;
+}
+export interface listProductBackInStockRemind {
+    listProductBackInStockRemind: listProductBackInStockRemind_listProductBackInStockRemind[];
+}
+export interface listProductBackInStockRemindVariables {
+    id?: StringFilterInput | null;
+    updatedAt?: DateFilterInput | null;
+    includeDeleted?: boolean | null;
+    email?: StringFilterInput | null;
+    productId?: StringFilterInput | null;
+    variantId?: StringFilterInput | null;
+}

package/build/api/back-in-stock-reminder/__generated__/saveProductBackInStockRemind.d.ts

@@ -0,0 +1,19 @@
+import { ProductBackInStockRemindInput } from "../../../__generated__/global-types";
+export interface saveProductBackInStockRemind_saveProductBackInStockRemind {
+    __typename: "ProductBackInStockRemind";
+    createdAt: any | null;
+    customerId: string;
+    deleted: boolean | null;
+    email: string;
+    id: string;
+    productId: string;
+    storefrontId: string;
+    updatedAt: any | null;
+    variantId: string;
+}
+export interface saveProductBackInStockRemind {
+    saveProductBackInStockRemind: saveProductBackInStockRemind_saveProductBackInStockRemind;
+}
+export interface saveProductBackInStockRemindVariables {
+    input: ProductBackInStockRemindInput;
+}

package/build/api/back-in-stock-reminder/index.d.ts

@@ -0,0 +1,23 @@
+import * as ListProductBackInStockRemindTypes from "./__generated__/listProductBackInStockRemind";
+import * as SaveProductBackInStockRemindTypes from "./__generated__/saveProductBackInStockRemind";
+import { DateFilterInput, StringFilterInput } from "../../__generated__/global-types";
+export declare class IkasProductBackInStockReminderAPI {
+    static list(listParams: ListParams): Promise<{
+        data: ListProductBackInStockRemindTypes.listProductBackInStockRemind_listProductBackInStockRemind[];
+    } | undefined>;
+    static save(input: ProductBackInStockRemindInput): Promise<SaveProductBackInStockRemindTypes.saveProductBackInStockRemind_saveProductBackInStockRemind | undefined>;
+}
+export declare type ProductBackInStockRemindInput = {
+    email: string;
+    productId: string;
+    variantId: string;
+};
+declare type ListParams = {
+    email?: string;
+    id?: StringFilterInput;
+    includeDeleted?: boolean;
+    productId?: string;
+    updatedAt?: DateFilterInput;
+    variantId?: string;
+};
+export {};

package/build/api/checkout/__generated__/getCheckoutById.d.ts

@@ -18,8 +18,6 @@ export interface getCheckoutById_getCheckoutById_billingAddress_country {
     code: string | null;
     id: string | null;
     name: string;
-    iso2: string | null;
-    iso3: string | null;
 }
 export interface getCheckoutById_getCheckoutById_billingAddress_district {
     __typename: "OrderAddressDistrict";
@@ -71,8 +69,6 @@ export interface getCheckoutById_getCheckoutById_shippingAddress_country {
     id: string | null;
     code: string | null;
     name: string;
-    iso2: string | null;
-    iso3: string | null;
 }
 export interface getCheckoutById_getCheckoutById_shippingAddress_district {
     __typename: "OrderAddressDistrict";

package/build/api/checkout/__generated__/listPaymentGateway.d.ts

@@ -14,7 +14,7 @@ export interface listPaymentGateway_listPaymentGateway_additionalPrices {
 export interface listPaymentGateway_listPaymentGateway_translations {
     __typename: "PaymentGatewayTranslation";
     description: string | null;
-    locale: string | null;
+    locale: string;
     name: string | null;
 }
 export interface listPaymentGateway_listPaymentGateway {
@@ -30,8 +30,6 @@ export interface listPaymentGateway_listPaymentGateway {
     logoUrl: string | null;
     additionalPrices: listPaymentGateway_listPaymentGateway_additionalPrices[] | null;
     translations: listPaymentGateway_listPaymentGateway_translations[] | null;
-    supportedCurrencies: string[] | null;
-    availableCountries: string[] | null;
 }
 export interface listPaymentGateway {
     listPaymentGateway: listPaymentGateway_listPaymentGateway[];

package/build/api/customer/__generated__/customerForgotPassword.d.ts

@@ -3,5 +3,4 @@ export interface customerForgotPassword {
 }
 export interface customerForgotPasswordVariables {
     email: string;
-    locale: string;
 }

package/build/api/customer/__generated__/registerCustomer.d.ts

@@ -68,5 +68,4 @@ export interface registerCustomerVariables {
     firstName: string;
     lastName: string;
     isAcceptMarketing?: boolean | null;
-    locale?: string | null;
 }

package/build/api/customer-review/__generated__/createCustomerReview.d.ts

@@ -0,0 +1,11 @@
+import { CreateCustomerReviewInput } from "../../../__generated__/global-types";
+export interface createCustomerReview_createCustomerReview {
+    __typename: "CustomerReview";
+    id: string;
+}
+export interface createCustomerReview {
+    createCustomerReview: createCustomerReview_createCustomerReview;
+}
+export interface createCustomerReviewVariables {
+    input: CreateCustomerReviewInput;
+}

package/build/api/customer-review/__generated__/listCustomerReviews.d.ts

@@ -0,0 +1,25 @@
+import { ListCustomerReviewInput, PaginationInput } from "../../../__generated__/global-types";
+export interface listCustomerReviews_listCustomerReviews_data {
+    __typename: "CustomerReview";
+    comment: string | null;
+    createdAt: any | null;
+    id: string;
+    star: number;
+    title: string | null;
+}
+export interface listCustomerReviews_listCustomerReviews {
+    __typename: "CustomerReviewSFPaginationResponse";
+    count: number;
+    data: listCustomerReviews_listCustomerReviews_data[];
+    hasNext: boolean;
+    limit: number;
+    page: number;
+}
+export interface listCustomerReviews {
+    listCustomerReviews: listCustomerReviews_listCustomerReviews;
+}
+export interface listCustomerReviewsVariables {
+    input: ListCustomerReviewInput;
+    productId?: string | null;
+    pagination?: PaginationInput | null;
+}

package/build/api/customer-review/index.d.ts

@@ -0,0 +1,24 @@
+import { IkasCustomerReview } from "../../models/index";
+import * as CreateCustomerReviewTypes from "./__generated__/createCustomerReview";
+export declare class IkasCustomerReviewAPI {
+    static listCustomerReviews(params: ListCustomerReviewInput): Promise<{
+        data: IkasCustomerReview[];
+        count: number;
+    }>;
+    static createCustomerReview(params: CreateCustomerReviewInput): Promise<false | CreateCustomerReviewTypes.createCustomerReview_createCustomerReview | undefined>;
+}
+declare type ListCustomerReviewInput = {
+    productId?: string;
+    salesChannelId: string;
+    page?: number;
+    limit?: number;
+};
+declare type CreateCustomerReviewInput = {
+    comment?: string;
+    customerId?: string;
+    productId: string;
+    salesChannelId: string;
+    star: number;
+    title?: string;
+};
+export {};

package/build/api/index.d.ts

@@ -6,6 +6,7 @@ export { IkasCheckoutAPI } from "./checkout/index";
 export { IkasCityAPI } from "./city/index";
 export { IkasCountryAPI } from "./country/index";
 export { IkasCustomerAPI } from "./customer/index";
+export { IkasCustomerReviewAPI } from "./customer-review/index";
 export { IkasDistrictAPI } from "./district/index";
 export { IkasHTMLMetaDataAPI } from "./html-meta-data/index";
 export { IkasMerchantAPI } from "./merchant/index";
@@ -15,4 +16,6 @@ export { IkasFavoriteProductAPI } from "./favorite-product/index";
 export { IkasContactFormAPI } from "./contact-form/index";
 export { IkasStateAPI } from "./state/index";
 export { IkasVariantTypeAPI } from "./variant-type/index";
+export { IkasProductOptionSetAPI } from "./product-option-set/index";
+export { IkasProductBackInStockReminderAPI } from "./back-in-stock-reminder/index";
 export { apollo } from "./apollo";

package/build/api/merchant/__generated__/listMerchantSettings.d.ts

@@ -1,4 +1,3 @@
-import { StringFilterInput } from "../../../__generated__/global-types";
 export interface listMerchantSettings_listMerchantSettings {
     __typename: "MerchantSettings";
     id: string;
@@ -8,6 +7,3 @@ export interface listMerchantSettings_listMerchantSettings {
 export interface listMerchantSettings {
     listMerchantSettings: listMerchantSettings_listMerchantSettings[];
 }
-export interface listMerchantSettingsVariables {
-    merchantId: StringFilterInput;
-}

package/build/api/merchant/index.d.ts

@@ -1,4 +1,4 @@
 import { IkasMerchantSettings } from "../../models/index";
 export declare class IkasMerchantAPI {
-    static listMerchantSettings(merchantId: string): Promise<IkasMerchantSettings | undefined>;
+    static listMerchantSettings(): Promise<IkasMerchantSettings | undefined>;
 }

package/build/api/product-option-set/__generated__/ListProductOptionSet.d.ts

@@ -0,0 +1,90 @@
+import { StringFilterInput, DateFilterInput, ProductOptionSelectTypeEnum, ProductOptionTypeEnum } from "../../../__generated__/global-types";
+export interface ListProductOptionSet_listProductOptionSet_options_dateSettings {
+    __typename: "ProductOptionDateSettings";
+    max: any | null;
+    min: any | null;
+}
+export interface ListProductOptionSet_listProductOptionSet_options_fileSettings {
+    __typename: "ProductOptionFileSettings";
+    allowedExtensions: string[] | null;
+    maxQuantity: number | null;
+    minQuantity: number | null;
+}
+export interface ListProductOptionSet_listProductOptionSet_options_selectSettings_values {
+    __typename: "ProductOptionSelectValue";
+    createdAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    order: number;
+    price: number | null;
+    updatedAt: any | null;
+    value: string;
+    thumbnailImageId: string | null;
+    colorCode: string | null;
+}
+export interface ListProductOptionSet_listProductOptionSet_options_selectSettings {
+    __typename: "ProductOptionSelectSettings";
+    maxSelect: number | null;
+    minSelect: number | null;
+    type: ProductOptionSelectTypeEnum;
+    values: ListProductOptionSet_listProductOptionSet_options_selectSettings_values[];
+}
+export interface ListProductOptionSet_listProductOptionSet_options_textSettings {
+    __typename: "ProductOptionTextSettings";
+    max: number | null;
+    min: number | null;
+}
+export interface ListProductOptionSet_listProductOptionSet_options {
+    __typename: "ProductOption";
+    createdAt: any | null;
+    dateSettings: ListProductOptionSet_listProductOptionSet_options_dateSettings | null;
+    deleted: boolean | null;
+    fileSettings: ListProductOptionSet_listProductOptionSet_options_fileSettings | null;
+    id: string;
+    isOptional: boolean | null;
+    name: string;
+    optionalText: string | null;
+    requiredOptionId: string | null;
+    requiredOptionValueIds: string[] | null;
+    order: number;
+    price: number | null;
+    selectSettings: ListProductOptionSet_listProductOptionSet_options_selectSettings | null;
+    textSettings: ListProductOptionSet_listProductOptionSet_options_textSettings | null;
+    type: ProductOptionTypeEnum;
+    updatedAt: any | null;
+}
+export interface ListProductOptionSet_listProductOptionSet_translations_options_values {
+    __typename: "ProductOptionSelectValueTranslations";
+    id: string;
+    value: string | null;
+}
+export interface ListProductOptionSet_listProductOptionSet_translations_options {
+    __typename: "ProductOptionTranslations";
+    id: string;
+    name: string | null;
+    optionalText: string | null;
+    values: ListProductOptionSet_listProductOptionSet_translations_options_values[] | null;
+}
+export interface ListProductOptionSet_listProductOptionSet_translations {
+    __typename: "ProductOptionSetTranslations";
+    locale: string;
+    options: ListProductOptionSet_listProductOptionSet_translations_options[] | null;
+}
+export interface ListProductOptionSet_listProductOptionSet {
+    __typename: "ProductOptionSet";
+    createdAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    name: string;
+    options: ListProductOptionSet_listProductOptionSet_options[];
+    translations: ListProductOptionSet_listProductOptionSet_translations[] | null;
+    updatedAt: any | null;
+}
+export interface ListProductOptionSet {
+    listProductOptionSet: ListProductOptionSet_listProductOptionSet[];
+}
+export interface ListProductOptionSetVariables {
+    id: StringFilterInput;
+    updatedAt?: DateFilterInput | null;
+    includeDeleted: boolean;
+}

package/build/api/product-option-set/index.d.ts

@@ -0,0 +1,6 @@
+import { IkasProductOptionSet } from "../../models/data/product-option-set/index";
+export declare class IkasProductOptionSetAPI {
+    static list(searchId: string, updatedAt?: number, includeDeleted?: boolean): Promise<{
+        data: IkasProductOptionSet[];
+    } | undefined>;
+}

package/build/components/page/index.d.ts

@@ -12,6 +12,7 @@ export declare type IkasPageProps = {
     configJson: Record<string, any>;
     reInitOnBrowser?: boolean;
     addOgpMetas?: boolean;
+    components?: Record<string, any>;
 };
 export declare const IkasPage: React.FC<IkasPageProps>;
 export declare const renderComponent: (pageComponentPropValue: IkasPageComponentPropValue, settings: IkasThemeSettings, index: number) => JSX.Element;