@shopware/composables 1.9.1 → 1.11.0

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 (60) hide show
  1. package/README.md +12 -5
  2. package/dist/index.d.mts +116 -34
  3. package/dist/index.d.ts +116 -34
  4. package/dist/index.mjs +117 -74
  5. package/package.json +13 -12
  6. package/src/cms/cmsAssociations.ts +5 -1
  7. package/src/cms/useCmsElementConfig.test.ts +8 -0
  8. package/src/cms/useCmsElementConfig.ts +4 -1
  9. package/src/cms/useCmsElementImage.test.ts +23 -0
  10. package/src/cms/useCmsElementProductBox.test.ts +21 -0
  11. package/src/devtools/plugin.ts +1 -2
  12. package/src/mocks/Configurator.ts +36 -36
  13. package/src/types/cmsBlockTypes.ts +2 -0
  14. package/src/types/cmsElementTypes.ts +24 -18
  15. package/src/useAddToCart/useAddToCart.test.ts +18 -1
  16. package/src/useAddress/useAddress.test.ts +41 -2
  17. package/src/useAddress/useAddress.ts +1 -1
  18. package/src/useCart/useCart.test.ts +42 -0
  19. package/src/useCart/useCart.ts +17 -0
  20. package/src/useCartNotification/useCartNotification.test.ts +30 -0
  21. package/src/useCheckout/useCheckout.test.ts +43 -1
  22. package/src/useCmsMeta/useCmsMeta.test.ts +26 -0
  23. package/src/useCountries/useCountries.test.ts +14 -0
  24. package/src/useCustomerOrders/useCustomerOrders.ts +1 -1
  25. package/src/useDefaultOrderAssociations/useDefaultOrderAssociations.test.ts +19 -21
  26. package/src/useDefaultOrderAssociations/useDefaultOrderAssociations.ts +23 -30
  27. package/src/useLandingSearch/useLandingSearch.test.ts +1 -1
  28. package/src/useLandingSearch/useLandingSearch.ts +1 -1
  29. package/src/useListing/useListing.test.ts +73 -0
  30. package/src/useListing/useListing.ts +10 -3
  31. package/src/useLocalWishlist/useLocalWishlist.test.ts +44 -5
  32. package/src/useLocalWishlist/useLocalWishlist.ts +3 -2
  33. package/src/useNavigationContext/useNavigationContext.test.ts +25 -24
  34. package/src/useNewsletter/useNewsletter.test.ts +16 -0
  35. package/src/useNewsletter/useNewsletter.ts +13 -0
  36. package/src/useOrderDetails/useOrderDetails.test.ts +92 -3
  37. package/src/useOrderDetails/useOrderDetails.ts +12 -14
  38. package/src/useOrderPayment/useOrderPayment.test.ts +55 -1
  39. package/src/useOrderPayment/useOrderPayment.ts +1 -0
  40. package/src/usePrice/usePrice.test.ts +10 -0
  41. package/src/usePrice/usePrice.ts +2 -7
  42. package/src/useProduct/useProduct.test.ts +14 -1
  43. package/src/useProductAssociations/useProductAssociations.spec.ts +1 -0
  44. package/src/useProductConfigurator/useProductConfigurator.spec.ts +38 -0
  45. package/src/useProductConfigurator/useProductConfigurator.ts +1 -1
  46. package/src/useProductPrice/useProductPrice.test.ts +7 -7
  47. package/src/useProductPrice/useProductPrice.ts +12 -4
  48. package/src/useProductReviews/useProductReviews.test.ts +15 -3
  49. package/src/useProductWishlist/useProductWishlist.ts +2 -2
  50. package/src/useSalutations/useSalutations.spec.ts +13 -0
  51. package/src/useSessionContext/useSessionContext.test.ts +122 -4
  52. package/src/useSessionContext/useSessionContext.ts +14 -2
  53. package/src/useSyncWishlist/useSyncWishlist.test.ts +94 -25
  54. package/src/useSyncWishlist/useSyncWishlist.ts +27 -8
  55. package/src/useUrlResolver/useUrlResolver.test.ts +6 -12
  56. package/src/useUrlResolver/useUrlResolver.ts +4 -6
  57. package/src/useUser/useUser.test.ts +233 -18
  58. package/src/useUser/useUser.ts +6 -1
  59. package/src/useWishlist/useWishlist.test.ts +133 -26
  60. package/src/useWishlist/useWishlist.ts +22 -6
