@saasquatch/mint-components 1.5.5-1 → 1.5.5-2

package/dist/types/components/sqm-leaderboard/sqm-leaderboard-view.d.ts

@@ -15,14 +15,14 @@ export interface LeaderboardViewProps {
   data: {
     rankType: string;
     leaderboard: {
-      value: number;
+      textValue: string;
       rank: number;
       firstName: string;
       lastInitial: string;
       rowNumber: number;
     }[];
     viewerRank?: {
-      value: number;
+      textValue: string;
       rank: number;
       firstName: string;
       lastInitial: string;

package/dist/types/components/sqm-leaderboard/sqm-leaderboard.d.ts

@@ -4,6 +4,13 @@ import { LeaderboardViewProps } from "./sqm-leaderboard-view";
  * @uiName Leaderboard
  */
 export declare class Leaderboard {
+  /**
+   * Filters leaderboard to show only data from this program. Defaults to the program context where this leaderboard is.
+   * If no program ID is set or provided by context, then a global leaderboard is shown.
+   *
+   * @uiName Program
+   */
+  programId?: string;
   /**
    * @uiName User Column Heading
    */
@@ -13,15 +20,15 @@ export declare class Leaderboard {
    */
   statsheading: string;
   /**
-   * @uiName Rank Heading
+   * @uiName Rank Column Heading
    */
   rankheading?: string;
   /**
-   * @uiName Show Leaderboard Rank
+   * @uiName Show Rank Column
    */
   showRank: boolean;
   /**
-   * Hide the current user's leaderboard information when they are not in the top 10
+   * Hide the viewer's leaderboard row if not in the top 10.
    *
    * @uiName Hide Viewing User
    */
@@ -36,21 +43,30 @@ export declare class Leaderboard {
   /**
    * @uiName Leaderboard Type
    * @uiType string
-   * @uiEnum ["topStartedReferrers", "topConvertedReferrers"]
-   * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers"]
+   * @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"]
+   * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"]
    */
-  leaderboardType: "topStartedReferrers" | "topConvertedReferrers";
+  leaderboardType: "topStartedReferrers" | "topConvertedReferrers" | "topPointEarners";
   /**
-   * Title displayed for users without names
-   * @uiName Unknown User Text
+   * Text displayed for users without names in the leaderboard
+   *
+   * @uiName Anonymous User Name
    */
   anonymousUser: string;
   /**
+   * Only count leaderboard activity within a given interval
+   *
    * @uiName Leaderboard Time Interval
    * @uiWidget DateRange
-   * @uiWidgetOptions {"allowPastDates":true, "months": 1}
+   * @uiOptions {"allowPastDates":true, "months": 1}
    */
   interval: string;
+  /**
+   * Control the maximum amount of rows displayed on the leaderboard.
+   *
+   * @uiName Maximum Rows Number
+   */
+  maxRows: number;
   /**
    * @undocumented
    * @uiType object

package/dist/types/components/sqm-leaderboard/useLeaderboard.d.ts

@@ -8,7 +8,9 @@ export interface LeaderboardProps {
   showRank?: boolean;
   hideViewer?: boolean;
   rankType: "rowNumber" | "rank" | "denseRank";
-  leaderboardType: "topStartedReferrers" | "topConvertedReferrers";
+  leaderboardType: "topStartedReferrers" | "topConvertedReferrers" | "topPointEarners";
+  maxRows: number;
+  programId?: string;
   interval: string;
   empty: VNode;
   loadingstate: VNode;
@@ -20,7 +22,7 @@ export declare type Rank = {
   rowNumber: number;
 };
 export declare type Leaderboard = {
-  value: number;
+  textValue: string;
   rank: number;
   firstName: string;
   lastInitial: string;

package/dist/types/components/sqm-leaderboard-rank/LeaderboardRank.stories.d.ts

@@ -1,5 +1,10 @@
 declare const _default: {
   title: string;
+  parameters: {
+    scenario: string;
+  };
 };
 export default _default;
 export declare const First: () => any;
+export declare const Second: () => any;
+export declare const Unranked: () => any;

package/dist/types/components/sqm-leaderboard-rank/sqm-leaderboard-rank.d.ts

@@ -5,7 +5,7 @@ import { DemoData } from "../../global/demo";
  */
 export declare class LeaderboardRank {
   /**
-   * @uiName Default Rank
+   * @uiName Default rank
    * @uiType string
    * @uiEnum ["rowNumber", "rank", "denseRank"]
    * @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
@@ -16,22 +16,29 @@ export declare class LeaderboardRank {
    */
   rankText: string;
   /**
-   * @uiName Leaderboard Type
+   * @uiName Leaderboard type
    * @uiType string
-   * @uiEnum ["topStartedReferrers", "topConvertedReferrers"]
-   * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers"]
+   * @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"]
+   * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"]
    */
-  leaderboardType: "topStartedReferrers" | "topConvertedReferrers";
+  leaderboardType: "topStartedReferrers" | "topConvertedReferrers" | "topPointEarners";
   /**
    * @uiName Unranked Text
    */
   unrankedText: string;
   /**
-   * @uiName Leaderboard Time Interval
+   * @uiName Leaderboard time interval
    * @uiWidget DateRange
-   * @uiWidgetOptions {"allowPastDates":true, "months": 1}
+   * @uiOptions {"allowPastDates":true, "months": 1}
    */
   interval: string;
+  /**
+   * Filters leaderboard to show only data from this program. Defaults to the program context where this leaderboard is.
+   * If no program ID is set or provided by context, then a global leaderboard is shown.
+   *
+   * @uiName Program
+   */
+  programId?: string;
   /**
    * @undocumented
    * @uiType object

package/dist/types/components/sqm-leaderboard-rank/useLeaderboardRank.d.ts

@@ -2,7 +2,8 @@ import { LeaderboardRankViewProps } from "./sqm-leaderboard-rank-view";
 export interface LeaderboardRankProps {
   rankType: "rowNumber" | "rank" | "denseRank";
   rankText: string;
-  leaderboardType: "topStartedReferrers" | "topConvertedReferrers";
+  leaderboardType: "topStartedReferrers" | "topConvertedReferrers" | "topPointEarners";
+  programId?: string;
   unrankedText: string;
   interval: string;
 }

package/dist/types/components/sqm-name-fields/sqm-name-fields.d.ts

@@ -6,11 +6,11 @@ import { NameFieldsViewProps } from "./sqm-name-fields-view";
 export declare class NameFields {
   ignored: boolean;
   /**
-   * @uiName First Name label
+   * @uiName First name field label
    */
   firstNameLabel: string;
   /**
-   * @uiName Last Name label
+   * @uiName Last name field label
    */
   lastNameLabel: string;
   /**

package/dist/types/components/sqm-navigation-menu/sqm-navigation-menu.d.ts

@@ -6,13 +6,11 @@ import { DemoData } from "../../global/demo";
 export declare class NavigationMenu {
   ignored: boolean;
   /**
-   * @uiName Include Dropdown Menu
+   * @uiName Include dropdown menu
    */
   includeDropdown: boolean;
   /**
-   * Label on the header menu
-   *
-   * @uiName Menu Label
+   * @uiName Label on the header menu
    */
   menuLabel: string;
   /**

package/dist/types/components/sqm-navigation-sidebar/sqm-navigation-sidebar.d.ts

@@ -1,5 +1,5 @@
 /**
- * A container for navigation menu items
+ * A holder for navigation menu items
  *
  * @uiName Navigation Sidebar
  */

package/dist/types/components/sqm-navigation-sidebar-item/sqm-navigation-sidebar-item.d.ts

@@ -5,7 +5,7 @@ import { NavigationSidebarItemViewProps } from "./sqm-navigation-sidebar-item-vi
  */
 export declare class NavigationSidebarItem {
   /**
-   * @uiName Navigation Path
+   * @uiName Navigation path
    */
   path: string;
   /**

package/dist/types/components/sqm-password-field/sqm-password-field.d.ts

@@ -14,14 +14,11 @@ export interface PasswordFieldViewDemoProps {
 export declare class PortalPasswordField {
   ignored: boolean;
   /**
-   * Label for password field
-   *
-   * @uiName Password Label
+   * @uiName Label for password field
    */
   fieldLabel: string;
   /**
-   * Enable live password validation
-   * @uiName Enable Validation
+   * @uiName Enable live password validation
    */
   enableValidation: boolean;
   /**

package/dist/types/components/sqm-popup-container/sqm-popup-container.d.ts

@@ -1,37 +1,22 @@
 /**
- * @uiName Popup Container For Widgets
+ * @uiName Popup container for widgets
  */
 export declare class PopupContainer {
-  /**
-   * Show Powered By SaaSquatch link
-   *
-   * @uiName Show Powered By
-   */
+  /** @uiName Show SaaSquatch Powered By messaging */
   poweredBy: boolean;
-  /**
-   * Display a close button on the popup
-   *
-   * @uiName Show Close Button
-   */
+  /** @uiName Display a close button on the popup */
   closeButton: boolean;
-  /**
-   * Text inside the close button
-   *
-   * @uiName Close Button Text
-   */
+  /** @uiName Text to be used as the close button */
   closeButtonText: string;
   /**
-   * Specify padding on the popup contents when in embedded mode
-   *
-   * @uiName Embed Padding
+   * @uiName Specify padding on the popup contents when in embedded mode
    * @uiType string
    * @uiEnum ["none", "small", "medium", "large"]
    * @uiEnumNames ["None", "Small", "Medium", "Large"]
    */
   embedPadding?: "none" | "small" | "medium" | "large";
   /**
-   * Specify padding on the popup contents when in popup mode
-   * @uiName Popup Padding
+   * @uiName  Specify padding on the popup contents when in popup mode
    * @uiType string
    * @uiEnum ["none", "small", "medium", "large"]
    * @uiEnumNames ["None", "Small", "Medium", "Large"]

package/dist/types/components/sqm-portal-change-password/sqm-portal-change-password.d.ts

@@ -6,47 +6,35 @@ import { DemoData } from "../../global/demo";
 export declare class PortalChangePassword {
   ignored: boolean;
   /**
-   * @uiName Change Password Modal Header
+   * @uiName Change password modal header
    */
   modalChangePasswordHeader: string;
   /**
-   * Modal cancel button text
-   *
-   * @uiName Cancel Button Text
+   * @uiName Modal cancel password change button text
    */
   cancelText: string;
   /**
-   * Modal change password button text
-   *
-   * @uiName Change Password Button Text
+   * @uiName Modal change password button text
    */
   changePasswordButtonText: string;
   /**
-   * Password input field label
-   *
-   * @uiName Password Label
+   * @uiName Password input field label
    */
   passwordFieldLabel: string;
   /**
-   * Password confirmation input field label
-   *
-   * @uiName Confirm Password Label
+   * @uiName Password confirmation input field label
    */
   confirmPasswordFieldLabel: string;
   /**
-   * Successful password change message
-   *
-   * @uiName Successful Message
+   * @uiName Successful password change message
    */
   successMessage: string;
   /**
-   * Portal change password section header
-   *
-   * @uiName Change Password Header
+   * @uiName Portal change password section header
    */
   portalChangePasswordHeader: string;
   /**
-   * @uiName Change Password Button Text
+   * @uiName Portal change password button text
    */
   portalChangePasswordButtonText: string;
   /**

package/dist/types/components/sqm-portal-container/sqm-portal-container.d.ts

@@ -25,7 +25,7 @@ export declare class PortalContainer {
    * @uiEnumNames ["None", "XXX-Small", "XX-Small", "X-Small", "Small", "Medium", "Large", "X-Large", "XX-Large", "XXX-Large", "XXXX-Large"]
    */
   gap: Spacing;
-  /** @uiName Minimum Width */
+  /** @uiName Minimum width */
   minWidth?: string;
   /**
    * @uiName Display
@@ -35,9 +35,7 @@ export declare class PortalContainer {
    */
   display: "grid" | "flex";
   /**
-   * Defines how the container distributes space between & around content items along the main-axis of a flex container
-   *
-   * @uiName Justify Content
+   * @uiName Justify content
    * @uiType string
    * @uiEnum ["start", "center", "end", "space-between", "space-around", "space-evenly"]
    * @uiEnumNames ["Start", "Center", "End", "Space Between", "Space Around", "Space Evenly"]
@@ -48,7 +46,7 @@ export declare class PortalContainer {
    */
   maxWidth?: string;
   /**
-   * @uiName Center Content
+   * @uiName Center content
    */
   center?: boolean;
   constructor();

package/dist/types/components/sqm-portal-email-verification/sqm-portal-email-verification.d.ts

@@ -8,19 +8,19 @@ export declare class PortalEmailVerification {
   /**
    * The page that users are redirected to from the verification email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email redirection base path
    */
   redirectPath: string;
   /**
-   * @uiName Email Verification Header Text
+   * @uiName Email verification header text
    */
   emailVerificationHeader: string;
   /**
-   * @uiName Re-send Email Button Text
+   * @uiName Re-send email button text
    */
   resendEmailButtonText: string;
   /**
-   * @uiName Email Verification Body Text
+   * @uiName Email verification body text
    */
   verifyMessage: string;
   /**

package/dist/types/components/sqm-portal-forgot-password/sqm-portal-forgot-password.d.ts

@@ -8,19 +8,19 @@ export declare class PortalForgotPassword {
   /**
    * The page that users are redirected to from the password reset email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email redirection base path
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Email label
    */
   emailLabel: string;
   /**
-   * @uiName Password Reset Button Text
+   * @uiName Password reset button text
    */
   submitLabel: string;
   /**
-   * @uiName Login Page Routing Path
+   * @uiName Routing path to login page
    */
   loginPath: string;
   /**

package/dist/types/components/sqm-portal-login/sqm-portal-login.d.ts

@@ -6,55 +6,39 @@ import { PortalLoginViewProps } from "./sqm-portal-login-view";
 export declare class PortalLogin {
   ignored: boolean;
   /**
-   * Page navigated to after sign-in
-   *
-   * @uiName Next Page Path
+   * @uiName Page navigated to after sign-in
    */
   nextPage: string;
   /**
-   * Label for email field
-   *
-   * @uiName Email Label
+   * @uiName Label for email field
    */
   emailLabel: string;
   /**
-   * Label for password field
-   *
-   * @uiName Password Label
+   * @uiName Label for password field
    */
   passwordLabel: string;
   /**
-   * Label for submit button
-   *
-   * @uiName Submit Button Text
+   * @uiName Label for submit button
    */
   submitLabel: string;
   /**
-   * Label for forgotten password button
-   *
-   * @uiName Forgot Password Text
+   * @uiName Label for forgotten password button
    */
   forgotPasswordLabel: string;
   /**
-   * Label for register button
-   *
-   * @uiName Register Button Text
+   * @uiName Label for register navigation button
    */
   registerLabel: string;
   /**
-   * @uiName Heading Label
+   * @uiName Heading label
    */
   pageLabel: string;
   /**
-   * Register redirect path
-   *
-   * @uiName Register Path
+   * @uiName Register button redirection path
    */
   registerPath: string;
   /**
-   * Forgot password redirect path
-   *
-   * @uiName Forgot Password Path
+   * @uiName Forgot password button redirect path
    */
   forgotPasswordPath: string;
   /**

package/dist/types/components/sqm-portal-logout/sqm-portal-logout.d.ts

@@ -4,7 +4,7 @@
 export declare class PortalLogout {
   ignored: boolean;
   /**
-   * @uiName Next Page Path
+   * @uiName Next Page path
    */
   nextPage: string;
   constructor();

package/dist/types/components/sqm-portal-profile/sqm-portal-profile.d.ts

@@ -6,45 +6,35 @@ import { DemoData } from "../../global/demo";
 export declare class PortalProfile {
   ignored: boolean;
   /**
-   * First name input field label
-   *
-   * @uiName First Name Label
+   * @uiName First name input field label
    */
   firstnametext: string;
   /**
-   * Last name input field label
-   *
-   * @uiName Last Name Label
+   * @uiName Last name input field label
    */
   lastnametext: string;
   /**
-   * Email input field label
-   *
-   * @uiName Email Label
+   * @uiName Email input field label
    */
   emailtext: string;
   /**
-   * Country input field label
-   *
-   * @uiName Country Label
+   * @uiName Country input field label
    */
   countrytext: string;
   /**
-   * @uiName Edit Profile Header
+   * @uiName Edit profile header
    */
   editProfileHeader: string;
   /**
-   * @uiName Edit Profile Sub Header
+   * @uiName Edit profile sub header
    */
   editProfileSubHeader: string;
   /**
-   * @uiName Submit Changes Button Text
+   * @uiName Text for the submit changes button
    */
   submitChangeButtonText: string;
   /**
-   * Show or hide the country field
-   *
-   * @uiName Show Country Field
+   * @uiName Show or hide country field
    */
   showCountry: boolean;
   /**

package/dist/types/components/sqm-portal-protected-route/sqm-portal-protected-route.d.ts

@@ -12,7 +12,7 @@ export declare class PortalProtectedRoute {
    */
   requireEmailVerification: boolean;
   /**
-   * @uiName Redirect Unverified Users Path
+   * @uiName Redirect unverified users path
    */
   redirectToUnverified: string;
   constructor();

package/dist/types/components/sqm-portal-register/sqm-portal-register.d.ts

@@ -6,61 +6,53 @@ import { PortalRegisterViewProps } from "./sqm-portal-register-view";
 export declare class PortalRegister {
   ignored: boolean;
   /**
-   * Page navigated to after registration
-   *
-   * @uiName Next Page
+   * @uiName Page navigated to after registration
    */
   nextPage: string;
   /**
    * The page that users are redirected to from the verification email.
    *
-   * @uiName Email Redirection Base Path
+   * @uiName Email redirection base path
    */
   redirectPath: string;
   /**
-   * @uiName Email Label
+   * @uiName Label for email field
    */
   emailLabel: string;
   /**
-   * @uiName Password Label
+   * @uiName Label for password field
    */
   passwordLabel: string;
   /**
-   * @uiName Submit Button Text
+   * @uiName Label for submit button
    */
   submitLabel: string;
   /**
-   * @uiName Login Button Text
+   * @uiName Label for login navigation button
    */
   loginLabel: string;
   /**
-   * @uiName Confirm Password Label
+   * @uiName Label for confirm password field
    */
   confirmPasswordLabel: string;
   /**
-   * Show or hide the confirm password input
-   *
-   * @uiName Show Confirm Password Field
+   * @uiName Show confirm password field
    */
   confirmPassword: boolean;
   /**
-   * @uiName Enable Password Validation
+   * @uiName Use password field with live validation
    */
   enablePasswordValidation: boolean;
   /**
-   * Hide default input fields to use custom fields
-   *
-   * @uiName Hide Default Inputs
+   * @uiName Hide default input fields to use custom fields
    */
   hideInputs: boolean;
   /**
-   * @uiName Heading Label
+   * @uiName Heading label
    */
   pageLabel: string;
   /**
-   * Login button redirection path
-   *
-   * @uiName Login Path
+   * @uiName Sign in button redirection path
    */
   loginPath: string;
   /**