@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,20 @@
1
+ import {useUtil} from '../useUtil';
2
+ import {useConfig} from '../useConfig';
3
+ import {useCheckoutStore} from '../useCheckoutStore';
4
+ import {type AddressField, type AddressType, PdkUtil} from '../../data';
5
+
6
+ /**
7
+ * Get field by name. Will return element with selector: "#<billing|shipping>_<name>".
8
+ */
9
+ export const getAddressField = (
10
+ name: AddressField | string,
11
+ addressType?: AddressType,
12
+ warn = true,
13
+ ): HTMLInputElement | null => {
14
+ const resolvedAddressType = addressType ?? useCheckoutStore().state.addressType;
15
+
16
+ const config = useConfig();
17
+ const getElement = useUtil(PdkUtil.GetElement);
18
+
19
+ return getElement(config.fields[resolvedAddressType][name], warn);
20
+ };
@@ -0,0 +1,6 @@
1
+ import {type AddressField, type AddressType} from '../../data';
2
+ import {getFieldValue} from './getFieldValue';
3
+
4
+ export const getAddressFieldValue = (name: AddressField | string, addressType?: AddressType): undefined | string => {
5
+ return getFieldValue(name, addressType);
6
+ };
@@ -0,0 +1,10 @@
1
+ import {useUtil} from '../useUtil';
2
+ import {useConfig} from '../useConfig';
3
+ import {type AddressType, PdkField, PdkUtil} from '../../data';
4
+
5
+ export const getAddressType = (): AddressType => {
6
+ const getFieldValue = useUtil(PdkUtil.GetFieldValue);
7
+ const config = useConfig();
8
+
9
+ return config.getAddressType(getFieldValue(PdkField.AddressType));
10
+ };
@@ -0,0 +1,28 @@
1
+ import {afterEach, describe, expect, it, vi} from 'vitest';
2
+ import {getElement} from './getElement';
3
+
4
+ describe('getElement', () => {
5
+ afterEach(() => {
6
+ document.body.innerHTML = '';
7
+ });
8
+
9
+ it('should return null if the element is not found', () => {
10
+ expect(getElement('#foo', false)).toBeNull();
11
+ });
12
+
13
+ it('should return the element if it is found', () => {
14
+ document.body.innerHTML = `
15
+ <div id="foo"></div>
16
+ `;
17
+
18
+ expect(getElement('#foo')).toEqual(document.querySelector('#foo'));
19
+ });
20
+
21
+ it('should warn if the element is not found', () => {
22
+ const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
23
+
24
+ getElement('#foo', true);
25
+
26
+ expect(consoleWarnSpy).toHaveBeenCalledWith('Element not found: "#foo"');
27
+ });
28
+ });
@@ -0,0 +1,10 @@
1
+ export const getElement = <E extends Element = Element>(selector: string, warn = true): null | E => {
2
+ const element = document.querySelector<E>(selector);
3
+
4
+ if (!element && warn) {
5
+ // eslint-disable-next-line no-console
6
+ console.warn(`Element not found: "${selector}"`);
7
+ }
8
+
9
+ return element ?? null;
10
+ };
@@ -0,0 +1,24 @@
1
+ import {isEnumValue} from '@myparcel-dev/ts-utils';
2
+ import {useCheckoutStore} from '../useCheckoutStore';
3
+ import {type PdkCheckoutForm} from '../../types';
4
+ import {type AddressField, type AddressType, PdkField} from '../../data';
5
+
6
+ type GetFieldValue = {
7
+ (field: AddressField | string, addressType?: AddressType, fields?: PdkCheckoutForm): undefined | string;
8
+ (field: PdkField | string, fields?: PdkCheckoutForm, arg3?: never): undefined | string;
9
+ };
10
+
11
+ export const getFieldValue: GetFieldValue = (name, arg2, arg3) => {
12
+ const checkout = useCheckoutStore();
13
+
14
+ if (isEnumValue(name, PdkField)) {
15
+ const object = (arg2 as PdkCheckoutForm) ?? checkout.state.form;
16
+
17
+ return object[name]?.trim();
18
+ }
19
+
20
+ const object = arg3 ?? checkout.state.form;
21
+ const addressType = (arg2 ?? checkout.state.addressType) as AddressType;
22
+
23
+ return object[addressType]?.[name as AddressField]?.trim();
24
+ };
@@ -0,0 +1,9 @@
1
+ export * from './doRequest';
2
+ export * from './fieldsEqual';
3
+ export * from './getAddressField';
4
+ export * from './getAddressFieldValue';
5
+ export * from './getAddressType';
6
+ export * from './getElement';
7
+ export * from './getFieldValue';
8
+ export * from './setFieldValue';
9
+ export * from './triggerEvent';
@@ -0,0 +1,24 @@
1
+ import {useUtil} from '../useUtil';
2
+ import {useConfig} from '../useConfig';
3
+ import {type AddressField, type AddressType, PdkUtil} from '../../data';
4
+ import {getAddressField} from './getAddressField';
5
+
6
+ export const setFieldValue = (
7
+ name: AddressField | string,
8
+ value?: string,
9
+ addressType?: AddressType,
10
+ dispatchEvent = true,
11
+ ): void => {
12
+ const field = getAddressField(name, addressType);
13
+
14
+ if (field) {
15
+ field.value = value ?? '';
16
+
17
+ if (dispatchEvent) {
18
+ const triggerEvent = useUtil(PdkUtil.TriggerEvent);
19
+ const config = useConfig();
20
+
21
+ triggerEvent('change', undefined, config.getForm());
22
+ }
23
+ }
24
+ };
@@ -0,0 +1,29 @@
1
+ import {afterEach, describe, expect, it, vi} from 'vitest';
2
+ import {triggerEvent} from './triggerEvent';
3
+
4
+ describe('triggerEvent', () => {
5
+ const documentDispatchEventSpy = vi.spyOn(document, 'dispatchEvent');
6
+
7
+ afterEach(() => {
8
+ documentDispatchEventSpy.mockClear();
9
+ });
10
+
11
+ it('dispatches an event on the document', () => {
12
+ triggerEvent('foo');
13
+ expect(documentDispatchEventSpy).toHaveBeenCalled();
14
+ });
15
+
16
+ it('dispatches an event on the document with a detail', () => {
17
+ triggerEvent('foo', {bar: 'baz'});
18
+ expect(documentDispatchEventSpy).toHaveBeenCalledWith(expect.any(CustomEvent));
19
+ });
20
+
21
+ it('dispatches an event on a given element', () => {
22
+ const element = document.createElement('div');
23
+
24
+ element.dispatchEvent = vi.fn();
25
+
26
+ triggerEvent('foo', null, element);
27
+ expect(element.dispatchEvent).toHaveBeenCalled();
28
+ });
29
+ });
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Trigger an event on a given element. Defaults to body.
3
+ */
4
+ export const triggerEvent = (
5
+ eventName: string,
6
+ detail: unknown = null,
7
+ element: string | HTMLElement | Document = document,
8
+ ): void => {
9
+ let eventSource: HTMLElement | Document;
10
+
11
+ if (typeof element === 'string') {
12
+ eventSource = document.querySelector(element) as HTMLElement;
13
+ } else {
14
+ eventSource = element;
15
+ }
16
+
17
+ if (detail) {
18
+ eventSource?.dispatchEvent(new CustomEvent(eventName, {detail}));
19
+ return;
20
+ }
21
+
22
+ eventSource?.dispatchEvent(new Event(eventName));
23
+ };
@@ -0,0 +1,22 @@
1
+ import {beforeEach, describe, expect, it} from 'vitest';
2
+ import {AddressType} from '../data';
3
+ import {hasAddressTypeSpy, mockPdkCheckout} from '../__tests__';
4
+ import {hasAddressType} from './hasAddressType';
5
+
6
+ describe('hasAddressType', () => {
7
+ beforeEach(async () => {
8
+ await mockPdkCheckout();
9
+ });
10
+
11
+ it('should return true if the address type is enabled', () => {
12
+ hasAddressTypeSpy.mockReturnValueOnce(true);
13
+
14
+ expect(hasAddressType(AddressType.Shipping)).toBe(true);
15
+ });
16
+
17
+ it('should return false if the address type is disabled', () => {
18
+ hasAddressTypeSpy.mockReturnValueOnce(false);
19
+
20
+ expect(hasAddressType(AddressType.Billing)).toBe(false);
21
+ });
22
+ });
@@ -0,0 +1,8 @@
1
+ import {type AddressType} from '../data';
2
+ import {useConfig} from './useConfig';
3
+
4
+ export const hasAddressType = (addressType: AddressType): boolean => {
5
+ const config = useConfig();
6
+
7
+ return config.hasAddressType(addressType);
8
+ };
@@ -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,11 @@
1
+ import {type MyParcelPdk} from '../types';
2
+
3
+ export const realUseUtil: MyParcelPdk['useUtil'] = (name) => {
4
+ const util = window.MyParcelPdk?.utils?.[name];
5
+
6
+ if (!util) {
7
+ throw new Error(`Util "${name}" not found.`);
8
+ }
9
+
10
+ return util;
11
+ };
@@ -0,0 +1,2 @@
1
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
2
+ export const useCheckoutStore = () => window.MyParcelPdk.stores.checkout;
@@ -0,0 +1,2 @@
1
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
2
+ export const useConfig = () => window.MyParcelPdk.config;
@@ -0,0 +1,9 @@
1
+ import {type MyParcelPdk} from '../types';
2
+ import {type PdkEvent} from '../data';
3
+
4
+ export const useEvent = <E extends PdkEvent | string>(
5
+ event: E,
6
+ ): E extends PdkEvent ? MyParcelPdk['events'][E] : string => {
7
+ // @ts-expect-error todo
8
+ return window.MyParcelPdk.events[event as keyof typeof window.MyParcelPdk.events];
9
+ };
@@ -0,0 +1,5 @@
1
+ // noinspection JSUnusedGlobalSymbols
2
+
3
+ import {type PdkCheckout} from '../types';
4
+
5
+ export const usePdkCheckout = (): PdkCheckout => window.MyParcelPdk.instance;
@@ -0,0 +1,5 @@
1
+ import {type Plugin} from '@myparcel-dev/pdk-common';
2
+
3
+ export const useSettings = (): Plugin.ModelContextCheckoutContext['settings'] => {
4
+ return window.MyParcelPdk.stores.checkout.state.context.settings;
5
+ };
@@ -0,0 +1,3 @@
1
+ import {type MyParcelPdk} from '../types';
2
+
3
+ export const useUtil: MyParcelPdk['useUtil'] = (name) => window.MyParcelPdk.useUtil(name);