@gusto/embedded-react-sdk 0.47.0 → 0.48.0

package/dist/components/Employee/Compensation/shared/useJobForm/fields.d.ts

@@ -6,14 +6,115 @@ import { SelectHookFieldProps } from '../../../../../partner-hook-utils/form/fie
 import { DatePickerHookFieldProps } from '../../../../../partner-hook-utils/form/fields/DatePickerHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
 import { WARiskClassCode } from '../../../../../models/WA_RISK_CODES';
+/**
+ * The validation error code a {@link useJobForm} field can produce.
+ *
+ * @remarks
+ * Currently a single literal — `'REQUIRED'` — surfaced as the key in
+ * `validationMessages` on each `Fields.*` component. Future schema additions
+ * may extend the union.
+ *
+ * @public
+ */
 export type JobRequiredValidation = typeof JobErrorCodes.REQUIRED;
+/**
+ * Props accepted by {@link useJobForm}'s `Fields.Title` component.
+ *
+ * @public
+ */
 export type JobTitleFieldProps = HookFieldProps<TextInputHookFieldProps<JobRequiredValidation>>;
+/**
+ * Text input bound to the `title` field of {@link useJobForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Title` when `withTitleField` is
+ * `true` (the default). On update flows where another form owns the title
+ * (e.g. compensation edits), set `withTitleField: false` on `useJobForm` and
+ * render the compensation form's title field instead.
+ *
+ * @param props - {@link JobTitleFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `title`.
+ * @public
+ */
 export declare function JobTitleField(props: JobTitleFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useJobForm}'s `Fields.HireDate` component.
+ *
+ * @public
+ */
 export type HireDateFieldProps = HookFieldProps<DatePickerHookFieldProps<JobRequiredValidation>>;
+/**
+ * Date picker bound to the `hireDate` field of {@link useJobForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.HireDate` when
+ * `withHireDateField` is `true` (the default). When `false`, supply the value
+ * via `JobSubmitOptions.hireDate` at submit time — useful when the hire date
+ * is derived from external context (e.g. the employee's `startDate` during
+ * onboarding).
+ *
+ * @param props - {@link HireDateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered date picker bound to `hireDate`.
+ * @public
+ */
 export declare function HireDateField(props: HireDateFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useJobForm}'s `Fields.TwoPercentShareholder` component.
+ *
+ * @public
+ */
 export type TwoPercentShareholderFieldProps = HookFieldProps<CheckboxHookFieldProps>;
+/**
+ * Checkbox bound to the `twoPercentShareholder` field of {@link useJobForm}.
+ *
+ * @remarks
+ * Indicates whether the employee is a 2% shareholder in an S-Corporation.
+ * Available on the hook result as `form.Fields.TwoPercentShareholder` only
+ * when the company is taxable as an S-Corp (see `data.showTwoPercentShareholder`).
+ *
+ * @param props - {@link TwoPercentShareholderFieldProps} — accepts the standard hook field props (label, description, FieldComponent override).
+ * @returns The rendered checkbox bound to `twoPercentShareholder`.
+ * @public
+ */
 export declare function TwoPercentShareholderField(props: TwoPercentShareholderFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useJobForm}'s `Fields.StateWcCovered` component.
+ *
+ * @public
+ */
 export type StateWcCoveredFieldProps = HookFieldProps<RadioGroupHookFieldProps<never, boolean>>;
+/**
+ * Radio group bound to the `stateWcCovered` field of {@link useJobForm}.
+ *
+ * @remarks
+ * Captures whether the employee is covered by Washington state workers'
+ * compensation. Available on the hook result as `form.Fields.StateWcCovered`
+ * only when the employee's active work address is in Washington (see
+ * `data.showStateWc`).
+ *
+ * @param props - {@link StateWcCoveredFieldProps} — accepts the standard hook field props (label, description, getOptionLabel, FieldComponent override).
+ * @returns The rendered radio group bound to `stateWcCovered`.
+ * @public
+ */
 export declare function StateWcCoveredField(props: StateWcCoveredFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useJobForm}'s `Fields.StateWcClassCode` component.
+ *
+ * @public
+ */
 export type StateWcClassCodeFieldProps = HookFieldProps<SelectHookFieldProps<JobRequiredValidation, WARiskClassCode>>;
+/**
+ * Select dropdown bound to the `stateWcClassCode` field of {@link useJobForm}.
+ *
+ * @remarks
+ * Populated with Washington state workers' compensation risk class codes.
+ * Available on the hook result as `form.Fields.StateWcClassCode` only when
+ * the active work address is in Washington and `stateWcCovered` is `true`.
+ * The schema enforces this field as required whenever it is rendered,
+ * independent of `optionalFieldsToRequire`.
+ *
+ * @param props - {@link StateWcClassCodeFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered select bound to `stateWcClassCode`.
+ * @public
+ */
 export declare function StateWcClassCodeField(props: StateWcClassCodeFieldProps): import("react").JSX.Element;

package/dist/components/Employee/Compensation/shared/useJobForm/fields.js

@@ -1,23 +1,23 @@
 import { jsx as o } from "react/jsx-runtime";
