@saasquatch/mint-components 1.5.6-2 → 1.6.0-0

package/dist/collection/components/sqm-leaderboard/sqm-leaderboard.js

@@ -7,9 +7,6 @@ import { LeaderboardView } from "./sqm-leaderboard-view";
 import { useLeaderboard } from "./useLeaderboard";
 /**
  * @uiName Leaderboard
- * @example Referral Converted Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topConvertedReferrers" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" > </sqm-empty></sqm-leaderboard>
- * @example Referral Started Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topStartedReferrers" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" > </sqm-empty></sqm-leaderboard>
- * @example Point Earners Leaderboard - <sqm-leaderboard usersheading="Users" statsheading="Points Earned" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topPointEarners" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to earn points and reach the top of the leaderboard" ></sqm-empty></sqm-leaderboard>
  */
 export class Leaderboard {
   constructor() {
@@ -20,8 +17,9 @@ export class Leaderboard {
      */
     this.hideViewer = false;
     /**
-     * Title displayed for users without names
-     * @uiName Unknown User Text
+     * Text displayed for users without names in the leaderboard
+     *
+     * @uiName Anonymous User Name
      */
     this.anonymousUser = "Anonymous User";
     /**
@@ -152,7 +150,7 @@ export class Leaderboard {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Show Leaderboard Rank",
+            "text": "Show Rank Column",
             "name": "uiName"
           }],
         "text": ""
@@ -251,10 +249,10 @@ export class Leaderboard {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Unknown User Text",
+            "text": "Anonymous User Name",
             "name": "uiName"
           }],
-        "text": "Title displayed for users without names"
+        "text": "Text displayed for users without names in the leaderboard"
       },
       "attribute": "anonymous-user",
       "reflect": false,
@@ -279,9 +277,9 @@ export class Leaderboard {
             "name": "uiWidget"
           }, {
             "text": "{\"allowPastDates\":true, \"months\": 1}",
-            "name": "uiWidgetOptions"
+            "name": "uiOptions"
           }],
-        "text": ""
+        "text": "Only count leaderboard activity within a given interval"
       },
       "attribute": "interval",
       "reflect": false

package/dist/collection/components/sqm-leaderboard-rank/sqm-leaderboard-rank.js

@@ -44,7 +44,7 @@ export class LeaderboardRank {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Default Rank",
+            "text": "Default rank",
             "name": "uiName"
           }, {
             "text": "string",
@@ -94,7 +94,7 @@ export class LeaderboardRank {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Leaderboard Type",
+            "text": "Leaderboard type",
             "name": "uiName"
           }, {
             "text": "string",
@@ -143,14 +143,14 @@ export class LeaderboardRank {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Leaderboard Time Interval",
+            "text": "Leaderboard time interval",
             "name": "uiName"
           }, {
             "text": "DateRange",
             "name": "uiWidget"
           }, {
             "text": "{\"allowPastDates\":true, \"months\": 1}",
-            "name": "uiWidgetOptions"
+            "name": "uiOptions"
           }],
         "text": ""
       },

package/dist/collection/components/sqm-name-fields/sqm-name-fields.js

@@ -11,11 +11,11 @@ export class NameFields {
   constructor() {
     this.ignored = true;
     /**
-     * @uiName First Name label
+     * @uiName First name field label
      */
     this.firstNameLabel = "First Name";
     /**
-     * @uiName Last Name label
+     * @uiName Last name field label
      */
     this.lastNameLabel = "Last Name";
     withHooks(this);
@@ -39,7 +39,7 @@ export class NameFields {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "First Name label",
+            "text": "First name field label",
             "name": "uiName"
           }],
         "text": ""
@@ -60,7 +60,7 @@ export class NameFields {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Last Name label",
+            "text": "Last name field label",
             "name": "uiName"
           }],
         "text": ""

package/dist/collection/components/sqm-navigation-menu/sqm-navigation-menu.js

@@ -42,7 +42,7 @@ export class NavigationMenu {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Include Dropdown Menu",
+            "text": "Include dropdown menu",
             "name": "uiName"
           }],
         "text": ""
