@zenky/storefront-vue 0.9.39 → 0.9.42

package/dist/zenky.d.ts

@@ -1,13 +1,18 @@
 import * as vue from 'vue';
-import { Ref, ComputedRef } from 'vue';
+import { Ref, ComputedRef, WritableComputedRef } from 'vue';
 import * as _zenky_api from '@zenky/api';
-import { PaginationRequest, Pagination, PaginatedResponse, ResourceRequest, Address, City, NestedCategory, ProductsCollection, Feature, FeaturesGroupContainer, Article, ArticlesPaginationRequest, ArticleCategory, ArticleCategoriesPaginationRequest, Customer, AuthenticationPhone, Order, OrderCredentials, CustomerPaymentMethod, Medium, Image, Offer, OffersPaginationRequest, OrderSettings, OrderCheckoutTotal, ProductVariant, OrderProductVariant, Product, ProductsPricesRange, ProductsPaginationRequest, Schedule, Stock, Store, StoreSettings } from '@zenky/api';
+import { ZenkyError, PaginationRequest, Pagination, PaginatedResponse, ResourceRequest, Address, City, NestedCategory, ProductsCollection, Feature, FeaturesGroupContainer, Article, ArticlesPaginationRequest, ArticleCategory, ArticleCategoriesPaginationRequest, Customer, AuthenticationPhone, Order, OrderCredentials, CustomerPaymentMethod, Medium, Image, Offer, OffersPaginationRequest, OrderSettings, OrderCheckoutTotal, ProductVariant, OrderProductVariant, ProductModifiersGroup, ProductModifier, ProductVariantPriceCalculation, Enum, VariantOptionValue, Product, ProductRequest, ProductsPaginationRequest, ProductsPricesRange, Schedule, Stock, Store, StoreSettings } from '@zenky/api';
 import * as pinia from 'pinia';
 import Pusher from 'pusher-js';
 
-declare type ApiErrorHandler = (e: any) => any;
+interface ApiErrorHandlerData {
+    e: any;
+    error?: ZenkyError | null;
+    message?: string | null;
+}
+declare type ApiErrorHandler = (data: ApiErrorHandlerData) => any;
 declare type OptionalApiErrorHandler = ApiErrorHandler | null | undefined;
