@rebilly/instruments 4.8.1 → 4.8.2

package/src/data/options-schema/schemas/options-schema.js

@@ -1,448 +0,0 @@
-export default {
-    title: 'Mount Options Schema',
-    type: 'object',
-    properties: {
-        form: {
-            type: 'string',
-            default: '.rebilly-instruments',
-        },
-        summary: {
-            type: 'string',
-            default: '.rebilly-instruments-summary',
-        },
-        apiMode: {
-            type: 'string',
-            enum: ['sandbox', 'live'],
-        },
-        publishableKey: { type: 'string' },
-        jwt: { type: 'string' },
-        websiteId: { type: 'string' },
-        organizationId: { type: 'string' },
-        items: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    planId: { type: 'string' },
-                    thumbnail: { type: 'string' },
-                },
-                oneOf: [
-                    {
-                        properties: {
-                            quantity: { type: 'number' },
-                        },
-                    },
-                    {
-                        properties: {
-                            quantity: {
-                                type: 'object',
-                                properties: {
-                                    default: { type: 'number' },
-                                    minimum: { type: 'number' },
-                                    maximum: { type: 'number' },
-                                    multipleOf: { type: 'number' },
-                                },
-                            },
-                        },
-                    },
-                ],
-                required: ['planId', 'quantity'],
-            },
-            minItems: 1,
-        },
-        addons: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    planId: { type: 'string' },
-                    quantity: { type: 'number' },
-                    thumbnail: { type: 'string' },
-                },
-                required: ['planId', 'quantity'],
-            },
-            default: [],
-        },
-        bumpOffer: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    planId: { type: 'string' },
-                    quantity: { type: 'number' },
-                    thumbnail: { type: 'string' },
-                },
-                required: ['planId', 'quantity'],
-            },
-            default: [],
-        },
-        money: {
-            type: 'object',
-            properties: {
-                amount: {
-                    type: 'number',
-                },
-                currency: {
-                    type: 'string',
-                    minLength: 3,
-                    maxLength: 3,
-                },
-            },
-            required: ['amount', 'currency'],
-        },
-        invoiceId: { type: 'string' },
-        transactionId: { type: 'string' },
-        deposit: {
-            oneOf: [
-                {
-                    type: 'object',
-                    properties: {
-                        depositRequestId: { type: 'string' },
-                    },
-                    required: ['depositRequestId'],
-                },
-                {
-                    type: 'object',
-                    properties: {
-                        currency: {
-                            type: 'string',
-                            minLength: 3,
-                            maxLength: 3,
-                        },
-                        amount: {
-                            type: 'number',
-                        },
-                        buttons: {
-                            type: 'array',
-                            items: {
-                                type: 'number',
-                            },
-                        },
-                        editable: { type: 'boolean' },
-                        customAmount: {
-                            type: 'object',
-                            properties: {
-                                minimum: { type: 'number' },
-                                maximum: { type: 'number' },
-                                multipleOf: { type: 'number' },
-                            },
-                        },
-                    },
-                    anyOf: [
-                        {
-                            required: ['amount'],
-                        },
-                        {
-                            required: ['buttons'],
-                        },
-                    ],
-                    required: ['currency'],
-                },
-            ],
-        },
-        transactionType: {
-            type: 'string',
-            enum: ['purchase', 'setup'],
-            default: 'purchase',
-        },
-        css: { type: 'string' },
-        theme: {
-            type: 'object',
-            properties: {
-                labels: {
-                    type: 'string',
-                    enum: ['stacked', 'floating'],
-                    default: 'stacked',
-                },
-                // TODO: split file add schema for all tokens
-            },
-            default: {},
-        },
-        countryCode: {
-            type: 'string',
-            default: 'US',
-        },
-        locale: {
-            type: 'string',
-            default: 'auto',
-        },
-        i18n: {
-            type: 'object',
-            patternProperties: {
-                '^[a-z]{2}(-[A-Z]{2})?$': {
-                    type: 'object',
-                    properties: {
-                        // TODO: split file add schema for all translation keys
-                        summary: { type: 'object' },
-                        form: { type: 'object' },
-                        confirmation: { type: 'object' },
-                        result: { type: 'object' },
-                        validations: { type: 'object' },
-                        paymentMethods: { type: 'object' },
-                    },
-                },
-            },
-        },
-        paymentInstruments: {
-            type: 'object',
-            properties: {
-                compactExpressInstruments: {
-                    type: 'boolean',
-                    default: false,
-                },
-                address: {
-                    type: 'object',
-                    properties: {
-                        name: {
-                            type: 'string',
-                            enum: ['default', 'combined', 'stacked'],
-                            default: 'default',
-                        },
-                        region: {
-                            type: 'string',
-                            enum: ['default', 'split', 'stacked'],
-                            default: 'default',
-                        },
-                        show: {
-                            type: 'array',
-                            default: [],
-                            items: {
-                                type: 'string',
-                                enum: [
-                                    'all',
-                                    'email',
-                                    'organization',
-                                    'phoneNumber',
-                                    'city',
-                                    'country',
-                                    'region',
-                                    'postalCode',
-                                    'address',
-                                    'address2',
-                                ],
-                            },
-                        },
-                        hide: {
-                            type: 'array',
-                            default: [],
-                            items: {
-                                type: 'string',
-                                enum: [
-                                    'all',
-                                    'email',
-                                    'organization',
-                                    'phoneNumber',
-                                    'city',
-                                    'country',
-                                    'region',
-                                    'postalCode',
-                                    'address',
-                                    'address2',
-                                ],
-                            },
-                        },
-                        require: {
-                            type: 'array',
-                            default: [],
-                            items: {
-                                type: 'string',
-                                enum: [
-                                    'organization',
-                                    'email',
-                                    'phoneNumber',
-                                    'address',
-                                    'address2',
-                                    'city',
-                                    'country',
-                                    'region',
-                                    'postalCode',
-                                ],
-                            },
-                        },
-                    },
-                    default: {},
-                },
-                paypal: {
-                    type: 'object',
-                    properties: {
-                        buttonHeight: {
-                            type: 'number',
-                            default: 48,
-                        },
-                    },
-                    default: {},
-                },
-                googlePay: {
-                    type: 'object',
-                    properties: {
-                        displayOptions: {
-                            type: 'object',
-                            properties: {
-                                buttonColor: {
-                                    type: 'string',
-                                    default: 'black',
-                                },
-                                buttonHeight: {
-                                    type: 'string',
-                                    pattern: '^[0-9]+px$',
-                                    default: '48px',
-                                },
-                                buttonType: {
-                                    type: 'string',
-                                    default: 'plain',
-                                },
-                            },
-                            default: {},
-                        },
-                    },
-                    default: {},
-                },
-                applePay: {
-                    type: 'object',
-                    properties: {
-                        displayOptions: {
-                            type: 'object',
-                            properties: {
-                                buttonColor: {
-                                    type: 'string',
-                                    default: 'black',
-                                },
-                                buttonHeight: {
-                                    type: 'string',
-                                    pattern: '^[0-9]+px$',
-                                    default: '48px',
-                                },
-                                buttonType: {
-                                    type: 'string',
-                                    default: 'plain',
-                                },
-                            },
-                            default: {},
-                        },
-                    },
-                    default: {},
-                },
-                paymentCard: {
-                    type: 'object',
-                    properties: {
-                        popup: {
-                            type: 'boolean',
-                            default: false,
-                        },
-                    },
-                    default: {},
-                },
-            },
-            default: {},
-        },
-        features: {
-            type: 'object',
-            properties: {
-                autoConfirmation: {
-                    type: 'boolean',
-                    default: true,
-                },
-                autoResult: {
-                    type: 'boolean',
-                    default: true,
-                },
-                fullPageRedirect: {
-                    type: 'boolean',
-                    default: false,
-                },
-                showCoupons: {
-                    type: 'array',
-                    items: {
-                        type: 'string',
-                        enum: ['summary', 'confirmation'],
-                    },
-                },
-            },
-            default: {},
-        },
-        _dev: {
-            type: 'object',
-            properties: {
-                paymentMethodsUrl: {
-                    type: 'string',
-                    default: 'https://forms.local.rebilly.dev:3000',
-                },
-                liveUrl: { type: 'string' },
-                sandboxUrl: { type: 'string' },
-                framePayScriptLink: { type: 'string' },
-                framePayStyleLink: { type: 'string' },
-            },
-        },
-    },
-    required: ['apiMode'],
-    dependentRequired: {
-        invoiceId: ['jwt'],
-        transactionId: ['jwt'],
-        deposit: ['jwt'],
-    },
-    anyOf: [
-        {
-            if: { required: ['items'] },
-            then: {
-                properties: {
-                    transactionId: false,
-                    invoiceId: false,
-                    deposit: false,
-                    money: false,
-                },
-            },
-            else: false,
-        },
-        {
-            if: { required: ['money'] },
-            then: {
-                properties: {
-                    transactionId: false,
-                    invoiceId: false,
-                    deposit: false,
-                    items: false,
-                },
-            },
-            else: false,
-        },
-        {
-            if: { required: ['transactionId'] },
-            then: {
-                properties: {
-                    invoiceId: false,
-                    deposit: false,
-                    items: false,
-                    money: false,
-                },
-            },
-            else: false,
-        },
-        {
-            if: { required: ['invoiceId'] },
-            then: {
-                properties: {
-                    transactionId: false,
-                    deposit: false,
-                    items: false,
-                    money: false,
-                },
-            },
-            else: false,
-        },
-        {
-            if: { required: ['deposit'] },
-            then: {
-                properties: {
-                    invoiceId: false,
-                    transactionId: false,
-                    items: false,
-                    money: false,
-                },
-            },
-            else: false,
-        },
-        {
-            required: ['jwt'],
-        },
-    ],
-};

