@ikas/storefront 0.2.0-alpha.4 → 0.2.0-alpha.6

package/build/esm/analytics/googleTagManager.d.ts

@@ -0,0 +1,201 @@
+import { IkasProductDetail, IkasOrderLineItem, IkasCheckout, IkasCategory } from "../models/index";
+import { CheckoutStep } from "../components/checkout/model";
+export declare class GoogleTagManager {
+    constructor();
+    static pageView(url: string): {
+        event: string;
+        page: string;
+    } | undefined;
+    static productView(productDetail: IkasProductDetail): {
+        event: string;
+        ecommerce: {
+            items: {
+                item_name: string;
+                item_id: string;
+                price: number;
+                item_brand: string;
+                item_category: string;
+                item_category_2: string;
+                item_category_3: string;
+                item_category_4: string;
+                item_variant: string;
+                item_list_name: string;
+                item_list_id: string;
+                index: number;
+                quantity: number;
+            }[];
+            extraParams: {
+                parent_id: string;
+                currency: string;
+                url: string;
+                item_image: string;
+            };
+        };
+    } | undefined;
+    static addToCart(item: IkasProductDetail | IkasOrderLineItem, quantity: number): {
+        event: string;
+        ecommerce: {
+            items: ({
+                item_name: string;
+                item_id: string;
+                price: number;
+                item_brand: string;
+                item_category: string;
+                item_category_2: string;
+                item_category_3: string;
+                item_category_4: string;
+                item_variant: string;
+                item_list_name: string;
+                item_list_id: string;
+                index: number;
+                quantity: number;
+            } | {
+                item_name: string;
+                item_id: string;
+                price: string;
+                item_brand: string;
+                item_category: string;
+                item_category_2: string;
+                item_category_3: string;
+                item_category_4: string;
+                item_variant: string;
+                item_list_name: string;
+                item_list_id: string;
+                index: number;
+                quantity: number;
+            })[];
+        };
+    } | undefined;
+    static removeFromCart(item: IkasProductDetail | IkasOrderLineItem, quantity: number): {
+        event: string;
+        ecommerce: {
+            items: ({
+                item_name: string;
+                item_id: string;
+                price: number;
+                item_brand: string;
+                item_category: string;
+                item_category_2: string;
+                item_category_3: string;
+                item_category_4: string;
+                item_variant: string;
+                item_list_name: string;
+                item_list_id: string;
+                index: number;
+                quantity: number;
+            } | {
+                item_name: string;
+                item_id: string;
+                price: string;
+                item_brand: string;
+                item_category: string;
+                item_category_2: string;
+                item_category_3: string;
+                item_category_4: string;
+                item_variant: string;
+                item_list_name: string;
+                item_list_id: string;
+                index: number;
+                quantity: number;
+            })[];
+        };
+    } | undefined;
+    static beginCheckout(checkout: IkasCheckout): {
+        event: string;
+        ecommerce: {
+            items: {
+                item_name: string;
+                item_id: string;
+                price: string;
+                item_brand: string;
+                item_category: string;
+                item_category_2: string;
+                item_category_3: string;
+                item_category_4: string;
+                item_variant: string;
+                item_list_name: string;
+                item_list_id: string;
+                index: number;
+                quantity: number;
+            }[] | undefined;
+        };
+    } | undefined;
+    static purchase(checkout: IkasCheckout, orderId: string): {
+        event: string;
+        ecommerce: {
+            purchase: {
+                transaction_id: string;
+                affiliation: string;
+                value: string;
+                tax: string;
+                shipping: string;
+                currency: string | undefined;
+                coupon: string | null | undefined;
+                items: {
+                    item_name: string;
+                    item_id: string;
+                    price: string;
+                    item_brand: string;
+                    item_category: string;
+                    item_category_2: string;
+                    item_category_3: string;
+                    item_category_4: string;
+                    item_variant: string;
+                    item_list_name: string;
+                    item_list_id: string;
+                    index: number;
+                    quantity: number;
+                }[] | undefined;
+            };
+        };
+    } | undefined;
+    static checkoutStep(checkout: IkasCheckout, step: CheckoutStep): {
+        event: string;
+        ecommerce: {
+            items: {
+                item_name: string;
+                item_id: string;
+                price: string;
+                item_brand: string;
+                item_category: string;
+                item_category_2: string;
+                item_category_3: string;
+                item_category_4: string;
+                item_variant: string;
+                item_list_name: string;
+                item_list_id: string;
+                index: number;
+                quantity: number;
+            }[] | undefined;
+        };
+    } | undefined;
+    static disableHTML(): void;
+    static completeRegistration(): {
+        event: string;
+    } | undefined;
+    static search(searchKeyword: string): {
+        event: string;
+        search_string: string;
+    } | undefined;
+    static viewCategory(category: IkasCategory, categoryPath: string): {
+        event: string;
+        ecommerce: {
+            category: {
+                id: string;
+                name: string;
+                metaData: import("../models/index").IkasHTMLMetaData | null | undefined;
+                href: string;
+                image: import("../models/index").IkasImage | null | undefined;
+                path: string;
+            }[];
+        };
+    } | undefined;
+    static customerLogin(email: string): {
+        event: string;
+        email: string;
+    } | undefined;
+    static customerVisit(email: string): {
+        event: string;
+        email: string;
+    } | undefined;
+}

