@justifi/webcomponents 4.9.1 → 4.10.0

package/dist/collection/components/business-forms/payment-provisioning/business-owners/business-owners-form-step.js

@@ -0,0 +1,284 @@
+import { Host, h } from "@stencil/core";
+import { BusinessFormServerErrors } from "../../utils/business-form-types";
+import { Api } from "../../../../api";
+import { config } from "../../../../../config";
+import { Owner } from "../../../../api/Identity";
+/**
+ * @exportedPart label: Label for inputs
+ * @exportedPart input: The input fields
+ * @exportedPart input-invalid: Invalid state for inputfs
+ */
+export class BusinessOwnersFormStep {
+    constructor() {
+        this.managePayload = async () => {
+            const payload = this.owners.filter((owner) => owner.id).map((owner) => {
+                return { id: owner.id };
+            });
+            return payload;
+        };
+        this.matchRef = (ref, ownerId) => {
+            const ownerIndex = this.refs.findIndex(ref => ref === ownerId);
+            if (ownerIndex !== -1) {
+                this.refs[ownerIndex] = ref;
+            }
+        };
+        this.fetchData = async () => {
+            this.formLoading.emit(true);
+            try {
+                const response = await this.api.get(this.businessEndpoint);
+                if (response.data.owners.length) {
+                    this.owners = response.data.owners.map(owner => owner);
+                }
+                else {
+                    this.addOwnerForm();
+                }
+            }
+            catch (error) {
+                this.serverError.emit({ data: error, message: BusinessFormServerErrors.fetchData });
+            }
+            finally {
+                this.formLoading.emit(false);
+                this.manageRefs();
+            }
+        };
+        this.sendData = async (onSuccess) => {
+            this.formLoading.emit(true);
+            try {
+                const payload = await this.managePayload();
+                const response = await this.api.patch(this.businessEndpoint, JSON.stringify({ owners: payload }));
+                this.handleResponse(response, onSuccess);
+            }
+            catch (error) {
+                this.serverError.emit({ data: error, message: BusinessFormServerErrors.patchData });
+            }
+            finally {
+                this.formLoading.emit(false);
+            }
+        };
+        this.addOwnerForm = () => {
+            this.newFormOpen = true;
+            const newOwner = Object.assign({}, new Owner({}));
+            this.owners = [...this.owners, newOwner];
+        };
+        this.removeOwnerForm = (id) => {
+            this.owners = this.owners.filter(owner => owner.id !== id);
+            this.newFormOpen ? this.newFormOpen = false : null;
+        };
+        this.handleOwnerSubmit = (event) => {
+            const ownerData = event.detail.data.data;
+            const currentIndex = this.owners.findIndex(owner => owner.id === ownerData.id);
+            if (currentIndex !== -1) {
+                this.owners[currentIndex] = ownerData;
+            }
+            else {
+                const newOwnerIndex = this.owners.findIndex(owner => !owner.id);
+                this.owners[newOwnerIndex] = ownerData;
+                this.newFormOpen ? this.newFormOpen = false : null;
+            }
+        };
+        this.authToken = undefined;
+        this.businessId = undefined;
+        this.owners = [];
+        this.newFormOpen = undefined;
+        this.refs = [];
+    }
+    get businessEndpoint() {
+        return `entities/business/${this.businessId}`;
+    }
+    get showAddOwnerButton() {
+        return this.owners.length < 4 && !this.newFormOpen;
+    }
+    manageRefs() {
+        const ownerRefs = this.owners.map((owner) => owner.id);
+        this.refs = ownerRefs;
+    }
+    handleResponse(response, onSuccess) {
+        if (response.error) {
+            this.serverError.emit({ data: response.error, message: BusinessFormServerErrors.patchData });
+        }
+        else {
+            onSuccess();
+        }
+        this.submitted.emit({ data: response, metadata: { completedStep: 'owners' } });
+    }
+    async validateAndSubmit({ onSuccess }) {
+        const formValidations = this.refs.map(ref => ref.validate());
+        const formsValid = (await Promise.all(formValidations)).every(result => result);
+        if (!formsValid) {
+            return;
+        }
+        const formSubmissions = this.refs.map(ref => ref.submit());
+        const submissionsValid = (await Promise.all(formSubmissions)).every(result => result);
+        if (!submissionsValid) {
+            return;
+        }
+        await this.sendData(onSuccess);
+    }
+    ;
+    componentWillLoad() {
+        const missingAuthTokenMessage = 'Warning: Missing auth-token. The form will not be functional without it.';
+        const missingBusinessIdMessage = 'Warning: Missing business-id. The form requires an existing business-id to function.';
+        if (!this.authToken)
+            console.error(missingAuthTokenMessage);
+        if (!this.businessId)
+            console.error(missingBusinessIdMessage);
+        this.api = Api(this.authToken, config.proxyApiOrigin);
+        this.fetchData();
+    }
+    onOwnersUpdated() {
+        this.manageRefs();
+    }
+    render() {
+        return (h(Host, { exportparts: "label,input,input-invalid" }, h("div", { class: 'col-12' }, this.owners.map((owner) => {
+            return (h("justifi-owner-form", { key: owner.id, authToken: this.authToken, businessId: this.businessId, ownerId: owner.id, removeOwner: this.removeOwnerForm, newFormOpen: this.newFormOpen, ownersLength: this.owners.length, onSubmitted: (e) => this.handleOwnerSubmit(e), onFormLoading: (e) => this.formLoading.emit(e.detail), ref: (ref) => { this.matchRef(ref, owner.id); } }));
+        })), this.showAddOwnerButton &&
+            h("div", { class: 'col-12' }, h("button", { class: 'btn btn-primary', onClick: this.addOwnerForm }, "Add Owner"))));
+    }
+    static get is() { return "justifi-business-owners-form-step"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["business-owners-form-step.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["business-owners-form-step.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "authToken": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "auth-token",
+                "reflect": false
+            },
+            "businessId": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "attribute": "business-id",
+                "reflect": false
+            }
+        };
+    }
+    static get states() {
+        return {
+            "owners": {},
+            "newFormOpen": {},
+            "refs": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "submitted",
+                "name": "submitted",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "BusinessFormSubmitEvent",
+                    "resolved": "BusinessFormSubmitEvent",
+                    "references": {
+                        "BusinessFormSubmitEvent": {
+                            "location": "import",
+                            "path": "../../utils/business-form-types",
+                            "id": "src/components/business-forms/utils/business-form-types.ts::BusinessFormSubmitEvent"
+                        }
+                    }
+                }
+            }, {
+                "method": "formLoading",
+                "name": "formLoading",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                }
+            }, {
+                "method": "serverError",
+                "name": "serverError",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "BusinessFormServerErrorEvent",
+                    "resolved": "BusinessFormServerErrorEvent",
+                    "references": {
+                        "BusinessFormServerErrorEvent": {
+                            "location": "import",
+                            "path": "../../utils/business-form-types",
+                            "id": "src/components/business-forms/utils/business-form-types.ts::BusinessFormServerErrorEvent"
+                        }
+                    }
+                }
+            }];
+    }
+    static get methods() {
+        return {
+            "validateAndSubmit": {
+                "complexType": {
+                    "signature": "({ onSuccess }: { onSuccess: any; }) => Promise<void>",
+                    "parameters": [{
+                            "name": "__0",
+                            "type": "{ onSuccess: any; }",
+                            "docs": ""
+                        }],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "",
+                    "tags": []
+                }
+            }
+        };
+    }
+    static get watchers() {
+        return [{
+                "propName": "owners",
+                "methodName": "onOwnersUpdated"
+            }];
+    }
+}

