@reactionary/source 0.0.52 → 0.2.15

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 (292) hide show
  1. package/.env-template +19 -0
  2. package/.github/workflows/pull-request.yml +3 -1
  3. package/.github/workflows/release.yml +9 -0
  4. package/.vscode/extensions.json +0 -2
  5. package/LICENSE +21 -0
  6. package/README.md +175 -23
  7. package/core/package.json +6 -3
  8. package/core/src/cache/cache.interface.ts +1 -0
  9. package/core/src/cache/index.ts +4 -0
  10. package/core/src/cache/memory-cache.ts +30 -2
  11. package/core/src/cache/noop-cache.ts +15 -1
  12. package/core/src/cache/redis-cache.ts +20 -0
  13. package/core/src/client/client-builder.ts +71 -54
  14. package/core/src/client/client.ts +9 -47
  15. package/core/src/client/index.ts +2 -0
  16. package/core/src/decorators/index.ts +1 -0
  17. package/core/src/decorators/reactionary.decorator.ts +203 -34
  18. package/core/src/index.ts +6 -19
  19. package/core/src/initialization.ts +1 -18
  20. package/core/src/metrics/metrics.ts +67 -0
  21. package/core/src/providers/analytics.provider.ts +1 -6
  22. package/core/src/providers/base.provider.ts +5 -69
  23. package/core/src/providers/cart.provider.ts +15 -55
  24. package/core/src/providers/category.provider.ts +7 -11
  25. package/core/src/providers/checkout.provider.ts +17 -15
  26. package/core/src/providers/identity.provider.ts +6 -8
  27. package/core/src/providers/index.ts +2 -1
  28. package/core/src/providers/inventory.provider.ts +15 -5
  29. package/core/src/providers/order-search.provider.ts +29 -0
  30. package/core/src/providers/order.provider.ts +47 -15
  31. package/core/src/providers/price.provider.ts +30 -36
  32. package/core/src/providers/product-search.provider.ts +61 -0
  33. package/core/src/providers/product.provider.ts +71 -12
  34. package/core/src/providers/profile.provider.ts +74 -14
  35. package/core/src/providers/store.provider.ts +3 -5
  36. package/core/src/schemas/capabilities.schema.ts +10 -3
  37. package/core/src/schemas/errors/generic.error.ts +9 -0
  38. package/core/src/schemas/errors/index.ts +4 -0
  39. package/core/src/schemas/errors/invalid-input.error.ts +9 -0
  40. package/core/src/schemas/errors/invalid-output.error.ts +9 -0
  41. package/core/src/schemas/errors/not-found.error.ts +9 -0
  42. package/core/src/schemas/index.ts +7 -0
  43. package/core/src/schemas/models/analytics.model.ts +2 -1
  44. package/core/src/schemas/models/base.model.ts +6 -24
  45. package/core/src/schemas/models/cart.model.ts +5 -8
  46. package/core/src/schemas/models/category.model.ts +4 -9
  47. package/core/src/schemas/models/checkout.model.ts +6 -7
  48. package/core/src/schemas/models/cost.model.ts +4 -3
  49. package/core/src/schemas/models/currency.model.ts +2 -1
  50. package/core/src/schemas/models/identifiers.model.ts +106 -62
  51. package/core/src/schemas/models/identity.model.ts +10 -19
  52. package/core/src/schemas/models/index.ts +2 -1
  53. package/core/src/schemas/models/inventory.model.ts +8 -5
  54. package/core/src/schemas/models/order-search.model.ts +28 -0
  55. package/core/src/schemas/models/order.model.ts +20 -26
  56. package/core/src/schemas/models/payment.model.ts +14 -17
  57. package/core/src/schemas/models/price.model.ts +11 -11
  58. package/core/src/schemas/models/product-search.model.ts +42 -0
  59. package/core/src/schemas/models/product.model.ts +64 -22
  60. package/core/src/schemas/models/profile.model.ts +19 -22
  61. package/core/src/schemas/models/shipping-method.model.ts +24 -29
  62. package/core/src/schemas/models/store.model.ts +9 -5
  63. package/core/src/schemas/mutations/analytics.mutation.ts +8 -7
  64. package/core/src/schemas/mutations/base.mutation.ts +2 -1
  65. package/core/src/schemas/mutations/cart.mutation.ts +33 -33
  66. package/core/src/schemas/mutations/checkout.mutation.ts +23 -30
  67. package/core/src/schemas/mutations/identity.mutation.ts +4 -3
  68. package/core/src/schemas/mutations/profile.mutation.ts +38 -3
  69. package/core/src/schemas/queries/base.query.ts +2 -1
  70. package/core/src/schemas/queries/cart.query.ts +3 -3
  71. package/core/src/schemas/queries/category.query.ts +18 -18
  72. package/core/src/schemas/queries/checkout.query.ts +7 -9
  73. package/core/src/schemas/queries/identity.query.ts +2 -1
  74. package/core/src/schemas/queries/index.ts +2 -1
  75. package/core/src/schemas/queries/inventory.query.ts +5 -5
  76. package/core/src/schemas/queries/order-search.query.ts +10 -0
  77. package/core/src/schemas/queries/order.query.ts +3 -2
  78. package/core/src/schemas/queries/price.query.ts +10 -4
  79. package/core/src/schemas/queries/product-search.query.ts +16 -0
  80. package/core/src/schemas/queries/product.query.ts +13 -6
  81. package/core/src/schemas/queries/profile.query.ts +5 -2
  82. package/core/src/schemas/queries/store.query.ts +6 -5
  83. package/core/src/schemas/result.ts +107 -0
  84. package/core/src/schemas/session.schema.ts +4 -4
  85. package/core/src/test/reactionary.decorator.spec.ts +249 -0
  86. package/core/src/zod-utils.ts +19 -0
  87. package/core/tsconfig.json +1 -1
  88. package/core/tsconfig.spec.json +2 -26
  89. package/core/vitest.config.ts +14 -0
  90. package/documentation/1-purpose.md +114 -0
  91. package/documentation/2-getting-started.md +229 -0
  92. package/documentation/3-querying-and-changing-data.md +74 -0
  93. package/documentation/4-product-data.md +107 -0
  94. package/documentation/5-cart-and-checkout.md +211 -0
  95. package/documentation/6-product-search.md +143 -0
  96. package/documentation/7-marketing.md +3 -0
  97. package/eslint.config.mjs +1 -0
  98. package/examples/node/eslint.config.mjs +1 -4
  99. package/examples/node/package.json +10 -3
  100. package/examples/node/project.json +4 -1
  101. package/examples/node/src/basic/basic-node-provider-model-extension.spec.ts +22 -23
  102. package/examples/node/src/basic/basic-node-provider-query-extension.spec.ts +15 -11
  103. package/examples/node/src/basic/basic-node-setup.spec.ts +44 -28
  104. package/examples/node/src/basic/client-creation.spec.ts +53 -0
  105. package/examples/node/src/capabilities/cart.spec.ts +255 -0
  106. package/examples/node/src/capabilities/category.spec.ts +193 -0
  107. package/examples/node/src/capabilities/checkout.spec.ts +341 -0
  108. package/examples/node/src/capabilities/identity.spec.ts +93 -0
  109. package/examples/node/src/capabilities/inventory.spec.ts +66 -0
  110. package/examples/node/src/capabilities/order-search.spec.ts +159 -0
  111. package/examples/node/src/capabilities/order.spec.ts +91 -0
  112. package/examples/node/src/capabilities/price.spec.ts +51 -0
  113. package/examples/node/src/capabilities/product-search.spec.ts +293 -0
  114. package/examples/node/src/capabilities/product.spec.ts +122 -0
  115. package/examples/node/src/capabilities/profile.spec.ts +316 -0
  116. package/examples/node/src/capabilities/store.spec.ts +26 -0
  117. package/examples/node/src/utils.ts +137 -0
  118. package/examples/node/tsconfig.json +9 -12
  119. package/examples/node/tsconfig.lib.json +1 -2
  120. package/examples/node/tsconfig.spec.json +2 -14
  121. package/examples/node/vitest.config.ts +14 -0
  122. package/migrations.json +22 -5
  123. package/nx.json +8 -47
  124. package/package.json +24 -96
  125. package/providers/algolia/README.md +39 -2
  126. package/providers/algolia/package.json +2 -1
  127. package/providers/algolia/src/core/initialize.ts +7 -14
  128. package/providers/algolia/src/index.ts +2 -4
  129. package/providers/algolia/src/providers/index.ts +1 -0
  130. package/providers/algolia/src/providers/product-search.provider.ts +241 -0
  131. package/providers/algolia/src/schema/capabilities.schema.ts +2 -3
  132. package/providers/algolia/src/schema/index.ts +3 -0
  133. package/providers/algolia/src/schema/search.schema.ts +8 -8
  134. package/providers/algolia/tsconfig.json +1 -1
  135. package/providers/algolia/tsconfig.lib.json +1 -1
  136. package/providers/algolia/tsconfig.spec.json +2 -14
  137. package/providers/algolia/vitest.config.ts +14 -0
  138. package/providers/commercetools/README.md +30 -3
  139. package/providers/commercetools/package.json +2 -1
  140. package/providers/commercetools/src/core/client.ts +178 -99
  141. package/providers/commercetools/src/core/initialize.ts +130 -74
  142. package/providers/commercetools/src/core/token-cache.ts +45 -0
  143. package/providers/commercetools/src/index.ts +3 -2
  144. package/providers/commercetools/src/providers/cart.provider.ts +281 -341
  145. package/providers/commercetools/src/providers/category.provider.ts +223 -138
  146. package/providers/commercetools/src/providers/checkout.provider.ts +631 -449
  147. package/providers/commercetools/src/providers/identity.provider.ts +50 -29
  148. package/providers/commercetools/src/providers/index.ts +2 -2
  149. package/providers/commercetools/src/providers/inventory.provider.ts +76 -74
  150. package/providers/commercetools/src/providers/order-search.provider.ts +220 -0
  151. package/providers/commercetools/src/providers/order.provider.ts +96 -61
  152. package/providers/commercetools/src/providers/price.provider.ts +147 -117
  153. package/providers/commercetools/src/providers/product-search.provider.ts +528 -0
  154. package/providers/commercetools/src/providers/product.provider.ts +249 -74
  155. package/providers/commercetools/src/providers/profile.provider.ts +445 -28
  156. package/providers/commercetools/src/providers/store.provider.ts +54 -40
  157. package/providers/commercetools/src/schema/capabilities.schema.ts +3 -1
  158. package/providers/commercetools/src/schema/commercetools.schema.ts +17 -3
  159. package/providers/commercetools/src/schema/configuration.schema.ts +1 -0
  160. package/providers/commercetools/src/schema/session.schema.ts +7 -0
  161. package/providers/commercetools/src/test/caching.spec.ts +82 -0
  162. package/providers/commercetools/src/test/identity.spec.ts +109 -0
  163. package/providers/commercetools/src/test/test-utils.ts +21 -19
  164. package/providers/commercetools/tsconfig.json +1 -1
  165. package/providers/commercetools/tsconfig.lib.json +1 -1
  166. package/providers/commercetools/tsconfig.spec.json +2 -14
  167. package/providers/commercetools/vitest.config.ts +15 -0
  168. package/providers/fake/README.md +20 -4
  169. package/providers/fake/package.json +2 -1
  170. package/providers/fake/src/core/initialize.ts +47 -49
  171. package/providers/fake/src/providers/analytics.provider.ts +5 -7
  172. package/providers/fake/src/providers/cart.provider.ts +163 -92
  173. package/providers/fake/src/providers/category.provider.ts +78 -50
  174. package/providers/fake/src/providers/checkout.provider.ts +254 -0
  175. package/providers/fake/src/providers/identity.provider.ts +57 -65
  176. package/providers/fake/src/providers/index.ts +6 -2
  177. package/providers/fake/src/providers/inventory.provider.ts +40 -36
  178. package/providers/fake/src/providers/order-search.provider.ts +78 -0
  179. package/providers/fake/src/providers/order.provider.ts +106 -0
  180. package/providers/fake/src/providers/price.provider.ts +93 -41
  181. package/providers/fake/src/providers/product-search.provider.ts +206 -0
  182. package/providers/fake/src/providers/product.provider.ts +56 -41
  183. package/providers/fake/src/providers/profile.provider.ts +147 -0
  184. package/providers/fake/src/providers/store.provider.ts +30 -20
  185. package/providers/fake/src/schema/capabilities.schema.ts +5 -1
  186. package/providers/fake/src/test/cart.provider.spec.ts +59 -80
  187. package/providers/fake/src/test/category.provider.spec.ts +145 -87
  188. package/providers/fake/src/test/checkout.provider.spec.ts +222 -0
  189. package/providers/fake/src/test/order-search.provider.spec.ts +50 -0
  190. package/providers/fake/src/test/order.provider.spec.ts +44 -0
  191. package/providers/fake/src/test/price.provider.spec.ts +50 -45
  192. package/providers/fake/src/test/product.provider.spec.ts +15 -7
  193. package/providers/fake/src/test/profile.provider.spec.ts +167 -0
  194. package/providers/fake/tsconfig.json +1 -1
  195. package/providers/fake/tsconfig.lib.json +1 -1
  196. package/providers/fake/tsconfig.spec.json +2 -12
  197. package/providers/fake/vitest.config.ts +14 -0
  198. package/providers/medusa/README.md +30 -0
  199. package/providers/medusa/TESTING.md +98 -0
  200. package/providers/medusa/eslint.config.mjs +19 -0
  201. package/providers/medusa/package.json +22 -0
  202. package/providers/medusa/project.json +34 -0
  203. package/providers/medusa/src/core/client.ts +370 -0
  204. package/providers/medusa/src/core/initialize.ts +78 -0
  205. package/providers/medusa/src/index.ts +13 -0
  206. package/providers/medusa/src/providers/cart.provider.ts +575 -0
  207. package/providers/medusa/src/providers/category.provider.ts +247 -0
  208. package/providers/medusa/src/providers/checkout.provider.ts +636 -0
  209. package/providers/medusa/src/providers/identity.provider.ts +137 -0
  210. package/providers/medusa/src/providers/inventory.provider.ts +173 -0
  211. package/providers/medusa/src/providers/order-search.provider.ts +201 -0
  212. package/providers/medusa/src/providers/order.provider.ts +226 -0
  213. package/providers/medusa/src/providers/price.provider.ts +140 -0
  214. package/providers/medusa/src/providers/product-search.provider.ts +243 -0
  215. package/providers/medusa/src/providers/product.provider.ts +261 -0
  216. package/providers/medusa/src/providers/profile.provider.ts +392 -0
  217. package/providers/medusa/src/schema/capabilities.schema.ts +18 -0
  218. package/providers/medusa/src/schema/configuration.schema.ts +11 -0
  219. package/providers/medusa/src/schema/medusa.schema.ts +31 -0
  220. package/providers/medusa/src/test/cart.provider.spec.ts +240 -0
  221. package/providers/medusa/src/test/category.provider.spec.ts +231 -0
  222. package/providers/medusa/src/test/checkout.spec.ts +349 -0
  223. package/providers/medusa/src/test/identity.provider.spec.ts +122 -0
  224. package/providers/medusa/src/test/inventory.provider.spec.ts +88 -0
  225. package/providers/medusa/src/test/large-cart.provider.spec.ts +103 -0
  226. package/providers/medusa/src/test/price.provider.spec.ts +104 -0
  227. package/providers/medusa/src/test/product.provider.spec.ts +146 -0
  228. package/providers/medusa/src/test/search.provider.spec.ts +203 -0
  229. package/providers/medusa/src/test/test-utils.ts +13 -0
  230. package/providers/medusa/src/utils/medusa-helpers.ts +89 -0
  231. package/providers/medusa/tsconfig.json +21 -0
  232. package/providers/medusa/tsconfig.lib.json +9 -0
  233. package/providers/medusa/tsconfig.spec.json +4 -0
  234. package/providers/medusa/vitest.config.ts +15 -0
  235. package/providers/meilisearch/README.md +48 -0
  236. package/providers/meilisearch/eslint.config.mjs +22 -0
  237. package/providers/meilisearch/package.json +13 -0
  238. package/providers/meilisearch/project.json +34 -0
  239. package/providers/meilisearch/src/core/initialize.ts +16 -0
  240. package/providers/meilisearch/src/index.ts +5 -0
  241. package/providers/meilisearch/src/providers/index.ts +1 -0
  242. package/providers/meilisearch/src/providers/product-search.provider.ts +251 -0
  243. package/providers/meilisearch/src/schema/capabilities.schema.ts +9 -0
  244. package/providers/meilisearch/src/schema/configuration.schema.ts +10 -0
  245. package/providers/meilisearch/src/schema/index.ts +3 -0
  246. package/providers/meilisearch/src/schema/search.schema.ts +14 -0
  247. package/providers/meilisearch/tsconfig.json +24 -0
  248. package/providers/meilisearch/tsconfig.lib.json +10 -0
  249. package/providers/meilisearch/tsconfig.spec.json +4 -0
  250. package/providers/meilisearch/vitest.config.ts +14 -0
  251. package/providers/posthog/package.json +2 -1
  252. package/providers/posthog/tsconfig.json +1 -1
  253. package/tsconfig.base.json +5 -0
  254. package/vitest.config.ts +10 -0
  255. package/core/src/providers/search.provider.ts +0 -18
  256. package/core/src/schemas/models/search.model.ts +0 -36
  257. package/core/src/schemas/queries/search.query.ts +0 -9
  258. package/examples/next/.swcrc +0 -30
  259. package/examples/next/eslint.config.mjs +0 -21
  260. package/examples/next/index.d.ts +0 -6
  261. package/examples/next/next-env.d.ts +0 -5
  262. package/examples/next/next.config.js +0 -31
  263. package/examples/next/project.json +0 -9
  264. package/examples/next/public/.gitkeep +0 -0
  265. package/examples/next/public/favicon.ico +0 -0
  266. package/examples/next/src/app/global.css +0 -0
  267. package/examples/next/src/app/layout.tsx +0 -18
  268. package/examples/next/src/app/page.module.scss +0 -2
  269. package/examples/next/src/app/page.tsx +0 -47
  270. package/examples/next/src/instrumentation.ts +0 -9
  271. package/examples/next/tsconfig.json +0 -44
  272. package/examples/node/jest.config.ts +0 -10
  273. package/jest.config.ts +0 -6
  274. package/jest.preset.js +0 -3
  275. package/providers/algolia/jest.config.ts +0 -10
  276. package/providers/algolia/src/providers/product.provider.ts +0 -66
  277. package/providers/algolia/src/providers/search.provider.ts +0 -106
  278. package/providers/algolia/src/test/search.provider.spec.ts +0 -91
  279. package/providers/commercetools/jest.config.cjs +0 -10
  280. package/providers/commercetools/src/providers/search.provider.ts +0 -96
  281. package/providers/commercetools/src/test/cart.provider.spec.ts +0 -199
  282. package/providers/commercetools/src/test/category.provider.spec.ts +0 -168
  283. package/providers/commercetools/src/test/checkout.provider.spec.ts +0 -312
  284. package/providers/commercetools/src/test/identity.provider.spec.ts +0 -88
  285. package/providers/commercetools/src/test/inventory.provider.spec.ts +0 -41
  286. package/providers/commercetools/src/test/price.provider.spec.ts +0 -81
  287. package/providers/commercetools/src/test/product.provider.spec.ts +0 -80
  288. package/providers/commercetools/src/test/profile.provider.spec.ts +0 -49
  289. package/providers/commercetools/src/test/search.provider.spec.ts +0 -61
  290. package/providers/commercetools/src/test/store.provider.spec.ts +0 -37
  291. package/providers/fake/jest.config.cjs +0 -10
  292. package/providers/fake/src/providers/search.provider.ts +0 -132
