@rebilly/instruments 4.8.0 → 4.8.2

package/src/functions/mount/fetch-data.js

@@ -1,234 +0,0 @@
-import { collectData } from '@rebilly/risk-data-collector';
-import state from '../../state';
-import { fetchProductsFromPlans } from '../../storefront/fetch-products-from-plans';
-import { fetchPlansFromAddonsBumpOffer } from '../../storefront/fetch-plans-from-addons-bumpOffer';
-import { fetchReadyToPay } from '../../storefront/ready-to-pay';
-import { fetchSummary } from '../../storefront/summary';
-import { fetchInvoiceAndProducts as FetchInvoiceAndProducts } from '../../storefront/invoices';
-import { fetchTransaction as FetchTransaction } from '../../storefront/transactions';
-import { fetchAccountAndWebsite as FetchAccountAndWebsite } from '../../storefront/account-and-website';
-import { fetchPaymentInstrument as FetchInstruments } from '../../storefront/payment-instruments';
-import { fetchDepositRequest as FetchDepositRequest } from '../../storefront/deposit-requests';
-import DepositRequestModel from '../../storefront/models/deposit-request-model';
-import { getLeadSourceData } from './get-lead-source-data';
-
-export class DataInstance {
-    constructor({ ...fields } = {}) {
-        Object.entries({
-            ...(state.data || {}),
-            ...fields,
-        }).forEach(([key, value]) => {
-            this[key] = value;
-        });
-
-        this.money = state.options?.money || null;
-        this.couponIds = [];
-        this.addons = [];
-        this.acceptBumpOffer = false;
-    }
-
-    get amountAndCurrency() {
-        let currency;
-        let amount;
-        let amountDue;
-
-        if (this.previewPurchase) {
-            currency = this.previewPurchase.currency;
-            amount = this.previewPurchase.total;
-        } else if (this.invoice) {
-            currency = this.invoice.currency;
-            amount = this.invoice.amount;
-            amountDue = this.invoice.amountDue;
-        } else if (this.transaction) {
-            currency = this.transaction.currency;
-            amount = this.transaction.amount;
-        } else if (this.money) {
-            currency = this.money.currency;
-            amount = this.money.amount;
-        }
-        const amountAndCurrency = {
-            amount,
-            currency,
-        };
-        if (amountDue) {
-            amountAndCurrency.amountDue = amountDue;
-        }
-        return amountAndCurrency;
-    }
-
-    get isPayment() {
-        return this.invoice || this.transaction || this.money;
-    }
-
-    get isPurchase() {
-        return this.previewPurchase;
-    }
-
-    get hasAmountDue() {
-        return !!(
-            this.amountAndCurrency.amountDue &&
-            this.amountAndCurrency.amountDue !== this.amountAndCurrency.amount
-        );
-    }
-
-    get summaryItems() {
-        const {
-            discountsAmount = null,
-            shippingAmount = null,
-            subtotalAmount = null,
-            taxAmount = null,
-        } = this.previewPurchase || this.invoice || {};
-
-        return {
-            discountsAmount,
-            shippingAmount,
-            subtotalAmount,
-            taxAmount,
-        };
-    }
-
-    get summaryLineItems() {
-        let lineItems = [];
-        if (this.invoice) {
-            ({ items: lineItems = [] } = this.invoice);
-        } else {
-            ({ lineItems = [] } = this.previewPurchase || {});
-        }
-
-        return lineItems;
-    }
-
-    get isShippingRequired() {
-        return (this.products || []).some(
-            (product) => product.requiresShipping,
-        );
-    }
-
-    toPostmatesModel() {
-        return JSON.parse(
-            JSON.stringify({
-                ...this,
-                amountAndCurrency: this.amountAndCurrency,
-                isPayment: this.isPayment,
-                isPurchase: this.isPurchase,
-                hasAmountDue: this.hasAmountDue,
-                summaryItems: this.summaryItems,
-                summaryLineItems: this.summaryLineItems,
-                isShippingRequired: this.isShippingRequired,
-                leadSource: getLeadSourceData(),
-            }),
-        );
-    }
-}
-
-export async function fetchData({
-    riskMetadata = null,
-
-    // Dependency injectable functions
-    fetchInvoiceAndProducts = FetchInvoiceAndProducts,
-    fetchTransaction = FetchTransaction,
-    fetchAccountAndWebsite = FetchAccountAndWebsite,
-    fetchInstruments = FetchInstruments,
-    fetchDepositRequest = FetchDepositRequest,
-} = {}) {
-    try {
-        state.data = new DataInstance();
-
-        if (state.options?.deposit) {
-            if (state.options.deposit.depositRequestId) {
-                state.data.deposit = await fetchDepositRequest({
-                    data: {
-                        id: state.options.deposit.depositRequestId,
-                    },
-                });
-            } else {
-                state.data.deposit = new DepositRequestModel(
-                    state.options.deposit,
-                );
-            }
-        }
-
-        let readyToPayPromise = Promise.resolve(null);
-
-        let availableInstrumentsPromise = null;
-        if (state.options?.jwt) {
-            fetchAccountAndWebsite({ state }).then(({ account, website }) => {
-                state.data.account = account;
-                state.data.website = website;
-            });
-            readyToPayPromise = fetchReadyToPay({ riskMetadata });
-            availableInstrumentsPromise = fetchInstruments({ state });
-        } else {
-            readyToPayPromise = fetchReadyToPay({ riskMetadata });
-        }
-
-        if (state.options?.transactionId) {
-            state.data.transaction = await fetchTransaction({
-                data: {
-                    id: state.options.transactionId,
-                },
-            });
-        }
-
-        let productsPromise;
-        const invoiceId =
-            state.options?.invoiceId || state.data?.transaction?.invoiceId;
-        if (invoiceId) {
-            const { invoice, products } = await fetchInvoiceAndProducts({
-                data: {
-                    id: invoiceId,
-                },
-            });
-            productsPromise = Promise.resolve(products);
-            state.data.invoice = invoice;
-        }
-
-        if (!riskMetadata) {
-            ({ riskMetadata } = await collectData());
-            state.data.riskMetadata = riskMetadata;
-        }
-
-        const previewPurchasePromise = state.options.items
-            ? fetchSummary()
-            : null;
-
-        if (!state.options?.jwt) {
-            // There is no invoice, only pla ns through the static options,
-            // so we should fetch the products from the provided plan names.
-            productsPromise = fetchProductsFromPlans({ state });
-        }
-
-        let plansPromise = new Promise((resolve) => {
-            resolve([]);
-        });
-        if (state.options?.addons || state.options?.bumpOffer) {
-            plansPromise = fetchPlansFromAddonsBumpOffer({ state });
-        }
-
-        const [
-            readyToPay,
-            previewPurchase,
-            products,
-            plans,
-            availableInstruments,
-        ] = await Promise.all([
-            readyToPayPromise,
-            previewPurchasePromise,
-            productsPromise,
-            plansPromise,
-            availableInstrumentsPromise,
-        ]);
-
-        return new DataInstance({
-            readyToPay,
-            previewPurchase,
-            products,
-            plans,
-            availableInstruments,
-        });
-    } catch (error) {
-        // console.log(error);
-    }
-
-    return new DataInstance({});
-}

