@gusto/embedded-react-sdk 0.47.1 → 0.48.0

package/dist/components/Employee/HomeAddress/shared/useHomeAddressSummary/useHomeAddressSummary.d.ts

@@ -1,21 +1,36 @@
 import { EmployeeAddress } from '@gusto/embedded-api-v-2025-11-15/models/components/employeeaddress';
 import { BaseHookReady, HookLoadingResult } from '../../../../../partner-hook-utils/types';
+/**
+ * Params for {@link useHomeAddressSummary}.
+ *
+ * @public
+ */
 export interface UseHomeAddressSummaryParams {
+    /** The associated employee identifier. */
     employeeId: string;
 }
-export type UseHomeAddressSummaryReady = BaseHookReady<{
+type UseHomeAddressSummaryReady = BaseHookReady<{
     currentHomeAddress: EmployeeAddress | undefined;
     employeeAddressList: EmployeeAddress[];
 }, {
     isFetching: boolean;
     isPending: boolean;
 }>;
+/**
+ * Return type of {@link useHomeAddressSummary}.
+ *
+ * @public
+ */
 export type UseHomeAddressSummaryResult = HookLoadingResult | UseHomeAddressSummaryReady;
 /**
- * Read-only data hook for the Home address management card. Wraps
- * `useEmployeeAddressesGet` and surfaces the active row plus the full
- * list (the latter lets partners build their own history/pending UI).
- * Mutations live in `useHomeAddressManagement` (the form-driven hook
- * the edit form consumes).
+ * Read-only headless hook returning the employee's active home address and full address list.
+ *
+ * @remarks
+ * Use {@link useHomeAddressManagement} when you need create, update, or delete actions.
+ *
+ * @param params - {@link UseHomeAddressSummaryParams}
+ * @returns A {@link HookLoadingResult} while loading, or the ready state with `currentHomeAddress` and `employeeAddressList`.
+ * @public
  */
 export declare function useHomeAddressSummary({ employeeId, }: UseHomeAddressSummaryParams): UseHomeAddressSummaryResult;
+export {};

package/dist/components/Employee/HomeAddress/shared/useHomeAddressSummary/useHomeAddressSummary.js.map

@@ -1 +1 @@
-{"version":3,"file":"useHomeAddressSummary.js","sources":["../../../../../../src/components/Employee/HomeAddress/shared/useHomeAddressSummary/useHomeAddressSummary.tsx"],"sourcesContent":["import { useEmployeeAddressesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesGet'\nimport type { EmployeeAddress } from '@gusto/embedded-api-v-2025-11-15/models/components/employeeaddress'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type { BaseHookReady, HookLoadingResult } from '@/partner-hook-utils/types'\n\nexport interface UseHomeAddressSummaryParams {\n  employeeId: string\n}\n\nexport type UseHomeAddressSummaryReady = BaseHookReady<\n  {\n    currentHomeAddress: EmployeeAddress | undefined\n    employeeAddressList: EmployeeAddress[]\n  },\n  { isFetching: boolean; isPending: boolean }\n>\n\nexport type UseHomeAddressSummaryResult = HookLoadingResult | UseHomeAddressSummaryReady\n\n/**\n * Read-only data hook for the Home address management card. Wraps\n * `useEmployeeAddressesGet` and surfaces the active row plus the full\n * list (the latter lets partners build their own history/pending UI).\n * Mutations live in `useHomeAddressManagement` (the form-driven hook\n * the edit form consumes).\n */\nexport function useHomeAddressSummary({\n  employeeId,\n}: UseHomeAddressSummaryParams): UseHomeAddressSummaryResult {\n  const addressesQuery = useEmployeeAddressesGet({ employeeId }, { staleTime: Infinity })\n\n  const errorHandling = composeErrorHandler([addressesQuery])\n\n  if (addressesQuery.isLoading) {\n    return { isLoading: true, errorHandling }\n  }\n\n  const employeeAddressList = addressesQuery.data?.employeeAddressList ?? []\n  const currentHomeAddress = employeeAddressList.find(address => address.active)\n\n  return {\n    isLoading: false,\n    data: { currentHomeAddress, employeeAddressList },\n    status: {\n      isFetching: addressesQuery.isFetching,\n      isPending: false,\n    },\n    errorHandling,\n  }\n}\n"],"names":["useHomeAddressSummary","employeeId","addressesQuery","useEmployeeAddressesGet","errorHandling","composeErrorHandler","employeeAddressList","address"],"mappings":";;AA0BO,SAASA,EAAsB;AAAA,EACpC,YAAAC;AACF,GAA6D;AAC3D,QAAMC,IAAiBC,EAAwB,EAAE,YAAAF,EAAA,GAAc,EAAE,WAAW,OAAU,GAEhFG,IAAgBC,EAAoB,CAACH,CAAc,CAAC;AAE1D,MAAIA,EAAe;AACjB,WAAO,EAAE,WAAW,IAAM,eAAAE,EAAA;AAG5B,QAAME,IAAsBJ,EAAe,MAAM,uBAAuB,CAAA;AAGxE,SAAO;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,oBAJiBI,EAAoB,KAAK,CAAAC,MAAWA,EAAQ,MAAM,GAI/C,qBAAAD,EAAA;AAAA,IAC5B,QAAQ;AAAA,MACN,YAAYJ,EAAe;AAAA,MAC3B,WAAW;AAAA,IAAA;AAAA,IAEb,eAAAE;AAAA,EAAA;AAEJ;"}
+{"version":3,"file":"useHomeAddressSummary.js","sources":["../../../../../../src/components/Employee/HomeAddress/shared/useHomeAddressSummary/useHomeAddressSummary.tsx"],"sourcesContent":["import { useEmployeeAddressesGet } from '@gusto/embedded-api-v-2025-11-15/react-query/employeeAddressesGet'\nimport type { EmployeeAddress } from '@gusto/embedded-api-v-2025-11-15/models/components/employeeaddress'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type { BaseHookReady, HookLoadingResult } from '@/partner-hook-utils/types'\n\n/**\n * Params for {@link useHomeAddressSummary}.\n *\n * @public\n */\nexport interface UseHomeAddressSummaryParams {\n  /** The associated employee identifier. */\n  employeeId: string\n}\n\ntype UseHomeAddressSummaryReady = BaseHookReady<\n  {\n    currentHomeAddress: EmployeeAddress | undefined\n    employeeAddressList: EmployeeAddress[]\n  },\n  { isFetching: boolean; isPending: boolean }\n>\n\n/**\n * Return type of {@link useHomeAddressSummary}.\n *\n * @public\n */\nexport type UseHomeAddressSummaryResult = HookLoadingResult | UseHomeAddressSummaryReady\n\n/**\n * Read-only headless hook returning the employee's active home address and full address list.\n *\n * @remarks\n * Use {@link useHomeAddressManagement} when you need create, update, or delete actions.\n *\n * @param params - {@link UseHomeAddressSummaryParams}\n * @returns A {@link HookLoadingResult} while loading, or the ready state with `currentHomeAddress` and `employeeAddressList`.\n * @public\n */\nexport function useHomeAddressSummary({\n  employeeId,\n}: UseHomeAddressSummaryParams): UseHomeAddressSummaryResult {\n  const addressesQuery = useEmployeeAddressesGet({ employeeId }, { staleTime: Infinity })\n\n  const errorHandling = composeErrorHandler([addressesQuery])\n\n  if (addressesQuery.isLoading) {\n    return { isLoading: true, errorHandling }\n  }\n\n  const employeeAddressList = addressesQuery.data?.employeeAddressList ?? []\n  const currentHomeAddress = employeeAddressList.find(address => address.active)\n\n  return {\n    isLoading: false,\n    data: { currentHomeAddress, employeeAddressList },\n    status: {\n      isFetching: addressesQuery.isFetching,\n      isPending: false,\n    },\n    errorHandling,\n  }\n}\n"],"names":["useHomeAddressSummary","employeeId","addressesQuery","useEmployeeAddressesGet","errorHandling","composeErrorHandler","employeeAddressList","address"],"mappings":";;AAwCO,SAASA,EAAsB;AAAA,EACpC,YAAAC;AACF,GAA6D;AAC3D,QAAMC,IAAiBC,EAAwB,EAAE,YAAAF,EAAA,GAAc,EAAE,WAAW,OAAU,GAEhFG,IAAgBC,EAAoB,CAACH,CAAc,CAAC;AAE1D,MAAIA,EAAe;AACjB,WAAO,EAAE,WAAW,IAAM,eAAAE,EAAA;AAG5B,QAAME,IAAsBJ,EAAe,MAAM,uBAAuB,CAAA;AAGxE,SAAO;AAAA,IACL,WAAW;AAAA,IACX,MAAM,EAAE,oBAJiBI,EAAoB,KAAK,CAAAC,MAAWA,EAAQ,MAAM,GAI/C,qBAAAD,EAAA;AAAA,IAC5B,QAAQ;AAAA,MACN,YAAYJ,EAAe;AAAA,MAC3B,WAAW;AAAA,IAAA;AAAA,IAEb,eAAAE;AAAA,EAAA;AAEJ;"}

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

@@ -3,5 +3,11 @@ interface SummaryProps extends CommonComponentInterface<'Employee.Landing'> {
     employeeId: string;
     companyId: string;
 }
+/**
+ * Landing page for the employee self-onboarding flow. Displays a welcome
+ * message and the list of onboarding steps the employee needs to complete.
+ *
+ * @public
+ */
 export declare function Landing(props: SummaryProps & BaseComponentInterface): import("react").JSX.Element;
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"Landing.js","sources":["../../../../src/components/Employee/Landing/Landing.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { useEmployeesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { useCompaniesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/companiesGet'\nimport DOMPurify from 'dompurify'\nimport { useMemo } from 'react'\nimport {\n  BaseComponent,\n  useBase,\n  type BaseComponentInterface,\n  type CommonComponentInterface,\n} 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\ninterface SummaryProps extends CommonComponentInterface<'Employee.Landing'> {\n  employeeId: string\n  companyId: string\n}\n\nexport function Landing(props: SummaryProps & BaseComponentInterface) {\n  useI18n('Employee.Landing')\n  useComponentDictionary('Employee.Landing', props.dictionary)\n\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nconst Root = ({ employeeId, companyId, className }: SummaryProps) => {\n  const { onEvent } = useBase()\n  const Components = useComponentContext()\n\n  const {\n    data: { employee },\n  } = useEmployeesGetSuspense({ employeeId })\n  const sanitizedFirstName = useMemo(() => DOMPurify.sanitize(employee!.firstName), [employee])\n\n  const {\n    data: { company },\n  } = useCompaniesGetSuspense({ companyId })\n  const sanitizedCompanyName = useMemo(() => DOMPurify.sanitize(company?.name ?? ''), [company])\n\n  const { t } = useTranslation('Employee.Landing')\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.EMPLOYEE_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                firstName: sanitizedFirstName,\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={[t('steps.personalInfo'), t('steps.taxInfo'), t('steps.bankInfo')]}\n            />\n          </Flex>\n        </Flex>\n      </Components.Box>\n    </section>\n  )\n}\n"],"names":["Landing","props","useI18n","useComponentDictionary","jsx","BaseComponent","Root","employeeId","companyId","className","onEvent","useBase","Components","useComponentContext","employee","useEmployeesGetSuspense","sanitizedFirstName","useMemo","DOMPurify","company","useCompaniesGetSuspense","sanitizedCompanyName","t","useTranslation","ActionsLayout","jsxs","componentEvents","ArrowRightIcon","Flex"],"mappings":";;;;;;;;;;;;;;AAuBO,SAASA,EAAQC,GAA8C;AACpE,SAAAC,EAAQ,kBAAkB,GAC1BC,EAAuB,oBAAoBF,EAAM,UAAU,GAGzD,gBAAAG,EAACC,GAAA,EAAe,GAAGJ,GACjB,UAAA,gBAAAG,EAACE,KAAM,GAAGL,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,MAAMK,IAAO,CAAC,EAAE,YAAAC,GAAY,WAAAC,GAAW,WAAAC,QAA8B;AACnE,QAAM,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAaC,EAAA,GAEb;AAAA,IACJ,MAAM,EAAE,UAAAC,EAAA;AAAA,EAAS,IACfC,EAAwB,EAAE,YAAAR,GAAY,GACpCS,IAAqBC,EAAQ,MAAMC,EAAU,SAASJ,EAAU,SAAS,GAAG,CAACA,CAAQ,CAAC,GAEtF;AAAA,IACJ,MAAM,EAAE,SAAAK,EAAA;AAAA,EAAQ,IACdC,EAAwB,EAAE,WAAAZ,GAAW,GACnCa,IAAuBJ,EAAQ,MAAMC,EAAU,SAASC,GAAS,QAAQ,EAAE,GAAG,CAACA,CAAO,CAAC,GAEvF,EAAE,GAAAG,EAAA,IAAMC,EAAe,kBAAkB;AAE/C,SACE,gBAAAnB,EAAC,aAAQ,WAAAK,GACP,UAAA,gBAAAL;AAAA,IAACQ,EAAW;AAAA,IAAX;AAAA,MACC,0BACGY,GAAA,EACC,UAAA,gBAAAC;AAAA,QAACb,EAAW;AAAA,QAAX;AAAA,UACC,SAAQ;AAAA,UACR,SAAS,MAAM;AACb,YAAAF,EAAQgB,EAAgB,8BAA8B;AAAA,UACxD;AAAA,UAEC,UAAA;AAAA,YAAAJ,EAAE,eAAe;AAAA,YAClB,gBAAAlB,EAACuB,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,gBAAAxB,EAACQ,EAAW,SAAX,EAAmB,IAAG,MACpB,YAAE,mBAAmB;AAAA,YACpB,WAAWI;AAAA,YACX,aAAaK;AAAA,YACb,eAAe,EAAE,aAAa,GAAA;AAAA,UAAM,CACrC,GACH;AAAA,UACA,gBAAAjB,EAACQ,EAAW,MAAX,EAAgB,SAAQ,cAAc,UAAAU,EAAE,oBAAoB,EAAA,CAAE;AAAA,QAAA,GACjE;AAAA,QACA,gBAAAG,EAACG,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAAxB,EAACQ,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAU,EAAE,eAAe,GAAE;AAAA,UAChD,gBAAAlB;AAAA,YAACQ,EAAW;AAAA,YAAX;AAAA,cACC,OAAO,CAACU,EAAE,oBAAoB,GAAGA,EAAE,eAAe,GAAGA,EAAE,gBAAgB,CAAC;AAAA,YAAA;AAAA,UAAA;AAAA,QAC1E,EAAA,CACF;AAAA,MAAA,EAAA,CACF;AAAA,IAAA;AAAA,EAAA,GAEJ;AAEJ;"}
+{"version":3,"file":"Landing.js","sources":["../../../../src/components/Employee/Landing/Landing.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport { useEmployeesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { useCompaniesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/companiesGet'\nimport DOMPurify from 'dompurify'\nimport { useMemo } from 'react'\nimport {\n  BaseComponent,\n  useBase,\n  type BaseComponentInterface,\n  type CommonComponentInterface,\n} 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\ninterface SummaryProps extends CommonComponentInterface<'Employee.Landing'> {\n  employeeId: string\n  companyId: string\n}\n\n/**\n * Landing page for the employee self-onboarding flow. Displays a welcome\n * message and the list of onboarding steps the employee needs to complete.\n *\n * @public\n */\nexport function Landing(props: SummaryProps & BaseComponentInterface) {\n  useI18n('Employee.Landing')\n  useComponentDictionary('Employee.Landing', props.dictionary)\n\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nconst Root = ({ employeeId, companyId, className }: SummaryProps) => {\n  const { onEvent } = useBase()\n  const Components = useComponentContext()\n\n  const {\n    data: { employee },\n  } = useEmployeesGetSuspense({ employeeId })\n  const sanitizedFirstName = useMemo(() => DOMPurify.sanitize(employee!.firstName), [employee])\n\n  const {\n    data: { company },\n  } = useCompaniesGetSuspense({ companyId })\n  const sanitizedCompanyName = useMemo(() => DOMPurify.sanitize(company?.name ?? ''), [company])\n\n  const { t } = useTranslation('Employee.Landing')\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.EMPLOYEE_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                firstName: sanitizedFirstName,\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={[t('steps.personalInfo'), t('steps.taxInfo'), t('steps.bankInfo')]}\n            />\n          </Flex>\n        </Flex>\n      </Components.Box>\n    </section>\n  )\n}\n"],"names":["Landing","props","useI18n","useComponentDictionary","jsx","BaseComponent","Root","employeeId","companyId","className","onEvent","useBase","Components","useComponentContext","employee","useEmployeesGetSuspense","sanitizedFirstName","useMemo","DOMPurify","company","useCompaniesGetSuspense","sanitizedCompanyName","t","useTranslation","ActionsLayout","jsxs","componentEvents","ArrowRightIcon","Flex"],"mappings":";;;;;;;;;;;;;;AA6BO,SAASA,EAAQC,GAA8C;AACpE,SAAAC,EAAQ,kBAAkB,GAC1BC,EAAuB,oBAAoBF,EAAM,UAAU,GAGzD,gBAAAG,EAACC,GAAA,EAAe,GAAGJ,GACjB,UAAA,gBAAAG,EAACE,KAAM,GAAGL,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,MAAMK,IAAO,CAAC,EAAE,YAAAC,GAAY,WAAAC,GAAW,WAAAC,QAA8B;AACnE,QAAM,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAaC,EAAA,GAEb;AAAA,IACJ,MAAM,EAAE,UAAAC,EAAA;AAAA,EAAS,IACfC,EAAwB,EAAE,YAAAR,GAAY,GACpCS,IAAqBC,EAAQ,MAAMC,EAAU,SAASJ,EAAU,SAAS,GAAG,CAACA,CAAQ,CAAC,GAEtF;AAAA,IACJ,MAAM,EAAE,SAAAK,EAAA;AAAA,EAAQ,IACdC,EAAwB,EAAE,WAAAZ,GAAW,GACnCa,IAAuBJ,EAAQ,MAAMC,EAAU,SAASC,GAAS,QAAQ,EAAE,GAAG,CAACA,CAAO,CAAC,GAEvF,EAAE,GAAAG,EAAA,IAAMC,EAAe,kBAAkB;AAE/C,SACE,gBAAAnB,EAAC,aAAQ,WAAAK,GACP,UAAA,gBAAAL;AAAA,IAACQ,EAAW;AAAA,IAAX;AAAA,MACC,0BACGY,GAAA,EACC,UAAA,gBAAAC;AAAA,QAACb,EAAW;AAAA,QAAX;AAAA,UACC,SAAQ;AAAA,UACR,SAAS,MAAM;AACb,YAAAF,EAAQgB,EAAgB,8BAA8B;AAAA,UACxD;AAAA,UAEC,UAAA;AAAA,YAAAJ,EAAE,eAAe;AAAA,YAClB,gBAAAlB,EAACuB,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,gBAAAxB,EAACQ,EAAW,SAAX,EAAmB,IAAG,MACpB,YAAE,mBAAmB;AAAA,YACpB,WAAWI;AAAA,YACX,aAAaK;AAAA,YACb,eAAe,EAAE,aAAa,GAAA;AAAA,UAAM,CACrC,GACH;AAAA,UACA,gBAAAjB,EAACQ,EAAW,MAAX,EAAgB,SAAQ,cAAc,UAAAU,EAAE,oBAAoB,EAAA,CAAE;AAAA,QAAA,GACjE;AAAA,QACA,gBAAAG,EAACG,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,UAAA,gBAAAxB,EAACQ,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAAU,EAAE,eAAe,GAAE;AAAA,UAChD,gBAAAlB;AAAA,YAACQ,EAAW;AAAA,YAAX;AAAA,cACC,OAAO,CAACU,EAAE,oBAAoB,GAAGA,EAAE,eAAe,GAAGA,EAAE,gBAAgB,CAAC;AAAA,YAAA;AAAA,UAAA;AAAA,QAC1E,EAAA,CACF;AAAA,MAAA,EAAA,CACF;AAAA,IAAA;AAAA,EAAA,GAEJ;AAEJ;"}