@@ -62,10 +62,10 @@ export class NavigationMenu {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Menu Label",
+            "text": "Label on the header menu",
             "name": "uiName"
           }],
-        "text": "Label on the header menu"
+        "text": ""
       },
       "attribute": "menu-label",
       "reflect": false

package/dist/collection/components/sqm-navigation-sidebar/sqm-navigation-sidebar.js

@@ -2,7 +2,7 @@ import { withHooks } from "@saasquatch/stencil-hooks";
 import { Component, h, State } from "@stencil/core";
 import { NavigationSidebarView } from "./sqm-navigation-sidebar-view";
 /**
- * A container for navigation menu items
+ * A holder for navigation menu items
  *
  * @uiName Navigation Sidebar
  */

package/dist/collection/components/sqm-navigation-sidebar-item/sqm-navigation-sidebar-item.js

@@ -34,7 +34,7 @@ export class NavigationSidebarItem {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Navigation Path",
+            "text": "Navigation path",
             "name": "uiName"
           }],
         "text": ""

package/dist/collection/components/sqm-password-field/sqm-password-field.js

@@ -13,14 +13,11 @@ export class PortalPasswordField {
   constructor() {
     this.ignored = true;
     /**
-     * Label for password field
-     *
-     * @uiName Password Label
+     * @uiName Label for password field
      */
     this.fieldLabel = "Password";
     /**
-     * Enable live password validation
-     * @uiName Enable Validation
+     * @uiName Enable live password validation
      */
     this.enableValidation = true;
     withHooks(this);
@@ -46,10 +43,10 @@ export class PortalPasswordField {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password Label",
+            "text": "Label for password field",
             "name": "uiName"
           }],
-        "text": "Label for password field"
+        "text": ""
       },
       "attribute": "field-label",
       "reflect": false,
@@ -67,10 +64,10 @@ export class PortalPasswordField {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Enable Validation",
+            "text": "Enable live password validation",
             "name": "uiName"
           }],
-        "text": "Enable live password validation"
+        "text": ""
       },
       "attribute": "enable-validation",
       "reflect": false,

package/dist/collection/components/sqm-popup-container/sqm-popup-container.js

@@ -4,7 +4,7 @@ import { withHooks } from "@saasquatch/stencil-hooks";
 import { usePopupContainer } from "./usePopupContainer";
 import { getProps } from "../../utils/utils";
 /**
- * @uiName Popup Container For Widgets
+ * @uiName Popup container for widgets
  */
 export class PopupContainer {
   constructor() {
@@ -35,10 +35,10 @@ export class PopupContainer {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Show Powered By",
+            "text": "Show SaaSquatch Powered By messaging",
             "name": "uiName"
           }],
-        "text": "Show Powered By SaaSquatch link"
+        "text": ""
       },
       "attribute": "powered-by",
       "reflect": false
@@ -55,10 +55,10 @@ export class PopupContainer {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Show Close Button",
+            "text": "Display a close button on the popup",
             "name": "uiName"
           }],
-        "text": "Display a close button on the popup"
+        "text": ""
       },
       "attribute": "close-button",
       "reflect": false
@@ -75,10 +75,10 @@ export class PopupContainer {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Close Button Text",
+            "text": "Text to be used as the close button",
             "name": "uiName"
           }],
-        "text": "Text inside the close button"
+        "text": ""
       },
       "attribute": "close-button-text",
       "reflect": false
@@ -95,7 +95,7 @@ export class PopupContainer {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Embed Padding",
+            "text": "Specify padding on the popup contents when in embedded mode",
             "name": "uiName"
           }, {
             "text": "string",
@@ -107,7 +107,7 @@ export class PopupContainer {
             "text": "[\"None\", \"Small\", \"Medium\", \"Large\"]",
             "name": "uiEnumNames"
           }],