@@ -1,4 +1,4 @@
1
- import { describe, expect, it, vi } from "vitest";
1
+ import { beforeEach, describe, expect, it, vi } from "vitest";
2
2
  import { computed, ref } from "vue";
3
3
  import { useSyncWishlist, useUser, useWishlist } from "#imports";
4
4
  import type { Schemas } from "#shopware";
@@ -10,33 +10,38 @@ const getMockedUser = (isLoggedIn: boolean, isGuestSession: boolean) =>
10
10
  isGuestSession: ref(isGuestSession),
11
11
  }) as ReturnType<typeof useUser>;
12
12
 
13
+ const defaultLocalItems = [
14
+ "local-testId-1",
15
+ "local-testId-2",
16
+ "local-testId-3",
17
+ "local-testId-4",
18
+ "local-testId-5",
19
+ "local-testId-6",
20
+ "local-testId-7",
21
+ "local-testId-8",
22
+ "local-testId-9",
23
+ "local-testId-10",
24
+ "local-testId-11",
25
+ "local-testId-12",
26
+ "local-testId-13",
27
+ "local-testId-14",
28
+ "local-testId-15",
29
+ "local-testId-16",
30
+ "local-testId-17",
31
+ ];
32
+ let mockLocalItems: string[] = [...defaultLocalItems];
33
+
13
34
  vi.mock("../useLocalWishlist/useLocalWishlist.ts", () => ({
14
35
  useLocalWishlist() {
15
36
  return {
16
37
  getWishlistProducts: () => undefined,
17
38
  items: {
18
- value: [
19
- "local-testId-1",
20
- "local-testId-2",
21
- "local-testId-3",
22
- "local-testId-4",
23
- "local-testId-5",
24
- "local-testId-6",
25
- "local-testId-7",
26
- "local-testId-8",
27
- "local-testId-9",
28
- "local-testId-10",
29
- "local-testId-11",
30
- "local-testId-12",
31
- "local-testId-13",
32
- "local-testId-14",
33
- "local-testId-15",
34
- "local-testId-16",
35
- "local-testId-17",
36
- ],
39
+ get value() {
40
+ return [...mockLocalItems];
41
+ },
37
42
  },
38
43
  clearWishlist: () => undefined,
39
- count: ref(17),
44
+ count: ref(mockLocalItems.length),
40
45
  };
41
46
  },
42
47
  }));