package/dist/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlow.d.ts

@@ -2,15 +2,58 @@ import { OnboardingExecutionInitialState } from './onboardingExecutionStateMachi
 import { OnboardingDefaultValues } from './OnboardingExecutionFlowComponents';
 import { OnEventType } from '../../Base/useBase';
 import { EventType, EmployeeOnboardingStatus } from '../../../shared/constants';
+/**
+ * Props for {@link OnboardingExecutionFlow}.
+ *
+ * @public
+ */
 export interface OnboardingExecutionFlowProps {
+    /** The associated company identifier. */
     companyId: string;
+    /** Callback invoked when the flow emits an event. */
     onEvent: OnEventType<EventType, unknown>;
+    /** The step the flow starts on. Defaults to `employeeProfile`. */
     initialState?: OnboardingExecutionInitialState;
+    /** The associated employee identifier to resume onboarding for. Omit to begin onboarding a new employee. */
     initialEmployeeId?: string;
+    /** The current onboarding status of the employee being onboarded. Drives skip behavior for self-onboarding and document steps. */
     initialOnboardingStatus?: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus];
+    /** Default values for individual flow step components. */
     defaultValues?: OnboardingDefaultValues;
+    /** When true, the flow renders in the admin context. When false, it is configured for employee self-onboarding. Defaults to `true`. */
     isAdmin?: boolean;
+    /** When true, presents the self-onboarding toggle on the profile step. Defaults to `true`. */
     isSelfOnboardingEnabled?: boolean;
+    /** When true, enables the Employee Documents step in the flow, allowing the admin to configure I-9 document requirements. Defaults to `false`. */
     withEmployeeI9?: boolean;
 }
+/**
+ * The multi-step onboarding execution flow — profile, compensation, taxes, payment method, deductions, documents, and summary.
+ *
+ * @remarks
+ * Drives the per-employee onboarding experience used by both {@link OnboardingFlow} (admin) and {@link SelfOnboardingFlow} (employee). Each step is also exported as a standalone block — see {@link Profile}, {@link Compensation}, {@link FederalTaxes}, {@link StateTaxes}, {@link PaymentMethod}, {@link Deductions}, {@link EmployeeDocuments}, and {@link OnboardingSummary} — for composing a custom workflow when this orchestration is the wrong fit.
+ *
+ * Self-onboarding statuses cause the federal-taxes, state-taxes, and payment-method steps to be skipped (the employee fills those in themselves); the documents step is also skipped unless `withEmployeeI9` is true and the documents config has not yet been completed.
+ *
+ * The flow forwards every event emitted by its sub-components to `onEvent`; see the events table on each sub-component for the full set of events and payloads observable from this flow.
+ *
+ * @param props - See {@link OnboardingExecutionFlowProps}.
+ * @returns The multi-step onboarding execution flow.
+ * @public
+ * @group Flow Components
+ *
+ * @example
+ * ```tsx
+ * import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'
+ *
+ * function MyApp() {
+ *   return (
+ *     <EmployeeOnboarding.OnboardingExecutionFlow
+ *       companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365"
+ *       onEvent={() => {}}
+ *     />
+ *   )
+ * }
+ * ```
+ */
 export declare function OnboardingExecutionFlow({ companyId, onEvent, initialState, initialEmployeeId, initialOnboardingStatus, defaultValues, isAdmin, isSelfOnboardingEnabled, withEmployeeI9, }: OnboardingExecutionFlowProps): import("react").JSX.Element;

package/dist/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlow.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnboardingExecutionFlow.js","sources":["../../../../src/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport {\n  onboardingExecutionMachine,\n  INITIAL_COMPONENT_MAP,\n  type OnboardingExecutionInitialState,\n} from './onboardingExecutionStateMachine'\nimport {\n  type OnboardingContextInterface,\n  type OnboardingDefaultValues,\n} from './OnboardingExecutionFlowComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { OnEventType } from '@/components/Base/useBase'\nimport type { EventType, EmployeeOnboardingStatus } from '@/shared/constants'\n\nexport interface OnboardingExecutionFlowProps {\n  companyId: string\n  onEvent: OnEventType<EventType, unknown>\n  initialState?: OnboardingExecutionInitialState\n  initialEmployeeId?: string\n  initialOnboardingStatus?: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n  defaultValues?: OnboardingDefaultValues\n  isAdmin?: boolean\n  isSelfOnboardingEnabled?: boolean\n  withEmployeeI9?: boolean\n}\n\nexport function OnboardingExecutionFlow({\n  companyId,\n  onEvent,\n  initialState = 'employeeProfile',\n  initialEmployeeId,\n  initialOnboardingStatus,\n  defaultValues,\n  isAdmin = true,\n  isSelfOnboardingEnabled = true,\n  withEmployeeI9 = false,\n}: OnboardingExecutionFlowProps) {\n  const machine = useMemo(\n    () =>\n      createMachine(\n        initialState,\n        onboardingExecutionMachine,\n        (initialContext: OnboardingContextInterface) => ({\n          ...initialContext,\n          component: INITIAL_COMPONENT_MAP[initialState],\n          companyId,\n          employeeId: initialEmployeeId,\n          onboardingStatus: initialOnboardingStatus,\n          defaultValues,\n          isAdmin,\n          isSelfOnboardingEnabled,\n          withEmployeeI9,\n        }),\n      ),\n    [\n      companyId,\n      initialState,\n      initialEmployeeId,\n      initialOnboardingStatus,\n      defaultValues,\n      isAdmin,\n      isSelfOnboardingEnabled,\n      withEmployeeI9,\n    ],\n  )\n\n  return <Flow machine={machine} onEvent={onEvent} />\n}\n"],"names":["OnboardingExecutionFlow","companyId","onEvent","initialState","initialEmployeeId","initialOnboardingStatus","defaultValues","isAdmin","isSelfOnboardingEnabled","withEmployeeI9","machine","useMemo","createMachine","onboardingExecutionMachine","initialContext","INITIAL_COMPONENT_MAP","jsx","Flow"],"mappings":";;;;;AA2BO,SAASA,EAAwB;AAAA,EACtC,WAAAC;AAAA,EACA,SAAAC;AAAA,EACA,cAAAC,IAAe;AAAA,EACf,mBAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAAC;AAAA,EACA,SAAAC,IAAU;AAAA,EACV,yBAAAC,IAA0B;AAAA,EAC1B,gBAAAC,IAAiB;AACnB,GAAiC;AAC/B,QAAMC,IAAUC;AAAA,IACd,MACEC;AAAA,MACET;AAAA,MACAU;AAAA,MACA,CAACC,OAAgD;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWC,EAAsBZ,CAAY;AAAA,QAC7C,WAAAF;AAAA,QACA,YAAYG;AAAA,QACZ,kBAAkBC;AAAA,QAClB,eAAAC;AAAA,QACA,SAAAC;AAAA,QACA,yBAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ;AAAA,MACER;AAAA,MACAE;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,IAAA;AAAA,EACF;AAGF,SAAO,gBAAAO,EAACC,GAAA,EAAK,SAAAP,GAAkB,SAAAR,EAAA,CAAkB;AACnD;"}
+{"version":3,"file":"OnboardingExecutionFlow.js","sources":["../../../../src/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport {\n  onboardingExecutionMachine,\n  INITIAL_COMPONENT_MAP,\n  type OnboardingExecutionInitialState,\n} from './onboardingExecutionStateMachine'\nimport {\n  type OnboardingContextInterface,\n  type OnboardingDefaultValues,\n} from './OnboardingExecutionFlowComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { OnEventType } from '@/components/Base/useBase'\nimport type { EventType, EmployeeOnboardingStatus } from '@/shared/constants'\n\n/**\n * Props for {@link OnboardingExecutionFlow}.\n *\n * @public\n */\nexport interface OnboardingExecutionFlowProps {\n  /** The associated company identifier. */\n  companyId: string\n  /** Callback invoked when the flow emits an event. */\n  onEvent: OnEventType<EventType, unknown>\n  /** The step the flow starts on. Defaults to `employeeProfile`. */\n  initialState?: OnboardingExecutionInitialState\n  /** The associated employee identifier to resume onboarding for. Omit to begin onboarding a new employee. */\n  initialEmployeeId?: string\n  /** The current onboarding status of the employee being onboarded. Drives skip behavior for self-onboarding and document steps. */\n  initialOnboardingStatus?: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n  /** Default values for individual flow step components. */\n  defaultValues?: OnboardingDefaultValues\n  /** When true, the flow renders in the admin context. When false, it is configured for employee self-onboarding. Defaults to `true`. */\n  isAdmin?: boolean\n  /** When true, presents the self-onboarding toggle on the profile step. Defaults to `true`. */\n  isSelfOnboardingEnabled?: boolean\n  /** When true, enables the Employee Documents step in the flow, allowing the admin to configure I-9 document requirements. Defaults to `false`. */\n  withEmployeeI9?: boolean\n}\n\n/**\n * The multi-step onboarding execution flow — profile, compensation, taxes, payment method, deductions, documents, and summary.\n *\n * @remarks\n * Drives the per-employee onboarding experience used by both {@link OnboardingFlow} (admin) and {@link SelfOnboardingFlow} (employee). Each step is also exported as a standalone block — see {@link Profile}, {@link Compensation}, {@link FederalTaxes}, {@link StateTaxes}, {@link PaymentMethod}, {@link Deductions}, {@link EmployeeDocuments}, and {@link OnboardingSummary} — for composing a custom workflow when this orchestration is the wrong fit.\n *\n * Self-onboarding statuses cause the federal-taxes, state-taxes, and payment-method steps to be skipped (the employee fills those in themselves); the documents step is also skipped unless `withEmployeeI9` is true and the documents config has not yet been completed.\n *\n * The flow forwards every event emitted by its sub-components to `onEvent`; see the events table on each sub-component for the full set of events and payloads observable from this flow.\n *\n * @param props - See {@link OnboardingExecutionFlowProps}.\n * @returns The multi-step onboarding execution flow.\n * @public\n * @group Flow Components\n *\n * @example\n * ```tsx\n * import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'\n *\n * function MyApp() {\n *   return (\n *     <EmployeeOnboarding.OnboardingExecutionFlow\n *       companyId=\"a007e1ab-3595-43c2-ab4b-af7a5af2e365\"\n *       onEvent={() => {}}\n *     />\n *   )\n * }\n * ```\n */\nexport function OnboardingExecutionFlow({\n  companyId,\n  onEvent,\n  initialState = 'employeeProfile',\n  initialEmployeeId,\n  initialOnboardingStatus,\n  defaultValues,\n  isAdmin = true,\n  isSelfOnboardingEnabled = true,\n  withEmployeeI9 = false,\n}: OnboardingExecutionFlowProps) {\n  const machine = useMemo(\n    () =>\n      createMachine(\n        initialState,\n        onboardingExecutionMachine,\n        (initialContext: OnboardingContextInterface) => ({\n          ...initialContext,\n          component: INITIAL_COMPONENT_MAP[initialState],\n          companyId,\n          employeeId: initialEmployeeId,\n          onboardingStatus: initialOnboardingStatus,\n          defaultValues,\n          isAdmin,\n          isSelfOnboardingEnabled,\n          withEmployeeI9,\n        }),\n      ),\n    [\n      companyId,\n      initialState,\n      initialEmployeeId,\n      initialOnboardingStatus,\n      defaultValues,\n      isAdmin,\n      isSelfOnboardingEnabled,\n      withEmployeeI9,\n    ],\n  )\n\n  return <Flow machine={machine} onEvent={onEvent} />\n}\n"],"names":["OnboardingExecutionFlow","companyId","onEvent","initialState","initialEmployeeId","initialOnboardingStatus","defaultValues","isAdmin","isSelfOnboardingEnabled","withEmployeeI9","machine","useMemo","createMachine","onboardingExecutionMachine","initialContext","INITIAL_COMPONENT_MAP","jsx","Flow"],"mappings":";;;;;AAsEO,SAASA,EAAwB;AAAA,EACtC,WAAAC;AAAA,EACA,SAAAC;AAAA,EACA,cAAAC,IAAe;AAAA,EACf,mBAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAAC;AAAA,EACA,SAAAC,IAAU;AAAA,EACV,yBAAAC,IAA0B;AAAA,EAC1B,gBAAAC,IAAiB;AACnB,GAAiC;AAC/B,QAAMC,IAAUC;AAAA,IACd,MACEC;AAAA,MACET;AAAA,MACAU;AAAA,MACA,CAACC,OAAgD;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWC,EAAsBZ,CAAY;AAAA,QAC7C,WAAAF;AAAA,QACA,YAAYG;AAAA,QACZ,kBAAkBC;AAAA,QAClB,eAAAC;AAAA,QACA,SAAAC;AAAA,QACA,yBAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ;AAAA,MACER;AAAA,MACAE;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,IAAA;AAAA,EACF;AAGF,SAAO,gBAAAO,EAACC,GAAA,EAAK,SAAAP,GAAkB,SAAAR,EAAA,CAAkB;AACnD;"}

