@gusto/embedded-react-sdk 0.50.0 → 0.51.0

package/dist/types/hooks.d.ts

@@ -1,4 +1,4 @@
-import { BeforeCreateRequestHook, BeforeRequestHook, AfterSuccessHook, AfterErrorHook, BeforeCreateRequestContext, BeforeRequestContext, AfterSuccessContext, AfterErrorContext } from '@gusto/embedded-api-v-2025-11-15/hooks/types';
+import { BeforeCreateRequestHook, BeforeRequestHook, AfterSuccessHook, AfterErrorHook, BeforeCreateRequestContext, BeforeRequestContext, AfterSuccessContext, AfterErrorContext } from '@gusto/embedded-api-v-2026-02-01/hooks/types';
 export type { BeforeCreateRequestHook, BeforeRequestHook, AfterSuccessHook, AfterErrorHook, BeforeCreateRequestContext, BeforeRequestContext, AfterSuccessContext, AfterErrorContext, };
 /**
  * Request interceptors for customizing HTTP requests and responses.
@@ -7,7 +7,7 @@ export type { BeforeCreateRequestHook, BeforeRequestHook, AfterSuccessHook, Afte
  * Pass an instance of this interface to {@link GustoProvider} via `config.hooks` to
  * inspect or modify requests and responses across the four lifecycle stages.
  * Each entry is an array of objects implementing the corresponding hook type
- * from `@gusto/embedded-api-v-2025-11-15/hooks/types`.
+ * from `@gusto/embedded-api-v-2026-02-01/hooks/types`.
  *
  * | Stage | When it runs |
  * | ----- | ------------ |

package/dist/types/sdkError.js

@@ -1,6 +1,6 @@
-import { GustoEmbeddedError as n } from "@gusto/embedded-api-v-2025-11-15/models/errors/gustoembeddederror";
-import { HTTPClientError as o } from "@gusto/embedded-api-v-2025-11-15/models/errors/httpclienterrors";
-import { SDKValidationError as i } from "@gusto/embedded-api-v-2025-11-15/models/errors/sdkvalidationerror";
+import { GustoEmbeddedError as n } from "@gusto/embedded-api-v-2026-02-01/models/errors/gustoembeddederror";
+import { HTTPClientError as o } from "@gusto/embedded-api-v-2026-02-01/models/errors/httpclienterrors";
+import { SDKValidationError as i } from "@gusto/embedded-api-v-2026-02-01/models/errors/sdkvalidationerror";
 import { getFieldErrors as c } from "../helpers/apiErrorToList.js";
 const A = {
   API_ERROR: "api_error",

package/dist/types/sdkError.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdkError.js","sources":["../../src/types/sdkError.ts"],"sourcesContent":["import type { EntityErrorObject } from '@gusto/embedded-api-v-2025-11-15/models/components/entityerrorobject'\nimport { GustoEmbeddedError } from '@gusto/embedded-api-v-2025-11-15/models/errors/gustoembeddederror'\nimport { HTTPClientError } from '@gusto/embedded-api-v-2025-11-15/models/errors/httpclienterrors'\nimport { SDKValidationError } from '@gusto/embedded-api-v-2025-11-15/models/errors/sdkvalidationerror'\nimport { getFieldErrors } from '@/helpers/apiErrorToList'\n\n/**\n * Constant map of {@link SDKErrorCategory} string values keyed by uppercase name.\n *\n * @remarks\n * Use this when you need to reference a category value by name (e.g.\n * `SDKErrorCategories.API_ERROR`). Each entry corresponds to one classification:\n *\n * | Value | When it applies |\n * | ----- | --------------- |\n * | `api_error` | HTTP error response from the Gusto API (422, 404, 409, 500, etc.) |\n * | `validation_error` | Client-side Zod schema validation before the request was sent |\n * | `network_error` | Network connectivity failure (connection refused, timeout, abort) |\n * | `internal_error` | Unexpected runtime error (unhandled exception, initialization failure) |\n *\n * @public\n */\nexport const SDKErrorCategories = {\n  API_ERROR: 'api_error',\n  VALIDATION_ERROR: 'validation_error',\n  NETWORK_ERROR: 'network_error',\n  INTERNAL_ERROR: 'internal_error',\n} as const\n\n/**\n * High-level classification of where an {@link SDKError} originated.\n *\n * @public\n */\nexport type SDKErrorCategory = (typeof SDKErrorCategories)[keyof typeof SDKErrorCategories]\n\n/**\n * An error thrown by internal SDK logic that should be caught and normalized\n * by `baseSubmitHandler` rather than propagating to the ErrorBoundary.\n *\n * Use this for guard clauses and data integrity checks inside submit handler\n * callbacks where the error should surface as an inline banner, not a crash.\n *\n * @internal\n *\n * @example\n * ```typescript\n * await baseSubmitHandler(data, async () => {\n *   const response = await createPayroll({ ... })\n *   if (!response.payrollId) {\n *     throw new SDKInternalError('Missing payroll ID in response')\n *   }\n * })\n * ```\n */\nexport class SDKInternalError extends Error {\n  readonly category: SDKErrorCategory\n\n  constructor(message: string, category: SDKErrorCategory = 'internal_error') {\n    super(message)\n    this.name = 'SDKInternalError'\n    this.category = category\n  }\n}\n\n/**\n * A flattened, field-level error extracted from an API response.\n *\n * @remarks\n * For API errors with structured field errors (e.g. 422 responses), nested\n * `errors[]` structures are recursively flattened into one entry per leaf\n * field. The `field` property is the dot-separated camelCase path\n * (e.g. `\"firstName\"`, `\"states.CA.filingStatus.value\"`).\n *\n * @public\n */\nexport interface SDKFieldError {\n  /** Dot-separated camelCase field path (e.g. \"firstName\", \"states.CA.filingStatus.value\") */\n  field: string\n  /** API error category (e.g. \"invalid_attribute_value\", \"invalid_operation\", \"payroll_blocker\") */\n  category: string\n  /** Human-readable error message from the API */\n  message: string\n  /** Additional metadata from the API (e.g. `{ key: \"missing_bank_info\" }` for payroll blockers) */\n  metadata?: Record<string, unknown>\n}\n\n/**\n * Unified error shape returned by every form hook and error-handling surface.\n *\n * @remarks\n * Every caught error — whether from the Gusto API, client-side Zod validation,\n * a network failure, or an unexpected runtime exception — is normalized into\n * this shape. The {@link SDKErrorCategory} `category` field distinguishes\n * which source produced the error; `fieldErrors` is populated for structured\n * API responses (typically 422) and is an empty array otherwise.\n *\n * Observability telemetry uses {@link ObservabilityError}, which extends this\n * shape with component context.\n *\n * @public\n *\n * @example\n * ```tsx\n * import { useEmployeeForm } from '@gusto/embedded-react-sdk'\n *\n * const { errorHandling } = useEmployeeForm({ employeeId })\n * const error = errorHandling.error\n *\n * if (error) {\n *   console.log(error.category)    // 'api_error'\n *   console.log(error.httpStatus)  // 422\n *   console.log(error.fieldErrors) // [{ field: 'firstName', ... }]\n * }\n * ```\n */\nexport interface SDKError {\n  /** High-level error classification */\n  category: SDKErrorCategory\n\n  /** Human-readable error summary */\n  message: string\n\n  /** HTTP status code (undefined for non-HTTP errors like network or validation) */\n  httpStatus?: number\n\n  /** Flattened field-level errors from API responses. Empty array for non-field errors. */\n  fieldErrors: SDKFieldError[]\n\n  /**\n   * The original error object for advanced use cases.\n   * May be stripped by sanitization (controlled by `sanitization.includeRawError`).\n   */\n  raw?: unknown\n}\n\ninterface ErrorWithErrors {\n  errors: EntityErrorObject[]\n}\n\nfunction hasErrorsArray(error: unknown): error is ErrorWithErrors {\n  return (\n    error !== null &&\n    typeof error === 'object' &&\n    'errors' in error &&\n    Array.isArray((error as { errors: unknown }).errors)\n  )\n}\n\nfunction humanizeFieldName(snakeCaseField: string): string {\n  if (!snakeCaseField) return snakeCaseField\n  const words = snakeCaseField.replace(/_/g, ' ')\n  return words.charAt(0).toUpperCase() + words.slice(1)\n}\n\nfunction humanizeMessage(message: string, field: string): string {\n  if (!message || !field) return message\n  const humanized = humanizeFieldName(field)\n  return message.replace(field, humanized)\n}\n\nfunction toSDKFieldError(entityError: EntityErrorObject): SDKFieldError {\n  const rawMessage = entityError.message ?? ''\n  return {\n    field: entityError.errorKey,\n    message: humanizeMessage(rawMessage, entityError.errorKey),\n    category: entityError.category,\n    metadata: entityError.metadata as Record<string, unknown> | undefined,\n  }\n}\n\n/**\n * Extracts and flattens field errors from an API error's `errors[]` array.\n *\n * Uses the existing `getFieldErrors` recursive traversal for nested errors,\n * with a fallback for errors in categories that `getFieldErrors` doesn't handle.\n */\nfunction extractFieldErrors(errors: EntityErrorObject[]): SDKFieldError[] {\n  const flattened = errors.flatMap(err => getFieldErrors(err))\n  if (flattened.length > 0) {\n    return flattened.map(toSDKFieldError)\n  }\n\n  return errors.filter(err => err.message).map(toSDKFieldError)\n}\n\ninterface RawAPIFieldError {\n  error_key?: string\n  errorKey?: string\n  category: string\n  message?: string\n  metadata?: Record<string, unknown>\n}\n\nfunction rawToEntityError(raw: RawAPIFieldError): EntityErrorObject {\n  return {\n    errorKey: raw.errorKey ?? raw.error_key ?? '',\n    category: raw.category,\n    message: raw.message,\n    metadata: raw.metadata,\n  }\n}\n\nfunction tryExtractFieldErrorsFromBody(body: string | undefined): SDKFieldError[] {\n  if (!body) return []\n  try {\n    const parsed: unknown = JSON.parse(body)\n    if (\n      parsed !== null &&\n      typeof parsed === 'object' &&\n      'errors' in parsed &&\n      Array.isArray((parsed as { errors: unknown }).errors)\n    ) {\n      const errors = (parsed as { errors: RawAPIFieldError[] }).errors\n      return errors\n        .filter(err => err.message)\n        .map(rawToEntityError)\n        .map(toSDKFieldError)\n    }\n  } catch {\n    // Body isn't valid JSON\n  }\n  return []\n}\n\nfunction buildApiErrorMessage(fieldErrors: SDKFieldError[], fallbackMessage: string): string {\n  if (fieldErrors.length === 0) {\n    return fallbackMessage\n  }\n  return fieldErrors.length === 1\n    ? '1 field has issues'\n    : `${fieldErrors.length} fields have issues`\n}\n\n/**\n * Normalizes any caught error into a unified `SDKError`.\n *\n * Classification is based purely on the error type:\n * - `SDKInternalError` → uses the error's own `category` (default: `internal_error`)\n * - `GustoEmbeddedError` subclasses → `api_error`\n * - `SDKValidationError` → `validation_error`\n * - `HTTPClientError` subclasses → `network_error`\n * - Everything else → `internal_error`\n *\n * @internal\n */\nexport function normalizeToSDKError(error: unknown): SDKError {\n  if (error instanceof SDKInternalError) {\n    return {\n      category: error.category,\n      message: error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  if (error instanceof SDKValidationError) {\n    return {\n      category: 'validation_error',\n      message: typeof error.rawMessage === 'string' ? error.rawMessage : error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  if (error instanceof HTTPClientError) {\n    return {\n      category: 'network_error',\n      message: error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  if (error instanceof GustoEmbeddedError) {\n    const httpStatus = error.httpMeta.response.status\n    const fieldErrors = hasErrorsArray(error)\n      ? extractFieldErrors(error.errors)\n      : tryExtractFieldErrorsFromBody(error.httpMeta.body)\n\n    return {\n      category: 'api_error',\n      message: buildApiErrorMessage(fieldErrors, error.message),\n      httpStatus,\n      fieldErrors,\n      raw: error,\n    }\n  }\n\n  if (error instanceof Error) {\n    return {\n      category: 'internal_error',\n      message: error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  return {\n    category: 'internal_error',\n    message: 'An unknown error occurred',\n    fieldErrors: [],\n    raw: error,\n  }\n}\n"],"names":["SDKErrorCategories","SDKInternalError","message","category","hasErrorsArray","error","humanizeFieldName","snakeCaseField","words","humanizeMessage","field","humanized","toSDKFieldError","entityError","rawMessage","extractFieldErrors","errors","flattened","err","getFieldErrors","rawToEntityError","raw","tryExtractFieldErrorsFromBody","body","parsed","buildApiErrorMessage","fieldErrors","fallbackMessage","normalizeToSDKError","SDKValidationError","HTTPClientError","GustoEmbeddedError","httpStatus"],"mappings":";;;;AAsBO,MAAMA,IAAqB;AAAA,EAChC,WAAW;AAAA,EACX,kBAAkB;AAAA,EAClB,eAAe;AAAA,EACf,gBAAgB;AAClB;AA4BO,MAAMC,UAAyB,MAAM;AAAA,EACjC;AAAA,EAET,YAAYC,GAAiBC,IAA6B,kBAAkB;AAC1E,UAAMD,CAAO,GACb,KAAK,OAAO,oBACZ,KAAK,WAAWC;AAAA,EAClB;AACF;AA6EA,SAASC,EAAeC,GAA0C;AAChE,SACEA,MAAU,QACV,OAAOA,KAAU,YACjB,YAAYA,KACZ,MAAM,QAASA,EAA8B,MAAM;AAEvD;AAEA,SAASC,EAAkBC,GAAgC;AACzD,MAAI,CAACA,EAAgB,QAAOA;AAC5B,QAAMC,IAAQD,EAAe,QAAQ,MAAM,GAAG;AAC9C,SAAOC,EAAM,OAAO,CAAC,EAAE,gBAAgBA,EAAM,MAAM,CAAC;AACtD;AAEA,SAASC,EAAgBP,GAAiBQ,GAAuB;AAC/D,MAAI,CAACR,KAAW,CAACQ,EAAO,QAAOR;AAC/B,QAAMS,IAAYL,EAAkBI,CAAK;AACzC,SAAOR,EAAQ,QAAQQ,GAAOC,CAAS;AACzC;AAEA,SAASC,EAAgBC,GAA+C;AACtE,QAAMC,IAAaD,EAAY,WAAW;AAC1C,SAAO;AAAA,IACL,OAAOA,EAAY;AAAA,IACnB,SAASJ,EAAgBK,GAAYD,EAAY,QAAQ;AAAA,IACzD,UAAUA,EAAY;AAAA,IACtB,UAAUA,EAAY;AAAA,EAAA;AAE1B;AAQA,SAASE,EAAmBC,GAA8C;AACxE,QAAMC,IAAYD,EAAO,QAAQ,CAAAE,MAAOC,EAAeD,CAAG,CAAC;AAC3D,SAAID,EAAU,SAAS,IACdA,EAAU,IAAIL,CAAe,IAG/BI,EAAO,OAAO,CAAAE,MAAOA,EAAI,OAAO,EAAE,IAAIN,CAAe;AAC9D;AAUA,SAASQ,EAAiBC,GAA0C;AAClE,SAAO;AAAA,IACL,UAAUA,EAAI,YAAYA,EAAI,aAAa;AAAA,IAC3C,UAAUA,EAAI;AAAA,IACd,SAASA,EAAI;AAAA,IACb,UAAUA,EAAI;AAAA,EAAA;AAElB;AAEA,SAASC,EAA8BC,GAA2C;AAChF,MAAI,CAACA,EAAM,QAAO,CAAA;AAClB,MAAI;AACF,UAAMC,IAAkB,KAAK,MAAMD,CAAI;AACvC,QACEC,MAAW,QACX,OAAOA,KAAW,YAClB,YAAYA,KACZ,MAAM,QAASA,EAA+B,MAAM;AAGpD,aADgBA,EAA0C,OAEvD,OAAO,CAAAN,MAAOA,EAAI,OAAO,EACzB,IAAIE,CAAgB,EACpB,IAAIR,CAAe;AAAA,EAE1B,QAAQ;AAAA,EAER;AACA,SAAO,CAAA;AACT;AAEA,SAASa,EAAqBC,GAA8BC,GAAiC;AAC3F,SAAID,EAAY,WAAW,IAClBC,IAEFD,EAAY,WAAW,IAC1B,uBACA,GAAGA,EAAY,MAAM;AAC3B;AAcO,SAASE,EAAoBvB,GAA0B;AAC5D,MAAIA,aAAiBJ;AACnB,WAAO;AAAA,MACL,UAAUI,EAAM;AAAA,MAChB,SAASA,EAAM;AAAA,MACf,aAAa,CAAA;AAAA,MACb,KAAKA;AAAA,IAAA;AAIT,MAAIA,aAAiBwB;AACnB,WAAO;AAAA,MACL,UAAU;AAAA,MACV,SAAS,OAAOxB,EAAM,cAAe,WAAWA,EAAM,aAAaA,EAAM;AAAA,MACzE,aAAa,CAAA;AAAA,MACb,KAAKA;AAAA,IAAA;AAIT,MAAIA,aAAiByB;AACnB,WAAO;AAAA,MACL,UAAU;AAAA,MACV,SAASzB,EAAM;AAAA,MACf,aAAa,CAAA;AAAA,MACb,KAAKA;AAAA,IAAA;AAIT,MAAIA,aAAiB0B,GAAoB;AACvC,UAAMC,IAAa3B,EAAM,SAAS,SAAS,QACrCqB,IAActB,EAAeC,CAAK,IACpCU,EAAmBV,EAAM,MAAM,IAC/BiB,EAA8BjB,EAAM,SAAS,IAAI;AAErD,WAAO;AAAA,MACL,UAAU;AAAA,MACV,SAASoB,EAAqBC,GAAarB,EAAM,OAAO;AAAA,MACxD,YAAA2B;AAAA,MACA,aAAAN;AAAA,MACA,KAAKrB;AAAA,IAAA;AAAA,EAET;AAEA,SAAIA,aAAiB,QACZ;AAAA,IACL,UAAU;AAAA,IACV,SAASA,EAAM;AAAA,IACf,aAAa,CAAA;AAAA,IACb,KAAKA;AAAA,EAAA,IAIF;AAAA,IACL,UAAU;AAAA,IACV,SAAS;AAAA,IACT,aAAa,CAAA;AAAA,IACb,KAAKA;AAAA,EAAA;AAET;"}
+{"version":3,"file":"sdkError.js","sources":["../../src/types/sdkError.ts"],"sourcesContent":["import type { EntityErrorObject } from '@gusto/embedded-api-v-2026-02-01/models/components/entityerrorobject'\nimport { GustoEmbeddedError } from '@gusto/embedded-api-v-2026-02-01/models/errors/gustoembeddederror'\nimport { HTTPClientError } from '@gusto/embedded-api-v-2026-02-01/models/errors/httpclienterrors'\nimport { SDKValidationError } from '@gusto/embedded-api-v-2026-02-01/models/errors/sdkvalidationerror'\nimport { getFieldErrors } from '@/helpers/apiErrorToList'\n\n/**\n * Constant map of {@link SDKErrorCategory} string values keyed by uppercase name.\n *\n * @remarks\n * Use this when you need to reference a category value by name (e.g.\n * `SDKErrorCategories.API_ERROR`). Each entry corresponds to one classification:\n *\n * | Value | When it applies |\n * | ----- | --------------- |\n * | `api_error` | HTTP error response from the Gusto API (422, 404, 409, 500, etc.) |\n * | `validation_error` | Client-side Zod schema validation before the request was sent |\n * | `network_error` | Network connectivity failure (connection refused, timeout, abort) |\n * | `internal_error` | Unexpected runtime error (unhandled exception, initialization failure) |\n *\n * @public\n */\nexport const SDKErrorCategories = {\n  API_ERROR: 'api_error',\n  VALIDATION_ERROR: 'validation_error',\n  NETWORK_ERROR: 'network_error',\n  INTERNAL_ERROR: 'internal_error',\n} as const\n\n/**\n * High-level classification of where an {@link SDKError} originated.\n *\n * @public\n */\nexport type SDKErrorCategory = (typeof SDKErrorCategories)[keyof typeof SDKErrorCategories]\n\n/**\n * An error thrown by internal SDK logic that should be caught and normalized\n * by `baseSubmitHandler` rather than propagating to the ErrorBoundary.\n *\n * Use this for guard clauses and data integrity checks inside submit handler\n * callbacks where the error should surface as an inline banner, not a crash.\n *\n * @internal\n *\n * @example\n * ```typescript\n * await baseSubmitHandler(data, async () => {\n *   const response = await createPayroll({ ... })\n *   if (!response.payrollId) {\n *     throw new SDKInternalError('Missing payroll ID in response')\n *   }\n * })\n * ```\n */\nexport class SDKInternalError extends Error {\n  readonly category: SDKErrorCategory\n\n  constructor(message: string, category: SDKErrorCategory = 'internal_error') {\n    super(message)\n    this.name = 'SDKInternalError'\n    this.category = category\n  }\n}\n\n/**\n * A flattened, field-level error extracted from an API response.\n *\n * @remarks\n * For API errors with structured field errors (e.g. 422 responses), nested\n * `errors[]` structures are recursively flattened into one entry per leaf\n * field. The `field` property is the dot-separated camelCase path\n * (e.g. `\"firstName\"`, `\"states.CA.filingStatus.value\"`).\n *\n * @public\n */\nexport interface SDKFieldError {\n  /** Dot-separated camelCase field path (e.g. \"firstName\", \"states.CA.filingStatus.value\") */\n  field: string\n  /** API error category (e.g. \"invalid_attribute_value\", \"invalid_operation\", \"payroll_blocker\") */\n  category: string\n  /** Human-readable error message from the API */\n  message: string\n  /** Additional metadata from the API (e.g. `{ key: \"missing_bank_info\" }` for payroll blockers) */\n  metadata?: Record<string, unknown>\n}\n\n/**\n * Unified error shape returned by every form hook and error-handling surface.\n *\n * @remarks\n * Every caught error — whether from the Gusto API, client-side Zod validation,\n * a network failure, or an unexpected runtime exception — is normalized into\n * this shape. The {@link SDKErrorCategory} `category` field distinguishes\n * which source produced the error; `fieldErrors` is populated for structured\n * API responses (typically 422) and is an empty array otherwise.\n *\n * Observability telemetry uses {@link ObservabilityError}, which extends this\n * shape with component context.\n *\n * @public\n *\n * @example\n * ```tsx\n * import { useEmployeeForm } from '@gusto/embedded-react-sdk'\n *\n * const { errorHandling } = useEmployeeForm({ employeeId })\n * const error = errorHandling.error\n *\n * if (error) {\n *   console.log(error.category)    // 'api_error'\n *   console.log(error.httpStatus)  // 422\n *   console.log(error.fieldErrors) // [{ field: 'firstName', ... }]\n * }\n * ```\n */\nexport interface SDKError {\n  /** High-level error classification */\n  category: SDKErrorCategory\n\n  /** Human-readable error summary */\n  message: string\n\n  /** HTTP status code (undefined for non-HTTP errors like network or validation) */\n  httpStatus?: number\n\n  /** Flattened field-level errors from API responses. Empty array for non-field errors. */\n  fieldErrors: SDKFieldError[]\n\n  /**\n   * The original error object for advanced use cases.\n   * May be stripped by sanitization (controlled by `sanitization.includeRawError`).\n   */\n  raw?: unknown\n}\n\ninterface ErrorWithErrors {\n  errors: EntityErrorObject[]\n}\n\nfunction hasErrorsArray(error: unknown): error is ErrorWithErrors {\n  return (\n    error !== null &&\n    typeof error === 'object' &&\n    'errors' in error &&\n    Array.isArray((error as { errors: unknown }).errors)\n  )\n}\n\nfunction humanizeFieldName(snakeCaseField: string): string {\n  if (!snakeCaseField) return snakeCaseField\n  const words = snakeCaseField.replace(/_/g, ' ')\n  return words.charAt(0).toUpperCase() + words.slice(1)\n}\n\nfunction humanizeMessage(message: string, field: string): string {\n  if (!message || !field) return message\n  const humanized = humanizeFieldName(field)\n  return message.replace(field, humanized)\n}\n\nfunction toSDKFieldError(entityError: EntityErrorObject): SDKFieldError {\n  const rawMessage = entityError.message ?? ''\n  return {\n    field: entityError.errorKey,\n    message: humanizeMessage(rawMessage, entityError.errorKey),\n    category: entityError.category,\n    metadata: entityError.metadata as Record<string, unknown> | undefined,\n  }\n}\n\n/**\n * Extracts and flattens field errors from an API error's `errors[]` array.\n *\n * Uses the existing `getFieldErrors` recursive traversal for nested errors,\n * with a fallback for errors in categories that `getFieldErrors` doesn't handle.\n */\nfunction extractFieldErrors(errors: EntityErrorObject[]): SDKFieldError[] {\n  const flattened = errors.flatMap(err => getFieldErrors(err))\n  if (flattened.length > 0) {\n    return flattened.map(toSDKFieldError)\n  }\n\n  return errors.filter(err => err.message).map(toSDKFieldError)\n}\n\ninterface RawAPIFieldError {\n  error_key?: string\n  errorKey?: string\n  category: string\n  message?: string\n  metadata?: Record<string, unknown>\n}\n\nfunction rawToEntityError(raw: RawAPIFieldError): EntityErrorObject {\n  return {\n    errorKey: raw.errorKey ?? raw.error_key ?? '',\n    category: raw.category,\n    message: raw.message,\n    metadata: raw.metadata,\n  }\n}\n\nfunction tryExtractFieldErrorsFromBody(body: string | undefined): SDKFieldError[] {\n  if (!body) return []\n  try {\n    const parsed: unknown = JSON.parse(body)\n    if (\n      parsed !== null &&\n      typeof parsed === 'object' &&\n      'errors' in parsed &&\n      Array.isArray((parsed as { errors: unknown }).errors)\n    ) {\n      const errors = (parsed as { errors: RawAPIFieldError[] }).errors\n      return errors\n        .filter(err => err.message)\n        .map(rawToEntityError)\n        .map(toSDKFieldError)\n    }\n  } catch {\n    // Body isn't valid JSON\n  }\n  return []\n}\n\nfunction buildApiErrorMessage(fieldErrors: SDKFieldError[], fallbackMessage: string): string {\n  if (fieldErrors.length === 0) {\n    return fallbackMessage\n  }\n  return fieldErrors.length === 1\n    ? '1 field has issues'\n    : `${fieldErrors.length} fields have issues`\n}\n\n/**\n * Normalizes any caught error into a unified `SDKError`.\n *\n * Classification is based purely on the error type:\n * - `SDKInternalError` → uses the error's own `category` (default: `internal_error`)\n * - `GustoEmbeddedError` subclasses → `api_error`\n * - `SDKValidationError` → `validation_error`\n * - `HTTPClientError` subclasses → `network_error`\n * - Everything else → `internal_error`\n *\n * @internal\n */\nexport function normalizeToSDKError(error: unknown): SDKError {\n  if (error instanceof SDKInternalError) {\n    return {\n      category: error.category,\n      message: error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  if (error instanceof SDKValidationError) {\n    return {\n      category: 'validation_error',\n      message: typeof error.rawMessage === 'string' ? error.rawMessage : error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  if (error instanceof HTTPClientError) {\n    return {\n      category: 'network_error',\n      message: error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  if (error instanceof GustoEmbeddedError) {\n    const httpStatus = error.httpMeta.response.status\n    const fieldErrors = hasErrorsArray(error)\n      ? extractFieldErrors(error.errors)\n      : tryExtractFieldErrorsFromBody(error.httpMeta.body)\n\n    return {\n      category: 'api_error',\n      message: buildApiErrorMessage(fieldErrors, error.message),\n      httpStatus,\n      fieldErrors,\n      raw: error,\n    }\n  }\n\n  if (error instanceof Error) {\n    return {\n      category: 'internal_error',\n      message: error.message,\n      fieldErrors: [],\n      raw: error,\n    }\n  }\n\n  return {\n    category: 'internal_error',\n    message: 'An unknown error occurred',\n    fieldErrors: [],\n    raw: error,\n  }\n}\n"],"names":["SDKErrorCategories","SDKInternalError","message","category","hasErrorsArray","error","humanizeFieldName","snakeCaseField","words","humanizeMessage","field","humanized","toSDKFieldError","entityError","rawMessage","extractFieldErrors","errors","flattened","err","getFieldErrors","rawToEntityError","raw","tryExtractFieldErrorsFromBody","body","parsed","buildApiErrorMessage","fieldErrors","fallbackMessage","normalizeToSDKError","SDKValidationError","HTTPClientError","GustoEmbeddedError","httpStatus"],"mappings":";;;;AAsBO,MAAMA,IAAqB;AAAA,EAChC,WAAW;AAAA,EACX,kBAAkB;AAAA,EAClB,eAAe;AAAA,EACf,gBAAgB;AAClB;AA4BO,MAAMC,UAAyB,MAAM;AAAA,EACjC;AAAA,EAET,YAAYC,GAAiBC,IAA6B,kBAAkB;AAC1E,UAAMD,CAAO,GACb,KAAK,OAAO,oBACZ,KAAK,WAAWC;AAAA,EAClB;AACF;AA6EA,SAASC,EAAeC,GAA0C;AAChE,SACEA,MAAU,QACV,OAAOA,KAAU,YACjB,YAAYA,KACZ,MAAM,QAASA,EAA8B,MAAM;AAEvD;AAEA,SAASC,EAAkBC,GAAgC;AACzD,MAAI,CAACA,EAAgB,QAAOA;AAC5B,QAAMC,IAAQD,EAAe,QAAQ,MAAM,GAAG;AAC9C,SAAOC,EAAM,OAAO,CAAC,EAAE,gBAAgBA,EAAM,MAAM,CAAC;AACtD;AAEA,SAASC,EAAgBP,GAAiBQ,GAAuB;AAC/D,MAAI,CAACR,KAAW,CAACQ,EAAO,QAAOR;AAC/B,QAAMS,IAAYL,EAAkBI,CAAK;AACzC,SAAOR,EAAQ,QAAQQ,GAAOC,CAAS;AACzC;AAEA,SAASC,EAAgBC,GAA+C;AACtE,QAAMC,IAAaD,EAAY,WAAW;AAC1C,SAAO;AAAA,IACL,OAAOA,EAAY;AAAA,IACnB,SAASJ,EAAgBK,GAAYD,EAAY,QAAQ;AAAA,IACzD,UAAUA,EAAY;AAAA,IACtB,UAAUA,EAAY;AAAA,EAAA;AAE1B;AAQA,SAASE,EAAmBC,GAA8C;AACxE,QAAMC,IAAYD,EAAO,QAAQ,CAAAE,MAAOC,EAAeD,CAAG,CAAC;AAC3D,SAAID,EAAU,SAAS,IACdA,EAAU,IAAIL,CAAe,IAG/BI,EAAO,OAAO,CAAAE,MAAOA,EAAI,OAAO,EAAE,IAAIN,CAAe;AAC9D;AAUA,SAASQ,EAAiBC,GAA0C;AAClE,SAAO;AAAA,IACL,UAAUA,EAAI,YAAYA,EAAI,aAAa;AAAA,IAC3C,UAAUA,EAAI;AAAA,IACd,SAASA,EAAI;AAAA,IACb,UAAUA,EAAI;AAAA,EAAA;AAElB;AAEA,SAASC,EAA8BC,GAA2C;AAChF,MAAI,CAACA,EAAM,QAAO,CAAA;AAClB,MAAI;AACF,UAAMC,IAAkB,KAAK,MAAMD,CAAI;AACvC,QACEC,MAAW,QACX,OAAOA,KAAW,YAClB,YAAYA,KACZ,MAAM,QAASA,EAA+B,MAAM;AAGpD,aADgBA,EAA0C,OAEvD,OAAO,CAAAN,MAAOA,EAAI,OAAO,EACzB,IAAIE,CAAgB,EACpB,IAAIR,CAAe;AAAA,EAE1B,QAAQ;AAAA,EAER;AACA,SAAO,CAAA;AACT;AAEA,SAASa,EAAqBC,GAA8BC,GAAiC;AAC3F,SAAID,EAAY,WAAW,IAClBC,IAEFD,EAAY,WAAW,IAC1B,uBACA,GAAGA,EAAY,MAAM;AAC3B;AAcO,SAASE,EAAoBvB,GAA0B;AAC5D,MAAIA,aAAiBJ;AACnB,WAAO;AAAA,MACL,UAAUI,EAAM;AAAA,MAChB,SAASA,EAAM;AAAA,MACf,aAAa,CAAA;AAAA,MACb,KAAKA;AAAA,IAAA;AAIT,MAAIA,aAAiBwB;AACnB,WAAO;AAAA,MACL,UAAU;AAAA,MACV,SAAS,OAAOxB,EAAM,cAAe,WAAWA,EAAM,aAAaA,EAAM;AAAA,MACzE,aAAa,CAAA;AAAA,MACb,KAAKA;AAAA,IAAA;AAIT,MAAIA,aAAiByB;AACnB,WAAO;AAAA,MACL,UAAU;AAAA,MACV,SAASzB,EAAM;AAAA,MACf,aAAa,CAAA;AAAA,MACb,KAAKA;AAAA,IAAA;AAIT,MAAIA,aAAiB0B,GAAoB;AACvC,UAAMC,IAAa3B,EAAM,SAAS,SAAS,QACrCqB,IAActB,EAAeC,CAAK,IACpCU,EAAmBV,EAAM,MAAM,IAC/BiB,EAA8BjB,EAAM,SAAS,IAAI;AAErD,WAAO;AAAA,MACL,UAAU;AAAA,MACV,SAASoB,EAAqBC,GAAarB,EAAM,OAAO;AAAA,MACxD,YAAA2B;AAAA,MACA,aAAAN;AAAA,MACA,KAAKrB;AAAA,IAAA;AAAA,EAET;AAEA,SAAIA,aAAiB,QACZ;AAAA,IACL,UAAU;AAAA,IACV,SAASA,EAAM;AAAA,IACf,aAAa,CAAA;AAAA,IACb,KAAKA;AAAA,EAAA,IAIF;AAAA,IACL,UAAU;AAAA,IACV,SAAS;AAAA,IACT,aAAa,CAAA;AAAA,IACb,KAAKA;AAAA,EAAA;AAET;"}

package/docs/guides/endpoint-inventory.json

@@ -1802,6 +1802,25 @@
         "contractorUuid"
       ]
     },