-        "text": "Specify padding on the popup contents when in embedded mode"
+        "text": ""
       },
       "attribute": "embed-padding",
       "reflect": false
@@ -124,7 +124,7 @@ export class PopupContainer {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Popup Padding",
+            "text": "Specify padding on the popup contents when in popup mode",
             "name": "uiName"
           }, {
             "text": "string",
@@ -136,7 +136,7 @@ export class PopupContainer {
             "text": "[\"None\", \"Small\", \"Medium\", \"Large\"]",
             "name": "uiEnumNames"
           }],
-        "text": "Specify padding on the popup contents when in popup mode"
+        "text": ""
       },
       "attribute": "popup-padding",
       "reflect": false

package/dist/collection/components/sqm-portal-change-password/sqm-portal-change-password.js

@@ -11,47 +11,35 @@ export class PortalChangePassword {
   constructor() {
     this.ignored = true;
     /**
-     * @uiName Change Password Modal Header
+     * @uiName Change password modal header
      */
     this.modalChangePasswordHeader = "Change Password";
     /**
-     * Modal cancel button text
-     *
-     * @uiName Cancel Button Text
+     * @uiName Modal cancel password change button text
      */
     this.cancelText = "Cancel";
     /**
-     * Modal change password button text
-     *
-     * @uiName Change Password Button Text
+     * @uiName Modal change password button text
      */
     this.changePasswordButtonText = "Change Password";
     /**
-     * Password input field label
-     *
-     * @uiName Password Label
+     * @uiName Password input field label
      */
     this.passwordFieldLabel = "New Password";
     /**
-     * Password confirmation input field label
-     *
-     * @uiName Confirm Password Label
+     * @uiName Password confirmation input field label
      */
     this.confirmPasswordFieldLabel = "Confirm New Password";
     /**
-     * Successful password change message
-     *
-     * @uiName Successful Message
+     * @uiName Successful password change message
      */
     this.successMessage = "Your password has been updated.";
     /**
-     * Portal change password section header
-     *
-     * @uiName Change Password Header
+     * @uiName Portal change password section header
      */
     this.portalChangePasswordHeader = "Password";
     /**
-     * @uiName Change Password Button Text
+     * @uiName Portal change password button text
      */
     this.portalChangePasswordButtonText = "Change your password...";
     withHooks(this);
@@ -78,7 +66,7 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Change Password Modal Header",
+            "text": "Change password modal header",
             "name": "uiName"
           }],
         "text": ""
@@ -99,10 +87,10 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Cancel Button Text",
+            "text": "Modal cancel password change button text",
             "name": "uiName"
           }],
-        "text": "Modal cancel button text"
+        "text": ""
       },
       "attribute": "cancel-text",
       "reflect": false,
@@ -120,10 +108,10 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Change Password Button Text",
+            "text": "Modal change password button text",
             "name": "uiName"
           }],
-        "text": "Modal change password button text"
+        "text": ""
       },
       "attribute": "change-password-button-text",
       "reflect": false,
@@ -141,10 +129,10 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password Label",
+            "text": "Password input field label",
             "name": "uiName"
           }],
-        "text": "Password input field label"
+        "text": ""
       },
       "attribute": "password-field-label",
       "reflect": false,
@@ -162,10 +150,10 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Confirm Password Label",
+            "text": "Password confirmation input field label",
             "name": "uiName"
           }],
-        "text": "Password confirmation input field label"
+        "text": ""
       },
       "attribute": "confirm-password-field-label",
       "reflect": false,
@@ -183,10 +171,10 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Successful Message",
+            "text": "Successful password change message",
             "name": "uiName"
           }],
-        "text": "Successful password change message"
+        "text": ""
       },
       "attribute": "success-message",
       "reflect": false,
@@ -204,10 +192,10 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Change Password Header",
+            "text": "Portal change password section header",
             "name": "uiName"
           }],
