@shopware-pwa/composables-next - npm Package Compare versions

Comparing version 0.0.0-canary-20221211144321 to 0.0.0-canary-20221214075543

dist/index.d.ts

 import * as vue from 'vue';
 import { CSSProperties, ComputedRef, AnchorHTMLAttributes, ImgHTMLAttributes, Ref, UnwrapRef, App } from 'vue';
-import { CmsBlock, CmsSlot, Media, Product, ProductListingResult, EntityResult, ProductReview, PropertyGroup, CrossSelling, Salutation, SectionType, CmsSection, Category, ProductResponse as ProductResponse$1, LandingPage, CmsPage, ShopwareSearchParams, StoreNavigationElement, StoreNavigationType, Cart, LineItem, EntityError, PropertyGroupOption, PropertyGroupOptionCart, LineItemType, CustomerRegistrationParams, Customer, Country, PaymentMethodTranslation, BillingAddress, ShippingAddress, SessionContext, ShippingMethod, PaymentMethod, Currency, ListingResult, Sort, ListingFilter, CreateOrderParams, Order, ShopwareError, CustomerAddress, CalculatedPrice, ReferencePrice, CmsPageResponse, NewsletterInput, SeoUrl, RouteName } from '@shopware-pwa/types';
+import { CmsBlock, CmsSlot, Media, Product, ProductListingResult, EntityResult, ProductReview, PropertyGroup, CrossSelling, Salutation, SectionType, CmsSection, Category, ProductResponse as ProductResponse$1, LandingPage, CmsPage, ShopwareSearchParams, StoreNavigationElement, StoreNavigationType, Cart, LineItem, EntityError, PropertyGroupOption, PropertyGroupOptionCart, LineItemType, CustomerRegistrationParams, Customer, Country, PaymentMethodTranslation, BillingAddress, ShippingAddress, Language, SessionContext, ShippingMethod, PaymentMethod, Currency, ListingResult, Sort, ListingFilter, CreateOrderParams, Order, ShopwareError, CustomerAddress, CalculatedPrice, ReferencePrice, CmsPageResponse, NewsletterInput, SeoUrl, RouteName } from '@shopware-pwa/types';
 import { ShopwareApiInstance, CustomerUpdateProfileParam, CustomerUpdateEmailParam, CustomerUpdatePasswordParam, CustomerResetPasswordParam } from '@shopware-pwa/api-client';
@@ -451,3 +451,11 @@ import { TierPrice } from '@shopware-pwa/helpers-next';
 type UseProductReviewsReturn = {
+    /**
+     * All reviews added to the product
+     */
     productReviews: ComputedRef<ProductReview[]>;
+    /**
+     * Adds a review to the product
+     * @param data `title` - review title, `content` - review content, `points` - review points (range of 1-5)
+     * @returns
+     */
     addReview: (data: {
@@ -458,2 +466,7 @@ title: string;
     }) => Promise<void>;
+    /**
+     * Fetches the reviews list and assigns the result to the `productReviews` property
+     * @param parameters {@link ShopwareSearchParams}
+     * @returns
+     */
     loadProductReviews: (parameters?: ShopwareSearchParams) => Promise<void>;
@@ -490,6 +503,17 @@ };
 type ArrayElement$1<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
