@zoxllc/shopify-checkout-extensions 0.0.8 → 0.1.0

package/package.json

@@ -1,12 +1,30 @@
 {
   "name": "@zoxllc/shopify-checkout-extensions",
-  "version": "0.0.8",
-  "description": "ZOX helper lib for shopify checkout extensions",
-  "main": "src/index.ts",
+  "version": "0.1.0",
+  "description": "Configuration-driven runtime engine for Shopify checkout extensions - campaigns, discounts, qualifiers, and selectors",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "EXAMPLES.md",
+    "INTEGRATION.md",
+    "CLAUDE.md"
+  ],
+  "keywords": [
+    "shopify",
+    "checkout",
+    "extensions",
+    "discounts",
+    "campaigns",
+    "functions"
+  ],
   "directories": {
     "test": "tests"
   },
   "scripts": {
+    "build": "rm -rf dist && tsc",
+    "prepublishOnly": "npm run build",
     "test": "vitest"
   },
   "repository": {
@@ -20,13 +38,14 @@
   },
   "homepage": "https://github.com/zoxllc/shopify-checkout-extensions#readme",
   "dependencies": {
-    "@shopify/app-bridge-types": "^0.0.7",
-    "@shopify/shopify_function": "0.1.0",
+    "@shopify/app-bridge-types": "^0.0.17",
+    "@shopify/shopify_function": "^1.0.5",
     "@types/lodash": "^4.14.202",
-    "javy": "0.1.1",
+    "javy": "^0.1.2",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "vitest": "^1.3.1"
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
   }
 }

package/migrate.ts

@@ -1,64 +0,0 @@
-ShippingDiscount.new(
-  :all,
-  CustomerTagQualifier.new(
-    :does,
-    :match,
-    ["new customer 35", "tier: Active Subscriber", "active_subscriber", "tier: Subscribers", "Active Subscriber"]
-  ),
-  AndSelector.new(
-    CartAmountQualifier.new(
-      :cart,
-      :greater_than,
-      50
-    ),
-    ReducedCartAmountQualifier.new(
-      :greater_than,
-      50
-    ),
-    nil
-  ),
-  :any,
-  nil,
-  RateNameSelector.new(
-    :does,
-    :include,
-    ["FedEx"]
-  ),
-  FixedDiscount.new(
-    10,
-    "ZOXPASS Discount"
-  )
-),
-ShippingDiscount.new(
-  :all,
-  nil,
-  CountryCodeQualifier.new(
-    :is_one,
-    ["US"]
-  ),
-  :any,
-  SubscriptionItemSelector.new(
-    :is
-  ),
-  nil,
-  FixedDiscount.new(
-    4,
-    ""
-  )
-),
-ShippingDiscount.new(
-  :all,
-  nil,
-  nil,
-  :any,
-  nil,
-  RateNameSelector.new(
-    :does,
-    :include,
-    ["Standard - Untracked"]
-  ),
-  FixedDiscount.new(
-    3,
-    ""
-  )
-)

package/src/common/AndSelector.ts

@@ -1,42 +0,0 @@
-import type { DiscountCart } from './DiscountCart';
-import type { Qualifier } from './Qualifier';
-import type { Selector } from './Selector';
-import type { CartLine } from '../lineItem/api';
-
-export class AndSelector {
-  is_a: 'AndSelector';
-  conditions: (Qualifier | Selector)[];
-
-  constructor(conditions: (Qualifier | Selector)[]) {
-    this.is_a = 'AndSelector';
-    this.conditions = conditions;
-  }
-
-  match(
-    subject: CartLine | DiscountCart,
-    selector?: Selector
-  ) {
-    try {
-      const conditionsResult = this.conditions
-        .map((condition) => {
-          if (selector) {
-            return (condition as Qualifier).match(
-              subject as DiscountCart,
-              selector
-            );
-          } else {
-            return (condition as Selector).match(
-              subject as CartLine
-            );
-          }
-        })
-        .filter((result) => result === true);
-
-      return (
-        conditionsResult.length == this.conditions.length
-      );
-    } catch (e) {
-      return false;
-    }
-  }
-}

package/src/common/Campaign.ts

