@riverbankcms/sdk 0.130.2 → 0.134.0

package/dist/_dts/commerce/src/purchase/checkoutStripeSessionPlanning.d.ts

@@ -0,0 +1,125 @@
+import { type Result } from '../../../core/src/index';
+import { type LineSettlementBreakdown } from './settlement';
+export type CheckoutStripeSessionPaymentPlan = Readonly<{
+    kind: 'stripe' | 'instalment_plan';
+    creditReservationId?: string | null;
+}> | Readonly<{
+    kind: 'flexible_balance';
+    initialPaymentCents: number;
+    creditReservationId?: string | null;
+}>;
+export type CheckoutStripeSessionPaymentIntentPaymentPlan = Readonly<{
+    kind: CheckoutStripeSessionPaymentPlan['kind'];
+}>;
+export type CheckoutStripeSessionLineInput = Readonly<{
+    displayName: string;
+    quantity: number;
+    settlement: Readonly<{
+        line: LineSettlementBreakdown;
+    }>;
+}>;
+export type CheckoutStripeSessionLineItemPlan = Readonly<{
+    name: string;
+    unitAmountCents: number;
+    quantity: number;
+}>;
+export type CheckoutStripeSessionCollectionPlan = Readonly<{
+    lineItems: readonly CheckoutStripeSessionLineItemPlan[];
+    totals: Readonly<{
+        discountCents: number;
+        creditCents: number;
+    }>;
+    expiresAtEpoch: number | undefined;
+}>;
+export type CheckoutStripeSessionDiscountMetadata = Readonly<{
+    redemptionId: string;
+    discountCodeId: string;
+    discountCode: string;
+    discountPublicLabel: string;
+}>;
+export type CheckoutStripeSessionOrderReferences = Readonly<{
+    siteId: string;
+    orderId: string;
+    customerEmail: string;
+    orderPaymentPlanId: string | null;
+    flexibleBalanceContractId: string | null;
+}>;
+export type CheckoutStripeSessionApplicationFeeDecision = Readonly<{
+    kind: 'none';
+}> | Readonly<{
+    kind: 'application_fee_amount';
+    amountCents: number;
+}>;
+export type CheckoutStripeSessionPaymentIntentPlan = Readonly<{
+    customerCreation?: 'always';
+    setupFutureUsage?: 'off_session';
+    applicationFeeAmountCents?: number;
+}>;
+export type CheckoutStripeSessionSettlementPolicy = Readonly<{
+    kind: 'stripe_default';
+}> | Readonly<{
+    kind: 'must_settle_before_reservation_deadline';
+    paymentMethodSet: 'immediate_only';
+}>;
+export type CheckoutStripeSessionRequestPlan = CheckoutStripeSessionCollectionPlan & Readonly<{
+    metadata: Record<string, string>;
+    paymentIntent: CheckoutStripeSessionPaymentIntentPlan;
+    paymentMethodTypes: readonly ['card'] | undefined;
+}>;
+export type CheckoutStripeSessionPlanningError = Readonly<{
+    _tag: 'invalid_line_quantity';
+    lineIndex: number;
+    quantity: number;
+    message: string;
+}> | Readonly<{
+    _tag: 'invalid_line_money';
+    lineIndex: number;
+    field: 'stripeChargeCents';
+    amountCents: number;
+    message: string;
+}> | Readonly<{
+    _tag: 'invalid_flexible_balance_initial_payment';
+    amountCents: number;
+    message: string;
+}>;
+export declare function planCheckoutStripeSessionRequest(options: Readonly<{
+    checkoutLines: readonly CheckoutStripeSessionLineInput[];
+    paymentPlan: CheckoutStripeSessionPaymentPlan;
+    orderDisplayName: string;
+    discountExpiresAtEpoch: number | undefined;
+    creditReservationExpiresAtIso: string | null;
+    registrationHoldExpiresAtEpoch?: number;
+    discount: CheckoutStripeSessionDiscountMetadata | null;
+    orderReferences: CheckoutStripeSessionOrderReferences;
+    applicationFeeDecision: CheckoutStripeSessionApplicationFeeDecision;
+    settlementPolicy?: CheckoutStripeSessionSettlementPolicy;
+}>): Result<CheckoutStripeSessionRequestPlan, CheckoutStripeSessionPlanningError>;
+export declare function planCheckoutStripeSessionCollection(options: Readonly<{
+    checkoutLines: readonly CheckoutStripeSessionLineInput[];
+    paymentPlan: CheckoutStripeSessionPaymentPlan;
+    orderDisplayName: string;
+    discountExpiresAtEpoch: number | undefined;
+    creditReservationExpiresAtIso: string | null;
+    registrationHoldExpiresAtEpoch?: number;
+}>): Result<CheckoutStripeSessionCollectionPlan, CheckoutStripeSessionPlanningError>;
+export declare function planCheckoutStripeSessionMetadata(options: Readonly<{
+    paymentPlan: CheckoutStripeSessionPaymentPlan;
+    discount: CheckoutStripeSessionDiscountMetadata | null;
+    orderReferences: CheckoutStripeSessionOrderReferences;
+    totals: CheckoutStripeSessionCollectionPlan['totals'];
+}>): Record<string, string>;
+export declare function planCheckoutStripeSessionPaymentIntent(options: Readonly<{
+    paymentPlan: CheckoutStripeSessionPaymentIntentPaymentPlan;
+    applicationFeeDecision: CheckoutStripeSessionApplicationFeeDecision;
+}>): CheckoutStripeSessionPaymentIntentPlan;
+export declare function summarizeCheckoutSessionLines(lines: readonly CheckoutStripeSessionLineInput[]): CheckoutStripeSessionCollectionPlan['totals'];
+export declare function resolveCheckoutSessionExpiryEpoch(options: Readonly<{
+    discountExpiresAtEpoch: number | undefined;
+    creditReservationExpiresAtIso: string | null;
+    registrationHoldExpiresAtEpoch?: number;
+}>): number | undefined;
+export declare function planCheckoutStripeLineItems(options: Readonly<{
+    checkoutLines: readonly CheckoutStripeSessionLineInput[];
+    paymentPlan: CheckoutStripeSessionPaymentPlan;
+    orderDisplayName: string;
+}>): Result<readonly CheckoutStripeSessionLineItemPlan[], CheckoutStripeSessionPlanningError>;

