@gusto/embedded-react-sdk 0.50.0 → 0.51.2

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

@@ -0,0 +1 @@
+{"version":3,"file":"SignatureForm.js","sources":["../../../../../src/components/Contractor/Documents/SignatureForm/SignatureForm.tsx"],"sourcesContent":["import { Trans, useTranslation } from 'react-i18next'\nimport {\n  useContractorSignatureForm,\n  type UseContractorSignatureFormReady,\n} from './useContractorSignatureForm'\nimport { useI18n, useComponentDictionary } from '@/i18n'\nimport type { BaseComponentInterface } from '@/components/Base/Base'\nimport { BaseComponent, BaseLayout } from '@/components/Base'\nimport { useBase } from '@/components/Base/useBase'\nimport { ActionsLayout, Flex } from '@/components/Common'\nimport { Form as FormLayout } from '@/components/Common/Form'\nimport { SDKFormProvider } from '@/partner-hook-utils/form/SDKFormProvider'\nimport { contractorEvents, componentEvents } from '@/shared/constants'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\n/** IRS instructions page for completing Form W-9. */\nconst W9_INSTRUCTIONS_URL = 'https://www.irs.gov/forms-pubs/about-form-w-9'\n\n/**\n * Props for {@link SignatureForm}.\n *\n * @public\n */\nexport interface SignatureFormProps extends BaseComponentInterface<'Contractor.SignatureForm'> {\n  /** The UUID of the contractor document to sign. */\n  documentUuid: string\n  /** The associated contractor identifier. */\n  contractorId: string\n}\n\n/**\n * Standalone form for signing an individual contractor document (W-9).\n *\n * @remarks\n * Lower-level building block used internally by `ContractorDocumentSigner` for\n * its signing view. Use this component directly when you need full control over\n * navigation between the document list and the signature form.\n *\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `contractor/documents/sign` | Fired when the document is successfully signed | The signed document |\n * | `CANCEL` | Fired when the user navigates back from the signature form | — |\n *\n * @param props - See {@link SignatureFormProps}.\n * @returns The rendered signature form.\n * @public\n */\nexport function SignatureForm(props: SignatureFormProps) {\n  return (\n    <BaseComponent {...props}>\n      <Root {...props} />\n    </BaseComponent>\n  )\n}\n\nfunction Root({ documentUuid, dictionary }: SignatureFormProps) {\n  useComponentDictionary('Contractor.SignatureForm', dictionary)\n  useI18n('Contractor.SignatureForm')\n  const { t } = useTranslation('Contractor.SignatureForm')\n  const { onEvent } = useBase()\n  const Components = useComponentContext()\n\n  const hookResult = useContractorSignatureForm({ documentUuid })\n\n  if (hookResult.isLoading) {\n    return <BaseLayout isLoading error={hookResult.errorHandling.errors} />\n  }\n\n  const { document, pdfUrl, hasFields } = hookResult.data\n  const { isPending } = hookResult.status\n  const { Agree } = hookResult.form.Fields\n\n  const handleFormSubmit = async () => {\n    const result = await hookResult.actions.onSubmit()\n    if (result) {\n      onEvent(contractorEvents.CONTRACTOR_SIGN_DOCUMENT, result.data)\n    }\n  }\n\n  const handleBack = () => {\n    onEvent(componentEvents.CANCEL)\n  }\n\n  return (\n    <BaseLayout error={hookResult.errorHandling.errors}>\n      <SDKFormProvider formHookResult={hookResult}>\n        <FormLayout onSubmit={handleFormSubmit}>\n          <Flex flexDirection=\"column\" gap={32} alignItems=\"stretch\">\n            <Flex flexDirection=\"column\" gap={4}>\n              <Components.Heading as=\"h2\">\n                {document.title ?? t('signatureRequired')}\n              </Components.Heading>\n              <Components.Text variant=\"supporting\">\n                <Components.Link\n                  href={W9_INSTRUCTIONS_URL}\n                  target=\"_blank\"\n                  rel=\"noopener noreferrer\"\n                >\n                  {t('instructions')}\n                </Components.Link>\n              </Components.Text>\n              {pdfUrl && (\n                <Components.Text variant=\"supporting\">\n                  <Trans\n                    t={t}\n                    i18nKey=\"downloadPrompt\"\n                    components={{\n                      downloadLink: (\n                        <Components.Link\n                          href={pdfUrl}\n                          target=\"_blank\"\n                          rel=\"noopener noreferrer\"\n                          download={`${document.title || 'document'}.pdf`}\n                        />\n                      ),\n                    }}\n                  />\n                </Components.Text>\n              )}\n            </Flex>\n\n            {hasFields ? (\n              <W9Fields hookResult={hookResult} />\n            ) : (\n              <Agree\n                label={t('agreeLabel')}\n                validationMessages={{ AGREE_REQUIRED: t('validation.agreeRequired') }}\n              />\n            )}\n\n            <ActionsLayout>\n              <Components.Button variant=\"secondary\" type=\"button\" onClick={handleBack}>\n                {t('backCta')}\n              </Components.Button>\n              <Components.Button type=\"submit\" isDisabled={isPending}>\n                {hasFields\n                  ? isPending\n                    ? t('signingCta')\n                    : t('signCta')\n                  : isPending\n                    ? t('acknowledgingCta')\n                    : t('acknowledgeCta')}\n              </Components.Button>\n            </ActionsLayout>\n          </Flex>\n        </FormLayout>\n      </SDKFormProvider>\n    </BaseLayout>\n  )\n}\n\ninterface W9FieldsProps {\n  hookResult: UseContractorSignatureFormReady\n}\n\nfunction W9Fields({ hookResult }: W9FieldsProps) {\n  const { t } = useTranslation('Contractor.SignatureForm')\n  const Components = useComponentContext()\n  const { Fields, fieldsMetadata } = hookResult.form\n  const copy = useSignatureFormCopy()\n\n  const requiredMessages = {\n    REQUIRED: t('validation.required'),\n  }\n\n  return (\n    <>\n      {/* Classification */}\n      <Components.Box>\n        <Flex flexDirection=\"column\" gap={16}>\n          {Fields.Name && (\n            <Fields.Name\n              label={t('fields.name.label')}\n              description={t('fields.name.description')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.BusinessName && (\n            <Fields.BusinessName\n              label={t('fields.business_name.label')}\n              description={t('fields.business_name.description')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.TaxClassification && (\n            <Fields.TaxClassification\n              label={t('fields.taxClassification.label')}\n              description={t('fields.taxClassification.description')}\n              validationMessages={requiredMessages}\n              getOptionLabel={value => copy.taxClassificationOptions[value] ?? value}\n            />\n          )}\n          {Fields.LlcClassificationCode && (\n            <Fields.LlcClassificationCode\n              label={t('fields.llcClassificationCode.label')}\n              description={t('fields.llcClassificationCode.description')}\n              validationMessages={requiredMessages}\n              placeholder={copy.llcPlaceholder}\n              getOptionLabel={value => copy.llcClassificationOptions[value] ?? value}\n            />\n          )}\n          {Fields.OtherText && (\n            <Fields.OtherText\n              label={t('fields.other_text.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.ForeignPartners && (\n            <Fields.ForeignPartners\n              label={t('fields.foreign_partners.label')}\n              description={t('fields.foreign_partners.description')}\n            />\n          )}\n        </Flex>\n      </Components.Box>\n\n      {/* Exemptions */}\n      {(Fields.ExemptPayeeCode || Fields.ExemptionFromFatca) && (\n        <Components.Box\n          header={\n            <Flex flexDirection=\"column\" gap={2}>\n              <Components.Heading as=\"h3\">{t('sections.exemptions')}</Components.Heading>\n              <Components.Text variant=\"supporting\">\n                {t('sectionInstructions.exemptions')}\n              </Components.Text>\n            </Flex>\n          }\n        >\n          <Flex flexDirection=\"column\" gap={16}>\n            {Fields.ExemptPayeeCode && (\n              <Fields.ExemptPayeeCode\n                label={t('fields.exempt_payee_code.label')}\n                validationMessages={requiredMessages}\n              />\n            )}\n            {Fields.ExemptionFromFatca && (\n              <Fields.ExemptionFromFatca\n                label={t('fields.exemption_from_FATCA.label')}\n                description={t('fields.exemption_from_FATCA.description')}\n                validationMessages={requiredMessages}\n              />\n            )}\n          </Flex>\n        </Components.Box>\n      )}\n\n      {/* Address */}\n      <Components.Box\n        header={\n          <Flex flexDirection=\"column\" gap={2}>\n            <Components.Heading as=\"h3\">{t('sections.address')}</Components.Heading>\n            <Components.Text variant=\"supporting\">\n              {t('sectionInstructions.address')}\n            </Components.Text>\n          </Flex>\n        }\n      >\n        <Flex flexDirection=\"column\" gap={16}>\n          {Fields.HomeAddressStreet1 && (\n            <Fields.HomeAddressStreet1\n              label={t('fields.home_address_street_1.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.HomeAddressStreet2 && (\n            <Fields.HomeAddressStreet2\n              label={t('fields.home_address_street_2.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.HomeAddressCity && (\n            <Fields.HomeAddressCity\n              label={t('fields.home_address_city.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.HomeAddressState && (\n            <Fields.HomeAddressState\n              label={t('fields.home_address_state.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.HomeAddressZip && (\n            <Fields.HomeAddressZip\n              label={t('fields.home_address_zip.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.AccountNumber && (\n            <Fields.AccountNumber\n              label={t('fields.account_number.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          {Fields.CompanyName && (\n            <Fields.CompanyName\n              label={t('fields.company_name.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n        </Flex>\n      </Components.Box>\n\n      {/* Taxpayer Identification Number */}\n      {(Fields.Ssn || Fields.Ein) && (\n        <Components.Box\n          header={\n            <Flex flexDirection=\"column\" gap={2}>\n              <Components.Heading as=\"h3\">{t('sections.tin')}</Components.Heading>\n              <Components.Text variant=\"supporting\">\n                {t('sectionInstructions.tin')} {t('sectionInstructions.tinSecondary')}\n              </Components.Text>\n            </Flex>\n          }\n        >\n          <Flex flexDirection=\"column\" gap={16}>\n            {Fields.Ssn && (\n              <Fields.Ssn\n                label={t('fields.ssn.label')}\n                validationMessages={{\n                  ...requiredMessages,\n                  INVALID_SSN: t('validation.invalidSsn'),\n                }}\n                placeholder={fieldsMetadata.ssn.placeholder}\n              />\n            )}\n            {Fields.Ein && (\n              <Fields.Ein\n                label={t('fields.ein.label')}\n                validationMessages={{\n                  ...requiredMessages,\n                  INVALID_EIN: t('validation.invalidEin'),\n                }}\n                placeholder={fieldsMetadata.ein.placeholder}\n              />\n            )}\n          </Flex>\n        </Components.Box>\n      )}\n\n      {/* Certification */}\n      <Components.Box\n        header={\n          <Flex flexDirection=\"column\" gap={2}>\n            <Components.Heading as=\"h3\">{t('sections.certification')}</Components.Heading>\n            <Components.Text variant=\"supporting\">\n              {t('sectionInstructions.certification')}\n            </Components.Text>\n          </Flex>\n        }\n      >\n        <Flex flexDirection=\"column\" gap={16}>\n          <CertificationDeclaration />\n          {Fields.SignatureText && (\n            <Fields.SignatureText\n              label={t('fields.signature_text.label')}\n              validationMessages={requiredMessages}\n            />\n          )}\n          <Fields.Agree\n            label={t('agreeLabel')}\n            validationMessages={{ AGREE_REQUIRED: t('validation.agreeRequired') }}\n          />\n        </Flex>\n      </Components.Box>\n    </>\n  )\n}\n\nfunction CertificationDeclaration() {\n  const { t } = useTranslation('Contractor.SignatureForm')\n  const Components = useComponentContext()\n\n  return (\n    <Flex flexDirection=\"column\" gap={8}>\n      <Components.Text weight=\"medium\">{t('certificationIntro')}</Components.Text>\n      <Components.OrderedList\n        items={[\n          <Components.Text key=\"taxpayerId\">{t('certificationPoints.taxpayerId')}</Components.Text>,\n          <Components.Text key=\"backupWithholding\">\n            {t('certificationPoints.backupWithholding')}\n          </Components.Text>,\n          <Components.Text key=\"usPerson\">{t('certificationPoints.usPerson')}</Components.Text>,\n          <Components.Text key=\"fatca\">{t('certificationPoints.fatca')}</Components.Text>,\n        ]}\n      />\n    </Flex>\n  )\n}\n\n/**\n * Resolves the W-9 classification option copy into lookup maps keyed by option\n * value. Each entry uses a static translation key so the typed `t` surface stays\n * sound.\n */\nfunction useSignatureFormCopy() {\n  const { t } = useTranslation('Contractor.SignatureForm')\n\n  const taxClassificationOptions: Record<string, string> = {\n    individual_proprietor: t('options.taxClassification.individual_proprietor'),\n    c_corporation: t('options.taxClassification.c_corporation'),\n    s_corporation: t('options.taxClassification.s_corporation'),\n    partnership: t('options.taxClassification.partnership'),\n    trust_estate: t('options.taxClassification.trust_estate'),\n    limited_liability_company: t('options.taxClassification.limited_liability_company'),\n    other: t('options.taxClassification.other'),\n  }\n\n  const llcClassificationOptions: Record<string, string> = {\n    c: t('options.llcClassificationCode.c'),\n    s: t('options.llcClassificationCode.s'),\n    p: t('options.llcClassificationCode.p'),\n  }\n\n  return {\n    taxClassificationOptions,\n    llcClassificationOptions,\n    llcPlaceholder: t('options.llcClassificationCode.placeholder'),\n  }\n}\n"],"names":["W9_INSTRUCTIONS_URL","SignatureForm","props","jsx","BaseComponent","Root","documentUuid","dictionary","useComponentDictionary","useI18n","t","useTranslation","onEvent","useBase","Components","useComponentContext","hookResult","useContractorSignatureForm","BaseLayout","document","pdfUrl","hasFields","isPending","Agree","handleFormSubmit","result","contractorEvents","handleBack","componentEvents","SDKFormProvider","FormLayout","jsxs","Flex","Trans","W9Fields","ActionsLayout","Fields","fieldsMetadata","copy","useSignatureFormCopy","requiredMessages","Fragment","value","CertificationDeclaration","taxClassificationOptions","llcClassificationOptions"],"mappings":";;;;;;;;;;;;;AAgBA,MAAMA,IAAsB;AA+BrB,SAASC,EAAcC,GAA2B;AACvD,SACE,gBAAAC,EAACC,KAAe,GAAGF,GACjB,4BAACG,GAAA,EAAM,GAAGH,GAAO,EAAA,CACnB;AAEJ;AAEA,SAASG,EAAK,EAAE,cAAAC,GAAc,YAAAC,KAAkC;AAC9D,EAAAC,EAAuB,4BAA4BD,CAAU,GAC7DE,EAAQ,0BAA0B;AAClC,QAAM,EAAE,GAAAC,EAAA,IAAMC,EAAe,0BAA0B,GACjD,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAaC,EAAA,GAEbC,IAAaC,EAA2B,EAAE,cAAAX,GAAc;AAE9D,MAAIU,EAAW;AACb,6BAAQE,GAAA,EAAW,WAAS,IAAC,OAAOF,EAAW,cAAc,QAAQ;AAGvE,QAAM,EAAE,UAAAG,GAAU,QAAAC,GAAQ,WAAAC,EAAA,IAAcL,EAAW,MAC7C,EAAE,WAAAM,MAAcN,EAAW,QAC3B,EAAE,OAAAO,EAAA,IAAUP,EAAW,KAAK,QAE5BQ,IAAmB,YAAY;AACnC,UAAMC,IAAS,MAAMT,EAAW,QAAQ,SAAA;AACxC,IAAIS,KACFb,EAAQc,EAAiB,0BAA0BD,EAAO,IAAI;AAAA,EAElE,GAEME,IAAa,MAAM;AACvB,IAAAf,EAAQgB,EAAgB,MAAM;AAAA,EAChC;AAEA,SACE,gBAAAzB,EAACe,KAAW,OAAOF,EAAW,cAAc,QAC1C,UAAA,gBAAAb,EAAC0B,KAAgB,gBAAgBb,GAC/B,4BAACc,GAAA,EAAW,UAAUN,GACpB,UAAA,gBAAAO,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAAI,YAAW,WAC/C,UAAA;AAAA,IAAA,gBAAAD,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,MAAA,gBAAA7B,EAACW,EAAW,SAAX,EAAmB,IAAG,MACpB,UAAAK,EAAS,SAAST,EAAE,mBAAmB,EAAA,CAC1C;AAAA,MACA,gBAAAP,EAACW,EAAW,MAAX,EAAgB,SAAQ,cACvB,UAAA,gBAAAX;AAAA,QAACW,EAAW;AAAA,QAAX;AAAA,UACC,MAAMd;AAAA,UACN,QAAO;AAAA,UACP,KAAI;AAAA,UAEH,YAAE,cAAc;AAAA,QAAA;AAAA,MAAA,GAErB;AAAA,MACCoB,KACC,gBAAAjB,EAACW,EAAW,MAAX,EAAgB,SAAQ,cACvB,UAAA,gBAAAX;AAAA,QAAC8B;AAAA,QAAA;AAAA,UACC,GAAAvB;AAAA,UACA,SAAQ;AAAA,UACR,YAAY;AAAA,YACV,cACE,gBAAAP;AAAA,cAACW,EAAW;AAAA,cAAX;AAAA,gBACC,MAAMM;AAAA,gBACN,QAAO;AAAA,gBACP,KAAI;AAAA,gBACJ,UAAU,GAAGD,EAAS,SAAS,UAAU;AAAA,cAAA;AAAA,YAAA;AAAA,UAC3C;AAAA,QAEJ;AAAA,MAAA,EACF,CACF;AAAA,IAAA,GAEJ;AAAA,IAECE,IACC,gBAAAlB,EAAC+B,GAAA,EAAS,YAAAlB,EAAA,CAAwB,IAElC,gBAAAb;AAAA,MAACoB;AAAA,MAAA;AAAA,QACC,OAAOb,EAAE,YAAY;AAAA,QACrB,oBAAoB,EAAE,gBAAgBA,EAAE,0BAA0B,EAAA;AAAA,MAAE;AAAA,IAAA;AAAA,sBAIvEyB,GAAA,EACC,UAAA;AAAA,MAAA,gBAAAhC,EAACW,EAAW,QAAX,EAAkB,SAAQ,aAAY,MAAK,UAAS,SAASa,GAC3D,UAAAjB,EAAE,SAAS,EAAA,CACd;AAAA,MACA,gBAAAP,EAACW,EAAW,QAAX,EAAkB,MAAK,UAAS,YAAYQ,GAC1C,UAEKZ,EAFLW,IACGC,IACI,eACA,YACJA,IACI,qBACA,gBAJY,EAII,CAC1B;AAAA,IAAA,EAAA,CACF;AAAA,EAAA,GACF,EAAA,CACF,GACF,GACF;AAEJ;AAMA,SAASY,EAAS,EAAE,YAAAlB,KAA6B;AAC/C,QAAM,EAAE,GAAAN,EAAA,IAAMC,EAAe,0BAA0B,GACjDG,IAAaC,EAAA,GACb,EAAE,QAAAqB,GAAQ,gBAAAC,EAAA,IAAmBrB,EAAW,MACxCsB,IAAOC,EAAA,GAEPC,IAAmB;AAAA,IACvB,UAAU9B,EAAE,qBAAqB;AAAA,EAAA;AAGnC,SACE,gBAAAqB,EAAAU,GAAA,EAEE,UAAA;AAAA,IAAA,gBAAAtC,EAACW,EAAW,KAAX,EACC,UAAA,gBAAAiB,EAACC,KAAK,eAAc,UAAS,KAAK,IAC/B,UAAA;AAAA,MAAAI,EAAO,QACN,gBAAAjC;AAAA,QAACiC,EAAO;AAAA,QAAP;AAAA,UACC,OAAO1B,EAAE,mBAAmB;AAAA,UAC5B,aAAaA,EAAE,yBAAyB;AAAA,UACxC,oBAAoB8B;AAAA,QAAA;AAAA,MAAA;AAAA,MAGvBJ,EAAO,gBACN,gBAAAjC;AAAA,QAACiC,EAAO;AAAA,QAAP;AAAA,UACC,OAAO1B,EAAE,4BAA4B;AAAA,UACrC,aAAaA,EAAE,kCAAkC;AAAA,UACjD,oBAAoB8B;AAAA,QAAA;AAAA,MAAA;AAAA,MAGvBJ,EAAO,qBACN,gBAAAjC;AAAA,QAACiC,EAAO;AAAA,QAAP;AAAA,UACC,OAAO1B,EAAE,gCAAgC;AAAA,UACzC,aAAaA,EAAE,sCAAsC;AAAA,UACrD,oBAAoB8B;AAAA,UACpB,gBAAgB,CAAAE,MAASJ,EAAK,yBAAyBI,CAAK,KAAKA;AAAA,QAAA;AAAA,MAAA;AAAA,MAGpEN,EAAO,yBACN,gBAAAjC;AAAA,QAACiC,EAAO;AAAA,QAAP;AAAA,UACC,OAAO1B,EAAE,oCAAoC;AAAA,UAC7C,aAAaA,EAAE,0CAA0C;AAAA,UACzD,oBAAoB8B;AAAA,UACpB,aAAaF,EAAK;AAAA,UAClB,gBAAgB,CAAAI,MAASJ,EAAK,yBAAyBI,CAAK,KAAKA;AAAA,QAAA;AAAA,MAAA;AAAA,MAGpEN,EAAO,aACN,gBAAAjC;AAAA,QAACiC,EAAO;AAAA,QAAP;AAAA,UACC,OAAO1B,EAAE,yBAAyB;AAAA,UAClC,oBAAoB8B;AAAA,QAAA;AAAA,MAAA;AAAA,MAGvBJ,EAAO,mBACN,gBAAAjC;AAAA,QAACiC,EAAO;AAAA,QAAP;AAAA,UACC,OAAO1B,EAAE,+BAA+B;AAAA,UACxC,aAAaA,EAAE,qCAAqC;AAAA,QAAA;AAAA,MAAA;AAAA,IACtD,EAAA,CAEJ,EAAA,CACF;AAAA,KAGE0B,EAAO,mBAAmBA,EAAO,uBACjC,gBAAAjC;AAAA,MAACW,EAAW;AAAA,MAAX;AAAA,QACC,QACE,gBAAAiB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAA7B,EAACW,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAJ,EAAE,qBAAqB,GAAE;AAAA,UACtD,gBAAAP,EAACW,EAAW,MAAX,EAAgB,SAAQ,cACtB,UAAAJ,EAAE,gCAAgC,EAAA,CACrC;AAAA,QAAA,GACF;AAAA,QAGF,UAAA,gBAAAqB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAC/B,UAAA;AAAA,UAAAI,EAAO,mBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,gCAAgC;AAAA,cACzC,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGvBJ,EAAO,sBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,mCAAmC;AAAA,cAC5C,aAAaA,EAAE,yCAAyC;AAAA,cACxD,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,QACtB,EAAA,CAEJ;AAAA,MAAA;AAAA,IAAA;AAAA,IAKJ,gBAAArC;AAAA,MAACW,EAAW;AAAA,MAAX;AAAA,QACC,QACE,gBAAAiB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAA7B,EAACW,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAJ,EAAE,kBAAkB,GAAE;AAAA,UACnD,gBAAAP,EAACW,EAAW,MAAX,EAAgB,SAAQ,cACtB,UAAAJ,EAAE,6BAA6B,EAAA,CAClC;AAAA,QAAA,GACF;AAAA,QAGF,UAAA,gBAAAqB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAC/B,UAAA;AAAA,UAAAI,EAAO,sBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,oCAAoC;AAAA,cAC7C,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGvBJ,EAAO,sBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,oCAAoC;AAAA,cAC7C,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGvBJ,EAAO,mBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,gCAAgC;AAAA,cACzC,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGvBJ,EAAO,oBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,iCAAiC;AAAA,cAC1C,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGvBJ,EAAO,kBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,+BAA+B;AAAA,cACxC,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGvBJ,EAAO,iBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,6BAA6B;AAAA,cACtC,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGvBJ,EAAO,eACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,2BAA2B;AAAA,cACpC,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,QACtB,EAAA,CAEJ;AAAA,MAAA;AAAA,IAAA;AAAA,KAIAJ,EAAO,OAAOA,EAAO,QACrB,gBAAAjC;AAAA,MAACW,EAAW;AAAA,MAAX;AAAA,QACC,QACE,gBAAAiB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAA7B,EAACW,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAJ,EAAE,cAAc,GAAE;AAAA,UAC/C,gBAAAqB,EAACjB,EAAW,MAAX,EAAgB,SAAQ,cACtB,UAAA;AAAA,YAAAJ,EAAE,yBAAyB;AAAA,YAAE;AAAA,YAAEA,EAAE,kCAAkC;AAAA,UAAA,EAAA,CACtE;AAAA,QAAA,GACF;AAAA,QAGF,UAAA,gBAAAqB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAC/B,UAAA;AAAA,UAAAI,EAAO,OACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,kBAAkB;AAAA,cAC3B,oBAAoB;AAAA,gBAClB,GAAG8B;AAAA,gBACH,aAAa9B,EAAE,uBAAuB;AAAA,cAAA;AAAA,cAExC,aAAa2B,EAAe,IAAI;AAAA,YAAA;AAAA,UAAA;AAAA,UAGnCD,EAAO,OACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,kBAAkB;AAAA,cAC3B,oBAAoB;AAAA,gBAClB,GAAG8B;AAAA,gBACH,aAAa9B,EAAE,uBAAuB;AAAA,cAAA;AAAA,cAExC,aAAa2B,EAAe,IAAI;AAAA,YAAA;AAAA,UAAA;AAAA,QAClC,EAAA,CAEJ;AAAA,MAAA;AAAA,IAAA;AAAA,IAKJ,gBAAAlC;AAAA,MAACW,EAAW;AAAA,MAAX;AAAA,QACC,QACE,gBAAAiB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAA7B,EAACW,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAJ,EAAE,wBAAwB,GAAE;AAAA,UACzD,gBAAAP,EAACW,EAAW,MAAX,EAAgB,SAAQ,cACtB,UAAAJ,EAAE,mCAAmC,EAAA,CACxC;AAAA,QAAA,GACF;AAAA,QAGF,UAAA,gBAAAqB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAChC,UAAA;AAAA,UAAA,gBAAA7B,EAACwC,GAAA,EAAyB;AAAA,UACzBP,EAAO,iBACN,gBAAAjC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,6BAA6B;AAAA,cACtC,oBAAoB8B;AAAA,YAAA;AAAA,UAAA;AAAA,UAGxB,gBAAArC;AAAA,YAACiC,EAAO;AAAA,YAAP;AAAA,cACC,OAAO1B,EAAE,YAAY;AAAA,cACrB,oBAAoB,EAAE,gBAAgBA,EAAE,0BAA0B,EAAA;AAAA,YAAE;AAAA,UAAA;AAAA,QACtE,EAAA,CACF;AAAA,MAAA;AAAA,IAAA;AAAA,EACF,GACF;AAEJ;AAEA,SAASiC,IAA2B;AAClC,QAAM,EAAE,GAAAjC,EAAA,IAAMC,EAAe,0BAA0B,GACjDG,IAAaC,EAAA;AAEnB,SACE,gBAAAgB,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,IAAA,gBAAA7B,EAACW,EAAW,MAAX,EAAgB,QAAO,UAAU,UAAAJ,EAAE,oBAAoB,GAAE;AAAA,IAC1D,gBAAAP;AAAA,MAACW,EAAW;AAAA,MAAX;AAAA,QACC,OAAO;AAAA,4BACJA,EAAW,MAAX,EAAkC,UAAAJ,EAAE,gCAAgC,KAAhD,YAAkD;AAAA,4BACtEI,EAAW,MAAX,EACE,UAAAJ,EAAE,uCAAuC,KADvB,mBAErB;AAAA,4BACCI,EAAW,MAAX,EAAgC,UAAAJ,EAAE,8BAA8B,KAA5C,UAA8C;AAAA,4BAClEI,EAAW,MAAX,EAA6B,UAAAJ,EAAE,2BAA2B,KAAtC,OAAwC;AAAA,QAAA;AAAA,MAC/D;AAAA,IAAA;AAAA,EACF,GACF;AAEJ;AAOA,SAAS6B,IAAuB;AAC9B,QAAM,EAAE,GAAA7B,EAAA,IAAMC,EAAe,0BAA0B,GAEjDiC,IAAmD;AAAA,IACvD,uBAAuBlC,EAAE,iDAAiD;AAAA,IAC1E,eAAeA,EAAE,yCAAyC;AAAA,IAC1D,eAAeA,EAAE,yCAAyC;AAAA,IAC1D,aAAaA,EAAE,uCAAuC;AAAA,IACtD,cAAcA,EAAE,wCAAwC;AAAA,IACxD,2BAA2BA,EAAE,qDAAqD;AAAA,IAClF,OAAOA,EAAE,iCAAiC;AAAA,EAAA,GAGtCmC,IAAmD;AAAA,IACvD,GAAGnC,EAAE,iCAAiC;AAAA,IACtC,GAAGA,EAAE,iCAAiC;AAAA,IACtC,GAAGA,EAAE,iCAAiC;AAAA,EAAA;AAGxC,SAAO;AAAA,IACL,0BAAAkC;AAAA,IACA,0BAAAC;AAAA,IACA,gBAAgBnC,EAAE,2CAA2C;AAAA,EAAA;AAEjE;"}