package/src/events/base-event.js

@@ -1,47 +0,0 @@
-export class RegisteredListeners {
-    _listeners = {};
-
-    add(eventName, callback) {
-        document.addEventListener(eventName, callback, false);
-
-        if (!(eventName in this._listeners)) {
-            this._listeners[eventName] = [];
-        }
-        this._listeners[eventName].push(callback);
-    }
-
-    removeAll() {
-        Object.keys(this._listeners).forEach((eventName) => {
-            this._listeners[eventName].forEach((callback) =>
-                document.removeEventListener(eventName, callback, false),
-            );
-        });
-        this._listeners = {};
-    }
-}
-
-export const registeredListeners = new RegisteredListeners();
-
-export default class BaseEvent {
-    /**
-     * @param {string} name
-     */
-    constructor(name) {
-        // Using namespaced internal name as a protection mechanism
-        const PREFIX = 'rebilly-instruments-';
-        this.internalName = PREFIX + name;
-    }
-
-    addEventListener(callback) {
-        const innerCallback = ({ detail }) => callback(detail);
-        registeredListeners.add(this.internalName, innerCallback);
-    }
-
-    dispatch(detail) {
-        const event = new CustomEvent(this.internalName, {
-            bubbles: true,
-            detail,
-        });
-        document.dispatchEvent(event);
-    }
-}

