@saasquatch/mint-components 1.5.3 → 1.5.4-2

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

@@ -9,7 +9,8 @@ export declare const Empty: () => any;
 export declare const Loading: () => any;
 export declare const One: () => any;
 export declare const Five: () => any;
-export declare const Ten: () => any;
+export declare const ReferralLeaderboard: () => any;
+export declare const PointsLeaderboard: () => any;
 export declare const TenWithRank: () => any;
 export declare const ViewerOutside: () => any;
 export declare const ViewerAnonymous: () => any;

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

@@ -14,6 +14,24 @@ export declare const TopStartedReferrers: {
     hookStory: Function;
   };
 };
+export declare const topPointEarners: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const globalLeaderboards: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
+export declare const FiveResults: {
+  (): any;
+  parameters: {
+    hookStory: Function;
+  };
+};
 export declare const EmptyLeaderboard: {
   (): any;
   parameters: {

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,43 +20,53 @@ 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
+   * @uiName Hide Viewing User
    */
   hideViewer: boolean;
   /**
-   * @uiName Rank type
+   * @uiName Rank Type
    * @uiType string
    * @uiEnum ["rowNumber", "rank", "denseRank"]
    * @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
    */
   rankType: "rowNumber" | "rank" | "denseRank";
   /**
-   * @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 Title displayed for users without names
+   * Text displayed for users without names in the leaderboard
+   *
+   * @uiName Anonymous User Name
    */
   anonymousUser: string;
   /**
-   * @uiName Leaderboard time interval
+   * Only count leaderboard activity within a given interval
+   *
+   * @uiName Leaderboard Time Interval
    * @uiWidget DateRange
    * @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

@@ -18,10 +18,10 @@ export declare class LeaderboardRank {
   /**
    * @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
    */
@@ -32,6 +32,13 @@ export declare class LeaderboardRank {
    * @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.d.ts

@@ -414,7 +414,8 @@ export namespace Components {
     }
     interface SqmLeaderboard {
         /**
-          * @uiName Title displayed for users without names
+          * Text displayed for users without names in the leaderboard
+          * @uiName Anonymous User Name
          */
         "anonymousUser": string;
         /**
@@ -423,36 +424,49 @@ export namespace Components {
          */
         "demoData"?: DemoData<LeaderboardViewProps>;
         /**
-          * Hide the current user's leaderboard information when they are not in the top 10
-          * @uiName Hide viewing user
+          * Hide the viewer's leaderboard row if not in the top 10.
+          * @uiName Hide Viewing User
          */
         "hideViewer": boolean;
         /**
-          * @uiName Leaderboard time interval
+          * Only count leaderboard activity within a given interval
+          * @uiName Leaderboard Time Interval
           * @uiWidget DateRange
           * @uiOptions {"allowPastDates":true, "months": 1}
          */
         "interval": 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"
+    | "topPointEarners";
+        /**
+          * Control the maximum amount of rows displayed on the leaderboard.
+          * @uiName Maximum Rows Number
+         */
+        "maxRows": number;
+        /**
+          * 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
          */
-        "leaderboardType": "topStartedReferrers" | "topConvertedReferrers";
+        "programId"?: string;
         /**
-          * @uiName Rank type
+          * @uiName Rank Type
           * @uiType string
           * @uiEnum ["rowNumber", "rank", "denseRank"]
           * @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
          */
         "rankType": "rowNumber" | "rank" | "denseRank";
         /**
-          * @uiName Rank Heading
+          * @uiName Rank Column Heading
          */
         "rankheading"?: string;
         /**
-          * @uiName Show leaderboard rank
+          * @uiName Show Rank Column
          */
         "showRank": boolean;
         /**
@@ -479,10 +493,17 @@ export namespace Components {
         /**
           * @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"
+    | "topPointEarners";
+        /**
+          * 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
          */
-        "leaderboardType": "topStartedReferrers" | "topConvertedReferrers";
+        "programId"?: string;
         /**
           * @uiName Rank Text
          */
@@ -2985,7 +3006,8 @@ declare namespace LocalJSX {
     }
     interface SqmLeaderboard {
         /**
-          * @uiName Title displayed for users without names
+          * Text displayed for users without names in the leaderboard
+          * @uiName Anonymous User Name
          */
         "anonymousUser"?: string;
         /**
@@ -2994,36 +3016,49 @@ declare namespace LocalJSX {
          */
         "demoData"?: DemoData<LeaderboardViewProps>;
         /**
-          * Hide the current user's leaderboard information when they are not in the top 10
-          * @uiName Hide viewing user
+          * Hide the viewer's leaderboard row if not in the top 10.
+          * @uiName Hide Viewing User
          */
         "hideViewer"?: boolean;
         /**
-          * @uiName Leaderboard time interval
+          * Only count leaderboard activity within a given interval
+          * @uiName Leaderboard Time Interval
           * @uiWidget DateRange
           * @uiOptions {"allowPastDates":true, "months": 1}
          */
         "interval"?: 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"
+    | "topPointEarners";
+        /**
+          * Control the maximum amount of rows displayed on the leaderboard.
+          * @uiName Maximum Rows Number
+         */
+        "maxRows"?: number;
+        /**
+          * 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
          */
-        "leaderboardType"?: "topStartedReferrers" | "topConvertedReferrers";
+        "programId"?: string;
         /**
-          * @uiName Rank type
+          * @uiName Rank Type
           * @uiType string
           * @uiEnum ["rowNumber", "rank", "denseRank"]
           * @uiEnumNames ["Row Number", "Rank", "Dense Rank"]
          */
         "rankType"?: "rowNumber" | "rank" | "denseRank";
         /**
-          * @uiName Rank Heading
+          * @uiName Rank Column Heading
          */
         "rankheading"?: string;
         /**
-          * @uiName Show leaderboard rank
+          * @uiName Show Rank Column
          */
         "showRank"?: boolean;
         /**
@@ -3050,10 +3085,17 @@ declare namespace LocalJSX {
         /**
           * @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"
+    | "topPointEarners";
+        /**
+          * 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
          */
-        "leaderboardType"?: "topStartedReferrers" | "topConvertedReferrers";
+        "programId"?: string;
         /**
           * @uiName Rank Text
          */