@fire-spark/core 0.3.0 → 0.3.1

package/dist/index.d.ts

@@ -399,7 +399,10 @@ type ReorderOrderOptions = CreateOrderOptions & {
 type OrderDraft = Order$2;
 type ApplyRedeemInput = {
   reward_id: string;
-  /** Reward units to redeem (integer ≥ 1). */
+  /**
+   * Reward units to redeem (integer ≥ 1). With `payment_id` it is
+   * informational: `amount` and `points` already cover every unit.
+   */
   quantity: number;
   /** 0–1, compounded per unit over the remaining value. */
   discount_rate?: number;
@@ -414,11 +417,16 @@ type ApplyRedeemInput = {
   line_uid?: string;
   /**
    * Points / balance: the merchant `REDEMPTION` payment that pays `amount`
-   * (a tender, not a discount). Requires `amount` and `points`.
+   * (a tender, not a discount). Requires `amount` and `points`. Redeems
+   * with the same `payment_id` share one tender (`details.rewards[]`).
    */
   payment_id?: string;
-  /** Money the points cover; trimmed to total − tip − delivery. */
+  /**
+   * Total money the points cover 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`). */
@@ -496,14 +504,19 @@ declare 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: the order gets a REDEMPTION tender for
-   * it, capped at total − tip − delivery (D15, D18, D19).
+   * balance) it is not a discount: `amount` and `points` are totals 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).
    */
   applyRedeem(input: ApplyRedeemInput): void;
   /**
    * 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).
+   * (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`.
    */
   removeRedeem(input: RemoveRedeemInput): void;
   private rememberLogScope;
@@ -810,7 +823,17 @@ declare const listMenus: (scope?: StorefrontMenuScope, options?: ServiceHttpOpti
 declare const listMenusStream: (scope?: StorefrontMenuScope, options?: ListMenusStreamOptions) => AsyncGenerator<StorefrontMenu[], any, any>;
 //#endregion
 //#region src/services/payments.d.ts
-declare const listPayments: (input: StorefrontPaymentsListInput, options?: ServiceHttpOptions) => Promise<MerchantPayment[]>;
+type ListPaymentsOptions = ServiceHttpOptions & {
+  /** Keep `REDEMPTION` payments (points / balance) for redeem flows. */
+  includeRedemptions?: boolean;
+};
+/**
+ * Payments a customer can pick at checkout. `REDEMPTION` payments are
+ * applied through the order's `redeem` entries, never chosen as a method.
+ */
+declare const selectablePayments: <T extends MerchantPayment>(payments: readonly T[]) => T[];
+/** Lists payments without `REDEMPTION` unless `includeRedemptions` is set. */
+declare const listPayments: (input: StorefrontPaymentsListInput, options?: ListPaymentsOptions) => Promise<MerchantPayment[]>;
 type PaymentOperationBody = {
   order_id: string | null;
   attempt_reference: string | null;
@@ -1263,4 +1286,4 @@ declare const validateCardholderName: (value: string) => CardholderNameError | n
  */
 declare const cardPreviewGroups: (value: string) => CardPreviewSlot[][];
 //#endregion
-export { type ApplyRedeemInput, type AuthConfigureOptions, CARD_BRANDS, type CardBrand, type CardBrandSpec, type CardCvcError, type CardExpiry, type CardExpiryError, type CardNumberError, type CardPreviewSlot, type CardholderNameError, type CreateOrderOptions, type CreateSessionOptions, type CustomizationPath, type CustomizationSession, DEFAULT_RECOMMENDATION_TYPES, type ExchangeOptions, type FailedCharge, type FlatMenuCategory, type GroupDisplayType, type IdBuilder, type ListMenusStreamOptions, type Menu, type MenuCategoryNode, type MenuLookup, type MilestoneSteps, type MilestoneTrackItem, type ModifierControlType, type ModifierCtx, type ModifierGroupCtx, type NestedMenuCategory, Order, type OrderCustomerSource, type OrderDraft, type OrderIssue, type OrderIssueCode, type OrderLineDiff, type OrderLineIssue, type OrderLineIssueCode, type OrderScope, OrderSyncPendingError, OrderValidationError, type OrderValidationResult, type PayIntentOptions, type PayIntentResult, type PayOptions, type PaymentCardBrand, type PaymentProgressEvent, type PaymentProgressListener, type PaymentRunOptions, type PaymentSessionOptions, type PricingModifier, type Product, type ProductCtx, type QuantitiesByPath, type RecommendationType, RecurringDateCron, type RemoveRedeemInput, type ReorderOrderOptions, type ResetOptions, type ReversalOutcome, type ReverseAllOptions, RulesEngine, type ScheduleWindow, type SelectionStatus, type SelectionsByPath, type SerializedError, type ServiceHttpOptions, type SimpleTenderPayment, type Snapshot, type StorefrontAccessToken, type StorefrontErrorDetails, StorefrontHttpError, type TrackWorkflow, type ValidateOptions, type ValidateOrderAgainstMenuInput, type Variant, type VariantGroup, type VariantGroupCtx, type VariantOptionCtx, type VariantSelection, type VerifyWebhookSignatureInput, type VisitedState, addLines, auth, buildCustomerSnapshot, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, parseExpiry, paymentMatchesClientConditions, recomputeRedemptions, recomputeTotals, redemptionCap, remainingAmount, removeLine, replaceLine, resolveCheckout, reversePayment, runPaymentAttempt, serializeError, services, setLineQuantity, storefrontJson, stripRedemptionLines, toOrderLines, toPaymentCardBrand, validateCardNumber, validateCardholderName, validateCvc, validateExpiry, validateOrderAgainstMenu, verifyWebhookSignature, visitedStates };
+export { type ApplyRedeemInput, type AuthConfigureOptions, CARD_BRANDS, type CardBrand, type CardBrandSpec, type CardCvcError, type CardExpiry, type CardExpiryError, type CardNumberError, type CardPreviewSlot, type CardholderNameError, type CreateOrderOptions, type CreateSessionOptions, type CustomizationPath, type CustomizationSession, DEFAULT_RECOMMENDATION_TYPES, type ExchangeOptions, type FailedCharge, type FlatMenuCategory, type GroupDisplayType, type IdBuilder, type ListMenusStreamOptions, type ListPaymentsOptions, type Menu, type MenuCategoryNode, type MenuLookup, type MilestoneSteps, type MilestoneTrackItem, type ModifierControlType, type ModifierCtx, type ModifierGroupCtx, type NestedMenuCategory, Order, type OrderCustomerSource, type OrderDraft, type OrderIssue, type OrderIssueCode, type OrderLineDiff, type OrderLineIssue, type OrderLineIssueCode, type OrderScope, OrderSyncPendingError, OrderValidationError, type OrderValidationResult, type PayIntentOptions, type PayIntentResult, type PayOptions, type PaymentCardBrand, type PaymentProgressEvent, type PaymentProgressListener, type PaymentRunOptions, type PaymentSessionOptions, type PricingModifier, type Product, type ProductCtx, type QuantitiesByPath, type RecommendationType, RecurringDateCron, type RemoveRedeemInput, type ReorderOrderOptions, type ResetOptions, type ReversalOutcome, type ReverseAllOptions, RulesEngine, type ScheduleWindow, type SelectionStatus, type SelectionsByPath, type SerializedError, type ServiceHttpOptions, type SimpleTenderPayment, type Snapshot, type StorefrontAccessToken, type StorefrontErrorDetails, StorefrontHttpError, type TrackWorkflow, type ValidateOptions, type ValidateOrderAgainstMenuInput, type Variant, type VariantGroup, type VariantGroupCtx, type VariantOptionCtx, type VariantSelection, type VerifyWebhookSignatureInput, type VisitedState, addLines, auth, buildCustomerSnapshot, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, parseExpiry, paymentMatchesClientConditions, recomputeRedemptions, recomputeTotals, redemptionCap, remainingAmount, removeLine, replaceLine, resolveCheckout, reversePayment, runPaymentAttempt, selectablePayments, serializeError, services, setLineQuantity, storefrontJson, stripRedemptionLines, toOrderLines, toPaymentCardBrand, validateCardNumber, validateCardholderName, validateCvc, validateExpiry, validateOrderAgainstMenu, verifyWebhookSignature, visitedStates };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { DIGITAL_COLLECT_AT, PARTIAL_APPROVAL_ERROR, activeIntent, amountTolerance, createAttemptReference, createPaymentError, currencyDecimals, currentIntent, defaultReversalFor, isDeliveryFee, isPaymentError, isRealPaymentMethod, isTenderSettled, isTipFee, liveTenders, memoryPaymentStorage, missingDeviceFields, resolvePaymentPolicy, resolveProviderEnvironment, roundTo, scopedPaymentStorage, taxBreakdown, toChargeAmount, withTerminalLock } from "@fire-spark/payments";
+import { DIGITAL_COLLECT_AT, PARTIAL_APPROVAL_ERROR, activeIntent, amountTolerance, createAttemptReference, createPaymentError, currencyDecimals, currentIntent, defaultReversalFor, groupPaymentRedeems, isDeliveryFee, isPaymentError, isRealPaymentMethod, isRealPaymentMethod as isRealPaymentMethod$1, isTenderSettled, isTipFee, liveTenders, memoryPaymentStorage, missingDeviceFields, resolvePaymentPolicy, resolveProviderEnvironment, roundTo, scopedPaymentStorage, taxBreakdown, toChargeAmount, withTerminalLock } from "@fire-spark/payments";
 import advancedFormat from "dayjs/plugin/advancedFormat.js";
 import isBetween from "dayjs/plugin/isBetween.js";
 import isSameOrAfter from "dayjs/plugin/isSameOrAfter.js";
@@ -2641,10 +2641,21 @@ const validateOrder = async (body, options) => {
 };
 //#endregion
 //#region src/services/payments.ts
-const listPayments = (input, options) => {
+/**
+* Payments a customer can pick at checkout. `REDEMPTION` payments are
+* applied through the order's `redeem` entries, never chosen as a method.
+*/
+const selectablePayments = (payments) => {
+	return payments.filter((payment) => isRealPaymentMethod$1(payment.method.method));
+};
+/** Lists payments without `REDEMPTION` unless `includeRedemptions` is set. */
+const listPayments = async (input, options = {}) => {
+	const { includeRedemptions = false, ...http } = options;
 	const params = new URLSearchParams();
 	for (const [key, value] of Object.entries(input)) if (value) params.set(key, value);
-	return storefrontJson(`/api/storefront/v1/payments?${params.toString()}`, {}, options);
+	const payments = await storefrontJson(`/api/storefront/v1/payments?${params.toString()}`, {}, http);
+	if (includeRedemptions) return payments;
+	return selectablePayments(payments);
 };
 /** Server half of an adapter (`POST /payments/:id/operations/:operation`). */
 const callPaymentOperation = (paymentId, operation, body, options) => {
@@ -3532,6 +3543,22 @@ const buildRedeem = (input) => {
 	if (expires_at !== void 0) redeem.expires_at = expires_at;
 	return redeem;
 };
+/** Payment redeems hold totals, so the kept units keep their share. */
+const keepUnits = (item, rest) => {
+	if (!isPaymentRedeem(item) || rest === item.quantity) return {
+		...item,
+		quantity: 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
+	};
+};
 /**
 * Takes `quantity` units of `reward_id` off the latest entries first, so the
 * earlier redeems keep their step position. Entries that reach 0 are removed.
@@ -3549,10 +3576,7 @@ const subtractRedeem = (items, reward_id, quantity) => {
 		const taken = Math.min(item.quantity, pending);
 		pending -= taken;
 		const rest = item.quantity - taken;
-		if (rest > 0) kept.unshift({
-			...item,
-			quantity: rest
-		});
+		if (rest > 0) kept.unshift(keepUnits(item, rest));
 	}
 	return kept;
 };
@@ -3888,29 +3912,16 @@ const clampPaymentRedeems = (redeem, cap, currency) => {
 		}];
 	});
 };
-/** One REDEMPTION tender per payment redeem of the order (D15, D19). */
+/**
+* One REDEMPTION tender per `payment_id` of the payment redeems (D15,
+* D19); its `details.rewards[]` lists every grouped redeem.
+*/
 const redemptionTenderInputs = (redeem, providers = /* @__PURE__ */ new Map()) => {
-	return redeem.filter(isPaymentRedeem).map((item) => {
-		const payment_id = item.payment_id;
+	return groupPaymentRedeems(redeem).map(({ payment_id, details }) => {
 		const fallback = DEFAULT_REDEMPTION_PROVIDER;
-		const provider = providers.get(payment_id) ?? fallback;
-		const program = item.program ?? item.reward_id;
-		const d1 = {
-			method: "REDEMPTION",
-			reward_id: item.reward_id
-		};
-		const d2 = {
-			program,
-			points: item.points ?? 0
-		};
-		const details = {
-			...d1,
-			...d2,
-			points_value: item.amount ?? 0
-		};
 		const t1 = {
 			method: "REDEMPTION",
-			provider,
+			provider: providers.get(payment_id) ?? fallback,
 			payment_id
 		};
 		const t2 = {
@@ -5472,8 +5483,11 @@ 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: the order gets a REDEMPTION tender for
-	* it, capped at total − tip − delivery (D15, D18, D19).
+	* balance) it is not a discount: `amount` and `points` are totals 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).
 	*/
 	applyRedeem(input) {
 		if (this.deleted) return;
@@ -5499,7 +5513,9 @@ 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).
+	* (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`.
 	*/
 	removeRedeem(input) {
 		if (this.deleted) return;
@@ -8531,4 +8547,4 @@ const cardPreviewGroups = (value) => {
 	return groups;
 };
 //#endregion
-export { CARD_BRANDS, DEFAULT_RECOMMENDATION_TYPES, Order, OrderSyncPendingError, OrderValidationError, RecurringDateCron, RulesEngine, StorefrontHttpError, addLines, auth, buildCustomerSnapshot, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, parseExpiry, paymentMatchesClientConditions, recomputeRedemptions, recomputeTotals, redemptionCap, remainingAmount, removeLine, replaceLine, resolveCheckout, reversePayment, runPaymentAttempt, serializeError, services, setLineQuantity, storefrontJson, stripRedemptionLines, toOrderLines, toPaymentCardBrand, validateCardNumber, validateCardholderName, validateCvc, validateExpiry, validateOrderAgainstMenu, verifyWebhookSignature, visitedStates };
+export { CARD_BRANDS, DEFAULT_RECOMMENDATION_TYPES, Order, OrderSyncPendingError, OrderValidationError, RecurringDateCron, RulesEngine, StorefrontHttpError, addLines, auth, buildCustomerSnapshot, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, parseExpiry, paymentMatchesClientConditions, recomputeRedemptions, recomputeTotals, redemptionCap, remainingAmount, removeLine, replaceLine, resolveCheckout, reversePayment, runPaymentAttempt, selectablePayments, serializeError, services, setLineQuantity, storefrontJson, stripRedemptionLines, toOrderLines, toPaymentCardBrand, validateCardNumber, validateCardholderName, validateCvc, validateExpiry, validateOrderAgainstMenu, verifyWebhookSignature, visitedStates };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/core",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "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.0",
-    "@fire-spark/types": "^0.3.0"
+    "@fire-spark/payments": "^0.3.1",
+    "@fire-spark/types": "^0.3.1"
   },
   "devDependencies": {
     "tsdown": "^0.22.14",