package/dist/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlowComponents.d.ts

@@ -4,10 +4,24 @@ import { CompensationDefaultValues } from '../Compensation';
 import { FlowContextInterface } from '../../Flow/useFlow';
 import { EmployeeOnboardingStatus } from '../../../shared/constants';
 import { RequireAtLeastOne } from '../../../types/Helpers';
+/**
+ * Default values for the onboarding flow's per-step form components.
+ *
+ * @remarks
+ * At least one of the step-level keys must be provided. Per-step values are
+ * forwarded to the matching step component (e.g. `profile` to {@link Profile},
+ * `compensation` to {@link Compensation}). If employee data is available via
+ * the API, the corresponding values are overwritten.
+ *
+ * @public
+ */
 export type OnboardingDefaultValues = RequireAtLeastOne<{
+    /** Default values for the profile step. */
     profile?: ProfileDefaultValues;
+    /** Default values for the compensation step. */
     compensation?: CompensationDefaultValues;
 }>;
+/** @internal */
 export interface OnboardingContextInterface extends FlowContextInterface {
     companyId: string;
     employeeId?: string;
@@ -19,6 +33,9 @@ export interface OnboardingContextInterface extends FlowContextInterface {
     isSelfOnboardingEnabled?: boolean;
     withEmployeeI9?: boolean;
 }
+/** @internal */
 export declare function FederalTaxesContextual(): import("react").JSX.Element;
+/** @internal */
 export declare function StateTaxesContextual(): import("react").JSX.Element;
+/** @internal */
 export declare function DeductionsContextual(): import("react").JSX.Element;

package/dist/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlowComponents.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnboardingExecutionFlowComponents.js","sources":["../../../../src/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlowComponents.tsx"],"sourcesContent":["import type { PaymentMethodBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/paymentmethodbankaccount'\nimport { Deductions } from '../Deductions/onboarding/Deductions'\nimport { FederalTaxes } from '../FederalTaxes/onboarding/FederalTaxes'\nimport { StateTaxes } from '../StateTaxes/onboarding/StateTaxes'\nimport type { ProfileDefaultValues } from '../Profile/onboarding/Profile'\nimport type { CompensationDefaultValues } from '../Compensation'\nimport { ensureRequired } from '@/helpers/ensureRequired'\nimport { useFlow, type FlowContextInterface } from '@/components/Flow/useFlow'\nimport type { EmployeeOnboardingStatus } from '@/shared/constants'\nimport type { RequireAtLeastOne } from '@/types/Helpers'\n\nexport type OnboardingDefaultValues = RequireAtLeastOne<{\n  profile?: ProfileDefaultValues\n  compensation?: CompensationDefaultValues\n}>\n\nexport interface OnboardingContextInterface extends FlowContextInterface {\n  companyId: string\n  employeeId?: string\n  isAdmin?: boolean\n  onboardingStatus?: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n  startDate?: string\n  paymentMethod?: PaymentMethodBankAccount\n  defaultValues?: OnboardingDefaultValues\n  isSelfOnboardingEnabled?: boolean\n  withEmployeeI9?: boolean\n}\n\nexport function FederalTaxesContextual() {\n  const { employeeId, onEvent } = useFlow<OnboardingContextInterface>()\n  return <FederalTaxes onEvent={onEvent} employeeId={ensureRequired(employeeId)} />\n}\n\nexport function StateTaxesContextual() {\n  const { employeeId, onEvent, isAdmin } = useFlow<OnboardingContextInterface>()\n  return <StateTaxes onEvent={onEvent} employeeId={ensureRequired(employeeId)} isAdmin={isAdmin} />\n}\n\nexport function DeductionsContextual() {\n  const { employeeId, onEvent } = useFlow<OnboardingContextInterface>()\n  return <Deductions onEvent={onEvent} employeeId={ensureRequired(employeeId)} />\n}\n"],"names":["FederalTaxesContextual","employeeId","onEvent","useFlow","FederalTaxes","ensureRequired","StateTaxesContextual","isAdmin","StateTaxes","DeductionsContextual","Deductions"],"mappings":";;;;;;AA4BO,SAASA,IAAyB;AACvC,QAAM,EAAE,YAAAC,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQC,GAAA,EAAa,SAAAF,GAAkB,YAAYG,EAAeJ,CAAU,GAAG;AACjF;AAEO,SAASK,IAAuB;AACrC,QAAM,EAAE,YAAAL,GAAY,SAAAC,GAAS,SAAAK,EAAA,IAAYJ,EAAA;AACzC,2BAAQK,GAAA,EAAW,SAAAN,GAAkB,YAAYG,EAAeJ,CAAU,GAAG,SAAAM,GAAkB;AACjG;AAEO,SAASE,IAAuB;AACrC,QAAM,EAAE,YAAAR,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQO,GAAA,EAAW,SAAAR,GAAkB,YAAYG,EAAeJ,CAAU,GAAG;AAC/E;"}
+{"version":3,"file":"OnboardingExecutionFlowComponents.js","sources":["../../../../src/components/Employee/OnboardingExecutionFlow/OnboardingExecutionFlowComponents.tsx"],"sourcesContent":["import type { PaymentMethodBankAccount } from '@gusto/embedded-api-v-2025-11-15/models/components/paymentmethodbankaccount'\nimport { Deductions } from '../Deductions/onboarding/Deductions'\nimport { FederalTaxes } from '../FederalTaxes/onboarding/FederalTaxes'\nimport { StateTaxes } from '../StateTaxes/onboarding/StateTaxes'\nimport type { ProfileDefaultValues } from '../Profile/onboarding/Profile'\nimport type { CompensationDefaultValues } from '../Compensation'\nimport { ensureRequired } from '@/helpers/ensureRequired'\nimport { useFlow, type FlowContextInterface } from '@/components/Flow/useFlow'\nimport type { EmployeeOnboardingStatus } from '@/shared/constants'\nimport type { RequireAtLeastOne } from '@/types/Helpers'\n\n/**\n * Default values for the onboarding flow's per-step form components.\n *\n * @remarks\n * At least one of the step-level keys must be provided. Per-step values are\n * forwarded to the matching step component (e.g. `profile` to {@link Profile},\n * `compensation` to {@link Compensation}). If employee data is available via\n * the API, the corresponding values are overwritten.\n *\n * @public\n */\nexport type OnboardingDefaultValues = RequireAtLeastOne<{\n  /** Default values for the profile step. */\n  profile?: ProfileDefaultValues\n  /** Default values for the compensation step. */\n  compensation?: CompensationDefaultValues\n}>\n\n/** @internal */\nexport interface OnboardingContextInterface extends FlowContextInterface {\n  companyId: string\n  employeeId?: string\n  isAdmin?: boolean\n  onboardingStatus?: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n  startDate?: string\n  paymentMethod?: PaymentMethodBankAccount\n  defaultValues?: OnboardingDefaultValues\n  isSelfOnboardingEnabled?: boolean\n  withEmployeeI9?: boolean\n}\n\n/** @internal */\nexport function FederalTaxesContextual() {\n  const { employeeId, onEvent } = useFlow<OnboardingContextInterface>()\n  return <FederalTaxes onEvent={onEvent} employeeId={ensureRequired(employeeId)} />\n}\n\n/** @internal */\nexport function StateTaxesContextual() {\n  const { employeeId, onEvent, isAdmin } = useFlow<OnboardingContextInterface>()\n  return <StateTaxes onEvent={onEvent} employeeId={ensureRequired(employeeId)} isAdmin={isAdmin} />\n}\n\n/** @internal */\nexport function DeductionsContextual() {\n  const { employeeId, onEvent } = useFlow<OnboardingContextInterface>()\n  return <Deductions onEvent={onEvent} employeeId={ensureRequired(employeeId)} />\n}\n"],"names":["FederalTaxesContextual","employeeId","onEvent","useFlow","FederalTaxes","ensureRequired","StateTaxesContextual","isAdmin","StateTaxes","DeductionsContextual","Deductions"],"mappings":";;;;;;AA2CO,SAASA,IAAyB;AACvC,QAAM,EAAE,YAAAC,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQC,GAAA,EAAa,SAAAF,GAAkB,YAAYG,EAAeJ,CAAU,GAAG;AACjF;AAGO,SAASK,IAAuB;AACrC,QAAM,EAAE,YAAAL,GAAY,SAAAC,GAAS,SAAAK,EAAA,IAAYJ,EAAA;AACzC,2BAAQK,GAAA,EAAW,SAAAN,GAAkB,YAAYG,EAAeJ,CAAU,GAAG,SAAAM,GAAkB;AACjG;AAGO,SAASE,IAAuB;AACrC,QAAM,EAAE,YAAAR,GAAY,SAAAC,EAAA,IAAYC,EAAA;AAChC,2BAAQO,GAAA,EAAW,SAAAR,GAAkB,YAAYG,EAAeJ,CAAU,GAAG;AAC/E;"}

package/dist/components/Employee/OnboardingExecutionFlow/index.d.ts

@@ -1,4 +1,4 @@
 import "./types/i18next.d.ts"
 export { OnboardingExecutionFlow, type OnboardingExecutionFlowProps, } from './OnboardingExecutionFlow';
-export { onboardingExecutionMachine, type OnboardingExecutionInitialState, } from './onboardingExecutionStateMachine';
-export type { OnboardingContextInterface, OnboardingDefaultValues, } from './OnboardingExecutionFlowComponents';
+export { type OnboardingDefaultValues } from './OnboardingExecutionFlowComponents';
+export { type OnboardingExecutionInitialState } from './onboardingExecutionStateMachine';

package/dist/components/Employee/OnboardingExecutionFlow/onboardingExecutionStateMachine.d.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export declare const onboardingExecutionMachine: {
     employeeProfile: import('robot3').MachineState<any>;
     compensation: import('robot3').MachineState<any>;
@@ -8,7 +9,13 @@ export declare const onboardingExecutionMachine: {
     employeeDocuments: import('robot3').MachineState<any>;
     summary: import('robot3').MachineState<any>;
 };
+/** @internal */
 export declare const INITIAL_COMPONENT_MAP: {
     readonly employeeProfile: () => import("react").JSX.Element;
 };
+/**
+ * The set of steps {@link OnboardingExecutionFlow} can be started on.
+ *
+ * @public
+ */
 export type OnboardingExecutionInitialState = keyof typeof INITIAL_COMPONENT_MAP;

package/dist/components/Employee/OnboardingExecutionFlow/onboardingExecutionStateMachine.js.map

@@ -1 +1 @@
-{"version":3,"file":"onboardingExecutionStateMachine.js","sources":["../../../../src/components/Employee/OnboardingExecutionFlow/onboardingExecutionStateMachine.ts"],"sourcesContent":["import { transition, reduce, state, guard } from 'robot3'\nimport {\n  FederalTaxesContextual,\n  StateTaxesContextual,\n  DeductionsContextual,\n  type OnboardingContextInterface,\n} from './OnboardingExecutionFlowComponents'\nimport {\n  componentEvents,\n  EmployeeSelfOnboardingStatuses,\n  EmployeeOnboardingStatus,\n} from '@/shared/constants'\nimport type { MachineEventType, MachineTransition } from '@/types/Helpers'\nimport { CompensationContextual } from '@/components/Employee/Compensation'\nimport { EmployeeDocumentsContextual } from '@/components/Employee/Documents/onboarding/EmployeeDocuments'\nimport { PaymentMethodContextual } from '@/components/Employee/PaymentMethod'\nimport { ProfileContextual } from '@/components/Employee/Profile/onboarding/Profile'\nimport { OnboardingSummaryContextual } from '@/components/Employee/OnboardingSummary'\n\ntype EventPayloads = {\n  [componentEvents.EMPLOYEE_PROFILE_DONE]: {\n    uuid: string\n    onboardingStatus: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n    startDate: string\n  }\n}\n\nconst createReducer = (props: Partial<OnboardingContextInterface>) => {\n  return (ctx: OnboardingContextInterface): OnboardingContextInterface => ({\n    ...ctx,\n    ...props,\n  })\n}\n\nconst employeeDocumentsConfigCompletedStatuses: Set<\n  (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n> = new Set([\n  EmployeeOnboardingStatus.SELF_ONBOARDING_COMPLETED_BY_EMPLOYEE,\n  EmployeeOnboardingStatus.SELF_ONBOARDING_AWAITING_ADMIN_REVIEW,\n  EmployeeOnboardingStatus.ONBOARDING_COMPLETED,\n])\n\nconst employeeDocumentsGuard = (ctx: OnboardingContextInterface) => {\n  if (!ctx.withEmployeeI9) return false\n  if (ctx.onboardingStatus && employeeDocumentsConfigCompletedStatuses.has(ctx.onboardingStatus))\n    return false\n  return true\n}\n\nconst selfOnboardingGuard = (ctx: OnboardingContextInterface) =>\n  ctx.onboardingStatus\n    ? !(\n        // prettier-ignore\n        // @ts-expect-error: onboarding_status during runtime can be one of self onboarding statuses\n        (EmployeeSelfOnboardingStatuses.has(ctx.onboardingStatus) ||\n        ctx.onboardingStatus === EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE)\n      )\n    : true\n\nexport const onboardingExecutionMachine = {\n  employeeProfile: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_PROFILE_DONE,\n      'compensation',\n      reduce(\n        (\n          ctx: OnboardingContextInterface,\n          ev: MachineEventType<EventPayloads, typeof componentEvents.EMPLOYEE_PROFILE_DONE>,\n        ): OnboardingContextInterface => ({\n          ...ctx,\n          component: CompensationContextual,\n          employeeId: ev.payload.uuid,\n          onboardingStatus: ev.payload.onboardingStatus,\n          startDate: ev.payload.startDate,\n        }),\n      ),\n    ),\n  ),\n  compensation: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_COMPENSATION_DONE,\n      'federalTaxes',\n      reduce(createReducer({ component: FederalTaxesContextual })),\n      guard(selfOnboardingGuard),\n    ),\n    transition(\n      componentEvents.EMPLOYEE_COMPENSATION_DONE,\n      'deductions',\n      reduce(createReducer({ component: DeductionsContextual })),\n    ),\n  ),\n  federalTaxes: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_FEDERAL_TAXES_DONE,\n      'stateTaxes',\n      reduce(createReducer({ component: StateTaxesContextual })),\n      guard(selfOnboardingGuard),\n    ),\n  ),\n  stateTaxes: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_STATE_TAXES_DONE,\n      'paymentMethod',\n      reduce(createReducer({ component: PaymentMethodContextual })),\n      guard(selfOnboardingGuard),\n    ),\n  ),\n  paymentMethod: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_PAYMENT_METHOD_DONE,\n      'deductions',\n      reduce(createReducer({ component: DeductionsContextual })),\n    ),\n  ),\n  deductions: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_DEDUCTION_DONE,\n      'employeeDocuments',\n      reduce(createReducer({ component: EmployeeDocumentsContextual })),\n      guard(employeeDocumentsGuard),\n    ),\n    transition(\n      componentEvents.EMPLOYEE_DEDUCTION_DONE,\n      'summary',\n      reduce(createReducer({ component: OnboardingSummaryContextual })),\n    ),\n  ),\n  employeeDocuments: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_DOCUMENTS_DONE,\n      'summary',\n      reduce(createReducer({ component: OnboardingSummaryContextual })),\n    ),\n  ),\n  summary: state<MachineTransition>(),\n}\n\nexport const INITIAL_COMPONENT_MAP = {\n  employeeProfile: ProfileContextual,\n} as const\n\nexport type OnboardingExecutionInitialState = keyof typeof INITIAL_COMPONENT_MAP\n"],"names":["createReducer","props","ctx","employeeDocumentsConfigCompletedStatuses","EmployeeOnboardingStatus","employeeDocumentsGuard","selfOnboardingGuard","EmployeeSelfOnboardingStatuses","onboardingExecutionMachine","state","transition","componentEvents","reduce","ev","CompensationContextual","FederalTaxesContextual","guard","DeductionsContextual","StateTaxesContextual","PaymentMethodContextual","EmployeeDocumentsContextual","OnboardingSummaryContextual","INITIAL_COMPONENT_MAP","ProfileContextual"],"mappings":";;;;;;;;AA2BA,MAAMA,IAAgB,CAACC,MACd,CAACC,OAAiE;AAAA,EACvE,GAAGA;AAAA,EACH,GAAGD;AAAA,IAIDE,wBAEE,IAAI;AAAA,EACVC,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAC3B,CAAC,GAEKC,IAAyB,CAACH,MAC1B,GAACA,EAAI,kBACLA,EAAI,oBAAoBC,EAAyC,IAAID,EAAI,gBAAgB,IAKzFI,IAAsB,CAACJ,MAC3BA,EAAI,mBACA;AAAA;AAAA,CAGGK,EAA+B,IAAIL,EAAI,gBAAgB,KACxDA,EAAI,qBAAqBE,EAAyB,kCAEpD,IAEOI,IAA6B;AAAA,EACxC,iBAAiBC;AAAA,IACfC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CACEV,GACAW,OACgC;AAAA,UAChC,GAAGX;AAAA,UACH,WAAWY;AAAA,UACX,YAAYD,EAAG,QAAQ;AAAA,UACvB,kBAAkBA,EAAG,QAAQ;AAAA,UAC7B,WAAWA,EAAG,QAAQ;AAAA,QAAA;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AAAA,EAEF,cAAcJ;AAAA,IACZC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWe,EAAA,CAAwB,CAAC;AAAA,MAC3DC,EAAMV,CAAmB;AAAA,IAAA;AAAA,IAE3BI;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWiB,EAAA,CAAsB,CAAC;AAAA,IAAA;AAAA,EAC3D;AAAA,EAEF,cAAcR;AAAA,IACZC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWkB,EAAA,CAAsB,CAAC;AAAA,MACzDF,EAAMV,CAAmB;AAAA,IAAA;AAAA,EAC3B;AAAA,EAEF,YAAYG;AAAA,IACVC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWmB,EAAA,CAAyB,CAAC;AAAA,MAC5DH,EAAMV,CAAmB;AAAA,IAAA;AAAA,EAC3B;AAAA,EAEF,eAAeG;AAAA,IACbC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWiB,EAAA,CAAsB,CAAC;AAAA,IAAA;AAAA,EAC3D;AAAA,EAEF,YAAYR;AAAA,IACVC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWoB,EAAA,CAA6B,CAAC;AAAA,MAChEJ,EAAMX,CAAsB;AAAA,IAAA;AAAA,IAE9BK;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWqB,EAAA,CAA6B,CAAC;AAAA,IAAA;AAAA,EAClE;AAAA,EAEF,mBAAmBZ;AAAA,IACjBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWqB,EAAA,CAA6B,CAAC;AAAA,IAAA;AAAA,EAClE;AAAA,EAEF,SAASZ,EAAA;AACX,GAEaa,IAAwB;AAAA,EACnC,iBAAiBC;AACnB;"}
+{"version":3,"file":"onboardingExecutionStateMachine.js","sources":["../../../../src/components/Employee/OnboardingExecutionFlow/onboardingExecutionStateMachine.ts"],"sourcesContent":["import { transition, reduce, state, guard } from 'robot3'\nimport {\n  FederalTaxesContextual,\n  StateTaxesContextual,\n  DeductionsContextual,\n  type OnboardingContextInterface,\n} from './OnboardingExecutionFlowComponents'\nimport {\n  componentEvents,\n  EmployeeSelfOnboardingStatuses,\n  EmployeeOnboardingStatus,\n} from '@/shared/constants'\nimport type { MachineEventType, MachineTransition } from '@/types/Helpers'\nimport { CompensationContextual } from '@/components/Employee/Compensation'\nimport { EmployeeDocumentsContextual } from '@/components/Employee/Documents/onboarding/EmployeeDocuments'\nimport { PaymentMethodContextual } from '@/components/Employee/PaymentMethod'\nimport { ProfileContextual } from '@/components/Employee/Profile/onboarding/Profile'\nimport { OnboardingSummaryContextual } from '@/components/Employee/OnboardingSummary'\n\ntype EventPayloads = {\n  [componentEvents.EMPLOYEE_PROFILE_DONE]: {\n    uuid: string\n    onboardingStatus: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n    startDate: string\n  }\n}\n\nconst createReducer = (props: Partial<OnboardingContextInterface>) => {\n  return (ctx: OnboardingContextInterface): OnboardingContextInterface => ({\n    ...ctx,\n    ...props,\n  })\n}\n\nconst employeeDocumentsConfigCompletedStatuses: Set<\n  (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n> = new Set([\n  EmployeeOnboardingStatus.SELF_ONBOARDING_COMPLETED_BY_EMPLOYEE,\n  EmployeeOnboardingStatus.SELF_ONBOARDING_AWAITING_ADMIN_REVIEW,\n  EmployeeOnboardingStatus.ONBOARDING_COMPLETED,\n])\n\nconst employeeDocumentsGuard = (ctx: OnboardingContextInterface) => {\n  if (!ctx.withEmployeeI9) return false\n  if (ctx.onboardingStatus && employeeDocumentsConfigCompletedStatuses.has(ctx.onboardingStatus))\n    return false\n  return true\n}\n\nconst selfOnboardingGuard = (ctx: OnboardingContextInterface) =>\n  ctx.onboardingStatus\n    ? !(\n        // prettier-ignore\n        // @ts-expect-error: onboarding_status during runtime can be one of self onboarding statuses\n        (EmployeeSelfOnboardingStatuses.has(ctx.onboardingStatus) ||\n        ctx.onboardingStatus === EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE)\n      )\n    : true\n\n/** @internal */\nexport const onboardingExecutionMachine = {\n  employeeProfile: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_PROFILE_DONE,\n      'compensation',\n      reduce(\n        (\n          ctx: OnboardingContextInterface,\n          ev: MachineEventType<EventPayloads, typeof componentEvents.EMPLOYEE_PROFILE_DONE>,\n        ): OnboardingContextInterface => ({\n          ...ctx,\n          component: CompensationContextual,\n          employeeId: ev.payload.uuid,\n          onboardingStatus: ev.payload.onboardingStatus,\n          startDate: ev.payload.startDate,\n        }),\n      ),\n    ),\n  ),\n  compensation: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_COMPENSATION_DONE,\n      'federalTaxes',\n      reduce(createReducer({ component: FederalTaxesContextual })),\n      guard(selfOnboardingGuard),\n    ),\n    transition(\n      componentEvents.EMPLOYEE_COMPENSATION_DONE,\n      'deductions',\n      reduce(createReducer({ component: DeductionsContextual })),\n    ),\n  ),\n  federalTaxes: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_FEDERAL_TAXES_DONE,\n      'stateTaxes',\n      reduce(createReducer({ component: StateTaxesContextual })),\n      guard(selfOnboardingGuard),\n    ),\n  ),\n  stateTaxes: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_STATE_TAXES_DONE,\n      'paymentMethod',\n      reduce(createReducer({ component: PaymentMethodContextual })),\n      guard(selfOnboardingGuard),\n    ),\n  ),\n  paymentMethod: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_PAYMENT_METHOD_DONE,\n      'deductions',\n      reduce(createReducer({ component: DeductionsContextual })),\n    ),\n  ),\n  deductions: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_DEDUCTION_DONE,\n      'employeeDocuments',\n      reduce(createReducer({ component: EmployeeDocumentsContextual })),\n      guard(employeeDocumentsGuard),\n    ),\n    transition(\n      componentEvents.EMPLOYEE_DEDUCTION_DONE,\n      'summary',\n      reduce(createReducer({ component: OnboardingSummaryContextual })),\n    ),\n  ),\n  employeeDocuments: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_DOCUMENTS_DONE,\n      'summary',\n      reduce(createReducer({ component: OnboardingSummaryContextual })),\n    ),\n  ),\n  summary: state<MachineTransition>(),\n}\n\n/** @internal */\nexport const INITIAL_COMPONENT_MAP = {\n  employeeProfile: ProfileContextual,\n} as const\n\n/**\n * The set of steps {@link OnboardingExecutionFlow} can be started on.\n *\n * @public\n */\nexport type OnboardingExecutionInitialState = keyof typeof INITIAL_COMPONENT_MAP\n"],"names":["createReducer","props","ctx","employeeDocumentsConfigCompletedStatuses","EmployeeOnboardingStatus","employeeDocumentsGuard","selfOnboardingGuard","EmployeeSelfOnboardingStatuses","onboardingExecutionMachine","state","transition","componentEvents","reduce","ev","CompensationContextual","FederalTaxesContextual","guard","DeductionsContextual","StateTaxesContextual","PaymentMethodContextual","EmployeeDocumentsContextual","OnboardingSummaryContextual","INITIAL_COMPONENT_MAP","ProfileContextual"],"mappings":";;;;;;;;AA2BA,MAAMA,IAAgB,CAACC,MACd,CAACC,OAAiE;AAAA,EACvE,GAAGA;AAAA,EACH,GAAGD;AAAA,IAIDE,wBAEE,IAAI;AAAA,EACVC,EAAyB;AAAA,EACzBA,EAAyB;AAAA,EACzBA,EAAyB;AAC3B,CAAC,GAEKC,IAAyB,CAACH,MAC1B,GAACA,EAAI,kBACLA,EAAI,oBAAoBC,EAAyC,IAAID,EAAI,gBAAgB,IAKzFI,IAAsB,CAACJ,MAC3BA,EAAI,mBACA;AAAA;AAAA,CAGGK,EAA+B,IAAIL,EAAI,gBAAgB,KACxDA,EAAI,qBAAqBE,EAAyB,kCAEpD,IAGOI,IAA6B;AAAA,EACxC,iBAAiBC;AAAA,IACfC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC;AAAA,QACE,CACEV,GACAW,OACgC;AAAA,UAChC,GAAGX;AAAA,UACH,WAAWY;AAAA,UACX,YAAYD,EAAG,QAAQ;AAAA,UACvB,kBAAkBA,EAAG,QAAQ;AAAA,UAC7B,WAAWA,EAAG,QAAQ;AAAA,QAAA;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AAAA,EAEF,cAAcJ;AAAA,IACZC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWe,EAAA,CAAwB,CAAC;AAAA,MAC3DC,EAAMV,CAAmB;AAAA,IAAA;AAAA,IAE3BI;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWiB,EAAA,CAAsB,CAAC;AAAA,IAAA;AAAA,EAC3D;AAAA,EAEF,cAAcR;AAAA,IACZC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWkB,EAAA,CAAsB,CAAC;AAAA,MACzDF,EAAMV,CAAmB;AAAA,IAAA;AAAA,EAC3B;AAAA,EAEF,YAAYG;AAAA,IACVC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWmB,EAAA,CAAyB,CAAC;AAAA,MAC5DH,EAAMV,CAAmB;AAAA,IAAA;AAAA,EAC3B;AAAA,EAEF,eAAeG;AAAA,IACbC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWiB,EAAA,CAAsB,CAAC;AAAA,IAAA;AAAA,EAC3D;AAAA,EAEF,YAAYR;AAAA,IACVC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWoB,EAAA,CAA6B,CAAC;AAAA,MAChEJ,EAAMX,CAAsB;AAAA,IAAA;AAAA,IAE9BK;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWqB,EAAA,CAA6B,CAAC;AAAA,IAAA;AAAA,EAClE;AAAA,EAEF,mBAAmBZ;AAAA,IACjBC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAC,EAAOZ,EAAc,EAAE,WAAWqB,EAAA,CAA6B,CAAC;AAAA,IAAA;AAAA,EAClE;AAAA,EAEF,SAASZ,EAAA;AACX,GAGaa,IAAwB;AAAA,EACnC,iBAAiBC;AACnB;"}

package/dist/components/Employee/OnboardingFlow/OnboardingFlow.d.ts

@@ -1,10 +1,69 @@
 import { OnboardingDefaultValues } from './OnboardingFlowComponents';
 import { BaseComponentInterface } from '../../Base';
 import { RequireAtLeastOne } from '../../../types/Helpers';
+/**
+ * Props for {@link OnboardingFlow}.
+ *
+ * @public
+ */
 export interface OnboardingFlowProps extends BaseComponentInterface {
+    /** The associated company identifier. */
     companyId: string;
+    /** Default values for individual flow step components. */
     defaultValues?: RequireAtLeastOne<OnboardingDefaultValues>;
+    /**
+     * When true, presents the self-onboarding toggle allowing the admin to opt
+     * the employee into self-onboarding. When false, the option to self-onboard
+     * is not available. Defaults to `true`.
+     */
     isSelfOnboardingEnabled?: boolean;
+    /**
+     * When true, enables the Employee Documents step in the onboarding flow,
+     * allowing the admin to configure I-9 document requirements. Defaults to
+     * `false`.
+     */
     withEmployeeI9?: boolean;
 }
+/**
+ * Complete workflow for onboarding an employee — profile, compensation, taxes, payment method, and document signing.
+ *
+ * @remarks
+ * Renders a multi-step experience that collects every piece of information
+ * required to add an employee to payroll. Begins on the employee list and
+ * transitions into the onboarding execution flow when "Add employee" or a
+ * row's "Edit"/"Review" action is invoked; returning from the execution flow
+ * surfaces the list again. The flow is driven by an internal state machine
+ * and wraps each step in error and suspense boundaries.
+ *
+ * Each step of the flow is also exported as a standalone block — see
+ * {@link EmployeeList}, {@link Profile}, {@link Compensation},
+ * {@link FederalTaxes}, {@link StateTaxes}, {@link PaymentMethod},
+ * {@link Deductions}, {@link EmployeeDocuments}, and
+ * {@link OnboardingSummary} — for composing a custom workflow when this
+ * orchestration is the wrong fit.
+ *
+ * The flow forwards every event emitted by its sub-components to `onEvent`;
+ * see the events table on each sub-component for the full set of events and
+ * payloads observable from this flow.
+ *
+ * @param props - See {@link OnboardingFlowProps}.
+ * @returns The multi-step onboarding flow with internal navigation between the employee list and the per-step screens.
+ * @public
+ * @group Flow Components
+ *
+ * @example
+ * ```tsx
+ * import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'
+ *
+ * function MyApp() {
+ *   return (
+ *     <EmployeeOnboarding.OnboardingFlow
+ *       companyId="a007e1ab-3595-43c2-ab4b-af7a5af2e365"
+ *       withEmployeeI9
+ *       onEvent={() => {}}
+ *     />
+ *   )
+ * }
+ * ```
+ */
 export declare const OnboardingFlow: ({ companyId, onEvent, defaultValues, isSelfOnboardingEnabled, withEmployeeI9, }: OnboardingFlowProps) => import("react").JSX.Element;

package/dist/components/Employee/OnboardingFlow/OnboardingFlow.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnboardingFlow.js","sources":["../../../../src/components/Employee/OnboardingFlow/OnboardingFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { employeeOnboardingMachine } from './onboardingStateMachine'\nimport {\n  type OnboardingDefaultValues,\n  type OnboardingContextInterface,\n  EmployeeListContextual,\n} from './OnboardingFlowComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport type { RequireAtLeastOne } from '@/types/Helpers'\n\nexport interface OnboardingFlowProps extends BaseComponentInterface {\n  companyId: string\n  defaultValues?: RequireAtLeastOne<OnboardingDefaultValues>\n  isSelfOnboardingEnabled?: boolean\n  withEmployeeI9?: boolean\n}\n\nexport const OnboardingFlow = ({\n  companyId,\n  onEvent,\n  defaultValues,\n  isSelfOnboardingEnabled = true,\n  withEmployeeI9 = false,\n}: OnboardingFlowProps) => {\n  const manageEmployees = useMemo(\n    () =>\n      createMachine(\n        'index',\n        employeeOnboardingMachine,\n        (initialContext: OnboardingContextInterface) => ({\n          ...initialContext,\n          component: EmployeeListContextual,\n          companyId,\n          isAdmin: true,\n          defaultValues,\n          isSelfOnboardingEnabled,\n          withEmployeeI9,\n        }),\n      ),\n    [companyId, defaultValues, isSelfOnboardingEnabled, withEmployeeI9],\n  )\n  return <Flow machine={manageEmployees} onEvent={onEvent} />\n}\n"],"names":["OnboardingFlow","companyId","onEvent","defaultValues","isSelfOnboardingEnabled","withEmployeeI9","manageEmployees","useMemo","createMachine","employeeOnboardingMachine","initialContext","EmployeeListContextual","jsx","Flow"],"mappings":";;;;;;AAmBO,MAAMA,IAAiB,CAAC;AAAA,EAC7B,WAAAC;AAAA,EACA,SAAAC;AAAA,EACA,eAAAC;AAAA,EACA,yBAAAC,IAA0B;AAAA,EAC1B,gBAAAC,IAAiB;AACnB,MAA2B;AACzB,QAAMC,IAAkBC;AAAA,IACtB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAgD;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAV;AAAA,QACA,SAAS;AAAA,QACT,eAAAE;AAAA,QACA,yBAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACJ,GAAWE,GAAeC,GAAyBC,CAAc;AAAA,EAAA;AAEpE,SAAO,gBAAAO,EAACC,GAAA,EAAK,SAASP,GAAiB,SAAAJ,EAAA,CAAkB;AAC3D;"}
+{"version":3,"file":"OnboardingFlow.js","sources":["../../../../src/components/Employee/OnboardingFlow/OnboardingFlow.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useMemo } from 'react'\nimport { employeeOnboardingMachine } from './onboardingStateMachine'\nimport {\n  type OnboardingDefaultValues,\n  type OnboardingContextInterface,\n  EmployeeListContextual,\n} from './OnboardingFlowComponents'\nimport { Flow } from '@/components/Flow/Flow'\nimport type { BaseComponentInterface } from '@/components/Base'\nimport type { RequireAtLeastOne } from '@/types/Helpers'\n\n/**\n * Props for {@link OnboardingFlow}.\n *\n * @public\n */\nexport interface OnboardingFlowProps extends BaseComponentInterface {\n  /** The associated company identifier. */\n  companyId: string\n  /** Default values for individual flow step components. */\n  defaultValues?: RequireAtLeastOne<OnboardingDefaultValues>\n  /**\n   * When true, presents the self-onboarding toggle allowing the admin to opt\n   * the employee into self-onboarding. When false, the option to self-onboard\n   * is not available. Defaults to `true`.\n   */\n  isSelfOnboardingEnabled?: boolean\n  /**\n   * When true, enables the Employee Documents step in the onboarding flow,\n   * allowing the admin to configure I-9 document requirements. Defaults to\n   * `false`.\n   */\n  withEmployeeI9?: boolean\n}\n\n/**\n * Complete workflow for onboarding an employee — profile, compensation, taxes, payment method, and document signing.\n *\n * @remarks\n * Renders a multi-step experience that collects every piece of information\n * required to add an employee to payroll. Begins on the employee list and\n * transitions into the onboarding execution flow when \"Add employee\" or a\n * row's \"Edit\"/\"Review\" action is invoked; returning from the execution flow\n * surfaces the list again. The flow is driven by an internal state machine\n * and wraps each step in error and suspense boundaries.\n *\n * Each step of the flow is also exported as a standalone block — see\n * {@link EmployeeList}, {@link Profile}, {@link Compensation},\n * {@link FederalTaxes}, {@link StateTaxes}, {@link PaymentMethod},\n * {@link Deductions}, {@link EmployeeDocuments}, and\n * {@link OnboardingSummary} — for composing a custom workflow when this\n * orchestration is the wrong fit.\n *\n * The flow forwards every event emitted by its sub-components to `onEvent`;\n * see the events table on each sub-component for the full set of events and\n * payloads observable from this flow.\n *\n * @param props - See {@link OnboardingFlowProps}.\n * @returns The multi-step onboarding flow with internal navigation between the employee list and the per-step screens.\n * @public\n * @group Flow Components\n *\n * @example\n * ```tsx\n * import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'\n *\n * function MyApp() {\n *   return (\n *     <EmployeeOnboarding.OnboardingFlow\n *       companyId=\"a007e1ab-3595-43c2-ab4b-af7a5af2e365\"\n *       withEmployeeI9\n *       onEvent={() => {}}\n *     />\n *   )\n * }\n * ```\n */\nexport const OnboardingFlow = ({\n  companyId,\n  onEvent,\n  defaultValues,\n  isSelfOnboardingEnabled = true,\n  withEmployeeI9 = false,\n}: OnboardingFlowProps) => {\n  const manageEmployees = useMemo(\n    () =>\n      createMachine(\n        'index',\n        employeeOnboardingMachine,\n        (initialContext: OnboardingContextInterface) => ({\n          ...initialContext,\n          component: EmployeeListContextual,\n          companyId,\n          isAdmin: true,\n          defaultValues,\n          isSelfOnboardingEnabled,\n          withEmployeeI9,\n        }),\n      ),\n    [companyId, defaultValues, isSelfOnboardingEnabled, withEmployeeI9],\n  )\n  return <Flow machine={manageEmployees} onEvent={onEvent} />\n}\n"],"names":["OnboardingFlow","companyId","onEvent","defaultValues","isSelfOnboardingEnabled","withEmployeeI9","manageEmployees","useMemo","createMachine","employeeOnboardingMachine","initialContext","EmployeeListContextual","jsx","Flow"],"mappings":";;;;;;AA8EO,MAAMA,IAAiB,CAAC;AAAA,EAC7B,WAAAC;AAAA,EACA,SAAAC;AAAA,EACA,eAAAC;AAAA,EACA,yBAAAC,IAA0B;AAAA,EAC1B,gBAAAC,IAAiB;AACnB,MAA2B;AACzB,QAAMC,IAAkBC;AAAA,IACtB,MACEC;AAAA,MACE;AAAA,MACAC;AAAA,MACA,CAACC,OAAgD;AAAA,QAC/C,GAAGA;AAAA,QACH,WAAWC;AAAA,QACX,WAAAV;AAAA,QACA,SAAS;AAAA,QACT,eAAAE;AAAA,QACA,yBAAAC;AAAA,QACA,gBAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAEJ,CAACJ,GAAWE,GAAeC,GAAyBC,CAAc;AAAA,EAAA;AAEpE,SAAO,gBAAAO,EAACC,GAAA,EAAK,SAASP,GAAiB,SAAAJ,EAAA,CAAkB;AAC3D;"}

package/dist/components/Employee/OnboardingFlow/OnboardingFlowComponents.d.ts

@@ -1,4 +1,5 @@
 export type { OnboardingContextInterface, OnboardingDefaultValues, } from '../OnboardingExecutionFlow/OnboardingExecutionFlowComponents';
-export { FederalTaxesContextual, StateTaxesContextual, DeductionsContextual, } from '../OnboardingExecutionFlow/OnboardingExecutionFlowComponents';
+/** @internal */
 export declare const EmployeeListContextual: () => import("react").JSX.Element;
+/** @internal */
 export declare function OnboardingExecutionFlowContextual(): import("react").JSX.Element;

package/dist/components/Employee/OnboardingFlow/OnboardingFlowComponents.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnboardingFlowComponents.js","sources":["../../../../src/components/Employee/OnboardingFlow/OnboardingFlowComponents.tsx"],"sourcesContent":["import { OnboardingExecutionFlow } from '../OnboardingExecutionFlow/OnboardingExecutionFlow'\nimport { EmployeeList } from '../EmployeeList/onboarding/EmployeeList'\nimport type { OnboardingContextInterface } from '../OnboardingExecutionFlow/OnboardingExecutionFlowComponents'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport { ensureRequired } from '@/helpers/ensureRequired'\n\nexport type {\n  OnboardingContextInterface,\n  OnboardingDefaultValues,\n} from '../OnboardingExecutionFlow/OnboardingExecutionFlowComponents'\nexport {\n  FederalTaxesContextual,\n  StateTaxesContextual,\n  DeductionsContextual,\n} from '../OnboardingExecutionFlow/OnboardingExecutionFlowComponents'\n\nexport const EmployeeListContextual = () => {\n  const { companyId, onEvent } = useFlow<OnboardingContextInterface>()\n  return <EmployeeList companyId={ensureRequired(companyId)} onEvent={onEvent} />\n}\n\nexport function OnboardingExecutionFlowContextual() {\n  const {\n    companyId,\n    employeeId,\n    onEvent,\n    onboardingStatus,\n    defaultValues,\n    isAdmin,\n    isSelfOnboardingEnabled,\n    withEmployeeI9,\n  } = useFlow<OnboardingContextInterface>()\n\n  return (\n    <OnboardingExecutionFlow\n      companyId={ensureRequired(companyId)}\n      onEvent={onEvent}\n      initialEmployeeId={employeeId}\n      initialOnboardingStatus={onboardingStatus}\n      defaultValues={defaultValues}\n      isAdmin={isAdmin}\n      isSelfOnboardingEnabled={isSelfOnboardingEnabled}\n      withEmployeeI9={withEmployeeI9}\n    />\n  )\n}\n"],"names":["EmployeeListContextual","companyId","onEvent","useFlow","EmployeeList","ensureRequired","OnboardingExecutionFlowContextual","employeeId","onboardingStatus","defaultValues","isAdmin","isSelfOnboardingEnabled","withEmployeeI9","jsx","OnboardingExecutionFlow"],"mappings":";;;;;AAgBO,MAAMA,IAAyB,MAAM;AAC1C,QAAM,EAAE,WAAAC,GAAW,SAAAC,EAAA,IAAYC,EAAA;AAC/B,2BAAQC,GAAA,EAAa,WAAWC,EAAeJ,CAAS,GAAG,SAAAC,GAAkB;AAC/E;AAEO,SAASI,IAAoC;AAClD,QAAM;AAAA,IACJ,WAAAL;AAAA,IACA,YAAAM;AAAA,IACA,SAAAL;AAAA,IACA,kBAAAM;AAAA,IACA,eAAAC;AAAA,IACA,SAAAC;AAAA,IACA,yBAAAC;AAAA,IACA,gBAAAC;AAAA,EAAA,IACET,EAAA;AAEJ,SACE,gBAAAU;AAAA,IAACC;AAAA,IAAA;AAAA,MACC,WAAWT,EAAeJ,CAAS;AAAA,MACnC,SAAAC;AAAA,MACA,mBAAmBK;AAAA,MACnB,yBAAyBC;AAAA,MACzB,eAAAC;AAAA,MACA,SAAAC;AAAA,MACA,yBAAAC;AAAA,MACA,gBAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;"}
+{"version":3,"file":"OnboardingFlowComponents.js","sources":["../../../../src/components/Employee/OnboardingFlow/OnboardingFlowComponents.tsx"],"sourcesContent":["import { OnboardingExecutionFlow } from '../OnboardingExecutionFlow/OnboardingExecutionFlow'\nimport { EmployeeList } from '../EmployeeList/onboarding/EmployeeList'\nimport type { OnboardingContextInterface } from '../OnboardingExecutionFlow/OnboardingExecutionFlowComponents'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport { ensureRequired } from '@/helpers/ensureRequired'\n\nexport type {\n  OnboardingContextInterface,\n  OnboardingDefaultValues,\n} from '../OnboardingExecutionFlow/OnboardingExecutionFlowComponents'\n\n/** @internal */\nexport const EmployeeListContextual = () => {\n  const { companyId, onEvent } = useFlow<OnboardingContextInterface>()\n  return <EmployeeList companyId={ensureRequired(companyId)} onEvent={onEvent} />\n}\n\n/** @internal */\nexport function OnboardingExecutionFlowContextual() {\n  const {\n    companyId,\n    employeeId,\n    onEvent,\n    onboardingStatus,\n    defaultValues,\n    isAdmin,\n    isSelfOnboardingEnabled,\n    withEmployeeI9,\n  } = useFlow<OnboardingContextInterface>()\n\n  return (\n    <OnboardingExecutionFlow\n      companyId={ensureRequired(companyId)}\n      onEvent={onEvent}\n      initialEmployeeId={employeeId}\n      initialOnboardingStatus={onboardingStatus}\n      defaultValues={defaultValues}\n      isAdmin={isAdmin}\n      isSelfOnboardingEnabled={isSelfOnboardingEnabled}\n      withEmployeeI9={withEmployeeI9}\n    />\n  )\n}\n"],"names":["EmployeeListContextual","companyId","onEvent","useFlow","EmployeeList","ensureRequired","OnboardingExecutionFlowContextual","employeeId","onboardingStatus","defaultValues","isAdmin","isSelfOnboardingEnabled","withEmployeeI9","jsx","OnboardingExecutionFlow"],"mappings":";;;;;AAYO,MAAMA,IAAyB,MAAM;AAC1C,QAAM,EAAE,WAAAC,GAAW,SAAAC,EAAA,IAAYC,EAAA;AAC/B,2BAAQC,GAAA,EAAa,WAAWC,EAAeJ,CAAS,GAAG,SAAAC,GAAkB;AAC/E;AAGO,SAASI,IAAoC;AAClD,QAAM;AAAA,IACJ,WAAAL;AAAA,IACA,YAAAM;AAAA,IACA,SAAAL;AAAA,IACA,kBAAAM;AAAA,IACA,eAAAC;AAAA,IACA,SAAAC;AAAA,IACA,yBAAAC;AAAA,IACA,gBAAAC;AAAA,EAAA,IACET,EAAA;AAEJ,SACE,gBAAAU;AAAA,IAACC;AAAA,IAAA;AAAA,MACC,WAAWT,EAAeJ,CAAS;AAAA,MACnC,SAAAC;AAAA,MACA,mBAAmBK;AAAA,MACnB,yBAAyBC;AAAA,MACzB,eAAAC;AAAA,MACA,SAAAC;AAAA,MACA,yBAAAC;AAAA,MACA,gBAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;"}

package/dist/components/Employee/OnboardingFlow/onboardingStateMachine.d.ts

@@ -1,3 +1,4 @@
+/** @internal */
 export declare const employeeOnboardingMachine: {
     index: import('robot3').MachineState<any>;
     executing: import('robot3').MachineState<any>;

package/dist/components/Employee/OnboardingFlow/onboardingStateMachine.js.map

@@ -1 +1 @@
-{"version":3,"file":"onboardingStateMachine.js","sources":["../../../../src/components/Employee/OnboardingFlow/onboardingStateMachine.ts"],"sourcesContent":["import { transition, reduce, state } from 'robot3'\nimport {\n  EmployeeListContextual,\n  OnboardingExecutionFlowContextual,\n  type OnboardingContextInterface,\n} from './OnboardingFlowComponents'\nimport { componentEvents, type EmployeeOnboardingStatus } from '@/shared/constants'\nimport type { MachineEventType, MachineTransition } from '@/types/Helpers'\n\ntype EventPayloads = {\n  [componentEvents.EMPLOYEE_UPDATE]: {\n    employeeId: string\n    onboardingStatus: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n  }\n}\n\nconst returnToIndex = reduce(\n  (ctx: OnboardingContextInterface): OnboardingContextInterface => ({\n    ...ctx,\n    component: EmployeeListContextual,\n    employeeId: undefined,\n    onboardingStatus: undefined,\n  }),\n)\n\nexport const employeeOnboardingMachine = {\n  index: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_CREATE,\n      'executing',\n      reduce(\n        (ctx: OnboardingContextInterface): OnboardingContextInterface => ({\n          ...ctx,\n          component: OnboardingExecutionFlowContextual,\n          employeeId: undefined,\n        }),\n      ),\n    ),\n    transition(\n      componentEvents.EMPLOYEE_UPDATE,\n      'executing',\n      reduce(\n        (\n          ctx: OnboardingContextInterface,\n          ev: MachineEventType<EventPayloads, typeof componentEvents.EMPLOYEE_UPDATE>,\n        ): OnboardingContextInterface => ({\n          ...ctx,\n          component: OnboardingExecutionFlowContextual,\n          employeeId: ev.payload.employeeId,\n          onboardingStatus: ev.payload.onboardingStatus,\n        }),\n      ),\n    ),\n    transition(componentEvents.EMPLOYEE_ONBOARDING_DONE, 'final'),\n  ),\n  executing: state<MachineTransition>(\n    transition(componentEvents.EMPLOYEES_LIST, 'index', returnToIndex),\n    transition(componentEvents.CANCEL, 'index', returnToIndex),\n  ),\n  final: state<MachineTransition>(),\n}\n"],"names":["returnToIndex","reduce","ctx","EmployeeListContextual","employeeOnboardingMachine","state","transition","componentEvents","OnboardingExecutionFlowContextual","ev"],"mappings":";;;AAgBA,MAAMA,IAAgBC;AAAA,EACpB,CAACC,OAAiE;AAAA,IAChE,GAAGA;AAAA,IACH,WAAWC;AAAA,IACX,YAAY;AAAA,IACZ,kBAAkB;AAAA,EAAA;AAEtB,GAEaC,IAA4B;AAAA,EACvC,OAAOC;AAAA,IACLC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAN;AAAA,QACE,CAACC,OAAiE;AAAA,UAChE,GAAGA;AAAA,UACH,WAAWM;AAAA,UACX,YAAY;AAAA,QAAA;AAAA,MACd;AAAA,IACF;AAAA,IAEFF;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAN;AAAA,QACE,CACEC,GACAO,OACgC;AAAA,UAChC,GAAGP;AAAA,UACH,WAAWM;AAAA,UACX,YAAYC,EAAG,QAAQ;AAAA,UACvB,kBAAkBA,EAAG,QAAQ;AAAA,QAAA;AAAA,MAC/B;AAAA,IACF;AAAA,IAEFH,EAAWC,EAAgB,0BAA0B,OAAO;AAAA,EAAA;AAAA,EAE9D,WAAWF;AAAA,IACTC,EAAWC,EAAgB,gBAAgB,SAASP,CAAa;AAAA,IACjEM,EAAWC,EAAgB,QAAQ,SAASP,CAAa;AAAA,EAAA;AAAA,EAE3D,OAAOK,EAAA;AACT;"}
+{"version":3,"file":"onboardingStateMachine.js","sources":["../../../../src/components/Employee/OnboardingFlow/onboardingStateMachine.ts"],"sourcesContent":["import { transition, reduce, state } from 'robot3'\nimport {\n  EmployeeListContextual,\n  OnboardingExecutionFlowContextual,\n  type OnboardingContextInterface,\n} from './OnboardingFlowComponents'\nimport { componentEvents, type EmployeeOnboardingStatus } from '@/shared/constants'\nimport type { MachineEventType, MachineTransition } from '@/types/Helpers'\n\ntype EventPayloads = {\n  [componentEvents.EMPLOYEE_UPDATE]: {\n    employeeId: string\n    onboardingStatus: (typeof EmployeeOnboardingStatus)[keyof typeof EmployeeOnboardingStatus]\n  }\n}\n\nconst returnToIndex = reduce(\n  (ctx: OnboardingContextInterface): OnboardingContextInterface => ({\n    ...ctx,\n    component: EmployeeListContextual,\n    employeeId: undefined,\n    onboardingStatus: undefined,\n  }),\n)\n\n/** @internal */\nexport const employeeOnboardingMachine = {\n  index: state<MachineTransition>(\n    transition(\n      componentEvents.EMPLOYEE_CREATE,\n      'executing',\n      reduce(\n        (ctx: OnboardingContextInterface): OnboardingContextInterface => ({\n          ...ctx,\n          component: OnboardingExecutionFlowContextual,\n          employeeId: undefined,\n        }),\n      ),\n    ),\n    transition(\n      componentEvents.EMPLOYEE_UPDATE,\n      'executing',\n      reduce(\n        (\n          ctx: OnboardingContextInterface,\n          ev: MachineEventType<EventPayloads, typeof componentEvents.EMPLOYEE_UPDATE>,\n        ): OnboardingContextInterface => ({\n          ...ctx,\n          component: OnboardingExecutionFlowContextual,\n          employeeId: ev.payload.employeeId,\n          onboardingStatus: ev.payload.onboardingStatus,\n        }),\n      ),\n    ),\n    transition(componentEvents.EMPLOYEE_ONBOARDING_DONE, 'final'),\n  ),\n  executing: state<MachineTransition>(\n    transition(componentEvents.EMPLOYEES_LIST, 'index', returnToIndex),\n    transition(componentEvents.CANCEL, 'index', returnToIndex),\n  ),\n  final: state<MachineTransition>(),\n}\n"],"names":["returnToIndex","reduce","ctx","EmployeeListContextual","employeeOnboardingMachine","state","transition","componentEvents","OnboardingExecutionFlowContextual","ev"],"mappings":";;;AAgBA,MAAMA,IAAgBC;AAAA,EACpB,CAACC,OAAiE;AAAA,IAChE,GAAGA;AAAA,IACH,WAAWC;AAAA,IACX,YAAY;AAAA,IACZ,kBAAkB;AAAA,EAAA;AAEtB,GAGaC,IAA4B;AAAA,EACvC,OAAOC;AAAA,IACLC;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAN;AAAA,QACE,CAACC,OAAiE;AAAA,UAChE,GAAGA;AAAA,UACH,WAAWM;AAAA,UACX,YAAY;AAAA,QAAA;AAAA,MACd;AAAA,IACF;AAAA,IAEFF;AAAA,MACEC,EAAgB;AAAA,MAChB;AAAA,MACAN;AAAA,QACE,CACEC,GACAO,OACgC;AAAA,UAChC,GAAGP;AAAA,UACH,WAAWM;AAAA,UACX,YAAYC,EAAG,QAAQ;AAAA,UACvB,kBAAkBA,EAAG,QAAQ;AAAA,QAAA;AAAA,MAC/B;AAAA,IACF;AAAA,IAEFH,EAAWC,EAAgB,0BAA0B,OAAO;AAAA,EAAA;AAAA,EAE9D,WAAWF;AAAA,IACTC,EAAWC,EAAgB,gBAAgB,SAASP,CAAa;AAAA,IACjEM,EAAWC,EAAgB,QAAQ,SAASP,CAAa;AAAA,EAAA;AAAA,EAE3D,OAAOK,EAAA;AACT;"}

package/dist/components/Employee/OnboardingSummary/OnboardingSummary.d.ts

@@ -3,6 +3,13 @@ interface SummaryProps extends CommonComponentInterface<'Employee.OnboardingSumm
     employeeId: string;
     isAdmin?: boolean;
 }
+/**
+ * Displays a summary of an employee's onboarding status, listing completed and
+ * outstanding steps. Rendered as a standalone step inside `OnboardingFlow`.
+ *
+ * @public
+ */
 export declare function OnboardingSummary(props: SummaryProps & BaseComponentInterface): import("react").JSX.Element;
+/** @internal */
 export declare const OnboardingSummaryContextual: () => import("react").JSX.Element;
 export {};

package/dist/components/Employee/OnboardingSummary/OnboardingSummary.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnboardingSummary.js","sources":["../../../../src/components/Employee/OnboardingSummary/OnboardingSummary.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport classNames from 'classnames'\nimport { useEmployeesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { useEmployeesGetOnboardingStatusSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGetOnboardingStatus'\nimport DOMPurify from 'dompurify'\nimport { useMemo } from 'react'\nimport type { OnboardingContextInterface } from '../OnboardingFlow/OnboardingFlowComponents'\nimport styles from './OnboardingSummary.module.scss'\nimport {\n  BaseComponent,\n  useBase,\n  type BaseComponentInterface,\n  type CommonComponentInterface,\n} from '@/components/Base'\nimport { Flex, ActionsLayout } from '@/components/Common'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { useI18n } from '@/i18n'\nimport { componentEvents, EmployeeOnboardingStatus } from '@/shared/constants'\nimport SuccessCheck from '@/assets/icons/success_check.svg?react'\nimport UncheckedCircular from '@/assets/icons/unchecked_circular.svg?react'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport { useComponentDictionary } from '@/i18n/I18n'\n\ninterface SummaryProps extends CommonComponentInterface<'Employee.OnboardingSummary'> {\n  employeeId: string\n  isAdmin?: boolean\n}\n\nexport function OnboardingSummary(props: SummaryProps & BaseComponentInterface) {\n  useI18n('Employee.OnboardingSummary')\n  useComponentDictionary('Employee.OnboardingSummary', props.dictionary)\n\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nconst Root = ({ employeeId, className, isAdmin = false }: SummaryProps) => {\n  const { onEvent } = useBase()\n  const { t } = useTranslation('Employee.OnboardingSummary')\n  const Components = useComponentContext()\n\n  const {\n    data: { employee },\n  } = useEmployeesGetSuspense({ employeeId })\n  const { firstName, lastName } = employee!\n\n  const { data } = useEmployeesGetOnboardingStatusSuspense({ employeeId })\n  const { onboardingStatus, onboardingSteps } = data.employeeOnboardingStatus!\n\n  const hasMissingRequirements =\n    onboardingSteps?.length &&\n    onboardingSteps.findIndex(step => step.required && !step.completed) > -1\n\n  const isOnboardingCompleted =\n    onboardingStatus === EmployeeOnboardingStatus.ONBOARDING_COMPLETED ||\n    (!hasMissingRequirements &&\n      onboardingStatus === EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE)\n\n  const sanitizedFirstName = useMemo(() => DOMPurify.sanitize(firstName), [firstName])\n  const sanitizedLastName = useMemo(() => DOMPurify.sanitize(lastName), [lastName])\n\n  return (\n    <section className={className}>\n      <Flex flexDirection=\"column\" gap={20}>\n        <Flex alignItems=\"center\" flexDirection=\"column\" gap={8}>\n          {isAdmin ? (\n            isOnboardingCompleted ? (\n              <Flex flexDirection=\"column\" gap={4} alignItems=\"center\">\n                <Components.Heading as=\"h2\" textAlign=\"center\">\n                  {t('onboardedAdminSubtitle', {\n                    name: `${sanitizedFirstName} ${sanitizedLastName}`,\n                    interpolation: { escapeValue: false },\n                  })}\n                </Components.Heading>\n                <Components.Text variant=\"supporting\" className={styles.description}>\n                  {t('onboardedAdminDescription')}\n                </Components.Text>\n              </Flex>\n            ) : (\n              <Flex flexDirection=\"column\" alignItems=\"flex-start\" gap={8}>\n                <Components.Heading as=\"h2\">{t('missingRequirementsSubtitle')}</Components.Heading>\n                <Components.Text>{t('missingRequirementsDescription')}</Components.Text>\n                <ul className={styles.list}>\n                  {onboardingSteps\n                    ?.sort((a, b) => (a.completed ? -1 : 1))\n                    .map(step => {\n                      return (\n                        <li key={step.id} className={styles.listItem}>\n                          {step.completed ? (\n                            <SuccessCheck width={24} height={24} className={styles.listItemIcon} />\n                          ) : (\n                            <UncheckedCircular\n                              width={24}\n                              height={24}\n                              className={classNames(styles.listItemIcon, styles.incomplete)}\n                            />\n                          )}\n                          <Components.Heading as=\"h4\">\n                            {/* @ts-expect-error: id has typeof keyof steps */}\n                            {t(`steps.${step.id}`, step.title)}\n                          </Components.Heading>\n                        </li>\n                      )\n                    })}\n                </ul>\n              </Flex>\n            )\n          ) : (\n            <>\n              <Flex flexDirection=\"column\" gap={20} alignItems=\"center\">\n                <Flex flexDirection=\"column\" gap={4} alignItems=\"center\">\n                  <Components.Heading as=\"h2\" textAlign=\"center\">\n                    {t('onboardedSelfSubtitle')}\n                  </Components.Heading>\n                  <Components.Text variant=\"supporting\" className={styles.description}>\n                    {t('onboardedSelfDescription')}\n                  </Components.Text>\n                </Flex>\n                <ActionsLayout justifyContent={isOnboardingCompleted ? 'center' : 'start'}>\n                  <Components.Button\n                    variant=\"secondary\"\n                    onClick={() => {\n                      onEvent(componentEvents.EMPLOYEE_ONBOARDING_DONE)\n                    }}\n                  >\n                    {t('doneCta')}\n                  </Components.Button>\n                </ActionsLayout>\n              </Flex>\n            </>\n          )}\n        </Flex>\n\n        {isAdmin && (\n          <ActionsLayout justifyContent={'center'}>\n            <Components.Button\n              variant=\"secondary\"\n              onClick={() => {\n                onEvent(componentEvents.EMPLOYEES_LIST)\n              }}\n            >\n              {t('doneCta')}\n            </Components.Button>\n          </ActionsLayout>\n        )}\n      </Flex>\n    </section>\n  )\n}\n\nexport const OnboardingSummaryContextual = () => {\n  const { employeeId, onEvent, isAdmin } = useFlow<OnboardingContextInterface>()\n  const { t } = useTranslation('common')\n\n  if (!employeeId) {\n    throw new Error(\n      t('errors.missingParamsOrContext', {\n        component: 'Summary',\n        param: 'employeeId',\n        provider: 'FlowProvider',\n      }),\n    )\n  }\n  return <OnboardingSummary employeeId={employeeId} onEvent={onEvent} isAdmin={isAdmin} />\n}\n"],"names":["OnboardingSummary","props","useI18n","useComponentDictionary","jsx","BaseComponent","Root","employeeId","className","isAdmin","onEvent","useBase","useTranslation","Components","useComponentContext","employee","useEmployeesGetSuspense","firstName","lastName","data","useEmployeesGetOnboardingStatusSuspense","onboardingStatus","onboardingSteps","hasMissingRequirements","step","isOnboardingCompleted","EmployeeOnboardingStatus","sanitizedFirstName","useMemo","DOMPurify","sanitizedLastName","jsxs","Flex","styles","a","b","SuccessCheck","UncheckedCircular","classNames","ActionsLayout","componentEvents","OnboardingSummaryContextual","useFlow","t"],"mappings":";;;;;;;;;;;;;;;;;;AA4BO,SAASA,EAAkBC,GAA8C;AAC9E,SAAAC,EAAQ,4BAA4B,GACpCC,EAAuB,8BAA8BF,EAAM,UAAU,GAGnE,gBAAAG,EAACC,GAAA,EAAe,GAAGJ,GACjB,UAAA,gBAAAG,EAACE,KAAM,GAAGL,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,MAAMK,IAAO,CAAC,EAAE,YAAAC,GAAY,WAAAC,GAAW,SAAAC,IAAU,SAA0B;AACzE,QAAM,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACd,EAAE,EAAA,IAAMC,EAAe,4BAA4B,GACnDC,IAAaC,EAAA,GAEb;AAAA,IACJ,MAAM,EAAE,UAAAC,EAAA;AAAA,EAAS,IACfC,EAAwB,EAAE,YAAAT,GAAY,GACpC,EAAE,WAAAU,GAAW,UAAAC,EAAA,IAAaH,GAE1B,EAAE,MAAAI,EAAA,IAASC,EAAwC,EAAE,YAAAb,GAAY,GACjE,EAAE,kBAAAc,GAAkB,iBAAAC,EAAA,IAAoBH,EAAK,0BAE7CI,IACJD,GAAiB,UACjBA,EAAgB,UAAU,CAAAE,MAAQA,EAAK,YAAY,CAACA,EAAK,SAAS,IAAI,IAElEC,IACJJ,MAAqBK,EAAyB,wBAC7C,CAACH,KACAF,MAAqBK,EAAyB,gCAE5CC,IAAqBC,EAAQ,MAAMC,EAAU,SAASZ,CAAS,GAAG,CAACA,CAAS,CAAC,GAC7Ea,IAAoBF,EAAQ,MAAMC,EAAU,SAASX,CAAQ,GAAG,CAACA,CAAQ,CAAC;AAEhF,SACE,gBAAAd,EAAC,aAAQ,WAAAI,GACP,UAAA,gBAAAuB,EAACC,KAAK,eAAc,UAAS,KAAK,IAChC,UAAA;AAAA,IAAA,gBAAA5B,EAAC4B,KAAK,YAAW,UAAS,eAAc,UAAS,KAAK,GACnD,UAAAvB,IACCgB,IACE,gBAAAM,EAACC,KAAK,eAAc,UAAS,KAAK,GAAG,YAAW,UAC9C,UAAA;AAAA,MAAA,gBAAA5B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAAK,WAAU,UACnC,YAAE,0BAA0B;AAAA,QAC3B,MAAM,GAAGc,CAAkB,IAAIG,CAAiB;AAAA,QAChD,eAAe,EAAE,aAAa,GAAA;AAAA,MAAM,CACrC,GACH;AAAA,MACA,gBAAA1B,EAACS,EAAW,MAAX,EAAgB,SAAQ,cAAa,WAAWoB,EAAO,aACrD,UAAA,EAAE,2BAA2B,EAAA,CAChC;AAAA,IAAA,EAAA,CACF,sBAECD,GAAA,EAAK,eAAc,UAAS,YAAW,cAAa,KAAK,GACxD,UAAA;AAAA,MAAA,gBAAA5B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAA,EAAE,6BAA6B,GAAE;AAAA,wBAC7DA,EAAW,MAAX,EAAiB,UAAA,EAAE,gCAAgC,GAAE;AAAA,wBACrD,MAAA,EAAG,WAAWoB,EAAO,MACnB,aACG,KAAK,CAACC,GAAGC,MAAOD,EAAE,YAAY,KAAK,CAAE,EACtC,IAAI,CAAAV,MAED,gBAAAO,EAAC,MAAA,EAAiB,WAAWE,EAAO,UACjC,UAAA;AAAA,QAAAT,EAAK,YACJ,gBAAApB,EAACgC,GAAA,EAAa,OAAO,IAAI,QAAQ,IAAI,WAAWH,EAAO,aAAA,CAAc,IAErE,gBAAA7B;AAAA,UAACiC;AAAAA,UAAA;AAAA,YACC,OAAO;AAAA,YACP,QAAQ;AAAA,YACR,WAAWC,EAAWL,EAAO,cAAcA,EAAO,UAAU;AAAA,UAAA;AAAA,QAAA;AAAA,QAGhE,gBAAA7B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAEpB,UAAA,EAAE,SAASW,EAAK,EAAE,IAAIA,EAAK,KAAK,EAAA,CACnC;AAAA,MAAA,EAAA,GAbOA,EAAK,EAcd,CAEH,EAAA,CACL;AAAA,IAAA,EAAA,CACF,2BAIA,UAAA,gBAAAO,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAAI,YAAW,UAC/C,UAAA;AAAA,MAAA,gBAAAD,EAACC,KAAK,eAAc,UAAS,KAAK,GAAG,YAAW,UAC9C,UAAA;AAAA,QAAA,gBAAA5B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAAK,WAAU,UACnC,UAAA,EAAE,uBAAuB,EAAA,CAC5B;AAAA,QACA,gBAAAT,EAACS,EAAW,MAAX,EAAgB,SAAQ,cAAa,WAAWoB,EAAO,aACrD,UAAA,EAAE,0BAA0B,EAAA,CAC/B;AAAA,MAAA,GACF;AAAA,MACA,gBAAA7B,EAACmC,GAAA,EAAc,gBAAgBd,IAAwB,WAAW,SAChE,UAAA,gBAAArB;AAAA,QAACS,EAAW;AAAA,QAAX;AAAA,UACC,SAAQ;AAAA,UACR,SAAS,MAAM;AACb,YAAAH,EAAQ8B,EAAgB,wBAAwB;AAAA,UAClD;AAAA,UAEC,YAAE,SAAS;AAAA,QAAA;AAAA,MAAA,EACd,CACF;AAAA,IAAA,EAAA,CACF,GACF,GAEJ;AAAA,IAEC/B,KACC,gBAAAL,EAACmC,GAAA,EAAc,gBAAgB,UAC7B,UAAA,gBAAAnC;AAAA,MAACS,EAAW;AAAA,MAAX;AAAA,QACC,SAAQ;AAAA,QACR,SAAS,MAAM;AACb,UAAAH,EAAQ8B,EAAgB,cAAc;AAAA,QACxC;AAAA,QAEC,YAAE,SAAS;AAAA,MAAA;AAAA,IAAA,EACd,CACF;AAAA,EAAA,EAAA,CAEJ,EAAA,CACF;AAEJ,GAEaC,KAA8B,MAAM;AAC/C,QAAM,EAAE,YAAAlC,GAAY,SAAAG,GAAS,SAAAD,EAAA,IAAYiC,EAAA,GACnC,EAAE,GAAAC,EAAA,IAAM/B,EAAe,QAAQ;AAErC,MAAI,CAACL;AACH,UAAM,IAAI;AAAA,MACRoC,EAAE,iCAAiC;AAAA,QACjC,WAAW;AAAA,QACX,OAAO;AAAA,QACP,UAAU;AAAA,MAAA,CACX;AAAA,IAAA;AAGL,SAAO,gBAAAvC,EAACJ,GAAA,EAAkB,YAAAO,GAAwB,SAAAG,GAAkB,SAAAD,EAAA,CAAkB;AACxF;"}
+{"version":3,"file":"OnboardingSummary.js","sources":["../../../../src/components/Employee/OnboardingSummary/OnboardingSummary.tsx"],"sourcesContent":["import { useTranslation } from 'react-i18next'\nimport classNames from 'classnames'\nimport { useEmployeesGetSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGet'\nimport { useEmployeesGetOnboardingStatusSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/employeesGetOnboardingStatus'\nimport DOMPurify from 'dompurify'\nimport { useMemo } from 'react'\nimport type { OnboardingContextInterface } from '../OnboardingFlow/OnboardingFlowComponents'\nimport styles from './OnboardingSummary.module.scss'\nimport {\n  BaseComponent,\n  useBase,\n  type BaseComponentInterface,\n  type CommonComponentInterface,\n} from '@/components/Base'\nimport { Flex, ActionsLayout } from '@/components/Common'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\nimport { useI18n } from '@/i18n'\nimport { componentEvents, EmployeeOnboardingStatus } from '@/shared/constants'\nimport SuccessCheck from '@/assets/icons/success_check.svg?react'\nimport UncheckedCircular from '@/assets/icons/unchecked_circular.svg?react'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport { useComponentDictionary } from '@/i18n/I18n'\n\ninterface SummaryProps extends CommonComponentInterface<'Employee.OnboardingSummary'> {\n  employeeId: string\n  isAdmin?: boolean\n}\n\n/**\n * Displays a summary of an employee's onboarding status, listing completed and\n * outstanding steps. Rendered as a standalone step inside `OnboardingFlow`.\n *\n * @public\n */\nexport function OnboardingSummary(props: SummaryProps & BaseComponentInterface) {\n  useI18n('Employee.OnboardingSummary')\n  useComponentDictionary('Employee.OnboardingSummary', props.dictionary)\n\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nconst Root = ({ employeeId, className, isAdmin = false }: SummaryProps) => {\n  const { onEvent } = useBase()\n  const { t } = useTranslation('Employee.OnboardingSummary')\n  const Components = useComponentContext()\n\n  const {\n    data: { employee },\n  } = useEmployeesGetSuspense({ employeeId })\n  const { firstName, lastName } = employee!\n\n  const { data } = useEmployeesGetOnboardingStatusSuspense({ employeeId })\n  const { onboardingStatus, onboardingSteps } = data.employeeOnboardingStatus!\n\n  const hasMissingRequirements =\n    onboardingSteps?.length &&\n    onboardingSteps.findIndex(step => step.required && !step.completed) > -1\n\n  const isOnboardingCompleted =\n    onboardingStatus === EmployeeOnboardingStatus.ONBOARDING_COMPLETED ||\n    (!hasMissingRequirements &&\n      onboardingStatus === EmployeeOnboardingStatus.SELF_ONBOARDING_PENDING_INVITE)\n\n  const sanitizedFirstName = useMemo(() => DOMPurify.sanitize(firstName), [firstName])\n  const sanitizedLastName = useMemo(() => DOMPurify.sanitize(lastName), [lastName])\n\n  return (\n    <section className={className}>\n      <Flex flexDirection=\"column\" gap={20}>\n        <Flex alignItems=\"center\" flexDirection=\"column\" gap={8}>\n          {isAdmin ? (\n            isOnboardingCompleted ? (\n              <Flex flexDirection=\"column\" gap={4} alignItems=\"center\">\n                <Components.Heading as=\"h2\" textAlign=\"center\">\n                  {t('onboardedAdminSubtitle', {\n                    name: `${sanitizedFirstName} ${sanitizedLastName}`,\n                    interpolation: { escapeValue: false },\n                  })}\n                </Components.Heading>\n                <Components.Text variant=\"supporting\" className={styles.description}>\n                  {t('onboardedAdminDescription')}\n                </Components.Text>\n              </Flex>\n            ) : (\n              <Flex flexDirection=\"column\" alignItems=\"flex-start\" gap={8}>\n                <Components.Heading as=\"h2\">{t('missingRequirementsSubtitle')}</Components.Heading>\n                <Components.Text>{t('missingRequirementsDescription')}</Components.Text>\n                <ul className={styles.list}>\n                  {onboardingSteps\n                    ?.sort((a, b) => (a.completed ? -1 : 1))\n                    .map(step => {\n                      return (\n                        <li key={step.id} className={styles.listItem}>\n                          {step.completed ? (\n                            <SuccessCheck width={24} height={24} className={styles.listItemIcon} />\n                          ) : (\n                            <UncheckedCircular\n                              width={24}\n                              height={24}\n                              className={classNames(styles.listItemIcon, styles.incomplete)}\n                            />\n                          )}\n                          <Components.Heading as=\"h4\">\n                            {/* @ts-expect-error: id has typeof keyof steps */}\n                            {t(`steps.${step.id}`, step.title)}\n                          </Components.Heading>\n                        </li>\n                      )\n                    })}\n                </ul>\n              </Flex>\n            )\n          ) : (\n            <>\n              <Flex flexDirection=\"column\" gap={20} alignItems=\"center\">\n                <Flex flexDirection=\"column\" gap={4} alignItems=\"center\">\n                  <Components.Heading as=\"h2\" textAlign=\"center\">\n                    {t('onboardedSelfSubtitle')}\n                  </Components.Heading>\n                  <Components.Text variant=\"supporting\" className={styles.description}>\n                    {t('onboardedSelfDescription')}\n                  </Components.Text>\n                </Flex>\n                <ActionsLayout justifyContent={isOnboardingCompleted ? 'center' : 'start'}>\n                  <Components.Button\n                    variant=\"secondary\"\n                    onClick={() => {\n                      onEvent(componentEvents.EMPLOYEE_ONBOARDING_DONE)\n                    }}\n                  >\n                    {t('doneCta')}\n                  </Components.Button>\n                </ActionsLayout>\n              </Flex>\n            </>\n          )}\n        </Flex>\n\n        {isAdmin && (\n          <ActionsLayout justifyContent={'center'}>\n            <Components.Button\n              variant=\"secondary\"\n              onClick={() => {\n                onEvent(componentEvents.EMPLOYEES_LIST)\n              }}\n            >\n              {t('doneCta')}\n            </Components.Button>\n          </ActionsLayout>\n        )}\n      </Flex>\n    </section>\n  )\n}\n\n/** @internal */\nexport const OnboardingSummaryContextual = () => {\n  const { employeeId, onEvent, isAdmin } = useFlow<OnboardingContextInterface>()\n  const { t } = useTranslation('common')\n\n  if (!employeeId) {\n    throw new Error(\n      t('errors.missingParamsOrContext', {\n        component: 'Summary',\n        param: 'employeeId',\n        provider: 'FlowProvider',\n      }),\n    )\n  }\n  return <OnboardingSummary employeeId={employeeId} onEvent={onEvent} isAdmin={isAdmin} />\n}\n"],"names":["OnboardingSummary","props","useI18n","useComponentDictionary","jsx","BaseComponent","Root","employeeId","className","isAdmin","onEvent","useBase","useTranslation","Components","useComponentContext","employee","useEmployeesGetSuspense","firstName","lastName","data","useEmployeesGetOnboardingStatusSuspense","onboardingStatus","onboardingSteps","hasMissingRequirements","step","isOnboardingCompleted","EmployeeOnboardingStatus","sanitizedFirstName","useMemo","DOMPurify","sanitizedLastName","jsxs","Flex","styles","a","b","SuccessCheck","UncheckedCircular","classNames","ActionsLayout","componentEvents","OnboardingSummaryContextual","useFlow","t"],"mappings":";;;;;;;;;;;;;;;;;;AAkCO,SAASA,EAAkBC,GAA8C;AAC9E,SAAAC,EAAQ,4BAA4B,GACpCC,EAAuB,8BAA8BF,EAAM,UAAU,GAGnE,gBAAAG,EAACC,GAAA,EAAe,GAAGJ,GACjB,UAAA,gBAAAG,EAACE,KAAM,GAAGL,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,MAAMK,IAAO,CAAC,EAAE,YAAAC,GAAY,WAAAC,GAAW,SAAAC,IAAU,SAA0B;AACzE,QAAM,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACd,EAAE,EAAA,IAAMC,EAAe,4BAA4B,GACnDC,IAAaC,EAAA,GAEb;AAAA,IACJ,MAAM,EAAE,UAAAC,EAAA;AAAA,EAAS,IACfC,EAAwB,EAAE,YAAAT,GAAY,GACpC,EAAE,WAAAU,GAAW,UAAAC,EAAA,IAAaH,GAE1B,EAAE,MAAAI,EAAA,IAASC,EAAwC,EAAE,YAAAb,GAAY,GACjE,EAAE,kBAAAc,GAAkB,iBAAAC,EAAA,IAAoBH,EAAK,0BAE7CI,IACJD,GAAiB,UACjBA,EAAgB,UAAU,CAAAE,MAAQA,EAAK,YAAY,CAACA,EAAK,SAAS,IAAI,IAElEC,IACJJ,MAAqBK,EAAyB,wBAC7C,CAACH,KACAF,MAAqBK,EAAyB,gCAE5CC,IAAqBC,EAAQ,MAAMC,EAAU,SAASZ,CAAS,GAAG,CAACA,CAAS,CAAC,GAC7Ea,IAAoBF,EAAQ,MAAMC,EAAU,SAASX,CAAQ,GAAG,CAACA,CAAQ,CAAC;AAEhF,SACE,gBAAAd,EAAC,aAAQ,WAAAI,GACP,UAAA,gBAAAuB,EAACC,KAAK,eAAc,UAAS,KAAK,IAChC,UAAA;AAAA,IAAA,gBAAA5B,EAAC4B,KAAK,YAAW,UAAS,eAAc,UAAS,KAAK,GACnD,UAAAvB,IACCgB,IACE,gBAAAM,EAACC,KAAK,eAAc,UAAS,KAAK,GAAG,YAAW,UAC9C,UAAA;AAAA,MAAA,gBAAA5B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAAK,WAAU,UACnC,YAAE,0BAA0B;AAAA,QAC3B,MAAM,GAAGc,CAAkB,IAAIG,CAAiB;AAAA,QAChD,eAAe,EAAE,aAAa,GAAA;AAAA,MAAM,CACrC,GACH;AAAA,MACA,gBAAA1B,EAACS,EAAW,MAAX,EAAgB,SAAQ,cAAa,WAAWoB,EAAO,aACrD,UAAA,EAAE,2BAA2B,EAAA,CAChC;AAAA,IAAA,EAAA,CACF,sBAECD,GAAA,EAAK,eAAc,UAAS,YAAW,cAAa,KAAK,GACxD,UAAA;AAAA,MAAA,gBAAA5B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAAM,UAAA,EAAE,6BAA6B,GAAE;AAAA,wBAC7DA,EAAW,MAAX,EAAiB,UAAA,EAAE,gCAAgC,GAAE;AAAA,wBACrD,MAAA,EAAG,WAAWoB,EAAO,MACnB,aACG,KAAK,CAACC,GAAGC,MAAOD,EAAE,YAAY,KAAK,CAAE,EACtC,IAAI,CAAAV,MAED,gBAAAO,EAAC,MAAA,EAAiB,WAAWE,EAAO,UACjC,UAAA;AAAA,QAAAT,EAAK,YACJ,gBAAApB,EAACgC,GAAA,EAAa,OAAO,IAAI,QAAQ,IAAI,WAAWH,EAAO,aAAA,CAAc,IAErE,gBAAA7B;AAAA,UAACiC;AAAAA,UAAA;AAAA,YACC,OAAO;AAAA,YACP,QAAQ;AAAA,YACR,WAAWC,EAAWL,EAAO,cAAcA,EAAO,UAAU;AAAA,UAAA;AAAA,QAAA;AAAA,QAGhE,gBAAA7B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAEpB,UAAA,EAAE,SAASW,EAAK,EAAE,IAAIA,EAAK,KAAK,EAAA,CACnC;AAAA,MAAA,EAAA,GAbOA,EAAK,EAcd,CAEH,EAAA,CACL;AAAA,IAAA,EAAA,CACF,2BAIA,UAAA,gBAAAO,EAACC,GAAA,EAAK,eAAc,UAAS,KAAK,IAAI,YAAW,UAC/C,UAAA;AAAA,MAAA,gBAAAD,EAACC,KAAK,eAAc,UAAS,KAAK,GAAG,YAAW,UAC9C,UAAA;AAAA,QAAA,gBAAA5B,EAACS,EAAW,SAAX,EAAmB,IAAG,MAAK,WAAU,UACnC,UAAA,EAAE,uBAAuB,EAAA,CAC5B;AAAA,QACA,gBAAAT,EAACS,EAAW,MAAX,EAAgB,SAAQ,cAAa,WAAWoB,EAAO,aACrD,UAAA,EAAE,0BAA0B,EAAA,CAC/B;AAAA,MAAA,GACF;AAAA,MACA,gBAAA7B,EAACmC,GAAA,EAAc,gBAAgBd,IAAwB,WAAW,SAChE,UAAA,gBAAArB;AAAA,QAACS,EAAW;AAAA,QAAX;AAAA,UACC,SAAQ;AAAA,UACR,SAAS,MAAM;AACb,YAAAH,EAAQ8B,EAAgB,wBAAwB;AAAA,UAClD;AAAA,UAEC,YAAE,SAAS;AAAA,QAAA;AAAA,MAAA,EACd,CACF;AAAA,IAAA,EAAA,CACF,GACF,GAEJ;AAAA,IAEC/B,KACC,gBAAAL,EAACmC,GAAA,EAAc,gBAAgB,UAC7B,UAAA,gBAAAnC;AAAA,MAACS,EAAW;AAAA,MAAX;AAAA,QACC,SAAQ;AAAA,QACR,SAAS,MAAM;AACb,UAAAH,EAAQ8B,EAAgB,cAAc;AAAA,QACxC;AAAA,QAEC,YAAE,SAAS;AAAA,MAAA;AAAA,IAAA,EACd,CACF;AAAA,EAAA,EAAA,CAEJ,EAAA,CACF;AAEJ,GAGaC,KAA8B,MAAM;AAC/C,QAAM,EAAE,YAAAlC,GAAY,SAAAG,GAAS,SAAAD,EAAA,IAAYiC,EAAA,GACnC,EAAE,GAAAC,EAAA,IAAM/B,EAAe,QAAQ;AAErC,MAAI,CAACL;AACH,UAAM,IAAI;AAAA,MACRoC,EAAE,iCAAiC;AAAA,QACjC,WAAW;AAAA,QACX,OAAO;AAAA,QACP,UAAU;AAAA,MAAA,CACX;AAAA,IAAA;AAGL,SAAO,gBAAAvC,EAACJ,GAAA,EAAkB,YAAAO,GAAwB,SAAAG,GAAkB,SAAAD,EAAA,CAAkB;AACxF;"}

package/dist/components/Employee/PaymentMethod/management/PaymentMethod.d.ts

@@ -1,11 +1,50 @@
 import { BaseComponentInterface, CommonComponentInterface } from '../../../Base';
 import { EventType } from '../../../../shared/constants';
 import { OnEventType } from '../../../Base/useBase';
+/**
+ * Props for {@link PaymentMethod}.
+ *
+ * @public
+ */
 export interface PaymentMethodProps extends CommonComponentInterface<'Employee.Management.PaymentMethod'> {
+    /** The associated employee identifier. */
     employeeId: string;
+    /** Not used — payment method management edits live data. */
     defaultValues?: never;
+    /** Whether the current viewer is an admin. Defaults to `true`. */
     isAdmin?: boolean;
+    /** Step to render first: the list card, the add-account form, or the split-paycheck form. Defaults to `'list'`. */
     initialState?: 'list' | 'add' | 'split';
+    /** Event handler fired on flow state changes. */
     onEvent: OnEventType<EventType, unknown>;
 }
+/**
+ * Management flow for editing an employee's payment method.
+ *
+ * @remarks
+ * Orchestrates the list card, add-bank-account form, and split-paycheck form
+ * for an existing employee. Routes between steps based on user actions
+ * starting from `initialState`. Composed of the smaller standalone components
+ * ({@link PaymentMethodCard}, {@link PaymentMethodBankForm},
+ * {@link PaymentMethodSplitForm}) which can also be used directly when an
+ * orchestrator other than this flow is needed.
+ *
+ * @param props - See {@link PaymentMethodProps}.
+ * @returns The payment method management flow.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import { EmployeeManagement } from '@gusto/embedded-react-sdk'
+ *
+ * function MyComponent() {
+ *   return (
+ *     <EmployeeManagement.PaymentMethod
+ *       employeeId="4b3f930f-82cd-48a8-b797-798686e12e5e"
+ *       onEvent={() => {}}
+ *     />
+ *   )
+ * }
+ * ```
+ */
 export declare function PaymentMethod({ dictionary, FallbackComponent, ...props }: PaymentMethodProps & BaseComponentInterface<'Employee.Management.PaymentMethod'>): import("react").JSX.Element;