@infosoftas/s4-orders-js-sdk 0.1.21 → 0.2.1

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 (72) hide show
  1. package/.editorconfig +0 -0
  2. package/.release-it.json +0 -0
  3. package/README.md +572 -471
  4. package/build/postcss-scope-tailwind.cjs +0 -0
  5. package/components.json +0 -0
  6. package/package.json +62 -58
  7. package/src/App.completion.test.tsx +677 -0
  8. package/src/App.css +0 -14
  9. package/src/App.paymentReturn.test.tsx +341 -0
  10. package/src/App.tsx +722 -639
  11. package/src/ErrorBoundary.tsx +0 -0
  12. package/src/api/InvoiceApi.ts +0 -0
  13. package/src/api/OrdersApi.ts +74 -59
  14. package/src/api/SubscribeApi.ts +0 -0
  15. package/src/bundle.ts +0 -0
  16. package/src/components/Alert/Alert.tsx +0 -0
  17. package/src/components/Button/Button.tsx +0 -0
  18. package/src/components/EHFForm/EHFForm.tsx +250 -253
  19. package/src/components/FormFields/AddressField.tsx +0 -0
  20. package/src/components/FormFields/EmailField.tsx +0 -0
  21. package/src/components/FormFields/FormFields.helper.ts +0 -0
  22. package/src/components/FormFields/FormFieldsMapper.ts +0 -0
  23. package/src/components/FormFields/InputField.tsx +0 -0
  24. package/src/components/FormFields/NameField.tsx +0 -0
  25. package/src/components/FormFields/PhoneField.tsx +0 -0
  26. package/src/components/FormFields/TermsCheckbox.tsx +0 -0
  27. package/src/components/FormFields/ToggleFiled.tsx +0 -0
  28. package/src/components/FormFields/fieldValidators.ts +0 -0
  29. package/src/components/OIOForm/OIOForm.tsx +304 -307
  30. package/src/components/OrderDenialModal/OrderDenialModal.tsx +0 -0
  31. package/src/components/OrderForm/ContactDetailsSection.tsx +0 -0
  32. package/src/components/OrderForm/OrderForm.tsx +417 -420
  33. package/src/components/OrderForm/PaymentMethodContent.tsx +0 -0
  34. package/src/components/OrderForm/PaymentMethodSection.tsx +0 -0
  35. package/src/components/OrderForm/SubmitConfirmationDialog.tsx +0 -0
  36. package/src/components/OrderForm/orderFormState.ts +0 -0
  37. package/src/components/OrderForm/useSlotElement.tsx +0 -0
  38. package/src/components/ui/alert-dialog.tsx +0 -0
  39. package/src/components/ui/alert.tsx +0 -0
  40. package/src/components/ui/button.tsx +0 -0
  41. package/src/components/ui/card.tsx +0 -0
  42. package/src/components/ui/checkbox.tsx +0 -0
  43. package/src/components/ui/field.tsx +0 -0
  44. package/src/components/ui/input.tsx +0 -0
  45. package/src/components/ui/label.tsx +0 -0
  46. package/src/components/ui/radio-group.tsx +0 -0
  47. package/src/components/ui/separator.tsx +0 -0
  48. package/src/components/ui/skeleton.tsx +0 -0
  49. package/src/components/ui/spinner.tsx +0 -0
  50. package/src/components/ui/switch.tsx +0 -0
  51. package/src/components/ui/textarea.tsx +0 -0
  52. package/src/constants/index.ts +0 -0
  53. package/src/custom.d.ts +0 -0
  54. package/src/enums/api.ts +0 -0
  55. package/src/enums/general.ts +42 -40
  56. package/src/hooks/useOrderForm.tsx +400 -403
  57. package/src/hooks/usePaymentReturn.tsx +139 -0
  58. package/src/hooks/useQueryParams.ts +0 -0
  59. package/src/index.tsx +0 -0
  60. package/src/lib/utils.ts +0 -0
  61. package/src/types/api.ts +0 -0
  62. package/src/types/general.ts +153 -136
  63. package/src/types/order.ts +91 -70
  64. package/src/utils/fetcher.ts +131 -113
  65. package/src/utils/helper.ts +0 -0
  66. package/src/utils/order.helper.test.ts +81 -0
  67. package/src/utils/order.helper.ts +285 -272
  68. package/src/utils/waitForOrderCompletion.ts +125 -0
  69. package/tsconfig.json +39 -38
  70. package/src/components/MainIframe/MainIframe.tsx +0 -42
  71. package/src/hooks/useIframe.tsx +0 -59
  72. package/src/hooks/useMessageEvent.tsx +0 -194