@@ -0,0 +1,91 @@
1
+ import 'dotenv/config';
2
+ import { assert, beforeEach, describe, expect, it, vi } from 'vitest';
3
+ import { createClient, PrimaryProvider } from '../utils.js';
4
+ import type { OrderIdentifier, ProductSearchQueryCreateNavigationFilter } from '@reactionary/core';
5
+
6
+ const testData = {
7
+ searchTerm: '',
8
+ sku: '0766623301831',
9
+ };
10
+
11
+ describe.each([PrimaryProvider.COMMERCETOOLS])(
12
+ 'Order Search Capability - %s',
13
+ (provider) => {
14
+ let client: ReturnType<typeof createClient>;
15
+
16
+ beforeEach(() => {
17
+ client = createClient(provider);
18
+ });
19
+
20
+ it.skip('can be called by guest users', async () => {
21
+ const updatedCart = await client.cart.add(
22
+ {
23
+ quantity: 1,
24
+ variant: {
25
+ sku: testData.sku
26
+ },
27
+ }
28
+ );
29
+ // create order....somehow.....
30
+
31
+ const orderId: OrderIdentifier = { key: '123456'};
32
+ const identity = await client.identity.getSelf({});
33
+ if (!identity.success) {
34
+ assert.fail();
35
+ }
36
+
37
+ expect(identity.value.type).toBe('Guest');
38
+ const result = await client.order.getById({ order: orderId });
39
+ if (!result.success) {
40
+ assert.fail(JSON.stringify(result.error));
41
+ }
42
+
43
+ const order = result.value;
44
+ expect(order.identifier.key).toBe(orderId.key);
45
+ expect(order.items.length).toBeGreaterThan(0);
46
+ expect(order.price.grandTotal.value).toBeGreaterThan(0);
47
+
48
+ });
49
+
50
+ it.skip('can be called by registered users', async () => {
51
+ const time = new Date().getTime();
52
+ const identity = await client.identity.register(
53
+ {
54
+ username: `test-user+${time}@example.com`,
55
+ password: 'love2test',
56
+ }
57
+ );
58
+
59
+ if (!identity.success) {
60
+ assert.fail();
61
+ }
62
+
63
+ expect(identity.value.type).toBe('Registered');
64
+
65
+ const updatedCart = await client.cart.add(
66
+ {
67
+ quantity: 1,
68
+ variant: {
69
+ sku: testData.sku
70
+ },
71
+ }
72
+ );
73
+ // create order....somehow.....
74
+
75
+ const orderId: OrderIdentifier = { key: '456789'};
76
+
77
+
78
+ expect(identity.value.type).toBe('Guest');
79
+ const result = await client.order.getById({ order: orderId });
80
+ if (!result.success) {
81
+ assert.fail(JSON.stringify(result.error));
82
+ }
83
+
84
+ const order = result.value;
85
+ expect(order.identifier.key).toBe(orderId.key);
86
+ expect(order.items.length).toBeGreaterThan(0);
87
+ expect(order.price.grandTotal.value).toBeGreaterThan(0);
88
+ });
89
+
90
+
91
+ });
@@ -0,0 +1,51 @@
1
+ import 'dotenv/config';
2
+ import { describe, expect, it, beforeEach, assert } from 'vitest';
3
+ import { createClient, PrimaryProvider } from '../utils.js';
4
+
5
+ const testData = {
6
+ skuWithoutTiers: '4049699458101',
7
+ };
8
+
9
+ // FIXME: Currently broken in terms of actually looking up anything...
10
+ describe.each([PrimaryProvider.COMMERCETOOLS])(
11
+ 'Price Capability - %s',
12
+ (provider) => {
13
+ let client: ReturnType<typeof createClient>;
14
+
15
+ beforeEach(() => {
16
+ client = createClient(provider);
17
+ });
18
+
19
+ it('should be able to get an offer price for a sku', async () => {
20
+ const result = await client.price.getCustomerPrice({
21
+ variant: { sku: testData.skuWithoutTiers },
22
+ });
23
+
24
+ if (!result.success) {
25
+ assert.fail();
26
+ }
27
+
28
+ expect(result.value.identifier.variant.sku).toBe(
29
+ testData.skuWithoutTiers
30
+ );
31
+ expect(result.value.unitPrice.value).toBe(155.1);
32
+ expect(result.value.unitPrice.currency).toBe('USD');
33
+ expect(result.value.tieredPrices.length).toBe(0);
34
+ });
35
+
36
+ it('should be able to get a list price for a sku', async () => {
37
+ const result = await client.price.getListPrice({
38
+ variant: { sku: testData.skuWithoutTiers },
39
+ });
40
+
41
+ if (!result.success) {
42
+ assert.fail();
43
+ }
44
+
45
+ expect(result.value.identifier.variant.sku).toBe(testData.skuWithoutTiers);
46
+ expect(result.value.unitPrice.value).toBeGreaterThan(200);
47
+ expect(result.value.unitPrice.currency).toBe('USD');
48
+ expect(result.value.tieredPrices.length).toBe(0);
49
+ });
50
+ }
51
+ );
@@ -0,0 +1,293 @@
1
+ import 'dotenv/config';
2
+ import { assert, beforeEach, describe, expect, it, vi } from 'vitest';
3
+ import { createClient, PrimaryProvider } from '../utils.js';
4
+ import type { ProductSearchQueryCreateNavigationFilter } from '@reactionary/core';
5
+
6
+ const testData = {
7
+ searchTerm: 'manhattan',
8
+ };
9
+
10
+ describe.each([PrimaryProvider.ALGOLIA, PrimaryProvider.COMMERCETOOLS,PrimaryProvider.MEILISEARCH])(
11
+ 'Product Search Capability - %s',
12
+ (provider) => {
13
+ let client: ReturnType<typeof createClient>;
14
+
15
+ beforeEach(() => {
16
+ client = createClient(provider);
17
+ });
18
+
19
+ it('should be able to get a result by term', async () => {
20
+ const result = await client.productSearch.queryByTerm({
21
+ search: {
22
+ term: testData.searchTerm,
23
+ facets: [],
24
+ paginationOptions: {
25
+ pageNumber: 1,
26
+ pageSize: 10,
27
+ },
28
+ filters: [],
29
+ },
30
+ });
31
+
32
+ if (!result.success) {
33
+ assert.fail(JSON.stringify(result.error));
34
+ }
35
+
36
+ expect(result.value.items.length).toBeGreaterThan(0);
37
+ });
38
+
39
+ it('should be able to get a result by term, paged', async () => {
40
+ const result = await client.productSearch.queryByTerm({
41
+ search: {
42
+ term: testData.searchTerm,
43
+ facets: [],
44
+ paginationOptions: {
45
+ pageNumber: 1,
46
+ pageSize: 1,
47
+ },
48
+ filters: [],
49
+ },
50
+ });
51
+
52
+ if (!result.success) {
53
+ assert.fail();
54
+ }
55
+
56
+ expect(result.value.items.length).toBeGreaterThan(0);
57
+ expect(result.value.totalPages).toBeGreaterThan(1);
58
+
59
+ const result2 = await client.productSearch.queryByTerm({
60
+ search: {
61
+ term: testData.searchTerm,
62
+ facets: [],
63
+ paginationOptions: {
64
+ pageNumber: 2,
65
+ pageSize: 1,
66
+ },
67
+ filters: [],
68
+ },
69
+ });
70
+
71
+ if (!result2.success) {
72
+ assert.fail();
73
+ }
74
+
75
+ expect(result2.value.items.length).toBeGreaterThan(0);
76
+ expect(result2.value.totalPages).toBeGreaterThan(2);
77
+ expect(result2.value.items[0].identifier.key).not.toBe(
78
+ result.value.items[0].identifier.key
79
+ );
80
+ });
81
+
82
+ it('should be able to change page size', async () => {
83
+ const smallPage = await client.productSearch.queryByTerm({
84
+ search: {
85
+ term: testData.searchTerm,
86
+ paginationOptions: {
87
+ pageNumber: 1,
88
+ pageSize: 2,
89
+ },
90
+ facets: [],
91
+ filters: [],
92
+ },
93
+ });
94
+ const largePage = await client.productSearch.queryByTerm({
95
+ search: {
96
+ term: testData.searchTerm,
97
+
98
+ paginationOptions: {
99
+ pageNumber: 1,
100
+ pageSize: 30,
101
+ },
102
+ facets: [],
103
+ filters: [],
104
+ },
105
+ });
106
+
107
+ if (!smallPage.success || !largePage.success) {
108
+ assert.fail();
109
+ }
110
+
111
+ expect(smallPage.value.items.length).toBe(2);
112
+ expect(smallPage.value.pageSize).toBe(2);
113
+ expect(largePage.value.items.length).toBe(30);
114
+ expect(largePage.value.pageSize).toBe(30);
115
+ });
116
+
117
+ it('should be able to apply facets', async () => {
118
+ const initial = await client.productSearch.queryByTerm({
119
+ search: {
120
+ term: "",
121
+ paginationOptions: {
122
+ pageNumber: 1,
123
+ pageSize: 2,
124
+ },
125
+ facets: [],
126
+ filters: [],
127
+ },
128
+ });
129
+
130
+ if (!initial.success) {
131
+ assert.fail();
132
+ }
133
+
134
+ expect(initial.value.facets.length).toBeGreaterThan(0);
135
+
136
+ const filtered = await client.productSearch.queryByTerm({
137
+ search: {
138
+ term: "",
139
+ paginationOptions: {
140
+ pageNumber: 1,
141
+ pageSize: 2,
142
+ },
143
+ facets: [initial.value.facets[0].values[0].identifier],
144
+ filters: [],
145
+ },
146
+ });
147
+
148
+ if (!filtered.success) {
149
+ assert.fail();
150
+ }
151
+
152
+ expect(initial.value.totalCount).toBeGreaterThan(filtered.value.totalCount);
153
+ expect(filtered.value.totalCount).toBeGreaterThan(0);
154
+ });
155
+
156
+ it('should not return facets with no values', async () => {
157
+ const result = await client.productSearch.queryByTerm({
158
+ search: {
159
+ term: testData.searchTerm,
160
+ paginationOptions: {
161
+ pageNumber: 1,
162
+ pageSize: 10,
163
+ },
164
+ facets: [],
165
+ filters: [],
166
+ },
167
+ });
168
+
169
+ if (!result.success) {
170
+ assert.fail();
171
+ }
172
+
173
+ for (const facet of result.value.facets) {
174
+ expect(facet.values.length).toBeGreaterThan(0);
175
+ }
176
+ });
177
+
178
+
179
+ it('can apply a category facet', async () => {
180
+ const result = await client.productSearch.queryByTerm({
181
+ search: {
182
+ term: "*",
183
+ paginationOptions: {
184
+ pageNumber: 1,
185
+ pageSize: 10,
186
+ },
187
+ facets: [],
188
+ filters: [],
189
+ },
190
+ });
191
+
192
+ if (!result.success) {
193
+ assert.fail();
194
+ }
195
+
196
+ const categoryFacet = result.value.facets.find(
197
+ (f) => f.identifier.key === 'categories'
198
+ );
199
+ expect(categoryFacet).toBeDefined();
200
+ const chosenFacet = categoryFacet!.values[0]!;
201
+
202
+ const narrowedResult = await client.productSearch.queryByTerm({
203
+ search: {
204
+ term: "*",
205
+ paginationOptions: {
206
+ pageNumber: 1,
207
+ pageSize: 10,
208
+ },
209
+ facets: [chosenFacet.identifier],
210
+ filters: [],
211
+ },
212
+ });
213
+
214
+ if (!narrowedResult.success) {
215
+ assert.fail();
216
+ }
217
+
218
+ expect(narrowedResult.value.totalCount).toBeLessThan(result.value.totalCount);
219
+ expect(narrowedResult.value.totalCount).toBeGreaterThan(0);
220
+ expect(narrowedResult.value.totalCount).toBe(chosenFacet.count);
221
+
222
+ });
223
+
224
+
225
+
226
+ it.skip('can apply a top level category filter', async () => {
227
+ // First, get a category to filter on
228
+ const categories = await client.category.findTopCategories({
229
+ paginationOptions: {
230
+ pageNumber: 1,
231
+ pageSize: 2,
232
+ },
233
+ });
234
+
235
+
236
+ const unfilteredSearch = await client.productSearch.queryByTerm({
237
+ search: {
238
+ term: "",
239
+ paginationOptions: {
240
+ pageNumber: 1,
241
+ pageSize: 1,
242
+ },
243
+ facets: [],
244
+ filters: [],
245
+ },
246
+ });
247
+
248
+ if (!unfilteredSearch.success || !categories.success) {
249
+ assert.fail();
250
+ }
251
+
252
+ expect(unfilteredSearch.value.totalCount).toBeGreaterThan(0);
253
+
254
+ const breadCrumb = await client.category.getBreadcrumbPathToCategory({
255
+ id: categories.value.items[1].identifier,
256
+ });
257
+
258
+ if (!breadCrumb.success) {
259
+ assert.fail();
260
+ }
261
+
262
+ expect(breadCrumb.value.length).toBeGreaterThan(0);
263
+
264
+ const categoryFilter = await client.productSearch.createCategoryNavigationFilter({
265
+ categoryPath: breadCrumb.value,
266
+ } satisfies ProductSearchQueryCreateNavigationFilter);
267
+
268
+ if (!categoryFilter.success) {
269
+ assert.fail();
270
+ }
271
+
272
+ const filteredSearch = await client.productSearch.queryByTerm({
273
+ search: {
274
+ term: "",
275
+ categoryFilter: categoryFilter.value,
276
+ paginationOptions: {
277
+ pageNumber: 1,
278
+ pageSize: 1,
279
+ },
280
+ facets: [],
281
+ filters: [],
282
+ },
283
+ });
284
+
285
+ if (!filteredSearch.success) {
286
+ assert.fail();
287
+ }
288
+
289
+ expect(filteredSearch.value.totalCount).toBeLessThan(unfilteredSearch.value.totalCount);
290
+ expect(filteredSearch.value.totalCount).toBeGreaterThan(0);
291
+ });
292
+ }
293
+ );
@@ -0,0 +1,122 @@
1
+ import 'dotenv/config';
2
+ import { describe, expect, it, beforeEach, assert } from 'vitest';
3
+ import { createClient, PrimaryProvider } from '../utils.js';
4
+
5
+ const testData = {
6
+ product: {
7
+ id: 'product_10959528',
8
+ name: 'Manhattan 170703 cable accessory Cable kit',
9
+ image: 'https://images.icecat.biz/img/norm/high/10959528-2837.jpg',
10
+ sku: '0766623170703',
11
+ slug: 'manhattan-170703-cable-accessory-cable-kit-10959528',
12
+ },
13
+ productWithMultiVariants: {
14
+ slug: 'hp-gk859aa-mouse-office-bluetooth-laser-1600-dpi-1377612',
15
+ },
16
+ };
17
+
18
+ describe.each([PrimaryProvider.COMMERCETOOLS])(
19
+ 'Product Capability - %s',
20
+ (provider) => {
21
+ let client: ReturnType<typeof createClient>;
22
+
23
+ beforeEach(() => {
24
+ client = createClient(provider);
25
+ });
26
+
27
+ it('should be able to get a product by id', async () => {
28
+ const response = await client.product.getById({
29
+ identifier: { key: testData.product.id },
30
+ });
31
+
32
+ if (!response.success) {
33
+ assert.fail();
34
+ }
35
+
36
+ expect(response.value.identifier.key).toBe(testData.product.id);
37
+ expect(response.value.name).toBe(testData.product.name);
38
+ expect(response.value.mainVariant.images[0].sourceUrl).toBe(
39
+ testData.product.image
40
+ );
41
+ expect(response.value.mainVariant.name).toBeTruthy();
42
+ });
43
+
44
+ it('should be able to get a product by slug', async () => {
45
+ const response = await client.product.getBySlug({
46
+ slug: testData.product.slug,
47
+ });
48
+
49
+ if (!response.success) {
50
+ assert.fail();
51
+ }
52
+
53
+ expect(response.value.identifier.key).toBe(testData.product.id);
54
+ expect(response.value.name).toBe(testData.product.name);
55
+ expect(response.value.mainVariant.images[0].sourceUrl).toBe(
56
+ testData.product.image
57
+ );
58
+ });
59
+
60
+ it('should be able to get a multivariant product by slug', async () => {
61
+ const response = await client.product.getBySlug({
62
+ slug: testData.productWithMultiVariants.slug,
63
+ });
64
+
65
+ if (!response.success) {
66
+ assert.fail();
67
+ }
68
+
69
+ expect(response.value.identifier.key).toBeTruthy();
70
+ expect(response.value.slug).toBe(testData.productWithMultiVariants.slug);
71
+ expect(response.value.mainVariant).toBeDefined();
72
+ expect(response.value.variants.length).toBeGreaterThan(0);
73
+ expect(response.value.variants[0].identifier.sku).toBeTruthy();
74
+ expect(response.value.variants[0].identifier.sku).not.toBe(
75
+ response.value.mainVariant.identifier.sku
76
+ );
77
+ expect(response.value.sharedAttributes.length).toBeGreaterThan(1);
78
+ expect(response.value.sharedAttributes[1].values.length).toBeGreaterThan(0);
79
+ expect(response.value.sharedAttributes[1].values[0].value).toBeTruthy();
80
+ });
81
+
82
+ it('should be able to get a product by sku', async () => {
83
+ const response = await client.product.getBySKU({
84
+ variant: { sku: testData.product.sku },
85
+ });
86
+
87
+ if (!response.success) {
88
+ assert.fail();
89
+ }
90
+
91
+ expect(response.value.identifier.key).toBe(testData.product.id);
92
+ expect(response.value.name).toBe(testData.product.name);
93
+ expect(response.value.mainVariant.images[0].sourceUrl).toBe(
94
+ testData.product.image
95
+ );
96
+ });
97
+
98
+ it('should contain both product level and variant level attributes', async () => {
99
+ const response = await client.product.getBySKU({
100
+ variant: { sku: testData.product.sku },
101
+ });
102
+
103
+ if (!response.success) {
104
+ assert.fail();
105
+ }
106
+
107
+ expect(response.value.sharedAttributes.length).toBeGreaterThan(1);
108
+ expect(response.value.sharedAttributes[1].values.length).toBeGreaterThan(0);
109
+ expect(response.value.sharedAttributes[1].values[0].value).toBeTruthy();
110
+ });
111
+
112
+ it('should return an error of NotFound for unknown slug', async () => {
113
+ const response = await client.product.getBySlug({ slug: 'unknown-slug' });
114
+
115
+ if (response.success) {
116
+ assert.fail();
117
+ }
118
+
119
+ expect(response.error.type).toBe('NotFound');
120
+ });
121
+ }
122
+ );