@npm-zenwork/tax-remittance-ui 0.2.6 → 0.4.0

package/dist/api/remittancePayments.d.ts

@@ -11,7 +11,8 @@ export interface RemittancePaymentResponse {
     paymentDate: string;
     status: string | null;
     reason: string | null;
-    /** Federal tax form / state reason for payment — not served by the API yet. */
+    /** Federal IRS form type, or the state agency form actually chosen for the payment
+     * (falls back to Reason for Payment when no form applies, e.g. Bill Payment). */
     formType?: string | null;
 }
 export interface RemittancePaymentStatusCounts {

package/dist/api/statePayments.d.ts

@@ -1,4 +1,4 @@
-import { CreateStatePaymentRequest, StatePaymentFormMetadata, StatePaymentFormReferences, StatePaymentReasonOption, StatePaymentResponse, StatePaymentStateOption, UpdateStatePaymentRequest } from '../types/statePayment';
+import { CreateStatePaymentRequest, StatePaymentFormMetadata, StatePaymentFormReferences, StatePaymentOption, StatePaymentReasonOption, StatePaymentResponse, StatePaymentStateOption, UpdateStatePaymentRequest } from '../types/statePayment';
 import { PagedResult } from '../types/pagination';
 import { PaymentStatus } from '../components/payments/paymentsTableConfig';
 export interface StatePaymentStatusCounts {
@@ -18,6 +18,23 @@ export declare function getStatePaymentStates(signal?: AbortSignal): Promise<Sta
 export declare function getStatePaymentReasons(entityId: number, state: string, signal?: AbortSignal): Promise<StatePaymentReasonOption[]>;
 export declare function getStatePaymentValidationMetadata(entityId: number, state: string, reason: string, signal?: AbortSignal): Promise<StatePaymentFormMetadata>;
 export declare function getStatePaymentFormReferences(entityId: number, state: string, reason: string, signal?: AbortSignal): Promise<StatePaymentFormReferences>;
+/**
+ * Suggests occurrence dates for a recurring series on the rule-scoped Deposit Frequency
+ * vocabulary (frequencyCode from validation-metadata's frequencyOptions) — a convenience the
+ * caller reviews/edits before submitting as explicit Occurrences[] rows. Replaces the legacy
+ * IsRecurring/Frequency/RecurringEndDate server-generated path; see the State Payment Rules
+ * plan, point 4. Rejects (422) when the frequency has no unambiguous fixed interval to generate
+ * from (e.g. SEMI_WEEKLY) — the caller falls back to adding rows manually in that case.
+ */
+export declare function getStatePaymentOccurrenceDates(entityId: number, state: string, reason: string, frequencyCode: string, startDate: string, endDate: string, signal?: AbortSignal): Promise<string[]>;
+/**
+ * Recomputes Tax Period options for a specific Deposit Frequency and Tax Year. The
+ * validation-metadata response's frequencyOptions[].taxPeriodOptions already carries a
+ * current-calendar-year default; call this once the caller has picked a different Tax Year —
+ * leap years and weekday alignment shift date-range boundaries year to year for some
+ * frequencies (Weekly, Semi-weekly, Quarter-monthly).
+ */
+export declare function getStatePaymentTaxPeriods(entityId: number, state: string, reason: string, frequencyCode: string, taxYear: number, signal?: AbortSignal): Promise<StatePaymentOption[]>;
 export declare function getStatePayments({ entityId, status, pageNumber, pageSize, }: GetStatePaymentsQuery): Promise<PagedResult<StatePaymentResponse>>;
 export declare function getStatePaymentStatusCounts(entityId: number): Promise<StatePaymentStatusCounts>;
 export declare function getStatePaymentById(statePaymentDetailId: number): Promise<StatePaymentResponse>;

package/dist/components/payments/RecurringPaymentToggle.d.ts

@@ -1,16 +1,12 @@
 interface RecurringPaymentToggleProps {
     enabled: boolean;
     onChange: (enabled: boolean) => void;
-    frequency: string;
-    endDate: string;
-    onEndDateChange: (endDate: string) => void;
-    endDateError?: string;
     disabled?: boolean;
 }
 /**
- * "Make This a Recurring Payment" panel. When enabled, the backend generates
- * one scheduled payment per occurrence of the chosen frequency, up to the end
- * date entered here.
+ * "Make This a Recurring Payment" panel. When enabled, the caller adds each occurrence
+ * explicitly ("+ Add New" in the Tax Periods & Amounts section below) — every occurrence keeps
+ * its own Tax Period, Tax Amount, and Payment Date, submitted together as one series.
  */
-export declare function RecurringPaymentToggle({ enabled, onChange, frequency, endDate, onEndDateChange, endDateError, disabled, }: RecurringPaymentToggleProps): import("react").JSX.Element;
+export declare function RecurringPaymentToggle({ enabled, onChange, disabled, }: RecurringPaymentToggleProps): import("react").JSX.Element;
 export {};

package/dist/components/payments/RecurringPeriodRows.d.ts

@@ -17,10 +17,10 @@ interface RecurringPeriodRowsProps {
 /**
  * Extra tax period / amount / date rows for a recurring schedule.
  *
- * UI-only for now: StatePaymentDraft and CreateStatePaymentRequest each hold a
- * single period, so only the first row (owned by the form itself) is
- * submitted. These rows capture the intended schedule until the API accepts
- * one.
+ * Each row becomes its own occurrence in CreateStatePaymentRequest.occurrences on submit,
+ * alongside the primary row owned by the form itself — see AddStatePaymentForm's toDraft /
+ * statePaymentFlow's toCreateStatePaymentRequest. Using these rows takes over from the legacy
+ * server-generated Frequency/End Date schedule (they're mutually exclusive on the backend).
  */
 export declare function RecurringPeriodRows({ rows, taxPeriodOptions, onChange, onRemove, onAdd, disabled, }: RecurringPeriodRowsProps): import("react").JSX.Element;
 interface PeriodRowDeleteButtonProps {

package/dist/components/tax-forms/states/stateFormKit.d.ts

@@ -0,0 +1,101 @@
+import { ReactNode } from 'react';
+export interface AmountParts {
+    dollars: string;
+    cents: string;
+}
+/** The white "paper" a return is laid out on. */
+export declare function FormSheet({ children }: {
+    children: ReactNode;
+}): import("react").JSX.Element;
+/** Outer rule around a group of `BoxedRow`s. */
+export declare function BoxedGroup({ children }: {
+    children: ReactNode;
+}): import("react").JSX.Element;
+/**
+ * One ruled row. `columns` is a grid template matching the printed cell widths.
+ * VA-15 runs its city/state/ZIP labels over a single unbroken fill, so the
+ * vertical rules are optional.
+ */
+export declare function BoxedRow({ columns, dividers, children, }: {
+    columns?: string;
+    dividers?: boolean;
+    children: ReactNode;
+}): import("react").JSX.Element;
+/**
+ * Caption-over-value cell — the agency's boxed field.
+ *
+ * `filled` draws the value on the pale blue band the fillable vouchers print
+ * (VA-15); without it the value sits on plain paper (VA-16).
+ */
+export declare function BoxedField({ label, value, filled, }: {
+    label: string;
+    value?: string;
+    filled?: boolean;
+}): import("react").JSX.Element;
+/** The OCR line the agency prints across the return. */
+export declare function ScanLine({ value }: {
+    value: string;
+}): import("react").JSX.Element;
+/** Dollars box, decimal point, cents box — the split money field, read-only. */
+export declare function AmountBox({ amount, label }: {
+    amount: AmountParts;
+    label: string;
+}): import("react").JSX.Element;
+/**
+ * The same field, filled in by the taxpayer. White rather than filled so a line
+ * that wants an entry reads differently from one the payment already answered.
+ */
+export declare function AmountInput({ amount, label, onChange, }: {
+    amount: AmountParts;
+    label: string;
+    onChange: (amount: AmountParts) => void;
+}): import("react").JSX.Element;
+/** Read-only box or input, chosen by whether the caller passes a handler. */
+export declare function AmountField({ amount, label, onChange, }: {
+    amount: AmountParts;
+    label: string;
+    onChange?: (amount: AmountParts) => void;
+}): import("react").JSX.Element;
+/**
+ * A rule with its caption underneath, as the return prints it. Supply
+ * `onChange` for the lines the taxpayer signs and dates; leave it off for
+ * anything the payment already answered.
+ */
+export declare function SignatureLine({ caption, value, placeholder, onChange, maxLength, }: {
+    caption: string;
+    value?: string;
+    placeholder?: string;
+    onChange?: (value: string) => void;
+    maxLength?: number;
+}): import("react").JSX.Element;
+export type FormMode = 'preview' | 'edit';
+/**
+ * A return opens in preview: nothing is editable and it cannot be submitted,
+ * so a filer reads what the payment produced before touching anything. Edit
+ * unlocks the taxpayer-entered fields and turns into Cancel.
+ */
+export declare function FormActions({ mode, onBack, onEdit, onCancel, onSubmit, submitLabel, isSubmitting, }: {
+    mode: FormMode;
+    onBack?: () => void;
+    onEdit: () => void;
+    onCancel: () => void;
+    onSubmit?: () => void;
+    submitLabel: string;
+    isSubmitting?: boolean;
+}): import("react").JSX.Element;
+/**
+ * One numbered money line: `3.  Adjustment Total   [ 2,450 . 00 ]`.
+ *
+ * `columns` lets a form match its own printed proportions — VA-5 gives the
+ * amount more room than VA-16 does.
+ */
+export declare function AmountLine({ number, label, hint, amount, onAmountChange, columns, }: {
+    number: number;
+    label: string;
+    /** Small print under the label, e.g. `(See Instructions)`. */
+    hint?: string;
+    amount: AmountParts;
+    /** Supplied for lines the taxpayer fills in; omitted for payment-bound lines. */
+    onAmountChange?: (amount: AmountParts) => void;
+    columns?: string;
+}): import("react").JSX.Element;

package/dist/components/tax-forms/states/virginia/VA15Form.d.ts

@@ -0,0 +1,38 @@
+import { AmountParts } from '../stateFormKit';
+/** Filled in from the state payment — displayed, never edited here. */
+export interface VA15BoundData {
+    /** Printed under the title, e.g. `315`. */
+    docId: string;
+    /** The quarter this voucher falls in, as printed. */
+    quarterlyPeriodEnding: string;
+    /** The OCR line across the middle of the voucher. */
+    scanLine: string;
+    accountNumber: string;
+    name: string;
+    address: string;
+    city: string;
+    state: string;
+    zipCode: string;
+    /** The payment being remitted — the voucher's only figure. */
+    totalAmountDue: AmountParts;
+}
+/** What the taxpayer completes on the voucher. */
+export interface VA15EditableValues {
+    signature: string;
+    signatureDate: string;
+    phoneNumber: string;
+}
+interface VA15FormProps {
+    data: VA15BoundData;
+    /** Starting entries — anything omitted starts blank. */
+    initialValues?: Partial<VA15EditableValues>;
+    /** Fires on every keystroke with the complete set of entries. */
+    onValuesChange?: (values: VA15EditableValues) => void;
+    /** Leaves the voucher. Omit to hide the Back button. */
+    onBack?: () => void;
+    /** Offered only once the voucher is in edit mode. */
+    onSubmit?: (values: VA15EditableValues) => void;
+    isSubmitting?: boolean;
+}
+export declare function VA15Form({ data, initialValues, onValuesChange, onBack, onSubmit, isSubmitting, }: VA15FormProps): import("react").JSX.Element;
+export {};

package/dist/components/tax-forms/states/virginia/VA15Form.preview.d.ts

@@ -0,0 +1,2 @@
+import { VA15BoundData } from './VA15Form';
+export declare const VA15_TEMPORARY_BOUND_DATA: VA15BoundData;

package/dist/components/tax-forms/states/virginia/VA16Form.d.ts

@@ -1,7 +1,4 @@
-export interface AmountParts {
-    dollars: string;
-    cents: string;
-}
+import { AmountParts } from '../stateFormKit';
 /** Filled in from the state payment — displayed, never edited here. */
 export interface VA16BoundData {
     /** Printed top-right, e.g. `316`. */

package/dist/components/tax-forms/states/virginia/VA5Form.d.ts

@@ -0,0 +1,49 @@
+import { AmountParts } from '../stateFormKit';
+/** Filled in from the state payment — displayed, never edited here. */
+export interface VA5BoundData {
+    /** Printed under the title, e.g. `355`. */
+    docId: string;
+    /** Filing frequency printed beside the Doc ID — `M` monthly, `Q` quarterly. */
+    filingFrequency: string;
+    /** Period end, as printed: `03 / 31 / 2026`. */
+    period: string;
+    dueDate: string;
+    /** The OCR line across the middle of the return. */
+    scanLine: string;
+    accountNumber: string;
+    fein: string;
+    name: string;
+    address: string;
+    city: string;
+    state: string;
+    zipCode: string;
+    /** Line 1 — the payment's withheld tax. */
+    incomeTaxWithheld: AmountParts;
+}
+/** Money lines 2–6, which the taxpayer completes. */
+export interface VA5EditableAmounts {
+    previousPeriodAdjustments: AmountParts;
+    adjustmentTotal: AmountParts;
+    penalty: AmountParts;
+    interest: AmountParts;
+    totalAmountDue: AmountParts;
+}
+export interface VA5EditableValues extends VA5EditableAmounts {
+    signature: string;
+    signatureDate: string;
+    phoneNumber: string;
+}
+interface VA5FormProps {
+    data: VA5BoundData;
+    /** Starting entries — anything omitted starts blank. */
+    initialValues?: Partial<VA5EditableValues>;
+    /** Fires on every keystroke with the complete set of entries. */
+    onValuesChange?: (values: VA5EditableValues) => void;
+    /** Leaves the return. Omit to hide the Back button. */
+    onBack?: () => void;
+    /** Offered only once the return is in edit mode. */
+    onSubmit?: (values: VA5EditableValues) => void;
+    isSubmitting?: boolean;
+}
+export declare function VA5Form({ data, initialValues, onValuesChange, onBack, onSubmit, isSubmitting, }: VA5FormProps): import("react").JSX.Element;
+export {};

package/dist/components/tax-forms/states/virginia/VA5Form.preview.d.ts

@@ -0,0 +1,2 @@
+import { VA5BoundData } from './VA5Form';
+export declare const VA5_TEMPORARY_BOUND_DATA: VA5BoundData;

package/dist/components/tax-forms/states/virginia/VA6Form.d.ts

@@ -0,0 +1,49 @@
+import { AmountParts } from '../stateFormKit';
+/** Filled in from the state payment — displayed, never edited here. */
+export interface VA6BoundData {
+    /** Printed under the title, e.g. `306`. */
+    docId: string;
+    /** The year being summarised, as printed. */
+    calendarYear: string;
+    dueDate: string;
+    /** The OCR line across the middle of the return. */
+    scanLine: string;
+    accountNumber: string;
+    fein: string;
+    name: string;
+    address: string;
+    city: string;
+    state: string;
+    zipCode: string;
+}
+/** What the taxpayer completes on the return. */
+export interface VA6EditableValues {
+    /** Lines 1–12, one per month, January first. */
+    monthlyPayments: AmountParts[];
+    /** 13 — Add Lines 1–12. */
+    totalPayments: AmountParts;
+    /** 14 — Total VA Tax Withheld. */
+    totalTaxWithheld: AmountParts;
+    /** 15 — Lines 13–14. */
+    additionalPayment: AmountParts;
+    paidElectronically: boolean;
+    /** 16 — count of W-2 and 1099 statements, not a money value. */
+    statementCount: string;
+    signature: string;
+    signatureDate: string;
+    phoneNumber: string;
+}
+interface VA6FormProps {
+    data: VA6BoundData;
+    /** Starting entries — anything omitted starts blank. */
+    initialValues?: Partial<VA6EditableValues>;
+    /** Fires on every keystroke with the complete set of entries. */
+    onValuesChange?: (values: VA6EditableValues) => void;
+    /** Leaves the return. Omit to hide the Back button. */
+    onBack?: () => void;
+    /** Offered only once the return is in edit mode. */
+    onSubmit?: (values: VA6EditableValues) => void;
+    isSubmitting?: boolean;
+}
+export declare function VA6Form({ data, initialValues, onValuesChange, onBack, onSubmit, isSubmitting, }: VA6FormProps): import("react").JSX.Element;
+export {};

package/dist/components/tax-forms/states/virginia/VA6Form.preview.d.ts

@@ -0,0 +1,2 @@
+import { VA6BoundData } from './VA6Form';
+export declare const VA6_TEMPORARY_BOUND_DATA: VA6BoundData;

package/dist/components/tax-forms/states/virginia/VA760ESForm.d.ts

@@ -0,0 +1,54 @@
+import { AmountParts } from '../stateFormKit';
+/** A Part I line is answered once per column. */
+export interface ColumnPair {
+    /** Column A — spouse, when filing Status 4 on Form 760PY. */
+    a: AmountParts;
+    /** Column B — yourself; used by all other filers. */
+    b: AmountParts;
+}
+/** Filled in from the state payment — displayed, never edited here. */
+export interface VA760ESBoundData {
+    /** The year being estimated. Every year printed on the worksheet derives from it. */
+    taxYear: string;
+}
+/** Part I — computed separately for each column. */
+export interface VA760ESPairValues {
+    adjustedGrossIncome: ColumnPair;
+    itemizedDeductions: ColumnPair;
+    standardDeduction: ColumnPair;
+    childCareExpenses: ColumnPair;
+    personalExemptions: ColumnPair;
+    deductionsTotal: ColumnPair;
+    taxableIncome: ColumnPair;
+    incomeTax: ColumnPair;
+    taxAdjustments: ColumnPair;
+    estimatedIncomeTax: ColumnPair;
+}
+export interface VA760ESEditableValues extends VA760ESPairValues {
+    /** 10 — Line 9, Column A plus Column B. */
+    totalEstimatedTax: AmountParts;
+    /** 11 — the amount from Line 10. */
+    estimatedTax: AmountParts;
+    /** 12 — expected withholding for the year. */
+    expectedWithholding: AmountParts;
+    /** 13 — Line 11 less Line 12. */
+    estimatedTaxDue: AmountParts;
+    /** 14 — a count of payments, not a money value. */
+    numberOfPayments: string;
+    /** 15 — the installment to enclose payment for. */
+    installmentAmount: AmountParts;
+}
+interface VA760ESFormProps {
+    data: VA760ESBoundData;
+    /** Starting entries — anything omitted starts blank. */
+    initialValues?: Partial<VA760ESEditableValues>;
+    /** Fires on every keystroke with the complete set of entries. */
+    onValuesChange?: (values: VA760ESEditableValues) => void;
+    /** Leaves the worksheet. Omit to hide the Back button. */
+    onBack?: () => void;
+    /** Offered only once the worksheet is in edit mode. */
+    onSubmit?: (values: VA760ESEditableValues) => void;
+    isSubmitting?: boolean;
+}
+export declare function VA760ESForm({ data, initialValues, onValuesChange, onBack, onSubmit, isSubmitting, }: VA760ESFormProps): import("react").JSX.Element;
+export {};

package/dist/components/tax-forms/states/virginia/VA760ESForm.preview.d.ts

@@ -0,0 +1,2 @@
+import { VA760ESBoundData } from './VA760ESForm';
+export declare const VA760ES_TEMPORARY_BOUND_DATA: VA760ESBoundData;