package/dist/_dts/commerce/src/purchase/checkoutValidatedItemPlanning.d.ts

@@ -0,0 +1,55 @@
+import type { BookingFlexibleBalanceConfig } from '../../../core/src/index';
+import type { CheckoutPaymentTermCollectionOptionKind } from './checkoutPaymentTerms';
+export type SelectedAppointmentCheckoutCollectionOption<TInstalmentPlan, TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig> = Readonly<{
+    kind: 'upfront' | 'deferred_manual';
+}> | Readonly<{
+    kind: 'instalment_plan';
+    plan: TInstalmentPlan;
+}> | Readonly<{
+    kind: 'flexible_balance';
+    config: TFlexibleBalanceConfig;
+}> | null;
+export type SelectedAttendeeBookingCheckoutCollectionOption<TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig> = Readonly<{
+    kind: 'upfront' | 'deferred_manual';
+}> | Readonly<{
+    kind: 'flexible_balance';
+    config: TFlexibleBalanceConfig;
+}> | null;
+export type AttendeeBookingCollectionOptionInput<TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig> = Readonly<{
+    kind: 'upfront' | 'deferred_manual';
+}> | Readonly<{
+    kind: 'flexible_balance';
+    config: TFlexibleBalanceConfig;
+}> | Readonly<{
+    kind: 'instalment_plan';
+}> | null;
+export type ValidatedAttendeeBookingPaymentSelection<TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig> = Readonly<{
+    bookingStartAt: string;
+    selectedCollectionOptionKind: 'flexible_balance';
+    selectedFlexibleBalanceConfig: TFlexibleBalanceConfig;
+}> | Readonly<{
+    bookingStartAt: string;
+    selectedCollectionOptionKind: Exclude<CheckoutPaymentTermCollectionOptionKind, 'flexible_balance'> | null;
+    selectedFlexibleBalanceConfig: null;
+}>;
+export type ValidatedAppointmentPaymentSelection<TInstalmentPlan, TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig> = Readonly<{
+    selectedCollectionOptionKind: 'instalment_plan';
+    selectedInstalmentPlan: TInstalmentPlan;
+    selectedFlexibleBalanceConfig: null;
+}> | Readonly<{
+    selectedCollectionOptionKind: 'flexible_balance';
+    selectedInstalmentPlan: null;
+    selectedFlexibleBalanceConfig: TFlexibleBalanceConfig;
+}> | Readonly<{
+    selectedCollectionOptionKind: 'upfront' | 'deferred_manual' | null;
+    selectedInstalmentPlan: null;
+    selectedFlexibleBalanceConfig: null;
+}>;
+export declare function buildValidatedAttendeeBookingPaymentSelection<TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig>(input: Readonly<{
+    bookingStartAt: string;
+    selectedCollectionOption: SelectedAttendeeBookingCheckoutCollectionOption<TFlexibleBalanceConfig>;
+}>): ValidatedAttendeeBookingPaymentSelection<TFlexibleBalanceConfig>;
+export declare function toSelectedAttendeeBookingCheckoutCollectionOption<TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig>(option: AttendeeBookingCollectionOptionInput<TFlexibleBalanceConfig>): SelectedAttendeeBookingCheckoutCollectionOption<TFlexibleBalanceConfig>;
+export declare function buildValidatedAppointmentPaymentSelection<TInstalmentPlan, TFlexibleBalanceConfig extends BookingFlexibleBalanceConfig>(input: Readonly<{
+    selectedCollectionOption: SelectedAppointmentCheckoutCollectionOption<TInstalmentPlan, TFlexibleBalanceConfig>;
+}>): ValidatedAppointmentPaymentSelection<TInstalmentPlan, TFlexibleBalanceConfig>;

