@fire-spark/core 0.9.1 → 0.10.0

package/dist/index.d.ts

@@ -327,7 +327,10 @@ type PaymentSessionOptions = {
    * SDK charges are always saved with `collect_at: DEVICE` (§7.3).
    */
   collectAt?: PaymentCollectAt;
-  /** Where cash is collected: `COUNTER` on a kiosk, `DOOR` on delivery. */
+  /**
+   * Where cash and the Fire Spark card terminal are collected: `COUNTER` on
+   * a kiosk, `DOOR` on delivery.
+   */
   cashCollectAt?: PaymentCollectAt;
   /** `settings_overrides.payment_settings` of this device, by payment id. */
   deviceSettings?: Record<string, Record<string, unknown>>;
@@ -1058,6 +1061,45 @@ type PaymentOperationBody = {
 };
 /** Server half of an adapter (`POST /payments/:id/operations/:operation`). */
 declare const callPaymentOperation: <T>(paymentId: string, operation: string, body: PaymentOperationBody, options?: ServiceHttpOptions) => Promise<T>;
+type DeunaCallbackUrls = Partial<Record<"on_success" | "on_pending" | "on_failed" | "on_canceled" | "on_reject", string>>;
+type DeunaTokenizeBody = {
+  order_id: string;
+  attempt_reference: string;
+  callback_urls?: DeunaCallbackUrls;
+};
+type DeunaTokenizeResult = {
+  order_token: string;
+  order_id: string;
+};
+type DeunaOrderStatus = {
+  order_token: string;
+  status: string;
+  transaction_id: string | null;
+  error: {
+    code: string | null;
+    message: string | null;
+  } | null;
+};
+/** DEUNA order for the Payment Widget (`POST .../deuna/:id/tokenize`). */
+declare const tokenizeDeunaOrder: (paymentId: string, body: DeunaTokenizeBody, options?: ServiceHttpOptions) => Promise<DeunaTokenizeResult>;
+/** Payment status of a DEUNA order (`GET .../deuna/:id/orders/:token`). */
+declare const getDeunaOrder: (paymentId: string, orderToken: string, options?: ServiceHttpOptions) => Promise<DeunaOrderStatus>;
+/**
+ * `api` option of `deunaWidgetPayments` (`@fire-spark/payments-deuna-widget`)
+ * bound to the storefront HTTP options of the template.
+ */
+declare const createDeunaWidgetApi: (options?: ServiceHttpOptions) => {
+  tokenize: (input: {
+    paymentId: string;
+    orderId: string;
+    attemptReference: string;
+    callbackUrls?: DeunaCallbackUrls;
+  }) => Promise<DeunaTokenizeResult>;
+  order: (input: {
+    paymentId: string;
+    orderToken: string;
+  }) => Promise<DeunaOrderStatus>;
+};
 type TerminalFailureBody = {
   operation: string;
   device_id?: string | null;
@@ -1208,6 +1250,11 @@ declare const services: {
     list: typeof listPayments;
     operation: typeof callPaymentOperation;
     terminalFailure: typeof reportTerminalFailure;
+    deuna: {
+      tokenize: typeof tokenizeDeunaOrder;
+      order: typeof getDeunaOrder;
+      widgetApi: typeof createDeunaWidgetApi;
+    };
   };
   stores: {
     list: typeof listStores;
@@ -1554,4 +1601,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 GenOrderIdOptions, type GroupDisplayType, ID_HASH_FORMATS, type IdBuilder, type IdHashFormat, 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 OrderDeviceCredential, type OrderDraft, type OrderIssue, type OrderIssueCode, type OrderLineDiff, type OrderLineIssue, type OrderLineIssueCode, OrderPaymentRequiredError, type OrderScope, OrderSyncPendingError, OrderSyncRejectedError, 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 RedeemPaymentRow, 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, capRedeems, cappedRedeems, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, fitRedeems, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isGenId, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderPaymentRequiredError, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, linePayableTotal, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, orderPayableTotal, orderRedeemedTotal, orderRedeems, parseExpiry, paymentMatchesClientConditions, rebuildRootGroups, recomputeTotals, redeemedTotal, redemptionCap, redemptionSteps, remainingAmount, removeLine, replaceLine, resolveCheckout, resolveModifierImageUrl, reversePayment, runPaymentAttempt, selectablePayments, serializeError, services, setLineQuantity, storefrontJson, 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 DeunaCallbackUrls, type DeunaOrderStatus, type ExchangeOptions, type FailedCharge, type FlatMenuCategory, type GenOrderIdOptions, type GroupDisplayType, ID_HASH_FORMATS, type IdBuilder, type IdHashFormat, 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 OrderDeviceCredential, type OrderDraft, type OrderIssue, type OrderIssueCode, type OrderLineDiff, type OrderLineIssue, type OrderLineIssueCode, OrderPaymentRequiredError, type OrderScope, OrderSyncPendingError, OrderSyncRejectedError, 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 RedeemPaymentRow, 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, capRedeems, cappedRedeems, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createDeunaWidgetApi, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, fitRedeems, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isGenId, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderPaymentRequiredError, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, linePayableTotal, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, orderPayableTotal, orderRedeemedTotal, orderRedeems, parseExpiry, paymentMatchesClientConditions, rebuildRootGroups, recomputeTotals, redeemedTotal, redemptionCap, redemptionSteps, remainingAmount, removeLine, replaceLine, resolveCheckout, resolveModifierImageUrl, reversePayment, runPaymentAttempt, selectablePayments, serializeError, services, setLineQuantity, storefrontJson, toOrderLines, toPaymentCardBrand, validateCardNumber, validateCardholderName, validateCvc, validateExpiry, validateOrderAgainstMenu, verifyWebhookSignature, visitedStates };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { DIGITAL_COLLECT_AT, PARTIAL_APPROVAL_ERROR, REDEMPTION_METHOD, activeIntent, createAttemptReference, createPaymentError, currentIntent, defaultReversalFor, groupRedeems, hasRedeemPayment, isDeliveryFee, isPaymentError, isRealPaymentMethod, isRealPaymentMethod as isRealPaymentMethod$1, isTenderSettled, isTipFee, liveTenders, memoryPaymentStorage, missingDeviceFields, money, moneyMin, moneyNumber, moneyZero, orderRedeems, orderRedeems as orderRedeems$1, redeemsCoverTotal, resolvePaymentPolicy, resolveProviderEnvironment, scopedPaymentStorage, taxBreakdown, toChargeAmount, withTerminalLock } from "@fire-spark/payments";
+import { DIGITAL_COLLECT_AT, PARTIAL_APPROVAL_ERROR, REDEMPTION_METHOD, activeIntent, createAttemptReference, createPaymentError, currentIntent, defaultReversalFor, groupRedeems, hasRedeemPayment, isDeliveryFee, isManualPayment, isPaymentError, isRealPaymentMethod, isRealPaymentMethod as isRealPaymentMethod$1, isTenderSettled, isTipFee, liveTenders, memoryPaymentStorage, missingDeviceFields, money, moneyMin, moneyNumber, moneyZero, orderRedeems, orderRedeems as orderRedeems$1, redeemsCoverTotal, resolvePaymentPolicy, resolveProviderEnvironment, 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";
@@ -2722,6 +2722,42 @@ const callPaymentOperation = (paymentId, operation, body, options) => {
 		body: JSON.stringify(body)
 	}, options);
 };
+const deunaPath = (paymentId) => {
+	return `/api/storefront/v1/payments/deuna/${encodeURIComponent(paymentId)}`;
+};
+/** DEUNA order for the Payment Widget (`POST .../deuna/:id/tokenize`). */
+const tokenizeDeunaOrder = (paymentId, body, options) => {
+	return storefrontJson(`${deunaPath(paymentId)}/tokenize`, {
+		method: "POST",
+		body: JSON.stringify(body)
+	}, options);
+};
+/** Payment status of a DEUNA order (`GET .../deuna/:id/orders/:token`). */
+const getDeunaOrder = (paymentId, orderToken, options) => {
+	const token = encodeURIComponent(orderToken);
+	return storefrontJson(`${deunaPath(paymentId)}/orders/${token}`, {}, options);
+};
+/**
+* `api` option of `deunaWidgetPayments` (`@fire-spark/payments-deuna-widget`)
+* bound to the storefront HTTP options of the template.
+*/
+const createDeunaWidgetApi = (options) => {
+	return {
+		tokenize: (input) => {
+			const b1 = { order_id: input.orderId };
+			const b2 = { attempt_reference: input.attemptReference };
+			const b3 = input.callbackUrls ? { callback_urls: input.callbackUrls } : {};
+			return tokenizeDeunaOrder(input.paymentId, {
+				...b1,
+				...b2,
+				...b3
+			}, options);
+		},
+		order: (input) => {
+			return getDeunaOrder(input.paymentId, input.orderToken, options);
+		}
+	};
+};
 /** Reports a failed terminal operation (`payment.terminal_failed`). */
 const reportTerminalFailure = (paymentId, body, options) => {
 	return storefrontJson(`/api/storefront/v1/payments/${encodeURIComponent(paymentId)}/terminal-failures`, {
@@ -3089,7 +3125,12 @@ const services = {
 	payments: {
 		list: listPayments,
 		operation: callPaymentOperation,
-		terminalFailure: reportTerminalFailure
+		terminalFailure: reportTerminalFailure,
+		deuna: {
+			tokenize: tokenizeDeunaOrder,
+			order: getDeunaOrder,
+			widgetApi: createDeunaWidgetApi
+		}
 	},
 	stores: {
 		list: listStores,
@@ -3834,10 +3875,10 @@ const simpleTenderInput = (payment) => {
 /**
 * Charge order of §6.1: deferred capture (authorize only), immediate
 * capture reversible with cancel/refund, manual reversal only, then cash /
-* IDLE last.
+* card terminal (IDLE) last.
 */
 const chargeRank = (tender, adapter) => {
-	if (tender.method === "CASH") return 3;
+	if (isManualPayment(tender.provider, tender.method)) return 3;
 	if (adapter.capabilities?.deferredCapture) return 0;
 	if (adapter.cancel || adapter.refund) return 1;
 	return 2;
@@ -4164,6 +4205,10 @@ const reversePayment = async (adapter, ctx, result, options = {}) => {
 };
 //#endregion
 //#region src/order/payments/session.ts
+/** Cash or the Fire Spark card terminal: staff collects, no adapter call. */
+const isManual = (payment) => {
+	return isManualPayment(payment.provider.provider_id, payment.method.method);
+};
 const noopUI = {
 	message: () => void 0,
 	action: () => void 0,
@@ -4389,12 +4434,12 @@ var PaymentSession = class {
 		};
 	}
 	collectAt(payment) {
-		if (payment.method.method === "CASH") return this.options.cashCollectAt ?? "DOOR";
+		if (isManual(payment)) return this.options.cashCollectAt ?? "DOOR";
 		return this.options.collectAt ?? "DEVICE";
 	}
-	/** `collect_at` of a new tender: cash in person, the rest digital. */
+	/** `collect_at` of a new tender: manual in person, the rest digital. */
 	tenderCollectAt(payment) {
-		if (payment.method.method === "CASH") return this.options.cashCollectAt ?? "DOOR";
+		if (isManual(payment)) return this.options.cashCollectAt ?? "DOOR";
 		return "DEVICE";
 	}
 	toRecord(tender, result) {
@@ -4509,7 +4554,7 @@ var PaymentSession = class {
 		const amount = tender.amount.total;
 		const attemptReference = tender.attempt_reference;
 		const metadata = { attempt_reference: attemptReference };
-		if (!(payment.method.method === "CASH") && tender.status !== "PENDING") {
+		if (!isManual(payment) && tender.status !== "PENDING") {
 			const pending = {
 				status: "PENDING",
 				amount,
@@ -8937,4 +8982,4 @@ const cardPreviewGroups = (value) => {
 	return groups;
 };
 //#endregion
-export { CARD_BRANDS, DEFAULT_RECOMMENDATION_TYPES, ID_HASH_FORMATS, Order, OrderPaymentRequiredError, OrderSyncPendingError, OrderSyncRejectedError, OrderValidationError, RecurringDateCron, RulesEngine, StorefrontHttpError, addLines, auth, buildCustomerSnapshot, capRedeems, cappedRedeems, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, fitRedeems, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isGenId, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderPaymentRequiredError, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, linePayableTotal, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, orderPayableTotal, orderRedeemedTotal, orderRedeems, parseExpiry, paymentMatchesClientConditions, rebuildRootGroups, recomputeTotals, redeemedTotal, redemptionCap, redemptionSteps, remainingAmount, removeLine, replaceLine, resolveCheckout, resolveModifierImageUrl, reversePayment, runPaymentAttempt, selectablePayments, serializeError, services, setLineQuantity, storefrontJson, toOrderLines, toPaymentCardBrand, validateCardNumber, validateCardholderName, validateCvc, validateExpiry, validateOrderAgainstMenu, verifyWebhookSignature, visitedStates };
+export { CARD_BRANDS, DEFAULT_RECOMMENDATION_TYPES, ID_HASH_FORMATS, Order, OrderPaymentRequiredError, OrderSyncPendingError, OrderSyncRejectedError, OrderValidationError, RecurringDateCron, RulesEngine, StorefrontHttpError, addLines, auth, buildCustomerSnapshot, capRedeems, cappedRedeems, cardBrandSpec, cardDigits, cardNumberGaps, cardNumberMaxLength, cardPreviewGroups, caretAfterDigits, collectOrderLineDiffs, computeStartingPrice, countCartProducts, coveredAmount, createDeunaWidgetApi, createSession, currentNodes, cvcMaxLength, defaultConditionError, detectCardBrand, fitRedeems, flattenMenuCategories, flushLogs, formatCardNumber, formatCvc, formatExpiry, fromOrderLines, genId, genOrderId, getLogContext, getScheduleWindow, indexMenu, isCardNumberComplete, isCardNumberDefinitelyInvalid, isCheckoutFieldFilled, isCvcComplete, isDeviceCharged, isDeviceNotLinked, isExpiryComplete, isGenId, isKioskUnauthorized, isMilestoneStepDone, isOnSchedule, isOrderPaymentRequiredError, isOrderValidationError, isPosDeviceNotLinked, isPosUnauthorized, isRealPaymentMethod, isStorefrontNotFound, isVariantBase, linePayableTotal, listMenusStream, localizePosError, log, logError, luhnCheck, matchAbsoluteDateOperator, matchBooleanOperator, matchCurrencyOperator, matchEnumOperator, matchNumberOperator, matchRecurringDateOperator, matchRelativeDateOperator, matchStringOperator, milestoneSteps, milestoneTrack, nestMenuCategories, normalizeCardholderName, orderPayableTotal, orderRedeemedTotal, orderRedeems, parseExpiry, paymentMatchesClientConditions, rebuildRootGroups, recomputeTotals, redeemedTotal, redemptionCap, redemptionSteps, remainingAmount, removeLine, replaceLine, resolveCheckout, resolveModifierImageUrl, reversePayment, runPaymentAttempt, selectablePayments, serializeError, services, setLineQuantity, storefrontJson, toOrderLines, toPaymentCardBrand, validateCardNumber, validateCardholderName, validateCvc, validateExpiry, validateOrderAgainstMenu, verifyWebhookSignature, visitedStates };

package/package.json

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