-import { SelectHookField as t } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
-import { RadioGroupHookField as r } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
-import { CheckboxHookField as i } from "../../../../../partner-hook-utils/form/fields/CheckboxHookField.js";
-import { DatePickerHookField as n } from "../../../../../partner-hook-utils/form/fields/DatePickerHookField.js";
-import { TextInputHookField as a } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { DatePickerHookField as t } from "../../../../../partner-hook-utils/form/fields/DatePickerHookField.js";
+import { TextInputHookField as r } from "../../../../../partner-hook-utils/form/fields/TextInputHookField.js";
+import { SelectHookField as i } from "../../../../../partner-hook-utils/form/fields/SelectHookField.js";
+import { RadioGroupHookField as n } from "../../../../../partner-hook-utils/form/fields/RadioGroupHookField.js";
+import { CheckboxHookField as a } from "../../../../../partner-hook-utils/form/fields/CheckboxHookField.js";
 function F(e) {
-  return /* @__PURE__ */ o(a, { ...e, name: "title" });
+  return /* @__PURE__ */ o(r, { ...e, name: "title" });
 }
 function p(e) {
-  return /* @__PURE__ */ o(n, { ...e, name: "hireDate" });
+  return /* @__PURE__ */ o(t, { ...e, name: "hireDate" });
 }
 function k(e) {
-  return /* @__PURE__ */ o(i, { ...e, name: "twoPercentShareholder" });
+  return /* @__PURE__ */ o(a, { ...e, name: "twoPercentShareholder" });
 }
 function s(e) {
-  return /* @__PURE__ */ o(r, { ...e, name: "stateWcCovered" });
+  return /* @__PURE__ */ o(n, { ...e, name: "stateWcCovered" });
 }
 function C(e) {
-  return /* @__PURE__ */ o(t, { ...e, name: "stateWcClassCode" });
+  return /* @__PURE__ */ o(i, { ...e, name: "stateWcClassCode" });
 }
 export {
   p as HireDateField,

package/dist/components/Employee/Compensation/shared/useJobForm/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useJobForm/fields.tsx"],"sourcesContent":["import type { JobErrorCodes } from './jobSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport {\n  TextInputHookField,\n  CheckboxHookField,\n  RadioGroupHookField,\n  SelectHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\nimport type { WARiskClassCode } from '@/models/WA_RISK_CODES'\n\nexport type JobRequiredValidation = typeof JobErrorCodes.REQUIRED\n\nexport type JobTitleFieldProps = HookFieldProps<TextInputHookFieldProps<JobRequiredValidation>>\n\nexport function JobTitleField(props: JobTitleFieldProps) {\n  return <TextInputHookField {...props} name=\"title\" />\n}\n\nexport type HireDateFieldProps = HookFieldProps<DatePickerHookFieldProps<JobRequiredValidation>>\n\nexport function HireDateField(props: HireDateFieldProps) {\n  return <DatePickerHookField {...props} name=\"hireDate\" />\n}\n\nexport type TwoPercentShareholderFieldProps = HookFieldProps<CheckboxHookFieldProps>\n\nexport function TwoPercentShareholderField(props: TwoPercentShareholderFieldProps) {\n  return <CheckboxHookField {...props} name=\"twoPercentShareholder\" />\n}\n\nexport type StateWcCoveredFieldProps = HookFieldProps<RadioGroupHookFieldProps<never, boolean>>\n\nexport function StateWcCoveredField(props: StateWcCoveredFieldProps) {\n  return <RadioGroupHookField {...props} name=\"stateWcCovered\" />\n}\n\nexport type StateWcClassCodeFieldProps = HookFieldProps<\n  SelectHookFieldProps<JobRequiredValidation, WARiskClassCode>\n>\n\nexport function StateWcClassCodeField(props: StateWcClassCodeFieldProps) {\n  return <SelectHookField {...props} name=\"stateWcClassCode\" />\n}\n"],"names":["JobTitleField","props","jsx","TextInputHookField","HireDateField","DatePickerHookField","TwoPercentShareholderField","CheckboxHookField","StateWcCoveredField","RadioGroupHookField","StateWcClassCodeField","SelectHookField"],"mappings":";;;;;;AAoBO,SAASA,EAAcC,GAA2B;AACvD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,SAAQ;AACrD;AAIO,SAASG,EAAcH,GAA2B;AACvD,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,YAAW;AACzD;AAIO,SAASK,EAA2BL,GAAwC;AACjF,SAAO,gBAAAC,EAACK,GAAA,EAAmB,GAAGN,GAAO,MAAK,yBAAwB;AACpE;AAIO,SAASO,EAAoBP,GAAiC;AACnE,SAAO,gBAAAC,EAACO,GAAA,EAAqB,GAAGR,GAAO,MAAK,kBAAiB;AAC/D;AAMO,SAASS,EAAsBT,GAAmC;AACvE,SAAO,gBAAAC,EAACS,GAAA,EAAiB,GAAGV,GAAO,MAAK,oBAAmB;AAC7D;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useJobForm/fields.tsx"],"sourcesContent":["import type { JobErrorCodes } from './jobSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport type { RadioGroupHookFieldProps } from '@/partner-hook-utils/form/fields/RadioGroupHookField'\nimport type { SelectHookFieldProps } from '@/partner-hook-utils/form/fields/SelectHookField'\nimport type { DatePickerHookFieldProps } from '@/partner-hook-utils/form/fields/DatePickerHookField'\nimport {\n  TextInputHookField,\n  CheckboxHookField,\n  RadioGroupHookField,\n  SelectHookField,\n  DatePickerHookField,\n} from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\nimport type { WARiskClassCode } from '@/models/WA_RISK_CODES'\n\n/**\n * The validation error code a {@link useJobForm} field can produce.\n *\n * @remarks\n * Currently a single literal — `'REQUIRED'` — surfaced as the key in\n * `validationMessages` on each `Fields.*` component. Future schema additions\n * may extend the union.\n *\n * @public\n */\nexport type JobRequiredValidation = typeof JobErrorCodes.REQUIRED\n\n/**\n * Props accepted by {@link useJobForm}'s `Fields.Title` component.\n *\n * @public\n */\nexport type JobTitleFieldProps = HookFieldProps<TextInputHookFieldProps<JobRequiredValidation>>\n\n/**\n * Text input bound to the `title` field of {@link useJobForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Title` when `withTitleField` is\n * `true` (the default). On update flows where another form owns the title\n * (e.g. compensation edits), set `withTitleField: false` on `useJobForm` and\n * render the compensation form's title field instead.\n *\n * @param props - {@link JobTitleFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `title`.\n * @public\n */\nexport function JobTitleField(props: JobTitleFieldProps) {\n  return <TextInputHookField {...props} name=\"title\" />\n}\n\n/**\n * Props accepted by {@link useJobForm}'s `Fields.HireDate` component.\n *\n * @public\n */\nexport type HireDateFieldProps = HookFieldProps<DatePickerHookFieldProps<JobRequiredValidation>>\n\n/**\n * Date picker bound to the `hireDate` field of {@link useJobForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.HireDate` when\n * `withHireDateField` is `true` (the default). When `false`, supply the value\n * via `JobSubmitOptions.hireDate` at submit time — useful when the hire date\n * is derived from external context (e.g. the employee's `startDate` during\n * onboarding).\n *\n * @param props - {@link HireDateFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered date picker bound to `hireDate`.\n * @public\n */\nexport function HireDateField(props: HireDateFieldProps) {\n  return <DatePickerHookField {...props} name=\"hireDate\" />\n}\n\n/**\n * Props accepted by {@link useJobForm}'s `Fields.TwoPercentShareholder` component.\n *\n * @public\n */\nexport type TwoPercentShareholderFieldProps = HookFieldProps<CheckboxHookFieldProps>\n\n/**\n * Checkbox bound to the `twoPercentShareholder` field of {@link useJobForm}.\n *\n * @remarks\n * Indicates whether the employee is a 2% shareholder in an S-Corporation.\n * Available on the hook result as `form.Fields.TwoPercentShareholder` only\n * when the company is taxable as an S-Corp (see `data.showTwoPercentShareholder`).\n *\n * @param props - {@link TwoPercentShareholderFieldProps} — accepts the standard hook field props (label, description, FieldComponent override).\n * @returns The rendered checkbox bound to `twoPercentShareholder`.\n * @public\n */\nexport function TwoPercentShareholderField(props: TwoPercentShareholderFieldProps) {\n  return <CheckboxHookField {...props} name=\"twoPercentShareholder\" />\n}\n\n/**\n * Props accepted by {@link useJobForm}'s `Fields.StateWcCovered` component.\n *\n * @public\n */\nexport type StateWcCoveredFieldProps = HookFieldProps<RadioGroupHookFieldProps<never, boolean>>\n\n/**\n * Radio group bound to the `stateWcCovered` field of {@link useJobForm}.\n *\n * @remarks\n * Captures whether the employee is covered by Washington state workers'\n * compensation. Available on the hook result as `form.Fields.StateWcCovered`\n * only when the employee's active work address is in Washington (see\n * `data.showStateWc`).\n *\n * @param props - {@link StateWcCoveredFieldProps} — accepts the standard hook field props (label, description, getOptionLabel, FieldComponent override).\n * @returns The rendered radio group bound to `stateWcCovered`.\n * @public\n */\nexport function StateWcCoveredField(props: StateWcCoveredFieldProps) {\n  return <RadioGroupHookField {...props} name=\"stateWcCovered\" />\n}\n\n/**\n * Props accepted by {@link useJobForm}'s `Fields.StateWcClassCode` component.\n *\n * @public\n */\nexport type StateWcClassCodeFieldProps = HookFieldProps<\n  SelectHookFieldProps<JobRequiredValidation, WARiskClassCode>\n>\n\n/**\n * Select dropdown bound to the `stateWcClassCode` field of {@link useJobForm}.\n *\n * @remarks\n * Populated with Washington state workers' compensation risk class codes.\n * Available on the hook result as `form.Fields.StateWcClassCode` only when\n * the active work address is in Washington and `stateWcCovered` is `true`.\n * The schema enforces this field as required whenever it is rendered,\n * independent of `optionalFieldsToRequire`.\n *\n * @param props - {@link StateWcClassCodeFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered select bound to `stateWcClassCode`.\n * @public\n */\nexport function StateWcClassCodeField(props: StateWcClassCodeFieldProps) {\n  return <SelectHookField {...props} name=\"stateWcClassCode\" />\n}\n"],"names":["JobTitleField","props","jsx","TextInputHookField","HireDateField","DatePickerHookField","TwoPercentShareholderField","CheckboxHookField","StateWcCoveredField","RadioGroupHookField","StateWcClassCodeField","SelectHookField"],"mappings":";;;;;;AAgDO,SAASA,EAAcC,GAA2B;AACvD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,SAAQ;AACrD;AAuBO,SAASG,EAAcH,GAA2B;AACvD,SAAO,gBAAAC,EAACG,GAAA,EAAqB,GAAGJ,GAAO,MAAK,YAAW;AACzD;AAqBO,SAASK,EAA2BL,GAAwC;AACjF,SAAO,gBAAAC,EAACK,GAAA,EAAmB,GAAGN,GAAO,MAAK,yBAAwB;AACpE;AAsBO,SAASO,EAAoBP,GAAiC;AACnE,SAAO,gBAAAC,EAACO,GAAA,EAAqB,GAAGR,GAAO,MAAK,kBAAiB;AAC/D;AAyBO,SAASS,EAAsBT,GAAmC;AACvE,SAAO,gBAAAC,EAACS,GAAA,EAAiB,GAAGV,GAAO,MAAK,oBAAmB;AAC7D;"}