package/build/esm/analytics/head/index.d.ts

@@ -0,0 +1,7 @@
+import * as React from "react";
+declare type HeadProps = {
+    blockHTML?: boolean;
+};
+export declare const AnalyticsHead: React.FC<HeadProps>;
+export declare const AnalyticsBody: React.FC;
+export {};

package/build/esm/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/esm/analytics/index.d.ts

@@ -0,0 +1,2 @@
+export { Analytics } from "./analytics";
+export * from "./head/index";

package/build/esm/analytics.js

@@ -0,0 +1 @@
+export{ag as Analytics}from"./index-05282f31.js";export{a as AnalyticsBody,A as AnalyticsHead}from"./index-d26b7878.js";import"./get-41aa8e36.js";import"./storefront.js";import"mobx";import"react";

package/build/esm/api/apollo.d.ts

@@ -0,0 +1,10 @@
+import { ApolloClient, NormalizedCacheObject } from "@apollo/client";
+declare class Apollo {
+    private _client?;
+    static customerToken?: string;
+    createApolloClient: (apiKey?: string | undefined) => void;
+    setCustomerToken: (customerToken?: string | undefined) => void;
+    getClient: () => ApolloClient<NormalizedCacheObject>;
+}
+export declare const apollo: Apollo;
+export {};

package/build/esm/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/esm/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/esm/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/esm/api/blog/__generated__/getBlog.d.ts

@@ -0,0 +1,83 @@
+import { StringFilterInput, PaginationInput, BlogMetadataTargetTypeEnum } from "../../../__generated__/global-types";
+export interface getBlog_listBlog_data_blogContent {
+    __typename: "BlogContent";
+    content: string;
+    createdAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    updatedAt: any | null;
+}
+export interface getBlog_listBlog_data_category_metadata {
+    __typename: "BlogMetadata";
+    createdAt: any | null;
+    deleted: boolean | null;
+    description: string | null;
+    id: string;
+    pageTitle: string | null;
+    slug: string;
+    targetId: string | null;
+    targetType: BlogMetadataTargetTypeEnum | null;
+    updatedAt: any | null;
+}
+export interface getBlog_listBlog_data_category {
+    __typename: "BlogCategory";
+    createdAt: any | null;
+    updatedAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    name: string;
+    imageId: string;
+    metadata: getBlog_listBlog_data_category_metadata;
+}
+export interface getBlog_listBlog_data_metadata {
+    __typename: "BlogMetadata";
+    createdAt: any | null;
+    deleted: boolean | null;
+    description: string | null;
+    id: string;
+    pageTitle: string | null;
+    slug: string;
+    targetId: string | null;
+    targetType: BlogMetadataTargetTypeEnum | null;
+    updatedAt: any | null;
+}
+export interface getBlog_listBlog_data_writer {
+    __typename: "BlogWriter";
+    firstName: string;
+    lastName: string;
+}
+export interface getBlog_listBlog_data {
+    __typename: "Blog";
+    title: string;
+    blogContent: getBlog_listBlog_data_blogContent;
+    categoryId: string;
+    category: getBlog_listBlog_data_category;
+    createdAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    imageId: string;
+    isPublished: boolean;
+    metadata: getBlog_listBlog_data_metadata;
+    writer: getBlog_listBlog_data_writer;
+    publishedAt: any | null;
+    shortDescription: string;
+    storefrontId: string;
+    tagIds: string[] | null;
+    updatedAt: any | null;
+}
+export interface getBlog_listBlog {
+    __typename: "BlogPaginationResponse";
+    count: number;
+    data: getBlog_listBlog_data[];
+    hasNext: boolean;
+    limit: number;
+    page: number;
+}
+export interface getBlog {
+    listBlog: getBlog_listBlog;
+}
+export interface getBlogVariables {
+    id?: StringFilterInput | null;
+    pagination?: PaginationInput | null;
+    storefrontId?: StringFilterInput | null;
+}

package/build/esm/api/blog/__generated__/listBlog.d.ts