package/dist/_dts/commerce/src/purchase/confirmationEmailPayment.d.ts

@@ -0,0 +1,91 @@
+import type { OrderPaymentMethod } from './orderTypes';
+export type ConfirmationEmailPaymentSummary = Readonly<{
+    kind: 'free';
+}> | Readonly<{
+    kind: 'manual_due';
+}> | Readonly<{
+    kind: 'managed_balance_due';
+    dueAt: string | null;
+}> | Readonly<{
+    kind: 'waived';
+}> | Readonly<{
+    kind: 'pass';
+    passName?: string;
+    passCreditsUsed?: number;
+}> | Readonly<{
+    kind: 'membership';
+    membershipName?: string;
+}> | Readonly<{
+    kind: 'monetary';
+    amountPaidCents: number;
+    amountOutstandingCents?: number;
+    dueAt?: string | null;
+    currency: string;
+    paymentMethod: Extract<OrderPaymentMethod, 'stripe' | 'store_credit' | 'mixed'>;
+}>;
+export type ConfirmationEmailTemplatePaymentFields = Readonly<{
+    paymentMethod?: 'free' | 'pass' | 'membership' | 'stripe' | 'manual' | 'waived';
+    amountPaid?: number;
+    amountOutstanding?: number;
+    currency?: string;
+    passName?: string;
+    passCreditsUsed?: number;
+    membershipName?: string;
+    managedBalanceDueAt?: string | null;
+}>;
+type NonMonetaryConfirmationPaymentMethod = 'free' | 'pass' | 'membership';
+export declare function settledOrderItemTotalCents(item: Readonly<{
+    netTotalCents: number | null;
+    totalCents: number | null;
+    creditCents: number | null;
+}>): number;
+export declare function buildOrderItemConfirmationEmailPaymentSummary(options: {
+    orderPaymentMethod: OrderPaymentMethod;
+    item: Readonly<{
+        netTotalCents: number | null;
+        totalCents: number | null;
+        creditCents: number | null;
+    }>;
+    currency: string;
+    flexibleBalanceDueAt?: string | null;
+    settlement: Readonly<{
+        kind: 'settled_in_full';
+    }> | Readonly<{
+        kind: 'collected';
+        collectedCents: number;
+    }>;
+}): ConfirmationEmailPaymentSummary;
+export declare function buildEventRegistrationConfirmationEmailPaymentSummary(options: Readonly<{
+    paymentMethod: NonMonetaryConfirmationPaymentMethod;
+    passCreditsUsed?: number;
+}>): ConfirmationEmailPaymentSummary;
+export declare function buildManualAttendeeConfirmationEmailPaymentSummary(options: Readonly<{
+    paymentMethod: NonMonetaryConfirmationPaymentMethod;
+    passName?: string;
+    passCreditsUsed?: number;
+    membershipName?: string;
+}>): ConfirmationEmailPaymentSummary;
+export declare function buildBundleConfirmationEmailPaymentSummary(options: Readonly<{
+    paymentMethod: Extract<NonMonetaryConfirmationPaymentMethod, 'pass' | 'membership'>;
+    passName?: string;
+    passCreditsUsed?: number;
+    membershipName?: string;
+}>): ConfirmationEmailPaymentSummary;
+export declare function buildTransferredAttendeeConfirmationEmailPaymentSummary(options: Readonly<{
+    paymentMethod: NonMonetaryConfirmationPaymentMethod | 'stripe';
+    amountPaidCents?: number | null;
+    currency?: string | null;
+}>): ConfirmationEmailPaymentSummary | undefined;
+export declare function buildCourseEnrollmentConfirmationEmailPaymentSummary(options: Readonly<{
+    paymentMethod: 'free' | 'membership' | 'stripe';
+    amountPaidCents?: number | null;
+    currency?: string | null;
+    membershipName?: string;
+}>): ConfirmationEmailPaymentSummary | undefined;
+export declare function buildBypassedCheckoutConfirmationEmailPaymentSummary(options: Readonly<{
+    bypassReason: 'free' | 'discount_free' | 'store_credit';
+    settledAmountCents: number;
+    currency: string;
+}>): ConfirmationEmailPaymentSummary;
+export declare function toConfirmationEmailTemplatePaymentFields(summary: ConfirmationEmailPaymentSummary | undefined): ConfirmationEmailTemplatePaymentFields;
+export {};