package/dist/components/Contractor/Documents/SignatureForm/index.d.ts

@@ -0,0 +1,2 @@
+export { SignatureForm, type SignatureFormProps } from './SignatureForm';
+export * from './useContractorSignatureForm';

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

@@ -0,0 +1,175 @@
+import { z } from 'zod';
+import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes produced by the contractor signature form schema.
+ *
+ * @remarks
+ * Use these constants as the keys in a field's `validationMessages` prop to map
+ * an error code to a user-facing message.
+ *
+ * @public
+ */
+export declare const ContractorSignatureFormErrorCodes: {
+    /** A required field was left empty. */
+    readonly REQUIRED: "REQUIRED";
+    /** The electronic-signature consent checkbox was not checked. */
+    readonly AGREE_REQUIRED: "AGREE_REQUIRED";
+    /** The Social Security Number is not a valid SSN. */
+    readonly INVALID_SSN: "INVALID_SSN";
+    /** The Employer Identification Number is not a valid EIN. */
+    readonly INVALID_EIN: "INVALID_EIN";
+};
+/**
+ * Union of validation error code strings emitted by the contractor signature
+ * form schema.
+ *
+ * @public
+ */
+export type ContractorSignatureFormErrorCode = (typeof ContractorSignatureFormErrorCodes)[keyof typeof ContractorSignatureFormErrorCodes];
+/**
+ * Shape of the values managed by {@link useContractorSignatureForm}.
+ *
+ * @remarks
+ * Keys are the camelCase react-hook-form field names. `taxClassification` and
+ * `llcClassificationCode` are synthesized (they have no single API field), and
+ * `agree` is the electronic-signature consent; all other keys map to a W-9 API
+ * field via the hook's serializer.
+ *
+ * @public
+ * @interface
+ */
+export type ContractorSignatureFormData = {
+      /** Entity or individual name (W-9 line 1). */
+      name: string
+      /** Business name, if different (W-9 line 2). */
+      businessName: string
+      /** Selected federal tax classification option key (W-9 line 3). */
+      taxClassification: string
+      /** LLC tax classification code, set only when the LLC classification is selected. */
+      llcClassificationCode: string
+      /** Free-text classification entry, used only when the "Other" classification is selected. */
+      otherText: string
+      /** Whether the payee has foreign partners/owners/beneficiaries (W-9 line 3b). */
+      foreignPartners: boolean
+      /** Exempt payee code (W-9 line 4a). */
+      exemptPayeeCode: string
+      /** Exemption from FATCA reporting code (W-9 line 4b). */
+      exemptionFromFatca: string
+      /** Street address line 1 (W-9 line 5). */
+      homeAddressStreet1: string
+      /** Street address line 2 (W-9 line 5). */
+      homeAddressStreet2: string
+      /** City (W-9 line 6). */
+      homeAddressCity: string
+      /** State (W-9 line 6). */
+      homeAddressState: string
+      /** ZIP code (W-9 line 6). */
+      homeAddressZip: string
+      /** Account number(s) (W-9 line 7). */
+      accountNumber: string
+      /** Requester's name and address. */
+      companyName: string
+      /**
+         * Social Security Number. Accepts a 9-digit SSN (validated digits-only) or the
+         * `N/A` sentinel the API uses when the W-9 collects an EIN instead. A redacted
+         * value left untouched (empty) is valid — the server keeps the SSN on file.
+         */
+      ssn: string
+      /**
+         * Employer Identification Number. Accepts a formatted EIN (`NN-NNNNNNN`) or the
+         * `N/A` sentinel the API uses when the W-9 collects an SSN instead. A redacted
+         * value left untouched (empty) is valid — the server keeps the EIN on file.
+         */
+      ein: string
+      /** Typed signature. */
+      signatureText: string
+      /** Electronic-signature consent; must be checked to submit. */
+      agree: boolean
+    };
+/**
+ * Validated submission shape produced by the {@link useContractorSignatureForm} schema.
+ *
+ * @public
+ */
+export type ContractorSignatureFormOutputs = ContractorSignatureFormData;
+/**
+ * Optional W-9 fields a partner can promote to required.
+ *
+ * @public
+ */
+export type ContractorSignatureOptionalFieldsToRequire = { create?: ("businessName" | "llcClassificationCode" | "otherText" | "foreignPartners" | "exemptPayeeCode" | "exemptionFromFatca" | "homeAddressStreet2" | "accountNumber" | "companyName")[] | undefined; update?: ("businessName" | "llcClassificationCode" | "otherText" | "foreignPartners" | "exemptPayeeCode" | "exemptionFromFatca" | "homeAddressStreet2" | "accountNumber" | "companyName")[] | undefined; };
+/**
+ * Options for {@link createContractorSignatureFormSchema}.
+ *
+ * @internal
+ */
+export interface ContractorSignatureSchemaOptions {
+    /** Partner overrides promoting optional fields to required. */
+    optionalFieldsToRequire?: ContractorSignatureOptionalFieldsToRequire;
+    /** Whether the SSN arrived redacted (a value is already on file, so an empty input is valid). */
+    ssnRedacted?: boolean;
+    /** Whether the EIN arrived redacted (a value is already on file, so an empty input is valid). */
+    einRedacted?: boolean;
+}
+/**
+ * Builds the W-9 signing form schema and its metadata config.
+ *
+ * @remarks
+ * Required-field rules are declarative (`requiredFieldsConfig`) and the W-9 is
+ * always a create operation. `ssn`/`ein` are exempted from required validation
+ * when their value arrived redacted; `agree` must be checked (enforced via the
+ * `superRefine`).
+ *
+ * @param options - Partner overrides and API-derived redaction flags.
+ * @returns The `[schema, metadataConfig]` tuple from {@link buildFormSchema}.
+ * @internal
+ */
+export declare function createContractorSignatureFormSchema({ optionalFieldsToRequire, ssnRedacted, einRedacted, }?: ContractorSignatureSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
+    /** Entity or individual name (W-9 line 1). */
+    name: z.ZodString;
+    /** Business name, if different (W-9 line 2). */
+    businessName: z.ZodString;
+    /** Selected federal tax classification option key (W-9 line 3). */
+    taxClassification: z.ZodString;
+    /** LLC tax classification code, set only when the LLC classification is selected. */
+    llcClassificationCode: z.ZodString;
+    /** Free-text classification entry, used only when the "Other" classification is selected. */
+    otherText: z.ZodString;
+    /** Whether the payee has foreign partners/owners/beneficiaries (W-9 line 3b). */
+    foreignPartners: z.ZodBoolean;
+    /** Exempt payee code (W-9 line 4a). */
+    exemptPayeeCode: z.ZodString;
+    /** Exemption from FATCA reporting code (W-9 line 4b). */
+    exemptionFromFatca: z.ZodString;
+    /** Street address line 1 (W-9 line 5). */
+    homeAddressStreet1: z.ZodString;
+    /** Street address line 2 (W-9 line 5). */
+    homeAddressStreet2: z.ZodString;
+    /** City (W-9 line 6). */
+    homeAddressCity: z.ZodString;
+    /** State (W-9 line 6). */
+    homeAddressState: z.ZodString;
+    /** ZIP code (W-9 line 6). */
+    homeAddressZip: z.ZodString;
+    /** Account number(s) (W-9 line 7). */
+    accountNumber: z.ZodString;
+    /** Requester's name and address. */
+    companyName: z.ZodString;
+    /**
+     * Social Security Number. Accepts a 9-digit SSN (validated digits-only) or the
+     * `N/A` sentinel the API uses when the W-9 collects an EIN instead. A redacted
+     * value left untouched (empty) is valid — the server keeps the SSN on file.
+     */
+    ssn: z.ZodString;
+    /**
+     * Employer Identification Number. Accepts a formatted EIN (`NN-NNNNNNN`) or the
+     * `N/A` sentinel the API uses when the W-9 collects an SSN instead. A redacted
+     * value left untouched (empty) is valid — the server keeps the EIN on file.
+     */
+    ein: z.ZodString;
+    /** Typed signature. */
+    signatureText: z.ZodString;
+    /** Electronic-signature consent; must be checked to submit. */
+    agree: z.ZodBoolean;
+}>;
+export {};

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

