@gusto/embedded-react-sdk 0.56.7 → 0.57.0

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

@@ -377,9 +377,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 +1029,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 +1086,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 +1104,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

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';

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 {

package/docs/guides/endpoint-inventory.json

@@ -1790,6 +1790,11 @@
           "path": "/v1/companies/:companyId/pay_schedules/assignment_preview",
           "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/post-v1-companies-company_id-pay_schedules-assignment_preview"
         },
+        {
+          "method": "GET",
+          "path": "/v1/companies/:companyId/pay_schedules/assignments",
+          "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-companies-company_id-pay_schedules-assignments"
+        },
         {
           "method": "GET",
           "path": "/v1/companies/:companyId/pay_schedules/preview",
@@ -2005,6 +2010,11 @@
           "method": "POST",
           "path": "/v1/companies/:companyId/pay_schedules/assignment_preview",
           "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/post-v1-companies-company_id-pay_schedules-assignment_preview"
+        },
+        {
+          "method": "GET",
+          "path": "/v1/companies/:companyId/pay_schedules/assignments",
+          "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-companies-company_id-pay_schedules-assignments"
         }
       ],
       "variables": [
@@ -2028,6 +2038,11 @@
           "method": "POST",
           "path": "/v1/companies/:companyId/pay_schedules/assignment_preview",
           "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/post-v1-companies-company_id-pay_schedules-assignment_preview"
+        },
+        {
+          "method": "GET",
+          "path": "/v1/companies/:companyId/pay_schedules/assignments",
+          "docsUrl": "https://docs.gusto.com/embedded-payroll/v2026-06-15/reference/get-v1-companies-company_id-pay_schedules-assignments"
         }
       ],
       "variables": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gusto/embedded-react-sdk",
-  "version": "0.56.7",
+  "version": "0.57.0",
   "homepage": "https://github.com/Gusto/embedded-react-sdk",
   "bugs": {
     "url": "https://github.com/Gusto/embedded-react-sdk/issues"
@@ -65,7 +65,7 @@
     "pack": "npm run build && npm pack",
     "release": "release-it",
     "postversion": "git push",
-    "prepare": "husky",
+    "prepare": "husky || true",
     "prepublishOnly": "npm run build",
     "preversion": "npm test",
     "test": "vitest",
@@ -100,11 +100,11 @@
     "@commitlint/config-conventional": "^21.2.2",
     "@eslint/js": "^9.39.5",
     "@microsoft/api-extractor": "^7.59.1",
-    "@playwright/test": "^1.63.0",
+    "@playwright/test": "^1.64.0",
     "@release-it/conventional-changelog": "^12.0.2",
-    "@storybook/addon-a11y": "^10.6.0",
+    "@storybook/addon-a11y": "^10.6.1",
     "@storybook/addon-docs": "^10.6.0",
-    "@storybook/addon-onboarding": "^10.6.0",
+    "@storybook/addon-onboarding": "^10.6.1",
     "@storybook/react-vite": "^10.6.0",
     "@storybook/test-runner": "^0.24.5",
     "@testing-library/dom": "^10.4.2",
@@ -123,8 +123,8 @@
     "@vitejs/plugin-react-swc": "^4.3.3",
     "@vitest/coverage-v8": "^5.0.0",
     "ajv": "^8.20.0",
-    "axe-core": "^4.13.0",
-    "cspell": "^10.3.3",
+    "axe-core": "^4.14.0",
+    "cspell": "^10.3.6",
     "dotenv": "^18.0.3",
     "eslint": "^9.39.5",
     "eslint-plugin-import": "^2.31.0",
@@ -133,7 +133,7 @@
     "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-react-refresh": "^0.4.24",
     "eslint-plugin-storybook": "^10.6.0",
-    "eslint-plugin-tsdoc": "^0.5.3",
+    "eslint-plugin-tsdoc": "^0.5.4",
     "fuse.js": "^7.5.0",
     "globals": "^17.12.0",
     "husky": "^9.1.7",
@@ -143,7 +143,7 @@
     "json-schema-to-typescript": "^16.0.0",
     "lint-staged": "^17.5.1",
     "markdownlint-cli2": "^0.23.3",
-    "msw": "^2.15.0",
+    "msw": "^3.0.3",
     "npm-run-all": "^4.1.5",
     "pixelmatch": "^7.2.0",
     "pngjs": "^7.0.0",
@@ -159,10 +159,10 @@
     "ts-morph": "^28.0.0",
     "tsx": "^4.23.15",
     "typescript-eslint": "^8.70.1",
-    "vite": "^6.4.3",
+    "vite": "^6.4.4",
     "vite-plugin-checker": "^0.14.5",
     "vite-plugin-circular-dependency": "^0.6.0",
-    "vite-plugin-dts": "^5.1.1",
+    "vite-plugin-dts": "^5.1.2",
     "vite-plugin-externalize-deps": "^0.10.0",
     "vite-plugin-stylelint": "^6.3.0",
     "vite-plugin-svgr": "^5.2.0",
@@ -189,7 +189,7 @@
     "@hookform/error-message": "^2.0.1",
     "@hookform/resolvers": "^5.9.1",
     "@internationalized/date": "^3.12.4",
-    "@internationalized/number": "^3.6.8",
+    "@internationalized/number": "^3.6.9",
     "classnames": "^2.5.1",
     "deepmerge": "^4.3.1",
     "dompurify": "^3.4.16",