-        "text": "Portal change password section header"
+        "text": ""
       },
       "attribute": "portal-change-password-header",
       "reflect": false,
@@ -225,7 +213,7 @@ export class PortalChangePassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Change Password Button Text",
+            "text": "Portal change password button text",
             "name": "uiName"
           }],
         "text": ""

package/dist/collection/components/sqm-portal-change-password/usePortalChangePassword.js

@@ -2,7 +2,7 @@ import { useEffect, useState } from "@saasquatch/universal-hooks";
 import jsonpointer from "jsonpointer";
 import { useChangePasswordMutation, useUserIdentity, } from "@saasquatch/component-boilerplate";
 export function usePortalChangePassword(props) {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e, _f, _g, _h;
   const [request, { loading, errors, data }] = useChangePasswordMutation();
   const [open, setOpen] = useState(false);
   const [error, setError] = useState("");
@@ -40,7 +40,7 @@ export function usePortalChangePassword(props) {
       open,
       loading,
       success,
-      error: error || ((_d = (_c = (_b = errors === null || errors === void 0 ? void 0 : errors.response) === null || _b === void 0 ? void 0 : _b.errors) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.message),
+      error: error || ((_e = (_d = (_c = (_b = errors === null || errors === void 0 ? void 0 : errors.response) === null || _b === void 0 ? void 0 : _b.errors) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.extensions) === null || _e === void 0 ? void 0 : _e.message) || ((_h = (_g = (_f = errors === null || errors === void 0 ? void 0 : errors.response) === null || _f === void 0 ? void 0 : _f.errors) === null || _g === void 0 ? void 0 : _g[0]) === null || _h === void 0 ? void 0 : _h.message),
       content: {
         modalChangePasswordHeader: props.modalChangePasswordHeader,
         cancelText: props.cancelText,

package/dist/collection/components/sqm-portal-container/sqm-portal-container.js

@@ -4,7 +4,6 @@ import { PortalContainerView } from "./sqm-portal-container-view";
 import { getProps } from "../../utils/utils";
 /**
  * @uiName Portal Container
- * @slots [{"name":"","title":"Widget Content"}]
  */
 export class PortalContainer {
   constructor() {
@@ -155,7 +154,7 @@ export class PortalContainer {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Minimum Width",
+            "text": "Minimum width",
             "name": "uiName"
           }],
         "text": ""
@@ -205,7 +204,7 @@ export class PortalContainer {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Justify Content",
+            "text": "Justify content",
             "name": "uiName"
           }, {
             "text": "string",
@@ -217,7 +216,7 @@ export class PortalContainer {
             "text": "[\"Start\", \"Center\", \"End\", \"Space Between\", \"Space Around\", \"Space Evenly\"]",
             "name": "uiEnumNames"
           }],
-        "text": "Defines how the container distributes space between & around content items along the main-axis of a flex container"
+        "text": ""
       },
       "attribute": "justify-content",
       "reflect": false
@@ -255,7 +254,7 @@ export class PortalContainer {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Center Content",
+            "text": "Center content",
             "name": "uiName"
           }],
         "text": ""

package/dist/collection/components/sqm-portal-email-verification/sqm-portal-email-verification.js

@@ -13,19 +13,19 @@ export class PortalEmailVerification {
     /**
      * The page that users are redirected to from the verification email.
      *
-     * @uiName Email Redirection Base Path
+     * @uiName Email redirection base path
      */
     this.redirectPath = "/verifyEmail";
     /**
-     * @uiName Email Verification Header Text
+     * @uiName Email verification header text
      */
     this.emailVerificationHeader = "Verify your email";
     /**
-     * @uiName Re-send Email Button Text
+     * @uiName Re-send email button text
      */
     this.resendEmailButtonText = "Re-send Email";
     /**
-     * @uiName Email Verification Body Text
+     * @uiName Email verification body text
      */
     this.verifyMessage = "A verification email was sent to {email}. Please verify your email to continue to the portal.";
     withHooks(this);
@@ -52,7 +52,7 @@ export class PortalEmailVerification {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Redirection Base Path",
+            "text": "Email redirection base path",
             "name": "uiName"
           }],
         "text": "The page that users are redirected to from the verification email."
@@ -73,7 +73,7 @@ export class PortalEmailVerification {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Verification Header Text",
+            "text": "Email verification header text",
             "name": "uiName"
           }],
         "text": ""
@@ -94,7 +94,7 @@ export class PortalEmailVerification {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Re-send Email Button Text",
+            "text": "Re-send email button text",
             "name": "uiName"
           }],
         "text": ""
@@ -115,7 +115,7 @@ export class PortalEmailVerification {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Verification Body Text",
+            "text": "Email verification body text",
             "name": "uiName"
           }],
         "text": ""

package/dist/collection/components/sqm-portal-email-verification/usePortalEmailVerification.js

@@ -1,7 +1,7 @@
 import { useEffect, useState } from "@saasquatch/universal-hooks";
 import { useUserIdentity, useRequestVerificationEmailMutation, } from "@saasquatch/component-boilerplate";
 export function usePortalEmailVerification(props) {
-  var _a, _b, _c, _d, _e;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
   const [request, { loading, data, errors }] = useRequestVerificationEmailMutation();
   const userIdent = useUserIdentity();
   const email = (_a = userIdent === null || userIdent === void 0 ? void 0 : userIdent.managedIdentity) === null || _a === void 0 ? void 0 : _a.email;
@@ -32,7 +32,8 @@ export function usePortalEmailVerification(props) {
   return {
     states: {
       loading,
-      error: ((_e = (_d = (_c = errors === null || errors === void 0 ? void 0 : errors.response) === null || _c === void 0 ? void 0 : _c.errors) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.message) || error,
+      error: ((_f = (_e = (_d = (_c = errors === null || errors === void 0 ? void 0 : errors.response) === null || _c === void 0 ? void 0 : _c.errors) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.extensions) === null || _f === void 0 ? void 0 : _f.message) || ((_j = (_h = (_g = errors === null || errors === void 0 ? void 0 : errors.response) === null || _g === void 0 ? void 0 : _g.errors) === null || _h === void 0 ? void 0 : _h[0]) === null || _j === void 0 ? void 0 : _j.message) ||
+        error,
       success,
     },
     callbacks: {

package/dist/collection/components/sqm-portal-forgot-password/sqm-portal-forgot-password.js

@@ -13,19 +13,19 @@ export class PortalForgotPassword {
     /**
      * The page that users are redirected to from the password reset email.
      *
-     * @uiName Email Redirection Base Path
+     * @uiName Email redirection base path
      */
     this.redirectPath = "/resetPassword";
     /**
-     * @uiName Email Label
+     * @uiName Email label
      */
     this.emailLabel = "Email";
     /**
-     * @uiName Password Reset Button Text
+     * @uiName Password reset button text
      */
     this.submitLabel = "Request Password Reset";
     /**
-     * @uiName Login Page Routing Path
+     * @uiName Routing path to login page
      */
     this.loginPath = "/login";
     withHooks(this);
@@ -59,7 +59,7 @@ export class PortalForgotPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Redirection Base Path",
+            "text": "Email redirection base path",
             "name": "uiName"
           }],
         "text": "The page that users are redirected to from the password reset email."
@@ -80,7 +80,7 @@ export class PortalForgotPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Label",
+            "text": "Email label",
             "name": "uiName"
           }],
         "text": ""
@@ -101,7 +101,7 @@ export class PortalForgotPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password Reset Button Text",
+            "text": "Password reset button text",
             "name": "uiName"
           }],
         "text": ""
@@ -122,7 +122,7 @@ export class PortalForgotPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Login Page Routing Path",
+            "text": "Routing path to login page",
             "name": "uiName"
           }],
         "text": ""