@saasquatch/mint-components 1.8.0-99 → 1.8.0

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

@@ -8,8 +8,6 @@ export interface TaxAndCashDashboardProps {
     canEditPayoutInfo: boolean;
     disabled?: boolean;
     dateSubmitted?: string;
-    dateExpired?: string;
-    expiresSoon?: boolean;
     noFormNeeded?: boolean;
     indirectTaxType?: string;
     qstNumber?: string;
@@ -22,6 +20,7 @@ export interface TaxAndCashDashboardProps {
     isBusinessEntity?: boolean;
     loading?: boolean;
     loadingError?: boolean;
+    showNewFormDialog: boolean;
     errors?: {
       general?: boolean;
     };
@@ -32,6 +31,8 @@ export interface TaxAndCashDashboardProps {
   callbacks: {
     onClick: (props: any) => void;
     onEditPayoutInfo: () => void;
+    onNewFormCancel: () => void;
+    onNewFormClick: () => void;
   };
   text: {
     statusTextActive?: string;
@@ -66,9 +67,19 @@ export interface TaxAndCashDashboardProps {
     subRegionTaxNumber: string;
     invoiceColumnTitle: string;
     earningsColumnTitle: string;
-    taxedAmountColumnTitle: string;
+    indirectTaxColumnTitle: string;
     earningsAfterTaxColumnTitle: string;
     dateColumnTitle: string;
+    taxAndPayoutsDescription: string;
+    invoiceDescription: string;
+    invoicePrevLabel: string;
+    invoiceMoreLabel: string;
+    invoiceHeader: string;
+    invoiceEmptyStateHeader: string;
+    invoiceEmptyStateText: string;
+    replaceTaxFormModalHeader: string;
+    replaceTaxFormModalBodyText: string;
+    cancelButton: string;
     error: {
       generalTitle: string;
       generalDescription: string;

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

@@ -5,234 +5,264 @@ import { UseTaxAndCashDashboardResult } from "./useTaxAndCashDashboard";
  */
 export declare class TaxAndCashDashboard {
   /**
-   * Status text displayed in badge when tax document is Active
-   *
-   * @uiName Status text
+   * @uiName Active tax form badge label
    */
   statusTextActive?: string;
   /**
-   * Status text displayed in badge when tax document is Not Active
-   *
-   * @uiName Status text
+   * @uiName Invalid tax form badge label
    */
   statusTextNotActive?: string;
   /**
-   * Status text displayed in badge when tax document is Not Verified
+   * Displayed when the participant submitted their form but it is awaiting review.
    *
-   * @uiName Status text
+   * @uiName Not verified tax form badge label
    */
   statusTextNotVerified?: string;
   /**
-   * Description text which appears beside badge showing when the form was submitted
+   * Additional text displayed next to the tax form's status badge
    *
-   * @uiName Badge description text
+   * @uiName Active W-9 description
    */
   badgeTextSubmittedOn?: string;
   /**
-   * Description text for W8 which appears beside badge showing when the form was submitted
+   * Additional text displayed next to the tax form's status badge.
    *
-   * @uiName Badge description text
+   * @uiName Active W-8 description
    */
   badgeTextSubmittedOnW8?: string;
   /**
-   * Description text which appears beside badge showing the form is awaiting review
+   * Additional text displayed next to the tax form's status badge.
    *
-   * @uiName Badge description text
+   * @uiName Tax form in review description
    */
   badgeTextAwaitingReview?: string;
   /**
-   * Header displayed in not active W9 alert header at the top of the page.
+   * Part of the alert displayed at the top of the page.
    *
-   * @uiName Not active W9 alert header
+   * @uiName Inactive W-9 error message title
+   * @uiWidget textArea
    */
   taxAlertHeaderNotActiveW9?: string;
   /**
-   * Header displayed in not active W9 alert header at the top of the page.
+   * Part of the alert displayed at the top of the page.
    *
-   * @uiName Not active W8 alert header
+   * @uiName Inactive W-8 error message title
+   * @uiWidget textArea
    */
   taxAlertHeaderNotActiveW8?: string;
   /**
-   * Description text displayed in W9 alert body at the top of the page.
+   * Part of the alert displayed at the top of the page.
    *
-   * @uiName Tax W9 alert message
+   * @uiName Inactive W-9 error message description
+   * @uiWidget textArea
    */
   taxAlertNotActiveMessageW9?: string;
   /**
-   * Description text displayed in W8 alert body at the top of the page.
+   * Part of the alert displayed at the top of the page.
    *
-   * @uiName Tax W8 alert message
+   * @uiName Inactive W-8 error message description
    */
   taxAlertNotActiveMessageW8?: string;
   /**
-   * Description text displayed next to the badge in the tax documents status
+   * Additional text displayed next to the tax form's status badge.
    *
-   * @uiName Invalid form description text
+   * @uiName Invalid tax form description
+   * @uiWidget textArea
    */
   invalidForm?: string;
   /**
-   * Header text displayed above the banking information card
-   *
-   * @uiName Banking information header
+   * @uiName Payout information section header
    */
   bankingInformationSectionHeader: string;
   /**
-   * Header text displayed above the tax documents status
-   *
    * @uiName Tax document section header
    */
   taxDocumentSectionHeader: string;
   /**
-   * Sub header text displayed above the tax documents status
+   * Displayed under the tax document section header.
    *
-   * @uiName Tax documents sub header
+   * @uiName Tax documents section description
    */
   taxDocumentSectionSubHeader: string;
   /**
-   * Subtext displayed at the bottom of the page if there are no tax documents to show
+   * No other statuses or badges will be displayed in the tax form section in this case.
    *
-   * @uiName No form needed subtext
+   * @uiName Tax form not required text
+   * @uiWidget textArea
    */
   noFormNeededSubtext: string;
   /**
-   * Header text displayed above the indirect tax preview section
    *
-   * @uiName Indirect Tax Information Header
+   * @uiName Indirect tax section header
    */
   indirectTaxInfoSectionHeader: string;
   /**
-   * Country/Province description text of indirect tax
+   * If the participant is registered for indirect tax in Canada, display the province they’re registered in.
    *
-   * @uiName Indirect tax Canada description
+   * @uiName Canadian province of indirect tax
    */
   indirectTaxInfoCanada: string;
   /**
-   * Other country description text of indirect tax
+   * If the participant is registered for indirect tax, display the country they’re registered in.
    *
-   * @uiName Indirect tax other country description
+   * @uiName Indirect tax country
    */
   indirectTaxInfoOtherCountry: string;
   /**
-   * Spain/Region description text of indirect tax
+   * If the participant is registered for indirect tax in Spain, display the region they’re registered in.
    *
-   * @uiName Indirect tax Spain description
+   * @uiName Spanish region of indirect tax
    */
   indirectTaxInfoSpain: string;
   /**
-   * Indirect tax tooltip text for support
-   *
-   * @uiName Indirect tax tooltip description
+   * @uiName Indirect tax tooltip
+   * @uiWidget textArea
    */
   indirectTaxTooltipSupport: string;
   /**
-   * Indirect tax number/type details
+   * Displayed to participants who have submitted their indirect tax information.
    *
    * @uiName Indirect tax details
    */
   indirectTaxDetails: string;
   /**
-   * Text displayed in the submit new document button at the bottom of the page
-   *
-   * @uiName No form needed subtext
+   * @uiName Submit new tax form button label
    */
   newFormButton: string;
   /**
-   * Text displayed in the edit Payment Information button
    *
-   * @uiName Edit Payment Information button
+   * @uiName Edit payment info button label
    */
   editPaymentInformationButton: string;
   /**
-   * Text displayed when partner is not registered for Indirect Tax
-   *
-   * @uiName Not registered for Indirect Tax
+   * @uiName Not registered for indirect tax text
+   * @uiWidget textArea
    */
   notRegisteredForTax: string;
   /**
-   * Label text for the QST number
-   * @uiName QST number input
+   * Displayed to participants registered in Quebec, Canada.
+   * @uiName QST indirect tax details
    */
   qstNumber: string;
   /**
-   * Label text for the sub-region tax number
-   * @uiName Sub-region tax number
+   * @uiName Spain sub-region indirect tax number
    */
   subRegionTaxNumber: string;
   /**
-   * Label text for next payout status badge
-   * @uiName Status badge text
+   * @uiName Payout status badge
    */
   statusBadgeText: string;
   /**
-   * Label text for the next payout based on balance
-   * @uiName Threshold payout text
+   * Display participants' payout preference on the payout information card, indicating the balance at which they want to get paid.
+   * @uiName Payout schedule by threshold text
    */
   thresholdPayoutText: string;
   /**
-   * Label text account heading text
-   * @uiName Account text
+   * Shown before the participant’s bank account information.
+   * @uiName Bank account field label
    */
   accountText: string;
   /**
-   * @uiName Error banner title text
+   * Part of the alert displayed at the top of the page when there’s been an issue preventing payouts.
+   * @uiName Payout error message title
+   * @uiWidget textArea
    */
   errorTitleText: string;
   /**
-   * @uiName Error banner description text
+   * Part of the alert displayed at the top of the page when there’s been an issue preventing payouts.
+   * @uiName Payout error message description
+   * @uiWidget textArea
    */
   errorDescriptionText: string;
   /**
-   * The title for error message shown at the top of the page in an error banner
-   *
-   * @uiName General error title
+   * Text displayed for existing publishers that do not have saved banking information.
+   * @uiName Payout missing information subtext
+   */
+  payoutMissingInformationText: string;
+  /**
+   * 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;
   /**
-   * Sub text describing how payouts are provided from impact.com
+   * Displayed under the payout details card.
    * @uiName Payout from impact text
+   * @uiWidget textArea
    */
   payoutFromImpact: 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;
   /**
-   * Invoice table Invoice column title
-   * @uiName Invoice column title
+   * Part of the Invoice table displayed at the bottom of the page.
+   * @uiName Invoice number column title
    */
   invoiceColumnTitle: string;
   /**
-   * Invoice table Date column title
+   * Part of the Invoice table displayed at the bottom of the page.
    * @uiName Date column title
    */
   dateColumnTitle: string;
   /**
-   * Invoice table Earnings column title
+   * Part of the Invoice table displayed at the bottom of the page.
    * @uiName Earnings column title
    */
   earningsColumnTitle: string;
   /**
-   * Invoice table Taxed Amount column title
-   * @uiName Taxed Amount column title
+   * Part of the Invoice table displayed at the bottom of the page.
+   * @uiName Indirect tax column title
    */
-  taxedAmountColumnTitle: string;
+  indirectTaxColumnTitle: string;
   /**
-   * Invoice table Earnings after tax column title
+   * Part of the Invoice table displayed at the bottom of the page.
    * @uiName Earnings after tax column title
    */
   earningsAfterTaxColumnTitle: string;
+  /** @uiName Invoice table description  */
+  invoiceDescription: string;
+  /** @uiName Invoice table previous page button label  */
+  invoicePrevLabel: string;
+  /** @uiName Invoice table next page button label  */
+  invoiceMoreLabel: string;
+  /** @uiName Invoice table title */
+  invoiceHeader: string;
+  /** @uiName Empty invoice table header  */
+  invoiceEmptyStateHeader: string;
+  /** @uiName Empty invoice table description  */
+  invoiceEmptyStateText: string;
+  /**
+   * Displayed at the top of the page on all set up steps and on the dashboard.
+   * @uiName Page description
+   */
+  taxAndPayoutsDescription: string;
+  /**
+   * @uiName Replace tax form modal header
+   */
+  replaceTaxFormModalHeader: string;
+  /**
+   * @uiName Replace tax form modal body text
+   */
+  replaceTaxFormModalBodyText: string;
+  /**
+   * @uiName Cancel button label
+   */
+  cancelButton: string;
   /**
    * @undocumented
    * @uiType object

package/dist/types/components/tax-and-cash/sqm-user-info-form/small-views/IndirectTaxDetailsView.d.ts

@@ -4,6 +4,7 @@ export interface IndirectDetailsSlotViewProps {
     disabled: boolean;
     loading: boolean;
     hide: boolean;
+    isPartner: boolean;
     formState: {
       selectedRegion?: string;
       subRegion?: string;

package/dist/types/components/tax-and-cash/sqm-user-info-form/small-views/SlotViews.stories.d.ts

@@ -7,4 +7,3 @@ export declare const RegisteredInCanada: () => any;
 export declare const RegisteredInOtherRegionWithErrors: () => any;
 export declare const RegisteredInCanadaWithErrors: () => any;
 export declare const DocusignExpired: () => any;
-export declare const DocusignCompleted: () => any;

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

@@ -63,6 +63,7 @@ export interface UserInfoFormViewProps {
     isPartnerAlertHeader: string;
     isPartnerAlertDescription: string;
     termsAndConditionsLabel: string;
+    taxAndPayoutsDescription: string;
     error: {
       generalTitle: string;
       generalDescription: string;

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

@@ -7,107 +7,108 @@ import { UseUserInfoFormResult } from "./useUserInfoForm";
 export declare class TaxForm {
   ignored: boolean;
   /**
-   * Label text for first name input
-   * @uiName First name label
+   * @uiName First name field label
    */
   firstName: string;
   /**
-   * Label text for last name input
-   * @uiName Last name label
+   * @uiName Last name field label
    */
   lastName: string;
   /**
-   * Label text for email input
-   * @uiName Email label
+   * @uiName Email field label
    */
   email: string;
   /**
-   * Label text for country input
-   * @uiName Country label
+   * @uiName Country field label
    */
   country: string;
   /**
-   * Label text for currency input
-   * @uiName Currency label
+   * @uiName Currency field label
    */
   currency: string;
   /**
-   * Help text shown underneath currency input
-   * @uiName Currency help text
+   * @uiName Currency field help text
    */
   currencyHelpText: string;
   /**
-   * Label text for tax and banking collection checkbox
-   * @uiName Tax and banking label
-   */
-  allowBankingCollection: string;
-  /**
-   * 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 above the forms inputs.
-   * @uiName Form heading text
+   * @uiName Step 1 title
    */
   personalInformation: string;
   /**
-   * Text shown inside of submit button
-   * @uiName Submit button text
+   * @uiName Continue button label
    */
   continueButton: string;
   /**
-   * Alert header text shown in alert if user is already a registered partner
-   * @uiName Participant is partner title
+   * 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;
   /**
-   * Alert description text shown in alert if user is already a registered partner
-   * @uiName Participant is partner 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;
   /**
-   * 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;
   /**
-   * Label text for terms and conditions
-   * @uiName Terms and conditions label text
+   * Edit the property called terms and conditions text to change what's displayed for {termsAndConditionsLink}.
+   * @uiName Terms and conditions checkbox
+   */
+  allowBankingCollection: string;
+  /**
+   * The text link that appears in the terms and conditions checkbox
+   * @uiName Terms and conditions text
+   * @uiWidget textArea
    */
   termsAndConditionsLabel: string;
   /**
    * Placeholder text displayed in the country search dropdown
-   * @uiName Search for country text
+   * @uiName Country field placeholder text
    */
   searchForCountryText: string;
   /**
    * Placeholder text displayed in the currency search dropdown
-   * @uiName Search for currency text
+   * @uiName Currency field placeholder text
    */
   searchForCurrencyText: 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;
   /**
-   * 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;
+  /**
+   * Displayed at the top of the page on all set up steps.
+   * @uiName Page description
+   */
+  taxAndPayoutsDescription: string;
   /**
    * @undocumented
    * @uiType object

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

@@ -1,4 +1,4 @@
-import { Currencies } from "../sqm-tax-and-cash/data";
+import { TaxCountry } from "../sqm-tax-and-cash/data";
 import { TaxForm } from "./sqm-user-info-form";
 export declare type ValidationErrorFunction = (input: {
   control: any;
@@ -48,10 +48,16 @@ export declare function useUserInfoForm(props: TaxForm): {
     };
   };
   data: {
-    currencies: Currencies;
-    countries: import("../sqm-tax-and-cash/data").TaxCountry[];
-    allCurrencies: Currencies;
-    allCountries: import("../sqm-tax-and-cash/data").TaxCountry[];
+    currencies: {
+      displayName: string;
+      currencyCode: string;
+    }[];
+    countries: TaxCountry[];
+    allCurrencies: {
+      displayName: string;
+      currencyCode: string;
+    }[];
+    allCountries: TaxCountry[];
   };
   states: {
     step: string;

package/dist/types/components/tax-and-cash/utils.d.ts

@@ -1,4 +1,12 @@
 import { TaxDocumentType } from "./sqm-tax-and-cash/data";
+export declare function validTaxDocument(requiredType: TaxDocumentType | undefined, currentType: TaxDocumentType | undefined): boolean;
 export declare const objectIsFull: (obj: Record<string, unknown>) => boolean;
 export declare const taxTypeToName: (taxType: TaxDocumentType) => "" | "W-9" | "W-8 BEN" | "W-8 BEN-E";
 export declare const getIsRequiredErrorMessage: (fieldName: string, errorMessage: string) => string;
+export declare function getCountryObj({ countryCode, locale, }: {
+  countryCode: string;
+  locale: string;
+}): {
+  countryCode: string;
+  displayName: any;
+};