@npm-zenwork/tax-remittance-ui 0.2.5 → 0.3.0

package/dist/types/statePayment.d.ts

@@ -1,3 +1,14 @@
+/**
+ * One row of an explicit Occurrences[] series — see CreateStatePaymentRequest.occurrences and
+ * the State Payment Rules plan, point 3. Each occurrence carries its own Tax Period, unlike the
+ * legacy IsRecurring/Frequency/RecurringEndDate path, which stamps one period across every
+ * server-generated date.
+ */
+export interface StatePaymentOccurrenceRequest {
+    taxPeriod?: string | null;
+    taxAmount: number;
+    paymentDate: string;
+}
 export interface CreateStatePaymentRequest {
     entityId: number;
     state: string;
@@ -6,14 +17,17 @@ export interface CreateStatePaymentRequest {
     accountId: string;
     letterId?: string | null;
     taxYear: string;
-    /** Optional for bill payment; required for every other payment reason. */
+    /** Optional for bill payment; required for every other payment reason. Legacy single-payment
+     * path only — omitted (may be null) when occurrences is supplied. */
     taxPeriod?: string | null;
-    taxAmount: number;
-    paymentDate: string;
+    taxAmount?: number | null;
+    paymentDate?: string | null;
     bankAccountDetailId: number;
     isRecurring?: boolean;
     frequency?: string | null;
     recurringEndDate?: string | null;
+    formName?: string | null;
+    occurrences?: StatePaymentOccurrenceRequest[];
 }
 export interface UpdateStatePaymentRequest {
     state: string;
@@ -27,6 +41,7 @@ export interface UpdateStatePaymentRequest {
     taxAmount: number;
     paymentDate: string;
     bankAccountDetailId: number;
+    formName?: string | null;
 }
 export interface StatePaymentResponse {
     statePaymentDetailId: number;
@@ -49,6 +64,7 @@ export interface StatePaymentResponse {
     recurringEndDate: string | null;
     recurringGroupId: string | null;
     createdAt: string;
+    formName: string | null;
 }
 export interface StatePaymentStateOption {
     code: string;
@@ -74,6 +90,12 @@ export interface StatePaymentLetterIdRule {
     example: string | null;
     message: string;
 }
+/** One Deposit Frequency valid for a (State, Reason), with the Tax Periods valid under it. */
+export interface StatePaymentFrequencyOption {
+    code: string;
+    label: string;
+    taxPeriodOptions: StatePaymentOption[];
+}
 export interface StatePaymentFormMetadata {
     rulesVersion: string;
     state: string;
@@ -88,6 +110,10 @@ export interface StatePaymentFormMetadata {
     taxPeriodRequired: boolean;
     letterId: StatePaymentLetterIdRule;
     notes: string[];
+    frequencyMode: 'Fixed' | 'AccountAssigned' | 'NotApplicable';
+    maxRecurringRows: number;
+    sourceNote: string | null;
+    frequencyOptions: StatePaymentFrequencyOption[];
 }
 export interface StatePaymentFormReferenceItem {
     formName: string;

package/dist/types/statePaymentFlow.d.ts

@@ -1,4 +1,11 @@
 import { CreateStatePaymentRequest, StatePaymentResponse, UpdateStatePaymentRequest } from './statePayment';
+/** One row of an explicit occurrence series — draft-form (string) counterpart of
+ * StatePaymentOccurrenceRequest, mirroring how the other draft fields stay strings until submit. */
+export interface StatePaymentDraftOccurrence {
+    taxPeriod: string;
+    taxAmount: string;
+    paymentDate: string;
+}
 export interface StatePaymentDraft {
     statePaymentDetailId?: number;
     state: string;
@@ -17,6 +24,8 @@ export interface StatePaymentDraft {
     isRecurring?: boolean;
     frequency?: string;
     recurringEndDate?: string;
+    formName?: string;
+    additionalOccurrences?: StatePaymentDraftOccurrence[];
 }
 export interface StatePaymentFlowState {
     from?: string;

package/dist/types/taxAccountDetails.d.ts

@@ -1,50 +1,54 @@
 /**
  * Tax account detail types — mirror the backend `portal/tax-accounts` contract
- * (TaxAccountResponse + nested Virginia). Distinct from the list-summary
- * `TaxAccountResponse` in ./taxAccount.ts.
+ * (TaxAccountResponse). One generic shape for every state; no state-specific
+ * sub-fields — a saved account is scoped to State + ReasonForPayment. Address
+ * fields aren't part of the redesigned Tax Accounts UI and are optional.
  */
-export interface VirginiaTaxAccountRequest {
-    virginiaTaxAccountId: string;
-    virginiaWithholdingAccountingId: string;
-    unemploymentTaxAccountId: string;
-    virginiaDepartmentOfTaxationClientNumber: string;
-    businessLocationCode: string;
-    franchiseTaxAccount: string;
-    transientOccupancyTaxAccountId?: string | null;
-    certificateOfAuthorityNumber?: string | null;
-    licensedProfessionalEmployerEntityNumber?: string | null;
-}
 export interface CreateTaxAccountRequest {
     entityId: number;
     state: string;
-    city: string;
-    zipCode: string;
-    address1: string;
+    reasonForPayment: string;
+    stateAccountId: string;
+    accountId: string;
+    taxYear?: string | null;
+    frequency?: string | null;
+    notes?: string | null;
+    city?: string | null;
+    zipCode?: string | null;
+    address1?: string | null;
     address2?: string | null;
-    virginia?: VirginiaTaxAccountRequest | null;
 }
 export interface UpdateTaxAccountRequest {
     state?: string;
-    city?: string;
-    zipCode?: string;
-    address1?: string;
+    reasonForPayment?: string;
+    stateAccountId?: string;
+    accountId?: string;
+    taxYear?: string | null;
+    frequency?: string | null;
+    notes?: string | null;
+    city?: string | null;
+    zipCode?: string | null;
+    address1?: string | null;
     address2?: string | null;
     status?: string;
-    virginia?: VirginiaTaxAccountRequest | null;
-}
-export interface VirginiaTaxAccountDetailResponse extends VirginiaTaxAccountRequest {
-    virginiaTaxAccountDetailId: number;
 }
 export interface TaxAccountDetailResponse {
     taxAccountDetailId: number;
     entityId: number;
     state: string;
-    city: string;
-    zipCode: string;
-    address1: string;
+    reasonForPayment: string;
+    stateAccountId: string;
+    accountId: string;
+    taxYear: string | null;
+    frequency: string | null;
+    notes: string | null;
+    city: string | null;
+    zipCode: string | null;
+    address1: string | null;
     address2: string | null;
-    status: string | null;
+    status: string;
     createdAt: string;
     updatedAt: string;
-    virginia: VirginiaTaxAccountDetailResponse | null;
+    frequencyValid: boolean;
+    frequencyValidationMessage: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npm-zenwork/tax-remittance-ui",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "Embeddable Tax Remittance portal — React component library",
   "type": "module",
   "main": "./dist/index.cjs",

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

@@ -1,8 +0,0 @@
-import { MonthlyOverview } from '../../types/dashboard';
-interface MonthlyOverviewSectionProps {
-    entityId: number | null;
-    initialOverview?: MonthlyOverview;
-    isDashboardLoading?: boolean;
-}
-export declare function MonthlyOverviewSection({ entityId, initialOverview, isDashboardLoading, }: MonthlyOverviewSectionProps): import("react").JSX.Element;
-export {};

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

@@ -1,8 +0,0 @@
-import { DashboardPaymentsPage } from '../../types/dashboard';
-interface MyPaymentsTableProps {
-    entityId: number | null;
-    initialPayments?: DashboardPaymentsPage;
-    isDashboardLoading?: boolean;
-}
-export declare function MyPaymentsTable({ entityId, initialPayments, isDashboardLoading, }: MyPaymentsTableProps): import("react").JSX.Element;
-export {};

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

@@ -1,21 +0,0 @@
-import { PaymentCategorySummary as ApiPaymentCategorySummary } from '../../types/dashboard';
-type SummaryAmountKey = 'submitted' | 'paid' | 'scheduled' | 'failed';
-interface StatItem {
-    label: string;
-    key: SummaryAmountKey;
-    dotClassName: string;
-}
-interface PaymentSummaryCardProps {
-    entityId: number | null;
-    category: 'federal' | 'state' | 'local';
-    title: string;
-    subtitlePrefix: string;
-    defaultTaxYear: number;
-    taxYearOptions: number[];
-    initialSummary?: ApiPaymentCategorySummary;
-    isDashboardLoading?: boolean;
-    stats: StatItem[];
-    comingSoon?: boolean;
-}
-export declare function PaymentSummaryCard({ entityId, category, title, subtitlePrefix, defaultTaxYear, taxYearOptions, initialSummary, isDashboardLoading, stats, comingSoon, }: PaymentSummaryCardProps): import("react").JSX.Element;
-export {};

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

@@ -1,32 +0,0 @@
-import { z } from 'zod';
-import { TaxAccountDetailResponse } from '../../types/taxAccountDetails';
-declare const taxAccountSchema: z.ZodObject<{
-    state: z.ZodString;
-    city: z.ZodString;
-    zipCode: z.ZodString;
-    address1: z.ZodString;
-    address2: z.ZodOptional<z.ZodString>;
-    virginiaTaxAccountId: z.ZodOptional<z.ZodString>;
-    virginiaWithholdingAccountingId: z.ZodOptional<z.ZodString>;
-    unemploymentTaxAccountId: z.ZodOptional<z.ZodString>;
-    virginiaDepartmentOfTaxationClientNumber: z.ZodOptional<z.ZodString>;
-    businessLocationCode: z.ZodOptional<z.ZodString>;
-    franchiseTaxAccount: z.ZodOptional<z.ZodString>;
-    transientOccupancyTaxAccountId: z.ZodOptional<z.ZodString>;
-    certificateOfAuthorityNumber: z.ZodOptional<z.ZodString>;
-    licensedProfessionalEmployerEntityNumber: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export type TaxAccountFormValues = z.infer<typeof taxAccountSchema>;
-interface AddTaxAccountFormProps {
-    entityId: number;
-    /** When set, the form edits this tax account (PATCH) instead of creating one. */
-    taxAccountDetailId?: number;
-    initialValues?: TaxAccountFormValues;
-    onCancel: () => void;
-    onSuccess?: () => void;
-}
-export declare const emptyTaxAccountValues: TaxAccountFormValues;
-/** Maps a fetched tax account into form values for editing. */
-export declare function toTaxAccountFormValues(account: TaxAccountDetailResponse): TaxAccountFormValues;
-export declare function AddTaxAccountForm({ entityId, taxAccountDetailId, initialValues, onCancel, onSuccess, }: AddTaxAccountFormProps): import("react").JSX.Element;
-export {};

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

@@ -1,8 +0,0 @@
-import { EntityDetailsResponse } from '../../types/entity';
-interface EditEntityModalProps {
-    open: boolean;
-    entity: EntityDetailsResponse;
-    onClose: () => void;
-}
-export declare function EditEntityModal({ open, entity, onClose }: EditEntityModalProps): import('react').ReactPortal | null;
-export {};

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

@@ -1,18 +0,0 @@
-export declare const virginiaCities: readonly ["Alexandria", "Arlington", "Chesapeake", "Hampton", "Lynchburg", "Newport News", "Norfolk", "Richmond", "Roanoke", "Virginia Beach"];
-export type TaxAccountFieldName = 'virginiaTaxAccountId' | 'virginiaWithholdingAccountingId' | 'unemploymentTaxAccountId' | 'virginiaDepartmentOfTaxationClientNumber' | 'businessLocationCode' | 'franchiseTaxAccount' | 'transientOccupancyTaxAccountId' | 'certificateOfAuthorityNumber' | 'licensedProfessionalEmployerEntityNumber';
-export interface TaxAccountFieldDef {
-    name: TaxAccountFieldName;
-    label: string;
-    required: boolean;
-    placeholder?: string;
-}
-export interface TaxAccountFieldGroup {
-    title: string;
-    fields: TaxAccountFieldDef[];
-}
-/**
- * State-specific field sections, keyed by state code. A state with no entry
- * here has no state-specific card rendered — supporting a new state is adding
- * a key here, never a change to the form's rendering components.
- */
-export declare const STATE_TAX_FIELD_GROUPS: Partial<Record<string, TaxAccountFieldGroup[]>>;

package/dist/pages/AddTaxAccountPage.d.ts

@@ -1 +0,0 @@
-export declare function AddTaxAccountPage(): import("react").JSX.Element;

package/dist/types/taxAccount.d.ts

@@ -1,9 +0,0 @@
-export interface TaxAccountResponse {
-    taxAccountId: number;
-    entityId: number;
-    accountName: string;
-    federalStateId: string;
-    paymentCount: number;
-    formTypes: string[];
-    status: string | null;
-}