@saasquatch/mint-components 2.1.8-23 → 2.1.8-25

package/dist/collection/components/sqm-share-link/sqm-share-link.js

@@ -59,29 +59,29 @@ export class ShareLink {
      */
     this.buttonStyle = "icon";
     /**
-     * Enable users to customize their referral link
+     * Let advocates customize their share links up to 5 times.
      *
-     * @uiName Customize URL
+     * @uiName Allow customization
      * @uiType boolean
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.customizeUrl = false;
+    this.allowCustomization = false;
     /**
-     * Text shown below the share link input to trigger customization
+     * Displayed below the share link.
      *
-     * @uiName Customize link label
+     * @uiName Customize link button label
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.customizeLinkLabel = "Customize Link";
+    this.customizeLinkButtonLabel = "Customize Link";
     /**
      * Text for the save button in editing mode
      *
      * @uiName Save button label
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
     this.saveLabelText = "Save";
@@ -90,79 +90,83 @@ export class ShareLink {
      *
      * @uiName Cancel button label
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
     this.cancelLabelText = "Cancel";
     /**
-     * Title text shown when the custom link is already taken
+     * Title of the error message shown when the link has already been taken
      *
-     * @uiName Existing code conflict error title
+     * @uiName Link taken error title
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.existingCodeConflictErrorTitle = "This link is already taken";
+    this.linkTakenErrorTitle = "This link is already taken";
     /**
-     * Description text shown when the custom link is already taken
+     * Description text shown when the link has already been taken
      *
-     * @uiName Existing code conflict error description
+     * @uiName Link taken error message
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.existingCodeConflictErrorDescription = "Try adding numbers, a dash or underscore to create a unique link.";
+    this.linkTakenErrorDescription = "Try adding numbers, a dash or underscore to create a unique link.";
     /**
-     * Title text shown when the link contains invalid characters
+     * Title of the error message shown when the link contains invalid special characters.
      *
      * @uiName Invalid characters error title
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
     this.invalidCharactersErrorTitle = "Please use only letters, numbers, dashes and underscores";
     /**
-     * Description text shown when the link contains invalid characters
+     * Description text shown when the link contains invalid special characters.
      *
      * @uiName Invalid characters error description
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
     this.invalidCharactersErrorDescription = "Special characters can break the link when sharing.";
     /**
-     * Title text shown when the link contains profanity
+     * Title of the error message shown when the link contains profanity or brand names.
      *
-     * @uiName Profanity error title
+     * @uiName Restricted words error title
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.profanityErrorTitle = "Please try a different link";
+    this.restrictedWordsErrorTitle = "Please try a different link";
     /**
-     * Description text shown when the link contains profanity
+     * Description text shown when the link contains profanity or brand names.
      *
-     * @uiName Profanity error description
+     * @uiName Restricted words error description
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.profanityErrorDescription = "This link contains a restricted word.";
+    this.restrictedWordsErrorDescription = "This link contains a restricted word.";
     /**
-     * Text describing the edit limit
+     * Subtext shown while the user is customizing their URL.
      *
      * @uiName Edit limit text
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
-    this.editLimitText = "You can edit your link up to 5 times.";
+    this.editLimitText = "You can edit your link up to {editsRemaining} more times.";
     /**
-     * Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link.
+     * 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
-     * @uiGroup Customize Vanity Link
+     * @uiWidget textarea
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
     this.editLimitReachedText = "5 edit limit reached. To make more changes, please contact {supportLink}.";
@@ -171,7 +175,7 @@ export class ShareLink {
      *
      * @uiName Support link text
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
     this.supportLinkText = "Support";
@@ -180,7 +184,7 @@ export class ShareLink {
      *
      * @uiName Customize disabled tooltip
      * @uiType string
-     * @uiGroup Customize Vanity Link
+     * @uiGroup Customizable Vanity Link
      * @requiredFlavor impact
      */
     this.customizeDisabledTooltip = "Link customization is not available.";
@@ -495,7 +499,7 @@ export class ShareLink {
       "reflect": false,
       "defaultValue": "\"icon\""
     },
-    "customizeUrl": {
+    "allowCustomization": {
       "type": "boolean",
       "mutable": false,
       "complexType": {
@@ -507,25 +511,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Customize URL",
+            "text": "Allow customization",
             "name": "uiName"
           }, {
             "text": "boolean",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Enable users to customize their referral link"
+        "text": "Let advocates customize their share links up to 5 times."
       },
-      "attribute": "customize-url",
+      "attribute": "allow-customization",
       "reflect": false,
       "defaultValue": "false"
     },
-    "customizeLinkLabel": {
+    "customizeLinkButtonLabel": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -537,21 +541,21 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Customize link label",
+            "text": "Customize link button label",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Text shown below the share link input to trigger customization"
+        "text": "Displayed below the share link."
       },
-      "attribute": "customize-link-label",
+      "attribute": "customize-link-button-label",
       "reflect": false,
       "defaultValue": "\"Customize Link\""
     },
@@ -573,7 +577,7 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
@@ -603,7 +607,7 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
@@ -615,7 +619,7 @@ export class ShareLink {
       "reflect": false,
       "defaultValue": "\"Cancel\""
     },
-    "existingCodeConflictErrorTitle": {
+    "linkTakenErrorTitle": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -627,25 +631,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Existing code conflict error title",
+            "text": "Link taken error title",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Title text shown when the custom link is already taken"
+        "text": "Title of the error message shown when the link has already been taken"
       },
-      "attribute": "existing-code-conflict-error-title",
+      "attribute": "link-taken-error-title",
       "reflect": false,
       "defaultValue": "\"This link is already taken\""
     },
