@myparcel-dev/pdk-checkout-common 1.7.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 (135) hide show
  1. package/CHANGELOG.md +122 -0
  2. package/dist/__tests__/constants.d.ts +15 -0
  3. package/dist/__tests__/getMockCheckoutContext.d.ts +2 -0
  4. package/dist/__tests__/getMockDeliveryOptionsConfig.d.ts +2 -0
  5. package/dist/__tests__/getMockFormData.d.ts +3 -0
  6. package/dist/__tests__/getMockPdkCheckoutConfig.d.ts +2 -0
  7. package/dist/__tests__/index.d.ts +9 -0
  8. package/dist/__tests__/mockDeliveryOptionsElement.d.ts +1 -0
  9. package/dist/__tests__/mockPdkCheckout.d.ts +2 -0
  10. package/dist/__tests__/mockShippingMethod.d.ts +1 -0
  11. package/dist/__tests__/spies.d.ts +7 -0
  12. package/dist/constants.d.ts +1 -0
  13. package/dist/createPdkCheckout.d.ts +2 -0
  14. package/dist/data/address.d.ts +15 -0
  15. package/dist/data/events.d.ts +20 -0
  16. package/dist/data/index.d.ts +4 -0
  17. package/dist/data/store.d.ts +3 -0
  18. package/dist/data/utils.d.ts +13 -0
  19. package/dist/defaults/defaultFormChange.d.ts +1 -0
  20. package/dist/defaults/defaultGetAddressType.d.ts +2 -0
  21. package/dist/defaults/defaultGetFormData.d.ts +3 -0
  22. package/dist/defaults/defaultHasDeliveryOptions.d.ts +1 -0
  23. package/dist/defaults/index.d.ts +4 -0
  24. package/dist/globals.d.ts +13 -0
  25. package/dist/index.d.ts +11 -0
  26. package/dist/init/addFormListeners.d.ts +1 -0
  27. package/dist/init/createConfig.d.ts +2 -0
  28. package/dist/init/index.d.ts +4 -0
  29. package/dist/init/initializeCheckoutStore.d.ts +1 -0
  30. package/dist/init/setupGlobals.d.ts +2 -0
  31. package/dist/listeners/index.d.ts +2 -0
  32. package/dist/listeners/updateAddressType.d.ts +2 -0
  33. package/dist/listeners/updateCheckoutForm.d.ts +1 -0
  34. package/dist/store/createCheckoutStore.d.ts +2 -0
  35. package/dist/store/index.d.ts +3 -0
  36. package/dist/store/logStoreDebugInfo.d.ts +3 -0
  37. package/dist/store/realCreateStore.d.ts +3 -0
  38. package/dist/types/address.types.d.ts +2 -0
  39. package/dist/types/checkout.types.d.ts +70 -0
  40. package/dist/types/endpoints.types.d.ts +20 -0
  41. package/dist/types/global.types.d.ts +42 -0
  42. package/dist/types/index.d.ts +5 -0
  43. package/dist/types/store.types.d.ts +34 -0
  44. package/dist/utils/getEnabledShippingMethods.d.ts +1 -0
  45. package/dist/utils/getFrontendContext.d.ts +2 -0
  46. package/dist/utils/global/doRequest.d.ts +5 -0
  47. package/dist/utils/global/fieldsEqual.d.ts +8 -0
  48. package/dist/utils/global/getAddressField.d.ts +5 -0
  49. package/dist/utils/global/getAddressFieldValue.d.ts +2 -0
  50. package/dist/utils/global/getAddressType.d.ts +2 -0
  51. package/dist/utils/global/getElement.d.ts +1 -0
  52. package/dist/utils/global/getFieldValue.d.ts +8 -0
  53. package/dist/utils/global/index.d.ts +9 -0
  54. package/dist/utils/global/setFieldValue.d.ts +2 -0
  55. package/dist/utils/global/triggerEvent.d.ts +4 -0
  56. package/dist/utils/hasAddressType.d.ts +2 -0
  57. package/dist/utils/index.d.ts +11 -0
  58. package/dist/utils/realUseUtil.d.ts +2 -0
  59. package/dist/utils/useCheckoutStore.d.ts +1 -0
  60. package/dist/utils/useConfig.d.ts +1 -0
  61. package/dist/utils/useEvent.d.ts +3 -0
  62. package/dist/utils/usePdkCheckout.d.ts +2 -0
  63. package/dist/utils/useSettings.d.ts +2 -0
  64. package/dist/utils/useUtil.d.ts +2 -0
  65. package/package.json +50 -0
  66. package/src/__tests__/__snapshots__/exports.spec.ts.snap +62 -0
  67. package/src/__tests__/constants.ts +17 -0
  68. package/src/__tests__/exports.spec.ts +8 -0
  69. package/src/__tests__/getMockCheckoutContext.ts +44 -0
  70. package/src/__tests__/getMockDeliveryOptionsConfig.ts +27 -0
  71. package/src/__tests__/getMockFormData.ts +29 -0
  72. package/src/__tests__/getMockPdkCheckoutConfig.ts +46 -0
  73. package/src/__tests__/index.ts +9 -0
  74. package/src/__tests__/mockDeliveryOptionsElement.ts +20 -0
  75. package/src/__tests__/mockPdkCheckout.ts +32 -0
  76. package/src/__tests__/mockShippingMethod.ts +8 -0
  77. package/src/__tests__/spies.ts +16 -0
  78. package/src/constants.ts +1 -0
  79. package/src/createPdkCheckout.ts +32 -0
  80. package/src/data/address.ts +17 -0
  81. package/src/data/events.ts +38 -0
  82. package/src/data/index.ts +4 -0
  83. package/src/data/store.ts +3 -0
  84. package/src/data/utils.ts +13 -0
  85. package/src/defaults/defaultFormChange.ts +9 -0
  86. package/src/defaults/defaultGetAddressType.ts +4 -0
  87. package/src/defaults/defaultGetFormData.ts +11 -0
  88. package/src/defaults/defaultHasDeliveryOptions.ts +8 -0
  89. package/src/defaults/index.ts +4 -0
  90. package/src/globals.ts +18 -0
  91. package/src/index.ts +11 -0
  92. package/src/init/addFormListeners.ts +10 -0
  93. package/src/init/createConfig.ts +15 -0
  94. package/src/init/index.ts +4 -0
  95. package/src/init/initializeCheckoutStore.ts +5 -0
  96. package/src/init/setupGlobals.ts +75 -0
  97. package/src/listeners/index.ts +2 -0
  98. package/src/listeners/updateAddressType.ts +13 -0
  99. package/src/listeners/updateCheckoutForm.ts +38 -0
  100. package/src/store/createCheckoutStore.ts +27 -0
  101. package/src/store/index.ts +3 -0
  102. package/src/store/logStoreDebugInfo.ts +19 -0
  103. package/src/store/realCreateStore.ts +64 -0
  104. package/src/types/address.types.ts +3 -0
  105. package/src/types/checkout.types.ts +89 -0
  106. package/src/types/endpoints.types.ts +31 -0
  107. package/src/types/global.types.ts +56 -0
  108. package/src/types/index.ts +5 -0
  109. package/src/types/store.types.ts +43 -0
  110. package/src/utils/getEnabledShippingMethods.ts +9 -0
  111. package/src/utils/getFrontendContext.ts +22 -0
  112. package/src/utils/global/doRequest.spec.ts +18 -0
  113. package/src/utils/global/doRequest.ts +25 -0
  114. package/src/utils/global/fieldsEqual.spec.ts +83 -0
  115. package/src/utils/global/fieldsEqual.ts +29 -0
  116. package/src/utils/global/getAddressField.ts +20 -0
  117. package/src/utils/global/getAddressFieldValue.ts +6 -0
  118. package/src/utils/global/getAddressType.ts +10 -0
  119. package/src/utils/global/getElement.spec.ts +28 -0
  120. package/src/utils/global/getElement.ts +10 -0
  121. package/src/utils/global/getFieldValue.ts +24 -0
  122. package/src/utils/global/index.ts +9 -0
  123. package/src/utils/global/setFieldValue.ts +24 -0
  124. package/src/utils/global/triggerEvent.spec.ts +29 -0
  125. package/src/utils/global/triggerEvent.ts +23 -0
  126. package/src/utils/hasAddressType.spec.ts +22 -0
  127. package/src/utils/hasAddressType.ts +8 -0
  128. package/src/utils/index.ts +11 -0
  129. package/src/utils/realUseUtil.ts +11 -0
  130. package/src/utils/useCheckoutStore.ts +2 -0
  131. package/src/utils/useConfig.ts +2 -0
  132. package/src/utils/useEvent.ts +9 -0
  133. package/src/utils/usePdkCheckout.ts +5 -0
  134. package/src/utils/useSettings.ts +5 -0
  135. package/src/utils/useUtil.ts +3 -0