@@ -44,6 +49,10 @@ vi.mock("../useLocalWishlist/useLocalWishlist.ts", () => ({
44
49
  vi.mock("../useSyncWishlist/useSyncWishlist.ts");
45
50
  vi.mock("../useUser/useUser.ts");
46
51
 
52
+ beforeEach(() => {
53
+ mockLocalItems = [...defaultLocalItems];
54
+ });
55
+
47
56
  describe("useWishlist - not logged in user", () => {
48
57
  it("should merge wishlist products", () => {
49
58
  vi.mocked(useUser).mockReturnValue(getMockedUser(false, true));
@@ -55,6 +64,9 @@ describe("useWishlist - not logged in user", () => {
55
64
  removeFromWishlistSync: () => undefined,
56
65
  count: computed(() => 17),
57
66
  currentPage: computed(() => 2),
67
+ limit: computed(() => 15),
68
+ products: computed((): Schemas["Product"][] => []),
69
+ isLoading: computed(() => false),
58
70
  });
59
71
  const { vm } = useSetup(() => useWishlist());
60
72
 
@@ -77,6 +89,9 @@ describe("useWishlist - not logged in user", () => {
77
89
  removeFromWishlistSync: () => undefined,
78
90
  count: computed(() => 15),
79
91
  currentPage: computed(() => 2),
92
+ limit: computed(() => 15),
93
+ products: computed((): Schemas["Product"][] => []),
94
+ isLoading: computed(() => false),
80
95
  });
81
96
  const { vm } = useSetup(() => useWishlist());
82
97
 
@@ -110,13 +125,58 @@ describe("useWishlist - not logged in user", () => {
110
125
 
111
126
  expect(Number(vm.currentPage)).toBe(2);
112
127
  });
128
+
129
+ it("should handle query without limit property", async () => {
130
+ vi.mocked(useUser).mockReturnValue(getMockedUser(false, true));
131
+ vi.mocked(useSyncWishlist).mockReturnValue({
132
+ getWishlistProducts: () => new Promise<void>((resolve) => resolve()),
133
+ items: computed((): string[] => []),
134
+ addToWishlistSync: () => undefined,
135
+ mergeWishlistProducts: () => undefined,
136
+ removeFromWishlistSync: () => undefined,
137
+ count: computed(() => 0),
138
+ currentPage: computed(() => 1),
139
+ limit: computed(() => 15),
140
+ products: computed((): Schemas["Product"][] => []),
141
+ isLoading: computed(() => false),
142
+ });
143
+ const { vm } = useSetup(() => useWishlist());
144
+
145
+ await vm.getWishlistProducts({ page: 2 });
146
+
147
+ expect(Number(vm.totalPagesCount)).toBe(2);
148
+ });
149
+
150
+ it("should update limit when query has limit", async () => {
151
+ vi.mocked(useUser).mockReturnValue(getMockedUser(false, true));
152
+ vi.mocked(useSyncWishlist).mockReturnValue({
153
+ getWishlistProducts: () => new Promise<void>((resolve) => resolve()),
154
+ items: computed((): string[] => []),
155
+ addToWishlistSync: () => undefined,
156
+ mergeWishlistProducts: () => undefined,
157
+ removeFromWishlistSync: () => undefined,
158
+ count: computed(() => 0),
159
+ currentPage: computed(() => 1),
160
+ limit: computed(() => 10),
161
+ products: computed((): Schemas["Product"][] => []),
162
+ isLoading: computed(() => false),
163
+ });
164
+ const { vm } = useSetup(() => useWishlist());
165
+
166
+ await vm.getWishlistProducts({ limit: 10 });
167
+
168
+ expect(Number(vm.totalPagesCount)).toBe(2);
169
+ });
113
170
  });
114
171
 
115
172
  describe("useWishlist - logged in user", () => {
116
- it("should merge wishlist products", () => {
173
+ it("should merge wishlist products", async () => {
174
+ const mergeWishlistProductsSyncSpy = vi.fn().mockResolvedValue(undefined);
175
+ const getWishlistProductsSyncSpy = vi.fn().mockResolvedValue(undefined);
176
+ const removeFromWishlistSyncSpy = vi.fn().mockResolvedValue(undefined);
117
177
  vi.mocked(useUser).mockReturnValue(getMockedUser(true, false));
118
178
  vi.mocked(useSyncWishlist).mockReturnValue({
119
- getWishlistProducts: () => new Promise<void>((resolve) => resolve()),
179
+ getWishlistProducts: getWishlistProductsSyncSpy,
120
180
  items: computed((): string[] => {
121
181
  return [
122
182
  "local-test-1",
@@ -137,17 +197,39 @@ describe("useWishlist - logged in user", () => {
137
197
  ];
138
198
  }),
139
199
  addToWishlistSync: () => undefined,
140
- mergeWishlistProducts: () => undefined,
141
- removeFromWishlistSync: () => undefined,
200
+ mergeWishlistProducts: mergeWishlistProductsSyncSpy,
201
+ removeFromWishlistSync: removeFromWishlistSyncSpy,
142
202
  count: computed(() => 15),
143
203
  currentPage: computed(() => 1),
204
+ limit: computed(() => 15),
205
+ products: computed((): Schemas["Product"][] => []),
206
+ isLoading: computed(() => false),
144
207
  });
145
208
  const { vm } = useSetup(() => useWishlist());
146
209
 
147
210
  vm.clearWishlist();
148
211
  vm.getWishlistProducts();
149
- vm.mergeWishlistProducts();
212
+ await vm.mergeWishlistProducts();
150
213
 
214
+ expect(mergeWishlistProductsSyncSpy).toHaveBeenCalledWith([
215
+ "local-testId-1",
216
+ "local-testId-2",
217
+ "local-testId-3",
218
+ "local-testId-4",
219
+ "local-testId-5",
220
+ "local-testId-6",
221
+ "local-testId-7",
222
+ "local-testId-8",
223
+ "local-testId-9",
224
+ "local-testId-10",
225
+ "local-testId-11",
226
+ "local-testId-12",
227
+ "local-testId-13",
228
+ "local-testId-14",
229
+ "local-testId-15",
230
+ "local-testId-16",
231
+ "local-testId-17",
232
+ ]);
151
233
  expect(vm.items.length).toBe(15);
152
234
  expect(vm.count).toBe(15);
153
235
  });
@@ -175,4 +257,29 @@ describe("useWishlist - logged in user", () => {
175
257
  "local-test-15",
176
258
  ]);
177
259
  });
260
+
261
+ it("mergeWishlistProducts when local wishlist is empty skips merge", async () => {
262
+ const mergeWishlistProductsSyncSpy = vi.fn().mockResolvedValue(undefined);
263
+ const getWishlistProductsSyncSpy = vi.fn().mockResolvedValue(undefined);
264
+ mockLocalItems = [];
265
+ vi.mocked(useUser).mockReturnValue(getMockedUser(true, false));
266
+ vi.mocked(useSyncWishlist).mockReturnValue({
267
+ getWishlistProducts: getWishlistProductsSyncSpy,
268
+ items: computed((): string[] => []),
269
+ addToWishlistSync: () => undefined,
270
+ mergeWishlistProducts: mergeWishlistProductsSyncSpy,
271
+ removeFromWishlistSync: () => undefined,
272
+ count: computed(() => 0),
273
+ currentPage: computed(() => 1),
274
+ limit: computed(() => 15),
275
+ products: computed((): Schemas["Product"][] => []),
276
+ isLoading: computed(() => false),
277
+ });
278
+ const { vm } = useSetup(() => useWishlist());
279
+
280
+ await vm.mergeWishlistProducts();
281
+
282
+ expect(mergeWishlistProductsSyncSpy).not.toHaveBeenCalled();
283
+ expect(getWishlistProductsSyncSpy).toHaveBeenCalled();
284
+ });
178
285
  });
@@ -40,6 +40,14 @@ export type UseWishlistReturn = {
40
40
  * Indicates if the wishlist can be synced
41
41
  */
42
42
  canSyncWishlist: ComputedRef<boolean>;
43
+ /**
44
+ * Wishlist products
45
+ */
46
+ products: ComputedRef<Schemas["Product"][]>;
47
+ /**
48
+ * Limit number of products per page
49
+ */
50
+ limit: ComputedRef<number>;
43
51
  };
44
52
 
45
53
  /**
@@ -65,21 +73,27 @@ export function useWishlist(): UseWishlistReturn {
65
73
  removeFromWishlistSync,
66
74
  count: countSync,
67
75
  currentPage,
76
+ products,
77
+ limit: limitSync,
68
78
  } = useSyncWishlist();
69
79
 
70
80
  const limit = ref<number>(15);
71
81
 
72
82
  const getWishlistProducts = async (query?: Schemas["Criteria"]) => {
73
- const wishlistQuery = {} as Schemas["Criteria"];
83
+ let wishlistQuery = {
84
+ limit: limit.value,
85
+ } as Schemas["Criteria"];
86
+
74
87
  if (query) {
75
- defu(wishlistQuery, query);
76
- }
77
- if (query?.limit) {
78
- limit.value = query.limit;
88
+ wishlistQuery = defu(query, wishlistQuery);
89
+
90
+ if (query.limit) {
91
+ limit.value = query.limit;
92
+ }
79
93
  }
80
94
 
81
95
  if (canSyncWishlist.value) {
82
- await getWishlistProductsSync(query);
96
+ await getWishlistProductsSync(wishlistQuery);
83
97
  } else {
84
98
  getWishlistProductsLocal();
85
99
  }
@@ -124,5 +138,7 @@ export function useWishlist(): UseWishlistReturn {
124
138
  totalPagesCount,
125
139
  count,
126
140
  canSyncWishlist,
141
+ products,
142
+ limit: limitSync,
127
143
  };
128
144
  }