@@ -0,0 +1,341 @@
1
+ // @vitest-environment jsdom
2
+
3
+ import {
4
+ act,
5
+ cleanup,
6
+ fireEvent,
7
+ render,
8
+ screen,
9
+ } from '@testing-library/react';
10
+ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
11
+
12
+ import App from './App';
13
+ import { MessageEventTypeEnum } from './enums/general';
14
+ import type { ConfigType } from './types/general';
15
+ import type { OrderInfoType } from './types/order';
16
+
17
+ const submission = vi.hoisted(() => ({
18
+ url: null as string | null,
19
+ data: null as unknown as OrderInfoType,
20
+ }));
21
+
22
+ vi.mock('./components/OrderForm/OrderForm', () => ({
23
+ default: ({
24
+ callback,
25
+ }: {
26
+ callback: (url: string | null, data: OrderInfoType) => void;
27
+ }) => (
28
+ <button onClick={() => callback(submission.url, submission.data)}>
29
+ Submit order
30
+ </button>
31
+ ),
32
+ }));
33
+
34
+ const response = (body: unknown, status = 200) =>
35
+ new Response(JSON.stringify(body), { status });
36
+
37
+ const fetchMock = vi.fn<typeof fetch>();
38
+
39
+ const renderApp = (props: Partial<ConfigType> = {}) =>
40
+ render(
41
+ <App
42
+ apiKey="tenant-key"
43
+ apiUrl="https://orders.example.test"
44
+ domElementId="sdk-order"
45
+ templatePackageId="template-1"
46
+ subscriberId=""
47
+ userId=""
48
+ identityProviderId=""
49
+ organizationId="organization-1"
50
+ settings={{
51
+ successText: 'Order completed',
52
+ orderProcessingText: 'Processing order',
53
+ }}
54
+ {...props}
55
+ />
56
+ );
57
+
58
+ const returnTo = (search: string) =>
59
+ window.history.replaceState({}, '', `/${search}`);
60
+
61
+ const advance = async (ms = 0) => {
62
+ await act(async () => {
63
+ await vi.advanceTimersByTimeAsync(ms);
64
+ });
65
+ };
66
+
67
+ const requests = () =>
68
+ fetchMock.mock.calls.map(([url, init]) => `${init?.method} ${url}`);
69
+
70
+ const postedMessages = (type: MessageEventTypeEnum) =>
71
+ vi
72
+ .mocked(window.postMessage)
73
+ .mock.calls.map(([message]) => message as { type?: string })
74
+ .filter((message) => message.type === type);
75
+
76
+ const foreignMessages = [
77
+ { type: 'cancel' },
78
+ { type: 'complete', orderId: 'foreign-order', agreementId: 'x' },
79
+ { type: 'completeOrder', orderId: 'foreign-order', agreementId: 'x' },
80
+ ];
81
+
82
+ const postForeignMessages = () =>
83
+ act(() => {
84
+ for (const data of foreignMessages) {
85
+ window.dispatchEvent(new MessageEvent('message', { data }));
86
+ window.dispatchEvent(
87
+ new MessageEvent('message', { data, source: window })
88
+ );
89
+ }
90
+ });
91
+
92
+ describe('full-page payment returns', () => {
93
+ beforeEach(() => {
94
+ vi.useFakeTimers();
95
+ fetchMock.mockReset();
96
+ vi.stubGlobal('fetch', fetchMock);
97
+ returnTo('');
98
+ sessionStorage.clear();
99
+ localStorage.clear();
100
+ submission.url = null;
101
+ submission.data = null as unknown as OrderInfoType;
102
+ vi.spyOn(window, 'postMessage').mockImplementation(() => undefined);
103
+ vi.spyOn(console, 'log').mockImplementation(() => undefined);
104
+ });
105
+
106
+ afterEach(() => {
107
+ cleanup();
108
+ vi.useRealTimers();
109
+ vi.restoreAllMocks();
110
+ vi.unstubAllGlobals();
111
+ });
112
+
113
+ it('ignores payment messages when no checkout is active', async () => {
114
+ renderApp();
115
+ postForeignMessages();
116
+ await advance(1000);
117
+
118
+ expect(fetchMock).not.toHaveBeenCalled();
119
+ expect(
120
+ screen.getByRole('button', { name: 'Submit order' })
121
+ ).toBeTruthy();
122
+ });
123
+
124
+ it('does not let payment messages abort, cancel or redirect an active completion', async () => {
125
+ let finish!: (value: Response) => void;
126
+ fetchMock.mockResolvedValueOnce(response(null)).mockImplementationOnce(
127
+ () =>
128
+ new Promise((resolve) => {
129
+ finish = resolve;
130
+ })
131
+ );
132
+ returnTo(
133
+ '?action=complete&S4OrderId=returned-order&TransactionId=tx-1'
134
+ );
135
+ renderApp();
136
+ await advance();
137
+
138
+ postForeignMessages();
139
+ await advance();
140
+
141
+ expect(requests()).toEqual([
142
+ 'POST https://orders.example.test/order/returned-order/complete',
143
+ 'GET https://orders.example.test/order/returned-order',
144
+ ]);
145
+ expect(fetchMock.mock.calls[1][1]?.signal?.aborted).toBe(false);
146
+
147
+ await act(async () => {
148
+ finish(response({ id: 'returned-order', status: 'Completed' }));
149
+ });
150
+ expect(screen.getByText('Order completed')).toBeTruthy();
151
+ expect(
152
+ postedMessages(MessageEventTypeEnum.ORDER_FLOW_COMPLETE)
153
+ ).toEqual([expect.objectContaining({ orderId: 'returned-order' })]);
154
+ });
155
+
156
+ it('sends SwedbankPay to the payment terminal with a full-page redirect', async () => {
157
+ submission.url = `${window.location.origin}/#swedbank-terminal`;
158
+ submission.data = {
159
+ orderId: 'swedbank-order',
160
+ paymentMethod: 'SwedbankPay',
161
+ subscriberId: 'subscriber-7',
162
+ };
163
+ renderApp({ showIframe: true } as Partial<ConfigType>);
164
+
165
+ fireEvent.click(screen.getByRole('button', { name: 'Submit order' }));
166
+ await advance(300);
167
+
168
+ expect(window.location.hash).toBe('#swedbank-terminal');
169
+ expect(document.querySelector('iframe')).toBeNull();
170
+ expect(fetchMock).not.toHaveBeenCalled();
171
+ // Coming back with the browser's back button shows a usable form.
172
+ expect(
173
+ screen.getByRole('button', { name: 'Submit order' })
174
+ ).toBeTruthy();
175
+ expect(screen.queryByTestId('sdk-order-loading-skeleton')).toBeNull();
176
+ });
177
+
178
+ it('completes a SwedbankPay return', async () => {
179
+ fetchMock
180
+ .mockResolvedValueOnce(response(null))
181
+ .mockResolvedValueOnce(
182
+ response({ id: 'returned-order', status: 'Completed' })
183
+ );
184
+ returnTo(
185
+ '?action=complete&S4OrderId=returned-order&TransactionId=tx-1'
186
+ );
187
+ renderApp();
188
+ await advance();
189
+
190
+ expect(requests()).toEqual([
191
+ 'POST https://orders.example.test/order/returned-order/complete',
192
+ 'GET https://orders.example.test/order/returned-order',
193
+ ]);
194
+ expect(screen.getByText('Order completed')).toBeTruthy();
195
+ });
196
+
197
+ it('cancels the order on a SwedbankPay cancel return and reopens the form', async () => {
198
+ fetchMock.mockResolvedValueOnce(response(null));
199
+ returnTo('?action=cancel&S4OrderId=returned-order&TransactionId=tx-1');
200
+ renderApp();
201
+ await advance();
202
+
203
+ expect(requests()).toEqual([
204
+ 'DELETE https://orders.example.test/order/returned-order',
205
+ ]);
206
+ expect(
207
+ screen.getByRole('button', { name: 'Submit order' })
208
+ ).toBeTruthy();
209
+ expect(
210
+ postedMessages(MessageEventTypeEnum.ORDER_FLOW_CANCEL)
211
+ ).toHaveLength(1);
212
+ });
213
+
214
+ it('cancels the stored Mollie order on a cancel return without an order ID', async () => {
215
+ fetchMock.mockResolvedValueOnce(response(null));
216
+ sessionStorage.setItem(
217
+ 'mollieOrderId',
218
+ JSON.stringify({ id: 'mollie-order', ts: Date.now() })
219
+ );
220
+ returnTo('?action=cancel');
221
+ renderApp();
222
+ await advance();
223
+
224
+ expect(requests()).toEqual([
225
+ 'DELETE https://orders.example.test/order/mollie-order',
226
+ ]);
227
+ expect(sessionStorage.getItem('mollieOrderId')).toBeNull();
228
+ });
229
+
230
+ it('completes a Mollie return', async () => {
231
+ fetchMock
232
+ .mockResolvedValueOnce(response(null))
233
+ .mockResolvedValueOnce(
234
+ response({ id: 'mollie-order', status: 'Completed' })
235
+ );
236
+ returnTo('?action=complete&S4OrderId=mollie-order');
237
+ renderApp();
238
+ await advance();
239
+
240
+ expect(requests()).toEqual([
241
+ 'POST https://orders.example.test/order/mollie-order/complete',
242
+ 'GET https://orders.example.test/order/mollie-order',
243
+ ]);
244
+ expect(screen.getByText('Order completed')).toBeTruthy();
245
+ });
246
+
247
+ it('completes a Vipps return', async () => {
248
+ fetchMock
249
+ .mockResolvedValueOnce(response(null))
250
+ .mockResolvedValueOnce(
251
+ response({ id: 'vipps-order', status: 'Completed' })
252
+ );
253
+ returnTo('?orderId=vipps-order&agreementId=agreement-1');
254
+ renderApp();
255
+ await advance();
256
+
257
+ expect(requests()).toEqual([
258
+ 'POST https://orders.example.test/order/vipps-order/complete',
259
+ 'GET https://orders.example.test/order/vipps-order',
260
+ ]);
261
+ expect(screen.getByText('Order completed')).toBeTruthy();
262
+ });
263
+ });
264
+
265
+ describe('payment returns inside a legacy checkout iframe', () => {
266
+ const swedbankComplete =
267
+ '?action=complete&S4OrderId=returned-order&TransactionId=tx-1';
268
+
269
+ const insideFrame = (location: object) => {
270
+ const parent = { location } as unknown as Window;
271
+ vi.spyOn(window, 'top', 'get').mockReturnValue(parent);
272
+ };
273
+
274
+ beforeEach(() => {
275
+ vi.useFakeTimers();
276
+ fetchMock.mockReset();
277
+ fetchMock.mockResolvedValue(response(null));
278
+ vi.stubGlobal('fetch', fetchMock);
279
+ returnTo('');
280
+ sessionStorage.clear();
281
+ vi.spyOn(window, 'postMessage').mockImplementation(() => undefined);
282
+ vi.spyOn(console, 'log').mockImplementation(() => undefined);
283
+ });
284
+
285
+ afterEach(() => {
286
+ cleanup();
287
+ vi.useRealTimers();
288
+ vi.restoreAllMocks();
289
+ vi.unstubAllGlobals();
290
+ });
291
+
292
+ it.each([
293
+ ['a SwedbankPay completion', swedbankComplete],
294
+ ['a cancellation', '?action=cancel&S4OrderId=returned-order'],
295
+ ['a Vipps return', '?orderId=vipps-order&agreementId=agreement-1'],
296
+ ])(
297
+ 'moves %s to the top-level page without handling it in the frame',
298
+ async (_label, search) => {
299
+ const replace = vi.fn();
300
+ insideFrame({ origin: window.location.origin, replace });
301
+ sessionStorage.setItem(
302
+ 'mollieOrderId',
303
+ JSON.stringify({ id: 'mollie-order', ts: Date.now() })
304
+ );
305
+ returnTo(search);
306
+ renderApp();
307
+ await advance(1000);
308
+
309
+ expect(replace).toHaveBeenCalledExactlyOnceWith(
310
+ window.location.href
311
+ );
312
+ expect(fetchMock).not.toHaveBeenCalled();
313
+ expect(sessionStorage.getItem('mollieOrderId')).not.toBeNull();
314
+ }
315
+ );
316
+
317
+ it('handles the return in the frame when the parent page is on another origin', async () => {
318
+ insideFrame({
319
+ get origin(): string {
320
+ throw new DOMException('Blocked', 'SecurityError');
321
+ },
322
+ });
323
+ returnTo(swedbankComplete);
324
+ renderApp({ completionMode: 'external' });
325
+ await advance();
326
+
327
+ expect(requests()).toEqual([
328
+ 'POST https://orders.example.test/order/returned-order/complete',
329
+ ]);
330
+ });
331
+
332
+ it('does nothing in a frame without a payment return', async () => {
333
+ const replace = vi.fn();
334
+ insideFrame({ origin: window.location.origin, replace });
335
+ renderApp();
336
+ await advance(1000);
337
+
338
+ expect(replace).not.toHaveBeenCalled();
339
+ expect(fetchMock).not.toHaveBeenCalled();
340
+ });
341
+ });