@zoxllc/shopify-checkout-extensions 0.0.1 → 0.0.3

package/package.json

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

package/src/common/AndSelector.ts

@@ -1,7 +1,7 @@
 import type { DiscountCart } from "./DiscountCart";
 import type { Qualifier } from "./Qualifier";
 import type { Selector } from "./Selector";
-import type { CartLine } from "extensions/zox-product-discount/generated/api";
+import type { CartLine } from '../generated/api';
 
 export class AndSelector {
   is_a: "AndSelector";

package/src/common/BuyXGetY.ts

@@ -1,11 +1,16 @@
 import { Campaign } from "./Campaign";
-import type { CartLine } from "../../../../extensions/zox-product-discount/generated/api";
-import type { AndSelector } from "./AndSelector";
-import type { DiscountCart } from "./DiscountCart";
-import type { ApplyDiscount, DiscountInterface } from "./DiscountInterface";
-import type { OrSelector } from "./OrSelector";
-import type { Qualifier, QualifierBehavior } from "./Qualifier";
-import type { Selector } from "./Selector";
+import type { AndSelector } from './AndSelector';
+import type { DiscountCart } from './DiscountCart';
+import type {
+  ApplyDiscount,
+  DiscountInterface,
+} from './DiscountInterface';
+import type { OrSelector } from './OrSelector';
+import type {
+  Qualifier,
+  QualifierBehavior,
+} from './Qualifier';
+import type { Selector } from './Selector';
 
 export class BuyXGetY extends Campaign {
   lineItemSelector?: Selector;
@@ -39,14 +44,19 @@ export class BuyXGetY extends Campaign {
       // Find the items that qualify for buyX
       let applicableBuyItems = discountCart.cart.lines;
       if (this.lineItemSelector) {
-        applicableBuyItems = discountCart.cart.lines.filter((lineItem) => {
-          return this.lineItemSelector?.match(lineItem as CartLine);
-        });
+        applicableBuyItems = discountCart.cart.lines.filter(
+          (lineItem) => {
+            // @ts-ignore
+            return this.lineItemSelector?.match(lineItem);
+          }
+        );
       }
 
       if (
-        applicableBuyItems.reduce((qty, item) => (qty += item.quantity), 0) <
-        this.buyX
+        applicableBuyItems.reduce(
+          (qty, item) => (qty += item.quantity),
+          0
+        ) < this.buyX
       ) {
         return discountCart;
       }
@@ -54,9 +64,12 @@ export class BuyXGetY extends Campaign {
       // Find the items that qualify for getX
       let eligibleGetItems = discountCart.cart.lines;
       if (this.getItemSelector) {
-        eligibleGetItems = discountCart.cart.lines.filter((lineItem) => {
-          return this.getItemSelector?.match(lineItem as CartLine);
-        });
+        eligibleGetItems = discountCart.cart.lines.filter(
+          (lineItem) => {
+            // @ts-ignore
+            return this.getItemSelector?.match(lineItem);
+          }
+        );
       }
 
       // Check if cart qualifies for discounts and limit the discount sets
@@ -65,13 +78,18 @@ export class BuyXGetY extends Campaign {
         0
       );
       const discountableSets = this.maxSets
-        ? [purchasedQuantity / this.buyX, this.maxSets].sort((a, b) => a - b)[0]
+        ? [
+            purchasedQuantity / this.buyX,
+            this.maxSets,
+          ].sort((a, b) => a - b)[0]
         : Math.floor(purchasedQuantity / this.buyX);
 
       if (discountableSets > 0) {
         let discountableQuantity =
           discountableSets *
-          (this.getY ? this.getY : discountCart.totalLineItemQuantity());
+          (this.getY
+            ? this.getY
+            : discountCart.totalLineItemQuantity());
 
         // Apply the discounts (sort to discount lower priced items first)
         eligibleGetItems = eligibleGetItems.sort(
@@ -86,7 +104,9 @@ export class BuyXGetY extends Campaign {
           }
 
           if (lineItem.quantity <= discountableQuantity) {
-            itemsToApplyDiscounts.push({ lineItem } as ApplyDiscount);
+            itemsToApplyDiscounts.push({
+              lineItem,
+            } as ApplyDiscount);
             discountableQuantity -= lineItem.quantity;
           } else {
             itemsToApplyDiscounts.push({
@@ -98,7 +118,9 @@ export class BuyXGetY extends Campaign {
         });
 
         if (itemsToApplyDiscounts.length) {
-          const discount = this.discount.apply(itemsToApplyDiscounts);
+          const discount = this.discount.apply(
+            itemsToApplyDiscounts
+          );
           discountCart.addDiscount(discount);
         }
       }

package/src/common/CartHasItemQualifier.ts

@@ -1,11 +1,14 @@
-import type { CartLine } from "extensions/zox-product-discount/generated/api";
-import type { DiscountCart } from "./DiscountCart";
-import { type NumericalComparisonType, Qualifier } from "./Qualifier";
-import { type Selector } from "./Selector";
+import type { CartLine } from '../generated/api';
+import type { DiscountCart } from './DiscountCart';
+import {
+  type NumericalComparisonType,
+  Qualifier,
+} from './Qualifier';
+import { type Selector } from './Selector';
 
 export enum CartHasItemBehavior {
-  QUANTITY = ":quantity",
-  SUBTOTAL = ":subtotal",
+  QUANTITY = ':quantity',
+  SUBTOTAL = ':subtotal',
 }
 
 export class CartHasItemQualifier extends Qualifier {
@@ -24,7 +27,8 @@ export class CartHasItemQualifier extends Qualifier {
     this.quantityOrSubtotal = quantityOrSubtotal;
     this.comparisonType = comparisonType;
     this.amount =
-      this.quantityOrSubtotal == CartHasItemBehavior.SUBTOTAL
+      this.quantityOrSubtotal ==
+      CartHasItemBehavior.SUBTOTAL
         ? amount
         : Math.floor(amount);
     this.itemSelector = itemSelector;
@@ -40,25 +44,37 @@ export class CartHasItemQualifier extends Qualifier {
 
     switch (this.quantityOrSubtotal) {
       case CartHasItemBehavior.QUANTITY:
-        total = discountCart.cart.lines.reduce((quantity, line) => {
-          return (
-            quantity +
-            (this.itemSelector.match(line as CartLine) ? line.quantity : 0)
-          );
-        }, 0);
+        total = discountCart.cart.lines.reduce(
+          (quantity, line) => {
+            return (
+              quantity +
+              (this.itemSelector.match(line as CartLine)
+                ? line.quantity
+                : 0)
+            );
+          },
+          0
+        );
         break;
       case CartHasItemBehavior.SUBTOTAL:
-        total = discountCart.cart.lines.reduce((amount, line) => {
-          return (
-            amount +
-            (this.itemSelector.match(line as CartLine)
-              ? line.cost.subtotalAmount.amount
-              : 0)
-          );
-        }, 0);
+        total = discountCart.cart.lines.reduce(
+          (amount, line) => {
+            return (
+              amount +
+              (this.itemSelector.match(line as CartLine)
+                ? line.cost.subtotalAmount.amount
+                : 0)
+            );
+          },
+          0
+        );
         break;
     }
 
-    return this.compareAmounts(total, this.comparisonType, this.amount);
+    return this.compareAmounts(
+      total,
+      this.comparisonType,
+      this.amount
+    );
   }
 }

package/src/common/CartQuantityQualifier.ts

@@ -1,13 +1,16 @@
-import type { CartLine } from "extensions/zox-product-discount/generated/api";
-import type { DiscountCart } from "./DiscountCart";
-import { type NumericalComparisonType, Qualifier } from "./Qualifier";
-import { type Selector } from "./Selector";
+import type { CartLine } from '../generated/api';
+import type { DiscountCart } from './DiscountCart';
+import {
+  type NumericalComparisonType,
+  Qualifier,
+} from './Qualifier';
+import { type Selector } from './Selector';
 
 export enum CartQuantityBehavior {
-  CART = ":cart",
-  ITEM = ":item",
-  LINE_ANY = ":line_any",
-  LINE_ALL = ":line_all",
+  CART = ':cart',
+  ITEM = ':item',
+  LINE_ANY = ':line_any',
+  LINE_ALL = ':line_all',
 }
 
 export class CartQuantityQualifier extends Qualifier {
@@ -36,17 +39,25 @@ export class CartQuantityQualifier extends Qualifier {
 
     switch (this.totalMethod) {
       case CartQuantityBehavior.ITEM:
-        total = discountCart.cart.lines.reduce((totalQty, line) => {
-          return (
-            totalQty +
-            ((selector ? selector.match(line as CartLine) : true)
-              ? line.quantity
-              : 0)
-          );
-        }, 0);
+        total = discountCart.cart.lines.reduce(
+          (totalQty, line) => {
+            return (
+              totalQty +
+              ((
+                selector
+                  ? selector.match(line as CartLine)
+                  : true
+              )
+                ? line.quantity
+                : 0)
+            );
+          },
+          0
+        );
         break;
       case CartQuantityBehavior.CART:
-        total = discountCart.totalLineItemQuantityExcludingGifts();
+        total =
+          discountCart.totalLineItemQuantityExcludingGifts();
         break;
     }
 
@@ -55,9 +66,15 @@ export class CartQuantityQualifier extends Qualifier {
       this.totalMethod == CartQuantityBehavior.LINE_ALL
     ) {
       const qualifiedItems = discountCart.cart.lines
-        .filter((line) => (selector ? selector.match(line as CartLine) : true))
+        .filter((line) =>
+          selector ? selector.match(line as CartLine) : true
+        )
         .map((line) =>
-          this.compareAmounts(line.quantity, this.comparisonType, this.quantity)
+          this.compareAmounts(
+            line.quantity,
+            this.comparisonType,
+            this.quantity
+          )
         );
 
       switch (this.totalMethod) {
@@ -67,7 +84,11 @@ export class CartQuantityQualifier extends Qualifier {
           return qualifiedItems.indexOf(false) == -1;
       }
     } else {
-      return this.compareAmounts(total, this.comparisonType, this.quantity);
+      return this.compareAmounts(
+        total,
+        this.comparisonType,
+        this.quantity
+      );
     }
   }
 }

package/src/common/DiscountCart.ts

@@ -1,7 +1,4 @@
-import type {
-  RunInput,
-  Discount,
-} from "extensions/zox-product-discount/generated/api";
+import type { RunInput, Discount } from '../generated/api';
 
 export class DiscountCart {
   cart: RunInput["cart"];

package/src/common/DiscountInterface.ts

@@ -1,7 +1,4 @@
-import type {
-  CartLine,
-  Discount,
-} from "extensions/zox-product-discount/generated/api";
+import type { CartLine, Discount } from '../generated/api';
 
 export type ApplyDiscount = {
   lineItem: CartLine;

package/src/common/OrSelector.ts

@@ -1,7 +1,7 @@
 import type { DiscountCart } from "./DiscountCart";
 import type { Qualifier } from "./Qualifier";
 import type { Selector } from "./Selector";
-import type { CartLine } from "extensions/zox-product-discount/generated/api";
+import type { CartLine } from '../generated/api';
 
 export class OrSelector {
   is_a: "OrSelector";

package/src/common/ProductHandleSelector.ts

@@ -1,7 +1,7 @@
 import type {
   CartLine,
   ProductVariant,
-} from "extensions/zox-product-discount/generated/api";
+} from '../generated/api';
 import { MatchType, Selector } from "./Selector";
 
 export class ProductHandleSelector extends Selector {

package/src/common/ProductIdSelector.ts

@@ -1,7 +1,7 @@
 import type {
   CartLine,
   ProductVariant,
-} from "extensions/zox-product-discount/generated/api";
+} from '../generated/api';
 import { MatchType, Selector } from "./Selector";
 
 export class ProductIdSelector extends Selector {

package/src/common/ProductTagSelector.ts

@@ -1,9 +1,12 @@
 import type {
   CartLine,
   ProductVariant,
-} from "extensions/zox-product-discount/generated/api";
-import { Selector } from "./Selector";
-import { QualifierMatchType, StringComparisonType } from "./Qualifier";
+} from '../generated/api';
+import { Selector } from './Selector';
+import {
+  QualifierMatchType,
+  StringComparisonType,
+} from './Qualifier';
 
 export class ProductTagSelector extends Selector {
   invert: boolean;
@@ -23,19 +26,24 @@ export class ProductTagSelector extends Selector {
 
   match(lineItem: CartLine) {
     const variant = lineItem.merchandise as ProductVariant;
-    const productTags = variant.product.hasTags.reduce((tags, t) => {
-      if (t.hasTag) {
-        tags.push(t.tag.toLowerCase());
-      }
-      return tags;
-    }, []);
+    const productTags = variant.product.hasTags.reduce(
+      (tags, t) => {
+        if (t.hasTag) {
+          tags.push(t.tag.toLowerCase());
+        }
+        return tags;
+      },
+      [] as string[]
+    );
 
     let matchResult: boolean;
 
     switch (this.matchCondition) {
       case StringComparisonType.MATCH:
         matchResult =
-          productTags.filter((tag) => this.tags.includes(tag)).length > 0;
+          productTags.filter((tag) =>
+            this.tags.includes(tag)
+          ).length > 0;
         break;
       default:
         matchResult = this.partialMatch(

package/src/common/ProductTypeSelector.ts

@@ -1,7 +1,7 @@
 import type {
   CartLine,
   ProductVariant,
-} from "extensions/zox-product-discount/generated/api";
+} from '../generated/api';
 import { MatchType, Selector } from "./Selector";
 
 export class ProductTypeSelector extends Selector {

package/src/common/Selector.ts

@@ -1,12 +1,12 @@
-import type { CartLine } from "extensions/zox-product-discount/generated/api";
-import { StringComparisonType } from "./Qualifier";
+import type { CartLine } from '../generated/api';
+import { StringComparisonType } from './Qualifier';
 
 export enum MatchType {
-  "ALL" = ":all",
-  "IS_ONE" = ":is_one",
-  "NOT_ONE" = ":not_one",
-  "DOES" = ":does",
-  "DOES_NOT" = ":does_not",
+  'ALL' = ':all',
+  'IS_ONE' = ':is_one',
+  'NOT_ONE' = ':not_one',
+  'DOES' = ':does',
+  'DOES_NOT' = ':does_not',
 }
 
 export class Selector {
@@ -30,19 +30,24 @@ export class Selector {
     possibleMatches: string[]
   ) {
     // Convert to an array if it isn't one
-    const subject = Array.isArray(itemInfo) ? itemInfo : [itemInfo];
+    const subject = Array.isArray(itemInfo)
+      ? itemInfo
+      : [itemInfo];
     let foundMatch = false;
     possibleMatches.forEach((possibility) => {
       subject.forEach((search) => {
         switch (matchType) {
           case StringComparisonType.CONTAINS:
-            if (search.search(possibility) > -1) foundMatch = true;
+            if (search.search(possibility) > -1)
+              foundMatch = true;
             break;
           case StringComparisonType.START_WITH:
-            if (search.startsWith(possibility)) foundMatch = true;
+            if (search.startsWith(possibility))
+              foundMatch = true;
             break;
           case StringComparisonType.END_WITH:
-            if (search.endsWith(possibility)) foundMatch = true;
+            if (search.endsWith(possibility))
+              foundMatch = true;
             break;
         }
       });

package/src/common/SubscriptionItemSelector.ts

@@ -1,5 +1,5 @@
-import type { CartLine } from "extensions/zox-product-discount/generated/api";
-import { MatchType, Selector } from "./Selector";
+import type { CartLine } from '../generated/api';
+import { MatchType, Selector } from './Selector';
 
 export class SubscriptionItemSelector extends Selector {
   invert: boolean;
@@ -10,7 +10,8 @@ export class SubscriptionItemSelector extends Selector {
   }
 
   match(lineItem: CartLine) {
-    const matchResult = lineItem.sellingPlanAllocation !== undefined;
+    const matchResult =
+      lineItem.sellingPlanAllocation !== undefined;
 
     if (this.invert) {
       return !matchResult;

package/src/index.ts

@@ -1,5 +1,4 @@
 export { ConditionalDiscount } from './lineItem/ConditionalDiscount';
-export { DiscountCodeList } from './lineItem/DiscountCodeList';
 export { FixedItemDiscount } from './lineItem/FixedItemDiscount';
 export { PercentageDiscount } from './lineItem/PercentageDiscount';
 export { AndSelector } from './common/AndSelector';

package/src/lineItem/DiscountCodeList.ts

@@ -1,91 +0,0 @@
-import type { DiscountCart } from '../common/DiscountCart';
-import type {
-  QualifierBehavior,
-  Qualifier,
-} from '../common/Qualifier';
-import type { Selector } from '../common/Selector';
-import { Campaign } from '../common/Campaign';
-import type { CartLine, Discount } from '../generated/api';
-import { AndSelector } from '~/common/AndSelector';
-import { OrSelector } from '~/common/OrSelector';
-
-export class DiscountCodeList extends Campaign {
-  discountList: string[];
-
-  constructor(
-    behavior: QualifierBehavior,
-    qualifiers: [Qualifier | AndSelector | OrSelector],
-    lineItemSelector?: Selector,
-    discountList?: string[]
-  ) {
-    super(behavior, qualifiers);
-    this.lineItemSelector = lineItemSelector;
-    this.discountList = discountList ? discountList : [];
-  }
-
-  run(discountCart: DiscountCart) {
-    // First we see if this cart qualifies for this discount
-    if (this.qualifies(discountCart)) {
-      // Now that it qualifies, we can determine the applicableLineItems
-      // to apply discounts to
-
-      // figure out applicable lineItems...
-      const applicableLineItems = discountCart.cart.lines
-        .filter((lineItem) => {
-          if (this.lineItemSelector === undefined) {
-            return true;
-          }
-          return this.lineItemSelector.match(
-            lineItem as CartLine
-          );
-        })
-        .sort((a, b) => {
-          const priceA = a.cost.amountPerQuantity
-            .amount as number;
-          const priceB = b.cost.amountPerQuantity
-            .amount as number;
-
-          if (priceA < priceB) return -1;
-          if (priceA == priceB) return 0;
-          return 1;
-        });
-
-      // Loop over the applicable line items and deduct the itemsToDiscount count
-      // as they are applied to not exceed a maximum.
-      applicableLineItems.forEach((lineItem) => {
-        // If there are no more items to discount, return/skip
-        if (this.itemsToDiscount === 0) return;
-
-        let discount: Discount;
-
-        // If items to discount is not undefined, apply as many as possible
-        if (this.itemsToDiscount !== undefined) {
-          // There are more than enough qty to apply, apply the maximum
-          if (lineItem.quantity >= this.itemsToDiscount) {
-            discount = this.discount.apply(
-              lineItem as CartLine,
-              this.itemsToDiscount
-            );
-            this.itemsToDiscount = 0;
-          } else {
-            discount = this.discount.apply(
-              lineItem as CartLine
-            );
-            this.itemsToDiscount -= lineItem.quantity;
-          }
-        } else {
-          // items to discount is undefined, so apply to entire item count
-          discount = this.discount.apply(
-            lineItem as CartLine
-          );
-        }
-
-        if (discount) {
-          // append the discount to the discountCart singleton
-          discountCart.addDiscount(discount);
-        }
-      });
-    }
-    return discountCart;
-  }
-}