@gusto/embedded-react-sdk 0.52.0 → 0.52.2

package/dist/components/Contractor/Documents/SignatureForm/useContractorSignatureForm/w9Fields.d.ts

@@ -16,39 +16,6 @@ export declare const W9_DOCUMENT_NAME = "taxpayer_identification_form_w_9";
  * @internal
  */
 export declare const NOT_APPLICABLE_VALUE = "N/A";
-/**
- * EIN input transform that preserves the `N/A` sentinel (and the in-progress
- * prefixes a user types toward it) while formatting numeric input as a standard
- * EIN (`NN-NNNNNNN`).
- *
- * @remarks
- * The W-9 accepts `N/A` for a taxpayer who supplies an SSN instead of an EIN,
- * but the plain `normalizeEin` formatter strips every non-digit on each
- * keystroke — making the sentinel impossible to type. This wrapper lets the
- * sentinel through (normalized to uppercase) and defers to `normalizeEin` for
- * everything else.
- *
- * @param value - Raw user input.
- * @returns The `N/A` sentinel (or an in-progress prefix), otherwise the EIN-formatted value.
- * @internal
- */
-export declare function normalizeEinOrNotApplicable(value: string): string;
-/**
- * SSN input transform that preserves the `N/A` sentinel (and the in-progress
- * prefixes `N` and `N/`) while otherwise deferring to {@link normalizeSSN}.
- *
- * @remarks
- * The W-9 accepts `N/A` for a taxpayer who supplies an EIN instead of an SSN,
- * but the plain `normalizeSSN` formatter strips every non-digit on each
- * keystroke — making the sentinel impossible to type. This wrapper lets the
- * sentinel through (normalized to uppercase) and defers to `normalizeSSN` for
- * everything else.
- *
- * @param value - Raw user input.
- * @returns The `N/A` sentinel (or an in-progress prefix), otherwise the SSN-formatted value.
- * @internal
- */
-export declare function normalizeSsnOrNotApplicable(value: string): string;
 /**
  * Form-field name for the synthesized federal tax classification radio group.
  *

package/dist/components/Contractor/Documents/SignatureForm/useContractorSignatureForm/w9Fields.js

@@ -1,15 +1,4 @@
-import { normalizeEin as S } from "../../../../../helpers/federalEin.js";
-import { normalizeSSN as N } from "../../../../../helpers/ssn.js";
-const R = "taxpayer_identification_form_w_9", _ = "N/A";
-function D(e) {
-  const t = e.replace(/\s/g, "").toUpperCase();
-  return t === "NA" ? _ : t === "N" || t === "N/" || t === _ ? t : S(e);
-}
-function k(e) {
-  const t = e.replace(/\s/g, "").toUpperCase();
-  return t === "NA" ? _ : t === "N" || t === "N/" || t === _ ? t : N(e);
-}
-const x = "taxClassification", T = "llcClassificationCode", F = "otherText", C = [
+const C = "taxpayer_identification_form_w_9", P = "N/A", S = "taxClassification", x = "llcClassificationCode", T = "otherText", A = [
   "individual_proprietor",
   "c_corporation",
   "s_corporation",
@@ -17,7 +6,7 @@ const x = "taxClassification", T = "llcClassificationCode", F = "otherText", C =
   "trust_estate",
   "limited_liability_company",
   "other"
-], y = "limited_liability_company", I = "other", K = ["c", "s", "p"], l = {
+], y = "limited_liability_company", F = "other", b = ["c", "s", "p"], _ = {
   name: "name",
   businessName: "business_name",
   otherText: "other_text",
@@ -34,64 +23,67 @@ const x = "taxClassification", T = "llcClassificationCode", F = "otherText", C =
   ssn: "ssn",
   ein: "ein",
   signatureText: "signature_text"
-}, g = /* @__PURE__ */ new Set(["ssn", "ein"]);
-function E(e) {
-  return typeof e == "string" && /[X•*]/.test(e);
+}, I = /* @__PURE__ */ new Set(["ssn", "ein"]);
+function N(s) {
+  return typeof s == "string" && /[X•*]/.test(s);
+}
+function h(s) {
+  return s ? (I.has(s.key ?? "") || s.dataType === "ssn" || s.dataType === "ein") && N(s.value) : !1;
 }
