@saasquatch/mint-components 1.6.2-6 → 1.6.2-9

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

@@ -5,29 +5,30 @@ import deepmerge from "deepmerge";
 import { PortalRegisterView, } from "./sqm-portal-register-view";
 import { usePortalRegister } from "./usePortalRegister";
 /**
- * @uiName Portal Register
+ * @uiName Microsite Registration
+ * @slots [{"name":"formData","title":"Additional Fields"},{"name":"terms","title":"Terms And Conditions Fields"}]
  */
 export class PortalRegister {
   constructor() {
     this.ignored = true;
     /**
-     * Page navigated to after registration
+     * Page participants are navigated to after registration.
      *
-     * @uiName Next Page
+     * @uiName Registration Redirect Path
      */
     this.nextPage = "/";
     /**
-     * The page that users are redirected to from the verification email.
+     * The page that participants are redirected to from the verification email.
      *
-     * @uiName Email Redirection Base Path
+     * @uiName Email Redirection Path
      */
     this.redirectPath = "/verifyEmail";
     /**
-     * @uiName Email Label
+     * @uiName Email Field Label
      */
     this.emailLabel = "Email";
     /**
-     * @uiName Password Label
+     * @uiName Password Field Label
      */
     this.passwordLabel = "Password";
     /**
@@ -43,10 +44,9 @@ export class PortalRegister {
      */
     this.confirmPasswordLabel = "Confirm Password";
     /**
-     * Show or hide the confirm password input
+     * Show or hide the confirm password input.
      *
      * @uiName Show Confirm Password Field
-     * @default
      */
     this.confirmPassword = false;
     /**
@@ -54,20 +54,19 @@ export class PortalRegister {
      */
     this.enablePasswordValidation = true;
     /**
-     * Hide default input fields to use custom fields
+     * Hide default input fields to use custom fields.
      *
      * @uiName Hide Default Inputs
-     * @default
      */
     this.hideInputs = false;
     /**
-     * @uiName Heading Label
+     * @uiName Header Text
      */
     this.pageLabel = "Register";
     /**
-     * Login button redirection path
+     * Login button redirection path.
      *
-     * @uiName Login Path
+     * @uiName Login Redirect Path
      */
     this.loginPath = "/login";
     withHooks(this);
@@ -105,10 +104,10 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Next Page",
+            "text": "Registration Redirect Path",
             "name": "uiName"
           }],
-        "text": "Page navigated to after registration"
+        "text": "Page participants are navigated to after registration."
       },
       "attribute": "next-page",
       "reflect": false,
@@ -126,10 +125,10 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Redirection Base Path",
+            "text": "Email Redirection Path",
             "name": "uiName"
           }],
-        "text": "The page that users are redirected to from the verification email."
+        "text": "The page that participants are redirected to from the verification email."
       },
       "attribute": "redirect-path",
       "reflect": false,
@@ -147,7 +146,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Label",
+            "text": "Email Field Label",
             "name": "uiName"
           }],
         "text": ""
@@ -168,7 +167,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password Label",
+            "text": "Password Field Label",
             "name": "uiName"
           }],
         "text": ""
@@ -254,11 +253,8 @@ export class PortalRegister {
         "tags": [{
             "text": "Show Confirm Password Field",
             "name": "uiName"
-          }, {
-            "text": undefined,
-            "name": "default"
           }],
-        "text": "Show or hide the confirm password input"
+        "text": "Show or hide the confirm password input."
       },
       "attribute": "confirm-password",
       "reflect": false,
@@ -299,11 +295,8 @@ export class PortalRegister {
         "tags": [{
             "text": "Hide Default Inputs",
             "name": "uiName"
-          }, {
-            "text": undefined,
-            "name": "default"
           }],
-        "text": "Hide default input fields to use custom fields"
+        "text": "Hide default input fields to use custom fields."
       },
       "attribute": "hide-inputs",
       "reflect": false,
@@ -321,7 +314,7 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Heading Label",
+            "text": "Header Text",
             "name": "uiName"
           }],
         "text": ""
@@ -342,10 +335,10 @@ export class PortalRegister {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Login Path",
+            "text": "Login Redirect Path",
             "name": "uiName"
           }],
-        "text": "Login button redirection path"
+        "text": "Login button redirection path."
       },
       "attribute": "login-path",
       "reflect": false,

package/dist/collection/components/sqm-portal-registration-form/sqm-portal-registration-form.js