package/dist/components/Employee/Compensation/shared/useJobForm/index.d.ts

@@ -2,4 +2,5 @@ import "./types/i18next.d.ts"
 export { useJobForm } from './useJobForm';
 export type { JobSubmitOptions, UseJobFormProps, UseJobFormResult, UseJobFormReady, JobFieldsMetadata, JobFormFields, } from './useJobForm';
 export { createJobSchema, JobErrorCodes, type JobErrorCode, type JobOptionalFieldsToRequire, type JobFormData, type JobFormOutputs, } from './jobSchema';
+export { JobTitleField, HireDateField, TwoPercentShareholderField, StateWcCoveredField, StateWcClassCodeField, } from './fields';
 export type { JobRequiredValidation, JobTitleFieldProps, HireDateFieldProps, TwoPercentShareholderFieldProps, StateWcCoveredFieldProps, StateWcClassCodeFieldProps, } from './fields';

package/dist/components/Employee/Compensation/shared/useJobForm/jobSchema.d.ts

@@ -1,8 +1,32 @@
 import { z } from 'zod';
 import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes produced by the {@link useJobForm} 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
+ *
+ * @example
+ * ```tsx
+ * import { JobErrorCodes } from '@gusto/embedded-react-sdk'
+ *
+ * <Fields.Title
+ *   label="Job title"
+ *   validationMessages={{ [JobErrorCodes.REQUIRED]: 'Job title is required' }}
+ * />
+ * ```
+ */
 export declare const JobErrorCodes: {
     readonly REQUIRED: "REQUIRED";
 };
