@rebilly/instruments 4.8.1 → 4.8.2

package/src/functions/mount/setup-options.spec.js

@@ -1,353 +0,0 @@
-import { RebillyInstrumentsConfigError } from '../../data/options-schema';
-import setupOptions, {
-    handleComputedProperty,
-    handleNestedPropertiesDefaultValues,
-    handleJwtDestructuring,
-} from './setup-options';
-
-describe('Setup options function', () => {
-    it.skip('should throw error when options are invalid', () => {
-        vi.spyOn(console, 'error').mockImplementation(() => {});
-
-        expect(() => setupOptions()).toThrow(RebillyInstrumentsConfigError);
-    });
-
-    it.skip('should expect only one purchase data', () => {
-        const errorLogs = [];
-        vi.spyOn(console, 'error').mockImplementation((error) => {
-            if (typeof error === 'object') {
-                errorLogs.push(error.message);
-            }
-        });
-
-        const options = {
-            apiMode: 'sandbox',
-            items: [
-                {
-                    planId: 'plan_TEST',
-                    quantity: 1,
-                },
-            ],
-            money: {
-                amount: 1.99,
-                currency: 'USD',
-            },
-        };
-        expect(() => setupOptions({ options })).toThrow(
-            RebillyInstrumentsConfigError,
-        );
-        expect(errorLogs.length).toEqual(1);
-        expect(errorLogs[0]).toEqual(
-            'options must match exactly one schema in oneOf, see schemas below.',
-        );
-    });
-
-    it('should validate and inject default values', () => {
-        const testJwt =
-            'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJqd3RfVEVTVC1BIiwiZXhwIjoxNzE0ODQwNDg5LCJpYXQiOjE2ODMyMTY1ODkuNTYwMjU2LCJhY2wiOlt7InNjb3BlIjp7Im9yZ2FuaXphdGlvbklkIjpbIm9yZ19URVNULUEiXSwiaW52b2ljZUlkIjpbImluX1RFU1QtQSJdLCJjdXN0b21GaWVsZE5hbWUiOlsiU0lOTGFzdDQiXX0sInBlcm1pc3Npb25zIjpbMjg0LDI4Niw0MTQsNDE1LDQzNCw0MTIsNDI0LDQyNSw0MjYsNDI3LDQyOCw0MjksNDA5LDQxMCw0MDEsNDAyLDQzMyw0MzFdfV0sImNsYWltcyI6eyJ3ZWJzaXRlSWQiOiJ3ZWJfVEVTVC1BIiwiaW52b2ljZUlkIjoiaW5fVEVTVC1BIiwicGF5bWVudE1ldGhvZHMiOltdfSwibWVyY2hhbnQiOiJNRVJDSEFOVC1URVNULUlELUEiLCJjdXN0b21lciI6eyJpZCI6ImN1c19URVNULUEiLCJuYW1lIjoiQ2FyZCBIb2xkZXIgTmFtZSIsImNyZWF0ZWRUaW1lIjoiMjAyMi0wOS0yMVQxODo1MDoyMiswMDowMCJ9fQ.tm33uioGUSpEedHeYufDGm-p1YW40eufNovppcU6-xg';
-        const options = {
-            jwt: testJwt,
-            apiMode: 'sandbox',
-            items: [
-                {
-                    planId: 'plan_TEST',
-                    quantity: {},
-                },
-            ],
-        };
-
-        const results = setupOptions({ options });
-
-        expect(results).toEqual({
-            jwt: testJwt,
-            apiMode: 'sandbox',
-            items: [
-                {
-                    planId: 'plan_TEST',
-                    quantity: {
-                        minimum: 1,
-                        maximum: Number.MAX_SAFE_INTEGER,
-                        multipleOf: 1,
-                    },
-                },
-            ],
-            form: '.rebilly-instruments',
-            summary: '.rebilly-instruments-summary',
-            addons: [],
-            bumpOffer: [],
-            transactionType: 'purchase',
-            theme: { labels: 'stacked' },
-            countryCode: 'US',
-            locale: 'auto',
-            paymentInstruments: {
-                compactExpressInstruments: false,
-                address: {
-                    name: 'default',
-                    region: 'default',
-                    show: [],
-                    hide: [],
-                    require: [],
-                },
-                paypal: { buttonHeight: 48 },
-                googlePay: {
-                    displayOptions: {
-                        buttonColor: 'black',
-                        buttonHeight: '48px',
-                        buttonType: 'plain',
-                    },
-                },
-                applePay: {
-                    displayOptions: {
-                        buttonColor: 'black',
-                        buttonHeight: '48px',
-                        buttonType: 'plain',
-                    },
-                },
-                paymentCard: { popup: false },
-            },
-            features: {
-                autoConfirmation: true,
-                autoResult: true,
-                fullPageRedirect: false,
-            },
-            _computed: {
-                paymentMethodsUrl: 'https://forms.secure-payments.app',
-            },
-            organizationId: 'MERCHANT-TEST-ID-A',
-            invoiceId: 'in_TEST-A',
-            websiteId: 'web_TEST-A',
-        });
-    });
-
-    it.skip('should throw error for missing purchase data', () => {
-        const errorLogs = [];
-        vi.spyOn(console, 'error').mockImplementation((error) => {
-            if (typeof error === 'string') {
-                errorLogs.push(error);
-            }
-        });
-
-        expect(() => setupOptions()).toThrow(RebillyInstrumentsConfigError);
-        expect(errorLogs.length).toEqual(6);
-        const expectedResults = [
-            'items',
-            'money',
-            'invoiceId',
-            'transactionId',
-            'deposit',
-            'jwt',
-        ];
-        expectedResults.forEach((result) => {
-            it(`should expect required oneOf ${result}`, () => {
-                expect(
-                    errorLogs.some((error) => {
-                        return (
-                            error.includes('required') && error.includes(result)
-                        );
-                    }),
-                ).toEqual(true);
-            });
-        });
-    });
-
-    describe('should ensure purchase data has dependant properties', () => {
-        let errorLogs = [];
-        beforeEach(() => {
-            errorLogs = [];
-            vi.spyOn(console, 'error').mockImplementation((error) => {
-                if (typeof error === 'object') {
-                    errorLogs.push(error.message);
-                }
-            });
-        });
-
-        const expectJwtTests = [
-            {
-                invoiceId: 'in_TEST',
-            },
-            {
-                transactionId: 'txn_TEST',
-            },
-            {
-                deposit: {
-                    depositRequestId: 'cash_req_TEST',
-                },
-            },
-        ];
-
-        expectJwtTests.forEach((test) => {
-            const key = Object.keys(test)[0];
-            it.skip(`should expect jwt with ${key}`, () => {
-                const options = {
-                    apiMode: 'sandbox',
-                    ...test,
-                };
-
-                expect(() => setupOptions({ options })).toThrow(
-                    RebillyInstrumentsConfigError,
-                );
-                expect(errorLogs.length).toEqual(1);
-                expect(errorLogs[0]).toEqual(
-                    `options must have property jwt when property ${key} is present`,
-                );
-            });
-        });
-    });
-});
-
-describe('Setup options handleComputedProperty function', () => {
-    it('should populate options with instrument methods url', () => {
-        const options = {};
-        const result = handleComputedProperty(options);
-
-        expect(result).toEqual({
-            _computed: {
-                paymentMethodsUrl: 'https://forms.secure-payments.app',
-            },
-        });
-    });
-
-    it('should set paymentMethodsUrl from _dev configuration', () => {
-        const options = {
-            _dev: {
-                paymentMethodsUrl: 'https://www.example.com',
-            },
-        };
-        const result = handleComputedProperty(options);
-
-        expect(result._computed.paymentMethodsUrl).toEqual(
-            'https://www.example.com',
-        );
-    });
-
-    it('should default paymentMethodsUrl from empty _dev configuration', () => {
-        const options = {
-            _dev: {},
-        };
-        const result = handleComputedProperty(options);
-
-        expect(result._computed.paymentMethodsUrl).toEqual(
-            'https://forms.secure-payments.app',
-        );
-    });
-});
-
-describe('Setup options handleNestedPropertiesDefaultValues function', () => {
-    it.skip('should add defaults for deposits with currency configuration', () => {
-        const options = {
-            deposit: {
-                currency: 'USD',
-            },
-        };
-
-        const result = handleNestedPropertiesDefaultValues(options);
-
-        expect(result).toEqual({
-            deposit: {
-                editable: true,
-                buttons: [],
-                customAmount: {
-                    minimum: 1,
-                    maximum: 1000000000000,
-                    increment: 1,
-                },
-                currency: 'USD',
-            },
-        });
-    });
-
-    it.skip('should not inject defaults to deposit without currency', () => {
-        const options = {
-            deposit: {
-                depositRequestId: 'cash_req_TEST',
-            },
-        };
-
-        const result = handleNestedPropertiesDefaultValues(options);
-        expect(result).toEqual({
-            deposit: {
-                depositRequestId: 'cash_req_TEST',
-            },
-        });
-    });
-
-    it.skip('should add defaults to items with empty object for quantity', () => {
-        const options = {
-            items: [
-                {
-                    planId: 'plan_TEST',
-                    quantity: {},
-                },
-            ],
-        };
-
-        const result = handleNestedPropertiesDefaultValues(options);
-        expect(result).toEqual({
-            items: [
-                {
-                    planId: 'plan_TEST',
-                    quantity: {
-                        minimum: 0.1,
-                        maximum: Number.MAX_SAFE_INTEGER,
-                        multipleOf: 0.1,
-                    },
-                },
-            ],
-        });
-    });
-});
-
-describe('Setup options handleJwtDestructuring function', () => {
-    const testJwt =
-        'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJqd3RfVEVTVC1BIiwiZXhwIjoxNzE0ODQwNDg5LCJpYXQiOjE2ODMyMTY1ODkuNTYwMjU2LCJhY2wiOlt7InNjb3BlIjp7Im9yZ2FuaXphdGlvbklkIjpbIm9yZ19URVNULUEiXSwiaW52b2ljZUlkIjpbImluX1RFU1QtQSJdLCJjdXN0b21GaWVsZE5hbWUiOlsiU0lOTGFzdDQiXX0sInBlcm1pc3Npb25zIjpbMjg0LDI4Niw0MTQsNDE1LDQzNCw0MTIsNDI0LDQyNSw0MjYsNDI3LDQyOCw0MjksNDA5LDQxMCw0MDEsNDAyLDQzMyw0MzFdfV0sImNsYWltcyI6eyJ3ZWJzaXRlSWQiOiJ3ZWJfVEVTVC1BIiwiaW52b2ljZUlkIjoiaW5fVEVTVC1BIiwicGF5bWVudE1ldGhvZHMiOltdfSwibWVyY2hhbnQiOiJNRVJDSEFOVC1URVNULUlELUEiLCJjdXN0b21lciI6eyJpZCI6ImN1c19URVNULUEiLCJuYW1lIjoiQ2FyZCBIb2xkZXIgTmFtZSIsImNyZWF0ZWRUaW1lIjoiMjAyMi0wOS0yMVQxODo1MDoyMiswMDowMCJ9fQ.tm33uioGUSpEedHeYufDGm-p1YW40eufNovppcU6-xg';
-
-    it('should destructure when jwt is present', () => {
-        const options = {
-            jwt: testJwt,
-        };
-
-        const result = handleJwtDestructuring(options);
-        expect(result).toEqual({
-            jwt: testJwt,
-            organizationId: 'MERCHANT-TEST-ID-A',
-            invoiceId: 'in_TEST-A',
-            websiteId: 'web_TEST-A',
-        });
-    });
-
-    it('should not destructure when publishableKey is supplied', () => {
-        const options = {
-            jwt: testJwt,
-            publishableKey: 'pk_sandbox_TEST',
-            organizationId: 'MERCHANT-TEST-ID-B',
-            invoiceId: 'in_TEST-B',
-            websiteId: 'web_TEST-B',
-        };
-
-        const result = handleJwtDestructuring(options);
-        expect(result).toEqual({
-            jwt: testJwt,
-            publishableKey: 'pk_sandbox_TEST',
-            organizationId: 'MERCHANT-TEST-ID-B',
-            invoiceId: 'in_TEST-B',
-            websiteId: 'web_TEST-B',
-        });
-    });
-
-    it('should use JWT values when publishableKey is missing', () => {
-        const options = {
-            jwt: testJwt,
-            organizationId: 'MERCHANT-TEST-ID-B',
-            invoiceId: 'in_TEST-B',
-            websiteId: 'web_TEST-B',
-        };
-
-        const result = handleJwtDestructuring(options);
-        expect(result).toEqual({
-            jwt: testJwt,
-            organizationId: 'MERCHANT-TEST-ID-A',
-            invoiceId: 'in_TEST-A',
-            websiteId: 'web_TEST-A',
-        });
-    });
-});

