@ikas/storefront 1.0.16-alpha.1 → 1.0.16

package/build/store/base.d.ts

@@ -0,0 +1,25 @@
+import { IkasCartStore } from "./cart";
+import { IkasCustomerStore } from "./customer";
+import { IkasThemePageType } from "../models/index";
+import { IkasStorefrontRouting } from "../models/data/storefront/routing/index";
+export declare class IkasBaseStore {
+    readonly customerStore: IkasCustomerStore;
+    readonly cartStore: IkasCartStore;
+    currentPageType?: IkasThemePageType | null;
+    localeOptions: IkasLocaleOption[];
+    showLocaleOptions: boolean;
+    currentCountryCode?: string | null;
+    private localeChecked;
+    private settingsSet;
+    constructor();
+    checkLocalization(): Promise<void>;
+    setLocalization(localeOption: IkasLocaleOption): void;
+    private setSettings;
+}
+declare type IkasLocaleOption = {
+    readonly id: string;
+    readonly countryName?: string;
+    readonly routing: IkasStorefrontRouting;
+    readonly isRecommended: boolean;
+};
+export {};

package/build/store/cart.d.ts

@@ -0,0 +1,30 @@
+import { IkasCart } from "../models/data/cart/index";
+import { IkasProductVariant, IkasOrderLineItem, IkasProduct } from "../models/index";
+import { IkasBaseStore } from "./base";
+export declare const CART_LS_KEY = "cartId";
+export declare const CHECKOUT_LS_KEY = "checkoutId";
+export declare class IkasCartStore {
+    cart?: IkasCart | null;
+    private baseStore;
+    private _checkoutId?;
+    private _isLoadingCart;
+    private _cartLoadFinished;
+    constructor(baseStore: IkasBaseStore);
+    get isBrowser(): boolean;
+    get isLoadingCart(): boolean;
+    get cartLoadFinished(): boolean;
+    get checkoutId(): string | null | undefined;
+    get checkoutUrl(): string | undefined;
+    private getCart;
+    private setCart;
+    private beforeCartOperationCheck;
+    private findExistingItem;
+    private createCartLineOptions;
+    private getOptionValues;
+    addItem: (variant: IkasProductVariant, product: IkasProduct, initialQuantity?: number) => Promise<boolean>;
+    changeItemQuantity: (item: IkasOrderLineItem, quantity: number) => Promise<boolean>;
+    removeItem: (item: IkasOrderLineItem) => Promise<void>;
+    removeCardIfEmpty: () => void;
+    removeCart: () => void;
+    waitUntilInitialized: () => Promise<unknown>;
+}

package/build/store/customer.d.ts

@@ -0,0 +1,91 @@
+import { IkasCustomer, IkasFavoriteProduct, IkasOrderTransaction, IkasProduct } from "../models/index";
+import { IkasBaseStore } from "./base";
+export declare class IkasCustomerStore {
+    customer?: IkasCustomer | null;
+    token?: string | null;
+    tokenExpiry?: number | null;
+    private baseStore?;
+    private _initialized;
+    private _visitorSubscribedEmail;
+    private _lastViewedProducts;
+    private _customerConsentGranted;
+    private _refundSettings?;
+    constructor(baseStore?: IkasBaseStore);
+    get initialized(): boolean;
+    get canCreateEmailSubscription(): boolean;
+    get customerConsentGranted(): boolean;
+    login: (email: string, password: string) => Promise<boolean>;
+    /**
+     * Call it when click the social login button
+     * This will automaticly redirect to matched url.
+     * @param provider
+     * @returns undefined
+     */
+    socialLogin(provider: "facebook" | "google"): Promise<void>;
+    /**
+     * When user click the social login ex. facebook login. We navigate to backend.
+     * and backend navigate to provider. after user login into provider,
+     * backend redirect to account/login with following params;
+     * socialLoginStatus: success | fail
+     * socialLoginError: string
+     * socialLoginToken: string
+     * if query params includes socialLoginToken call this function to verify
+     * @param token
+     * @returns boolean
+     */
+    socialLoginToken(token: string): Promise<boolean>;
+    register: (firstName: string, lastName: string, email: string, password: string, isMarketingAccepted?: boolean | undefined) => Promise<boolean>;
+    saveContactForm: (input: IkasContactForm) => Promise<boolean | undefined>;
+    checkEmail: (email: string) => Promise<boolean>;
+    forgotPassword: (email: string) => Promise<boolean>;
+    recoverPassword: (password: string, passwordAgain: string, token: string) => Promise<boolean>;
+    logout: () => void;
+    saveCustomer: (customer: IkasCustomer) => Promise<boolean>;
+    getOrders: () => Promise<import("../models/index").IkasOrder[] | undefined>;
+    getOrder: (id: string) => Promise<import("../models/index").IkasOrder | null>;
+    getOrderTransactions: (params?: {
+        checkoutId?: string;
+        id?: string;
+        orderId?: string;
+    }) => Promise<IkasOrderTransaction[]>;
+    getFavoriteProductsIds: () => Promise<IkasFavoriteProduct[]>;
+    getFavoriteProducts: () => Promise<IkasProduct[]>;
+    getOrderRefundSettings: () => Promise<void>;
+    addItemToFavorite: (productId: string) => Promise<boolean>;
+    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;
+    private routeChangeInit;
+    private getCustomer;
+    private refreshToken;
+    private setCustomer;
+    private getLastViewedProducts;
+    private saveLastViewedProducts;
+    private loadLastViewedProducts;
+    private removeLastViewedProducts;
+    private onProductView;
+    private saveLocalLastViewedProducts;
+    private saveCustomerConsent;
+    private loadCustomerConsent;
+    private removeCustomerConsent;
+    private setToken;
+    private loadToken;
+    private clearLocalTokenData;
+    private clearLocalData;
+}
+export declare type IkasContactForm = {
+    firstName: string;
+    lastName: string;
+    email: string;
+    message: string;
+};
+export declare type IkasCustomerReviewForm = {
+    comment?: string;
+    productId: string;
+    star: number;
+    title?: string;
+};

