Allow for addition of sales tax by zip code, Truck History Report form(s)

docker-compose.yml

@@ -177,6 +177,8 @@ services:
       PAYFABRIC_GATEWAY_NAME: ${PAYFABRIC_GATEWAY_NAME-EVO US_CC}
       PAYFABRIC_ENV: ${PAYFABRIC_ENV-SANDBOX}
       PAYFABRIC_PAYMENT_METHODS: ${PAYFABRIC_PAYMENT_METHODS-CreditCard}
+      AVATAX_API_HOST: ${AVATAX_API_HOST-https://sandbox-rest.avatax.com}
+      AVATAX_HASHED_CREDENTIALS: ${AVATAX_HASHED_CREDENTIALS}
       SENDGRID_API_KEY: ${SENDGRID_API_KEY}
       SENDGRID_DEV_TO: ${[email protected]}
       DEBUG: rigdig,payfabric,sendgrid
@@ -203,6 +205,8 @@ services:
       PAYFABRIC_GATEWAY_NAME: ${PAYFABRIC_GATEWAY_NAME-EVO US_CC}
       PAYFABRIC_ENV: ${PAYFABRIC_ENV-SANDBOX}
       PAYFABRIC_PAYMENT_METHODS: ${PAYFABRIC_PAYMENT_METHODS-CreditCard}
+      AVATAX_API_HOST: ${AVATAX_API_HOST-https://sandbox-rest.avatax.com}
+      AVATAX_HASHED_CREDENTIALS: ${AVATAX_HASHED_CREDENTIALS}
       SENDGRID_API_KEY: ${SENDGRID_API_KEY}
       SENDGRID_DEV_TO: ${[email protected]}
       DEBUG: rigdig,payfabric,sendgrid

packages/payfabric/src/client.js

@@ -99,12 +99,12 @@ module.exports = class ApiClient {
    * @param {IdentityXUserContext} args.user
    * @param {String} args.vin @todo memo/note?
    */
-  async createTransaction({ user, vin }) {
+  async createTransaction({ user, vin, amount }) {
     return this.request({
       endpoint: '/payment/api/transaction/create',
       body: JSON.stringify({
         // @todo additional details, customer reference?
-        Amount: 34.99,
+        Amount: amount,
         Currency: 'USD',
         Customer: user.id || user.email,
         SetupId: this.gatewayName,

packages/payfabric/src/env.js

@@ -6,4 +6,6 @@ module.exports = cleanEnv(process.env, {
   PAYFABRIC_GATEWAY_NAME: str({ desc: 'The name of the PayFabric Gateway to use.', default: 'EVO US_CC' }),
   PAYFABRIC_ENV: str({ desc: 'The Payfabric environment', choices: ['SANDBOX', 'LIVE'], default: 'SANDBOX' }),
   PAYFABRIC_PAYMENT_METHODS: str({ desc: 'A comma-separated list of enabled payment methods.', default: 'CreditCard,ApplePay,GooglePay' }),
+  AVATAX_API_HOST: str({ desc: 'The Avatax API host', default: 'https://sandbox-rest.avatax.com' }),
+  AVATAX_HASHED_CREDENTIALS: str({ desc: 'Base64 encoded credentials for the Avatax API' }),
 });

packages/payfabric/src/index.js

@@ -1,5 +1,7 @@
 const { asyncRoute } = require('@parameter1/base-cms-utils');
 const { json } = require('express');
+const pretaxAmount = require('./utils/pre-tax-amount');
+const calculateSalesTax = require('./utils/calculate-sales-tax');
 
 const PayFabricAPIClient = require('./client');
 const {
@@ -20,6 +22,8 @@ const createError = (message, code) => {
   return error;
 };
 
+const countryCodesRequireZip = new Set(['US', 'CA']);
+
 /**
  * @typedef ResponseContext
  * @prop {import('@parameter1/base-cms-marko-web-identity-x/service')} identityX
@@ -39,19 +43,34 @@ module.exports = (app) => {
   app.post('/__payfabric/create-transaction-token', json(), asyncRoute(async (req, res) => {
     try {
       const { body } = await req;
-      const { vin, email } = body;
+      const {
+        vin,
+        countryCode,
+        email,
+        zip: postalCode,
+      } = body;
       if (!vin) throw createError('You must provide a VIN to continue.', 400);
       if (!email) throw createError('You must provide an email address to continue.', 400);
+      if (!postalCode && countryCodesRequireZip.has(countryCode)) throw createError('You must provide a zip code to continue', 400);
 
       /** @type {ResponseContext} */
       const { identityX } = res.locals;
       /** @type {IdentityXContext} */
       const ctx = await identityX.loadActiveContext();
       const user = ctx.hasUser ? ctx.user : { email };
+      // Ensure a postalCode is provided even if existing user record doesn't have one
+      if (!user.postalCode && postalCode) user.postalCode = postalCode;
+      // Ensure a countryCode is provided even if existing user record doesn't have one
+      if (!user.countryCode && countryCode) user.countryCode = countryCode;
 
-      const { Key } = await client.createTransaction({ user, vin });
+      const salesTax = countryCodesRequireZip.has(user.countryCode) ? await calculateSalesTax({
+        postalCode,
+        pretaxAmount,
+      }) : 0;
+      const amount = Number((pretaxAmount + salesTax).toFixed(2));
+      const { Key } = await client.createTransaction({ user, vin, amount });
       const { Token } = await client.createJWT({ transactionId: Key });
-      res.json({ Token });
+      res.json({ Token, salesTax });
     } catch (error) {
       res.status(error.code || 500).json({ error: error.message });
     }

packages/payfabric/src/utils/calculate-sales-tax.js

@@ -0,0 +1,35 @@
+const fetch = require('node-fetch');
+const { AVATAX_API_HOST, AVATAX_HASHED_CREDENTIALS } = require('../env');
+
+module.exports = async ({ postalCode, pretaxAmount }) => {
+  const now = new Date();
+  const request = await fetch(`${AVATAX_API_HOST}/api/v2/transactions/create`, {
+    method: 'POST',
+    headers: {
+      'content-type': 'application-json',
+      Authorization: `Basic ${AVATAX_HASHED_CREDENTIALS}`,
+    },
+    body: JSON.stringify({
+      lines: [
+        {
+          quantity: 1,
+          amount: pretaxAmount,
+          // https://taxcode.avatax.avalara.com/search?q=DD040000
+          taxCode: 'DD040000',
+        },
+      ],
+      date: `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()}`,
+      customerCode: 'parameter1-website-customer',
+      addresses: {
+        singleLocation: {
+          postalCode,
+        },
+      },
+      currencyCode: 'USD',
+    }),
+  });
+  if (!request.ok) throw new Error('Bad fetch response, AvaTax');
+  const { totalTax } = await request.json();
+  // totalTax is the amount of tax applied for this transaction
+  return Number(totalTax);
+};

packages/payfabric/src/utils/pre-tax-amount.js

@@ -0,0 +1 @@
+module.exports = 34.95;

packages/rigdig/browser/checkout-header.vue

@@ -25,7 +25,23 @@
         1 Truck History Report
       </span>
       <strong>
-        $34.99
+        ${{ pretaxAmount }}
+      </strong>
+    </div>
+    <div v-if="salesTax" class="rigdig-modal__promo-footer">
+      <span>
+        Sales Tax
+      </span>
+      <strong>
+        ${{ salesTax }}
+      </strong>
+    </div>
+    <div v-if="salesTax" class="rigdig-modal__promo-footer">
+      <span>
+        <b>Total</b>
+      </span>
+      <strong>
+        ${{ total }}
       </strong>
     </div>
     <div v-if="email" class="rigdig-modal__teaser border">
@@ -52,6 +68,14 @@ export default {
       type: Number,
       default: 1,
     },
+    salesTax: {
+      type: Number,
+      default: null,
+    },
+    pretaxAmount: {
+      type: Number,
+      default: null,
+    },
     truckInfo: {
       type: String,
       required: true,
@@ -71,5 +95,11 @@ export default {
   },
 
   emits: ['back'],
+
+  computed: {
+    total() {
+      return (this.salesTax + this.pretaxAmount).toFixed(2);
+    },
+  },
 };
 </script>

packages/rigdig/browser/checkout-modal.vue

@@ -22,7 +22,7 @@
                   {{ vin }}
                 </dd>
                 <dd class="small">
-                  $34.99
+                  ${{ total }}
                 </dd>
               </dl>
             </div>
@@ -57,6 +57,8 @@
         </div>
         <div v-else-if="transactionId" class="rigdig-modal__content">
           <checkout-header
+            :sales-tax="salesTax"
+            :pretax-amount="pretaxAmount"
             :truck-info="truckInfo"
             :vin="vin"
             title="Sending Report!"
@@ -103,6 +105,8 @@
         </div>
         <div v-else class="rigdig-modal__content">
           <checkout-header
+            :sales-tax="salesTax"
+            :pretax-amount="pretaxAmount"
             :truck-info="truckInfo"
             :vin="vin"
             title="Report found!"
@@ -157,6 +161,38 @@
                     >
                   </template>
                 </label>
+                <country-code
+                  v-model="userCountryCode"
+                  class-name="rigdig-modal__form-group"
+                  :required="true"
+                  label="Country"
+                />
+                <label v-if="zipRequired" class="rigdig-modal__label">
+                  <template v-if="zip">
+                    <div class="rigdig-widget__label-text">
+                      Postal/Zip Code <strong class="text-danger">*</strong>
+                    </div>
+                    <input
+                      ref="zip"
+                      :value="zip"
+                      class="form-control rigdig-modal__zip"
+                      type="text"
+                      required
+                    >
+                  </template>
+                  <template v-else>
+                    <div class="rigdig-widget__label-text">
+                      Postal/Zip Code <strong class="text-danger">*</strong>
+                    </div>
+                    <input
+                      ref="zip"
+                      v-model="userZip"
+                      class="form-control rigdig-modal__zip"
+                      type="text"
+                      required
+                    >
+                  </template>
+                </label>
               </div>
 
               <div class="rigdig-modal__buttons">
@@ -183,7 +219,8 @@
             </form>
             <alert-error v-if="error" :show-help="false" title="Unable to start checkout.">
               <p>
-                The email address you supplied is invalid.  Please verify and try again or
+                The email address or zip code you supplied is invalid.
+                Please verify and try again or
                 <a :href="`mailto:${supportEmail}`">contact us</a>.
               </p>
             </alert-error>
@@ -208,6 +245,7 @@
 <script>
 import IconX from '@parameter1/base-cms-marko-web-icons/browser/x.vue';
 import IconCheckCircle from '@parameter1/base-cms-marko-web-icons/browser/check-circle.vue';
+import CountryCode from '@parameter1/base-cms-marko-web-identity-x/browser/form/fields/country.vue';
 import AlertError from './alert-error.vue';
 import CheckoutHeader from './checkout-header.vue';
 
@@ -217,15 +255,24 @@ export default {
   components: {
     AlertError,
     CheckoutHeader,
+    CountryCode,
     IconX,
     IconCheckCircle,
   },
 
   props: {
+    countryCode: {
+      type: String,
+      default: null,
+    },
     email: {
       type: String,
       default: null,
     },
+    zip: {
+      type: String,
+      default: null,
+    },
     buttonLabel: {
       type: String,
       default: 'Start checkout',
@@ -249,6 +296,10 @@ export default {
       type: Array,
       default: () => ['CreditCard', 'ApplePay'],
     },
+    pretaxAmount: {
+      type: Number,
+      default: null,
+    },
     debug: {
       type: Boolean,
       default: false,
@@ -262,10 +313,13 @@ export default {
   emits: ['cancel', 'purchase', 'error', 'generate'],
 
   data: () => ({
+    userCountryCode: 'US',
     userEmail: null,
+    userZip: null,
     error: null,
     loading: false,
     complete: false,
+    salesTax: null,
     transactionToken: null,
     transactionId: null,
     client: null,
@@ -276,12 +330,24 @@ export default {
     title() {
       return this.complete ? 'Payment Received!' : 'Report Found!';
     },
+    total() {
+      return (this.salesTax + this.pretaxAmount).toFixed(2);
+    },
+    zipRequired() {
+      return new Set(['US', 'CA']).has(this.userCountryCode);
+    },
   },
 
   created() {
     if (this.email) {
       this.userEmail = this.email;
     }
+    if (this.zip) {
+      this.userZip = this.zip;
+    }
+    if (this.countryCode) {
+      this.userCountryCode = this.countryCode;
+    }
   },
 
   methods: {
@@ -326,7 +392,9 @@ export default {
         headers: { 'content-type': 'application/json; charset=utf-8' },
         body: JSON.stringify({
           vin: this.vin,
+          countryCode: this.userCountryCode,
           email: this.userEmail,
+          zip: this.userZip,
         }),
       });
       if (!response.ok) {
@@ -341,7 +409,8 @@ export default {
         error.code = response.status;
         throw error;
       }
-      const { Token } = await response.json();
+      const { Token, salesTax } = await response.json();
+      this.salesTax = salesTax;
       return Token;
     },