@saasquatch/mint-components 2.1.10-56 → 2.1.10

package/dist/types/components.d.ts

@@ -54,9 +54,9 @@ 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 { UserAttributeViewProps } from "./components/sqm-user-attribute/sqm-user-attribute-view";
 import { UseUserInfoFormResult } from "./components/tax-and-cash/sqm-user-info-form/useUserInfoForm";
 import { UserNameViewProps } from "./components/sqm-user-name/sqm-user-name-view";
 export namespace Components {
@@ -4894,6 +4894,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
@@ -4935,21 +4944,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
@@ -4977,6 +5142,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 {
         /**
@@ -6813,37 +6986,6 @@ export namespace Components {
          */
         "textAlign": "left" | "center" | "right";
     }
-    interface SqmUserAttribute {
-        /**
-          * @uiName Color
-          * @uiWidget color
-          * @format color
-          * @uiGroup Style
-         */
-        "color"?: string;
-        /**
-          * @undocumented 
-          * @uiType object
-         */
-        "demoData"?: DemoData<UserAttributeViewProps>;
-        /**
-          * Font size in pixels.
-          * @uiName Font size
-          * @uiGroup Style
-         */
-        "fontsize"?: string;
-        /**
-          * @uiName Font weight
-          * @uiGroup Style
-         */
-        "fontweight"?: string;
-        /**
-          * The custom field key to display.
-          * @uiName Custom field key
-          * @uiWidget customFieldSelector
-         */
-        "value": string;
-    }
     interface SqmUserInfoForm {
         /**
           * @uiName Address field label
@@ -7864,12 +8006,6 @@ declare global {
         prototype: HTMLSqmTitledSectionElement;
         new (): HTMLSqmTitledSectionElement;
     };
-    interface HTMLSqmUserAttributeElement extends Components.SqmUserAttribute, HTMLStencilElement {
-    }
-    var HTMLSqmUserAttributeElement: {
-        prototype: HTMLSqmUserAttributeElement;
-        new (): HTMLSqmUserAttributeElement;
-    };
     interface HTMLSqmUserInfoFormElement extends Components.SqmUserInfoForm, HTMLStencilElement {
     }
     var HTMLSqmUserInfoFormElement: {
@@ -8019,7 +8155,6 @@ declare global {
         "sqm-timeline": HTMLSqmTimelineElement;
         "sqm-timeline-entry": HTMLSqmTimelineEntryElement;
         "sqm-titled-section": HTMLSqmTitledSectionElement;
-        "sqm-user-attribute": HTMLSqmUserAttributeElement;
         "sqm-user-info-form": HTMLSqmUserInfoFormElement;
         "sqm-user-name": HTMLSqmUserNameElement;
         "sqm-widget-verification": HTMLSqmWidgetVerificationElement;
@@ -12830,6 +12965,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
@@ -12871,21 +13015,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
@@ -12913,6 +13213,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 {
         /**
@@ -14748,37 +15056,6 @@ declare namespace LocalJSX {
          */
         "textAlign"?: "left" | "center" | "right";
     }
-    interface SqmUserAttribute {
-        /**
-          * @uiName Color
-          * @uiWidget color
-          * @format color
-          * @uiGroup Style
-         */
-        "color"?: string;
-        /**
-          * @undocumented 
-          * @uiType object
-         */
-        "demoData"?: DemoData<UserAttributeViewProps>;
-        /**
-          * Font size in pixels.
-          * @uiName Font size
-          * @uiGroup Style
-         */
-        "fontsize"?: string;
-        /**
-          * @uiName Font weight
-          * @uiGroup Style
-         */
-        "fontweight"?: string;
-        /**
-          * The custom field key to display.
-          * @uiName Custom field key
-          * @uiWidget customFieldSelector
-         */
-        "value"?: string;
-    }
     interface SqmUserInfoForm {
         /**
           * @uiName Address field label
@@ -15178,7 +15455,6 @@ declare namespace LocalJSX {
         "sqm-timeline": SqmTimeline;
         "sqm-timeline-entry": SqmTimelineEntry;
         "sqm-titled-section": SqmTitledSection;
-        "sqm-user-attribute": SqmUserAttribute;
         "sqm-user-info-form": SqmUserInfoForm;
         "sqm-user-name": SqmUserName;
         "sqm-widget-verification": SqmWidgetVerification;
@@ -15313,7 +15589,6 @@ declare module "@stencil/core" {
             "sqm-timeline": LocalJSX.SqmTimeline & JSXBase.HTMLAttributes<HTMLSqmTimelineElement>;
             "sqm-timeline-entry": LocalJSX.SqmTimelineEntry & JSXBase.HTMLAttributes<HTMLSqmTimelineEntryElement>;
             "sqm-titled-section": LocalJSX.SqmTitledSection & JSXBase.HTMLAttributes<HTMLSqmTitledSectionElement>;
-            "sqm-user-attribute": LocalJSX.SqmUserAttribute & JSXBase.HTMLAttributes<HTMLSqmUserAttributeElement>;
             "sqm-user-info-form": LocalJSX.SqmUserInfoForm & JSXBase.HTMLAttributes<HTMLSqmUserInfoFormElement>;
             "sqm-user-name": LocalJSX.SqmUserName & JSXBase.HTMLAttributes<HTMLSqmUserNameElement>;
             "sqm-widget-verification": LocalJSX.SqmWidgetVerification & JSXBase.HTMLAttributes<HTMLSqmWidgetVerificationElement>;