@@ -1,70 +0,0 @@
-import type { AndSelector } from './AndSelector';
-import type { DiscountCart } from './DiscountCart';
-import type { OrSelector } from './OrSelector';
-import type { Selector } from './Selector';
-import {
-  type Qualifier,
-  QualifierBehavior,
-} from './Qualifier';
-
-interface CampaignInterface {
-  runWithHooks(cart: DiscountCart): DiscountCart;
-  beforeRun?(cart: DiscountCart): DiscountCart;
-  run?(cart: DiscountCart): DiscountCart;
-  afterRun(cart: DiscountCart): DiscountCart;
-}
-
-export class Campaign implements CampaignInterface {
-  behavior: QualifierBehavior;
-  qualifiers?:
-    | (AndSelector | OrSelector | Qualifier)[]
-    | null;
-  lineItemSelector?: Selector;
-  message?: string;
-
-  constructor(
-    behavior: QualifierBehavior,
-    qualifiers?:
-      | (AndSelector | OrSelector | Qualifier)[]
-      | null
-  ) {
-    this.behavior = behavior;
-    this.qualifiers = qualifiers;
-  }
-
-  qualifies(discountCart: DiscountCart): boolean {
-    if (this.qualifiers == undefined) return true;
-
-    const qualifierResults = this.qualifiers.map(
-      (qualifier) =>
-        qualifier.match(discountCart, this.lineItemSelector)
-    );
-
-    if (this.behavior == QualifierBehavior.ALL) {
-      return (
-        qualifierResults.filter((i) => i === false)
-          .length == 0
-      );
-    } else if (this.behavior == QualifierBehavior.ANY) {
-      return (
-        qualifierResults.filter((i) => i === true).length >
-        0
-      );
-    } else {
-      return true;
-    }
-  }
-
-  runWithHooks(cart: DiscountCart) {
-    this.run(cart);
-    return this.afterRun(cart);
-  }
-
-  run(cart: DiscountCart) {
-    return cart;
-  }
-
-  afterRun(cart: DiscountCart) {
-    return cart;
-  }
-}

package/src/common/CampaignConfiguration.ts

@@ -1,10 +0,0 @@
-export enum CampaignType {
-  ConditionalDiscount = "ConditionalDiscount",
-}
-
-export type CampaignConfiguration = {
-  priority: number;
-  campaignType: CampaignType;
-  name: string;
-  arguments: string;
-};

package/src/common/CampaignFactory.ts