package/src/events/events.spec.js

@@ -1,11 +0,0 @@
-import kebabCase from 'lodash.kebabcase';
-import events, { publicEventNames } from '@/events';
-
-it('Should export all public event names', async () => {
-    Object.keys(events).forEach((internalEventName) => {
-        expect(events[internalEventName].internalName).toEqual(
-            `rebilly-instruments-${kebabCase(internalEventName)}`,
-        );
-        expect(kebabCase(internalEventName) in publicEventNames);
-    });
-});

package/src/events/index.js

@@ -1,15 +0,0 @@
-import kebabCase from 'lodash.kebabcase';
-import BaseEvent from './base-event';
-
-const events = {
-    dataReady: new BaseEvent('data-ready'),
-    instrumentReady: new BaseEvent('instrument-ready'),
-    purchaseCompleted: new BaseEvent('purchase-completed'),
-    setupCompleted: new BaseEvent('setup-completed'),
-};
-
-export default events;
-
-export const publicEventNames = Object.keys(events).map((internalName) =>
-    kebabCase(internalName),
-);

package/src/functions/destroy.js

@@ -1,29 +0,0 @@
-import { cancellation } from 'rebilly-js-sdk';
-import { registeredListeners } from '../events/base-event';
-import { sleep } from '../utils';
-import state from '../state';
-import iframes from '../state/iframes';
-
-export async function destroy() {
-    // wait to allow for cancellation to catch any pending api requests
-    const sleepMilliseconds = 1000;
-    await sleep(sleepMilliseconds);
-
-    Object.keys(iframes).forEach((frame) => {
-        if (iframes.hasFrame(frame)) {
-            iframes[frame].destroy();
-            iframes[frame] = null;
-        }
-    });
-
-    registeredListeners.removeAll(document);
-
-    state.hasMounted = false;
-
-    if (state.summary) {
-        state.summary.textContent = '';
-    }
-    state.form.textContent = '';
-    cancellation.cancelAll();
-    state.loader.clearAll();
-}

