@gusto/embedded-react-sdk 0.56.7 → 0.57.1

package/dist/src/i18n/types.d.ts

@@ -35,6 +35,10 @@ export interface Resources {
   /** */
   'Company.Management.PayScheduleAssignment': Translations.CompanyManagementPayScheduleAssignment
   /** */
+  'Company.Management.TaxPaymentDetail': Translations.CompanyManagementTaxPaymentDetail
+  /** */
+  'Company.Management.TaxPaymentsList': Translations.CompanyManagementTaxPaymentsList
+  /** */
   'Company.OnboardingOverview': Translations.CompanyOnboardingOverview
   /** */
   'Company.PaySchedule': Translations.CompanyPaySchedule
@@ -377,9 +381,9 @@ export namespace Translations {
       email: string
       /** @defaultValue `"Email addresses must match"` */
       emailMismatch: string
-      /** @defaultValue `"First name is required"` */
+      /** @defaultValue `"Enter a valid first name"` */
       firstName: string
-      /** @defaultValue `"Last name is required"` */
+      /** @defaultValue `"Enter a valid last name"` */
       lastName: string
       /** @defaultValue `"Phone number must be 10 digits"` */
       phone: string
@@ -1029,19 +1033,35 @@ export namespace Translations {
     title: string
     /** @defaultValue `"You have assigned everyone to be on one pay schedule."` */
     description: string
+    /** @defaultValue `"You have assigned employees to pay schedules by compensation type."` */
+    compensationDescription: string
+    /** @defaultValue `"Pay schedules by compensation type"` */
+    compensationTableLabel: string
     /** @defaultValue `"Manage"` */
     manageCta: string
     /** @defaultValue `"Edit"` */
     editCta: string
+    /** @defaultValue `"Edit schedule"` */
+    editScheduleCta: string
     /** @defaultValue `"Edit pay schedule"` */
     editScheduleAriaLabel: string
     /** @defaultValue `"Edit AutoPilot"` */
     editAutoPilotAriaLabel: string
+    /** @defaultValue `"Pay schedule actions"` */
+    rowMenuTriggerLabel: string
     labels: {
       /** @defaultValue `"Name"` */
       name: string
       /** @defaultValue `"Frequency"` */
       frequency: string
+      /** @defaultValue `"Schedule"` */
+      schedule: string
+    }
+    compensationTypes: {
+      /** @defaultValue `"Hourly"` */
+      hourly: string
+      /** @defaultValue `"Salaried"` */
+      salaried: string
     }
     autoPilot: {
       /** @defaultValue `"AutoPilot"` */
@@ -1070,6 +1090,12 @@ export namespace Translations {
           /** @defaultValue `"Choose one pay schedule for all your employees"` */
           description: string
         }
+        hourlySalaried: {
+          /** @defaultValue `"Separate schedules by compensation type"` */
+          label: string
+          /** @defaultValue `"Choose one pay schedule for hourly employees and another for salaried employees"` */
+          description: string
+        }
       }
     }
     scheduleStep: {
@@ -1082,6 +1108,20 @@ export namespace Translations {
       /** @defaultValue `"Add pay schedule"` */
       addPayScheduleCta: string
     }
+    compensationStep: {
+      /** @defaultValue `"Assign employees"` */
+      heading: string
+      /** @defaultValue `"Hourly employees"` */
+      hourlyPayScheduleLabel: string
+      /** @defaultValue `"The pay schedule to use for hourly employees."` */
+      hourlyPayScheduleDescription: string
+      /** @defaultValue `"Salaried employees"` */
+      salariedPayScheduleLabel: string
+      /** @defaultValue `"The pay schedule to use for salaried employees."` */
+      salariedPayScheduleDescription: string
+      /** @defaultValue `"Add pay schedule"` */
+      addPayScheduleCta: string
+    }
     reviewStep: {
       /** @defaultValue `"Review changes"` */
       heading: string
@@ -1109,6 +1149,148 @@ export namespace Translations {
     /** @defaultValue `"Submit"` */
     submitCta: string
   }
+  /** Translation keys for the `Company.Management.TaxPaymentDetail` i18n namespace. */
+  export interface CompanyManagementTaxPaymentDetail {
+    /** @defaultValue `"Back to tax payments"` */
+    backCta: string
+    /** @defaultValue `"Unknown agency"` */
+    unknownAgency: string
+    /** @defaultValue `"Federal"` */
+    federal: string
+    /** @defaultValue `"State · {{jurisdiction}}"` */
+    state: string
+    /** @defaultValue `"—"` */
+    notAvailable: string
+    status: {
+      /** @defaultValue `"Paid"` */
+      paid: string
+      /** @defaultValue `"Scheduled"` */
+      scheduled: string
+      /** @defaultValue `"Overdue"` */
+      overdue: string
+      /** @defaultValue `"Refund / Credit"` */
+      refund: string
+    }
+    overdueAlert: {
+      /** @defaultValue `"Payment overdue"` */
+      label: string
+      /** @defaultValue `"This payment was due on {{dueDate}} and has not been sent. Take action to avoid penalties."` */
+      description: string
+    }
+    details: {
+      /** @defaultValue `"Payment details"` */
+      title: string
+      /** @defaultValue `"Jurisdiction"` */
+      jurisdiction: string
+      /** @defaultValue `"Period"` */
+      period: string
+      /** @defaultValue `"Due date"` */
+      dueDate: string
+      /** @defaultValue `"Payment sent on"` */
+      paymentSentOn: string
+      /** @defaultValue `"Amount"` */
+      amount: string
+      /** @defaultValue `"Amount paid"` */
+      amountPaid: string
+    }
+    liabilities: {
+      /** @defaultValue `"Tax liabilities"` */
+      title: string
+      /** @defaultValue `"Tax liabilities"` */
+      tableLabel: string
+      /** @defaultValue `"Tax ID"` */
+      taxIdColumn: string
+      /** @defaultValue `"Payroll"` */
+      payrollColumn: string
+      /** @defaultValue `"Amount"` */
+      amountColumn: string
+      /** @defaultValue `"No tax liabilities."` */
+      emptyState: string
+    }
+    errors: {
+      /** @defaultValue `"Tax payment not found"` */
+      taxPaymentNotFound: string
+    }
+  }
+  /** Translation keys for the `Company.Management.TaxPaymentsList` i18n namespace. */
+  export interface CompanyManagementTaxPaymentsList {
+    /** @defaultValue `"Tax payments"` */
+    title: string
+    /** @defaultValue `"Tax payments"` */
+    tableLabel: string
+    /** @defaultValue `"Search tax payments"` */
+    searchLabel: string
+    /** @defaultValue `"Search by agency..."` */
+    searchPlaceholder: string
+    /** @defaultValue `"Jurisdiction"` */
+    jurisdictionFilterLabel: string
+    /** @defaultValue `"All jurisdictions"` */
+    allJurisdictions: string
+    /** @defaultValue `"Federal (US)"` */
+    federalJurisdictionOption: string
+    /** @defaultValue `"Status"` */
+    statusFilterLabel: string
+    /** @defaultValue `"All statuses"` */
+    allStatuses: string
+    columns: {
+      /** @defaultValue `"Agency"` */
+      agency: string
+      /** @defaultValue `"Jurisdiction"` */
+      jurisdiction: string
+      /** @defaultValue `"Period"` */
+      period: string
+      /** @defaultValue `"Due date"` */
+      dueDate: string
+      /** @defaultValue `"Amount"` */
+      amount: string
+      /** @defaultValue `"Status"` */
+      status: string
+    }
+    /** @defaultValue `"Federal"` */
+    federal: string
+    /** @defaultValue `"State · {{jurisdiction}}"` */
+    state: string
+    /** @defaultValue `"Unknown agency"` */
+    unknownAgency: string
+    /** @defaultValue `"—"` */
+    notAvailable: string
+    /** @defaultValue `"View"` */
+    viewCta: string
+    /** @defaultValue `"View {{agency}} tax payment"` */
+    viewPaymentLabel: string
+    status: {
+      /** @defaultValue `"Paid"` */
+      paid: string
+      /** @defaultValue `"Scheduled"` */
+      scheduled: string
+      /** @defaultValue `"Overdue"` */
+      overdue: string
+      /** @defaultValue `"Refund / Credit"` */
+      refund: string
+    }
+    overdueAlert: {
+      /** @defaultValue `"{{count}} tax payment is overdue and may require immediate attention."` */
+      label_one: string
+      /** @defaultValue `"{{count}} tax payments are overdue and may require immediate attention."` */
+      label_other: string
+    }
+    emptyState: {
+      /** @defaultValue `"No tax payments yet"` */
+      title: string
+      /** @defaultValue `"Tax payments appear here after payroll is processed."` */
+      description: string
+    }
+    noResults: {
+      /** @defaultValue `"No matching tax payments"` */
+      title: string
+      /** @defaultValue `"Try a different search or adjust the filters."` */
+      description: string
+    }
+    truncatedAlert: {
+      /** @defaultValue `"Showing the most recent tax payments. Older payments are not included."` */
+      label: string
+    }
+  }
   /** Translation keys for the `Company.OnboardingOverview` i18n namespace. */
   export interface CompanyOnboardingOverview {
     /** @defaultValue `"Nice! We’ll take it from here."` */
@@ -1408,6 +1590,8 @@ export namespace Translations {
       errors: {
         /** @defaultValue `"{{section}} for {{state}} is incomplete. Complete all required fields and try again."` */
         incompleteRequirementSet: string
+        /** @defaultValue `"Some values in {{section}} for {{state}} are invalid. Correct the highlighted fields and try again."` */
+        invalidRequirementSet: string
       }
       validations: {
         /** @defaultValue `"Minimum value is {{min}}%"` */
@@ -8129,11 +8313,15 @@ export namespace Translations {
     cancellingTitle: string
     /** @defaultValue `"This payroll has been cancelled."` */
     cancelledEmptyState: string
+    /** @defaultValue `"This payroll has changed"` */
+    notCalculatedErrorTitle: string
+    /** @defaultValue `"Refresh or return to your payrolls to continue."` */
+    notCalculatedErrorDescription: string
+    /** @defaultValue `"Back to payrolls"` */
+    notCalculatedErrorCta: string
     /** @defaultValue `"Skipped"` */
     skippedBadge: string
     alerts: {
-      /** @defaultValue `"Payroll is not calculated"` */
-      payrollNotCalculated: string
       /** @defaultValue `"There was an issue loading this payroll. Please try again."` */
       payrollLoadFailed: string
       /** @defaultValue `"To pay your employees with direct deposit by {{payDate}}, you'll need to run payroll by {{time}} on {{date}}."` */

package/dist/src/models/external.d.ts

@@ -306,14 +306,15 @@ export type { PayrollUpdateReimbursements } from '@gusto/embedded-api/models/com
 export type { PayrollUpdateState } from '@gusto/embedded-api/models/components/payrollupdate';
 export type { PayrollUpdateCustomWithholdings, PayrollUpdateDeductions, PayrollUpdateFederal, PayrollUpdateFixedCompensations, PayrollUpdateHourlyCompensations, } from '@gusto/embedded-api/models/components/payrollupdate';
 export { PayrollUpdateAmountType, PayrollUpdateEmployeeCompensationsAmountType, PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType, PayrollUpdateEmployeeCompensationsOverrideType, PayrollUpdateOverrideType, PayrollUpdatePaymentMethod, } from '@gusto/embedded-api/models/components/payrollupdate';
-/** `Departments` entity from the Gusto Embedded API. */
-export type { Departments } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
-/** `PayScheduleAssignmentBody` entity from the Gusto Embedded API. */
-export type { PayScheduleAssignmentBody } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
-/** `PayScheduleAssignmentBodyEmployees` entity from the Gusto Embedded API. */
-export type { PayScheduleAssignmentBodyEmployees } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
+/** `PayScheduleAssignmentType` entity from the Gusto Embedded API. */
+export { PayScheduleAssignmentType } from '@gusto/embedded-api/models/components/payscheduleassignment';
+export type { PayScheduleAssignment } from '@gusto/embedded-api/models/components/payscheduleassignment';
 /** `PayScheduleAssignmentBodyType` entity from the Gusto Embedded API. */
 export { PayScheduleAssignmentBodyType } from '@gusto/embedded-api/models/components/payscheduleassignmentbody';
+/** `PayScheduleAssignmentDepartment` entity from the Gusto Embedded API. */
+export type { PayScheduleAssignmentDepartment } from '@gusto/embedded-api/models/components/payscheduleassignmentdepartment';
+/** `PayScheduleAssignmentEmployee` entity from the Gusto Embedded API. */
+export type { PayScheduleAssignmentEmployee } from '@gusto/embedded-api/models/components/payscheduleassignmentemployee';
 /** `PayScheduleAssignmentEmployeeChange` entity from the Gusto Embedded API. */
 export type { PayScheduleAssignmentEmployeeChange } from '@gusto/embedded-api/models/components/payscheduleassignmentemployeechange';
 export type { PayScheduleAssignmentPayPeriod } from '@gusto/embedded-api/models/components/payscheduleassignmentpayperiod';
@@ -334,6 +335,8 @@ export { IdentityVerificationStatus } from '@gusto/embedded-api/models/component
 /** `SignatoryHomeAddress` entity from the Gusto Embedded API. */
 export type { SignatoryHomeAddress } from '@gusto/embedded-api/models/components/signatory';
 export type { Signatory } from '@gusto/embedded-api/models/components/signatory';
+export type { TaxPayment } from '@gusto/embedded-api/models/components/taxpayment';
+export type { TaxPaymentLineItem } from '@gusto/embedded-api/models/components/taxpaymentlineitem';
 /** `ApplicableIf` entity from the Gusto Embedded API. */
 export type { ApplicableIf } from '@gusto/embedded-api/models/components/taxrequirement';
 /** `TaxRequirement` entity from the Gusto Embedded API. */

package/dist/src/shared/constants.d.ts

@@ -349,6 +349,7 @@ export declare const runPayrollEvents: {
     readonly RUN_PAYROLL_ALREADY_PROCESSED: "runPayroll/alreadyProcessed";
     readonly RUN_PAYROLL_CANCELLED: "runPayroll/cancelled";
     readonly RUN_PAYROLL_CANCELLED_ALERT_DISMISSED: "runPayroll/cancelled/alertDismissed";
+    readonly RUN_PAYROLL_NOT_CALCULATED_BACK_TO_LIST: "runPayroll/notCalculated/backToList";
     readonly RUN_PAYROLL_EDIT: "runPayroll/edit";
     readonly RUN_PAYROLL_EMPLOYEE_EDIT: "runPayroll/employee/edit";
     readonly RUN_PAYROLL_EMPLOYEE_SKIP: "runPayroll/employee/skip";
@@ -446,6 +447,20 @@ export declare const printChecksEvents: {
     readonly PRINT_CHECKS_CANCEL: "payroll/printChecks/cancel";
     readonly PRINT_CHECKS_CLOSE: "payroll/printChecks/close";
 };
+/**
+ * Event keys emitted by the tax payments components.
+ *
+ * @remarks
+ * These keys are merged into {@link componentEvents}. Consume them through the
+ * `onEvent` handler of a tax payments component and compare against the
+ * value of an entry on this object.
+ *
+ * @alpha
+ */
+export declare const taxPaymentEvents: {
+    readonly TAX_PAYMENT_VIEW: "company/taxPayments/view";
+    readonly TAX_PAYMENT_BACK: "company/taxPayments/back";
+};
 /**
  * Event keys emitted by off-cycle payroll and transition components.
  *
@@ -596,6 +611,8 @@ export declare const componentEvents: {
     readonly CONTRACTOR_PAYMENT_CANCEL: "contractor/payments/cancel";
     readonly CONTRACTOR_PAYMENT_EXIT: "contractor/payments/exit";
     readonly CONTRACTOR_PAYMENT_RFI_RESPOND: "contractor/payments/rfi/respond";
+    readonly TAX_PAYMENT_VIEW: "company/taxPayments/view";
+    readonly TAX_PAYMENT_BACK: "company/taxPayments/back";
     readonly PRINT_CHECKS_START: "payroll/printChecks/start";
     readonly PRINT_CHECKS_GENERATE_START: "payroll/printChecks/generate/start";
     readonly PRINT_CHECKS_GENERATE_SUCCEEDED: "payroll/printChecks/generate/succeeded";
@@ -622,6 +639,7 @@ export declare const componentEvents: {
     readonly RUN_PAYROLL_ALREADY_PROCESSED: "runPayroll/alreadyProcessed";
     readonly RUN_PAYROLL_CANCELLED: "runPayroll/cancelled";
     readonly RUN_PAYROLL_CANCELLED_ALERT_DISMISSED: "runPayroll/cancelled/alertDismissed";
+    readonly RUN_PAYROLL_NOT_CALCULATED_BACK_TO_LIST: "runPayroll/notCalculated/backToList";
     readonly RUN_PAYROLL_EDIT: "runPayroll/edit";
     readonly RUN_PAYROLL_EMPLOYEE_EDIT: "runPayroll/employee/edit";
     readonly RUN_PAYROLL_EMPLOYEE_SKIP: "runPayroll/employee/skip";

package/dist/src/types/observability.d.ts

@@ -47,37 +47,76 @@ export interface ObservabilityMetric {
     timestamp: number;
 }
 /**
- * Configuration for sanitizing error and metric data before it reaches observability hooks.
+ * Configures redaction and raw-error inclusion for observability callbacks.
  *
  * @remarks
- * Sanitization runs by default to prevent PII leakage. When enabled, the SDK
- * pattern-redacts SSNs, emails, phone numbers, credit card numbers, and API
- * tokens from messages and tags, and removes values for fields with sensitive
- * names (`password`, `ssn`, `bankAccount`, etc.) from metadata. The `raw`
- * error object is excluded unless `includeRawError` is set to `true`.
+ * By default, the SDK redacts recognized string patterns in error `message` and
+ * `fieldErrors[].message`, and recursively redacts sensitive keys and recognized string
+ * patterns in `fieldErrors[].metadata` and metric `tags`. Sensitive keys include credentials,
+ * financial identifiers, personal names, birth dates, addresses, and document identifiers.
+ * Values are replaced with placeholders; keys are retained. Other properties are not redacted.
+ *
+ * Pattern and key matching do not detect every sensitive value. Free-text names and addresses,
+ * for example, may remain in messages. Select which fields to forward in your callbacks and
+ * use additional sensitive keys or custom sanitizers for further processing.
+ *
+ * Processing order is SDK redaction/raw exclusion, custom sanitizer, SDK redaction/raw
+ * exclusion again, then the observability callback. Custom functions receive processed input
+ * and their output follows the same configuration. `enabled` controls redaction independently
+ * of `includeRawError`; opted-in raw errors pass through without redaction.
+ *
+ * This configuration applies only to observability callbacks. It does not sanitize form-hook
+ * errors, component events, request hooks, or data added by your monitoring integration.
  *
  * @public
  */
 export interface SanitizationConfig {
     /**
-     * Whether to sanitize error data. Default: true
+     * Whether to redact recognized sensitive values in messages, field-error metadata, and
+     * metric tags. Default: true.
+     *
+     * @remarks
+     * When `false`, built-in and additional-sensitive-key redaction is skipped before and after
+     * custom sanitizers. Custom sanitizers still run. Raw errors remain excluded unless
+     * `includeRawError` is `true`.
      */
     enabled?: boolean;
     /**
-     * Whether to include the raw error object on SDKError. Default: false
-     * WARNING: Raw errors may contain sensitive data from form inputs or API responses
+     * Whether to include the original error as `raw` in observability errors. Default: false.
+     *
+     * @remarks
+     * When `false`, `raw` is set to `undefined` before and after a custom error sanitizer,
+     * regardless of `enabled`. When `true`, `raw` passes through without redaction and can
+     * contain form inputs, API response bodies, and request headers, including credentials.
      */
     includeRawError?: boolean;
     /**
-     * Custom sanitization function for errors
+     * Transforms an error between applications of the configured SDK processing.
+     *
+     * @remarks
+     * Receives an error after configured redaction and raw exclusion. The SDK processes the
+     * returned `message`, `fieldErrors[].message`, `fieldErrors[].metadata`, and `raw` again
+     * according to `enabled`, `includeRawError`, and `additionalSensitiveFields`. Other properties
+     * are preserved without redaction. Return an error of the same type; messages may be replaced
+     * and metadata omitted for additional control over emitted data.
      */
     customErrorSanitizer?: (error: ObservabilityError) => ObservabilityError;
     /**
-     * Custom sanitization function for metrics
+     * Transforms a metric between applications of the configured SDK redaction.
+     *
+     * @remarks
+     * Receives a metric after configured tag redaction. Returned `tags` are redacted again,
+     * including keys added by your function. Both passes honor `enabled` and
+     * `additionalSensitiveFields`. Other properties are preserved without redaction.
      */
     customMetricSanitizer?: (metric: ObservabilityMetric) => ObservabilityMetric;
     /**
-     * Additional field names to treat as sensitive (case-insensitive)
+     * Additional sensitive keys in field-error metadata and metric tags.
+     *
+     * @remarks
+     * Uses case-insensitive substring matching in nested objects and arrays, before and after
+     * custom sanitizers when redaction is enabled. Matching values are replaced with `[REDACTED]`.
+     * Does not match field-error paths, message text, or properties outside metadata and tags.
      */
     additionalSensitiveFields?: string[];
 }
@@ -87,8 +126,10 @@ export interface SanitizationConfig {
  * @remarks
  * Pass an instance to {@link GustoProvider} via `config.observability` to forward
  * errors to services like Sentry or Datadog and to capture performance metrics
- * for form submissions and component loading. Sanitization is applied before
- * the hooks are invoked; see {@link SanitizationConfig}.
+ * for form submissions and component loading. Recognized sensitive values are redacted and
+ * raw errors excluded by default before callbacks run; see {@link SanitizationConfig}.
+ * Select which payload fields to forward. This processing does not detect every PII value
+ * or cover data independently collected by your monitoring tool.
  *
  * @public
  * @group Observability
@@ -96,11 +137,11 @@ export interface SanitizationConfig {
  * @example
  * ```tsx
  * import * as Sentry from '@sentry/react'
- * import { GustoProvider, type ObservabilityHook } from '@gusto/embedded-react-sdk'
+ * import type { ObservabilityHook } from '@gusto/embedded-react-sdk'
  *
- * const observability: ObservabilityHook = {
+ * export const observability: ObservabilityHook = {
  *   onError: error => {
- *     Sentry.captureException(error.raw ?? new Error(error.message), {
+ *     Sentry.captureException(new Error(error.message), {
  *       level: error.category === 'validation_error' ? 'warning' : 'error',
  *       tags: {
  *         error_category: error.category,
@@ -114,9 +155,7 @@ export interface SanitizationConfig {
  *   },
  * }
  *
- * <GustoProvider config={{ baseUrl: '/api/', observability }}>
- *   <YourApp />
- * </GustoProvider>
+ * // Pass observability to GustoProvider through config.observability.
  * ```
  */
 export interface ObservabilityHook {