@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
@@ -1,272 +1,285 @@
1
- import { MessageEventTypeEnum, PaymentMethodEnum } from '../enums/general';
2
- import type { AgreementsType, OrderFormInputsType } from '../types/order';
3
- import type { OrderFormFieldType } from '../types/general';
4
- import { FIELD_TYPES } from '../components/FormFields/FormFields.helper';
5
-
6
- type AgreementModelType = {
7
- paymentMethod: PaymentMethodEnum;
8
- redirectUrl?: string;
9
- showIframe?: boolean;
10
- phoneNumber?: string;
11
- generateSubscriberContact: boolean;
12
- language: string;
13
- merchantAgreementUrl: string;
14
- accountId?: string;
15
- };
16
-
17
- const mapToPaymentProviderLanguage = (language: string) => {
18
- const allowedLanguages = [
19
- 'en-US',
20
- 'sv-SE',
21
- 'nb-NO',
22
- 'da-DK',
23
- 'fi-FI',
24
- 'en-GB',
25
- 'nn-NO',
26
- 'no-NO',
27
- 'se-NO',
28
- ];
29
- if (allowedLanguages.includes(language)) {
30
- return language;
31
- }
32
-
33
- console.warn(`Language ${language} not supported.`);
34
-
35
- return 'en-US';
36
- };
37
-
38
- export const prepareAgreementModel = ({
39
- paymentMethod,
40
- redirectUrl,
41
- showIframe,
42
- phoneNumber,
43
- generateSubscriberContact,
44
- language,
45
- merchantAgreementUrl,
46
- accountId,
47
- }: AgreementModelType): AgreementsType => {
48
- const model: AgreementsType = {
49
- paymentProvider: paymentMethod,
50
- };
51
- const existUrl = new URL(window.location.href);
52
- const journey = existUrl.searchParams.get('journey');
53
- const hashToken = existUrl.searchParams.get('hashToken');
54
- const url = showIframe
55
- ? window.location.href.split('?')[0]
56
- : redirectUrl || window.location.href;
57
- const cancelUrl = new URL(url);
58
- cancelUrl.searchParams.append('action', `${MessageEventTypeEnum.CANCEL}`);
59
- if (journey) {
60
- cancelUrl.searchParams.append('journey', journey);
61
- }
62
- if (hashToken) {
63
- cancelUrl.searchParams.append('hashToken', hashToken);
64
- }
65
- const confirmUrl = new URL(url);
66
- confirmUrl.searchParams.append(
67
- 'action',
68
- `${MessageEventTypeEnum.COMPLETE}`
69
- );
70
- if (journey) {
71
- confirmUrl.searchParams.append('journey', journey);
72
- }
73
- if (hashToken) {
74
- confirmUrl.searchParams.append('hashToken', hashToken);
75
- }
76
-
77
- if (paymentMethod === PaymentMethodEnum.SwedbankPay) {
78
- model.swedbankPay = {
79
- cancelUrl: `${cancelUrl}`,
80
- completeUrl: `${confirmUrl}`,
81
- language: mapToPaymentProviderLanguage(language),
82
- accountId,
83
- };
84
-
85
- return model;
86
- }
87
-
88
- if (paymentMethod === PaymentMethodEnum.Mollie) {
89
- model.mollie = {
90
- accountId,
91
- returnUrl: `${confirmUrl}`,
92
- cancelUrl: `${cancelUrl}`,
93
- language: mapToPaymentProviderLanguage(language),
94
- };
95
-
96
- return model;
97
- }
98
-
99
- if (
100
- paymentMethod === PaymentMethodEnum.Vipps ||
101
- paymentMethod === PaymentMethodEnum.MobilePay
102
- ) {
103
- model.vippsMobilePay = {
104
- generateSubscriberContact,
105
- merchantAgreementUrl,
106
- accountId,
107
- phoneNumber,
108
- merchantRedirectUrl: redirectUrl || window.location.href,
109
- };
110
-
111
- return model;
112
- }
113
-
114
- return model;
115
- };
116
-
117
- type ContactModelType = {
118
- data: OrderFormInputsType;
119
- orderFields: OrderFormFieldType[];
120
- };
121
-
122
- export const prepareContactModel = ({
123
- data,
124
- orderFields,
125
- }: ContactModelType) => {
126
- const organizationNumber =
127
- data.paymentMethod === PaymentMethodEnum.OIO
128
- ? data.cvr?.trim() || undefined
129
- : data.organizationNumber?.trim() || undefined;
130
-
131
- const model = {
132
- name: orderFields.find((i) => i.name === 'name')
133
- ? data.name?.trim() || undefined
134
- : undefined,
135
- email: orderFields.find((i) => i.name === 'email')
136
- ? data.email?.trim() || undefined
137
- : undefined,
138
- phone: orderFields.find((i) => i.name === 'phoneNumber')
139
- ? data.phoneNumber?.trim() || undefined
140
- : undefined,
141
- country: orderFields.find((i) => i.name === 'country')
142
- ? data.country?.trim() || undefined
143
- : undefined,
144
- city: orderFields.find((i) => i.name === 'city')
145
- ? data.city?.trim() || undefined
146
- : undefined,
147
- addressLines: orderFields.find((i) => i.name === 'address')
148
- ? data.address?.trim()
149
- ? data.address
150
- ?.trim()
151
- .replace(/\r\n/g, '\n')
152
- .split('\n')
153
- .filter((line) => line)
154
- : undefined
155
- : undefined,
156
- zip: orderFields.find((i) => i.name === 'zip')
157
- ? data.zip?.trim() || undefined
158
- : undefined,
159
- careOf: orderFields.find((i) => i.name === 'careOf')
160
- ? data.careOf?.trim() || undefined
161
- : undefined,
162
- organizationNumber,
163
- gln:
164
- data.paymentMethod === PaymentMethodEnum.OIO
165
- ? data.gln?.trim() || undefined
166
- : undefined,
167
- };
168
-
169
- return model;
170
- };
171
-
172
- export const prepareInvoiceModel = ({
173
- data,
174
- orderFields,
175
- }: ContactModelType) => {
176
- const model = {
177
- name: orderFields.find((i) => i.name === 'invoiceName')
178
- ? data.invoiceName?.trim() || undefined
179
- : undefined,
180
- email: orderFields.find((i) => i.name === 'invoiceEmail')
181
- ? data.invoiceEmail?.trim() || undefined
182
- : undefined,
183
- phone: orderFields.find((i) => i.name === 'invoicePhoneNumber')
184
- ? data.invoicePhoneNumber?.trim() || undefined
185
- : undefined,
186
- country: orderFields.find((i) => i.name === 'invoiceCountry')
187
- ? data.invoiceCountry?.trim() || undefined
188
- : undefined,
189
- city: orderFields.find((i) => i.name === 'invoiceCity')
190
- ? data.invoiceCity?.trim() || undefined
191
- : undefined,
192
- addressLines: orderFields.find((i) => i.name === 'invoiceAddress')
193
- ? data.invoiceAddress?.trim()
194
- ? data.invoiceAddress
195
- ?.trim()
196
- .replace(/\r\n/g, '\n')
197
- .split('\n')
198
- .filter((line) => line)
199
- : undefined
200
- : undefined,
201
- zip: orderFields.find((i) => i.name === 'invoiceZip')
202
- ? data.invoiceZip?.trim() || undefined
203
- : undefined,
204
- careOf: orderFields.find((i) => i.name === 'invoiceCareOf')
205
- ? data.invoiceCareOf?.trim() || undefined
206
- : undefined,
207
- buyerReference: orderFields.find(
208
- (i) => i.name === 'invoiceBuyerReference'
209
- )
210
- ? data.invoiceBuyerReference?.trim() || undefined
211
- : undefined,
212
- };
213
-
214
- return model;
215
- };
216
-
217
- export const orderInvoiceContactFields = [
218
- {
219
- name: FIELD_TYPES.INVOICE_NAME,
220
- label: 'Name',
221
- required: false,
222
- readOnly: false,
223
- },
224
- {
225
- name: FIELD_TYPES.INVOICE_EMAIL,
226
- label: 'Email',
227
- required: false,
228
- readOnly: false,
229
- },
230
- {
231
- name: FIELD_TYPES.INVOICE_PHONE,
232
- label: 'Phone',
233
- required: false,
234
- readOnly: false,
235
- },
236
- {
237
- name: FIELD_TYPES.INVOICE_COUNTRY,
238
- label: 'Country',
239
- required: false,
240
- readOnly: false,
241
- },
242
- {
243
- name: FIELD_TYPES.INVOICE_CITY,
244
- label: 'City',
245
- required: false,
246
- readOnly: false,
247
- },
248
- {
249
- name: FIELD_TYPES.INVOICE_ADDRESS,
250
- label: 'Address',
251
- required: false,
252
- readOnly: false,
253
- },
254
- {
255
- name: FIELD_TYPES.INVOICE_ZIP,
256
- label: 'Zip',
257
- required: false,
258
- readOnly: false,
259
- },
260
- {
261
- name: FIELD_TYPES.INVOICE_CARE_OF,
262
- label: 'Contact Person',
263
- required: false,
264
- readOnly: false,
265
- },
266
- {
267
- name: FIELD_TYPES.INVOICE_BUYER_REFERENCE,
268
- label: 'Buyer Reference',
269
- required: false,
270
- readOnly: false,
271
- },
272
- ];
1
+ import { PaymentMethodEnum, PaymentReturnActionEnum } from '../enums/general';
2
+ import type { AgreementsType, OrderFormInputsType } from '../types/order';
3
+ import type { OrderFormFieldType } from '../types/general';
4
+ import { FIELD_TYPES } from '../components/FormFields/FormFields.helper';
5
+
6
+ type AgreementModelType = {
7
+ paymentMethod: PaymentMethodEnum;
8
+ redirectUrl?: string;
9
+ phoneNumber?: string;
10
+ generateSubscriberContact: boolean;
11
+ language: string;
12
+ merchantAgreementUrl: string;
13
+ accountId?: string;
14
+ };
15
+
16
+ const mapToPaymentProviderLanguage = (language: string) => {
17
+ const allowedLanguages = [
18
+ 'en-US',
19
+ 'sv-SE',
20
+ 'nb-NO',
21
+ 'da-DK',
22
+ 'fi-FI',
23
+ 'en-GB',
24
+ 'nn-NO',
25
+ 'no-NO',
26
+ 'se-NO',
27
+ ];
28
+ if (allowedLanguages.includes(language)) {
29
+ return language;
30
+ }
31
+
32
+ console.warn(`Language ${language} not supported.`);
33
+
34
+ return 'en-US';
35
+ };
36
+
37
+ // Parameters a payment provider adds on return. A return URL built from a page
38
+ // that is itself a return would otherwise carry the previous attempt's values,
39
+ // and the first `action`/`S4OrderId` wins when the next return is read.
40
+ const PAYMENT_RETURN_PARAMS = [
41
+ 'action',
42
+ 's4orderid',
43
+ 'transactionid',
44
+ 'orderid',
45
+ 'agreementid',
46
+ ];
47
+
48
+ const withoutPaymentReturnParams = (href: string) => {
49
+ const url = new URL(href);
50
+ for (const key of [...url.searchParams.keys()]) {
51
+ if (PAYMENT_RETURN_PARAMS.includes(key.toLowerCase())) {
52
+ url.searchParams.delete(key);
53
+ }
54
+ }
55
+ return url;
56
+ };
57
+
58
+ export const prepareAgreementModel = ({
59
+ paymentMethod,
60
+ redirectUrl,
61
+ phoneNumber,
62
+ generateSubscriberContact,
63
+ language,
64
+ merchantAgreementUrl,
65
+ accountId,
66
+ }: AgreementModelType): AgreementsType => {
67
+ const model: AgreementsType = {
68
+ paymentProvider: paymentMethod,
69
+ };
70
+ const existUrl = new URL(window.location.href);
71
+ const journey = existUrl.searchParams.get('journey');
72
+ const hashToken = existUrl.searchParams.get('hashToken');
73
+ const baseUrl = withoutPaymentReturnParams(
74
+ redirectUrl || window.location.href
75
+ );
76
+ const buildReturnUrl = (action: PaymentReturnActionEnum) => {
77
+ const returnUrl = new URL(baseUrl);
78
+ returnUrl.searchParams.set('action', action);
79
+ if (journey) {
80
+ returnUrl.searchParams.set('journey', journey);
81
+ }
82
+ if (hashToken) {
83
+ returnUrl.searchParams.set('hashToken', hashToken);
84
+ }
85
+ return returnUrl;
86
+ };
87
+ const cancelUrl = buildReturnUrl(PaymentReturnActionEnum.CANCEL);
88
+ const confirmUrl = buildReturnUrl(PaymentReturnActionEnum.COMPLETE);
89
+
90
+ if (paymentMethod === PaymentMethodEnum.SwedbankPay) {
91
+ model.swedbankPay = {
92
+ cancelUrl: `${cancelUrl}`,
93
+ completeUrl: `${confirmUrl}`,
94
+ language: mapToPaymentProviderLanguage(language),
95
+ accountId,
96
+ };
97
+
98
+ return model;
99
+ }
100
+
101
+ if (paymentMethod === PaymentMethodEnum.Mollie) {
102
+ model.mollie = {
103
+ accountId,
104
+ returnUrl: `${confirmUrl}`,
105
+ cancelUrl: `${cancelUrl}`,
106
+ language: mapToPaymentProviderLanguage(language),
107
+ };
108
+
109
+ return model;
110
+ }
111
+
112
+ if (
113
+ paymentMethod === PaymentMethodEnum.Vipps ||
114
+ paymentMethod === PaymentMethodEnum.MobilePay
115
+ ) {
116
+ model.vippsMobilePay = {
117
+ generateSubscriberContact,
118
+ merchantAgreementUrl,
119
+ accountId,
120
+ phoneNumber,
121
+ merchantRedirectUrl: `${baseUrl}`,
122
+ };
123
+
124
+ return model;
125
+ }
126
+
127
+ return model;
128
+ };
129
+
130
+ type ContactModelType = {
131
+ data: OrderFormInputsType;
132
+ orderFields: OrderFormFieldType[];
133
+ };
134
+
135
+ export const prepareContactModel = ({
136
+ data,
137
+ orderFields,
138
+ }: ContactModelType) => {
139
+ const organizationNumber =
140
+ data.paymentMethod === PaymentMethodEnum.OIO
141
+ ? data.cvr?.trim() || undefined
142
+ : data.organizationNumber?.trim() || undefined;
143
+
144
+ const model = {
145
+ name: orderFields.find((i) => i.name === 'name')
146
+ ? data.name?.trim() || undefined
147
+ : undefined,
148
+ email: orderFields.find((i) => i.name === 'email')
149
+ ? data.email?.trim() || undefined
150
+ : undefined,
151
+ phone: orderFields.find((i) => i.name === 'phoneNumber')
152
+ ? data.phoneNumber?.trim() || undefined
153
+ : undefined,
154
+ country: orderFields.find((i) => i.name === 'country')
155
+ ? data.country?.trim() || undefined
156
+ : undefined,
157
+ city: orderFields.find((i) => i.name === 'city')
158
+ ? data.city?.trim() || undefined
159
+ : undefined,
160
+ addressLines: orderFields.find((i) => i.name === 'address')
161
+ ? data.address?.trim()
162
+ ? data.address
163
+ ?.trim()
164
+ .replace(/\r\n/g, '\n')
165
+ .split('\n')
166
+ .filter((line) => line)
167
+ : undefined
168
+ : undefined,
169
+ zip: orderFields.find((i) => i.name === 'zip')
170
+ ? data.zip?.trim() || undefined
171
+ : undefined,
172
+ careOf: orderFields.find((i) => i.name === 'careOf')
173
+ ? data.careOf?.trim() || undefined
174
+ : undefined,
175
+ organizationNumber,
176
+ gln:
177
+ data.paymentMethod === PaymentMethodEnum.OIO
178
+ ? data.gln?.trim() || undefined
179
+ : undefined,
180
+ };
181
+
182
+ return model;
183
+ };
184
+
185
+ export const prepareInvoiceModel = ({
186
+ data,
187
+ orderFields,
188
+ }: ContactModelType) => {
189
+ const model = {
190
+ name: orderFields.find((i) => i.name === 'invoiceName')
191
+ ? data.invoiceName?.trim() || undefined
192
+ : undefined,
193
+ email: orderFields.find((i) => i.name === 'invoiceEmail')
194
+ ? data.invoiceEmail?.trim() || undefined
195
+ : undefined,
196
+ phone: orderFields.find((i) => i.name === 'invoicePhoneNumber')
197
+ ? data.invoicePhoneNumber?.trim() || undefined
198
+ : undefined,
199
+ country: orderFields.find((i) => i.name === 'invoiceCountry')
200
+ ? data.invoiceCountry?.trim() || undefined
201
+ : undefined,
202
+ city: orderFields.find((i) => i.name === 'invoiceCity')
203
+ ? data.invoiceCity?.trim() || undefined
204
+ : undefined,
205
+ addressLines: orderFields.find((i) => i.name === 'invoiceAddress')
206
+ ? data.invoiceAddress?.trim()
207
+ ? data.invoiceAddress
208
+ ?.trim()
209
+ .replace(/\r\n/g, '\n')
210
+ .split('\n')
211
+ .filter((line) => line)
212
+ : undefined
213
+ : undefined,
214
+ zip: orderFields.find((i) => i.name === 'invoiceZip')
215
+ ? data.invoiceZip?.trim() || undefined
216
+ : undefined,
217
+ careOf: orderFields.find((i) => i.name === 'invoiceCareOf')
218
+ ? data.invoiceCareOf?.trim() || undefined
219
+ : undefined,
220
+ buyerReference: orderFields.find(
221
+ (i) => i.name === 'invoiceBuyerReference'
222
+ )
223
+ ? data.invoiceBuyerReference?.trim() || undefined
224
+ : undefined,
225
+ };
226
+
227
+ return model;
228
+ };
229
+
230
+ export const orderInvoiceContactFields = [
231
+ {
232
+ name: FIELD_TYPES.INVOICE_NAME,
233
+ label: 'Name',
234
+ required: false,
235
+ readOnly: false,
236
+ },
237
+ {
238
+ name: FIELD_TYPES.INVOICE_EMAIL,
239
+ label: 'Email',
240
+ required: false,
241
+ readOnly: false,
242
+ },
243
+ {
244
+ name: FIELD_TYPES.INVOICE_PHONE,
245
+ label: 'Phone',
246
+ required: false,
247
+ readOnly: false,
248
+ },
249
+ {
250
+ name: FIELD_TYPES.INVOICE_COUNTRY,
251
+ label: 'Country',
252
+ required: false,
253
+ readOnly: false,
254
+ },
255
+ {
256
+ name: FIELD_TYPES.INVOICE_CITY,
257
+ label: 'City',
258
+ required: false,
259
+ readOnly: false,
260
+ },
261
+ {
262
+ name: FIELD_TYPES.INVOICE_ADDRESS,
263
+ label: 'Address',
264
+ required: false,
265
+ readOnly: false,
266
+ },
267
+ {
268
+ name: FIELD_TYPES.INVOICE_ZIP,
269
+ label: 'Zip',
270
+ required: false,
271
+ readOnly: false,
272
+ },
273
+ {
274
+ name: FIELD_TYPES.INVOICE_CARE_OF,
275
+ label: 'Contact Person',
276
+ required: false,
277
+ readOnly: false,
278
+ },
279
+ {
280
+ name: FIELD_TYPES.INVOICE_BUYER_REFERENCE,
281
+ label: 'Buyer Reference',
282
+ required: false,
283
+ readOnly: false,
284
+ },
285
+ ];