@gusto/embedded-react-sdk 0.48.3 → 0.49.0

package/dist/components/Contractor/Address/shared/useContractorAddressForm/useContractorAddressForm.js

@@ -0,0 +1,133 @@
+import { useMemo as b } from "react";
+import { useForm as P } from "react-hook-form";
+import { zodResolver as L } from "@hookform/resolvers/zod";
+import { useContractorsGet as Q } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorsGet";
+import { useContractorsGetAddress as R } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorsGetAddress";
+import { useContractorsUpdateAddressMutation as T } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorsUpdateAddress";
+import { createContractorAddressSchema as Z } from "./contractorAddressSchema.js";
+import { ZipField as x, StateField as I, CityField as K, Street2Field as _, Street1Field as j } from "./fields.js";
+import { useDeriveFieldsMetadata as q } from "../../../../../partner-hook-utils/form/useDeriveFieldsMetadata.js";
+import { useHookFormInternals as J } from "../../../../../partner-hook-utils/form/useHookFormInternals.js";
+import { createGetFormSubmissionValues as N } from "../../../../../partner-hook-utils/form/getFormSubmissionValues.js";
+import { withOptions as W } from "../../../../../partner-hook-utils/form/withOptions.js";
+import { composeErrorHandler as X } from "../../../../../partner-hook-utils/composeErrorHandler.js";
+import { useBaseSubmit as Y } from "../../../../Base/useBaseSubmit.js";
+import { SDKInternalError as F } from "../../../../../types/sdkError.js";
+import { STATES_ABBR as C } from "../../../../../shared/constants.js";
+function ft({
+  contractorId: r,
+  optionalFieldsToRequire: d,
+  defaultValues: e,
+  validationMode: v = "onSubmit",
+  shouldFocusError: h = !0
+}) {
+  const c = Q(
+    { contractorUuid: r },
+    { enabled: !!r }
+  ), m = R(
+    { contractorUuid: r },
+    { enabled: !!r }
+  ), n = c.data?.contractor, w = n?.type, t = m.data?.contractorAddress, [u, g] = b(
+    () => Z({ optionalFieldsToRequire: d }),
+    [d]
+  ), p = b(
+    () => ({
+      street1: t?.street1 ?? e?.street1 ?? "",
+      street2: t?.street2 ?? e?.street2 ?? "",
+      city: t?.city ?? e?.city ?? "",
+      state: t?.state ?? e?.state ?? "",
+      zip: t?.zip ?? e?.zip ?? ""
+    }),
+    [t, e]
+  ), i = P({
+    resolver: L(u),
+    mode: v,
+    shouldFocusError: h,
+    defaultValues: p,
+    values: p,
+    resetOptions: { keepDirtyValues: !0 }
+  }), l = T(), z = l.isPending, {
+    baseSubmitHandler: M,
+    error: E,
+    setError: U
+  } = Y("ContractorAddressForm"), f = X([c, m], {
+    submitError: E,
+    setSubmitError: U
+  }), V = C.map((a) => ({
+    value: a,
+    label: a
+  })), o = q(g, i.control), B = {
+    street1: o.street1,
+    street2: o.street2,
+    city: o.city,
+    state: W(o.state, V, C),
+    zip: o.zip
+  }, H = async (a) => {
+    let S;
+    return await new Promise((y) => {
+      i.handleSubmit(
+        async (G) => {
+          await M(G, async (s) => {
+            const O = a?.contractorId ?? r;
+            if (!t?.version)
+              throw new F(
+                "Cannot update contractor address: no matching address on file"
+              );
+            const A = await l.mutateAsync({
+              request: {
+                contractorUuid: O,
+                contractorAddressUpdateBody: {
+                  version: t.version,
+                  street1: s.street1,
+                  street2: s.street2 || void 0,
+                  city: s.city,
+                  state: s.state,
+                  zip: s.zip
+                }
+              }
+            });
+            if (!A.contractorAddress)
+              throw new F("Contractor address update failed");
+            S = {
+              mode: "update",
+              data: A.contractorAddress
+            };
+          }), y();
+        },
+        () => {
+          y();
+        }
+      )();
+    }), S;
+  }, k = J(i);
+  return !n || !t ? { isLoading: !0, errorHandling: f } : {
+    isLoading: !1,
+    data: {
+      contractorAddress: t,
+      contractor: n,
+      contractorType: w
+    },
+    status: {
+      isPending: z,
+      mode: "update"
+    },
+    actions: { onSubmit: H },
+    errorHandling: f,
+    form: {
+      Fields: {
+        Street1: j,
+        Street2: _,
+        City: K,
+        State: I,
+        Zip: x
+      },
+      fieldsMetadata: B,
+      hookFormInternals: k,
+      getFormSubmissionValues: N(i, u)
+    }
+  };
+}
+export {
+  ft as useContractorAddressForm
+};
+//# sourceMappingURL=useContractorAddressForm.js.map