@@ -0,0 +1,110 @@
+import { z as e } from "zod";
+import { NOT_APPLICABLE_VALUE as n } from "./w9Fields.js";
+import { buildFormSchema as d } from "../../../../../partner-hook-utils/form/buildFormSchema.js";
+import { EIN_REGEX as E, SSN_REGEX as g } from "../../../../../helpers/validations.js";
+import { normalizeEin as c } from "../../../../../helpers/federalEin.js";
+const s = {
+  /** A required field was left empty. */
+  REQUIRED: "REQUIRED",
+  /** The electronic-signature consent checkbox was not checked. */
+  AGREE_REQUIRED: "AGREE_REQUIRED",
+  /** The Social Security Number is not a valid SSN. */
+  INVALID_SSN: "INVALID_SSN",
+  /** The Employer Identification Number is not a valid EIN. */
+  INVALID_EIN: "INVALID_EIN"
+}, I = {
+  /** Entity or individual name (W-9 line 1). */
+  name: e.string(),
+  /** Business name, if different (W-9 line 2). */
+  businessName: e.string(),
+  /** Selected federal tax classification option key (W-9 line 3). */
+  taxClassification: e.string(),
+  /** LLC tax classification code, set only when the LLC classification is selected. */
+  llcClassificationCode: e.string(),
+  /** Free-text classification entry, used only when the "Other" classification is selected. */
+  otherText: e.string(),
+  /** Whether the payee has foreign partners/owners/beneficiaries (W-9 line 3b). */
+  foreignPartners: e.boolean(),
+  /** Exempt payee code (W-9 line 4a). */
+  exemptPayeeCode: e.string(),
+  /** Exemption from FATCA reporting code (W-9 line 4b). */
+  exemptionFromFatca: e.string(),
+  /** Street address line 1 (W-9 line 5). */
+  homeAddressStreet1: e.string(),
+  /** Street address line 2 (W-9 line 5). */
+  homeAddressStreet2: e.string(),
+  /** City (W-9 line 6). */
+  homeAddressCity: e.string(),
+  /** State (W-9 line 6). */
+  homeAddressState: e.string(),
+  /** ZIP code (W-9 line 6). */
+  homeAddressZip: e.string(),
+  /** Account number(s) (W-9 line 7). */
+  accountNumber: e.string(),
+  /** Requester's name and address. */
+  companyName: e.string(),
+  /**
+   * Social Security Number. Accepts a 9-digit SSN (validated digits-only) or the
+   * `N/A` sentinel the API uses when the W-9 collects an EIN instead. A redacted
+   * value left untouched (empty) is valid — the server keeps the SSN on file.
+   */
+  ssn: e.string().refine((r) => r === n || g.test(r.replace(/\D/g, "")), {
+    message: s.INVALID_SSN
+  }),
+  /**
+   * Employer Identification Number. Accepts a formatted EIN (`NN-NNNNNNN`) or the
+   * `N/A` sentinel the API uses when the W-9 collects an SSN instead. A redacted
+   * value left untouched (empty) is valid — the server keeps the EIN on file.
+   */
+  ein: e.string().refine((r) => r === n || E.test(c(r)), {
+    message: s.INVALID_EIN
+  }),
+  /** Typed signature. */
+  signatureText: e.string(),
+  /** Electronic-signature consent; must be checked to submit. */
+  agree: e.boolean()
+}, f = {
+  // Optional by default; partners can promote these via `optionalFieldsToRequire`.
+  // These all back W-9 API fields the document marks `required: false`
+  // (`llcClassificationCode` serializes into the optional `tax_classification`
+  // field, `otherText` into the optional `other_text` field), so the form never
+  // forces them — it mirrors the API's requiredness rather than adding its own.
+  businessName: "never",
+  llcClassificationCode: "never",
+  otherText: "never",
+  exemptPayeeCode: "never",
+  exemptionFromFatca: "never",
+  foreignPartners: "never",
+  homeAddressStreet2: "never",
+  accountNumber: "never",
+  companyName: "never"
+  // name, taxClassification, homeAddressStreet1/City/State/Zip, ssn, ein,
+  // signatureText, and agree are omitted → 'always' required. ssn/ein are
+  // exempted at build time when their value arrived redacted (see factory).
+};
+function A({
+  optionalFieldsToRequire: r,
+  ssnRedacted: o = !1,
+  einRedacted: i = !1
+} = {}) {
+  const t = [];
+  return o && t.push("ssn"), i && t.push("ein"), d(I, {
+    requiredFieldsConfig: f,
+    requiredErrorCode: s.REQUIRED,
+    mode: "create",
+    optionalFieldsToRequire: r,
+    fieldsWithRedactedValues: t,
+    superRefine: (a, m) => {
+      a.agree || m.addIssue({
+        code: e.ZodIssueCode.custom,
+        path: ["agree"],
+        message: s.AGREE_REQUIRED
+      });
+    }
+  });
+}
+export {
+  s as ContractorSignatureFormErrorCodes,
+  A as createContractorSignatureFormSchema
+};
+//# sourceMappingURL=contractorSignatureFormSchema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contractorSignatureFormSchema.js","sources":["../../../../../../src/components/Contractor/Documents/SignatureForm/useContractorSignatureForm/contractorSignatureFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport { NOT_APPLICABLE_VALUE } from './w9Fields'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { SSN_REGEX, EIN_REGEX } from '@/helpers/validations'\nimport { normalizeEin } from '@/helpers/federalEin'\n\n/**\n * Validation error codes produced by the contractor signature form schema.\n *\n * @remarks\n * Use these constants as the keys in a field's `validationMessages` prop to map\n * an error code to a user-facing message.\n *\n * @public\n */\nexport const ContractorSignatureFormErrorCodes = {\n  /** A required field was left empty. */\n  REQUIRED: 'REQUIRED',\n  /** The electronic-signature consent checkbox was not checked. */\n  AGREE_REQUIRED: 'AGREE_REQUIRED',\n  /** The Social Security Number is not a valid SSN. */\n  INVALID_SSN: 'INVALID_SSN',\n  /** The Employer Identification Number is not a valid EIN. */\n  INVALID_EIN: 'INVALID_EIN',\n} as const\n\n/**\n * Union of validation error code strings emitted by the contractor signature\n * form schema.\n *\n * @public\n */\nexport type ContractorSignatureFormErrorCode =\n  (typeof ContractorSignatureFormErrorCodes)[keyof typeof ContractorSignatureFormErrorCodes]\n\nconst fieldValidators = {\n  /** Entity or individual name (W-9 line 1). */\n  name: z.string(),\n  /** Business name, if different (W-9 line 2). */\n  businessName: z.string(),\n  /** Selected federal tax classification option key (W-9 line 3). */\n  taxClassification: z.string(),\n  /** LLC tax classification code, set only when the LLC classification is selected. */\n  llcClassificationCode: z.string(),\n  /** Free-text classification entry, used only when the \"Other\" classification is selected. */\n  otherText: z.string(),\n  /** Whether the payee has foreign partners/owners/beneficiaries (W-9 line 3b). */\n  foreignPartners: z.boolean(),\n  /** Exempt payee code (W-9 line 4a). */\n  exemptPayeeCode: z.string(),\n  /** Exemption from FATCA reporting code (W-9 line 4b). */\n  exemptionFromFatca: z.string(),\n  /** Street address line 1 (W-9 line 5). */\n  homeAddressStreet1: z.string(),\n  /** Street address line 2 (W-9 line 5). */\n  homeAddressStreet2: z.string(),\n  /** City (W-9 line 6). */\n  homeAddressCity: z.string(),\n  /** State (W-9 line 6). */\n  homeAddressState: z.string(),\n  /** ZIP code (W-9 line 6). */\n  homeAddressZip: z.string(),\n  /** Account number(s) (W-9 line 7). */\n  accountNumber: z.string(),\n  /** Requester's name and address. */\n  companyName: z.string(),\n  /**\n   * Social Security Number. Accepts a 9-digit SSN (validated digits-only) or the\n   * `N/A` sentinel the API uses when the W-9 collects an EIN instead. A redacted\n   * value left untouched (empty) is valid — the server keeps the SSN on file.\n   */\n  ssn: z.string().refine(v => v === NOT_APPLICABLE_VALUE || SSN_REGEX.test(v.replace(/\\D/g, '')), {\n    message: ContractorSignatureFormErrorCodes.INVALID_SSN,\n  }),\n  /**\n   * Employer Identification Number. Accepts a formatted EIN (`NN-NNNNNNN`) or the\n   * `N/A` sentinel the API uses when the W-9 collects an SSN instead. A redacted\n   * value left untouched (empty) is valid — the server keeps the EIN on file.\n   */\n  ein: z.string().refine(v => v === NOT_APPLICABLE_VALUE || EIN_REGEX.test(normalizeEin(v)), {\n    message: ContractorSignatureFormErrorCodes.INVALID_EIN,\n  }),\n  /** Typed signature. */\n  signatureText: z.string(),\n  /** Electronic-signature consent; must be checked to submit. */\n  agree: z.boolean(),\n}\n\n/**\n * Shape of the values managed by {@link useContractorSignatureForm}.\n *\n * @remarks\n * Keys are the camelCase react-hook-form field names. `taxClassification` and\n * `llcClassificationCode` are synthesized (they have no single API field), and\n * `agree` is the electronic-signature consent; all other keys map to a W-9 API\n * field via the hook's serializer.\n *\n * @public\n * @interface\n */\nexport type ContractorSignatureFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\n/**\n * Validated submission shape produced by the {@link useContractorSignatureForm} schema.\n *\n * @public\n */\nexport type ContractorSignatureFormOutputs = ContractorSignatureFormData\n\nconst requiredFieldsConfig = {\n  // Optional by default; partners can promote these via `optionalFieldsToRequire`.\n  // These all back W-9 API fields the document marks `required: false`\n  // (`llcClassificationCode` serializes into the optional `tax_classification`\n  // field, `otherText` into the optional `other_text` field), so the form never\n  // forces them — it mirrors the API's requiredness rather than adding its own.\n  businessName: 'never',\n  llcClassificationCode: 'never',\n  otherText: 'never',\n  exemptPayeeCode: 'never',\n  exemptionFromFatca: 'never',\n  foreignPartners: 'never',\n  homeAddressStreet2: 'never',\n  accountNumber: 'never',\n  companyName: 'never',\n  // name, taxClassification, homeAddressStreet1/City/State/Zip, ssn, ein,\n  // signatureText, and agree are omitted → 'always' required. ssn/ein are\n  // exempted at build time when their value arrived redacted (see factory).\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Optional W-9 fields a partner can promote to required.\n *\n * @public\n */\nexport type ContractorSignatureOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\n/**\n * Options for {@link createContractorSignatureFormSchema}.\n *\n * @internal\n */\nexport interface ContractorSignatureSchemaOptions {\n  /** Partner overrides promoting optional fields to required. */\n  optionalFieldsToRequire?: ContractorSignatureOptionalFieldsToRequire\n  /** Whether the SSN arrived redacted (a value is already on file, so an empty input is valid). */\n  ssnRedacted?: boolean\n  /** Whether the EIN arrived redacted (a value is already on file, so an empty input is valid). */\n  einRedacted?: boolean\n}\n\n/**\n * Builds the W-9 signing form schema and its metadata config.\n *\n * @remarks\n * Required-field rules are declarative (`requiredFieldsConfig`) and the W-9 is\n * always a create operation. `ssn`/`ein` are exempted from required validation\n * when their value arrived redacted; `agree` must be checked (enforced via the\n * `superRefine`).\n *\n * @param options - Partner overrides and API-derived redaction flags.\n * @returns The `[schema, metadataConfig]` tuple from {@link buildFormSchema}.\n * @internal\n */\nexport function createContractorSignatureFormSchema({\n  optionalFieldsToRequire,\n  ssnRedacted = false,\n  einRedacted = false,\n}: ContractorSignatureSchemaOptions = {}) {\n  const fieldsWithRedactedValues: Array<keyof typeof fieldValidators> = []\n  if (ssnRedacted) fieldsWithRedactedValues.push('ssn')\n  if (einRedacted) fieldsWithRedactedValues.push('ein')\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: ContractorSignatureFormErrorCodes.REQUIRED,\n    mode: 'create',\n    optionalFieldsToRequire,\n    fieldsWithRedactedValues,\n    superRefine: (data, ctx) => {\n      if (!data.agree) {\n        ctx.addIssue({\n          code: z.ZodIssueCode.custom,\n          path: ['agree'],\n          message: ContractorSignatureFormErrorCodes.AGREE_REQUIRED,\n        })\n      }\n    },\n  })\n}\n"],"names":["ContractorSignatureFormErrorCodes","fieldValidators","z","v","NOT_APPLICABLE_VALUE","SSN_REGEX","EIN_REGEX","normalizeEin","requiredFieldsConfig","createContractorSignatureFormSchema","optionalFieldsToRequire","ssnRedacted","einRedacted","fieldsWithRedactedValues","buildFormSchema","data","ctx"],"mappings":";;;;;AAmBO,MAAMA,IAAoC;AAAA;AAAA,EAE/C,UAAU;AAAA;AAAA,EAEV,gBAAgB;AAAA;AAAA,EAEhB,aAAa;AAAA;AAAA,EAEb,aAAa;AACf,GAWMC,IAAkB;AAAA;AAAA,EAEtB,MAAMC,EAAE,OAAA;AAAA;AAAA,EAER,cAAcA,EAAE,OAAA;AAAA;AAAA,EAEhB,mBAAmBA,EAAE,OAAA;AAAA;AAAA,EAErB,uBAAuBA,EAAE,OAAA;AAAA;AAAA,EAEzB,WAAWA,EAAE,OAAA;AAAA;AAAA,EAEb,iBAAiBA,EAAE,QAAA;AAAA;AAAA,EAEnB,iBAAiBA,EAAE,OAAA;AAAA;AAAA,EAEnB,oBAAoBA,EAAE,OAAA;AAAA;AAAA,EAEtB,oBAAoBA,EAAE,OAAA;AAAA;AAAA,EAEtB,oBAAoBA,EAAE,OAAA;AAAA;AAAA,EAEtB,iBAAiBA,EAAE,OAAA;AAAA;AAAA,EAEnB,kBAAkBA,EAAE,OAAA;AAAA;AAAA,EAEpB,gBAAgBA,EAAE,OAAA;AAAA;AAAA,EAElB,eAAeA,EAAE,OAAA;AAAA;AAAA,EAEjB,aAAaA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMf,KAAKA,EAAE,OAAA,EAAS,OAAO,CAAAC,MAAKA,MAAMC,KAAwBC,EAAU,KAAKF,EAAE,QAAQ,OAAO,EAAE,CAAC,GAAG;AAAA,IAC9F,SAASH,EAAkC;AAAA,EAAA,CAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMD,KAAKE,EAAE,SAAS,OAAO,CAAAC,MAAKA,MAAMC,KAAwBE,EAAU,KAAKC,EAAaJ,CAAC,CAAC,GAAG;AAAA,IACzF,SAASH,EAAkC;AAAA,EAAA,CAC5C;AAAA;AAAA,EAED,eAAeE,EAAE,OAAA;AAAA;AAAA,EAEjB,OAAOA,EAAE,QAAA;AACX,GAyBMM,IAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM3B,cAAc;AAAA,EACd,uBAAuB;AAAA,EACvB,WAAW;AAAA,EACX,iBAAiB;AAAA,EACjB,oBAAoB;AAAA,EACpB,iBAAiB;AAAA,EACjB,oBAAoB;AAAA,EACpB,eAAe;AAAA,EACf,aAAa;AAAA;AAAA;AAAA;AAIf;AAsCO,SAASC,EAAoC;AAAA,EAClD,yBAAAC;AAAA,EACA,aAAAC,IAAc;AAAA,EACd,aAAAC,IAAc;AAChB,IAAsC,IAAI;AACxC,QAAMC,IAAgE,CAAA;AACtE,SAAIF,KAAaE,EAAyB,KAAK,KAAK,GAChDD,KAAaC,EAAyB,KAAK,KAAK,GAE7CC,EAAgBb,GAAiB;AAAA,IACtC,sBAAAO;AAAA,IACA,mBAAmBR,EAAkC;AAAA,IACrD,MAAM;AAAA,IACN,yBAAAU;AAAA,IACA,0BAAAG;AAAA,IACA,aAAa,CAACE,GAAMC,MAAQ;AAC1B,MAAKD,EAAK,SACRC,EAAI,SAAS;AAAA,QACX,MAAMd,EAAE,aAAa;AAAA,QACrB,MAAM,CAAC,OAAO;AAAA,QACd,SAASF,EAAkC;AAAA,MAAA,CAC5C;AAAA,IAEL;AAAA,EAAA,CACD;AACH;"}

