@veevarts/design-system 2.5.0 → 2.6.0

package/dist/patterns/InstallmentSchedule/types.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 export type InstallmentScheduleMode = 'automatic' | 'manual';
 export type InstallmentFrequency = 'weekly' | 'monthly' | 'quarterly' | 'annual';
-export type InstallmentStatus = 'scheduled' | 'paid' | 'payment_due' | 'overdue' | 'failed' | 'refunded' | 'disputed' | 'canceled' | 'processing' | 'pending_confirmation';
+export type InstallmentStatus = 'scheduled' | 'paid' | 'payment_due' | 'overdue' | 'failed' | 'refunded' | 'partially_refunded' | 'disputed' | 'canceled' | 'processing' | 'pending_confirmation';
 export type ScheduledInstallment = {
     id: string;
     name?: string | null;
@@ -13,9 +13,22 @@ export type ScheduledInstallment = {
      * or an ISO timestamp (shown in the viewer's timezone). Named after the
      * field the commitments API already returns for this, so installments
      * passed straight through from the API carry it without any mapping.
-     * `InstallmentTable` shows it on `paid` rows only; omit it to show none.
+     * `InstallmentTable` shows it on rows whose payment happened (`paid`,
+     * `partially_refunded`, `refunded`) and on no other status; omit it to
+     * show none.
      */
     fulfilledAt?: string | null;
+    /**
+     * FR-1422 — how much of the installment was refunded, in the same units as
+     * `amount` (a major-unit number: `50` is $50.00). `InstallmentTable`
+     * formats it with its own `currency` and `locale` and shows it as
+     * "Refunded $50.00" under the amount of a `partially_refunded` row.
+     *
+     * Ignored on every other status: a `refunded` row gave the whole amount
+     * back, so its amount and badge already say it. Also ignored when missing,
+     * zero or negative, so a row never reads "Refunded $0.00".
+     */
+    refundedAmount?: number | null;
 };
 export type AutomaticScheduleSettings = {
     numberOfInstallments: number;
@@ -120,8 +133,18 @@ export type InstallmentTableLabels = {
     installmentId?: string;
     amount?: string;
     scheduledDate?: string;
-    /** Prefix of the paid date shown under the scheduled date of a paid row: "Paid on Jun 3, 2026". */
+    /**
+     * Prefix of the paid date shown under the scheduled date of a row whose
+     * payment happened: "Paid on Jun 3, 2026".
+     */
     paidOn?: string;
+    /** FR-1422 — text of the `partially_refunded` status badge. Defaults to "Partially refunded". */
+    partiallyRefunded?: string;
+    /**
+     * FR-1422 — prefix of the refunded amount shown under the amount of a
+     * `partially_refunded` row: "Refunded $50.00". Defaults to "Refunded".
+     */
+    refundedAmount?: string;
     status?: string;
     actions?: string;
     payNow?: string;
@@ -151,8 +174,9 @@ export type InstallmentTableProps = {
     /**
      * FR-1619 — statuses for which the Pay Now button is NOT rendered on a row.
      * Typed with the `InstallmentStatus` union so consumers get compile-time
-     * safety on status keys. The pre-existing `paid` disabled guard still
-     * applies to any Pay Now button that IS rendered. Defaults to `[]`.
+     * safety on status keys. A Pay Now button that IS rendered is still
+     * disabled on a row whose payment already happened (`paid`,
+     * `partially_refunded`, `refunded`). Defaults to `[]`.
      */
     payNowHiddenStatuses?: InstallmentStatus[];
     showSavedIndicator?: boolean;

package/dist/patterns/InstallmentSchedule/utils.d.ts

@@ -28,3 +28,9 @@ export declare function hasManualRowErrors(errors: ManualRowErrors): boolean;
  * where the generator put it.
  */
 export declare function applyFirstInstallmentDateOverride(installments: ScheduledInstallment[], firstInstallmentDateOverride?: string): ScheduledInstallment[];
+/**
+ * Whether the installment's payment already happened: it was paid, and may
+ * since have been refunded in part or in full. Such a row is a record of money
+ * that moved, so it cannot be paid again, edited or deleted.
+ */
+export declare function isSettledInstallment(status: ScheduledInstallment['status']): boolean;

package/dist/patterns/PaymentSubAmountInput/PaymentSubAmountInput.d.ts

@@ -10,6 +10,8 @@ export interface PaymentSubAmountInputProps {
     defaultValue?: string;
     /** Fires on every keystroke with the raw string. */
     onChange?: (next: string) => void;
+    /** Fires when the amount field loses focus. */
+    onBlur?: () => void;
     /** Placeholder shown when value is empty (e.g. "$150.00"). */
     placeholder?: string;
     isDisabled?: boolean;

package/dist/patterns/shared/useDecimalDraft.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Keeps the text a cashier typed into a money input separate from the number
+ * the host holds.
+ *
+ * A money input whose display is `String(value)` loses what the cashier is
+ * mid-way through typing: `'40.'` parses to `40` and is re-rendered as `'40'`,
+ * so the next `0` produces `'400'` and `'40.00'` ends up read as 4000. The hook
+ * keeps the typed string and shows it while it still parses to `value` (the
+ * echo of the cashier's own keystroke). When the host holds a number the draft
+ * does not represent (a reset, a prefill, a host that ignores the keystroke),
+ * the input shows `format(value)` instead, so the host stays in control.
+ */
+/**
+ * Whether `text` is one amount, possibly partial, in a currency with
+ * `fractionDigits` minor digits: digits, then at most one `.` or `,` followed
+ * by at most `fractionDigits` digits (`''`, `'40'`, `'40.'`, `'40,5'`, `'.5'`).
+ * Anything else would show one amount while emitting another, because
+ * `parseFloat` reads only a prefix and `,` is the decimal separator: `'40.5.9'`
+ * and `'4a'` would emit 40.5 and 4, and `'1,000'` would emit 1. Callers reject
+ * such a keystroke instead of storing it, so the input keeps what it showed.
+ */
+export declare const isDecimalDraft: (text: string, fractionDigits: number) => boolean;
+/** Parses a typed amount (`'40.5'`, `'40,5'`, `'40.'`); `null` when there is no number yet (`''`, `'.'`, `','`). */
+export declare const parseDecimalDraft: (draft: string) => number | null;
+export interface DecimalDraft {
+    /** The text to show in the input. */
+    draft: string;
+    /** Stores the text the cashier typed. */
+    setDraft: (next: string) => void;
+    /** Rewrites the draft in its canonical form (`'40.'` → `'40'`) without changing its value. */
+    normalize: () => void;
+}
+export declare const useDecimalDraft: (value: number | null | undefined, format: (value: number | null | undefined) => string) => DecimalDraft;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@veevarts/design-system",
     "private": false,
-    "version": "2.5.0",
+    "version": "2.6.0",
     "type": "module",
     "main": "dist/index.js",
     "module": "dist/index.js",