@ikas/storefront 0.2.0-alpha.3 → 0.2.0-alpha.5

package/build/models/data/customer-review/index.d.ts

@@ -0,0 +1,23 @@
+export declare class IkasCustomerReview {
+    comment: string;
+    createdAt: string;
+    customerId: string;
+    deleted: boolean;
+    id: string;
+    orderId: string;
+    orderNumber: string;
+    productId: string;
+    salesChannelId: string;
+    star: number;
+    status: CustomerReviewStatusEnum;
+    storefrontId: string;
+    title: string;
+    updatedAt: string;
+    constructor(data: Partial<IkasCustomerReview>);
+}
+declare enum CustomerReviewStatusEnum {
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    WAITING = "WAITING"
+}
+export {};

package/build/models/data/customer-review-settings/index.d.ts

@@ -0,0 +1,4 @@
+export declare type IkasCustomerReviewSettings = {
+    customerLoginRequired: boolean;
+    customerPurchaseRequired: boolean;
+};

package/build/models/data/index.d.ts

@@ -5,6 +5,8 @@ export * from "./checkout/index";
 export type { IkasCity } from "./city/index";
 export * from "./customer/address/index";
 export { IkasCustomer } from "./customer/index";
+export { IkasCustomerReview } from "./customer-review/index";
+export type { IkasCustomerReviewSettings } from "./customer-review-settings/index";
 export type { IkasCountry } from "./country/index";
 export type { IkasDistrict } from "./district/index";
 export { IkasHTMLMetaData, IkasHTMLMetaDataTargetType } from "./html-meta-data/index";

package/build/models/data/order/address/index.d.ts

@@ -29,6 +29,8 @@ declare type IkasOrderAddressLocation = {
     id?: string;
     name?: string;
     code?: string;
+    iso2?: string;
+    iso3?: string;
 };
 export declare type IkasOrderAddressCountry = IkasOrderAddressLocation;
 export declare type IkasOrderAddressCity = IkasOrderAddressLocation;

package/build/models/data/payment-gateway/index.d.ts