package/dist/_dts/commerce/src/purchase/discountApplication.d.ts

@@ -0,0 +1,74 @@
+import type { CheckoutLineId } from '../../../core/src/index';
+import { type NonNegativeCents, type Result } from '../../../core/src/index';
+import type { CurrencyCode } from './settlement';
+export declare const CHECKOUT_DISCOUNT_ALLOCATION_RULE_VERSION: "proportional-v1";
+export type CheckoutDiscountAllocationRuleVersion = typeof CHECKOUT_DISCOUNT_ALLOCATION_RULE_VERSION;
+export type DiscountApplicationSource = 'manual' | 'auto';
+export type DiscountApplicationLineSnapshot<TLineId extends string = CheckoutLineId> = Readonly<{
+    lineId: TLineId;
+    eligible: boolean;
+    basisSubtotalCents: NonNegativeCents;
+    discountCents: NonNegativeCents;
+}>;
+export type DiscountApplicationSnapshot<TLineId extends string = CheckoutLineId> = Readonly<{
+    discountCodeId: string | null;
+    discountRedemptionId: string | null;
+    code: string;
+    displayLabel: string;
+    source: DiscountApplicationSource;
+    currency: CurrencyCode;
+    totalDiscountCents: NonNegativeCents;
+    allocationRuleVersion: CheckoutDiscountAllocationRuleVersion;
+    items: readonly DiscountApplicationLineSnapshot<TLineId>[];
+}>;
+export type CheckoutDiscountApplicationError<TLineId extends string = CheckoutLineId> = Readonly<{
+    _tag: 'empty_cart';
+    message: string;
+}> | Readonly<{
+    _tag: 'invalid_discount_amount';
+    message: string;
+}> | Readonly<{
+    _tag: 'invalid_line_money';
+    lineId: TLineId;
+    field: 'subtotalCents';
+    message: string;
+}>;
+export type CheckoutDiscountApplicationDiscount = Readonly<{
+    discountCodeId: string | null;
+    redemptionId: string | null;
+    discountCode: string;
+    discountPublicLabel: string;
+    autoApplied: boolean;
+    amountDiscountCents: NonNegativeCents;
+}>;
+export type CheckoutDiscountApplicationSelection<TLineId extends string, TDiscount extends CheckoutDiscountApplicationDiscount> = Readonly<{
+    discount: TDiscount;
+    eligibleLineIds: ReadonlySet<TLineId>;
+}>;
+export type CheckoutDiscountApplicationLineInput<TLineId extends string, TPayload> = Readonly<{
+    lineId: TLineId;
+    subtotalCents: NonNegativeCents;
+    payload: TPayload;
+}>;
+export type CheckoutDiscountApplicationInput<TLineId extends string, TPayload, TDiscount extends CheckoutDiscountApplicationDiscount> = Readonly<{
+    currency: CurrencyCode;
+    items: readonly CheckoutDiscountApplicationLineInput<TLineId, TPayload>[];
+    selectedDiscount: CheckoutDiscountApplicationSelection<TLineId, TDiscount> | null;
+}>;
+export type CheckoutDiscountApplicationLine<TLineId extends string, TPayload> = Readonly<{
+    lineId: TLineId;
+    subtotalCents: NonNegativeCents;
+    discountCents: NonNegativeCents;
+    totalAfterDiscountCents: NonNegativeCents;
+    payload: TPayload;
+}>;
+export type CheckoutDiscountApplication<TLineId extends string, TPayload, TDiscount extends CheckoutDiscountApplicationDiscount> = Readonly<{
+    currency: CurrencyCode;
+    items: readonly CheckoutDiscountApplicationLine<TLineId, TPayload>[];
+    subtotalCents: NonNegativeCents;
+    discountCents: NonNegativeCents;
+    totalAfterDiscountCents: NonNegativeCents;
+    discount: TDiscount | null;
+    discountApplication: DiscountApplicationSnapshot<TLineId> | null;
+}>;
+export declare function planCheckoutDiscountApplication<TLineId extends string, TPayload, TDiscount extends CheckoutDiscountApplicationDiscount>(input: CheckoutDiscountApplicationInput<TLineId, TPayload, TDiscount>): Result<CheckoutDiscountApplication<TLineId, TPayload, TDiscount>, CheckoutDiscountApplicationError<TLineId>>;