-declare function useCmsBlock<BLOCK_TYPE extends CmsBlock>(content: BLOCK_TYPE): {
-    block: BLOCK_TYPE;
-    getSlotContent: (slotName: ArrayElement$1<BLOCK_TYPE["slots"]>["slot"]) => ArrayElement$1<BLOCK_TYPE["slots"]>;
+type UseCmsBlockReturn = {
+    /**
+     * Cms block content
+     */
+    block: CmsBlock;
+    /**
+     * Get slot content by slot name (identifier)
+     * @example getSlotContent("main")
+     */
+    getSlotContent: (slotName: string) => ArrayElement$1<CmsBlock["slots"]>;
 };
+/**
+ * Composable to get cms block content
+ */
+declare function useCmsBlock<BLOCK_TYPE extends CmsBlock>(content: BLOCK_TYPE): UseCmsBlockReturn;
 
@@ -573,2 +597,6 @@ type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
 type UseUserReturn = {
+    /**
+     * Logs-in user with given credentials
+     * @param params - username and password
+     */
     login: (params: {
@@ -578,20 +606,85 @@ username: string;
     }) => Promise<void>;
+    /**
+     * Registers the user for given credentials
+     * @param params {@link CustomerRegistrationParams}
+     * @returns {@link Customer} object on success
+     */
     register: (params: CustomerRegistrationParams) => Promise<Customer>;
+    /**
+     * Whole {@link Customer} object
+     */
     user: ComputedRef<Partial<Customer> | undefined>;
+    /**
+     * Indicates if the user is logged in
+     */
     isLoggedIn: ComputedRef<boolean>;
+    /**
+     * Indicates if the user is logged in as a customer (not a guest)
+     */
     isCustomerSession: ComputedRef<boolean>;
+    /**
+     * Indicates if the user is logged in as a guest
+     */
     isGuestSession: ComputedRef<boolean>;
+    /**
+     * {@link Country} of the user
+     */
     country: Ref<Country | null>;
+    /**
+     * {@link Salutation} of the user
+     */
     salutation: Ref<Salutation | null>;
+    /**
+     * Default billing address id
+     */
     defaultBillingAddressId: ComputedRef<string | null>;
+    /**
+     * Default shipping address id
+     */
     defaultShippingAddressId: ComputedRef<string | null>;
+    /**
+     * Fetches the user data from the API
+     */
     refreshUser: () => Promise<void>;
+    /**
+     * Logs out the user
+     */
     logout: () => Promise<void>;
+    /**
+     * Loads the {@link Country} of the user
+     */
     loadCountry: (countryId: string) => Promise<void>;
+    /**
+     * Loads the {@link Salutation} for given id
+     */
     loadSalutation: (salutationId: string) => Promise<void>;
+    /**
+     * Updates the user profile data
+     * @param personals {@link CustomerUpdateProfileParam}
+     * @returns
+     */
     updatePersonalInfo: (personals: CustomerUpdateProfileParam) => Promise<void>;
+    /**
+     * Updates the user email
+     * @param updateEmailData - {@link CustomerUpdateEmailParam}
+     * @returns
+     */
     updateEmail: (updateEmailData: CustomerUpdateEmailParam) => Promise<void>;
+    /**
+     * Sets the default payment method for given id
+     * @param paymentMethodId
+     * @returns
+     */
     setDefaultPaymentMethod: (paymentMethodId: string) => Promise<void>;
+    /**
+     * Default payment method for the user
+     */
     userDefaultPaymentMethod: ComputedRef<PaymentMethodTranslation | null>;
+    /**
+     * Default billing address for the user
+     */
     userDefaultBillingAddress: ComputedRef<BillingAddress | null>;
+    /**
+     * Default shipping address for the user
+     */
     userDefaultShippingAddress: ComputedRef<ShippingAddress | null>;
@@ -605,7 +698,8 @@ };
 type UseSessionContextReturn = {
+    setLanguage: (language: Partial<Language>) => Promise<void>;
     sessionContext: ComputedRef<SessionContext | undefined>;
     refreshSessionContext: () => Promise<void>;
-    shippingMethod: ComputedRef<ShippingMethod | null>;
+    selectedShippingMethod: ComputedRef<ShippingMethod | null>;
     setShippingMethod: (shippingMethod: Partial<ShippingMethod>) => Promise<void>;
-    paymentMethod: ComputedRef<PaymentMethod | null>;
+    selectedPaymentMethod: ComputedRef<PaymentMethod | null>;
     setPaymentMethod: (paymentMethod: Partial<PaymentMethod>) => Promise<void>;
@@ -620,11 +714,2 @@ currency: ComputedRef<Currency | null>;
     countryId: ComputedRef<string | undefined>;
-    onCurrencyChange: (fn: (params: {
-        currency: Currency;
-    }) => void) => void;
-    onPaymentMethodChange: (fn: (params: {
-        paymentMethod: PaymentMethod;
-    }) => void) => void;
-    onShippingMethodChange: (fn: (params: {
-        shippingMethod: ShippingMethod;
-    }) => void) => void;
     userFromContext: ComputedRef<Customer | undefined>;
@@ -662,21 +747,39 @@ };
 
+type NotificationType = "info" | "warning" | "success" | "danger";
 type Notification = {
-    type: "info" | "warning" | "success" | "danger";
+    type: NotificationType;
     message: string;
     id: number;
 };
+type NotificationOptions = {
+    type?: NotificationType;
+    timeout?: number;
+    persistent?: boolean;
+};
 type UseNotificationsReturn = {
     notifications: ComputedRef<Notification[]>;
     /**
-     * Remove a specific notification by ID
+     * Removes a specific notification by its ID
      */
     removeOne: (id: number) => void;
     /**
-     * Reset the notification list
+     * Resets the notification list - clear all notifications
      */
     removeAll: () => void;
-    pushInfo: (message: string, options?: any) => void;
-    pushWarning: (message: string, options?: any) => void;
-    pushError: (message: string, options?: any) => void;
-    pushSuccess: (message: string, options?: any) => void;
+    /**
+     * Push an info notification to the current list
+     */
+    pushInfo: (message: string, options?: NotificationOptions) => void;
+    /**
+     * Pushes a warning notification to the current list
+     */
+    pushWarning: (message: string, options?: NotificationOptions) => void;
+    /**
+     * Pushes an error notification to the current list
+     */
+    pushError: (message: string, options?: NotificationOptions) => void;
+    /**
+     * Pushes a success notification to the current list
+     */
+    pushSuccess: (message: string, options?: NotificationOptions) => void;
 };
@@ -698,11 +801,44 @@ declare function useNotifications(): UseNotificationsReturn;
 type UseListingReturn<ELEMENTS_TYPE> = {
+    /**
+     * Listing that is currently set
+     * {@link ListingResult} object
+     */
     getInitialListing: ComputedRef<ListingResult<ELEMENTS_TYPE> | null>;
+    /**
+     * Sets the initial listing - available synchronously
+     * @param {@link initialListing} - initial listing to set
+     * @returns
+     */
     setInitialListing: (initialListing: Partial<ListingResult<ELEMENTS_TYPE>>) => Promise<void>;
+    /**
+     * @deprecated - use `search` instead
+     * Searches for the listing based on the criteria
+     * @param criteria {@link ShopwareSearchParams}
+     * @returns
+     */
     initSearch: (criteria: Partial<ShopwareSearchParams>) => Promise<ListingResult<ELEMENTS_TYPE>>;
+    /**
+     * Searches for the listing based on the criteria
+     * @param criteria
+     * @param options - `options.preventRouteChange` - if true, the route will not be changed
+     * @returns
+     */
     search: (criteria: Partial<ShopwareSearchParams>, options?: {
         preventRouteChange?: boolean;
     }) => Promise<void>;
+    /**
+     * Loads more (next page) elements to the listing
+     */
     loadMore: () => Promise<void>;
+    /**
+     * Listing that is currently set
+     */
     getCurrentListing: ComputedRef<Partial<ListingResult<ELEMENTS_TYPE>> | null>;
+    /**
+     * Listing elements ({@link Product}) that are currently set
+     */
     getElements: ComputedRef<ELEMENTS_TYPE[]>;
+    /**
+     * Available sorting orders
+     */
     getSortingOrders: ComputedRef<Sort[] | {
@@ -712,15 +848,63 @@ key: string;
     }[]>;
+    /**
+     * Current sorting order
+     */
     getCurrentSortingOrder: ComputedRef<string | undefined>;
+    /**
+     * Changes the current sorting order
+     * @param order - i.e. "name-asc"
+     * @returns
+     */
     changeCurrentSortingOrder: (order: string) => Promise<void>;
+    /**
+     * Current page number
+     */
     getCurrentPage: ComputedRef<string | number>;
+    /**
+     * Changes the current page number
+     * @param pageNumber - page number to change to
+     * @returns
+     */
     changeCurrentPage: (pageNumber?: number) => Promise<void>;
+    /**
+     * Total number of elements found for the current search criteria
+     */
     getTotal: ComputedRef<number>;
+    /**
+     * Total number of pages found for the current search criteria
+     */
     getTotalPagesCount: ComputedRef<number>;
+    /**
+     * Number of elements per page
+     */
     getLimit: ComputedRef<number>;
+    /**
+     * Initial filters
+     */
     getInitialFilters: ComputedRef<ListingFilter[]>;
+    /**
+     * All available filters
+     */
     getAvailableFilters: ComputedRef<ListingFilter[]>;
+    /**
+     * Filters that are currently set
+     */
     getCurrentFilters: ComputedRef<any>;
+    /**
+     * Sets the filters to be applied for the listing
+     * @param filters
+     * @returns
+     */
     setCurrentFilters: (filters: any) => Promise<void>;
+    /**
+     * Indicates if the listing is being fetched
+     */
     loading: ComputedRef<boolean>;
+    /**
+     * Indicates if the listing is being fetched via `loadMore` method
+     */
     loadingMore: ComputedRef<boolean>;
+    /**
+     * Resets the filters - clears the current filters
+     */
     resetFilters: () => Promise<void>;
@@ -746,4 +930,14 @@ };
 type UseProductReturn = {
+    /**
+     * {@link Product} object
+     */
     product: ComputedRef<Product>;
+    /**
+     * {@link PropertyGroup} array that defines the product possible configurations
+     */
     configurator: ComputedRef<PropertyGroup[]>;
+    /**
+     * Merges the current product with the new variant data
+     * @param variant - {@link Product} object with the new variant data
+     */
     changeVariant: (variant: Partial<Product>) => void;
@@ -754,2 +948,8 @@ };
 type UseProductSearchReturn = {
+    /**
+     * Searches for a product by its id
+     * @param productId
+     * @param options - optional parameters accepts `withCmsAssociations` flag to fetch cms-related associations
+     * @returns {Promise<ProductResponse>}
+     */
     search: (productId: string, options?: {
@@ -766,13 +966,54 @@ withCmsAssociations?: boolean;
 type UseCheckoutReturn = {
+    /**
+     * Fetches all available shipping methods
+     */
     getShippingMethods: (options?: {
         forceReload: boolean;
     }) => Promise<ComputedRef<ShippingMethod[]>>;
+    /**
+     * List of available shipping methods
+     */
     shippingMethods: ComputedRef<ShippingMethod[]>;
+    /**
+     * Fetches all available payment methods
+     */
     getPaymentMethods: (options?: {
         forceReload: boolean;
     }) => Promise<ComputedRef<PaymentMethod[]>>;
+    /**
+     * List of available payment methods
+     */
     paymentMethods: ComputedRef<PaymentMethod[]>;
+    /**
+     * Creates order based on the current cart
+     */
     createOrder: (params?: CreateOrderParams) => Promise<Order>;
+    /**
+     * Shipping address for the current session
+     */
     shippingAddress: ComputedRef<ShippingAddress | undefined>;
+    /**
+     * Billing address for the current session
+     */
     billingAddress: ComputedRef<Partial<BillingAddress> | undefined>;
+    /**
+     * Selected shipping method for the current session
+     * Sugar for {@link useSessionContext.selectedShippingMethod}
+     */
+    selectedShippingMethod: ComputedRef<ShippingMethod | null>;
+    /**
+     * Sets shipping method for the current session
+     * Sugar for {@link useSessionContext.setShippingMethod}
+     */
+    setShippingMethod: (shippingMethod: Partial<ShippingMethod>) => Promise<void>;
+    /**
+     * Selected payment method for the current session
+     * Sugar for {@link useSessionContext.selectedPaymentMethod}
+     */
+    selectedPaymentMethod: ComputedRef<PaymentMethod | null>;
+    /**
+     * Sets payment method for the current session
+     * Sugar for {@link useSessionContext.setPaymentMethod}
+     */
+    setPaymentMethod: (paymentMethod: Partial<PaymentMethod>) => Promise<void>;
 };
@@ -796,9 +1037,33 @@ declare function useCheckout(): UseCheckoutReturn;
 type UseOrderDetailsReturn = {
+    /**
+     * {@link Order} object
+     */
     order: ComputedRef<Order | undefined | null>;
+    /**
+     * Order status (e.g. 'open', 'cancelled')
+     */
     status: ComputedRef<string | undefined>;
+    /**
+     * Order total price
+     */
     total: ComputedRef<number | undefined>;
+    /**
+     * Order subtotal price for all items
+     */
     subtotal: ComputedRef<number | undefined>;
+    /**
+     * Order shipping costs
+     */
     shippingCosts: ComputedRef<number | undefined>;
+    /**
+     * Shipping address
+     */
     shippingAddress: ComputedRef<ShippingAddress | undefined>;
+    /**
+     * Billing address
+     */
     billingAddress: ComputedRef<BillingAddress | undefined>;
+    /**
+     * Basic personal details
+     */
     personalDetails: ComputedRef<{
@@ -809,4 +1074,13 @@ email: string | undefined;
     }>;
+    /**
+     * Payment URL for external payment methods (e.g. async payment in external payment gateway)
+     */
     paymentUrl: Ref<null | string>;
+    /**
+     * Selected shipping method
+     */
     shippingMethod: ComputedRef<ShippingMethod | undefined | null>;
+    /**
+     * Selected payment method
+     */
     paymentMethod: ComputedRef<PaymentMethod | undefined | null>;
@@ -829,2 +1103,7 @@ /**
     cancel: () => Promise<void>;
+    /**
+     * Changes the payment method for current cart.
+     * @param paymentMethodId - ID of the payment method to be set
+     * @returns
+     */
     changePaymentMethod: (paymentMethodId: string) => Promise<void>;
@@ -861,7 +1140,27 @@ };
 type UseProductSearchSuggestReturn = {
+    /**
+     * Current search term
+     */
     searchTerm: Ref<string>;
+    /**
+     * Indicates if the search is in progress
+     */
     loading: ComputedRef<boolean>;
+    /**
+     * Performs the search
+     * @param additionalCriteria - additional search criteria of type {@link ShopwareSearchParams}
+     * @returns
+     */
     search: (additionalCriteria?: Partial<ShopwareSearchParams>) => Promise<void>;
+    /**
+     * Loads more products for current search criteria
+     */
     loadMore: () => Promise<void>;
+    /**
+     * Returns the product list found by the search
+     */
     getProducts: ComputedRef<Product[]>;
+    /**
+     * Returns the total number of products found by the search
+     */
     getTotal: ComputedRef<number>;
@@ -900,4 +1199,13 @@ };
 type UseCustomerOrdersReturn = {
+    /**
+     * All placed orders belonging to the logged-in customer
+     */
     orders: Ref<Order[]>;
+    /**
+     * Changes the current page of the orders list
+     */
     changeCurrentPage: (pageNumber: number | string) => Promise<void>;
+    /**
+     * Fetches the orders list and assigns the result to the `orders` property
+     */
     loadOrders: () => Promise<void>;
@@ -985,4 +1293,16 @@ };
 type UseNewsletterReturn = {
+    /**
+     * Subscribes the user to the newsletter
+     * @param params {@link NewsletterInput}
+     */
     newsletterSubscribe: (params: NewsletterInput) => Promise<void>;
+    /**
+     * Removes the email from the newsletter
+     * @param email
+     */
     newsletterUnsubscribe: (email: string) => Promise<void>;
+    /**
+     * Indicates if the user is subscribed to the newsletter
+     * @returns {true} if the user is subscribed to the newsletter, {false} otherwise
+     */
     isNewsletterSubscriber: () => Promise<any>;
@@ -1044,2 +1364,2 @@ };
 
-export { BoxLayout, CATEGORY_ROUTE_NAME, CategoryResponse, CmsBlockCategoryNavigation, CmsBlockCenterText, CmsBlockCrossSelling, CmsBlockForm, CmsBlockGalleryBuybox, CmsBlockImage, CmsBlockImageBubbleRow, CmsBlockImageCover, CmsBlockImageFourColumn, CmsBlockImageGallery, CmsBlockImageHighlightRow, CmsBlockImageSimpleGrid, CmsBlockImageSlider, CmsBlockImageText, CmsBlockImageTextBubble, CmsBlockImageTextCover, CmsBlockImageTextGallery, CmsBlockImageTextRow, CmsBlockImageThreeColumn, CmsBlockImageThreeCover, CmsBlockImageTwoColumn, CmsBlockProductDescriptionReviews, CmsBlockProductHeading, CmsBlockProductListing, CmsBlockProductSlider, CmsBlockProductThreeColumn, CmsBlockSidebarFilter, CmsBlockText, CmsBlockTextHero, CmsBlockTextOnImage, CmsBlockTextTeaser, CmsBlockTextTeaserSection, CmsBlockTextThreeColumn, CmsBlockTextTwoColumn, CmsBlockVimeoVideo, CmsBlockYoutubeVideo, CmsElementBuyBox, CmsElementCategoryNavigation, CmsElementCrossSelling, CmsElementForm, CmsElementImage, CmsElementImageGallery, CmsElementImageSlider, CmsElementManufacturerLogo, CmsElementProductBox, CmsElementProductDescriptionReviews, CmsElementProductListing, CmsElementProductName, CmsElementProductSlider, CmsElementSidebarFilter, CmsElementText, CmsElementVimeoVideo, CmsElementYoutubeVideo, CmsSectionBlock, CmsSectionDefault, CmsSectionSidebar, DisplayMode, ElementConfig, LANDING_PAGE_ROUTE_NAME, LandingPageResponse, ListingType, Notification, PRODUCT_ROUTE_NAME, Position, ProductResponse, ResourceType, SearchCmsResult, ShopwareContext, SliderElementConfig, SourceType, UseAddToCartReturn, UseAddressReturn, UseCartItemReturn, UseCartReturn, UseCategoryReturn, UseCategorySearchReturn, UseCheckoutReturn, UseCmsElementImage, UseCmsMetaReturn, UseCountriesReturn, UseCustomerOrdersReturn, UseCustomerPasswordReturn, UseInternationalizationReturn, UseLandingSearchReturn, UseListingReturn, UseLocalWishlistReturn, UseNavigationContextReturn, UseNavigationReturn, UseNavigationSearchReturn, UseNewsletterReturn, UseNotificationsReturn, UseOrderDetailsReturn, UsePriceReturn, UseProductAssociationsReturn, UseProductConfiguratorReturn, UseProductPriceReturn, UseProductReturn, UseProductReviewsReturn, UseProductSearchReturn, UseProductSearchSuggestReturn, UseProductWishlistReturn, UseSalutationsReturn, UseSessionContextReturn, UseSyncWishlistReturn, UseUserReturn, UseWishlistReturn, VerticalAlign, createListingComposable, createShopwareContext, getDefaultApiParams, resolveCmsComponent, useAddToCart, useAddress, useCart, useCartItem, useCategory, useCategorySearch, useCheckout, useCmsBlock, useCmsElementConfig, useCmsElementImage, useCmsMeta, useCmsSection, useCountries, useCustomerOrders, useCustomerPassword, useInternationalization, useLandingSearch, useListing, useLocalWishlist, useNavigation, useNavigationContext, useNavigationSearch, useNewsletter, useNotifications, useOrderDetails, usePrice, useProduct, useProductAssociations, useProductConfigurator, useProductPrice, useProductReviews, useProductSearch, useProductSearchSuggest, useProductWishlist, useSalutations, useSessionContext, useShopwareContext, useSyncWishlist, useUser, useWishlist };
+export { BoxLayout, CATEGORY_ROUTE_NAME, CategoryResponse, CmsBlockCategoryNavigation, CmsBlockCenterText, CmsBlockCrossSelling, CmsBlockForm, CmsBlockGalleryBuybox, CmsBlockImage, CmsBlockImageBubbleRow, CmsBlockImageCover, CmsBlockImageFourColumn, CmsBlockImageGallery, CmsBlockImageHighlightRow, CmsBlockImageSimpleGrid, CmsBlockImageSlider, CmsBlockImageText, CmsBlockImageTextBubble, CmsBlockImageTextCover, CmsBlockImageTextGallery, CmsBlockImageTextRow, CmsBlockImageThreeColumn, CmsBlockImageThreeCover, CmsBlockImageTwoColumn, CmsBlockProductDescriptionReviews, CmsBlockProductHeading, CmsBlockProductListing, CmsBlockProductSlider, CmsBlockProductThreeColumn, CmsBlockSidebarFilter, CmsBlockText, CmsBlockTextHero, CmsBlockTextOnImage, CmsBlockTextTeaser, CmsBlockTextTeaserSection, CmsBlockTextThreeColumn, CmsBlockTextTwoColumn, CmsBlockVimeoVideo, CmsBlockYoutubeVideo, CmsElementBuyBox, CmsElementCategoryNavigation, CmsElementCrossSelling, CmsElementForm, CmsElementImage, CmsElementImageGallery, CmsElementImageSlider, CmsElementManufacturerLogo, CmsElementProductBox, CmsElementProductDescriptionReviews, CmsElementProductListing, CmsElementProductName, CmsElementProductSlider, CmsElementSidebarFilter, CmsElementText, CmsElementVimeoVideo, CmsElementYoutubeVideo, CmsSectionBlock, CmsSectionDefault, CmsSectionSidebar, DisplayMode, ElementConfig, LANDING_PAGE_ROUTE_NAME, LandingPageResponse, ListingType, Notification, NotificationOptions, PRODUCT_ROUTE_NAME, Position, ProductResponse, ResourceType, SearchCmsResult, ShopwareContext, SliderElementConfig, SourceType, UseAddToCartReturn, UseAddressReturn, UseCartItemReturn, UseCartReturn, UseCategoryReturn, UseCategorySearchReturn, UseCheckoutReturn, UseCmsBlockReturn, UseCmsElementImage, UseCmsMetaReturn, UseCountriesReturn, UseCustomerOrdersReturn, UseCustomerPasswordReturn, UseInternationalizationReturn, UseLandingSearchReturn, UseListingReturn, UseLocalWishlistReturn, UseNavigationContextReturn, UseNavigationReturn, UseNavigationSearchReturn, UseNewsletterReturn, UseNotificationsReturn, UseOrderDetailsReturn, UsePriceReturn, UseProductAssociationsReturn, UseProductConfiguratorReturn, UseProductPriceReturn, UseProductReturn, UseProductReviewsReturn, UseProductSearchReturn, UseProductSearchSuggestReturn, UseProductWishlistReturn, UseSalutationsReturn, UseSessionContextReturn, UseSyncWishlistReturn, UseUserReturn, UseWishlistReturn, VerticalAlign, createListingComposable, createShopwareContext, getDefaultApiParams, resolveCmsComponent, useAddToCart, useAddress, useCart, useCartItem, useCategory, useCategorySearch, useCheckout, useCmsBlock, useCmsElementConfig, useCmsElementImage, useCmsMeta, useCmsSection, useCountries, useCustomerOrders, useCustomerPassword, useInternationalization, useLandingSearch, useListing, useLocalWishlist, useNavigation, useNavigationContext, useNavigationSearch, useNewsletter, useNotifications, useOrderDetails, usePrice, useProduct, useProductAssociations, useProductConfigurator, useProductPrice, useProductReviews, useProductSearch, useProductSearchSuggest, useProductWishlist, useSalutations, useSessionContext, useShopwareContext, useSyncWishlist, useUser, useWishlist };

package.json

 {
   "name": "@shopware-pwa/composables-next",
-  "version": "0.0.0-canary-20221211144321",
+  "version": "0.0.0-canary-20221214075543",
   "module": "./dist/index.mjs",
@@ -13,4 +13,4 @@ "types": "./dist/index.d.ts",
     "scule": "^1.0.0",
-    "@shopware-pwa/api-client": "0.0.0-canary-20221211144321",
-    "@shopware-pwa/helpers-next": "0.0.0-canary-20221211144321"
+    "@shopware-pwa/api-client": "0.0.0-canary-20221214075543",
+    "@shopware-pwa/helpers-next": "0.0.0-canary-20221214075543"
   },
@@ -25,3 +25,3 @@ "devDependencies": {
     "vue": "^3.2.45",
-    "@shopware-pwa/types": "0.0.0-canary-20221211144321",
+    "@shopware-pwa/types": "0.0.0-canary-20221214075543",
     "eslint-config-shopware": "0.0.0",
@@ -28,0 +28,0 @@ "tsconfig": "0.0.0"

README.md

@@ -15,3 +15,3 @@ # shopware/frontends - composables
 
-### Latest changes: 0.0.0-canary-20221211144321
+### Latest changes: 0.0.0-canary-20221214075543
 
@@ -26,4 +26,6 @@ ### Patch Changes
 
+- [`21d8331`](https://github.com/shopware/frontends/commit/21d8331aff13cef7ed041c60376504b2f324c1f5) Thanks [@mkucmus](https://github.com/mkucmus)! - Move checkout-related methods to useCheckout composable
+
 - Updated dependencies [[`ccf4ed4`](https://github.com/shopware/frontends/commit/ccf4ed47e6bb46d1fcab7c1418a677fe575331b4)]:
-  - @shopware-pwa/api-client@0.0.0-canary-20221211144321
-  - @shopware-pwa/helpers-next@0.0.0-canary-20221211144321
+  - @shopware-pwa/api-client@0.0.0-canary-20221214075543
+  - @shopware-pwa/helpers-next@0.0.0-canary-20221214075543

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

106562

increased by8.62%

Lines of code

3124

increased by11.81%

Number of lines in readme file

30

increased by7.14%

Dependency changes

• + Added@shopware-pwa/api-client@0.0.0-canary-20221214075543(transitive)

• + Added@shopware-pwa/helpers-next@0.0.0-canary-20221214075543(transitive)

• + Added@shopware-pwa/types@0.0.0-canary-20221214075543(transitive)

• - Removed@shopware-pwa/api-client@0.0.0-canary-20221211144321(transitive)

• - Removed@shopware-pwa/helpers-next@0.0.0-canary-20221211144321(transitive)

• - Removed@shopware-pwa/types@0.0.0-canary-20221211144321(transitive)

• Updated@shopware-pwa/api-client@0.0.0-canary-20221214075543

• Updated@shopware-pwa/helpers-next@0.0.0-canary-20221214075543