package/dist/components/Contractor/Documents/SignatureForm/useContractorSignatureForm/contractorSignatureFormSchema.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,259 @@
+import { ComponentType } from 'react';
+import { ContractorSignatureFormErrorCodes } from './contractorSignatureFormSchema';
+import { TextInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/TextInputHookField';
+import { CheckboxHookFieldProps } from '../../../../../partner-hook-utils/form/fields/CheckboxHookField';
+import { RadioGroupHookFieldProps } from '../../../../../partner-hook-utils/form/fields/RadioGroupHookField';
+import { SelectHookFieldProps } from '../../../../../partner-hook-utils/form/fields/SelectHookField';
+import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * The form-field name of the electronic-signature consent checkbox.
+ *
+ * @internal
+ */
+export declare const AGREE_FIELD = "agree";
+/**
+ * The required-field error code emitted by most {@link useContractorSignatureForm} fields.
+ *
+ * @remarks
+ * Use as a key in `validationMessages` for text inputs, selects, and radio groups
+ * that only emit the `REQUIRED` error. See {@link ContractorSignatureFormErrorCodes}.
+ *
+ * @public
+ */
+export type RequiredValidation = typeof ContractorSignatureFormErrorCodes.REQUIRED;
+/**
+ * Validation error code emitted by the `Agree` consent checkbox.
+ *
+ * @remarks
+ * Use as a key in `validationMessages` on `Fields.Agree`. See
+ * {@link ContractorSignatureFormErrorCodes}.
+ *
+ * @public
+ */
+export type AgreeValidation = typeof ContractorSignatureFormErrorCodes.AGREE_REQUIRED;
+/**
+ * The format-validation error code emitted by the `ssn` field of {@link useContractorSignatureForm}.
+ *
+ * @remarks
+ * Use as a key in `validationMessages` on `Fields.Ssn`. See
+ * {@link ContractorSignatureFormErrorCodes}.
+ *
+ * @public
+ */
+export type SsnValidation = typeof ContractorSignatureFormErrorCodes.INVALID_SSN;
+/**
+ * The format-validation error code emitted by the `ein` field of {@link useContractorSignatureForm}.
+ *
+ * @remarks
+ * Use as a key in `validationMessages` on `Fields.Ein`. See
+ * {@link ContractorSignatureFormErrorCodes}.
+ *
+ * @public
+ */
+export type EinValidation = typeof ContractorSignatureFormErrorCodes.INVALID_EIN;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.Name` component.
+ *
+ * @public
+ */
+export type NameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.TaxClassification` component.
+ *
+ * @public
+ */
+export type TaxClassificationFieldProps = HookFieldProps<RadioGroupHookFieldProps<RequiredValidation, string>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.HomeAddressStreet1` component.
+ *
+ * @public
+ */
+export type HomeAddressStreet1FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.HomeAddressCity` component.
+ *
+ * @public
+ */
+export type HomeAddressCityFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.HomeAddressState` component.
+ *
+ * @public
+ */
+export type HomeAddressStateFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.HomeAddressZip` component.
+ *
+ * @public
+ */
+export type HomeAddressZipFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.Ssn` component.
+ *
+ * @public
+ */
+export type SsnFieldProps = HookFieldProps<TextInputHookFieldProps<SsnValidation, RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.Ein` component.
+ *
+ * @public
+ */
+export type EinFieldProps = HookFieldProps<TextInputHookFieldProps<EinValidation, RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.SignatureText` component.
+ *
+ * @public
+ */
+export type SignatureTextFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.Agree` component.
+ *
+ * @public
+ */
+export type AgreeFieldProps = HookFieldProps<CheckboxHookFieldProps<AgreeValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.BusinessName` component.
+ *
+ * @public
+ */
+export type BusinessNameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.LlcClassificationCode` component.
+ *
+ * @public
+ */
+export type LlcClassificationCodeFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, string>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.OtherText` component.
+ *
+ * @public
+ */
+export type OtherTextFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.ForeignPartners` component.
+ *
+ * @public
+ */
+export type ForeignPartnersFieldProps = HookFieldProps<CheckboxHookFieldProps>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.ExemptPayeeCode` component.
+ *
+ * @public
+ */
+export type ExemptPayeeCodeFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.ExemptionFromFatca` component.
+ *
+ * @public
+ */
+export type ExemptionFromFatcaFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.HomeAddressStreet2` component.
+ *
+ * @public
+ */
+export type HomeAddressStreet2FieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.AccountNumber` component.
+ *
+ * @public
+ */
+export type AccountNumberFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Props accepted by {@link useContractorSignatureForm}'s `Fields.CompanyName` component.
+ *
+ * @public
+ */
+export type CompanyNameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/** @internal */
+export declare function NameField(props: NameFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function TaxClassificationField(props: TaxClassificationFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function HomeAddressStreet1Field(props: HomeAddressStreet1FieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function HomeAddressCityField(props: HomeAddressCityFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function HomeAddressStateField(props: HomeAddressStateFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function HomeAddressZipField(props: HomeAddressZipFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function SsnField(props: SsnFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function EinField(props: EinFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function SignatureTextField(props: SignatureTextFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function AgreeField(props: AgreeFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function BusinessNameField(props: BusinessNameFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function LlcClassificationCodeField(props: LlcClassificationCodeFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function OtherTextField(props: OtherTextFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function ForeignPartnersField(props: ForeignPartnersFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function ExemptPayeeCodeField(props: ExemptPayeeCodeFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function ExemptionFromFatcaField(props: ExemptionFromFatcaFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function HomeAddressStreet2Field(props: HomeAddressStreet2FieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function AccountNumberField(props: AccountNumberFieldProps): import("react").JSX.Element;
+/** @internal */
+export declare function CompanyNameField(props: CompanyNameFieldProps): import("react").JSX.Element;
+/**
+ * Field components exposed by {@link useContractorSignatureForm} on `form.Fields`.
+ *
+ * @remarks
+ * Every field is presence-gated against the API response and is `undefined`
+ * when the document didn't return its backing field — always null-check before
+ * rendering. This guards against the document API diverging (dropping or
+ * renaming a field) by skipping fields it no longer returns, mirroring the
+ * stable signing flow. `Agree` is the sole exception: it's a synthesized
+ * electronic-signature consent checkbox with no API field, so it's always
+ * present.
+ *
+ * @public
+ */
+export interface ContractorSignatureFormFieldComponents {
+    /** Entity or individual name; defined only when the API returns `name`. */
+    Name: ComponentType<NameFieldProps> | undefined;
+    /** Federal tax classification radio group; defined only when the document carries classification checkboxes. */
+    TaxClassification: ComponentType<TaxClassificationFieldProps> | undefined;
+    /** Street address line 1; defined only when the API returns `home_address_street_1`. */
+    HomeAddressStreet1: ComponentType<HomeAddressStreet1FieldProps> | undefined;
+    /** City; defined only when the API returns `home_address_city`. */
+    HomeAddressCity: ComponentType<HomeAddressCityFieldProps> | undefined;
+    /** State; defined only when the API returns `home_address_state`. */
+    HomeAddressState: ComponentType<HomeAddressStateFieldProps> | undefined;
+    /** ZIP code; defined only when the API returns `home_address_zip`. */
+    HomeAddressZip: ComponentType<HomeAddressZipFieldProps> | undefined;
+    /** Social Security Number; defined only when the API returns `ssn`. */
+    Ssn: ComponentType<SsnFieldProps> | undefined;
+    /** Employer Identification Number; defined only when the API returns `ein`. */
+    Ein: ComponentType<EinFieldProps> | undefined;
+    /** Typed signature; defined only when the API returns `signature_text`. */
+    SignatureText: ComponentType<SignatureTextFieldProps> | undefined;
+    /** Electronic-signature consent checkbox; always present (synthesized, not an API field). */
+    Agree: ComponentType<AgreeFieldProps>;
+    /** Business name; defined only when the API returns `business_name`. */
+    BusinessName: ComponentType<BusinessNameFieldProps> | undefined;
+    /** LLC tax classification code select; defined only when classification checkboxes are present. */
+    LlcClassificationCode: ComponentType<LlcClassificationCodeFieldProps> | undefined;
+    /** "Other" free-text classification; defined only when the API returns `other_text`. */
+    OtherText: ComponentType<OtherTextFieldProps> | undefined;
+    /** Foreign partners checkbox; defined only when the API returns `foreign_partners`. */
+    ForeignPartners: ComponentType<ForeignPartnersFieldProps> | undefined;
+    /** Exempt payee code; defined only when the API returns `exempt_payee_code`. */
+    ExemptPayeeCode: ComponentType<ExemptPayeeCodeFieldProps> | undefined;
+    /** FATCA exemption code; defined only when the API returns `exemption_from_FATCA`. */
+    ExemptionFromFatca: ComponentType<ExemptionFromFatcaFieldProps> | undefined;
+    /** Street address line 2; defined only when the API returns `home_address_street_2`. */
+    HomeAddressStreet2: ComponentType<HomeAddressStreet2FieldProps> | undefined;
+    /** Account number(s); defined only when the API returns `account_number`. */
+    AccountNumber: ComponentType<AccountNumberFieldProps> | undefined;
+    /** Requester's name and address; defined only when the API returns `company_name`. */
+    CompanyName: ComponentType<CompanyNameFieldProps> | undefined;
+}