@gusto/embedded-react-sdk 0.50.0 → 0.51.0

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;
+}

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

@@ -0,0 +1,85 @@
+import { jsx as n } from "react/jsx-runtime";
+import { normalizeEinOrNotApplicable as i, normalizeSsnOrNotApplicable as o } from "./w9Fields.js";
+import { TextInputHookField as r } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { CheckboxHookField as t } from "../../../../../partner-hook-utils/form/fields/CheckboxHookField.js";
+import { SelectHookField as m } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
+import { RadioGroupHookField as a } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
+function F(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "name" });
+}
+function p(e) {
+  return /* @__PURE__ */ n(a, { ...e, name: "taxClassification" });
+}
+function x(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "homeAddressStreet1" });
+}
+function A(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "homeAddressCity" });
+}
+function C(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "homeAddressState" });
+}
+function S(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "homeAddressZip" });
+}
+function H(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "ssn", transform: o });
+}
+function N(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "ein", transform: i });
+}
+function h(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "signatureText" });
+}
+function b(e) {
+  return /* @__PURE__ */ n(t, { ...e, name: "agree" });
+}
+function g(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "businessName" });
+}
+function y(e) {
+  return /* @__PURE__ */ n(m, { ...e, name: "llcClassificationCode" });
+}
+function T(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "otherText" });
+}
+function k(e) {
+  return /* @__PURE__ */ n(t, { ...e, name: "foreignPartners" });
+}
+function E(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "exemptPayeeCode" });
+}
+function P(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "exemptionFromFatca" });
+}
+function O(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "homeAddressStreet2" });
+}
+function z(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "accountNumber" });
+}
+function Z(e) {
+  return /* @__PURE__ */ n(r, { ...e, name: "companyName" });
+}
+export {
+  z as AccountNumberField,
+  b as AgreeField,
+  g as BusinessNameField,
+  Z as CompanyNameField,
+  N as EinField,
+  E as ExemptPayeeCodeField,
+  P as ExemptionFromFatcaField,
+  k as ForeignPartnersField,
+  A as HomeAddressCityField,
+  C as HomeAddressStateField,
+  x as HomeAddressStreet1Field,
+  O as HomeAddressStreet2Field,
+  S as HomeAddressZipField,
+  y as LlcClassificationCodeField,
+  F as NameField,
+  T as OtherTextField,
+  h as SignatureTextField,
+  H as SsnField,
+  p as TaxClassificationField
+};
+//# sourceMappingURL=fields.js.map