@shopware/composables 0.0.0-canary-20250116155626

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +172 -0
  3. package/composables/index.ts +1 -0
  4. package/dist/index.d.mts +2239 -0
  5. package/dist/index.d.ts +2239 -0
  6. package/dist/index.mjs +2686 -0
  7. package/nuxt.config.ts +14 -0
  8. package/package.json +83 -0
  9. package/src/_test/index.ts +1 -0
  10. package/src/_test/useSetup.ts +43 -0
  11. package/src/cms/README.md +9 -0
  12. package/src/cms/cmsAssociations.ts +28 -0
  13. package/src/cms/index.ts +2 -0
  14. package/src/cms/useCmsElementConfig.test.ts +145 -0
  15. package/src/cms/useCmsElementConfig.ts +29 -0
  16. package/src/cms/useCmsElementImage.test.ts +179 -0
  17. package/src/cms/useCmsElementImage.ts +103 -0
  18. package/src/cms/useCmsElementProductBox.test.ts +15 -0
  19. package/src/cms/useCmsElementProductBox.ts +25 -0
  20. package/src/createShopwareContext.test.ts +23 -0
  21. package/src/createShopwareContext.ts +43 -0
  22. package/src/devtools/plugin.ts +201 -0
  23. package/src/helpers/ContextError.spec.ts +20 -0
  24. package/src/helpers/ContextError.ts +6 -0
  25. package/src/index.test.ts +54 -0
  26. package/src/index.ts +111 -0
  27. package/src/mocks/Cart.ts +774 -0
  28. package/src/mocks/CmsPage.ts +544 -0
  29. package/src/mocks/CmsProductBox.ts +377 -0
  30. package/src/mocks/Configurator.ts +123 -0
  31. package/src/mocks/Country.ts +184 -0
  32. package/src/mocks/CrossSellingResponse.ts +552 -0
  33. package/src/mocks/LandingPage.ts +62 -0
  34. package/src/mocks/Menu.ts +598 -0
  35. package/src/mocks/Order.ts +1151 -0
  36. package/src/mocks/Product.ts +473 -0
  37. package/src/mocks/ProductTierPrices.ts +771 -0
  38. package/src/mocks/Salutations.ts +51 -0
  39. package/src/mocks/Search.ts +518 -0
  40. package/src/types/cmsBlockTypes.ts +80 -0
  41. package/src/types/cmsElementTypes.ts +381 -0
  42. package/src/types/cmsSectionTypes.ts +15 -0
  43. package/src/types/index.ts +52 -0
  44. package/src/useAddToCart/useAddToCart.test.ts +39 -0
  45. package/src/useAddToCart/useAddToCart.ts +90 -0
  46. package/src/useAddress/useAddress.test.ts +134 -0
  47. package/src/useAddress/useAddress.ts +202 -0
  48. package/src/useB2bQuoteManagement/useB2bQuoteManagement.test.ts +137 -0
  49. package/src/useB2bQuoteManagement/useB2bQuoteManagement.ts +225 -0
  50. package/src/useBreadcrumbs/useBreadcrumbs.test.ts +71 -0
  51. package/src/useBreadcrumbs/useBreadcrumbs.ts +89 -0
  52. package/src/useCart/useCart.test.ts +251 -0
  53. package/src/useCart/useCart.ts +314 -0
  54. package/src/useCartErrorParamsResolver/useCartErrorParamsResolver.test.ts +122 -0
  55. package/src/useCartErrorParamsResolver/useCartErrorParamsResolver.ts +80 -0
  56. package/src/useCartItem/useCartItem.test.ts +168 -0
  57. package/src/useCartItem/useCartItem.ts +157 -0
  58. package/src/useCartNotification/useCartNotification.test.ts +129 -0
  59. package/src/useCartNotification/useCartNotification.ts +63 -0
  60. package/src/useCategory/useCategory.test.ts +14 -0
  61. package/src/useCategory/useCategory.ts +32 -0
  62. package/src/useCategorySearch/useCategorySearch.test.ts +98 -0
  63. package/src/useCategorySearch/useCategorySearch.ts +81 -0
  64. package/src/useCheckout/useCheckout.test.ts +104 -0
  65. package/src/useCheckout/useCheckout.ts +163 -0
  66. package/src/useCmsBlock/useCmsBlock.test.ts +25 -0
  67. package/src/useCmsBlock/useCmsBlock.ts +36 -0
  68. package/src/useCmsMeta/useCmsMeta.test.ts +17 -0
  69. package/src/useCmsMeta/useCmsMeta.ts +46 -0
  70. package/src/useCmsSection/useCmsSection.test.ts +18 -0
  71. package/src/useCmsSection/useCmsSection.ts +39 -0
  72. package/src/useCmsTranslations/useCmsTranslations.test.ts +10 -0
  73. package/src/useCmsTranslations/useCmsTranslations.ts +9 -0
  74. package/src/useContext/useContext.ts +36 -0
  75. package/src/useCountries/useCountries.test.ts +64 -0
  76. package/src/useCountries/useCountries.ts +64 -0
  77. package/src/useCustomerOrders/useCustomerOrders.test.ts +47 -0
  78. package/src/useCustomerOrders/useCustomerOrders.ts +89 -0
  79. package/src/useCustomerPassword/useCustomerPassword.test.ts +164 -0
  80. package/src/useCustomerPassword/useCustomerPassword.ts +57 -0
  81. package/src/useDefaultOrderAssociations/useDefaultOrderAssociations.test.ts +41 -0
  82. package/src/useDefaultOrderAssociations/useDefaultOrderAssociations.ts +45 -0
  83. package/src/useInternationalization/useInternationalization.test.ts +155 -0
  84. package/src/useInternationalization/useInternationalization.ts +159 -0
  85. package/src/useLandingSearch/useLandingSearch.test.ts +30 -0
  86. package/src/useLandingSearch/useLandingSearch.ts +58 -0
  87. package/src/useListing/useListing.test.ts +249 -0
  88. package/src/useListing/useListing.ts +592 -0
  89. package/src/useLocalWishlist/useLocalWishlist.test.ts +54 -0
  90. package/src/useLocalWishlist/useLocalWishlist.ts +95 -0
  91. package/src/useNavigation/useNavigation.test.ts +68 -0
  92. package/src/useNavigation/useNavigation.ts +83 -0
  93. package/src/useNavigationContext/useNavigationContext.test.ts +48 -0
  94. package/src/useNavigationContext/useNavigationContext.ts +39 -0
  95. package/src/useNavigationSearch/useNavigationSearch.test.ts +110 -0
  96. package/src/useNavigationSearch/useNavigationSearch.ts +60 -0
  97. package/src/useNewsletter/useNewsletter.test.ts +55 -0
  98. package/src/useNewsletter/useNewsletter.ts +109 -0
  99. package/src/useNotifications/useNotifications.test.ts +56 -0
  100. package/src/useNotifications/useNotifications.ts +119 -0
  101. package/src/useOrderDetails/useOrderDetails.test.ts +224 -0
  102. package/src/useOrderDetails/useOrderDetails.ts +329 -0
  103. package/src/useOrderPayment/useOrderPayment.test.ts +80 -0
  104. package/src/useOrderPayment/useOrderPayment.ts +119 -0
  105. package/src/usePrice/usePrice.test.ts +97 -0
  106. package/src/usePrice/usePrice.ts +106 -0
  107. package/src/useProduct/useProduct.test.ts +36 -0
  108. package/src/useProduct/useProduct.ts +56 -0
  109. package/src/useProductAssociations/useProductAssociations.spec.ts +105 -0
  110. package/src/useProductAssociations/useProductAssociations.ts +107 -0
  111. package/src/useProductConfigurator/useProductConfigurator.spec.ts +77 -0
  112. package/src/useProductConfigurator/useProductConfigurator.ts +134 -0
  113. package/src/useProductPrice/useProductPrice.test.ts +126 -0
  114. package/src/useProductPrice/useProductPrice.ts +131 -0
  115. package/src/useProductReviews/useProductReviews.test.ts +45 -0
  116. package/src/useProductReviews/useProductReviews.ts +80 -0
  117. package/src/useProductSearch/useProductSearch.test.ts +37 -0
  118. package/src/useProductSearch/useProductSearch.ts +58 -0
  119. package/src/useProductSearchSuggest/useProductSearchSuggest.test.ts +19 -0
  120. package/src/useProductSearchSuggest/useProductSearchSuggest.ts +67 -0
  121. package/src/useProductWishlist/useProductWishlist.test.ts +63 -0
  122. package/src/useProductWishlist/useProductWishlist.ts +74 -0
  123. package/src/useSalutations/useSalutations.spec.ts +37 -0
  124. package/src/useSalutations/useSalutations.ts +55 -0
  125. package/src/useSessionContext/useSessionContext.test.ts +221 -0
  126. package/src/useSessionContext/useSessionContext.ts +281 -0
  127. package/src/useShopwareContext/useShopwareContext.test.ts +8 -0
  128. package/src/useShopwareContext/useShopwareContext.ts +31 -0
  129. package/src/useSyncWishlist/useSyncWishlist.test.ts +117 -0
  130. package/src/useSyncWishlist/useSyncWishlist.ts +117 -0
  131. package/src/useUrlResolver/useUrlResolver.test.ts +25 -0
  132. package/src/useUrlResolver/useUrlResolver.ts +31 -0
  133. package/src/useUser/useUser.test.ts +290 -0
  134. package/src/useUser/useUser.ts +321 -0
  135. package/src/useWishlist/useWishlist.test.ts +178 -0
  136. package/src/useWishlist/useWishlist.ts +128 -0
  137. package/types/api-types.ts +11 -0