@@ -11,6 +11,8 @@ export declare class IkasPaymentGateway {
     description: string | null;
     additionalPrices: IkasPaymentGatewayAdditionalPrice[] | null;
     translations: IkasPaymentGatewayTranslation[] | null;
+    supportedCurrencies: string[];
+    availableCountries: string[];
     constructor(data: Partial<IkasPaymentGateway>);
     getCalculatedAdditionalPrices(totalFinalPrice: number, shippingLines: IkasOrderShippingLine[] | null): {
         name: string;

package/build/models/data/product/index.d.ts

@@ -23,6 +23,7 @@ export declare class IkasProduct {
     productOptionSet?: IkasProductOptionSet | null;
     constructor(data?: Partial<IkasProduct>);
     get hasVariant(): boolean;
+    get hasStock(): boolean;
     get mainVariantType(): import("../index").IkasVariantType | undefined;
     get href(): string;
 }

package/build/models/data/product/variant/index.d.ts

@@ -12,6 +12,13 @@ export declare class IkasProductVariant {
     price: IkasProductPrice;
     stock: number;
     isActive: boolean;
+    productId: string;
+    private _backInStockReminderSaved;
     constructor(data?: Partial<IkasProductVariant>);
     get mainImage(): IkasImage | undefined;
+    get hasStock(): boolean;
+    get isBackInStockEnabled(): boolean;
+    get isBackInStockCustomerLoginRequired(): boolean | null;
+    get isBackInStockReminderSaved(): boolean;
+    saveBackInStockReminder(email: string): Promise<boolean>;
 }

package/build/models/data/product-back-in-stock-settings/index.d.ts

@@ -0,0 +1,3 @@
+export declare type IkasProductBackInStockSettings = {
+    customerLoginRequired: boolean;
+};

package/build/models/ui/customer-review-list/index.d.ts

@@ -0,0 +1,43 @@
+import { IkasCustomerReview } from "../../data/customer-review/index";
+export declare class IkasCustomerReviewList {
+    data: IkasCustomerReview[];
+    private _limit;
+    private _page;
+    private _count;
+    private _initialized;
+    private _minPage?;
+    private _productId;
+    private _isLoading;
+    constructor(data: IkasCustomerReviewListParams);
+    get limit(): number;
+    get page(): number;
+    get count(): number;
+    get pageCount(): number;
+    get isInitialized(): boolean;
+    get hasPrev(): boolean;
+    get hasNext(): boolean;
+    get isLoading(): boolean;
+    private listCustomerReviews;
+    private getInitial;
+    getPrev: () => Promise<void>;
+    getNext: () => Promise<void>;
+    getPage: (page: number) => Promise<void>;
+    toJSON(): {
+        data: IkasCustomerReview[];
+        limit: number;
+        page: number;
+        count: number;
+        initialized: boolean;
+        minPage: number | null | undefined;
+        productId: string;
+    };
+}
+export declare type IkasCustomerReviewListParams = {
+    data?: IkasCustomerReview[];
+    limit?: number;
+    page?: number;
+    count?: number;
+    initialized?: boolean;
+    minPage?: number;
+    productId: string;
+};

package/build/models/ui/index.d.ts

@@ -8,6 +8,7 @@ export { IkasProductDetail, IkasDisplayedVariantType, IkasDisplayedVariantValue,
 export { IkasProductList, IkasProductListType, IkasProductListSortType, } from "./product-list/index";
 export * from "./product-attribute-detail/index";
 export * from "./product-attribute-list/index";
+export * from "./customer-review-list/index";
 export { Validator, ValidationStatus } from "./validator/index";
 export * from "./validator/rules/index";
 export { LoginForm } from "./validator/form/login";
@@ -17,4 +18,5 @@ export { ContactForm } from "./validator/form/contact-form";
 export { ForgotPasswordForm } from "./validator/form/forgot-password";
 export { RecoverPasswordForm } from "./validator/form/recover-password";
 export { AccountInfoForm } from "./validator/form/account-info";
+export { CustomerReviewForm } from "./validator/form/customer-review";
 export * from "./component-renderer/index";

package/build/models/ui/product-detail/index.d.ts

@@ -1,4 +1,4 @@
-import { IkasProduct, IkasVariantValue } from "../../index";
+import { IkasProduct, IkasVariantValue, IkasCustomerReviewList } from "../../index";
 import { NextRouter } from "next/router";
 import { IkasProductVariant, IkasVariantType } from "../../data/index";
 export declare class IkasProductDetail {
@@ -11,6 +11,9 @@ export declare class IkasProductDetail {
     get href(): string;
     get hasStock(): boolean;
     get displayedVariantTypes(): IkasDisplayedVariantType[];
+    get isCustomerReviewEnabled(): boolean;
+    get isCustomerReviewLoginRequired(): boolean;
+    getCustomerReviews(): Promise<IkasCustomerReviewList>;
     selectVariantValue(variantValue: IkasVariantValue): void;
 }
 export declare type IkasDisplayedVariantValue = {

package/build/models/ui/validator/form/customer-review.d.ts

@@ -0,0 +1,37 @@
+import { IkasBaseStore } from "../../../../store/index";
+declare type CustomerReviewFormProps<T> = {
+    productId: string;
+    message: {
+        starRule: ((model: T) => string) | string;
+    };
+    store: IkasBaseStore;
+};
+declare type CustomerReviewFormModel = {
+    title: string;
+    comment: string;
+    star: number;
+};
+export declare class CustomerReviewForm {
+    private productId;
+    private model;
+    private validator;
+    private store;
+    constructor(props: CustomerReviewFormProps<CustomerReviewFormModel>);
+    get title(): string;
+    set title(value: string);
+    get comment(): string;
+    set comment(value: string);
+    get star(): number;
+    set star(value: number);
+    get hasError(): boolean;
+    get starErrorMessage(): string | undefined;
+    onTitleChange: (value: string) => void;
+    onCommentChange: (value: string) => void;
+    onStarChange: (value: number) => void;
+    validateAll(): Promise<boolean>;
+    submit(): Promise<{
+        isFormError: boolean;
+        isSuccess: boolean;
+    }>;
+}
+export {};

package/build/providers/page-data-get.d.ts

@@ -35,6 +35,8 @@ export declare class IkasPageDataProvider {
                 stockPreference: import("../models/theme/settings/index").IkasThemeStockPreference;
                 storefrontJSScripts: string[];
                 translations: Record<string, any>;
+                customerReviewSettings: import("../models/index").IkasCustomerReviewSettings | null;
+                productBackInStockSettings: any;
             };
         };
     };

package/build/providers/page-data-next.d.ts

@@ -1,16 +1,17 @@
 /// <reference types="node" />
 import { GetServerSidePropsContext, GetStaticPropsContext } from "next";
 import { ParsedUrlQuery } from "querystring";
-import { IkasTheme, IkasThemePageType } from "../models/index";
+import { IkasTheme, IkasThemePageType, IkasCustomerReviewSettings } from "../models/index";
 import { IkasStorefront } from "../models/data/storefront/index";
 import { IkasSalesChannel } from "../models/data/sales-channel/index";
 import { IkasStorefrontRouting } from "../models/data/storefront/routing/index";
 import { IkasStorefrontThemeLocalization } from "../models/data/storefront/theme-localization/index";
 import { IkasThemeFavicon } from "../models/theme/settings/prop/favicon/index";
 import { IkasThemeSettings, IkasThemeStockPreference } from "../models/theme/settings/index";
+import { IkasProductBackInStockSettings } from "../models/data/product-back-in-stock-settings/index";
 export declare class IkasNextPageDataProvider {
     static readLocalTheme(): Promise<IkasTheme>;
-    static readSettingsFile(): Promise<any>;
+    static readSettingsFile(): Promise<SettingsData | null>;
     static getSettings(locale: string): Promise<SettingsData | null>;
     static getPageData(context: GetStaticPropsContext<ParsedUrlQuery> | GetServerSidePropsContext<ParsedUrlQuery>, isServer: boolean, pageType?: IkasThemePageType, possiblePageTypes?: IkasThemePageType[], isEditor?: boolean): Promise<{
         props: {};
@@ -41,6 +42,8 @@ export declare class IkasNextPageDataProvider {
                 stockPreference: IkasThemeStockPreference;
                 storefrontJSScripts: string[];
                 translations: Record<string, any>;
+                customerReviewSettings: IkasCustomerReviewSettings | null;
+                productBackInStockSettings: any;
             };
         };
         notFound?: undefined;
@@ -70,6 +73,8 @@ export declare class IkasNextPageDataProvider {
                 stockPreference: IkasThemeStockPreference;
                 storefrontJSScripts: string[];
                 translations: Record<string, any>;
+                customerReviewSettings: IkasCustomerReviewSettings | null;
+                productBackInStockSettings: any;
             };
         };
         revalidate: number;
@@ -108,6 +113,8 @@ export declare class IkasNextPageDataProvider {
                 stockPreference: IkasThemeStockPreference;
                 storefrontJSScripts: string[];
                 translations: Record<string, any>;
+                customerReviewSettings: IkasCustomerReviewSettings | null;
+                productBackInStockSettings: any;
             };
         };
         notFound?: undefined;
@@ -137,6 +144,8 @@ export declare class IkasNextPageDataProvider {
                 stockPreference: IkasThemeStockPreference;
                 storefrontJSScripts: string[];
                 translations: Record<string, any>;
+                customerReviewSettings: IkasCustomerReviewSettings | null;
+                productBackInStockSettings: any;
             };
         };
         revalidate: number;
@@ -175,6 +184,8 @@ export declare class IkasNextPageDataProvider {
                 stockPreference: IkasThemeStockPreference;
                 storefrontJSScripts: string[];
                 translations: Record<string, any>;
+                customerReviewSettings: IkasCustomerReviewSettings | null;
+                productBackInStockSettings: any;
             };
         };
         notFound?: undefined;