-declare function getApiErrorHandler(providedHandler: OptionalApiErrorHandler, defaultHandler: ApiErrorHandler): ApiErrorHandler;
+declare function getApiErrorHandler(providedHandler: OptionalApiErrorHandler, composableName: string, defaultMessage: string): ApiErrorHandler;
 
 interface DataDestroyer {
     destroying: Ref<boolean>;
@@ -117,6 +122,14 @@ interface AddressFormValueProvider {
     errors: string[];
     data: AddressFormValue;
 }
+declare enum AddressFormValueError {
+    DaDataSuggestionRequired = "dadata.suggestion_required",
+    CityRequired = "plain.city_required",
+    StreetRequired = "plain.street_required",
+    HouseRequired = "plain.house_required",
+    StockRequired = "stock_required",
+    TableRequired = "table_required"
+}
 declare function useAddressFormValue(form: AddressForm, resolver: string, address?: Address | null): AddressFormValueProvider;
 
 interface DadataProvider {
@@ -226,12 +239,19 @@ declare enum AuthenticationEvent {
     Completed = "completed"
 }
 declare enum AuthenticationResultType {
-    Pending = "pending",
     Validation = "validation",
     Failed = "failed",
     Completed = "completed",
     Stage = "stage"
 }
+declare enum AuthenticationFailureReason {
+    ApiError = "api_error",
+    InProgress = "in_progress",
+    Cooldown = "cooldown",
+    PhoneRequired = "phone_required",
+    PasswordRequired = "password_required",
+    CodeRequired = "code_required"
+}
 declare type EmitAuthenticationEvent = (e: AuthenticationEvent, payload?: any) => void;
 declare type CustomerStore = {
     inclusions: string;
@@ -253,6 +273,8 @@ interface AuthenticationFormProvider {
 interface AuthenticationResult {
     type: AuthenticationResultType;
     data?: any;
+    reason?: AuthenticationFailureReason;
+    error?: ZenkyError | null;
 }
 interface AuthenticationStatusCheckerProvider {
     active: Ref<boolean>;
@@ -285,10 +307,25 @@ interface ConfirmationProvider {
     resend: () => Promise<AuthenticationResult>;
     confirm: (withPassword: boolean) => Promise<AuthenticationResult>;
 }
+declare enum AddressResultType {
+    Failed = "failed",
+    Completed = "completed"
+}
+declare enum AddressResultReason {
+    InProgress = "in_progress",
+    Validation = "validation",
+    ApiError = "api_error"
+}
+interface AddressResult {
+    type: AddressResultType;
+    reason?: AddressResultReason;
+    data?: any;
+    error?: ZenkyError | null;
+}
 interface EditAddressFormProvider {
     form: Ref<AddressForm>;
     saving: Ref<boolean>;
-    save: () => Promise<boolean>;
+    save: () => Promise<AddressResult>;
 }
 
 declare function useAuthenticationStatusChecker(form: Ref<AuthenticationForm>, emit: EmitAuthenticationEvent): AuthenticationStatusCheckerProvider;
@@ -1084,6 +1121,37 @@ interface OrderProductVariantPromotion {
     id: string;
     reward_id: string;
 }
+declare type ProductVariantControlsCallbackHandler = (type: string, result: boolean) => void;
+declare enum OrderCheckoutResultType {
+    Validation = "validation",
+    Completed = "completed",
+    Failed = "failed"
+}
+declare enum OrderCheckoutResultReason {
+    InProgress = "in_progress",
+    Cooldown = "cooldown",
+    ApiError = "api_error",
+    OrderNotReady = "order_not_ready",
+    PhoneRequired = "phone_required",
+    FirstNameRequired = "first_name_required",
+    CodeRequired = "code_required",
+    AddressError = "address_error"
+}
+interface OrderCheckoutResult {
+    type: OrderCheckoutResultType;
+    reason?: OrderCheckoutResultReason;
+    data?: any;
+    error?: ZenkyError | null;
+}
+declare enum BillSuggestionType {
+    Bill = "bill",
+    NoChange = "no_change",
+    Custom = "custom"
+}
+interface BillSuggestion {
+    type: BillSuggestionType;
+    value: string | number;
+}
 
 declare const useOrderStore: pinia.StoreDefinition<"zenky:storefront:order", OrderStoreState, {
     credentials(): OrderCredentials | null;
@@ -4438,9 +4506,9 @@ declare function useCheckoutConfirmation(order: Ref<Order>): {
         code: string;
     }>;
     confirming: Ref<boolean>;
-    confirm: () => Promise<_zenky_api.OrderConfirmationResult | null>;
+    confirm: () => Promise<OrderCheckoutResult>;
     resending: Ref<boolean>;
-    resendCode: () => Promise<void>;
+    resendCode: () => Promise<OrderCheckoutResult>;
 };
 
 declare function useCustomerCheckoutForm(emit: (event: string) => any): {
@@ -4699,7 +4767,7 @@ declare function useCustomerCheckoutForm(emit: (event: string) => any): {
         first_name: string;
         last_name: string;
     }>;
-    save: () => Promise<void>;
+    save: () => Promise<OrderCheckoutResult>;
 };
 
 declare function useDeliveryCheckoutForm(emit: (event: string) => any): {
@@ -4790,14 +4858,11 @@ declare function useDeliveryCheckoutForm(emit: (event: string) => any): {
     addressesResolver: Ref<string | null>;
     priceIsNotEnough: vue.ComputedRef<boolean>;
     saving: Ref<boolean>;
-    save: () => Promise<void>;
+    save: () => Promise<OrderCheckoutResult>;
 };
 
 declare function useBillSuggestions(unpaidAmount: Ref<number>, staticAmounts?: number[], availableBills?: number[]): {
-    suggestions: vue.ComputedRef<{
-        label: string;
-        value: string | number;
-    }[]>;
+    suggestions: vue.ComputedRef<BillSuggestion[]>;
 };
 declare function useDeliveryPaymentsForm(emit: (event: string) => any): {
     form: Ref<{
@@ -4824,7 +4889,7 @@ declare function useDeliveryPaymentsForm(emit: (event: string) => any): {
     } | undefined>;
     bonusesAreChecking: Ref<boolean>;
     saving: Ref<boolean>;
-    save: () => Promise<void>;
+    save: () => Promise<OrderCheckoutResult>;
 };
 
 declare function useCheckoutSummary(emit: (event: string, payload?: any) => any): {
@@ -4834,7 +4899,15 @@ declare function useCheckoutSummary(emit: (event: string, payload?: any) => any)
     }>;
     hasPersonsCount: vue.ComputedRef<boolean>;
     saving: vue.Ref<boolean>;
-    save: () => Promise<void>;
+    save: () => Promise<{
+        type: OrderCheckoutResultType;
+        reason?: undefined;
+        error?: undefined;
+    } | {
+        type: OrderCheckoutResultType;
+        reason: OrderCheckoutResultReason;
+        error: _zenky_api.ZenkyError | null;
+    } | undefined>;
 };
 
 declare function useCheckoutTotal(): {
@@ -9977,7 +10050,7 @@ declare function useOrderVariants(): {
         } | null;
     }[]>;
 };
-declare const useVariantControls: (variant: Ref<ProductVariant>, modifiers: Ref<any[]>, modifiersHash: Ref<string | null>, promotion: Ref<OrderProductVariantPromotion | null>) => {
+declare const useVariantControls: (variant: Ref<ProductVariant>, modifiers: Ref<any[]>, modifiersHash: Ref<string | null>, promotion: Ref<OrderProductVariantPromotion | null>, callback?: ProductVariantControlsCallbackHandler) => {
     orderVariant: ComputedRef<OrderProductVariant | null | undefined>;
     totalQuantity: ComputedRef<number>;
     quantityModel: Ref<string | number>;
@@ -9991,6 +10064,122 @@ declare const useVariantControls: (variant: Ref<ProductVariant>, modifiers: Ref<
 
 declare function getUpdatedVariants(currentOrder: Order, order: Order): OrderProductVariant[];
 
+interface ProductModifierModel {
+    quantity: number;
+    modifier_id: string;
+}
+interface ModifiersGroupModifiersList {
+    [x: string]: ProductModifierModel;
+}
+interface ProductModifiersGroupModifierModel {
+    modifiers_group_id: string | null;
+    modifier_id: string | null;
+    quantity: number;
+}
+interface ModifiersGroupProps {
+    modelValue: ProductModifiersGroupModifierModel[];
+    group: ProductModifiersGroup;
+}
+interface SingleModifierProps {
+    modelValue: ProductModifierModel;
+    modifier: ProductModifier;
+    limitReached: boolean;
+}
+interface ProductCardModifiersList {
+    [x: string]: ProductModifierModel | ProductModifiersGroupModifierModel[];
+}
+interface SelectedProductModifier {
+    modifier_id: string;
+    quantity: number;
+    modifiers_group_id?: string;
+}
+declare type ProductVariantPriceCalcuator = (modifiers: Ref<SelectedProductModifier[]>) => Promise<string | null>;
+interface CalculatedProductVariantPrice extends ProductVariantPriceCalculation {
+    recalculated: boolean;
+    recalculating: boolean;
+}
+interface ProductCardVariantOption {
+    id: string;
+    name: string | null;
+    type: Enum | null;
+    values: VariantOptionValue[];
+}
+interface SelectedVariantOptionsList {
+    [x: string]: string | null;
+}
+interface ProductCardProduct {
+    id: string;
+    short_id: string | null;
+    category_id: string | null;
+    slug: string | null;
+    name: string | null;
+    description: string | null;
+    images: Medium[];
+    modifiers: ProductModifier[];
+    modifiers_groups: ProductModifiersGroup[];
+    variants_count: number;
+    has_images: boolean;
+    has_modifiers: boolean;
+}
+
+declare function useSingleModifier(props: SingleModifierProps, emit: (event: string, data: any) => any): {
+    value: WritableComputedRef<ProductModifierModel>;
+    checked: WritableComputedRef<boolean>;
+    shouldUseQuantityControls: ComputedRef<boolean>;
+    increase: () => void;
+    decrease: () => void;
+};
+
+declare function useModifiersGroup(props: ModifiersGroupProps, emit: (event: string, data: any) => any): {
+    selectedModifier: Ref<string>;
+    modifiers: Ref<ModifiersGroupModifiersList>;
+    shouldUseQuantityControls: ComputedRef<boolean>;
+    requiredModifierIsMissing: ComputedRef<boolean>;
+    limitReached: ComputedRef<boolean>;
+};
+
+declare function useModifiers(product: Product, variant: ComputedRef<ProductVariant | null>, recalculate: ProductVariantPriceCalcuator): {
+    modifiers: Ref<ProductCardModifiersList>;
+    selectedModifiers: Ref<SelectedProductModifier[]>;
+    modifiersHash: Ref<string | null>;
+};
+
+declare function getProductVariantsPricesRange(variants: ProductVariant[]): {
+    min: _zenky_api.Price;
+    max: _zenky_api.Price;
+} | null;
+declare function useVariantPrice(variants: ProductVariant[], variant: ComputedRef<ProductVariant | null>): {
+    totalPrice: ComputedRef<CalculatedProductVariantPrice | null>;
+    pricesRange: ComputedRef<{
+        min: _zenky_api.Price;
+        max: _zenky_api.Price;
+    } | null>;
+    recalculating: Ref<boolean>;
+    recalculate: ProductVariantPriceCalcuator;
+};
+
+declare function useProductItem(errorHandler?: OptionalApiErrorHandler): ItemLoader<Product, string, ProductRequest>;
+declare function useProductCard(item: Product): {
+    product: Ref<ProductCardProduct>;
+    variant: vue.ComputedRef<_zenky_api.ProductVariant | null>;
+    options: Ref<ProductCardVariantOption[]>;
+    selectedOptions: Ref<SelectedVariantOptionsList>;
+    pricesRange: vue.ComputedRef<{
+        min: _zenky_api.Price;
+        max: _zenky_api.Price;
+    } | null>;
+    totalPrice: vue.ComputedRef<CalculatedProductVariantPrice | null>;
+    modifiers: Ref<ProductCardModifiersList>;
+    modifiersHash: Ref<string | null>;
+    selectedModifiers: Ref<SelectedProductModifier[]>;
+};
+
+declare function useVariant(variants: ProductVariant[]): {
+    variant: ComputedRef<ProductVariant | null>;
+    options: Ref<ProductCardVariantOption[]>;
+    selectedOptions: Ref<SelectedVariantOptionsList>;
+};
+
 declare enum ProductsSourceType {
     Category = "category",
     Collection = "collection",
@@ -10011,6 +10200,9 @@ interface ProductsSource {
     id?: string;
     error?: boolean;
 }
+interface InjectedProductsSource {
+    id: string;
+}
 interface ProductsFilters {
     [key: string]: string[];
 }
@@ -10188,4 +10380,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, CheckoutStage, CollectionsState, ConfirmableDataDestroyer, ConfirmationProvider, CustomerStore, DadataProvider, DataDestroyer, DataDestroyerHandler, DataLoader, DataProvider, EditAddressFormProvider, EmitAuthenticationEvent, FlatCategoriesTreeProvider, FlattenNestedCategory, ItemLoader, ItemProvider, ListLoader, ListProvider, LoaderState, LoginProvider, LogoutProvider, OptionalApiErrorHandler, OrderInclusions, OrderProductVariantPromotion, OrderSettingsState, OrderStoreState, 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, getUpdatedVariants, getWebsocketsConnection, initializeOrderCustomer, initializePromotions, subscribeToOrderEvents, useAddressFormValue, useArticleCategoriesList, useArticleItem, useArticlesList, useAuthenticationForm, useAuthenticationStatusChecker, useBillSuggestions, useCategories, useCategoriesStore, useCategoriesTree, useCategory, useCategoryFeaturesGroupsList, useCategoryFeaturesList, useCheckoutConfirmation, useCheckoutSummary, useCheckoutTotal, useCollection, useCollections, useCollectionsStore, useCustomer, useCustomerCheckoutForm, useCustomerStore, useDadata, useDataDestroyer, useDataLoader, useDeliveryAddressDestroyer, useDeliveryAddressesList, useDeliveryCheckoutForm, useDeliveryPaymentsForm, useEditAddressForm, useFeaturesFilters, useFeaturesGroupsFilters, useFlatCategoriesTree, useItemLoader, useListLoader, useLogin, useLogout, useOfferItem, useOffersList, useOrderCheckout, useOrderItem, useOrderStore, useOrderVariants, useOrdersList, usePaginatedLoader, usePasswordReset, usePaymentMethodDestroyer, usePaymentMethodsList, usePhoneConfirmation, useProductsList, useProductsPricesRange, useProductsPricesRangeFilters, usePromotionsStore, useRegistration, useReversedTree, useRewardsSelector, useSplittedCategoriesTree, useStateDataLoader, useStoreStore, useSuggestionsRestrictedToCity, useTotalPrice, useTotalQuantity, useVariantControls };
+export { AddressForm, AddressFormValue, AddressFormValueError, AddressFormValueProvider, AddressResult, AddressResultReason, AddressResultType, ApiErrorHandler, ApiErrorHandlerData, AuthenticationEvent, AuthenticationFailureReason, AuthenticationForm, AuthenticationFormProvider, AuthenticationResult, AuthenticationResultType, AuthenticationStage, AuthenticationStatusCheckerProvider, BillSuggestion, BillSuggestionType, CalculatedProductVariantPrice, CategoriesProvider, CategoriesState, CategoriesTreeProvider, CategoryProvider, CheckoutStage, CollectionsState, ConfirmableDataDestroyer, ConfirmationProvider, CustomerStore, DadataProvider, DataDestroyer, DataDestroyerHandler, DataLoader, DataProvider, EditAddressFormProvider, EmitAuthenticationEvent, FlatCategoriesTreeProvider, FlattenNestedCategory, InjectedProductsSource, ItemLoader, ItemProvider, ListLoader, ListProvider, LoaderState, LoginProvider, LogoutProvider, ModifiersGroupModifiersList, ModifiersGroupProps, OptionalApiErrorHandler, OrderCheckoutResult, OrderCheckoutResultReason, OrderCheckoutResultType, OrderInclusions, OrderProductVariantPromotion, OrderSettingsState, OrderStoreState, PaginatedItemsProvider, PaginatedLoader, PaginatedLoaderState, PasswordResetProvider, ProductCardModifiersList, ProductCardProduct, ProductCardVariantOption, ProductModifierModel, ProductModifiersGroupModifierModel, ProductVariantControlsCallbackHandler, ProductVariantPriceCalcuator, ProductsCollectionProvider, ProductsCollectionsProvider, ProductsFilters, ProductsFiltersType, ProductsListConfig, ProductsListProvider, ProductsLoader, ProductsPriceFilters, ProductsPromotion, ProductsRequestCallback, ProductsSorting, ProductsSource, ProductsSourceType, PromotionsCheckerCompletedPayload, PromotionsCheckerSelector, PromotionsRewardsSelectorProvider, PromotionsSelector, PromotionsSelectorContext, PromotionsSelectorOffer, PromotionsStoreState, RegistrationProvider, ReversedTreeProvider, SelectedProductModifier, SelectedVariantOptionsList, SingleModifierProps, SplittedCategoriesTreeProvider, StateDataLoader, StateDataLoaderState, StoreState, ZenkyInjection, ZenkyStorage, ZenkyWebsocketEvent, createStorage, createWebsocketsConnection, getAddressForm, getApiErrorHandler, getExistedAddress, getExistedAddressDisplayValue, getFirstMedium, getProductVariantsPricesRange, getProductsListParamsFromQuery, getProductsListQueryParams, getProductsPaginationRequest, getProductsSource, getSelectedAddress, getSelectedAddressDisplayValue, getStockAddress, getStockSchedule, getStorage, getUpdatedVariants, getWebsocketsConnection, initializeOrderCustomer, initializePromotions, subscribeToOrderEvents, useAddressFormValue, useArticleCategoriesList, useArticleItem, useArticlesList, useAuthenticationForm, useAuthenticationStatusChecker, useBillSuggestions, useCategories, useCategoriesStore, useCategoriesTree, useCategory, useCategoryFeaturesGroupsList, useCategoryFeaturesList, useCheckoutConfirmation, useCheckoutSummary, useCheckoutTotal, useCollection, useCollections, useCollectionsStore, useCustomer, useCustomerCheckoutForm, useCustomerStore, useDadata, useDataDestroyer, useDataLoader, useDeliveryAddressDestroyer, useDeliveryAddressesList, useDeliveryCheckoutForm, useDeliveryPaymentsForm, useEditAddressForm, useFeaturesFilters, useFeaturesGroupsFilters, useFlatCategoriesTree, useItemLoader, useListLoader, useLogin, useLogout, useModifiers, useModifiersGroup, useOfferItem, useOffersList, useOrderCheckout, useOrderItem, useOrderStore, useOrderVariants, useOrdersList, usePaginatedLoader, usePasswordReset, usePaymentMethodDestroyer, usePaymentMethodsList, usePhoneConfirmation, useProductCard, useProductItem, useProductsList, useProductsPricesRange, useProductsPricesRangeFilters, usePromotionsStore, useRegistration, useReversedTree, useRewardsSelector, useSingleModifier, useSplittedCategoriesTree, useStateDataLoader, useStoreStore, useSuggestionsRestrictedToCity, useTotalPrice, useTotalQuantity, useVariant, useVariantControls, useVariantPrice };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenky/storefront-vue",
-  "version": "0.9.39",
+  "version": "0.9.42",
   "description": "Zenky Storefront library for Vue 3.",
   "author": "Timur Zurbaev <hello@zurbaev.ru>",
   "license": "MIT",
@@ -19,9 +19,8 @@
     "Zenky"
   ],
   "peerDependencies": {
-    "@zenky/api": "^0.9.50",
-    "@zenky/events": "^1.0.2",
-    "@zenky/ui": "^0.9.63",
+    "@zenky/api": "^0.9.51",
+    "@zenky/events": "^1.0.3",
     "date-fns": "^2.29.2",
     "lodash-es": "^4.17.21",
     "pinia": "^2.0.14",