@saasquatch/mint-components 2.1.8-0 → 2.1.8-10

package/dist/types/components.d.ts

@@ -54,6 +54,7 @@ import { ReferralIframeViewProps } from "./components/sqm-referral-iframe/sqm-re
 import { ReferralDates } from "./components/sqm-referral-table/useReferralTable";
 import { RewardExchangeViewProps } from "./components/sqm-reward-exchange-list/sqm-reward-exchange-list-view";
 import { ShareButtonViewProps } from "./components/sqm-share-button/sqm-share-button-view";
+import { ShareLinkViewProps } from "./components/sqm-share-link/sqm-share-link-view";
 import { TaskCardViewProps } from "./components/sqm-task-card/sqm-task-card-view";
 import { UseTaxAndCashDashboardResult } from "./components/tax-and-cash/sqm-tax-and-cash-dashboard/useTaxAndCashDashboard";
 import { UseUserInfoFormResult } from "./components/tax-and-cash/sqm-user-info-form/useUserInfoForm";
@@ -64,12 +65,6 @@ export namespace Components {
         "renderLabel": (idx: any) => Promise<any>;
     }
     interface SqmBankingInfoForm {
-        /**
-          * Error messages for the agency code field. Supports error codes: empty, alphanumeric, tooShort
-          * @uiName Agency code error
-          * @uiWidget textArea
-         */
-        "agencyCodeError": string;
         /**
           * @uiName Agency code field label
          */
@@ -79,42 +74,18 @@ export namespace Components {
           * @uiName Back button label
          */
         "backButton": string;
-        /**
-          * Error messages for the bank account number / IBAN field. Supports error codes: empty, invalidUk, invalid, ibanEmpty, ibanAlphanumeric, ibanInvalid, ibanCountryMismatch
-          * @uiName Bank account number / IBAN error
-          * @uiWidget textArea
-         */
-        "bankAccountNumberError": string;
         /**
           * @uiName Bank account number field label
          */
         "bankAccountNumberLabel": string;
-        /**
-          * Error messages for the bank account type field. Supports error codes: empty
-          * @uiName Bank account type error
-          * @uiWidget textArea
-         */
-        "bankAccountTypeError": string;
         /**
           * @uiName Bank account type field label
          */
         "bankAccountTypeLabel": string;
-        /**
-          * Error messages for the bank address field. Supports error codes: empty
-          * @uiName Bank address error
-          * @uiWidget textArea
-         */
-        "bankAddressError": string;
         /**
           * @uiName Bank address field label
          */
         "bankAddressLabel": string;
-        /**
-          * Error messages for the bank city field. Supports error codes: empty
-          * @uiName Bank city error
-          * @uiWidget textArea
-         */
-        "bankCityError": string;
         /**
           * @uiName Bank city field label
          */
@@ -123,32 +94,14 @@ export namespace Components {
           * @uiName Bank country field label
          */
         "bankLocationLabel": string;
-        /**
-          * Error messages for the bank name field. Supports error codes: empty
-          * @uiName Bank name error
-          * @uiWidget textArea
-         */
-        "bankNameError": string;
         /**
           * @uiName Bank name field label
          */
         "bankNameLabel": string;
-        /**
-          * Error messages for the bank postal code field. Supports error codes: empty
-          * @uiName Bank postal code error
-          * @uiWidget textArea
-         */
-        "bankPostalCodeError": string;
         /**
           * @uiName Bank postal code field label
          */
         "bankPostalCodeLabel": string;
-        /**
-          * Error messages for the bank province/state field. Supports error codes: empty
-          * @uiName Bank province/state error
-          * @uiWidget textArea
-         */
-        "bankStateError": string;
         /**
           * @uiName Bank province/state field label
          */
@@ -157,32 +110,14 @@ export namespace Components {
           * @uiName Beneficiary account field description
          */
         "beneficiaryAccountNameDescription": string;
-        /**
-          * Error messages for the beneficiary / account holder name field. Supports error codes: empty, invalidCharacters, numeric, tooLong, nonEnglish, businessNameMismatch, nameMismatch, businessPayeeMismatch, payeeMismatch
-          * @uiName Beneficiary account name error
-          * @uiWidget textArea
-         */
-        "beneficiaryAccountNameError": string;
         /**
           * @uiName Beneficiary account field label
          */
         "beneficiaryAccountNameLabel": string;
-        /**
-          * Error messages for the branch code field. Supports error codes: invalid
-          * @uiName Branch code error
-          * @uiWidget textArea
-         */
-        "branchCodeError": string;
         /**
           * @uiName Branch code field label
          */
         "branchCodeLabel": string;
-        /**
-          * Error messages for the branch name field. Supports error codes: empty
-          * @uiName Branch name error
-          * @uiWidget textArea
-         */
-        "branchNameError": string;
         /**
           * One of three options listed for the classification field
           * @uiName Business classification option
@@ -196,12 +131,6 @@ export namespace Components {
           * @uiName Classification CPF field label
          */
         "classificationCPFLabel": string;
-        /**
-          * Error messages for the classification code field. Supports error codes: empty, invalidKzt
-          * @uiName Classification code error
-          * @uiWidget textArea
-         */
-        "classificationCodeError": string;
         /**
           * @uiName Classification entity field label
          */
@@ -309,12 +238,6 @@ export namespace Components {
           * @uiName Information modal title
          */
         "modalTitle": string;
-        /**
-          * Error messages for the patronymic name field. Supports error codes: empty, alphanumeric
-          * @uiName Patronymic name error
-          * @uiWidget textArea
-         */
-        "patronymicNameError": string;
         /**
           * @uiName Patronymic name field label
          */
@@ -324,12 +247,6 @@ export namespace Components {
           * @uiName PayPal email field label
          */
         "payPalInputLabel": string;
-        /**
-          * Error messages for the payment day field. Supports error codes: empty, invalid
-          * @uiName Payment day error
-          * @uiWidget textArea
-         */
-        "paymentDayError": string;
         /**
           * Label text for the payment day select option for the fifteenth of the month
           * @uiName Fifteenth of month payday option
@@ -365,29 +282,11 @@ export namespace Components {
           * @uiName Fixed day payment schedule option
          */
         "paymentScheduleFixedDay": string;
-        /**
-          * Error messages for the payment threshold field. Supports error codes: empty, invalid
-          * @uiName Payment threshold error
-          * @uiWidget textArea
-         */
-        "paymentThresholdError": string;
         /**
           * Participant use this field to select the balance at which they want to be paid
           * @uiName Payment threshold field label
          */
         "paymentThresholdSelectLabel": string;
-        /**
-          * Error messages for the PayPal email field. Supports error codes: empty, unsupportedCurrency, invalidEmail, verificationIncomplete
-          * @uiName PayPal email error
-          * @uiWidget textArea
-         */
-        "paypalEmailError": string;
-        /**
-          * Error messages for the routing code / sort code / BSB field. Supports error codes: invalidBsb, invalidSortCode, empty, invalid
-          * @uiName Routing code error
-          * @uiWidget textArea
-         */
-        "routingCodeError": string;
         /**
           * @uiName Routing code field label
          */
@@ -405,12 +304,6 @@ export namespace Components {
           * @uiName Support link text
          */
         "supportLink": string;
-        /**
-          * Error messages for the SWIFT / BIC code field. Supports error codes: empty, alphanumeric, invalid
-          * @uiName SWIFT code error
-          * @uiWidget textArea
-         */
-        "swiftCodeError": string;
         /**
           * @uiName SWIFT code field label
          */
@@ -424,12 +317,6 @@ export namespace Components {
           * @uiName Page description
          */
         "taxAndPayoutsDescription": string;
-        /**
-          * Error messages for the tax payer ID / classification entity field. Supports error codes: empty, emptyAr, emptyKr, alphanumeric, alphanumericAr, alphanumericKr, invalid, invalidAr, invalidKr, invalidKzt, cnpjTooShort, cpfTooShort
-          * @uiName Tax payer ID error
-          * @uiWidget textArea
-         */
-        "taxPayerIdError": string;
         /**
           * @uiName Taxpayer ID field label
          */
@@ -447,12 +334,6 @@ export namespace Components {
           * @uiName Verify email header
          */
         "verifyEmailHeaderText": string;
-        /**
-          * Error messages for the VO code field. Supports error codes: empty, alphanumeric
-          * @uiName VO code error
-          * @uiWidget textArea
-         */
-        "voCodeError": string;
         /**
           * @uiName VO code field label
          */
@@ -5049,21 +4930,111 @@ export namespace Components {
           * @uiGroup Style
          */
         "buttonType"?: "primary" | "secondary";
+        /**
+          * Text for the cancel button in editing mode
+          * @uiName Cancel button label
+          * @uiType string
+         */
+        "cancelLabelText"?: string;
         /**
           * @uiName Copy button label
          */
         "copyButtonLabel": string;
+        /**
+          * Tooltip text shown when link customization is disabled
+          * @uiName Customize disabled tooltip
+          * @uiType string
+         */
+        "customizeDisabledTooltip"?: string;
+        /**
+          * Text shown below the share link input to trigger customization
+          * @uiName Customize link label
+          * @uiType string
+         */
+        "customizeLinkLabel"?: string;
+        /**
+          * Enable users to customize their referral link
+          * @uiName Customize URL
+          * @uiType boolean
+         */
+        "customizeUrl"?: boolean;
         /**
           * @undocumented 
           * @uiType object
          */
-        "demoData"?: DemoData<CopyTextViewProps>;
+        "demoData"?: DemoData<ShareLinkViewProps>;
+        /**
+          * Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link.
+          * @uiName Edit limit reached text
+          * @uiType string
+         */
+        "editLimitReachedText"?: string;
+        /**
+          * Text describing the edit limit
+          * @uiName Edit limit text
+          * @uiType string
+         */
+        "editLimitText"?: string;
+        /**
+          * Description text shown when the custom link is already taken
+          * @uiName Existing code conflict error description
+          * @uiType string
+         */
+        "existingCodeConflictErrorDescription"?: string;
+        /**
+          * Title text shown when the custom link is already taken
+          * @uiName Existing code conflict error title
+          * @uiType string
+         */
+        "existingCodeConflictErrorTitle"?: string;
+        /**
+          * Description text shown when the link contains invalid characters
+          * @uiName Invalid characters error description
+          * @uiType string
+         */
+        "invalidCharactersErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains invalid characters
+          * @uiName Invalid characters error title
+          * @uiType string
+         */
+        "invalidCharactersErrorTitle"?: string;
+        /**
+          * Description text shown when the link contains profanity
+          * @uiName Profanity error description
+          * @uiType string
+         */
+        "profanityErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains profanity
+          * @uiName Profanity error title
+          * @uiType string
+         */
+        "profanityErrorTitle"?: string;
         /**
           * The ID of the program that should generate the link. Defaults to the program ID in context where this widget is loaded.
           * @uiName Program ID
           * @uiWidget programSelector
          */
         "programId"?: string;
+        /**
+          * Text for the save button in editing mode
+          * @uiName Save button label
+          * @uiType string
+         */
+        "saveLabelText"?: string;
+        /**
+          * Message shown briefly after successfully saving a custom link
+          * @uiName Success message
+          * @uiType string
+         */
+        "successMessage"?: string;
+        /**
+          * Display text for the support link in the edit limit reached message
+          * @uiName Support link text
+          * @uiType string
+         */
+        "supportLinkText"?: string;
         /**
           * Change the text alignment
           * @uiName Share link alignment
@@ -8106,12 +8077,6 @@ declare namespace LocalJSX {
     interface RaisinsPlopTarget {
     }
     interface SqmBankingInfoForm {
-        /**
-          * Error messages for the agency code field. Supports error codes: empty, alphanumeric, tooShort
-          * @uiName Agency code error
-          * @uiWidget textArea
-         */
-        "agencyCodeError"?: string;
         /**
           * @uiName Agency code field label
          */
@@ -8121,42 +8086,18 @@ declare namespace LocalJSX {
           * @uiName Back button label
          */
         "backButton"?: string;
-        /**
-          * Error messages for the bank account number / IBAN field. Supports error codes: empty, invalidUk, invalid, ibanEmpty, ibanAlphanumeric, ibanInvalid, ibanCountryMismatch
-          * @uiName Bank account number / IBAN error
-          * @uiWidget textArea
-         */
-        "bankAccountNumberError"?: string;
         /**
           * @uiName Bank account number field label
          */
         "bankAccountNumberLabel"?: string;
-        /**
-          * Error messages for the bank account type field. Supports error codes: empty
-          * @uiName Bank account type error
-          * @uiWidget textArea
-         */
-        "bankAccountTypeError"?: string;
         /**
           * @uiName Bank account type field label
          */
         "bankAccountTypeLabel"?: string;
-        /**
-          * Error messages for the bank address field. Supports error codes: empty
-          * @uiName Bank address error
-          * @uiWidget textArea
-         */
-        "bankAddressError"?: string;
         /**
           * @uiName Bank address field label
          */
         "bankAddressLabel"?: string;
-        /**
-          * Error messages for the bank city field. Supports error codes: empty
-          * @uiName Bank city error
-          * @uiWidget textArea
-         */
-        "bankCityError"?: string;
         /**
           * @uiName Bank city field label
          */
@@ -8165,32 +8106,14 @@ declare namespace LocalJSX {
           * @uiName Bank country field label
          */
         "bankLocationLabel"?: string;
-        /**
-          * Error messages for the bank name field. Supports error codes: empty
-          * @uiName Bank name error
-          * @uiWidget textArea
-         */
-        "bankNameError"?: string;
         /**
           * @uiName Bank name field label
          */
         "bankNameLabel"?: string;
-        /**
-          * Error messages for the bank postal code field. Supports error codes: empty
-          * @uiName Bank postal code error
-          * @uiWidget textArea
-         */
-        "bankPostalCodeError"?: string;
         /**
           * @uiName Bank postal code field label
          */
         "bankPostalCodeLabel"?: string;
-        /**
-          * Error messages for the bank province/state field. Supports error codes: empty
-          * @uiName Bank province/state error
-          * @uiWidget textArea
-         */
-        "bankStateError"?: string;
         /**
           * @uiName Bank province/state field label
          */
@@ -8199,32 +8122,14 @@ declare namespace LocalJSX {
           * @uiName Beneficiary account field description
          */
         "beneficiaryAccountNameDescription"?: string;
-        /**
-          * Error messages for the beneficiary / account holder name field. Supports error codes: empty, invalidCharacters, numeric, tooLong, nonEnglish, businessNameMismatch, nameMismatch, businessPayeeMismatch, payeeMismatch
-          * @uiName Beneficiary account name error
-          * @uiWidget textArea
-         */
-        "beneficiaryAccountNameError"?: string;
         /**
           * @uiName Beneficiary account field label
          */
         "beneficiaryAccountNameLabel"?: string;
-        /**
-          * Error messages for the branch code field. Supports error codes: invalid
-          * @uiName Branch code error
-          * @uiWidget textArea
-         */
-        "branchCodeError"?: string;
         /**
           * @uiName Branch code field label
          */
         "branchCodeLabel"?: string;
-        /**
-          * Error messages for the branch name field. Supports error codes: empty
-          * @uiName Branch name error
-          * @uiWidget textArea
-         */
-        "branchNameError"?: string;
         /**
           * One of three options listed for the classification field
           * @uiName Business classification option
@@ -8238,12 +8143,6 @@ declare namespace LocalJSX {
           * @uiName Classification CPF field label
          */
         "classificationCPFLabel"?: string;
-        /**
-          * Error messages for the classification code field. Supports error codes: empty, invalidKzt
-          * @uiName Classification code error
-          * @uiWidget textArea
-         */
-        "classificationCodeError"?: string;
         /**
           * @uiName Classification entity field label
          */
@@ -8351,12 +8250,6 @@ declare namespace LocalJSX {
           * @uiName Information modal title
          */
         "modalTitle"?: string;
-        /**
-          * Error messages for the patronymic name field. Supports error codes: empty, alphanumeric
-          * @uiName Patronymic name error
-          * @uiWidget textArea
-         */
-        "patronymicNameError"?: string;
         /**
           * @uiName Patronymic name field label
          */
@@ -8366,12 +8259,6 @@ declare namespace LocalJSX {
           * @uiName PayPal email field label
          */
         "payPalInputLabel"?: string;
-        /**
-          * Error messages for the payment day field. Supports error codes: empty, invalid
-          * @uiName Payment day error
-          * @uiWidget textArea
-         */
-        "paymentDayError"?: string;
         /**
           * Label text for the payment day select option for the fifteenth of the month
           * @uiName Fifteenth of month payday option
@@ -8407,29 +8294,11 @@ declare namespace LocalJSX {
           * @uiName Fixed day payment schedule option
          */
         "paymentScheduleFixedDay"?: string;
-        /**
-          * Error messages for the payment threshold field. Supports error codes: empty, invalid
-          * @uiName Payment threshold error
-          * @uiWidget textArea
-         */
-        "paymentThresholdError"?: string;
         /**
           * Participant use this field to select the balance at which they want to be paid
           * @uiName Payment threshold field label
          */
         "paymentThresholdSelectLabel"?: string;
-        /**
-          * Error messages for the PayPal email field. Supports error codes: empty, unsupportedCurrency, invalidEmail, verificationIncomplete
-          * @uiName PayPal email error
-          * @uiWidget textArea
-         */
-        "paypalEmailError"?: string;
-        /**
-          * Error messages for the routing code / sort code / BSB field. Supports error codes: invalidBsb, invalidSortCode, empty, invalid
-          * @uiName Routing code error
-          * @uiWidget textArea
-         */
-        "routingCodeError"?: string;
         /**
           * @uiName Routing code field label
          */
@@ -8447,12 +8316,6 @@ declare namespace LocalJSX {
           * @uiName Support link text
          */
         "supportLink"?: string;
-        /**
-          * Error messages for the SWIFT / BIC code field. Supports error codes: empty, alphanumeric, invalid
-          * @uiName SWIFT code error
-          * @uiWidget textArea
-         */
-        "swiftCodeError"?: string;
         /**
           * @uiName SWIFT code field label
          */
@@ -8466,12 +8329,6 @@ declare namespace LocalJSX {
           * @uiName Page description
          */
         "taxAndPayoutsDescription"?: string;
-        /**
-          * Error messages for the tax payer ID / classification entity field. Supports error codes: empty, emptyAr, emptyKr, alphanumeric, alphanumericAr, alphanumericKr, invalid, invalidAr, invalidKr, invalidKzt, cnpjTooShort, cpfTooShort
-          * @uiName Tax payer ID error
-          * @uiWidget textArea
-         */
-        "taxPayerIdError"?: string;
         /**
           * @uiName Taxpayer ID field label
          */
@@ -8489,12 +8346,6 @@ declare namespace LocalJSX {
           * @uiName Verify email header
          */
         "verifyEmailHeaderText"?: string;
-        /**
-          * Error messages for the VO code field. Supports error codes: empty, alphanumeric
-          * @uiName VO code error
-          * @uiWidget textArea
-         */
-        "voCodeError"?: string;
         /**
           * @uiName VO code field label
          */
@@ -13062,21 +12913,111 @@ declare namespace LocalJSX {
           * @uiGroup Style
          */
         "buttonType"?: "primary" | "secondary";
+        /**
+          * Text for the cancel button in editing mode
+          * @uiName Cancel button label
+          * @uiType string
+         */
+        "cancelLabelText"?: string;
         /**
           * @uiName Copy button label
          */
         "copyButtonLabel"?: string;
+        /**
+          * Tooltip text shown when link customization is disabled
+          * @uiName Customize disabled tooltip
+          * @uiType string
+         */
+        "customizeDisabledTooltip"?: string;
+        /**
+          * Text shown below the share link input to trigger customization
+          * @uiName Customize link label
+          * @uiType string
+         */
+        "customizeLinkLabel"?: string;
+        /**
+          * Enable users to customize their referral link
+          * @uiName Customize URL
+          * @uiType boolean
+         */
+        "customizeUrl"?: boolean;
         /**
           * @undocumented 
           * @uiType object
          */
-        "demoData"?: DemoData<CopyTextViewProps>;
+        "demoData"?: DemoData<ShareLinkViewProps>;
+        /**
+          * Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link.
+          * @uiName Edit limit reached text
+          * @uiType string
+         */
+        "editLimitReachedText"?: string;
+        /**
+          * Text describing the edit limit
+          * @uiName Edit limit text
+          * @uiType string
+         */
+        "editLimitText"?: string;
+        /**
+          * Description text shown when the custom link is already taken
+          * @uiName Existing code conflict error description
+          * @uiType string
+         */
+        "existingCodeConflictErrorDescription"?: string;
+        /**
+          * Title text shown when the custom link is already taken
+          * @uiName Existing code conflict error title
+          * @uiType string
+         */
+        "existingCodeConflictErrorTitle"?: string;
+        /**
+          * Description text shown when the link contains invalid characters
+          * @uiName Invalid characters error description
+          * @uiType string
+         */
+        "invalidCharactersErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains invalid characters
+          * @uiName Invalid characters error title
+          * @uiType string
+         */
+        "invalidCharactersErrorTitle"?: string;
+        /**
+          * Description text shown when the link contains profanity
+          * @uiName Profanity error description
+          * @uiType string
+         */
+        "profanityErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains profanity
+          * @uiName Profanity error title
+          * @uiType string
+         */
+        "profanityErrorTitle"?: string;
         /**
           * The ID of the program that should generate the link. Defaults to the program ID in context where this widget is loaded.
           * @uiName Program ID
           * @uiWidget programSelector
          */
         "programId"?: string;
+        /**
+          * Text for the save button in editing mode
+          * @uiName Save button label
+          * @uiType string
+         */
+        "saveLabelText"?: string;
+        /**
+          * Message shown briefly after successfully saving a custom link
+          * @uiName Success message
+          * @uiType string
+         */
+        "successMessage"?: string;
+        /**
+          * Display text for the support link in the edit limit reached message
+          * @uiName Support link text
+          * @uiType string
+         */
+        "supportLinkText"?: string;
         /**
           * Change the text alignment
           * @uiName Share link alignment