package/src/functions/mount/fetch-data.spec.js

@@ -1,317 +0,0 @@
-import { StorefontTestingInstance } from 'tests/mocks/storefront-mock';
-import { fetchData, DataInstance } from './fetch-data';
-import TransactionModel from '@/storefront/models/transaction-model';
-
-describe('fetchData function', () => {
-    it('Should use correct invoice id for invoiceId', async () => {
-        const mockFetchInvoiceAndProducts = vi.fn();
-        const invoiceId = 'test-invoice-id';
-        StorefontTestingInstance({
-            options: {
-                invoiceId,
-            },
-        });
-
-        await fetchData({
-            fetchInvoiceAndProducts: mockFetchInvoiceAndProducts,
-        });
-
-        expect(mockFetchInvoiceAndProducts).toBeCalledTimes(1);
-        expect(mockFetchInvoiceAndProducts).toBeCalledWith(
-            expect.objectContaining({
-                data: {
-                    id: invoiceId,
-                },
-            }),
-        );
-    });
-
-    it('Should use correct invoice id for transaction with invoiceIds', async () => {
-        const mockFetchInvoiceAndProducts = vi.fn();
-        const invoiceId = 'test-invoice-id';
-        StorefontTestingInstance({
-            data: {
-                transaction: new TransactionModel({
-                    invoiceIds: [invoiceId],
-                }),
-            },
-        });
-
-        await fetchData({
-            fetchInvoiceAndProducts: mockFetchInvoiceAndProducts,
-        });
-
-        expect(mockFetchInvoiceAndProducts).toBeCalledTimes(1);
-        expect(mockFetchInvoiceAndProducts).toBeCalledWith(
-            expect.objectContaining({
-                data: {
-                    id: invoiceId,
-                },
-            }),
-        );
-    });
-
-    it('Should not fetch invoice for transaction with no invoice Ids', async () => {
-        const mockFetchInvoiceAndProducts = vi.fn();
-        StorefontTestingInstance({
-            options: {},
-            data: {
-                transaction: new TransactionModel({
-                    invoiceIds: [],
-                }),
-            },
-        });
-
-        fetchData({
-            fetchInvoiceAndProducts: mockFetchInvoiceAndProducts,
-        });
-
-        expect(mockFetchInvoiceAndProducts).toBeCalledTimes(0);
-    });
-
-    it('Should fetch account when JWT is supplied', async () => {
-        const mockFetchAccountAndWebsite = vi.fn();
-        StorefontTestingInstance({
-            options: {
-                jwt: 'TEST_JWT',
-            },
-        });
-
-        await fetchData({
-            fetchAccountAndWebsite: mockFetchAccountAndWebsite,
-        });
-
-        expect(mockFetchAccountAndWebsite).toBeCalledTimes(1);
-    });
-
-    it('Should not fetch account when there JWT is not supplied', async () => {
-        const mockFetchAccountAndWebsite = vi.fn();
-        StorefontTestingInstance({
-            options: {},
-        });
-
-        await fetchData({
-            fetchAccountAndWebsite: mockFetchAccountAndWebsite,
-        });
-
-        expect(mockFetchAccountAndWebsite).toBeCalledTimes(0);
-    });
-});
-
-describe('DataInstance', () => {
-    describe('Determining amountAndCurrency', () => {
-        it('should use money option', () => {
-            const expectedAmountAndCurrency = {
-                amount: 10,
-                currency: 'USD',
-            };
-            StorefontTestingInstance({
-                options: {
-                    money: expectedAmountAndCurrency,
-                },
-            });
-            const fetchedData = new DataInstance();
-
-            expect(fetchedData.amountAndCurrency).toEqual(
-                expectedAmountAndCurrency,
-            );
-        });
-
-        it('should use preview Purchase', () => {
-            const expectedAmountAndCurrency = {
-                amount: 10,
-                currency: 'USD',
-            };
-            StorefontTestingInstance();
-
-            const fetchedData = new DataInstance({
-                previewPurchase: {
-                    total: expectedAmountAndCurrency.amount,
-                    currency: expectedAmountAndCurrency.currency,
-                },
-            });
-            expect(fetchedData.amountAndCurrency).toEqual(
-                expect.objectContaining(expectedAmountAndCurrency),
-            );
-        });
-
-        it('should use invoice', () => {
-            const expectedAmountAndCurrency = {
-                amount: 10,
-                currency: 'USD',
-            };
-            StorefontTestingInstance();
-
-            const fetchedData = new DataInstance({
-                invoice: {
-                    ...expectedAmountAndCurrency,
-                },
-            });
-            expect(fetchedData.amountAndCurrency).toEqual(
-                expect.objectContaining(expectedAmountAndCurrency),
-            );
-        });
-
-        it('should use transaction', () => {
-            const expectedAmountAndCurrency = {
-                amount: 10,
-                currency: 'USD',
-            };
-            StorefontTestingInstance();
-
-            const fetchedData = new DataInstance({
-                transaction: {
-                    ...expectedAmountAndCurrency,
-                },
-            });
-            expect(fetchedData.amountAndCurrency).toEqual(
-                expect.objectContaining(expectedAmountAndCurrency),
-            );
-        });
-
-        it('should handle empty value', () => {
-            StorefontTestingInstance();
-
-            const fetchedData = new DataInstance();
-            expect(fetchedData.amountAndCurrency).toEqual(
-                expect.objectContaining({
-                    amount: undefined,
-                    currency: undefined,
-                }),
-            );
-        });
-    });
-
-    describe('isPayment', () => {
-        it('money is truthy', () => {
-            StorefontTestingInstance({
-                options: {
-                    money: true,
-                },
-            });
-            const fetchedData = new DataInstance();
-            expect(fetchedData.isPayment).toBeTruthy();
-        });
-
-        it('invoice is truthy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({
-                invoice: true,
-            });
-            expect(fetchedData.isPayment).toBeTruthy();
-        });
-
-        it('transaction is truthy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({
-                transaction: true,
-            });
-            expect(fetchedData.isPayment).toBeTruthy();
-        });
-
-        it('previewPurchase is falsy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({
-                previewPurchase: true,
-            });
-            expect(fetchedData.isPayment).toBeFalsy();
-        });
-
-        it('empty is falsy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({});
-            expect(fetchedData.isPayment).toBeFalsy();
-        });
-    });
-
-    describe('isPurchase', () => {
-        it('previewPurchase is truthy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({
-                previewPurchase: true,
-            });
-            expect(fetchedData.isPurchase).toBeTruthy();
-        });
-
-        it('money is falsy', () => {
-            StorefontTestingInstance({
-                options: {
-                    money: true,
-                },
-            });
-            const fetchedData = new DataInstance();
-            expect(fetchedData.isPurchase).toBeFalsy();
-        });
-
-        it('invoice is falsy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({
-                invoice: true,
-            });
-            expect(fetchedData.isPurchase).toBeFalsy();
-        });
-
-        it('transaction is falsy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({
-                transaction: true,
-            });
-            expect(fetchedData.isPurchase).toBeFalsy();
-        });
-
-        it('empty is falsy', () => {
-            StorefontTestingInstance();
-            const fetchedData = new DataInstance({});
-            expect(fetchedData.isPurchase).toBeFalsy();
-        });
-    });
-
-    it('Should get summaryItems', () => {
-        const expectedSummaryItems = {
-            discountsAmount: 1,
-            shippingAmount: 2,
-            subtotalAmount: 3,
-            taxAmount: 4,
-        };
-
-        let fetchedData = new DataInstance({
-            previewPurchase: {
-                ...expectedSummaryItems,
-            },
-        });
-        expect(fetchedData.summaryItems).toEqual(
-            expect.objectContaining(expectedSummaryItems),
-        );
-
-        fetchedData = new DataInstance({
-            invoice: {
-                ...expectedSummaryItems,
-            },
-        });
-        expect(fetchedData.summaryItems).toEqual(
-            expect.objectContaining(expectedSummaryItems),
-        );
-    });
-
-    it('Should get summaryLineItems', () => {
-        const expectedSummaryLineItems = [
-            {
-                line: 'item',
-            },
-        ];
-
-        let fetchedData = new DataInstance({
-            previewPurchase: {
-                lineItems: expectedSummaryLineItems,
-            },
-        });
-        expect(fetchedData.summaryLineItems).toEqual(expectedSummaryLineItems);
-
-        fetchedData = new DataInstance({
-            invoice: {
-                items: expectedSummaryLineItems,
-            },
-        });
-        expect(fetchedData.summaryLineItems).toEqual(expectedSummaryLineItems);
-    });
-});

