@fire-spark/core 0.3.5 → 0.4.0

package/dist/index.d.ts

@@ -408,7 +408,7 @@ type ApplyRedeemInput = {
   reward_id: string;
   /**
    * Reward units to redeem (integer ≥ 1). With `payment_id` it is
-   * informational: `amount` and `points` already cover every unit.
+   * informational: `amount` already covers every unit.
    */
   quantity: number;
   /** 0–1, compounded per unit over the remaining value. */
@@ -423,19 +423,17 @@ type ApplyRedeemInput = {
   /** Root line to discount; omit to discount the whole order (prorated). */
   line_uid?: string;
   /**
-   * Points / balance: the merchant `REDEMPTION` payment that pays `amount`
-   * (a tender, not a discount). Requires `amount` and `points`. Redeems
-   * with the same `payment_id` share one tender (`details.rewards[]`).
+   * Reward paid as a tender (voucher, balance…, not a discount): the
+   * merchant `REDEMPTION` payment that pays `amount`. Requires `amount`.
+   * Redeems with the same `payment_id` share one tender
+   * (`details.rewards[]`).
    */
   payment_id?: string;
   /**
-   * Total money the points cover for the whole entry (all `quantity`
+   * Total money the reward covers for the whole entry (all `quantity`
    * units, not per unit); trimmed to total − tip − delivery.
    */
   amount?: number;
-  /** Total points spent for the whole entry (not per unit). */
-  points?: number;
-  program?: string;
   /** Provider of the REDEMPTION payment (default `firespark`). */
   provider?: PaymentProvider;
   /** ISO datetime with offset; validation fails once it has passed. */
@@ -517,9 +515,9 @@ declare class Order {
   emptyOrder(): void;
   /**
    * Appends a redeem to `line_uid` (root line) or to the order. Steps keep
-   * the order in which redeems were applied. With `payment_id` (points /
-   * balance) it is not a discount: `amount` and `points` are totals of the
-   * whole entry (every unit, not per unit) and `quantity` is informational.
+   * the order in which redeems were applied. With `payment_id` (voucher,
+   * balance…) it is not a discount: `amount` is the total of the whole
+   * entry (every unit, not per unit) and `quantity` is informational.
    * Every redeem with the same `payment_id` is paid by one REDEMPTION
    * tender whose `details.rewards[]` lists them; their summed amount is
    * capped at total − tip − delivery (D15, D18, D19).
@@ -528,9 +526,8 @@ declare class Order {
   /**
    * Removes `quantity` units of `reward_id` from `line_uid` or the order,
    * latest applied first. Removing more units than applied clears them all
-   * (and the REDEMPTION tender of a points / balance redeem). A points /
-   * balance entry that keeps some units keeps the same share of its
-   * `amount` and `points`.
+   * (and the REDEMPTION tender of a payment redeem). A payment redeem that
+   * keeps some units keeps the same share of its `amount`.
    */
   removeRedeem(input: RemoveRedeemInput): void;
   private rememberLogScope;
@@ -544,7 +541,7 @@ declare class Order {
   cancelOrder(): Promise<void>;
   /**
    * Reopens this placed, unpaid order: the server voids every payment
-   * (REDEMPTION points released), cancels it as `VOIDED` and opens a new
+   * (REDEMPTION rewards released), cancels it as `VOIDED` and opens a new
    * `OPEN` order with the same content. This instance is closed afterwards;
    * replace it with the returned `Order` (same HTTP options and listener).
    *
@@ -856,7 +853,7 @@ declare const listMenusStream: (scope?: StorefrontMenuScope, options?: ListMenus
 //#endregion
 //#region src/services/payments.d.ts
 type ListPaymentsOptions = ServiceHttpOptions & {
-  /** Keep `REDEMPTION` payments (points / balance) for redeem flows. */
+  /** Keep `REDEMPTION` payments (vouchers, balance…) for redeem flows. */
   includeRedemptions?: boolean;
 };
 /**

package/dist/index.js

@@ -3480,8 +3480,8 @@ const orderRedeemCap = (order) => {
 	return Math.max(roundTo(redemptionCap(order) - used, decimals), 0);
 };
 /**
-* Trims payment redeems in application order so their sum fits the cap;
-* points shrink in proportion. Discount redeems are left untouched.
+* Trims payment redeems in application order so their sum fits the cap.
+* Discount redeems are left untouched.
 */
 const clampPaymentRedeems = (redeem, cap, currency) => {
 	const decimals = currencyDecimals(currency);
@@ -3493,12 +3493,9 @@ const clampPaymentRedeems = (redeem, cap, currency) => {
 		left = roundTo(left - fits, decimals);
 		if (fits <= 0) return [];
 		if (fits + amountTolerance(currency) >= amount) return [item];
-		const ratio = amount > 0 ? fits / amount : 0;
-		const points = roundTo((item.points ?? 0) * ratio, 0);
 		return [{
 			...item,
-			amount: fits,
-			points
+			amount: fits
 		}];
 	});
 };
@@ -4722,17 +4719,14 @@ const emptyTotals = (currency = "USD") => {
 //#region src/order/redemptions.ts
 const ORDER_KEY = "ORDER";
 const buildPaymentRedeem = (input) => {
-	const { reward_id, quantity, payment_id, amount, points } = input;
+	const { reward_id, quantity, payment_id, amount } = input;
 	if (amount === void 0 || !(amount > 0)) throw new Error("Redeem with payment_id requires amount > 0");
-	if (points === void 0 || !(points >= 0)) throw new Error("Redeem with payment_id requires points ≥ 0");
 	const redeem = {
 		reward_id,
 		quantity,
 		payment_id,
 		amount
 	};
-	redeem.points = points;
-	if (input.program !== void 0) redeem.program = input.program;
 	if (input.expires_at !== void 0) redeem.expires_at = input.expires_at;
 	return redeem;
 };
@@ -4766,12 +4760,10 @@ const keepUnits = (item, rest) => {
 	};
 	const ratio = new Big(rest).div(item.quantity);
 	const amount = new Big(item.amount ?? 0).times(ratio).round(6).toNumber();
-	const points = new Big(item.points ?? 0).times(ratio).round(0).toNumber();
 	return {
 		...item,
 		quantity: rest,
-		amount,
-		points
+		amount
 	};
 };
 /**
@@ -5094,7 +5086,7 @@ const cloneOrder = (order) => {
 };
 const redeemSignature$1 = (items) => {
 	return items.map((item) => {
-		return `${`${item.reward_id}:${item.quantity}:${item.payment_id ?? ""}`}:${`${item.amount ?? ""}:${item.points ?? ""}`}:${`${item.discount_rate ?? ""}:${item.discount_amount ?? ""}`}`;
+		return `${`${item.reward_id}:${item.quantity}:${item.payment_id ?? ""}`}:${`${item.amount ?? ""}`}:${`${item.discount_rate ?? ""}:${item.discount_amount ?? ""}`}`;
 	}).join("|");
 };
 const buildHttpOptions = (options) => {
@@ -5509,9 +5501,9 @@ var Order = class Order {
 	}
 	/**
 	* Appends a redeem to `line_uid` (root line) or to the order. Steps keep
-	* the order in which redeems were applied. With `payment_id` (points /
-	* balance) it is not a discount: `amount` and `points` are totals of the
-	* whole entry (every unit, not per unit) and `quantity` is informational.
+	* the order in which redeems were applied. With `payment_id` (voucher,
+	* balance…) it is not a discount: `amount` is the total of the whole
+	* entry (every unit, not per unit) and `quantity` is informational.
 	* Every redeem with the same `payment_id` is paid by one REDEMPTION
 	* tender whose `details.rewards[]` lists them; their summed amount is
 	* capped at total − tip − delivery (D15, D18, D19).
@@ -5520,7 +5512,7 @@ var Order = class Order {
 		if (this.deleted) return;
 		const { line_uid, provider, ...rest } = input;
 		const redeem = buildRedeem(rest);
-		if (isPaymentRedeem(redeem) && line_uid !== void 0) throw new Error("Points / balance redeems apply to the whole order");
+		if (isPaymentRedeem(redeem) && line_uid !== void 0) throw new Error("Payment redeems apply to the whole order");
 		if (redeem.payment_id && provider) this.redemptionProviders.set(redeem.payment_id, provider);
 		if (line_uid === void 0) {
 			this.commitLines({ redeem: [...this.appliedRedeem(), redeem] });
@@ -5540,9 +5532,8 @@ var Order = class Order {
 	/**
 	* Removes `quantity` units of `reward_id` from `line_uid` or the order,
 	* latest applied first. Removing more units than applied clears them all
-	* (and the REDEMPTION tender of a points / balance redeem). A points /
-	* balance entry that keeps some units keeps the same share of its
-	* `amount` and `points`.
+	* (and the REDEMPTION tender of a payment redeem). A payment redeem that
+	* keeps some units keeps the same share of its `amount`.
 	*/
 	removeRedeem(input) {
 		if (this.deleted) return;
@@ -5649,7 +5640,7 @@ var Order = class Order {
 	}
 	/**
 	* Reopens this placed, unpaid order: the server voids every payment
-	* (REDEMPTION points released), cancels it as `VOIDED` and opens a new
+	* (REDEMPTION rewards released), cancels it as `VOIDED` and opens a new
 	* `OPEN` order with the same content. This instance is closed afterwards;
 	* replace it with the returned `Order` (same HTTP options and listener).
 	*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/core",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "Fire Spark headless SDK",
   "type": "module",
   "sideEffects": false,
@@ -20,8 +20,8 @@
     "big.js": "6.2.1",
     "dayjs": "1.11.9",
     "@types/big.js": "6.2.2",
-    "@fire-spark/payments": "^0.3.5",
-    "@fire-spark/types": "^0.3.5"
+    "@fire-spark/payments": "^0.4.0",
+    "@fire-spark/types": "^0.4.0"
   },
   "devDependencies": {
     "tsdown": "^0.22.14",