@zoxllc/shopify-checkout-extensions 0.0.5 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoxllc/shopify-checkout-extensions",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "ZOX helper lib for shopify checkout extensions",
   "main": "src/index.ts",
   "directories": {

package/src/common/CampaignFactory.ts

@@ -9,11 +9,7 @@ import type {
   StringComparisonType,
 } from './Qualifier';
 import type { MatchType, Selector } from './Selector';
-import { ConditionalDiscount } from '../lineItem/ConditionalDiscount';
-import { FixedItemDiscount } from '../lineItem/FixedItemDiscount';
-import { PercentageDiscount } from '../lineItem/PercentageDiscount';
 import { AndSelector } from './AndSelector';
-import { BuyXGetY } from '../lineItem/BuyXGetY';
 import {
   type CartAmountBehavior,
   CartAmountQualifier,
@@ -33,11 +29,17 @@ import {
   SaleItemSelector,
   type SaleItemSelectorMatchType,
 } from './SaleItemSelector';
+
+import { ConditionalDiscount } from '../lineItem/ConditionalDiscount';
+import { FixedItemDiscount } from '../lineItem/FixedItemDiscount';
+import { PercentageDiscount } from '../lineItem/PercentageDiscount';
+import { BuyXGetY } from '../lineItem/BuyXGetY';
+
 import { SubscriptionItemSelector } from './SubscriptionItemSelector';
-import { RateNameSelector } from '~/shipping/RateNameSelector';
-import { FixedDiscount } from '~/shipping/FixedDiscount';
-import { ShippingDiscount } from '~/shipping/ShippingDiscount';
 import { CountryCodeQualifier } from './CountryCodeQualifier';
+import { RateNameSelector } from '../shipping/RateNameSelector';
+import { FixedDiscount } from '../shipping/FixedDiscount';
+import { ShippingDiscount } from '../shipping/ShippingDiscount';
 
 export type InputConfig = {
   __type: string;

package/src/common/DiscountCart.ts

@@ -1,5 +1,11 @@
-import type { RunInput as LineItemRunInput } from '../lineItem/api';
-import type { RunInput as ShippingRunInput } from '../shipping/api';
+import type {
+  RunInput as LineItemRunInput,
+  Discount as DiscountItem,
+} from '../lineItem/api';
+import type {
+  RunInput as ShippingRunInput,
+  Discount as DiscountShipping,
+} from '../shipping/api';
 import { Discount } from './DiscountInterface';
 
 type RunInput = {
@@ -80,7 +86,11 @@ export class DiscountCart {
     this.discounts = [];
   }
 
-  addDiscount(discount: Discount) {
+  addShippingDiscount(discount: DiscountShipping) {
+    this.discounts.push(discount as Discount);
+  }
+
+  addDiscount(discount: DiscountItem) {
     // Figure out how much discount has been applied
     const totalDiscounts = discount.targets.reduce(
       (total, target) => {
@@ -103,10 +113,7 @@ export class DiscountCart {
             line.cost.amountPerQuantity.amount
           );
 
-          // TODO: Make sure we're not discounting more items than are available on the line item quantity
-
-          // When it's a fixed amount, calculate the items per but only if it applies to each
-          // individual item...
+          // When it's a fixed amount, calculate the items per but only if it applies to each individual item...
           if (discount.value.fixedAmount) {
             if (
               discount.value.fixedAmount.appliesToEachItem
@@ -145,7 +152,7 @@ export class DiscountCart {
       this.appliedDiscountTotal
     );
 
-    this.discounts.push(discount);
+    this.discounts.push(discount as Discount);
   }
 
   reset() {

package/src/common/DiscountInterface.ts

@@ -3,10 +3,11 @@ import type {
   CartLine,
 } from '../lineItem/api';
 
-import type { Discount as ItemDiscount } from '../lineItem/api';
-import type { Discount as ShippingDiscount } from '~/shipping/api';
+import type { Discount as DiscountItem } from '../lineItem/api';
+import type { Discount as DiscountShipping } from '../shipping/api';
+
+export type Discount = DiscountItem & DiscountShipping;
 
-export type Discount = ItemDiscount & ShippingDiscount;
 
 type ApplyLineItemDiscount = {
   lineItem: CartLine;

package/src/common/Selector.ts

@@ -1,4 +1,4 @@
-import type { CartDeliveryOption } from '~/shipping/api';
+import type { CartDeliveryOption } from '../shipping/api';
 import type { CartLine } from '../lineItem/api';
 import { StringComparisonType } from './Qualifier';
 

package/src/shipping/ShippingDiscount.ts

@@ -67,7 +67,7 @@ export class ShippingDiscount extends Campaign {
         const discount = this.discount.apply(
           applicableDiscounts
         );
-        discountCart.addDiscount(discount);
+        discountCart.addShippingDiscount(discount);
       }
     }
     return discountCart;

package/tests/RateNameSelector.test.ts

@@ -33,7 +33,7 @@ describe('RateNameSelector', () => {
     const selector = new RateNameSelector(
       MatchType.DOES,
       StringComparisonType.CONTAINS,
-      ['edex']
+      ['FedEx']
     );
     const result = selector.match(cartDeliveryOption);
     expect(result).toEqual(true);
@@ -102,6 +102,6 @@ describe('RateNameSelector', () => {
   const cartDeliveryOption = {
     deliveryMethodType: DeliveryMethod.Shipping,
     handle: 'test-handle',
-    title: 'Fedex - 10% Shipping',
+    title: 'FedEx - 10% Shipping',
   } as CartDeliveryOption;
 });

package/tests/ShippingDiscount.test.ts

@@ -0,0 +1,147 @@
+import { describe, it, expect } from 'vitest';
+import _ from 'lodash';
+import {
+  DeliveryMethod,
+  Discount,
+  RunInput,
+} from '../src/shipping/api';
+import { ShippingDiscount } from '../src/shipping/ShippingDiscount';
+import { MatchType } from '../src/common/Selector';
+import {
+  NumericalComparisonType,
+  QualifierBehavior,
+  StringComparisonType,
+} from '../src/common/Qualifier';
+import {
+  CartAmountQualifier,
+  CartAmountBehavior,
+} from '../src/common/CartAmountQualifier';
+import { FixedDiscount } from '../src/shipping/FixedDiscount';
+import { RateNameSelector } from '../src/shipping/RateNameSelector';
+import { DiscountCart } from '../src/common/DiscountCart';
+
+describe('ShippingDiscount', () => {
+  it('is true when it matches one of', () => {
+    const campaign = new ShippingDiscount(
+      QualifierBehavior.ALL,
+      [
+        new CartAmountQualifier(
+          CartAmountBehavior.CART,
+          NumericalComparisonType.GREATER_THAN_OR_EQUAL,
+          50
+        ),
+      ],
+      new FixedDiscount(10, 'ZOXPASS Discount'),
+      new RateNameSelector(
+        MatchType.DOES,
+        StringComparisonType.CONTAINS,
+        ['FedEx']
+      )
+    );
+
+    // @ts-ignore
+    const discountCart = new DiscountCart(runInput.cart);
+    campaign.run(discountCart);
+
+    const expectedResult: Discount[] = [
+      {
+        message: 'ZOXPASS Discount',
+        targets: [
+          {
+            deliveryOption: {
+              handle: 'test-handle',
+            },
+          },
+        ],
+        value: {
+          fixedAmount: {
+            amount: 10,
+          },
+        },
+      },
+    ];
+
+    expect(discountCart.discounts).toEqual(expectedResult);
+  });
+
+  const runInput = {
+    cart: {
+      buyerIdentity: {
+        customer: {
+          email: 'sebi@zox.la',
+          isActiveSubscriber: false,
+          hasTags: [
+            {
+              tag: 'Active product subscription',
+              hasTag: true,
+            },
+          ],
+        },
+      },
+      cost: {
+        amountPerQuantity: {
+          amount: '8.0',
+        },
+        subtotalAmount: {
+          amount: '64.0',
+        },
+        totalAmount: {
+          amount: '64.0',
+        },
+        compareAtAmountPerQuantity: null,
+      },
+      lines: [
+        {
+          cost: {
+            amountPerQuantity: {
+              amount: '8.0',
+            },
+            subtotalAmount: {
+              amount: '64.0',
+            },
+            totalAmount: {
+              amount: '64.0',
+            },
+            compareAtAmountPerQuantity: null,
+          },
+          quantity: 8,
+          merchandise: {
+            __typename: 'ProductVariant',
+            id: 'gid://shopify/ProductVariant/12345',
+            product: {
+              id: 'gid://shopify/Product/67890',
+              productType: 'Wristband - Single',
+              hasTags: [
+                {
+                  tag: 'meta-exclude-gift',
+                  hasTag: false,
+                },
+                {
+                  tag: 'mystery-3-pack',
+                  hasTag: true,
+                },
+              ],
+            },
+          },
+        },
+      ],
+      deliveryGroups: [
+        {
+          deliveryOptions: [
+            {
+              deliveryMethodType: DeliveryMethod.Shipping,
+              handle: 'test-handle',
+              title: 'FedEx - 10% Shipping',
+            },
+          ],
+        },
+      ],
+    },
+    discountNode: {
+      metafield: {
+        value:
+          '{"campaigns":[{"__type":"ShippingDiscount","inputs":[":all",[{"__type":"CartAmountQualifier","inputs":[":cart",":greater_than_or_equal",50]}],{"__type":"FixedDiscount","inputs":[10,"ZOXPASS Discount"]},{"__type":"RateNameSelector","inputs":[":does",":contains",["FedEx"]]}]}]}',
+      },
+    },
+  } as unknown;
+});