+/**
+ * Union of every error code produced by the {@link useJobForm} schema.
+ *
+ * @public
+ */
 export type JobErrorCode = (typeof JobErrorCodes)[keyof typeof JobErrorCodes];
 declare const fieldValidators: {
     title: z.ZodString;
@@ -11,9 +35,30 @@ declare const fieldValidators: {
     stateWcCovered: z.ZodPipe<z.ZodTransform<boolean | undefined, unknown>, z.ZodBoolean>;
     stateWcClassCode: z.ZodString;
 };
+/**
+ * Shape of the form values managed by {@link useJobForm}.
+ *
+ * @remarks
+ * Accepted as `defaultValues` on `useJobForm` and returned by
+ * `form.getFormSubmissionValues()` once the form has validated. `hireDate` is
+ * an ISO date string (`YYYY-MM-DD`) or `null`; `stateWcCovered` is a boolean
+ * even though the radio group surfaces `'true'` / `'false'` strings during
+ * input (the schema preprocessor coerces them).
+ *
+ * @public
+ */
 export type JobFormData = {
     [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
 };
+/**
+ * Validated submission shape produced by the {@link useJobForm} schema.
+ *
+ * @remarks
+ * Identical to {@link JobFormData} — exposed as a separate alias so the input
+ * vs. output sides of the schema remain distinguishable in advanced usages.
+ *
+ * @public
+ */
 export type JobFormOutputs = JobFormData;
 declare const requiredFieldsConfig: {
     title: "create";
@@ -28,6 +73,35 @@ declare const requiredFieldsConfig: {
         stateWcClassCode: string;
     }) => boolean;
 };
+/**
+ * Override which fields are required on a given submission mode of {@link useJobForm}.
+ *
+ * @remarks
+ * Each mode key lists the fields that are optional by default for that mode
+ * but should be promoted to required. `stateWcClassCode` is automatically
+ * required when `stateWcCovered` is `true` and is not configurable here.
+ *
+ * | Field | Required on create | Required on update | Configurable? |
+ * | ----- | ------------------ | ------------------ | ------------- |
+ * | `title` | Yes | No | Yes (on update) |
+ * | `hireDate` | Yes | No | Yes (on update) |
+ * | `twoPercentShareholder` | No | No | Yes (either mode) |
+ * | `stateWcCovered` | No | No | Yes (either mode) |
+ * | `stateWcClassCode` | When WC is covered | When WC is covered | No (auto) |
+ *
+ * @public
+ *
+ * @example
+ * ```tsx
+ * const job = useJobForm({
+ *   employeeId,
+ *   jobId,
+ *   optionalFieldsToRequire: {
+ *     update: ['title', 'hireDate'],
+ *   },
+ * })
+ * ```
+ */
 export type JobOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
 interface JobSchemaOptions {
     mode?: 'create' | 'update';
@@ -49,6 +123,7 @@ interface JobSchemaOptions {
      */
     withTitleField?: boolean;
 }
+/** @internal */
 export declare function createJobSchema(options?: JobSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
     title: z.ZodString;
     hireDate: z.ZodPipe<z.ZodTransform<string | null, unknown>, z.ZodNullable<z.ZodISODate>>;

package/dist/components/Employee/Compensation/shared/useJobForm/jobSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"jobSchema.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useJobForm/jobSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { coerceToISODate, coerceStringBoolean } from '@/partner-hook-utils/form/preprocessors'\n\nexport const JobErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\nexport type JobErrorCode = (typeof JobErrorCodes)[keyof typeof JobErrorCodes]\n\nconst fieldValidators = {\n  title: z.string(),\n  hireDate: z.preprocess(coerceToISODate, z.iso.date().nullable()),\n  twoPercentShareholder: z.boolean(),\n  // Radio group delivers 'true'/'false' strings; coerceStringBoolean converts to boolean.\n  stateWcCovered: z.preprocess(coerceStringBoolean, z.boolean()),\n  stateWcClassCode: z.string(),\n}\n\nexport type JobFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\nexport type JobFormOutputs = JobFormData\n\nconst requiredFieldsConfig = {\n  title: 'create',\n  hireDate: 'create',\n  twoPercentShareholder: 'never',\n  stateWcCovered: 'never',\n  // stateWcClassCode is gated by stateWcCovered === true. The predicate also\n  // depends implicitly on the work-address state being WA — partners enforce\n  // that gate by passing `optionalFieldsToRequire` only for WA employees, or\n  // by simply never sending stateWcCovered=true outside WA.\n  stateWcClassCode: data => String(data.stateWcCovered) === 'true',\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\nexport type JobOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>\n\ninterface JobSchemaOptions {\n  mode?: 'create' | 'update'\n  optionalFieldsToRequire?: JobOptionalFieldsToRequire\n  /**\n   * When `false`, drops `hireDate` from the validated shape entirely — the\n   * field becomes hook-managed rather than user-facing (e.g. an onboarding\n   * screen that derives hireDate from the employee's `startDate`). Partners\n   * supply the value at submit time via `JobSubmitOptions.hireDate`.\n   * Defaults to `true`.\n   */\n  withHireDateField?: boolean\n  /**\n   * When `false`, drops `title` from the validated shape entirely and the\n   * hook stops sending it on PUT `/v1/jobs/:id`. Use this when title is\n   * being driven via the compensation form instead (steady-state edits,\n   * where title is effective-dated alongside rate/unit/FLSA on a future\n   * compensation row). Defaults to `true`.\n   */\n  withTitleField?: boolean\n}\n\nexport function createJobSchema(options: JobSchemaOptions = {}) {\n  const {\n    mode = 'create',\n    optionalFieldsToRequire,\n    withHireDateField = true,\n    withTitleField = true,\n  } = options\n\n  const excludeFields: Array<keyof typeof fieldValidators> = []\n  if (!withHireDateField) excludeFields.push('hireDate')\n  if (!withTitleField) excludeFields.push('title')\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: JobErrorCodes.REQUIRED,\n    mode,\n    optionalFieldsToRequire,\n    excludeFields,\n  })\n}\n"],"names":["JobErrorCodes","fieldValidators","z","coerceToISODate","coerceStringBoolean","requiredFieldsConfig","data","createJobSchema","options","mode","optionalFieldsToRequire","withHireDateField","withTitleField","excludeFields","buildFormSchema"],"mappings":";;;AAQO,MAAMA,IAAgB;AAAA,EAC3B,UAAU;AACZ,GAIMC,IAAkB;AAAA,EACtB,OAAOC,EAAE,OAAA;AAAA,EACT,UAAUA,EAAE,WAAWC,GAAiBD,EAAE,IAAI,OAAO,UAAU;AAAA,EAC/D,uBAAuBA,EAAE,QAAA;AAAA;AAAA,EAEzB,gBAAgBA,EAAE,WAAWE,GAAqBF,EAAE,SAAS;AAAA,EAC7D,kBAAkBA,EAAE,OAAA;AACtB,GAOMG,IAAuB;AAAA,EAC3B,OAAO;AAAA,EACP,UAAU;AAAA,EACV,uBAAuB;AAAA,EACvB,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA,EAKhB,kBAAkB,CAAAC,MAAQ,OAAOA,EAAK,cAAc,MAAM;AAC5D;AAyBO,SAASC,EAAgBC,IAA4B,IAAI;AAC9D,QAAM;AAAA,IACJ,MAAAC,IAAO;AAAA,IACP,yBAAAC;AAAA,IACA,mBAAAC,IAAoB;AAAA,IACpB,gBAAAC,IAAiB;AAAA,EAAA,IACfJ,GAEEK,IAAqD,CAAA;AAC3D,SAAKF,KAAmBE,EAAc,KAAK,UAAU,GAChDD,KAAgBC,EAAc,KAAK,OAAO,GAExCC,EAAgBb,GAAiB;AAAA,IACtC,sBAAAI;AAAA,IACA,mBAAmBL,EAAc;AAAA,IACjC,MAAAS;AAAA,IACA,yBAAAC;AAAA,IACA,eAAAG;AAAA,EAAA,CACD;AACH;"}
+{"version":3,"file":"jobSchema.js","sources":["../../../../../../src/components/Employee/Compensation/shared/useJobForm/jobSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\nimport { coerceToISODate, coerceStringBoolean } from '@/partner-hook-utils/form/preprocessors'\n\n/**\n * Validation error codes produced by the {@link useJobForm} schema.\n *\n * @remarks\n * Use these constants as the keys in a field's `validationMessages` prop to\n * map an error code to a user-facing message.\n *\n * @public\n *\n * @example\n * ```tsx\n * import { JobErrorCodes } from '@gusto/embedded-react-sdk'\n *\n * <Fields.Title\n *   label=\"Job title\"\n *   validationMessages={{ [JobErrorCodes.REQUIRED]: 'Job title is required' }}\n * />\n * ```\n */\nexport const JobErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\n/**\n * Union of every error code produced by the {@link useJobForm} schema.\n *\n * @public\n */\nexport type JobErrorCode = (typeof JobErrorCodes)[keyof typeof JobErrorCodes]\n\nconst fieldValidators = {\n  title: z.string(),\n  hireDate: z.preprocess(coerceToISODate, z.iso.date().nullable()),\n  twoPercentShareholder: z.boolean(),\n  // Radio group delivers 'true'/'false' strings; coerceStringBoolean converts to boolean.\n  stateWcCovered: z.preprocess(coerceStringBoolean, z.boolean()),\n  stateWcClassCode: z.string(),\n}\n\n/**\n * Shape of the form values managed by {@link useJobForm}.\n *\n * @remarks\n * Accepted as `defaultValues` on `useJobForm` and returned by\n * `form.getFormSubmissionValues()` once the form has validated. `hireDate` is\n * an ISO date string (`YYYY-MM-DD`) or `null`; `stateWcCovered` is a boolean\n * even though the radio group surfaces `'true'` / `'false'` strings during\n * input (the schema preprocessor coerces them).\n *\n * @public\n */\nexport type JobFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n\n/**\n * Validated submission shape produced by the {@link useJobForm} schema.\n *\n * @remarks\n * Identical to {@link JobFormData} — exposed as a separate alias so the input\n * vs. output sides of the schema remain distinguishable in advanced usages.\n *\n * @public\n */\nexport type JobFormOutputs = JobFormData\n\nconst requiredFieldsConfig = {\n  title: 'create',\n  hireDate: 'create',\n  twoPercentShareholder: 'never',\n  stateWcCovered: 'never',\n  // stateWcClassCode is gated by stateWcCovered === true. The predicate also\n  // depends implicitly on the work-address state being WA — partners enforce\n  // that gate by passing `optionalFieldsToRequire` only for WA employees, or\n  // by simply never sending stateWcCovered=true outside WA.\n  stateWcClassCode: data => String(data.stateWcCovered) === 'true',\n} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n/**\n * Override which fields are required on a given submission mode of {@link useJobForm}.\n *\n * @remarks\n * Each mode key lists the fields that are optional by default for that mode\n * but should be promoted to required. `stateWcClassCode` is automatically\n * required when `stateWcCovered` is `true` and is not configurable here.\n *\n * | Field | Required on create | Required on update | Configurable? |\n * | ----- | ------------------ | ------------------ | ------------- |\n * | `title` | Yes | No | Yes (on update) |\n * | `hireDate` | Yes | No | Yes (on update) |\n * | `twoPercentShareholder` | No | No | Yes (either mode) |\n * | `stateWcCovered` | No | No | Yes (either mode) |\n * | `stateWcClassCode` | When WC is covered | When WC is covered | No (auto) |\n *\n * @public\n *\n * @example\n * ```tsx\n * const job = useJobForm({\n *   employeeId,\n *   jobId,\n *   optionalFieldsToRequire: {\n *     update: ['title', 'hireDate'],\n *   },\n * })\n * ```\n */\nexport type JobOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>\n\ninterface JobSchemaOptions {\n  mode?: 'create' | 'update'\n  optionalFieldsToRequire?: JobOptionalFieldsToRequire\n  /**\n   * When `false`, drops `hireDate` from the validated shape entirely — the\n   * field becomes hook-managed rather than user-facing (e.g. an onboarding\n   * screen that derives hireDate from the employee's `startDate`). Partners\n   * supply the value at submit time via `JobSubmitOptions.hireDate`.\n   * Defaults to `true`.\n   */\n  withHireDateField?: boolean\n  /**\n   * When `false`, drops `title` from the validated shape entirely and the\n   * hook stops sending it on PUT `/v1/jobs/:id`. Use this when title is\n   * being driven via the compensation form instead (steady-state edits,\n   * where title is effective-dated alongside rate/unit/FLSA on a future\n   * compensation row). Defaults to `true`.\n   */\n  withTitleField?: boolean\n}\n\n/** @internal */\nexport function createJobSchema(options: JobSchemaOptions = {}) {\n  const {\n    mode = 'create',\n    optionalFieldsToRequire,\n    withHireDateField = true,\n    withTitleField = true,\n  } = options\n\n  const excludeFields: Array<keyof typeof fieldValidators> = []\n  if (!withHireDateField) excludeFields.push('hireDate')\n  if (!withTitleField) excludeFields.push('title')\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: JobErrorCodes.REQUIRED,\n    mode,\n    optionalFieldsToRequire,\n    excludeFields,\n  })\n}\n"],"names":["JobErrorCodes","fieldValidators","z","coerceToISODate","coerceStringBoolean","requiredFieldsConfig","data","createJobSchema","options","mode","optionalFieldsToRequire","withHireDateField","withTitleField","excludeFields","buildFormSchema"],"mappings":";;;AA2BO,MAAMA,IAAgB;AAAA,EAC3B,UAAU;AACZ,GASMC,IAAkB;AAAA,EACtB,OAAOC,EAAE,OAAA;AAAA,EACT,UAAUA,EAAE,WAAWC,GAAiBD,EAAE,IAAI,OAAO,UAAU;AAAA,EAC/D,uBAAuBA,EAAE,QAAA;AAAA;AAAA,EAEzB,gBAAgBA,EAAE,WAAWE,GAAqBF,EAAE,SAAS;AAAA,EAC7D,kBAAkBA,EAAE,OAAA;AACtB,GA6BMG,IAAuB;AAAA,EAC3B,OAAO;AAAA,EACP,UAAU;AAAA,EACV,uBAAuB;AAAA,EACvB,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA,EAKhB,kBAAkB,CAAAC,MAAQ,OAAOA,EAAK,cAAc,MAAM;AAC5D;AAuDO,SAASC,EAAgBC,IAA4B,IAAI;AAC9D,QAAM;AAAA,IACJ,MAAAC,IAAO;AAAA,IACP,yBAAAC;AAAA,IACA,mBAAAC,IAAoB;AAAA,IACpB,gBAAAC,IAAiB;AAAA,EAAA,IACfJ,GAEEK,IAAqD,CAAA;AAC3D,SAAKF,KAAmBE,EAAc,KAAK,UAAU,GAChDD,KAAgBC,EAAc,KAAK,OAAO,GAExCC,EAAgBb,GAAiB;AAAA,IACtC,sBAAAI;AAAA,IACA,mBAAmBL,EAAc;AAAA,IACjC,MAAAS;AAAA,IACA,yBAAAC;AAAA,IACA,eAAAG;AAAA,EAAA,CACD;AACH;"}

package/dist/components/Employee/Compensation/shared/useJobForm/useJobForm.d.ts

@@ -5,6 +5,17 @@ import { EmployeeWorkAddress } from '@gusto/embedded-api-v-2025-11-15/models/com
 import { JobOptionalFieldsToRequire, JobFormData } from './jobSchema';
 import { JobTitleField, HireDateField, TwoPercentShareholderField, StateWcCoveredField, StateWcClassCodeField } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Optional values supplied to {@link useJobForm}'s `actions.onSubmit` at submit time.
+ *
+ * @remarks
+ * Use these when a value isn't sourced from a rendered field — typically
+ * because the hook was configured with `withHireDateField: false`, or because
+ * the employee being saved was created in the same submit chain and the
+ * `employeeId` wasn't known at hook construction.
+ *
+ * @public
+ */
 export interface JobSubmitOptions {
     /** Override the `employeeId` configured at hook construction. Useful when the employee is created in the same submit chain. */
     employeeId?: string;
@@ -13,24 +24,40 @@ export interface JobSubmitOptions {
      * with `withHireDateField: false` for screens that derive hireDate from
      * external context (e.g. the employee's `startDate` during onboarding).
      * Falls back to the loaded job's `hireDate` on update mode when omitted;
-     * required (or sourced from a partner default) on create mode.
+     * required (or sourced from a default) on create mode.
      */
     hireDate?: string;
 }
+/**
+ * Configuration options for {@link useJobForm}.
+ *
+ * @remarks
+ * Presence or absence of `jobId` selects the API verb — see the `jobId` field
+ * description. `employeeId` is optional so the hook can be composed alongside
+ * an employee-creation step; supply it at submit time via
+ * {@link JobSubmitOptions.employeeId} in that case.
+ *
+ * @public
+ */
 export interface UseJobFormProps {
+    /** UUID of the employee whose job is being created or edited. May be omitted when the employee is created in the same submit chain — supply the value via {@link JobSubmitOptions.employeeId} at submit time. */
     employeeId?: string;
     /** Present → update mode (PUT /v1/jobs/:id with `version`). Omitted → create mode (POST /v1/employees/:id/jobs). */
     jobId?: string;
+    /** Override fields that are optional on a given mode to be required. See {@link JobOptionalFieldsToRequire}. */
     optionalFieldsToRequire?: JobOptionalFieldsToRequire;
+    /** Pre-fill form values. Server data takes precedence on update mode. */
     defaultValues?: Partial<JobFormData>;
+    /** Passed through to react-hook-form. Defaults to `'onSubmit'`. */
     validationMode?: UseFormProps['mode'];
+    /** Auto-focus the first invalid field on submit. Set to `false` when using `composeSubmitHandler` so submit-time focus is coordinated across multiple forms. Defaults to `true`. */
     shouldFocusError?: boolean;
     /**
      * When `false`, hides `Fields.HireDate` (becomes `undefined`) and removes
-     * `hireDate` from schema validation. Partners supply the value via
-     * `JobSubmitOptions.hireDate` at submit time, or rely on the loaded job's
-     * existing value on update. Use this when the date is driven by external
-     * context rather than user input (e.g. the employee's `startDate`).
+     * `hireDate` from schema validation. Supply the value via
+     * {@link JobSubmitOptions.hireDate} at submit time, or rely on the loaded
+     * job's existing value on update. Use this when the date is driven by
+     * external context rather than user input (e.g. the employee's `startDate`).
      * Defaults to `true`.
      */
     withHireDateField?: boolean;
@@ -46,39 +73,141 @@ export interface UseJobFormProps {
      */
     withTitleField?: boolean;
 }
+/**
+ * Pre-bound field components exposed on `useJobForm().form.Fields`.
+ *
+ * @remarks
+ * Each property is either the field component or `undefined`. A field is
+ * `undefined` when conditions for rendering it aren't met — see each member
+ * for its visibility rule. Always null-check conditional fields (e.g.
+ * `{Fields.TwoPercentShareholder && <Fields.TwoPercentShareholder ... />}`)
+ * before rendering.
+ *
+ * @public
+ */
 export interface JobFormFields {
+    /** Job title text input. `undefined` when `withTitleField: false`. */
     Title: typeof JobTitleField | undefined;
+    /** Hire date picker. `undefined` when `withHireDateField: false`. */
     HireDate: typeof HireDateField | undefined;
+    /** S-Corp 2% shareholder checkbox. `undefined` when the company is not taxable as an S-Corp (see `data.showTwoPercentShareholder`). */
     TwoPercentShareholder: typeof TwoPercentShareholderField | undefined;
+    /** Washington state workers' compensation coverage radio group. `undefined` when the active work address is not in Washington (see `data.showStateWc`). */
     StateWcCovered: typeof StateWcCoveredField | undefined;
+    /** Washington state workers' compensation risk class code select. `undefined` when the active work address is not in Washington or when `stateWcCovered` is `false`. */
     StateWcClassCode: typeof StateWcClassCodeField | undefined;
 }
+/**
+ * Ready-state shape returned by {@link useJobForm} once data has loaded.
+ *
+ * @remarks
+ * Discriminated by `isLoading: false`. Extends
+ * {@link BaseFormHookReady} with the job-specific `data`, `status`,
+ * `actions`, and `form.Fields` shape.
+ *
+ * @public
+ */
 export interface UseJobFormReady extends BaseFormHookReady<FieldsMetadata, JobFormData, JobFormFields> {
+    /** Job-specific data payload: the loaded job (if any), the employee's other jobs, the employee record, the active work address, and presentation flags for conditional fields. */
     data: {
         /** The job row loaded for update; `null` in create mode. */
         currentJob: Job | null;
         /** All jobs for the employee, when employeeId is set. Useful for screen-level cross-checks across jobs. */
         jobs: Job[] | undefined;
+        /** The loaded employee record, or `null` when `employeeId` was omitted. */
         employee: Employee | null;
+        /** The employee's active work address, or `null` when none is set. */
         currentWorkAddress: EmployeeWorkAddress | null;
-        /** True when the company is taxable as an S-Corp; partners use this to decide whether to render `TwoPercentShareholder`. */
+        /** True when the company is taxable as an S-Corp; use this to decide whether to render `TwoPercentShareholder`. */
         showTwoPercentShareholder: boolean;
         /**
-         * True when the active work-address state is WA; partners use this to decide whether to render
+         * True when the active work-address state is WA; use this to decide whether to render
          * `StateWcCovered`. `Fields.StateWcClassCode` is additionally gated on `stateWcCovered === true`,
-         * so partners typically only need to check `Fields.StateWcCovered` / `Fields.StateWcClassCode`
+         * so most callers only need to check `Fields.StateWcCovered` / `Fields.StateWcClassCode`
          * truthiness rather than this flag directly.
          */
         showStateWc: boolean;
     };
+    /** Submission state. `isPending` is `true` while any in-flight mutation (including the secondary-compensation correction block) hasn't settled. `mode` reflects whether the next submit will create or update. */
     status: {
         isPending: boolean;
         mode: 'create' | 'update';
     };
+    /** Submit actions exposed by the hook. */
     actions: {
+        /** Validates the form, runs the appropriate create/update mutation, and resolves to a {@link HookSubmitResult} containing the saved job. Resolves to `undefined` on validation failure or mutation error. */
         onSubmit: (options?: JobSubmitOptions) => Promise<HookSubmitResult<Job> | undefined>;
     };
 }
+/**
+ * Headless hook for creating or updating an employee's job — title, hire date, S-Corp 2% shareholder flag, and Washington state workers' compensation fields.
+ *
+ * @remarks
+ * Companion hook to `useCompensationForm`. Jobs and their compensations are
+ * separate entities in the Gusto API and this hook focuses exclusively on
+ * the job side. Presence of `jobId` selects the verb:
+ *
+ * | Hook config | Mode | API call |
+ * | ----------- | ---- | -------- |
+ * | `{ employeeId, jobId }` | update | `PUT /v1/jobs/:jobId` (with `version`) |
+ * | `{ employeeId }` (no `jobId`) | create | `POST /v1/employees/:employeeId/jobs` |
+ * | `{}` + submit `employeeId` | create | `POST /v1/employees/:options.employeeId/jobs` |
+ *
+ * Creating a job auto-creates a stub compensation. To update the stub in the
+ * same flow, capture `currentCompensationUuid` (and the compensation's
+ * `version` from `compensations[]`) from the create response and thread them
+ * into `useCompensationForm.actions.onSubmit({ jobId, compensationId, compensationVersion })`.
+ *
+ * When the primary job's `hireDate` changes, secondary compensation effective
+ * dates are corrected after the PUT; `isPending` stays `true` through that.
+ *
+ * @param input - {@link UseJobFormProps} — `employeeId`, `jobId` (toggle create/update), and configuration for required-field overrides, default values, and which fields the hook renders.
+ * @returns A {@link HookLoadingResult} while data is loading, or a {@link UseJobFormReady} once ready.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useJobForm, SDKFormProvider } from '@gusto/embedded-react-sdk'
+ *
+ * function JobForm({ employeeId }: { employeeId: string }) {
+ *   const job = useJobForm({ employeeId })
+ *   if (job.isLoading) return null
+ *
+ *   const { Fields } = job.form
+ *   return (
+ *     <form onSubmit={e => { e.preventDefault(); job.actions.onSubmit() }}>
+ *       <SDKFormProvider formHookResult={job}>
+ *         {Fields.Title && <Fields.Title label="Job title" />}
+ *         {Fields.HireDate && <Fields.HireDate label="Hire date" />}
+ *         {Fields.TwoPercentShareholder && (
+ *           <Fields.TwoPercentShareholder label="2% S-Corp shareholder" />
+ *         )}
+ *       </SDKFormProvider>
+ *       <button type="submit" disabled={job.status.isPending}>Save</button>
+ *     </form>
+ *   )
+ * }
+ * ```
+ */
 export declare function useJobForm({ employeeId, jobId, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, withHireDateField, withTitleField, }: UseJobFormProps): HookLoadingResult | UseJobFormReady;
+/**
+ * Discriminated union returned by {@link useJobForm}.
+ *
+ * @remarks
+ * Branch on `isLoading` to narrow to either {@link HookLoadingResult} or
+ * {@link UseJobFormReady}.
+ *
+ * @public
+ */
 export type UseJobFormResult = HookLoadingResult | UseJobFormReady;
+/**
+ * Shape of the per-field metadata exposed at `useJobForm().form.fieldsMetadata`.
+ *
+ * @remarks
+ * Maps each field name in {@link JobFormData} to its presentation metadata —
+ * including the registered `name`, whether the field is required or disabled,
+ * and (for select-like fields) the option list.
+ *
+ * @public
+ */
 export type JobFieldsMetadata = UseJobFormReady['form']['fieldsMetadata'];