@fire-spark/payments 0.3.0 → 0.3.1

package/dist/index.d.ts

@@ -464,6 +464,50 @@ declare const isBatchCloseDue: (input: {
 }) => boolean;
 declare const batchCloseDay: (now: Date) => string;
 //#endregion
+//#region src/redemptions.d.ts
+/** `details` of a REDEMPTION tender: one per `payment_id` (D15). */
+type RedemptionDetails = Extract<TenderDetails, {
+  method: "REDEMPTION";
+}>;
+/** One reward inside a grouped REDEMPTION tender (entry totals). */
+type RedemptionReward = RedemptionDetails["rewards"][number];
+/**
+ * Payment redeem as stored in `orders.redeem`. `amount` and `points` are
+ * totals of the entry (every unit); `quantity` is informational.
+ */
+type PaymentRedeemLike = {
+  reward_id: string;
+  quantity?: number;
+  payment_id?: string | null;
+  amount?: number;
+  points?: number;
+  program?: string;
+};
+/** Payment redeems of one `payment_id`, ready to seed its tender. */
+type RedemptionGroup = {
+  payment_id: string;
+  /** Tender value: Σ `amount` of the grouped redeems. */
+  amount: number;
+  details: RedemptionDetails;
+};
+/**
+ * Groups payment redeems (`payment_id` set) into one entry per
+ * `payment_id`, in first-appearance order. Discount redeems are skipped.
+ */
+declare const groupPaymentRedeems: (redeem: readonly PaymentRedeemLike[]) => RedemptionGroup[];
+/**
+ * REDEMPTION `details` in the grouped shape, or null for other methods.
+ * Single-reward details written before grouping read as one reward.
+ */
+declare const redemptionDetailsOf: (details: unknown) => RedemptionDetails | null;
+/** Rewards of a REDEMPTION tender; empty for other methods. */
+declare const redemptionRewardsOf: (details: unknown) => {
+  reward_id: string;
+  quantity: number;
+  points: number;
+  points_value: number;
+}[];
+//#endregion
 //#region src/reference.d.ts
 /** ULID per attempt; sent to the provider as merchant/idempotency reference. */
 declare const createAttemptReference: (now?: number) => string;
@@ -625,4 +669,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, type PaymentResult, type PaymentReversal, type PaymentServer, type PaymentStorage, PaymentTenderUpdate, type PaymentUI, REDEMPTION_METHOD, RawPaymentError, 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, isBatchCloseDue, isDeliveryFee, isIntentCovered, isMixedTenders, isPaymentError, isRealPaymentMethod, isRedemptionReserved, isScopePaid, isTenderSettled, isTerminalLocked, isTipFee, liveRealTenders, liveTenders, memoryPaymentStorage, mergePaymentTender, missingDeviceFields, nextIntentStatus, primaryTender, primaryTenderOf, prorateMinor, realTenders, 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, 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 };

package/dist/index.js

@@ -1170,6 +1170,90 @@ const isBatchCloseDue = (input) => {
 };
 const batchCloseDay = (now) => localDay(now);
 //#endregion
+//#region src/redemptions.ts
+const SUM_DECIMALS = 6;
+const add = (a, b) => roundTo(a + b, SUM_DECIMALS);
+const rewardOf = (redeem) => {
+	const r1 = {
+		reward_id: redeem.reward_id,
+		quantity: redeem.quantity ?? 1
+	};
+	const r2 = {
+		points: redeem.points ?? 0,
+		points_value: redeem.amount ?? 0
+	};
+	return {
+		...r1,
+		...r2
+	};
+};
+const detailsOf = (rewards, program, loyalty_transaction_id) => {
+	const d1 = {
+		method: REDEMPTION_METHOD,
+		rewards,
+		points: rewards.reduce((sum, item) => add(sum, item.points), 0),
+		points_value: rewards.reduce((sum, item) => add(sum, item.points_value), 0)
+	};
+	const d2 = program === void 0 ? {} : { program };
+	const d3 = loyalty_transaction_id ? { loyalty_transaction_id } : {};
+	return {
+		...d1,
+		...d2,
+		...d3
+	};
+};
+/**
+* Groups payment redeems (`payment_id` set) into one entry per
+* `payment_id`, in first-appearance order. Discount redeems are skipped.
+*/
+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) ?? [];
+		list.push(item);
+		groups.set(item.payment_id, list);
+	}
+	return [...groups].map(([payment_id, items]) => {
+		const program = items.find((item) => item.program)?.program;
+		const details = detailsOf(items.map(rewardOf), program);
+		return {
+			payment_id,
+			amount: details.points_value,
+			details
+		};
+	});
+};
+const isRecord = (value) => {
+	return typeof value === "object" && value !== null;
+};
+/**
+* REDEMPTION `details` in the grouped shape, or null for other methods.
+* Single-reward details written before grouping read as one reward.
+*/
+const redemptionDetailsOf = (details) => {
+	if (!isRecord(details) || details.method !== "REDEMPTION") return null;
+	if (Array.isArray(details.rewards)) return details;
+	if (typeof details.reward_id !== "string") return null;
+	const legacy = details;
+	const r1 = {
+		reward_id: legacy.reward_id,
+		quantity: 1
+	};
+	const r2 = { points: legacy.points ?? 0 };
+	const reward = {
+		...r1,
+		...r2,
+		points_value: legacy.points_value ?? 0
+	};
+	const id = legacy.loyalty_transaction_id;
+	return detailsOf([reward], legacy.program, id);
+};
+/** Rewards of a REDEMPTION tender; empty for other methods. */
+const redemptionRewardsOf = (details) => {
+	return redemptionDetailsOf(details)?.rewards ?? [];
+};
+//#endregion
 //#region src/reference.ts
 const ENCODING = "0123456789ABCDEFGHJKMNPQRSTVWXYZ";
 const randomBytes = (size) => {
@@ -1267,4 +1351,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, isBatchCloseDue, isDeliveryFee, isIntentCovered, isMixedTenders, isPaymentError, isRealPaymentMethod, isRedemptionReserved, isScopePaid, isTenderSettled, isTerminalLocked, isTipFee, liveRealTenders, liveTenders, memoryPaymentStorage, mergePaymentTender, missingDeviceFields, nextIntentStatus, primaryTender, primaryTenderOf, prorateMinor, realTenders, 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, 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 };

package/package.json

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