@fire-spark/payments 0.3.1 → 0.3.3

package/dist/index.d.ts

@@ -490,6 +490,25 @@ type RedemptionGroup = {
   amount: number;
   details: RedemptionDetails;
 };
+/**
+ * Points / balance paid with a REDEMPTION tender, not a discount (D16):
+ * it never discounts lines nor has a `redemption_steps` entry.
+ */
+declare const isPaymentRedeem: (redeem: {
+  payment_id?: string | null;
+}) => boolean;
+/** Discount redeems: the ones replayed into `redemption_steps`. */
+declare const discountRedeems: <T extends {
+  payment_id?: string | null;
+}>(redeem: readonly T[]) => T[];
+/**
+ * Payment redeems pay the whole order, so no real tender is needed: the
+ * intent is only REDEMPTION tenders and the order advances on its own.
+ */
+declare const paymentRedeemsCoverTotal: (redeem: readonly PaymentRedeemLike[], totals: {
+  total: number;
+  currency: string;
+}) => boolean;
 /**
  * Groups payment redeems (`payment_id` set) into one entry per
  * `payment_id`, in first-appearance order. Discount redeems are skipped.
@@ -669,4 +688,4 @@ declare const scopedPaymentStorage: (storage: PaymentStorage, paymentId: string)
 /** For tests and web previews; apps provide AsyncStorage or localStorage. */
 declare const memoryPaymentStorage: () => PaymentStorage;
 //#endregion
-export { ACTIVE_INTENT_STATUSES, AllocateTenderInput, AllocateTendersInput, AllocateTendersResult, AllocatedTender, AllocationError, CURRENCY_DECIMALS, ChargeConversion, DEFAULT_PAYMENT_POLICY, DELIVERY_FEE_BASED_ON, DIGITAL_COLLECT_AT, type DeviceField, MergePaymentTenderOutcome, MergePaymentTenderResult, NEXT_STATUSES, PARTIAL_APPROVAL_ERROR, PAYMENT_ERROR_CODES, PAYMENT_ERROR_DEFAULTS, type PaymentAction, type PaymentAdapter, type PaymentAdapterCapabilities, type PaymentAmount, type PaymentCardType, type PaymentCollectAt, type PaymentContext, type PaymentCustomer, type PaymentEntryMode, type PaymentEnvironment, PaymentError, PaymentErrorCode, PaymentErrorDictionary, PaymentErrorEntry, PaymentErrorReason, type PaymentIntentStatus, type PaymentMetadata, type PaymentMetadataPayment, type PaymentOperation, type PaymentPolicy, PaymentRedeemLike, type PaymentResult, type PaymentReversal, type PaymentServer, type PaymentStorage, PaymentTenderUpdate, type PaymentUI, REDEMPTION_METHOD, RawPaymentError, RedemptionDetails, RedemptionGroup, RedemptionReward, RulesTender, StandardPaymentError, TERMINAL_TENDER_STATUSES, TIP_FEE_BASED_ON, type TaxBreakdown, TaxLine, type TerminalContext, type TerminalOperation, type TerminalOperations, type TerminalResult, ValidateTendersResult, activeIntent, allocateTenders, amountTolerance, batchCloseDay, countTenderItems, createAttemptReference, createPaymentError, currencyDecimals, currentIntent, defaultReversalFor, definePaymentErrors, derivePaymentStatus, formatPaymentError, groupPaymentRedeems, isBatchCloseDue, isDeliveryFee, isIntentCovered, isMixedTenders, isPaymentError, isRealPaymentMethod, isRedemptionReserved, isScopePaid, isTenderSettled, isTerminalLocked, isTipFee, liveRealTenders, liveTenders, memoryPaymentStorage, mergePaymentTender, missingDeviceFields, nextIntentStatus, primaryTender, primaryTenderOf, prorateMinor, realTenders, redemptionDetailsOf, redemptionRewardsOf, resolvePaymentPolicy, resolveProviderEnvironment, roundTo, scopedPaymentStorage, taxBreakdown, tendersCoverage, tendersInScope, toChargeAmount, toPaymentAmount, toPaymentError, validateTendersAgainstRules, withTerminalLock };
+export { ACTIVE_INTENT_STATUSES, AllocateTenderInput, AllocateTendersInput, AllocateTendersResult, AllocatedTender, AllocationError, CURRENCY_DECIMALS, ChargeConversion, DEFAULT_PAYMENT_POLICY, DELIVERY_FEE_BASED_ON, DIGITAL_COLLECT_AT, type DeviceField, MergePaymentTenderOutcome, MergePaymentTenderResult, NEXT_STATUSES, PARTIAL_APPROVAL_ERROR, PAYMENT_ERROR_CODES, PAYMENT_ERROR_DEFAULTS, type PaymentAction, type PaymentAdapter, type PaymentAdapterCapabilities, type PaymentAmount, type PaymentCardType, type PaymentCollectAt, type PaymentContext, type PaymentCustomer, type PaymentEntryMode, type PaymentEnvironment, PaymentError, PaymentErrorCode, PaymentErrorDictionary, PaymentErrorEntry, PaymentErrorReason, type PaymentIntentStatus, type PaymentMetadata, type PaymentMetadataPayment, type PaymentOperation, type PaymentPolicy, PaymentRedeemLike, type PaymentResult, type PaymentReversal, type PaymentServer, type PaymentStorage, PaymentTenderUpdate, type PaymentUI, REDEMPTION_METHOD, RawPaymentError, RedemptionDetails, RedemptionGroup, RedemptionReward, RulesTender, StandardPaymentError, TERMINAL_TENDER_STATUSES, TIP_FEE_BASED_ON, type TaxBreakdown, TaxLine, type TerminalContext, type TerminalOperation, type TerminalOperations, type TerminalResult, ValidateTendersResult, activeIntent, allocateTenders, amountTolerance, batchCloseDay, countTenderItems, createAttemptReference, createPaymentError, currencyDecimals, currentIntent, defaultReversalFor, definePaymentErrors, derivePaymentStatus, discountRedeems, formatPaymentError, groupPaymentRedeems, isBatchCloseDue, isDeliveryFee, isIntentCovered, isMixedTenders, isPaymentError, isPaymentRedeem, isRealPaymentMethod, isRedemptionReserved, isScopePaid, isTenderSettled, isTerminalLocked, isTipFee, liveRealTenders, liveTenders, memoryPaymentStorage, mergePaymentTender, missingDeviceFields, nextIntentStatus, paymentRedeemsCoverTotal, primaryTender, primaryTenderOf, prorateMinor, realTenders, redemptionDetailsOf, redemptionRewardsOf, resolvePaymentPolicy, resolveProviderEnvironment, roundTo, scopedPaymentStorage, taxBreakdown, tendersCoverage, tendersInScope, toChargeAmount, toPaymentAmount, toPaymentError, validateTendersAgainstRules, withTerminalLock };