package/build/store/index.d.ts

@@ -0,0 +1 @@
+export { IkasBaseStore } from "./base";

package/build/storefront/index.d.ts

@@ -0,0 +1,55 @@
+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";
+import { NextRouter } from "next/router";
+export declare class IkasStorefrontConfig {
+    static store: IkasBaseStore;
+    static components: any;
+    static config: Record<string, any>;
+    static apiUrlOverride: string | null;
+    static router?: NextRouter;
+    static domain: string;
+    static storefrontId?: string;
+    static storefrontRoutingId?: string;
+    static storefrontThemeId?: string;
+    static salesChannelId?: string;
+    static priceListId?: string;
+    static stockLocationIds?: string[];
+    static routings: IkasStorefrontRouting[];
+    static paymentGateways: IkasSalesChannelPaymentGateway[];
+    static gtmId?: string;
+    static fbpId?: string;
+    static favicon: IkasThemeFavicon;
+    static stockPreference: IkasThemeStockPreference;
+    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>, router: NextRouter): void;
+    static getCurrentLocale(): string;
+    static getJson(): {
+        domain: string;
+        storefrontId: string | null;
+        storefrontRoutingId: string | null;
+        storefrontThemeId: string | null;
+        salesChannelId: string | null;
+        priceListId: string | null;
+        stockLocationIds: string[] | null;
+        routings: any;
+        paymentGateways: any;
+        gtmId: string | null;
+        fbpId: string | null;
+        favicon: any;
+        stockPreference: IkasThemeStockPreference;
+        storefrontJSScripts: string[];
+        translations: Record<string, any>;
+        customerReviewSettings: IkasCustomerReviewSettings | null;
+        productBackInStockSettings: any;
+    };
+}

package/build/utils/currency.d.ts

@@ -0,0 +1,7 @@
+/**
+ *
+ * @param price Price to format
+ * @param currency Code for the currency, USD, EUR, TRY, etc..
+ */
+export declare const formatMoney: (price: number, currency: string) => string;
+export declare function getCurrencySymbol(currencyCode: string): string;

package/build/utils/helper.d.ts

@@ -0,0 +1,8 @@
+export declare const stringToSlug: (str: string) => string;
+export declare const validatePhoneNumber: (str: string) => boolean;
+export declare const pascalCase: (str: string) => string;
+export declare const decodeBase64: (base64: string) => string;
+export declare function stringSorter(atitle: string, btitle: string): number;
+export declare function findAllIndexes(str: string, pattern: string): number[];
+export declare function formatDate(date: Date): string;
+export declare function tryForEach(items: Array<any>, callback: (item: any, index: number) => void, printErrors?: boolean): void;

package/build/utils/i18n.d.ts

@@ -0,0 +1,20 @@
+export declare const CHECKOUT_TRANSLATION_NAMESPACE = "checkout-page";
+export declare type TFunction = (pathString: string, params?: Record<string, any>) => string;
+export declare class I18NFileReader {
+    locale: string;
+    namespaces: string[];
+    localePath?: string;
+    constructor(locale: string, namespaces: string[], localePath?: string);
+    read(): Promise<Record<string, any>>;
+    private readLocaleFile;
+}
+declare function t(pathString: string, params?: Record<string, any>): string;
+export declare function useTranslation(namespace?: string | string[]): {
+    t: typeof t;
+};
+export declare function createTranslationInputData(value: string): InputData[];
+declare type InputData = {
+    value: string;
+    isVariable: boolean;
+};
+export {};

package/build/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./helper";
+export * from "./currency";
+export { useTranslation, createTranslationInputData } from "./i18n";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikas/storefront",
-  "version": "1.0.16-alpha.1",
+  "version": "1.0.16",
   "main": "./build/index.js",
   "module": "./build/index.es.js",
   "author": "Umut Ozan Yıldırım",
@@ -82,13 +82,14 @@
     "rollup-plugin-postcss": "^4.0.0",
     "rollup-plugin-sass": "^1.2.2",
     "rollup-plugin-typescript": "^1.0.1",
-    "rollup-plugin-typescript2": "^0.29.0",
+    "rollup-plugin-typescript2": "^0.31.1",
     "rollup-watch": "^4.3.1",
     "ts-essentials": "^7.0.1",
     "ts-jest": "^26.4.0",
     "ts-loader": "^8.0.4",
+    "tslib": "^2.3.1",
     "ttypescript": "^1.5.12",
-    "typescript": "^4.1.3",
+    "typescript": "^4.5.4",
     "typescript-transform-paths": "^2.2.2",
     "typings": "^2.1.1"
   },