@gusto/embedded-react-sdk 0.48.3 → 0.50.0

package/dist/components/Contractor/Profile/shared/useContractorDetailsForm/fields.d.ts

@@ -0,0 +1,312 @@
+import { ContractorDetailsErrorCodes, ContractorDetailsFormData } from './contractorDetailsSchema';
+import { TextInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/TextInputHookField';
+import { NumberInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/NumberInputHookField';
+import { DatePickerHookFieldProps } from '../../../../../partner-hook-utils/form/fields/DatePickerHookField';
+import { SwitchHookFieldProps } from '../../../../../partner-hook-utils/form/fields/SwitchHookField';
+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';
+/**
+ * Error code emitted by fields of {@link useContractorDetailsForm} that only
+ * produce `REQUIRED`.
+ *
+ * @public
+ */
+export type RequiredValidation = typeof ContractorDetailsErrorCodes.REQUIRED;
+/**
+ * Validation error codes emitted by the name fields of {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type NameValidation = (typeof ContractorDetailsErrorCodes)['REQUIRED' | 'INVALID_NAME'];
+/**
+ * Validation error codes emitted by the `email` field of {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type EmailValidation = (typeof ContractorDetailsErrorCodes)['REQUIRED' | 'INVALID_EMAIL'];
+/**
+ * Format-validation error code emitted by the `ssn` field of {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type SsnValidation = typeof ContractorDetailsErrorCodes.INVALID_SSN;
+/**
+ * Required-field error code emitted by the `ssn` field of {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type SsnRequiredValidation = typeof ContractorDetailsErrorCodes.REQUIRED;
+/**
+ * Format-validation error code emitted by the `ein` field of {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type EinValidation = typeof ContractorDetailsErrorCodes.INVALID_EIN;
+/**
+ * Required-field error code emitted by the `ein` field of {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type EinRequiredValidation = typeof ContractorDetailsErrorCodes.REQUIRED;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.Type` component.
+ *
+ * @public
+ */
+export type TypeFieldProps = HookFieldProps<RadioGroupHookFieldProps<never, ContractorDetailsFormData['type']>>;
+/**
+ * Radio group bound to the `type` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Selects whether the contractor is an `Individual` or a `Business`. Provide
+ * `getOptionLabel` to localize the option labels.
+ *
+ * @param props - {@link TypeFieldProps}.
+ * @returns The rendered radio group bound to `type`.
+ * @public
+ */
+export declare function TypeField(props: TypeFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.WageType` component.
+ *
+ * @public
+ */
+export type WageTypeFieldProps = HookFieldProps<RadioGroupHookFieldProps<never, ContractorDetailsFormData['wageType']>>;
+/**
+ * Radio group bound to the `wageType` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Selects whether the contractor is paid `Fixed` or `Hourly`. Provide
+ * `getOptionLabel` to localize the option labels.
+ *
+ * @param props - {@link WageTypeFieldProps}.
+ * @returns The rendered radio group bound to `wageType`.
+ * @public
+ */
+export declare function WageTypeField(props: WageTypeFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.StartDate` component.
+ *
+ * @public
+ */
+export type StartDateFieldProps = HookFieldProps<DatePickerHookFieldProps<RequiredValidation>>;
+/**
+ * Date picker bound to the `startDate` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Required on create; can be made required on update via
+ * `optionalFieldsToRequire`.
+ *
+ * @param props - {@link StartDateFieldProps}.
+ * @returns The rendered date picker bound to `startDate`.
+ * @public
+ */
+export declare function StartDateField(props: StartDateFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.HourlyRate` component.
+ *
+ * @public
+ */
+export type HourlyRateFieldProps = HookFieldProps<NumberInputHookFieldProps<RequiredValidation>>;
+/**
+ * Number input bound to the `hourlyRate` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.HourlyRate` only when
+ * `wageType` is `Hourly`, in which case it is required.
+ *
+ * @param props - {@link HourlyRateFieldProps}.
+ * @returns The rendered number input bound to `hourlyRate`.
+ * @public
+ */
+export declare function HourlyRateField(props: HourlyRateFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.SelfOnboarding` component.
+ *
+ * @public
+ */
+export type SelfOnboardingFieldProps = HookFieldProps<SwitchHookFieldProps>;
+/**
+ * Switch bound to the `selfOnboarding` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.SelfOnboarding` only when the
+ * field is toggleable (create mode, or an onboarding status that still allows
+ * inviting the contractor). Always null-check before rendering. When enabled,
+ * the contractor is invited to enter their own details and SSN/EIN are no
+ * longer collected by the admin.
+ *
+ * @param props - {@link SelfOnboardingFieldProps}.
+ * @returns The rendered switch bound to `selfOnboarding`.
+ * @public
+ */
+export declare function SelfOnboardingField(props: SelfOnboardingFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.FileNewHireReport` component.
+ *
+ * @public
+ */
+export type FileNewHireReportFieldProps = HookFieldProps<SwitchHookFieldProps>;
+/**
+ * Switch bound to the `fileNewHireReport` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.FileNewHireReport` only for
+ * individual contractors. When enabled, a work state must be supplied so the
+ * new-hire report can be filed.
+ *
+ * @param props - {@link FileNewHireReportFieldProps}.
+ * @returns The rendered switch bound to `fileNewHireReport`.
+ * @public
+ */
+export declare function FileNewHireReportField(props: FileNewHireReportFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.Email` component.
+ *
+ * @public
+ */
+export type EmailFieldProps = HookFieldProps<TextInputHookFieldProps<EmailValidation>>;
+/**
+ * Text input bound to the `email` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Email` only when
+ * self-onboarding is enabled, in which case it is required (reported via the
+ * `REQUIRED` code).
+ *
+ * @param props - {@link EmailFieldProps}.
+ * @returns The rendered text input bound to `email`.
+ * @public
+ */
+export declare function EmailField(props: EmailFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.FirstName` component.
+ *
+ * @public
+ */
+export type FirstNameFieldProps = HookFieldProps<TextInputHookFieldProps<NameValidation>>;
+/**
+ * Text input bound to the `firstName` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.FirstName` for individual
+ * contractors, in which case it is required.
+ *
+ * @param props - {@link FirstNameFieldProps}.
+ * @returns The rendered text input bound to `firstName`.
+ * @public
+ */
+export declare function FirstNameField(props: FirstNameFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.LastName` component.
+ *
+ * @public
+ */
+export type LastNameFieldProps = HookFieldProps<TextInputHookFieldProps<NameValidation>>;
+/**
+ * Text input bound to the `lastName` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.LastName` for individual
+ * contractors, in which case it is required.
+ *
+ * @param props - {@link LastNameFieldProps}.
+ * @returns The rendered text input bound to `lastName`.
+ * @public
+ */
+export declare function LastNameField(props: LastNameFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.MiddleInitial` component.
+ *
+ * @public
+ */
+export type MiddleInitialFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `middleInitial` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.MiddleInitial` for individual
+ * contractors. Always optional.
+ *
+ * @param props - {@link MiddleInitialFieldProps}.
+ * @returns The rendered text input bound to `middleInitial`.
+ * @public
+ */
+export declare function MiddleInitialField(props: MiddleInitialFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.BusinessName` component.
+ *
+ * @public
+ */
+export type BusinessNameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `businessName` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.BusinessName` for business
+ * contractors, in which case it is required.
+ *
+ * @param props - {@link BusinessNameFieldProps}.
+ * @returns The rendered text input bound to `businessName`.
+ * @public
+ */
+export declare function BusinessNameField(props: BusinessNameFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.Ssn` component.
+ *
+ * @public
+ */
+export type SsnFieldProps = HookFieldProps<TextInputHookFieldProps<SsnValidation, SsnRequiredValidation>>;
+/**
+ * Text input bound to the `ssn` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Ssn` for individual contractors.
+ * Auto-formats input with dashes (`XXX-XX-XXXX`). When the contractor already
+ * has an SSN on file, the field shows a masked placeholder and the required
+ * rule is waived.
+ *
+ * @param props - {@link SsnFieldProps}.
+ * @returns The rendered text input bound to `ssn`.
+ * @public
+ */
+export declare function SsnField(props: SsnFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.Ein` component.
+ *
+ * @public
+ */
+export type EinFieldProps = HookFieldProps<TextInputHookFieldProps<EinValidation, EinRequiredValidation>>;
+/**
+ * Text input bound to the `ein` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Ein` for business contractors.
+ * Auto-formats input as `XX-XXXXXXX`. When the contractor already has an EIN on
+ * file, the field shows a masked placeholder and the required rule is waived.
+ *
+ * @param props - {@link EinFieldProps}.
+ * @returns The rendered text input bound to `ein`.
+ * @public
+ */
+export declare function EinField(props: EinFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useContractorDetailsForm}'s `Fields.WorkState` component.
+ *
+ * @public
+ */
+export type WorkStateFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, string>>;
+/**
+ * Select bound to the `workState` field of {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.WorkState` for individual
+ * contractors when `fileNewHireReport` is enabled, in which case it is
+ * required.
+ *
+ * @param props - {@link WorkStateFieldProps}.
+ * @returns The rendered select bound to `workState`.
+ * @public
+ */
+export declare function WorkStateField(props: WorkStateFieldProps): import("react").JSX.Element;

package/dist/components/Contractor/Profile/shared/useContractorDetailsForm/fields.js

@@ -0,0 +1,87 @@
+import { jsx as t } from "react/jsx-runtime";
+import { TextInputHookField as n } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { SelectHookField as d } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
+import { NumberInputHookField as u } from "../../../../../partner-hook-utils/form/fields/NumberInputHookField.js";
+import { DatePickerHookField as f } from "../../../../../partner-hook-utils/form/fields/DatePickerHookField.js";
+import { RadioGroupHookField as i } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
+import { SwitchHookField as m } from "../../../../../partner-hook-utils/form/fields/SwitchHookField.js";
+import { useFormFieldsMetadataContext as l } from "../../../../../partner-hook-utils/form/FormFieldsMetadataContext.js";
+import { usePlaceholderSSN as s, normalizeSSN as c } from "../../../../../helpers/ssn.js";
+import { usePlaceholderEin as F, normalizeEin as p } from "../../../../../helpers/federalEin.js";
+function b(e) {
+  return /* @__PURE__ */ t(i, { ...e, name: "type" });
+}
+function g(e) {
+  return /* @__PURE__ */ t(i, { ...e, name: "wageType" });
+}
+function I(e) {
+  return /* @__PURE__ */ t(f, { ...e, name: "startDate" });
+}
+function M(e) {
+  return /* @__PURE__ */ t(u, { ...e, name: "hourlyRate" });
+}
+function T(e) {
+  return /* @__PURE__ */ t(m, { ...e, name: "selfOnboarding" });
+}
+function C(e) {
+  return /* @__PURE__ */ t(m, { ...e, name: "fileNewHireReport" });
+}
+function D(e) {
+  return /* @__PURE__ */ t(n, { ...e, name: "email" });
+}
+function P(e) {
+  return /* @__PURE__ */ t(n, { ...e, name: "firstName" });
+}
+function z(e) {
+  return /* @__PURE__ */ t(n, { ...e, name: "lastName" });
+}
+function O(e) {
+  return /* @__PURE__ */ t(n, { ...e, name: "middleInitial" });
+}
+function V(e) {
+  return /* @__PURE__ */ t(n, { ...e, name: "businessName" });
+}
+function W(e) {
+  const a = l(), o = e.formHookResult?.form.fieldsMetadata ?? a?.metadata ?? {}, r = s(o.ssn?.hasRedactedValue);
+  return /* @__PURE__ */ t(
+    n,
+    {
+      ...e,
+      name: "ssn",
+      transform: c,
+      placeholder: r
+    }
+  );
+}
+function j(e) {
+  const a = l(), o = e.formHookResult?.form.fieldsMetadata ?? a?.metadata ?? {}, r = F(o.ein?.hasRedactedValue);
+  return /* @__PURE__ */ t(
+    n,
+    {
+      ...e,
+      name: "ein",
+      transform: p,
+      placeholder: r
+    }
+  );
+}
+function B(e) {
+  return /* @__PURE__ */ t(d, { ...e, name: "workState" });
+}
+export {
+  V as BusinessNameField,
+  j as EinField,
+  D as EmailField,
+  C as FileNewHireReportField,
+  P as FirstNameField,
+  M as HourlyRateField,
+  z as LastNameField,
+  O as MiddleInitialField,
+  T as SelfOnboardingField,
+  W as SsnField,
+  I as StartDateField,
+  b as TypeField,
+  g as WageTypeField,
+  B as WorkStateField
+};
+//# sourceMappingURL=fields.js.map

package/dist/components/Contractor/Profile/shared/useContractorDetailsForm/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Contractor/Profile/shared/useContractorDetailsForm/fields.tsx"],"sourcesContent":["import type {\n  ContractorDetailsErrorCodes,\n  ContractorDetailsFormData,\n} from './contractorDetailsSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { NumberInputHookFieldProps } from '@/partner-hook-utils/form/fields/NumberInputHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport type { SwitchHookFieldProps } from '@/partner-hook-utils/form/fields/SwitchHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport {\n  TextInputHookField,\n  NumberInputHookField,\n  DatePickerHookField,\n  SwitchHookField,\n  RadioGroupHookField,\n  SelectHookField,\n} from '@/partner-hook-utils/form/fields'\nimport { useFormFieldsMetadataContext } from '@/partner-hook-utils/form/FormFieldsMetadataContext'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\nimport { normalizeSSN, usePlaceholderSSN } from '@/helpers/ssn'\nimport { normalizeEin, usePlaceholderEin } from '@/helpers/federalEin'\n\n/**\n * Error code emitted by fields of {@link useContractorDetailsForm} that only\n * produce `REQUIRED`.\n *\n * @public\n */\nexport type RequiredValidation = typeof ContractorDetailsErrorCodes.REQUIRED\n\n/**\n * Validation error codes emitted by the name fields of {@link useContractorDetailsForm}.\n *\n * @public\n */\nexport type NameValidation = (typeof ContractorDetailsErrorCodes)['REQUIRED' | 'INVALID_NAME']\n\n/**\n * Validation error codes emitted by the `email` field of {@link useContractorDetailsForm}.\n *\n * @public\n */\nexport type EmailValidation = (typeof ContractorDetailsErrorCodes)['REQUIRED' | 'INVALID_EMAIL']\n\n/**\n * Format-validation error code emitted by the `ssn` field of {@link useContractorDetailsForm}.\n *\n * @public\n */\nexport type SsnValidation = typeof ContractorDetailsErrorCodes.INVALID_SSN\n\n/**\n * Required-field error code emitted by the `ssn` field of {@link useContractorDetailsForm}.\n *\n * @public\n */\nexport type SsnRequiredValidation = typeof ContractorDetailsErrorCodes.REQUIRED\n\n/**\n * Format-validation error code emitted by the `ein` field of {@link useContractorDetailsForm}.\n *\n * @public\n */\nexport type EinValidation = typeof ContractorDetailsErrorCodes.INVALID_EIN\n\n/**\n * Required-field error code emitted by the `ein` field of {@link useContractorDetailsForm}.\n *\n * @public\n */\nexport type EinRequiredValidation = typeof ContractorDetailsErrorCodes.REQUIRED\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.Type` component.\n *\n * @public\n */\nexport type TypeFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<never, ContractorDetailsFormData['type']>\n>\n\n/**\n * Radio group bound to the `type` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Selects whether the contractor is an `Individual` or a `Business`. Provide\n * `getOptionLabel` to localize the option labels.\n *\n * @param props - {@link TypeFieldProps}.\n * @returns The rendered radio group bound to `type`.\n * @public\n */\nexport function TypeField(props: TypeFieldProps) {\n  return <RadioGroupHookField {...props} name=\"type\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.WageType` component.\n *\n * @public\n */\nexport type WageTypeFieldProps = HookFieldProps<\n  RadioGroupHookFieldProps<never, ContractorDetailsFormData['wageType']>\n>\n\n/**\n * Radio group bound to the `wageType` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Selects whether the contractor is paid `Fixed` or `Hourly`. Provide\n * `getOptionLabel` to localize the option labels.\n *\n * @param props - {@link WageTypeFieldProps}.\n * @returns The rendered radio group bound to `wageType`.\n * @public\n */\nexport function WageTypeField(props: WageTypeFieldProps) {\n  return <RadioGroupHookField {...props} name=\"wageType\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.StartDate` component.\n *\n * @public\n */\nexport type StartDateFieldProps = HookFieldProps<DatePickerHookFieldProps<RequiredValidation>>\n\n/**\n * Date picker bound to the `startDate` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Required on create; can be made required on update via\n * `optionalFieldsToRequire`.\n *\n * @param props - {@link StartDateFieldProps}.\n * @returns The rendered date picker bound to `startDate`.\n * @public\n */\nexport function StartDateField(props: StartDateFieldProps) {\n  return <DatePickerHookField {...props} name=\"startDate\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.HourlyRate` component.\n *\n * @public\n */\nexport type HourlyRateFieldProps = HookFieldProps<NumberInputHookFieldProps<RequiredValidation>>\n\n/**\n * Number input bound to the `hourlyRate` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.HourlyRate` only when\n * `wageType` is `Hourly`, in which case it is required.\n *\n * @param props - {@link HourlyRateFieldProps}.\n * @returns The rendered number input bound to `hourlyRate`.\n * @public\n */\nexport function HourlyRateField(props: HourlyRateFieldProps) {\n  return <NumberInputHookField {...props} name=\"hourlyRate\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.SelfOnboarding` component.\n *\n * @public\n */\nexport type SelfOnboardingFieldProps = HookFieldProps<SwitchHookFieldProps>\n\n/**\n * Switch bound to the `selfOnboarding` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.SelfOnboarding` only when the\n * field is toggleable (create mode, or an onboarding status that still allows\n * inviting the contractor). Always null-check before rendering. When enabled,\n * the contractor is invited to enter their own details and SSN/EIN are no\n * longer collected by the admin.\n *\n * @param props - {@link SelfOnboardingFieldProps}.\n * @returns The rendered switch bound to `selfOnboarding`.\n * @public\n */\nexport function SelfOnboardingField(props: SelfOnboardingFieldProps) {\n  return <SwitchHookField {...props} name=\"selfOnboarding\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.FileNewHireReport` component.\n *\n * @public\n */\nexport type FileNewHireReportFieldProps = HookFieldProps<SwitchHookFieldProps>\n\n/**\n * Switch bound to the `fileNewHireReport` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.FileNewHireReport` only for\n * individual contractors. When enabled, a work state must be supplied so the\n * new-hire report can be filed.\n *\n * @param props - {@link FileNewHireReportFieldProps}.\n * @returns The rendered switch bound to `fileNewHireReport`.\n * @public\n */\nexport function FileNewHireReportField(props: FileNewHireReportFieldProps) {\n  return <SwitchHookField {...props} name=\"fileNewHireReport\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.Email` component.\n *\n * @public\n */\nexport type EmailFieldProps = HookFieldProps<TextInputHookFieldProps<EmailValidation>>\n\n/**\n * Text input bound to the `email` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Email` only when\n * self-onboarding is enabled, in which case it is required (reported via the\n * `REQUIRED` code).\n *\n * @param props - {@link EmailFieldProps}.\n * @returns The rendered text input bound to `email`.\n * @public\n */\nexport function EmailField(props: EmailFieldProps) {\n  return <TextInputHookField {...props} name=\"email\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.FirstName` component.\n *\n * @public\n */\nexport type FirstNameFieldProps = HookFieldProps<TextInputHookFieldProps<NameValidation>>\n\n/**\n * Text input bound to the `firstName` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.FirstName` for individual\n * contractors, in which case it is required.\n *\n * @param props - {@link FirstNameFieldProps}.\n * @returns The rendered text input bound to `firstName`.\n * @public\n */\nexport function FirstNameField(props: FirstNameFieldProps) {\n  return <TextInputHookField {...props} name=\"firstName\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.LastName` component.\n *\n * @public\n */\nexport type LastNameFieldProps = HookFieldProps<TextInputHookFieldProps<NameValidation>>\n\n/**\n * Text input bound to the `lastName` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.LastName` for individual\n * contractors, in which case it is required.\n *\n * @param props - {@link LastNameFieldProps}.\n * @returns The rendered text input bound to `lastName`.\n * @public\n */\nexport function LastNameField(props: LastNameFieldProps) {\n  return <TextInputHookField {...props} name=\"lastName\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.MiddleInitial` component.\n *\n * @public\n */\nexport type MiddleInitialFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `middleInitial` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.MiddleInitial` for individual\n * contractors. Always optional.\n *\n * @param props - {@link MiddleInitialFieldProps}.\n * @returns The rendered text input bound to `middleInitial`.\n * @public\n */\nexport function MiddleInitialField(props: MiddleInitialFieldProps) {\n  return <TextInputHookField {...props} name=\"middleInitial\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.BusinessName` component.\n *\n * @public\n */\nexport type BusinessNameFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `businessName` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.BusinessName` for business\n * contractors, in which case it is required.\n *\n * @param props - {@link BusinessNameFieldProps}.\n * @returns The rendered text input bound to `businessName`.\n * @public\n */\nexport function BusinessNameField(props: BusinessNameFieldProps) {\n  return <TextInputHookField {...props} name=\"businessName\" />\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.Ssn` component.\n *\n * @public\n */\nexport type SsnFieldProps = HookFieldProps<\n  TextInputHookFieldProps<SsnValidation, SsnRequiredValidation>\n>\n\n/**\n * Text input bound to the `ssn` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Ssn` for individual contractors.\n * Auto-formats input with dashes (`XXX-XX-XXXX`). When the contractor already\n * has an SSN on file, the field shows a masked placeholder and the required\n * rule is waived.\n *\n * @param props - {@link SsnFieldProps}.\n * @returns The rendered text input bound to `ssn`.\n * @public\n */\nexport function SsnField(props: SsnFieldProps) {\n  const metadataContext = useFormFieldsMetadataContext()\n  const metadata = props.formHookResult?.form.fieldsMetadata ?? metadataContext?.metadata ?? {}\n  const placeholderSSN = usePlaceholderSSN(metadata.ssn?.hasRedactedValue)\n  return (\n    <TextInputHookField\n      {...props}\n      name=\"ssn\"\n      transform={normalizeSSN}\n      placeholder={placeholderSSN}\n    />\n  )\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.Ein` component.\n *\n * @public\n */\nexport type EinFieldProps = HookFieldProps<\n  TextInputHookFieldProps<EinValidation, EinRequiredValidation>\n>\n\n/**\n * Text input bound to the `ein` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Ein` for business contractors.\n * Auto-formats input as `XX-XXXXXXX`. When the contractor already has an EIN on\n * file, the field shows a masked placeholder and the required rule is waived.\n *\n * @param props - {@link EinFieldProps}.\n * @returns The rendered text input bound to `ein`.\n * @public\n */\nexport function EinField(props: EinFieldProps) {\n  const metadataContext = useFormFieldsMetadataContext()\n  const metadata = props.formHookResult?.form.fieldsMetadata ?? metadataContext?.metadata ?? {}\n  const placeholderEin = usePlaceholderEin(metadata.ein?.hasRedactedValue)\n  return (\n    <TextInputHookField\n      {...props}\n      name=\"ein\"\n      transform={normalizeEin}\n      placeholder={placeholderEin}\n    />\n  )\n}\n\n/**\n * Props accepted by {@link useContractorDetailsForm}'s `Fields.WorkState` component.\n *\n * @public\n */\nexport type WorkStateFieldProps = HookFieldProps<SelectHookFieldProps<RequiredValidation, string>>\n\n/**\n * Select bound to the `workState` field of {@link useContractorDetailsForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.WorkState` for individual\n * contractors when `fileNewHireReport` is enabled, in which case it is\n * required.\n *\n * @param props - {@link WorkStateFieldProps}.\n * @returns The rendered select bound to `workState`.\n * @public\n */\nexport function WorkStateField(props: WorkStateFieldProps) {\n  return <SelectHookField {...props} name=\"workState\" />\n}\n"],"names":["TypeField","props","jsx","RadioGroupHookField","WageTypeField","StartDateField","DatePickerHookField","HourlyRateField","NumberInputHookField","SelfOnboardingField","SwitchHookField","FileNewHireReportField","EmailField","TextInputHookField","FirstNameField","LastNameField","MiddleInitialField","BusinessNameField","SsnField","metadataContext","useFormFieldsMetadataContext","metadata","placeholderSSN","usePlaceholderSSN","normalizeSSN","EinField","placeholderEin","usePlaceholderEin","normalizeEin","WorkStateField","SelectHookField"],"mappings":";;;;;;;;;;AA6FO,SAASA,EAAUC,GAAuB;AAC/C,SAAO,gBAAAC,EAACC,GAAA,EAAqB,GAAGF,GAAO,MAAK,QAAO;AACrD;AAsBO,SAASG,EAAcH,GAA2B;AACvD,SAAO,gBAAAC,EAACC,GAAA,EAAqB,GAAGF,GAAO,MAAK,YAAW;AACzD;AAoBO,SAASI,EAAeJ,GAA4B;AACzD,SAAO,gBAAAC,EAACI,GAAA,EAAqB,GAAGL,GAAO,MAAK,aAAY;AAC1D;AAoBO,SAASM,EAAgBN,GAA6B;AAC3D,SAAO,gBAAAC,EAACM,GAAA,EAAsB,GAAGP,GAAO,MAAK,cAAa;AAC5D;AAuBO,SAASQ,EAAoBR,GAAiC;AACnE,SAAO,gBAAAC,EAACQ,GAAA,EAAiB,GAAGT,GAAO,MAAK,kBAAiB;AAC3D;AAqBO,SAASU,EAAuBV,GAAoC;AACzE,SAAO,gBAAAC,EAACQ,GAAA,EAAiB,GAAGT,GAAO,MAAK,qBAAoB;AAC9D;AAqBO,SAASW,EAAWX,GAAwB;AACjD,SAAO,gBAAAC,EAACW,GAAA,EAAoB,GAAGZ,GAAO,MAAK,SAAQ;AACrD;AAoBO,SAASa,EAAeb,GAA4B;AACzD,SAAO,gBAAAC,EAACW,GAAA,EAAoB,GAAGZ,GAAO,MAAK,aAAY;AACzD;AAoBO,SAASc,EAAcd,GAA2B;AACvD,SAAO,gBAAAC,EAACW,GAAA,EAAoB,GAAGZ,GAAO,MAAK,YAAW;AACxD;AAoBO,SAASe,EAAmBf,GAAgC;AACjE,SAAO,gBAAAC,EAACW,GAAA,EAAoB,GAAGZ,GAAO,MAAK,iBAAgB;AAC7D;AAoBO,SAASgB,EAAkBhB,GAA+B;AAC/D,SAAO,gBAAAC,EAACW,GAAA,EAAoB,GAAGZ,GAAO,MAAK,gBAAe;AAC5D;AAwBO,SAASiB,EAASjB,GAAsB;AAC7C,QAAMkB,IAAkBC,EAAA,GAClBC,IAAWpB,EAAM,gBAAgB,KAAK,kBAAkBkB,GAAiB,YAAY,CAAA,GACrFG,IAAiBC,EAAkBF,EAAS,KAAK,gBAAgB;AACvE,SACE,gBAAAnB;AAAA,IAACW;AAAA,IAAA;AAAA,MACE,GAAGZ;AAAA,MACJ,MAAK;AAAA,MACL,WAAWuB;AAAA,MACX,aAAaF;AAAA,IAAA;AAAA,EAAA;AAGnB;AAuBO,SAASG,EAASxB,GAAsB;AAC7C,QAAMkB,IAAkBC,EAAA,GAClBC,IAAWpB,EAAM,gBAAgB,KAAK,kBAAkBkB,GAAiB,YAAY,CAAA,GACrFO,IAAiBC,EAAkBN,EAAS,KAAK,gBAAgB;AACvE,SACE,gBAAAnB;AAAA,IAACW;AAAA,IAAA;AAAA,MACE,GAAGZ;AAAA,MACJ,MAAK;AAAA,MACL,WAAW2B;AAAA,MACX,aAAaF;AAAA,IAAA;AAAA,EAAA;AAGnB;AAqBO,SAASG,EAAe5B,GAA4B;AACzD,SAAO,gBAAAC,EAAC4B,GAAA,EAAiB,GAAG7B,GAAO,MAAK,aAAY;AACtD;"}

package/dist/components/Contractor/Profile/shared/useContractorDetailsForm/index.d.ts

@@ -0,0 +1,6 @@
+import "./types/i18next.d.ts"
+export { useContractorDetailsForm } from './useContractorDetailsForm';
+export type { ContractorDetailsSubmitOptions, ContractorDetailsOptionalFieldsToRequire, UseContractorDetailsFormSharedProps, UseContractorDetailsFormProps, UseContractorDetailsFormResult, UseContractorDetailsFormReady, ContractorDetailsFieldsMetadata, ContractorDetailsFormFields, ContractorDetailsFields, } from './useContractorDetailsForm';
+export { ContractorType, WageType, ContractorDetailsErrorCodes, createContractorDetailsSchema, type ContractorDetailsErrorCode, type ContractorDetailsFormData, type ContractorDetailsFormOutputs, } from './contractorDetailsSchema';
+export { TypeField, WageTypeField, StartDateField, HourlyRateField, SelfOnboardingField, FileNewHireReportField, EmailField, FirstNameField, LastNameField, MiddleInitialField, BusinessNameField, SsnField, EinField, WorkStateField, } from './fields';
+export type { RequiredValidation as ContractorDetailsRequiredValidation, NameValidation as ContractorDetailsNameValidation, EmailValidation as ContractorDetailsEmailValidation, SsnValidation as ContractorDetailsSsnValidation, SsnRequiredValidation as ContractorDetailsSsnRequiredValidation, EinValidation as ContractorDetailsEinValidation, EinRequiredValidation as ContractorDetailsEinRequiredValidation, TypeFieldProps, WageTypeFieldProps, StartDateFieldProps, HourlyRateFieldProps, SelfOnboardingFieldProps, FileNewHireReportFieldProps, EmailFieldProps, FirstNameFieldProps, LastNameFieldProps, MiddleInitialFieldProps, BusinessNameFieldProps, SsnFieldProps, EinFieldProps, WorkStateFieldProps, } from './fields';

package/dist/components/Contractor/Profile/shared/useContractorDetailsForm/useContractorDetailsForm.d.ts

@@ -0,0 +1,196 @@
+import { UseFormProps } from 'react-hook-form';
+import { Contractor } from '@gusto/embedded-api-v-2025-11-15/models/components/contractor';
+import { ContractorDetailsOptionalFieldsToRequire, ContractorDetailsFormData } from './contractorDetailsSchema';
+import { TypeField, WageTypeField, StartDateField, HourlyRateField, SelfOnboardingField, FileNewHireReportField, EmailField, FirstNameField, LastNameField, MiddleInitialField, BusinessNameField, SsnField, EinField, WorkStateField } from './fields';
+import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+export type { ContractorDetailsOptionalFieldsToRequire } from './contractorDetailsSchema';
+/**
+ * Optional overrides passed to {@link UseContractorDetailsFormReady.actions.onSubmit | onSubmit}.
+ *
+ * @public
+ */
+export interface ContractorDetailsSubmitOptions {
+    /** Override the company identifier supplied to the hook (e.g. after creating the company in the same flow). Only used in create mode. */
+    companyId?: string;
+}
+/**
+ * Shared options merged into both branches of {@link UseContractorDetailsFormProps}.
+ *
+ * @public
+ */
+export type UseContractorDetailsFormSharedProps = {
+    /** Whether to expose the self-onboarding toggle as `form.Fields.SelfOnboarding`. Defaults to `true`. */
+    withSelfOnboardingField?: boolean;
+    /** Fields that are optional by default but should be promoted to required for this form instance. */
+    optionalFieldsToRequire?: ContractorDetailsOptionalFieldsToRequire;
+    /** Initial values applied before any contractor data loads. */
+    defaultValues?: Partial<ContractorDetailsFormData>;
+    /** When validation runs. Forwarded to react-hook-form's `mode`. Defaults to `'onSubmit'`. */
+    validationMode?: UseFormProps['mode'];
+    /** Whether react-hook-form should focus the first error on validation failure. Defaults to `true`. */
+    shouldFocusError?: boolean;
+};
+/**
+ * Options for {@link useContractorDetailsForm}.
+ *
+ * @remarks
+ * Discriminated by mode: in create mode supply `companyId` and omit
+ * `contractorId`; in update mode supply `contractorId` (and optionally
+ * `companyId`).
+ *
+ * @public
+ */
+export type UseContractorDetailsFormProps = (UseContractorDetailsFormSharedProps & {
+    companyId: string;
+    contractorId?: never;
+}) | (UseContractorDetailsFormSharedProps & {
+    contractorId: string;
+    companyId?: string;
+});
+/**
+ * The Field components exposed by {@link useContractorDetailsForm} as `form.Fields`.
+ *
+ * @remarks
+ * Conditionally-visible fields are `undefined` when they do not apply to the
+ * current `type`, `wageType`, or self-onboarding selection. Always null-check
+ * before rendering.
+ *
+ * @public
+ */
+export interface ContractorDetailsFields {
+    /** Radio group bound to `type`. Always available. */
+    Type: typeof TypeField;
+    /** Radio group bound to `wageType`. Always available. */
+    WageType: typeof WageTypeField;
+    /** Date picker bound to `startDate`. Always available. */
+    StartDate: typeof StartDateField;
+    /** Number input bound to `hourlyRate`; available only when `wageType` is `Hourly`. */
+    HourlyRate: typeof HourlyRateField | undefined;
+    /** Switch bound to `selfOnboarding`; available only when toggleable. */
+    SelfOnboarding: typeof SelfOnboardingField | undefined;
+    /** Switch bound to `fileNewHireReport`; available only for individual contractors. */
+    FileNewHireReport: typeof FileNewHireReportField | undefined;
+    /** Text input bound to `email`; available only when self-onboarding is enabled. */
+    Email: typeof EmailField | undefined;
+    /** Text input bound to `firstName`; available only for individual contractors. */
+    FirstName: typeof FirstNameField | undefined;
+    /** Text input bound to `lastName`; available only for individual contractors. */
+    LastName: typeof LastNameField | undefined;
+    /** Text input bound to `middleInitial`; available only for individual contractors. */
+    MiddleInitial: typeof MiddleInitialField | undefined;
+    /** Text input bound to `businessName`; available only for business contractors. */
+    BusinessName: typeof BusinessNameField | undefined;
+    /** Text input bound to `ssn`; available only for individual contractors. */
+    Ssn: typeof SsnField | undefined;
+    /** Text input bound to `ein`; available only for business contractors. */
+    Ein: typeof EinField | undefined;
+    /** Select bound to `workState`; available only for individual contractors filing a new-hire report. */
+    WorkState: typeof WorkStateField | undefined;
+}
+/**
+ * The ready-state result returned by {@link useContractorDetailsForm} once data has loaded.
+ *
+ * @public
+ */
+export interface UseContractorDetailsFormReady extends BaseFormHookReady<FieldsMetadata, ContractorDetailsFormData, ContractorDetailsFields> {
+    /** The loaded contractor data, or `null` in create mode. */
+    data: {
+        /** The contractor being edited, or `null` in create mode. */
+        contractor: Contractor | null;
+    };
+    /** Submit status and form mode. */
+    status: {
+        /** `true` while the create or update mutation is in flight. */
+        isPending: boolean;
+        /** `'create'` when no `contractorId` was supplied, `'update'` otherwise. */
+        mode: 'create' | 'update';
+    };
+    /** Submit and related actions. */
+    actions: {
+        /** Validates the form and submits the changes. Returns the created or updated contractor, or `undefined` when validation fails. */
+        onSubmit: (options?: ContractorDetailsSubmitOptions) => Promise<HookSubmitResult<Contractor> | undefined>;
+    };
+}
+/**
+ * Headless hook for creating or updating a contractor's profile details —
+ * individual vs. business type, wage type, names, SSN/EIN, work state, and the
+ * self-onboarding preference.
+ *
+ * @remarks
+ * Returns a discriminated union: a loading variant while the contractor fetch
+ * resolves, and a ready variant exposing the form's data, pending status,
+ * submit action, error handling, and bound `Fields`. Field visibility is
+ * driven by the current `type` and `wageType` (self-onboarding only toggles the
+ * `Email` field); fields that do not apply are `undefined` on `form.Fields`.
+ * SSN/EIN are exposed by contractor type regardless of self-onboarding — each
+ * consumer decides whether to render them. Self-onboarding is only toggleable
+ * when the contractor's onboarding status allows it.
+ *
+ * @param input - See {@link UseContractorDetailsFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UseContractorDetailsFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import {
+ *   useContractorDetailsForm,
+ *   SDKFormProvider,
+ *   type UseContractorDetailsFormReady,
+ * } from '@gusto/embedded-react-sdk'
+ *
+ * function ContractorDetailsPage({
+ *   companyId,
+ *   contractorId,
+ * }: {
+ *   companyId: string
+ *   contractorId: string
+ * }) {
+ *   const contractorDetails = useContractorDetailsForm({ companyId, contractorId })
+ *
+ *   if (contractorDetails.isLoading) return <div>Loading...</div>
+ *
+ *   return <ContractorDetailsReady contractorDetails={contractorDetails} />
+ * }
+ *
+ * function ContractorDetailsReady({
+ *   contractorDetails,
+ * }: {
+ *   contractorDetails: UseContractorDetailsFormReady
+ * }) {
+ *   const { Fields } = contractorDetails.form
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={contractorDetails}>
+ *       <form onSubmit={e => { e.preventDefault(); void contractorDetails.actions.onSubmit() }}>
+ *         <Fields.Type label="Contractor type" />
+ *         <Fields.WageType label="Wage type" />
+ *         {Fields.FirstName && <Fields.FirstName label="First name" />}
+ *         {Fields.LastName && <Fields.LastName label="Last name" />}
+ *         {Fields.BusinessName && <Fields.BusinessName label="Business name" />}
+ *         <Fields.StartDate label="Start date" />
+ *         <button type="submit" disabled={contractorDetails.status.isPending}>Save</button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
+export declare function useContractorDetailsForm({ companyId, contractorId, withSelfOnboardingField, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseContractorDetailsFormProps): HookLoadingResult | UseContractorDetailsFormReady;
+/**
+ * Return type of {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type UseContractorDetailsFormResult = HookLoadingResult | UseContractorDetailsFormReady;
+/**
+ * Shape of `form.fieldsMetadata` returned by {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type ContractorDetailsFieldsMetadata = UseContractorDetailsFormReady['form']['fieldsMetadata'];
+/**
+ * Shape of `form.Fields` returned by {@link useContractorDetailsForm}.
+ *
+ * @public
+ */
+export type ContractorDetailsFormFields = UseContractorDetailsFormReady['form']['Fields'];