@saasquatch/mint-components 2.1.9-20 → 2.1.9-22

package/dist/collection/components/sqm-referral-iframe/ReferralIframe.stories.js

@@ -16,6 +16,7 @@ const props = {
       iframeSrc: "https://example.com",
       iframeHeight: "100%",
       iframeWidth: "100%",
+      codeParam: "rsCode",
     },
   },
 };

package/dist/collection/components/sqm-referral-iframe/sqm-referral-iframe-view.js

@@ -25,5 +25,5 @@ export function ReferralIframeView(props) {
   const styleString = sheet.toString();
   return (h("div", { class: sheet.classes.Container },
     h("style", { type: "text/css" }, styleString),
-    h("iframe", { class: sheet.classes.IFrame, src: `${content.iframeSrc}?rsCode=${data.shareCode}` })));
+    h("iframe", { class: sheet.classes.IFrame, src: `${content.iframeSrc}?${encodeURIComponent(content.codeParam)}=${data.shareCode}` })));
 }

package/dist/collection/components/sqm-referral-iframe/sqm-referral-iframe.js

@@ -22,6 +22,11 @@ export class SqmReferralIframe {
      * @uiName IFrame width
      */
     this.iframeWidth = "100%";
+    /**
+     * Override the default parameter name used in the iframe
+     * @uiName Referral code parameter name
+     */
+    this.codeParam = "rsCode";
     withHooks(this);
   }
   disconnectedCallback() { }
@@ -108,12 +113,33 @@ export class SqmReferralIframe {
       "reflect": false,
       "defaultValue": "\"100%\""
     },
+    "codeParam": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Referral code parameter name",
+            "name": "uiName"
+          }],
+        "text": "Override the default parameter name used in the iframe"
+      },
+      "attribute": "code-param",
+      "reflect": false,
+      "defaultValue": "\"rsCode\""
+    },
     "demoData": {
       "type": "unknown",
       "mutable": false,
       "complexType": {
         "original": "DemoData<ReferralIframeViewProps>",
-        "resolved": "{ states?: { content: { iframeSrc: string; iframeHeight: string; iframeWidth: string; }; }; data?: { shareCode: string; }; }",
+        "resolved": "{ states?: { content: { iframeSrc: string; iframeHeight: string; iframeWidth: string; codeParam: string; }; }; data?: { shareCode: string; }; }",
         "references": {
           "DemoData": {
             "location": "import",

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

@@ -415,7 +415,6 @@ function useDemoShareCode(props) {
     borderRadius: props.borderRadius,
     borderColor: props.borderColor,
     buttonType: props.buttonType,
-    rewardStatus: "AVAILABLE",
     open,
     onClick: () => {
       // Should well supported: https://developer.mozilla.org/en-US/docs/Web/API/Clipboard#browser_compatibility

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

@@ -1,5 +1,6 @@
 import { h } from "@stencil/core";
 import { CopyTextView } from "../views/copy-text-view";
+import { ShareLinkView } from "./sqm-share-link-view";
 import scenario from "./ShareLink.feature";
 export default {
   title: "Components/Share Link",
@@ -77,18 +78,138 @@ export const CustomStyles = () => {
   return h(CopyTextView, Object.assign({}, props));
 };
 export const CustomStylesWithDemoHooks = () => {
-  const props = {
-    copyString: "https://noah.example.com",
-    open: false,
-    tooltiptext: "Copied!",
-    backgroundColor: "#1ed760",
-    borderRadius: "30px",
-    textColor: "red",
-    buttonType: "primary",
-    borderColor: "#121212",
-  };
-  return (h("sqm-share-link", { demoData: { ...props }, backgroundColor: "#1ed760" }));
+  return (h("sqm-share-link", { demoData: {
+      copyTextViewProps: {
+        copyString: "https://noah.example.com",
+        open: false,
+        tooltiptext: "Copied!",
+        backgroundColor: "#1ed760",
+        borderRadius: "30px",
+        textColor: "red",
+        buttonType: "primary",
+        borderColor: "#121212",
+      },
+    }, backgroundColor: "#1ed760" }));
 };
 export const FullStack = () => {
   return h("sqm-share-link", null);
 };
+// Customize URL stories
+const noopFn = () => { };
+const defaultCustomizeProps = {
+  copyTextViewProps: {
+    copyString: "https://ssqt.co/abc123",
+    open: false,
+    tooltiptext: "Copied!",
+  },
+  allowCustomization: true,
+  customizeLinkLabel: "Customize Link",
+  saveLabelText: "Save",
+  cancelLabelText: "Cancel",
+  isEditing: false,
+  editValue: "",
+  domainPrefix: "https://ssqt.co/",
+  editsRemaining: 3,
+  maxEdits: 5,
+  limitReached: false,
+  validationError: null,
+  isValidating: false,
+  isSaving: false,
+  characterLimit: 15,
+  minCharacters: 3,
+  charactersRemaining: 15,
+  editLimitText: "You can edit your link up to 5 times.",
+  editLimitReachedText: "5 edit limit reached. To make more changes, please contact {supportLink}.",
+  supportLinkText: "Support",
+  customizeDisabled: false,
+  customizeDisabledTooltip: "Link customization is not available.",
+  minCharactersText: "Minimum 3 characters",
+  onCustomizeClick: noopFn,
+  onEditValueChange: noopFn,
+  onSave: noopFn,
+  onCancel: noopFn,
+};
+export const CustomizeUrlDefault = () => {
+  return h(ShareLinkView, Object.assign({}, defaultCustomizeProps));
+};
+export const CustomizeUrlEditing = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    isEditing: true,
+    editValue: "nvoiwb18",
+    charactersRemaining: 7,
+  })));
+};
+export const CustomizeUrlCustomized = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    copyTextViewProps: {
+      ...defaultCustomizeProps.copyTextViewProps,
+      copyString: "https://ssqt.co/bobtesterson",
+    },
+  })));
+};
+export const CustomizeUrlLimitReached = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    copyTextViewProps: {
+      ...defaultCustomizeProps.copyTextViewProps,
+      copyString: "https://ssqt.co/bobtesterson",
+    },
+    editsRemaining: 0,
+    limitReached: true,
+  })));
+};
+export const CustomizeUrlDisabled = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    customizeDisabled: true,
+  })));
+};
+export const CustomizeUrlValidationError = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    isEditing: true,
+    editValue: "nvoiwb18",
+    charactersRemaining: 7,
+    validationError: {
+      code: "EXISTING_CODE_CONFLICT",
+      title: "This link is already taken",
+      description: "Try adding numbers, a dash or underscore to create a unique link.",
+    },
+  })));
+};
+export const CustomizeUrlInvalidCharacters = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    isEditing: true,
+    editValue: "nvoiwb18",
+    charactersRemaining: 7,
+    validationError: {
+      code: "INVALID_CHARACTER",
+      title: "Please use only letters, numbers, dashes and underscores",
+      description: "Special characters can break the link when sharing.",
+    },
+  })));
+};
+export const CustomizeUrlProfanity = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    isEditing: true,
+    editValue: "nvoiwb18",
+    charactersRemaining: 7,
+    validationError: {
+      code: "BLOCKED_WORD",
+      title: "Please try a different link",
+      description: "This link contains a restricted word.",
+    },
+  })));
+};
+export const CustomizeUrlSaving = () => {
+  return (h(ShareLinkView, Object.assign({}, {
+    ...defaultCustomizeProps,
+    isEditing: true,
+    editValue: "bobtesterson",
+    isSaving: true,
+  })));
+};

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

