@rebilly/instruments 2.0.0-beta → 3.0.1-beta.0

package/dist/functions/mount/index.js

@@ -5,20 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.mount = mount;
 
-var _riskDataCollector = require("@rebilly/risk-data-collector");
-
 var _summary = require("../../views/summary");
 
 var _methodSelector = require("../../views/method-selector");
 
-var _utils = require("../../utils");
-
-var _fetchSummaryData = require("./fetch-summary-data");
+var _fetchData = require("./fetch-data");
 
 var _show = require("../show");
 
 var _on = require("../on");
 
+var _setupElement = _interopRequireDefault(require("./setup-element"));
+
 var _setupStorefront = _interopRequireDefault(require("./setup-storefront"));
 
 var _setupOptions = _interopRequireDefault(require("./setup-options"));
@@ -27,6 +25,10 @@ var _setupFramepay = _interopRequireDefault(require("./setup-framepay"));
 
 var _setupStyles = _interopRequireDefault(require("./setup-styles"));
 
+var _setupI18n = _interopRequireDefault(require("./setup-i18n"));
+
+var _setupFramepayTheme = _interopRequireDefault(require("./setup-framepay-theme"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /* eslint-disable max-len */
@@ -36,196 +38,152 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @property {string} planId - The Rebilly id of the plan.
  * @property {number} quantity - The number of the plans to be purchased.
  * @property {string} thumbnail - The source img for the product. Recommend 100px by 100px.
- */
-
-/**
- * @typedef {object} Intent
- * @property {"purchase" | "vault"} mode - Which mode the mount is usings. Default "purchase".
- * @property {Array.<Item>} items - Which plans the customer is purchasing.
- * @property {string} customerId - Which customer is associated with the instrument.
- * @property {string} countryCode - The country code for the transaction
- */
-
-/**
- * @typedef {GooglePayDisplayOptions} GooglePay
- * @param {"back" | "white"} buttonColor - default "black". Color of google pay button
- * @param {"short" | "long"} buttonType - default "short". The length of the button
- * @param {string} buttonHeight - The value and units of the button to match other payment buttons
- * <br>example: "44px", "1rem" etc.
- */
-
-/**
+ *
+ * @typedef {object} GooglePayDisplayOptions
+ * @property {"back" | "white"} [buttonColor=black] - Color of google pay button
+ * @property {"short" | "long"} [buttonType=short] - The length of the button
+ * @property {string} [buttonHeight=44px] - The value and units of the button to match other payment buttons
+ *
+ * @typedef {object} ApplePayDisplayOptions
+ * @property {"back" | "white"} [buttonColor=black] - Color of apple pay button
+ * @property {"short" | "long"} [buttonType=short] - The length of the button
+ * @property {string} [buttonHeight=44px] - The value and units of the button to match other payment buttons
+ *
+ * @typedef {object} ApplePayMerchantOptions
+ * @property {string} merchantName - The name of the merchant store.
+ *
  * @typedef {object} GooglePay
- * @param {GooglePayDisplayOptions} displayOptions - display options for google pay instrument
- */
-
-/**
+ * @property {GooglePayDisplayOptions} displayOptions - display options for google pay instrument
+ *
+ * @typedef {object} ApplePay
+ * @property {ApplePayDisplayOptions} displayOptions - display options for apple pay instrument
+ * @property {ApplePayMerchantOptions} merchantOptions - merchant options for apple pay instrument
+ *
  * @typedef {object} PaymentCard
- * @param {boolean} popup - default: false. Show method as a button with a form popup
- * <br>Otherwise the form will be mounted inline.
- */
-
-/**
+ * @property {boolean} [popup=true] - Show method as a button with a form popup. Otherwise the form will be mounted inline.
+ *
  * @typedef {object} Address
- * @param {string} name - default: default. One of default, combined, or stacked.
- * @param {string} region - default: default. One of default, split, or stacked.
- * @param {Array.<"organization" | "phoneNumber">} show. Show extra fields listed.
- * @param {Array.<"address" | "address2" | "email | "country" | "region" | "postalCode"">} hide. Hide the listed fields.
- * @param {Array.<"organization" | "address" | "address2" | "email" | "phoneNumber" | "country" | "region" | "postalCode">} require.
- * <br>If the field name is included, enforce the data for those inputs to be included.
- * <br>First name and last name are always required. Country is always required if the products require shipping.
- */
-
-/**
+ * @property {string} [name=default] - One of default, combined, or stacked.
+ * @property {string} [region=default] - One of default, split, or stacked.
+ * @property {Array.<"organization" | "phoneNumber">} show - Show extra fields listed.
+ * @property {Array.<"address" | "address2" | "email | "country" | "region" | "postalCode"">} hide - Hide the listed fields.
+ * @property {Array.<"organization" | "address" | "address2" | "email" | "phoneNumber" | "country" | "region" | "postalCode">} require - Require the listed fields.
+ *
  * @typedef {object} PaymentInstruments
- * @param {boolean} compactExpressInstruments - default: true. Show express methods as
- * <br>inline pill buttons, or list of full width button.
- * @param {PaymentCard} paymentCard - settings for payment card instruments
- * @param {GooglePay} googlePay - settings for google pay instruments
- * @param {Address} address - customization for address components for all payment instruments.
- */
-
-/**
+ * @property {boolean} [compactExpressInstruments=true] - Show express methods as inline pill buttons, or list of full width button.
+ * @property {PaymentCard} paymentCard - settings for payment card instruments
+ * @property {GooglePay} googlePay - settings for google pay instruments
+ * @property {ApplePay} applePay - settings for apple pay instruments
+ * @property {Address} address - customization for address components for all payment instruments.
+ *
  * @typedef {object} Features
- * @param {boolean} autoConfirmation - default: true. Will mount the confirmation screen after `instrument-ready`
- * <br>event is triggered. Will need to trigger purchase manually if set to false.
- * <br>Can use RebillyInstruments.show('confirmation', options) to mount defautl component
- * @param {boolean} autoResult - default: true. Show results of transaction after `purchase-completed` event is triggered
- * <br>Will need to handle purchase result manually if set to false.
- * <br>Can use RebillyInstruments.show('result', options) to display default component
- */
-
-/**
- * @typedef {object} Options
- * @property {Intent} intent - The information required for purchaseing or vaulting an instrument
- * @property {PaymentInstruments} paymentInstruments - settings for various payment instruments
- * @property {Features} features - flags to enable and disable different features
- * @property {string} locale - default: auto. Language to render component text
- */
-
-/**
- * Mount library with configurations.
- * @typedef {object} MountParams
- * @property {Object} state - Global state
- * @property {string | HTMLElement} form - The CSS class or HTML element were the form will be mounted.
- * @property {string | HTMLElement} form - The CSS class or HTML element were the form will be mounted.
- * @property {string | HTMLElement} summary - The CSS class or HTML element were the summary will be mounted.
- * @property {Options} options - The configurations that are to be passed to the library for use.
+ * @property {boolean} [autoConfirmation=true] - Will mount the confirmation screen after `instrument-ready` event is triggered.
+ * @property {boolean} [autoResult=true] - Show results of transaction after `purchase-completed` event is triggered
  */
 
 /**
  * Mount library with configurations.
- * @param {MountParams} params
+ * @param {object} options - The options object
+ * @param {object} options.state - Global state
+ * @param {string | HTMLElement} options.form - The CSS class or HTML element were the form will be mounted.
+ * @param {string | HTMLElement} options.summary - The CSS class or HTML element were the summary will be mounted.
+ * @param {Item[]} options.items - Which plans the customer is purchasing.
+ * @param {string} options.invoiceId - The Rebilly id of the invoice used for purchasing.
+ * @param {string} options.customerJwt - The customer token to access the invoice.
+ * @param {string} [options.countryCode=USD] - The country code for the transaction
+ * @param {PaymentInstruments} options.paymentInstruments - settings for various payment instruments
+ * @param {Features} options.features - flags to enable and disable different features
+ * @param {string} options.locale - default: auto. Language to render component text
  */
 async function mount({
   state,
-  form = '.rebilly-instruments',
-  summary = '.rebilly-instruments-summary',
   ...options
 } = {}) {
-  state.form = form;
-  state.summary = summary;
-  state.storefront = (0, _setupStorefront.default)(options);
-  state.options = (0, _setupOptions.default)(options);
-  state.mainStyle = await (0, _setupStyles.default)(options);
-  state._dev = options._dev;
-  (0, _setupFramepay.default)(options);
-  state.form = (0, _utils.processPropertyAsDOMElement)({
-    prop: state.form,
-    propName: 'form'
-  });
-  state.summary = (0, _utils.processPropertyAsDOMElement)({
-    prop: state.summary,
-    propName: 'summary',
-    isRequired: false
-  }); // Setup loader
-
-  state.loader.addDOMElement({
-    el: state.form
-  });
-  state.loader.addDOMElement({
-    section: 'summary',
-    el: state.summary
-  });
-
   try {
-    var _riskMetadata$browser;
+    var _state$data$transacti;
+
+    state.data = {};
+    state.options = {}; // Setup DOM
 
+    state.form = (0, _setupElement.default)({
+      element: 'form',
+      options
+    });
+    state.summary = (0, _setupElement.default)({
+      element: 'summary',
+      options
+    }); // Setup loader
+
+    state.loader.addDOMElement({
+      el: state.form
+    });
+    state.loader.addDOMElement({
+      section: 'summary',
+      el: state.summary
+    });
     state.loader.startLoading({
       section: 'summary',
       id: 'initSummary'
     });
     state.loader.startLoading({
       id: 'initForm'
-    });
-    const {
-      riskMetadata
-    } = await (0, _riskDataCollector.collectData)();
-
-    if (state.options.locale === 'auto' && riskMetadata !== null && riskMetadata !== void 0 && (_riskMetadata$browser = riskMetadata.browserData) !== null && _riskMetadata$browser !== void 0 && _riskMetadata$browser.language) {
-      const {
-        browserData: {
-          language
-        }
-      } = riskMetadata;
-      state.options.locale = language;
-    }
+    }); // Setup state
 
-    state.translate.init(state.options.locale, state.options.i18n);
-    const {
-      readyToPay,
-      summary: summaryData,
-      plans,
-      products
-    } = await (0, _fetchSummaryData.fetchSummaryData)({
-      riskMetadata,
+    state.storefront = (0, _setupStorefront.default)({
+      options
+    });
+    state.options = (0, _setupOptions.default)({
+      options
+    });
+    state.mainStyle = await (0, _setupStyles.default)({
+      options
+    });
+    state.data = await (0, _fetchData.fetchData)({
       state
     });
-    state.hasMounted = true;
+    state.options.themeFramepay = await (0, _setupFramepayTheme.default)({
+      state,
+      options
+    });
+    const i18n = (0, _setupI18n.default)({
+      state
+    });
+    (0, _setupFramepay.default)({
+      state
+    });
+
+    if (state.data.transaction && ((_state$data$transacti = state.data.transaction) === null || _state$data$transacti === void 0 ? void 0 : _state$data$transacti.type) === 'setup') {
+      state.options.transactionType = 'setup';
+    } // Mount content
+
 
     if (state.form) {
-      const formOptions = {
-        summary: summaryData,
-        mainStyle: state.mainStyle,
-        readyToPay,
-        plans,
-        products
-      };
       (0, _methodSelector.mountMethodSelector)({
-        state,
-        formOptions
+        state
       });
     }
 
     if (state.summary) {
-      const summaryOptions = {
-        summary: summaryData,
-        readyToPay,
-        plans,
-        products
-      };
       (0, _summary.mountSummary)({
-        state,
-        summaryOptions
+        state
       });
     }
+
+    i18n({
+      state
+    });
+    state.hasMounted = true;
   } catch (error) {
     throw error;
   }
 
-  state.translate.init(state.options.locale, state.options.i18n);
-  state.translate.translateItems();
-
   if (state.options.features.autoConfirmation) {
     (0, _on.on)({
       eventName: 'instrument-ready',
-      callback: instrument => {
+      callback: payload => {
         (0, _show.show)({
           componentName: 'confirmation',
-          payload: {
-            instrument,
-            mainStyle: state.mainStyle
-          },
+          payload,
           state
         });
       }
@@ -233,18 +191,28 @@ async function mount({
   }
 
   if (state.options.features.autoResult) {
-    (0, _on.on)({
-      eventName: 'purchase-completed',
-      callback: purchase => {
-        (0, _show.show)({
-          componentName: 'result',
-          payload: {
-            purchase,
-            mainStyle: state.mainStyle
-          },
-          state
-        });
-      }
-    });
+    if (state.options.transactionType === 'setup') {
+      (0, _on.on)({
+        eventName: 'setup-completed',
+        callback: payload => {
+          (0, _show.show)({
+            componentName: 'result',
+            payload,
+            state
+          });
+        }
+      });
+    } else {
+      (0, _on.on)({
+        eventName: 'purchase-completed',
+        callback: payload => {
+          (0, _show.show)({
+            componentName: 'result',
+            payload,
+            state
+          });
+        }
+      });
+    }
   }
 }

package/dist/functions/mount/mount.spec.js

@@ -31,9 +31,7 @@ describe('RebillyInstruments instance', () => {
         quantity: 1
       }],
       theme: {
-        color: {
-          background: '#000'
-        }
+        colorBackground: '#000'
       },
       css: `
       .rebilly-instruments-summary-line-item-synopsis-title {
@@ -50,7 +48,7 @@ describe('RebillyInstruments instance', () => {
     expect(summarySelector.innerHTML).toMatch('My Product'); // Theme config overrides initial styles
 
     const SUMMARY_CONTAINER = summarySelector.querySelector('.rebilly-instruments-content');
-    expect(getComputedStyle(SUMMARY_CONTAINER).background).toEqual('rgb(0, 0, 0)'); // CSS config property overrides initial styles
+    expect(getComputedStyle(SUMMARY_CONTAINER).getPropertyValue('--rebilly-colorBackground')).toEqual('#000'); // CSS config property overrides initial styles
 
     const LINE_ITEM_TITLE = document.querySelector('.rebilly-instruments-summary-line-item-synopsis-title');
     expect(getComputedStyle(LINE_ITEM_TITLE).color).toEqual('rgb(0, 68, 212)'); // Mounts default FramePay script

package/dist/functions/mount/setup-element.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = require("../../utils");
+
+var _default = ({
+  element = '',
+  options = {}
+}) => {
+  if (element !== 'form' && element !== 'summary') {
+    throw new Error('element must be "form" or "summary"');
+  }
+
+  const getProp = () => {
+    if (options[element]) {
+      return options[element];
+    }
+
+    switch (element) {
+      case 'summary':
+        return '.rebilly-instruments-summary';
+
+      case 'form':
+      default:
+        return '.rebilly-instruments';
+    }
+  };
+
+  return (0, _utils.processPropertyAsDOMElement)({
+    prop: getProp(),
+    propName: element,
+    isRequired: ['form'].includes(element)
+  });
+};
+
+exports.default = _default;

package/dist/functions/mount/setup-framepay-theme.js

@@ -0,0 +1,95 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _css = _interopRequireDefault(require("css"));
+
+var _postcss = _interopRequireDefault(require("postcss"));
+
+var _postcssCustomProperties = _interopRequireDefault(require("postcss-custom-properties"));
+
+var _lodash = _interopRequireDefault(require("lodash.camelcase"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const resolveCssVars = async rawCss => (0, _postcss.default)([(0, _postcssCustomProperties.default)({
+  preserve: false
+})]).process(rawCss, {
+  from: undefined
+}).then(output => output.css);
+
+const getStyleProps = (ast, selector) => {
+  const {
+    rules
+  } = ast.stylesheet;
+  const output = {
+    color: null,
+    fontFamily: null,
+    fontSize: null,
+    lineHeight: null,
+    fontWeight: null,
+    background: null
+  };
+
+  for (let i = 0; i < rules.length; i += 1) {
+    const rule = rules[i];
+
+    if (rule.type === 'rule' && rule.selectors.includes(selector)) {
+      rule.declarations.forEach(decl => {
+        const propName = (0, _lodash.default)(decl.property);
+
+        if (typeof output[propName] !== 'undefined') {
+          output[propName] = decl.value;
+        }
+      });
+    }
+  }
+
+  return output;
+};
+
+var _default = async ({
+  state,
+  options = {}
+}) => {
+  const fullCss = `
+    ${state.mainStyle}
+    ${options.css || ''}
+  `;
+  const resolvedCss = await resolveCssVars(fullCss);
+
+  const cssAst = _css.default.parse(resolvedCss);
+
+  const cssSelectors = {
+    base: '.rebilly-instruments-form-field-input',
+    baseHover: '.rebilly-instruments-form-field-input:hover',
+    baseFocus: '.rebilly-instruments-form-field-input:focus',
+    basePlaceholder: '.rebilly-instruments-form-field-input::placeholder',
+    baseSelection: '.rebilly-instruments-form-field-input::selection',
+    invalid: '.rebilly-instruments-form-field.is-error .rebilly-instruments-form-field-input',
+    invalidHover: '.rebilly-instruments-form-field.is-error .rebilly-instruments-form-field-input:hover',
+    invalidFocus: '.rebilly-instruments-form-field.is-error .rebilly-instruments-form-field-input:focus',
+    invalidPlaceholder: '.rebilly-instruments-form-field.is-error .rebilly-instruments-form-field-input::placeholder',
+    invalidSelection: '.rebilly-instruments-form-field.is-error .rebilly-instruments-form-field-input::selection'
+  };
+  const framepayStyle = {
+    base: { ...getStyleProps(cssAst, cssSelectors.base),
+      ':hover': getStyleProps(cssAst, cssSelectors.baseHover),
+      ':focus': getStyleProps(cssAst, cssSelectors.baseFocus),
+      '::placeholder': getStyleProps(cssAst, cssSelectors.basePlaceholder),
+      '::selection': getStyleProps(cssAst, cssSelectors.baseSelection)
+    },
+    invalid: { ...getStyleProps(cssAst, cssSelectors.invalid),
+      ':hover': getStyleProps(cssAst, cssSelectors.invalidHover),
+      ':focus': getStyleProps(cssAst, cssSelectors.invalidFocus),
+      '::placeholder': getStyleProps(cssAst, cssSelectors.invalidPlaceholder),
+      '::selection': getStyleProps(cssAst, cssSelectors.invalidSelection)
+    }
+  };
+  return framepayStyle;
+};
+
+exports.default = _default;

package/dist/functions/mount/setup-framepay.js

@@ -8,7 +8,11 @@ exports.default = void 0;
 var _utils = require("../../utils");
 
 var _default = ({
-  _dev
+  state: {
+    options: {
+      _dev
+    }
+  }
 } = {}) => {
   const framePayUrls = {
     script: _dev ? _dev.framePayScriptLink || 'https://framepay.rebilly.com/rebilly.js' : 'https://framepay.rebilly.com/rebilly.js',

package/dist/functions/mount/setup-i18n.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+const triggerTranslations = ({
+  state
+}) => {
+  state.translate.init(state.options.locale, state.options.i18n);
+  state.translate.translateItems();
+};
+
+var _default = ({
+  state = {}
+}) => {
+  var _state$data$riskMetad, _state$data$riskMetad2;
+
+  if (state.options.locale === 'auto' && (_state$data$riskMetad = state.data.riskMetadata) !== null && _state$data$riskMetad !== void 0 && (_state$data$riskMetad2 = _state$data$riskMetad.browserData) !== null && _state$data$riskMetad2 !== void 0 && _state$data$riskMetad2.language) {
+    const {
+      browserData: {
+        language
+      }
+    } = state.data.riskMetadata;
+    state.options.locale = language;
+  }
+
+  state.translate.init(state.options.locale, state.options.i18n);
+  return triggerTranslations;
+};
+
+exports.default = _default;