@gusto/embedded-react-sdk 0.48.1 → 0.48.3

package/dist/components/Company/DocumentSigner/DocumentList/useDocumentList.js

@@ -1,9 +1,23 @@
+import "react/jsx-runtime";
+import "react";
+import "react-error-boundary";
+import "react-i18next";
+import "@tanstack/react-query";
+import "../../../Base/useBase.js";
+import "@gusto/embedded-api-v-2025-11-15/models/errors/apierror";
+import "@gusto/embedded-api-v-2025-11-15/models/errors/gustoembeddederror";
+import "@gusto/embedded-api-v-2025-11-15/models/errors/sdkvalidationerror";
+import "@gusto/embedded-api-v-2025-11-15/models/errors/unprocessableentityerror";
+import "@gusto/embedded-api-v-2025-11-15/models/errors/httpclienterrors";
+import "../../../../shared/constants.js";
+import "../../../../contexts/ComponentAdapter/useComponentContext.js";
+import "../../../../contexts/LoadingIndicatorProvider/useLoadingIndicator.js";
 import { createCompoundContext as t } from "../../../Base/createCompoundContext.js";
-const [e, n] = t(
+const [d, f] = t(
   "CompanyDocumentListContext"
 );
 export {
-  n as DocumentListProvider,
-  e as useDocumentList
+  f as DocumentListProvider,
+  d as useDocumentList
 };
 //# sourceMappingURL=useDocumentList.js.map

package/dist/components/Company/DocumentSigner/DocumentList/useDocumentList.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDocumentList.js","sources":["../../../../../src/components/Company/DocumentSigner/DocumentList/useDocumentList.ts"],"sourcesContent":["import { type Signatory } from '@gusto/embedded-api-v-2025-11-15/models/components/signatory'\nimport { type Form as FormSchema } from '@gusto/embedded-api-v-2025-11-15/models/components/form'\nimport { createCompoundContext } from '@/components/Base'\n\ntype DocumentListContextType = {\n  companyForms: FormSchema[]\n  documentListError: Error | null\n  handleRequestFormToSign: (form: FormSchema) => void\n  handleChangeSignatory: () => void\n  handleContinue: () => void\n  isSelfSignatory: boolean\n  signatory?: Signatory\n}\n\nconst [useDocumentList, DocumentListProvider] = createCompoundContext<DocumentListContextType>(\n  'CompanyDocumentListContext',\n)\n\nexport { useDocumentList, DocumentListProvider }\n"],"names":["useDocumentList","DocumentListProvider","createCompoundContext"],"mappings":";AAcA,MAAM,CAACA,GAAiBC,CAAoB,IAAIC;AAAA,EAC9C;AACF;"}
+{"version":3,"file":"useDocumentList.js","sources":["../../../../../src/components/Company/DocumentSigner/DocumentList/useDocumentList.ts"],"sourcesContent":["import { type Signatory } from '@gusto/embedded-api-v-2025-11-15/models/components/signatory'\nimport { type Form as FormSchema } from '@gusto/embedded-api-v-2025-11-15/models/components/form'\nimport { createCompoundContext } from '@/components/Base'\n\ntype DocumentListContextType = {\n  companyForms: FormSchema[]\n  documentListError: Error | null\n  handleRequestFormToSign: (form: FormSchema) => void\n  handleChangeSignatory: () => void\n  handleContinue: () => void\n  isSelfSignatory: boolean\n  signatory?: Signatory\n}\n\nconst [useDocumentList, DocumentListProvider] = createCompoundContext<DocumentListContextType>(\n  'CompanyDocumentListContext',\n)\n\nexport { useDocumentList, DocumentListProvider }\n"],"names":["useDocumentList","DocumentListProvider","createCompoundContext"],"mappings":";;;;;;;;;;;;;;;AAcA,MAAM,CAACA,GAAiBC,CAAoB,IAAIC;AAAA,EAC9C;AACF;"}

package/dist/components/Company/DocumentSigner/DocumentSigner.d.ts

@@ -1,6 +1,43 @@
 import { BaseComponentInterface } from '../../Base';
+/**
+ * Props for {@link DocumentSigner}.
+ *
+ * @public
+ */
 export interface DocumentSignerProps extends BaseComponentInterface<'Company.DocumentList'> {
+    /** The associated company identifier. */
     companyId: string;
+    /**
+     * ID of the signatory. When set and matching the current signatory, the user is treated as the
+     * signatory and is allowed to sign documents — the signature form is pre-populated with their
+     * information.
+     */
     signatoryId?: string;
 }
+/**
+ * Company onboarding step for reading and signing required company documents.
+ *
+ * @remarks
+ * Handles document listing, signatory management, and the signing workflow. If no signatory has
+ * been assigned for the company yet, the flow starts on the assign-signatory step before
+ * presenting the document list.
+ *
+ * | Event | Description | Data |
+ * | ----- | ----------- | ---- |
+ * | `company/forms/view` | Fired when a user selects a form to sign from the document list | {@link Form} |
+ * | `company/forms/editSignatory` | Fired when the user requests to change the document signatory | The current signatory entity |
+ * | `company/forms/done` | Fired when the user completes the document signing process | — |
+ * | `company/forms/sign/signForm` | Fired when a form is successfully signed | {@link Form} |
+ * | `company/forms/sign/done` | Fired when the form signing process is complete | — |
+ * | `company/forms/sign/back` | Fired when the user navigates back from the signature form | — |
+ * | `company/signatory/assignSignatory/modeUpdated` | Fired when the signatory assignment mode changes | `'createSignatory'` or `'inviteSignatory'` |
+ * | `company/signatory/assignSignatory/done` | Fired when the signatory assignment process is complete | — |
+ * | `company/signatory/created` | Fired when a new signatory is created successfully | {@link Signatory} |
+ * | `company/signatory/updated` | Fired when an existing signatory is updated successfully | {@link Signatory} |
+ * | `company/signatory/invited` | Fired when a signatory is successfully invited to the company | {@link Signatory} |
+ *
+ * @param props - See {@link DocumentSignerProps}.
+ * @returns The document signer flow.
+ * @public
+ */
 export declare function DocumentSigner(props: DocumentSignerProps): import("react").JSX.Element;

package/dist/components/Company/DocumentSigner/DocumentSigner.js

@@ -6,6 +6,7 @@ import { DocumentList as p, AssignSignatory as f } from "./documentSignerStateMa
 import { documentSignerMachine as S } from "./stateMachine.js";
 import { Flow as d } from "../../Flow/Flow.js";
 import { BaseComponent as h } from "../../Base/Base.js";
+import "../../Base/useBase.js";
 import { useComponentDictionary as D } from "../../../i18n/I18n.js";
 function L({ companyId: o, signatoryId: i, onEvent: e, dictionary: r }) {
   D("Company.DocumentList", r);
@@ -29,10 +30,10 @@ function L({ companyId: o, signatoryId: i, onEvent: e, dictionary: r }) {
   );
   return /* @__PURE__ */ t(d, { machine: s, onEvent: e });
 }
-function E(o) {
+function U(o) {
   return /* @__PURE__ */ t(h, { ...o, children: /* @__PURE__ */ t(L, { ...o }) });
 }
 export {
-  E as DocumentSigner
+  U as DocumentSigner
 };
 //# sourceMappingURL=DocumentSigner.js.map

package/dist/components/Company/DocumentSigner/DocumentSigner.js.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentSigner.js","sources":["../../../../src/components/Company/DocumentSigner/DocumentSigner.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useSignatoriesListSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/signatoriesList'\nimport { useMemo } from 'react'\nimport { AssignSignatory, DocumentList } from './documentSignerStateMachine'\nimport { documentSignerMachine } from './stateMachine'\nimport type { DocumentSignerContextInterface } from './useDocumentSigner'\nimport { Flow } from '@/components/Flow/Flow'\nimport { BaseComponent, type BaseComponentInterface } from '@/components/Base'\nimport { useComponentDictionary } from '@/i18n/I18n'\n\nexport interface DocumentSignerProps extends BaseComponentInterface<'Company.DocumentList'> {\n  companyId: string\n  signatoryId?: string\n}\n\nfunction DocumentSignerFlow({ companyId, signatoryId, onEvent, dictionary }: DocumentSignerProps) {\n  useComponentDictionary('Company.DocumentList', dictionary)\n  const {\n    data: { signatories: signatoryList },\n  } = useSignatoriesListSuspense({\n    companyUuid: companyId,\n  })\n  const signatories = signatoryList!\n  const doesSignatoryExist = signatories.length > 0\n\n  const documentSigner = useMemo(\n    () =>\n      createMachine(\n        doesSignatoryExist ? 'documentList' : 'index',\n        documentSignerMachine,\n        (initialContext: DocumentSignerContextInterface) => ({\n          ...initialContext,\n          component: doesSignatoryExist ? DocumentList : AssignSignatory,\n          companyId,\n          signatoryId,\n        }),\n      ),\n\n    [companyId], // Only companyId - prevents recreation when signatoryId/doesSignatoryExist change\n  )\n  return <Flow machine={documentSigner} onEvent={onEvent} />\n}\n\nexport function DocumentSigner(props: DocumentSignerProps) {\n  return (\n    <BaseComponent {...props}>\n      <DocumentSignerFlow {...props} />\n    </BaseComponent>\n  )\n}\n"],"names":["DocumentSignerFlow","companyId","signatoryId","onEvent","dictionary","useComponentDictionary","signatoryList","useSignatoriesListSuspense","doesSignatoryExist","documentSigner","useMemo","createMachine","documentSignerMachine","initialContext","DocumentList","AssignSignatory","jsx","Flow","DocumentSigner","props","BaseComponent"],"mappings":";;;;;;;;;AAeA,SAASA,EAAmB,EAAE,WAAAC,GAAW,aAAAC,GAAa,SAAAC,GAAS,YAAAC,KAAmC;AAChG,EAAAC,EAAuB,wBAAwBD,CAAU;AACzD,QAAM;AAAA,IACJ,MAAM,EAAE,aAAaE,EAAA;AAAA,EAAc,IACjCC,EAA2B;AAAA,IAC7B,aAAaN;AAAA,EAAA,CACd,GAEKO,IADcF,EACmB,SAAS,GAE1CG,IAAiBC;AAAA,IACrB,MACEC;AAAA,MACEH,IAAqB,iBAAiB;AAAA,MACtCI;AAAA,MACA,CAACC,OAAoD;AAAA,QACnD,GAAGA;AAAA,QACH,WAAWL,IAAqBM,IAAeC;AAAA,QAC/C,WAAAd;AAAA,QACA,aAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAGJ,CAACD,CAAS;AAAA;AAAA,EAAA;AAEZ,SAAO,gBAAAe,EAACC,GAAA,EAAK,SAASR,GAAgB,SAAAN,EAAA,CAAkB;AAC1D;AAEO,SAASe,EAAeC,GAA4B;AACzD,SACE,gBAAAH,EAACI,KAAe,GAAGD,GACjB,4BAACnB,GAAA,EAAoB,GAAGmB,GAAO,EAAA,CACjC;AAEJ;"}
+{"version":3,"file":"DocumentSigner.js","sources":["../../../../src/components/Company/DocumentSigner/DocumentSigner.tsx"],"sourcesContent":["import { createMachine } from 'robot3'\nimport { useSignatoriesListSuspense } from '@gusto/embedded-api-v-2025-11-15/react-query/signatoriesList'\nimport { useMemo } from 'react'\nimport { AssignSignatory, DocumentList } from './documentSignerStateMachine'\nimport { documentSignerMachine } from './stateMachine'\nimport type { DocumentSignerContextInterface } from './useDocumentSigner'\nimport { Flow } from '@/components/Flow/Flow'\nimport { BaseComponent, type BaseComponentInterface } from '@/components/Base'\nimport { useComponentDictionary } from '@/i18n/I18n'\n\n/**\n * Props for {@link DocumentSigner}.\n *\n * @public\n */\nexport interface DocumentSignerProps extends BaseComponentInterface<'Company.DocumentList'> {\n  /** The associated company identifier. */\n  companyId: string\n  /**\n   * ID of the signatory. When set and matching the current signatory, the user is treated as the\n   * signatory and is allowed to sign documents — the signature form is pre-populated with their\n   * information.\n   */\n  signatoryId?: string\n}\n\nfunction DocumentSignerFlow({ companyId, signatoryId, onEvent, dictionary }: DocumentSignerProps) {\n  useComponentDictionary('Company.DocumentList', dictionary)\n  const {\n    data: { signatories: signatoryList },\n  } = useSignatoriesListSuspense({\n    companyUuid: companyId,\n  })\n  const signatories = signatoryList!\n  const doesSignatoryExist = signatories.length > 0\n\n  const documentSigner = useMemo(\n    () =>\n      createMachine(\n        doesSignatoryExist ? 'documentList' : 'index',\n        documentSignerMachine,\n        (initialContext: DocumentSignerContextInterface) => ({\n          ...initialContext,\n          component: doesSignatoryExist ? DocumentList : AssignSignatory,\n          companyId,\n          signatoryId,\n        }),\n      ),\n\n    [companyId], // Only companyId - prevents recreation when signatoryId/doesSignatoryExist change\n  )\n  return <Flow machine={documentSigner} onEvent={onEvent} />\n}\n\n/**\n * Company onboarding step for reading and signing required company documents.\n *\n * @remarks\n * Handles document listing, signatory management, and the signing workflow. If no signatory has\n * been assigned for the company yet, the flow starts on the assign-signatory step before\n * presenting the document list.\n *\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `company/forms/view` | Fired when a user selects a form to sign from the document list | {@link Form} |\n * | `company/forms/editSignatory` | Fired when the user requests to change the document signatory | The current signatory entity |\n * | `company/forms/done` | Fired when the user completes the document signing process | — |\n * | `company/forms/sign/signForm` | Fired when a form is successfully signed | {@link Form} |\n * | `company/forms/sign/done` | Fired when the form signing process is complete | — |\n * | `company/forms/sign/back` | Fired when the user navigates back from the signature form | — |\n * | `company/signatory/assignSignatory/modeUpdated` | Fired when the signatory assignment mode changes | `'createSignatory'` or `'inviteSignatory'` |\n * | `company/signatory/assignSignatory/done` | Fired when the signatory assignment process is complete | — |\n * | `company/signatory/created` | Fired when a new signatory is created successfully | {@link Signatory} |\n * | `company/signatory/updated` | Fired when an existing signatory is updated successfully | {@link Signatory} |\n * | `company/signatory/invited` | Fired when a signatory is successfully invited to the company | {@link Signatory} |\n *\n * @param props - See {@link DocumentSignerProps}.\n * @returns The document signer flow.\n * @public\n */\nexport function DocumentSigner(props: DocumentSignerProps) {\n  return (\n    <BaseComponent {...props}>\n      <DocumentSignerFlow {...props} />\n    </BaseComponent>\n  )\n}\n"],"names":["DocumentSignerFlow","companyId","signatoryId","onEvent","dictionary","useComponentDictionary","signatoryList","useSignatoriesListSuspense","doesSignatoryExist","documentSigner","useMemo","createMachine","documentSignerMachine","initialContext","DocumentList","AssignSignatory","jsx","Flow","DocumentSigner","props","BaseComponent"],"mappings":";;;;;;;;;;AA0BA,SAASA,EAAmB,EAAE,WAAAC,GAAW,aAAAC,GAAa,SAAAC,GAAS,YAAAC,KAAmC;AAChG,EAAAC,EAAuB,wBAAwBD,CAAU;AACzD,QAAM;AAAA,IACJ,MAAM,EAAE,aAAaE,EAAA;AAAA,EAAc,IACjCC,EAA2B;AAAA,IAC7B,aAAaN;AAAA,EAAA,CACd,GAEKO,IADcF,EACmB,SAAS,GAE1CG,IAAiBC;AAAA,IACrB,MACEC;AAAA,MACEH,IAAqB,iBAAiB;AAAA,MACtCI;AAAA,MACA,CAACC,OAAoD;AAAA,QACnD,GAAGA;AAAA,QACH,WAAWL,IAAqBM,IAAeC;AAAA,QAC/C,WAAAd;AAAA,QACA,aAAAC;AAAA,MAAA;AAAA,IACF;AAAA,IAGJ,CAACD,CAAS;AAAA;AAAA,EAAA;AAEZ,SAAO,gBAAAe,EAACC,GAAA,EAAK,SAASR,GAAgB,SAAAN,EAAA,CAAkB;AAC1D;AA4BO,SAASe,EAAeC,GAA4B;AACzD,SACE,gBAAAH,EAACI,KAAe,GAAGD,GACjB,4BAACnB,GAAA,EAAoB,GAAGmB,GAAO,EAAA,CACjC;AAEJ;"}

package/dist/components/Company/DocumentSigner/SignatureForm/SignatureForm.d.ts

@@ -1,7 +1,36 @@
 import { BaseComponentInterface } from '../../../Base/Base';
-interface SignatureFormProps extends BaseComponentInterface<'Company.SignatureForm'> {
+/**
+ * Props for {@link SignatureForm}.
+ *
+ * @public
+ */
+export interface SignatureFormProps extends BaseComponentInterface<'Company.SignatureForm'> {
+    /** The identifier of the form the user is signing. */
     formId: string;
+    /** The associated company identifier. */
     companyId: string;
+    /**
+     * Not applicable to this component — form fields are populated from the API using `formId`.
+     * @override
+     */
+    defaultValues?: never;
 }
+/**
+ * Standalone form for signing an individual company document.
+ *
+ * @remarks
+ * Lower-level building block used internally by the document signer for its signing view.
+ * Use this component directly when you need full control over navigation between the document
+ * list and the signature form (e.g. routing the user yourself after they select a form).
+ *
+ * | Event | Description | Data |
+ * | ----- | ----------- | ---- |
+ * | `company/forms/sign/signForm` | Fired when a form is successfully signed | Response from the sign company form API request |
+ * | `company/forms/sign/back` | Fired when the user navigates back from the signature form | — |
+ * | `company/forms/sign/done` | Fired when the form signing process is complete | — |
+ *
+ * @param props - See {@link SignatureFormProps}.
+ * @returns The rendered signature form.
+ * @public
+ */
 export declare function SignatureForm(props: SignatureFormProps): import("react").JSX.Element;
-export {};

package/dist/components/Company/DocumentSigner/SignatureForm/SignatureForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"SignatureForm.js","sources":["../../../../../src/components/Company/DocumentSigner/SignatureForm/SignatureForm.tsx"],"sourcesContent":["import { Trans, useTranslation } from 'react-i18next'\nimport { useSignCompanyForm } from '../shared/useSignCompanyForm'\nimport { useI18n, useComponentDictionary } from '@/i18n'\nimport type { BaseComponentInterface } from '@/components/Base/Base'\nimport { BaseComponent, BaseLayout } from '@/components/Base'\nimport { useBase } from '@/components/Base/useBase'\nimport { ActionsLayout, Flex } from '@/components/Common'\nimport { Form as FormLayout } from '@/components/Common/Form'\nimport { DocumentViewer } from '@/components/Common/DocumentViewer'\nimport { SDKFormProvider } from '@/partner-hook-utils/form/SDKFormProvider'\nimport { companyEvents } from '@/shared/constants'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\ninterface SignatureFormProps extends BaseComponentInterface<'Company.SignatureForm'> {\n  formId: string\n  companyId: string\n}\n\nexport function SignatureForm(props: SignatureFormProps) {\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nfunction Root({ formId, children, dictionary }: SignatureFormProps) {\n  useComponentDictionary('Company.SignatureForm', dictionary)\n  useI18n('Company.SignatureForm')\n  const { t } = useTranslation('Company.SignatureForm')\n  const { onEvent } = useBase()\n  const Components = useComponentContext()\n\n  const hookResult = useSignCompanyForm({ formId })\n\n  if (hookResult.isLoading) {\n    return <BaseLayout isLoading error={hookResult.errorHandling.errors} />\n  }\n\n  const { companyForm: form, pdfUrl } = hookResult.data\n  const { isPending } = hookResult.status\n  const { Signature, ConfirmSignature } = hookResult.form.Fields\n\n  const handleFormSubmit = async () => {\n    const result = await hookResult.actions.onSubmit()\n    if (result) {\n      onEvent(companyEvents.COMPANY_SIGN_FORM, result.data)\n      onEvent(companyEvents.COMPANY_SIGN_FORM_DONE)\n    }\n  }\n\n  const handleBack = () => {\n    onEvent(companyEvents.COMPANY_SIGN_FORM_BACK)\n  }\n\n  return (\n    <BaseLayout error={hookResult.errorHandling.errors}>\n      <SDKFormProvider formHookResult={hookResult}>\n        <FormLayout onSubmit={handleFormSubmit}>\n          <Flex flexDirection=\"column\" gap={32} alignItems=\"stretch\">\n            {children ?? (\n              <>\n                <section>\n                  <Flex flexDirection=\"column\" gap={4}>\n                    <Components.Heading as=\"h2\">\n                      {t('signatureFormTitle', { formTitle: form.title })}\n                    </Components.Heading>\n                    {pdfUrl && (\n                      <Components.Text variant=\"supporting\">\n                        <Trans\n                          t={t}\n                          i18nKey=\"downloadPrompt\"\n                          values={{ description: form.description }}\n                          components={{\n                            downloadLink: (\n                              <Components.Link\n                                href={pdfUrl}\n                                target=\"_blank\"\n                                rel=\"noopener noreferrer\"\n                                download={`${form.title || 'form'}.pdf`}\n                              />\n                            ),\n                          }}\n                        />\n                      </Components.Text>\n                    )}\n                  </Flex>\n                </section>\n                <DocumentViewer\n                  url={pdfUrl}\n                  title={form.title}\n                  downloadInstructions={t('downloadInstructions')}\n                  viewDocumentLabel={t('viewDocumentCta')}\n                />\n                <Signature\n                  label={t('signatureLabel')}\n                  description={t('signatureDescription')}\n                  validationMessages={{ REQUIRED: t('signatureError') }}\n                />\n                <ConfirmSignature\n                  label={t('confirmationLabel')}\n                  validationMessages={{ REQUIRED: t('confirmationError') }}\n                />\n                <ActionsLayout>\n                  <Components.Button variant=\"secondary\" type=\"button\" onClick={handleBack}>\n                    {t('backCta')}\n                  </Components.Button>\n                  <Components.Button type=\"submit\" isLoading={isPending}>\n                    {t('submitCta')}\n                  </Components.Button>\n                </ActionsLayout>\n              </>\n            )}\n          </Flex>\n        </FormLayout>\n      </SDKFormProvider>\n    </BaseLayout>\n  )\n}\n"],"names":["SignatureForm","props","jsx","BaseComponent","Root","formId","children","dictionary","useComponentDictionary","useI18n","t","useTranslation","onEvent","useBase","Components","useComponentContext","hookResult","useSignCompanyForm","BaseLayout","form","pdfUrl","isPending","Signature","ConfirmSignature","handleFormSubmit","result","companyEvents","handleBack","SDKFormProvider","FormLayout","Flex","jsxs","Fragment","Trans","DocumentViewer","ActionsLayout"],"mappings":";;;;;;;;;;;;;;AAkBO,SAASA,EAAcC,GAA2B;AACvD,SACE,gBAAAC,EAACC,GAAA,EAAe,GAAGF,GACjB,UAAA,gBAAAC,EAACE,KAAM,GAAGH,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,SAASG,EAAK,EAAE,QAAAC,GAAQ,UAAAC,GAAU,YAAAC,KAAkC;AAClE,EAAAC,EAAuB,yBAAyBD,CAAU,GAC1DE,EAAQ,uBAAuB;AAC/B,QAAM,EAAE,GAAAC,EAAA,IAAMC,EAAe,uBAAuB,GAC9C,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAaC,EAAA,GAEbC,IAAaC,EAAmB,EAAE,QAAAZ,GAAQ;AAEhD,MAAIW,EAAW;AACb,6BAAQE,GAAA,EAAW,WAAS,IAAC,OAAOF,EAAW,cAAc,QAAQ;AAGvE,QAAM,EAAE,aAAaG,GAAM,QAAAC,EAAA,IAAWJ,EAAW,MAC3C,EAAE,WAAAK,MAAcL,EAAW,QAC3B,EAAE,WAAAM,GAAW,kBAAAC,EAAA,IAAqBP,EAAW,KAAK,QAElDQ,IAAmB,YAAY;AACnC,UAAMC,IAAS,MAAMT,EAAW,QAAQ,SAAA;AACxC,IAAIS,MACFb,EAAQc,EAAc,mBAAmBD,EAAO,IAAI,GACpDb,EAAQc,EAAc,sBAAsB;AAAA,EAEhD,GAEMC,IAAa,MAAM;AACvB,IAAAf,EAAQc,EAAc,sBAAsB;AAAA,EAC9C;AAEA,SACE,gBAAAxB,EAACgB,KAAW,OAAOF,EAAW,cAAc,QAC1C,UAAA,gBAAAd,EAAC0B,GAAA,EAAgB,gBAAgBZ,GAC/B,UAAA,gBAAAd,EAAC2B,KAAW,UAAUL,GACpB,UAAA,gBAAAtB,EAAC4B,GAAA,EAAK,eAAc,UAAS,KAAK,IAAI,YAAW,WAC9C,UAAAxB,KACC,gBAAAyB,EAAAC,GAAA,EACE,UAAA;AAAA,IAAA,gBAAA9B,EAAC,aACC,UAAA,gBAAA6B,EAACD,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,MAAA,gBAAA5B,EAACY,EAAW,SAAX,EAAmB,IAAG,MACpB,UAAAJ,EAAE,sBAAsB,EAAE,WAAWS,EAAK,MAAA,CAAO,EAAA,CACpD;AAAA,MACCC,KACC,gBAAAlB,EAACY,EAAW,MAAX,EAAgB,SAAQ,cACvB,UAAA,gBAAAZ;AAAA,QAAC+B;AAAA,QAAA;AAAA,UACC,GAAAvB;AAAA,UACA,SAAQ;AAAA,UACR,QAAQ,EAAE,aAAaS,EAAK,YAAA;AAAA,UAC5B,YAAY;AAAA,YACV,cACE,gBAAAjB;AAAA,cAACY,EAAW;AAAA,cAAX;AAAA,gBACC,MAAMM;AAAA,gBACN,QAAO;AAAA,gBACP,KAAI;AAAA,gBACJ,UAAU,GAAGD,EAAK,SAAS,MAAM;AAAA,cAAA;AAAA,YAAA;AAAA,UACnC;AAAA,QAEJ;AAAA,MAAA,EACF,CACF;AAAA,IAAA,EAAA,CAEJ,EAAA,CACF;AAAA,IACA,gBAAAjB;AAAA,MAACgC;AAAA,MAAA;AAAA,QACC,KAAKd;AAAA,QACL,OAAOD,EAAK;AAAA,QACZ,sBAAsBT,EAAE,sBAAsB;AAAA,QAC9C,mBAAmBA,EAAE,iBAAiB;AAAA,MAAA;AAAA,IAAA;AAAA,IAExC,gBAAAR;AAAA,MAACoB;AAAA,MAAA;AAAA,QACC,OAAOZ,EAAE,gBAAgB;AAAA,QACzB,aAAaA,EAAE,sBAAsB;AAAA,QACrC,oBAAoB,EAAE,UAAUA,EAAE,gBAAgB,EAAA;AAAA,MAAE;AAAA,IAAA;AAAA,IAEtD,gBAAAR;AAAA,MAACqB;AAAA,MAAA;AAAA,QACC,OAAOb,EAAE,mBAAmB;AAAA,QAC5B,oBAAoB,EAAE,UAAUA,EAAE,mBAAmB,EAAA;AAAA,MAAE;AAAA,IAAA;AAAA,sBAExDyB,GAAA,EACC,UAAA;AAAA,MAAA,gBAAAjC,EAACY,EAAW,QAAX,EAAkB,SAAQ,aAAY,MAAK,UAAS,SAASa,GAC3D,UAAAjB,EAAE,SAAS,EAAA,CACd;AAAA,MACA,gBAAAR,EAACY,EAAW,QAAX,EAAkB,MAAK,UAAS,WAAWO,GACzC,UAAAX,EAAE,WAAW,EAAA,CAChB;AAAA,IAAA,EAAA,CACF;AAAA,EAAA,EAAA,CACF,EAAA,CAEJ,GACF,EAAA,CACF,EAAA,CACF;AAEJ;"}
+{"version":3,"file":"SignatureForm.js","sources":["../../../../../src/components/Company/DocumentSigner/SignatureForm/SignatureForm.tsx"],"sourcesContent":["import { Trans, useTranslation } from 'react-i18next'\nimport { useSignCompanyForm } from '../shared/useSignCompanyForm'\nimport { useI18n, useComponentDictionary } from '@/i18n'\nimport type { BaseComponentInterface } from '@/components/Base/Base'\nimport { BaseComponent, BaseLayout } from '@/components/Base'\nimport { useBase } from '@/components/Base/useBase'\nimport { ActionsLayout, Flex } from '@/components/Common'\nimport { Form as FormLayout } from '@/components/Common/Form'\nimport { DocumentViewer } from '@/components/Common/DocumentViewer'\nimport { SDKFormProvider } from '@/partner-hook-utils/form/SDKFormProvider'\nimport { companyEvents } from '@/shared/constants'\nimport { useComponentContext } from '@/contexts/ComponentAdapter/useComponentContext'\n\n/**\n * Props for {@link SignatureForm}.\n *\n * @public\n */\nexport interface SignatureFormProps extends BaseComponentInterface<'Company.SignatureForm'> {\n  /** The identifier of the form the user is signing. */\n  formId: string\n  /** The associated company identifier. */\n  companyId: string\n  /**\n   * Not applicable to this component — form fields are populated from the API using `formId`.\n   * @override\n   */\n  defaultValues?: never\n}\n\n/**\n * Standalone form for signing an individual company document.\n *\n * @remarks\n * Lower-level building block used internally by the document signer for its signing view.\n * Use this component directly when you need full control over navigation between the document\n * list and the signature form (e.g. routing the user yourself after they select a form).\n *\n * | Event | Description | Data |\n * | ----- | ----------- | ---- |\n * | `company/forms/sign/signForm` | Fired when a form is successfully signed | Response from the sign company form API request |\n * | `company/forms/sign/back` | Fired when the user navigates back from the signature form | — |\n * | `company/forms/sign/done` | Fired when the form signing process is complete | — |\n *\n * @param props - See {@link SignatureFormProps}.\n * @returns The rendered signature form.\n * @public\n */\nexport function SignatureForm(props: SignatureFormProps) {\n  return (\n    <BaseComponent {...props}>\n      <Root {...props}>{props.children}</Root>\n    </BaseComponent>\n  )\n}\n\nfunction Root({ formId, children, dictionary }: SignatureFormProps) {\n  useComponentDictionary('Company.SignatureForm', dictionary)\n  useI18n('Company.SignatureForm')\n  const { t } = useTranslation('Company.SignatureForm')\n  const { onEvent } = useBase()\n  const Components = useComponentContext()\n\n  const hookResult = useSignCompanyForm({ formId })\n\n  if (hookResult.isLoading) {\n    return <BaseLayout isLoading error={hookResult.errorHandling.errors} />\n  }\n\n  const { companyForm: form, pdfUrl } = hookResult.data\n  const { isPending } = hookResult.status\n  const { Signature, ConfirmSignature } = hookResult.form.Fields\n\n  const handleFormSubmit = async () => {\n    const result = await hookResult.actions.onSubmit()\n    if (result) {\n      onEvent(companyEvents.COMPANY_SIGN_FORM, result.data)\n      onEvent(companyEvents.COMPANY_SIGN_FORM_DONE)\n    }\n  }\n\n  const handleBack = () => {\n    onEvent(companyEvents.COMPANY_SIGN_FORM_BACK)\n  }\n\n  return (\n    <BaseLayout error={hookResult.errorHandling.errors}>\n      <SDKFormProvider formHookResult={hookResult}>\n        <FormLayout onSubmit={handleFormSubmit}>\n          <Flex flexDirection=\"column\" gap={32} alignItems=\"stretch\">\n            {children ?? (\n              <>\n                <section>\n                  <Flex flexDirection=\"column\" gap={4}>\n                    <Components.Heading as=\"h2\">\n                      {t('signatureFormTitle', { formTitle: form.title })}\n                    </Components.Heading>\n                    {pdfUrl && (\n                      <Components.Text variant=\"supporting\">\n                        <Trans\n                          t={t}\n                          i18nKey=\"downloadPrompt\"\n                          values={{ description: form.description }}\n                          components={{\n                            downloadLink: (\n                              <Components.Link\n                                href={pdfUrl}\n                                target=\"_blank\"\n                                rel=\"noopener noreferrer\"\n                                download={`${form.title || 'form'}.pdf`}\n                              />\n                            ),\n                          }}\n                        />\n                      </Components.Text>\n                    )}\n                  </Flex>\n                </section>\n                <DocumentViewer\n                  url={pdfUrl}\n                  title={form.title}\n                  downloadInstructions={t('downloadInstructions')}\n                  viewDocumentLabel={t('viewDocumentCta')}\n                />\n                <Signature\n                  label={t('signatureLabel')}\n                  description={t('signatureDescription')}\n                  validationMessages={{ REQUIRED: t('signatureError') }}\n                />\n                <ConfirmSignature\n                  label={t('confirmationLabel')}\n                  validationMessages={{ REQUIRED: t('confirmationError') }}\n                />\n                <ActionsLayout>\n                  <Components.Button variant=\"secondary\" type=\"button\" onClick={handleBack}>\n                    {t('backCta')}\n                  </Components.Button>\n                  <Components.Button type=\"submit\" isLoading={isPending}>\n                    {t('submitCta')}\n                  </Components.Button>\n                </ActionsLayout>\n              </>\n            )}\n          </Flex>\n        </FormLayout>\n      </SDKFormProvider>\n    </BaseLayout>\n  )\n}\n"],"names":["SignatureForm","props","jsx","BaseComponent","Root","formId","children","dictionary","useComponentDictionary","useI18n","t","useTranslation","onEvent","useBase","Components","useComponentContext","hookResult","useSignCompanyForm","BaseLayout","form","pdfUrl","isPending","Signature","ConfirmSignature","handleFormSubmit","result","companyEvents","handleBack","SDKFormProvider","FormLayout","Flex","jsxs","Fragment","Trans","DocumentViewer","ActionsLayout"],"mappings":";;;;;;;;;;;;;;AAgDO,SAASA,EAAcC,GAA2B;AACvD,SACE,gBAAAC,EAACC,GAAA,EAAe,GAAGF,GACjB,UAAA,gBAAAC,EAACE,KAAM,GAAGH,GAAQ,UAAAA,EAAM,SAAA,CAAS,EAAA,CACnC;AAEJ;AAEA,SAASG,EAAK,EAAE,QAAAC,GAAQ,UAAAC,GAAU,YAAAC,KAAkC;AAClE,EAAAC,EAAuB,yBAAyBD,CAAU,GAC1DE,EAAQ,uBAAuB;AAC/B,QAAM,EAAE,GAAAC,EAAA,IAAMC,EAAe,uBAAuB,GAC9C,EAAE,SAAAC,EAAA,IAAYC,EAAA,GACdC,IAAaC,EAAA,GAEbC,IAAaC,EAAmB,EAAE,QAAAZ,GAAQ;AAEhD,MAAIW,EAAW;AACb,6BAAQE,GAAA,EAAW,WAAS,IAAC,OAAOF,EAAW,cAAc,QAAQ;AAGvE,QAAM,EAAE,aAAaG,GAAM,QAAAC,EAAA,IAAWJ,EAAW,MAC3C,EAAE,WAAAK,MAAcL,EAAW,QAC3B,EAAE,WAAAM,GAAW,kBAAAC,EAAA,IAAqBP,EAAW,KAAK,QAElDQ,IAAmB,YAAY;AACnC,UAAMC,IAAS,MAAMT,EAAW,QAAQ,SAAA;AACxC,IAAIS,MACFb,EAAQc,EAAc,mBAAmBD,EAAO,IAAI,GACpDb,EAAQc,EAAc,sBAAsB;AAAA,EAEhD,GAEMC,IAAa,MAAM;AACvB,IAAAf,EAAQc,EAAc,sBAAsB;AAAA,EAC9C;AAEA,SACE,gBAAAxB,EAACgB,KAAW,OAAOF,EAAW,cAAc,QAC1C,UAAA,gBAAAd,EAAC0B,GAAA,EAAgB,gBAAgBZ,GAC/B,UAAA,gBAAAd,EAAC2B,KAAW,UAAUL,GACpB,UAAA,gBAAAtB,EAAC4B,GAAA,EAAK,eAAc,UAAS,KAAK,IAAI,YAAW,WAC9C,UAAAxB,KACC,gBAAAyB,EAAAC,GAAA,EACE,UAAA;AAAA,IAAA,gBAAA9B,EAAC,aACC,UAAA,gBAAA6B,EAACD,GAAA,EAAK,eAAc,UAAS,KAAK,GAChC,UAAA;AAAA,MAAA,gBAAA5B,EAACY,EAAW,SAAX,EAAmB,IAAG,MACpB,UAAAJ,EAAE,sBAAsB,EAAE,WAAWS,EAAK,MAAA,CAAO,EAAA,CACpD;AAAA,MACCC,KACC,gBAAAlB,EAACY,EAAW,MAAX,EAAgB,SAAQ,cACvB,UAAA,gBAAAZ;AAAA,QAAC+B;AAAA,QAAA;AAAA,UACC,GAAAvB;AAAA,UACA,SAAQ;AAAA,UACR,QAAQ,EAAE,aAAaS,EAAK,YAAA;AAAA,UAC5B,YAAY;AAAA,YACV,cACE,gBAAAjB;AAAA,cAACY,EAAW;AAAA,cAAX;AAAA,gBACC,MAAMM;AAAA,gBACN,QAAO;AAAA,gBACP,KAAI;AAAA,gBACJ,UAAU,GAAGD,EAAK,SAAS,MAAM;AAAA,cAAA;AAAA,YAAA;AAAA,UACnC;AAAA,QAEJ;AAAA,MAAA,EACF,CACF;AAAA,IAAA,EAAA,CAEJ,EAAA,CACF;AAAA,IACA,gBAAAjB;AAAA,MAACgC;AAAA,MAAA;AAAA,QACC,KAAKd;AAAA,QACL,OAAOD,EAAK;AAAA,QACZ,sBAAsBT,EAAE,sBAAsB;AAAA,QAC9C,mBAAmBA,EAAE,iBAAiB;AAAA,MAAA;AAAA,IAAA;AAAA,IAExC,gBAAAR;AAAA,MAACoB;AAAA,MAAA;AAAA,QACC,OAAOZ,EAAE,gBAAgB;AAAA,QACzB,aAAaA,EAAE,sBAAsB;AAAA,QACrC,oBAAoB,EAAE,UAAUA,EAAE,gBAAgB,EAAA;AAAA,MAAE;AAAA,IAAA;AAAA,IAEtD,gBAAAR;AAAA,MAACqB;AAAA,MAAA;AAAA,QACC,OAAOb,EAAE,mBAAmB;AAAA,QAC5B,oBAAoB,EAAE,UAAUA,EAAE,mBAAmB,EAAA;AAAA,MAAE;AAAA,IAAA;AAAA,sBAExDyB,GAAA,EACC,UAAA;AAAA,MAAA,gBAAAjC,EAACY,EAAW,QAAX,EAAkB,SAAQ,aAAY,MAAK,UAAS,SAASa,GAC3D,UAAAjB,EAAE,SAAS,EAAA,CACd;AAAA,MACA,gBAAAR,EAACY,EAAW,QAAX,EAAkB,MAAK,UAAS,WAAWO,GACzC,UAAAX,EAAE,WAAW,EAAA,CAChB;AAAA,IAAA,EAAA,CACF;AAAA,EAAA,EAAA,CACF,EAAA,CAEJ,GACF,EAAA,CACF,EAAA,CACF;AAEJ;"}

package/dist/components/Company/DocumentSigner/assignSignatoryState.d.ts

@@ -1 +1,2 @@
+/** @internal */
 export declare const assignSignatoryState: import('robot3').MachineState<any>;

package/dist/components/Company/DocumentSigner/assignSignatoryState.js.map

@@ -1 +1 @@
-{"version":3,"file":"assignSignatoryState.js","sources":["../../../../src/components/Company/DocumentSigner/assignSignatoryState.tsx"],"sourcesContent":["import { state, transition, reduce } from 'robot3'\nimport type { EventPayloads } from './documentSignerStateMachine'\nimport { DocumentList } from './documentSignerStateMachine'\nimport type { DocumentSignerContextInterface } from './useDocumentSigner'\nimport type { MachineEventType, MachineTransition } from '@/types/Helpers'\nimport { companyEvents } from '@/shared/constants'\n\nexport const assignSignatoryState = state<MachineTransition>(\n  transition(\n    companyEvents.COMPANY_SIGNATORY_INVITED,\n    'documentList',\n    reduce(\n      (ctx: DocumentSignerContextInterface): DocumentSignerContextInterface => ({\n        ...ctx,\n        component: DocumentList,\n      }),\n    ),\n  ),\n  transition(\n    companyEvents.COMPANY_SIGNATORY_CREATED,\n    'documentList',\n    reduce(\n      (\n        ctx: DocumentSignerContextInterface,\n        ev: MachineEventType<EventPayloads, typeof companyEvents.COMPANY_SIGNATORY_CREATED>,\n      ): DocumentSignerContextInterface => ({\n        ...ctx,\n        signatoryId: ev.payload.uuid,\n        component: DocumentList,\n      }),\n    ),\n  ),\n  transition(\n    companyEvents.COMPANY_SIGNATORY_UPDATED,\n    'documentList',\n    reduce(\n      (\n        ctx: DocumentSignerContextInterface,\n        ev: MachineEventType<EventPayloads, typeof companyEvents.COMPANY_SIGNATORY_UPDATED>,\n      ): DocumentSignerContextInterface => ({\n        ...ctx,\n        signatoryId: ev.payload.uuid,\n        component: DocumentList,\n      }),\n    ),\n  ),\n)\n"],"names":["assignSignatoryState","state","transition","companyEvents","reduce","ctx","DocumentList","ev"],"mappings":";;;AAOO,MAAMA,IAAuBC;AAAA,EAClCC;AAAA,IACEC,EAAc;AAAA,IACd;AAAA,IACAC;AAAA,MACE,CAACC,OAAyE;AAAA,QACxE,GAAGA;AAAA,QACH,WAAWC;AAAA,MAAA;AAAA,IACb;AAAA,EACF;AAAA,EAEFJ;AAAA,IACEC,EAAc;AAAA,IACd;AAAA,IACAC;AAAA,MACE,CACEC,GACAE,OACoC;AAAA,QACpC,GAAGF;AAAA,QACH,aAAaE,EAAG,QAAQ;AAAA,QACxB,WAAWD;AAAA,MAAA;AAAA,IACb;AAAA,EACF;AAAA,EAEFJ;AAAA,IACEC,EAAc;AAAA,IACd;AAAA,IACAC;AAAA,MACE,CACEC,GACAE,OACoC;AAAA,QACpC,GAAGF;AAAA,QACH,aAAaE,EAAG,QAAQ;AAAA,QACxB,WAAWD;AAAA,MAAA;AAAA,IACb;AAAA,EACF;AAEJ;"}
+{"version":3,"file":"assignSignatoryState.js","sources":["../../../../src/components/Company/DocumentSigner/assignSignatoryState.tsx"],"sourcesContent":["import { state, transition, reduce } from 'robot3'\nimport type { EventPayloads } from './documentSignerStateMachine'\nimport { DocumentList } from './documentSignerStateMachine'\nimport type { DocumentSignerContextInterface } from './useDocumentSigner'\nimport type { MachineEventType, MachineTransition } from '@/types/Helpers'\nimport { companyEvents } from '@/shared/constants'\n\n/** @internal */\nexport const assignSignatoryState = state<MachineTransition>(\n  transition(\n    companyEvents.COMPANY_SIGNATORY_INVITED,\n    'documentList',\n    reduce(\n      (ctx: DocumentSignerContextInterface): DocumentSignerContextInterface => ({\n        ...ctx,\n        component: DocumentList,\n      }),\n    ),\n  ),\n  transition(\n    companyEvents.COMPANY_SIGNATORY_CREATED,\n    'documentList',\n    reduce(\n      (\n        ctx: DocumentSignerContextInterface,\n        ev: MachineEventType<EventPayloads, typeof companyEvents.COMPANY_SIGNATORY_CREATED>,\n      ): DocumentSignerContextInterface => ({\n        ...ctx,\n        signatoryId: ev.payload.uuid,\n        component: DocumentList,\n      }),\n    ),\n  ),\n  transition(\n    companyEvents.COMPANY_SIGNATORY_UPDATED,\n    'documentList',\n    reduce(\n      (\n        ctx: DocumentSignerContextInterface,\n        ev: MachineEventType<EventPayloads, typeof companyEvents.COMPANY_SIGNATORY_UPDATED>,\n      ): DocumentSignerContextInterface => ({\n        ...ctx,\n        signatoryId: ev.payload.uuid,\n        component: DocumentList,\n      }),\n    ),\n  ),\n)\n"],"names":["assignSignatoryState","state","transition","companyEvents","reduce","ctx","DocumentList","ev"],"mappings":";;;AAQO,MAAMA,IAAuBC;AAAA,EAClCC;AAAA,IACEC,EAAc;AAAA,IACd;AAAA,IACAC;AAAA,MACE,CAACC,OAAyE;AAAA,QACxE,GAAGA;AAAA,QACH,WAAWC;AAAA,MAAA;AAAA,IACb;AAAA,EACF;AAAA,EAEFJ;AAAA,IACEC,EAAc;AAAA,IACd;AAAA,IACAC;AAAA,MACE,CACEC,GACAE,OACoC;AAAA,QACpC,GAAGF;AAAA,QACH,aAAaE,EAAG,QAAQ;AAAA,QACxB,WAAWD;AAAA,MAAA;AAAA,IACb;AAAA,EACF;AAAA,EAEFJ;AAAA,IACEC,EAAc;AAAA,IACd;AAAA,IACAC;AAAA,MACE,CACEC,GACAE,OACoC;AAAA,QACpC,GAAGF;AAAA,QACH,aAAaE,EAAG,QAAQ;AAAA,QACxB,WAAWD;AAAA,MAAA;AAAA,IACb;AAAA,EACF;AAEJ;"}

package/dist/components/Company/DocumentSigner/documentSignerStateMachine.d.ts

@@ -1,11 +1,15 @@
 import { Form } from '@gusto/embedded-api-v-2025-11-15/models/components/form';
 import { Signatory } from '@gusto/embedded-api-v-2025-11-15/models/components/signatory';
 import { companyEvents } from '../../../shared/constants';
+/** @internal */
 export type EventPayloads = {
     [companyEvents.COMPANY_VIEW_FORM_TO_SIGN]: Form;
     [companyEvents.COMPANY_SIGNATORY_CREATED]: Signatory;
     [companyEvents.COMPANY_SIGNATORY_UPDATED]: Signatory;
 };
+/** @internal */
 export declare function AssignSignatory(): import("react").JSX.Element;
+/** @internal */
 export declare function DocumentList(): import("react").JSX.Element;
+/** @internal */
 export declare function SignatureForm(): import("react").JSX.Element;

package/dist/components/Company/DocumentSigner/documentSignerStateMachine.js.map

@@ -1 +1 @@
-{"version":3,"file":"documentSignerStateMachine.js","sources":["../../../../src/components/Company/DocumentSigner/documentSignerStateMachine.tsx"],"sourcesContent":["import type { Form } from '@gusto/embedded-api-v-2025-11-15/models/components/form'\nimport type { Signatory } from '@gusto/embedded-api-v-2025-11-15/models/components/signatory'\nimport { AssignSignatory as BlockAssignSignatory } from '../AssignSignatory'\nimport { DocumentList as BlockDocumentList } from './DocumentList'\nimport { SignatureForm as BlockSignatureForm } from './SignatureForm'\nimport type { DocumentSignerContextInterface } from './useDocumentSigner'\nimport type { companyEvents } from '@/shared/constants'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport { ensureRequired } from '@/helpers/ensureRequired'\n\nexport type EventPayloads = {\n  [companyEvents.COMPANY_VIEW_FORM_TO_SIGN]: Form\n  [companyEvents.COMPANY_SIGNATORY_CREATED]: Signatory\n  [companyEvents.COMPANY_SIGNATORY_UPDATED]: Signatory\n}\n\nexport function AssignSignatory() {\n  const { companyId, signatoryId, onEvent } = useFlow<DocumentSignerContextInterface>()\n  return (\n    <BlockAssignSignatory\n      companyId={ensureRequired(companyId)}\n      signatoryId={signatoryId}\n      onEvent={onEvent}\n    />\n  )\n}\n\nexport function DocumentList() {\n  const { companyId, signatoryId, onEvent } = useFlow<DocumentSignerContextInterface>()\n\n  return (\n    <BlockDocumentList\n      companyId={ensureRequired(companyId)}\n      signatoryId={signatoryId}\n      onEvent={onEvent}\n    />\n  )\n}\n\nexport function SignatureForm() {\n  const { companyId, formId, onEvent } = useFlow<DocumentSignerContextInterface>()\n\n  return (\n    <BlockSignatureForm\n      companyId={ensureRequired(companyId)}\n      formId={ensureRequired(formId)}\n      onEvent={onEvent}\n    />\n  )\n}\n"],"names":["AssignSignatory","companyId","signatoryId","onEvent","useFlow","jsx","BlockAssignSignatory","ensureRequired","DocumentList","BlockDocumentList","SignatureForm","formId","BlockSignatureForm"],"mappings":";;;;;;AAgBO,SAASA,IAAkB;AAChC,QAAM,EAAE,WAAAC,GAAW,aAAAC,GAAa,SAAAC,EAAA,IAAYC,EAAA;AAC5C,SACE,gBAAAC;AAAA,IAACC;AAAAA,IAAA;AAAA,MACC,WAAWC,EAAeN,CAAS;AAAA,MACnC,aAAAC;AAAA,MACA,SAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;AAEO,SAASK,IAAe;AAC7B,QAAM,EAAE,WAAAP,GAAW,aAAAC,GAAa,SAAAC,EAAA,IAAYC,EAAA;AAE5C,SACE,gBAAAC;AAAA,IAACI;AAAAA,IAAA;AAAA,MACC,WAAWF,EAAeN,CAAS;AAAA,MACnC,aAAAC;AAAA,MACA,SAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;AAEO,SAASO,IAAgB;AAC9B,QAAM,EAAE,WAAAT,GAAW,QAAAU,GAAQ,SAAAR,EAAA,IAAYC,EAAA;AAEvC,SACE,gBAAAC;AAAA,IAACO;AAAAA,IAAA;AAAA,MACC,WAAWL,EAAeN,CAAS;AAAA,MACnC,QAAQM,EAAeI,CAAM;AAAA,MAC7B,SAAAR;AAAA,IAAA;AAAA,EAAA;AAGN;"}
+{"version":3,"file":"documentSignerStateMachine.js","sources":["../../../../src/components/Company/DocumentSigner/documentSignerStateMachine.tsx"],"sourcesContent":["import type { Form } from '@gusto/embedded-api-v-2025-11-15/models/components/form'\nimport type { Signatory } from '@gusto/embedded-api-v-2025-11-15/models/components/signatory'\nimport { AssignSignatory as BlockAssignSignatory } from '../AssignSignatory'\nimport { DocumentList as BlockDocumentList } from './DocumentList'\nimport { SignatureForm as BlockSignatureForm } from './SignatureForm'\nimport type { DocumentSignerContextInterface } from './useDocumentSigner'\nimport type { companyEvents } from '@/shared/constants'\nimport { useFlow } from '@/components/Flow/useFlow'\nimport { ensureRequired } from '@/helpers/ensureRequired'\n\n/** @internal */\nexport type EventPayloads = {\n  [companyEvents.COMPANY_VIEW_FORM_TO_SIGN]: Form\n  [companyEvents.COMPANY_SIGNATORY_CREATED]: Signatory\n  [companyEvents.COMPANY_SIGNATORY_UPDATED]: Signatory\n}\n\n/** @internal */\nexport function AssignSignatory() {\n  const { companyId, signatoryId, onEvent } = useFlow<DocumentSignerContextInterface>()\n  return (\n    <BlockAssignSignatory\n      companyId={ensureRequired(companyId)}\n      signatoryId={signatoryId}\n      onEvent={onEvent}\n    />\n  )\n}\n\n/** @internal */\nexport function DocumentList() {\n  const { companyId, signatoryId, onEvent } = useFlow<DocumentSignerContextInterface>()\n\n  return (\n    <BlockDocumentList\n      companyId={ensureRequired(companyId)}\n      signatoryId={signatoryId}\n      onEvent={onEvent}\n    />\n  )\n}\n\n/** @internal */\nexport function SignatureForm() {\n  const { companyId, formId, onEvent } = useFlow<DocumentSignerContextInterface>()\n\n  return (\n    <BlockSignatureForm\n      companyId={ensureRequired(companyId)}\n      formId={ensureRequired(formId)}\n      onEvent={onEvent}\n    />\n  )\n}\n"],"names":["AssignSignatory","companyId","signatoryId","onEvent","useFlow","jsx","BlockAssignSignatory","ensureRequired","DocumentList","BlockDocumentList","SignatureForm","formId","BlockSignatureForm"],"mappings":";;;;;;AAkBO,SAASA,IAAkB;AAChC,QAAM,EAAE,WAAAC,GAAW,aAAAC,GAAa,SAAAC,EAAA,IAAYC,EAAA;AAC5C,SACE,gBAAAC;AAAA,IAACC;AAAAA,IAAA;AAAA,MACC,WAAWC,EAAeN,CAAS;AAAA,MACnC,aAAAC;AAAA,MACA,SAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;AAGO,SAASK,IAAe;AAC7B,QAAM,EAAE,WAAAP,GAAW,aAAAC,GAAa,SAAAC,EAAA,IAAYC,EAAA;AAE5C,SACE,gBAAAC;AAAA,IAACI;AAAAA,IAAA;AAAA,MACC,WAAWF,EAAeN,CAAS;AAAA,MACnC,aAAAC;AAAA,MACA,SAAAC;AAAA,IAAA;AAAA,EAAA;AAGN;AAGO,SAASO,IAAgB;AAC9B,QAAM,EAAE,WAAAT,GAAW,QAAAU,GAAQ,SAAAR,EAAA,IAAYC,EAAA;AAEvC,SACE,gBAAAC;AAAA,IAACO;AAAAA,IAAA;AAAA,MACC,WAAWL,EAAeN,CAAS;AAAA,MACnC,QAAQM,EAAeI,CAAM;AAAA,MAC7B,SAAAR;AAAA,IAAA;AAAA,EAAA;AAGN;"}

package/dist/components/Company/DocumentSigner/shared/useSignCompanyForm/fields.d.ts

@@ -2,8 +2,49 @@ import { SignCompanyFormErrorCodes } from './signCompanyFormSchema';
 import { TextInputHookFieldProps } from '../../../../../partner-hook-utils/form/fields/TextInputHookField';
 import { CheckboxHookFieldProps } from '../../../../../partner-hook-utils/form/fields/CheckboxHookField';
 import { HookFieldProps } from '../../../../../partner-hook-utils/types';
+/**
+ * The required-field error code emitted by every field of {@link useSignCompanyForm}.
+ *
+ * @remarks
+ * Use this as the `validationMessages` key for any sign-company-form field.
+ * See {@link SignCompanyFormErrorCodes}.
+ *
+ * @public
+ */
 export type RequiredValidation = typeof SignCompanyFormErrorCodes.REQUIRED;
+/**
+ * Props accepted by {@link useSignCompanyForm}'s `Fields.Signature` component.
+ *
+ * @public
+ */
 export type SignatureFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>;
+/**
+ * Text input bound to the `signature` field of {@link useSignCompanyForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.Signature`. The signer types
+ * their full legal name; always required.
+ *
+ * @param props - {@link SignatureFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered text input bound to `signature`.
+ * @public
+ */
 export declare function SignatureField(props: SignatureFieldProps): import("react").JSX.Element;
+/**
+ * Props accepted by {@link useSignCompanyForm}'s `Fields.ConfirmSignature` component.
+ *
+ * @public
+ */
 export type ConfirmSignatureFieldProps = HookFieldProps<CheckboxHookFieldProps<RequiredValidation>>;
+/**
+ * Checkbox bound to the `confirmSignature` field of {@link useSignCompanyForm}.
+ *
+ * @remarks
+ * Available on the hook result as `form.Fields.ConfirmSignature`. The checkbox
+ * must be checked to submit; it captures consent to the form's terms.
+ *
+ * @param props - {@link ConfirmSignatureFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).
+ * @returns The rendered checkbox bound to `confirmSignature`.
+ * @public
+ */
 export declare function ConfirmSignatureField(props: ConfirmSignatureFieldProps): import("react").JSX.Element;

package/dist/components/Company/DocumentSigner/shared/useSignCompanyForm/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Company/DocumentSigner/shared/useSignCompanyForm/fields.tsx"],"sourcesContent":["import type { SignCompanyFormErrorCodes } from './signCompanyFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport { TextInputHookField, CheckboxHookField } from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\nexport type RequiredValidation = typeof SignCompanyFormErrorCodes.REQUIRED\n\nexport type SignatureFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\nexport function SignatureField(props: SignatureFieldProps) {\n  return <TextInputHookField {...props} name=\"signature\" />\n}\n\nexport type ConfirmSignatureFieldProps = HookFieldProps<CheckboxHookFieldProps<RequiredValidation>>\n\nexport function ConfirmSignatureField(props: ConfirmSignatureFieldProps) {\n  return <CheckboxHookField {...props} name=\"confirmSignature\" />\n}\n"],"names":["SignatureField","props","jsx","TextInputHookField","ConfirmSignatureField","CheckboxHookField"],"mappings":";;;AAUO,SAASA,EAAeC,GAA4B;AACzD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,aAAY;AACzD;AAIO,SAASG,EAAsBH,GAAmC;AACvE,SAAO,gBAAAC,EAACG,GAAA,EAAmB,GAAGJ,GAAO,MAAK,oBAAmB;AAC/D;"}
+{"version":3,"file":"fields.js","sources":["../../../../../../src/components/Company/DocumentSigner/shared/useSignCompanyForm/fields.tsx"],"sourcesContent":["import type { SignCompanyFormErrorCodes } from './signCompanyFormSchema'\nimport type { TextInputHookFieldProps } from '@/partner-hook-utils/form/fields/TextInputHookField'\nimport type { CheckboxHookFieldProps } from '@/partner-hook-utils/form/fields/CheckboxHookField'\nimport { TextInputHookField, CheckboxHookField } from '@/partner-hook-utils/form/fields'\nimport type { HookFieldProps } from '@/partner-hook-utils/types'\n\n/**\n * The required-field error code emitted by every field of {@link useSignCompanyForm}.\n *\n * @remarks\n * Use this as the `validationMessages` key for any sign-company-form field.\n * See {@link SignCompanyFormErrorCodes}.\n *\n * @public\n */\nexport type RequiredValidation = typeof SignCompanyFormErrorCodes.REQUIRED\n\n/**\n * Props accepted by {@link useSignCompanyForm}'s `Fields.Signature` component.\n *\n * @public\n */\nexport type SignatureFieldProps = HookFieldProps<TextInputHookFieldProps<RequiredValidation>>\n\n/**\n * Text input bound to the `signature` field of {@link useSignCompanyForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.Signature`. The signer types\n * their full legal name; always required.\n *\n * @param props - {@link SignatureFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered text input bound to `signature`.\n * @public\n */\nexport function SignatureField(props: SignatureFieldProps) {\n  return <TextInputHookField {...props} name=\"signature\" />\n}\n\n/**\n * Props accepted by {@link useSignCompanyForm}'s `Fields.ConfirmSignature` component.\n *\n * @public\n */\nexport type ConfirmSignatureFieldProps = HookFieldProps<CheckboxHookFieldProps<RequiredValidation>>\n\n/**\n * Checkbox bound to the `confirmSignature` field of {@link useSignCompanyForm}.\n *\n * @remarks\n * Available on the hook result as `form.Fields.ConfirmSignature`. The checkbox\n * must be checked to submit; it captures consent to the form's terms.\n *\n * @param props - {@link ConfirmSignatureFieldProps} — accepts the standard hook field props (label, description, validationMessages, FieldComponent override).\n * @returns The rendered checkbox bound to `confirmSignature`.\n * @public\n */\nexport function ConfirmSignatureField(props: ConfirmSignatureFieldProps) {\n  return <CheckboxHookField {...props} name=\"confirmSignature\" />\n}\n"],"names":["SignatureField","props","jsx","TextInputHookField","ConfirmSignatureField","CheckboxHookField"],"mappings":";;;AAmCO,SAASA,EAAeC,GAA4B;AACzD,SAAO,gBAAAC,EAACC,GAAA,EAAoB,GAAGF,GAAO,MAAK,aAAY;AACzD;AAoBO,SAASG,EAAsBH,GAAmC;AACvE,SAAO,gBAAAC,EAACG,GAAA,EAAmB,GAAGJ,GAAO,MAAK,oBAAmB;AAC/D;"}

package/dist/components/Company/DocumentSigner/shared/useSignCompanyForm/signCompanyFormSchema.d.ts

@@ -1,23 +1,53 @@
 import { z } from 'zod';
 import { OptionalFieldsToRequire } from '../../../../../partner-hook-utils/form/buildFormSchema';
+/**
+ * Validation error codes emitted by the sign-company-form schema. Map these
+ * codes to localized copy in `validationMessages` when composing the hook.
+ *
+ * @public
+ */
 export declare const SignCompanyFormErrorCodes: {
     readonly REQUIRED: "REQUIRED";
 };
+/**
+ * Union of validation error code strings emitted by the sign-company-form
+ * schema.
+ *
+ * @public
+ */
 export type SignCompanyFormErrorCode = (typeof SignCompanyFormErrorCodes)[keyof typeof SignCompanyFormErrorCodes];
-declare const fieldValidators: {
-    signature: z.ZodString;
-    confirmSignature: z.ZodBoolean;
-};
-export type SignCompanyFormField = keyof typeof fieldValidators;
-export type SignCompanyFormData = {
-    [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>;
-};
+/**
+ * Field names accepted by the sign-company form.
+ *
+ * @public
+ */
+export type SignCompanyFormField = "signature" | "confirmSignature";
+/**
+ * Shape of the values managed by the sign-company form.
+ *
+ * @public
+ */
+export type SignCompanyFormData = { signature: string; confirmSignature: boolean; };
+/**
+ * Shape of the validated values produced by the sign-company form on submit.
+ *
+ * @public
+ */
 export type SignCompanyFormOutputs = SignCompanyFormData;
-declare const requiredFieldsConfig: {};
-export type SignCompanyFormOptionalFieldsToRequire = OptionalFieldsToRequire<typeof requiredFieldsConfig>;
+/**
+ * Optional fields that may be promoted to required for the sign-company form.
+ *
+ * @remarks
+ * Both fields of this form are already required by default, so passing this
+ * is typically unnecessary.
+ *
+ * @public
+ */
+export type SignCompanyFormOptionalFieldsToRequire = { create?: never[] | undefined; update?: never[] | undefined; };
 interface SignCompanyFormSchemaOptions {
     optionalFieldsToRequire?: SignCompanyFormOptionalFieldsToRequire;
 }
+/** @internal */
 export declare function createSignCompanyFormSchema(options?: SignCompanyFormSchemaOptions): import('../../../../../partner-hook-utils/form/buildFormSchema').BuildFormSchemaResult<{
     signature: z.ZodString;
     confirmSignature: z.ZodBoolean;

package/dist/components/Company/DocumentSigner/shared/useSignCompanyForm/signCompanyFormSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"signCompanyFormSchema.js","sources":["../../../../../../src/components/Company/DocumentSigner/shared/useSignCompanyForm/signCompanyFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\nexport const SignCompanyFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\nexport type SignCompanyFormErrorCode =\n  (typeof SignCompanyFormErrorCodes)[keyof typeof SignCompanyFormErrorCodes]\n\n// ── Field validators ───────────────────────────────────────────────────\n\nconst fieldValidators = {\n  signature: z.string().min(1, { message: SignCompanyFormErrorCodes.REQUIRED }),\n  confirmSignature: z.boolean().refine(val => val, {\n    message: SignCompanyFormErrorCodes.REQUIRED,\n  }),\n}\n\nexport type SignCompanyFormField = keyof typeof fieldValidators\n\nexport type SignCompanyFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\nexport type SignCompanyFormOutputs = SignCompanyFormData\n\n// ── Required fields config ─────────────────────────────────────────────\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n// ── Schema factory ─────────────────────────────────────────────────────\n\nexport type SignCompanyFormOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\ninterface SignCompanyFormSchemaOptions {\n  optionalFieldsToRequire?: SignCompanyFormOptionalFieldsToRequire\n}\n\nexport function createSignCompanyFormSchema(options: SignCompanyFormSchemaOptions = {}) {\n  const { optionalFieldsToRequire } = options\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: SignCompanyFormErrorCodes.REQUIRED,\n    mode: 'create',\n    optionalFieldsToRequire,\n  })\n}\n"],"names":["SignCompanyFormErrorCodes","fieldValidators","z","val","requiredFieldsConfig","createSignCompanyFormSchema","options","optionalFieldsToRequire","buildFormSchema"],"mappings":";;AASO,MAAMA,IAA4B;AAAA,EACvC,UAAU;AACZ,GAOMC,IAAkB;AAAA,EACtB,WAAWC,EAAE,OAAA,EAAS,IAAI,GAAG,EAAE,SAASF,EAA0B,UAAU;AAAA,EAC5E,kBAAkBE,EAAE,QAAA,EAAU,OAAO,OAAOC,GAAK;AAAA,IAC/C,SAASH,EAA0B;AAAA,EAAA,CACpC;AACH,GAWMI,IAAuB,CAAA;AAYtB,SAASC,EAA4BC,IAAwC,IAAI;AACtF,QAAM,EAAE,yBAAAC,MAA4BD;AAEpC,SAAOE,EAAgBP,GAAiB;AAAA,IACtC,sBAAAG;AAAA,IACA,mBAAmBJ,EAA0B;AAAA,IAC7C,MAAM;AAAA,IACN,yBAAAO;AAAA,EAAA,CACD;AACH;"}
+{"version":3,"file":"signCompanyFormSchema.js","sources":["../../../../../../src/components/Company/DocumentSigner/shared/useSignCompanyForm/signCompanyFormSchema.ts"],"sourcesContent":["import { z } from 'zod'\nimport {\n  buildFormSchema,\n  type RequiredFieldConfig,\n  type OptionalFieldsToRequire,\n} from '@/partner-hook-utils/form/buildFormSchema'\n\n// ── Error codes ────────────────────────────────────────────────────────\n\n/**\n * Validation error codes emitted by the sign-company-form schema. Map these\n * codes to localized copy in `validationMessages` when composing the hook.\n *\n * @public\n */\nexport const SignCompanyFormErrorCodes = {\n  REQUIRED: 'REQUIRED',\n} as const\n\n/**\n * Union of validation error code strings emitted by the sign-company-form\n * schema.\n *\n * @public\n */\nexport type SignCompanyFormErrorCode =\n  (typeof SignCompanyFormErrorCodes)[keyof typeof SignCompanyFormErrorCodes]\n\n// ── Field validators ───────────────────────────────────────────────────\n\nconst fieldValidators = {\n  signature: z.string().min(1, { message: SignCompanyFormErrorCodes.REQUIRED }),\n  confirmSignature: z.boolean().refine(val => val, {\n    message: SignCompanyFormErrorCodes.REQUIRED,\n  }),\n}\n\n/**\n * Field names accepted by the sign-company form.\n *\n * @public\n */\nexport type SignCompanyFormField = keyof typeof fieldValidators\n\n/**\n * Shape of the values managed by the sign-company form.\n *\n * @public\n */\nexport type SignCompanyFormData = {\n  [K in keyof typeof fieldValidators]: z.infer<(typeof fieldValidators)[K]>\n}\n/**\n * Shape of the validated values produced by the sign-company form on submit.\n *\n * @public\n */\nexport type SignCompanyFormOutputs = SignCompanyFormData\n\n// ── Required fields config ─────────────────────────────────────────────\n\nconst requiredFieldsConfig = {} satisfies RequiredFieldConfig<typeof fieldValidators>\n\n// ── Schema factory ─────────────────────────────────────────────────────\n\n/**\n * Optional fields that may be promoted to required for the sign-company form.\n *\n * @remarks\n * Both fields of this form are already required by default, so passing this\n * is typically unnecessary.\n *\n * @public\n */\nexport type SignCompanyFormOptionalFieldsToRequire = OptionalFieldsToRequire<\n  typeof requiredFieldsConfig\n>\n\ninterface SignCompanyFormSchemaOptions {\n  optionalFieldsToRequire?: SignCompanyFormOptionalFieldsToRequire\n}\n\n/** @internal */\nexport function createSignCompanyFormSchema(options: SignCompanyFormSchemaOptions = {}) {\n  const { optionalFieldsToRequire } = options\n\n  return buildFormSchema(fieldValidators, {\n    requiredFieldsConfig,\n    requiredErrorCode: SignCompanyFormErrorCodes.REQUIRED,\n    mode: 'create',\n    optionalFieldsToRequire,\n  })\n}\n"],"names":["SignCompanyFormErrorCodes","fieldValidators","z","val","requiredFieldsConfig","createSignCompanyFormSchema","options","optionalFieldsToRequire","buildFormSchema"],"mappings":";;AAeO,MAAMA,IAA4B;AAAA,EACvC,UAAU;AACZ,GAaMC,IAAkB;AAAA,EACtB,WAAWC,EAAE,OAAA,EAAS,IAAI,GAAG,EAAE,SAASF,EAA0B,UAAU;AAAA,EAC5E,kBAAkBE,EAAE,QAAA,EAAU,OAAO,OAAOC,GAAK;AAAA,IAC/C,SAASH,EAA0B;AAAA,EAAA,CACpC;AACH,GA0BMI,IAAuB,CAAA;AAsBtB,SAASC,EAA4BC,IAAwC,IAAI;AACtF,QAAM,EAAE,yBAAAC,MAA4BD;AAEpC,SAAOE,EAAgBP,GAAiB;AAAA,IACtC,sBAAAG;AAAA,IACA,mBAAmBJ,EAA0B;AAAA,IAC7C,MAAM;AAAA,IACN,yBAAAO;AAAA,EAAA,CACD;AACH;"}

package/dist/components/Company/DocumentSigner/shared/useSignCompanyForm/useSignCompanyForm.d.ts

@@ -4,30 +4,141 @@ import { SignCompanyFormOptionalFieldsToRequire, SignCompanyFormData } from './s
 import { SignatureField, ConfirmSignatureField } from './fields';
 import { BaseFormHookReady, FieldsMetadata, HookLoadingResult, HookSubmitResult } from '../../../../../partner-hook-utils/types';
 export type { SignCompanyFormOptionalFieldsToRequire } from './signCompanyFormSchema';
+/**
+ * Props for {@link useSignCompanyForm}.
+ *
+ * @public
+ */
 export interface UseSignCompanyFormProps {
+    /** UUID of the company form to sign. */
     formId: string;
+    /** Promote optional fields to required. Both fields are already required by default, so this is typically unnecessary. */
     optionalFieldsToRequire?: SignCompanyFormOptionalFieldsToRequire;
+    /** Pre-fill form values (for example, pre-populate the signature field). */
     defaultValues?: Partial<SignCompanyFormData>;
+    /** When validation runs. Passed through to react-hook-form; defaults to `'onSubmit'`. */
     validationMode?: UseFormProps['mode'];
+    /** Auto-focus the first invalid field on submit. Defaults to `true`; set to `false` when using `composeSubmitHandler`. */
     shouldFocusError?: boolean;
 }
+/**
+ * Field components exposed by {@link useSignCompanyForm} on `form.Fields`.
+ *
+ * @public
+ */
 export interface SignCompanyFormFields {
+    /** Text input for the signer's typed name; always required. */
     Signature: typeof SignatureField;
+    /** Checkbox for confirming the signature and agreeing to the form's terms; always required. */
     ConfirmSignature: typeof ConfirmSignatureField;
 }
+/**
+ * Ready-state shape returned by {@link useSignCompanyForm} once the form metadata and PDF have loaded.
+ *
+ * @public
+ */
 export interface UseSignCompanyFormReady extends BaseFormHookReady<FieldsMetadata, SignCompanyFormData, SignCompanyFormFields> {
+    /** Loaded data — the company form entity and a preview PDF URL. */
     data: {
+        /** The company form entity fetched from the API (includes `uuid`, `title`, `description`). */
         companyForm: Form;
+        /** URL to the form's PDF document, or `null` when the document URL is not available. */
         pdfUrl: string | null;
     };
+    /** Submit-state flags. */
     status: {
+        /** `true` while the sign mutation is in flight. */
         isPending: boolean;
+        /** Always `'create'`; the hook always submits as a signing operation. */
         mode: 'create';
     };
+    /** Imperative actions exposed by the hook. */
     actions: {
+        /** Validates the form and submits the signature. Resolves with the signed form on success, or `undefined` on validation or API failure. */
         onSubmit: () => Promise<HookSubmitResult<Form> | undefined>;
     };
 }
+/**
+ * Headless hook for signing a company form — displays the form PDF and collects a typed signature with confirmation checkbox.
+ *
+ * @remarks
+ * The hook fetches the company form metadata and PDF, then exposes the
+ * {@link BaseFormHookReady} contract with `Fields`, `fieldsMetadata`,
+ * `onSubmit`, and error handling. Use `data.companyForm` to display the
+ * form's title and description, and `data.pdfUrl` to render the document for
+ * review before signing. Both `signature` and `confirmSignature` are always
+ * required.
+ *
+ * @param props - See {@link UseSignCompanyFormProps}.
+ * @returns A {@link HookLoadingResult} while loading, or a {@link UseSignCompanyFormReady} once the form is loaded.
+ * @public
+ *
+ * @example
+ * ```tsx
+ * import {
+ *   useSignCompanyForm,
+ *   SDKFormProvider,
+ *   type UseSignCompanyFormReady,
+ * } from '@gusto/embedded-react-sdk'
+ *
+ * function SignFormPage({ formId }: { formId: string }) {
+ *   const signForm = useSignCompanyForm({ formId })
+ *
+ *   if (signForm.isLoading) return <div>Loading...</div>
+ *
+ *   return <SignFormReady signForm={signForm} />
+ * }
+ *
+ * function SignFormReady({ signForm }: { signForm: UseSignCompanyFormReady }) {
+ *   const { Fields } = signForm.form
+ *
+ *   const handleSubmit = async () => {
+ *     const result = await signForm.actions.onSubmit()
+ *     if (result) {
+ *       console.log('Signed form:', result.data.uuid)
+ *     }
+ *   }
+ *
+ *   return (
+ *     <SDKFormProvider formHookResult={signForm}>
+ *       <form
+ *         onSubmit={e => {
+ *           e.preventDefault()
+ *           void handleSubmit()
+ *         }}
+ *       >
+ *         <h2>{signForm.data.companyForm.title}</h2>
+ *         {signForm.data.pdfUrl && (
+ *           <iframe src={signForm.data.pdfUrl} title="Form document" width="100%" height="600" />
+ *         )}
+ *         <Fields.Signature
+ *           label="Signature"
+ *           description="Type your full legal name"
+ *           validationMessages={{ REQUIRED: 'Signature is required' }}
+ *         />
+ *         <Fields.ConfirmSignature
+ *           label="I agree to the terms above"
+ *           validationMessages={{ REQUIRED: 'You must confirm to sign this form' }}
+ *         />
+ *         <button type="submit" disabled={signForm.status.isPending}>
+ *           {signForm.status.isPending ? 'Signing...' : 'Sign form'}
+ *         </button>
+ *       </form>
+ *     </SDKFormProvider>
+ *   )
+ * }
+ * ```
+ */
 export declare function useSignCompanyForm({ formId, optionalFieldsToRequire, defaultValues: partnerDefaults, validationMode, shouldFocusError, }: UseSignCompanyFormProps): HookLoadingResult | UseSignCompanyFormReady;
+/**
+ * Result of {@link useSignCompanyForm} — a discriminated union on `isLoading`.
+ *
+ * @public
+ */
 export type UseSignCompanyFormResult = HookLoadingResult | UseSignCompanyFormReady;
+/**
+ * Shape of the `form.fieldsMetadata` object returned by {@link useSignCompanyForm}.
+ *
+ * @public
+ */
 export type SignCompanyFormFieldsMetadata = UseSignCompanyFormReady['form']['fieldsMetadata'];

package/dist/components/Company/DocumentSigner/shared/useSignCompanyForm/useSignCompanyForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"useSignCompanyForm.js","sources":["../../../../../../src/components/Company/DocumentSigner/shared/useSignCompanyForm/useSignCompanyForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { Form } from '@gusto/embedded-api-v-2025-11-15/models/components/form'\nimport { useCompanyFormsGet } from '@gusto/embedded-api-v-2025-11-15/react-query/companyFormsGet'\nimport { useCompanyFormsGetPdf } from '@gusto/embedded-api-v-2025-11-15/react-query/companyFormsGetPdf'\nimport { useCompanyFormsSignMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/companyFormsSign'\nimport {\n  createSignCompanyFormSchema,\n  type SignCompanyFormOptionalFieldsToRequire,\n  type SignCompanyFormData,\n  type SignCompanyFormOutputs,\n} from './signCompanyFormSchema'\nimport { SignatureField, ConfirmSignatureField } from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\n\nexport type { SignCompanyFormOptionalFieldsToRequire } from './signCompanyFormSchema'\n\nexport interface UseSignCompanyFormProps {\n  formId: string\n  optionalFieldsToRequire?: SignCompanyFormOptionalFieldsToRequire\n  defaultValues?: Partial<SignCompanyFormData>\n  validationMode?: UseFormProps['mode']\n  shouldFocusError?: boolean\n}\n\nexport interface SignCompanyFormFields {\n  Signature: typeof SignatureField\n  ConfirmSignature: typeof ConfirmSignatureField\n}\n\nexport interface UseSignCompanyFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  SignCompanyFormData,\n  SignCompanyFormFields\n> {\n  data: {\n    companyForm: Form\n    pdfUrl: string | null\n  }\n  status: { isPending: boolean; mode: 'create' }\n  actions: {\n    onSubmit: () => Promise<HookSubmitResult<Form> | undefined>\n  }\n}\n\nconst HARDCODED_DEFAULTS: SignCompanyFormData = {\n  signature: '',\n  confirmSignature: false,\n}\n\nexport function useSignCompanyForm({\n  formId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseSignCompanyFormProps): HookLoadingResult | UseSignCompanyFormReady {\n  const formQuery = useCompanyFormsGet({ formId })\n  const pdfQuery = useCompanyFormsGetPdf({ formId })\n\n  const companyForm = formQuery.data?.form\n  const formPdf = pdfQuery.data?.formPdf\n\n  const [schema, metadataConfig] = useMemo(\n    () => createSignCompanyFormSchema({ optionalFieldsToRequire }),\n    [optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: SignCompanyFormData = {\n    signature: partnerDefaults?.signature ?? HARDCODED_DEFAULTS.signature,\n    confirmSignature: partnerDefaults?.confirmSignature ?? HARDCODED_DEFAULTS.confirmSignature,\n  }\n\n  const formMethods = useForm<SignCompanyFormData, unknown, SignCompanyFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const signFormMutation = useCompanyFormsSignMutation()\n  const isPending = signFormMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('SignCompanyForm')\n\n  const queries = [formQuery, pdfQuery]\n  const errorHandling = composeErrorHandler(queries, { submitError, setSubmitError })\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    signature: baseMetadata.signature,\n    confirmSignature: baseMetadata.confirmSignature,\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<Form> | undefined> => {\n    let submitResult: HookSubmitResult<Form> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: SignCompanyFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            if (!formId) {\n              throw new SDKInternalError('formId is required to sign a company form')\n            }\n\n            const result = await signFormMutation.mutateAsync({\n              request: {\n                formId,\n                requestBody: {\n                  signatureText: payload.signature,\n                  agree: payload.confirmSignature,\n                  signedByIpAddress: '',\n                },\n              },\n            })\n\n            const signedForm = result.form\n\n            if (!signedForm) {\n              throw new SDKInternalError('Company form signing failed')\n            }\n\n            submitResult = {\n              mode: 'create',\n              data: signedForm,\n            }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  const isDataLoading = formQuery.isLoading || pdfQuery.isLoading\n\n  if (isDataLoading || !companyForm || !formPdf) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  const pdfUrl = formPdf.documentUrl ?? null\n\n  return {\n    isLoading: false as const,\n    data: {\n      companyForm,\n      pdfUrl,\n    },\n    status: {\n      isPending,\n      mode: 'create' as const,\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Signature: SignatureField,\n        ConfirmSignature: ConfirmSignatureField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\nexport type UseSignCompanyFormResult = HookLoadingResult | UseSignCompanyFormReady\nexport type SignCompanyFormFieldsMetadata = UseSignCompanyFormReady['form']['fieldsMetadata']\n"],"names":["HARDCODED_DEFAULTS","useSignCompanyForm","formId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","formQuery","useCompanyFormsGet","pdfQuery","useCompanyFormsGetPdf","companyForm","formPdf","schema","metadataConfig","useMemo","createSignCompanyFormSchema","resolvedDefaults","formMethods","useForm","zodResolver","signFormMutation","useCompanyFormsSignMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","onSubmit","submitResult","resolve","data","payload","SDKInternalError","signedForm","hookFormInternals","useHookFormInternals","pdfUrl","SignatureField","ConfirmSignatureField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;AA0DA,MAAMA,IAA0C;AAAA,EAC9C,WAAW;AAAA,EACX,kBAAkB;AACpB;AAEO,SAASC,GAAmB;AAAA,EACjC,QAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAyE;AACvE,QAAMC,IAAYC,EAAmB,EAAE,QAAAN,GAAQ,GACzCO,IAAWC,EAAsB,EAAE,QAAAR,GAAQ,GAE3CS,IAAcJ,EAAU,MAAM,MAC9BK,IAAUH,EAAS,MAAM,SAEzB,CAACI,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAA4B,EAAE,yBAAAb,GAAyB;AAAA,IAC7D,CAACA,CAAuB;AAAA,EAAA,GAGpBc,IAAwC;AAAA,IAC5C,WAAWb,GAAiB,aAAaJ,EAAmB;AAAA,IAC5D,kBAAkBI,GAAiB,oBAAoBJ,EAAmB;AAAA,EAAA,GAGtEkB,IAAcC,EAA8D;AAAA,IAChF,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMR;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeW;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAAmBC,EAAA,GACnBC,IAAYF,EAAiB,WAE7B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,iBAAiB,GAG7BC,IAAgBC,EADN,CAACtB,GAAWE,CAAQ,GACe,EAAE,aAAAgB,GAAa,gBAAAC,GAAgB,GAE5EI,IAAeC,EAAwBjB,GAAgBI,EAAY,OAAO,GAC1Ec,IAAiB;AAAA,IACrB,WAAWF,EAAa;AAAA,IACxB,kBAAkBA,EAAa;AAAA,EAAA,GAG3BG,IAAW,YAAyD;AACxE,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKjB,EAAY;AAAA,QACf,OAAOkB,MAAiC;AACtC,gBAAMZ,EAAkBY,GAAM,OAAMC,MAAW;AAC7C,gBAAI,CAACnC;AACH,oBAAM,IAAIoC,EAAiB,2CAA2C;AAcxE,kBAAMC,KAXS,MAAMlB,EAAiB,YAAY;AAAA,cAChD,SAAS;AAAA,gBACP,QAAAnB;AAAA,gBACA,aAAa;AAAA,kBACX,eAAemC,EAAQ;AAAA,kBACvB,OAAOA,EAAQ;AAAA,kBACf,mBAAmB;AAAA,gBAAA;AAAA,cACrB;AAAA,YACF,CACD,GAEyB;AAE1B,gBAAI,CAACE;AACH,oBAAM,IAAID,EAAiB,6BAA6B;AAG1D,YAAAJ,IAAe;AAAA,cACb,MAAM;AAAA,cACN,MAAMK;AAAA,YAAA;AAAA,UAEV,CAAC,GACDJ,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMM,IAAoBC,EAAqBvB,CAAW;AAI1D,MAFsBX,EAAU,aAAaE,EAAS,aAEjC,CAACE,KAAe,CAACC;AACpC,WAAO,EAAE,WAAW,IAAe,eAAAgB,EAAA;AAGrC,QAAMc,IAAS9B,EAAQ,eAAe;AAEtC,SAAO;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,aAAAD;AAAA,MACA,QAAA+B;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACN,WAAAnB;AAAA,MACA,MAAM;AAAA,IAAA;AAAA,IAER,SAAS,EAAE,UAAAU,EAAA;AAAA,IACX,eAAAL;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,WAAWe;AAAA,QACX,kBAAkBC;AAAA,MAAA;AAAA,MAEpB,gBAAAZ;AAAA,MACA,mBAAAQ;AAAA,MACA,yBAAyBK,EAA8B3B,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}
+{"version":3,"file":"useSignCompanyForm.js","sources":["../../../../../../src/components/Company/DocumentSigner/shared/useSignCompanyForm/useSignCompanyForm.tsx"],"sourcesContent":["import { useMemo } from 'react'\nimport { useForm } from 'react-hook-form'\nimport type { UseFormProps } from 'react-hook-form'\nimport { zodResolver } from '@hookform/resolvers/zod'\nimport type { Form } from '@gusto/embedded-api-v-2025-11-15/models/components/form'\nimport { useCompanyFormsGet } from '@gusto/embedded-api-v-2025-11-15/react-query/companyFormsGet'\nimport { useCompanyFormsGetPdf } from '@gusto/embedded-api-v-2025-11-15/react-query/companyFormsGetPdf'\nimport { useCompanyFormsSignMutation } from '@gusto/embedded-api-v-2025-11-15/react-query/companyFormsSign'\nimport {\n  createSignCompanyFormSchema,\n  type SignCompanyFormOptionalFieldsToRequire,\n  type SignCompanyFormData,\n  type SignCompanyFormOutputs,\n} from './signCompanyFormSchema'\nimport { SignatureField, ConfirmSignatureField } from './fields'\nimport { useDeriveFieldsMetadata } from '@/partner-hook-utils/form/useDeriveFieldsMetadata'\nimport { useHookFormInternals } from '@/partner-hook-utils/form/useHookFormInternals'\nimport { createGetFormSubmissionValues } from '@/partner-hook-utils/form/getFormSubmissionValues'\nimport { composeErrorHandler } from '@/partner-hook-utils/composeErrorHandler'\nimport type {\n  BaseFormHookReady,\n  FieldsMetadata,\n  HookLoadingResult,\n  HookSubmitResult,\n} from '@/partner-hook-utils/types'\nimport { useBaseSubmit } from '@/components/Base/useBaseSubmit'\nimport { SDKInternalError } from '@/types/sdkError'\n\nexport type { SignCompanyFormOptionalFieldsToRequire } from './signCompanyFormSchema'\n\n/**\n * Props for {@link useSignCompanyForm}.\n *\n * @public\n */\nexport interface UseSignCompanyFormProps {\n  /** UUID of the company form to sign. */\n  formId: string\n  /** Promote optional fields to required. Both fields are already required by default, so this is typically unnecessary. */\n  optionalFieldsToRequire?: SignCompanyFormOptionalFieldsToRequire\n  /** Pre-fill form values (for example, pre-populate the signature field). */\n  defaultValues?: Partial<SignCompanyFormData>\n  /** When validation runs. Passed through to react-hook-form; defaults to `'onSubmit'`. */\n  validationMode?: UseFormProps['mode']\n  /** Auto-focus the first invalid field on submit. Defaults to `true`; set to `false` when using `composeSubmitHandler`. */\n  shouldFocusError?: boolean\n}\n\n/**\n * Field components exposed by {@link useSignCompanyForm} on `form.Fields`.\n *\n * @public\n */\nexport interface SignCompanyFormFields {\n  /** Text input for the signer's typed name; always required. */\n  Signature: typeof SignatureField\n  /** Checkbox for confirming the signature and agreeing to the form's terms; always required. */\n  ConfirmSignature: typeof ConfirmSignatureField\n}\n\n/**\n * Ready-state shape returned by {@link useSignCompanyForm} once the form metadata and PDF have loaded.\n *\n * @public\n */\nexport interface UseSignCompanyFormReady extends BaseFormHookReady<\n  FieldsMetadata,\n  SignCompanyFormData,\n  SignCompanyFormFields\n> {\n  /** Loaded data — the company form entity and a preview PDF URL. */\n  data: {\n    /** The company form entity fetched from the API (includes `uuid`, `title`, `description`). */\n    companyForm: Form\n    /** URL to the form's PDF document, or `null` when the document URL is not available. */\n    pdfUrl: string | null\n  }\n  /** Submit-state flags. */\n  status: {\n    /** `true` while the sign mutation is in flight. */\n    isPending: boolean\n    /** Always `'create'`; the hook always submits as a signing operation. */\n    mode: 'create'\n  }\n  /** Imperative actions exposed by the hook. */\n  actions: {\n    /** Validates the form and submits the signature. Resolves with the signed form on success, or `undefined` on validation or API failure. */\n    onSubmit: () => Promise<HookSubmitResult<Form> | undefined>\n  }\n}\n\nconst HARDCODED_DEFAULTS: SignCompanyFormData = {\n  signature: '',\n  confirmSignature: false,\n}\n\n/**\n * Headless hook for signing a company form — displays the form PDF and collects a typed signature with confirmation checkbox.\n *\n * @remarks\n * The hook fetches the company form metadata and PDF, then exposes the\n * {@link BaseFormHookReady} contract with `Fields`, `fieldsMetadata`,\n * `onSubmit`, and error handling. Use `data.companyForm` to display the\n * form's title and description, and `data.pdfUrl` to render the document for\n * review before signing. Both `signature` and `confirmSignature` are always\n * required.\n *\n * @param props - See {@link UseSignCompanyFormProps}.\n * @returns A {@link HookLoadingResult} while loading, or a {@link UseSignCompanyFormReady} once the form is loaded.\n * @public\n *\n * @example\n * ```tsx\n * import {\n *   useSignCompanyForm,\n *   SDKFormProvider,\n *   type UseSignCompanyFormReady,\n * } from '@gusto/embedded-react-sdk'\n *\n * function SignFormPage({ formId }: { formId: string }) {\n *   const signForm = useSignCompanyForm({ formId })\n *\n *   if (signForm.isLoading) return <div>Loading...</div>\n *\n *   return <SignFormReady signForm={signForm} />\n * }\n *\n * function SignFormReady({ signForm }: { signForm: UseSignCompanyFormReady }) {\n *   const { Fields } = signForm.form\n *\n *   const handleSubmit = async () => {\n *     const result = await signForm.actions.onSubmit()\n *     if (result) {\n *       console.log('Signed form:', result.data.uuid)\n *     }\n *   }\n *\n *   return (\n *     <SDKFormProvider formHookResult={signForm}>\n *       <form\n *         onSubmit={e => {\n *           e.preventDefault()\n *           void handleSubmit()\n *         }}\n *       >\n *         <h2>{signForm.data.companyForm.title}</h2>\n *         {signForm.data.pdfUrl && (\n *           <iframe src={signForm.data.pdfUrl} title=\"Form document\" width=\"100%\" height=\"600\" />\n *         )}\n *         <Fields.Signature\n *           label=\"Signature\"\n *           description=\"Type your full legal name\"\n *           validationMessages={{ REQUIRED: 'Signature is required' }}\n *         />\n *         <Fields.ConfirmSignature\n *           label=\"I agree to the terms above\"\n *           validationMessages={{ REQUIRED: 'You must confirm to sign this form' }}\n *         />\n *         <button type=\"submit\" disabled={signForm.status.isPending}>\n *           {signForm.status.isPending ? 'Signing...' : 'Sign form'}\n *         </button>\n *       </form>\n *     </SDKFormProvider>\n *   )\n * }\n * ```\n */\nexport function useSignCompanyForm({\n  formId,\n  optionalFieldsToRequire,\n  defaultValues: partnerDefaults,\n  validationMode = 'onSubmit',\n  shouldFocusError = true,\n}: UseSignCompanyFormProps): HookLoadingResult | UseSignCompanyFormReady {\n  const formQuery = useCompanyFormsGet({ formId })\n  const pdfQuery = useCompanyFormsGetPdf({ formId })\n\n  const companyForm = formQuery.data?.form\n  const formPdf = pdfQuery.data?.formPdf\n\n  const [schema, metadataConfig] = useMemo(\n    () => createSignCompanyFormSchema({ optionalFieldsToRequire }),\n    [optionalFieldsToRequire],\n  )\n\n  const resolvedDefaults: SignCompanyFormData = {\n    signature: partnerDefaults?.signature ?? HARDCODED_DEFAULTS.signature,\n    confirmSignature: partnerDefaults?.confirmSignature ?? HARDCODED_DEFAULTS.confirmSignature,\n  }\n\n  const formMethods = useForm<SignCompanyFormData, unknown, SignCompanyFormOutputs>({\n    resolver: zodResolver(schema),\n    mode: validationMode,\n    shouldFocusError,\n    defaultValues: resolvedDefaults,\n    values: resolvedDefaults,\n    resetOptions: { keepDirtyValues: true },\n  })\n\n  const signFormMutation = useCompanyFormsSignMutation()\n  const isPending = signFormMutation.isPending\n\n  const {\n    baseSubmitHandler,\n    error: submitError,\n    setError: setSubmitError,\n  } = useBaseSubmit('SignCompanyForm')\n\n  const queries = [formQuery, pdfQuery]\n  const errorHandling = composeErrorHandler(queries, { submitError, setSubmitError })\n\n  const baseMetadata = useDeriveFieldsMetadata(metadataConfig, formMethods.control)\n  const fieldsMetadata = {\n    signature: baseMetadata.signature,\n    confirmSignature: baseMetadata.confirmSignature,\n  }\n\n  const onSubmit = async (): Promise<HookSubmitResult<Form> | undefined> => {\n    let submitResult: HookSubmitResult<Form> | undefined\n\n    await new Promise<void>(resolve => {\n      void formMethods.handleSubmit(\n        async (data: SignCompanyFormOutputs) => {\n          await baseSubmitHandler(data, async payload => {\n            if (!formId) {\n              throw new SDKInternalError('formId is required to sign a company form')\n            }\n\n            const result = await signFormMutation.mutateAsync({\n              request: {\n                formId,\n                requestBody: {\n                  signatureText: payload.signature,\n                  agree: payload.confirmSignature,\n                  signedByIpAddress: '',\n                },\n              },\n            })\n\n            const signedForm = result.form\n\n            if (!signedForm) {\n              throw new SDKInternalError('Company form signing failed')\n            }\n\n            submitResult = {\n              mode: 'create',\n              data: signedForm,\n            }\n          })\n          resolve()\n        },\n        () => {\n          resolve()\n        },\n      )()\n    })\n\n    return submitResult\n  }\n\n  const hookFormInternals = useHookFormInternals(formMethods)\n\n  const isDataLoading = formQuery.isLoading || pdfQuery.isLoading\n\n  if (isDataLoading || !companyForm || !formPdf) {\n    return { isLoading: true as const, errorHandling }\n  }\n\n  const pdfUrl = formPdf.documentUrl ?? null\n\n  return {\n    isLoading: false as const,\n    data: {\n      companyForm,\n      pdfUrl,\n    },\n    status: {\n      isPending,\n      mode: 'create' as const,\n    },\n    actions: { onSubmit },\n    errorHandling,\n    form: {\n      Fields: {\n        Signature: SignatureField,\n        ConfirmSignature: ConfirmSignatureField,\n      },\n      fieldsMetadata,\n      hookFormInternals,\n      getFormSubmissionValues: createGetFormSubmissionValues(formMethods, schema),\n    },\n  }\n}\n\n/**\n * Result of {@link useSignCompanyForm} — a discriminated union on `isLoading`.\n *\n * @public\n */\nexport type UseSignCompanyFormResult = HookLoadingResult | UseSignCompanyFormReady\n/**\n * Shape of the `form.fieldsMetadata` object returned by {@link useSignCompanyForm}.\n *\n * @public\n */\nexport type SignCompanyFormFieldsMetadata = UseSignCompanyFormReady['form']['fieldsMetadata']\n"],"names":["HARDCODED_DEFAULTS","useSignCompanyForm","formId","optionalFieldsToRequire","partnerDefaults","validationMode","shouldFocusError","formQuery","useCompanyFormsGet","pdfQuery","useCompanyFormsGetPdf","companyForm","formPdf","schema","metadataConfig","useMemo","createSignCompanyFormSchema","resolvedDefaults","formMethods","useForm","zodResolver","signFormMutation","useCompanyFormsSignMutation","isPending","baseSubmitHandler","submitError","setSubmitError","useBaseSubmit","errorHandling","composeErrorHandler","baseMetadata","useDeriveFieldsMetadata","fieldsMetadata","onSubmit","submitResult","resolve","data","payload","SDKInternalError","signedForm","hookFormInternals","useHookFormInternals","pdfUrl","SignatureField","ConfirmSignatureField","createGetFormSubmissionValues"],"mappings":";;;;;;;;;;;;;;AA2FA,MAAMA,IAA0C;AAAA,EAC9C,WAAW;AAAA,EACX,kBAAkB;AACpB;AAyEO,SAASC,GAAmB;AAAA,EACjC,QAAAC;AAAA,EACA,yBAAAC;AAAA,EACA,eAAeC;AAAA,EACf,gBAAAC,IAAiB;AAAA,EACjB,kBAAAC,IAAmB;AACrB,GAAyE;AACvE,QAAMC,IAAYC,EAAmB,EAAE,QAAAN,GAAQ,GACzCO,IAAWC,EAAsB,EAAE,QAAAR,GAAQ,GAE3CS,IAAcJ,EAAU,MAAM,MAC9BK,IAAUH,EAAS,MAAM,SAEzB,CAACI,GAAQC,CAAc,IAAIC;AAAA,IAC/B,MAAMC,EAA4B,EAAE,yBAAAb,GAAyB;AAAA,IAC7D,CAACA,CAAuB;AAAA,EAAA,GAGpBc,IAAwC;AAAA,IAC5C,WAAWb,GAAiB,aAAaJ,EAAmB;AAAA,IAC5D,kBAAkBI,GAAiB,oBAAoBJ,EAAmB;AAAA,EAAA,GAGtEkB,IAAcC,EAA8D;AAAA,IAChF,UAAUC,EAAYP,CAAM;AAAA,IAC5B,MAAMR;AAAA,IACN,kBAAAC;AAAA,IACA,eAAeW;AAAA,IACf,QAAQA;AAAA,IACR,cAAc,EAAE,iBAAiB,GAAA;AAAA,EAAK,CACvC,GAEKI,IAAmBC,EAAA,GACnBC,IAAYF,EAAiB,WAE7B;AAAA,IACJ,mBAAAG;AAAA,IACA,OAAOC;AAAA,IACP,UAAUC;AAAA,EAAA,IACRC,EAAc,iBAAiB,GAG7BC,IAAgBC,EADN,CAACtB,GAAWE,CAAQ,GACe,EAAE,aAAAgB,GAAa,gBAAAC,GAAgB,GAE5EI,IAAeC,EAAwBjB,GAAgBI,EAAY,OAAO,GAC1Ec,IAAiB;AAAA,IACrB,WAAWF,EAAa;AAAA,IACxB,kBAAkBA,EAAa;AAAA,EAAA,GAG3BG,IAAW,YAAyD;AACxE,QAAIC;AAEJ,iBAAM,IAAI,QAAc,CAAAC,MAAW;AACjC,MAAKjB,EAAY;AAAA,QACf,OAAOkB,MAAiC;AACtC,gBAAMZ,EAAkBY,GAAM,OAAMC,MAAW;AAC7C,gBAAI,CAACnC;AACH,oBAAM,IAAIoC,EAAiB,2CAA2C;AAcxE,kBAAMC,KAXS,MAAMlB,EAAiB,YAAY;AAAA,cAChD,SAAS;AAAA,gBACP,QAAAnB;AAAA,gBACA,aAAa;AAAA,kBACX,eAAemC,EAAQ;AAAA,kBACvB,OAAOA,EAAQ;AAAA,kBACf,mBAAmB;AAAA,gBAAA;AAAA,cACrB;AAAA,YACF,CACD,GAEyB;AAE1B,gBAAI,CAACE;AACH,oBAAM,IAAID,EAAiB,6BAA6B;AAG1D,YAAAJ,IAAe;AAAA,cACb,MAAM;AAAA,cACN,MAAMK;AAAA,YAAA;AAAA,UAEV,CAAC,GACDJ,EAAA;AAAA,QACF;AAAA,QACA,MAAM;AACJ,UAAAA,EAAA;AAAA,QACF;AAAA,MAAA,EACF;AAAA,IACF,CAAC,GAEMD;AAAA,EACT,GAEMM,IAAoBC,EAAqBvB,CAAW;AAI1D,MAFsBX,EAAU,aAAaE,EAAS,aAEjC,CAACE,KAAe,CAACC;AACpC,WAAO,EAAE,WAAW,IAAe,eAAAgB,EAAA;AAGrC,QAAMc,IAAS9B,EAAQ,eAAe;AAEtC,SAAO;AAAA,IACL,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,aAAAD;AAAA,MACA,QAAA+B;AAAA,IAAA;AAAA,IAEF,QAAQ;AAAA,MACN,WAAAnB;AAAA,MACA,MAAM;AAAA,IAAA;AAAA,IAER,SAAS,EAAE,UAAAU,EAAA;AAAA,IACX,eAAAL;AAAA,IACA,MAAM;AAAA,MACJ,QAAQ;AAAA,QACN,WAAWe;AAAA,QACX,kBAAkBC;AAAA,MAAA;AAAA,MAEpB,gBAAAZ;AAAA,MACA,mBAAAQ;AAAA,MACA,yBAAyBK,EAA8B3B,GAAaL,CAAM;AAAA,IAAA;AAAA,EAC5E;AAEJ;"}

package/dist/components/Company/DocumentSigner/stateMachine.d.ts

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