@@ -1,7 +1,7 @@
 import { setUserIdentity } from "@saasquatch/component-boilerplate";
 import { useEffect } from "@saasquatch/universal-hooks";
 import { h } from "@stencil/core";
-import { CopyTextView } from "../views/copy-text-view";
+import { ShareLinkView } from "./sqm-share-link-view";
 import { useShareLink } from "./useShareLink";
 import { createHookStory } from "../sqm-stencilbook/HookStoryAddon";
 export default {
@@ -39,11 +39,11 @@ export const BareBonesView = createHookStory(() => {
   return (h("div", null,
     "Sharelink:",
     " ",
-    h("code", { style: { borderStyle: "solid", borderWidth: "1px", padding: "2px" } }, res.copyString)));
+    h("code", { style: { borderStyle: "solid", borderWidth: "1px", padding: "2px" } }, res.copyTextViewProps.copyString)));
 });
 export const RegularView = createHookStory(() => {
   setupGraphQL();
-  return (h(CopyTextView, Object.assign({}, useShareLink({
+  return (h(ShareLinkView, Object.assign({}, useShareLink({
     programId: "klip-referral-program",
     tooltiptext: "Copied to clipboard",
     tooltiplifespan: 1000,
@@ -51,9 +51,18 @@ export const RegularView = createHookStory(() => {
 });
 export const FastTooltip = createHookStory(() => {
   setupGraphQL();
-  return (h(CopyTextView, Object.assign({}, useShareLink({
+  return (h(ShareLinkView, Object.assign({}, useShareLink({
     programId: "klip-referral-program",
-    tooltiptext: "⠀⠀⠀⠀⠀⠀⠀⠀⠀HELLO THERE!!!\n⠀⠀⠀⡯⡯⡾⠝⠘⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢊⠘⡮⣣⠪⠢⡑⡌\n⠀⠀⠀⠟⠝⠈⠀⠀⠀⠡⠀⠠⢈⠠⢐⢠⢂⢔⣐⢄⡂⢔⠀⡁⢉⠸⢨⢑⠕⡌\n⠀⠀⡀⠁⠀⠀⠀⡀⢂⠡⠈⡔⣕⢮⣳⢯⣿⣻⣟⣯⣯⢷⣫⣆⡂⠀⠀⢐⠑⡌\n⢀⠠⠐⠈⠀⢀⢂⠢⡂⠕⡁⣝⢮⣳⢽⡽⣾⣻⣿⣯⡯⣟⣞⢾⢜⢆⠀⡀⠀⠪\n⣬⠂⠀⠀⢀⢂⢪⠨⢂⠥⣺⡪⣗⢗⣽⢽⡯⣿⣽⣷⢿⡽⡾⡽⣝⢎⠀⠀⠀⢡\n⣿⠀⠀⠀⢂⠢⢂⢥⢱⡹⣪⢞⡵⣻⡪⡯⡯⣟⡾⣿⣻⡽⣯⡻⣪⠧⠑⠀⠁⢐\n⣿⠀⠀⠀⠢⢑⠠⠑⠕⡝⡎⡗⡝⡎⣞⢽⡹⣕⢯⢻⠹⡹⢚⠝⡷⡽⡨⠀⠀⢔\n⣿⡯⠀⢈⠈⢄⠂⠂⠐⠀⠌⠠⢑⠱⡱⡱⡑⢔⠁⠀⡀⠐⠐⠐⡡⡹⣪⠀⠀⢘\n⣿⣽⠀⡀⡊⠀⠐⠨⠈⡁⠂⢈⠠⡱⡽⣷⡑⠁⠠⠑⠀⢉⢇⣤⢘⣪⢽⠀⢌⢎\n⣿⢾⠀⢌⠌⠀⡁⠢⠂⠐⡀⠀⢀⢳⢽⣽⡺⣨⢄⣑⢉⢃⢭⡲⣕⡭⣹⠠⢐⢗\n⣿⡗⠀⠢⠡⡱⡸⣔⢵⢱⢸⠈⠀⡪⣳⣳⢹⢜⡵⣱⢱⡱⣳⡹⣵⣻⢔⢅⢬⡷\n⣷⡇⡂⠡⡑⢕⢕⠕⡑⠡⢂⢊⢐⢕⡝⡮⡧⡳⣝⢴⡐⣁⠃⡫⡒⣕⢏⡮⣷⡟\n⣷⣻⣅⠑⢌⠢⠁⢐⠠⠑⡐⠐⠌⡪⠮⡫⠪⡪⡪⣺⢸⠰⠡⠠⠐⢱⠨⡪⡪⡰\n⣯⢷⣟⣇⡂⡂⡌⡀⠀⠁⡂⠅⠂⠀⡑⡄⢇⠇⢝⡨⡠⡁⢐⠠⢀⢪⡐⡜⡪⡊\n⣿⢽⡾⢹⡄⠕⡅⢇⠂⠑⣴⡬⣬⣬⣆⢮⣦⣷⣵⣷⡗⢃⢮⠱⡸⢰⢱⢸⢨⢌\n⣯⢯⣟⠸⣳⡅⠜⠔⡌⡐⠈⠻⠟⣿⢿⣿⣿⠿⡻⣃⠢⣱⡳⡱⡩⢢⠣⡃⠢⠁\n⡯⣟⣞⡇⡿⣽⡪⡘⡰⠨⢐⢀⠢⢢⢄⢤⣰⠼⡾⢕⢕⡵⣝⠎⢌⢪⠪⡘⡌⠀\n⡯⣳⠯⠚⢊⠡⡂⢂⠨⠊⠔⡑⠬⡸⣘⢬⢪⣪⡺⡼⣕⢯⢞⢕⢝⠎⢻⢼⣀⠀\n⠁⡂⠔⡁⡢⠣⢀⠢⠀⠅⠱⡐⡱⡘⡔⡕⡕⣲⡹⣎⡮⡏⡑⢜⢼⡱⢩⣗⣯⣟\n⢀⢂⢑⠀⡂⡃⠅⠊⢄⢑⠠⠑⢕⢕⢝⢮⢺⢕⢟⢮⢊⢢⢱⢄⠃⣇⣞⢞⣞⢾\n⢀⠢⡑⡀⢂⢊⠠⠁⡂⡐⠀⠅⡈⠪⠪⠪⠣⠫⠑⡁⢔⠕⣜⣜⢦⡰⡎⡯⡾⡽",
+    tooltiptext: "Copied to clipboard",
     tooltiplifespan: 500,
   }))));
 });
+export const CustomizeUrlEnabled = createHookStory(() => {
+  setupGraphQL();
+  return (h(ShareLinkView, Object.assign({}, useShareLink({
+    programId: "klip-referral-program",
+    tooltiptext: "Copied to clipboard",
+    tooltiplifespan: 1000,
+    allowCustomization: true,
+  }))));
+});

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

@@ -0,0 +1,192 @@
+import { h } from "@stencil/core";
+import { intl } from "../../global/global";
+import { createStyleSheet } from "../../styling/JSS";
+import { CopyTextView } from "../views/copy-text-view";
+const vanillaStyle = `
+  :host {
+    display: block;
+    width: 100%;
+  }
+`;
+export function ShareLinkView(props) {
+  const { copyTextViewProps, allowCustomization, customizeLinkLabel, saveLabelText, cancelLabelText, isEditing, editValue, domainPrefix, editsRemaining, maxEdits, limitReached, validationError, isValidating, isSaving, characterLimit, minCharacters, charactersRemaining, editLimitText, editLimitReachedText, supportLinkText, customizeDisabled, customizeDisabledTooltip, onCustomizeClick, onEditValueChange, onSave, onCancel, minCharactersText, } = props;
+  const style = {
+    Container: {
+      display: "flex",
+      flexDirection: "column",
+      gap: "var(--sl-spacing-xx-small)",
+      width: "100%",
+    },
+    CustomizeLinkText: {
+      paddingTop: "var(--sl-spacing-xx-small)",
+      margin: "0",
+      fontSize: "var(--sl-font-size-small)",
+      fontWeight: "600",
+      cursor: "pointer",
+      color: "var(--sl-color-neutral-900)",
+      textAlign: "left",
+      "&:hover": {
+        textDecoration: "underline",
+      },
+    },
+    CustomizeLinkDisabled: {
+      paddingTop: "var(--sl-spacing-xx-small)",
+      margin: "0",
+      fontSize: "var(--sl-font-size-small)",
+      fontWeight: "600",
+      color: "var(--sl-color-neutral-400)",
+      cursor: "default",
+      textAlign: "left",
+    },
+    EditContainer: {
+      display: "flex",
+      flexDirection: "column",
+      gap: "var(--sl-spacing-x-small)",
+      width: "100%",
+    },
+    EditInputWrapper: {
+      display: "flex",
+      alignItems: "center",
+      width: "100%",
+      border: "var(--sqm-border-thickness, 1px) solid var(--sqm-input-border-color, #d1d5db)",
+      borderRadius: "var(--sqm-border-radius-normal, 4px)",
+      background: "var(--sqm-input-background, #fff)",
+      overflow: "hidden",
+      "&:focus-within": {
+        borderColor: "#999999",
+        boxShadow: "0 0 0 var(--sl-focus-ring-width) var(--sl-input-focus-ring-color)",
+      },
+    },
+    DomainPrefix: {
+      padding: "0 0 0 var(--sl-spacing-medium)",
+      fontSize: "var(--sl-font-size-medium)",
+      color: "var(--sl-color-neutral-500)",
+      whiteSpace: "nowrap",
+      userSelect: "none",
+      lineHeight: "var(--sl-input-height-medium)",
+    },
+    EditInput: {
+      flex: "1",
+      border: "none",
+      outline: "none",
+      padding: "0 var(--sl-spacing-medium) 0 0",
+      fontSize: "var(--sl-font-size-medium)",
+      fontFamily: "var(--sl-font-sans)",
+      color: "var(--sl-input-color)",
+      background: "transparent",
+      lineHeight: "var(--sl-input-height-medium)",
+      minWidth: "0",
+    },
+    EditLabel: {
+      margin: "0",
+      fontSize: "var(--sl-font-size-small)",
+      color: "var(--sl-color-neutral-500)",
+    },
+    HelperText: {
+      paddingTop: "var(--sl-spacing-xx-small)",
+      margin: "0",
+      fontSize: "var(--sl-font-size-small)",
+      color: "var(--sl-color-neutral-500)",
+    },
+    ErrorText: {
+      margin: "0",
+      fontSize: "var(--sl-font-size-small)",
+      color: "var(--sqm-danger-color-text, #dc2626)",
+    },
+    ActionRow: {
+      display: "flex",
+      gap: "var(--sl-spacing-medium)",
+      alignItems: "center",
+    },
+    SaveButton: {
+      cursor: "pointer",
+      fontFamily: "var(--sl-font-sans)",
+      fontSize: "var(--sl-font-size-small)",
+      fontWeight: "600",
+      padding: "var(--sl-spacing-x-small) var(--sl-spacing-medium)",
+      borderRadius: "var(--sqm-border-radius-normal, 4px)",
+      border: "1px solid var(--sl-color-neutral-900)",
+      background: "var(--sl-color-neutral-900)",
+      color: "#fff",
+      "&:disabled": {
+        opacity: "0.5",
+        cursor: "default",
+      },
+    },
+    CancelButton: {
+      margin: "0",
+      fontSize: "var(--sl-font-size-small)",
+      fontWeight: "600",
+      cursor: "pointer",
+      background: "none",
+      border: "none",
+      fontFamily: "var(--sl-font-sans)",
+      color: "var(--sl-color-neutral-500)",
+      "&::part(label)": {
+        padding: "0",
+      },
+    },
+    LimitReachedContainer: {
+      display: "flex",
+      alignItems: "center",
+      gap: "var(--sl-spacing-x-small)",
+    },
+  };
+  const sheet = createStyleSheet(style);
+  const styleString = sheet.toString();
+  const errorMessageType = (validationError === null || validationError === void 0 ? void 0 : validationError.code) === "EXISTING_CODE_CONFLICT" ? "info" : "warning";
+  const showCharactersRemaining = charactersRemaining <= 14;
+  const editLimitMessage = intl.formatMessage({
+    id: "editLimitText",
+    defaultMessage: editLimitText,
+  }, { editsRemaining });
+  // Editing state
+  if (isEditing) {
+    return (h("div", { class: sheet.classes.Container },
+      h("style", { type: "text/css" },
+        styleString,
+        vanillaStyle),
+      h("p", { class: sheet.classes.EditLabel }, "Enter your link"),
+      h("div", { class: sheet.classes.EditInputWrapper },
+        h("span", { class: sheet.classes.DomainPrefix }, domainPrefix),
+        h("input", { class: sheet.classes.EditInput, type: "text", value: editValue, onInput: (e) => onEditValueChange(e.target.value), onKeyDown: (e) => {
+            if (e.key === "/" || e.key === "@")
+              e.preventDefault();
+          }, disabled: isSaving, maxLength: characterLimit })),
+      h("p", { class: sheet.classes.HelperText },
+        editLimitMessage,
+        " ",
+        charactersRemaining > 12 && minCharactersText,
+        showCharactersRemaining &&
+          ` Characters remaining: ${charactersRemaining}`),
+      validationError && (h("sqm-form-message", { type: errorMessageType, style: { paddingBottom: "var(--sl-spacing-xx-small)" } },
+        h("p", { part: "alert-title" }, validationError.title),
+        validationError.description)),
+      isValidating && h("p", { class: sheet.classes.HelperText }, "Validating..."),
+      h("div", { class: sheet.classes.ActionRow },
+        h("button", { class: sheet.classes.SaveButton, onClick: onSave, disabled: isSaving ||
+            isValidating ||
+            !!validationError ||
+            !editValue ||
+            editValue.length < minCharacters }, isSaving ? "Saving..." : saveLabelText),
+        h("sl-button", { type: "text", class: sheet.classes.CancelButton, onClick: onCancel, disabled: isSaving }, cancelLabelText))));
+  }
+  // Default / Customized / Limit reached states
+  return (h("div", { class: sheet.classes.Container },
+    h("style", { type: "text/css" },
+      styleString,
+      vanillaStyle),
+    h(CopyTextView, Object.assign({}, copyTextViewProps)),
+    allowCustomization &&
+      (customizeDisabled ? (h("sl-tooltip", { content: customizeDisabledTooltip, placement: "top", style: { display: "inline-block", width: "fit-content" } },
+        h("p", { class: sheet.classes.CustomizeLinkDisabled }, customizeLinkLabel))) : (h("div", { class: sheet.classes.LimitReachedContainer },
+        h("p", { class: limitReached
+            ? sheet.classes.CustomizeLinkDisabled
+            : sheet.classes.CustomizeLinkText, onClick: limitReached ? undefined : onCustomizeClick }, customizeLinkLabel),
+        allowCustomization && limitReached && (h("p", { class: sheet.classes.HelperText }, intl.formatMessage({
+          id: "editLimitReached",
+          defaultMessage: editLimitReachedText,
+        }, {
+          supportLink: (h("a", { target: "_blank", href: "https://help.impact.com/other/readme/get-help-and-support" }, supportLinkText)),
+        }))))))));
+}