@@ -0,0 +1,2239 @@
1
+ import * as vue from 'vue';
2
+ import { CSSProperties, ComputedRef, AnchorHTMLAttributes, ImgHTMLAttributes, App, EffectScope, Ref } from 'vue';
3
+ import { createAPIClient, ApiError } from '@shopware/api-client';
4
+ import { operations as operations$1, components } from '@shopware/api-client/store-api-types';
5
+ import { getListingFilters, TierPrice } from '@shopware-pwa/helpers-next';
6
+
7
+ type operations = operations$1;
8
+ type Schemas = components["schemas"];
9
+ type ApiClient = ReturnType<typeof createAPIClient<operations>>;
10
+
11
+ type BlockType<SLOT_NAMES> = Schemas["CmsBlock"] & {
12
+ slots: Array<Schemas["CmsSlot"] & {
13
+ slot: SLOT_NAMES;
14
+ }>;
15
+ };
16
+ type THREE_COLUMNS = "left" | "center" | "right";
17
+ type TWO_COLUMNS = "left" | "right";
18
+ type CmsBlockText = BlockType<"content">;
19
+ type CmsBlockTextHero = BlockType<"content">;
20
+ type CmsBlockTextTeaser = BlockType<"content">;
21
+ type CmsBlockTextTeaserSection = BlockType<TWO_COLUMNS>;
22
+ type CmsBlockTextTwoColumn = BlockType<TWO_COLUMNS>;
23
+ type CmsBlockTextThreeColumn = BlockType<THREE_COLUMNS>;
24
+ type CmsBlockImage = BlockType<"image">;
25
+ type CmsBlockImageCover = BlockType<"image">;
26
+ type CmsBlockImageTwoColumn = BlockType<TWO_COLUMNS>;
27
+ type CmsBlockImageThreeColumn = BlockType<THREE_COLUMNS>;
28
+ type CmsBlockImageThreeCover = BlockType<THREE_COLUMNS>;
29
+ type CmsBlockImageFourColumn = BlockType<"left" | "center-left" | "center-right" | "right">;
30
+ type CmsBlockImageBubbleRow = BlockType<THREE_COLUMNS>;
31
+ type CmsBlockImageHighlightRow = BlockType<THREE_COLUMNS>;
32
+ type CmsBlockImageSimpleGrid = BlockType<"left-top" | "left-bottom" | "right">;
33
+ type CmsBlockImageSlider = BlockType<"imageSlider">;
34
+ type CmsBlockImageGallery = BlockType<"imageGallery">;
35
+ type CmsBlockYoutubeVideo = BlockType<"video">;
36
+ type CmsBlockVimeoVideo = BlockType<"video">;
37
+ type CmsBlockImageText = BlockType<TWO_COLUMNS>;
38
+ type CmsBlockImageTextCover = BlockType<TWO_COLUMNS>;
39
+ type CmsBlockCenterText = BlockType<THREE_COLUMNS>;
40
+ type CmsBlockImageTextRow = BlockType<"left-image" | "left-text" | "center-image" | "center-text" | "right-image" | "right-text">;
41
+ type CmsBlockImageTextGallery = BlockType<"left-image" | "left-text" | "center-image" | "center-text" | "right-image" | "right-text">;
42
+ type CmsBlockImageTextBubble = BlockType<"left-image" | "left-text" | "center-image" | "center-text" | "right-image" | "right-text">;
43
+ type CmsBlockTextOnImage = BlockType<"content">;
44
+ type CmsBlockSidebarFilter = BlockType<"content">;
45
+ type CmsBlockCategoryNavigation = BlockType<"content">;
46
+ type CmsBlockProductHeading = BlockType<TWO_COLUMNS>;
47
+ type CmsBlockProductThreeColumn = BlockType<THREE_COLUMNS>;
48
+ type CmsBlockProductListing = BlockType<"content">;
49
+ type CmsBlockProductSlider = BlockType<"productSlider">;
50
+ type CmsBlockGalleryBuybox = BlockType<TWO_COLUMNS>;
51
+ type CmsBlockProductDescriptionReviews = BlockType<"content">;
52
+ type CmsBlockCrossSelling = BlockType<"content">;
53
+ type CmsBlockForm = BlockType<"content">;
54
+
55
+ type SourceType = "static" | "mapped";
56
+ type Position = "left" | "center" | "right";
57
+ type DisplayMode = Exclude<CSSProperties["objectFit"], undefined> | "standard";
58
+ type BoxLayout = "standard" | "image" | "minimal";
59
+ type VerticalAlign = "flex-start" | "center" | "flex-end" | "";
60
+ type ElementConfig<VALUE_TYPE> = {
61
+ source: SourceType;
62
+ value: VALUE_TYPE;
63
+ };
64
+ type TextElementConfig = {
65
+ content: ElementConfig<string>;
66
+ verticalAlign: ElementConfig<VerticalAlign>;
67
+ };
68
+ type ElementFieldConfig = {
69
+ name: string;
70
+ source: SourceType;
71
+ value: string | null;
72
+ apiAlias: string;
73
+ };
74
+ type CmsElementText = Schemas["CmsSlot"] & {
75
+ type: "text" | typeof String;
76
+ slot: typeof String;
77
+ config: TextElementConfig;
78
+ fieldConfig: ElementFieldConfig[];
79
+ data: {
80
+ content: string;
81
+ apiAlias: "cms_text";
82
+ };
83
+ translated: {
84
+ config: TextElementConfig;
85
+ };
86
+ };
87
+ type ImageElementConfig = {
88
+ url: ElementConfig<string>;
89
+ media: ElementConfig<string>;
90
+ newTab: ElementConfig<boolean>;
91
+ product: ElementConfig<string>;
92
+ boxLayout: ElementConfig<BoxLayout>;
93
+ displayMode: ElementConfig<DisplayMode>;
94
+ minHeight: ElementConfig<string | number>;
95
+ verticalAlign: ElementConfig<VerticalAlign>;
96
+ horizontalAlign: ElementConfig<VerticalAlign>;
97
+ };
98
+ type CmsElementImage = Schemas["CmsSlot"] & {
99
+ type: "image";
100
+ config: ImageElementConfig;
101
+ data: {
102
+ mediaId: string;
103
+ url: string;
104
+ newTab: boolean;
105
+ apiAlias: "cms_image";
106
+ media: Schemas["Media"];
107
+ };
108
+ };
109
+ type SliderElementConfig = {
110
+ minWidth?: ElementConfig<string>;
111
+ minHeight: ElementConfig<string | number>;
112
+ verticalAlign?: ElementConfig<VerticalAlign>;
113
+ displayMode?: ElementConfig<"standard" | "cover" | "contain">;
114
+ navigationDots?: ElementConfig<"outside" | "inside" | "">;
115
+ navigationArrows?: ElementConfig<"outside" | "inside" | "">;
116
+ };
117
+ type ImageSliderElementConfig = ImageElementConfig & SliderElementConfig & {
118
+ sliderItems: ElementConfig<Array<{
119
+ url: null | string;
120
+ newTab: boolean;
121
+ mediaId: string;
122
+ mediaUrl: string;
123
+ }>>;
124
+ };
125
+ type CmsElementImageSlider = Schemas["CmsSlot"] & {
126
+ type: "image-slider";
127
+ config: ImageSliderElementConfig;
128
+ data: {
129
+ apiAlias: "cms_image_slider";
130
+ navigation: unknown;
131
+ sliderItems: {
132
+ url: string;
133
+ newTab: boolean;
134
+ media: Schemas["Media"];
135
+ mediaId: string;
136
+ apiAlias: "cms_image_slider_item";
137
+ }[];
138
+ };
139
+ };
140
+ type ImageGalleryElementConfig = ImageSliderElementConfig & {
141
+ galleryPosition: ElementConfig<Position>;
142
+ magnifierOverGallery: ElementConfig<boolean>;
143
+ keepAspectRatioOnZoom: ElementConfig<boolean>;
144
+ fullScreen: ElementConfig<boolean>;
145
+ zoom: ElementConfig<boolean>;
146
+ };
147
+ type CmsElementImageGallery = Schemas["CmsSlot"] & {
148
+ type: "image-gallery";
149
+ config: ImageGalleryElementConfig;
150
+ data: {
151
+ apiAlias: "cms_image_slider";
152
+ navigation: unknown;
153
+ sliderItems: Array<{
154
+ url: null | string;
155
+ newTab: boolean;
156
+ media: Schemas["Media"];
157
+ apiAlias: "cms_image_slider_item";
158
+ } | Schemas["ProductMedia"]>;
159
+ };
160
+ };
161
+ type YouTubeVideoElementConfig = {
162
+ end: ElementConfig<string>;
163
+ url: ElementConfig<string>;
164
+ loop: ElementConfig<boolean>;
165
+ start: ElementConfig<string>;
166
+ videoID: ElementConfig<string>;
167
+ autoPlay: ElementConfig<boolean>;
168
+ displayMode: ElementConfig<DisplayMode>;
169
+ previewMedia: ElementConfig<string>;
170
+ showControls: ElementConfig<boolean>;
171
+ needsConfirmation: ElementConfig<boolean>;
172
+ advancePrivacyMode: ElementConfig<boolean>;
173
+ };
174
+ type CmsElementYoutubeVideo = Schemas["CmsSlot"] & {
175
+ type: "youtube-video";
176
+ config: YouTubeVideoElementConfig;
177
+ data: {
178
+ mediaId: string | null;
179
+ url: null | string;
180
+ newTab: null | boolean;
181
+ media: null | Schemas["Media"];
182
+ apiAlias: "cms_image";
183
+ };
184
+ };
185
+ type VimeoVideoElementConfig = {
186
+ loop: ElementConfig<boolean>;
187
+ color: ElementConfig<string>;
188
+ title: ElementConfig<boolean>;
189
+ mute: ElementConfig<boolean>;
190
+ byLine: ElementConfig<boolean>;
191
+ videoID: ElementConfig<string>;
192
+ autoplay: ElementConfig<boolean>;
193
+ controls: ElementConfig<boolean>;
194
+ portrait: ElementConfig<boolean>;
195
+ doNotTrack: ElementConfig<boolean>;
196
+ previewMedia: ElementConfig<string>;
197
+ needsConfirmation: ElementConfig<boolean>;
198
+ };
199
+ type CmsElementVimeoVideo = Schemas["CmsSlot"] & {
200
+ type: "vimeo-video";
201
+ config: VimeoVideoElementConfig;
202
+ data: {
203
+ mediaId: string | null;
204
+ url: null | string;
205
+ newTab: null | boolean;
206
+ media: null | Schemas["Media"];
207
+ apiAlias: "cms_image";
208
+ };
209
+ };
210
+ type ProductBoxElementConfig = {
211
+ boxLayout: ElementConfig<BoxLayout>;
212
+ product: ElementConfig<string>;
213
+ };
214
+ type CmsElementProductBox = Schemas["CmsSlot"] & {
215
+ type: "product-box";
216
+ config: ProductBoxElementConfig;
217
+ data: {
218
+ productId: string;
219
+ product: Schemas["Product"];
220
+ apiAlias: "cms_product_box";
221
+ };
222
+ };
223
+ type ProductSliderElementConfig = {
224
+ title: ElementConfig<string>;
225
+ border: ElementConfig<boolean>;
226
+ rotate: ElementConfig<boolean>;
227
+ products: ElementConfig<string[]>;
228
+ boxLayout: ElementConfig<BoxLayout>;
229
+ elMinWidth: ElementConfig<string>;
230
+ navigation: ElementConfig<boolean>;
231
+ displayMode: ElementConfig<DisplayMode>;
232
+ verticalAlign: ElementConfig<VerticalAlign>;
233
+ productStream: ElementConfig<string>;
234
+ productStreamSorting: ElementConfig<string>;
235
+ };
236
+ type CmsElementProductSlider = Schemas["CmsSlot"] & {
237
+ type: "product-slider";
238
+ config: ProductSliderElementConfig;
239
+ data: {
240
+ apiAlias: "cms_product_slider";
241
+ products: Schemas["Product"][];
242
+ };
243
+ };
244
+ type CmsSidebarFilterElementConfig = {
245
+ boxLayout: ElementConfig<BoxLayout>;
246
+ content: ElementConfig<string>;
247
+ displayMode: ElementConfig<DisplayMode>;
248
+ media: ElementConfig<string>;
249
+ minHeight: ElementConfig<string | number>;
250
+ newTab: ElementConfig<boolean>;
251
+ url: ElementConfig<string>;
252
+ verticalAlign: ElementConfig<VerticalAlign>;
253
+ };
254
+ type CmsElementSidebarFilter = Schemas["CmsSlot"] & {
255
+ type: "sidebar-filter";
256
+ config: CmsSidebarFilterElementConfig;
257
+ };
258
+ type CmsProductListingElementConfig = {
259
+ filters: ElementConfig<string>;
260
+ boxLayout: ElementConfig<BoxLayout>;
261
+ showSorting: ElementConfig<boolean>;
262
+ defaultSorting: ElementConfig<string>;
263
+ useCustomSorting: ElementConfig<boolean>;
264
+ availableSortings: ElementConfig<string[]>;
265
+ propertyWhitelist: ElementConfig<string[]>;
266
+ };
267
+ type CmsElementProductListing = Schemas["CmsSlot"] & {
268
+ type: "product-listing";
269
+ config: CmsProductListingElementConfig;
270
+ data: {
271
+ apiAlias: "cms_product_listing";
272
+ listing: Schemas["ProductListingResult"];
273
+ };
274
+ };
275
+ type CategoryNavigationElementConfig = unknown;
276
+ type CmsElementCategoryNavigation = Schemas["CmsSlot"] & {
277
+ type: "category-navigation";
278
+ config: CategoryNavigationElementConfig;
279
+ };
280
+ type ProductDescriptionReviewsElementConfig = {
281
+ product: ElementConfig<string>;
282
+ alignment: ElementConfig<VerticalAlign>;
283
+ };
284
+ type CmsElementProductDescriptionReviews = Schemas["CmsSlot"] & {
285
+ type: "product-description-reviews";
286
+ config: ProductDescriptionReviewsElementConfig;
287
+ data: {
288
+ productId: null | string;
289
+ ratingSuccess: boolean;
290
+ product?: Schemas["Product"];
291
+ reviews: {
292
+ elements: Schemas["ProductReview"][];
293
+ };
294
+ apiAlias: "cms_product_description_reviews";
295
+ };
296
+ };
297
+ type BuyBoxElementConfig = ProductDescriptionReviewsElementConfig;
298
+ type CmsElementBuyBox = Schemas["CmsSlot"] & {
299
+ type: "buy-box";
300
+ config: BuyBoxElementConfig;
301
+ data: {
302
+ configuratorSettings: Schemas["PropertyGroup"][] | null;
303
+ productId: null | string;
304
+ ratingSuccess: boolean;
305
+ product?: Schemas["Product"];
306
+ reviews: Schemas["ProductReview"][];
307
+ apiAlias: "cms_product_description_reviews";
308
+ };
309
+ };
310
+ type CrossSellingElementConfig = {
311
+ product: ElementConfig<string>;
312
+ alignment: ElementConfig<VerticalAlign>;
313
+ boxLayout: ElementConfig<BoxLayout>;
314
+ elMinWidth: ElementConfig<string>;
315
+ displayMode: ElementConfig<DisplayMode>;
316
+ };
317
+ type CmsElementCrossSelling = Schemas["CmsSlot"] & {
318
+ type: "cross-selling";
319
+ config: CrossSellingElementConfig;
320
+ data: {
321
+ apiAlias: "cms_cross_selling";
322
+ crossSellings: Schemas["CrossSellingElement"][];
323
+ };
324
+ };
325
+ type FormElementConfig = {
326
+ type: ElementConfig<"contact" | "newsletter">;
327
+ title: ElementConfig<string>;
328
+ mailReceiver: ElementConfig<string[]>;
329
+ confirmationText: ElementConfig<string>;
330
+ defaultMailReceiver: ElementConfig<boolean>;
331
+ };
332
+ type CmsElementForm = Schemas["CmsSlot"] & {
333
+ type: "form";
334
+ config: FormElementConfig;
335
+ data: Schemas["Salutation"][];
336
+ };
337
+ type CmsElementProductName = Schemas["CmsSlot"] & {
338
+ type: "product-name";
339
+ config: TextElementConfig;
340
+ fieldConfig: ElementFieldConfig[];
341
+ data: {
342
+ content: string;
343
+ apiAlias: "cms_text";
344
+ };
345
+ translated: {
346
+ config: TextElementConfig;
347
+ };
348
+ };
349
+ type CmsElementManufacturerLogo = Schemas["CmsSlot"] & {
350
+ type: "manufacturer-logo";
351
+ config: ImageElementConfig;
352
+ data: {
353
+ mediaId: string;
354
+ url: string;
355
+ newTab: boolean;
356
+ apiAlias: "cms_manufacturer_logo";
357
+ media: Schemas["Media"];
358
+ };
359
+ };
360
+
361
+ type CmsSectionBlock<TYPE extends Schemas["CmsSection"]["type"], SECTION_POSITIONS> = Schemas["CmsSection"] & {
362
+ type: TYPE;
363
+ blocks: Array<Schemas["CmsBlock"] & {
364
+ sectionPosition: SECTION_POSITIONS;
365
+ }>;
366
+ };
367
+ type CmsSectionDefault = CmsSectionBlock<"default", "main">;
368
+ type CmsSectionSidebar = CmsSectionBlock<"sidebar", "sidebar" | "main">;
369
+
370
+ type ImageContainerAttrs = {
371
+ href?: string;
372
+ target?: string;
373
+ rel?: string;
374
+ };
375
+ type UseCmsElementImage = {
376
+ containerStyle: ComputedRef<CSSProperties>;
377
+ anchorAttrs: ComputedRef<AnchorHTMLAttributes>;
378
+ imageAttrs: ComputedRef<ImgHTMLAttributes>;
379
+ imageContainerAttrs: ComputedRef<ImageContainerAttrs>;
380
+ imageLink: ComputedRef<{
381
+ newTab: boolean;
382
+ url: string;
383
+ }>;
384
+ displayMode: ComputedRef<DisplayMode>;
385
+ isVideoElement: ComputedRef<boolean>;
386
+ mimeType: ComputedRef<string | undefined>;
387
+ };
388
+ /**
389
+ * Composable to get cms element image
390
+ *
391
+ * @category CMS (Shopping Experiences)
392
+ */
393
+ declare function useCmsElementImage(element: CmsElementImage | CmsElementManufacturerLogo): UseCmsElementImage;
394
+
395
+ /**
396
+ * Composable to get cms element config
397
+ *
398
+ * @category CMS (Shopping Experiences)
399
+ */
400
+ declare function useCmsElementConfig<T extends Schemas["CmsSlot"] & {
401
+ config: T["config"] extends {
402
+ [key in infer X extends keyof T["config"]]: ElementConfig<unknown>;
403
+ } ? {
404
+ [key in X]: ElementConfig<T["config"][key]["value"]>;
405
+ } : never;
406
+ }>(element: T): {
407
+ getConfigValue: <ELEMENT_CONFIG extends keyof T["config"]>(key: ELEMENT_CONFIG) => (typeof element.config)[ELEMENT_CONFIG]["value"];
408
+ };
409
+
410
+ declare function createShopwareContext(app: App, options: {
411
+ devStorefrontUrl?: string | null;
412
+ enableDevtools?: boolean;
413
+ }): vue.Raw<{
414
+ install(app: App): void;
415
+ _a: App<any>;
416
+ _e: EffectScope;
417
+ devStorefrontUrl: string | null | undefined;
418
+ state: {
419
+ interceptors: {};
420
+ } | undefined;
421
+ }>;
422
+
423
+ type UseAddressReturn = {
424
+ /**
425
+ * List of customer addresses
426
+ */
427
+ customerAddresses: ComputedRef<Schemas["CustomerAddress"][]>;
428
+ /**
429
+ * Loads the addresses that are available under `customerAddresses` property
430
+ */
431
+ loadCustomerAddresses(): Promise<Schemas["CustomerAddress"][]>;
432
+ /**
433
+ * Allows to create new address for a current customer
434
+ */
435
+ createCustomerAddress(customerAddress: Schemas["CustomerAddress"]): Promise<Schemas["CustomerAddress"]>;
436
+ /**
437
+ * Allows to update existing address for a current customer
438
+ */
439
+ updateCustomerAddress(customerAddress: Schemas["CustomerAddress"]): Promise<Schemas["CustomerAddress"]>;
440
+ /**
441
+ * Allows to delete existing address for a current customer
442
+ */
443
+ deleteCustomerAddress(addressId: string): Promise<void>;
444
+ /**
445
+ * Sets the address for given ID as default billing address
446
+ */
447
+ setDefaultCustomerBillingAddress(addressId: string): Promise<string>;
448
+ /**
449
+ * Sets the address for given ID as default shipping address
450
+ */
451
+ setDefaultCustomerShippingAddress(addressId: string): Promise<string>;
452
+ /**
453
+ * Returns formatted error message
454
+ *
455
+ * @param {ShopwareError} error
456
+ */
457
+ errorMessageBuilder(error: ApiError): string | null;
458
+ };
459
+ /**
460
+ * Composable to manage customer addresses
461
+ *
462
+ * With this composable you can:
463
+ * - Fetch customer addresses
464
+ * - Return customer addresses
465
+ * - Create new customer address
466
+ * - Update existing customer address
467
+ * - Delete existing customer address
468
+ * - Set default billing address
469
+ * - Set default shipping address
470
+ * - Format error message
471
+ *
472
+ * @public
473
+ *
474
+ * @category Cart & Checkout
475
+ */
476
+ declare function useAddress(): UseAddressReturn;
477
+
478
+ type UseAddToCartReturn = {
479
+ /**
480
+ * Add to cart method
481
+ * @type {function}
482
+ */
483
+ addToCart(): Promise<Schemas["Cart"]>;
484
+ /**
485
+ * If you want to add more that 1 product set quantity before invoking `addToCart`
486
+ */
487
+ quantity: Ref<number>;
488
+ /**
489
+ * Returns product count in stock
490
+ */
491
+ getStock: ComputedRef<number | undefined>;
492
+ /**
493
+ * Returns product count in available stock
494
+ */
495
+ getAvailableStock: ComputedRef<number | undefined>;
496
+ /**
497
+ * Flag if product is already in cart
498
+ */
499
+ isInCart: ComputedRef<boolean>;
500
+ /**
501
+ * count of the product quantity already in the cart
502
+ */
503
+ count: ComputedRef<number>;
504
+ };
505
+ /**
506
+ * Composable to manage adding product to cart
507
+ *
508
+ * With this composable you can:
509
+ * - Add product to cart
510
+ * - Get product quantity
511
+ * - Get product stock
512
+ * - Get product available stock
513
+ * - Check if product is in cart
514
+ * - Get product count in cart
515
+ *
516
+ * @public
517
+ * @category Cart & Checkout
518
+ */
519
+ declare function useAddToCart(product: Ref<Schemas["Product"] | undefined>): UseAddToCartReturn;
520
+
521
+ /**
522
+ * @internal
523
+ */
524
+ type Breadcrumb = {
525
+ name: string;
526
+ path?: string;
527
+ } | Schemas["Breadcrumb"];
528
+ /**
529
+ * @public
530
+ */
531
+ type UseBreadcrumbsReturn = {
532
+ /**
533
+ * Clear breadcrumbs store
534
+ */
535
+ clearBreadcrumbs(): void;
536
+ /**
537
+ * List of breadcrumbs
538
+ */
539
+ breadcrumbs: ComputedRef<Breadcrumb[]>;
540
+ /**
541
+ * Build breadcrumbs dynamically for a category by fetching them from the API
542
+ *
543
+ * @param {operations["readBreadcrumb get /breadcrumb/{id}"]["response"]} breadcrumbs
544
+ */
545
+ buildDynamicBreadcrumbs(breadcrumbs: operations["readBreadcrumb get /breadcrumb/{id}"]["response"]): Promise<void>;
546
+ /**
547
+ * Add a breadcrumb to the breadcrumbs list
548
+ *
549
+ * @param {Breadcrumb} breadcrumb
550
+ */
551
+ pushBreadcrumb(breadcrumb: Breadcrumb): void;
552
+ };
553
+ /**
554
+ * Composable for breadcrumbs management.
555
+ * Read the [guide](https://frontends.shopware.com/getting-started/page-elements/breadcrumbs.html#building-breadcrumbs-for-cms-pages).
556
+ *
557
+ * @public
558
+ * @category CMS (Shopping Experiences)
559
+ */
560
+ declare function useBreadcrumbs(newBreadcrumbs?: Breadcrumb[]): UseBreadcrumbsReturn;
561
+
562
+ /**
563
+ * Composable to manage cart
564
+ *
565
+ * @public
566
+ * @category Cart & Checkout
567
+ */
568
+ type UseCartReturn = {
569
+ /**
570
+ * Add product by id and quantity
571
+ */
572
+ addProduct(params: {
573
+ id: string;
574
+ quantity?: number;
575
+ }): Promise<Schemas["Cart"]>;
576
+ /**
577
+ * Add products by array of items
578
+ */
579
+ addProducts(items: operations["addLineItem post /checkout/cart/line-item"]["body"]["items"]): Promise<Schemas["Cart"]>;
580
+ /**
581
+ * Adds a promotion code to the cart
582
+ */
583
+ addPromotionCode(promotionCode: string): Promise<Schemas["Cart"]>;
584
+ /**
585
+ * Lists all applied and active promotion codes
586
+ */
587
+ appliedPromotionCodes: ComputedRef<Schemas["LineItem"][]>;
588
+ /**
589
+ * Current Cart object
590
+ */
591
+ cart: ComputedRef<Schemas["Cart"] | undefined>;
592
+ /**
593
+ * All items in the cart
594
+ */
595
+ cartItems: ComputedRef<Schemas["LineItem"][]>;
596
+ /**
597
+ * Changes the quantity of a product in the cart
598
+ */
599
+ changeProductQuantity(params: {
600
+ id: string;
601
+ quantity: number;
602
+ }): Promise<Schemas["Cart"]>;
603
+ /**
604
+ * The number of items in the cart
605
+ */
606
+ count: ComputedRef<number>;
607
+ /**
608
+ * Refreshes the cart object and related data
609
+ * If @param newCart is provided, it will be used as a new cart object
610
+ */
611
+ refreshCart(newCart?: Schemas["Cart"]): Promise<Schemas["Cart"]>;
612
+ /**
613
+ * Removes the provided LineItem from the cart
614
+ */
615
+ removeItem(lineItem: Schemas["LineItem"]): Promise<Schemas["Cart"]>;
616
+ /**
617
+ * The total price of the cart (including calculated costs like shipping)
618
+ */
619
+ totalPrice: ComputedRef<number>;
620
+ /**
621
+ * Shipping price
622
+ *
623
+ * @deprecated Use `shippingCosts` instead
624
+ */
625
+ shippingTotal: ComputedRef<number>;
626
+ /**
627
+ * Shipping costs
628
+ */
629
+ shippingCosts: ComputedRef<Schemas["CartDelivery"][]>;
630
+ /**
631
+ * The total price of all cart items
632
+ */
633
+ subtotal: ComputedRef<number>;
634
+ /**
635
+ * `true` if the cart contains no items
636
+ */
637
+ isEmpty: ComputedRef<boolean>;
638
+ /**
639
+ * `true` if cart contains only digital items
640
+ */
641
+ isVirtualCart: ComputedRef<boolean>;
642
+ /**
643
+ * Get cart errors
644
+ */
645
+ consumeCartErrors(): Schemas["Cart"]["errors"];
646
+ };
647
+ /**
648
+ * Cart management logic.
649
+ *
650
+ * Used as [Shared](https://frontends.shopware.com/framework/composables/shared-composables.html) Composable `useCart`
651
+ *
652
+ * @category Cart & Checkout
653
+ */
654
+ declare function useCartFunction(): UseCartReturn;
655
+ declare const useCart: typeof useCartFunction;
656
+
657
+ type UseCartItemReturn = {
658
+ /**
659
+ * Calculated price {number} for the current item
660
+ */
661
+ itemRegularPrice: ComputedRef<number | undefined>;
662
+ /**
663
+ * Calculated price {number} for the current item if list price is set
664
+ */
665
+ itemSpecialPrice: ComputedRef<number | undefined>;
666
+ /**
667
+ * Total price for the current item of given quantity in the cart
668
+ */
669
+ itemTotalPrice: ComputedRef<number | undefined>;
670
+ /**
671
+ * Thumbnail url for the current item's entity
672
+ */
673
+ itemImageThumbnailUrl: ComputedRef<string>;
674
+ /**
675
+ * Options (of variation) for the current item
676
+ */
677
+ itemOptions: ComputedRef<Schemas["LineItem"]["payload"]["options"]>;
678
+ /**
679
+ * Type of the current item: "product" or "promotion"
680
+ */
681
+ itemType: ComputedRef<Schemas["LineItem"]["type"] | undefined>;
682
+ /**
683
+ * Determines if the current item is a product
684
+ */
685
+ isProduct: ComputedRef<boolean>;
686
+ /**
687
+ * Determines if the current item is a promotion
688
+ */
689
+ isPromotion: ComputedRef<boolean>;
690
+ /**
691
+ * Determines if the current item can be removed from cart
692
+ */
693
+ isRemovable: ComputedRef<boolean>;
694
+ /**
695
+ * Determines if the current item's quantity can be changed
696
+ */
697
+ isStackable: ComputedRef<boolean>;
698
+ /**
699
+ * Determines if the current item is a digital product (to download)
700
+ */
701
+ isDigital: ComputedRef<boolean>;
702
+ /**
703
+ * Stock information for the current item
704
+ */
705
+ itemStock: ComputedRef<number | undefined>;
706
+ /**
707
+ * Quantity of the current item in the cart
708
+ */
709
+ itemQuantity: ComputedRef<number | undefined>;
710
+ /**
711
+ * Changes the current item quantity in the cart
712
+ */
713
+ changeItemQuantity(quantity: number): Promise<Schemas["Cart"]>;
714
+ /**
715
+ * Removes the current item from the cart
716
+ */
717
+ removeItem(): Promise<Schemas["Cart"]>;
718
+ };
719
+ /**
720
+ * Composable to manage specific cart item
721
+ * @public
722
+ * @category Cart & Checkout
723
+ */
724
+ declare function useCartItem(cartItem: Ref<Schemas["LineItem"]>): UseCartItemReturn;
725
+
726
+ type UseCategoryReturn = {
727
+ /**
728
+ * Current category entity
729
+ */
730
+ category: ComputedRef<Schemas["Category"]>;
731
+ };
732
+ /**
733
+ * Composable to get the category from current CMS context
734
+ *
735
+ * @category Product
736
+ * @public
737
+ */
738
+ declare function useCategory(category?: Ref<Schemas["Category"]>): UseCategoryReturn;
739
+
740
+ type UseCategorySearchReturn = {
741
+ /**
742
+ * Search for category by ID
743
+ * Accepts optional query params and associations
744
+ */
745
+ search(categoryId: string, options?: {
746
+ withCmsAssociations?: boolean;
747
+ query?: Schemas["Criteria"];
748
+ }): Promise<Schemas["Category"]>;
749
+ /**
750
+ * Search based on the query
751
+ */
752
+ advancedSearch(options: {
753
+ withCmsAssociations?: boolean;
754
+ query: Schemas["Criteria"];
755
+ }): Promise<Schemas["Category"][]>;
756
+ };
757
+ /**
758
+ * Composable for category search.
759
+ * @public
760
+ * @category Navigation & Routing
761
+ */
762
+ declare function useCategorySearch(): UseCategorySearchReturn;
763
+
764
+ type UseCheckoutReturn = {
765
+ /**
766
+ * Fetches all available shipping methods
767
+ */
768
+ getShippingMethods(options?: {
769
+ forceReload: boolean;
770
+ }): Promise<ComputedRef<Schemas["ShippingMethod"][]>>;
771
+ /**
772
+ * List of available shipping methods
773
+ */
774
+ shippingMethods: ComputedRef<Schemas["ShippingMethod"][]>;
775
+ /**
776
+ * Fetches all available payment methods
777
+ */
778
+ getPaymentMethods(options?: {
779
+ forceReload: boolean;
780
+ }): Promise<ComputedRef<Schemas["PaymentMethod"][]>>;
781
+ /**
782
+ * List of available payment methods
783
+ */
784
+ paymentMethods: ComputedRef<Schemas["PaymentMethod"][]>;
785
+ /**
786
+ * Creates order based on the current cart
787
+ */
788
+ createOrder(params?: operations["createOrder post /checkout/order"]["body"]): Promise<Schemas["Order"]>;
789
+ /**
790
+ * Shipping address for the current session
791
+ */
792
+ shippingAddress: ComputedRef<Schemas["CustomerAddress"] | undefined>;
793
+ /**
794
+ * Billing address for the current session
795
+ */
796
+ billingAddress: ComputedRef<Schemas["CustomerAddress"] | undefined>;
797
+ /**
798
+ * Selected shipping method for the current session
799
+ * Sugar for {@link useSessionContext.selectedShippingMethod}
800
+ */
801
+ selectedShippingMethod: ComputedRef<Schemas["ShippingMethod"] | null>;
802
+ /**
803
+ * Sets shipping method for the current session
804
+ * Sugar for {@link useSessionContext.setShippingMethod}
805
+ */
806
+ setShippingMethod(shippingMethod: {
807
+ id: string;
808
+ }): Promise<void>;
809
+ /**
810
+ * Selected payment method for the current session
811
+ * Sugar for {@link useSessionContext.selectedPaymentMethod}
812
+ */
813
+ selectedPaymentMethod: ComputedRef<Schemas["PaymentMethod"] | null>;
814
+ /**
815
+ * Sets payment method for the current session
816
+ * Sugar for {@link useSessionContext.setPaymentMethod}
817
+ */
818
+ setPaymentMethod(paymentMethod: {
819
+ id: string;
820
+ }): Promise<void>;
821
+ };
822
+ /**
823
+ * Composable to manage checkout process
824
+ * @public
825
+ * @category Cart & Checkout
826
+ */
827
+ declare function useCheckout(): UseCheckoutReturn;
828
+
829
+ type ArrayElement$1<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
830
+ type UseCmsBlockReturn = {
831
+ /**
832
+ * Cms block content
833
+ */
834
+ block: Schemas["CmsBlock"];
835
+ /**
836
+ * Get slot content by slot name (identifier)
837
+ * @example getSlotContent("main")
838
+ */
839
+ getSlotContent(slotName: string): ArrayElement$1<Schemas["CmsBlock"]["slots"]>;
840
+ };
841
+ /**
842
+ * Composable to get cms block content
843
+ * @public
844
+ * @category CMS (Shopping Experiences)
845
+ */
846
+ declare function useCmsBlock<BLOCK_TYPE extends Schemas["CmsBlock"]>(content: BLOCK_TYPE): UseCmsBlockReturn;
847
+
848
+ type UseCmsMetaReturn = {
849
+ /**
850
+ * Meta title for current page/entity
851
+ */
852
+ title: ComputedRef<string>;
853
+ /**
854
+ * Meta tags for current page/entity
855
+ */
856
+ meta: ComputedRef<{
857
+ name: string;
858
+ content: string;
859
+ }[]>;
860
+ };
861
+ /**
862
+ * TODO: remove parameter and use reactive state of cmsResponse provided by useCms composable
863
+ * @category CMS (Shopping Experiences)
864
+ */
865
+ declare function useCmsMeta(entity: Schemas["Category"] | Schemas["Product"] | Schemas["LandingPage"]): UseCmsMetaReturn;
866
+
867
+ type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType extends readonly (infer ElementType)[] ? ElementType : never;
868
+ type UseCmsSectionType = {
869
+ /**
870
+ * CMS section
871
+ */
872
+ section: Schemas["CmsSection"];
873
+ /**
874
+ * Position of the section
875
+ */
876
+ getPositionContent(position: ArrayElement<Schemas["CmsSection"]["blocks"]>["sectionPosition"]): Array<Schemas["CmsBlock"]>;
877
+ };
878
+ /**
879
+ * Composable to get cms section content
880
+ * @public
881
+ * @category CMS (Shopping Experiences)
882
+ */
883
+ declare function useCmsSection<SECTION_TYPE extends Schemas["CmsSection"]>(content: SECTION_TYPE): UseCmsSectionType;
884
+
885
+ /**
886
+ * @category CMS (Shopping Experiences)
887
+ * @returns
888
+ */
889
+ declare function useCmsTranslations(): {};
890
+
891
+ /**
892
+ * Context helper composable to provide and inject data.
893
+ * It takes `injectionName` to inject the context. If no context is provided, it will create a new one and provide it.
894
+ * If `context` is provided in params, it will create new context, use param as value and provide it.
895
+ * If `replace` is provided, it will replace the existing context with the new value.
896
+ *
897
+ * @public
898
+ * @category Context & Language
899
+ */
900
+ declare function useContext<T>(injectionName: string, params?: {
901
+ context?: Ref<T> | T;
902
+ replace?: T;
903
+ }): Ref<T, T>;
904
+
905
+ type UseCountriesReturn = {
906
+ mountedCallback(): Promise<void>;
907
+ getCountries: ComputedRef<Schemas["Country"][]>;
908
+ fetchCountries(): Promise<operations["readCountry post /country"]["response"]>;
909
+ getStatesForCountry(countryId: string): Schemas["CountryState"][] | null;
910
+ };
911
+ /**
912
+ * Composable to manage countries
913
+ * @public
914
+ * @category Context & Language
915
+ */
916
+ declare function useCountries(): UseCountriesReturn;
917
+
918
+ type UseCustomerOrdersReturn = {
919
+ /**
920
+ * All placed orders belonging to the logged-in customer
921
+ */
922
+ orders: Ref<Schemas["Order"][]>;
923
+ /**
924
+ * Changes the current page of the orders list
925
+ *
926
+ * In order to change a page with additional parameters please use `loadOrders` method.
927
+ */
928
+ changeCurrentPage(pageNumber: number | string): Promise<void>;
929
+ /**
930
+ * Fetches the orders list and assigns the result to the `orders` property
931
+ */
932
+ loadOrders(parameters?: operations["readOrder post /order"]["body"]): Promise<void>;
933
+ /**
934
+ * Current page number
935
+ */
936
+ currentPage: ComputedRef<number>;
937
+ /**
938
+ * total pages
939
+ */
940
+ totalPages: ComputedRef<number>;
941
+ /**
942
+ * Limit of orders per page
943
+ */
944
+ limit: Ref<number>;
945
+ };
946
+ /**
947
+ * Composable for fetching the orders list.
948
+ * @public
949
+ * @category Customer & Account
950
+ */
951
+ declare function useCustomerOrders(): UseCustomerOrdersReturn;
952
+
953
+ type UseCustomerPasswordReturn = {
954
+ /**
955
+ * Change customer's current password
956
+ */
957
+ updatePassword(updatePasswordData: operations["changePassword post /account/change-password"]["body"]): Promise<operations["changePassword post /account/change-password"]["response"]>;
958
+ /**
959
+ * Reset customer's password
960
+ */
961
+ resetPassword(resetPasswordData: operations["sendRecoveryMail post /account/recovery-password"]["body"]): Promise<operations["sendRecoveryMail post /account/recovery-password"]["response"]>;
962
+ };
963
+ /**
964
+ * Composable for customer password management.
965
+ * @public
966
+ * @category Customer & Account
967
+ */
968
+ declare function useCustomerPassword(): UseCustomerPasswordReturn;
969
+
970
+ type UseDefaultOrderAssociationsReturn = Schemas["Criteria"] & {
971
+ checkPromotion?: boolean;
972
+ };
973
+ /**
974
+ * Returns default order associations. You can override this composable in your project.
975
+ * @public
976
+ * @category Order
977
+ */
978
+ declare function useDefaultOrderAssociations(): UseDefaultOrderAssociationsReturn;
979
+
980
+ type UseInternationalizationReturn = {
981
+ /**
982
+ * StorefrontUrl is needed to specify language of emails
983
+ *
984
+ * @returns {string} storefront URL
985
+ */
986
+ getStorefrontUrl(): string;
987
+ /**
988
+ * Get available languages from backend
989
+ *
990
+ * @returns {Promise<operations['readLanguages post /language']['body']>} list of languages
991
+ */
992
+ getAvailableLanguages(): Promise<operations["readLanguages post /language"]["response"]>;
993
+ /**
994
+ * Change current language
995
+ *
996
+ * @param {string} languageId
997
+ * @returns {Promise<Schemas['ContextTokenResponse']>} context object
998
+ */
999
+ changeLanguage(languageId: string): Promise<operations["updateContext patch /context"]["response"]>;
1000
+ /**
1001
+ * Get language code from backend language id
1002
+ *
1003
+ * @param {string} languageId
1004
+ * @returns {string} language code
1005
+ */
1006
+ getLanguageCodeFromId(languageId: string): string;
1007
+ /**
1008
+ * Get backend language id from language code
1009
+ *
1010
+ * @param {string} languageCode
1011
+ * @returns {string} language
1012
+ */
1013
+ getLanguageIdFromCode(languageCode: string): string;
1014
+ /**
1015
+ * Replace to dev url if it is set
1016
+ *
1017
+ * @param {string} url
1018
+ * @returns {string} prefixed url
1019
+ */
1020
+ replaceToDevStorefront(url: string): string;
1021
+ /**
1022
+ * List of available languages
1023
+ */
1024
+ languages: Ref<Schemas["Language"][]>;
1025
+ /**
1026
+ * Currently used language
1027
+ */
1028
+ currentLanguage: Ref<string>;
1029
+ /**
1030
+ * Current prefix from the context
1031
+ */
1032
+ currentPrefix: Ref<string>;
1033
+ /**
1034
+ * Add prefix to the Url
1035
+ * @param {string | RouteObject} link
1036
+ */
1037
+ formatLink(link: string | RouteObject): string | RouteObject;
1038
+ };
1039
+ type RouteObject = {
1040
+ path: string;
1041
+ [key: string]: unknown;
1042
+ };
1043
+ /**
1044
+ * Composable for internationalization management.
1045
+ * @public
1046
+ * @category Context & Language
1047
+ */
1048
+ declare function useInternationalization(pathResolver?: (path: string) => string): UseInternationalizationReturn;
1049
+
1050
+ type UseLandingSearchReturn = {
1051
+ /**
1052
+ * Search for landing page by ID
1053
+ * Accepts optional media associations
1054
+ */
1055
+ search(navigationId: string, options?: {
1056
+ withCmsAssociations?: boolean;
1057
+ }): Promise<Schemas["LandingPage"]>;
1058
+ };
1059
+ /**
1060
+ * Composable for landing page search.
1061
+ * @public
1062
+ * @category Navigation & Routing
1063
+ */
1064
+ declare function useLandingSearch(): {
1065
+ search: (navigationId: string, options?: {
1066
+ withCmsAssociations?: boolean;
1067
+ }) => Promise<Schemas["LandingPage"]>;
1068
+ };
1069
+
1070
+ type ListingType = "productSearchListing" | "categoryListing";
1071
+ type ShortcutFilterParam<T extends keyof Schemas["ProductListingCriteria"] = keyof Schemas["ProductListingCriteria"]> = {
1072
+ code: T;
1073
+ value: Schemas["ProductListingCriteria"][T];
1074
+ };
1075
+ type UseListingReturn = {
1076
+ /**
1077
+ * Listing that is currently set
1078
+ * {@link ListingResult} object
1079
+ */
1080
+ getInitialListing: ComputedRef<Schemas["ProductListingResult"] | null>;
1081
+ /**
1082
+ * Sets the initial listing - available synchronously
1083
+ * @param {@link initialListing} - initial listing to set
1084
+ * @returns
1085
+ */
1086
+ setInitialListing(initialListing: Schemas["ProductListingResult"]): Promise<void>;
1087
+ /**
1088
+ * @deprecated - use `search` instead
1089
+ * Searches for the listing based on the criteria
1090
+ * @param criteria {@link Schemas['Criteria']}
1091
+ * @returns
1092
+ */
1093
+ initSearch(criteria: operations["searchPage post /search"]["body"]): Promise<Schemas["ProductListingResult"]>;
1094
+ /**
1095
+ * Searches for the listing based on the criteria
1096
+ * @param criteria
1097
+ * @returns
1098
+ */
1099
+ search(criteria: operations["readProductListing post /product-listing/{categoryId}"]["body"] | operations["searchPage post /search"]["body"]): Promise<void>;
1100
+ /**
1101
+ * Loads more (next page) elements to the listing
1102
+ */
1103
+ loadMore(criteria?: operations["searchPage post /search"]["body"]): Promise<void>;
1104
+ /**
1105
+ * Listing that is currently set
1106
+ */
1107
+ getCurrentListing: ComputedRef<Schemas["ProductListingResult"] | null>;
1108
+ /**
1109
+ * Listing elements ({@link Product}) that are currently set
1110
+ */
1111
+ getElements: ComputedRef<Schemas["ProductListingResult"]["elements"]>;
1112
+ /**
1113
+ * Available sorting orders
1114
+ */
1115
+ getSortingOrders: ComputedRef<Schemas["ProductSorting"][] | {
1116
+ key: string;
1117
+ label: string;
1118
+ }[] | undefined>;
1119
+ /**
1120
+ * Current sorting order
1121
+ */
1122
+ getCurrentSortingOrder: ComputedRef<string | undefined>;
1123
+ /**
1124
+ * Changes the current sorting order
1125
+ * @param order - i.e. "name-asc"
1126
+ * @returns
1127
+ */
1128
+ changeCurrentSortingOrder(order: string, query?: operations["searchPage post /search"]["body"]): Promise<void>;
1129
+ /**
1130
+ * Current page number
1131
+ */
1132
+ getCurrentPage: ComputedRef<number>;
1133
+ /**
1134
+ * Changes the current page number
1135
+ * @param pageNumber - page number to change to
1136
+ * @returns
1137
+ */
1138
+ changeCurrentPage(page: number, query?: operations["searchPage post /search"]["body"]): Promise<void>;
1139
+ /**
1140
+ * Total number of elements found for the current search criteria
1141
+ */
1142
+ getTotal: ComputedRef<number>;
1143
+ /**
1144
+ * Total number of pages found for the current search criteria
1145
+ */
1146
+ getTotalPagesCount: ComputedRef<number>;
1147
+ /**
1148
+ * Number of elements per page
1149
+ */
1150
+ getLimit: ComputedRef<number>;
1151
+ /**
1152
+ * Initial filters
1153
+ */
1154
+ getInitialFilters: ComputedRef<ReturnType<typeof getListingFilters>>;
1155
+ /**
1156
+ * All available filters
1157
+ */
1158
+ getAvailableFilters: ComputedRef<ReturnType<typeof getListingFilters>>;
1159
+ /**
1160
+ * Filters that are currently set
1161
+ */
1162
+ getCurrentFilters: ComputedRef<Schemas["ProductListingResult"]["currentFilters"]>;
1163
+ /**
1164
+ * Sets the filters to be applied for the listing
1165
+ * @param filters
1166
+ * @returns
1167
+ */
1168
+ setCurrentFilters(filters: ShortcutFilterParam[]): Promise<void>;
1169
+ /**
1170
+ * Indicates if the listing is being fetched
1171
+ */
1172
+ loading: ComputedRef<boolean>;
1173
+ /**
1174
+ * Indicates if the listing is being fetched via `loadMore` method
1175
+ */
1176
+ loadingMore: ComputedRef<boolean>;
1177
+ /**
1178
+ * Resets the filters - clears the current filters
1179
+ */
1180
+ resetFilters(): Promise<void>;
1181
+ /**
1182
+ * Change selected filters to the query object
1183
+ */
1184
+ filtersToQuery(filters: Schemas["ProductListingCriteria"]): Record<string, unknown>;
1185
+ };
1186
+ /**
1187
+ * @public
1188
+ * @category Product
1189
+ */
1190
+ declare function useListing(params?: {
1191
+ listingType: ListingType;
1192
+ categoryId?: string;
1193
+ defaultSearchCriteria?: operations["searchPage post /search"]["body"];
1194
+ }): UseListingReturn;
1195
+ declare const createCategoryListingContext: () => UseListingReturn;
1196
+ /**
1197
+ * Temporary workaround over `useListing` to support shared data. This composable API will change in the future.
1198
+ *
1199
+ * You need to call `createCategoryListingContext` before this composable.
1200
+ */
1201
+ declare const useCategoryListing: () => UseListingReturn;
1202
+ /**
1203
+ * Temporary workaround over `useListing` to support shared data. This composable API will change in the future.
1204
+ */
1205
+ declare const useProductSearchListing: () => UseListingReturn;
1206
+ /**
1207
+ * Factory to create your own listing.
1208
+ *
1209
+ * By default you can use useListing composable, which provides you predefined listings for category(cms) listing and product search listing.
1210
+ * Using factory you can provide our own compatible search method and use it for example for creating listing of orders in my account.
1211
+ *
1212
+ * @public
1213
+ */
1214
+ declare function createListingComposable({ searchMethod, searchDefaults, listingKey, }: {
1215
+ searchMethod(searchParams: operations["readProductListing post /product-listing/{categoryId}"]["body"] | operations["searchPage post /search"]["body"]): Promise<Schemas["ProductListingResult"]>;
1216
+ searchDefaults: operations["searchPage post /search"]["body"];
1217
+ listingKey: string;
1218
+ }): UseListingReturn;
1219
+
1220
+ type UseLocalWishlistReturn = {
1221
+ /**
1222
+ * Get wishlist products from localstorage
1223
+ */
1224
+ getWishlistProducts(): void;
1225
+ /**
1226
+ * Add product to wishlist by its id
1227
+ */
1228
+ addToWishlist(id: string): Promise<void>;
1229
+ /**
1230
+ * Remove product from wishlist by its id
1231
+ */
1232
+ removeFromWishlist(id: string): Promise<void>;
1233
+ /**
1234
+ * Remove all products from wishlist
1235
+ */
1236
+ clearWishlist(): Promise<void>;
1237
+ /**
1238
+ * List of wishlist items
1239
+ */
1240
+ items: ComputedRef<string[]>;
1241
+ /**
1242
+ * Count of wishlist items
1243
+ */
1244
+ count: ComputedRef<number>;
1245
+ };
1246
+ /**
1247
+ * Composable for wishlist management.
1248
+ * @public
1249
+ * @category Wishlist
1250
+ */
1251
+ declare function useLocalWishlist(): UseLocalWishlistReturn;
1252
+
1253
+ /**
1254
+ *
1255
+ * Provides state for navigation trees depending on navigation type.
1256
+ */
1257
+ type UseNavigationReturn = {
1258
+ /**
1259
+ * List of navigation elements
1260
+ */
1261
+ navigationElements: ComputedRef<Schemas["NavigationRouteResponse"] | null>;
1262
+ /**
1263
+ * Load navigation elements
1264
+ */
1265
+ loadNavigationElements(params: operations["readNavigation post /navigation/{activeId}/{rootId}"]["body"]): Promise<Schemas["NavigationRouteResponse"]>;
1266
+ };
1267
+ /**
1268
+ * Composable for navigation.
1269
+ * Provides state for navigation trees depending on navigation type.
1270
+ *
1271
+ * @example
1272
+ * ```
1273
+ * // get main navigation
1274
+ * useNavigation()
1275
+ * // get footer navigation
1276
+ * useNavigation({ type: "footer-navigation" } )
1277
+ * ```
1278
+ * @public
1279
+ * @category Navigation & Routing
1280
+ */
1281
+ declare function useNavigation(params?: {
1282
+ type?: Schemas["NavigationType"] | string;
1283
+ }): UseNavigationReturn;
1284
+
1285
+ type UseNavigationContextReturn = {
1286
+ /**
1287
+ * SEO URL from the navigation context
1288
+ */
1289
+ navigationContext: ComputedRef<Schemas["SeoUrl"] | null>;
1290
+ /**
1291
+ * Route name from the navigation context
1292
+ */
1293
+ routeName: ComputedRef<Schemas["SeoUrl"]["routeName"] | undefined>;
1294
+ /**
1295
+ * Foreign key (ID) for current navigation context
1296
+ */
1297
+ foreignKey: ComputedRef<string>;
1298
+ };
1299
+ /**
1300
+ * Composable to get navigation context from the URL.
1301
+ * @public
1302
+ * @category Navigation & Routing
1303
+ */
1304
+ declare function useNavigationContext(context?: Ref<Schemas["SeoUrl"] | null>): UseNavigationContextReturn;
1305
+
1306
+ type UseNavigationSearchReturn = {
1307
+ /**
1308
+ * Get {@link SeoUrl} entity for given path
1309
+ * @example resolvePath("/my-category/my-product") or resolvePath("/") for home page
1310
+ */
1311
+ resolvePath(path: string): Promise<Schemas["SeoUrl"] | null>;
1312
+ };
1313
+ /**
1314
+ * Composable to get search for SeoUrl entity for given path.
1315
+ * @public
1316
+ * @category Navigation & Routing
1317
+ */
1318
+ declare function useNavigationSearch(): UseNavigationSearchReturn;
1319
+
1320
+ type UseNewsletterReturn = {
1321
+ /**
1322
+ * Subscribes the user to the newsletter
1323
+ * @param params {@link operations['subscribeToNewsletter post /newsletter/subscribe']['body']}
1324
+ */
1325
+ newsletterSubscribe(params: Omit<operations["subscribeToNewsletter post /newsletter/subscribe"]["body"], "storefrontUrl">): Promise<void>;
1326
+ /**
1327
+ * Removes the email from the newsletter
1328
+ * @param email
1329
+ */
1330
+ newsletterUnsubscribe(email: string): Promise<void>;
1331
+ /**
1332
+ * Get newsletter status from the API call
1333
+ */
1334
+ getNewsletterStatus(): Promise<Schemas["AccountNewsletterRecipient"]>;
1335
+ /**
1336
+ * Indicates if the user is subscribed to the newsletter
1337
+ *
1338
+ * Returns `true` if the user is subscribed to the newsletter, `false` otherwise
1339
+ */
1340
+ isNewsletterSubscriber: ComputedRef<boolean>;
1341
+ /**
1342
+ * Newsletter status
1343
+ */
1344
+ newsletterStatus: Ref<Schemas["AccountNewsletterRecipient"]["status"]>;
1345
+ /**
1346
+ * Inform about newsletter confirmation
1347
+ */
1348
+ confirmationNeeded: ComputedRef<boolean>;
1349
+ };
1350
+ /**
1351
+ * Composable for newsletter subscription.
1352
+ * @public
1353
+ * @category Customer & Account
1354
+ */
1355
+ declare function useNewsletter(): UseNewsletterReturn;
1356
+
1357
+ type NotificationType = "info" | "warning" | "success" | "danger";
1358
+ /**
1359
+ * @private
1360
+ */
1361
+ type Notification = {
1362
+ type: NotificationType;
1363
+ message: string;
1364
+ id: number;
1365
+ };
1366
+ /**
1367
+ * @private
1368
+ */
1369
+ type NotificationOptions = {
1370
+ /**
1371
+ * @private
1372
+ */
1373
+ type?: NotificationType;
1374
+ timeout?: number;
1375
+ persistent?: boolean;
1376
+ };
1377
+ /**
1378
+ * @public
1379
+ */
1380
+ type UseNotificationsReturn = {
1381
+ /**
1382
+ * List of active notifications
1383
+ */
1384
+ notifications: ComputedRef<Notification[]>;
1385
+ /**
1386
+ * Removes a specific notification by its ID
1387
+ */
1388
+ removeOne(id: number): void;
1389
+ /**
1390
+ * Resets the notification list - clear all notifications
1391
+ */
1392
+ removeAll(): void;
1393
+ /**
1394
+ * Push an info notification to the current list
1395
+ */
1396
+ pushInfo(message: string, options?: NotificationOptions): void;
1397
+ /**
1398
+ * Pushes a warning notification to the current list
1399
+ */
1400
+ pushWarning(message: string, options?: NotificationOptions): void;
1401
+ /**
1402
+ * Pushes an error notification to the current list
1403
+ */
1404
+ pushError(message: string, options?: NotificationOptions): void;
1405
+ /**
1406
+ * Pushes a success notification to the current list
1407
+ */
1408
+ pushSuccess(message: string, options?: NotificationOptions): void;
1409
+ };
1410
+ /**
1411
+ * Composable for managing notifications (flash messages) on frontend.
1412
+ * @public
1413
+ */
1414
+ declare function useNotifications(): UseNotificationsReturn;
1415
+
1416
+ type UseOrderDetailsReturn = {
1417
+ /**
1418
+ * {@link Schemas['Order']} object
1419
+ */
1420
+ order: ComputedRef<Schemas["Order"] | undefined | null>;
1421
+ /**
1422
+ * Order status (e.g. 'Open', 'Cancelled')
1423
+ */
1424
+ status: ComputedRef<string | undefined>;
1425
+ /**
1426
+ * Order status technical name (e.g. 'open', 'cancelled')
1427
+ */
1428
+ statusTechnicalName: ComputedRef<string | undefined>;
1429
+ /**
1430
+ * Order total price
1431
+ */
1432
+ total: ComputedRef<number | undefined>;
1433
+ /**
1434
+ * Order subtotal price for all items
1435
+ */
1436
+ subtotal: ComputedRef<number | undefined>;
1437
+ /**
1438
+ * Order shipping costs
1439
+ */
1440
+ shippingCosts: ComputedRef<number | undefined>;
1441
+ /**
1442
+ * Shipping address
1443
+ */
1444
+ shippingAddress: ComputedRef<Schemas["OrderAddress"] | undefined>;
1445
+ /**
1446
+ * Billing address
1447
+ */
1448
+ billingAddress: ComputedRef<Schemas["OrderAddress"] | undefined>;
1449
+ /**
1450
+ * Basic personal details
1451
+ */
1452
+ personalDetails: ComputedRef<{
1453
+ email: string | undefined;
1454
+ firstName: string | undefined;
1455
+ lastName: string | undefined;
1456
+ }>;
1457
+ /**
1458
+ * Payment URL for external payment methods (e.g. async payment in external payment gateway)
1459
+ */
1460
+ paymentUrl: Ref<null | string>;
1461
+ /**
1462
+ * Returns current selected shipping method for the order. Last element in delivery array.
1463
+ */
1464
+ shippingMethod: ComputedRef<Schemas["ShippingMethod"] | undefined | null>;
1465
+ /**
1466
+ * Returns current selected payment method for the order. Last element in transactions array.
1467
+ */
1468
+ paymentMethod: ComputedRef<Schemas["PaymentMethod"] | undefined | null>;
1469
+ /**
1470
+ * Get order object including additional associations.
1471
+ * useDefaults describes what order object should look like.
1472
+ */
1473
+ loadOrderDetails(): Promise<Schemas["OrderRouteResponse"]>;
1474
+ /**
1475
+ * Handle payment for existing error.
1476
+ *
1477
+ * Pass custom success and error URLs (optionally).
1478
+ */
1479
+ handlePayment(successUrl?: string, errorUrl?: string, paymentDetails?: unknown): void;
1480
+ /**
1481
+ * Cancel an order.
1482
+ *
1483
+ * Action cannot be reverted.
1484
+ */
1485
+ cancel(): Promise<Schemas["StateMachineState"]>;
1486
+ /**
1487
+ * Changes the payment method for current cart.
1488
+ * @param paymentMethodId - ID of the payment method to be set
1489
+ * @returns
1490
+ */
1491
+ changePaymentMethod(paymentMethodId: string): Promise<Schemas["SuccessResponse"]>;
1492
+ /**
1493
+ * Get media content
1494
+ *
1495
+ * @param {string} downloadId
1496
+ * @returns {Blob}
1497
+ */
1498
+ getMediaFile: (downloadId: string) => Promise<Blob>;
1499
+ /**
1500
+ * Get order documents
1501
+ * @param {string} documentId
1502
+ * @param {string} deepLinkCode
1503
+ * @returns
1504
+ */
1505
+ getDocumentFile: (documentId: string, deepLinkCode: string) => Promise<Schemas["Document"]>;
1506
+ /**
1507
+ * Check if order has documents
1508
+ */
1509
+ hasDocuments: ComputedRef<boolean>;
1510
+ /**
1511
+ * Get order documents
1512
+ */
1513
+ documents: ComputedRef<Schemas["Document"][]>;
1514
+ /**
1515
+ * Fetches all available payment methods
1516
+ */
1517
+ getPaymentMethods(): Promise<Schemas["PaymentMethod"][]>;
1518
+ paymentChangeable: ComputedRef<boolean>;
1519
+ };
1520
+ /**
1521
+ * Composable for managing an existing order.
1522
+ * @public
1523
+ * @category Customer & Account
1524
+ */
1525
+ declare function useOrderDetails(orderId: string, associations?: Schemas["Criteria"]["associations"]): UseOrderDetailsReturn;
1526
+
1527
+ type UseOrderPaymentReturn = {
1528
+ /**
1529
+ * If the payment can be done after the order is placed
1530
+ */
1531
+ isAsynchronous: ComputedRef<boolean | undefined>;
1532
+ /**
1533
+ * Active payment transaction
1534
+ */
1535
+ activeTransaction: ComputedRef<Schemas["OrderTransaction"] | undefined>;
1536
+ /**
1537
+ * Payment status
1538
+ */
1539
+ state: ComputedRef<Schemas["StateMachineState"] | null | undefined>;
1540
+ paymentUrl: Ref<null | string>;
1541
+ /**
1542
+ * Payment method set for the order
1543
+ */
1544
+ paymentMethod: ComputedRef<Schemas["PaymentMethod"] | undefined | null>;
1545
+ /**
1546
+ * Invokes the payment process for the order in the backend
1547
+ */
1548
+ handlePayment(
1549
+ /**
1550
+ * URL to redirect after successful payment
1551
+ */
1552
+ successUrl?: string,
1553
+ /**
1554
+ * URL to redirect after failed payment
1555
+ */
1556
+ errorUrl?: string,
1557
+ /**
1558
+ * additional payment details to provide
1559
+ */
1560
+ paymentDetails?: unknown): Promise<undefined | unknown>;
1561
+ /**
1562
+ * Change a payment method for the order
1563
+ */
1564
+ changePaymentMethod(paymentMethodId: string): Promise<Schemas["SuccessResponse"] | undefined>;
1565
+ };
1566
+ /**
1567
+ * Composable for managing an existing order.
1568
+ * @public
1569
+ * @category Customer & Account
1570
+ */
1571
+ declare function useOrderPayment(order: ComputedRef<Schemas["Order"] | null | undefined>): UseOrderPaymentReturn;
1572
+
1573
+ type UsePriceReturn = {
1574
+ /**
1575
+ * Format price i.e. (2) -> 2.00 $
1576
+ */
1577
+ getFormattedPrice(value: number | string | undefined): string;
1578
+ /**
1579
+ * Update configuration
1580
+ */
1581
+ update(params: {
1582
+ localeCode: string | undefined;
1583
+ currencyCode: string;
1584
+ }): void;
1585
+ /**
1586
+ * Currency code
1587
+ */
1588
+ currencyCode: ComputedRef<string>;
1589
+ };
1590
+ /**
1591
+ * Composable for getting formatted price
1592
+ * Set the default currency code and locale in order to format a price correctly
1593
+ *
1594
+ * @public
1595
+ * @category Product
1596
+ */
1597
+ declare function _usePrice(params?: {
1598
+ localeCode: string | undefined;
1599
+ currencyCode: string;
1600
+ }): UsePriceReturn;
1601
+ /**
1602
+ * @category Product
1603
+ */
1604
+ declare const usePrice: typeof _usePrice;
1605
+
1606
+ type UseProductReturn = {
1607
+ /**
1608
+ * Returns product object
1609
+ * {@link Product} object
1610
+ */
1611
+ product: ComputedRef<Schemas["Product"]>;
1612
+ /**
1613
+ * {@link PropertyGroup} array that defines the product possible configurations
1614
+ */
1615
+ configurator: ComputedRef<Schemas["PropertyGroup"][]>;
1616
+ /**
1617
+ * Merges the current product with the new variant data
1618
+ * @param variant - {@link Product} object with the new variant data
1619
+ */
1620
+ changeVariant(variant?: Partial<Schemas["Product"]>): void;
1621
+ };
1622
+ /**
1623
+ * Composable for product management.
1624
+ * @public
1625
+ * @category Product
1626
+ */
1627
+ declare function useProduct(product?: Ref<Schemas["Product"]> | Schemas["Product"], configurator?: Ref<Schemas["PropertyGroup"][]> | Schemas["PropertyGroup"][]): UseProductReturn;
1628
+
1629
+ type UseProductAssociationsReturn = {
1630
+ /**
1631
+ * Start loading resources. Search Parameters and HTTP method can be passed.
1632
+ *
1633
+ */
1634
+ loadAssociations(params: {
1635
+ method?: "post" | "get";
1636
+ searchParams: Schemas["Criteria"];
1637
+ }): Promise<void>;
1638
+ /**
1639
+ * If it's loading - indicator
1640
+ */
1641
+ isLoading: ComputedRef<boolean>;
1642
+ /**
1643
+ * Product associations, like CrossSelling[]
1644
+ */
1645
+ productAssociations: ComputedRef<Schemas["CrossSellingElementCollection"]>;
1646
+ };
1647
+ /**
1648
+ * Get product association entity.
1649
+ * @public
1650
+ * @category Product
1651
+ */
1652
+ declare function useProductAssociations(product: ComputedRef<Schemas["Product"]>, options: {
1653
+ associationContext: "cross-selling" | "reviews";
1654
+ }): UseProductAssociationsReturn;
1655
+
1656
+ type UseProductConfiguratorReturn = {
1657
+ /**
1658
+ * Handler for action when the selected option is changed
1659
+ */
1660
+ handleChange(attribute: string, option: string, onChangeHandled: () => void): Promise<void>;
1661
+ findVariantForSelectedOptions(options?: {
1662
+ [key: string]: string;
1663
+ }): Promise<Schemas["Product"] | undefined>;
1664
+ /**
1665
+ * Indicates if the options are being (re)loaded
1666
+ */
1667
+ isLoadingOptions: Ref<boolean>;
1668
+ /**
1669
+ * Object of currently selected options
1670
+ */
1671
+ getSelectedOptions: ComputedRef<{
1672
+ [key: string]: string;
1673
+ }>;
1674
+ /**
1675
+ * All assigned properties which the variant can be made of
1676
+ */
1677
+ getOptionGroups: ComputedRef<Schemas["PropertyGroup"][]>;
1678
+ };
1679
+ /**
1680
+ * Composable to change product variant.
1681
+ * @public
1682
+ * @category Product
1683
+ */
1684
+ declare function useProductConfigurator(): UseProductConfiguratorReturn;
1685
+
1686
+ type UseProductPriceReturn = {
1687
+ /**
1688
+ * Whole calculated price object
1689
+ */
1690
+ price: ComputedRef<Schemas["CalculatedPrice"] | undefined>;
1691
+ /**
1692
+ * Calculated price value for one selling unit
1693
+ */
1694
+ totalPrice: ComputedRef<number | undefined>;
1695
+ /**
1696
+ * Current unit price value
1697
+ */
1698
+ unitPrice: ComputedRef<number | undefined>;
1699
+ /**
1700
+ * Can be used if isListPrice is set to true
1701
+ */
1702
+ referencePrice: ComputedRef<Schemas["CalculatedPrice"]["referencePrice"] | undefined>;
1703
+ /**
1704
+ * determines if `price` contains the minimum tier price
1705
+ */
1706
+ displayFrom: ComputedRef<boolean>;
1707
+ /**
1708
+ * cheapest price value for a variant if exists
1709
+ */
1710
+ displayFromVariants: ComputedRef<number | false | undefined>;
1711
+ /**
1712
+ * array of TierPrice object
1713
+ */
1714
+ tierPrices: ComputedRef<TierPrice[]>;
1715
+ /**
1716
+ * determines whether a discount price is set
1717
+ */
1718
+ isListPrice: ComputedRef<boolean>;
1719
+ /**
1720
+ * price for products with regulation price
1721
+ */
1722
+ regulationPrice: ComputedRef<number | undefined>;
1723
+ };
1724
+ /**
1725
+ * The purpose of the `useProductPrice` function is to abstract the logic to expose most useful helpers for price displaying.
1726
+ *
1727
+ * @public
1728
+ * @category Product
1729
+ */
1730
+ declare function useProductPrice(product: Ref<Schemas["Product"] | undefined>): UseProductPriceReturn;
1731
+
1732
+ type UseProductReviewsReturn = {
1733
+ /**
1734
+ * All reviews added to the product
1735
+ */
1736
+ productReviews: ComputedRef<Schemas["ProductReview"][]>;
1737
+ /**
1738
+ * Adds a review to the product
1739
+ * @param data `title` - review title, `content` - review content, `points` - review points (range of 1-5)
1740
+ * @returns
1741
+ */
1742
+ addReview(data: {
1743
+ title: string;
1744
+ content: string;
1745
+ points: number;
1746
+ }): Promise<void>;
1747
+ /**
1748
+ * Fetches the reviews list and assigns the result to the `productReviews` property
1749
+ * @param parameters {@link Schemas["Criteria"]}
1750
+ * @returns
1751
+ */
1752
+ loadProductReviews(parameters?: Schemas["Criteria"]): Promise<operations["readProductReviews post /product/{productId}/reviews"]["response"]>;
1753
+ };
1754
+ /**
1755
+ * Composable for listing customer orders.
1756
+ * @public
1757
+ * @category Product
1758
+ */
1759
+ declare function useProductReviews(product: Ref<Schemas["Product"]>): UseProductReviewsReturn;
1760
+
1761
+ type UseProductSearchReturnOptions = {
1762
+ withCmsAssociations?: boolean;
1763
+ criteria?: Partial<Schemas["Criteria"]>;
1764
+ associations?: Partial<Schemas["Association"]>;
1765
+ };
1766
+ type UseProductSearchReturn = {
1767
+ /**
1768
+ * Searches for a product by its id
1769
+ * @param productId
1770
+ * @param options - optional parameters accepts `withCmsAssociations` flag to fetch cms-related associations and criteria
1771
+ * @returns {Promise<Schemas['ProductDetailResponse']>}
1772
+ */
1773
+ search: (productId: string, options?: UseProductSearchReturnOptions) => Promise<Schemas["ProductDetailResponse"]>;
1774
+ };
1775
+ /**
1776
+ * Composable for product search.
1777
+ * @public
1778
+ * @category Navigation & Routing
1779
+ */
1780
+ declare function useProductSearch(): UseProductSearchReturn;
1781
+
1782
+ type UseProductSearchSuggestReturn = {
1783
+ /**
1784
+ * Current search term
1785
+ */
1786
+ searchTerm: Ref<string>;
1787
+ /**
1788
+ * Indicates if the search is in progress
1789
+ */
1790
+ loading: ComputedRef<boolean>;
1791
+ /**
1792
+ * Performs the search
1793
+ * @param additionalCriteria - additional search criteria of type {@link ShopwareSearchParams}
1794
+ * @returns
1795
+ */
1796
+ search(additionalCriteria?: Partial<operations["searchPage post /search"]["body"]>): Promise<void>;
1797
+ /**
1798
+ * Loads more products for current search criteria
1799
+ */
1800
+ loadMore(criteria: operations["searchPage post /search"]["body"]): Promise<void>;
1801
+ /**
1802
+ * Returns the product list found by the search
1803
+ */
1804
+ getProducts: ComputedRef<Schemas["ProductListingResult"]["elements"]>;
1805
+ /**
1806
+ * Returns the total number of products found by the search
1807
+ */
1808
+ getTotal: ComputedRef<number>;
1809
+ };
1810
+ /**
1811
+ * Composable for product suggest search.
1812
+ * @public
1813
+ * @category Product
1814
+ */
1815
+ declare function useProductSearchSuggest(): UseProductSearchSuggestReturn;
1816
+
1817
+ type UseProductWishlistReturn = {
1818
+ /**
1819
+ * Removes product from wishlist
1820
+ */
1821
+ removeFromWishlist(): Promise<void>;
1822
+ /**
1823
+ * Adds product to wishlist
1824
+ */
1825
+ addToWishlist(): Promise<void>;
1826
+ /**
1827
+ * Indicates whether a product is in wishlist
1828
+ */
1829
+ isInWishlist: Ref<boolean>;
1830
+ };
1831
+ /**
1832
+ * Manage wishlist for a single product.
1833
+ *
1834
+ * @public
1835
+ * @category Product
1836
+ */
1837
+ declare function useProductWishlist(productId: string): UseProductWishlistReturn;
1838
+
1839
+ type UseSalutationsReturn = {
1840
+ /**
1841
+ * All available salutations
1842
+ */
1843
+ getSalutations: ComputedRef<Schemas["Salutation"][]>;
1844
+ /**
1845
+ * Fetches the salutations list and assigns the result to the `salutations` property
1846
+ */
1847
+ fetchSalutations(): Promise<operations["readSalutation post /salutation"]["response"]>;
1848
+ };
1849
+ /**
1850
+ * Composable for fetching the salutations list.
1851
+ * @public
1852
+ * @category Context & Language
1853
+ */
1854
+ declare function useSalutations(): UseSalutationsReturn;
1855
+
1856
+ type UseSessionContextReturn = {
1857
+ /**
1858
+ * Patches the context in order to use new language
1859
+ */
1860
+ setLanguage(language: Partial<Schemas["Language"]>): Promise<void>;
1861
+ /**
1862
+ * Patches the context in order to use new countryId
1863
+ *
1864
+ * @param {string} countryId
1865
+ */
1866
+ setCountry(countryId: string): Promise<void>;
1867
+ /**
1868
+ * current context's language
1869
+ */
1870
+ sessionContext: ComputedRef<Schemas["SalesChannelContext"] | undefined>;
1871
+ /**
1872
+ * Fetches the session context and assigns the result to the `sessionContext` property
1873
+ */
1874
+ refreshSessionContext(): Promise<void>;
1875
+ /**
1876
+ * current context's language
1877
+ */
1878
+ selectedShippingMethod: ComputedRef<Schemas["ShippingMethod"] | null>;
1879
+ /**
1880
+ * Patches the context in order to use new shipping method
1881
+ */
1882
+ setShippingMethod(shippingMethod: Partial<Schemas["ShippingMethod"]>): Promise<void>;
1883
+ /**
1884
+ * current context's payment method
1885
+ */
1886
+ selectedPaymentMethod: ComputedRef<Schemas["PaymentMethod"] | null>;
1887
+ /**
1888
+ * Patches the context in order to use new payment method
1889
+ */
1890
+ setPaymentMethod(paymentMethod: {
1891
+ id: string;
1892
+ }): Promise<void>;
1893
+ /**
1894
+ * current context's currency
1895
+ */
1896
+ currency: ComputedRef<Schemas["Currency"] | null>;
1897
+ /**
1898
+ * Patches the context in order to use new currency
1899
+ */
1900
+ setCurrency(currency: Partial<Schemas["Currency"]>): Promise<void>;
1901
+ /**
1902
+ * current context's shipping address
1903
+ */
1904
+ activeShippingAddress: ComputedRef<Schemas["CustomerAddress"] | null>;
1905
+ /**
1906
+ * Patches the context in order to use new shipping address
1907
+ */
1908
+ setActiveShippingAddress(address: Partial<Schemas["CustomerAddress"]>): Promise<void>;
1909
+ /**
1910
+ * current context's billing address
1911
+ */
1912
+ activeBillingAddress: ComputedRef<Schemas["CustomerAddress"] | null>;
1913
+ /**
1914
+ * current context's tax state
1915
+ */
1916
+ taxState: ComputedRef<string | undefined>;
1917
+ /**
1918
+ * Patches the context in order to use new billing address
1919
+ */
1920
+ setActiveBillingAddress(address: Partial<Schemas["CustomerAddress"]>): Promise<void>;
1921
+ /**
1922
+ * Patches the context with new context
1923
+ */
1924
+ setContext(context: Schemas["SalesChannelContext"]): void;
1925
+ /**
1926
+ * current context's country id
1927
+ */
1928
+ countryId: ComputedRef<string | undefined>;
1929
+ /**
1930
+ * current sales channel country id
1931
+ */
1932
+ salesChannelCountryId: ComputedRef<string | undefined>;
1933
+ /**
1934
+ * current language id
1935
+ */
1936
+ languageId: ComputedRef<string | undefined>;
1937
+ /**
1938
+ * current language id chain
1939
+ */
1940
+ languageIdChain: ComputedRef<string>;
1941
+ /**
1942
+ * current context's customer object
1943
+ */
1944
+ userFromContext: ComputedRef<Schemas["Customer"] | undefined>;
1945
+ };
1946
+ /**
1947
+ * Composable for session management.
1948
+ * SessionContext contain all related data like user, currency, country, shippingMethod, paymentMethod etc.
1949
+ * @public
1950
+ * @category Context & Language
1951
+ */
1952
+ declare function useSessionContext(newContext?: Schemas["SalesChannelContext"]): UseSessionContextReturn;
1953
+
1954
+ type ShopwareContext = {
1955
+ devStorefrontUrl: string | null;
1956
+ /**
1957
+ * Shopware API client
1958
+ */
1959
+ apiClient: ApiClient;
1960
+ };
1961
+ /**
1962
+ * @public
1963
+ * @category Context & Language
1964
+ */
1965
+ declare function useShopwareContext(): ShopwareContext;
1966
+
1967
+ type UseSyncWishlistReturn = {
1968
+ /**
1969
+ * Get products from wishlist
1970
+ */
1971
+ getWishlistProducts(defaultSearchCriteria?: Schemas["Criteria"]): Promise<void>;
1972
+ /**
1973
+ * Merge products with wishlist already existing in API wishlist
1974
+ */
1975
+ mergeWishlistProducts(itemsToMerge: string[]): void;
1976
+ /**
1977
+ * Add product to wishlist
1978
+ */
1979
+ addToWishlistSync(id: string): void;
1980
+ /**
1981
+ * Remove product from wishlist
1982
+ */
1983
+ removeFromWishlistSync(id: string): void;
1984
+ /**
1985
+ * Wishlist items (Product IDs)
1986
+ */
1987
+ items: ComputedRef<string[]>;
1988
+ /**
1989
+ * Wishlist items count
1990
+ */
1991
+ count: ComputedRef<number>;
1992
+ /**
1993
+ * Current page number
1994
+ */
1995
+ currentPage: ComputedRef<number>;
1996
+ };
1997
+ /**
1998
+ * Composable to manage wishlist via API
1999
+ * @public
2000
+ * @category Wishlist
2001
+ */
2002
+ declare function useSyncWishlist(): UseSyncWishlistReturn;
2003
+
2004
+ declare function useUrlResolver(): {
2005
+ resolveUrl: (url: string) => string;
2006
+ getUrlPrefix: () => string;
2007
+ };
2008
+
2009
+ type UseUserReturn = {
2010
+ /**
2011
+ * Logs-in user with given credentials
2012
+ * @param params - username and password
2013
+ *
2014
+ * @see https://github.com/shopware/frontends/issues/112 if login fails due to missing context token
2015
+ */
2016
+ login(params: {
2017
+ username: string;
2018
+ password: string;
2019
+ }): Promise<void>;
2020
+ /**
2021
+ * Registers the user for given credentials
2022
+ * @param params {@link CustomerRegistrationParams}
2023
+ * @returns {@link Customer} object on success
2024
+ */
2025
+ register(params: Omit<operations["register post /account/register"]["body"], "storefrontUrl">): Promise<Schemas["Customer"]>;
2026
+ /**
2027
+ * Whole {@link Customer} object
2028
+ */
2029
+ user: ComputedRef<Schemas["Customer"] | undefined>;
2030
+ /**
2031
+ * Indicates if the user is logged in
2032
+ */
2033
+ isLoggedIn: ComputedRef<boolean>;
2034
+ /**
2035
+ * Indicates if the user is logged in as a customer (not a guest)
2036
+ */
2037
+ isCustomerSession: ComputedRef<boolean>;
2038
+ /**
2039
+ * Indicates if the user is logged in as a guest
2040
+ */
2041
+ isGuestSession: ComputedRef<boolean>;
2042
+ /**
2043
+ * {@link Country} of the user
2044
+ */
2045
+ country: Ref<Schemas["Country"] | null>;
2046
+ /**
2047
+ * {@link Salutation} of the user
2048
+ */
2049
+ salutation: Ref<Schemas["Salutation"] | null>;
2050
+ /**
2051
+ * Default billing address id
2052
+ */
2053
+ defaultBillingAddressId: ComputedRef<string | null>;
2054
+ /**
2055
+ * Default shipping address id
2056
+ */
2057
+ defaultShippingAddressId: ComputedRef<string | null>;
2058
+ /**
2059
+ * Fetches the user data from the API
2060
+ */
2061
+ refreshUser(params?: Schemas["Criteria"]): Promise<Schemas["Customer"]>;
2062
+ /**
2063
+ * Logs out the user
2064
+ */
2065
+ logout(): Promise<operations["logoutCustomer post /account/logout"]["response"]>;
2066
+ /**
2067
+ * Loads the {@link Country} of the user
2068
+ */
2069
+ loadCountry(countryId: string): Promise<operations["readCountry post /country"]["response"]>;
2070
+ /**
2071
+ * Loads the {@link Salutation} for given id
2072
+ */
2073
+ loadSalutation(salutationId: string): Promise<operations["readSalutation post /salutation"]["response"]>;
2074
+ /**
2075
+ * Updates the user profile data
2076
+ * @param personals {@link RequestParameters<'changeProfile'>}
2077
+ * @returns
2078
+ */
2079
+ updatePersonalInfo(personals: operations["changeProfile post /account/change-profile"]["body"]): Promise<void>;
2080
+ /**
2081
+ * Updates the user email
2082
+ * @param updateEmailData - {@link RequestParameters<'changeEmail'>}
2083
+ * @returns
2084
+ */
2085
+ updateEmail(updateEmailData: operations["changeEmail post /account/change-email"]["body"]): Promise<void>;
2086
+ /**
2087
+ * Sets the default payment method for given id
2088
+ * @param paymentMethodId
2089
+ * @returns
2090
+ */
2091
+ setDefaultPaymentMethod(paymentMethodId: string): Promise<void>;
2092
+ /**
2093
+ * Default payment method for the user
2094
+ */
2095
+ userDefaultPaymentMethod: ComputedRef<Schemas["PaymentMethod"]["translated"] | null>;
2096
+ /**
2097
+ * Default billing address for the user
2098
+ */
2099
+ userDefaultBillingAddress: ComputedRef<Schemas["CustomerAddress"] | null>;
2100
+ /**
2101
+ * Default shipping address for the user
2102
+ */
2103
+ userDefaultShippingAddress: ComputedRef<Schemas["CustomerAddress"] | null>;
2104
+ };
2105
+ /**
2106
+ * Composable for user management.
2107
+ * @public
2108
+ * @category Customer & Account
2109
+ */
2110
+ declare function useUser(): UseUserReturn;
2111
+
2112
+ type UseWishlistReturn = {
2113
+ /**
2114
+ * Merge products with wishlist between async (API) and sync (localstorage) wishlists
2115
+ */
2116
+ mergeWishlistProducts(): void;
2117
+ /**
2118
+ * Get products list added to wishlist
2119
+ */
2120
+ getWishlistProducts(query?: Schemas["Criteria"]): Promise<void>;
2121
+ /**
2122
+ * Clear wishlist
2123
+ */
2124
+ clearWishlist(): void;
2125
+ /**
2126
+ * Wishlist items (Product IDs)
2127
+ */
2128
+ items: ComputedRef<string[]>;
2129
+ /**
2130
+ * Current page number
2131
+ */
2132
+ currentPage: ComputedRef<number>;
2133
+ /**
2134
+ * total pages count
2135
+ */
2136
+ totalPagesCount: ComputedRef<number>;
2137
+ /**
2138
+ * total wishlist items count
2139
+ */
2140
+ count: ComputedRef<number>;
2141
+ /**
2142
+ * Indicates if the wishlist can be synced
2143
+ */
2144
+ canSyncWishlist: ComputedRef<boolean>;
2145
+ };
2146
+ /**
2147
+ * Composable to manage wishlist
2148
+ * @public
2149
+ * @category Wishlist
2150
+ */
2151
+ declare function useWishlist(): UseWishlistReturn;
2152
+
2153
+ type UseB2bQuoteManagement = {
2154
+ getQuoteList: () => Promise<Schemas["Quote"][]>;
2155
+ getQuote: (quoteId: string) => Promise<Schemas["Quote"]>;
2156
+ declineQuote: (quoteId: string, comment: string) => Promise<void>;
2157
+ requestChangeQuote: (quoteId: string, comment: string) => Promise<void>;
2158
+ requestQuote: (comment: string) => Promise<Schemas["Quote"]>;
2159
+ createOrderFromQuote: (quoteId: string, comment: string) => Promise<Schemas["Order"]>;
2160
+ changeShippingMethod: (quoteId: string, shippingMethodId: string) => Promise<void>;
2161
+ changePaymentMethod: (quoteId: string, paymentMethodId: string) => Promise<void>;
2162
+ };
2163
+ type ChangePaymentShippingMethodParams = {
2164
+ quoteId: string;
2165
+ paymentMethodId?: string;
2166
+ shippingMethodId?: string;
2167
+ };
2168
+ /**
2169
+ * Composable to manage quotes in the B2BQuote module.
2170
+ *
2171
+ * With this composable you can:
2172
+ * - Get list of quotes
2173
+ * - Get quote details
2174
+ * - Decline quote
2175
+ * - Request change of the quote
2176
+ * - Change shipping method
2177
+ * - Change payment method
2178
+ * - Create order from quote
2179
+ * - Request quote
2180
+ *
2181
+ * @category B2B
2182
+ * @returns {UseB2bQuoteManagement}
2183
+ */
2184
+ declare function useB2bQuoteManagement(): UseB2bQuoteManagement;
2185
+
2186
+ type useCartNotificationReturn = {
2187
+ codeErrorsNotification(): void;
2188
+ getErrorsCodes(): Schemas["CartError"][];
2189
+ };
2190
+ /**
2191
+ * UI composable
2192
+ *
2193
+ * @category Cart & Checkout
2194
+ * @returns
2195
+ */
2196
+ declare function useCartNotification(): useCartNotificationReturn;
2197
+
2198
+ type UseCartErrorParamsResolver = {
2199
+ resolveCartError: (errorObject: ErrorObjectParam) => {
2200
+ params: {
2201
+ [key: string]: string | number | null | undefined;
2202
+ } | null;
2203
+ messageKey: string;
2204
+ };
2205
+ };
2206
+ type ErrorObjectParam = {
2207
+ messageKey: string;
2208
+ key: string;
2209
+ message?: string;
2210
+ code?: number;
2211
+ level?: number;
2212
+ };
2213
+ /**
2214
+ * @category Cart & Checkout
2215
+ *
2216
+ * @returns
2217
+ */
2218
+ declare function useCartErrorParamsResolver(): UseCartErrorParamsResolver;
2219
+
2220
+ declare function resolveCmsComponent(content: Schemas["CmsSection"] | Schemas["CmsBlock"] | Schemas["CmsSlot"]): {
2221
+ componentName: string;
2222
+ componentNameToResolve: never;
2223
+ isResolved: boolean;
2224
+ resolvedComponent: vue.ConcreteComponent<{}, any, any, vue.ComputedOptions, vue.MethodOptions, {}, any> | undefined;
2225
+ resolved?: undefined;
2226
+ error?: undefined;
2227
+ } | {
2228
+ componentName: string;
2229
+ componentNameToResolve: never;
2230
+ resolvedComponent: undefined;
2231
+ resolved: boolean;
2232
+ isResolved: boolean;
2233
+ error: string;
2234
+ };
2235
+ declare function getDefaultApiParams(): {
2236
+ [composableName: string]: unknown;
2237
+ };
2238
+
2239
+ export { type BoxLayout, type Breadcrumb, type ChangePaymentShippingMethodParams, type CmsBlockCategoryNavigation, type CmsBlockCenterText, type CmsBlockCrossSelling, type CmsBlockForm, type CmsBlockGalleryBuybox, type CmsBlockImage, type CmsBlockImageBubbleRow, type CmsBlockImageCover, type CmsBlockImageFourColumn, type CmsBlockImageGallery, type CmsBlockImageHighlightRow, type CmsBlockImageSimpleGrid, type CmsBlockImageSlider, type CmsBlockImageText, type CmsBlockImageTextBubble, type CmsBlockImageTextCover, type CmsBlockImageTextGallery, type CmsBlockImageTextRow, type CmsBlockImageThreeColumn, type CmsBlockImageThreeCover, type CmsBlockImageTwoColumn, type CmsBlockProductDescriptionReviews, type CmsBlockProductHeading, type CmsBlockProductListing, type CmsBlockProductSlider, type CmsBlockProductThreeColumn, type CmsBlockSidebarFilter, type CmsBlockText, type CmsBlockTextHero, type CmsBlockTextOnImage, type CmsBlockTextTeaser, type CmsBlockTextTeaserSection, type CmsBlockTextThreeColumn, type CmsBlockTextTwoColumn, type CmsBlockVimeoVideo, type CmsBlockYoutubeVideo, type CmsElementBuyBox, type CmsElementCategoryNavigation, type CmsElementCrossSelling, type CmsElementForm, type CmsElementImage, type CmsElementImageGallery, type CmsElementImageSlider, type CmsElementManufacturerLogo, type CmsElementProductBox, type CmsElementProductDescriptionReviews, type CmsElementProductListing, type CmsElementProductName, type CmsElementProductSlider, type CmsElementSidebarFilter, type CmsElementText, type CmsElementVimeoVideo, type CmsElementYoutubeVideo, type CmsSectionBlock, type CmsSectionDefault, type CmsSectionSidebar, type DisplayMode, type ElementConfig, type ErrorObjectParam, type ImageContainerAttrs, type ListingType, type Notification, type NotificationOptions, type Position, type RouteObject, type ShopwareContext, type ShortcutFilterParam, type SliderElementConfig, type SourceType, type UseAddToCartReturn, type UseAddressReturn, type UseBreadcrumbsReturn, type UseCartErrorParamsResolver, type UseCartItemReturn, type UseCartReturn, type UseCategoryReturn, type UseCategorySearchReturn, type UseCheckoutReturn, type UseCmsBlockReturn, type UseCmsElementImage, type UseCmsMetaReturn, type UseCountriesReturn, type UseCustomerOrdersReturn, type UseCustomerPasswordReturn, type UseDefaultOrderAssociationsReturn, type UseInternationalizationReturn, type UseLandingSearchReturn, type UseListingReturn, type UseLocalWishlistReturn, type UseNavigationContextReturn, type UseNavigationReturn, type UseNavigationSearchReturn, type UseNewsletterReturn, type UseNotificationsReturn, type UseOrderDetailsReturn, type UseOrderPaymentReturn, type UsePriceReturn, type UseProductAssociationsReturn, type UseProductConfiguratorReturn, type UseProductPriceReturn, type UseProductReturn, type UseProductReviewsReturn, type UseProductSearchReturn, type UseProductSearchSuggestReturn, type UseProductWishlistReturn, type UseSalutationsReturn, type UseSessionContextReturn, type UseSyncWishlistReturn, type UseUserReturn, type UseWishlistReturn, type VerticalAlign, createCategoryListingContext, createListingComposable, createShopwareContext, getDefaultApiParams, resolveCmsComponent, useAddToCart, useAddress, useB2bQuoteManagement, useBreadcrumbs, useCart, useCartErrorParamsResolver, useCartFunction, useCartItem, useCartNotification, type useCartNotificationReturn, useCategory, useCategoryListing, useCategorySearch, useCheckout, useCmsBlock, useCmsElementConfig, useCmsElementImage, useCmsMeta, useCmsSection, useCmsTranslations, useContext, useCountries, useCustomerOrders, useCustomerPassword, useDefaultOrderAssociations, useInternationalization, useLandingSearch, useListing, useLocalWishlist, useNavigation, useNavigationContext, useNavigationSearch, useNewsletter, useNotifications, useOrderDetails, useOrderPayment, usePrice, useProduct, useProductAssociations, useProductConfigurator, useProductPrice, useProductReviews, useProductSearch, useProductSearchListing, useProductSearchSuggest, useProductWishlist, useSalutations, useSessionContext, useShopwareContext, useSyncWishlist, useUrlResolver, useUser, useWishlist };