@saasquatch/mint-components 2.2.0-6 → 2.2.0-8

package/dist/types/components.d.ts

@@ -55,6 +55,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";
@@ -184,6 +185,10 @@ export namespace Components {
           * @uiWidget textArea
          */
         "branchNameError": string;
+        /**
+          * @uiName Branch name field label
+         */
+        "branchNameLabel": string;
         /**
           * One of three options listed for the classification field
           * @uiName Business classification option
@@ -203,6 +208,10 @@ export namespace Components {
           * @uiWidget textArea
          */
         "classificationCodeError": string;
+        /**
+          * @uiName Classification code field label
+         */
+        "classificationCodeLabel": string;
         /**
           * @uiName Classification entity field label
          */
@@ -576,7 +585,7 @@ export namespace Components {
          */
         "checkboxLabelLink"?: string;
         /**
-          * @uiName Checkbox label link lext
+          * @uiName Checkbox label link text
          */
         "checkboxLabelLinkText"?: string;
         /**
@@ -4104,6 +4113,11 @@ export namespace Components {
         "titleText"?: string;
     }
     interface SqmReferralIframe {
+        /**
+          * Override the default parameter name used in the iframe
+          * @uiName Referral code parameter name
+         */
+        "codeParam": string;
         /**
           * @undocumented 
           * @uiType object
@@ -5113,6 +5127,15 @@ export namespace Components {
         "tooltiptext": string;
     }
     interface SqmShareLink {
+        /**
+          * Let advocates customize their share links up to 5 times.
+          * @uiName Allow customization
+          * @uiType boolean
+          * @uiGroup Customizable Vanity Link
+          * @uiWidget CustomLinkSwitch
+          * @requiredFlavor impact
+         */
+        "allowCustomization"?: boolean;
         /**
           * Background color of share link container
           * @uiName Background color
@@ -5154,21 +5177,177 @@ export namespace Components {
           * @uiGroup Style
          */
         "buttonType"?: "primary" | "secondary";
+        /**
+          * Text for the cancel button in editing mode
+          * @uiName Cancel button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "cancelLabelText"?: string;
+        /**
+          * Text shown when nearing the character limit. Use {charactersRemaining} as a placeholder for the count.
+          * @uiName Characters remaining text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "charactersRemainingText"?: string;
         /**
           * @uiName Copy button label
          */
         "copyButtonLabel": string;
+        /**
+          * Tooltip text shown when link customization is disabled
+          * @uiName Customize disabled tooltip
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "customizeDisabledTooltip"?: string;
+        /**
+          * Displayed below the share link.
+          * @uiName Customize link button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "customizeLinkButtonLabel"?: string;
         /**
           * @undocumented 
           * @uiType object
          */
-        "demoData"?: DemoData<CopyTextViewProps>;
+        "demoData"?: DemoData<ShareLinkViewProps>;
+        /**
+          * Label shown above the link input while editing
+          * @uiName Edit input label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "editLabelText"?: string;
+        /**
+          * Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder.
+          * @uiName Edit limit reached text
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "editLimitReachedText"?: string;
+        /**
+          * Subtext shown while the user is customizing their URL.
+          * @uiName Edit limit text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "editLimitText"?: string;
+        /**
+          * Description text shown when the link contains invalid special characters.
+          * @uiName Invalid characters error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "invalidCharactersErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link contains invalid special characters.
+          * @uiName Invalid characters error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "invalidCharactersErrorTitle"?: string;
+        /**
+          * Description text shown when the link has already been taken
+          * @uiName Link taken error message
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "linkTakenErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link has already been taken
+          * @uiName Link taken error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "linkTakenErrorTitle"?: string;
+        /**
+          * @uiName Min characters text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "minCharactersText"?: 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;
+        /**
+          * Description text shown when the link contains profanity or brand names.
+          * @uiName Restricted words error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link contains profanity or brand names.
+          * @uiName Restricted words error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorTitle"?: string;
+        /**
+          * Description shown when saving fails with an unknown error
+          * @uiName Save error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "saveErrorDescription"?: string;
+        /**
+          * Title shown when saving fails with an unknown error
+          * @uiName Save error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "saveErrorTitle"?: string;
+        /**
+          * Text for the save button in editing mode
+          * @uiName Save button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "saveLabelText"?: string;
+        /**
+          * Text for the save button while saving is in progress
+          * @uiName Saving button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "savingLabelText"?: string;
+        /**
+          * Display text for the support link in the edit limit reached message
+          * @uiName Support link text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "supportLinkText"?: string;
         /**
           * Change the text alignment
           * @uiName Share link alignment
@@ -5196,6 +5375,14 @@ export namespace Components {
           * @uiName Tooltip text
          */
         "tooltiptext": string;
+        /**
+          * Text shown while the link is being validated
+          * @uiName Validating label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "validatingLabelText"?: string;
     }
     interface SqmSkeleton {
         /**
@@ -6325,6 +6512,11 @@ export namespace Components {
           * @uiGroup Step 4 Properties
          */
         "step4_branchCodeLabel": string;
+        /**
+          * @uiName Branch name field label
+          * @uiGroup Step 4 Properties
+         */
+        "step4_branchNameLabel": string;
         /**
           * One of three options listed for the classification field
           * @uiName Business classification option
@@ -6341,6 +6533,11 @@ export namespace Components {
           * @uiGroup Step 4 Properties
          */
         "step4_classificationCPFLabel": string;
+        /**
+          * @uiName Classification code field label
+          * @uiGroup Step 4 Properties
+         */
+        "step4_classificationCodeLabel": string;
         /**
           * @uiName Classification entity field label
           * @uiGroup Step 4 Properties
@@ -8396,6 +8593,10 @@ declare namespace LocalJSX {
           * @uiWidget textArea
          */
         "branchNameError"?: string;
+        /**
+          * @uiName Branch name field label
+         */
+        "branchNameLabel"?: string;
         /**
           * One of three options listed for the classification field
           * @uiName Business classification option
@@ -8415,6 +8616,10 @@ declare namespace LocalJSX {
           * @uiWidget textArea
          */
         "classificationCodeError"?: string;
+        /**
+          * @uiName Classification code field label
+         */
+        "classificationCodeLabel"?: string;
         /**
           * @uiName Classification entity field label
          */
@@ -8788,7 +8993,7 @@ declare namespace LocalJSX {
          */
         "checkboxLabelLink"?: string;
         /**
-          * @uiName Checkbox label link lext
+          * @uiName Checkbox label link text
          */
         "checkboxLabelLinkText"?: string;
         /**
@@ -12311,6 +12516,11 @@ declare namespace LocalJSX {
         "titleText"?: string;
     }
     interface SqmReferralIframe {
+        /**
+          * Override the default parameter name used in the iframe
+          * @uiName Referral code parameter name
+         */
+        "codeParam"?: string;
         /**
           * @undocumented 
           * @uiType object
@@ -13296,6 +13506,15 @@ declare namespace LocalJSX {
         "tooltiptext"?: string;
     }
     interface SqmShareLink {
+        /**
+          * Let advocates customize their share links up to 5 times.
+          * @uiName Allow customization
+          * @uiType boolean
+          * @uiGroup Customizable Vanity Link
+          * @uiWidget CustomLinkSwitch
+          * @requiredFlavor impact
+         */
+        "allowCustomization"?: boolean;
         /**
           * Background color of share link container
           * @uiName Background color
@@ -13337,21 +13556,177 @@ declare namespace LocalJSX {
           * @uiGroup Style
          */
         "buttonType"?: "primary" | "secondary";
+        /**
+          * Text for the cancel button in editing mode
+          * @uiName Cancel button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "cancelLabelText"?: string;
+        /**
+          * Text shown when nearing the character limit. Use {charactersRemaining} as a placeholder for the count.
+          * @uiName Characters remaining text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "charactersRemainingText"?: string;
         /**
           * @uiName Copy button label
          */
         "copyButtonLabel"?: string;
+        /**
+          * Tooltip text shown when link customization is disabled
+          * @uiName Customize disabled tooltip
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "customizeDisabledTooltip"?: string;
+        /**
+          * Displayed below the share link.
+          * @uiName Customize link button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "customizeLinkButtonLabel"?: string;
         /**
           * @undocumented 
           * @uiType object
          */
-        "demoData"?: DemoData<CopyTextViewProps>;
+        "demoData"?: DemoData<ShareLinkViewProps>;
+        /**
+          * Label shown above the link input while editing
+          * @uiName Edit input label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "editLabelText"?: string;
+        /**
+          * Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder.
+          * @uiName Edit limit reached text
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "editLimitReachedText"?: string;
+        /**
+          * Subtext shown while the user is customizing their URL.
+          * @uiName Edit limit text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "editLimitText"?: string;
+        /**
+          * Description text shown when the link contains invalid special characters.
+          * @uiName Invalid characters error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "invalidCharactersErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link contains invalid special characters.
+          * @uiName Invalid characters error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "invalidCharactersErrorTitle"?: string;
+        /**
+          * Description text shown when the link has already been taken
+          * @uiName Link taken error message
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "linkTakenErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link has already been taken
+          * @uiName Link taken error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "linkTakenErrorTitle"?: string;
+        /**
+          * @uiName Min characters text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "minCharactersText"?: 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;
+        /**
+          * Description text shown when the link contains profanity or brand names.
+          * @uiName Restricted words error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorDescription"?: string;
+        /**
+          * Title of the error message shown when the link contains profanity or brand names.
+          * @uiName Restricted words error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "restrictedWordsErrorTitle"?: string;
+        /**
+          * Description shown when saving fails with an unknown error
+          * @uiName Save error description
+          * @uiType string
+          * @uiWidget textarea
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "saveErrorDescription"?: string;
+        /**
+          * Title shown when saving fails with an unknown error
+          * @uiName Save error title
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "saveErrorTitle"?: string;
+        /**
+          * Text for the save button in editing mode
+          * @uiName Save button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "saveLabelText"?: string;
+        /**
+          * Text for the save button while saving is in progress
+          * @uiName Saving button label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "savingLabelText"?: string;
+        /**
+          * Display text for the support link in the edit limit reached message
+          * @uiName Support link text
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "supportLinkText"?: string;
         /**
           * Change the text alignment
           * @uiName Share link alignment
@@ -13379,6 +13754,14 @@ declare namespace LocalJSX {
           * @uiName Tooltip text
          */
         "tooltiptext"?: string;
+        /**
+          * Text shown while the link is being validated
+          * @uiName Validating label
+          * @uiType string
+          * @uiGroup Customizable Vanity Link
+          * @requiredFlavor impact
+         */
+        "validatingLabelText"?: string;
     }
     interface SqmSkeleton {
         /**
@@ -14508,6 +14891,11 @@ declare namespace LocalJSX {
           * @uiGroup Step 4 Properties
          */
         "step4_branchCodeLabel"?: string;
+        /**
+          * @uiName Branch name field label
+          * @uiGroup Step 4 Properties
+         */
+        "step4_branchNameLabel"?: string;
         /**
           * One of three options listed for the classification field
           * @uiName Business classification option
@@ -14524,6 +14912,11 @@ declare namespace LocalJSX {
           * @uiGroup Step 4 Properties
          */
         "step4_classificationCPFLabel"?: string;
+        /**
+          * @uiName Classification code field label
+          * @uiGroup Step 4 Properties
+         */
+        "step4_classificationCodeLabel"?: string;
         /**
           * @uiName Classification entity field label
           * @uiGroup Step 4 Properties