package/dist/collection/components/business-forms/payment-provisioning/business-owners/test/business-owners-form-step.spec.js

@@ -0,0 +1,97 @@
+import { newSpecPage } from "@stencil/core/testing";
+import { BusinessOwnersFormStep } from "../business-owners-form-step";
+describe.skip('justifi-business-owners-form-step', () => {
+    let consoleSpy;
+    // Initialize the spy in the beforeEach
+    beforeEach(() => {
+        consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
+    });
+    // Restore the original function in the afterEach
+    afterEach(() => {
+        consoleSpy.mockRestore();
+    });
+    it('should log a warning if no authToken is provided', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should log a warning if no businessId is provided', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should emit server error event if server error when fetching data', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should emit server error event if server error when patching data', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should render', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should call fetchData if rendered with valid props', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should populate inputs with data from fetchData', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should instantiate new Form Controller on load', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should fire form controller validation when called', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should only call submit after validate returns true', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should call sendData when submit is called', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should send correct data payload', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should emit submitted event when sendData resolves', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+    it('should emit formLoading event when data is being sent or fetched', async () => {
+        await newSpecPage({
+            components: [BusinessOwnersFormStep],
+            html: `<justifi-business-owners-form-step business-id="biz_123" auth-token="some-token"></justifi-business-owners-form-step>`,
+        });
+    });
+});