@@ -0,0 +1,11 @@
1
+ export * from './getEnabledShippingMethods';
2
+ export * from './getFrontendContext';
3
+ export * from './global';
4
+ export * from './hasAddressType';
5
+ export * from './realUseUtil';
6
+ export * from './useCheckoutStore';
7
+ export * from './useConfig';
8
+ export * from './useEvent';
9
+ export * from './usePdkCheckout';
10
+ export * from './useSettings';
11
+ export * from './useUtil';
@@ -0,0 +1,2 @@
1
+ import { type MyParcelPdk } from '../types';
2
+ export declare const realUseUtil: MyParcelPdk['useUtil'];
@@ -0,0 +1 @@
1
+ export declare const useCheckoutStore: () => import("..").CheckoutStore;
@@ -0,0 +1 @@
1
+ export declare const useConfig: () => import("..").PdkCheckoutConfig;
@@ -0,0 +1,3 @@
1
+ import { type MyParcelPdk } from '../types';
2
+ import { type PdkEvent } from '../data';
3
+ export declare const useEvent: <E extends string>(event: E) => E extends PdkEvent ? MyParcelPdk['events'][E] : string;
@@ -0,0 +1,2 @@
1
+ import { type PdkCheckout } from '../types';
2
+ export declare const usePdkCheckout: () => PdkCheckout;
@@ -0,0 +1,2 @@
1
+ import { type Plugin } from '@myparcel-dev/pdk-common';
2
+ export declare const useSettings: () => Plugin.ModelContextCheckoutContext['settings'];
@@ -0,0 +1,2 @@
1
+ import { type MyParcelPdk } from '../types';
2
+ export declare const useUtil: MyParcelPdk['useUtil'];
package/package.json ADDED
@@ -0,0 +1,50 @@
1
+ {
2
+ "name": "@myparcel-dev/pdk-checkout-common",
3
+ "version": "1.7.0",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "https://github.com/myparcelnl/js-pdk.git",
7
+ "directory": "libs/checkout-common"
8
+ },
9
+ "license": "MIT",
10
+ "sideEffects": false,
11
+ "type": "module",
12
+ "exports": "./src/index.ts",
13
+ "types": "./dist/index.d.ts",
14
+ "files": [
15
+ "./src",
16
+ "./dist"
17
+ ],
18
+ "scripts": {
19
+ "build": "run ws:ts:build \"$(pwd)\"",
20
+ "clean": "run ws:clean \"$(pwd)\"",
21
+ "lint": "run ws:lint \"$(pwd)\"",
22
+ "lint:fix": "run ws:lint:fix \"$(pwd)\"",
23
+ "test": "run ws:test \"$(pwd)\"",
24
+ "test:coverage": "run ws:test:coverage \"$(pwd)\"",
25
+ "test:run": "run ws:test:run \"$(pwd)\"",
26
+ "test:update": "run ws:test:update \"$(pwd)\"",
27
+ "typecheck": "run ws:ts:typecheck \"$(pwd)\""
28
+ },
29
+ "dependencies": {
30
+ "@myparcel-dev/constants": "^2.7.0",
31
+ "@myparcel-dev/delivery-options": "^6.23.0",
32
+ "@myparcel-dev/pdk-common": "^1.11.0",
33
+ "typescript": "^5.2.2"
34
+ },
35
+ "devDependencies": {
36
+ "radash": "^12.1.0",
37
+ "typescript": "^5.2.2",
38
+ "vitest": "^2.1.3"
39
+ },
40
+ "engines": {
41
+ "node": ">=20"
42
+ },
43
+ "volta": {
44
+ "extends": "../../package.json"
45
+ },
46
+ "publishConfig": {
47
+ "access": "public"
48
+ },
49
+ "deployGroup": "checkout"
50
+ }
@@ -0,0 +1,62 @@
1
+ // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
2
+
3
+ exports[`exports > exports from index.ts 1`] = `
4
+ [
5
+ "ATTRIBUTE_CONTEXT",
6
+ "AddressField",
7
+ "AddressType",
8
+ "EVENT_CHECKOUT",
9
+ "EVENT_DELIVERY_OPTIONS",
10
+ "EVENT_PDK",
11
+ "EVENT_STORE",
12
+ "EVENT_TYPE_INITIALIZE",
13
+ "EVENT_TYPE_INITIALIZED",
14
+ "EVENT_TYPE_SYNCHRONIZE",
15
+ "EVENT_TYPE_SYNCHRONIZED",
16
+ "EVENT_TYPE_UPDATE",
17
+ "EVENT_TYPE_UPDATED",
18
+ "PdkEvent",
19
+ "PdkField",
20
+ "PdkUtil",
21
+ "StoreListener",
22
+ "addFormListeners",
23
+ "createCheckoutStore",
24
+ "createConfig",
25
+ "createEventName",
26
+ "createPdkCheckout",
27
+ "defaultFormChange",
28
+ "defaultGetAddressType",
29
+ "defaultGetFormData",
30
+ "defaultHasDeliveryOptions",
31
+ "doRequest",
32
+ "eventCheckoutUpdate",
33
+ "eventCheckoutUpdated",
34
+ "eventStoreInitialize",
35
+ "fieldsEqual",
36
+ "getAddressField",
37
+ "getAddressFieldValue",
38
+ "getAddressType",
39
+ "getElement",
40
+ "getEnabledShippingMethods",
41
+ "getFieldValue",
42
+ "getFrontendContext",
43
+ "globals",
44
+ "hasAddressType",
45
+ "initializeCheckoutStore",
46
+ "logStoreDebugInfo",
47
+ "realCreateStore",
48
+ "realUseUtil",
49
+ "setFieldValue",
50
+ "setupGlobals",
51
+ "tests",
52
+ "triggerEvent",
53
+ "updateAddressType",
54
+ "updateCheckoutForm",
55
+ "useCheckoutStore",
56
+ "useConfig",
57
+ "useEvent",
58
+ "usePdkCheckout",
59
+ "useSettings",
60
+ "useUtil",
61
+ ]
62
+ `;
@@ -0,0 +1,17 @@
1
+ import {type PdkFormData} from '../types';
2
+ import {AddressType} from '../data';
3
+
4
+ export const DEFAULT_MOCK_FORM_DATA = Object.freeze({
5
+ 'address-type': AddressType.Billing,
6
+ 'b-address1': 'Straatnaam 12e',
7
+ 'b-address2': '',
8
+ 'b-city': 'Amsterdam',
9
+ 'b-country': 'NL',
10
+ 'b-postal-code': '1234AB',
11
+ 's-address1': 'Straatnaam 12e',
12
+ 's-address2': '',
13
+ 's-city': 'Amsterdam',
14
+ 's-country': 'NL',
15
+ 's-postal-code': '1234AB',
16
+ 'shipping-method': 'standard',
17
+ } satisfies PdkFormData);
@@ -0,0 +1,8 @@
1
+ import {describe, expect, it} from 'vitest';
2
+ import * as index from '../index';
3
+
4
+ describe('exports', () => {
5
+ it('exports from index.ts', () => {
6
+ expect(Object.keys(index).sort()).toMatchSnapshot();
7
+ });
8
+ });
@@ -0,0 +1,44 @@
1
+ import {vi} from 'vitest';
2
+ import {FrontendEndpoint, type Plugin} from '@myparcel-dev/pdk-common';
3
+ import {KEY_CONFIG} from '@myparcel-dev/delivery-options';
4
+ import {PackageTypeName} from '@myparcel-dev/constants';
5
+ import {getMockDeliveryOptionsConfig} from './getMockDeliveryOptionsConfig';
6
+
7
+ export const getMockCheckoutContext = vi.fn(
8
+ (context?: Partial<Plugin.ModelContextCheckoutContext>): Plugin.ModelContextCheckoutContext => {
9
+ return {
10
+ settings: {
11
+ hasDeliveryOptions: true,
12
+ actions: {
13
+ baseUrl: '',
14
+ endpoints: {
15
+ [FrontendEndpoint.FetchCheckoutContext]: {
16
+ body: '',
17
+ headers: {},
18
+ method: 'GET',
19
+ parameters: {},
20
+ path: '',
21
+ property: 'context',
22
+ ...context?.settings?.actions?.endpoints?.[FrontendEndpoint.FetchCheckoutContext],
23
+ },
24
+ },
25
+ ...context?.settings?.actions,
26
+ },
27
+ allowedShippingMethods: {
28
+ '-1': ['standard', 'free_shipping'],
29
+ [PackageTypeName.Package]: ['flat_rate:1'],
30
+ [PackageTypeName.PackageSmall]: ['flat_rate:2'],
31
+ [PackageTypeName.Mailbox]: ['flat_rate:3', 'flat_rate:4'],
32
+ [PackageTypeName.DigitalStamp]: ['flat_rate:5'],
33
+ [PackageTypeName.Letter]: ['flat_rate:6'],
34
+ },
35
+ carriersWithTaxFields: [],
36
+ countriesWithSeparateAddressFields: [],
37
+ hiddenInputName: '',
38
+ ...context?.settings,
39
+ },
40
+ [KEY_CONFIG]: getMockDeliveryOptionsConfig(),
41
+ ...context,
42
+ } as Plugin.ModelContextCheckoutContext;
43
+ },
44
+ );
@@ -0,0 +1,27 @@
1
+ import {vi} from 'vitest';
2
+ import {assign} from 'radash';
3
+ import {
4
+ CarrierSetting,
5
+ ConfigSetting,
6
+ type InputDeliveryOptionsConfig,
7
+ KEY_CARRIER_SETTINGS,
8
+ } from '@myparcel-dev/delivery-options';
9
+ import {CarrierName, PackageTypeName, PlatformName} from '@myparcel-dev/constants';
10
+
11
+ export const getMockDeliveryOptionsConfig = vi.fn(
12
+ (config?: Partial<InputDeliveryOptionsConfig>): InputDeliveryOptionsConfig => {
13
+ return assign(
14
+ {
15
+ [ConfigSetting.Platform]: PlatformName.MyParcel,
16
+ [CarrierSetting.PackageType]: PackageTypeName.Package,
17
+ [KEY_CARRIER_SETTINGS]: {
18
+ [CarrierName.PostNl]: {},
19
+ [`${CarrierName.PostNl}:1`]: {},
20
+ [CarrierName.DhlForYou]: {},
21
+ },
22
+ },
23
+ // @ts-expect-error radash types are not great
24
+ config,
25
+ );
26
+ },
27
+ );
@@ -0,0 +1,29 @@
1
+ import {type RecursivePartial} from '@myparcel-dev/ts-utils';
2
+ import {type PdkCheckoutConfigInput} from '../types';
3
+ import {AddressField, AddressType, PdkField} from '../data';
4
+
5
+ export const getMockFormData = (
6
+ formData?: RecursivePartial<PdkCheckoutConfigInput['formData']>,
7
+ ): PdkCheckoutConfigInput['formData'] => {
8
+ return {
9
+ [PdkField.AddressType]: 'address-type',
10
+ [PdkField.ShippingMethod]: 'shipping-method',
11
+ [AddressType.Billing]: {
12
+ [AddressField.Address1]: 'b-address1',
13
+ [AddressField.Address2]: 'b-address2',
14
+ [AddressField.City]: 'b-city',
15
+ [AddressField.Country]: 'b-country',
16
+ [AddressField.PostalCode]: 'b-postal-code',
17
+ ...formData?.[AddressType.Billing],
18
+ },
19
+ [AddressType.Shipping]: {
20
+ [AddressField.Address1]: 's-address1',
21
+ [AddressField.Address2]: 's-address2',
22
+ [AddressField.City]: 's-city',
23
+ [AddressField.Country]: 's-country',
24
+ [AddressField.PostalCode]: 's-postal-code',
25
+ ...formData?.[AddressType.Shipping],
26
+ },
27
+ ...formData,
28
+ } as PdkCheckoutConfigInput['formData'];
29
+ };
@@ -0,0 +1,46 @@
1
+ import {vi} from 'vitest';
2
+ import {type PdkCheckoutConfigInput} from '../types';
3
+ import {AddressField, AddressType, PdkField} from '../data';
4
+ import {doRequestSpy, getFormDataSpy, getFormSpy, hasAddressTypeSpy, initializeSpy, toggleFieldSpy} from './spies';
5
+ import {getMockFormData} from './getMockFormData';
6
+
7
+ export const getMockPdkCheckoutConfig = vi.fn(
8
+ (config?: Partial<PdkCheckoutConfigInput>): PdkCheckoutConfigInput => ({
9
+ doRequest: doRequestSpy,
10
+ getForm: getFormSpy,
11
+ getFormData: getFormDataSpy,
12
+ hasAddressType: hasAddressTypeSpy,
13
+ initialize: initializeSpy,
14
+ toggleField: toggleFieldSpy,
15
+
16
+ selectors: {
17
+ deliveryOptions: '#delivery-options',
18
+ deliveryOptionsWrapper: '#delivery-options-wrapper',
19
+ ...config?.selectors,
20
+ },
21
+
22
+ fields: {
23
+ [PdkField.AddressType]: 'address-type',
24
+ [PdkField.ShippingMethod]: 'shipping-method',
25
+ [AddressType.Billing]: {
26
+ [AddressField.Address1]: 'b-address1',
27
+ [AddressField.Address2]: 'b-address2',
28
+ [AddressField.City]: 'b-city',
29
+ [AddressField.Country]: 'b-country',
30
+ [AddressField.PostalCode]: 'b-postal-code',
31
+ ...config?.fields?.[AddressType.Billing],
32
+ },
33
+ [AddressType.Shipping]: {
34
+ [AddressField.Address1]: 's-address1',
35
+ [AddressField.Address2]: 's-address2',
36
+ [AddressField.City]: 's-city',
37
+ [AddressField.Country]: 's-country',
38
+ [AddressField.PostalCode]: 's-postal-code',
39
+ ...config?.fields?.[AddressType.Shipping],
40
+ },
41
+ ...config?.fields,
42
+ },
43
+
44
+ formData: getMockFormData(config?.formData),
45
+ }),
46
+ );
@@ -0,0 +1,9 @@
1
+ export * from './constants';
2
+ export * from './getMockCheckoutContext';
3
+ export * from './getMockDeliveryOptionsConfig';
4
+ export * from './getMockFormData';
5
+ export * from './getMockPdkCheckoutConfig';
6
+ export * from './mockDeliveryOptionsElement';
7
+ export * from './mockPdkCheckout';
8
+ export * from './mockShippingMethod';
9
+ export * from './spies';
@@ -0,0 +1,20 @@
1
+ import {ATTRIBUTE_CONTEXT} from '../constants';
2
+ import {getMockCheckoutContext} from './getMockCheckoutContext';
3
+
4
+ export const mockDeliveryOptionsElement = (): void => {
5
+ const form = document.createElement('form');
6
+
7
+ const wrapper = document.createElement('div');
8
+ const element = document.createElement('div');
9
+
10
+ form.id = 'test-wrapper';
11
+ wrapper.id = 'delivery-options-wrapper';
12
+ element.id = 'delivery-options';
13
+
14
+ wrapper.setAttribute(ATTRIBUTE_CONTEXT, JSON.stringify({checkout: getMockCheckoutContext()}));
15
+
16
+ wrapper.appendChild(element);
17
+ form.appendChild(wrapper);
18
+
19
+ document.body.appendChild(form);
20
+ };
@@ -0,0 +1,32 @@
1
+ import {usePdkCheckout} from '../utils';
2
+ import {type PdkCheckoutConfigInput} from '../types';
3
+ import {createPdkCheckout} from '../createPdkCheckout';
4
+ import {mockDeliveryOptionsElement} from './mockDeliveryOptionsElement';
5
+ import {getMockPdkCheckoutConfig} from './getMockPdkCheckoutConfig';
6
+
7
+ function reset() {
8
+ // Clear the window object
9
+ // @ts-expect-error this is correct for testing
10
+ window.MyParcelPdk = undefined;
11
+
12
+ // Delete any wrappers added by previous tests
13
+ document.getElementById('test-wrapper')?.remove();
14
+ }
15
+
16
+ export const mockPdkCheckout = (config?: Partial<PdkCheckoutConfigInput>, includeElements = true): Promise<void> => {
17
+ reset();
18
+
19
+ return new Promise((resolve, reject) => {
20
+ if (includeElements) {
21
+ mockDeliveryOptionsElement();
22
+ }
23
+
24
+ createPdkCheckout(getMockPdkCheckoutConfig(config));
25
+
26
+ usePdkCheckout().onInitialize(() => resolve());
27
+
28
+ setTimeout(() => {
29
+ reject(new Error('Timeout: mockPdkCheckout'));
30
+ }, 1000);
31
+ });
32
+ };
@@ -0,0 +1,8 @@
1
+ import {getFormDataSpy} from './spies';
2
+
3
+ export const mockShippingMethod = (shippingMethod: string): void => {
4
+ getFormDataSpy.mockReturnValue({
5
+ ...getFormDataSpy(),
6
+ 'shipping-method': shippingMethod,
7
+ });
8
+ };
@@ -0,0 +1,16 @@
1
+ import {vi} from 'vitest';
2
+ import {type PdkFormData} from '../types';
3
+ import {DEFAULT_MOCK_FORM_DATA} from './constants';
4
+
5
+ export const doRequestSpy = vi.fn();
6
+
7
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
8
+ export const getFormSpy = vi.fn(() => document.querySelector<HTMLFormElement>('form')!);
9
+
10
+ export const getFormDataSpy = vi.fn((): PdkFormData => DEFAULT_MOCK_FORM_DATA);
11
+
12
+ export const hasAddressTypeSpy = vi.fn(() => true);
13
+
14
+ export const initializeSpy = vi.fn(() => Promise.resolve());
15
+
16
+ export const toggleFieldSpy = vi.fn();
@@ -0,0 +1 @@
1
+ export const ATTRIBUTE_CONTEXT = 'data-context';
@@ -0,0 +1,32 @@
1
+ import {useConfig} from './utils';
2
+ import {type InitializeCallback, type PdkCheckoutConfigInput} from './types';
3
+ import {createConfig, setupGlobals} from './init';
4
+
5
+ const execute = (callback: InitializeCallback): void => {
6
+ if (window.MyParcelPdk.initialized) {
7
+ callback();
8
+ } else {
9
+ window.MyParcelPdk.initializeCallbacks.push(callback);
10
+ }
11
+ };
12
+
13
+ // noinspection JSUnusedGlobalSymbols
14
+ export const createPdkCheckout = (config: PdkCheckoutConfigInput): void => {
15
+ setupGlobals(createConfig(config));
16
+
17
+ if (!window.MyParcelPdk.instance) {
18
+ void (async () => {
19
+ const config = useConfig();
20
+
21
+ await config.initialize?.();
22
+
23
+ window.MyParcelPdk.initialized = true;
24
+
25
+ await Promise.all(window.MyParcelPdk.initializeCallbacks.map((callback) => callback()));
26
+ })();
27
+
28
+ window.MyParcelPdk.instance = {
29
+ onInitialize: execute,
30
+ };
31
+ }
32
+ };
@@ -0,0 +1,17 @@
1
+ export enum AddressType {
2
+ Billing = 'billing',
3
+ Shipping = 'shipping',
4
+ }
5
+
6
+ export enum AddressField {
7
+ Address1 = 'address1',
8
+ Address2 = 'address2',
9
+ City = 'city',
10
+ Country = 'country',
11
+ PostalCode = 'postalCode',
12
+ }
13
+
14
+ export enum PdkField {
15
+ AddressType = 'addressType',
16
+ ShippingMethod = 'shippingMethod',
17
+ }
@@ -0,0 +1,38 @@
1
+ export enum PdkEvent {
2
+ CheckoutUpdate = 'checkoutUpdate',
3
+ CheckoutUpdated = 'checkoutUpdated',
4
+ StoreInitialize = 'storeInitialize',
5
+ StoreInitialized = 'storeInitialized',
6
+ }
7
+
8
+ const EVENT_PREFIX = 'myparcelnl';
9
+ const EVENT_SEPARATOR = ':';
10
+ export const EVENT_STORE = 'store';
11
+
12
+ export const EVENT_DELIVERY_OPTIONS = 'deliveryOptions';
13
+
14
+ export const EVENT_CHECKOUT = 'checkout';
15
+
16
+ export const EVENT_PDK = 'pdk';
17
+
18
+ export const EVENT_TYPE_INITIALIZE = 'initialize';
19
+
20
+ export const EVENT_TYPE_INITIALIZED = `${EVENT_TYPE_INITIALIZE}d`;
21
+
22
+ export const EVENT_TYPE_SYNCHRONIZE = 'synchronize';
23
+
24
+ export const EVENT_TYPE_SYNCHRONIZED = `${EVENT_TYPE_SYNCHRONIZE}d`;
25
+
26
+ export const EVENT_TYPE_UPDATE = 'update';
27
+
28
+ export const EVENT_TYPE_UPDATED = `${EVENT_TYPE_UPDATE}d`;
29
+
30
+ export const createEventName = (...names: string[]): string => {
31
+ return [EVENT_PREFIX, ...names].join(EVENT_SEPARATOR);
32
+ };
33
+
34
+ export const eventCheckoutUpdate = createEventName(EVENT_CHECKOUT, EVENT_TYPE_UPDATE);
35
+
36
+ export const eventCheckoutUpdated = createEventName(EVENT_CHECKOUT, EVENT_TYPE_UPDATED);
37
+
38
+ export const eventStoreInitialize = createEventName(EVENT_STORE, EVENT_TYPE_INITIALIZED);
@@ -0,0 +1,4 @@
1
+ export * from './address';
2
+ export * from './events';
3
+ export * from './store';
4
+ export * from './utils';
@@ -0,0 +1,3 @@
1
+ export enum StoreListener {
2
+ Update = 'update',
3
+ }
@@ -0,0 +1,13 @@
1
+ export enum PdkUtil {
2
+ CreateStore = 'createStore',
3
+ DoRequest = 'doRequest',
4
+ FieldsEqual = 'fieldsEqual',
5
+ GetAddressField = 'getAddressField',
6
+ GetAddressFieldValue = 'getAddressFieldValue',
7
+ GetElement = 'getElement',
8
+ GetFieldValue = 'getFieldValue',
9
+ IsEnumValue = 'isEnumValue',
10
+ IsOfType = 'isOfType',
11
+ SetFieldValue = 'setFieldValue',
12
+ TriggerEvent = 'triggerEvent',
13
+ }
@@ -0,0 +1,9 @@
1
+ import {useConfig} from '../utils';
2
+ import {type PdkCheckoutConfig} from '../types';
3
+
4
+ export const defaultFormChange = ((callback) => {
5
+ const config = useConfig();
6
+ const form = config.getForm();
7
+
8
+ form.addEventListener('change', callback);
9
+ }) satisfies PdkCheckoutConfig['formChange'];
@@ -0,0 +1,4 @@
1
+ import {type PdkCheckoutConfig} from '../types';
2
+ import {type AddressType} from '../data';
3
+
4
+ export const defaultGetAddressType = ((value) => value as AddressType) satisfies PdkCheckoutConfig['getAddressType'];
@@ -0,0 +1,11 @@
1
+ import {useConfig} from '../utils';
2
+ import {type PdkCheckoutConfig} from '../types';
3
+
4
+ export const defaultGetFormData = (() => {
5
+ const config = useConfig();
6
+ const form = config.getForm();
7
+
8
+ const formData = new FormData(form);
9
+
10
+ return Object.fromEntries(formData.entries());
11
+ }) satisfies PdkCheckoutConfig['getFormData'];
@@ -0,0 +1,8 @@
1
+ import {getEnabledShippingMethods} from '../utils';
2
+ import {type PdkCheckoutConfig} from '../types';
3
+
4
+ export const defaultHasDeliveryOptions = ((shippingMethod: string): boolean => {
5
+ const enabledShippingMethods = getEnabledShippingMethods();
6
+
7
+ return enabledShippingMethods.some((method) => shippingMethod === method);
8
+ }) satisfies PdkCheckoutConfig['hasDeliveryOptions'];
@@ -0,0 +1,4 @@
1
+ export * from './defaultFormChange';
2
+ export * from './defaultGetAddressType';
3
+ export * from './defaultGetFormData';
4
+ export * from './defaultHasDeliveryOptions';
package/src/globals.ts ADDED
@@ -0,0 +1,18 @@
1
+ import {type MyParcelPdk} from './types';
2
+
3
+ declare global {
4
+ // eslint-disable-next-line @typescript-eslint/no-empty-interface
5
+ interface AdditionalEvents {}
6
+
7
+ // eslint-disable-next-line @typescript-eslint/no-empty-interface
8
+ interface AdditionalStores {}
9
+
10
+ // eslint-disable-next-line @typescript-eslint/no-empty-interface
11
+ interface AdditionalUtils {}
12
+
13
+ interface Window {
14
+ MyParcelPdk: MyParcelPdk;
15
+ }
16
+ }
17
+
18
+ export {};
package/src/index.ts ADDED
@@ -0,0 +1,11 @@
1
+ export * as tests from './__tests__';
2
+ export * from './constants';
3
+ export * from './createPdkCheckout';
4
+ export * from './data';
5
+ export * from './defaults';
6
+ export * as globals from './globals';
7
+ export * from './init';
8
+ export * from './listeners';
9
+ export * from './store';
10
+ export * from './types';
11
+ export * from './utils';
@@ -0,0 +1,10 @@
1
+ import {useConfig} from '../utils';
2
+ import {updateCheckoutForm} from '../listeners';
3
+
4
+ export const addFormListeners = (): void => {
5
+ const config = useConfig();
6
+
7
+ config.formChange(updateCheckoutForm);
8
+
9
+ updateCheckoutForm();
10
+ };
@@ -0,0 +1,15 @@
1
+ import {type PdkCheckoutConfig, type PdkCheckoutConfigInput} from '../types';
2
+ import {defaultFormChange, defaultGetAddressType, defaultGetFormData, defaultHasDeliveryOptions} from '../defaults';
3
+
4
+ export const createConfig = (config: PdkCheckoutConfigInput): PdkCheckoutConfig => ({
5
+ formChange: defaultFormChange,
6
+ getAddressType: defaultGetAddressType,
7
+ getFormData: defaultGetFormData,
8
+ hasDeliveryOptions: defaultHasDeliveryOptions,
9
+
10
+ ...config,
11
+ selectors: {
12
+ deliveryOptions: '#myparcel-delivery-options',
13
+ ...config.selectors,
14
+ },
15
+ });
@@ -0,0 +1,4 @@
1
+ export * from './addFormListeners';
2
+ export * from './createConfig';
3
+ export * from './initializeCheckoutStore';
4
+ export * from './setupGlobals';