package/src/functions/destroy.spec.js

@@ -1,63 +0,0 @@
-import Events, { publicEventNames } from '@/events';
-import BaseEvent from '@/events/base-event';
-import { RenderMockRebillyInstruments } from 'tests/mocks/rebilly-instruments-mock';
-
-describe('RebillyInstruments Destroy', () => {
-    it('should be able to destroy instance', async () => {
-        const rebillyInstruments = await RenderMockRebillyInstruments();
-
-        const formElement = document.querySelector('.form-selector');
-        const summaryElement = document.querySelector('.summary-selector');
-
-        expect(formElement.innerHTML).not.toEqual('');
-        expect(summaryElement.innerHTML).not.toEqual('');
-
-        await rebillyInstruments.destroy();
-
-        expect(formElement.innerHTML).toEqual('');
-        expect(summaryElement.innerHTML).toEqual('');
-    });
-
-    it('should remove registered listeners', async () => {
-        const rebillyInstruments = await RenderMockRebillyInstruments();
-
-        const fakeEventListener = vi.fn();
-        Events.fakeEvent = new BaseEvent('fake-event');
-        publicEventNames.push('fake-event');
-        rebillyInstruments.on('fake-event', fakeEventListener);
-
-        Events.fakeEvent.dispatch();
-
-        expect(fakeEventListener).toHaveBeenCalledTimes(1);
-
-        fakeEventListener.mockClear();
-        await rebillyInstruments.destroy();
-
-        Events.fakeEvent.dispatch();
-        expect(fakeEventListener).not.toHaveBeenCalled();
-    });
-
-    it('should remove multiple listeners on the same event', async () => {
-        const rebillyInstruments = await RenderMockRebillyInstruments();
-
-        const fakeEventListener = vi.fn();
-        const anotherFakeEventListener = vi.fn();
-        Events.fakeEvent = new BaseEvent('fake-event');
-        publicEventNames.push('fake-event');
-        rebillyInstruments.on('fake-event', fakeEventListener);
-        rebillyInstruments.on('fake-event', anotherFakeEventListener);
-
-        Events.fakeEvent.dispatch();
-
-        expect(fakeEventListener).toHaveBeenCalledTimes(1);
-        expect(anotherFakeEventListener).toHaveBeenCalledTimes(1);
-
-        fakeEventListener.mockClear();
-        anotherFakeEventListener.mockClear();
-        await rebillyInstruments.destroy();
-
-        Events.fakeEvent.dispatch();
-        expect(fakeEventListener).not.toHaveBeenCalled();
-        expect(anotherFakeEventListener).not.toHaveBeenCalled();
-    });
-});