@@ -1,233 +0,0 @@
-import { OrSelector } from './OrSelector';
-import type { Campaign } from './Campaign';
-import type { DiscountInterface } from './DiscountInterface';
-import type {
-  NumericalComparisonType,
-  Qualifier,
-  QualifierBehavior,
-  QualifierMatchType,
-  StringComparisonType,
-} from './Qualifier';
-import type { MatchType, Selector } from './Selector';
-import { AndSelector } from './AndSelector';
-import {
-  type CartAmountBehavior,
-  CartAmountQualifier,
-} from './CartAmountQualifier';
-import {
-  type CartQuantityBehavior,
-  CartQuantityQualifier,
-} from './CartQuantityQualifier';
-import { CustomerEmailQualifier } from './CustomerEmailQualifier';
-import { CustomerSubscriberQualifier } from './CustomerSubscriberQualifier';
-import { CustomerTagQualifier } from './CustomerTagQualifier';
-import { PostCartAmountQualifier } from './PostCartAmountQualifier';
-import { ProductIdSelector } from './ProductIdSelector';
-import { ProductTagSelector } from './ProductTagSelector';
-import { ProductTypeSelector } from './ProductTypeSelector';
-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 { CountryCodeQualifier } from './CountryCodeQualifier';
-import { RateNameSelector } from '../shipping/RateNameSelector';
-import { FixedDiscount } from '../shipping/FixedDiscount';
-import { ShippingDiscount } from '../shipping/ShippingDiscount';
-
-export type InputConfig = {
-  __type: string;
-  inputs: (
-    | boolean
-    | number
-    | string
-    | InputConfig
-    | boolean[]
-    | number[]
-    | string[]
-    | InputConfig[]
-  )[];
-};
-
-export class CampaignFactory {
-  static createFromConfig(config: InputConfig) {
-    return CampaignFactory.createInputsObject(
-      config
-    ) as Campaign;
-  }
-
-  private static parseInputConfig(
-    input:
-      | boolean
-      | number
-      | string
-      | InputConfig
-      | boolean[]
-      | number[]
-      | string[]
-      | InputConfig[]
-  ) {
-    if (
-      typeof input == 'string' ||
-      typeof input == 'number' ||
-      typeof input == 'boolean' ||
-      input === null
-    ) {
-      return input;
-    } else {
-      return CampaignFactory.createInputsObject(
-        input as InputConfig
-      );
-    }
-  }
-
-  static createInputsObject(
-    config: InputConfig
-  ):
-    | Campaign
-    | Qualifier
-    | AndSelector
-    | OrSelector
-    | Selector
-    | DiscountInterface
-    | undefined {
-    const args = config.inputs.map((input) => {
-      if (Array.isArray(input)) {
-        return input.map((i) =>
-          CampaignFactory.parseInputConfig(i)
-        );
-      } else {
-        return CampaignFactory.parseInputConfig(input);
-      }
-    });
-
-    switch (config.__type) {
-      case 'ConditionalDiscount':
-        return new ConditionalDiscount(
-          args[0] as QualifierBehavior,
-          args[1] as [AndSelector | OrSelector | Qualifier],
-          args[2] as DiscountInterface,
-          args[3] as Selector,
-          args[4] as number
-        );
-      case 'BuyXGetY':
-        return new BuyXGetY(
-          args[0] as QualifierBehavior,
-          args[1] as [AndSelector | OrSelector | Qualifier],
-          args[2] as DiscountInterface,
-          args[3] as Selector,
-          args[4] as Selector,
-          args[5] as number,
-          args[6] as number,
-          args[7] as number
-        );
-      case 'ShippingDiscount':
-        return new ShippingDiscount(
-          args[0] as QualifierBehavior,
-          args[1] as [AndSelector | OrSelector | Qualifier],
-          args[2] as DiscountInterface,
-          args[3] as Selector
-        );
-      case 'AndSelector':
-        return new AndSelector([...args] as (
-          | Selector
-          | Qualifier
-        )[]);
-      case 'OrSelector':
-        return new OrSelector([...args] as (
-          | Selector
-          | Qualifier
-        )[]);
-      case 'PostCartAmountQualifier':
-        return new PostCartAmountQualifier(
-          args[0] as NumericalComparisonType,
-          args[1] as number
-        );
-      case 'CartAmountQualifier':
-        return new CartAmountQualifier(
-          args[0] as CartAmountBehavior,
-          args[1] as NumericalComparisonType,
-          args[2] as number
-        );
-      case 'CartQuantityQualifier':
-        return new CartQuantityQualifier(
-          args[0] as CartQuantityBehavior,
-          args[1] as NumericalComparisonType,
-          args[2] as number
-        );
-      case 'CountryCodeQualifier':
-        return new CountryCodeQualifier(
-          args[0] as QualifierMatchType,
-          args[1] as string[]
-        );
-      case 'SaleItemSelector':
-        return new SaleItemSelector(
-          args[0] as SaleItemSelectorMatchType
-        );
-      case 'ProductIdSelector':
-        return new ProductIdSelector(
-          args[0] as MatchType.IS_ONE | MatchType.NOT_ONE,
-          args[1] as string[]
-        );
-      case 'ProductTypeSelector':
-        return new ProductTypeSelector(
-          args[0] as MatchType,
-          args[1] as string[]
-        );
-      case 'ProductTagSelector':
-        return new ProductTagSelector(
-          args[0] as QualifierMatchType,
-          args[1] as StringComparisonType,
-          args[2] as string[]
-        );
-      case 'PercentageDiscount':
-        return new PercentageDiscount(
-          args[0] as number,
-          args[1] as string
-        );
-      case 'FixedItemDiscount':
-        return new FixedItemDiscount(
-          args[0] as number,
-          args[1] as boolean,
-          args[2] as string
-        );
-      case 'FixedDiscount':
-        return new FixedDiscount(
-          args[0] as number,
-          args[1] as string
-        );
-      case 'SubscriptionItemSelector':
-        return new SubscriptionItemSelector(
-          args[0] as MatchType
-        );
-      case 'RateNameSelector':
-        return new RateNameSelector(
-          args[0] as MatchType.DOES | MatchType.DOES_NOT,
-          args[1] as StringComparisonType,
-          args[2] as string[]
-        );
-      case 'CustomerSubscriberQualifier':
-        return new CustomerSubscriberQualifier(
-          args[0] as QualifierMatchType
-        );
-      case 'CustomerEmailQualifier':
-        return new CustomerEmailQualifier(
-          args[0] as QualifierMatchType,
-          args[1] as StringComparisonType,
-          args[2] as string[]
-        );
-      case 'CustomerTagQualifier':
-        return new CustomerTagQualifier(
-          args[0] as QualifierMatchType,
-          args[1] as StringComparisonType,
-          args[2] as string[]
-        );
-    }
-  }
-}

