@saasquatch/mint-components 1.8.0-99 → 1.8.0

package/dist/types/components/tax-and-cash/sqm-banking-info-form/sqm-banking-info-form.d.ts

@@ -8,207 +8,178 @@ import { BankingInfoFormViewProps } from "./sqm-banking-info-form-view";
 export declare class BankingInfoForm {
   ignored: boolean;
   /**
-   * Subtext shown at the top of the page, used to show the current step of the tax form.
-   * @uiName Form step text
+   * @uiName Setup progress
    */
   formStep: string;
   /**
-   * Heading text shown at the top of the page
-   * @uiName Tax and Payouts heading text
+   * @uiName Step 4 title
    */
   taxAndPayouts: string;
   /**
-   * Text shown at the top of the page next to the tax and payouts label text
-   * @uiName Tax and Payouts label text
+   * Displayed at the top of the page on all set up steps.
+   * @uiName Page description
    */
   taxAndPayoutsDescription: string;
   /**
-   * Text for the option to receive payments directly to a bank account
-   * @uiName Directly to bank account option text
+   * @uiName Direct to bank payout option
    */
   directlyToBankAccount: string;
   /**
-   * Text for the option to receive payments to a PayPal account with processing fee details
-   * @uiName PayPal option text with processing fee placeholder
+   * @uiName PayPal payout option
    */
   toPayPalAccount: string;
   /**
-   * Text for the option to receive payments at a specific balance threshold
-   * @uiName Payment schedule balance threshold text
+   * @uiName Threshold balance payment schedule option
    */
   paymentScheduleBalanceThreshold: string;
   /**
-   * Text for the option to receive payments on a specific day of the month
-   * @uiName Payment schedule fixed day text
+   * @uiName Fixed day payment schedule option
    */
   paymentScheduleFixedDay: string;
   /**
-   * Label text for the payment day select
-   * @uiName Payment day select label
+   * Let the participant choose what day of the month they’ll get paid
+   * @uiName Payment day field label
    */
   paymentDaySelectLabel: string;
   /**
-   * Label text for the payment day select
-   * @uiName Payment day select label
+   * Participant use this field to select the balance at which they want to be paid
+   * @uiName Payment threshold field label
    */
   paymentThresholdSelectLabel: string;
   /**
-   * Label text for the payment day select option for the first of the month
-   * @uiName First of month label text
+   * One of two payment day options
+   * @uiName First of month payday option
    */
   paymentDayFirstOfMonthLabelText: string;
   /**
    * Label text for the payment day select option for the fifteenth of the month
-   * @uiName Fifteenth of month label text
+   * @uiName Fifteenth of month payday option
    */
   paymentDayFifteenthOfMonthLabelText: string;
   /**
-   * Heading text for the payment method section
-   * @uiName Payment method heading text
+   * @uiName Payment method section header
    */
   paymentMethod: string;
   /**
-   * Heading text for the payment schedule section
-   * @uiName Payment schedule heading text
+   * @uiName Payment schedule section header
    */
   paymentSchedule: string;
   /**
-   * Subtext for the payment method section
-   * @uiName Payment method subtext
+   * @uiName Payment method section description
    */
   paymentMethodSubtext: string;
   /**
-   * Label text for the PayPal email input field
-   * @uiName PayPal email input label
+   * Displayed to participants who choose PayPal as their payout method
+   * @uiName PayPal email field label
    */
   payPalInputLabel: string;
   /**
-   * Label text for the bank country location input field
-   * @uiName Bank country location input label
+   * @uiName Bank country field label
    */
   bankLocationLabel: string;
   /**
-   * Label text for the beneficiary account name input field
-   * @uiName Beneficiary account name input label
+   * @uiName Beneficiary account field label
    */
   beneficiaryAccountNameLabel: string;
   /**
-   * Label text for the bank account type input field
-   * @uiName Bank account type input label
+   * @uiName Bank account type field label
    */
   bankAccountTypeLabel: string;
   /**
-   * Label text for the checking account type select item
-   * @uiName Checking select item label
+   * @uiName Checking account option
    */
   checkingSelectItemLabel: string;
   /**
-   * Label text for the savings account type select item
-   * @uiName Savings select item label
+   * @uiName Savings account options
    */
   savingsSelectItemLabel: string;
   /**
-   * Label text for the bank account number input field
-   * @uiName Bank account number input label
+   * @uiName Bank account number field label
    */
   bankAccountNumberLabel: string;
   /**
-   * Label text for the IBAN input field
-   * @uiName IBAN input label
+   * @uiName IBAN field label
    */
   ibanLabel: string;
   /**
-   * Label text for the SWIFT code input field
-   * @uiName SWIFT code input label
+   * @uiName SWIFT code field label
    */
   swiftCodeLabel: string;
   /**
-   * Label text for the routing code input field
-   * @uiName Routing code input label
+   * @uiName Routing code field label
    */
   routingCodeLabel: string;
   /**
-   * Label text for the bank name input field
-   * @uiName Bank name input label
+   * @uiName Bank name field label
    */
   bankNameLabel: string;
   /**
-   * Label text for the classification entity input field
-   * @uiName Classification entity input label
+   * @uiName Classification entity field label
    */
   classificationEntityLabel: string;
   /**
-   * Label text for the business select item
-   * @uiName Business select item label
+   * One of three options listed for the classification field
+   * @uiName Business classification option
    */
   businessSelectItemLabel: string;
   /**
-   * Label text for the individual select item
-   * @uiName Individual select item label
+   * One of three options listed for the classification field
+   * @uiName Individual classification option
    */
   individualSelectItemLabel: string;
   /**
-   * Label text for the foreign select item
-   * @uiName Foreign select item label
+   * One of three options listed for the classification field
+   * @uiName Foreign classification option
    */
   foreignSelectItemLabel: string;
   /**
-   * Label text for the classification CPF input field
-   * @uiName Classification CPF input label
+   * @uiName Classification CPF field label
    */
   classificationCPFLabel: string;
   /**
-   * Label text for the patronymic name input field
-   * @uiName Patronymic name input label
+   * @uiName Patronymic name field label
    */
   patronymicNameLabel: string;
   /**
-   * Label text for the VO code input field
-   * @uiName VO code input label
+   * @uiName VO code field label
    */
   voCodeLabel: string;
   /**
-   * Label text for the agency code input field
-   * @uiName Agency code input label
+   * @uiName Agency code field label
    */
   agencyCodeLabel: string;
   /**
-   * Label text for the branch code input field
-   * @uiName Branch code input label
+   * @uiName Branch code field label
    */
   branchCodeLabel: string;
   /**
    * Label text for the classification input field
-   * @uiName Classification input label
+   * @uiName Classification field label
    */
   classificationLabel: string;
   /**
-   * Label text for the Taxpayer ID input field
-   * @uiName Taxpayer ID input label
+   * @uiName Taxpayer ID field label
    */
   taxPayerIdLabel: string;
   /**
-   * Label text for the Bank Address input
-   * @uiName Bank Address input item label
+   * @uiName Bank address field label
    */
   bankAddressLabel: string;
   /**
-   * Label text for the Bank City input
-   * @uiName Bank City Label input label
+   * @uiName Bank city field label
    */
   bankCityLabel: string;
   /**
-   * Label text for the Bank Province / State input
-   * @uiName Bank Province / State input label
+   * @uiName Bank province/state field label
    */
   bankStateLabel: string;
   /**
-   * Label text for the Bank Postal Code
-   * @uiName Bank Postal Code input label
+   * @uiName Bank postal code field label
    */
   bankPostalCodeLabel: string;
   /**
-   * @uiName EFT Withdrawal label text
+   * Default payment method to the participants’ bank account.
+   * @uiName EFT withdrawal payment method
    */
   eftWithdrawalLabel: string;
   /**
@@ -216,53 +187,63 @@ export declare class BankingInfoForm {
    */
   fxWireProcessingFeeLabel: string;
   /**
-   * Header text for the alert when the user is identified as a partner
-   * @uiName Partner identification alert header
+   * Placeholder text displayed in the country search dropdown
+   * @uiName Country field placeholder text
+   */
+  searchForCountryText: string;
+  /**
+   * Part of the alert displayed at the top of the page if the participant is already a registered partner on impact.com.
+   * @uiName Participant is a partner alert title
+   * @uiWidget textArea
    */
   isPartnerAlertHeader: string;
   /**
-   * Description text for the alert when the user is identified as a partner
-   * @uiName Partner identification alert description
+   * Part of the alert displayed at the top of the page if the participant is already a registered partner on impact.com.
+   * @uiName Participant is a partner alert description
+   * @uiWidget textArea
    */
   isPartnerAlertDescription: string;
   /**
-   * Title text for a general form submission error
-   * @uiName General form submission error title
+   * Part of the alert displayed at the top of the page.
+   * @uiName Form submission error message title
+   * @uiWidget textArea
    */
   generalErrorTitle: string;
   /**
-   * Description text for a general form submission error
-   * @uiName General form submission error description
+   * Part of the alert displayed at the top of the page.
+   * @uiName Form submission error message description
+   * @uiWidget textArea
    */
   generalErrorDescription: string;
   /**
-   * Required error text shown at the bottom of field inputs
-   * @uiName Field inputs error text
+   * Displayed under a field that is missing required information.
+   * @uiName Empty form field error message
    */
   fieldRequiredError: string;
   /**
-   * Invalid error text shown at the bottom of field inputs
-   * @uiName Field inputs invalid error text
+   * Displayed under a field when it has an invalid entry.
+   * @uiName Form field error message
    */
   fieldInvalidError: string;
   /**
-   * Text for the save button in the form
-   * @uiName Save button text
+   * @uiName Continue button label
    */
   continueButton: string;
   /**
    * Text for the back button in the form
-   * @uiName Back button text
+   * @uiName Back button label
    */
   backButton: string;
   /**
-   * Alert header shown if there is a problem loading a form
-   * @uiName Loading error alert header
+   * Part of the alert displayed at the top of the page.
+   * @uiName Page load error message title
+   * @uiWidget textArea
    */
   loadingErrorAlertHeader: string;
   /**
-   * Alert description shown if there is a problem loading a form
-   * @uiName Loading error alert description
+   * Part of the alert displayed at the top of the page.
+   * @uiName Page load error message description
+   * @uiWidget textArea
    */
   loadingErrorAlertDescription: string;
   /**

package/dist/types/components/tax-and-cash/sqm-banking-info-form/useBankingInfoForm.d.ts

@@ -40,61 +40,9 @@ export declare type BankingInfoFormData = {
   bankName?: string;
   patronymicName?: string;
 };
-export declare function getFormMap({ props, getValidationErrorMessage, }: {
-  props: BankingInfoFormViewProps | Omit<any, "text" | "callbacks">;
-  getValidationErrorMessage: (props: {
-    type: "required" | "invalid";
-    label: string;
-  }) => string;
-}): {
-  0: {
-    input: any;
-  };
-  1: {
-    input: any;
-  };
-  2: {
-    input: any;
-  };
-  3: {
-    input: any;
-  };
-  4: {
-    input: any;
-  };
-  5: {
-    input: any;
-  };
-  6: {
-    input: any;
-  };
-  7: {
-    input: any[];
-  };
-  8: {
-    input: any;
-  };
-  9: {
-    input: any;
-  };
-  10: {
-    input: any;
-  };
-  11: {
-    input: any;
-  };
-  12: {
-    input: any[];
-  };
-  13: {
-    input: any;
-  };
-  14: {
-    input: any;
-  };
-};
 export declare function getFormInputs({ bitset, formMap }: {
   bitset: any;
   formMap: any;
 }): any;
 export declare function useBankingInfoForm(props: BankingInfoForm): BankingInfoFormViewProps;
+export declare type UseBankingInfoFormResult = ReturnType<typeof useBankingInfoForm>;

package/dist/types/components/tax-and-cash/sqm-docusign-form/docusign-iframe/DocusignIframe.d.ts

@@ -11,7 +11,6 @@ export interface DocusignIframeProps {
   };
   text: {
     docusignExpired: string;
-    docusignCompleted: string;
     docusignError: string;
     refreshButton: string;
   };

package/dist/types/components/tax-and-cash/sqm-docusign-form/sqm-docusign-form-view.d.ts

@@ -20,7 +20,6 @@ export interface DocusignFormViewProps {
     };
     documentType: TaxDocumentType;
     documentTypeString: string;
-    hideBackButton: boolean;
   };
   slots: {
     docusignExpiredSlot?: VNode;
@@ -28,7 +27,6 @@ export interface DocusignFormViewProps {
   };
   callbacks: {
     setParticipantType: (p: ParticipantType) => void;
-    onBack: () => void;
   };
   text: {
     formStep: string;
@@ -37,19 +35,15 @@ export interface DocusignFormViewProps {
     taxFormDescription: string;
     taxFormDescriptionIndividualParticipant: string;
     taxFormDescriptionBusinessEntity?: string;
-    notBasedInUS: string;
-    banner: string;
-    checkboxLabel: string;
-    checkboxDescription: string;
-    backButton: string;
-    cancelButton: string;
+    docusignExpired: string;
+    docusignSessionWarning: string;
     businessEntity: string;
     individualParticipant: string;
     participantType: string;
+    taxAndPayoutsDescription: string;
     error: {
       generalTitle: string;
       generalDescription: string;
-      formSubmission: string;
       participantType: string;
       loadingErrorAlertHeader: string;
       loadingErrorAlertDescription: string;

package/dist/types/components/tax-and-cash/sqm-docusign-form/sqm-docusign-form.d.ts

@@ -9,128 +9,101 @@ export declare class DocusignForm {
   el: any;
   ignored: boolean;
   /**
-   * Sub text shown at the top of the page, used to show the current step of the tax form.
-   * @uiName Tax form step text
+   * @uiName Setup progress
    */
   formStep: string;
   /**
-   * Heading text shown at the top of the page
-   * @uiName Tax form heading text
+   * @uiName Step 3 title
    */
   taxForm: string;
   /**
-   * Text shown at the top of the page next to the document type text
-   * @uiName Tax form label text
+   * Display the type of tax form that the participant must submit.
+   * @uiName Tax form name
    */
   taxFormLabel: string;
   /**
-   * Subtext shown at the top of the page next to the document type text
-   * @uiName Tax form subtext
+   * Displayed at the top of the page to participants based in the US.
+   * @uiName W-9 tax form description
+   * @uiWidget textArea
    */
   taxFormDescription: string;
   /**
-   * Subtext shown at the top of the page next to the document type text for individual participants
-   * @uiName Tax form subtext
+   * Displayed at the top of the page to individuals joining a US program who reside outside the country.
+   * @uiName W-8 BEN tax form description
+   * @uiWidget textArea
    */
   taxFormDescriptionIndividualParticipant: string;
   /**
-   * Subtext shown at the top of the page next to the document type text for business entities
-   * @uiName Tax form subtext
+   * Displayed at the top of the page to participants representing a business.
+   * @uiName W-8 BEN-E tax form description
+   * @uiWidget textArea
    */
   taxFormDescriptionBusinessEntity: string;
   /**
-   * Text shown in the link to the form for non US residents
-   * @uiName Not based in US link text
-   */
-  notBasedInUS: string;
-  /**
-   * Text shown in the banner above the document
-   * @uiName Banner text
-   */
-  banner: string;
-  /**
-   * Heading text for the form submission checkbox
-   * @uiName Form submission checkbox heading
-   */
-  checkboxLabel: string;
-  /**
-   * Label text for the form submission checkbox
-   * @uiName Form submission checkbox label
-   */
-  checkboxDescription: string;
-  /**
-   * Text inside iframe when Docusign expires
-   * @uiName Docusign expired text
+   * This appears inside the Docusign frame.
+   * @uiName Docusign session expired messag
+   * @uiWidget textArea
    */
   docusignExpired: string;
   /**
-   * Text inside iframe when Docusign form is compelted
-   * @uiName Docusign completed text
+   * Remind participants their session will time out after 20 minutes of inactivity.
+   * @uiName Docusign timed session message
+   * @uiWidget textArea
    */
-  docusignCompleted: string;
+  docusignSessionWarning: string;
   /**
-   * Heading text for the participant type radio buttons
-   * @uiName Participant type radio buttons heading
+   * @uiName Participant type field label
    */
   participantType: string;
   /**
-   * Label text for the business entity radio button
-   * @uiName Business entity radio button label
+   * An option for the participant type field. Used to determine which W-8 form is required.
+   * @uiName Business representative participant type label
    */
   businessEntity: string;
   /**
-   * Label text for the individual participant radio button
-   * @uiName Individual participant radio button label
+   * An option for the participant type field. Used to determine which W-8 form is required.
+   * @uiName Individual participant type label
    */
   individualParticipant: string;
   /**
-   * Text inside iframe when Docusign form throws error
-   * @uiName Docusign error text
+   * This appears inside the Docusign frame.
+   * @uiName Docusign form error message
+   * @uiWidget textArea
    */
   docusignError: string;
   /**
-   * Text shown inside of refresh button
-   * @uiName Refresh button text
+   * @uiName Refresh page button label
    */
   refreshButton: string;
   /**
-   * Text shown inside of back button
-   * @uiName Back button text
-   */
-  backButton: string;
-  /**
-   * Text shown inside of cancel button
-   * @uiName Cancel button text
-   */
-  cancelButton: string;
-  /**
-   * The title for error message shown at the top of the page in an error banner
-   *
-   * @uiName General error title
+   * Part of the alert displayed at the top of the page.
+   * @uiName Form submission error message title
+   * @uiWidget textArea
    */
   generalErrorTitle: string;
   /**
-   * The error message shown at the top of the page in an error banner
-   *
-   * @uiName General error text
+   * Part of the alert displayed at the top of the page.
+   * @uiName Form submission error message description
+   * @uiWidget textArea
    */
   generalErrorDescription: string;
   /**
-   * Alert header shown if there is a problem loading a form
-   * @uiName Loading error alert header
+   * Part of the alert displayed at the top of the page.
+   * @uiName Page load error message title
+   * @uiWidget textArea
    */
   loadingErrorAlertHeader: string;
   /**
-   * Alert description shown if there is a problem loading a form
-   * @uiName Loading error alert description
+   * Part of the alert displayed at the top of the page.
+   * @uiName Page load error message description
+   * @uiWidget textArea
    */
   loadingErrorAlertDescription: string;
   /**
-   * The error message shown at the bottom of the page if the user has not checked the form submission checkbox
-   *
-   * @uiName Form submission error text
+   * Displayed at the top of the page on all set up steps.
+   * @uiName Page description
    */
-  formSubmissionError: string;
+  taxAndPayoutsDescription: string;
   /**
    * @undocumented
    * @uiType object
@@ -142,7 +115,6 @@ export declare class DocusignForm {
     error: {
       generalTitle: string;
       generalDescription: string;
-      formSubmission: string;
       participantType: string;
       loadingErrorAlertHeader: string;
       loadingErrorAlertDescription: string;

package/dist/types/components/tax-and-cash/sqm-docusign-form/useDocusignForm.d.ts

@@ -21,22 +21,19 @@ export declare function useDocusignForm(props: DocusignForm): {
     docusignStatus: DocusignStatus;
     documentType: import("../sqm-tax-and-cash/data").TaxDocumentType;
     documentTypeString: string;
-    hideBackButton: boolean;
   };
   data: {
     taxForm: import("../sqm-tax-and-cash/data").TaxDocumentType;
     documentUrl: string;
   };
   callbacks: {
-    setDocusignStatus: (value: "delete" | "ttl_expired" | "signing_complete" | "cancel" | "exception" | "fax_pending" | "session_timeout" | "viewing_complete" | ((prev: DocusignStatus) => DocusignStatus)) => void;
+    setDocusignStatus: (value: "ttl_expired" | "signing_complete" | "cancel" | "delete" | "exception" | "fax_pending" | "session_timeout" | "viewing_complete" | ((prev: DocusignStatus) => DocusignStatus)) => void;
     setParticipantType: (value: "individualParticipant" | "businessEntity" | ((prev: "individualParticipant" | "businessEntity") => "individualParticipant" | "businessEntity")) => void;
-    onBack: () => void;
   };
   text: DocusignForm & {
     error: {
       generalTitle: string;
       generalDescription: string;
-      formSubmission: string;
       participantType: string;
       loadingErrorAlertHeader: string;
       loadingErrorAlertDescription: string;