@zenky/storefront-vue 0.9.37 → 0.9.38

package/dist/cjs/index.js

@@ -1957,6 +1957,123 @@ function getProductsSource(source) {
     }
 }
 
+const usePromotionsStore = pinia.defineStore({
+    id: 'zenky:storefront:promotions',
+    state: () => ({
+        checking: false,
+        failed: false,
+        selector: {
+            available: false,
+            closed: false,
+            offer: null,
+            promotion_id: '',
+            reward_id: '',
+            max_quantity: 0,
+            context: null,
+        },
+    }),
+    getters: {
+        hasSelector() {
+            if (this.checking) {
+                return false;
+            }
+            else if (!this.selector.available) {
+                return false;
+            }
+            else if (!this.selector.promotion_id || !this.selector.reward_id) {
+                return false;
+            }
+            return true;
+        },
+        hasSelectorContext() {
+            if (this.selector.context === null) {
+                return false;
+            }
+            return !!this.selector.context.id && !!this.selector.context.type;
+        },
+    },
+    actions: {
+        setCheckerState(value, timedOut = false) {
+            this.checking = value;
+            this.failed = timedOut;
+        },
+        disableRewardsSelector() {
+            this.selector.available = false;
+            this.selector.offer = null;
+            this.selector.promotion_id = '';
+            this.selector.reward_id = '';
+            this.selector.max_quantity = 0;
+            this.selector.context = null;
+        },
+        enableRewardsSelector(selector) {
+            this.selector.available = true;
+            this.selector.offer = selector.offer;
+            this.selector.promotion_id = selector.promotion_id;
+            this.selector.reward_id = selector.reward_id;
+            this.selector.max_quantity = selector.limit;
+            this.selector.context = selector.context;
+        },
+        closeRewardsSelector() {
+            this.selector.closed = true;
+        },
+        openRewardsSelector() {
+            this.selector.closed = false;
+        },
+        initialize() {
+            events.usePromotionsCheckerStarted().subscribe('storefront.promotions.initialize', () => this.setCheckerState(true));
+            events.usePromotionsCheckerCompleted().subscribe('storefront.promotions.initialize', (params) => this.setCheckerState(false, params && params.timeout === true));
+            events.useDisplayOrderPromotionRewardSelection().subscribe('storefront.promotions.initialize', ({ data }) => this.enableRewardsSelector(data));
+            events.useOrderPromotionsNotFound().subscribe('storefront.promotions.initialize', () => this.disableRewardsSelector());
+        },
+    },
+});
+
+function initializePromotions(order, timeout = 10000) {
+    const promotionsStore = usePromotionsStore();
+    promotionsStore.initialize();
+    const promotionsAreChecking = vue.computed(() => promotionsStore.checking);
+    let manualTimeout = undefined;
+    const checker = async () => {
+        if (promotionsAreChecking.value) {
+            return;
+        }
+        if (manualTimeout) {
+            clearTimeout(manualTimeout);
+        }
+        events.usePromotionsCheckerStarted().publish();
+        await api.checkCompletedPromotions({ id: order.id, token: order.token });
+        manualTimeout = setTimeout(() => {
+            if (promotionsAreChecking.value) {
+                events.usePromotionsCheckerCompleted().publish({ timeout: true });
+            }
+        }, timeout);
+    };
+    events.useProductQuantityIncreased().subscribe('promotions.init', checker);
+    events.useProductQuantityDecreased().subscribe('promotions.init', checker);
+    api.checkCompletedPromotions({ id: order.id, token: order.token }).then(() => {
+        console.log('[storefront/promotions] Promotions checker has been initialized.');
+    });
+}
+function useRewardsSelector() {
+    const promotionsStore = usePromotionsStore();
+    const selector = vue.computed(() => promotionsStore.selector);
+    const checking = vue.computed(() => promotionsStore.checking);
+    const failed = vue.computed(() => promotionsStore.failed);
+    const available = vue.computed(() => selector.value.available);
+    const collapsed = vue.computed(() => selector.value.closed);
+    const close = () => promotionsStore.closeRewardsSelector();
+    const open = () => promotionsStore.openRewardsSelector();
+    return {
+        checking,
+        failed,
+        available,
+        collapsed,
+        selector,
+        open,
+        close,
+    };
+}
+
 exports.ZenkyWebsocketEvent = void 0;
 (function (ZenkyWebsocketEvent) {
     ZenkyWebsocketEvent["OrderPriceRecalculated"] = "orders.price.recalculated";
@@ -2039,6 +2156,7 @@ exports.getStockAddress = getStockAddress;
 exports.getStockSchedule = getStockSchedule;
 exports.getStorage = getStorage;
 exports.getWebsocketsConnection = getWebsocketsConnection;
+exports.initializePromotions = initializePromotions;
 exports.subscribeToOrderEvents = subscribeToOrderEvents;
 exports.useAddressFormValue = useAddressFormValue;
 exports.useArticleCategoriesList = useArticleCategoriesList;
@@ -2082,8 +2200,10 @@ exports.usePhoneConfirmation = usePhoneConfirmation;
 exports.useProductsList = useProductsList;
 exports.useProductsPricesRange = useProductsPricesRange;
 exports.useProductsPricesRangeFilters = useProductsPricesRangeFilters;
+exports.usePromotionsStore = usePromotionsStore;
 exports.useRegistration = useRegistration;
 exports.useReversedTree = useReversedTree;
+exports.useRewardsSelector = useRewardsSelector;
 exports.useSplittedCategoriesTree = useSplittedCategoriesTree;
 exports.useStateDataLoader = useStateDataLoader;
 exports.useStoreStore = useStoreStore;

package/dist/esm/index.js

@@ -1,9 +1,9 @@
 import { ref, computed, watch, unref, inject } from 'vue';
 import { debounce, isBoolean } from 'lodash-es';
-import { getStore, getAddressSuggestions, getCategoriesTree, Visibility, getProductsCollections, getApiErrorMessage, getCategoryFeatures, getCategoryFeaturesGroups, getArticles, getArticleCategories, getArticle, getAuthenticationStatus, setAxiosToken, getCustomerProfile, login, requestPasswordResetCode, resetPassword, register, resendConfirmationCode, confirm, getApiErrorCode, getCustomerAddresses, deleteAddress, updateAddress, getCustomerOrders, getOrder, getCustomerPaymentMethods, deleteCustomerPaymentMethod, ImageType, getOffers, getOffer, getProductsPricesRange, getProducts } from '@zenky/api';
+import { getStore, getAddressSuggestions, getCategoriesTree, Visibility, getProductsCollections, getApiErrorMessage, getCategoryFeatures, getCategoryFeaturesGroups, getArticles, getArticleCategories, getArticle, getAuthenticationStatus, setAxiosToken, getCustomerProfile, login, requestPasswordResetCode, resetPassword, register, resendConfirmationCode, confirm, getApiErrorCode, getCustomerAddresses, deleteAddress, updateAddress, getCustomerOrders, getOrder, getCustomerPaymentMethods, deleteCustomerPaymentMethod, ImageType, getOffers, getOffer, getProductsPricesRange, getProducts, checkCompletedPromotions } from '@zenky/api';
 import { defineStore } from 'pinia';
 import { useNotification } from '@zenky/ui';
-import { useCustomerLoaded, useCustomerAuthenticated, useCustomerLoggedOut, useOrderPriceRecalculated, useOrderShouldBeReloaded, useOrderPromotionRewardsShouldBeReloaded, useDisplayOrderPromotionRewardSelection, usePromotionsCheckerCompleted, useOrderPromotionsNotFound, useOrderSubmitted } from '@zenky/events';
+import { useCustomerLoaded, useCustomerAuthenticated, useCustomerLoggedOut, usePromotionsCheckerStarted, usePromotionsCheckerCompleted, useDisplayOrderPromotionRewardSelection, useOrderPromotionsNotFound, useProductQuantityIncreased, useProductQuantityDecreased, useOrderPriceRecalculated, useOrderShouldBeReloaded, useOrderPromotionRewardsShouldBeReloaded, useOrderSubmitted } from '@zenky/events';
 import Pusher from 'pusher-js';
 
 function useDataDestroyer(destroyer, errorHandler) {
@@ -1949,6 +1949,123 @@ function getProductsSource(source) {
     }
 }
 
+const usePromotionsStore = defineStore({
+    id: 'zenky:storefront:promotions',
+    state: () => ({
+        checking: false,
+        failed: false,
+        selector: {
+            available: false,
+            closed: false,
+            offer: null,
+            promotion_id: '',
+            reward_id: '',
+            max_quantity: 0,
+            context: null,
+        },
+    }),
+    getters: {
+        hasSelector() {
+            if (this.checking) {
+                return false;
+            }
+            else if (!this.selector.available) {
+                return false;
+            }
+            else if (!this.selector.promotion_id || !this.selector.reward_id) {
+                return false;
+            }
+            return true;
+        },
+        hasSelectorContext() {
+            if (this.selector.context === null) {
+                return false;
+            }
+            return !!this.selector.context.id && !!this.selector.context.type;
+        },
+    },
+    actions: {
+        setCheckerState(value, timedOut = false) {
+            this.checking = value;
+            this.failed = timedOut;
+        },
+        disableRewardsSelector() {
+            this.selector.available = false;
+            this.selector.offer = null;
+            this.selector.promotion_id = '';
+            this.selector.reward_id = '';
+            this.selector.max_quantity = 0;
+            this.selector.context = null;
+        },
+        enableRewardsSelector(selector) {
+            this.selector.available = true;
+            this.selector.offer = selector.offer;
+            this.selector.promotion_id = selector.promotion_id;
+            this.selector.reward_id = selector.reward_id;
+            this.selector.max_quantity = selector.limit;
+            this.selector.context = selector.context;
+        },
+        closeRewardsSelector() {
+            this.selector.closed = true;
+        },
+        openRewardsSelector() {
+            this.selector.closed = false;
+        },
+        initialize() {
+            usePromotionsCheckerStarted().subscribe('storefront.promotions.initialize', () => this.setCheckerState(true));
+            usePromotionsCheckerCompleted().subscribe('storefront.promotions.initialize', (params) => this.setCheckerState(false, params && params.timeout === true));
+            useDisplayOrderPromotionRewardSelection().subscribe('storefront.promotions.initialize', ({ data }) => this.enableRewardsSelector(data));
+            useOrderPromotionsNotFound().subscribe('storefront.promotions.initialize', () => this.disableRewardsSelector());
+        },
+    },
+});
+
+function initializePromotions(order, timeout = 10000) {
+    const promotionsStore = usePromotionsStore();
+    promotionsStore.initialize();
+    const promotionsAreChecking = computed(() => promotionsStore.checking);
+    let manualTimeout = undefined;
+    const checker = async () => {
+        if (promotionsAreChecking.value) {
+            return;
+        }
+        if (manualTimeout) {
+            clearTimeout(manualTimeout);
+        }
+        usePromotionsCheckerStarted().publish();
+        await checkCompletedPromotions({ id: order.id, token: order.token });
+        manualTimeout = setTimeout(() => {
+            if (promotionsAreChecking.value) {
+                usePromotionsCheckerCompleted().publish({ timeout: true });
+            }
+        }, timeout);
+    };
+    useProductQuantityIncreased().subscribe('promotions.init', checker);
+    useProductQuantityDecreased().subscribe('promotions.init', checker);
+    checkCompletedPromotions({ id: order.id, token: order.token }).then(() => {
+        console.log('[storefront/promotions] Promotions checker has been initialized.');
+    });
+}
+function useRewardsSelector() {
+    const promotionsStore = usePromotionsStore();
+    const selector = computed(() => promotionsStore.selector);
+    const checking = computed(() => promotionsStore.checking);
+    const failed = computed(() => promotionsStore.failed);
+    const available = computed(() => selector.value.available);
+    const collapsed = computed(() => selector.value.closed);
+    const close = () => promotionsStore.closeRewardsSelector();
+    const open = () => promotionsStore.openRewardsSelector();
+    return {
+        checking,
+        failed,
+        available,
+        collapsed,
+        selector,
+        open,
+        close,
+    };
+}
+
 var ZenkyWebsocketEvent;
 (function (ZenkyWebsocketEvent) {
     ZenkyWebsocketEvent["OrderPriceRecalculated"] = "orders.price.recalculated";
@@ -2014,4 +2131,4 @@ function subscribeToOrderEvents(order) {
     });
 }
 
-export { AuthenticationEvent, AuthenticationResultType, AuthenticationStage, ZenkyInjection, ZenkyWebsocketEvent, createStorage, createWebsocketsConnection, getAddressForm, getApiErrorHandler, getExistedAddress, getExistedAddressDisplayValue, getFirstMedium, getProductsListParamsFromQuery, getProductsListQueryParams, getProductsPaginationRequest, getProductsSource, getSelectedAddress, getSelectedAddressDisplayValue, getStockAddress, getStockSchedule, getStorage, getWebsocketsConnection, subscribeToOrderEvents, useAddressFormValue, useArticleCategoriesList, useArticleItem, useArticlesList, useAuthenticationForm, useAuthenticationStatusChecker, useCategories, useCategoriesStore, useCategoriesTree, useCategory, useCategoryFeaturesGroupsList, useCategoryFeaturesList, useCollection, useCollections, useCollectionsStore, useCustomer, useCustomerStore, useDadata, useDataDestroyer, useDataLoader, useDeliveryAddressDestroyer, useDeliveryAddressesList, useEditAddressForm, useFeaturesFilters, useFeaturesGroupsFilters, useFlatCategoriesTree, useItemLoader, useListLoader, useLogin, useLogout, useOfferItem, useOffersList, useOrderItem, useOrdersList, usePaginatedLoader, usePasswordReset, usePaymentMethodDestroyer, usePaymentMethodsList, usePhoneConfirmation, useProductsList, useProductsPricesRange, useProductsPricesRangeFilters, useRegistration, useReversedTree, useSplittedCategoriesTree, useStateDataLoader, useStoreStore, useSuggestionsRestrictedToCity };
+export { AuthenticationEvent, AuthenticationResultType, AuthenticationStage, ZenkyInjection, ZenkyWebsocketEvent, createStorage, createWebsocketsConnection, getAddressForm, getApiErrorHandler, getExistedAddress, getExistedAddressDisplayValue, getFirstMedium, getProductsListParamsFromQuery, getProductsListQueryParams, getProductsPaginationRequest, getProductsSource, getSelectedAddress, getSelectedAddressDisplayValue, getStockAddress, getStockSchedule, getStorage, getWebsocketsConnection, initializePromotions, subscribeToOrderEvents, useAddressFormValue, useArticleCategoriesList, useArticleItem, useArticlesList, useAuthenticationForm, useAuthenticationStatusChecker, useCategories, useCategoriesStore, useCategoriesTree, useCategory, useCategoryFeaturesGroupsList, useCategoryFeaturesList, useCollection, useCollections, useCollectionsStore, useCustomer, useCustomerStore, useDadata, useDataDestroyer, useDataLoader, useDeliveryAddressDestroyer, useDeliveryAddressesList, useEditAddressForm, useFeaturesFilters, useFeaturesGroupsFilters, useFlatCategoriesTree, useItemLoader, useListLoader, useLogin, useLogout, useOfferItem, useOffersList, useOrderItem, useOrdersList, usePaginatedLoader, usePasswordReset, usePaymentMethodDestroyer, usePaymentMethodsList, usePhoneConfirmation, useProductsList, useProductsPricesRange, useProductsPricesRangeFilters, usePromotionsStore, useRegistration, useReversedTree, useRewardsSelector, useSplittedCategoriesTree, useStateDataLoader, useStoreStore, useSuggestionsRestrictedToCity };

package/dist/zenky.d.ts

@@ -1167,6 +1167,64 @@ declare function getProductsSource(source: ProductsSource | null): ProductsSourc
 
 declare function getProductsPaginationRequest(page: number, loader: ProductsLoader): ProductsPaginationRequest | null;
 
+interface PromotionsSelectorContext {
+    id: string;
+    type: string;
+}
+interface PromotionsSelectorOffer {
+    id: string;
+    short_id: string;
+    slug: string;
+}
+interface PromotionsSelector {
+    available: boolean;
+    closed: boolean;
+    offer: PromotionsSelectorOffer | null;
+    promotion_id: string;
+    reward_id: string;
+    max_quantity: number;
+    context: PromotionsSelectorContext | null;
+}
+interface PromotionsCheckerSelector {
+    offer: PromotionsSelectorOffer | null;
+    promotion_id: string;
+    reward_id: string;
+    limit: number;
+    context: PromotionsSelectorContext | null;
+}
+interface PromotionsStoreState {
+    checking: boolean;
+    failed: boolean;
+    selector: PromotionsSelector;
+}
+interface PromotionsCheckerCompletedPayload {
+    timeout?: boolean;
+}
+interface PromotionsRewardsSelectorProvider {
+    checking: ComputedRef<boolean>;
+    failed: ComputedRef<boolean>;
+    available: ComputedRef<boolean>;
+    collapsed: ComputedRef<boolean>;
+    selector: ComputedRef<PromotionsSelector>;
+    open: () => void;
+    close: () => void;
+}
+
+declare const usePromotionsStore: pinia.StoreDefinition<"zenky:storefront:promotions", PromotionsStoreState, {
+    hasSelector(): boolean;
+    hasSelectorContext(): boolean;
+}, {
+    setCheckerState(value: boolean, timedOut?: boolean): void;
+    disableRewardsSelector(): void;
+    enableRewardsSelector(selector: PromotionsCheckerSelector): void;
+    closeRewardsSelector(): void;
+    openRewardsSelector(): void;
+    initialize(): void;
+}>;
+
+declare function initializePromotions(order: Order, timeout?: number): void;
+declare function useRewardsSelector(): PromotionsRewardsSelectorProvider;
+
 declare function getStockSchedule(schedule: Schedule): string;
 declare function getStockAddress(stock: Stock): string | null;
 
@@ -1202,4 +1260,4 @@ declare function createWebsocketsConnection(store: Store): Pusher;
 declare function getWebsocketsConnection(): Pusher;
 declare function subscribeToOrderEvents(order: Order): void;
 
-export { AddressForm, AddressFormValue, AddressFormValueProvider, ApiErrorHandler, AuthenticationEvent, AuthenticationForm, AuthenticationFormProvider, AuthenticationResult, AuthenticationResultType, AuthenticationStage, AuthenticationStatusCheckerProvider, CategoriesProvider, CategoriesState, CategoriesTreeProvider, CategoryProvider, CollectionsState, ConfirmableDataDestroyer, ConfirmationProvider, CustomerStore, DadataProvider, DataDestroyer, DataDestroyerHandler, DataLoader, DataProvider, EditAddressFormProvider, EmitAuthenticationEvent, FlatCategoriesTreeProvider, FlattenNestedCategory, ItemLoader, ItemProvider, ListLoader, ListProvider, LoaderState, LoginProvider, LogoutProvider, OptionalApiErrorHandler, PaginatedItemsProvider, PaginatedLoader, PaginatedLoaderState, PasswordResetProvider, ProductsCollectionProvider, ProductsCollectionsProvider, RegistrationProvider, ReversedTreeProvider, SplittedCategoriesTreeProvider, StateDataLoader, StateDataLoaderState, StoreState, ZenkyInjection, ZenkyStorage, ZenkyWebsocketEvent, createStorage, createWebsocketsConnection, getAddressForm, getApiErrorHandler, getExistedAddress, getExistedAddressDisplayValue, getFirstMedium, getProductsListParamsFromQuery, getProductsListQueryParams, getProductsPaginationRequest, getProductsSource, getSelectedAddress, getSelectedAddressDisplayValue, getStockAddress, getStockSchedule, getStorage, getWebsocketsConnection, subscribeToOrderEvents, useAddressFormValue, useArticleCategoriesList, useArticleItem, useArticlesList, useAuthenticationForm, useAuthenticationStatusChecker, useCategories, useCategoriesStore, useCategoriesTree, useCategory, useCategoryFeaturesGroupsList, useCategoryFeaturesList, useCollection, useCollections, useCollectionsStore, useCustomer, useCustomerStore, useDadata, useDataDestroyer, useDataLoader, useDeliveryAddressDestroyer, useDeliveryAddressesList, useEditAddressForm, useFeaturesFilters, useFeaturesGroupsFilters, useFlatCategoriesTree, useItemLoader, useListLoader, useLogin, useLogout, useOfferItem, useOffersList, useOrderItem, useOrdersList, usePaginatedLoader, usePasswordReset, usePaymentMethodDestroyer, usePaymentMethodsList, usePhoneConfirmation, useProductsList, useProductsPricesRange, useProductsPricesRangeFilters, useRegistration, useReversedTree, useSplittedCategoriesTree, useStateDataLoader, useStoreStore, useSuggestionsRestrictedToCity };
+export { AddressForm, AddressFormValue, AddressFormValueProvider, ApiErrorHandler, AuthenticationEvent, AuthenticationForm, AuthenticationFormProvider, AuthenticationResult, AuthenticationResultType, AuthenticationStage, AuthenticationStatusCheckerProvider, CategoriesProvider, CategoriesState, CategoriesTreeProvider, CategoryProvider, CollectionsState, ConfirmableDataDestroyer, ConfirmationProvider, CustomerStore, DadataProvider, DataDestroyer, DataDestroyerHandler, DataLoader, DataProvider, EditAddressFormProvider, EmitAuthenticationEvent, FlatCategoriesTreeProvider, FlattenNestedCategory, ItemLoader, ItemProvider, ListLoader, ListProvider, LoaderState, LoginProvider, LogoutProvider, OptionalApiErrorHandler, PaginatedItemsProvider, PaginatedLoader, PaginatedLoaderState, PasswordResetProvider, ProductsCollectionProvider, ProductsCollectionsProvider, PromotionsCheckerCompletedPayload, PromotionsCheckerSelector, PromotionsRewardsSelectorProvider, PromotionsSelector, PromotionsSelectorContext, PromotionsSelectorOffer, PromotionsStoreState, RegistrationProvider, ReversedTreeProvider, SplittedCategoriesTreeProvider, StateDataLoader, StateDataLoaderState, StoreState, ZenkyInjection, ZenkyStorage, ZenkyWebsocketEvent, createStorage, createWebsocketsConnection, getAddressForm, getApiErrorHandler, getExistedAddress, getExistedAddressDisplayValue, getFirstMedium, getProductsListParamsFromQuery, getProductsListQueryParams, getProductsPaginationRequest, getProductsSource, getSelectedAddress, getSelectedAddressDisplayValue, getStockAddress, getStockSchedule, getStorage, getWebsocketsConnection, initializePromotions, subscribeToOrderEvents, useAddressFormValue, useArticleCategoriesList, useArticleItem, useArticlesList, useAuthenticationForm, useAuthenticationStatusChecker, useCategories, useCategoriesStore, useCategoriesTree, useCategory, useCategoryFeaturesGroupsList, useCategoryFeaturesList, useCollection, useCollections, useCollectionsStore, useCustomer, useCustomerStore, useDadata, useDataDestroyer, useDataLoader, useDeliveryAddressDestroyer, useDeliveryAddressesList, useEditAddressForm, useFeaturesFilters, useFeaturesGroupsFilters, useFlatCategoriesTree, useItemLoader, useListLoader, useLogin, useLogout, useOfferItem, useOffersList, useOrderItem, useOrdersList, usePaginatedLoader, usePasswordReset, usePaymentMethodDestroyer, usePaymentMethodsList, usePhoneConfirmation, useProductsList, useProductsPricesRange, useProductsPricesRangeFilters, usePromotionsStore, useRegistration, useReversedTree, useRewardsSelector, useSplittedCategoriesTree, useStateDataLoader, useStoreStore, useSuggestionsRestrictedToCity };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenky/storefront-vue",
-  "version": "0.9.37",
+  "version": "0.9.38",
   "description": "Zenky Storefront library for Vue 3.",
   "author": "Timur Zurbaev <hello@zurbaev.ru>",
   "license": "MIT",
@@ -19,7 +19,7 @@
     "Zenky"
   ],
   "peerDependencies": {
-    "@zenky/api": "^0.9.44",
+    "@zenky/api": "^0.9.45",
     "@zenky/events": "^1.0.2",
     "@zenky/ui": "^0.9.63",
     "lodash-es": "^4.17.21",