package/dist/_dts/commerce/src/purchase/index.d.ts

@@ -0,0 +1,55 @@
+export * from './types';
+export * from './orderTypes';
+export * from './orderPlanningTypes';
+export * from './bookingInstalmentSchedule';
+export * from './cancellationPolicy';
+export * from './checkoutCollectionPlan';
+export * from './checkoutCommitPlan';
+export * from './checkoutDiscountContextPlanning';
+export * from './checkoutErrorCodes';
+export * from './checkoutOrderItemProjection';
+export * from './checkoutPaymentFlow';
+export * from './checkoutPaymentPlanPlanning';
+export * from './checkoutPaymentTermPlanning';
+export * from './checkoutPaymentTerms';
+export * from './checkoutQuantity';
+export * from './checkoutSettlement';
+export * from './checkoutStripeFinalizationPlanning';
+export * from './checkoutStripeSessionPlanning';
+export * from './checkoutSessionMetadata';
+export * from './checkoutValidatedItemPlanning';
+export * from './canonicalRefundPlanner';
+export * from './confirmationEmailPayment';
+export * from './discountApplication';
+export * from './oneTimeCheckoutPlanning';
+export * from './order-number';
+export * from './orderCancellationPlan';
+export * from './orderConfirmationPlanning';
+export * from './orderCompletionEmailPlan';
+export * from './orderFulfillmentPlan';
+export * from './orderFulfillmentResult';
+export * from './orderHistoryLedgerFilters';
+export * from './orderHistorySource';
+export * from './orderInstalmentAdminSettlement';
+export * from './orderInstalmentClosure';
+export * from './orderInstalmentLifecycle';
+export * from './orderInstalmentPayoff';
+export * from './orderInstalmentPlan';
+export * from './orderItemMetadata';
+export * from './orderItemSupport';
+export * from './orderListFilters';
+export * from './orderPaymentState';
+export * from './orderPaymentReceipt';
+export * from './orderPaymentLinkPlanning';
+export * from './orderRefundPlanning';
+export * from './orderRefundPolicy';
+export * from './orderTotals';
+export * from './persistedCheckoutLines';
+export * from './pendingCheckoutSessionClaim';
+export * from './protectedDepositRefundPolicy';
+export * from './refundRailSplit';
+export * from './refundPolicy';
+export * from './settlement';
+export * from './shopRefundPlanning';
+export * from './stripeMinimumCharge';
+export * from './stateTransitions';

