@npm-zenwork/tax-remittance-ui 0.5.0 → 0.5.2

package/dist/api/entities.d.ts

@@ -17,4 +17,12 @@ interface CreateEntityDetailsResponse {
 export declare function getAllMyEntities(): Promise<EntityDetailsResponse[]>;
 export declare function createEntity(request: CreateEntityDetailsRequest): Promise<CreateEntityDetailsResponse>;
 export declare function updateEntity(entityId: number, request: UpdateEntityDetailsRequest): Promise<EntityDetailsResponse>;
+/**
+ * Activates / deactivates an entity.
+ *
+ * The same PATCH endpoint as updateEntity — it merges only the fields present
+ * in the body (EntitiesController.Update), so status travels on its own rather
+ * than round-tripping the whole profile.
+ */
+export declare function updateEntityStatus(entityId: number, status: string): Promise<EntityDetailsResponse>;
 export {};

package/dist/components/dashboard/useSetupProgress.d.ts

@@ -2,7 +2,11 @@ import { DashboardResponse } from '../../types/dashboard';
 interface UseSetupProgressArgs {
     entityId: number | null;
     entityCount: number;
+    /** True while the entities list itself is still loading. */
+    entitiesLoading: boolean;
     dashboard: DashboardResponse | undefined;
+    /** True while the selected entity's dashboard summary is still loading. */
+    dashboardLoading: boolean;
     /**
      * Full name of the signed-in user, when the host app supplies one. Embedded
      * hosts own the session, so the widget's own storage is empty there.
@@ -15,6 +19,14 @@ export interface SetupProgress {
     hasBankAccount: boolean;
     hasAuthorizedPayment: boolean;
     isComplete: boolean;
+    /**
+     * True until every signal `isComplete` depends on — entities, and (once an
+     * entity is selected) its dashboard summary and bank accounts — has loaded
+     * at least once. Callers must wait for this before branching on
+     * `isComplete`, otherwise the checklist flashes true/false/true as each
+     * query resolves at a different time (e.g. right after login).
+     */
+    isLoading: boolean;
     /** First name of the signed-in user, when the session carries one. */
     userName?: string;
 }
@@ -26,5 +38,5 @@ export interface SetupProgress {
  * are filled in, and scheduling happens later from the drafts tab. The API has
  * no separate authorization flag to read.
  */
-export declare function useSetupProgress({ entityId, entityCount, dashboard, userName, }: UseSetupProgressArgs): SetupProgress;
+export declare function useSetupProgress({ entityId, entityCount, entitiesLoading, dashboard, dashboardLoading, userName, }: UseSetupProgressArgs): SetupProgress;
 export {};

package/dist/components/forms/CustomSelect.d.ts

@@ -0,0 +1,40 @@
+import { ReactNode } from 'react';
+export interface CustomSelectOption {
+    value: string;
+    label: string;
+    disabled?: boolean;
+    /** Small pill shown to the right of the label (e.g. "Coming Soon") — plain text, no markup. */
+    badge?: string;
+}
+interface CustomSelectProps {
+    value: string;
+    onChange: (value: string) => void;
+    options: CustomSelectOption[];
+    placeholder: string;
+    disabled?: boolean;
+    hasError?: boolean;
+    loading?: boolean;
+    loadingLabel?: string;
+    /**
+     * Renders the control with its own label and error line. Omit it when the
+     * caller already provides those — inside a `PaymentField`, say.
+     */
+    label?: string;
+    required?: boolean;
+    error?: string;
+    id?: string;
+    ariaLabel?: string;
+    /** `sm` is the compact inline control toolbars use (pagination, chart headers). */
+    size?: 'md' | 'sm';
+    /** Icon pinned inside the control's left edge, as on the tax-year picker. */
+    leadingIcon?: ReactNode;
+}
+/**
+ * The one dropdown in the app. Every select goes through it so hover/focus/selected
+ * styling stays identical everywhere (border-gov-400 / bg-gov-50, matching the app's
+ * focus-ring accent) — a native <select>'s option list is OS-rendered chrome the page
+ * can't restyle, and can't show a badge (see the Reason for Payment "Coming Soon"
+ * case) at all. Change it here and every dropdown changes with it.
+ */
+export declare function CustomSelect({ value, onChange, options, placeholder, disabled, hasError, loading, loadingLabel, label, required, error, id, ariaLabel, size, leadingIcon, }: CustomSelectProps): import("react").JSX.Element;
+export {};

package/dist/components/forms/FormField.d.ts

@@ -1,4 +1,4 @@
-import { InputHTMLAttributes, ReactNode, SelectHTMLAttributes } from 'react';
+import { InputHTMLAttributes, ReactNode } from 'react';
 export interface FormLabelProps {
     label: string;
     required?: boolean;
@@ -13,13 +13,6 @@ interface FormInputProps extends InputHTMLAttributes<HTMLInputElement> {
     tooltip?: string;
 }
 export declare const FormInput: import('react').ForwardRefExoticComponent<FormInputProps & import('react').RefAttributes<HTMLInputElement>>;
-interface FormSelectProps extends SelectHTMLAttributes<HTMLSelectElement> {
-    label: string;
-    required?: boolean;
-    error?: string;
-    children: ReactNode;
-}
-export declare const FormSelect: import('react').ForwardRefExoticComponent<FormSelectProps & import('react').RefAttributes<HTMLSelectElement>>;
 interface FormSectionProps {
     step?: number;
     title: string;

package/dist/components/forms/PhoneNumberInput.d.ts

@@ -0,0 +1,27 @@
+import { ChangeEvent, FocusEventHandler } from 'react';
+import { UseFormRegisterReturn } from 'react-hook-form';
+interface PhoneNumberInputProps {
+    label?: string;
+    required?: boolean;
+    error?: string;
+    /** Chrome only: `payment` matches the IRS-form fields, everything else uses `default`. */
+    variant?: 'default' | 'payment';
+    placeholder?: string;
+    id?: string;
+    name?: string;
+    readOnly?: boolean;
+    disabled?: boolean;
+    onFocus?: FocusEventHandler<HTMLInputElement>;
+    /** react-hook-form registration — omit for a controlled field. */
+    register?: UseFormRegisterReturn;
+    /** Controlled value/handler — omit when `register` is given. */
+    value?: string;
+    onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
+}
+/**
+ * The only phone number input in the app. Every phone field goes through it so
+ * they all mask alike (`+1 (479) 555-0123`), cap at the same length and accept
+ * digits only — change it here and every form changes with it.
+ */
+export declare function PhoneNumberInput({ label, required, error, variant, placeholder, id, name, readOnly, disabled, onFocus, register, value, onChange, }: PhoneNumberInputProps): import("react").JSX.Element;
+export {};

package/dist/components/onboarding/EntityAddressFields.d.ts

@@ -1,9 +1,10 @@
-import { FieldErrors, UseFormRegister, UseFormRegisterReturn } from 'react-hook-form';
+import { Control, FieldErrors, UseFormRegister, UseFormRegisterReturn } from 'react-hook-form';
 import { StateOption } from '../../lib/useAddressReference';
 import { EntityFormValues } from '../../types/entity';
 import { HelpKey } from './entityHelpContent';
 interface EntityAddressFieldsProps {
     register: UseFormRegister<EntityFormValues>;
+    control: Control<EntityFormValues>;
     errors: FieldErrors<EntityFormValues>;
     zipRegister: UseFormRegisterReturn;
     isUS: boolean;
@@ -13,5 +14,5 @@ interface EntityAddressFieldsProps {
     focusHelp: (key: HelpKey) => () => void;
 }
 /** Registered address for the entity — labels and formatting follow the country. */
-export declare function EntityAddressFields({ register, errors, zipRegister, isUS, state, stateOptions, zipStateMismatch, focusHelp, }: EntityAddressFieldsProps): import("react").JSX.Element;
+export declare function EntityAddressFields({ register, control, errors, zipRegister, isUS, state, stateOptions, zipStateMismatch, focusHelp, }: EntityAddressFieldsProps): import("react").JSX.Element;
 export {};

package/dist/components/onboarding/EntityBusinessFields.d.ts

@@ -1,8 +1,9 @@
-import { FieldErrors, UseFormRegister, UseFormRegisterReturn } from 'react-hook-form';
+import { Control, FieldErrors, UseFormRegister, UseFormRegisterReturn } from 'react-hook-form';
 import { EntityFormValues } from '../../types/entity';
 import { HelpKey } from './entityHelpContent';
 interface EntityBusinessFieldsProps {
     register: UseFormRegister<EntityFormValues>;
+    control: Control<EntityFormValues>;
     errors: FieldErrors<EntityFormValues>;
     einRegister: UseFormRegisterReturn;
     phoneRegister: UseFormRegisterReturn;
@@ -13,5 +14,5 @@ interface EntityBusinessFieldsProps {
     focusHelp: (key: HelpKey) => () => void;
 }
 /** Business account fields: names, contact details, entity type and EIN. */
-export declare function EntityBusinessFields({ register, errors, einRegister, phoneRegister, accountType, idLabel, idPlaceholder, idMaxLength, focusHelp, }: EntityBusinessFieldsProps): import("react").JSX.Element;
+export declare function EntityBusinessFields({ register, control, errors, einRegister, phoneRegister, accountType, idLabel, idPlaceholder, idMaxLength, focusHelp, }: EntityBusinessFieldsProps): import("react").JSX.Element;
 export {};

package/dist/components/onboarding/SecondaryTaxpayerSection.d.ts

@@ -12,6 +12,8 @@ interface SecondaryTaxpayerSectionProps {
     /** Per-field messages, populated on submit. */
     errors: SecondaryTaxpayerErrors;
     onFieldChange: (field: SecondaryField) => (event: ChangeEvent<HTMLInputElement | HTMLSelectElement>) => void;
+    /** Value-based counterpart, for controls that report a value rather than an event. */
+    onFieldValueChange: (field: SecondaryField, value: string) => void;
     onSsnChange: (value: string) => void;
     onSameAsPrimaryChange: (checked: boolean) => void;
 }
@@ -19,5 +21,5 @@ interface SecondaryTaxpayerSectionProps {
  * Joint-filer details, shown for Individual + "Married Filing Jointly".
  * UI-only — nothing here is submitted yet (see SecondaryTaxpayer).
  */
-export declare function SecondaryTaxpayerSection({ values, address, stateOptions, errors, onFieldChange, onSsnChange, onSameAsPrimaryChange, }: SecondaryTaxpayerSectionProps): import("react").JSX.Element;
+export declare function SecondaryTaxpayerSection({ values, address, stateOptions, errors, onFieldChange, onFieldValueChange, onSsnChange, onSameAsPrimaryChange, }: SecondaryTaxpayerSectionProps): import("react").JSX.Element;
 export {};

package/dist/components/onboarding/entityHelpContent.d.ts

@@ -9,7 +9,7 @@ export interface FieldHelp {
     mistake?: string;
 }
 /**
- * Per-field copy for the "How to fill this" side panel — keyed by a help key
+ * Per-field copy for the "How to fill this" side panel - keyed by a help key
  * set on each input's onFocus. Fields without an entry here fall back to the
  * panel's generic copy.
  */

package/dist/components/onboarding/useEntityForm.d.ts

@@ -13,6 +13,7 @@ export interface CreatedEntitySnapshot {
  */
 export declare function useEntityForm(): {
     register: import('react-hook-form').UseFormRegister<EntityFormValues>;
+    control: import('react-hook-form').Control<EntityFormValues, any, EntityFormValues>;
     errors: import('react-hook-form').FieldErrors<EntityFormValues>;
     onSubmit: (e?: React.BaseSyntheticEvent) => Promise<void>;
     error: string | null;
@@ -71,6 +72,7 @@ export declare function useEntityForm(): {
     };
     secondaryStateOptions: import('../../lib/useAddressReference').StateOption[];
     updateSecondaryField: <K extends keyof Omit<SecondaryTaxpayer, "sameAsPrimaryAddress">>(field: K) => (event: ChangeEvent<HTMLInputElement | HTMLSelectElement>) => void;
+    setSecondaryField: <K extends keyof Omit<SecondaryTaxpayer, "sameAsPrimaryAddress">>(field: K, value: string) => void;
     setSecondarySsn: (value: string) => void;
     setSecondarySameAsPrimary: (checked: boolean) => void;
     createdEntity: CreatedEntitySnapshot | null;

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

@@ -26,6 +26,12 @@ interface SubmitAction {
     label: string;
     disabled?: boolean;
     isSubmitting?: boolean;
+    /**
+     * Set false where the submit is blocked by something that does not make the
+     * step unsaveable — an unticked consent box, say: the payment is filled in
+     * and worth keeping as a draft, the taxpayer just has not agreed yet.
+     */
+    blocksDraft?: boolean;
     /**
      * Steps that are a `<form>` leave this off and let the button submit. The
      * federal review step is a plain `<div>`, so it passes its handler here.

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

@@ -9,6 +9,6 @@ interface PaymentRowMenuProps {
     isSubmitting?: boolean;
     isViewPdfLoading?: boolean;
 }
-/** Vertical-dots row menu — holds the actions available for the row's status. */
+/** Vertical-dots row menu - holds the actions available for the row's status. */
 export declare function PaymentRowMenu(props: PaymentRowMenuProps): import("react").JSX.Element;
 export {};

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

@@ -6,7 +6,7 @@ interface RecurringPaymentToggleProps {
 }
 /**
  * "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
+ * 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, disabled, helperText, }: RecurringPaymentToggleProps): import("react").JSX.Element;

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

@@ -5,15 +5,20 @@ interface SignatureFieldGroupProps {
     signature: UseFormRegisterReturn;
     title: UseFormRegisterReturn;
     date: UseFormRegisterReturn;
+    /** Adds a signer-name cell between the signature and the title — state authorizations ask for it. */
+    signerName?: UseFormRegisterReturn;
+    signerNameCaption?: string;
+    signerNamePlaceholder?: string;
     signatureValue: string;
     dateValue?: string;
     dateReadOnly?: boolean;
     errors?: {
         signature?: string;
+        signerName?: string;
         title?: string;
         date?: string;
     };
     signatureCaption?: string;
 }
-export declare function SignatureFieldGroup({ label, required, signature, title, date, signatureValue, dateValue, dateReadOnly, errors, signatureCaption, }: SignatureFieldGroupProps): import("react").JSX.Element;
+export declare function SignatureFieldGroup({ label, required, signature, title, date, signerName, signerNameCaption, signerNamePlaceholder, signatureValue, dateValue, dateReadOnly, errors, signatureCaption, }: SignatureFieldGroupProps): import("react").JSX.Element;
 export {};

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

@@ -26,6 +26,13 @@ export declare function getSubcategoryCodeLabels(taxFormType: string): {
 export declare function isValidAmountField(value: string): boolean;
 export declare function sanitizeFederalAmountInput(raw: string): string;
 export declare function parseAmountField(value: string): number | null;
+/**
+ * Settle a half-typed amount when the field loses focus: `123` becomes
+ * `123.00`, `123.4` becomes `123.40`, `12.` becomes `12.00`. An empty field is
+ * left empty — a blank is "not filled in yet", not zero — and anything that
+ * isn't a number is returned untouched so validation can report it as typed.
+ */
+export declare function formatAmountFieldOnBlur(value: string): string;
 export declare function sumSubcategoryAmounts(amount1: string, amount2: string, amount3: string, includeAmount3: boolean): number;
 export declare function amountsEqual(left: number, right: number): boolean;
 /** Maps subcategory amounts to IRS API codes ("1", "2", "3") per Tax1099 backend. */

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

@@ -9,3 +9,10 @@ export declare function getTaxPeriodYearBounds(): {
     minYear: number;
     maxYear: number;
 };
+/**
+ * How a federal form's tax period should be read back. The form dictates the cadence:
+ * only 720/941 file per quarter, the annual forms (940, 943, 945, CT-1, …) file once for
+ * the whole tax year even though their period code carries the filing month.
+ */
+export type FederalTaxPeriodKind = 'quarterly' | 'annual' | 'monthly';
+export declare function getTaxPeriodKindForTaxForm(taxFormType: string | null | undefined): FederalTaxPeriodKind;

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

@@ -18,7 +18,11 @@ export interface RemittancePaymentRow {
      * gates whether the list's row-level "Submit & Pay" may submit directly (see PaymentsPage). */
     isAuthorized: boolean;
 }
-export declare function formatTaxPeriod(taxPeriod: string | null | undefined): string;
+/**
+ * `taxFormType` is what makes a `YYYYMM` period readable: 202612 is Q4 on a 941 but the whole
+ * 2026 tax year on a 940. Without it the month is shown as-is rather than guessed at.
+ */
+export declare function formatTaxPeriod(taxPeriod: string | null | undefined, taxFormType?: string | null): string;
 export declare function mapRemittancePaymentToRow(payment: {
     id: number;
     category: 'federal' | 'state';

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

@@ -1,3 +1,3 @@
-export declare const statePaymentAuthorizationIntro = "By signing below, you authorize Zenwork Payments to initiate this tax payment using the payment details you provided.";
+export declare const statePaymentAuthorizationIntro = "By signing below, you authorize Govpay Payments to initiate this tax payment using the payment details you provided.";
 export declare const statePaymentAuthorizationAcknowledgements: string[];
 export declare const statePaymentAuthorizationClosing = "By signing, you confirm that you are authorized to act on behalf of the taxpayer or business listed above.";

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

@@ -6,7 +6,7 @@ interface EditEntityFormProps {
 }
 /**
  * Edit Entity form — same composition as the Add Entity form (EntityForm), with
- * the identifier locked and no filing status, which the update payload omits.
+ * the identifier locked. Filing Status is editable here too, same as at creation.
  */
 export declare function EditEntityForm({ entity, onCancel, onSaved }: EditEntityFormProps): import("react").JSX.Element;
 export {};

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

@@ -0,0 +1,35 @@
+import { CSSProperties, RefObject } from 'react';
+interface AnchoredLayerOptions {
+    open: boolean;
+    /** The trigger the layer hangs off. */
+    anchorRef: RefObject<HTMLElement | null>;
+    /** The floating element itself — needed so a click inside it is not "outside". */
+    layerRef: RefObject<HTMLElement | null>;
+    onDismiss: () => void;
+    /** `anchor` matches the trigger's width (dropdowns); a number pins it (menus). */
+    width?: number | 'anchor';
+    /** `end` right-aligns the layer with the trigger, as row menus do. */
+    align?: 'start' | 'end';
+    gap?: number;
+    /** Caps a scrolling list; omit for menus, which are measured instead. */
+    maxHeight?: number;
+}
+/**
+ * Positions a floating layer against its trigger in viewport coordinates, for
+ * use with a portal. Anything rendered this way is immune to the two things
+ * that break an `absolute` popup: an ancestor's `overflow` clipping it (the
+ * payments table scroller) and a later sibling's stacking context painting over
+ * it. Repositions while the page or a drawer scrolls, and handles dismissal on
+ * outside click and Escape.
+ *
+ * Returns `null` until the first measurement, so callers render nothing yet.
+ */
+export declare function useAnchoredLayer({ open, anchorRef, layerRef, onDismiss, width, align, gap, maxHeight, }: AnchoredLayerOptions): CSSProperties | null;
+/**
+ * Where a floating layer is mounted. The widget's own root rather than
+ * `document.body`: the `--embedded-*` tokens the gov-* palette reads are scoped
+ * to `.tax-remittance-embedded`, and outside it those colours fall back to the
+ * unthemed defaults.
+ */
+export declare function getLayerHost(anchor: HTMLElement | null): HTMLElement | null;
+export {};

package/dist/embedded/EmbeddedLayout.d.ts

@@ -10,9 +10,7 @@ export interface PortalOutletContext {
     setSelectedEntityId: (entityId: number) => void;
 }
 /**
- * Minimal shell for the embedded widget — no sidebar, no header branding.
- * Renders a compact top bar with:
- *   - Entity selector (dropdown) when multiple entities exist
- *   - Back button when on a sub-page
+ * Minimal shell for the embedded widget — no sidebar, no header branding, no
+ * top bar. Each page carries its own heading and back affordance.
  */
 export declare function EmbeddedLayout(): import("react").JSX.Element;