@@ -5,29 +5,30 @@ import deepmerge from "deepmerge";
 import { PortalRegistrationFormView, } from "./sqm-portal-registration-form-view";
 import { usePortalRegistrationForm } from "./usePortalRegistrationForm";
 /**
- * @uiName Portal Register
+ * @uiName Microsite Registration
+ * @slots [{"name":"formData","title":"Additional Fields"},{"name":"terms","title":"Terms And Conditions Fields"}]
  */
 export class PortalRegistrationForm {
   constructor() {
     this.ignored = true;
     /**
-     * Page navigated to after registration
+     * Page participants are navigated to after registration.
      *
-     * @uiName Next Page
+     * @uiName Registration Redirect Path
      */
     this.nextPage = "/";
     /**
-     * The page that users are redirected to from the verification email.
+     * The page that participants are redirected to from the verification email.
      *
-     * @uiName Email Redirection Base Path
+     * @uiName Email Redirection Path
      */
     this.redirectPath = "/verifyEmail";
     /**
-     * @uiName Email Label
+     * @uiName Email Field Label
      */
     this.emailLabel = "Email";
     /**
-     * @uiName Password Label
+     * @uiName Password Field Label
      */
     this.passwordLabel = "Password";
     /**
@@ -43,10 +44,9 @@ export class PortalRegistrationForm {
      */
     this.confirmPasswordLabel = "Confirm Password";
     /**
-     * Show or hide the confirm password input
+     * Show or hide the confirm password input.
      *
      * @uiName Show Confirm Password Field
-     * @default
      */
     this.confirmPassword = false;
     /**
@@ -54,20 +54,19 @@ export class PortalRegistrationForm {
      */
     this.enablePasswordValidation = true;
     /**
-     * Hide default input fields to use custom fields
+     * Hide default input fields to use custom fields.
      *
      * @uiName Hide Default Inputs
-     * @default
      */
     this.hideInputs = false;
     /**
-     * @uiName Heading Label
+     * @uiName Header Text
      */
     this.pageLabel = "Register";
     /**
-     * Login button redirection path
+     * Login button redirection path.
      *
-     * @uiName Login Path
+     * @uiName Login Redirect Path
      */
     this.loginPath = "/login";
     /**
@@ -111,10 +110,10 @@ export class PortalRegistrationForm {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Next Page",
+            "text": "Registration Redirect Path",
             "name": "uiName"
           }],
-        "text": "Page navigated to after registration"
+        "text": "Page participants are navigated to after registration."
       },
       "attribute": "next-page",
       "reflect": false,
@@ -132,10 +131,10 @@ export class PortalRegistrationForm {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Redirection Base Path",
+            "text": "Email Redirection Path",
             "name": "uiName"
           }],
-        "text": "The page that users are redirected to from the verification email."
+        "text": "The page that participants are redirected to from the verification email."
       },
       "attribute": "redirect-path",
       "reflect": false,
@@ -153,7 +152,7 @@ export class PortalRegistrationForm {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Email Label",
+            "text": "Email Field Label",
             "name": "uiName"
           }],
         "text": ""
@@ -174,7 +173,7 @@ export class PortalRegistrationForm {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Password Label",
+            "text": "Password Field Label",
             "name": "uiName"
           }],
         "text": ""
@@ -260,11 +259,8 @@ export class PortalRegistrationForm {
         "tags": [{
             "text": "Show Confirm Password Field",
             "name": "uiName"
-          }, {
-            "text": undefined,
-            "name": "default"
           }],
-        "text": "Show or hide the confirm password input"
+        "text": "Show or hide the confirm password input."
       },
       "attribute": "confirm-password",
       "reflect": false,
@@ -305,11 +301,8 @@ export class PortalRegistrationForm {
         "tags": [{
             "text": "Hide Default Inputs",
             "name": "uiName"
-          }, {
-            "text": undefined,
-            "name": "default"
           }],
-        "text": "Hide default input fields to use custom fields"
+        "text": "Hide default input fields to use custom fields."
       },
       "attribute": "hide-inputs",
       "reflect": false,
@@ -327,7 +320,7 @@ export class PortalRegistrationForm {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Heading Label",
+            "text": "Header Text",
             "name": "uiName"
           }],
         "text": ""
@@ -348,10 +341,10 @@ export class PortalRegistrationForm {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Login Path",
+            "text": "Login Redirect Path",
             "name": "uiName"
           }],
-        "text": "Login button redirection path"
+        "text": "Login button redirection path."
       },
       "attribute": "login-path",
       "reflect": false,

package/dist/collection/components/sqm-portal-registration-form/usePortalRegistrationForm.js

@@ -45,7 +45,6 @@ export function usePortalRegistrationForm(props) {
     let formData = {};
     let validationErrors = {};
     formControls === null || formControls === void 0 ? void 0 : formControls.forEach((control) => {
-      console.log({ control }, control.name);
       if (!control.name)
         return;
       const key = control.name;

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

@@ -5,28 +5,27 @@ import deepmerge from "deepmerge";
 import { PortalResetPasswordView, } from "./sqm-portal-reset-password-view";
 import { usePortalResetPassword } from "./usePortalResetPassword";
 /**
- * @uiName Portal Reset Password
+ * @uiName Microsite Reset Password
  */
 export class PortalResetPassword {
   constructor() {
     this.ignored = true;
     /**
-     * The page that users are redirected to when the password reset succeeds.
+     * The page that participants are redirected to when the password reset succeeds.
      *
-     * @uiName Next Page Path
+     * @uiName Reset Successful Redirect Path
      */
     this.nextPage = "/";
     /**
-     * The page that users are redirected to if the reset fails due to outdated password reset attempt.
+     * The page that participants are redirected to if the reset fails due to outdated password reset attempt.
      *
-     * @uiName Failed Page Path
+     * @uiName Reset Failed Redirect Path
      */
     this.failedPage = "/";
     /**
-     * Show or hide confirm password field
+     * Show or hide confirm password field.
      *
      * @uiName Show Confirm Password
-     * @default
      */
     this.confirmPassword = false;
     /**
@@ -34,9 +33,10 @@ export class PortalResetPassword {
      */
     this.resetPasswordHeader = "Reset your password";
     /**
-     * Displayed after a successful password reset
+     * Displayed after a successful password reset.
      *
      * @uiName Successful Password Reset Text
+     * @uiWidget textArea
      */
     this.passwordResetHeader = "Password reset";
     /**
@@ -44,13 +44,13 @@ export class PortalResetPassword {
      */
     this.resetPasswordButtonText = "Reset Password";
     /**
-     * Button text displayed after a successful password reset
+     * Button text displayed after a successful password reset.
      *
      * @uiName Continue Button Text
      */
     this.continueButtonText = "Continue";
     /**
-     * @uiName Confirm Password Label
+     * @uiName Password Comfirmation Label
      */
     this.confirmPasswordFieldLabel = "Confirm Password";
     /**
@@ -81,10 +81,10 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Next Page Path",
+            "text": "Reset Successful Redirect Path",
             "name": "uiName"
           }],
-        "text": "The page that users are redirected to when the password reset succeeds."
+        "text": "The page that participants are redirected to when the password reset succeeds."
       },
       "attribute": "next-page",
       "reflect": false,
@@ -102,10 +102,10 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Failed Page Path",
+            "text": "Reset Failed Redirect Path",
             "name": "uiName"
           }],
-        "text": "The page that users are redirected to if the reset fails due to outdated password reset attempt."
+        "text": "The page that participants are redirected to if the reset fails due to outdated password reset attempt."
       },
       "attribute": "failed-page",
       "reflect": false,
@@ -125,11 +125,8 @@ export class PortalResetPassword {
         "tags": [{
             "text": "Show Confirm Password",
             "name": "uiName"
-          }, {
-            "text": undefined,
-            "name": "default"
           }],
-        "text": "Show or hide confirm password field"
+        "text": "Show or hide confirm password field."
       },
       "attribute": "confirm-password",
       "reflect": false,
@@ -170,8 +167,11 @@ export class PortalResetPassword {
         "tags": [{
             "text": "Successful Password Reset Text",
             "name": "uiName"
+          }, {
+            "text": "textArea",
+            "name": "uiWidget"
           }],
-        "text": "Displayed after a successful password reset"
+        "text": "Displayed after a successful password reset."
       },
       "attribute": "password-reset-header",
       "reflect": false,
@@ -213,7 +213,7 @@ export class PortalResetPassword {
             "text": "Continue Button Text",
             "name": "uiName"
           }],
-        "text": "Button text displayed after a successful password reset"
+        "text": "Button text displayed after a successful password reset."
       },
       "attribute": "continue-button-text",
       "reflect": false,
@@ -231,7 +231,7 @@ export class PortalResetPassword {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Confirm Password Label",
+            "text": "Password Comfirmation Label",
             "name": "uiName"
           }],
         "text": ""

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

@@ -5,21 +5,21 @@ import deepmerge from "deepmerge";
 import { PortalVerifyEmailView, } from "./sqm-portal-verify-email-view";
 import { usePortalVerifyEmail } from "./usePortalVerifyEmail";
 /**
- * @uiName Portal Verify Email
+ * @uiName Microsite Verify Email
  */
 export class PortalVerifyEmail {
   constructor() {
     this.ignored = true;
     /**
-     * The page that users are redirected to when the verification succeeds.
+     * The page that participants are redirected to when the verification succeeds.
      *
-     * @uiName Next Page Path
+     * @uiName Verification Redirect Path
      */
     this.nextPage = "/";
     /**
-     * The page that users are redirected to if verification fails due to outdated verification attempt.
+     * The page that participants are redirected to if verification fails due to outdated verification attempt.
      *
-     * @uiName Failed Page Path
+     * @uiName Verification Failed Redirect Path
      */
     this.failedPage = "/";
     withHooks(this);
@@ -46,10 +46,10 @@ export class PortalVerifyEmail {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Next Page Path",
+            "text": "Verification Redirect Path",
             "name": "uiName"
           }],
-        "text": "The page that users are redirected to when the verification succeeds."
+        "text": "The page that participants are redirected to when the verification succeeds."
       },
       "attribute": "next-page",
       "reflect": false,
@@ -67,10 +67,10 @@ export class PortalVerifyEmail {
       "optional": false,
       "docs": {
         "tags": [{
-            "text": "Failed Page Path",
+            "text": "Verification Failed Redirect Path",
             "name": "uiName"
           }],
-        "text": "The page that users are redirected to if verification fails due to outdated verification attempt."
+        "text": "The page that participants are redirected to if verification fails due to outdated verification attempt."
       },
       "attribute": "failed-page",
       "reflect": false,

package/dist/collection/components/sqm-portal-verify-email/usePortalVerifyEmail.js

@@ -1,16 +1,17 @@
-import { useEffect, useState } from "@saasquatch/universal-hooks";
+import { useEffect } from "@saasquatch/universal-hooks";
 import { navigation, useUserIdentity, useVerifyEmailMutation, } from "@saasquatch/component-boilerplate";
 import { sanitizeUrlPath } from "../../utils/utils";
 export function usePortalVerifyEmail({ nextPage, failedPage }) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-  const [verified, setVerified] = useState(false);
-  const [disableContinue, setDisableContinue] = useState(true);
+  var _a, _b, _c, _d, _e, _f, _g, _h;
   const userIdent = useUserIdentity();
   const [request, { loading, data, errors }] = useVerifyEmailMutation();
-  const [error, setError] = useState("");
   const urlParams = new URLSearchParams(window.location.search);
   const oobCode = urlParams.get("oobCode");
   const nextPageOverride = urlParams.get("nextPage");
+  // derived from useMutation in component boilerplate initialState
+  const disableContinue = data === undefined && errors === undefined && !!oobCode;
+  // if logged out, userIdent?.managedIdentity?.emailVerified will be falsey, even if verification was successful
+  const verified = !!(((_a = userIdent === null || userIdent === void 0 ? void 0 : userIdent.managedIdentity) === null || _a === void 0 ? void 0 : _a.emailVerified) || (data === null || data === void 0 ? void 0 : data.verifyManagedIdentityEmail.success));
   const failed = () => {
     return navigation.push({
       pathname: failedPage,
@@ -20,52 +21,32 @@ export function usePortalVerifyEmail({ nextPage, failedPage }) {
   const gotoNextPage = () => {
     urlParams.delete("nextPage");
     const url = sanitizeUrlPath(nextPageOverride || nextPage);
-    navigation.push(url.href);
+    window.history.pushState(undefined, "", url.href);
   };
   const submit = async () => {
-    if (oobCode) {
-      setError("");
-      await request({ oobCode });
-    }
-  };
-  useEffect(() => {
     var _a;
-    if ((_a = data === null || data === void 0 ? void 0 : data.verifyManagedIdentityEmail) === null || _a === void 0 ? void 0 : _a.success) {
-      setVerified(true);
-    }
-  }, [(_a = data === null || data === void 0 ? void 0 : data.verifyManagedIdentityEmail) === null || _a === void 0 ? void 0 : _a.success]);
-  useEffect(() => {
-    submit();
-  }, []);
-  useEffect(() => {
-    var _a, _b;
-    if ((_a = userIdent === null || userIdent === void 0 ? void 0 : userIdent.managedIdentity) === null || _a === void 0 ? void 0 : _a.emailVerified) {
-      setDisableContinue(false);
-      setTimeout(() => {
-        gotoNextPage();
-      }, 3000);
-    }
-    else if (!oobCode ||
-      ((_b = data === null || data === void 0 ? void 0 : data.verifyManagedIdentityEmail) === null || _b === void 0 ? void 0 : _b.success) === false) {
-      setDisableContinue(false);
-    }
-    else if (!userIdent) {
-      setDisableContinue(false);
+    if (oobCode) {
+      const result = await request({ oobCode });
+      console.log({ result });
+      if ((result instanceof Error ||
+        !result.verifyManagedIdentityEmail.success) &&
+        !((_a = userIdent === null || userIdent === void 0 ? void 0 : userIdent.managedIdentity) === null || _a === void 0 ? void 0 : _a.emailVerified)) {
+        // pause on error if logged out/unverified
+        return;
+      }
       setTimeout(() => {
         gotoNextPage();
       }, 3000);
     }
-  }, [(_b = userIdent === null || userIdent === void 0 ? void 0 : userIdent.managedIdentity) === null || _b === void 0 ? void 0 : _b.emailVerified]);
+  };
   useEffect(() => {
-    if (errors === null || errors === void 0 ? void 0 : errors.message) {
-      setError("Network request failed.");
-    }
-  }, [errors]);
+    submit();
+  }, []);
   return {
     states: {
       loading: loading || disableContinue,
-      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,
+      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) ||
+        ((errors === null || errors === void 0 ? void 0 : errors.message) && "Network request failed."),
       verified,
     },
     data: {

package/dist/collection/components/sqm-program-explainer/sqm-program-explainer.js

@@ -6,7 +6,7 @@ import { ProgramExplainerView } from "./sqm-program-explainer-view";
  * @uiName Program Explainer
  * @exampleGroup Common Components
  * @slots [{"name":"", "title":"Explainer", "validChildren":["sqm-program-explainer-step"]}]
- * @example Program Explainer - <sqm-program-explainer header="How it works"><sqm-program-explainer-step description="Complete tasks like uploading your first video or sharing videos with friends" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step><sqm-program-explainer-step description="Use your points and redeem rewards like one free month of Enterprise or a visa giftcard" header="Redeem rewards" icon="people" text-color="#000000"></sqm-program-explainer-step></sqm-program-explainer>
+ * @example Program Explainer - <sqm-program-explainer header="How it works"><sqm-program-explainer-step description="Explore and use our product while earning points in the process!" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step><sqm-program-explainer-step description="Use your points and redeem rewards like one free month of Enterprise or a visa giftcard" header="Redeem rewards" icon="people" text-color="#000000"></sqm-program-explainer-step></sqm-program-explainer>
  */
 export class ProgramExplainer {
   constructor() {

package/dist/collection/components/sqm-program-explainer-step/sqm-program-explainer-step.js

@@ -5,7 +5,7 @@ import { ProgramExplainerStepView } from "./sqm-program-explainer-step-view";
 /**
  * @uiName Program Explainer Step
  * @exampleGroup Common Components
- * @example Program Explainer Step - <sqm-program-explainer-step description="Complete tasks like uploading your first video or sharing videos with friends" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step>
+ * @example Program Explainer Step - <sqm-program-explainer-step description="Explore and use our product while earning points in the process!" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step>
  * @validParents ["sqm-program-explainer"]
  */
 export class ProgramExplainerStep {
@@ -155,7 +155,7 @@ export class ProgramExplainerStep {
             "text": "Icon",
             "name": "uiName"
           }],
-        "text": "Full list of valid icon names available in the {@link https://shoelace.style/components/icon Shoelace Icon Library}. This value is case sensitive."
+        "text": "Full list of valid icon names available in the [Shoelace Icon Library](https://shoelace.style/components/icon). This value is case sensitive."
       },
       "attribute": "icon",
       "reflect": false

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

@@ -3,7 +3,8 @@ import { withHooks } from "@saasquatch/stencil-hooks";
 import { useProgramMenu } from "./useProgramMenu";
 import { getProps } from "../../utils/utils";
 /**
- * @uiName Portal Menu
+ * @uiName Microsite Program Menu
+ * @slots [{"name":"","title":"Menu Content"}]
  * @canvasRenderer always-replace
  */
 export class ProgramMenu {