package/dist/_dts/commerce/src/purchase/oneTimeCheckoutPlanning.d.ts

@@ -0,0 +1,86 @@
+import { type NonEmptyArray, type Result } from '../../../core/src/index';
+import { type CurrencyCode, type Money } from './settlement';
+import type { CartCheckout } from './types';
+import type { OrderPaymentMethod, OrderStatus } from './orderTypes';
+export type CheckoutPlanningError = {
+    _tag: 'CheckoutPlanningError';
+    code: 'empty_cart';
+    message: string;
+};
+type CheckoutPlanningSettledCart = Readonly<{
+    items: readonly unknown[];
+    subtotalCents: number;
+    discountCents: number;
+    creditCents: number;
+    totalAfterDiscountCents: number;
+    totalAfterCreditsCents: number;
+    currency: string;
+    discount: unknown;
+    discountApplication: unknown;
+}>;
+export type CheckoutPaymentPlanBase = Readonly<{
+    creditReservedCents: number;
+}>;
+export type StripeCheckoutPaymentPlan = CheckoutPaymentPlanBase & Readonly<{
+    kind: 'stripe';
+}>;
+export type BypassCheckoutPaymentPlan = CheckoutPaymentPlanBase & Readonly<{
+    kind: 'bypass';
+    bypassReason: 'free' | 'store_credit' | 'discount_free';
+}>;
+export type DeferredManualCheckoutPaymentPlan = CheckoutPaymentPlanBase & Readonly<{
+    kind: 'deferred_manual';
+}>;
+export type InstalmentCheckoutPaymentPlan = CheckoutPaymentPlanBase & Readonly<{
+    kind: 'instalment_plan';
+}>;
+export type FlexibleBalanceCheckoutPaymentPlan = CheckoutPaymentPlanBase & Readonly<{
+    kind: 'flexible_balance';
+    initialPaymentCents: number;
+}>;
+export type OneTimeCheckoutPlanningPaymentPlan = StripeCheckoutPaymentPlan | BypassCheckoutPaymentPlan | DeferredManualCheckoutPaymentPlan | InstalmentCheckoutPaymentPlan | FlexibleBalanceCheckoutPaymentPlan;
+type CheckoutPlanningContext = Readonly<Record<string, unknown>>;
+export type FlexibleBalanceInitialPaymentPlan = Readonly<{
+    kind: 'stripe';
+}> | Readonly<{
+    kind: 'none';
+}>;
+export type OrderSettlementPlan<TItem, TDiscount, TDiscountApplication> = Readonly<{
+    currency: CurrencyCode;
+    items: NonEmptyArray<TItem>;
+    subtotal: Money<CurrencyCode>;
+    discountTotal: Money<CurrencyCode>;
+    creditTotal: Money<CurrencyCode>;
+    totalAfterDiscount: Money<CurrencyCode>;
+    totalAfterCredits: Money<CurrencyCode>;
+    discount: TDiscount;
+    discountApplication: TDiscountApplication;
+}>;
+export type OrderDraftPlan = Readonly<{
+    status: OrderStatus;
+    paymentMethod: OrderPaymentMethod;
+    paidTotal: Money<CurrencyCode>;
+}>;
+export type OneTimeCheckoutPlan<TContext extends CheckoutPlanningContext, TSettledCart extends CheckoutPlanningSettledCart> = Readonly<{
+    ctx: TContext;
+    settlement: OrderSettlementPlan<TSettledCart['items'][number], TSettledCart['discount'], TSettledCart['discountApplication']>;
+    orderDraft: OrderDraftPlan;
+}>;
+export declare function buildOneTimeCheckoutPlan<TContext extends CheckoutPlanningContext, TSettledCart extends CheckoutPlanningSettledCart>(options: {
+    checkout: CartCheckout;
+    ctx: TContext;
+    settledCart: TSettledCart;
+    paymentPlan: OneTimeCheckoutPlanningPaymentPlan;
+}): Result<OneTimeCheckoutPlan<TContext, TSettledCart>, CheckoutPlanningError>;
+export declare function materializeSettledCart<TPlan extends Pick<OneTimeCheckoutPlan<CheckoutPlanningContext, CheckoutPlanningSettledCart>, 'settlement'>>(plan: TPlan): Readonly<{
+    items: TPlan['settlement']['items'];
+    subtotalCents: number;
+    discountCents: number;
+    creditCents: number;
+    totalAfterDiscountCents: number;
+    totalAfterCreditsCents: number;
+    currency: CurrencyCode;
+    discount: TPlan['settlement']['discount'];
+    discountApplication: TPlan['settlement']['discountApplication'];
+}>;
+export {};