@@ -204,6 +215,8 @@ export declare class IkasNextPageDataProvider {
                 stockPreference: IkasThemeStockPreference;
                 storefrontJSScripts: string[];
                 translations: Record<string, any>;
+                customerReviewSettings: IkasCustomerReviewSettings | null;
+                productBackInStockSettings: any;
             };
         };
         revalidate: number;
@@ -220,8 +233,11 @@ export declare type SettingsData = {
     themeLocalization: IkasStorefrontThemeLocalization;
     salesChannel: IkasSalesChannel;
     routing: IkasStorefrontRouting;
+    localizationMap?: Record<string, any>;
     favicon: IkasThemeFavicon;
     stockPreference: IkasThemeStockPreference;
     storefrontJSScripts: string[];
     domain: string;
+    productBackInStockSettings: IkasProductBackInStockSettings | null;
+    customerReviewSettings: IkasCustomerReviewSettings | null;
 };

package/build/store/customer.d.ts

@@ -36,6 +36,7 @@ export declare class IkasCustomerStore {
     removeItemFromFavorite: (productId: string) => Promise<boolean>;
     isProductFavorite: (productId: string) => Promise<boolean>;
     createEmailSubscription: (email: string) => Promise<boolean>;
+    sendReview: (input: IkasCustomerReviewForm) => Promise<false | import("../api/customer-review/__generated__/createCustomerReview").createCustomerReview_createCustomerReview | undefined>;
     onCustomerConsentGrant: () => void;
     waitUntilInitialized: () => Promise<unknown>;
     private init;
@@ -63,3 +64,9 @@ export declare type IkasContactForm = {
     email: string;
     message: string;
 };
+export declare type IkasCustomerReviewForm = {
+    comment?: string;
+    productId: string;
+    star: number;
+    title?: string;
+};

package/build/storefront/index.d.ts

@@ -1,8 +1,10 @@
+import { IkasProductBackInStockSettings } from "../models/data/product-back-in-stock-settings/index";
 import { IkasSalesChannelPaymentGateway } from "../models/data/sales-channel/index";
 import { IkasStorefrontRouting } from "../models/data/storefront/routing/index";
 import { IkasThemeStockPreference } from "../models/theme/settings/index";
 import { IkasThemeFavicon } from "../models/theme/settings/prop/favicon/index";
 import { IkasBaseStore } from "../store/index";
+import { IkasCustomerReviewSettings } from "../models/index";
 export declare class IkasStorefrontConfig {
     static store: IkasBaseStore;
     static components: any;
@@ -24,6 +26,8 @@ export declare class IkasStorefrontConfig {
     static translations: Record<string, any>;
     static storefrontJSScripts: string[];
     static isEditor: boolean;
+    static customerReviewSettings: IkasCustomerReviewSettings | null;
+    static productBackInStockSettings: IkasProductBackInStockSettings | null;
     static init(store: IkasBaseStore, components: any, config: Record<string, any>, apiUrlOverride?: string): void;
     static initWithJson(json: Record<string, any>): void;
     static getCurrentLocale(): string;
@@ -43,5 +47,7 @@ export declare class IkasStorefrontConfig {
         stockPreference: IkasThemeStockPreference;
         storefrontJSScripts: string[];
         translations: Record<string, any>;
+        customerReviewSettings: IkasCustomerReviewSettings | null;
+        productBackInStockSettings: any;
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikas/storefront",
-  "version": "0.2.0-alpha.3",
+  "version": "0.2.0-alpha.5",
   "main": "./build/index.js",
   "module": "./build/index.es.js",
   "author": "Umut Ozan Yıldırım",