package/src/functions/mount/get-lead-source-data.js

@@ -1,46 +0,0 @@
-const collectedProperties = [
-    // Google UTM fields
-    'utm_source',
-    'utm_medium',
-    'utm_campaign',
-    'utm_term',
-    'utm_content',
-    // FramePay specific fields
-    'affiliate',
-    'subAffiliate',
-    'clickId',
-    'salesAgent',
-];
-const prefix = /utm_/g;
-
-/**
- * Generates the lead source data object that framepay expects as part of
- * the extraData property. We generate it in the top level of instruments
- * so that it has the correct path and query parameters.
- * @returns {Object} The lead source data object
- */
-export const getLeadSourceData = () => {
-    const { href, origin, pathname, search } = window.location;
-
-    const leadSource = {
-        // Large query parameters including JWTs will cause issues, so make sure we dont
-        // use anything longer than 255 characters.
-        path: href.length <= 255 ? href : `${origin}${pathname}`,
-    };
-
-    const query = search.replace('?', '');
-
-    // Process query parameters and add them to the leadSource object
-    return query
-        .split('&')
-        .map((field) => field.split('='))
-        .filter((field) => {
-            const [name] = field;
-            return collectedProperties.indexOf(name) > -1;
-        })
-        .reduce((data, field) => {
-            const [name, value = null] = field;
-            data[name.replace(prefix, '')] = value;
-            return data;
-        }, leadSource);
-};

