@justifi/webcomponents 4.10.0 → 4.11.0

package/dist/collection/components/payments-list/get-payments.js

@@ -1,7 +1,8 @@
 import { Payment } from "../../api";
-import { getErrorMessage } from "../../api/services/utils";
+import { ComponentErrorSeverity } from "../../api/ComponentError";
+import { getErrorCode, getErrorMessage } from "../../api/services/utils";
 export const makeGetPayments = ({ id, authToken, service }) => async ({ params, onSuccess, onError }) => {
-    var _a;
+    var _a, _b;
     try {
         const response = await service.fetchPayments(id, authToken, params);
         if (!response.error) {
@@ -11,10 +12,20 @@ export const makeGetPayments = ({ id, authToken, service }) => async ({ params,
         }
         else {
             const responseError = getErrorMessage(response.error);
-            return onError(responseError);
+            const code = getErrorCode((_b = response.error) === null || _b === void 0 ? void 0 : _b.code);
+            return onError({
+                error: responseError,
+                code,
+                severity: ComponentErrorSeverity.ERROR,
+            });
         }
     }
     catch (error) {
-        return onError(error.message || error);
+        const code = getErrorCode(error === null || error === void 0 ? void 0 : error.code);
+        return onError({
+            error: error.message || error,
+            code,
+            severity: ComponentErrorSeverity.ERROR,
+        });
     }
 };

package/dist/collection/components/payments-list/payments-list-core.js

@@ -37,8 +37,13 @@ export class PaymentsListCore {
                 this.paging = pagingInfo;
                 this.loading = false;
             },
-            onError: (errorMessage) => {
-                this.errorMessage = errorMessage;
+            onError: ({ error, code, severity }) => {
+                this.errorMessage = error;
+                this.errorEvent.emit({
+                    errorCode: code,
+                    message: error,
+                    severity,
+                });
                 this.loading = false;
             },
         });
@@ -144,6 +149,27 @@ export class PaymentsListCore {
                         }
                     }
                 }