package/dist/_dts/commerce/src/purchase/order-number.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Order numbering utilities.
+ *
+ * Generates human-readable order numbers from site slugs.
+ * Format: "{prefix}-{year}-{sequence}" (e.g., "MAC-2026-0001")
+ */
+/**
+ * Derives a deterministic order prefix from a site slug.
+ *
+ * Strategy: take the first letter of each word (split by hyphens), uppercase.
+ * Single-word slugs use the first 2-3 characters.
+ *
+ * The prefix is stored in the `sites` table (`order_prefix` column)
+ * on first order creation. Collisions are resolved by appending a
+ * numeric suffix (e.g., "YS2"). Site admins can customize via settings.
+ *
+ * @example
+ *   siteSlugToOrderPrefix("macadamia")       // "MAC"
+ *   siteSlugToOrderPrefix("bobs-barbershop") // "BB"
+ *   siteSlugToOrderPrefix("the-art-house")   // "TAH"
+ *   siteSlugToOrderPrefix("pilates")         // "PIL"
+ *   siteSlugToOrderPrefix("a")               // "A"
+ */
+export declare function siteSlugToOrderPrefix(slug: string): string;
+/**
+ * Generates a formatted order number string.
+ *
+ * @example
+ *   generateOrderNumber("MAC", 2026, 1)     // "MAC-2026-0001"
+ *   generateOrderNumber("MAC", 2026, 9999)  // "MAC-2026-9999"
+ *   generateOrderNumber("MAC", 2026, 10000) // "MAC-2026-10000"
+ */
+export declare function generateOrderNumber(prefix: string, year: number, sequenceNumber: number): string;

package/dist/_dts/commerce/src/purchase/orderCancellationPlan.d.ts

