@rebilly/instruments 3.19.0-beta.0 → 3.21.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/instruments",
-  "version": "3.19.0-beta.0",
+  "version": "3.21.0-beta.0",
   "author": "Rebilly",
   "license": "MIT",
   "main": "dist/index.js",
@@ -23,7 +23,7 @@
     "lodash.kebabcase": "^4.1.1",
     "lodash.merge": "^4.6.2",
     "popostmate": "^1.6.4",
-    "rebilly-js-sdk": "^47.13.2",
+    "rebilly-js-sdk": "^47.14.2",
     "values.js": "^2.0.0"
   },
   "devDependencies": {

package/src/data/payment-methods.json

@@ -2273,6 +2273,25 @@
       }
     ]
   },
+  {
+    "apiName": "SafetyPay",
+    "name": "SafetyPay",
+    "landscapeLogo": null,
+    "portraitLogo": null,
+    "summary": "SafetyPay operates the largest network of banks and cash collection points in Latin America, the result of 10+ years effort, with presence in 16 countries consolidated with 380 bank partners and 180,000 collection points.\n",
+    "description": "SafetyPay operates the largest network of banks and cash collection points in Latin America, the result of 10+ years effort, with presence in 16 countries consolidated with 380 bank partners and 180,000 collection points.\n",
+    "countries": {
+      "mode": "unknown",
+      "values": []
+    },
+    "storefrontEnabled": true,
+    "_links": [
+      {
+        "rel": "self",
+        "href": "https://api.rebilly.com/payment-methods/SafetyPay"
+      }
+    ]
+  },
   {
     "apiName": "Siirto",
     "name": "Siirto",

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

@@ -1,10 +1,11 @@
 import { collectData } from '@rebilly/risk-data-collector';
 import { fetchProductsFromPlans } from '../../storefront/fetch-products-from-plans';
+import { fetchPlansFromAddonsBumpOffers } from '../../storefront/fetch-plans-from-addons-bumpOffers';
 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 { fetchAccount as FetchAccount } from '../../storefront/account';
+import { fetchAccountAndWebsite as FetchAccountAndWebsite } from '../../storefront/account-and-website';
 import { fetchPaymentInstrument as FetchInstruments } from '../../storefront/payment-instruments';
 
 export class DataInstance {
@@ -21,6 +22,7 @@ export class DataInstance {
 
     this.money = state.options?.money || null;
     this.couponIds = [];
+    this.addons = [];
   }
 
   get amountAndCurrency() {
@@ -122,7 +124,7 @@ export async function fetchData({
   // Dependency injectable functions
   fetchInvoiceAndProducts = FetchInvoiceAndProducts,
   fetchTransaction = FetchTransaction,
-  fetchAccount = FetchAccount,
+  fetchAccountAndWebsite = FetchAccountAndWebsite,
   fetchInstruments = FetchInstruments
 }) {
   try {
@@ -133,8 +135,9 @@ export async function fetchData({
     let accountPromise = Promise.resolve(null);
     let availableInstrumentsPromise = null;
     if (state.options?.jwt) {
-      accountPromise = fetchAccount({state}).then(account => {
+      accountPromise = fetchAccountAndWebsite({state}).then(({account, website}) => {
         state.data.account = account;
+        state.data.website = website;
       });
       availableInstrumentsPromise = fetchInstruments({state});
     }
@@ -174,15 +177,22 @@ export async function fetchData({
       productsPromise = fetchProductsFromPlans({ state });
     }
 
+    let plansPromise = new Promise((resolve) => resolve([]));
+    if (state.options?.addons || state.options?.bumpOffers) {
+      plansPromise = fetchPlansFromAddonsBumpOffers({ state });
+    }
+
     const [
       readyToPay,
       previewPurchase,
       products,
+      plans,
       availableInstruments
     ] = await Promise.all([
       readyToPayPromise,
       previewPurchasePromise,
       productsPromise,
+      plansPromise,
       availableInstrumentsPromise
     ]);
 
@@ -191,6 +201,7 @@ export async function fetchData({
       readyToPay,
       previewPurchase,
       products,
+      plans,
       availableInstruments
     });
   } catch(error) {

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

@@ -75,7 +75,7 @@ describe('fetchData function', () => {
   });
 
   it('Should fetch account when JWT is supplied', async () => {
-    const mockFetchAccount = jest.fn();
+    const mockFetchAccountAndWebsite = jest.fn();
     const accountState = {
       options: {
         jwt: 'TEST_JWT'
@@ -84,23 +84,23 @@ describe('fetchData function', () => {
 
     await fetchData({
       state: accountState,
-      fetchAccount: mockFetchAccount,
+      fetchAccountAndWebsite: mockFetchAccountAndWebsite,
     });
 
-    expect(mockFetchAccount).toBeCalledTimes(1);
+    expect(mockFetchAccountAndWebsite).toBeCalledTimes(1);
   });
 
   it('Should not fetch account when there JWT is not supplied', async () => {
-    const mockFetchAccount = jest.fn();
+    const mockFetchAccountAndWebsite = jest.fn();
 
     await fetchData({
       state: {
         options: {}
       },
-      fetchAccount: mockFetchAccount,
+      fetchAccountAndWebsite: mockFetchAccountAndWebsite,
     });
 
-    expect(mockFetchAccount).toBeCalledTimes(0);
+    expect(mockFetchAccountAndWebsite).toBeCalledTimes(0);
   });
 });
 

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

@@ -7,6 +7,8 @@ export const defaults = {
   theme: {
     labels: 'stacked'
   },
+  addons: [],
+  bumpOffers: [],
   paymentInstruments: {
     address: {
       name: 'default',
@@ -136,6 +138,7 @@ export default ({
   // Add optional key's
   [
     'items',
+    'bumpOffers',
     'money',
     'invoiceId',
     'transactionId',
@@ -147,5 +150,12 @@ export default ({
     }
   });
 
+  // only add "addons" if items are available
+  if (combinedOptions.items) {
+    if (options.addons) {
+      combinedOptions.addons = options.addons;
+    }
+  }
+
   return combinedOptions;
 }

package/src/functions/purchase.js

@@ -74,6 +74,14 @@ export async function makePurchase({ state, payload }) {
     data.couponIds = state.data.couponIds
   }
 
+  if (state.options.addons && state.data.addons && Array.isArray(state.data.addons)) {
+    state.options.addons.forEach(addon => {
+      if (state.data.addons.includes(addon.planId)) {
+        data.items.push(addon);
+      }
+    })
+  }
+
   const { fields } = await postPurchase({
     state,
     data

package/src/storefront/account-and-website.js

@@ -0,0 +1,15 @@
+import AccountModel from './models/account-model';
+import WebsiteModel from './models/website-model';
+import { Endpoint } from './index';
+
+export async function fetchAccountAndWebsite({ state = null }) {
+  return Endpoint({state}, async () => {
+    state.storefront.setSessionToken(state.options.jwt);
+    const {fields} = await state.storefront.account.get({expand: 'website'});
+
+    return {
+      website: new WebsiteModel(fields._embedded?.website),
+      account: new AccountModel(fields),
+    }
+  });
+}

package/src/storefront/account-and-website.spec.js

@@ -0,0 +1,73 @@
+import { StorefontTestingInstance } from 'tests/mocks/storefront-mock';
+import { ok, get } from 'msw-when-then';
+import { when } from 'tests/msw/server';
+import { storefrontURL } from 'tests/mocks/storefront-api-mock';
+import { fetchAccountAndWebsite } from './account-and-website';
+import AccountModel, { AddressModel } from './models/account-model';
+import WebsiteModel from './models/website-model';
+
+describe('Storefront API Account', () => {
+  it('should handle fetch a customer with a null primary address', async () => {
+    const options = {
+      jwt: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzYjBkNTRkOS0xNmM4LTRlZDAtYjljMy01ODAyZmQ4YzE2ZTIiLCJleHAiOjE2ODY2OTc0MTQuODQxMjUsImlhdCI6MTY1NTE2MTQxNC44Nzk4OTEsImFjbCI6W3sic2NvcGUiOnsib3JnYW5pemF0aW9uSWQiOlsiMzY0NEFGTEFKMUciXSwicGF5bWVudE1ldGhvZHMiOlsicGF5bWVudC1jYXJkIl19LCJwZXJtaXNzaW9ucyI6WzI4NCwyODYsNDE0LDQxNSw0MzQsNDExLDQxMiw0MTMsNDI0LDQyNSw0MjYsNDI3LDQyOCw0MjksNDA5LDQxMCw0MDEsNDAyLDQzMyw0ODgsNDg3XX1dLCJjbGFpbXMiOnsid2Vic2l0ZUlkIjoiZGVtby13ZWJzaXRlIiwidHJhbnNhY3Rpb25JZCI6IjRiZDE3N2NmLTFlY2EtNDA2Yy04OWI0LTEzYzMzODk5NzlmMCIsInBheW1lbnRNZXRob2RzIjpbInBheW1lbnQtY2FyZCJdfSwibWVyY2hhbnQiOiIzNjQ0QUZMQUoxRyIsImN1c3RvbWVyIjp7ImlkIjoidGVzdC1jdXN0b21lci1pZCIsIm5hbWUiOiJUZXN0IEN1c3RvbWVyIE5hbWUiLCJjcmVhdGVkVGltZSI6IjIwMjItMDctMTRUMDA6MDA6MDArMDA6MDAifX0.VPue9QBhRGe3vvncaD47w84N8Bv2hEeShUl6SlNqoOQ',
+      items: [
+        {
+          planId: 'test-plan-id',
+          quantity: 1
+        }
+      ]
+    };
+
+    when(get(`${storefrontURL}/acount`)).thenReturn(
+      ok({
+        defaultPaymentInstrument: null,
+        id: "test-customer-id",
+        primaryAddress: null,
+        websiteId: "test-website-id",
+      })
+    );
+
+    const instance = StorefontTestingInstance({
+      options
+    });
+
+    jest.spyOn(instance.storefront.account, 'get');
+
+    const response = await fetchAccountAndWebsite({ state: instance });
+    expect(response.account.address).toEqual(new AddressModel({}));
+  })
+
+  it('should return an object with account and website', async () => {
+    const options = {
+      jwt: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzYjBkNTRkOS0xNmM4LTRlZDAtYjljMy01ODAyZmQ4YzE2ZTIiLCJleHAiOjE2ODY2OTc0MTQuODQxMjUsImlhdCI6MTY1NTE2MTQxNC44Nzk4OTEsImFjbCI6W3sic2NvcGUiOnsib3JnYW5pemF0aW9uSWQiOlsiMzY0NEFGTEFKMUciXSwicGF5bWVudE1ldGhvZHMiOlsicGF5bWVudC1jYXJkIl19LCJwZXJtaXNzaW9ucyI6WzI4NCwyODYsNDE0LDQxNSw0MzQsNDExLDQxMiw0MTMsNDI0LDQyNSw0MjYsNDI3LDQyOCw0MjksNDA5LDQxMCw0MDEsNDAyLDQzMyw0ODgsNDg3XX1dLCJjbGFpbXMiOnsid2Vic2l0ZUlkIjoiZGVtby13ZWJzaXRlIiwidHJhbnNhY3Rpb25JZCI6IjRiZDE3N2NmLTFlY2EtNDA2Yy04OWI0LTEzYzMzODk5NzlmMCIsInBheW1lbnRNZXRob2RzIjpbInBheW1lbnQtY2FyZCJdfSwibWVyY2hhbnQiOiIzNjQ0QUZMQUoxRyIsImN1c3RvbWVyIjp7ImlkIjoidGVzdC1jdXN0b21lci1pZCIsIm5hbWUiOiJUZXN0IEN1c3RvbWVyIE5hbWUiLCJjcmVhdGVkVGltZSI6IjIwMjItMDctMTRUMDA6MDA6MDArMDA6MDAifX0.VPue9QBhRGe3vvncaD47w84N8Bv2hEeShUl6SlNqoOQ',
+      items: [
+        {
+          planId: 'test-plan-id',
+          quantity: 1
+        }
+      ]
+    };
+
+    when(get(`${storefrontURL}/acount`)).thenReturn(
+      ok({
+        defaultPaymentInstrument: null,
+        id: "test-customer-id",
+        primaryAddress: null,
+        websiteId: "test-website-id",
+        _embedded: {
+          website: {},
+        }
+      })
+    );
+
+    const instance = StorefontTestingInstance({
+      options
+    });
+
+    jest.spyOn(instance.storefront.account, 'get');
+
+    const response = await fetchAccountAndWebsite({ state: instance });
+    expect(response.account instanceof(AccountModel)).toBe(true);
+    expect(response.website instanceof(WebsiteModel)).toBe(true);
+  })
+});

package/src/storefront/fetch-plans-from-addons-bumpOffers.js

@@ -0,0 +1,27 @@
+import PlanModel from './models/plan-model';
+import { Endpoint } from './index';
+
+export async function fetchPlansFromAddonsBumpOffers({ state = {} }) {
+  return Endpoint({state}, async () => {
+    let ids = [];
+
+    if (state.options?.addons) {
+      ids = ids.concat(state.options.addons
+        .map((item) => item.planId));
+    }
+
+    if (state.options?.bumpOffers) {
+      ids = ids.concat(state.options.bumpOffers
+        .map((item) => item.planId));
+    }
+
+    if (ids.length > 0) {
+      const { items: planItems } = await state.storefront.plans.getAll({
+        filter: `id:${ids.join(',')}`
+      });
+      return planItems.map(({fields}) => new PlanModel(fields).toPayload());
+    }
+
+    return [];
+  });
+}

package/src/storefront/fetch-products-from-plans.js

@@ -15,9 +15,20 @@ export async function fetchProductsFromPlans({ state = {} }) {
     };
 
     if (lineItems.length) {
-      filterByPlanId.filter = `id:${lineItems
-        .map((item) => item.planId)
-        .join(',')}`;
+      let ids = lineItems
+        .map((item) => item.planId);
+
+      if (state.options?.addons) {
+        ids = ids.concat(state.options.addons
+          .map((item) => item.planId));
+      }
+
+      if (state.options?.bumpOffers) {
+        ids = ids.concat(state.options.bumpOffers
+          .map((item) => item.planId));
+      }
+
+      filterByPlanId.filter = `id:${[...new Set(ids)].join(',')}`;
     }
 
     // Only fetch plans if we have specific plans to fetch
@@ -28,7 +39,15 @@ export async function fetchProductsFromPlans({ state = {} }) {
           filterByPlanId
         );
 
-        return planItems.map(({ fields }) => new ProductModel(fields._embedded.product));
+        const products = []
+        planItems
+          .map(({ fields }) => new ProductModel(fields._embedded.product))
+          .forEach(product => {
+            if (products.every(item => item.id !== product.id)) {
+              products.push(product)
+            }
+        });
+        return products;
       } catch(e) {
         // Ignore and return empty items
       };

package/src/storefront/models/plan-model.js

@@ -1,3 +1,85 @@
 import BaseModel from './base-model';
 
-export default class PlanModel extends BaseModel {}
+export class PlanPricingBracketModel {
+  constructor ({
+    maxQuantity = null,
+    price = null
+  } = {}) {
+    this.maxQuantity = maxQuantity || Number.MAX_SAFE_INTEGER;
+    this.price = !Number.isNaN(parseFloat(price)) ? parseFloat(price) : null; 
+  }
+}
+
+export class PlanPricingModel {
+  static SimpleFormulas = {
+    fixedFee: 'fixed-fee',
+    flatRate: 'flat-rate'
+  };
+
+  static BracketFormulas = {
+    stairstep: 'stairstep',
+    tiered: 'tiered',
+    volume: 'volume'
+  };
+
+  static Formulas = {
+    ...PlanPricingModel.SimpleFormulas,
+    ...PlanPricingModel.BracketFormulas
+  };
+
+  constructor ({
+    formula = PlanPricingModel.Formulas.fixedFee,
+    price = 0,
+    maxQuantity = null,
+    brackets = []
+  } = {}) {
+    this.formula = formula;
+
+    switch (this.formula) {
+      case PlanPricingModel.Formulas.stairstep:
+      case PlanPricingModel.Formulas.tiered:
+      case PlanPricingModel.Formulas.volume:
+        this.brackets = brackets.map(bracket => new PlanPricingBracketModel(bracket));
+        break;
+      case PlanPricingModel.Formulas.flatRate:
+        this.price = !Number.isNaN(parseFloat(price)) ? parseFloat(price) : null;
+        this.maxQuantity = maxQuantity;
+        break;
+      case PlanPricingModel.Formulas.fixedFee:
+      default:
+        this.price = !Number.isNaN(parseFloat(price)) ? parseFloat(price) : null;
+        break;
+    }
+  }
+
+  get isSimple() {
+    return Object.values(PlanPricingModel.SimpleFormulas).includes(this.formula);
+  }
+
+  get isBracket () {
+    return Object.values(PlanPricingModel.BracketFormulas).includes(this.formula);
+  }
+
+  toPayload() {
+    return {
+      ...this,
+      isSimple: this.isSimple,
+      isBracket: this.isBracket,
+    }
+  }
+}
+
+export default class PlanModel extends BaseModel {
+  constructor(fields = {}) {
+    super(fields);
+
+    this.pricing = new PlanPricingModel(fields.pricing || {});
+  }
+
+  toPayload() {
+    return {
+      ...this,
+      pricing: this.pricing.toPayload(),
+    }
+  }
+}

package/src/storefront/models/website-model.js

@@ -0,0 +1,3 @@
+import BaseModel from './base-model';
+
+export default class WebsiteModel extends BaseModel {}

package/src/storefront/summary.js

@@ -18,6 +18,10 @@ export async function fetchSummary({ data = null, state = null } = {}) {
         planId: item.planId,
         quantity: item.quantity,
       }));
+
+      if (state.data?.addons > 0) {
+        payload.data.items.concat(state.data.addons)
+      }
     }
 
     if (state.data?.amountAndCurrency) {

package/src/views/common/iframe/events/update-addons-handler.js

@@ -0,0 +1,21 @@
+export function updateAddonsHandler(iframe) {
+  iframe.component.on(`${iframe.name}-update-addons`, async ({addons, previewPurchase}) => {
+    const addonPlanIds = addons.map(addon => addon.planId);
+    iframe.state.data.addons = addonPlanIds;
+    iframe.state.data.previewPurchase = previewPurchase;
+    
+    iframe.state.data.previewPurchase.addonLineItems = iframe.state.data.previewPurchase.lineItems
+      .filter(item => addonPlanIds.includes(item.planId));
+    iframe.state.data.previewPurchase.lineItems = iframe.state.data.previewPurchase.lineItems
+      .filter(item => !addonPlanIds.includes(item.planId));
+
+    const updateModel = {
+      data: iframe.state.data.toPostmatesModel(),
+      options: iframe.state.options
+    }
+    if (iframe.state.iframeComponents.summary) {
+      iframe.state.iframeComponents.summary.component.call('update', updateModel);
+    }
+    iframe.state.iframeComponents.form.component.call('update', updateModel);
+  });
+}

package/src/views/common/iframe/view-iframe.js

@@ -3,6 +3,7 @@ import BaseIframe from './base-iframe';
 import { resizeComponentHandler } from './events/resize-component-handler';
 import { dispatchEventHandler } from './events/dispatch-event-handler';
 import { updateCouponsHandler } from './events/update-coupons-handler';
+import { updateAddonsHandler } from './events/update-addons-handler';
 import { showErrorHandler } from './events/show-error-handler';
 import { stopLoaderHandler } from './events/stop-loader-handler';
 
@@ -17,5 +18,6 @@ export class ViewIframe extends BaseIframe {
     stopLoaderHandler(this, { loader });
     showErrorHandler(this);
     updateCouponsHandler(this);
+    updateAddonsHandler(this);
   }
 }

package/src/storefront/account.js

@@ -1,11 +0,0 @@
-import AccountModel from './models/account-model';
-import { Endpoint } from './index';
-
-export async function fetchAccount({ state = null }) {
-  return Endpoint({state}, async () => {
-    state.storefront.setSessionToken(state.options.jwt);
-    const {fields} = await state.storefront.account.get();
-
-    return new AccountModel(fields);
-  });
-}

package/src/storefront/account.spec.js

@@ -1,39 +0,0 @@
-import { StorefontTestingInstance } from 'tests/mocks/storefront-mock';
-import { ok, get } from 'msw-when-then';
-import { when } from 'tests/msw/server';
-import { storefrontURL } from 'tests/mocks/storefront-api-mock';
-import { fetchAccount } from './account';
-import { AddressModel } from './models/account-model';
-
-describe('Storefront API Account', () => {
-  it('should handle fetch a customer with a null primary address', async () => {
-    const options = {
-      jwt: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzYjBkNTRkOS0xNmM4LTRlZDAtYjljMy01ODAyZmQ4YzE2ZTIiLCJleHAiOjE2ODY2OTc0MTQuODQxMjUsImlhdCI6MTY1NTE2MTQxNC44Nzk4OTEsImFjbCI6W3sic2NvcGUiOnsib3JnYW5pemF0aW9uSWQiOlsiMzY0NEFGTEFKMUciXSwicGF5bWVudE1ldGhvZHMiOlsicGF5bWVudC1jYXJkIl19LCJwZXJtaXNzaW9ucyI6WzI4NCwyODYsNDE0LDQxNSw0MzQsNDExLDQxMiw0MTMsNDI0LDQyNSw0MjYsNDI3LDQyOCw0MjksNDA5LDQxMCw0MDEsNDAyLDQzMyw0ODgsNDg3XX1dLCJjbGFpbXMiOnsid2Vic2l0ZUlkIjoiZGVtby13ZWJzaXRlIiwidHJhbnNhY3Rpb25JZCI6IjRiZDE3N2NmLTFlY2EtNDA2Yy04OWI0LTEzYzMzODk5NzlmMCIsInBheW1lbnRNZXRob2RzIjpbInBheW1lbnQtY2FyZCJdfSwibWVyY2hhbnQiOiIzNjQ0QUZMQUoxRyIsImN1c3RvbWVyIjp7ImlkIjoidGVzdC1jdXN0b21lci1pZCIsIm5hbWUiOiJUZXN0IEN1c3RvbWVyIE5hbWUiLCJjcmVhdGVkVGltZSI6IjIwMjItMDctMTRUMDA6MDA6MDArMDA6MDAifX0.VPue9QBhRGe3vvncaD47w84N8Bv2hEeShUl6SlNqoOQ',
-      websiteId: 'test-website-id',
-      items: [
-        {
-          planId: 'test-plan-id',
-          quantity: 1
-        }
-      ]
-    };
-
-    when(get(`${storefrontURL}/acount`)).thenReturn(
-      ok({
-        defaultPaymentInstrument: null,
-        id: "test-customer-id",
-        primaryAddress: null,
-        websiteId: "test-website-id",
-      })
-    );
-
-    const instance = StorefontTestingInstance({
-      options
-    });
-
-    jest.spyOn(instance.storefront.account, 'get');
-
-    const response = await fetchAccount({ state: instance });
-    expect(response.address).toEqual(new AddressModel({}));
-  })
-});