package/src/functions/mount/get-lead-source-data.spec.js

@@ -1,38 +0,0 @@
-import { getLeadSourceData } from './get-lead-source-data';
-
-export const mockLocation = (url) => {
-    const location = new URL(url);
-    delete window.location;
-    window.location = location;
-};
-
-describe('getLeadSourceData', () => {
-    it('should return an object with a path property that matches the current URL', () => {
-        const result = getLeadSourceData();
-        expect(result.path).toBe(window.location.href);
-    });
-
-    it('should return the path without the query if the query is longer than 255 characters', () => {
-        const query = Array(300).fill('a').join('');
-
-        const pathWithoutQuery = 'http://www.example.com/path';
-        mockLocation(`${pathWithoutQuery}?${query}`);
-
-        const result = getLeadSourceData();
-        expect(result.path).toBe(pathWithoutQuery);
-    });
-
-    it('should add the query parameters to the returned object', () => {
-        const query = 'utm_source=google&utm_medium=cpc&utm_campaign=example';
-        mockLocation(`http://www.example.com/path?${query}`);
-
-        expect(getLeadSourceData()).toMatchInlineSnapshot(`
-      {
-        "campaign": "example",
-        "medium": "cpc",
-        "path": "http://www.example.com/path?utm_source=google&utm_medium=cpc&utm_campaign=example",
-        "source": "google",
-      }
-    `);
-    });
-});