@rebilly/instruments 4.5.0 → 4.7.0

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

@@ -3,313 +3,315 @@ 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
-      }
+    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,
+                },
+            }),
+        );
     });
 
-    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]
-        }),
-      },
+    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,
+                },
+            }),
+        );
     });
 
-    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: []
-        }),
-      }
+    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);
     });
 
-    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'
-      }
-    });
+    it('Should fetch account when JWT is supplied', async () => {
+        const mockFetchAccountAndWebsite = vi.fn();
+        StorefontTestingInstance({
+            options: {
+                jwt: 'TEST_JWT',
+            },
+        });
 
-    await fetchData({
-      fetchAccountAndWebsite: mockFetchAccountAndWebsite,
+        await fetchData({
+            fetchAccountAndWebsite: mockFetchAccountAndWebsite,
+        });
+
+        expect(mockFetchAccountAndWebsite).toBeCalledTimes(1);
     });
 
-    expect(mockFetchAccountAndWebsite).toBeCalledTimes(1);
-  });
+    it('Should not fetch account when there JWT is not supplied', async () => {
+        const mockFetchAccountAndWebsite = vi.fn();
+        StorefontTestingInstance({
+            options: {},
+        });
 
-  it ('Should not fetch account when there JWT is not supplied', async () => {
-    const mockFetchAccountAndWebsite = vi.fn();
-    StorefontTestingInstance({
-      options: {}
-    });
+        await fetchData({
+            fetchAccountAndWebsite: mockFetchAccountAndWebsite,
+        });
 
-    await fetchData({
-      fetchAccountAndWebsite: mockFetchAccountAndWebsite,
+        expect(mockFetchAccountAndWebsite).toBeCalledTimes(0);
     });
-
-    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();
+    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,
+                }),
+            );
+        });
     });
 
-    it ('invoice is truthy', () => {
-      StorefontTestingInstance();
-      const fetchedData = new DataInstance({
-        invoice: true
-      });
-      expect(fetchedData.isPayment).toBeTruthy();
+    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();
+        });
     });
 
-    it ('transaction is truthy', () => {
-      StorefontTestingInstance();
-      const fetchedData = new DataInstance({
-        transaction: true
-      });
-      expect(fetchedData.isPayment).toBeTruthy();
+    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 ('previewPurchase is falsy', () => {
-      StorefontTestingInstance();
-      const fetchedData = new DataInstance({
-        previewPurchase: true
-      });
-      expect(fetchedData.isPayment).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 ('empty is falsy', () => {
-      StorefontTestingInstance();
-      const fetchedData = new DataInstance({});
-      expect(fetchedData.isPayment).toBeFalsy();
+    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);
     });
-  });
-
-  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,15 +1,15 @@
 const collectedProperties = [
-  // Google UTM fields
-  'utm_source',
-  'utm_medium',
-  'utm_campaign',
-  'utm_term',
-  'utm_content',
-  // FramePay specific fields
-  'affiliate',
-  'subAffiliate',
-  'clickId',
-  'salesAgent'
+    // Google UTM fields
+    'utm_source',
+    'utm_medium',
+    'utm_campaign',
+    'utm_term',
+    'utm_content',
+    // FramePay specific fields
+    'affiliate',
+    'subAffiliate',
+    'clickId',
+    'salesAgent',
 ];
 const prefix = /utm_/g;
 
@@ -20,27 +20,27 @@ const prefix = /utm_/g;
  * @returns {Object} The lead source data object
  */
 export const getLeadSourceData = () => {
-  const { href, origin, pathname, search } = window.location;
+    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 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('?', '');
+    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);
+    // 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);
 };