package/src/functions/mount/setup-storefront.js

@@ -1,23 +0,0 @@
-import Storefront from '../../storefront';
-import state from '../../state';
-
-export default () => {
-    const { publishableKey, organizationId, apiMode, _dev } = state.options;
-
-    const storefront = {
-        organizationId,
-        mode: apiMode || 'live',
-    };
-
-    if (publishableKey) {
-        storefront.publishableKey = publishableKey;
-    }
-
-    if (_dev) {
-        storefront.liveUrl = _dev.liveUrl || 'https://api.rebilly.com';
-        storefront.sandboxUrl =
-            _dev.sandboxUrl || 'https://api-sandbox.rebilly.com';
-    }
-
-    return Storefront(storefront);
-};

package/src/functions/mount/setup-styles-vars.js

@@ -1,30 +0,0 @@
-import { mainStyleVars } from '../../style';
-import { addDOMElement } from '../../utils';
-import { minifyCss } from '../../style/utils/minifyCss';
-import state from '../../state';
-
-export default () => {
-    const { theme = {}, css } = state.options;
-
-    // Adds base CSS vars stylesheet
-    const styleVars = mainStyleVars(theme || {});
-
-    addDOMElement({
-        element: 'style',
-        attributes: { type: 'text/css' },
-        content: minifyCss(styleVars),
-        target: 'head',
-    });
-
-    // Adds options CSS to override any styles
-    if (css) {
-        addDOMElement({
-            element: 'style',
-            attributes: { type: 'text/css' },
-            content: minifyCss(css),
-            target: 'head',
-        });
-    }
-
-    return styleVars;
-};