-    "existingCodeConflictErrorDescription": {
+    "linkTakenErrorDescription": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -657,21 +661,24 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Existing code conflict error description",
+            "text": "Link taken error message",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Description text shown when the custom link is already taken"
+        "text": "Description text shown when the link has already been taken"
       },
-      "attribute": "existing-code-conflict-error-description",
+      "attribute": "link-taken-error-description",
       "reflect": false,
       "defaultValue": "\"Try adding numbers, a dash or underscore to create a unique link.\""
     },
@@ -693,13 +700,13 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Title text shown when the link contains invalid characters"
+        "text": "Title of the error message shown when the link contains invalid special characters."
       },
       "attribute": "invalid-characters-error-title",
       "reflect": false,
@@ -723,19 +730,22 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Description text shown when the link contains invalid characters"
+        "text": "Description text shown when the link contains invalid special characters."
       },
       "attribute": "invalid-characters-error-description",
       "reflect": false,
       "defaultValue": "\"Special characters can break the link when sharing.\""
     },
-    "profanityErrorTitle": {
+    "restrictedWordsErrorTitle": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -747,25 +757,25 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Profanity error title",
+            "text": "Restricted words error title",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Title text shown when the link contains profanity"
+        "text": "Title of the error message shown when the link contains profanity or brand names."
       },
-      "attribute": "profanity-error-title",
+      "attribute": "restricted-words-error-title",
       "reflect": false,
       "defaultValue": "\"Please try a different link\""
     },
-    "profanityErrorDescription": {
+    "restrictedWordsErrorDescription": {
       "type": "string",
       "mutable": false,
       "complexType": {
@@ -777,21 +787,24 @@ export class ShareLink {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Profanity error description",
+            "text": "Restricted words error description",
             "name": "uiName"
           }, {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Description text shown when the link contains profanity"
+        "text": "Description text shown when the link contains profanity or brand names."
       },
-      "attribute": "profanity-error-description",
+      "attribute": "restricted-words-error-description",
       "reflect": false,
       "defaultValue": "\"This link contains a restricted word.\""
     },
@@ -813,17 +826,17 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Text describing the edit limit"
+        "text": "Subtext shown while the user is customizing their URL."
       },
       "attribute": "edit-limit-text",
       "reflect": false,
-      "defaultValue": "\"You can edit your link up to 5 times.\""
+      "defaultValue": "\"You can edit your link up to {editsRemaining} more times.\""
     },
     "editLimitReachedText": {
       "type": "string",
@@ -843,13 +856,16 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "textarea",
+            "name": "uiWidget"
+          }, {
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
             "name": "requiredFlavor"
           }],
-        "text": "Message shown when the edit limit has been reached. Use {supportLink} as a placeholder for the support link."
+        "text": "Message shown when the URL has been edited 5 times. To display a clickable link, use {supportLink} as a placeholder."
       },
       "attribute": "edit-limit-reached-text",
       "reflect": false,
