@classytic/loyalty 0.4.0 → 0.6.0

package/dist/{index-YSsi4e_G.d.mts → index-Cp_sXNpG.d.mts}

@@ -1,9 +1,14 @@
-import { a as RuleStatus, n as MemberStatus, o as RuleType, s as TransactionType } from "./index-DMK8a98J.mjs";
+import { a as RuleStatus, n as MemberStatus, o as RuleType, s as TransactionType } from "./index-D_Oe3aDk.mjs";
+import "./config-CtkGj3xZ.mjs";
 import { OperationContext } from "@classytic/primitives/context";
 import { ApprovalChain } from "@classytic/primitives/approval";
-
 //#region src/domain/entities/earning-rule.d.ts
 interface EarningConditions {
+  /**
+   * Minimum order total for the rule to apply — **integer minor units** of the
+   * host's ambient currency (paisa for BDT). `10000` = ৳100. Compared against
+   * `evaluateOrder`'s `orderTotal` (also minor units).
+   */
   minOrderAmount?: number;
   categories?: string[];
   tiers?: string[];
@@ -12,7 +17,7 @@ interface EarningConditions {
    * Days the rule applies, JS `getDay()` convention: 0=Sun … 6=Sat. Empty /
    * omitted = every day. Evaluated against the wall-clock weekday in the
    * engine's configured `timezone` (UTC when unset), never the server's local
-   * clock. See `LoyaltyConfig.timezone`.
+   * clock. See `LoyaltyShape.timezone`.
    */
   dayOfWeek?: number[];
   dateRange?: {
@@ -21,7 +26,24 @@ interface EarningConditions {
   };
 }
 interface EarningReward {
+  /**
+   * Points awarded per `rateBasis` minor units of spend:
+   * `points = pointsPerAmount × (orderTotalMinor / rateBasis)` (rounded once
+   * per `roundingMode`). REQUIRES `rateBasis` — there is no implicit
+   * "per 1 major unit" basis anymore (that ambiguity was the bug).
+   * "5 points per ৳100" = `{ pointsPerAmount: 5, rateBasis: 10000 }`.
+   */
   pointsPerAmount?: number;
+  /**
+   * RATE: the explicit integer minor-unit basis `pointsPerAmount` is quoted
+   * against (≥ 1). Required whenever `pointsPerAmount` is set.
+   */
+  rateBasis?: number;
+  /**
+   * RATE: integer minor units of spend per single point (≥ 1).
+   * `points = orderTotalMinor / amountPerPoint` (rounded per `roundingMode`).
+   * "1 point per ৳100" = `amountPerPoint: 10000`.
+   */
   amountPerPoint?: number;
   fixedPoints?: number;
   multiplier?: number;
@@ -48,6 +70,11 @@ interface EarningRule {
 //#region src/domain/entities/tier-definition.d.ts
 interface TierQualification {
   minLifetimePoints?: number;
+  /**
+   * Minimum lifetime spend — **integer minor units** (paisa for BDT).
+   * Declared for host-side qualification logic only: the in-package tier
+   * evaluation checks lifetime POINTS exclusively and never reads this field.
+   */
   minLifetimeSpend?: number;
   evaluationPeriodDays?: number;
 }
@@ -178,6 +205,10 @@ interface RedemptionValidation {
   valid: boolean;
   error?: string;
   pointsToRedeem: number;
+  /**
+   * Discount in **integer minor units** (paisa for BDT) — always exactly
+   * `pointsToRedeem × pointValueMinor`.
+   */
   discountAmount: number;
   maxAllowedPoints: number;
 }
@@ -278,7 +309,7 @@ interface CreateEarningRuleInput {
    * Loyalty program this rule belongs to.
    *
    * Optional for repository-created rules: `EarningRuleRepository.create(...)`
-   * and `createMany(...)` fill this from `LoyaltyConfig.program.id`, matching
+   * and `createMany(...)` fill this from `LoyaltyShape.program.id`, matching
    * the default used by `MemberRepository.enroll(...)`. Pass explicitly only
    * when creating a rule for a different program.
    */