package/src/common/CartAmountQualifier.ts

@@ -1,64 +0,0 @@
-import type { DiscountCart } from "./DiscountCart";
-import { type NumericalComparisonType, Qualifier } from "./Qualifier";
-import { type Selector } from "./Selector";
-
-export enum CartAmountBehavior {
-  CART = ":cart",
-  ITEM = ":item",
-  DIFF_CART = ":diff_cart",
-  DIFF_ITEM = ":diff_item",
-}
-
-export class CartAmountQualifier extends Qualifier {
-  behavior: CartAmountBehavior;
-  comparisonType: NumericalComparisonType;
-  amount: number;
-
-  constructor(
-    behavior: CartAmountBehavior,
-    comparisonType: NumericalComparisonType,
-    amount: number
-  ) {
-    super();
-    this.behavior = behavior;
-    this.comparisonType = comparisonType;
-    this.amount = amount;
-  }
-
-  /**
-   * Determines if the carts amount
-   * @param cart
-   * @param selector
-   */
-  match(discountCart: DiscountCart, selector?: Selector) {
-    let total =
-      parseFloat(discountCart.cart.cost.subtotalAmount.amount) -
-      discountCart.appliedDiscountTotal;
-
-    switch (this.behavior) {
-      case CartAmountBehavior.CART:
-      case CartAmountBehavior.ITEM:
-        return this.compareAmounts(total, this.comparisonType, this.amount);
-      case CartAmountBehavior.DIFF_CART:
-        return this.compareAmounts(
-          parseFloat(discountCart.cart.cost.subtotalAmount.amount) -
-            this.amount,
-          this.comparisonType,
-          total
-        );
-      case CartAmountBehavior.DIFF_ITEM:
-        const originalLineTotal = discountCart.cart.lines.reduce(
-          (runningTotal: number, line) => {
-            runningTotal += parseFloat(line.cost.subtotalAmount.amount);
-            return runningTotal;
-          },
-          total
-        );
-        return this.compareAmounts(
-          originalLineTotal - this.amount,
-          this.comparisonType,
-          total
-        );
-    }
-  }
-}

package/src/common/CartHasItemQualifier.ts

@@ -1,80 +0,0 @@
-import type { CartLine } from '../lineItem/api';
-import type { DiscountCart } from './DiscountCart';
-import {
-  type NumericalComparisonType,
-  Qualifier,
-} from './Qualifier';
-import { type Selector } from './Selector';
-
-export enum CartHasItemBehavior {
-  QUANTITY = ':quantity',
-  SUBTOTAL = ':subtotal',
-}
-
-export class CartHasItemQualifier extends Qualifier {
-  quantityOrSubtotal: CartHasItemBehavior;
-  comparisonType: NumericalComparisonType;
-  amount: number;
-  itemSelector: Selector;
-
-  constructor(
-    quantityOrSubtotal: CartHasItemBehavior,
-    comparisonType: NumericalComparisonType,
-    amount: number,
-    itemSelector: Selector
-  ) {
-    super();
-    this.quantityOrSubtotal = quantityOrSubtotal;
-    this.comparisonType = comparisonType;
-    this.amount =
-      this.quantityOrSubtotal ==
-      CartHasItemBehavior.SUBTOTAL
-        ? amount
-        : Math.floor(amount);
-    this.itemSelector = itemSelector;
-  }
-
-  /**
-   * Determines if the carts amount
-   * @param cart
-   * @param selector
-   */
-  match(discountCart: DiscountCart, selector?: Selector) {
-    let total = 0;
-
-    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
-        );
-        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
-        );
-        break;
-    }
-
-    return this.compareAmounts(
-      total,
-      this.comparisonType,
-      this.amount
-    );
-  }
-}