@@ -873,7 +889,7 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
@@ -903,7 +919,7 @@ export class ShareLink {
             "text": "string",
             "name": "uiType"
           }, {
-            "text": "Customize Vanity Link",
+            "text": "Customizable Vanity Link",
             "name": "uiGroup"
           }, {
             "text": "impact",
@@ -920,7 +936,7 @@ export class ShareLink {
       "mutable": false,
       "complexType": {
         "original": "DemoData<ShareLinkViewProps>",
-        "resolved": "{ copyTextViewProps?: CopyTextViewProps; customizeUrl?: boolean; customizeLinkLabel?: string; saveLabelText?: string; cancelLabelText?: string; isEditing?: boolean; editValue?: string; domainPrefix?: string; editsRemaining?: number; maxEdits?: number; limitReached?: boolean; validationError?: ValidationErrorInfo; isValidating?: boolean; isSaving?: boolean; characterLimit?: number; minCharacters?: number; charactersRemaining?: number; editLimitText?: string; editLimitReachedText?: string; supportLinkText?: string; customizeDisabled?: boolean; customizeDisabledTooltip?: string; onCustomizeClick?: () => void; onEditValueChange?: (value: string) => void; onSave?: () => void; onCancel?: () => void; }",
+        "resolved": "{ copyTextViewProps?: CopyTextViewProps; allowCustomization?: boolean; customizeLinkLabel?: string; saveLabelText?: string; cancelLabelText?: string; isEditing?: boolean; editValue?: string; domainPrefix?: string; editsRemaining?: number; maxEdits?: number; limitReached?: boolean; validationError?: ValidationErrorInfo; isValidating?: boolean; isSaving?: boolean; characterLimit?: number; minCharacters?: number; charactersRemaining?: number; editLimitText?: string; editLimitReachedText?: string; supportLinkText?: string; customizeDisabled?: boolean; customizeDisabledTooltip?: string; onCustomizeClick?: () => void; onEditValueChange?: (value: string) => void; onSave?: () => void; onCancel?: () => void; }",
         "references": {
           "DemoData": {
             "location": "import",
@@ -944,6 +960,23 @@ export class ShareLink {
           }],
         "text": ""
       }
+    },
+    "editsRemaining": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "attribute": "edits-remaining",
+      "reflect": false
     }
   }; }
 }
@@ -973,8 +1006,8 @@ function useDemoShareLink(props) {
         setTimeout(() => setOpen(false), props.tooltiplifespan);
       },
     },
-    customizeUrl: props.customizeUrl,
-    customizeLinkLabel: props.customizeLinkLabel,
+    allowCustomization: props.allowCustomization,
+    customizeLinkLabel: props.customizeLinkButtonLabel,
     saveLabelText: props.saveLabelText,
     cancelLabelText: props.cancelLabelText,
     isEditing,

package/dist/collection/components/sqm-share-link/useShareLink.js

@@ -88,8 +88,8 @@ export function useShareLink(props) {
   const [addShareLinkCode, { loading: isSaving }] = useMutation(ADD_SHARE_LINK_CODE);
   const [validateLinkCode] = useLazyQuery(VALIDATE_LINK_CODE);
   const { refresh } = useRefreshDispatcher();
-  const { data: linkDomainData } = useQuery(GET_LINK_DOMAIN, {}, !(user === null || user === void 0 ? void 0 : user.jwt) || !props.customizeUrl);
-  const { data: editCountData, refetch: refetchEditCount } = useQuery(SHARE_LINK_EDIT_COUNT, {}, !(user === null || user === void 0 ? void 0 : user.jwt) || !props.customizeUrl);
+  const { data: linkDomainData } = useQuery(GET_LINK_DOMAIN, {}, !(user === null || user === void 0 ? void 0 : user.jwt) || !props.allowCustomization);
+  const { data: editCountData, refetch: refetchEditCount } = useQuery(SHARE_LINK_EDIT_COUNT, {}, !(user === null || user === void 0 ? void 0 : user.jwt) || !props.allowCustomization);
   const { url: copyString, domain: domainPrefix, path: pathSuffix, } = parseShareUrl((_b = ((contextData === null || contextData === void 0 ? void 0 : contextData.shareLink) || ((_a = data === null || data === void 0 ? void 0 : data.user) === null || _a === void 0 ? void 0 : _a.shareLink))) !== null && _b !== void 0 ? _b : 
   // Shown during loading
   "...");
@@ -111,8 +111,8 @@ export function useShareLink(props) {
     const errorMap = {
       EXISTING_CODE_CONFLICT: {
         code: "EXISTING_CODE_CONFLICT",
-        title: props.existingCodeConflictErrorTitle,
-        description: props.existingCodeConflictErrorDescription,
+        title: props.linkTakenErrorTitle,
+        description: props.linkTakenErrorDescription,
       },
       INVALID_CHARACTER: {
         code: "INVALID_CHARACTER",
@@ -121,8 +121,8 @@ export function useShareLink(props) {
       },
       BLOCKED_WORD: {
         code: "BLOCKED_WORD",
-        title: props.profanityErrorTitle,
-        description: props.profanityErrorDescription,
+        title: props.restrictedWordsErrorTitle,
+        description: props.restrictedWordsErrorDescription,
       },
     };
     return errorMap[errorCode];
@@ -229,8 +229,8 @@ export function useShareLink(props) {
       open,
       copyString,
     },
-    customizeUrl: props.customizeUrl,
-    customizeLinkLabel: props.customizeLinkLabel,
+    allowCustomization: props.allowCustomization,
+    customizeLinkLabel: props.customizeLinkButtonLabel,
     saveLabelText: props.saveLabelText,
     cancelLabelText: props.cancelLabelText,
     isEditing,