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

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

@@ -1,15 +1,26 @@
 import { ComponentType, SVGProps } from 'react';
+/** Bucket a payment row falls into — derived from its status. */
 export type PaymentStatus = 'drafts' | 'scheduled' | 'submitted' | 'rejected' | 'paid';
+/** Tabs on the Tax Payments table — every bucket, plus the unfiltered "All". */
+export type PaymentTab = 'all' | PaymentStatus;
 export type PaymentActionType = 'draft-actions' | 'view-pdf' | 'view-link' | 'rejected-actions';
-export interface TabTableConfig {
-    columns: string[];
-    emptyMessage: string;
-    actionType: PaymentActionType;
-}
 export declare const statusTabs: {
-    key: PaymentStatus;
+    key: PaymentTab;
     label: string;
-    Icon: ComponentType<SVGProps<SVGSVGElement>>;
-    iconClassName: string;
+    /** Omitted for "All", which is text-only in the design. */
+    Icon?: ComponentType<SVGProps<SVGSVGElement>>;
+    iconClassName?: string;
 }[];
-export declare const tabTableConfig: Record<PaymentStatus, TabTableConfig>;
+/**
+ * How a tab lays out its rows:
+ *  - `default`     status pill, actions in the row menu (unlabelled column)
+ *  - `view-action` same columns, inline View button
+ *  - `draft`       reference ID, no status, view/edit icons + Submit & Pay
+ *  - `rejected`    reference ID, rejected date and reason, view icon + Re-Submit
+ */
+export type PaymentTableLayout = 'default' | 'view-action' | 'draft' | 'rejected';
+export declare const tabLayout: Record<PaymentTab, PaymentTableLayout>;
+export declare const layoutColumns: Record<PaymentTableLayout, string[]>;
+export declare const tabEmptyMessage: Record<PaymentTab, string>;
+/** Actions offered for a row, keyed by the row's own bucket (not the open tab). */
+export declare const rowActionType: Record<PaymentStatus, PaymentActionType>;

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

@@ -11,6 +11,8 @@ export interface RemittancePaymentRow {
     paymentDate: string;
     status: string | null;
     reason: string | null;
+    /** Federal tax form / state reason for payment. `—` when unknown. */
+    formType: string;
     tab: PaymentStatus;
 }
 export declare function formatTaxPeriod(taxPeriod: string | null | undefined): string;
@@ -24,6 +26,7 @@ export declare function mapRemittancePaymentToRow(payment: {
     paymentDate: string;
     status: string | null;
     reason: string | null;
+    formType?: string | null;
 }): RemittancePaymentRow;
 export declare function mapFederalPaymentToRemittanceRow(payment: FederalPaymentResponse): RemittancePaymentRow;
 export declare function mapStatePaymentToRemittanceRow(payment: StatePaymentResponse): RemittancePaymentRow;

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

@@ -1,2 +1,2 @@
-export declare const statePaymentAuthorizationText = "By proceeding, you authorize the payment to the selected tax authority and acknowledge that you are responsible for the accuracy of the information provided.";
+export declare const statePaymentAuthorizationText = "Before your payment is processed, please review the information carefully. By proceeding, you authorize to initiate this payment to the selected tax authority using your chosen bank account. You acknowledge that you are responsible for ensuring the accuracy of the payment information and for complying with all applicable tax filing and payment requirements.";
 export declare const statePaymentAuthorizationCheckboxLabel = "I have reviewed the details and authorize this payment.";

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

@@ -0,0 +1,11 @@
+import { EntityDetailsResponse } from '../../types/entity';
+import { StatePaymentDraft } from '../../types/statePaymentFlow';
+/**
+ * Persist an in-progress state payment as a Draft. Shared by the Bank Account
+ * step and the Authorization step so "Save as Draft" behaves identically in
+ * both places.
+ */
+export declare function useStatePaymentDraftSave(entity: EntityDetailsResponse | null): {
+    upsertPayment: (paymentDraft: StatePaymentDraft) => Promise<import('../../types/statePayment').StatePaymentResponse | null>;
+    saveAsDraft: (paymentDraft: StatePaymentDraft) => Promise<void>;
+};

package/dist/components/settings/BankAccountActionsMenu.d.ts

@@ -3,6 +3,8 @@ interface BankAccountActionsMenuProps {
     account: BankAccountResponse;
     entityId: number;
     onEdit: (account: BankAccountResponse) => void;
+    /** `kebab` is the icon-only trigger used on the bank account cards. */
+    variant?: 'button' | 'kebab';
 }
-export declare function BankAccountActionsMenu({ account, entityId, onEdit }: BankAccountActionsMenuProps): import("react").JSX.Element;
+export declare function BankAccountActionsMenu({ account, entityId, onEdit, variant, }: BankAccountActionsMenuProps): import("react").JSX.Element;
 export {};

package/dist/components/settings/EditEntityForm.d.ts