package/src/functions/mount/setup-user-flow.js

@@ -1,60 +0,0 @@
-import { on } from '../on';
-import { show } from '../show';
-import { purchase } from '../purchase';
-import { setup } from '../setup';
-
-function showResult({ state, payload }) {
-    show({
-        componentName: 'result',
-        payload,
-        state,
-    });
-}
-
-export default ({ state = {} }) => {
-    if (state.options.features.autoConfirmation) {
-        on({
-            eventName: 'instrument-ready',
-            callback: (payload) => {
-                // Alternate flow for paypal.
-                if (payload._raw?.method === 'paypal') {
-                    if (!state.data.isShippingRequired) {
-                        if (state.options.transactionType === 'setup') {
-                            setup({ state, payload });
-                        } else {
-                            purchase({ state, payload });
-                        }
-                        state.loader.startLoading({
-                            state,
-                            id: 'express-purchase',
-                            message: 'form.loaderMessages.processingPayment',
-                        });
-                        return;
-                    }
-                }
-                show({
-                    componentName: 'confirmation',
-                    payload,
-                    state,
-                });
-            },
-        });
-    }
-
-    if (state.options.features.autoResult) {
-        on({
-            eventName: 'purchase-completed',
-            callback: (payload) => {
-                payload = JSON.parse(JSON.stringify(payload));
-                showResult({ state, payload });
-            },
-        });
-        on({
-            eventName: 'setup-completed',
-            callback: (payload) => {
-                payload = JSON.parse(JSON.stringify(payload));
-                showResult({ state, payload });
-            },
-        });
-    }
-};