package/dist/components/Contractor/Address/shared/useContractorAddressForm/useContractorAddressForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useContractorAddressForm.js","sources":["../../../../../../src/components/Contractor/Address/shared/useContractorAddressForm/useContractorAddressForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type {\n  Contractor,\n  ContractorType,\n} from '@gusto/embedded-api-v-2025-11-15/models/components/contractor'\nimport type { ContractorAddress } from '@gusto/embedded-api-v-2025-11-15/models/components/contractoraddress'\nimport { useContractorsGet } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorsGet'\nimport { useContractorsGetAddress } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorsGetAddress'\nimport { useContractorsUpdateAddressMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorsUpdateAddress'\nimport {\n  createContractorAddressSchema,\n  type ContractorAddressOptionalFieldsToRequire,\n  type ContractorAddressFormData,\n  type ContractorAddressFormOutputs,\n} from './contractorAddressSchema'\nimport { Street1Field, Street2Field, CityField, StateField, ZipField } from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { withOptions } from '@/partner-hook-utils/form/withOptions'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\nimport { STATES_ABBR } from '@/shared/constants'\n\nexport type { ContractorAddressOptionalFieldsToRequire } from './contractorAddressSchema'\n\n/**\n * Optional overrides passed to {@link UseContractorAddressFormReady.actions.onSubmit | onSubmit}.\n *\n * @public\n */\nexport interface ContractorAddressSubmitOptions {\n  /** Override the contractor identifier supplied to the hook. */\n  contractorId?: string\n}\n\n/**\n * Configuration options for {@link useContractorAddressForm}.\n *\n * @public\n */\nexport interface UseContractorAddressFormProps {\n  /** UUID of the contractor whose address is being edited. */\n  contractorId: string\n  /** Override fields that are optional by default to be required. See `ContractorAddressOptionalFieldsToRequire`. */\n  optionalFieldsToRequire?: ContractorAddressOptionalFieldsToRequire\n  /** Pre-fill form values. Server data takes precedence. */\n  defaultValues?: Partial<ContractorAddressFormData>\n  /** Passed through to react-hook-form. Defaults to `'onSubmit'`. */\n  validationMode?: UseFormProps['mode']\n  /** 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`. */\n  shouldFocusError?: boolean\n}\n\n/**\n * Pre-bound field components exposed on `useContractorAddressForm().form.Fields`.\n *\n * @public\n */\nexport interface ContractorAddressFields {\n  /** Street address line 1 text input. Required. */\n  Street1: typeof Street1Field\n  /** Street address line 2 text input. Optional. */\n  Street2: typeof Street2Field\n  /** City text input. Required. */\n  City: typeof CityField\n  /** State selector. Required. */\n  State: typeof StateField\n  /** ZIP code text input. Required. */\n  Zip: typeof ZipField\n}\n\n/**\n * Ready-state shape returned by {@link useContractorAddressForm} once data has loaded.\n *\n * @remarks\n * Discriminated by `isLoading: false`. Extends {@link BaseFormHookReady} with\n * the contractor-address-specific `data`, `status`, `actions`, and `form.Fields` shape.\n *\n * @public\n */\nexport interface UseContractorAddressFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  ContractorAddressFormData,\n  ContractorAddressFields\n> {\n  /** Static entity data resolved from the API. */\n  data: {\n    /** The contractor address row loaded for update. */\n    contractorAddress: ContractorAddress\n    /** The full contractor entity loaded alongside the address. */\n    contractor: Contractor\n    /** The contractor's type — drives whether the address is labelled \"home\" (Individual) or \"business\" (Business). */\n    contractorType: ContractorType | undefined\n  }\n  /** Reactive status flags. */\n  status: { isPending: boolean; mode: 'update' }\n  /** Available actions. */\n  actions: {\n    onSubmit: (\n      options?: ContractorAddressSubmitOptions,\n    ) => Promise<HookSubmitResult<ContractorAddress> | undefined>\n  }\n}\n\n/**\n * Form hook for editing a contractor's address.\n *\n * @remarks\n * A contractor always has exactly one address (created with the contractor),\n * so this hook operates only in update mode and issues a PUT on submit. The\n * same address is labelled a \"home\" address for Individual contractors and a\n * \"business\" address for Business contractors; the hook exposes `contractorType`\n * so the consuming component can choose the appropriate copy.\n *\n * @param props - See {@link UseContractorAddressFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UseContractorAddressFormReady} once ready.\n * @public\n */\nexport function useContractorAddressForm({\n  contractorId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseContractorAddressFormProps): HookLoadingResult | UseContractorAddressFormReady {\n  const contractorQuery = useContractorsGet(\n    { contractorUuid: contractorId },\n    { enabled: !!contractorId },\n  )\n  const addressQuery = useContractorsGetAddress(\n    { contractorUuid: contractorId },\n    { enabled: !!contractorId },\n  )\n\n  const contractor = contractorQuery.data?.contractor\n  const contractorType = contractor?.type\n  const fetchedAddress = addressQuery.data?.contractorAddress\n\n  const [schema, metadataConfig] = useMemo(\n    () => createContractorAddressSchema({ optionalFieldsToRequire }),\n    [optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: ContractorAddressFormData = useMemo(\n    () => ({\n      street1: fetchedAddress?.street1 ?? partnerDefaults?.street1 ?? '',\n      street2: fetchedAddress?.street2 ?? partnerDefaults?.street2 ?? '',\n      city: fetchedAddress?.city ?? partnerDefaults?.city ?? '',\n      state: fetchedAddress?.state ?? partnerDefaults?.state ?? '',\n      zip: fetchedAddress?.zip ?? partnerDefaults?.zip ?? '',\n    }),\n    [fetchedAddress, partnerDefaults],\n  )\n\n  const formMethods = useForm<ContractorAddressFormData, unknown, ContractorAddressFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const updateAddressMutation = useContractorsUpdateAddressMutation()\n\n  const isPending = updateAddressMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('ContractorAddressForm')\n\n  const errorHandling = composeErrorHandler([contractorQuery, addressQuery], {\n    submitError,\n    setSubmitError,\n  })\n\n  const stateOptions = STATES_ABBR.map(abbr => ({\n    value: abbr,\n    label: abbr,\n  }))\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    street1: baseMetadata.street1,\n    street2: baseMetadata.street2,\n    city: baseMetadata.city,\n    state: withOptions(baseMetadata.state, stateOptions, STATES_ABBR),\n    zip: baseMetadata.zip,\n  }\n\n  const onSubmit = async (\n    options?: ContractorAddressSubmitOptions,\n  ): Promise<HookSubmitResult<ContractorAddress> | undefined> => {\n    let submitResult: HookSubmitResult<ContractorAddress> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: ContractorAddressFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            const resolvedContractorId = options?.contractorId ?? contractorId\n\n            if (!fetchedAddress?.version) {\n              throw new SDKInternalError(\n                'Cannot update contractor address: no matching address on file',\n              )\n            }\n\n            const result = await updateAddressMutation.mutateAsync({\n              request: {\n                contractorUuid: resolvedContractorId,\n                contractorAddressUpdateBody: {\n                  version: fetchedAddress.version,\n                  street1: payload.street1,\n                  street2: payload.street2 || undefined,\n                  city: payload.city,\n                  state: payload.state,\n                  zip: payload.zip,\n                },\n              },\n            })\n\n            if (!result.contractorAddress) {\n              throw new SDKInternalError('Contractor address update failed')\n            }\n\n            submitResult = {\n              mode: 'update',\n              data: result.contractorAddress,\n            }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  if (!contractor || !fetchedAddress) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  return {\n    isLoading: false as const,\n    data: {\n      contractorAddress: fetchedAddress,\n      contractor,\n      contractorType,\n    },\n    status: {\n      isPending,\n      mode: 'update' as const,\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Street1: Street1Field,\n        Street2: Street2Field,\n        City: CityField,\n        State: StateField,\n        Zip: ZipField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Discriminated union returned by {@link useContractorAddressForm}.\n *\n * @public\n */\nexport type UseContractorAddressFormResult = HookLoadingResult | UseContractorAddressFormReady\n/**\n * Type of `form.fieldsMetadata` returned by {@link useContractorAddressForm}.\n *\n * @public\n */\nexport type ContractorAddressFieldsMetadata =\n  UseContractorAddressFormReady['form']['fieldsMetadata']\n/**\n * Type of `form.Fields` returned by {@link useContractorAddressForm}.\n *\n * @public\n */\nexport type ContractorAddressFormFields = UseContractorAddressFormReady['form']['Fields']\n"],"names":["useContractorAddressForm","contractorId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","contractorQuery","useContractorsGet","addressQuery","useContractorsGetAddress","contractor","contractorType","fetchedAddress","schema","metadataConfig","useMemo","createContractorAddressSchema","resolvedDefaults","formMethods","useForm","zodResolver","updateAddressMutation","useContractorsUpdateAddressMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","stateOptions","STATES_ABBR","abbr","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","withOptions","onSubmit","options","submitResult","resolve","data","payload","resolvedContractorId","SDKInternalError","result","hookFormInternals","useHookFormInternals","Street1Field","Street2Field","CityField","StateField","ZipField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;;;AAiIO,SAASA,GAAyB;AAAA,EACvC,cAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAqF;AACnF,QAAMC,IAAkBC;AAAA,IACtB,EAAE,gBAAgBN,EAAA;AAAA,IAClB,EAAE,SAAS,CAAC,CAACA,EAAA;AAAA,EAAa,GAEtBO,IAAeC;AAAA,IACnB,EAAE,gBAAgBR,EAAA;AAAA,IAClB,EAAE,SAAS,CAAC,CAACA,EAAA;AAAA,EAAa,GAGtBS,IAAaJ,EAAgB,MAAM,YACnCK,IAAiBD,GAAY,MAC7BE,IAAiBJ,EAAa,MAAM,mBAEpC,CAACK,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAA8B,EAAE,yBAAAd,GAAyB;AAAA,IAC/D,CAACA,CAAuB;AAAA,EAAA,GAGpBe,IAA8CF;AAAA,IAClD,OAAO;AAAA,MACL,SAASH,GAAgB,WAAWT,GAAiB,WAAW;AAAA,MAChE,SAASS,GAAgB,WAAWT,GAAiB,WAAW;AAAA,MAChE,MAAMS,GAAgB,QAAQT,GAAiB,QAAQ;AAAA,MACvD,OAAOS,GAAgB,SAAST,GAAiB,SAAS;AAAA,MAC1D,KAAKS,GAAgB,OAAOT,GAAiB,OAAO;AAAA,IAAA;AAAA,IAEtD,CAACS,GAAgBT,CAAe;AAAA,EAAA,GAG5Be,IAAcC,EAA0E;AAAA,IAC5F,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMT;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeY;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAAwBC,EAAA,GAExBC,IAAYF,EAAsB,WAElC;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,uBAAuB,GAEnCC,IAAgBC,EAAoB,CAACvB,GAAiBE,CAAY,GAAG;AAAA,IACzE,aAAAiB;AAAA,IACA,gBAAAC;AAAA,EAAA,CACD,GAEKI,IAAeC,EAAY,IAAI,CAAAC,OAAS;AAAA,IAC5C,OAAOA;AAAA,IACP,OAAOA;AAAA,EAAA,EACP,GAEIC,IAAeC,EAAwBpB,GAAgBI,EAAY,OAAO,GAC1EiB,IAAiB;AAAA,IACrB,SAASF,EAAa;AAAA,IACtB,SAASA,EAAa;AAAA,IACtB,MAAMA,EAAa;AAAA,IACnB,OAAOG,EAAYH,EAAa,OAAOH,GAAcC,CAAW;AAAA,IAChE,KAAKE,EAAa;AAAA,EAAA,GAGdI,IAAW,OACfC,MAC6D;AAC7D,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKtB,EAAY;AAAA,QACf,OAAOuB,MAAuC;AAC5C,gBAAMjB,EAAkBiB,GAAM,OAAMC,MAAW;AAC7C,kBAAMC,IAAuBL,GAAS,gBAAgBrC;AAEtD,gBAAI,CAACW,GAAgB;AACnB,oBAAM,IAAIgC;AAAA,gBACR;AAAA,cAAA;AAIJ,kBAAMC,IAAS,MAAMxB,EAAsB,YAAY;AAAA,cACrD,SAAS;AAAA,gBACP,gBAAgBsB;AAAA,gBAChB,6BAA6B;AAAA,kBAC3B,SAAS/B,EAAe;AAAA,kBACxB,SAAS8B,EAAQ;AAAA,kBACjB,SAASA,EAAQ,WAAW;AAAA,kBAC5B,MAAMA,EAAQ;AAAA,kBACd,OAAOA,EAAQ;AAAA,kBACf,KAAKA,EAAQ;AAAA,gBAAA;AAAA,cACf;AAAA,YACF,CACD;AAED,gBAAI,CAACG,EAAO;AACV,oBAAM,IAAID,EAAiB,kCAAkC;AAG/D,YAAAL,IAAe;AAAA,cACb,MAAM;AAAA,cACN,MAAMM,EAAO;AAAA,YAAA;AAAA,UAEjB,CAAC,GACDL,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMO,IAAoBC,EAAqB7B,CAAW;AAE1D,SAAI,CAACR,KAAc,CAACE,IACX,EAAE,WAAW,IAAe,eAAAgB,EAAA,IAG9B;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,mBAAmBhB;AAAA,MACnB,YAAAF;AAAA,MACA,gBAAAC;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACN,WAAAY;AAAA,MACA,MAAM;AAAA,IAAA;AAAA,IAER,SAAS,EAAE,UAAAc,EAAA;AAAA,IACX,eAAAT;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,SAASoB;AAAA,QACT,SAASC;AAAA,QACT,MAAMC;AAAA,QACN,OAAOC;AAAA,QACP,KAAKC;AAAA,MAAA;AAAA,MAEP,gBAAAjB;AAAA,MACA,mBAAAW;AAAA,MACA,yBAAyBO,EAA8BnC,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Contractor/Address/types.d.ts

@@ -0,0 +1,8 @@
+import { ContractorAddressFormData } from './shared/useContractorAddressForm';
+import { RequireAtLeastOne } from '../../../types/Helpers';
+/**
+ * Pre-fill values accepted by {@link Address}. At least one of `street1`, `street2`, `city`, `state`, or `zip` must be provided.
+ *
+ * @public
+ */
+export type AddressDefaultValues = RequireAtLeastOne<ContractorAddressFormData>;

package/dist/components/Contractor/ContractorList/index.d.ts

@@ -1,11 +1,11 @@
 import "./types/i18next.d.ts"
-import { BaseComponentInterface, CommonComponentInterface } from '../../Base';
+import { BaseComponentInterface } from '../../Base';
 /**
  * Props for {@link ContractorList}.
  *
  * @public
  */
-export interface ContractorListProps extends CommonComponentInterface<'Contractor.ContractorList'> {
+export interface ContractorListProps extends BaseComponentInterface<'Contractor.ContractorList'> {
     /** UUID of the company whose contractors should be listed. */
     companyId: string;
     /** Success message to display in an alert above the list, typically after a create, update, or delete action. */
@@ -14,7 +14,7 @@ export interface ContractorListProps extends CommonComponentInterface<'Contracto
 /**
  * Lists a company's contractors with controls to add, edit, delete, and continue onboarding.
  *
- * @remarks
+ * @events
  * | Event | Description | Data |
  * | ----- | ----------- | ---- |
  * | `contractor/create` | The add-contractor action was triggered. | — |
@@ -26,4 +26,4 @@ export interface ContractorListProps extends CommonComponentInterface<'Contracto
  * @returns The rendered contractor list.
  * @public
  */
-export declare function ContractorList(props: ContractorListProps & BaseComponentInterface): import("react").JSX.Element;
+export declare function ContractorList(props: ContractorListProps): import("react").JSX.Element;

package/dist/components/Contractor/ContractorList/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../src/components/Contractor/ContractorList/index.tsx"],"sourcesContent":["import { type Contractor } from '@gusto/embedded-api-v-2025-11-15/models/components/contractor'\nimport { useTranslation } from 'react-i18next'\nimport { useContractorsDeleteMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorsDelete'\nimport { useContractors } from './useContractorList'\nimport { ActionsLayout, DataView, EmptyData, Flex, useDataView } from '@/components/Common'\nimport { firstLastName } from '@/helpers/formattedStrings'\nimport { HamburgerMenu } from '@/components/Common/HamburgerMenu/HamburgerMenu'\nimport PencilSvg from '@/assets/icons/pencil.svg?react'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { ContractorOnboardingStatusBadge } from '@/components/Common/OnboardingStatusBadge'\nimport { useI18n, useComponentDictionary } from '@/i18n'\nimport {\n  BaseComponent,\n  useBase,\n  type BaseComponentInterface,\n  type CommonComponentInterface,\n} from '@/components/Base'\nimport { componentEvents, CONTRACTOR_TYPE } from '@/shared/constants'\nimport TrashCanSvg from '@/assets/icons/trashcan.svg?react'\n\ninterface HeadProps {\n  count: number\n  handleAdd: () => void\n}\nfunction Head({ count, handleAdd }: HeadProps) {\n  const { Button, Heading } = useComponentContext()\n  const { t } = useTranslation('Contractor.ContractorList')\n\n  return (\n    <Flex alignItems=\"center\" justifyContent=\"space-between\">\n      <Heading as=\"h2\">{t('title')}</Heading>\n\n      {count !== 0 && (\n        <Button variant=\"secondary\" onClick={handleAdd}>\n          {t('addAnotherCta')}\n        </Button>\n      )}\n    </Flex>\n  )\n}\n\ninterface EmptyDataContractorsListProps {\n  handleAdd: () => void\n}\nfunction EmptyDataContractorsList({ handleAdd }: EmptyDataContractorsListProps) {\n  const { Button } = useComponentContext()\n  const { t } = useTranslation('Contractor.ContractorList')\n\n  return (\n    <EmptyData title={t('emptyTableTitle')} description={t('emptyTableDescription')}>\n      <ActionsLayout justifyContent=\"center\">\n        <Button onClick={handleAdd}>{t('addContractorCta')}</Button>\n      </ActionsLayout>\n    </EmptyData>\n  )\n}\n\n/**\n * Props for {@link ContractorList}.\n *\n * @public\n */\nexport interface ContractorListProps extends CommonComponentInterface<'Contractor.ContractorList'> {\n  /** UUID of the company whose contractors should be listed. */\n  companyId: string\n  /** Success message to display in an alert above the list, typically after a create, update, or delete action. */\n  successMessage?: string\n}\n\n/**\n * Lists a company's contractors with controls to add, edit, delete, and continue onboarding.\n *\n * @remarks\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `contractor/create` | The add-contractor action was triggered. | — |\n * | `contractor/update` | A contractor row's edit action was triggered. | `{ contractorId: string }` |\n * | `contractor/deleted` | A contractor was successfully deleted. | `{ contractorId: string }` |\n * | `contractor/onboarding/continue` | The continue action was triggered to advance onboarding. | — |\n *\n * @param props - See {@link ContractorListProps}.\n * @returns The rendered contractor list.\n * @public\n */\nexport function ContractorList(props: ContractorListProps & BaseComponentInterface) {\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nfunction Root({ companyId, className, dictionary, successMessage }: ContractorListProps) {\n  useI18n('Contractor.ContractorList')\n  useComponentDictionary('Contractor.ContractorList', dictionary)\n  const { t } = useTranslation('Contractor.ContractorList')\n  const { onEvent, baseSubmitHandler } = useBase()\n  const { Alert, Button } = useComponentContext()\n  const {\n    contractors,\n    totalCount,\n    handleNextPage,\n    handleFirstPage,\n    handleLastPage,\n    handlePreviousPage,\n    handleItemsPerPageChange,\n    currentPage,\n    totalPages,\n    itemsPerPage,\n  } = useContractors({ companyUuid: companyId })\n  const { mutateAsync: deleteContractorMutation, isPending: isPendingDelete } =\n    useContractorsDeleteMutation()\n\n  const dataViewProps = useDataView<Contractor>({\n    columns: [\n      {\n        title: t('listHeaders.name'),\n        render: contractor =>\n          contractor.type === CONTRACTOR_TYPE.BUSINESS\n            ? contractor.businessName\n            : firstLastName({ first_name: contractor.firstName, last_name: contractor.lastName }),\n      },\n      {\n        title: t('listHeaders.status'),\n        render: ({ onboarded, onboardingStatus }) => (\n          <ContractorOnboardingStatusBadge\n            onboarded={onboarded}\n            onboardingStatus={onboardingStatus}\n          />\n        ),\n      },\n    ],\n    data: contractors,\n    itemMenu: contractor => (\n      <HamburgerMenu\n        items={[\n          {\n            label: t('editCta'),\n            icon: <PencilSvg aria-hidden />,\n            onClick: () => {\n              handleEdit(contractor.uuid)\n            },\n          },\n          {\n            label: t('deleteCta'),\n            icon: <TrashCanSvg aria-hidden />,\n            onClick: () => {\n              void handleDelete(contractor.uuid)\n            },\n          },\n        ]}\n        triggerLabel={t('editCta')}\n        isLoading={isPendingDelete}\n      />\n    ),\n    emptyState: () => <EmptyDataContractorsList handleAdd={handleAdd} />,\n    pagination: {\n      handleNextPage,\n      handleFirstPage,\n      handleLastPage,\n      handlePreviousPage,\n      handleItemsPerPageChange,\n      currentPage,\n      totalPages,\n      totalCount,\n      itemsPerPage,\n    },\n  })\n\n  const handleAdd = () => {\n    onEvent(componentEvents.CONTRACTOR_CREATE)\n  }\n\n  const handleEdit = (uuid: string) => {\n    onEvent(componentEvents.CONTRACTOR_UPDATE, { contractorId: uuid })\n  }\n\n  const handleContinue = () => {\n    onEvent(componentEvents.CONTRACTOR_ONBOARDING_CONTINUE)\n  }\n\n  const handleDelete = async (uuid: string) => {\n    await baseSubmitHandler(uuid, async payload => {\n      await deleteContractorMutation({\n        request: { contractorUuid: payload },\n      })\n\n      onEvent(componentEvents.CONTRACTOR_DELETED, { contractorId: payload })\n    })\n  }\n\n  return (\n    <section className={className}>\n      {successMessage && <Alert label={successMessage} status=\"success\" />}\n      <Flex flexDirection=\"column\">\n        <Head count={totalCount} handleAdd={handleAdd} />\n        <DataView label={t('contractorListLabel')} {...dataViewProps} />\n        <ActionsLayout>\n          <Button onClick={handleContinue} isLoading={false}>\n            {t('continueCta')}\n          </Button>\n        </ActionsLayout>\n      </Flex>\n    </section>\n  )\n}\n"],"names":["Head","count","handleAdd","Button","Heading","useComponentContext","t","useTranslation","jsxs","Flex","jsx","EmptyDataContractorsList","EmptyData","ActionsLayout","ContractorList","props","BaseComponent","Root","companyId","className","dictionary","successMessage","useI18n","useComponentDictionary","onEvent","baseSubmitHandler","useBase","Alert","contractors","totalCount","handleNextPage","handleFirstPage","handleLastPage","handlePreviousPage","handleItemsPerPageChange","currentPage","totalPages","itemsPerPage","useContractors","deleteContractorMutation","isPendingDelete","useContractorsDeleteMutation","dataViewProps","useDataView","contractor","CONTRACTOR_TYPE","firstLastName","onboarded","onboardingStatus","ContractorOnboardingStatusBadge","HamburgerMenu","PencilSvg","handleEdit","TrashCanSvg","handleDelete","componentEvents","uuid","handleContinue","payload","DataView"],"mappings":";;;;;;;;;;;;;;;;;;;AAwBA,SAASA,EAAK,EAAE,OAAAC,GAAO,WAAAC,KAAwB;AAC7C,QAAM,EAAE,QAAAC,GAAQ,SAAAC,EAAA,IAAYC,EAAA,GACtB,EAAE,GAAAC,EAAA,IAAMC,EAAe,2BAA2B;AAExD,SACE,gBAAAC,EAACC,GAAA,EAAK,YAAW,UAAS,gBAAe,iBACvC,UAAA;AAAA,IAAA,gBAAAC,EAACN,GAAA,EAAQ,IAAG,MAAM,UAAAE,EAAE,OAAO,GAAE;AAAA,IAE5BL,MAAU,KACT,gBAAAS,EAACP,GAAA,EAAO,SAAQ,aAAY,SAASD,GAClC,UAAAI,EAAE,eAAe,EAAA,CACpB;AAAA,EAAA,GAEJ;AAEJ;AAKA,SAASK,EAAyB,EAAE,WAAAT,KAA4C;AAC9E,QAAM,EAAE,QAAAC,EAAA,IAAWE,EAAA,GACb,EAAE,GAAAC,EAAA,IAAMC,EAAe,2BAA2B;AAExD,SACE,gBAAAG,EAACE,KAAU,OAAON,EAAE,iBAAiB,GAAG,aAAaA,EAAE,uBAAuB,GAC5E,UAAA,gBAAAI,EAACG,KAAc,gBAAe,UAC5B,4BAACV,GAAA,EAAO,SAASD,GAAY,UAAAI,EAAE,kBAAkB,EAAA,CAAE,EAAA,CACrD,EAAA,CACF;AAEJ;AA6BO,SAASQ,GAAeC,GAAqD;AAClF,SACE,gBAAAL,EAACM,GAAA,EAAe,GAAGD,GACjB,UAAA,gBAAAL,EAACO,KAAM,GAAGF,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,SAASE,EAAK,EAAE,WAAAC,GAAW,WAAAC,GAAW,YAAAC,GAAY,gBAAAC,KAAuC;AACvF,EAAAC,EAAQ,2BAA2B,GACnCC,EAAuB,6BAA6BH,CAAU;AAC9D,QAAM,EAAE,GAAAd,EAAA,IAAMC,EAAe,2BAA2B,GAClD,EAAE,SAAAiB,GAAS,mBAAAC,EAAA,IAAsBC,EAAA,GACjC,EAAE,OAAAC,GAAO,QAAAxB,EAAA,IAAWE,EAAA,GACpB;AAAA,IACJ,aAAAuB;AAAA,IACA,YAAAC;AAAA,IACA,gBAAAC;AAAA,IACA,iBAAAC;AAAA,IACA,gBAAAC;AAAA,IACA,oBAAAC;AAAA,IACA,0BAAAC;AAAA,IACA,aAAAC;AAAA,IACA,YAAAC;AAAA,IACA,cAAAC;AAAA,EAAA,IACEC,EAAe,EAAE,aAAapB,GAAW,GACvC,EAAE,aAAaqB,GAA0B,WAAWC,EAAA,IACxDC,EAAA,GAEIC,IAAgBC,EAAwB;AAAA,IAC5C,SAAS;AAAA,MACP;AAAA,QACE,OAAOrC,EAAE,kBAAkB;AAAA,QAC3B,QAAQ,CAAAsC,MACNA,EAAW,SAASC,EAAgB,WAChCD,EAAW,eACXE,EAAc,EAAE,YAAYF,EAAW,WAAW,WAAWA,EAAW,UAAU;AAAA,MAAA;AAAA,MAE1F;AAAA,QACE,OAAOtC,EAAE,oBAAoB;AAAA,QAC7B,QAAQ,CAAC,EAAE,WAAAyC,GAAW,kBAAAC,QACpB,gBAAAtC;AAAA,UAACuC;AAAA,UAAA;AAAA,YACC,WAAAF;AAAA,YACA,kBAAAC;AAAA,UAAA;AAAA,QAAA;AAAA,MACF;AAAA,IAEJ;AAAA,IAEF,MAAMpB;AAAA,IACN,UAAU,CAAAgB,MACR,gBAAAlC;AAAA,MAACwC;AAAA,MAAA;AAAA,QACC,OAAO;AAAA,UACL;AAAA,YACE,OAAO5C,EAAE,SAAS;AAAA,YAClB,MAAM,gBAAAI,EAACyC,GAAA,EAAU,eAAW,GAAA,CAAC;AAAA,YAC7B,SAAS,MAAM;AACb,cAAAC,EAAWR,EAAW,IAAI;AAAA,YAC5B;AAAA,UAAA;AAAA,UAEF;AAAA,YACE,OAAOtC,EAAE,WAAW;AAAA,YACpB,MAAM,gBAAAI,EAAC2C,GAAA,EAAY,eAAW,GAAA,CAAC;AAAA,YAC/B,SAAS,MAAM;AACb,cAAKC,EAAaV,EAAW,IAAI;AAAA,YACnC;AAAA,UAAA;AAAA,QACF;AAAA,QAEF,cAActC,EAAE,SAAS;AAAA,QACzB,WAAWkC;AAAA,MAAA;AAAA,IAAA;AAAA,IAGf,YAAY,MAAM,gBAAA9B,EAACC,GAAA,EAAyB,WAAAT,EAAA,CAAsB;AAAA,IAClE,YAAY;AAAA,MACV,gBAAA4B;AAAA,MACA,iBAAAC;AAAA,MACA,gBAAAC;AAAA,MACA,oBAAAC;AAAA,MACA,0BAAAC;AAAA,MACA,aAAAC;AAAA,MACA,YAAAC;AAAA,MACA,YAAAP;AAAA,MACA,cAAAQ;AAAA,IAAA;AAAA,EACF,CACD,GAEKnC,IAAY,MAAM;AACtB,IAAAsB,EAAQ+B,EAAgB,iBAAiB;AAAA,EAC3C,GAEMH,IAAa,CAACI,MAAiB;AACnC,IAAAhC,EAAQ+B,EAAgB,mBAAmB,EAAE,cAAcC,GAAM;AAAA,EACnE,GAEMC,IAAiB,MAAM;AAC3B,IAAAjC,EAAQ+B,EAAgB,8BAA8B;AAAA,EACxD,GAEMD,IAAe,OAAOE,MAAiB;AAC3C,UAAM/B,EAAkB+B,GAAM,OAAME,MAAW;AAC7C,YAAMnB,EAAyB;AAAA,QAC7B,SAAS,EAAE,gBAAgBmB,EAAA;AAAA,MAAQ,CACpC,GAEDlC,EAAQ+B,EAAgB,oBAAoB,EAAE,cAAcG,GAAS;AAAA,IACvE,CAAC;AAAA,EACH;AAEA,SACE,gBAAAlD,EAAC,aAAQ,WAAAW,GACN,UAAA;AAAA,IAAAE,KAAkB,gBAAAX,EAACiB,GAAA,EAAM,OAAON,GAAgB,QAAO,WAAU;AAAA,IAClE,gBAAAb,EAACC,GAAA,EAAK,eAAc,UAClB,UAAA;AAAA,MAAA,gBAAAC,EAACV,GAAA,EAAK,OAAO6B,GAAY,WAAA3B,EAAA,CAAsB;AAAA,wBAC9CyD,GAAA,EAAS,OAAOrD,EAAE,qBAAqB,GAAI,GAAGoC,GAAe;AAAA,MAC9D,gBAAAhC,EAACG,GAAA,EACC,UAAA,gBAAAH,EAACP,GAAA,EAAO,SAASsD,GAAgB,WAAW,IACzC,UAAAnD,EAAE,aAAa,EAAA,CAClB,EAAA,CACF;AAAA,IAAA,EAAA,CACF;AAAA,EAAA,GACF;AAEJ;"}
+{"version":3,"file":"index.js","sources":["../../../../src/components/Contractor/ContractorList/index.tsx"],"sourcesContent":["import { type Contractor } from '@gusto/embedded-api-v-2025-11-15/models/components/contractor'\nimport { useTranslation } from 'react-i18next'\nimport { useContractorsDeleteMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorsDelete'\nimport { useContractors } from './useContractorList'\nimport { ActionsLayout, DataView, EmptyData, Flex, useDataView } from '@/components/Common'\nimport { firstLastName } from '@/helpers/formattedStrings'\nimport { HamburgerMenu } from '@/components/Common/HamburgerMenu/HamburgerMenu'\nimport PencilSvg from '@/assets/icons/pencil.svg?react'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { ContractorOnboardingStatusBadge } from '@/components/Common/OnboardingStatusBadge'\nimport { useI18n, useComponentDictionary } from '@/i18n'\nimport { BaseComponent, useBase, type BaseComponentInterface } from '@/components/Base'\nimport { componentEvents, CONTRACTOR_TYPE } from '@/shared/constants'\nimport TrashCanSvg from '@/assets/icons/trashcan.svg?react'\n\ninterface HeadProps {\n  count: number\n  handleAdd: () => void\n}\nfunction Head({ count, handleAdd }: HeadProps) {\n  const { Button, Heading } = useComponentContext()\n  const { t } = useTranslation('Contractor.ContractorList')\n\n  return (\n    <Flex alignItems=\"center\" justifyContent=\"space-between\">\n      <Heading as=\"h2\">{t('title')}</Heading>\n\n      {count !== 0 && (\n        <Button variant=\"secondary\" onClick={handleAdd}>\n          {t('addAnotherCta')}\n        </Button>\n      )}\n    </Flex>\n  )\n}\n\ninterface EmptyDataContractorsListProps {\n  handleAdd: () => void\n}\nfunction EmptyDataContractorsList({ handleAdd }: EmptyDataContractorsListProps) {\n  const { Button } = useComponentContext()\n  const { t } = useTranslation('Contractor.ContractorList')\n\n  return (\n    <EmptyData title={t('emptyTableTitle')} description={t('emptyTableDescription')}>\n      <ActionsLayout justifyContent=\"center\">\n        <Button onClick={handleAdd}>{t('addContractorCta')}</Button>\n      </ActionsLayout>\n    </EmptyData>\n  )\n}\n\n/**\n * Props for {@link ContractorList}.\n *\n * @public\n */\nexport interface ContractorListProps extends BaseComponentInterface<'Contractor.ContractorList'> {\n  /** UUID of the company whose contractors should be listed. */\n  companyId: string\n  /** Success message to display in an alert above the list, typically after a create, update, or delete action. */\n  successMessage?: string\n}\n\n/**\n * Lists a company's contractors with controls to add, edit, delete, and continue onboarding.\n *\n * @events\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `contractor/create` | The add-contractor action was triggered. | — |\n * | `contractor/update` | A contractor row's edit action was triggered. | `{ contractorId: string }` |\n * | `contractor/deleted` | A contractor was successfully deleted. | `{ contractorId: string }` |\n * | `contractor/onboarding/continue` | The continue action was triggered to advance onboarding. | — |\n *\n * @param props - See {@link ContractorListProps}.\n * @returns The rendered contractor list.\n * @public\n */\nexport function ContractorList(props: ContractorListProps) {\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nfunction Root({ companyId, className, dictionary, successMessage }: ContractorListProps) {\n  useI18n('Contractor.ContractorList')\n  useComponentDictionary('Contractor.ContractorList', dictionary)\n  const { t } = useTranslation('Contractor.ContractorList')\n  const { onEvent, baseSubmitHandler } = useBase()\n  const { Alert, Button } = useComponentContext()\n  const {\n    contractors,\n    totalCount,\n    handleNextPage,\n    handleFirstPage,\n    handleLastPage,\n    handlePreviousPage,\n    handleItemsPerPageChange,\n    currentPage,\n    totalPages,\n    itemsPerPage,\n  } = useContractors({ companyUuid: companyId })\n  const { mutateAsync: deleteContractorMutation, isPending: isPendingDelete } =\n    useContractorsDeleteMutation()\n\n  const dataViewProps = useDataView<Contractor>({\n    columns: [\n      {\n        title: t('listHeaders.name'),\n        render: contractor =>\n          contractor.type === CONTRACTOR_TYPE.BUSINESS\n            ? contractor.businessName\n            : firstLastName({ first_name: contractor.firstName, last_name: contractor.lastName }),\n      },\n      {\n        title: t('listHeaders.status'),\n        render: ({ onboarded, onboardingStatus }) => (\n          <ContractorOnboardingStatusBadge\n            onboarded={onboarded}\n            onboardingStatus={onboardingStatus}\n          />\n        ),\n      },\n    ],\n    data: contractors,\n    itemMenu: contractor => (\n      <HamburgerMenu\n        items={[\n          {\n            label: t('editCta'),\n            icon: <PencilSvg aria-hidden />,\n            onClick: () => {\n              handleEdit(contractor.uuid)\n            },\n          },\n          {\n            label: t('deleteCta'),\n            icon: <TrashCanSvg aria-hidden />,\n            onClick: () => {\n              void handleDelete(contractor.uuid)\n            },\n          },\n        ]}\n        triggerLabel={t('editCta')}\n        isLoading={isPendingDelete}\n      />\n    ),\n    emptyState: () => <EmptyDataContractorsList handleAdd={handleAdd} />,\n    pagination: {\n      handleNextPage,\n      handleFirstPage,\n      handleLastPage,\n      handlePreviousPage,\n      handleItemsPerPageChange,\n      currentPage,\n      totalPages,\n      totalCount,\n      itemsPerPage,\n    },\n  })\n\n  const handleAdd = () => {\n    onEvent(componentEvents.CONTRACTOR_CREATE)\n  }\n\n  const handleEdit = (uuid: string) => {\n    onEvent(componentEvents.CONTRACTOR_UPDATE, { contractorId: uuid })\n  }\n\n  const handleContinue = () => {\n    onEvent(componentEvents.CONTRACTOR_ONBOARDING_CONTINUE)\n  }\n\n  const handleDelete = async (uuid: string) => {\n    await baseSubmitHandler(uuid, async payload => {\n      await deleteContractorMutation({\n        request: { contractorUuid: payload },\n      })\n\n      onEvent(componentEvents.CONTRACTOR_DELETED, { contractorId: payload })\n    })\n  }\n\n  return (\n    <section className={className}>\n      {successMessage && <Alert label={successMessage} status=\"success\" />}\n      <Flex flexDirection=\"column\">\n        <Head count={totalCount} handleAdd={handleAdd} />\n        <DataView label={t('contractorListLabel')} {...dataViewProps} />\n        <ActionsLayout>\n          <Button onClick={handleContinue} isLoading={false}>\n            {t('continueCta')}\n          </Button>\n        </ActionsLayout>\n      </Flex>\n    </section>\n  )\n}\n"],"names":["Head","count","handleAdd","Button","Heading","useComponentContext","t","useTranslation","jsxs","Flex","jsx","EmptyDataContractorsList","EmptyData","ActionsLayout","ContractorList","props","BaseComponent","Root","companyId","className","dictionary","successMessage","useI18n","useComponentDictionary","onEvent","baseSubmitHandler","useBase","Alert","contractors","totalCount","handleNextPage","handleFirstPage","handleLastPage","handlePreviousPage","handleItemsPerPageChange","currentPage","totalPages","itemsPerPage","useContractors","deleteContractorMutation","isPendingDelete","useContractorsDeleteMutation","dataViewProps","useDataView","contractor","CONTRACTOR_TYPE","firstLastName","onboarded","onboardingStatus","ContractorOnboardingStatusBadge","HamburgerMenu","PencilSvg","handleEdit","TrashCanSvg","handleDelete","componentEvents","uuid","handleContinue","payload","DataView"],"mappings":";;;;;;;;;;;;;;;;;;;AAmBA,SAASA,EAAK,EAAE,OAAAC,GAAO,WAAAC,KAAwB;AAC7C,QAAM,EAAE,QAAAC,GAAQ,SAAAC,EAAA,IAAYC,EAAA,GACtB,EAAE,GAAAC,EAAA,IAAMC,EAAe,2BAA2B;AAExD,SACE,gBAAAC,EAACC,GAAA,EAAK,YAAW,UAAS,gBAAe,iBACvC,UAAA;AAAA,IAAA,gBAAAC,EAACN,GAAA,EAAQ,IAAG,MAAM,UAAAE,EAAE,OAAO,GAAE;AAAA,IAE5BL,MAAU,KACT,gBAAAS,EAACP,GAAA,EAAO,SAAQ,aAAY,SAASD,GAClC,UAAAI,EAAE,eAAe,EAAA,CACpB;AAAA,EAAA,GAEJ;AAEJ;AAKA,SAASK,EAAyB,EAAE,WAAAT,KAA4C;AAC9E,QAAM,EAAE,QAAAC,EAAA,IAAWE,EAAA,GACb,EAAE,GAAAC,EAAA,IAAMC,EAAe,2BAA2B;AAExD,SACE,gBAAAG,EAACE,KAAU,OAAON,EAAE,iBAAiB,GAAG,aAAaA,EAAE,uBAAuB,GAC5E,UAAA,gBAAAI,EAACG,KAAc,gBAAe,UAC5B,4BAACV,GAAA,EAAO,SAASD,GAAY,UAAAI,EAAE,kBAAkB,EAAA,CAAE,EAAA,CACrD,EAAA,CACF;AAEJ;AA6BO,SAASQ,GAAeC,GAA4B;AACzD,SACE,gBAAAL,EAACM,GAAA,EAAe,GAAGD,GACjB,UAAA,gBAAAL,EAACO,KAAM,GAAGF,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,SAASE,EAAK,EAAE,WAAAC,GAAW,WAAAC,GAAW,YAAAC,GAAY,gBAAAC,KAAuC;AACvF,EAAAC,EAAQ,2BAA2B,GACnCC,EAAuB,6BAA6BH,CAAU;AAC9D,QAAM,EAAE,GAAAd,EAAA,IAAMC,EAAe,2BAA2B,GAClD,EAAE,SAAAiB,GAAS,mBAAAC,EAAA,IAAsBC,EAAA,GACjC,EAAE,OAAAC,GAAO,QAAAxB,EAAA,IAAWE,EAAA,GACpB;AAAA,IACJ,aAAAuB;AAAA,IACA,YAAAC;AAAA,IACA,gBAAAC;AAAA,IACA,iBAAAC;AAAA,IACA,gBAAAC;AAAA,IACA,oBAAAC;AAAA,IACA,0BAAAC;AAAA,IACA,aAAAC;AAAA,IACA,YAAAC;AAAA,IACA,cAAAC;AAAA,EAAA,IACEC,EAAe,EAAE,aAAapB,GAAW,GACvC,EAAE,aAAaqB,GAA0B,WAAWC,EAAA,IACxDC,EAAA,GAEIC,IAAgBC,EAAwB;AAAA,IAC5C,SAAS;AAAA,MACP;AAAA,QACE,OAAOrC,EAAE,kBAAkB;AAAA,QAC3B,QAAQ,CAAAsC,MACNA,EAAW,SAASC,EAAgB,WAChCD,EAAW,eACXE,EAAc,EAAE,YAAYF,EAAW,WAAW,WAAWA,EAAW,UAAU;AAAA,MAAA;AAAA,MAE1F;AAAA,QACE,OAAOtC,EAAE,oBAAoB;AAAA,QAC7B,QAAQ,CAAC,EAAE,WAAAyC,GAAW,kBAAAC,QACpB,gBAAAtC;AAAA,UAACuC;AAAA,UAAA;AAAA,YACC,WAAAF;AAAA,YACA,kBAAAC;AAAA,UAAA;AAAA,QAAA;AAAA,MACF;AAAA,IAEJ;AAAA,IAEF,MAAMpB;AAAA,IACN,UAAU,CAAAgB,MACR,gBAAAlC;AAAA,MAACwC;AAAA,MAAA;AAAA,QACC,OAAO;AAAA,UACL;AAAA,YACE,OAAO5C,EAAE,SAAS;AAAA,YAClB,MAAM,gBAAAI,EAACyC,GAAA,EAAU,eAAW,GAAA,CAAC;AAAA,YAC7B,SAAS,MAAM;AACb,cAAAC,EAAWR,EAAW,IAAI;AAAA,YAC5B;AAAA,UAAA;AAAA,UAEF;AAAA,YACE,OAAOtC,EAAE,WAAW;AAAA,YACpB,MAAM,gBAAAI,EAAC2C,GAAA,EAAY,eAAW,GAAA,CAAC;AAAA,YAC/B,SAAS,MAAM;AACb,cAAKC,EAAaV,EAAW,IAAI;AAAA,YACnC;AAAA,UAAA;AAAA,QACF;AAAA,QAEF,cAActC,EAAE,SAAS;AAAA,QACzB,WAAWkC;AAAA,MAAA;AAAA,IAAA;AAAA,IAGf,YAAY,MAAM,gBAAA9B,EAACC,GAAA,EAAyB,WAAAT,EAAA,CAAsB;AAAA,IAClE,YAAY;AAAA,MACV,gBAAA4B;AAAA,MACA,iBAAAC;AAAA,MACA,gBAAAC;AAAA,MACA,oBAAAC;AAAA,MACA,0BAAAC;AAAA,MACA,aAAAC;AAAA,MACA,YAAAC;AAAA,MACA,YAAAP;AAAA,MACA,cAAAQ;AAAA,IAAA;AAAA,EACF,CACD,GAEKnC,IAAY,MAAM;AACtB,IAAAsB,EAAQ+B,EAAgB,iBAAiB;AAAA,EAC3C,GAEMH,IAAa,CAACI,MAAiB;AACnC,IAAAhC,EAAQ+B,EAAgB,mBAAmB,EAAE,cAAcC,GAAM;AAAA,EACnE,GAEMC,IAAiB,MAAM;AAC3B,IAAAjC,EAAQ+B,EAAgB,8BAA8B;AAAA,EACxD,GAEMD,IAAe,OAAOE,MAAiB;AAC3C,UAAM/B,EAAkB+B,GAAM,OAAME,MAAW;AAC7C,YAAMnB,EAAyB;AAAA,QAC7B,SAAS,EAAE,gBAAgBmB,EAAA;AAAA,MAAQ,CACpC,GAEDlC,EAAQ+B,EAAgB,oBAAoB,EAAE,cAAcG,GAAS;AAAA,IACvE,CAAC;AAAA,EACH;AAEA,SACE,gBAAAlD,EAAC,aAAQ,WAAAW,GACN,UAAA;AAAA,IAAAE,KAAkB,gBAAAX,EAACiB,GAAA,EAAM,OAAON,GAAgB,QAAO,WAAU;AAAA,IAClE,gBAAAb,EAACC,GAAA,EAAK,eAAc,UAClB,UAAA;AAAA,MAAA,gBAAAC,EAACV,GAAA,EAAK,OAAO6B,GAAY,WAAA3B,EAAA,CAAsB;AAAA,wBAC9CyD,GAAA,EAAS,OAAOrD,EAAE,qBAAqB,GAAI,GAAGoC,GAAe;AAAA,MAC9D,gBAAAhC,EAACG,GAAA,EACC,UAAA,gBAAAH,EAACP,GAAA,EAAO,SAASsD,GAAgB,WAAW,IACzC,UAAAnD,EAAE,aAAa,EAAA,CAClB,EAAA,CACF;AAAA,IAAA,EAAA,CACF;AAAA,EAAA,GACF;AAEJ;"}

package/dist/components/Contractor/Documents/DocumentsList/DocumentsList.d.ts

@@ -0,0 +1,29 @@
+import { BaseComponentInterface } from '../../../Base/Base';
+/**
+ * Props for {@link DocumentsList}.
+ *
+ * @public
+ */
+export interface DocumentsListProps extends BaseComponentInterface<'Contractor.DocumentsList'> {
+    /** The associated contractor identifier. */
+    contractorId: string;
+}
+/**
+ * Lists a contractor's documents and lets the contractor open each one for signing.
+ *
+ * @remarks
+ * Fetches the contractor's documents via {@link useContractorDocumentsList} and
+ * renders them in a table. The Continue action is disabled until every document
+ * that requires signing has been signed.
+ *
+ * @events
+ * | Event | Description | Data |
+ * | ----- | ----------- | ---- |
+ * | `contractor/documents/view` | Fired when a document's "Sign" action is selected | `{ uuid?: string; title?: string }` |
+ * | `contractor/documents/done` | Fired when all required documents are signed and the user continues | — |
+ *
+ * @param props - See {@link DocumentsListProps}.
+ * @returns The contractor documents list.
+ * @public
+ */
+export declare function DocumentsList(props: DocumentsListProps): import("react").JSX.Element;

package/dist/components/Contractor/Documents/DocumentsList/DocumentsList.js

@@ -0,0 +1,71 @@
+import { jsx as n, jsxs as l } from "react/jsx-runtime";
+import { useTranslation as b } from "react-i18next";
+import { useContractorDocumentsList as S } from "./useContractorDocumentsList/useContractorDocumentsList.js";
+import { BaseComponent as x, BaseLayout as u } from "../../../Base/Base.js";
+import { useBase as E } from "../../../Base/useBase.js";
+import { useComponentDictionary as O, useI18n as R } from "../../../../i18n/I18n.js";
+import { Flex as a } from "../../../Common/Flex/Flex.js";
+import { ActionsLayout as _ } from "../../../Common/ActionsLayout/ActionsLayout.js";
+import { useComponentContext as y } from "../../../../contexts/ComponentAdapter/useComponentContext.js";
+import "react";
+import { contractorEvents as m } from "../../../../shared/constants.js";
+import { DocumentList as N } from "../../../Common/DocumentList/DocumentList.js";
+function d(e) {
+  return !!e.requiresSigning && !e.signedAt;
+}
+function V(e) {
+  return /* @__PURE__ */ n(x, { ...e, children: /* @__PURE__ */ n(q, { ...e }) });
+}
+function q({ contractorId: e, className: g, dictionary: p }) {
+  O("Contractor.DocumentsList", p), R("Contractor.DocumentsList");
+  const { t } = b("Contractor.DocumentsList"), { onEvent: c } = E(), i = y(), r = S({ contractorId: e });
+  if (r.isLoading)
+    return /* @__PURE__ */ n(u, { isLoading: !0, error: r.errorHandling.errors });
+  const { documents: s } = r.data, C = r.errorHandling.errors.length > 0, f = s.every((o) => !d(o)), L = (o) => {
+    const D = s.find((T) => T.uuid === o);
+    c(m.CONTRACTOR_VIEW_DOCUMENT_TO_SIGN, {
+      uuid: o,
+      title: D?.title
+    });
+  }, h = () => {
+    c(m.CONTRACTOR_DOCUMENTS_DONE);
+  };
+  return /* @__PURE__ */ n("section", { className: g, children: /* @__PURE__ */ n(u, { error: r.errorHandling.errors, children: /* @__PURE__ */ l(a, { flexDirection: "column", gap: 32, children: [
+    /* @__PURE__ */ l(a, { flexDirection: "column", gap: 4, children: [
+      /* @__PURE__ */ n(i.Heading, { as: "h2", children: t("title") }),
+      /* @__PURE__ */ n(i.Text, { children: t("subtitle") })
+    ] }),
+    /* @__PURE__ */ n(
+      N,
+      {
+        forms: s.map((o) => ({
+          uuid: o.uuid ?? "",
+          title: o.title,
+          description: o.description,
+          requires_signing: d(o)
+        })),
+        onRequestSign: (o) => {
+          L(o.uuid);
+        },
+        withError: C,
+        label: t("documentListLabel"),
+        columnLabels: {
+          form: t("documentColumnLabel"),
+          action: t("statusColumnLabel")
+        },
+        statusLabels: {
+          signCta: t("signDocumentCta"),
+          notSigned: t("notSigned"),
+          complete: t("signed")
+        },
+        emptyStateLabel: t("emptyTitle"),
+        errorLabel: t("errorTitle")
+      }
+    ),
+    /* @__PURE__ */ n(_, { children: /* @__PURE__ */ n(i.Button, { onClick: h, isDisabled: !f, children: t("continueCta") }) })
+  ] }) }) });
+}
+export {
+  V as DocumentsList
+};
+//# sourceMappingURL=DocumentsList.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentsList.js","sources":["../../../../../src/components/Contractor/Documents/DocumentsList/DocumentsList.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport type { Document } from '@gusto/embedded-api-v-2025-11-15/models/components/document'\nimport { useContractorDocumentsList } from './useContractorDocumentsList'\nimport { BaseComponent, type BaseComponentInterface } from '@/components/Base/Base'\nimport { BaseLayout } from '@/components/Base'\nimport { useBase } from '@/components/Base/useBase'\nimport { useI18n, useComponentDictionary } from '@/i18n'\nimport { ActionsLayout, Flex } from '@/components/Common'\nimport { DocumentList } from '@/components/Common/DocumentList'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { contractorEvents } from '@/shared/constants'\n\n/**\n * Props for {@link DocumentsList}.\n *\n * @public\n */\nexport interface DocumentsListProps extends BaseComponentInterface<'Contractor.DocumentsList'> {\n  /** The associated contractor identifier. */\n  contractorId: string\n}\n\n/**\n * Returns whether a document still needs the contractor's signature.\n *\n * @remarks\n * A document is outstanding when it requires signing and has not yet been\n * signed (`signedAt` is unset).\n */\nfunction requiresSignature(document: Document): boolean {\n  return Boolean(document.requiresSigning) && !document.signedAt\n}\n\n/**\n * Lists a contractor's documents and lets the contractor open each one for signing.\n *\n * @remarks\n * Fetches the contractor's documents via {@link useContractorDocumentsList} and\n * renders them in a table. The Continue action is disabled until every document\n * that requires signing has been signed.\n *\n * @events\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `contractor/documents/view` | Fired when a document's \"Sign\" action is selected | `{ uuid?: string; title?: string }` |\n * | `contractor/documents/done` | Fired when all required documents are signed and the user continues | — |\n *\n * @param props - See {@link DocumentsListProps}.\n * @returns The contractor documents list.\n * @public\n */\nexport function DocumentsList(props: DocumentsListProps) {\n  return (\n    <BaseComponent {...props}>\n      <Root {...props} />\n    </BaseComponent>\n  )\n}\n\nfunction Root({ contractorId, className, dictionary }: DocumentsListProps) {\n  useComponentDictionary('Contractor.DocumentsList', dictionary)\n  useI18n('Contractor.DocumentsList')\n  const { t } = useTranslation('Contractor.DocumentsList')\n  const { onEvent } = useBase()\n  const Components = useComponentContext()\n\n  const result = useContractorDocumentsList({ contractorId })\n\n  if (result.isLoading) {\n    return <BaseLayout isLoading error={result.errorHandling.errors} />\n  }\n\n  const { documents } = result.data\n  const hasError = result.errorHandling.errors.length > 0\n  const hasSignedAllDocuments = documents.every(document => !requiresSignature(document))\n\n  const handleRequestSign = (uuid: string) => {\n    const document = documents.find(candidate => candidate.uuid === uuid)\n    onEvent(contractorEvents.CONTRACTOR_VIEW_DOCUMENT_TO_SIGN, {\n      uuid,\n      title: document?.title,\n    })\n  }\n\n  const handleContinue = () => {\n    onEvent(contractorEvents.CONTRACTOR_DOCUMENTS_DONE)\n  }\n\n  return (\n    <section className={className}>\n      <BaseLayout error={result.errorHandling.errors}>\n        <Flex flexDirection=\"column\" gap={32}>\n          <Flex flexDirection=\"column\" gap={4}>\n            <Components.Heading as=\"h2\">{t('title')}</Components.Heading>\n            <Components.Text>{t('subtitle')}</Components.Text>\n          </Flex>\n\n          <DocumentList\n            forms={documents.map(document => ({\n              uuid: document.uuid ?? '',\n              title: document.title,\n              description: document.description,\n              requires_signing: requiresSignature(document),\n            }))}\n            onRequestSign={form => {\n              handleRequestSign(form.uuid)\n            }}\n            withError={hasError}\n            label={t('documentListLabel')}\n            columnLabels={{\n              form: t('documentColumnLabel'),\n              action: t('statusColumnLabel'),\n            }}\n            statusLabels={{\n              signCta: t('signDocumentCta'),\n              notSigned: t('notSigned'),\n              complete: t('signed'),\n            }}\n            emptyStateLabel={t('emptyTitle')}\n            errorLabel={t('errorTitle')}\n          />\n\n          <ActionsLayout>\n            <Components.Button onClick={handleContinue} isDisabled={!hasSignedAllDocuments}>\n              {t('continueCta')}\n            </Components.Button>\n          </ActionsLayout>\n        </Flex>\n      </BaseLayout>\n    </section>\n  )\n}\n"],"names":["requiresSignature","document","DocumentsList","props","jsx","BaseComponent","Root","contractorId","className","dictionary","useComponentDictionary","useI18n","useTranslation","onEvent","useBase","Components","useComponentContext","result","useContractorDocumentsList","BaseLayout","documents","hasError","hasSignedAllDocuments","handleRequestSign","uuid","candidate","contractorEvents","handleContinue","jsxs","Flex","DocumentList","form","ActionsLayout"],"mappings":";;;;;;;;;;;;AA6BA,SAASA,EAAkBC,GAA6B;AACtD,SAAO,EAAQA,EAAS,mBAAoB,CAACA,EAAS;AACxD;AAoBO,SAASC,EAAcC,GAA2B;AACvD,SACE,gBAAAC,EAACC,KAAe,GAAGF,GACjB,4BAACG,GAAA,EAAM,GAAGH,GAAO,EAAA,CACnB;AAEJ;AAEA,SAASG,EAAK,EAAE,cAAAC,GAAc,WAAAC,GAAW,YAAAC,KAAkC;AACzE,EAAAC,EAAuB,4BAA4BD,CAAU,GAC7DE,EAAQ,0BAA0B;AAClC,QAAM,EAAE,EAAA,IAAMC,EAAe,0BAA0B,GACjD,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAaC,EAAA,GAEbC,IAASC,EAA2B,EAAE,cAAAX,GAAc;AAE1D,MAAIU,EAAO;AACT,6BAAQE,GAAA,EAAW,WAAS,IAAC,OAAOF,EAAO,cAAc,QAAQ;AAGnE,QAAM,EAAE,WAAAG,MAAcH,EAAO,MACvBI,IAAWJ,EAAO,cAAc,OAAO,SAAS,GAChDK,IAAwBF,EAAU,MAAM,OAAY,CAACpB,EAAkBC,CAAQ,CAAC,GAEhFsB,IAAoB,CAACC,MAAiB;AAC1C,UAAMvB,IAAWmB,EAAU,KAAK,CAAAK,MAAaA,EAAU,SAASD,CAAI;AACpE,IAAAX,EAAQa,EAAiB,kCAAkC;AAAA,MACzD,MAAAF;AAAA,MACA,OAAOvB,GAAU;AAAA,IAAA,CAClB;AAAA,EACH,GAEM0B,IAAiB,MAAM;AAC3B,IAAAd,EAAQa,EAAiB,yBAAyB;AAAA,EACpD;AAEA,SACE,gBAAAtB,EAAC,WAAA,EAAQ,WAAAI,GACP,UAAA,gBAAAJ,EAACe,KAAW,OAAOF,EAAO,cAAc,QACtC,UAAA,gBAAAW,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAChC,UAAA;AAAA,IAAA,gBAAAD,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,MAAA,gBAAAzB,EAACW,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAA,EAAE,OAAO,GAAE;AAAA,wBACvCA,EAAW,MAAX,EAAiB,UAAA,EAAE,UAAU,EAAA,CAAE;AAAA,IAAA,GAClC;AAAA,IAEA,gBAAAX;AAAA,MAAC0B;AAAA,MAAA;AAAA,QACC,OAAOV,EAAU,IAAI,CAAAnB,OAAa;AAAA,UAChC,MAAMA,EAAS,QAAQ;AAAA,UACvB,OAAOA,EAAS;AAAA,UAChB,aAAaA,EAAS;AAAA,UACtB,kBAAkBD,EAAkBC,CAAQ;AAAA,QAAA,EAC5C;AAAA,QACF,eAAe,CAAA8B,MAAQ;AACrB,UAAAR,EAAkBQ,EAAK,IAAI;AAAA,QAC7B;AAAA,QACA,WAAWV;AAAA,QACX,OAAO,EAAE,mBAAmB;AAAA,QAC5B,cAAc;AAAA,UACZ,MAAM,EAAE,qBAAqB;AAAA,UAC7B,QAAQ,EAAE,mBAAmB;AAAA,QAAA;AAAA,QAE/B,cAAc;AAAA,UACZ,SAAS,EAAE,iBAAiB;AAAA,UAC5B,WAAW,EAAE,WAAW;AAAA,UACxB,UAAU,EAAE,QAAQ;AAAA,QAAA;AAAA,QAEtB,iBAAiB,EAAE,YAAY;AAAA,QAC/B,YAAY,EAAE,YAAY;AAAA,MAAA;AAAA,IAAA;AAAA,IAG5B,gBAAAjB,EAAC4B,GAAA,EACC,UAAA,gBAAA5B,EAACW,EAAW,QAAX,EAAkB,SAASY,GAAgB,YAAY,CAACL,GACtD,UAAA,EAAE,aAAa,GAClB,EAAA,CACF;AAAA,EAAA,EAAA,CACF,GACF,GACF;AAEJ;"}

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

@@ -0,0 +1,3 @@
+import "./types/i18next.d.ts"
+export { DocumentsList, type DocumentsListProps } from './DocumentsList';
+export { useContractorDocumentsList, type UseContractorDocumentsListParams, type UseContractorDocumentsListReady, type UseContractorDocumentsListResult, } from './useContractorDocumentsList';

package/dist/components/Contractor/Documents/DocumentsList/useContractorDocumentsList/index.d.ts

@@ -0,0 +1,2 @@
+import "./types/i18next.d.ts"
+export { useContractorDocumentsList, type UseContractorDocumentsListParams, type UseContractorDocumentsListReady, type UseContractorDocumentsListResult, } from './useContractorDocumentsList';

package/dist/components/Contractor/Documents/DocumentsList/useContractorDocumentsList/useContractorDocumentsList.d.ts

@@ -0,0 +1,59 @@
+import { Document } from '@gusto/embedded-api-v-2025-11-15/models/components/document';
+import { BaseHookReady, HookLoadingResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Parameters for {@link useContractorDocumentsList}.
+ *
+ * @public
+ */
+export interface UseContractorDocumentsListParams {
+    /** The associated contractor identifier. */
+    contractorId: string;
+}
+/**
+ * Ready-state shape returned by {@link useContractorDocumentsList} once the documents have loaded.
+ *
+ * @public
+ */
+export type UseContractorDocumentsListReady = BaseHookReady<{
+    documents: Document[];
+}, {
+    isFetching: boolean;
+}>;
+/**
+ * Result of {@link useContractorDocumentsList} — a discriminated union of loading and ready states.
+ *
+ * @public
+ */
+export type UseContractorDocumentsListResult = HookLoadingResult | UseContractorDocumentsListReady;
+/**
+ * Standalone data hook for a contractor's documents.
+ *
+ * @remarks
+ * Wraps the `contractorDocumentsGetAll` query in the standard
+ * {@link BaseHookReady} shape. Read-only — viewing or signing a document is
+ * handled by the screen the parent routes to, so this hook exposes no actions.
+ *
+ * @param params - See {@link UseContractorDocumentsListParams}.
+ * @returns A {@link HookLoadingResult} while loading, or the ready state with `data.documents` once loaded.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { useContractorDocumentsList } from '@gusto/embedded-react-sdk'
+ *
+ * function ContractorDocuments({ contractorId }: { contractorId: string }) {
+ *   const result = useContractorDocumentsList({ contractorId })
+ *
+ *   if (result.isLoading) return <div>Loading...</div>
+ *
+ *   return (
+ *     <ul>
+ *       {result.data.documents.map(doc => (
+ *         <li key={doc.uuid}>{doc.title}</li>
+ *       ))}
+ *     </ul>
+ *   )
+ * }
+ * ```
+ */
+export declare function useContractorDocumentsList({ contractorId, }: UseContractorDocumentsListParams): UseContractorDocumentsListResult;

package/dist/components/Contractor/Documents/DocumentsList/useContractorDocumentsList/useContractorDocumentsList.js

@@ -0,0 +1,20 @@
+import { useContractorDocumentsGetAll as r } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorDocumentsGetAll";
+import { composeErrorHandler as e } from "../../../../../partner-hook-utils/composeErrorHandler.js";
+function a({
+  contractorId: n
+}) {
+  const t = r(
+    { contractorUuid: n },
+    { staleTime: 1 / 0 }
+  ), o = e([t]);
+  return t.isLoading ? { isLoading: !0, errorHandling: o } : {
+    isLoading: !1,
+    data: { documents: t.data?.documents ?? [] },
+    status: { isFetching: t.isFetching },
+    errorHandling: o
+  };
+}
+export {
+  a as useContractorDocumentsList
+};
+//# sourceMappingURL=useContractorDocumentsList.js.map

package/dist/components/Contractor/Documents/DocumentsList/useContractorDocumentsList/useContractorDocumentsList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useContractorDocumentsList.js","sources":["../../../../../../src/components/Contractor/Documents/DocumentsList/useContractorDocumentsList/useContractorDocumentsList.tsx"],"sourcesContent":["import { useContractorDocumentsGetAll } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorDocumentsGetAll'\nimport type { Document } from '@gusto/embedded-api-v-2025-11-15/models/components/document'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type { BaseHookReady, HookLoadingResult } from '@/partner-hook-utils/types'\n\n/**\n * Parameters for {@link useContractorDocumentsList}.\n *\n * @public\n */\nexport interface UseContractorDocumentsListParams {\n  /** The associated contractor identifier. */\n  contractorId: string\n}\n\n/**\n * Ready-state shape returned by {@link useContractorDocumentsList} once the documents have loaded.\n *\n * @public\n */\nexport type UseContractorDocumentsListReady = BaseHookReady<\n  { documents: Document[] },\n  { isFetching: boolean }\n>\n\n/**\n * Result of {@link useContractorDocumentsList} — a discriminated union of loading and ready states.\n *\n * @public\n */\nexport type UseContractorDocumentsListResult = HookLoadingResult | UseContractorDocumentsListReady\n\n/**\n * Standalone data hook for a contractor's documents.\n *\n * @remarks\n * Wraps the `contractorDocumentsGetAll` query in the standard\n * {@link BaseHookReady} shape. Read-only — viewing or signing a document is\n * handled by the screen the parent routes to, so this hook exposes no actions.\n *\n * @param params - See {@link UseContractorDocumentsListParams}.\n * @returns A {@link HookLoadingResult} while loading, or the ready state with `data.documents` once loaded.\n * @public\n *\n * @example\n * ```tsx\n * import { useContractorDocumentsList } from '@gusto/embedded-react-sdk'\n *\n * function ContractorDocuments({ contractorId }: { contractorId: string }) {\n *   const result = useContractorDocumentsList({ contractorId })\n *\n *   if (result.isLoading) return <div>Loading...</div>\n *\n *   return (\n *     <ul>\n *       {result.data.documents.map(doc => (\n *         <li key={doc.uuid}>{doc.title}</li>\n *       ))}\n *     </ul>\n *   )\n * }\n * ```\n */\nexport function useContractorDocumentsList({\n  contractorId,\n}: UseContractorDocumentsListParams): UseContractorDocumentsListResult {\n  // staleTime: Infinity — the SDK QueryClient invalidates on any mutation\n  // success, so a long stale time avoids redundant refetches on remount.\n  const documentsQuery = useContractorDocumentsGetAll(\n    { contractorUuid: contractorId },\n    { staleTime: Infinity },\n  )\n\n  const errorHandling = composeErrorHandler([documentsQuery])\n\n  if (documentsQuery.isLoading) {\n    return { isLoading: true, errorHandling }\n  }\n\n  return {\n    isLoading: false,\n    data: { documents: documentsQuery.data?.documents ?? [] },\n    status: { isFetching: documentsQuery.isFetching },\n    errorHandling,\n  }\n}\n"],"names":["useContractorDocumentsList","contractorId","documentsQuery","useContractorDocumentsGetAll","errorHandling","composeErrorHandler"],"mappings":";;AA+DO,SAASA,EAA2B;AAAA,EACzC,cAAAC;AACF,GAAuE;AAGrE,QAAMC,IAAiBC;AAAA,IACrB,EAAE,gBAAgBF,EAAA;AAAA,IAClB,EAAE,WAAW,MAAA;AAAA,EAAS,GAGlBG,IAAgBC,EAAoB,CAACH,CAAc,CAAC;AAE1D,SAAIA,EAAe,YACV,EAAE,WAAW,IAAM,eAAAE,EAAA,IAGrB;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,WAAWF,EAAe,MAAM,aAAa,CAAA,EAAC;AAAA,IACtD,QAAQ,EAAE,YAAYA,EAAe,WAAA;AAAA,IACrC,eAAAE;AAAA,EAAA;AAEJ;"}

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

@@ -0,0 +1,19 @@
+import { BaseComponentInterface } from '../../Base';
+/**
+ * Props for the {@link Landing} component.
+ *
+ * @public
+ */
+export interface LandingProps extends BaseComponentInterface<'Contractor.Landing'> {
+    /** UUID of the contractor entering the self-onboarding flow. */
+    contractorId: string;
+    /** UUID of the company the contractor belongs to. */
+    companyId: string;
+}
+/**
+ * Landing page for the contractor self-onboarding flow. Displays a welcome
+ * message and the list of onboarding steps the contractor needs to complete.
+ *
+ * @public
+ */
+export declare function Landing(props: LandingProps): import("react").JSX.Element;

package/dist/components/Contractor/Landing/Landing.js

@@ -0,0 +1,73 @@
+import { jsx as n, jsxs as r } from "react/jsx-runtime";
+import { useTranslation as h } from "react-i18next";
+import { useContractorsGetSuspense as g } from "@gusto/embedded-api-v-2025-11-15/react-query/contractorsGet";
+import { useCompaniesGetSuspense as C } from "@gusto/embedded-api-v-2025-11-15/react-query/companiesGet";
+import c from "dompurify";
+import { useMemo as m } from "react";
+import { BaseComponent as x } from "../../Base/Base.js";
+import { useBase as N } from "../../Base/useBase.js";
+import { Flex as a } from "../../Common/Flex/Flex.js";
+import { ActionsLayout as y } from "../../Common/ActionsLayout/ActionsLayout.js";
+import { useComponentContext as S } from "../../../contexts/ComponentAdapter/useComponentContext.js";
+import { useI18n as D, useComponentDictionary as L } from "../../../i18n/I18n.js";
+import { componentEvents as R } from "../../../shared/constants.js";
+import T from "../../../assets/icons/icon-arrow-right.svg.js";
+function U(o) {
+  return D("Contractor.Landing"), L("Contractor.Landing", o.dictionary), /* @__PURE__ */ n(x, { ...o, children: /* @__PURE__ */ n(v, { ...o, children: o.children }) });
+}
+const v = ({ contractorId: o, companyId: d, className: p }) => {
+  const { onEvent: l } = N(), e = S(), { t } = h("Contractor.Landing"), {
+    data: { contractor: i }
+  } = g({ contractorUuid: o }), u = m(
+    () => c.sanitize(i?.firstName ?? i?.businessName ?? t("fallbackName")),
+    [i, t]
+  ), {
+    data: { company: s }
+  } = C({ companyId: d }), f = m(() => c.sanitize(s?.name ?? ""), [s]);
+  return /* @__PURE__ */ n("section", { className: p, children: /* @__PURE__ */ n(
+    e.Box,
+    {
+      footer: /* @__PURE__ */ n(y, { children: /* @__PURE__ */ r(
+        e.Button,
+        {
+          variant: "secondary",
+          onClick: () => {
+            l(R.CONTRACTOR_SELF_ONBOARDING_START);
+          },
+          children: [
+            t("getStartedCta"),
+            /* @__PURE__ */ n(T, { "aria-hidden": !0 })
+          ]
+        }
+      ) }),
+      children: /* @__PURE__ */ r(a, { alignItems: "center", flexDirection: "column", gap: 32, children: [
+        /* @__PURE__ */ r(a, { flexDirection: "column", gap: 4, children: [
+          /* @__PURE__ */ n(e.Heading, { as: "h2", children: t("landingSubtitle", {
+            contractorName: u,
+            companyName: f,
+            interpolation: { escapeValue: !1 }
+          }) }),
+          /* @__PURE__ */ n(e.Text, { variant: "supporting", children: t("landingDescription") })
+        ] }),
+        /* @__PURE__ */ r(a, { flexDirection: "column", gap: 8, children: [
+          /* @__PURE__ */ n(e.Heading, { as: "h3", children: t("stepsSubtitle") }),
+          /* @__PURE__ */ n(
+            e.UnorderedList,
+            {
+              items: [
+                t("steps.profile"),
+                t("steps.address"),
+                t("steps.paymentMethod"),
+                t("steps.documents")
+              ]
+            }
+          )
+        ] })
+      ] })
+    }
+  ) });
+};
+export {
+  U as Landing
+};
+//# sourceMappingURL=Landing.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Landing.js","sources":["../../../../src/components/Contractor/Landing/Landing.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { useContractorsGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/contractorsGet'\nimport { useCompaniesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/companiesGet'\nimport DOMPurify from 'dompurify'\nimport { useMemo } from 'react'\nimport { BaseComponent, useBase, type BaseComponentInterface } from '@/components/Base'\nimport { Flex, ActionsLayout } from '@/components/Common'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { useI18n } from '@/i18n'\nimport { componentEvents } from '@/shared/constants'\nimport { useComponentDictionary } from '@/i18n/I18n'\nimport ArrowRightIcon from '@/assets/icons/icon-arrow-right.svg?react'\n\n/**\n * Props for the {@link Landing} component.\n *\n * @public\n */\nexport interface LandingProps extends BaseComponentInterface<'Contractor.Landing'> {\n  /** UUID of the contractor entering the self-onboarding flow. */\n  contractorId: string\n  /** UUID of the company the contractor belongs to. */\n  companyId: string\n}\n\n/**\n * Landing page for the contractor self-onboarding flow. Displays a welcome\n * message and the list of onboarding steps the contractor needs to complete.\n *\n * @public\n */\nexport function Landing(props: LandingProps) {\n  useI18n('Contractor.Landing')\n  useComponentDictionary('Contractor.Landing', props.dictionary)\n\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nconst Root = ({ contractorId, companyId, className }: LandingProps) => {\n  const { onEvent } = useBase()\n  const Components = useComponentContext()\n\n  const { t } = useTranslation('Contractor.Landing')\n\n  const {\n    data: { contractor },\n  } = useContractorsGetSuspense({ contractorUuid: contractorId })\n  const sanitizedContractorName = useMemo(\n    () =>\n      DOMPurify.sanitize(contractor?.firstName ?? contractor?.businessName ?? t('fallbackName')),\n    [contractor, t],\n  )\n\n  const {\n    data: { company },\n  } = useCompaniesGetSuspense({ companyId })\n  const sanitizedCompanyName = useMemo(() => DOMPurify.sanitize(company?.name ?? ''), [company])\n\n  return (\n    <section className={className}>\n      <Components.Box\n        footer={\n          <ActionsLayout>\n            <Components.Button\n              variant=\"secondary\"\n              onClick={() => {\n                onEvent(componentEvents.CONTRACTOR_SELF_ONBOARDING_START)\n              }}\n            >\n              {t('getStartedCta')}\n              <ArrowRightIcon aria-hidden />\n            </Components.Button>\n          </ActionsLayout>\n        }\n      >\n        <Flex alignItems=\"center\" flexDirection=\"column\" gap={32}>\n          <Flex flexDirection=\"column\" gap={4}>\n            <Components.Heading as=\"h2\">\n              {t('landingSubtitle', {\n                contractorName: sanitizedContractorName,\n                companyName: sanitizedCompanyName,\n                interpolation: { escapeValue: false },\n              })}\n            </Components.Heading>\n            <Components.Text variant=\"supporting\">{t('landingDescription')}</Components.Text>\n          </Flex>\n          <Flex flexDirection=\"column\" gap={8}>\n            <Components.Heading as=\"h3\">{t('stepsSubtitle')}</Components.Heading>\n            <Components.UnorderedList\n              items={[\n                t('steps.profile'),\n                t('steps.address'),\n                t('steps.paymentMethod'),\n                t('steps.documents'),\n              ]}\n            />\n          </Flex>\n        </Flex>\n      </Components.Box>\n    </section>\n  )\n}\n"],"names":["Landing","props","useI18n","useComponentDictionary","jsx","BaseComponent","Root","contractorId","companyId","className","onEvent","useBase","Components","useComponentContext","useTranslation","contractor","useContractorsGetSuspense","sanitizedContractorName","useMemo","DOMPurify","company","useCompaniesGetSuspense","sanitizedCompanyName","ActionsLayout","jsxs","componentEvents","ArrowRightIcon","Flex"],"mappings":";;;;;;;;;;;;;;AA+BO,SAASA,EAAQC,GAAqB;AAC3C,SAAAC,EAAQ,oBAAoB,GAC5BC,EAAuB,sBAAsBF,EAAM,UAAU,GAG3D,gBAAAG,EAACC,GAAA,EAAe,GAAGJ,GACjB,UAAA,gBAAAG,EAACE,KAAM,GAAGL,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,MAAMK,IAAO,CAAC,EAAE,cAAAC,GAAc,WAAAC,GAAW,WAAAC,QAA8B;AACrE,QAAM,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAaC,EAAA,GAEb,EAAE,EAAA,IAAMC,EAAe,oBAAoB,GAE3C;AAAA,IACJ,MAAM,EAAE,YAAAC,EAAA;AAAA,EAAW,IACjBC,EAA0B,EAAE,gBAAgBT,GAAc,GACxDU,IAA0BC;AAAA,IAC9B,MACEC,EAAU,SAASJ,GAAY,aAAaA,GAAY,gBAAgB,EAAE,cAAc,CAAC;AAAA,IAC3F,CAACA,GAAY,CAAC;AAAA,EAAA,GAGV;AAAA,IACJ,MAAM,EAAE,SAAAK,EAAA;AAAA,EAAQ,IACdC,EAAwB,EAAE,WAAAb,GAAW,GACnCc,IAAuBJ,EAAQ,MAAMC,EAAU,SAASC,GAAS,QAAQ,EAAE,GAAG,CAACA,CAAO,CAAC;AAE7F,SACE,gBAAAhB,EAAC,aAAQ,WAAAK,GACP,UAAA,gBAAAL;AAAA,IAACQ,EAAW;AAAA,IAAX;AAAA,MACC,0BACGW,GAAA,EACC,UAAA,gBAAAC;AAAA,QAACZ,EAAW;AAAA,QAAX;AAAA,UACC,SAAQ;AAAA,UACR,SAAS,MAAM;AACb,YAAAF,EAAQe,EAAgB,gCAAgC;AAAA,UAC1D;AAAA,UAEC,UAAA;AAAA,YAAA,EAAE,eAAe;AAAA,YAClB,gBAAArB,EAACsB,GAAA,EAAe,eAAW,GAAA,CAAC;AAAA,UAAA;AAAA,QAAA;AAAA,MAAA,GAEhC;AAAA,MAGF,4BAACC,GAAA,EAAK,YAAW,UAAS,eAAc,UAAS,KAAK,IACpD,UAAA;AAAA,QAAA,gBAAAH,EAACG,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAAvB,EAACQ,EAAW,SAAX,EAAmB,IAAG,MACpB,YAAE,mBAAmB;AAAA,YACpB,gBAAgBK;AAAA,YAChB,aAAaK;AAAA,YACb,eAAe,EAAE,aAAa,GAAA;AAAA,UAAM,CACrC,GACH;AAAA,UACA,gBAAAlB,EAACQ,EAAW,MAAX,EAAgB,SAAQ,cAAc,UAAA,EAAE,oBAAoB,EAAA,CAAE;AAAA,QAAA,GACjE;AAAA,QACA,gBAAAY,EAACG,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAAvB,EAACQ,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAA,EAAE,eAAe,GAAE;AAAA,UAChD,gBAAAR;AAAA,YAACQ,EAAW;AAAA,YAAX;AAAA,cACC,OAAO;AAAA,gBACL,EAAE,eAAe;AAAA,gBACjB,EAAE,eAAe;AAAA,gBACjB,EAAE,qBAAqB;AAAA,gBACvB,EAAE,iBAAiB;AAAA,cAAA;AAAA,YACrB;AAAA,UAAA;AAAA,QACF,EAAA,CACF;AAAA,MAAA,EAAA,CACF;AAAA,IAAA;AAAA,EAAA,GAEJ;AAEJ;"}

package/dist/components/Contractor/Landing/index.d.ts

@@ -0,0 +1,2 @@
+import "./types/i18next.d.ts"
+export * from './Landing';

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

@@ -9,6 +9,7 @@ import { NewHireReportProps } from './types';
  * Set `selfOnboarding` to `true` when this component is rendered as part of the contractor's
  * own self-onboarding flow rather than admin onboarding.
  *
+ * @events
  * | Event | Description | Data |
  * | ----- | ----------- | ---- |
  * | `contractor/newHireReport/updated` | Fired when the new hire report is saved | The API response object; access the updated contractor at `.contractor` |