+    "ContractorOnboarding.SignatureForm": {
+      "endpoints": [
+        {
+          "method": "GET",
+          "path": "/v1/documents/:documentUuid"
+        },
+        {
+          "method": "GET",
+          "path": "/v1/documents/:documentUuid/pdf"
+        },
+        {
+          "method": "PUT",
+          "path": "/v1/documents/:documentUuid/sign"
+        }
+      ],
+      "variables": [
+        "documentUuid"
+      ]
+    },
     "ContractorManagement.PaymentsList": {
       "endpoints": [
         {
@@ -1945,6 +1964,16 @@
         "ContractorOnboarding.PaymentMethod"
       ]
     },
+    "ContractorOnboarding.SelfOnboardingFlow": {
+      "blocks": [
+        "ContractorOnboarding.Address",
+        "ContractorOnboarding.ContractorProfile",
+        "ContractorOnboarding.DocumentSigner",
+        "ContractorOnboarding.Landing",
+        "ContractorOnboarding.OnboardingSummary",
+        "ContractorOnboarding.PaymentMethod"
+      ]
+    },
     "EmployeeManagement.DashboardFlow": {
       "blocks": [
         "EmployeeManagement.Compensation",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gusto/embedded-react-sdk",
-  "version": "0.50.0",
+  "version": "0.51.0",
   "homepage": "https://github.com/Gusto/embedded-react-sdk",
   "bugs": {
     "url": "https://github.com/Gusto/embedded-react-sdk/issues"
@@ -31,9 +31,9 @@
     "./CHANGELOG.md"
   ],
   "scripts": {
-    "build": "npm run build:clean && npm run i18n:generate && vite build",
-    "api-report:derive": "api-extractor run --local --config .reports/config/api-extractor.json",
-    "derive": "npm run models:derive && npm run build && npm run endpoints:derive && npm run api-report:derive && npm run docs:api:generate",
+    "build": "npm run build:clean && vite build",
+    "api-report:derive": "api-extractor run --local --config .reports/config/api-extractor.json && node ./build/collapseApiReportTranslations.mjs",
+    "derive": "npm run models:derive && npm run i18n:generate && npm run build && npm run endpoints:derive && npm run api-report:derive && npm run docs:api:generate",
     "endpoints:derive": "npx tsx ./build/deriveEndpointInventory.ts",
     "endpoints:verify": "npx tsx ./build/deriveEndpointInventory.ts --verify",
     "models:derive": "npx tsx ./build/deriveExternalModels.ts",
@@ -138,7 +138,7 @@
     "jsdom-testing-mocks": "^1.16.0",
     "json-schema-to-typescript": "^15.0.4",
     "lint-staged": "^17.0.8",
-    "markdownlint-cli2": "^0.22.1",
+    "markdownlint-cli2": "^0.23.0",
     "msw": "^2.14.6",
     "npm-run-all": "^4.1.5",
     "pixelmatch": "^7.2.0",
@@ -153,7 +153,7 @@
     "storybook": "^10.4.4",
     "stylelint-config-standard": "^40.0.0",
     "ts-morph": "^28.0.0",
-    "tsx": "^4.22.4",
+    "tsx": "^4.23.0",
     "typescript-eslint": "^8.62.1",
     "vite": "^6.4.3",
     "vite-plugin-checker": "^0.14.4",
@@ -179,7 +179,7 @@
     "markdown-it": "^14.2.0"
   },
   "dependencies": {
-    "@gusto/embedded-api-v-2025-11-15": "^0.0.2",
+    "@gusto/embedded-api-v-2026-02-01": "^0.0.1",
     "@hookform/error-message": "^2.0.1",
     "@hookform/resolvers": "^5.4.0",
     "@internationalized/date": "^3.12.2",
@@ -191,7 +191,7 @@
     "react-aria": "^3.47.0",
     "react-aria-components": "1.16.0",
     "react-error-boundary": "^6.1.2",
-    "react-hook-form": "^7.80.0",
+    "react-hook-form": "^7.81.0",
     "react-i18next": "^17.0.8",
     "react-robot": "^1.2.1",
     "robot3": "^1.2.0",

package/dist/assets/icons/unchecked_circular.svg.js

@@ -1,10 +0,0 @@
-import * as e from "react";
-const i = ({
-  title: t,
-  titleId: r,
-  ...l
-}) => /* @__PURE__ */ e.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", width: 24, height: 24, viewBox: "0 0 24 24", fill: "none", "aria-labelledby": r, ...l }, t ? /* @__PURE__ */ e.createElement("title", { id: r }, t) : null, /* @__PURE__ */ e.createElement("rect", { x: 1, y: 1, width: 22, height: 22, rx: 11, fill: "none" }), /* @__PURE__ */ e.createElement("rect", { x: 1, y: 1, width: 22, height: 22, rx: 11, stroke: "currentColor", strokeWidth: 2 }));
-export {
-  i as default
-};
-//# sourceMappingURL=unchecked_circular.svg.js.map

package/dist/assets/icons/unchecked_circular.svg.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"unchecked_circular.svg.js","sources":["../../../src/assets/icons/unchecked_circular.svg?react"],"sourcesContent":["import * as React from \"react\";\nconst SvgUncheckedCircular = ({\n  title,\n  titleId,\n  ...props\n}) => /* @__PURE__ */ React.createElement(\"svg\", { xmlns: \"http://www.w3.org/2000/svg\", width: 24, height: 24, viewBox: \"0 0 24 24\", fill: \"none\", \"aria-labelledby\": titleId, ...props }, title ? /* @__PURE__ */ React.createElement(\"title\", { id: titleId }, title) : null, /* @__PURE__ */ React.createElement(\"rect\", { x: 1, y: 1, width: 22, height: 22, rx: 11, fill: \"none\" }), /* @__PURE__ */ React.createElement(\"rect\", { x: 1, y: 1, width: 22, height: 22, rx: 11, stroke: \"currentColor\", strokeWidth: 2 }));\nexport default SvgUncheckedCircular;\n"],"names":["SvgUncheckedCircular","title","titleId","props","React"],"mappings":";AACK,MAACA,IAAuB,CAAC;AAAA,EAC5B,OAAAC;AAAA,EACA,SAAAC;AAAA,EACA,GAAGC;AACL,MAAsB,gBAAAC,EAAM,cAAc,OAAO,EAAE,OAAO,8BAA8B,OAAO,IAAI,QAAQ,IAAI,SAAS,aAAa,MAAM,QAAQ,mBAAmBF,GAAS,GAAGC,EAAK,GAAIF,IAAwB,gBAAAG,EAAM,cAAc,SAAS,EAAE,IAAIF,EAAO,GAAID,CAAK,IAAI,MAAsB,gBAAAG,EAAM,cAAc,QAAQ,EAAE,GAAG,GAAG,GAAG,GAAG,OAAO,IAAI,QAAQ,IAAI,IAAI,IAAI,MAAM,OAAM,CAAE,GAAmB,gBAAAA,EAAM,cAAc,QAAQ,EAAE,GAAG,GAAG,GAAG,GAAG,OAAO,IAAI,QAAQ,IAAI,IAAI,IAAI,QAAQ,gBAAgB,aAAa,EAAC,CAAE,CAAC;"}

package/dist/components/Employee/OnboardingSummary/OnboardingSummary.module.scss.js

@@ -1,16 +0,0 @@
-const t = "_description_16lxz_1", s = "_list_16lxz_4", l = "_listItem_16lxz_8", e = "_listItemIcon_16lxz_13", i = "_incomplete_16lxz_16", o = {
-  description: t,
-  list: s,
-  listItem: l,
-  listItemIcon: e,
-  incomplete: i
-};
-export {
-  o as default,
-  t as description,
-  i as incomplete,
-  s as list,
-  l as listItem,
-  e as listItemIcon
-};
-//# sourceMappingURL=OnboardingSummary.module.scss.js.map

package/dist/components/Employee/OnboardingSummary/OnboardingSummary.module.scss.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"OnboardingSummary.module.scss.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;"}

package/dist/partner-hook-utils/form/useFieldErrorMessage.js

@@ -1,20 +0,0 @@
-import { useFormContext as m, get as d } from "react-hook-form";
-import { useFormFieldsMetadataContext as c } from "./FormFieldsMetadataContext.js";
-import { normalizeErrorKeyForForm as E } from "../../helpers/formattedStrings.js";
-function g(o, e) {
-  const {
-    formState: { errors: s }
-  } = m(), n = c()?.errors ?? [], r = d(s, o)?.message;
-  if (r && e?.[r])
-    return e[r];
-  for (const f of n) {
-    const t = f.fieldErrors.find(
-      (i) => E(i.field) === o
-    );
-    if (t?.message) return t.message;
-  }
-}
-export {
-  g as useFieldErrorMessage
-};
-//# sourceMappingURL=useFieldErrorMessage.js.map

package/dist/partner-hook-utils/form/useFieldErrorMessage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useFieldErrorMessage.js","sources":["../../../src/partner-hook-utils/form/useFieldErrorMessage.ts"],"sourcesContent":["import { useFormContext, get } from 'react-hook-form'\nimport type { ValidationMessages } from '../types'\nimport { useFormFieldsMetadataContext } from './FormFieldsMetadataContext'\nimport { normalizeErrorKeyForForm } from '@/helpers/formattedStrings'\n\n/**\n * Resolves the display string for a field's current error from either client-side validation or server-side `SDKError`s.\n *\n * @remarks\n * Use inside a custom field component rendered under a form hook's\n * provider to surface the same error message the built-in `Fields` would\n * render. Looks up the field's error in this order:\n *\n * 1. The react-hook-form error for `fieldName`. If its message matches a\n *    key in `validationMessages`, returns that mapped string.\n * 2. Any matching field-level error attached to a server-side error\n *    available on the form provider.\n * 3. `undefined` when no error applies.\n *\n * Must be called from a component rendered inside the form hook's\n * `FormProvider`.\n *\n * @typeParam TErrorCode - Error codes the field can produce; each key in `validationMessages` maps a code to its display string.\n * @param fieldName - Name of the field as registered with react-hook-form.\n * @param validationMessages - Map of validation error codes to display strings. When omitted, only server-side errors are returned.\n * @returns The display message for the field's current error, or `undefined` when the field is valid.\n * @internal\n *\n * @example\n * ```tsx\n * function StreetAddressField() {\n *   const errorMessage = useFieldErrorMessage('street1', {\n *     REQUIRED: 'Street address is required',\n *   })\n *   return (\n *     <label>\n *       Street\n *       <input name=\"street1\" aria-invalid={errorMessage ? true : undefined} />\n *       {errorMessage ? <span role=\"alert\">{errorMessage}</span> : null}\n *     </label>\n *   )\n * }\n * ```\n */\nexport function useFieldErrorMessage<TErrorCode extends string>(\n  fieldName: string,\n  validationMessages?: ValidationMessages<TErrorCode>,\n): string | undefined {\n  const {\n    formState: { errors },\n  } = useFormContext()\n  const context = useFormFieldsMetadataContext()\n  const sdkErrors = context?.errors ?? []\n\n  const fieldError = get(errors, fieldName) as { message?: string } | undefined\n  const errorCode = fieldError?.message as TErrorCode | undefined\n  if (errorCode && validationMessages?.[errorCode]) {\n    return validationMessages[errorCode]\n  }\n\n  for (const sdkError of sdkErrors) {\n    const sdkFieldError = sdkError.fieldErrors.find(\n      fe => normalizeErrorKeyForForm(fe.field) === fieldName,\n    )\n    if (sdkFieldError?.message) return sdkFieldError.message\n  }\n\n  return undefined\n}\n"],"names":["useFieldErrorMessage","fieldName","validationMessages","errors","useFormContext","sdkErrors","useFormFieldsMetadataContext","errorCode","get","sdkError","sdkFieldError","fe","normalizeErrorKeyForForm"],"mappings":";;;AA4CO,SAASA,EACdC,GACAC,GACoB;AACpB,QAAM;AAAA,IACJ,WAAW,EAAE,QAAAC,EAAA;AAAA,EAAO,IAClBC,EAAA,GAEEC,IADUC,EAAA,GACW,UAAU,CAAA,GAG/BC,IADaC,EAAIL,GAAQF,CAAS,GACV;AAC9B,MAAIM,KAAaL,IAAqBK,CAAS;AAC7C,WAAOL,EAAmBK,CAAS;AAGrC,aAAWE,KAAYJ,GAAW;AAChC,UAAMK,IAAgBD,EAAS,YAAY;AAAA,MACzC,CAAAE,MAAMC,EAAyBD,EAAG,KAAK,MAAMV;AAAA,IAAA;AAE/C,QAAIS,GAAe,QAAS,QAAOA,EAAc;AAAA,EACnD;AAGF;"}