+            }, {
+                "method": "errorEvent",
+                "name": "error-event",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "ComponentError",
+                    "resolved": "ComponentError",
+                    "references": {
+                        "ComponentError": {
+                            "location": "import",
+                            "path": "../../api/ComponentError",
+                            "id": "src/api/ComponentError.ts::ComponentError"
+                        }
+                    }
+                }
             }];
     }
     static get watchers() {

package/dist/collection/components/payments-list/payments-list.js

@@ -2,6 +2,7 @@ import { h } from "@stencil/core";
 import { PaymentService } from "../../api/services/payment.service";
 import { makeGetPayments } from "./get-payments";
 import { ErrorState } from "../details/utils";
+import { ComponentErrorCodes, ComponentErrorSeverity } from "../../api/ComponentError";
 /**
   * @exportedPart table-head: Table head
   * @exportedPart table-head-row: Head row
@@ -23,6 +24,10 @@ import { ErrorState } from "../details/utils";
 */
 export class PaymentsList {
     constructor() {
+        this.handleErrorEvent = (event) => {
+            this.errorMessage = event.detail.message;
+            this.errorEvent.emit(event.detail);
+        };
         this.accountId = undefined;
         this.authToken = undefined;
         this.getPayments = undefined;
@@ -44,13 +49,18 @@ export class PaymentsList {
         }
         else {
             this.errorMessage = 'Account ID and Auth Token are required';
+            this.errorEvent.emit({
+                errorCode: ComponentErrorCodes.MISSING_PROPS,
+                message: this.errorMessage,
+                severity: ComponentErrorSeverity.ERROR,
+            });
         }
     }
     render() {
         if (this.errorMessage) {
             return ErrorState(this.errorMessage);
         }
-        return (h("payments-list-core", { getPayments: this.getPayments }));
+        return (h("payments-list-core", { getPayments: this.getPayments, "onError-event": this.handleErrorEvent }));
     }
     static get is() { return "justifi-payments-list"; }
     static get encapsulation() { return "shadow"; }
@@ -98,6 +108,30 @@ export class PaymentsList {
             "errorMessage": {}
         };
     }
+    static get events() {
+        return [{
+                "method": "errorEvent",
+                "name": "error-event",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "ComponentError",
+                    "resolved": "ComponentError",
+                    "references": {
+                        "ComponentError": {
+                            "location": "import",
+                            "path": "../../api/ComponentError",
+                            "id": "src/api/ComponentError.ts::ComponentError"
+                        }
+                    }
+                }
+            }];
+    }
     static get watchers() {
         return [{
                 "propName": "accountId",

package/dist/collection/components/payments-list/test/get-payments.spec.js

@@ -1,6 +1,6 @@
 import { PaymentService } from "../../../api/services/payment.service";
 import { makeGetPayments } from "../get-payments";
-import mockResponse from "../../../api/mockData/mockPaymentsSuccess.json";
+import mockResponse from "../../../../../../mockData/mockPaymentsSuccess.json";
 import { Payment } from "../../../api";
 // Mock the PaymentService class
 jest.mock('../../../api/services/payment.service');
@@ -48,7 +48,11 @@ describe('makeGetPayments', () => {
             service: mockServiceInstance,
         });
         await getPayments({ params: mockParams, onSuccess, onError });
-        expect(onError).toHaveBeenCalledWith('Error fetching payments');
+        expect(onError).toHaveBeenCalledWith({
+            code: 'fetch-error',
+            error: 'Error fetching payments',
+            severity: 'error',
+        });
         expect(onSuccess).not.toHaveBeenCalled();
     });
     it('should call onError with an exception message on fetch exception', async () => {
@@ -63,7 +67,11 @@ describe('makeGetPayments', () => {
             service: mockServiceInstance,
         });
         await getPayments({ params: mockParams, onSuccess, onError });
-        expect(onError).toHaveBeenCalledWith('Network error');
+        expect(onError).toHaveBeenCalledWith({
+            code: 'fetch-error',
+            error: 'Network error',
+            severity: 'error',
+        });
         expect(onSuccess).not.toHaveBeenCalled();
     });
     // Add more tests as needed for edge cases and different scenarios

package/dist/collection/components/payments-list/test/payments-list-core.spec.js

@@ -1,8 +1,9 @@
+import { h } from "@stencil/core";
 import { newSpecPage } from "@stencil/core/testing";
 import { PaymentsListCore } from "../payments-list-core";
 import { Table } from "../../table/table";
 import { PaginationMenu } from "../../pagination-menu/pagination-menu";
-import mockSuccessResponse from "../../../api/mockData/mockPaymentsSuccess.json";
+import mockSuccessResponse from "../../../../../../mockData/mockPaymentsSuccess.json";
 import { makeGetPayments } from "../get-payments";
 const mockPaymentsResponse = mockSuccessResponse;
 describe('payments-list-core', () => {
@@ -10,17 +11,15 @@ describe('payments-list-core', () => {
         const mockPaymentsService = {
             fetchPayments: jest.fn().mockResolvedValue(mockPaymentsResponse),
         };
-        const page = await newSpecPage({
-            components: [PaymentsListCore, Table, PaginationMenu],
-            html: `<payments-list-core></payments-list-core>`,
-        });
-        page.rootInstance.componentWillLoad = () => { };
-        page.rootInstance.getPayments = makeGetPayments({
+        const getPayments = makeGetPayments({
             id: '123',
             authToken: '123',
             service: mockPaymentsService
         });
-        page.rootInstance.fetchData();
+        const page = await newSpecPage({
+            components: [PaymentsListCore, Table, PaginationMenu],
+            template: () => h("payments-list-core", { getPayments: getPayments }),
+        });
         await page.waitForChanges();
         const justifiTable = page.root.querySelector('justifi-table');
         expect(page.rootInstance.payments[0]).toEqual(expect.objectContaining({ account_id: mockPaymentsResponse.data[0].account_id }));
@@ -40,11 +39,8 @@ describe('payments-list-core', () => {
         });
         const page = await newSpecPage({
             components: [PaymentsListCore, Table, PaginationMenu],
-            html: '<payments-list-core></payments-list-core>',
+            template: () => h("payments-list-core", { getPayments: getPayments }),
         });
-        page.rootInstance.componentWillLoad = () => { };
-        page.rootInstance.getPayments = getPayments;
-        await page.rootInstance.fetchData();
         await page.waitForChanges();
         expect(page.rootInstance.errorMessage).toBe('Fetch error');
         expect(page.root).toMatchSnapshot();
@@ -53,17 +49,15 @@ describe('payments-list-core', () => {
         const mockPaymentsService = {
             fetchPayments: jest.fn().mockResolvedValue(mockPaymentsResponse),
         };
-        const page = await newSpecPage({
-            components: [PaymentsListCore, Table, PaginationMenu],
-            html: `<payments-list-core></payments-list-core>`,
-        });
-        page.rootInstance.componentWillLoad = () => { };
-        page.rootInstance.getPayments = makeGetPayments({
+        const getPayments = makeGetPayments({
             id: '123',
             authToken: '123',
             service: mockPaymentsService
         });
-        page.rootInstance.fetchData();
+        const page = await newSpecPage({
+            components: [PaymentsListCore, Table, PaginationMenu],
+            template: () => h("payments-list-core", { getPayments: getPayments }),
+        });
         await page.waitForChanges();
         const justifiTable = page.root.querySelector('justifi-table');
         const firstRow = justifiTable.shadowRoot.querySelector('[data-test-id="table-row"]');
@@ -77,24 +71,45 @@ describe('payments-list-core', () => {
         const mockPaymentsService = {
             fetchPayments: jest.fn().mockResolvedValue(mockPaymentsResponse),
         };
-        const page = await newSpecPage({
-            components: [PaymentsListCore, Table, PaginationMenu],
-            html: `<payments-list-core></payments-list-core>`,
-        });
-        page.rootInstance.componentWillLoad = () => { };
-        page.rootInstance.getPayments = makeGetPayments({
+        const getPayments = makeGetPayments({
             id: '123',
             authToken: '123',
             service: mockPaymentsService
         });
-        page.rootInstance.fetchData();
+        const page = await newSpecPage({
+            components: [PaymentsListCore, Table, PaginationMenu],
+            template: () => h("payments-list-core", { getPayments: getPayments }),
+        });
         await page.waitForChanges();
         // Assuming handleClickNext is accessible and modifies `params` which triggers a re-fetch
         page.rootInstance.handleClickNext('nextCursor');
         await page.waitForChanges();
-        // The mock function should be called 3 times: once for the initial load, twice for when mockGetPayments is set and later after the pagination interaction
-        expect(mockPaymentsService.fetchPayments).toHaveBeenCalledTimes(3);
+        // The mock function should be called 2 times: once for the initial load and later after the pagination interaction
+        expect(mockPaymentsService.fetchPayments).toHaveBeenCalledTimes(2);
         const updatedParams = page.rootInstance.params;
         expect(updatedParams.after_cursor).toBe('nextCursor');
     });
+    it('emits error event on fetch error', async () => {
+        const mockService = {
+            fetchPayments: jest.fn().mockRejectedValue(new Error('Fetch error'))
+        };
+        const getPayments = makeGetPayments({
+            id: 'some-id',
+            authToken: 'some-auth',
+            service: mockService
+        });
+        const errorEvent = jest.fn();
+        const page = await newSpecPage({
+            components: [PaymentsListCore, Table, PaginationMenu],
+            template: () => h("payments-list-core", { getPayments: getPayments, "onError-event": errorEvent }),
+        });
+        await page.waitForChanges();
+        expect(errorEvent).toHaveBeenCalledWith(expect.objectContaining({
+            detail: {
+                errorCode: 'fetch-error',
+                message: 'Fetch error',
+                severity: 'error',
+            }
+        }));
+    });
 });

package/dist/collection/components/payments-list/test/payments-list.spec.js

@@ -1,11 +1,14 @@
+import { h } from "@stencil/core";
 import { newSpecPage } from "@stencil/core/testing";
 import { PaymentsList } from "../payments-list";
 import { PaymentsListCore } from "../payments-list-core";
+import { PaymentService } from "../../../api/services/payment.service";
+jest.mock('../../../api/services/payment.service');
 describe('payments-list', () => {
     it('renders an error message when accountId and authToken are not provided', async () => {
         const page = await newSpecPage({
             components: [PaymentsList, PaymentsListCore],
-            html: '<justifi-payments-list></justifi-payments-list>',
+            template: () => h("justifi-payments-list", null),
         });
         await page.waitForChanges();
         expect(page.root).toMatchSnapshot();
@@ -13,7 +16,7 @@ describe('payments-list', () => {
     it('renders an error message when accountId is not provided', async () => {
         const page = await newSpecPage({
             components: [PaymentsList, PaymentsListCore],
-            html: '<justifi-payments-list auth-token="abc"></justifi-payments-list>',
+            template: () => h("justifi-payments-list", { "auth-token": "abc" }),
         });
         await page.waitForChanges();
         expect(page.root).toMatchSnapshot();
@@ -21,9 +24,34 @@ describe('payments-list', () => {
     it('renders an error message when authToken is not provided', async () => {
         const page = await newSpecPage({
             components: [PaymentsList, PaymentsListCore],
-            html: '<justifi-payments-list account-id="abc"></justifi-payments-list>',
+            template: () => h("justifi-payments-list", { "account-id": "abc" }),
         });
         await page.waitForChanges();
         expect(page.root).toMatchSnapshot();
     });
+    it('emit an error event when accountId and authToken are not provided', async () => {
+        const errorEvent = jest.fn();
+        const page = await newSpecPage({
+            components: [PaymentsList, PaymentsListCore],
+            template: () => h("justifi-payments-list", { "onError-event": errorEvent }),
+        });
+        await page.waitForChanges();
+        expect(errorEvent).toHaveBeenCalled();
+    });
+    it('emit an error event when fetch fails', async () => {
+        PaymentService.prototype.fetchPayments = jest.fn().mockRejectedValue(new Error('Fetch error'));
+        const errorEvent = jest.fn();
+        const page = await newSpecPage({
+            components: [PaymentsList, PaymentsListCore],
+            template: () => (h("justifi-payments-list", { "account-id": "abc", "auth-token": "abc", "onError-event": errorEvent })),
+        });
+        await page.waitForChanges();
+        expect(errorEvent).toHaveBeenCalledWith(expect.objectContaining({
+            detail: {
+                errorCode: 'fetch-error',
+                message: 'Fetch error',
+                severity: 'error',
+            }
+        }));
+    });
 });

package/dist/collection/components/payout-details/get-payout-details.js

@@ -1,6 +1,8 @@
 import { Payout } from "../../api";
-import { getErrorMessage } from "../../api/services/utils";
+import { ComponentErrorSeverity } from "../../api/ComponentError";
+import { getErrorCode, getErrorMessage } from "../../api/services/utils";
 export const makeGetPayoutDetails = ({ id, authToken, service }) => async ({ onSuccess, onError }) => {
+    var _a;
     try {
         const response = await service.fetchPayout(id, authToken);
         if (!response.error) {
@@ -8,13 +10,22 @@ export const makeGetPayoutDetails = ({ id, authToken, service }) => async ({ onS
             onSuccess(payout);
         }
         else {
-            const responseError = getErrorMessage(response.error);
-            const errorMessage = `Error fetching payout details: ${responseError}`;
-            onError(errorMessage);
+            const errorMessage = getErrorMessage(response.error);
+            const code = getErrorCode((_a = response.error) === null || _a === void 0 ? void 0 : _a.code);
+            onError({
+                error: errorMessage,
+                code,
+                severity: ComponentErrorSeverity.ERROR,
+            });
         }
     }
     catch (error) {
-        const errorMessage = `Error fetching payout details: ${error}`;
-        onError(errorMessage);
+        const errorMessage = getErrorMessage(error);
+        const code = getErrorCode(error === null || error === void 0 ? void 0 : error.code);
+        onError({
+            error: errorMessage,
+            code,
+            severity: ComponentErrorSeverity.ERROR,
+        });
     }
 };

package/dist/collection/components/payout-details/payout-details-core.js

@@ -24,9 +24,13 @@ export class PayoutDetailsCore {
                 this.payout = payout;
                 this.loading = false;
             },
-            onError: (errorMessage) => {
-                this.errorMessage = errorMessage;
-                console.error(this.errorMessage);
+            onError: ({ error, code, severity }) => {
+                this.errorMessage = error;
+                this.errorEvent.emit({
+                    message: error,
+                    errorCode: code,
+                    severity,
+                });
                 this.loading = false;
             },
         });
@@ -77,6 +81,30 @@ export class PayoutDetailsCore {
             "errorMessage": {}
         };
     }
+    static get events() {
+        return [{
+                "method": "errorEvent",
+                "name": "error-event",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "ComponentError",
+                    "resolved": "ComponentError",
+                    "references": {
+                        "ComponentError": {
+                            "location": "import",
+                            "path": "../../api/ComponentError",
+                            "id": "src/api/ComponentError.ts::ComponentError"
+                        }
+                    }
+                }
+            }];
+    }
     static get watchers() {
         return [{
                 "propName": "getPayout",

package/dist/collection/components/payout-details/payout-details.js

@@ -2,8 +2,13 @@ import { h } from "@stencil/core";
 import { PayoutService } from "../../api/services/payout.service";
 import { makeGetPayoutDetails } from "./get-payout-details";
 import { ErrorState } from "../details/utils";
+import { ComponentErrorCodes, ComponentErrorSeverity } from "../../api/ComponentError";
 export class PayoutDetails {
     constructor() {
+        this.handleErrorEvent = (event) => {
+            this.errorMessage = event.detail.message;
+            this.errorEvent.emit(event.detail);
+        };
         this.payoutId = undefined;
         this.authToken = undefined;
         this.getPayout = undefined;
@@ -25,13 +30,18 @@ export class PayoutDetails {
         }
         else {
             this.errorMessage = 'Failed to load payout details. payoutId or authToken is not provided.';
+            this.errorEvent.emit({
+                message: this.errorMessage,
+                errorCode: ComponentErrorCodes.MISSING_PROPS,
+                severity: ComponentErrorSeverity.ERROR
+            });
         }
     }
     render() {
         if (this.errorMessage) {
             return ErrorState(this.errorMessage);
         }
-        return (h("payout-details-core", { getPayout: this.getPayout }));
+        return (h("payout-details-core", { getPayout: this.getPayout, "onError-event": this.handleErrorEvent }));
     }
     static get is() { return "justifi-payout-details"; }
     static get encapsulation() { return "shadow"; }
@@ -79,6 +89,30 @@ export class PayoutDetails {
             "errorMessage": {}
         };
     }
+    static get events() {
+        return [{
+                "method": "errorEvent",
+                "name": "error-event",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "ComponentError",
+                    "resolved": "ComponentError",
+                    "references": {
+                        "ComponentError": {
+                            "location": "import",
+                            "path": "../../api/ComponentError",
+                            "id": "src/api/ComponentError.ts::ComponentError"
+                        }
+                    }
+                }
+            }];
+    }
     static get watchers() {
         return [{
                 "propName": "payoutId",

package/dist/collection/components/payout-details/test/get-payout-details.spec.js

@@ -1,7 +1,7 @@
 import { Payout } from "../../../api";
 import { PayoutService } from "../../../api/services/payout.service";
 import { makeGetPayoutDetails } from "../get-payout-details";
-import mockResponse from "../../../api/mockData/mockPayoutDetailsSuccess.json";
+import mockResponse from "../../../../../../mockData/mockPayoutDetailsSuccess.json";
 describe('getPayout', () => {
     const mockId = '123';
     const mockAuthToken = '123';
@@ -25,7 +25,8 @@ describe('getPayout', () => {
         expect(onError).not.toHaveBeenCalled();
     });
     it('should call onError with an error message on API failure', async () => {
-        const mockError = new Error('Error fetching payout');
+        const errorMessage = 'Error fetching payout';
+        const mockError = new Error(errorMessage);
         const onSuccess = jest.fn();
         const onError = jest.fn();
         mockServiceInstance.fetchPayout.mockRejectedValue(mockError);
@@ -36,10 +37,15 @@ describe('getPayout', () => {
         });
         await getPayout({ onSuccess, onError });
         expect(onSuccess).not.toHaveBeenCalled();
-        expect(onError).toHaveBeenCalledWith(`Error fetching payout details: ${mockError}`);
+        expect(onError).toHaveBeenCalledWith({
+            code: 'fetch-error',
+            error: 'Error fetching payout',
+            severity: 'error',
+        });
     });
     it('should call onError with an error message on API failure with error message', async () => {
-        const mockError = new Error('Error fetching payout');
+        const errorMessage = 'Error fetching payout';
+        const mockError = new Error(errorMessage);
         const onSuccess = jest.fn();
         const onError = jest.fn();
         mockServiceInstance.fetchPayout.mockRejectedValue(mockError);
@@ -50,6 +56,10 @@ describe('getPayout', () => {
         });
         await getPayout({ onSuccess, onError });
         expect(onSuccess).not.toHaveBeenCalled();
-        expect(onError).toHaveBeenCalledWith(`Error fetching payout details: ${mockError}`);
+        expect(onError).toHaveBeenCalledWith({
+            code: 'fetch-error',
+            error: 'Error fetching payout',
+            severity: 'error',
+        });
     });
 });