@saasquatch/mint-components 2.1.8-2 → 2.1.8-4

package/dist/types/components/sqm-referral-iframe/sqm-referral-iframe-view.d.ts

@@ -4,7 +4,6 @@ export declare type ReferralIframeViewProps = {
       iframeSrc: string;
       iframeHeight: string;
       iframeWidth: string;
-      codeParam: string;
     };
   };
   data: {

package/dist/types/components/sqm-referral-iframe/sqm-referral-iframe.d.ts

@@ -21,11 +21,6 @@ export declare class SqmReferralIframe {
    * @uiName IFrame width
    */
   iframeWidth: string;
-  /**
-   * Override the default parameter name used in the iframe
-   * @uiName Referral code parameter name
-   */
-  codeParam: string;
   /**
    * @undocumented
    * @uiType object

package/dist/types/components/sqm-share-link/ShareLink.stories.d.ts

@@ -16,3 +16,13 @@ export declare const CopyButtonBelow: () => any;
 export declare const CustomStyles: () => any;
 export declare const CustomStylesWithDemoHooks: () => any;
 export declare const FullStack: () => any;
+export declare const CustomizeUrlDefault: () => any;
+export declare const CustomizeUrlEditing: () => any;
+export declare const CustomizeUrlCustomized: () => any;
+export declare const CustomizeUrlLimitReached: () => any;
+export declare const CustomizeUrlDisabled: () => any;
+export declare const CustomizeUrlValidationError: () => any;
+export declare const CustomizeUrlInvalidSymbols: () => any;
+export declare const CustomizeUrlRestrictedWord: () => any;
+export declare const CustomizeUrlSaving: () => any;
+export declare const CustomizeUrlSuccess: () => any;

package/dist/types/components/sqm-share-link/UseShareLink.stories.d.ts

@@ -20,3 +20,9 @@ export declare const FastTooltip: {
     hookStory: Function;
   };
 };
+export declare const CustomizeUrlEnabled: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};

package/dist/types/components/sqm-share-link/sqm-share-link-view.d.ts

@@ -0,0 +1,37 @@
+import { CopyTextViewProps } from "../views/copy-text-view";
+export declare type ValidationErrorCode = "LINK_TAKEN" | "INVALID_SYMBOLS" | "RESTRICTED_WORD" | null;
+export interface ValidationErrorInfo {
+  code: ValidationErrorCode;
+  title: string;
+  description: string;
+}
+export interface ShareLinkViewProps {
+  copyTextViewProps: CopyTextViewProps;
+  customizeUrl: boolean;
+  customizeLinkLabel: string;
+  saveLabelText: string;
+  cancelLabelText: string;
+  successMessage: string;
+  isEditing: boolean;
+  editValue: string;
+  domainPrefix: string;
+  editsRemaining: number;
+  maxEdits: number;
+  limitReached: boolean;
+  validationError: ValidationErrorInfo | null;
+  isValidating: boolean;
+  isSaving: boolean;
+  showSuccess: boolean;
+  characterLimit: number;
+  charactersRemaining: number;
+  editLimitText: string;
+  editLimitReachedText: string;
+  supportLinkText: string;
+  customizeDisabled: boolean;
+  customizeDisabledTooltip: string;
+  onCustomizeClick: () => void;
+  onEditValueChange: (value: string) => void;
+  onSave: () => void;
+  onCancel: () => void;
+}
+export declare function ShareLinkView(props: ShareLinkViewProps): any;

package/dist/types/components/sqm-share-link/sqm-share-link.d.ts

@@ -1,5 +1,5 @@
 import { DemoData } from "../../global/demo";
-import { CopyTextViewProps } from "../views/copy-text-view";
+import { ShareLinkViewProps } from "./sqm-share-link-view";
 /**
  * @uiName Share Link
  * @exampleGroup Sharing
@@ -90,11 +90,116 @@ export declare class ShareLink {
    * @uiGroup Style
    */
   buttonStyle?: "icon" | "button-outside" | "button-below";
+  /**
+   * Enable users to customize their referral link
+   *
+   * @uiName Customize URL
+   * @uiType boolean
+   */
+  customizeUrl?: boolean;
+  /**
+   * Text shown below the share link input to trigger customization
+   *
+   * @uiName Customize link label
+   * @uiType string
+   */
+  customizeLinkLabel?: string;
+  /**
+   * Text for the save button in editing mode
+   *
+   * @uiName Save button label
+   * @uiType string
+   */
+  saveLabelText?: string;
+  /**
+   * Text for the cancel button in editing mode
+   *
+   * @uiName Cancel button label
+   * @uiType string
+   */
+  cancelLabelText?: string;
+  /**
+   * Message shown briefly after successfully saving a custom link
+   *
+   * @uiName Success message
+   * @uiType string
+   */
+  successMessage?: string;
+  /**
+   * Title text shown when the custom link is already taken
+   *
+   * @uiName Link taken error title
+   * @uiType string
+   */
+  linkTakenErrorTitle?: string;
+  /**
+   * Description text shown when the custom link is already taken
+   *
+   * @uiName Link taken error description
+   * @uiType string
+   */
+  linkTakenErrorDescription?: string;
+  /**
+   * Title text shown when the link contains invalid symbols
+   *
+   * @uiName Invalid symbols error title
+   * @uiType string
+   */
+  invalidSymbolsErrorTitle?: string;
+  /**
+   * Description text shown when the link contains invalid symbols
+   *
+   * @uiName Invalid symbols error description
+   * @uiType string
+   */
+  invalidSymbolsErrorDescription?: string;
+  /**
+   * Title text shown when the link contains a restricted word
+   *
+   * @uiName Restricted word error title
+   * @uiType string
+   */
+  restrictedWordErrorTitle?: string;
+  /**
+   * Description text shown when the link contains a restricted word
+   *
+   * @uiName Restricted word error description
+   * @uiType string
+   */
+  restrictedWordErrorDescription?: string;
+  /**
+   * Text describing the edit limit
+   *
+   * @uiName Edit limit text
+   * @uiType string
+   */
+  editLimitText?: string;
+  /**
+   * 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;
+  /**
+   * Display text for the support link in the edit limit reached message
+   *
+   * @uiName Support link text
+   * @uiType string
+   */
+  supportLinkText?: string;
+  /**
+   * Tooltip text shown when link customization is disabled
+   *
+   * @uiName Customize disabled tooltip
+   * @uiType string
+   */
+  customizeDisabledTooltip?: string;
   /**
    * @undocumented
    * @uiType object
    */
-  demoData?: DemoData<CopyTextViewProps>;
+  demoData?: DemoData<ShareLinkViewProps>;
   constructor();
   disconnectedCallback(): void;
   render(): any;

package/dist/types/components/sqm-share-link/useShareLink.d.ts

@@ -1,9 +1,32 @@
-import { CopyTextViewProps } from "../views/copy-text-view";
-interface ShareLinkProps {
+import { ShareLinkViewProps } from "./sqm-share-link-view";
+export interface ShareLinkProps {
   programId?: string;
   tooltiptext: string;
   tooltiplifespan: number;
   linkOverride?: string;
+  customizeUrl?: boolean;
+  customizeUrlText?: string;
+  customizeLinkLabel?: string;
+  saveLabelText?: string;
+  cancelLabelText?: string;
+  successMessage?: string;
+  textAlign?: "left" | "center" | "right";
+  buttonStyle?: "icon" | "button-outside" | "button-below";
+  backgroundColor?: string;
+  textColor?: string;
+  borderRadius?: string;
+  buttonType?: "primary" | "secondary";
+  copyButtonLabel?: string;
+  borderColor?: string;
+  linkTakenErrorTitle?: string;
+  linkTakenErrorDescription?: string;
+  invalidSymbolsErrorTitle?: string;
+  invalidSymbolsErrorDescription?: string;
+  restrictedWordErrorTitle?: string;
+  restrictedWordErrorDescription?: string;
+  editLimitText?: string;
+  editLimitReachedText?: string;
+  supportLinkText?: string;
+  customizeDisabledTooltip?: string;
 }
-export declare function useShareLink(props: ShareLinkProps): CopyTextViewProps;
-export {};
+export declare function useShareLink(props: ShareLinkProps): ShareLinkViewProps;

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";
@@ -3879,11 +3880,6 @@ 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
@@ -4934,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 link contains invalid symbols
+          * @uiName Invalid symbols error description
+          * @uiType string
+         */
+        "invalidSymbolsErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains invalid symbols
+          * @uiName Invalid symbols error title
+          * @uiType string
+         */
+        "invalidSymbolsErrorTitle"?: string;
+        /**
+          * Description text shown when the custom link is already taken
+          * @uiName Link taken error description
+          * @uiType string
+         */
+        "linkTakenErrorDescription"?: string;
+        /**
+          * Title text shown when the custom link is already taken
+          * @uiName Link taken error title
+          * @uiType string
+         */
+        "linkTakenErrorTitle"?: 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 a restricted word
+          * @uiName Restricted word error description
+          * @uiType string
+         */
+        "restrictedWordErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains a restricted word
+          * @uiName Restricted word error title
+          * @uiType string
+         */
+        "restrictedWordErrorTitle"?: 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
@@ -11801,11 +11887,6 @@ 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
@@ -12832,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 link contains invalid symbols
+          * @uiName Invalid symbols error description
+          * @uiType string
+         */
+        "invalidSymbolsErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains invalid symbols
+          * @uiName Invalid symbols error title
+          * @uiType string
+         */
+        "invalidSymbolsErrorTitle"?: string;
+        /**
+          * Description text shown when the custom link is already taken
+          * @uiName Link taken error description
+          * @uiType string
+         */
+        "linkTakenErrorDescription"?: string;
+        /**
+          * Title text shown when the custom link is already taken
+          * @uiName Link taken error title
+          * @uiType string
+         */
+        "linkTakenErrorTitle"?: 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 a restricted word
+          * @uiName Restricted word error description
+          * @uiType string
+         */
+        "restrictedWordErrorDescription"?: string;
+        /**
+          * Title text shown when the link contains a restricted word
+          * @uiName Restricted word error title
+          * @uiType string
+         */
+        "restrictedWordErrorTitle"?: 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