@@ -0,0 +1,12 @@
+import { EntityDetailsResponse } from '../../types/entity';
+interface EditEntityFormProps {
+    entity: EntityDetailsResponse;
+    onCancel: () => void;
+    onSaved: () => void;
+}
+/**
+ * Edit Entity form — same composition as the Add Entity form (EntityForm), with
+ * the identifier locked and no filing status, which the update payload omits.
+ */
+export declare function EditEntityForm({ entity, onCancel, onSaved }: EditEntityFormProps): import("react").JSX.Element;
+export {};

package/dist/components/settings/TaxAccountDrawer.d.ts

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+import { TaxAccountDetailResponse } from '../../types/taxAccountDetails';
+declare const taxAccountSchema: z.ZodObject<{
+    state: z.ZodString;
+    reasonForPayment: z.ZodString;
+    stateAccountId: z.ZodString;
+    accountId: z.ZodString;
+    taxYear: z.ZodString;
+    frequency: z.ZodOptional<z.ZodString>;
+    status: z.ZodString;
+    notes: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TaxAccountDrawerValues = z.infer<typeof taxAccountSchema>;
+interface TaxAccountDrawerProps {
+    open: boolean;
+    entityId: number | null;
+    /** When set, the drawer edits this account instead of creating one. */
+    account?: TaxAccountDetailResponse | null;
+    onClose: () => void;
+}
+export declare function TaxAccountDrawer({ open, entityId, account, onClose }: TaxAccountDrawerProps): import("react").JSX.Element;
+export {};

package/dist/components/settings/settingsNavConfig.d.ts

@@ -1,5 +1,5 @@
 import { ComponentType, SVGProps } from 'react';
-export type SettingsSectionId = 'bank-accounts' | 'tax-accounts' | 'payment-history' | 'entity-details';
+export type SettingsSectionId = 'bank-accounts' | 'tax-accounts' | 'entity-details';
 export interface SettingsNavItem {
     id: SettingsSectionId;
     title: string;

package/dist/components/settings/taxAccountDrawerConfig.d.ts

@@ -0,0 +1 @@
+export declare const TAX_ACCOUNT_STATUSES: readonly ["Active", "Inactive"];

package/dist/components/tax-forms/TaxFormCard.d.ts

@@ -0,0 +1,7 @@
+import { TaxFormResponse } from '../../types/taxForm';
+interface TaxFormCardProps {
+    form: TaxFormResponse;
+    onAction?: (form: TaxFormResponse) => void;
+}
+export declare function TaxFormCard({ form, onAction }: TaxFormCardProps): import("react").JSX.Element;
+export {};

package/dist/components/tax-forms/TaxFormsGrid.d.ts

@@ -0,0 +1,9 @@
+import { TaxFormResponse } from '../../types/taxForm';
+interface TaxFormsGridProps {
+    forms?: TaxFormResponse[];
+    isLoading?: boolean;
+    isError?: boolean;
+    onFormAction?: (form: TaxFormResponse) => void;
+}
+export declare function TaxFormsGrid({ forms, isLoading, isError, onFormAction, }: TaxFormsGridProps): import("react").JSX.Element;
+export {};

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

@@ -0,0 +1,53 @@
+export interface AmountParts {
+    dollars: string;
+    cents: string;
+}
+/** Filled in from the state payment — displayed, never edited here. */
+export interface VA16BoundData {
+    /** Printed top-right, e.g. `316`. */
+    docId: string;
+    /** Quarter 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–9, which the taxpayer completes. */
+export interface VA16EditableAmounts {
+    previousPeriodAdjustments: AmountParts;
+    adjustedTotal: AmountParts;
+    paymentsMadeThisPeriod: AmountParts;
+    balanceOfTaxDue: AmountParts;
+    penalty: AmountParts;
+    interest: AmountParts;
+    paymentForFollowingMonth: AmountParts;
+    totalAmountDue: AmountParts;
+}
+export interface VA16EditableValues extends VA16EditableAmounts {
+    signature: string;
+    signatureDate: string;
+    phoneNumber: string;
+}
+interface VA16FormProps {
+    data: VA16BoundData;
+    /** Starting entries — anything omitted starts blank. */
+    initialValues?: Partial<VA16EditableValues>;
+    /** Fires on every keystroke with the complete set of entries. */
+    onValuesChange?: (values: VA16EditableValues) => void;
+    /** Leaves the return. Omit to hide the Back button. */
+    onBack?: () => void;
+    /** Offered only once the return is in edit mode. */
+    onSubmit?: (values: VA16EditableValues) => void;
+    isSubmitting?: boolean;
+}
+export declare function VA16Form({ data, initialValues, onValuesChange, onBack, onSubmit, isSubmitting, }: VA16FormProps): import("react").JSX.Element;
+export {};

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

@@ -0,0 +1,2 @@
+import { VA16BoundData } from './VA16Form';
+export declare const VA16_TEMPORARY_BOUND_DATA: VA16BoundData;

package/dist/components/ui/SideDrawer.d.ts

@@ -0,0 +1,18 @@
+import { ReactNode } from 'react';
+interface SideDrawerProps {
+    open: boolean;
+    title: string;
+    onClose: () => void;
+    children: ReactNode;
+    /** Pinned to the bottom of the panel — action buttons live here. */
+    footer?: ReactNode;
+    labelledById?: string;
+    /** Turn off while another drawer is stacked on top, so Escape closes that one only. */
+    closeOnEscape?: boolean;
+}
+/**
+ * Right-hand slide-over panel. Same overlay/escape/scroll-lock behaviour as
+ * the centred modals, but anchored to the edge and full height.
+ */
+export declare function SideDrawer({ open, title, onClose, children, footer, labelledById, closeOnEscape, }: SideDrawerProps): import('react').ReactPortal | null;
+export {};

package/dist/components/ui/StatusPill.d.ts

@@ -0,0 +1,10 @@
+interface StatusPillProps {
+    active: boolean;
+    /** `outline` matches the tax accounts table; `filled` the bank account cards. */
+    variant?: 'filled' | 'outline';
+    activeLabel?: string;
+    inactiveLabel?: string;
+}
+/** Small dot + label pill for Active / Inactive state. */
+export declare function StatusPill({ active, variant, activeLabel, inactiveLabel, }: StatusPillProps): import("react").JSX.Element;
+export {};

package/dist/components/ui/ToastProvider.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 interface ToastContextValue {
-    showSuccess: (title: string, message: string) => void;
-    showError: (title: string, message: string) => void;
+    showSuccess: (title: string, message?: string) => void;
+    showError: (title: string, message?: string) => void;
 }
 export declare function ToastProvider({ children }: {
     children: ReactNode;

package/dist/embedded/EmbeddedContext.d.ts

@@ -11,13 +11,16 @@ interface EmbeddedContextValue {
     refetchEntities: () => Promise<void>;
     enabledPayments: PaymentType[];
     onPaymentRequired?: (info: PaymentRequiredInfo) => void;
+    /** Display name of the signed-in user, read from the access token. */
+    userName?: string;
 }
 interface EmbeddedContextProviderProps {
     onOrganizationCreated?: (org: EntityDetailsResponse) => void;
     enabledPayments?: PaymentType[];
     onPaymentRequired?: (info: PaymentRequiredInfo) => void;
+    userName?: string;
     children: ReactNode;
 }
-export declare function EmbeddedContextProvider({ onOrganizationCreated, enabledPayments, onPaymentRequired, children, }: EmbeddedContextProviderProps): import("react").JSX.Element;
+export declare function EmbeddedContextProvider({ onOrganizationCreated, enabledPayments, onPaymentRequired, userName, children, }: EmbeddedContextProviderProps): import("react").JSX.Element;
 export declare function useEmbeddedContext(): EmbeddedContextValue;
 export {};

package/dist/embedded/EmbeddedWidgetBase.d.ts

@@ -17,6 +17,8 @@ export interface EmbeddedWidgetBaseProps {
     selectEntityFnRef: MutableRefObject<((id: number) => void) | null>;
     /** Payment types this widget instance supports. Controls which dashboard action cards appear. */
     enabledPayments?: PaymentType[];
+    /** Display name of the signed-in user, used to greet them on the dashboard. */
+    userName?: string;
     /** The <Routes> subtree specific to this widget. */
     children: ReactNode;
 }
@@ -30,4 +32,4 @@ export interface EmbeddedWidgetBaseProps {
  *
  * Children should be a <Routes> element with the widget-specific route tree.
  */
-export declare function EmbeddedWidgetBase({ appKey, accessToken, apiBaseUrl, theme, onSessionExpired, onOrganizationCreated, onNavigate, onPaymentRequired, navigateFnRef, selectEntityFnRef, enabledPayments, children, }: EmbeddedWidgetBaseProps): import("react").JSX.Element;
+export declare function EmbeddedWidgetBase({ appKey, accessToken, apiBaseUrl, theme, onSessionExpired, onOrganizationCreated, onNavigate, onPaymentRequired, navigateFnRef, selectEntityFnRef, enabledPayments, userName, children, }: EmbeddedWidgetBaseProps): import("react").JSX.Element;

package/dist/embedded/TaxRemittanceEmbedded.d.ts

@@ -56,6 +56,12 @@ export interface TaxRemittanceEmbeddedProps {
     apiBaseUrl: string;
     /** Optional visual theme overrides. */
     theme?: TaxRemittanceTheme;
+    /**
+     * Optional override for the dashboard greeting ("Welcome, Jane!").
+     * By default the widget reads the name from the access token's claims,
+     * so hosts don't need to pass this.
+     */
+    userName?: string;
     /**
      * Called when the user's session expires (401/403 from the API).
      * Use this to redirect to your own login page.

package/dist/embedded/pages/EmbeddedEntityEditPage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Full-page Edit Entity screen — the same shell as the Add Entity page
+ * (EmbeddedEntityFormPage), so both flows read identically.
+ * Top-left Back returns to the entity list (or state.from).
+ */
+export declare function EmbeddedEntityEditPage(): import("react").JSX.Element;