package/dist/index.js

@@ -1173,6 +1173,29 @@ const batchCloseDay = (now) => localDay(now);
 //#region src/redemptions.ts
 const SUM_DECIMALS = 6;
 const add = (a, b) => roundTo(a + b, SUM_DECIMALS);
+/**
+* Points / balance paid with a REDEMPTION tender, not a discount (D16):
+* it never discounts lines nor has a `redemption_steps` entry.
+*/
+const isPaymentRedeem = (redeem) => {
+	return Boolean(redeem.payment_id);
+};
+/** Discount redeems: the ones replayed into `redemption_steps`. */
+const discountRedeems = (redeem) => {
+	return redeem.filter((item) => !isPaymentRedeem(item));
+};
+/**
+* Payment redeems pay the whole order, so no real tender is needed: the
+* intent is only REDEMPTION tenders and the order advances on its own.
+*/
+const paymentRedeemsCoverTotal = (redeem, totals) => {
+	const decimals = currencyDecimals(totals.currency);
+	const paid = redeem.reduce((sum, item) => {
+		return isPaymentRedeem(item) ? add(sum, item.amount ?? 0) : sum;
+	}, 0);
+	if (paid <= 0) return false;
+	return roundTo(paid, decimals) >= roundTo(totals.total, decimals);
+};
 const rewardOf = (redeem) => {
 	const r1 = {
 		reward_id: redeem.reward_id,
@@ -1209,10 +1232,11 @@ const detailsOf = (rewards, program, loyalty_transaction_id) => {
 const groupPaymentRedeems = (redeem) => {
 	const groups = /* @__PURE__ */ new Map();
 	for (const item of redeem) {
-		if (!item.payment_id) continue;
-		const list = groups.get(item.payment_id) ?? [];
+		if (!isPaymentRedeem(item)) continue;
+		const payment_id = item.payment_id;
+		const list = groups.get(payment_id) ?? [];
 		list.push(item);
-		groups.set(item.payment_id, list);
+		groups.set(payment_id, list);
 	}
 	return [...groups].map(([payment_id, items]) => {
 		const program = items.find((item) => item.program)?.program;
@@ -1351,4 +1375,4 @@ const memoryPaymentStorage = () => {
 	};
 };
 //#endregion
-export { ACTIVE_INTENT_STATUSES, CURRENCY_DECIMALS, DEFAULT_PAYMENT_POLICY, DELIVERY_FEE_BASED_ON, DIGITAL_COLLECT_AT, NEXT_STATUSES, PARTIAL_APPROVAL_ERROR, PAYMENT_ERROR_CODES, PAYMENT_ERROR_DEFAULTS, PaymentError, REDEMPTION_METHOD, TERMINAL_TENDER_STATUSES, TIP_FEE_BASED_ON, activeIntent, allocateTenders, amountTolerance, batchCloseDay, countTenderItems, createAttemptReference, createPaymentError, currencyDecimals, currentIntent, defaultReversalFor, definePaymentErrors, derivePaymentStatus, formatPaymentError, groupPaymentRedeems, isBatchCloseDue, isDeliveryFee, isIntentCovered, isMixedTenders, isPaymentError, isRealPaymentMethod, isRedemptionReserved, isScopePaid, isTenderSettled, isTerminalLocked, isTipFee, liveRealTenders, liveTenders, memoryPaymentStorage, mergePaymentTender, missingDeviceFields, nextIntentStatus, primaryTender, primaryTenderOf, prorateMinor, realTenders, redemptionDetailsOf, redemptionRewardsOf, resolvePaymentPolicy, resolveProviderEnvironment, roundTo, scopedPaymentStorage, taxBreakdown, tendersCoverage, tendersInScope, toChargeAmount, toPaymentAmount, toPaymentError, validateTendersAgainstRules, withTerminalLock };
+export { ACTIVE_INTENT_STATUSES, CURRENCY_DECIMALS, DEFAULT_PAYMENT_POLICY, DELIVERY_FEE_BASED_ON, DIGITAL_COLLECT_AT, NEXT_STATUSES, PARTIAL_APPROVAL_ERROR, PAYMENT_ERROR_CODES, PAYMENT_ERROR_DEFAULTS, PaymentError, REDEMPTION_METHOD, TERMINAL_TENDER_STATUSES, TIP_FEE_BASED_ON, activeIntent, allocateTenders, amountTolerance, batchCloseDay, countTenderItems, createAttemptReference, createPaymentError, currencyDecimals, currentIntent, defaultReversalFor, definePaymentErrors, derivePaymentStatus, discountRedeems, formatPaymentError, groupPaymentRedeems, isBatchCloseDue, isDeliveryFee, isIntentCovered, isMixedTenders, isPaymentError, isPaymentRedeem, isRealPaymentMethod, isRedemptionReserved, isScopePaid, isTenderSettled, isTerminalLocked, isTipFee, liveRealTenders, liveTenders, memoryPaymentStorage, mergePaymentTender, missingDeviceFields, nextIntentStatus, paymentRedeemsCoverTotal, primaryTender, primaryTenderOf, prorateMinor, realTenders, redemptionDetailsOf, redemptionRewardsOf, resolvePaymentPolicy, resolveProviderEnvironment, roundTo, scopedPaymentStorage, taxBreakdown, tendersCoverage, tendersInScope, toChargeAmount, toPaymentAmount, toPaymentError, validateTendersAgainstRules, withTerminalLock };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/payments",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Fire Spark payments contract: adapters, errors, amounts and policy",
   "type": "module",
   "sideEffects": false,
@@ -17,7 +17,7 @@
     }
   },
   "dependencies": {
-    "@fire-spark/types": "^0.3.1"
+    "@fire-spark/types": "^0.3.3"
   },
   "devDependencies": {
     "tsdown": "^0.22.14",