-function h(e) {
-  return e ? (g.has(e.key ?? "") || e.dataType === "ssn" || e.dataType === "ein") && E(e.value) : !1;
+function u(s) {
+  const n = /* @__PURE__ */ new Map();
+  for (const t of s.fields ?? [])
+    t.key && n.set(t.key, t);
+  return n;
 }
-function u(e) {
-  const t = /* @__PURE__ */ new Map();
-  for (const n of e.fields ?? [])
-    n.key && t.set(n.key, n);
-  return t;
+function p(s) {
+  return s === "1" || s === "true";
 }
-function A(e) {
-  return e === "1" || e === "true";
+function O(s) {
+  return s.name === C;
 }
-function b(e) {
-  const t = u(e), n = t.get("ssn"), s = t.get("ein"), o = h(n), a = h(s);
+function g(s) {
+  const n = u(s), t = n.get("ssn"), e = n.get("ein"), a = h(t), o = h(e);
   return {
-    ssnRedacted: o,
-    einRedacted: a,
-    ssnPlaceholder: o ? n?.value ?? void 0 : void 0,
-    einPlaceholder: a ? s?.value ?? void 0 : void 0
+    ssnRedacted: a,
+    einRedacted: o,
+    ssnPlaceholder: a ? t?.value ?? void 0 : void 0,
+    einPlaceholder: o ? e?.value ?? void 0 : void 0
   };
 }
-function L(e) {
-  const t = u(e), n = /* @__PURE__ */ new Set();
-  for (const [o, a] of Object.entries(l))
-    t.has(a) && n.add(o);
-  return C.some((o) => t.has(o)) && (n.add(x), n.add(T)), n;
+function E(s) {
+  const n = u(s), t = /* @__PURE__ */ new Set();
+  for (const [a, o] of Object.entries(_))
+    n.has(o) && t.add(a);
+  return A.some((a) => n.has(a)) && (t.add(S), t.add(x)), t;
 }
-function z(e) {
-  const t = u(e), n = b(e), s = (a) => t.get(a)?.value ?? "", o = C.find((a) => A(t.get(a)?.value)) ?? "";
+function v(s) {
+  const n = u(s), t = g(s), e = (o) => n.get(o)?.value ?? "", a = A.find((o) => p(n.get(o)?.value)) ?? "";
   return {
-    name: s("name"),
-    businessName: s("business_name"),
-    taxClassification: o,
+    name: e("name"),
+    businessName: e("business_name"),
+    taxClassification: a,
     // The LLC code serializes into the `tax_classification` field, so seed it
     // back from there when the LLC classification is the selected one.
-    llcClassificationCode: o === y ? s("tax_classification") : "",
-    otherText: s("other_text"),
-    foreignPartners: A(t.get("foreign_partners")?.value),
-    exemptPayeeCode: s("exempt_payee_code"),
-    exemptionFromFatca: s("exemption_from_FATCA"),
-    homeAddressStreet1: s("home_address_street_1"),
-    homeAddressStreet2: s("home_address_street_2"),
-    homeAddressCity: s("home_address_city"),
-    homeAddressState: s("home_address_state"),
-    homeAddressZip: s("home_address_zip"),
-    accountNumber: s("account_number"),
-    companyName: s("company_name"),
-    ssn: n.ssnRedacted ? "" : s("ssn"),
-    ein: n.einRedacted ? "" : s("ein"),
-    signatureText: s("signature_text"),
+    llcClassificationCode: a === y ? e("tax_classification") : "",
+    otherText: e("other_text"),
+    foreignPartners: p(n.get("foreign_partners")?.value),
+    exemptPayeeCode: e("exempt_payee_code"),
+    exemptionFromFatca: e("exemption_from_FATCA"),
+    homeAddressStreet1: e("home_address_street_1"),
+    homeAddressStreet2: e("home_address_street_2"),
+    homeAddressCity: e("home_address_city"),
+    homeAddressState: e("home_address_state"),
+    homeAddressZip: e("home_address_zip"),
+    accountNumber: e("account_number"),
+    companyName: e("company_name"),
+    ssn: t.ssnRedacted ? "" : e("ssn"),
+    ein: t.einRedacted ? "" : e("ein"),
+    signatureText: e("signature_text"),
     agree: !1
   };
 }
-const V = {
+const D = {
   name: "",
   businessName: "",
   taxClassification: "",
@@ -111,7 +103,7 @@ const V = {
   ein: "",
   signatureText: "",
   agree: !1
-}, O = [
+}, L = [
   "name",
   "businessName",
   "exemptPayeeCode",
@@ -125,39 +117,38 @@ const V = {
   "companyName",
   "signatureText"
 ];
-function U(e, t, n) {
-  const s = L(e), o = [], a = t, r = (i) => {
-    const m = a[i];
+function R(s, n, t) {
+  const e = E(s), a = [], o = n, r = (i) => {
+    const m = o[i];
     return typeof m == "string" ? m : "";
-  }, c = r("taxClassification"), d = (i, m) => {
-    o.push({ key: l[i], value: m });
+  }, d = r("taxClassification"), c = (i, m) => {
+    a.push({ key: _[i], value: m });
   };
-  for (const i of O)
-    s.has(i) && d(i, r(i));
-  s.has(F) && c === I && d("otherText", r("otherText")), s.has("foreignPartners") && o.push({
-    key: l.foreignPartners,
-    value: t.foreignPartners ? "1" : "0"
+  for (const i of L)
+    e.has(i) && c(i, r(i));
+  e.has(T) && d === F && c("otherText", r("otherText")), e.has("foreignPartners") && a.push({
+    key: _.foreignPartners,
+    value: n.foreignPartners ? "1" : "0"
   });
-  const f = r("ssn"), p = r("ein");
-  return s.has("ssn") && !(n.ssnRedacted && f === "") && d("ssn", f), s.has("ein") && !(n.einRedacted && p === "") && d("ein", p), c && (o.push({ key: c, value: "1" }), c === y && o.push({ key: "tax_classification", value: r("llcClassificationCode") })), o;
+  const l = r("ssn"), f = r("ein");
+  return e.has("ssn") && !(t.ssnRedacted && l === "") && c("ssn", l), e.has("ein") && !(t.einRedacted && f === "") && c("ein", f), d && (a.push({ key: d, value: "1" }), d === y && a.push({ key: "tax_classification", value: r("llcClassificationCode") })), a;
 }
 export {
-  V as EMPTY_W9_DEFAULTS,
-  K as LLC_CLASSIFICATION_CODES,
-  T as LLC_CLASSIFICATION_FIELD,
+  D as EMPTY_W9_DEFAULTS,
+  b as LLC_CLASSIFICATION_CODES,
+  x as LLC_CLASSIFICATION_FIELD,
   y as LLC_CLASSIFICATION_OPTION,
-  _ as NOT_APPLICABLE_VALUE,
-  I as OTHER_CLASSIFICATION_OPTION,
-  F as OTHER_TEXT_FIELD,
-  x as TAX_CLASSIFICATION_FIELD,
-  C as TAX_CLASSIFICATION_OPTION_KEYS,
-  R as W9_DOCUMENT_NAME,
-  l as W9_FIELD_API_KEYS,
-  z as buildW9Defaults,
-  L as getPresentFieldNames,
-  b as getRedactionState,
-  D as normalizeEinOrNotApplicable,
-  k as normalizeSsnOrNotApplicable,
-  U as serializeW9Fields
+  P as NOT_APPLICABLE_VALUE,
+  F as OTHER_CLASSIFICATION_OPTION,
+  T as OTHER_TEXT_FIELD,
+  S as TAX_CLASSIFICATION_FIELD,
+  A as TAX_CLASSIFICATION_OPTION_KEYS,
+  C as W9_DOCUMENT_NAME,
+  _ as W9_FIELD_API_KEYS,
+  v as buildW9Defaults,
+  E as getPresentFieldNames,
+  g as getRedactionState,
+  O as isW9Document,
+  R as serializeW9Fields
 };
 //# sourceMappingURL=w9Fields.js.map

package/dist/components/Contractor/Documents/SignatureForm/useContractorSignatureForm/w9Fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"w9Fields.js","sources":["../../../../../../src/components/Contractor/Documents/SignatureForm/useContractorSignatureForm/w9Fields.ts"],"sourcesContent":["import type {\n  Document,\n  Fields as DocumentField,\n} from '@gusto/embedded-api/models/components/document'\nimport type { ContractorSignatureFormData } from './contractorSignatureFormSchema'\nimport { normalizeEin } from '@/helpers/federalEin'\nimport { normalizeSSN } from '@/helpers/ssn'\n\n/**\n * The `name` of the W-9 document — the only contractor document type that\n * supports signing today.\n *\n * @internal\n */\nexport const W9_DOCUMENT_NAME = 'taxpayer_identification_form_w_9'\n\n/**\n * Sentinel the API returns (and accepts) for a taxpayer-ID field that doesn't\n * apply to the signer — e.g. the EIN of an individual contractor, or the SSN of\n * a business contractor. The sign endpoint stamps this verbatim, so the form\n * both prefills it and treats it as a valid submission.\n *\n * @internal\n */\nexport const NOT_APPLICABLE_VALUE = 'N/A'\n\n/**\n * EIN input transform that preserves the `N/A` sentinel (and the in-progress\n * prefixes a user types toward it) while formatting numeric input as a standard\n * EIN (`NN-NNNNNNN`).\n *\n * @remarks\n * The W-9 accepts `N/A` for a taxpayer who supplies an SSN instead of an EIN,\n * but the plain `normalizeEin` formatter strips every non-digit on each\n * keystroke — making the sentinel impossible to type. This wrapper lets the\n * sentinel through (normalized to uppercase) and defers to `normalizeEin` for\n * everything else.\n *\n * @param value - Raw user input.\n * @returns The `N/A` sentinel (or an in-progress prefix), otherwise the EIN-formatted value.\n * @internal\n */\nexport function normalizeEinOrNotApplicable(value: string): string {\n  const sentinel = value.replace(/\\s/g, '').toUpperCase()\n  if (sentinel === 'NA') return NOT_APPLICABLE_VALUE\n  if (sentinel === 'N' || sentinel === 'N/' || sentinel === NOT_APPLICABLE_VALUE) return sentinel\n  return normalizeEin(value)\n}\n\n/**\n * SSN input transform that preserves the `N/A` sentinel (and the in-progress\n * prefixes `N` and `N/`) while otherwise deferring to {@link normalizeSSN}.\n *\n * @remarks\n * The W-9 accepts `N/A` for a taxpayer who supplies an EIN instead of an SSN,\n * but the plain `normalizeSSN` formatter strips every non-digit on each\n * keystroke — making the sentinel impossible to type. This wrapper lets the\n * sentinel through (normalized to uppercase) and defers to `normalizeSSN` for\n * everything else.\n *\n * @param value - Raw user input.\n * @returns The `N/A` sentinel (or an in-progress prefix), otherwise the SSN-formatted value.\n * @internal\n */\nexport function normalizeSsnOrNotApplicable(value: string): string {\n  const sentinel = value.replace(/\\s/g, '').toUpperCase()\n  if (sentinel === 'NA') return NOT_APPLICABLE_VALUE\n  if (sentinel === 'N' || sentinel === 'N/' || sentinel === NOT_APPLICABLE_VALUE) return sentinel\n  return normalizeSSN(value)\n}\n\n/**\n * Form-field name for the synthesized federal tax classification radio group.\n *\n * @internal\n */\nexport const TAX_CLASSIFICATION_FIELD = 'taxClassification'\n\n/**\n * Form-field name for the synthesized LLC tax classification code select.\n *\n * @internal\n */\nexport const LLC_CLASSIFICATION_FIELD = 'llcClassificationCode'\n\n/**\n * Form-field name for the \"Other\" free-text classification field.\n *\n * @internal\n */\nexport const OTHER_TEXT_FIELD = 'otherText'\n\n/**\n * Ordered classification option keys backing the {@link TAX_CLASSIFICATION_FIELD}\n * radio group. Each maps to a W-9 checkbox field on the underlying document.\n *\n * @internal\n */\nexport const TAX_CLASSIFICATION_OPTION_KEYS = [\n  'individual_proprietor',\n  'c_corporation',\n  's_corporation',\n  'partnership',\n  'trust_estate',\n  'limited_liability_company',\n  'other',\n] as const\n\n/**\n * A single federal tax classification option key.\n *\n * @internal\n */\nexport type TaxClassificationOptionKey = (typeof TAX_CLASSIFICATION_OPTION_KEYS)[number]\n\n/**\n * The classification option that reveals the LLC tax classification select.\n *\n * @internal\n */\nexport const LLC_CLASSIFICATION_OPTION: TaxClassificationOptionKey = 'limited_liability_company'\n\n/**\n * The classification option that reveals the \"Other\" free-text field.\n *\n * @internal\n */\nexport const OTHER_CLASSIFICATION_OPTION: TaxClassificationOptionKey = 'other'\n\n/**\n * Ordered LLC tax classification code options.\n *\n * @internal\n */\nexport const LLC_CLASSIFICATION_CODES = ['c', 's', 'p'] as const\n\n/**\n * Maps each pass-through {@link ContractorSignatureFormData} field to its W-9\n * API field key. Synthesized fields (`taxClassification`,\n * `llcClassificationCode`) and `agree` are intentionally absent.\n *\n * @internal\n */\nexport const W9_FIELD_API_KEYS = {\n  name: 'name',\n  businessName: 'business_name',\n  otherText: 'other_text',\n  foreignPartners: 'foreign_partners',\n  exemptPayeeCode: 'exempt_payee_code',\n  exemptionFromFatca: 'exemption_from_FATCA',\n  homeAddressStreet1: 'home_address_street_1',\n  homeAddressStreet2: 'home_address_street_2',\n  homeAddressCity: 'home_address_city',\n  homeAddressState: 'home_address_state',\n  homeAddressZip: 'home_address_zip',\n  accountNumber: 'account_number',\n  companyName: 'company_name',\n  ssn: 'ssn',\n  ein: 'ein',\n  signatureText: 'signature_text',\n} as const satisfies Record<string, string>\n\n/** A pass-through W-9 field name (one with a single backing API key). */\ntype PassThroughFieldName = keyof typeof W9_FIELD_API_KEYS\n\n/** API field keys whose values are sensitive and arrive masked when on file. */\nconst SENSITIVE_FIELD_KEYS = new Set(['ssn', 'ein'])\n\n/** Whether a value is a server-side mask (e.g. `XXX-XX-1111`) rather than real input. */\nfunction isMaskedValue(value: string | null | undefined): boolean {\n  return typeof value === 'string' && /[X•*]/.test(value)\n}\n\n/** Whether a document field carries a redacted (masked) sensitive value. */\nfunction hasRedactedValue(field: DocumentField | undefined): boolean {\n  if (!field) return false\n  const isSensitive =\n    SENSITIVE_FIELD_KEYS.has(field.key ?? '') ||\n    field.dataType === 'ssn' ||\n    field.dataType === 'ein'\n  return isSensitive && isMaskedValue(field.value)\n}\n\nfunction indexFields(document: Document): Map<string, DocumentField> {\n  const byKey = new Map<string, DocumentField>()\n  for (const field of document.fields ?? []) {\n    if (field.key) byKey.set(field.key, field)\n  }\n  return byKey\n}\n\n/** Coerces an API checkbox value (`'1'`, `'true'`) to a boolean. */\nfunction toBoolean(value: string | null | undefined): boolean {\n  return value === '1' || value === 'true'\n}\n\n/**\n * Whether the document is a W-9 (the only signable contractor document type).\n *\n * @internal\n */\nexport function isW9Document(document: Document): boolean {\n  return document.name === W9_DOCUMENT_NAME\n}\n\n/**\n * Redaction state for the sensitive W-9 fields, derived from the API response.\n *\n * @internal\n */\nexport interface W9RedactionState {\n  /** Whether the API returned a masked SSN value. */\n  ssnRedacted: boolean\n  /** Whether the API returned a masked EIN value. */\n  einRedacted: boolean\n  /** The masked SSN to surface as a placeholder, when redacted. */\n  ssnPlaceholder?: string\n  /** The masked EIN to surface as a placeholder, when redacted. */\n  einPlaceholder?: string\n}\n\n/**\n * Computes the redaction state of the SSN/EIN fields from the document.\n *\n * @param document - The W-9 document returned by the API.\n * @returns The redaction flags and masked placeholders.\n * @internal\n */\nexport function getRedactionState(document: Document): W9RedactionState {\n  const byKey = indexFields(document)\n  const ssnField = byKey.get('ssn')\n  const einField = byKey.get('ein')\n  const ssnRedacted = hasRedactedValue(ssnField)\n  const einRedacted = hasRedactedValue(einField)\n  return {\n    ssnRedacted,\n    einRedacted,\n    ssnPlaceholder: ssnRedacted ? (ssnField?.value ?? undefined) : undefined,\n    einPlaceholder: einRedacted ? (einField?.value ?? undefined) : undefined,\n  }\n}\n\n/**\n * Computes which W-9 form fields the API actually returned — the safety check\n * that drives presence-gating in {@link useContractorSignatureForm}.\n *\n * @remarks\n * A pass-through field is present when its API key is in `document.fields`. The\n * synthesized classification fields (`taxClassification`,\n * `llcClassificationCode`) are present when the document carries any of the\n * federal tax classification checkbox fields.\n *\n * @param document - The W-9 document returned by the API.\n * @returns The set of present camelCase field names.\n * @internal\n */\nexport function getPresentFieldNames(document: Document): Set<string> {\n  const byKey = indexFields(document)\n  const presentFieldNames = new Set<string>()\n\n  for (const [fieldName, apiKey] of Object.entries(W9_FIELD_API_KEYS)) {\n    if (byKey.has(apiKey)) presentFieldNames.add(fieldName)\n  }\n\n  const hasClassification = TAX_CLASSIFICATION_OPTION_KEYS.some(key => byKey.has(key))\n  if (hasClassification) {\n    presentFieldNames.add(TAX_CLASSIFICATION_FIELD)\n    presentFieldNames.add(LLC_CLASSIFICATION_FIELD)\n  }\n\n  return presentFieldNames\n}\n\n/**\n * Builds default form values from a document's fields.\n *\n * @remarks\n * Pass-through values are seeded from the API `value`. The classification radio\n * defaults to whichever classification checkbox is already set (`'1'`/`'true'`),\n * and when that is the LLC classification the LLC code select is seeded from the\n * `tax_classification` field it serializes into. A masked SSN/EIN seeds an empty\n * input (the mask is surfaced as a placeholder instead) so it is never echoed\n * back as the new value on submit.\n *\n * @param document - The W-9 document returned by the API.\n * @returns The default form values.\n * @internal\n */\nexport function buildW9Defaults(document: Document): ContractorSignatureFormData {\n  const byKey = indexFields(document)\n  const redaction = getRedactionState(document)\n  const textValue = (apiKey: string): string => byKey.get(apiKey)?.value ?? ''\n  const selectedClassification =\n    TAX_CLASSIFICATION_OPTION_KEYS.find(key => toBoolean(byKey.get(key)?.value)) ?? ''\n\n  return {\n    name: textValue('name'),\n    businessName: textValue('business_name'),\n    taxClassification: selectedClassification,\n    // The LLC code serializes into the `tax_classification` field, so seed it\n    // back from there when the LLC classification is the selected one.\n    llcClassificationCode:\n      selectedClassification === LLC_CLASSIFICATION_OPTION ? textValue('tax_classification') : '',\n    otherText: textValue('other_text'),\n    foreignPartners: toBoolean(byKey.get('foreign_partners')?.value),\n    exemptPayeeCode: textValue('exempt_payee_code'),\n    exemptionFromFatca: textValue('exemption_from_FATCA'),\n    homeAddressStreet1: textValue('home_address_street_1'),\n    homeAddressStreet2: textValue('home_address_street_2'),\n    homeAddressCity: textValue('home_address_city'),\n    homeAddressState: textValue('home_address_state'),\n    homeAddressZip: textValue('home_address_zip'),\n    accountNumber: textValue('account_number'),\n    companyName: textValue('company_name'),\n    ssn: redaction.ssnRedacted ? '' : textValue('ssn'),\n    ein: redaction.einRedacted ? '' : textValue('ein'),\n    signatureText: textValue('signature_text'),\n    agree: false,\n  }\n}\n\n/**\n * The empty default form values, used while the document is still loading.\n *\n * @internal\n */\nexport const EMPTY_W9_DEFAULTS: ContractorSignatureFormData = {\n  name: '',\n  businessName: '',\n  taxClassification: '',\n  llcClassificationCode: '',\n  otherText: '',\n  foreignPartners: false,\n  exemptPayeeCode: '',\n  exemptionFromFatca: '',\n  homeAddressStreet1: '',\n  homeAddressStreet2: '',\n  homeAddressCity: '',\n  homeAddressState: '',\n  homeAddressZip: '',\n  accountNumber: '',\n  companyName: '',\n  ssn: '',\n  ein: '',\n  signatureText: '',\n  agree: false,\n}\n\n/**\n * A single `{ key, value }` pair sent in the sign request.\n *\n * @internal\n */\nexport interface SignFieldValue {\n  /** The API field key. */\n  key: string\n  /** The serialized field value. */\n  value: string\n}\n\n/** Pass-through text fields serialized verbatim (everything except the checkbox and TIN fields). */\nconst TEXT_PASS_THROUGH_FIELDS: PassThroughFieldName[] = [\n  'name',\n  'businessName',\n  'exemptPayeeCode',\n  'exemptionFromFatca',\n  'homeAddressStreet1',\n  'homeAddressStreet2',\n  'homeAddressCity',\n  'homeAddressState',\n  'homeAddressZip',\n  'accountNumber',\n  'companyName',\n  'signatureText',\n]\n\n/**\n * Serializes W-9 form values into the `{ key, value }` field array expected by\n * the sign API.\n *\n * @remarks\n * Only fields the API returned (see {@link getPresentFieldNames}) are sent.\n * Applies the W-9 mapping: the chosen classification key is sent with value\n * `'1'`; when the LLC classification is chosen, the selected LLC code is sent\n * under the `tax_classification` key. `foreignPartners` serializes to\n * `'1'`/`'0'`. The `otherText` value is only included for the \"Other\"\n * classification. An untouched redacted SSN/EIN is omitted so the mask is never\n * sent back. The `date` field is intentionally omitted so the API auto-fills the\n * signing date in its own locale-correct format.\n *\n * @param document - The W-9 document being signed.\n * @param values - The validated form values.\n * @param redaction - The redaction state from {@link getRedactionState}.\n * @returns The ordered field array for the sign request body.\n * @internal\n */\nexport function serializeW9Fields(\n  document: Document,\n  values: ContractorSignatureFormData,\n  redaction: W9RedactionState,\n): SignFieldValue[] {\n  const presentFieldNames = getPresentFieldNames(document)\n  const fields: SignFieldValue[] = []\n  // The schema preprocesses empty inputs to `undefined`, so read through an\n  // `unknown` view and coalesce missing values to an empty string.\n  const raw = values as Record<string, unknown>\n  const text = (name: string): string => {\n    const value = raw[name]\n    return typeof value === 'string' ? value : ''\n  }\n  const classification = text('taxClassification')\n\n  const pushField = (fieldName: PassThroughFieldName, value: string) => {\n    fields.push({ key: W9_FIELD_API_KEYS[fieldName], value })\n  }\n\n  for (const fieldName of TEXT_PASS_THROUGH_FIELDS) {\n    if (!presentFieldNames.has(fieldName)) continue\n    pushField(fieldName, text(fieldName))\n  }\n\n  if (presentFieldNames.has(OTHER_TEXT_FIELD) && classification === OTHER_CLASSIFICATION_OPTION) {\n    pushField('otherText', text('otherText'))\n  }\n\n  if (presentFieldNames.has('foreignPartners')) {\n    fields.push({\n      key: W9_FIELD_API_KEYS.foreignPartners,\n      value: values.foreignPartners ? '1' : '0',\n    })\n  }\n\n  // A redacted field left untouched is omitted so the masked value isn't sent\n  // back as a replacement; the server keeps the value already on file.\n  const ssnValue = text('ssn')\n  const einValue = text('ein')\n  if (presentFieldNames.has('ssn') && !(redaction.ssnRedacted && ssnValue === '')) {\n    pushField('ssn', ssnValue)\n  }\n  if (presentFieldNames.has('ein') && !(redaction.einRedacted && einValue === '')) {\n    pushField('ein', einValue)\n  }\n\n  if (classification) {\n    fields.push({ key: classification, value: '1' })\n    if (classification === LLC_CLASSIFICATION_OPTION) {\n      fields.push({ key: 'tax_classification', value: text('llcClassificationCode') })\n    }\n  }\n\n  return fields\n}\n"],"names":["W9_DOCUMENT_NAME","NOT_APPLICABLE_VALUE","normalizeEinOrNotApplicable","value","sentinel","normalizeEin","normalizeSsnOrNotApplicable","normalizeSSN","TAX_CLASSIFICATION_FIELD","LLC_CLASSIFICATION_FIELD","OTHER_TEXT_FIELD","TAX_CLASSIFICATION_OPTION_KEYS","LLC_CLASSIFICATION_OPTION","OTHER_CLASSIFICATION_OPTION","LLC_CLASSIFICATION_CODES","W9_FIELD_API_KEYS","SENSITIVE_FIELD_KEYS","isMaskedValue","hasRedactedValue","field","indexFields","document","byKey","toBoolean","getRedactionState","ssnField","einField","ssnRedacted","einRedacted","getPresentFieldNames","presentFieldNames","fieldName","apiKey","key","buildW9Defaults","redaction","textValue","selectedClassification","EMPTY_W9_DEFAULTS","TEXT_PASS_THROUGH_FIELDS","serializeW9Fields","values","fields","raw","text","name","classification","pushField","ssnValue","einValue"],"mappings":";;AAcO,MAAMA,IAAmB,oCAUnBC,IAAuB;AAkB7B,SAASC,EAA4BC,GAAuB;AACjE,QAAMC,IAAWD,EAAM,QAAQ,OAAO,EAAE,EAAE,YAAA;AAC1C,SAAIC,MAAa,OAAaH,IAC1BG,MAAa,OAAOA,MAAa,QAAQA,MAAaH,IAA6BG,IAChFC,EAAaF,CAAK;AAC3B;AAiBO,SAASG,EAA4BH,GAAuB;AACjE,QAAMC,IAAWD,EAAM,QAAQ,OAAO,EAAE,EAAE,YAAA;AAC1C,SAAIC,MAAa,OAAaH,IAC1BG,MAAa,OAAOA,MAAa,QAAQA,MAAaH,IAA6BG,IAChFG,EAAaJ,CAAK;AAC3B;AAOO,MAAMK,IAA2B,qBAO3BC,IAA2B,yBAO3BC,IAAmB,aAQnBC,IAAiC;AAAA,EAC5C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAcaC,IAAwD,6BAOxDC,IAA0D,SAO1DC,IAA2B,CAAC,KAAK,KAAK,GAAG,GASzCC,IAAoB;AAAA,EAC/B,MAAM;AAAA,EACN,cAAc;AAAA,EACd,WAAW;AAAA,EACX,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,iBAAiB;AAAA,EACjB,kBAAkB;AAAA,EAClB,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,aAAa;AAAA,EACb,KAAK;AAAA,EACL,KAAK;AAAA,EACL,eAAe;AACjB,GAMMC,IAAuB,oBAAI,IAAI,CAAC,OAAO,KAAK,CAAC;AAGnD,SAASC,EAAcd,GAA2C;AAChE,SAAO,OAAOA,KAAU,YAAY,QAAQ,KAAKA,CAAK;AACxD;AAGA,SAASe,EAAiBC,GAA2C;AACnE,SAAKA,KAEHH,EAAqB,IAAIG,EAAM,OAAO,EAAE,KACxCA,EAAM,aAAa,SACnBA,EAAM,aAAa,UACCF,EAAcE,EAAM,KAAK,IAL5B;AAMrB;AAEA,SAASC,EAAYC,GAAgD;AACnE,QAAMC,wBAAY,IAAA;AAClB,aAAWH,KAASE,EAAS,UAAU,CAAA;AACrC,IAAIF,EAAM,OAAKG,EAAM,IAAIH,EAAM,KAAKA,CAAK;AAE3C,SAAOG;AACT;AAGA,SAASC,EAAUpB,GAA2C;AAC5D,SAAOA,MAAU,OAAOA,MAAU;AACpC;AAkCO,SAASqB,EAAkBH,GAAsC;AACtE,QAAMC,IAAQF,EAAYC,CAAQ,GAC5BI,IAAWH,EAAM,IAAI,KAAK,GAC1BI,IAAWJ,EAAM,IAAI,KAAK,GAC1BK,IAAcT,EAAiBO,CAAQ,GACvCG,IAAcV,EAAiBQ,CAAQ;AAC7C,SAAO;AAAA,IACL,aAAAC;AAAA,IACA,aAAAC;AAAA,IACA,gBAAgBD,IAAeF,GAAU,SAAS,SAAa;AAAA,IAC/D,gBAAgBG,IAAeF,GAAU,SAAS,SAAa;AAAA,EAAA;AAEnE;AAgBO,SAASG,EAAqBR,GAAiC;AACpE,QAAMC,IAAQF,EAAYC,CAAQ,GAC5BS,wBAAwB,IAAA;AAE9B,aAAW,CAACC,GAAWC,CAAM,KAAK,OAAO,QAAQjB,CAAiB;AAChE,IAAIO,EAAM,IAAIU,CAAM,KAAGF,EAAkB,IAAIC,CAAS;AAIxD,SAD0BpB,EAA+B,KAAK,OAAOW,EAAM,IAAIW,CAAG,CAAC,MAEjFH,EAAkB,IAAItB,CAAwB,GAC9CsB,EAAkB,IAAIrB,CAAwB,IAGzCqB;AACT;AAiBO,SAASI,EAAgBb,GAAiD;AAC/E,QAAMC,IAAQF,EAAYC,CAAQ,GAC5Bc,IAAYX,EAAkBH,CAAQ,GACtCe,IAAY,CAACJ,MAA2BV,EAAM,IAAIU,CAAM,GAAG,SAAS,IACpEK,IACJ1B,EAA+B,KAAK,CAAAsB,MAAOV,EAAUD,EAAM,IAAIW,CAAG,GAAG,KAAK,CAAC,KAAK;AAElF,SAAO;AAAA,IACL,MAAMG,EAAU,MAAM;AAAA,IACtB,cAAcA,EAAU,eAAe;AAAA,IACvC,mBAAmBC;AAAA;AAAA;AAAA,IAGnB,uBACEA,MAA2BzB,IAA4BwB,EAAU,oBAAoB,IAAI;AAAA,IAC3F,WAAWA,EAAU,YAAY;AAAA,IACjC,iBAAiBb,EAAUD,EAAM,IAAI,kBAAkB,GAAG,KAAK;AAAA,IAC/D,iBAAiBc,EAAU,mBAAmB;AAAA,IAC9C,oBAAoBA,EAAU,sBAAsB;AAAA,IACpD,oBAAoBA,EAAU,uBAAuB;AAAA,IACrD,oBAAoBA,EAAU,uBAAuB;AAAA,IACrD,iBAAiBA,EAAU,mBAAmB;AAAA,IAC9C,kBAAkBA,EAAU,oBAAoB;AAAA,IAChD,gBAAgBA,EAAU,kBAAkB;AAAA,IAC5C,eAAeA,EAAU,gBAAgB;AAAA,IACzC,aAAaA,EAAU,cAAc;AAAA,IACrC,KAAKD,EAAU,cAAc,KAAKC,EAAU,KAAK;AAAA,IACjD,KAAKD,EAAU,cAAc,KAAKC,EAAU,KAAK;AAAA,IACjD,eAAeA,EAAU,gBAAgB;AAAA,IACzC,OAAO;AAAA,EAAA;AAEX;AAOO,MAAME,IAAiD;AAAA,EAC5D,MAAM;AAAA,EACN,cAAc;AAAA,EACd,mBAAmB;AAAA,EACnB,uBAAuB;AAAA,EACvB,WAAW;AAAA,EACX,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,iBAAiB;AAAA,EACjB,kBAAkB;AAAA,EAClB,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,aAAa;AAAA,EACb,KAAK;AAAA,EACL,KAAK;AAAA,EACL,eAAe;AAAA,EACf,OAAO;AACT,GAeMC,IAAmD;AAAA,EACvD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAsBO,SAASC,EACdnB,GACAoB,GACAN,GACkB;AAClB,QAAML,IAAoBD,EAAqBR,CAAQ,GACjDqB,IAA2B,CAAA,GAG3BC,IAAMF,GACNG,IAAO,CAACC,MAAyB;AACrC,UAAM1C,IAAQwC,EAAIE,CAAI;AACtB,WAAO,OAAO1C,KAAU,WAAWA,IAAQ;AAAA,EAC7C,GACM2C,IAAiBF,EAAK,mBAAmB,GAEzCG,IAAY,CAAChB,GAAiC5B,MAAkB;AACpE,IAAAuC,EAAO,KAAK,EAAE,KAAK3B,EAAkBgB,CAAS,GAAG,OAAA5B,GAAO;AAAA,EAC1D;AAEA,aAAW4B,KAAaQ;AACtB,IAAKT,EAAkB,IAAIC,CAAS,KACpCgB,EAAUhB,GAAWa,EAAKb,CAAS,CAAC;AAGtC,EAAID,EAAkB,IAAIpB,CAAgB,KAAKoC,MAAmBjC,KAChEkC,EAAU,aAAaH,EAAK,WAAW,CAAC,GAGtCd,EAAkB,IAAI,iBAAiB,KACzCY,EAAO,KAAK;AAAA,IACV,KAAK3B,EAAkB;AAAA,IACvB,OAAO0B,EAAO,kBAAkB,MAAM;AAAA,EAAA,CACvC;AAKH,QAAMO,IAAWJ,EAAK,KAAK,GACrBK,IAAWL,EAAK,KAAK;AAC3B,SAAId,EAAkB,IAAI,KAAK,KAAK,EAAEK,EAAU,eAAea,MAAa,OAC1ED,EAAU,OAAOC,CAAQ,GAEvBlB,EAAkB,IAAI,KAAK,KAAK,EAAEK,EAAU,eAAec,MAAa,OAC1EF,EAAU,OAAOE,CAAQ,GAGvBH,MACFJ,EAAO,KAAK,EAAE,KAAKI,GAAgB,OAAO,KAAK,GAC3CA,MAAmBlC,KACrB8B,EAAO,KAAK,EAAE,KAAK,sBAAsB,OAAOE,EAAK,uBAAuB,GAAG,IAI5EF;AACT;"}
+{"version":3,"file":"w9Fields.js","sources":["../../../../../../src/components/Contractor/Documents/SignatureForm/useContractorSignatureForm/w9Fields.ts"],"sourcesContent":["import type {\n  Document,\n  Fields as DocumentField,\n} from '@gusto/embedded-api/models/components/document'\nimport type { ContractorSignatureFormData } from './contractorSignatureFormSchema'\n\n/**\n * The `name` of the W-9 document — the only contractor document type that\n * supports signing today.\n *\n * @internal\n */\nexport const W9_DOCUMENT_NAME = 'taxpayer_identification_form_w_9'\n\n/**\n * Sentinel the API returns (and accepts) for a taxpayer-ID field that doesn't\n * apply to the signer — e.g. the EIN of an individual contractor, or the SSN of\n * a business contractor. The sign endpoint stamps this verbatim, so the form\n * both prefills it and treats it as a valid submission.\n *\n * @internal\n */\nexport const NOT_APPLICABLE_VALUE = 'N/A'\n\n/**\n * Form-field name for the synthesized federal tax classification radio group.\n *\n * @internal\n */\nexport const TAX_CLASSIFICATION_FIELD = 'taxClassification'\n\n/**\n * Form-field name for the synthesized LLC tax classification code select.\n *\n * @internal\n */\nexport const LLC_CLASSIFICATION_FIELD = 'llcClassificationCode'\n\n/**\n * Form-field name for the \"Other\" free-text classification field.\n *\n * @internal\n */\nexport const OTHER_TEXT_FIELD = 'otherText'\n\n/**\n * Ordered classification option keys backing the {@link TAX_CLASSIFICATION_FIELD}\n * radio group. Each maps to a W-9 checkbox field on the underlying document.\n *\n * @internal\n */\nexport const TAX_CLASSIFICATION_OPTION_KEYS = [\n  'individual_proprietor',\n  'c_corporation',\n  's_corporation',\n  'partnership',\n  'trust_estate',\n  'limited_liability_company',\n  'other',\n] as const\n\n/**\n * A single federal tax classification option key.\n *\n * @internal\n */\nexport type TaxClassificationOptionKey = (typeof TAX_CLASSIFICATION_OPTION_KEYS)[number]\n\n/**\n * The classification option that reveals the LLC tax classification select.\n *\n * @internal\n */\nexport const LLC_CLASSIFICATION_OPTION: TaxClassificationOptionKey = 'limited_liability_company'\n\n/**\n * The classification option that reveals the \"Other\" free-text field.\n *\n * @internal\n */\nexport const OTHER_CLASSIFICATION_OPTION: TaxClassificationOptionKey = 'other'\n\n/**\n * Ordered LLC tax classification code options.\n *\n * @internal\n */\nexport const LLC_CLASSIFICATION_CODES = ['c', 's', 'p'] as const\n\n/**\n * Maps each pass-through {@link ContractorSignatureFormData} field to its W-9\n * API field key. Synthesized fields (`taxClassification`,\n * `llcClassificationCode`) and `agree` are intentionally absent.\n *\n * @internal\n */\nexport const W9_FIELD_API_KEYS = {\n  name: 'name',\n  businessName: 'business_name',\n  otherText: 'other_text',\n  foreignPartners: 'foreign_partners',\n  exemptPayeeCode: 'exempt_payee_code',\n  exemptionFromFatca: 'exemption_from_FATCA',\n  homeAddressStreet1: 'home_address_street_1',\n  homeAddressStreet2: 'home_address_street_2',\n  homeAddressCity: 'home_address_city',\n  homeAddressState: 'home_address_state',\n  homeAddressZip: 'home_address_zip',\n  accountNumber: 'account_number',\n  companyName: 'company_name',\n  ssn: 'ssn',\n  ein: 'ein',\n  signatureText: 'signature_text',\n} as const satisfies Record<string, string>\n\n/** A pass-through W-9 field name (one with a single backing API key). */\ntype PassThroughFieldName = keyof typeof W9_FIELD_API_KEYS\n\n/** API field keys whose values are sensitive and arrive masked when on file. */\nconst SENSITIVE_FIELD_KEYS = new Set(['ssn', 'ein'])\n\n/** Whether a value is a server-side mask (e.g. `XXX-XX-1111`) rather than real input. */\nfunction isMaskedValue(value: string | null | undefined): boolean {\n  return typeof value === 'string' && /[X•*]/.test(value)\n}\n\n/** Whether a document field carries a redacted (masked) sensitive value. */\nfunction hasRedactedValue(field: DocumentField | undefined): boolean {\n  if (!field) return false\n  const isSensitive =\n    SENSITIVE_FIELD_KEYS.has(field.key ?? '') ||\n    field.dataType === 'ssn' ||\n    field.dataType === 'ein'\n  return isSensitive && isMaskedValue(field.value)\n}\n\nfunction indexFields(document: Document): Map<string, DocumentField> {\n  const byKey = new Map<string, DocumentField>()\n  for (const field of document.fields ?? []) {\n    if (field.key) byKey.set(field.key, field)\n  }\n  return byKey\n}\n\n/** Coerces an API checkbox value (`'1'`, `'true'`) to a boolean. */\nfunction toBoolean(value: string | null | undefined): boolean {\n  return value === '1' || value === 'true'\n}\n\n/**\n * Whether the document is a W-9 (the only signable contractor document type).\n *\n * @internal\n */\nexport function isW9Document(document: Document): boolean {\n  return document.name === W9_DOCUMENT_NAME\n}\n\n/**\n * Redaction state for the sensitive W-9 fields, derived from the API response.\n *\n * @internal\n */\nexport interface W9RedactionState {\n  /** Whether the API returned a masked SSN value. */\n  ssnRedacted: boolean\n  /** Whether the API returned a masked EIN value. */\n  einRedacted: boolean\n  /** The masked SSN to surface as a placeholder, when redacted. */\n  ssnPlaceholder?: string\n  /** The masked EIN to surface as a placeholder, when redacted. */\n  einPlaceholder?: string\n}\n\n/**\n * Computes the redaction state of the SSN/EIN fields from the document.\n *\n * @param document - The W-9 document returned by the API.\n * @returns The redaction flags and masked placeholders.\n * @internal\n */\nexport function getRedactionState(document: Document): W9RedactionState {\n  const byKey = indexFields(document)\n  const ssnField = byKey.get('ssn')\n  const einField = byKey.get('ein')\n  const ssnRedacted = hasRedactedValue(ssnField)\n  const einRedacted = hasRedactedValue(einField)\n  return {\n    ssnRedacted,\n    einRedacted,\n    ssnPlaceholder: ssnRedacted ? (ssnField?.value ?? undefined) : undefined,\n    einPlaceholder: einRedacted ? (einField?.value ?? undefined) : undefined,\n  }\n}\n\n/**\n * Computes which W-9 form fields the API actually returned — the safety check\n * that drives presence-gating in {@link useContractorSignatureForm}.\n *\n * @remarks\n * A pass-through field is present when its API key is in `document.fields`. The\n * synthesized classification fields (`taxClassification`,\n * `llcClassificationCode`) are present when the document carries any of the\n * federal tax classification checkbox fields.\n *\n * @param document - The W-9 document returned by the API.\n * @returns The set of present camelCase field names.\n * @internal\n */\nexport function getPresentFieldNames(document: Document): Set<string> {\n  const byKey = indexFields(document)\n  const presentFieldNames = new Set<string>()\n\n  for (const [fieldName, apiKey] of Object.entries(W9_FIELD_API_KEYS)) {\n    if (byKey.has(apiKey)) presentFieldNames.add(fieldName)\n  }\n\n  const hasClassification = TAX_CLASSIFICATION_OPTION_KEYS.some(key => byKey.has(key))\n  if (hasClassification) {\n    presentFieldNames.add(TAX_CLASSIFICATION_FIELD)\n    presentFieldNames.add(LLC_CLASSIFICATION_FIELD)\n  }\n\n  return presentFieldNames\n}\n\n/**\n * Builds default form values from a document's fields.\n *\n * @remarks\n * Pass-through values are seeded from the API `value`. The classification radio\n * defaults to whichever classification checkbox is already set (`'1'`/`'true'`),\n * and when that is the LLC classification the LLC code select is seeded from the\n * `tax_classification` field it serializes into. A masked SSN/EIN seeds an empty\n * input (the mask is surfaced as a placeholder instead) so it is never echoed\n * back as the new value on submit.\n *\n * @param document - The W-9 document returned by the API.\n * @returns The default form values.\n * @internal\n */\nexport function buildW9Defaults(document: Document): ContractorSignatureFormData {\n  const byKey = indexFields(document)\n  const redaction = getRedactionState(document)\n  const textValue = (apiKey: string): string => byKey.get(apiKey)?.value ?? ''\n  const selectedClassification =\n    TAX_CLASSIFICATION_OPTION_KEYS.find(key => toBoolean(byKey.get(key)?.value)) ?? ''\n\n  return {\n    name: textValue('name'),\n    businessName: textValue('business_name'),\n    taxClassification: selectedClassification,\n    // The LLC code serializes into the `tax_classification` field, so seed it\n    // back from there when the LLC classification is the selected one.\n    llcClassificationCode:\n      selectedClassification === LLC_CLASSIFICATION_OPTION ? textValue('tax_classification') : '',\n    otherText: textValue('other_text'),\n    foreignPartners: toBoolean(byKey.get('foreign_partners')?.value),\n    exemptPayeeCode: textValue('exempt_payee_code'),\n    exemptionFromFatca: textValue('exemption_from_FATCA'),\n    homeAddressStreet1: textValue('home_address_street_1'),\n    homeAddressStreet2: textValue('home_address_street_2'),\n    homeAddressCity: textValue('home_address_city'),\n    homeAddressState: textValue('home_address_state'),\n    homeAddressZip: textValue('home_address_zip'),\n    accountNumber: textValue('account_number'),\n    companyName: textValue('company_name'),\n    ssn: redaction.ssnRedacted ? '' : textValue('ssn'),\n    ein: redaction.einRedacted ? '' : textValue('ein'),\n    signatureText: textValue('signature_text'),\n    agree: false,\n  }\n}\n\n/**\n * The empty default form values, used while the document is still loading.\n *\n * @internal\n */\nexport const EMPTY_W9_DEFAULTS: ContractorSignatureFormData = {\n  name: '',\n  businessName: '',\n  taxClassification: '',\n  llcClassificationCode: '',\n  otherText: '',\n  foreignPartners: false,\n  exemptPayeeCode: '',\n  exemptionFromFatca: '',\n  homeAddressStreet1: '',\n  homeAddressStreet2: '',\n  homeAddressCity: '',\n  homeAddressState: '',\n  homeAddressZip: '',\n  accountNumber: '',\n  companyName: '',\n  ssn: '',\n  ein: '',\n  signatureText: '',\n  agree: false,\n}\n\n/**\n * A single `{ key, value }` pair sent in the sign request.\n *\n * @internal\n */\nexport interface SignFieldValue {\n  /** The API field key. */\n  key: string\n  /** The serialized field value. */\n  value: string\n}\n\n/** Pass-through text fields serialized verbatim (everything except the checkbox and TIN fields). */\nconst TEXT_PASS_THROUGH_FIELDS: PassThroughFieldName[] = [\n  'name',\n  'businessName',\n  'exemptPayeeCode',\n  'exemptionFromFatca',\n  'homeAddressStreet1',\n  'homeAddressStreet2',\n  'homeAddressCity',\n  'homeAddressState',\n  'homeAddressZip',\n  'accountNumber',\n  'companyName',\n  'signatureText',\n]\n\n/**\n * Serializes W-9 form values into the `{ key, value }` field array expected by\n * the sign API.\n *\n * @remarks\n * Only fields the API returned (see {@link getPresentFieldNames}) are sent.\n * Applies the W-9 mapping: the chosen classification key is sent with value\n * `'1'`; when the LLC classification is chosen, the selected LLC code is sent\n * under the `tax_classification` key. `foreignPartners` serializes to\n * `'1'`/`'0'`. The `otherText` value is only included for the \"Other\"\n * classification. An untouched redacted SSN/EIN is omitted so the mask is never\n * sent back. The `date` field is intentionally omitted so the API auto-fills the\n * signing date in its own locale-correct format.\n *\n * @param document - The W-9 document being signed.\n * @param values - The validated form values.\n * @param redaction - The redaction state from {@link getRedactionState}.\n * @returns The ordered field array for the sign request body.\n * @internal\n */\nexport function serializeW9Fields(\n  document: Document,\n  values: ContractorSignatureFormData,\n  redaction: W9RedactionState,\n): SignFieldValue[] {\n  const presentFieldNames = getPresentFieldNames(document)\n  const fields: SignFieldValue[] = []\n  // The schema preprocesses empty inputs to `undefined`, so read through an\n  // `unknown` view and coalesce missing values to an empty string.\n  const raw = values as Record<string, unknown>\n  const text = (name: string): string => {\n    const value = raw[name]\n    return typeof value === 'string' ? value : ''\n  }\n  const classification = text('taxClassification')\n\n  const pushField = (fieldName: PassThroughFieldName, value: string) => {\n    fields.push({ key: W9_FIELD_API_KEYS[fieldName], value })\n  }\n\n  for (const fieldName of TEXT_PASS_THROUGH_FIELDS) {\n    if (!presentFieldNames.has(fieldName)) continue\n    pushField(fieldName, text(fieldName))\n  }\n\n  if (presentFieldNames.has(OTHER_TEXT_FIELD) && classification === OTHER_CLASSIFICATION_OPTION) {\n    pushField('otherText', text('otherText'))\n  }\n\n  if (presentFieldNames.has('foreignPartners')) {\n    fields.push({\n      key: W9_FIELD_API_KEYS.foreignPartners,\n      value: values.foreignPartners ? '1' : '0',\n    })\n  }\n\n  // A redacted field left untouched is omitted so the masked value isn't sent\n  // back as a replacement; the server keeps the value already on file.\n  const ssnValue = text('ssn')\n  const einValue = text('ein')\n  if (presentFieldNames.has('ssn') && !(redaction.ssnRedacted && ssnValue === '')) {\n    pushField('ssn', ssnValue)\n  }\n  if (presentFieldNames.has('ein') && !(redaction.einRedacted && einValue === '')) {\n    pushField('ein', einValue)\n  }\n\n  if (classification) {\n    fields.push({ key: classification, value: '1' })\n    if (classification === LLC_CLASSIFICATION_OPTION) {\n      fields.push({ key: 'tax_classification', value: text('llcClassificationCode') })\n    }\n  }\n\n  return fields\n}\n"],"names":["W9_DOCUMENT_NAME","NOT_APPLICABLE_VALUE","TAX_CLASSIFICATION_FIELD","LLC_CLASSIFICATION_FIELD","OTHER_TEXT_FIELD","TAX_CLASSIFICATION_OPTION_KEYS","LLC_CLASSIFICATION_OPTION","OTHER_CLASSIFICATION_OPTION","LLC_CLASSIFICATION_CODES","W9_FIELD_API_KEYS","SENSITIVE_FIELD_KEYS","isMaskedValue","value","hasRedactedValue","field","indexFields","document","byKey","toBoolean","isW9Document","getRedactionState","ssnField","einField","ssnRedacted","einRedacted","getPresentFieldNames","presentFieldNames","fieldName","apiKey","key","buildW9Defaults","redaction","textValue","selectedClassification","EMPTY_W9_DEFAULTS","TEXT_PASS_THROUGH_FIELDS","serializeW9Fields","values","fields","raw","text","name","classification","pushField","ssnValue","einValue"],"mappings":"AAYO,MAAMA,IAAmB,oCAUnBC,IAAuB,OAOvBC,IAA2B,qBAO3BC,IAA2B,yBAO3BC,IAAmB,aAQnBC,IAAiC;AAAA,EAC5C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAcaC,IAAwD,6BAOxDC,IAA0D,SAO1DC,IAA2B,CAAC,KAAK,KAAK,GAAG,GASzCC,IAAoB;AAAA,EAC/B,MAAM;AAAA,EACN,cAAc;AAAA,EACd,WAAW;AAAA,EACX,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,iBAAiB;AAAA,EACjB,kBAAkB;AAAA,EAClB,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,aAAa;AAAA,EACb,KAAK;AAAA,EACL,KAAK;AAAA,EACL,eAAe;AACjB,GAMMC,IAAuB,oBAAI,IAAI,CAAC,OAAO,KAAK,CAAC;AAGnD,SAASC,EAAcC,GAA2C;AAChE,SAAO,OAAOA,KAAU,YAAY,QAAQ,KAAKA,CAAK;AACxD;AAGA,SAASC,EAAiBC,GAA2C;AACnE,SAAKA,KAEHJ,EAAqB,IAAII,EAAM,OAAO,EAAE,KACxCA,EAAM,aAAa,SACnBA,EAAM,aAAa,UACCH,EAAcG,EAAM,KAAK,IAL5B;AAMrB;AAEA,SAASC,EAAYC,GAAgD;AACnE,QAAMC,wBAAY,IAAA;AAClB,aAAWH,KAASE,EAAS,UAAU,CAAA;AACrC,IAAIF,EAAM,OAAKG,EAAM,IAAIH,EAAM,KAAKA,CAAK;AAE3C,SAAOG;AACT;AAGA,SAASC,EAAUN,GAA2C;AAC5D,SAAOA,MAAU,OAAOA,MAAU;AACpC;AAOO,SAASO,EAAaH,GAA6B;AACxD,SAAOA,EAAS,SAAShB;AAC3B;AAyBO,SAASoB,EAAkBJ,GAAsC;AACtE,QAAMC,IAAQF,EAAYC,CAAQ,GAC5BK,IAAWJ,EAAM,IAAI,KAAK,GAC1BK,IAAWL,EAAM,IAAI,KAAK,GAC1BM,IAAcV,EAAiBQ,CAAQ,GACvCG,IAAcX,EAAiBS,CAAQ;AAC7C,SAAO;AAAA,IACL,aAAAC;AAAA,IACA,aAAAC;AAAA,IACA,gBAAgBD,IAAeF,GAAU,SAAS,SAAa;AAAA,IAC/D,gBAAgBG,IAAeF,GAAU,SAAS,SAAa;AAAA,EAAA;AAEnE;AAgBO,SAASG,EAAqBT,GAAiC;AACpE,QAAMC,IAAQF,EAAYC,CAAQ,GAC5BU,wBAAwB,IAAA;AAE9B,aAAW,CAACC,GAAWC,CAAM,KAAK,OAAO,QAAQnB,CAAiB;AAChE,IAAIQ,EAAM,IAAIW,CAAM,KAAGF,EAAkB,IAAIC,CAAS;AAIxD,SAD0BtB,EAA+B,KAAK,OAAOY,EAAM,IAAIY,CAAG,CAAC,MAEjFH,EAAkB,IAAIxB,CAAwB,GAC9CwB,EAAkB,IAAIvB,CAAwB,IAGzCuB;AACT;AAiBO,SAASI,EAAgBd,GAAiD;AAC/E,QAAMC,IAAQF,EAAYC,CAAQ,GAC5Be,IAAYX,EAAkBJ,CAAQ,GACtCgB,IAAY,CAACJ,MAA2BX,EAAM,IAAIW,CAAM,GAAG,SAAS,IACpEK,IACJ5B,EAA+B,KAAK,CAAAwB,MAAOX,EAAUD,EAAM,IAAIY,CAAG,GAAG,KAAK,CAAC,KAAK;AAElF,SAAO;AAAA,IACL,MAAMG,EAAU,MAAM;AAAA,IACtB,cAAcA,EAAU,eAAe;AAAA,IACvC,mBAAmBC;AAAA;AAAA;AAAA,IAGnB,uBACEA,MAA2B3B,IAA4B0B,EAAU,oBAAoB,IAAI;AAAA,IAC3F,WAAWA,EAAU,YAAY;AAAA,IACjC,iBAAiBd,EAAUD,EAAM,IAAI,kBAAkB,GAAG,KAAK;AAAA,IAC/D,iBAAiBe,EAAU,mBAAmB;AAAA,IAC9C,oBAAoBA,EAAU,sBAAsB;AAAA,IACpD,oBAAoBA,EAAU,uBAAuB;AAAA,IACrD,oBAAoBA,EAAU,uBAAuB;AAAA,IACrD,iBAAiBA,EAAU,mBAAmB;AAAA,IAC9C,kBAAkBA,EAAU,oBAAoB;AAAA,IAChD,gBAAgBA,EAAU,kBAAkB;AAAA,IAC5C,eAAeA,EAAU,gBAAgB;AAAA,IACzC,aAAaA,EAAU,cAAc;AAAA,IACrC,KAAKD,EAAU,cAAc,KAAKC,EAAU,KAAK;AAAA,IACjD,KAAKD,EAAU,cAAc,KAAKC,EAAU,KAAK;AAAA,IACjD,eAAeA,EAAU,gBAAgB;AAAA,IACzC,OAAO;AAAA,EAAA;AAEX;AAOO,MAAME,IAAiD;AAAA,EAC5D,MAAM;AAAA,EACN,cAAc;AAAA,EACd,mBAAmB;AAAA,EACnB,uBAAuB;AAAA,EACvB,WAAW;AAAA,EACX,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,iBAAiB;AAAA,EACjB,kBAAkB;AAAA,EAClB,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,aAAa;AAAA,EACb,KAAK;AAAA,EACL,KAAK;AAAA,EACL,eAAe;AAAA,EACf,OAAO;AACT,GAeMC,IAAmD;AAAA,EACvD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAsBO,SAASC,EACdpB,GACAqB,GACAN,GACkB;AAClB,QAAML,IAAoBD,EAAqBT,CAAQ,GACjDsB,IAA2B,CAAA,GAG3BC,IAAMF,GACNG,IAAO,CAACC,MAAyB;AACrC,UAAM7B,IAAQ2B,EAAIE,CAAI;AACtB,WAAO,OAAO7B,KAAU,WAAWA,IAAQ;AAAA,EAC7C,GACM8B,IAAiBF,EAAK,mBAAmB,GAEzCG,IAAY,CAAChB,GAAiCf,MAAkB;AACpE,IAAA0B,EAAO,KAAK,EAAE,KAAK7B,EAAkBkB,CAAS,GAAG,OAAAf,GAAO;AAAA,EAC1D;AAEA,aAAWe,KAAaQ;AACtB,IAAKT,EAAkB,IAAIC,CAAS,KACpCgB,EAAUhB,GAAWa,EAAKb,CAAS,CAAC;AAGtC,EAAID,EAAkB,IAAItB,CAAgB,KAAKsC,MAAmBnC,KAChEoC,EAAU,aAAaH,EAAK,WAAW,CAAC,GAGtCd,EAAkB,IAAI,iBAAiB,KACzCY,EAAO,KAAK;AAAA,IACV,KAAK7B,EAAkB;AAAA,IACvB,OAAO4B,EAAO,kBAAkB,MAAM;AAAA,EAAA,CACvC;AAKH,QAAMO,IAAWJ,EAAK,KAAK,GACrBK,IAAWL,EAAK,KAAK;AAC3B,SAAId,EAAkB,IAAI,KAAK,KAAK,EAAEK,EAAU,eAAea,MAAa,OAC1ED,EAAU,OAAOC,CAAQ,GAEvBlB,EAAkB,IAAI,KAAK,KAAK,EAAEK,EAAU,eAAec,MAAa,OAC1EF,EAAU,OAAOE,CAAQ,GAGvBH,MACFJ,EAAO,KAAK,EAAE,KAAKI,GAAgB,OAAO,KAAK,GAC3CA,MAAmBpC,KACrBgC,EAAO,KAAK,EAAE,KAAK,sBAAsB,OAAOE,EAAK,uBAAuB,GAAG,IAI5EF;AACT;"}

package/dist/components/Contractor/OnboardingFlow/OnboardingFlow.d.ts

@@ -27,7 +27,7 @@ import { OnboardingFlowProps } from './OnboardingFlowComponents';
  * | `contractor/onboarding/continue` | Fired when the user chooses to continue onboarding a contractor | — |
  * | `contractor/created` | Fired when a new contractor is created successfully | Create contractor API response |
  * | `contractor/updated` | Fired when an existing contractor is updated | Update contractor API response |
- * | `contractor/profile/done` | Fired when the contractor profile step is complete | `{ contractorId: string, selfOnboarding: boolean }` |
+ * | `contractor/profile/done` | Fired when the contractor profile step is complete | `{ contractorId: string, onboardingStatus?: string, selfOnboarding: boolean }` |
  * | `contractor/address/updated` | Fired when the contractor address is updated | Create or update contractor address API response |
  * | `contractor/address/done` | Fired when the address step is complete | — |
  * | `contractor/bankAccount/created` | Fired when a bank account is created for the contractor | Create contractor bank account API response |

package/dist/components/Contractor/OnboardingFlow/OnboardingFlow.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnboardingFlow.js","sources":["../../../../src/components/Contractor/OnboardingFlow/OnboardingFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { onboardingMachine } from './onboardingStateMachine'\nimport type { OnboardingFlowProps } from './OnboardingFlowComponents'\nimport {\n  ContractorListContextual,\n  type OnboardingFlowContextInterface,\n} from './OnboardingFlowComponents'\nimport { Flow } from '@/components/Flow/Flow'\n\n/**\n * Guided flow for admins to onboard a contractor to the company.\n *\n * @remarks\n * Renders a multi-step experience that collects every piece of information\n * required to add a contractor to a company. Begins on the contractor list\n * and transitions into the per-step screens when \"Add contractor\" or a row's\n * \"Edit\"/\"Continue\" action is invoked; the submit step returns to the list.\n * The flow is driven by an internal state machine and wraps each step in\n * error and suspense boundaries.\n *\n * Each step of the flow is also exported as a standalone block (see the\n * Blocks table) for composing a custom workflow when this orchestration\n * is the wrong fit.\n *\n * The flow forwards every event emitted by its blocks to `onEvent`;\n * see the events table on each block for the full set of events and\n * payloads observable from this flow.\n *\n * @events\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `contractor/create` | Fired when the user chooses to add a new contractor | — |\n * | `contractor/update` | Fired when the user selects a contractor to edit | `{ contractorId: string }` |\n * | `contractor/deleted` | Fired when a contractor is deleted | `{ contractorId: string }` |\n * | `contractor/onboarding/continue` | Fired when the user chooses to continue onboarding a contractor | — |\n * | `contractor/created` | Fired when a new contractor is created successfully | Create contractor API response |\n * | `contractor/updated` | Fired when an existing contractor is updated | Update contractor API response |\n * | `contractor/profile/done` | Fired when the contractor profile step is complete | `{ contractorId: string, selfOnboarding: boolean }` |\n * | `contractor/address/updated` | Fired when the contractor address is updated | Create or update contractor address API response |\n * | `contractor/address/done` | Fired when the address step is complete | — |\n * | `contractor/bankAccount/created` | Fired when a bank account is created for the contractor | Create contractor bank account API response |\n * | `contractor/paymentMethod/updated` | Fired when the payment method is updated | Update contractor payment method API response |\n * | `contractor/paymentMethod/done` | Fired when the payment method step is complete | — |\n * | `contractor/newHireReport/updated` | Fired when the new hire report is updated | Update contractor API response |\n * | `contractor/newHireReport/done` | Fired when the new hire report step is complete | — |\n * | `contractor/onboardingStatus/updated` | Fired when the contractor's onboarding status is updated | Change contractor onboarding status API response |\n * | `contractor/submit/done` | Fired when the contractor submission is complete | `{ message: string }` or `{ onboardingStatus, message: string }` |\n * | `contractor/invite/selfOnboarding` | Fired when the contractor is invited for self-onboarding | `{ contractorId: string }` |\n *\n * @components\n * - {@link ContractorList}\n * - {@link ContractorProfile}\n * - {@link Address}\n * - {@link PaymentMethod}\n * - {@link NewHireReport}\n * - {@link ContractorSubmit}\n *\n * @param props - See {@link OnboardingFlowProps}.\n * @returns The multi-step onboarding flow with internal navigation between the contractor list and the per-step screens.\n * @public\n *\n * @example\n * ```tsx title=\"App.tsx\"\n * import { ContractorOnboarding, type EventType } from '@gusto/embedded-react-sdk'\n *\n * function MyApp() {\n *   return (\n *     <ContractorOnboarding.OnboardingFlow\n *       companyId=\"a007e1ab-3595-43c2-ab4b-af7a5af2e365\"\n *       onEvent={(eventType: EventType) => {\n *         if (eventType === 'contractor/submit/done') {\n *           // Contractor onboarding complete — navigate to your next screen\n *         }\n *       }}\n *     />\n *   )\n * }\n * ```\n */\nexport const OnboardingFlow = ({ companyId, onEvent, defaultValues }: OnboardingFlowProps) => {\n  const onboardingFlow = useMemo(\n    () =>\n      createMachine(\n        'list',\n        onboardingMachine,\n        (initialContext: OnboardingFlowContextInterface) => ({\n          ...initialContext,\n          component: ContractorListContextual,\n          companyId,\n          defaultValues,\n          selfOnboarding: false,\n        }),\n      ),\n    [companyId, defaultValues],\n  )\n  return <Flow machine={onboardingFlow} onEvent={onEvent} />\n}\n"],"names":["OnboardingFlow","companyId","onEvent","defaultValues","onboardingFlow","useMemo","createMachine","onboardingMachine","initialContext","ContractorListContextual","jsx","Flow"],"mappings":";;;;;;AAgFO,MAAMA,IAAiB,CAAC,EAAE,WAAAC,GAAW,SAAAC,GAAS,eAAAC,QAAyC;AAC5F,QAAMC,IAAiBC;AAAA,IACrB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAoD;AAAA,QACnD,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAR;AAAA,QACA,eAAAE;AAAA,QACA,gBAAgB;AAAA,MAAA;AAAA,IAClB;AAAA,IAEJ,CAACF,GAAWE,CAAa;AAAA,EAAA;AAE3B,SAAO,gBAAAO,EAACC,GAAA,EAAK,SAASP,GAAgB,SAAAF,EAAA,CAAkB;AAC1D;"}
+{"version":3,"file":"OnboardingFlow.js","sources":["../../../../src/components/Contractor/OnboardingFlow/OnboardingFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { onboardingMachine } from './onboardingStateMachine'\nimport type { OnboardingFlowProps } from './OnboardingFlowComponents'\nimport {\n  ContractorListContextual,\n  type OnboardingFlowContextInterface,\n} from './OnboardingFlowComponents'\nimport { Flow } from '@/components/Flow/Flow'\n\n/**\n * Guided flow for admins to onboard a contractor to the company.\n *\n * @remarks\n * Renders a multi-step experience that collects every piece of information\n * required to add a contractor to a company. Begins on the contractor list\n * and transitions into the per-step screens when \"Add contractor\" or a row's\n * \"Edit\"/\"Continue\" action is invoked; the submit step returns to the list.\n * The flow is driven by an internal state machine and wraps each step in\n * error and suspense boundaries.\n *\n * Each step of the flow is also exported as a standalone block (see the\n * Blocks table) for composing a custom workflow when this orchestration\n * is the wrong fit.\n *\n * The flow forwards every event emitted by its blocks to `onEvent`;\n * see the events table on each block for the full set of events and\n * payloads observable from this flow.\n *\n * @events\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `contractor/create` | Fired when the user chooses to add a new contractor | — |\n * | `contractor/update` | Fired when the user selects a contractor to edit | `{ contractorId: string }` |\n * | `contractor/deleted` | Fired when a contractor is deleted | `{ contractorId: string }` |\n * | `contractor/onboarding/continue` | Fired when the user chooses to continue onboarding a contractor | — |\n * | `contractor/created` | Fired when a new contractor is created successfully | Create contractor API response |\n * | `contractor/updated` | Fired when an existing contractor is updated | Update contractor API response |\n * | `contractor/profile/done` | Fired when the contractor profile step is complete | `{ contractorId: string, onboardingStatus?: string, selfOnboarding: boolean }` |\n * | `contractor/address/updated` | Fired when the contractor address is updated | Create or update contractor address API response |\n * | `contractor/address/done` | Fired when the address step is complete | — |\n * | `contractor/bankAccount/created` | Fired when a bank account is created for the contractor | Create contractor bank account API response |\n * | `contractor/paymentMethod/updated` | Fired when the payment method is updated | Update contractor payment method API response |\n * | `contractor/paymentMethod/done` | Fired when the payment method step is complete | — |\n * | `contractor/newHireReport/updated` | Fired when the new hire report is updated | Update contractor API response |\n * | `contractor/newHireReport/done` | Fired when the new hire report step is complete | — |\n * | `contractor/onboardingStatus/updated` | Fired when the contractor's onboarding status is updated | Change contractor onboarding status API response |\n * | `contractor/submit/done` | Fired when the contractor submission is complete | `{ message: string }` or `{ onboardingStatus, message: string }` |\n * | `contractor/invite/selfOnboarding` | Fired when the contractor is invited for self-onboarding | `{ contractorId: string }` |\n *\n * @components\n * - {@link ContractorList}\n * - {@link ContractorProfile}\n * - {@link Address}\n * - {@link PaymentMethod}\n * - {@link NewHireReport}\n * - {@link ContractorSubmit}\n *\n * @param props - See {@link OnboardingFlowProps}.\n * @returns The multi-step onboarding flow with internal navigation between the contractor list and the per-step screens.\n * @public\n *\n * @example\n * ```tsx title=\"App.tsx\"\n * import { ContractorOnboarding, type EventType } from '@gusto/embedded-react-sdk'\n *\n * function MyApp() {\n *   return (\n *     <ContractorOnboarding.OnboardingFlow\n *       companyId=\"a007e1ab-3595-43c2-ab4b-af7a5af2e365\"\n *       onEvent={(eventType: EventType) => {\n *         if (eventType === 'contractor/submit/done') {\n *           // Contractor onboarding complete — navigate to your next screen\n *         }\n *       }}\n *     />\n *   )\n * }\n * ```\n */\nexport const OnboardingFlow = ({ companyId, onEvent, defaultValues }: OnboardingFlowProps) => {\n  const onboardingFlow = useMemo(\n    () =>\n      createMachine(\n        'list',\n        onboardingMachine,\n        (initialContext: OnboardingFlowContextInterface) => ({\n          ...initialContext,\n          component: ContractorListContextual,\n          companyId,\n          defaultValues,\n          selfOnboarding: false,\n        }),\n      ),\n    [companyId, defaultValues],\n  )\n  return <Flow machine={onboardingFlow} onEvent={onEvent} />\n}\n"],"names":["OnboardingFlow","companyId","onEvent","defaultValues","onboardingFlow","useMemo","createMachine","onboardingMachine","initialContext","ContractorListContextual","jsx","Flow"],"mappings":";;;;;;AAgFO,MAAMA,IAAiB,CAAC,EAAE,WAAAC,GAAW,SAAAC,GAAS,eAAAC,QAAyC;AAC5F,QAAMC,IAAiBC;AAAA,IACrB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAoD;AAAA,QACnD,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAR;AAAA,QACA,eAAAE;AAAA,QACA,gBAAgB;AAAA,MAAA;AAAA,IAClB;AAAA,IAEJ,CAACF,GAAWE,CAAa;AAAA,EAAA;AAE3B,SAAO,gBAAAO,EAACC,GAAA,EAAK,SAASP,GAAgB,SAAAF,EAAA,CAAkB;AAC1D;"}

package/dist/components/Contractor/OnboardingFlow/OnboardingFlowComponents.d.ts

@@ -34,6 +34,8 @@ export interface OnboardingFlowContextInterface extends FlowContextInterface {
     defaultValues?: OnboardingFlowDefaultValues;
     /** True when the contractor will be self-onboarding; switches the flow to the shorter self-onboarding path. */
     selfOnboarding?: boolean;
+    /** True while the new hire report step should be shown; false once the contractor has advanced past the admin's initial onboarding pass. */
+    showNewHireReport?: boolean;
     /** Success message to display on the contractor list when returning from a completed sub-flow. */
     successMessage?: string;
 }

package/dist/components/Contractor/OnboardingFlow/OnboardingFlowComponents.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnboardingFlowComponents.js","sources":["../../../../src/components/Contractor/OnboardingFlow/OnboardingFlowComponents.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { ContractorList } from '../ContractorList'\nimport { ContractorProfile } from '../Profile'\nimport { Address } from '../Address'\nimport { PaymentMethod } from '../PaymentMethod/PaymentMethod'\nimport { NewHireReport } from '../NewHireReport/NewHireReport'\nimport { ContractorSubmit } from '../Submit/Submit'\nimport type { ContractorDetailsFormData } from '../Profile/shared'\nimport type { AddressDefaultValues } from '../Address'\nimport { useFlow, type FlowContextInterface } from '@/components/Flow/useFlow'\nimport type { RequireAtLeastOne } from '@/types/Helpers'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport { ensureRequired } from '@/helpers/ensureRequired'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { useI18n } from '@/i18n'\nimport { componentEvents } from '@/shared/constants'\n\n/**\n * Default pre-fill values for the contractor onboarding flow.\n * At least one of `profile` or `address` must be provided.\n *\n * @public\n */\nexport type OnboardingFlowDefaultValues = RequireAtLeastOne<{\n  profile?: Partial<ContractorDetailsFormData>\n  address?: AddressDefaultValues\n}>\n/**\n * Props for {@link OnboardingFlow}.\n *\n * @public\n */\nexport interface OnboardingFlowProps extends BaseComponentInterface<never> {\n  /** The associated company identifier. */\n  companyId: string\n  /** Default values for individual flow step components — `profile` and/or `address` sub-objects. */\n  defaultValues?: RequireAtLeastOne<OnboardingFlowDefaultValues>\n}\n/** @internal */\nexport interface OnboardingFlowContextInterface extends FlowContextInterface {\n  /** The associated company identifier. */\n  companyId: string\n  /** The contractor currently being onboarded; populated once the profile step creates or selects one. */\n  contractorId?: string\n  /** Default values for individual flow step components. */\n  defaultValues?: OnboardingFlowDefaultValues\n  /** True when the contractor will be self-onboarding; switches the flow to the shorter self-onboarding path. */\n  selfOnboarding?: boolean\n  /** Success message to display on the contractor list when returning from a completed sub-flow. */\n  successMessage?: string\n}\n\n/** @internal */\nexport function ContractorListContextual() {\n  const { companyId, onEvent, successMessage } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <ContractorList\n      onEvent={onEvent}\n      companyId={ensureRequired(companyId)}\n      successMessage={successMessage}\n    />\n  )\n}\n\n/** @internal */\nexport function ProfileContextual() {\n  const { companyId, onEvent, contractorId, defaultValues } =\n    useFlow<OnboardingFlowContextInterface>()\n  return (\n    <ContractorProfile\n      onEvent={onEvent}\n      companyId={ensureRequired(companyId)}\n      contractorId={contractorId}\n      defaultValues={defaultValues?.profile}\n    />\n  )\n}\n\n/** @internal */\nexport function AddressContextual() {\n  const { onEvent, contractorId, defaultValues } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <Address\n      onEvent={onEvent}\n      contractorId={ensureRequired(contractorId)}\n      defaultValues={defaultValues?.address}\n    />\n  )\n}\n/** @internal */\nexport function PaymentMethodContextual() {\n  const { onEvent, contractorId } = useFlow<OnboardingFlowContextInterface>()\n  return <PaymentMethod onEvent={onEvent} contractorId={ensureRequired(contractorId)} />\n}\n/** @internal */\nexport function NewHireReportContextual() {\n  const { onEvent, contractorId, selfOnboarding } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <NewHireReport\n      onEvent={onEvent}\n      contractorId={ensureRequired(contractorId)}\n      selfOnboarding={selfOnboarding}\n    />\n  )\n}\n/** @internal */\nexport function SubmitContextual() {\n  const { onEvent, contractorId, selfOnboarding } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <ContractorSubmit\n      onEvent={onEvent}\n      contractorId={ensureRequired(contractorId)}\n      selfOnboarding={selfOnboarding}\n    />\n  )\n}\n\n/** @internal */\nexport function ProgressBarCta() {\n  const { onEvent } = useFlow<OnboardingFlowContextInterface>()\n  const { Button } = useComponentContext()\n  useI18n('Contractor.ContractorList')\n  const { t } = useTranslation('Contractor.ContractorList')\n  return (\n    <Button\n      onClick={() => {\n        onEvent(componentEvents.CANCEL)\n      }}\n      variant=\"secondary\"\n    >\n      {t('progressBarCta')}\n    </Button>\n  )\n}\n"],"names":["ContractorListContextual","companyId","onEvent","successMessage","useFlow","jsx","ContractorList","ensureRequired","ProfileContextual","contractorId","defaultValues","ContractorProfile","AddressContextual","Address","PaymentMethodContextual","PaymentMethod","NewHireReportContextual","selfOnboarding","NewHireReport","SubmitContextual","ContractorSubmit","ProgressBarCta","Button","useComponentContext","useI18n","t","useTranslation","componentEvents"],"mappings":";;;;;;;;;;;;;AAqDO,SAASA,IAA2B;AACzC,QAAM,EAAE,WAAAC,GAAW,SAAAC,GAAS,gBAAAC,EAAA,IAAmBC,EAAA;AAC/C,SACE,gBAAAC;AAAA,IAACC;AAAA,IAAA;AAAA,MACC,SAAAJ;AAAA,MACA,WAAWK,EAAeN,CAAS;AAAA,MACnC,gBAAAE;AAAA,IAAA;AAAA,EAAA;AAGN;AAGO,SAASK,IAAoB;AAClC,QAAM,EAAE,WAAAP,GAAW,SAAAC,GAAS,cAAAO,GAAc,eAAAC,EAAA,IACxCN,EAAA;AACF,SACE,gBAAAC;AAAA,IAACM;AAAA,IAAA;AAAA,MACC,SAAAT;AAAA,MACA,WAAWK,EAAeN,CAAS;AAAA,MACnC,cAAAQ;AAAA,MACA,eAAeC,GAAe;AAAA,IAAA;AAAA,EAAA;AAGpC;AAGO,SAASE,IAAoB;AAClC,QAAM,EAAE,SAAAV,GAAS,cAAAO,GAAc,eAAAC,EAAA,IAAkBN,EAAA;AACjD,SACE,gBAAAC;AAAA,IAACQ;AAAA,IAAA;AAAA,MACC,SAAAX;AAAA,MACA,cAAcK,EAAeE,CAAY;AAAA,MACzC,eAAeC,GAAe;AAAA,IAAA;AAAA,EAAA;AAGpC;AAEO,SAASI,IAA0B;AACxC,QAAM,EAAE,SAAAZ,GAAS,cAAAO,EAAA,IAAiBL,EAAA;AAClC,2BAAQW,GAAA,EAAc,SAAAb,GAAkB,cAAcK,EAAeE,CAAY,GAAG;AACtF;AAEO,SAASO,IAA0B;AACxC,QAAM,EAAE,SAAAd,GAAS,cAAAO,GAAc,gBAAAQ,EAAA,IAAmBb,EAAA;AAClD,SACE,gBAAAC;AAAA,IAACa;AAAA,IAAA;AAAA,MACC,SAAAhB;AAAA,MACA,cAAcK,EAAeE,CAAY;AAAA,MACzC,gBAAAQ;AAAA,IAAA;AAAA,EAAA;AAGN;AAEO,SAASE,IAAmB;AACjC,QAAM,EAAE,SAAAjB,GAAS,cAAAO,GAAc,gBAAAQ,EAAA,IAAmBb,EAAA;AAClD,SACE,gBAAAC;AAAA,IAACe;AAAA,IAAA;AAAA,MACC,SAAAlB;AAAA,MACA,cAAcK,EAAeE,CAAY;AAAA,MACzC,gBAAAQ;AAAA,IAAA;AAAA,EAAA;AAGN;AAGO,SAASI,IAAiB;AAC/B,QAAM,EAAE,SAAAnB,EAAA,IAAYE,EAAA,GACd,EAAE,QAAAkB,EAAA,IAAWC,EAAA;AACnB,EAAAC,EAAQ,2BAA2B;AACnC,QAAM,EAAE,GAAAC,EAAA,IAAMC,EAAe,2BAA2B;AACxD,SACE,gBAAArB;AAAA,IAACiB;AAAA,IAAA;AAAA,MACC,SAAS,MAAM;AACb,QAAApB,EAAQyB,EAAgB,MAAM;AAAA,MAChC;AAAA,MACA,SAAQ;AAAA,MAEP,YAAE,gBAAgB;AAAA,IAAA;AAAA,EAAA;AAGzB;"}
+{"version":3,"file":"OnboardingFlowComponents.js","sources":["../../../../src/components/Contractor/OnboardingFlow/OnboardingFlowComponents.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { ContractorList } from '../ContractorList'\nimport { ContractorProfile } from '../Profile'\nimport { Address } from '../Address'\nimport { PaymentMethod } from '../PaymentMethod/PaymentMethod'\nimport { NewHireReport } from '../NewHireReport/NewHireReport'\nimport { ContractorSubmit } from '../Submit/Submit'\nimport type { ContractorDetailsFormData } from '../Profile/shared'\nimport type { AddressDefaultValues } from '../Address'\nimport { useFlow, type FlowContextInterface } from '@/components/Flow/useFlow'\nimport type { RequireAtLeastOne } from '@/types/Helpers'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport { ensureRequired } from '@/helpers/ensureRequired'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { useI18n } from '@/i18n'\nimport { componentEvents } from '@/shared/constants'\n\n/**\n * Default pre-fill values for the contractor onboarding flow.\n * At least one of `profile` or `address` must be provided.\n *\n * @public\n */\nexport type OnboardingFlowDefaultValues = RequireAtLeastOne<{\n  profile?: Partial<ContractorDetailsFormData>\n  address?: AddressDefaultValues\n}>\n/**\n * Props for {@link OnboardingFlow}.\n *\n * @public\n */\nexport interface OnboardingFlowProps extends BaseComponentInterface<never> {\n  /** The associated company identifier. */\n  companyId: string\n  /** Default values for individual flow step components — `profile` and/or `address` sub-objects. */\n  defaultValues?: RequireAtLeastOne<OnboardingFlowDefaultValues>\n}\n/** @internal */\nexport interface OnboardingFlowContextInterface extends FlowContextInterface {\n  /** The associated company identifier. */\n  companyId: string\n  /** The contractor currently being onboarded; populated once the profile step creates or selects one. */\n  contractorId?: string\n  /** Default values for individual flow step components. */\n  defaultValues?: OnboardingFlowDefaultValues\n  /** True when the contractor will be self-onboarding; switches the flow to the shorter self-onboarding path. */\n  selfOnboarding?: boolean\n  /** True while the new hire report step should be shown; false once the contractor has advanced past the admin's initial onboarding pass. */\n  showNewHireReport?: boolean\n  /** Success message to display on the contractor list when returning from a completed sub-flow. */\n  successMessage?: string\n}\n\n/** @internal */\nexport function ContractorListContextual() {\n  const { companyId, onEvent, successMessage } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <ContractorList\n      onEvent={onEvent}\n      companyId={ensureRequired(companyId)}\n      successMessage={successMessage}\n    />\n  )\n}\n\n/** @internal */\nexport function ProfileContextual() {\n  const { companyId, onEvent, contractorId, defaultValues } =\n    useFlow<OnboardingFlowContextInterface>()\n  return (\n    <ContractorProfile\n      onEvent={onEvent}\n      companyId={ensureRequired(companyId)}\n      contractorId={contractorId}\n      defaultValues={defaultValues?.profile}\n    />\n  )\n}\n\n/** @internal */\nexport function AddressContextual() {\n  const { onEvent, contractorId, defaultValues } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <Address\n      onEvent={onEvent}\n      contractorId={ensureRequired(contractorId)}\n      defaultValues={defaultValues?.address}\n    />\n  )\n}\n/** @internal */\nexport function PaymentMethodContextual() {\n  const { onEvent, contractorId } = useFlow<OnboardingFlowContextInterface>()\n  return <PaymentMethod onEvent={onEvent} contractorId={ensureRequired(contractorId)} />\n}\n/** @internal */\nexport function NewHireReportContextual() {\n  const { onEvent, contractorId, selfOnboarding } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <NewHireReport\n      onEvent={onEvent}\n      contractorId={ensureRequired(contractorId)}\n      selfOnboarding={selfOnboarding}\n    />\n  )\n}\n/** @internal */\nexport function SubmitContextual() {\n  const { onEvent, contractorId, selfOnboarding } = useFlow<OnboardingFlowContextInterface>()\n  return (\n    <ContractorSubmit\n      onEvent={onEvent}\n      contractorId={ensureRequired(contractorId)}\n      selfOnboarding={selfOnboarding}\n    />\n  )\n}\n\n/** @internal */\nexport function ProgressBarCta() {\n  const { onEvent } = useFlow<OnboardingFlowContextInterface>()\n  const { Button } = useComponentContext()\n  useI18n('Contractor.ContractorList')\n  const { t } = useTranslation('Contractor.ContractorList')\n  return (\n    <Button\n      onClick={() => {\n        onEvent(componentEvents.CANCEL)\n      }}\n      variant=\"secondary\"\n    >\n      {t('progressBarCta')}\n    </Button>\n  )\n}\n"],"names":["ContractorListContextual","companyId","onEvent","successMessage","useFlow","jsx","ContractorList","ensureRequired","ProfileContextual","contractorId","defaultValues","ContractorProfile","AddressContextual","Address","PaymentMethodContextual","PaymentMethod","NewHireReportContextual","selfOnboarding","NewHireReport","SubmitContextual","ContractorSubmit","ProgressBarCta","Button","useComponentContext","useI18n","t","useTranslation","componentEvents"],"mappings":";;;;;;;;;;;;;AAuDO,SAASA,IAA2B;AACzC,QAAM,EAAE,WAAAC,GAAW,SAAAC,GAAS,gBAAAC,EAAA,IAAmBC,EAAA;AAC/C,SACE,gBAAAC;AAAA,IAACC;AAAA,IAAA;AAAA,MACC,SAAAJ;AAAA,MACA,WAAWK,EAAeN,CAAS;AAAA,MACnC,gBAAAE;AAAA,IAAA;AAAA,EAAA;AAGN;AAGO,SAASK,IAAoB;AAClC,QAAM,EAAE,WAAAP,GAAW,SAAAC,GAAS,cAAAO,GAAc,eAAAC,EAAA,IACxCN,EAAA;AACF,SACE,gBAAAC;AAAA,IAACM;AAAA,IAAA;AAAA,MACC,SAAAT;AAAA,MACA,WAAWK,EAAeN,CAAS;AAAA,MACnC,cAAAQ;AAAA,MACA,eAAeC,GAAe;AAAA,IAAA;AAAA,EAAA;AAGpC;AAGO,SAASE,IAAoB;AAClC,QAAM,EAAE,SAAAV,GAAS,cAAAO,GAAc,eAAAC,EAAA,IAAkBN,EAAA;AACjD,SACE,gBAAAC;AAAA,IAACQ;AAAA,IAAA;AAAA,MACC,SAAAX;AAAA,MACA,cAAcK,EAAeE,CAAY;AAAA,MACzC,eAAeC,GAAe;AAAA,IAAA;AAAA,EAAA;AAGpC;AAEO,SAASI,IAA0B;AACxC,QAAM,EAAE,SAAAZ,GAAS,cAAAO,EAAA,IAAiBL,EAAA;AAClC,2BAAQW,GAAA,EAAc,SAAAb,GAAkB,cAAcK,EAAeE,CAAY,GAAG;AACtF;AAEO,SAASO,IAA0B;AACxC,QAAM,EAAE,SAAAd,GAAS,cAAAO,GAAc,gBAAAQ,EAAA,IAAmBb,EAAA;AAClD,SACE,gBAAAC;AAAA,IAACa;AAAA,IAAA;AAAA,MACC,SAAAhB;AAAA,MACA,cAAcK,EAAeE,CAAY;AAAA,MACzC,gBAAAQ;AAAA,IAAA;AAAA,EAAA;AAGN;AAEO,SAASE,IAAmB;AACjC,QAAM,EAAE,SAAAjB,GAAS,cAAAO,GAAc,gBAAAQ,EAAA,IAAmBb,EAAA;AAClD,SACE,gBAAAC;AAAA,IAACe;AAAA,IAAA;AAAA,MACC,SAAAlB;AAAA,MACA,cAAcK,EAAeE,CAAY;AAAA,MACzC,gBAAAQ;AAAA,IAAA;AAAA,EAAA;AAGN;AAGO,SAASI,IAAiB;AAC/B,QAAM,EAAE,SAAAnB,EAAA,IAAYE,EAAA,GACd,EAAE,QAAAkB,EAAA,IAAWC,EAAA;AACnB,EAAAC,EAAQ,2BAA2B;AACnC,QAAM,EAAE,GAAAC,EAAA,IAAMC,EAAe,2BAA2B;AACxD,SACE,gBAAArB;AAAA,IAACiB;AAAA,IAAA;AAAA,MACC,SAAS,MAAM;AACb,QAAApB,EAAQyB,EAAgB,MAAM;AAAA,MAChC;AAAA,MACA,SAAQ;AAAA,MAEP,YAAE,gBAAgB;AAAA,IAAA;AAAA,EAAA;AAGzB;"}