@@ -0,0 +1,86 @@
+import { StringFilterInput, PaginationInput, BlogMetadataTargetTypeEnum } from "../../../__generated__/global-types";
+export interface listBlog_listBlog_data_category_metadata {
+    __typename: "BlogMetadata";
+    createdAt: any | null;
+    deleted: boolean | null;
+    description: string | null;
+    id: string;
+    pageTitle: string | null;
+    slug: string;
+    targetId: string | null;
+    targetType: BlogMetadataTargetTypeEnum | null;
+    updatedAt: any | null;
+}
+export interface listBlog_listBlog_data_category {
+    __typename: "BlogCategory";
+    createdAt: any | null;
+    updatedAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    name: string;
+    imageId: string;
+    metadata: listBlog_listBlog_data_category_metadata;
+}
+export interface listBlog_listBlog_data_tags {
+    __typename: "BlogTag";
+    createdAt: any | null;
+    id: string;
+    name: string;
+    deleted: boolean | null;
+    updatedAt: any | null;
+}
+export interface listBlog_listBlog_data_metadata {
+    __typename: "BlogMetadata";
+    createdAt: any | null;
+    deleted: boolean | null;
+    description: string | null;
+    id: string;
+    pageTitle: string | null;
+    slug: string;
+    targetId: string | null;
+    targetType: BlogMetadataTargetTypeEnum | null;
+    updatedAt: any | null;
+}
+export interface listBlog_listBlog_data_writer {
+    __typename: "BlogWriter";
+    firstName: string;
+    lastName: string;
+}
+export interface listBlog_listBlog_data {
+    __typename: "Blog";
+    title: string;
+    categoryId: string;
+    category: listBlog_listBlog_data_category;
+    tags: listBlog_listBlog_data_tags[] | null;
+    createdAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    imageId: string;
+    isPublished: boolean;
+    metadata: listBlog_listBlog_data_metadata;
+    writer: listBlog_listBlog_data_writer;
+    publishedAt: any | null;
+    shortDescription: string;
+    storefrontId: string;
+    tagIds: string[] | null;
+    updatedAt: any | null;
+}
+export interface listBlog_listBlog {
+    __typename: "BlogPaginationResponse";
+    count: number;
+    data: listBlog_listBlog_data[];
+    hasNext: boolean;
+    limit: number;
+    page: number;
+}
+export interface listBlog {
+    listBlog: listBlog_listBlog;
+}
+export interface listBlogVariables {
+    id?: StringFilterInput | null;
+    categoryId?: StringFilterInput | null;
+    pagination?: PaginationInput | null;
+    storefrontId?: StringFilterInput | null;
+    tagId?: StringFilterInput | null;
+    search?: string | null;
+}

package/build/esm/api/blog/__generated__/listBlogCategory.d.ts

@@ -0,0 +1,38 @@
+import { StringFilterInput, PaginationInput, BlogMetadataTargetTypeEnum } from "../../../__generated__/global-types";
+export interface listBlogCategory_listBlogCategory_data_metadata {
+    __typename: "BlogMetadata";
+    createdAt: any | null;
+    deleted: boolean | null;
+    description: string | null;
+    id: string;
+    pageTitle: string | null;
+    slug: string;
+    targetId: string | null;
+    targetType: BlogMetadataTargetTypeEnum | null;
+    updatedAt: any | null;
+}
+export interface listBlogCategory_listBlogCategory_data {
+    __typename: "BlogCategory";
+    createdAt: any | null;
+    deleted: boolean | null;
+    id: string;
+    imageId: string;
+    metadata: listBlogCategory_listBlogCategory_data_metadata;
+    name: string;
+    updatedAt: any | null;
+}
+export interface listBlogCategory_listBlogCategory {
+    __typename: "BlogCategoryPaginationResponse";
+    count: number;
+    data: listBlogCategory_listBlogCategory_data[];
+    hasNext: boolean;
+    limit: number;
+    page: number;
+}
+export interface listBlogCategory {
+    listBlogCategory: listBlogCategory_listBlogCategory;
+}
+export interface listBlogCategoryVariables {
+    id?: StringFilterInput | null;
+    pagination?: PaginationInput | null;
+}

package/build/esm/api/blog/__generated__/listBlogMetaData.d.ts

@@ -0,0 +1,29 @@
+import { StringFilterInput, BlogMetadataTargetTypeEnumFilter, BlogMetadataTargetTypeEnum } from "../../../__generated__/global-types";
+export interface listBlogMetaData_listBlogMetadata_data {
+    __typename: "BlogMetadata";
+    createdAt: any | null;
+    deleted: boolean | null;
+    description: string | null;
+    id: string;
+    pageTitle: string | null;
+    slug: string;
+    targetId: string | null;
+    targetType: BlogMetadataTargetTypeEnum | null;
+    updatedAt: any | null;
+}
+export interface listBlogMetaData_listBlogMetadata {
+    __typename: "BlogMetadataPaginationResponse";
+    count: number;
+    data: listBlogMetaData_listBlogMetadata_data[];
+    hasNext: boolean;
+    limit: number;
+    page: number;
+}
+export interface listBlogMetaData {
+    listBlogMetadata: listBlogMetaData_listBlogMetadata;
+}
+export interface listBlogMetaDataVariables {
+    slug?: StringFilterInput | null;
+    targetId?: StringFilterInput | null;
+    targetType?: BlogMetadataTargetTypeEnumFilter | null;
+}