package/src/functions/on.js

@@ -1,22 +0,0 @@
-import camelCase from 'lodash.camelcase';
-import Events, { publicEventNames } from '../events';
-
-/**
- @typedef OnParams
- @type {Object}
- @property {string} eventName - The name of the event
- @property {function} callback - The function that is triggered by the event.
- */
-
-/**
- * Register events that will be triggered
- * @param {OnParams} params
- */
-export function on({ eventName, callback }) {
-    if (!publicEventNames.includes(eventName)) {
-        throw new Error(`${eventName} is not a supported event`);
-    }
-
-    const internalEventName = camelCase(eventName);
-    Events[internalEventName].addEventListener(callback);
-}

package/src/functions/on.spec.js

@@ -1,75 +0,0 @@
-import camelCase from 'lodash.camelcase';
-import { RenderMockRebillyInstruments } from 'tests/mocks/rebilly-instruments-mock';
-import { RebillyInstrumentsInstance } from '@/instance';
-import Events from '@/events';
-import iframes from '@/state/iframes';
-
-describe('RebillyInstruments on', () => {
-    it('should register event listeners', async () => {
-        const rebillyInstruments = await RenderMockRebillyInstruments();
-        const publicEventNames = ['instrument-ready', 'purchase-completed'];
-
-        await Promise.all(
-            publicEventNames.map(async (eventName) => {
-                const callback = vi.fn();
-                rebillyInstruments.on(eventName, callback);
-
-                const details = {
-                    test: 'data',
-                };
-                Events[camelCase(eventName)].dispatch(details);
-
-                expect(callback).toBeCalledTimes(1);
-                expect(callback).toBeCalledWith(details);
-            }),
-        );
-    });
-
-    it('should throw error for internal namespaced events', async () => {
-        const callback = vi.fn();
-        const instance = new RebillyInstrumentsInstance();
-        const iframeMock = {
-            component: {
-                call: vi.fn(),
-            },
-        };
-        iframes.form = iframeMock;
-
-        let error;
-        try {
-            // rebilly-instruments-purchase-completed will be used internally but not available externally
-            await instance.on(
-                'rebilly-instruments-purchase-completed',
-                callback,
-            );
-        } catch (e) {
-            error = e;
-        }
-        expect(error).toEqual(
-            new Error(
-                'rebilly-instruments-purchase-completed is not a supported event',
-            ),
-        );
-    });
-
-    it('should throw error for a non defined event', async () => {
-        const callback = vi.fn();
-        const instance = new RebillyInstrumentsInstance();
-        const iframeMock = {
-            component: {
-                call: vi.fn(),
-            },
-        };
-        iframes.form = iframeMock;
-
-        let error;
-        try {
-            await instance.on('not-an-event', callback);
-        } catch (e) {
-            error = e;
-        }
-        expect(error).toEqual(
-            new Error('not-an-event is not a supported event'),
-        );
-    });
-});