@@ -0,0 +1,19 @@
+import { type ShopRefundableOrderItem } from './orderItemSupport';
+import type { OrderItemPlanningRecord } from './orderPlanningTypes';
+import type { OrderPaymentMethod } from './orderTypes';
+export type CancelledOrderEmailItem = Readonly<{
+    title: string;
+    quantity: number;
+}>;
+export type OrderCancellationExecutionPlan<TItem extends OrderItemPlanningRecord = OrderItemPlanningRecord> = Readonly<{
+    itemsToCancel: readonly TItem[];
+    shopRefundItems: readonly ShopRefundableOrderItem<TItem>[];
+    directCancellationItems: readonly TItem[];
+    remainingActiveItems: readonly TItem[];
+}>;
+export declare function planOrderCancellationExecution<TItem extends OrderItemPlanningRecord>(options: Readonly<{
+    paymentMethod: OrderPaymentMethod;
+    allItems: readonly TItem[];
+    itemsToCancel: readonly TItem[];
+}>): OrderCancellationExecutionPlan<TItem>;
+export declare function toCancelledOrderEmailItems(items: readonly OrderItemPlanningRecord[]): readonly CancelledOrderEmailItem[];

package/dist/_dts/commerce/src/purchase/orderCompletionEmailPlan.d.ts

@@ -0,0 +1,71 @@
+import type { EventTicketOrderItemMetadata, MembershipOrderItemMetadata, PassOrderItemMetadata } from './orderItemMetadata';
+import { type ConfirmationEmailPaymentSummary } from './confirmationEmailPayment';
+import type { OrderItemPlanningRecord } from './orderPlanningTypes';
+import type { OrderPaymentMethod } from './orderTypes';
+import type { AttendeeId } from '../../../core/src/index';
+export type OrderCompletionEmailAction = Readonly<{
+    kind: 'send_order_confirmation';
+    orderId: string;
+}> | Readonly<{
+    kind: 'send_event_confirmation';
+    attendeeId: AttendeeId;
+    metadata: EventTicketOrderItemMetadata;
+    paymentSummary: ConfirmationEmailPaymentSummary;
+}> | Readonly<{
+    kind: 'send_pass_bundle_confirmation';
+    attendeeId: AttendeeId;
+    metadata: PassOrderItemMetadata & Readonly<{
+        bundleFulfillment: NonNullable<PassOrderItemMetadata['bundleFulfillment']>;
+    }>;
+}> | Readonly<{
+    kind: 'send_course_enrollment_confirmation';
+    orderId: string;
+    enrollmentId: string;
+    paymentSummary: ConfirmationEmailPaymentSummary;
+}> | Readonly<{
+    kind: 'send_appointment_confirmation';
+    appointmentId: string;
+}> | Readonly<{
+    kind: 'send_membership_activation';
+    customerMembershipId: string;
+    amountPaidCents: number;
+}> | Readonly<{
+    kind: 'send_membership_bundle_confirmation';
+    attendeeId: AttendeeId;
+    metadata: MembershipOrderItemMetadata & Readonly<{
+        bundleFulfillment: NonNullable<MembershipOrderItemMetadata['bundleFulfillment']>;
+    }>;
+}>;
+export type OrderCompletionEmailWarning = Readonly<{
+    kind: 'missing_event_attendee_id';
+    orderItemId: string;
+    orderId: string;
+}> | Readonly<{
+    kind: 'missing_course_enrollment_id';
+    orderItemId: string;
+    orderId: string;
+}> | Readonly<{
+    kind: 'missing_appointment_id';
+    orderItemId: string;
+    orderId: string;
+}> | Readonly<{
+    kind: 'missing_customer_membership_id';
+    orderItemId: string;
+    orderId: string;
+}>;
+export type OrderCompletionEmailPlan = Readonly<{
+    actions: readonly OrderCompletionEmailAction[];
+    warnings: readonly OrderCompletionEmailWarning[];
+}>;
+export declare function buildOrderCompletionEmailPlan(options: Readonly<{
+    items: readonly OrderItemPlanningRecord[];
+    orderPaymentMethod: OrderPaymentMethod;
+    currency: string;
+    flexibleBalanceDueAt?: string | null;
+    settlement: Readonly<{
+        kind: 'settled_in_full';
+    }> | Readonly<{
+        kind: 'collected_by_item';
+        collectedCentsByOrderItemId: Readonly<Record<string, number>>;
+    }>;
+}>): OrderCompletionEmailPlan;