@saasquatch/mint-components 1.6.2-9 → 1.6.3-1

package/dist/types/components/sqm-header-logo/sqm-header-logo.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @uiName Header Logo
+ */
+export declare class HeroImage {
+  /**
+   * @uiWidget ImageUpload
+   * @format url
+   * @uiName Logo Image
+   */
+  imageUrl: string;
+  /**
+   * Page participants are navigated to after clicking the header logo.
+   *
+   * @uiName Redirect Path
+   * @uiWidget pageSelect
+   */
+  nextPage: string;
+  /**
+   * @uiName Logo Height
+   */
+  height: number;
+  constructor();
+  disconnectedCallback(): void;
+  render(): any;
+}

package/dist/types/components/sqm-input-field/sqm-input-field-view.d.ts

@@ -1,7 +1,7 @@
-import { ValidationErrors } from "../sqm-portal-register/useValidationState";
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export interface InputFieldViewProps {
   states: {
-    validationErrors?: ValidationErrors;
+    registrationFormState?: RegistrationFormState;
   };
   content: {
     fieldName: string;

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

@@ -4,14 +4,15 @@ import { InputFieldViewProps } from "./sqm-input-field-view";
  * @uiName Form Input Field
  * @validParents ["sqm-portal-register","sqm-portal-registration-form"]
  * @exampleGroup Microsite Components
- * @example Form Input Field - <sqm-input-field slot="formData" input-label="Field Label" field-type="text" error-message="Cannot be empty"></sqm-input-field>
+ * @example Form Input Field - <sqm-input-field input-label="Field Label" field-type="text" error-message="Cannot be empty"></sqm-input-field>
  */
 export declare class InputField {
   ignored: boolean;
   /**
-   * Used as the key of the inputs value in form data.
+   * This name is used as the key for this form field on submission. The name must be unique within this specific form.
    *
    * @uiName Input Name Attribute
+   * @required
    */
   fieldName: string;
   /**

package/dist/types/components/sqm-input-field/useInputField.d.ts

@@ -1,5 +1,6 @@
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export declare function useInputField(): {
   states: {
-    validationErrors: import("../sqm-portal-register/useValidationState").ValidationErrors;
+    registrationFormState: RegistrationFormState;
   };
 };

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

@@ -1,8 +1,6 @@
-import { ValidationErrors } from "../sqm-portal-register/useValidationState";
 import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export interface NameFieldsViewProps {
   states: {
-    validationErrors?: ValidationErrors;
     registrationFormState?: RegistrationFormState;
     content: {
       firstNameLabel: string;

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

@@ -2,7 +2,6 @@ import { RegistrationFormState } from "../sqm-portal-registration-form/useRegist
 import { NameFields } from "./sqm-name-fields";
 export declare function useNameFields(props: NameFields): {
   states: {
-    validationErrors: import("../sqm-portal-register/useValidationState").ValidationErrors;
     registrationFormState: RegistrationFormState;
     content: {
       lastNameLabel: string;

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

@@ -1,6 +1,6 @@
 /**
  * @uiName Microsite Sidebar
- * @slots [{"name":"", "title":"Sidebar Content", "validChildren":["sqm-navigation-sidebar-item"]}]
+ * @slots [{"name":"", "title":"Sidebar Content"}]
  */
 export declare class NavigationSidebar {
   ignored: boolean;

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

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

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

@@ -5,7 +5,6 @@ export interface PortalPasswordFieldViewProps {
     enableValidation: boolean;
     dynamicValidation: VNode | string;
     registrationFormState: RegistrationFormState;
-    validationErrors: Record<string, string>;
     content: {
       fieldLabel: string;
     };

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

@@ -3,7 +3,6 @@ export interface PasswordFieldViewDemoProps {
   initValue: string;
   states: {
     enableValidation: boolean;
-    validationErrors: Record<string, string>;
     registrationFormState: RegistrationFormState;
     content: {
       fieldLabel: string;
@@ -14,7 +13,7 @@ export interface PasswordFieldViewDemoProps {
  * @uiName Form Password Field
  * @validParents ["sqm-portal-register","sqm-portal-registration-form"]
  * @exampleGroup Microsite Components
- * @example Form Password Field - <sqm-password-field slot="formData" field-label="Password" enable-validation></sqm-password-field>
+ * @example Form Password Field - <sqm-password-field field-label="Password"></sqm-password-field>
  */
 export declare class PortalPasswordField {
   ignored: boolean;
@@ -25,10 +24,10 @@ export declare class PortalPasswordField {
    */
   fieldLabel: string;
   /**
-   * Enable live password validation
-   * @uiName Enable Validation
+   * Disable live password validation
+   * @uiName Disable Validation
    */
-  enableValidation: boolean;
+  disableValidation: boolean;
   /**
    * @undocumented
    * @uiType object

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

@@ -10,25 +10,25 @@ export declare class PortalChangePassword {
    */
   modalChangePasswordHeader: string;
   /**
-   * Modal cancel button text
+   * Found in modal
    *
    * @uiName Cancel Button Text
    */
   cancelText: string;
   /**
-   * Modal change password button text
+   * Found in modal
    *
    * @uiName Change Password Button Text
    */
   changePasswordButtonText: string;
   /**
-   * Password input field label
+   * Found in modal
    *
-   * @uiName Password Label
+   * @uiName New Password Field Label
    */
   passwordFieldLabel: string;
   /**
-   * Password confirmation input field label
+   * Found in modal
    *
    * @uiName Confirm Password Label
    */

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

@@ -3,6 +3,9 @@ export interface PortalEmailVerificationViewProps {
     error: string;
     loading: boolean;
     success: boolean;
+    isVerified?: boolean;
+    loadingVerification?: boolean;
+    countdown?: number;
   };
   callbacks: {
     submit: (event: any) => Promise<void>;
@@ -12,6 +15,8 @@ export interface PortalEmailVerificationViewProps {
     verifyMessage: string;
     emailVerificationHeader: string;
     resendEmailButtonText: string;
+    verificationStatusMessage?: string;
+    verificationLoadingMessage?: string;
   };
 }
 export declare function PortalEmailVerificationView(props: PortalEmailVerificationViewProps): any;

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

@@ -6,9 +6,10 @@ import { PortalEmailVerificationViewProps } from "./sqm-portal-email-verificatio
 export declare class PortalEmailVerification {
   ignored: boolean;
   /**
-   * The microsite page that participants are redirected to from the verification email.
+   * Redirect participants to this page from their verification email.
    *
-   * @uiName Email Redirection Path
+   * @uiName Email Redirect
+   * @uiWidget pageSelect
    */
   redirectPath: string;
   /**
@@ -24,6 +25,16 @@ export declare class PortalEmailVerification {
    * @uiWidget textArea
    */
   verifyMessage: string;
+  /**
+   * @uiName Email Verification Status Text
+   * @uiWidget textArea
+   */
+  verificationStatusMessage: string;
+  /**
+   * @uiName Email Verification Checking Text
+   * @uiWidget textArea
+   */
+  verificationLoadingMessage: string;
   /**
    * @undocumented
    * @uiType object

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

@@ -4,6 +4,9 @@ export declare function usePortalEmailVerification(props: PortalEmailVerificatio
     loading: boolean;
     error: string;
     success: boolean;
+    loadingVerification: boolean;
+    isVerified: boolean;
+    countdown: number;
   };
   callbacks: {
     submit: () => Promise<void>;
@@ -13,5 +16,7 @@ export declare function usePortalEmailVerification(props: PortalEmailVerificatio
     verifyMessage: string;
     emailVerificationHeader: string;
     resendEmailButtonText: string;
+    verificationLoadingMessage: string;
+    verificationStatusMessage: string;
   };
 };

package/dist/types/components/sqm-portal-footer/sqm-portal-footer-view.d.ts

@@ -9,7 +9,7 @@ declare type PortalFooterViewProps = {
   termsText?: string;
   supportText?: string;
   supportEmail?: string;
-  showPoweredBy?: boolean;
+  hidePoweredBy?: boolean;
   poweredByLink?: string;
 };
 export declare function PortalFooterView(props: PortalFooterViewProps): any;

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

@@ -29,9 +29,9 @@ export declare class PortalFooter {
    */
   faqText?: string;
   /**
-   * @uiName Show Powered By SaaSquatch
+   * @uiName Hide Powered By SaaSquatch
    */
-  showPoweredBy: boolean;
+  hidePoweredBy: boolean;
   /**
    * @uiName Powered By Link
    */

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

@@ -6,9 +6,10 @@ import { PortalForgotPasswordViewProps } from "./sqm-portal-forgot-password-view
 export declare class PortalForgotPassword {
   ignored: boolean;
   /**
-   * The microsite page that participants are redirected to from the password reset email.
+   * Redirect participants to this page after they verify their email.
    *
-   * @uiName Email Redirection Path
+   * @uiName Email Redirect
+   * @uiWidget pageSelect
    */
   redirectPath: string;
   /**
@@ -21,6 +22,7 @@ export declare class PortalForgotPassword {
   submitLabel: string;
   /**
    * @uiName Login Redirect Path
+   * @uiWidget pageSelect
    */
   loginPath: string;
   /**

package/dist/types/components/sqm-portal-frame/sqm-portal-frame-view.d.ts

@@ -7,5 +7,6 @@ export interface PortalFrameViewProps {
   callbacks: {
     rerender: Function;
   };
+  notFullScreen?: boolean;
 }
 export declare function PortalFrameView(props: PortalFrameViewProps, children: VNode): any;

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

@@ -6,6 +6,10 @@ import { DemoData } from "../../global/demo";
  */
 export declare class PortalFrame {
   ignored: boolean;
+  /**
+   * @undocumented
+   */
+  notFullScreen?: boolean;
   /**
    * @undocumented
    * @uiType object

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

@@ -6,9 +6,10 @@ import { PortalLoginViewProps } from "./sqm-portal-login-view";
 export declare class PortalLogin {
   ignored: boolean;
   /**
-   * Page participants are navigated to after login.
+   * Redirect participants to this page after they successfully login.
    *
-   * @uiName Login Redirect Path
+   * @uiName Login Redirect
+   * @uiWidget pageSelect
    */
   nextPage: string;
   /**
@@ -24,7 +25,9 @@ export declare class PortalLogin {
    */
   submitLabel: string;
   /**
-   * @uiName Forgot Password Redirect Path
+   * Redirect participants to this page to reset their password
+   * @uiName Forgot Password Redirect
+   * @uiWidget pageSelect
    */
   forgotPasswordPath: string;
   /**
@@ -36,7 +39,9 @@ export declare class PortalLogin {
    */
   registerLabel: string;
   /**
-   * @uiName Register Button Redirect Path
+   * Redirect participants to this page to start registration.
+   * @uiName Register Button Redirect
+   * @uiWidget pageSelect
    */
   registerPath: string;
   /**

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

@@ -4,9 +4,10 @@
 export declare class PortalLogout {
   ignored: boolean;
   /**
-   * Redirect participants to this path when they log out
+   * Redirect participants to this page when they log out.
    *
-   *  @uiName Logout Redirect Path
+   * @uiName Logout Redirect Path
+   * @uiWidget pageSelect
    */
   nextPage: string;
   constructor();

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

@@ -34,11 +34,9 @@ export declare class PortalProfile {
    */
   submitChangeButtonText: string;
   /**
-   * Show or hide the country field.
-   *
-   * @uiName Show Country Field
+   * @uiName Hide Country Field
    */
-  showCountry: boolean;
+  hideCountry: boolean;
   /**
    * @undocumented
    * @uiType object

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

@@ -7,6 +7,6 @@ export interface PortalProfileProps {
   editProfileHeader: string;
   editProfileSubHeader: string;
   submitChangeButtonText: string;
-  showCountry: boolean;
+  hideCountry: boolean;
 }
 export declare function usePortalProfile(props: PortalProfileProps): PortalProfileViewProps;

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

@@ -5,9 +5,9 @@
 export declare class PortalProtectedRoute {
   ignored: boolean;
   /**
-   * Redirect participants to this path they are not logged in.
+   * Redirect participants to this page they are not logged in.
    *
-   * @uiName Redirect Path
+   * @uiName Unauthenticated Participant Redirect
    */
   redirectTo: string;
   /**
@@ -15,9 +15,9 @@ export declare class PortalProtectedRoute {
    */
   requireEmailVerification: boolean;
   /**
-   * Redirect participants to this path when email verification is required but they have not verified their email.
+   * Redirect participants to this page when email verification is required but they have not verified their email.
    *
-   * @uiName Unverified Participant Redirect Path
+   * @uiName Unverified Participant Redirect
    */
   redirectToUnverified: string;
   constructor();

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

@@ -1,13 +1,13 @@
 import { VNode } from "../../stencil-public-runtime";
-import { FormState } from "./useValidationState";
+import { RegistrationFormState } from "../sqm-portal-registration-form/useRegistrationFormState";
 export interface PortalRegisterViewProps {
   states: {
     error: string;
     loading: boolean;
     confirmPassword: boolean;
     hideInputs: boolean;
-    validationState?: FormState;
-    enablePasswordValidation?: boolean;
+    registrationFormState: RegistrationFormState;
+    disablePasswordValidation?: boolean;
     loginPath: string;
   };
   callbacks: {

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

@@ -7,15 +7,17 @@ import { PortalRegisterViewProps } from "./sqm-portal-register-view";
 export declare class PortalRegister {
   ignored: boolean;
   /**
-   * Page participants are navigated to after registration.
+   * Redirect participants to this page from their verification email
    *
-   * @uiName Registration Redirect Path
+   * @uiName Registration Redirect
+   * @uiWidget pageSelect
    */
   nextPage: string;
   /**
    * The page that participants are redirected to from the verification email.
    *
-   * @uiName Email Redirection Path
+   * @uiName Email Verification Redirect
+   * @uiWidget pageSelect
    */
   redirectPath: string;
   /**
@@ -35,23 +37,21 @@ export declare class PortalRegister {
    */
   loginLabel: string;
   /**
-   * @uiName Confirm Password Label
+   * @uiName Confirm Password Field Label
    */
   confirmPasswordLabel: string;
   /**
-   * Show or hide the confirm password input.
-   *
    * @uiName Show Confirm Password Field
    */
   confirmPassword: boolean;
   /**
-   * @uiName Enable Password Validation
+   * @uiName Disable Password Validation
    */
-  enablePasswordValidation: boolean;
+  disablePasswordValidation: boolean;
   /**
-   * Hide default input fields to use custom fields.
+   * Hides the email and password fields. Note: If you hide default inputs, you must add additional input fields. They must have the input name attributes "email" and "password" for this form to succeed.
    *
-   * @uiName Hide Default Inputs
+   * @uiName Hide Default Fields
    */
   hideInputs: boolean;
   /**
@@ -59,9 +59,10 @@ export declare class PortalRegister {
    */
   pageLabel: string;
   /**
-   * Login button redirection path.
+   * Redirect participants to this page after clicking the login button.
    *
-   * @uiName Login Redirect Path
+   * @uiName Login Redirect
+   * @uiWidget pageSelect
    */
   loginPath: string;
   /**

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

@@ -8,10 +8,11 @@ export declare function usePortalRegister(props: PortalRegister): {
   states: {
     loading: boolean;
     error: string;
-    validationState: import("./useValidationState").FormState;
+    registrationFormState: import("../sqm-portal-registration-form/useRegistrationFormState").RegistrationFormState;
     confirmPassword: boolean;
     hideInputs: boolean;
     loginPath: string;
+    disablePasswordValidation: boolean;
   };
   callbacks: {
     submit: (event: any) => Promise<void>;

package/dist/types/components/sqm-portal-registration-form/sqm-portal-registration-form-view.d.ts

@@ -1,5 +1,4 @@
 import { VNode } from "../../stencil-public-runtime";
-import { FormState } from "../sqm-portal-register/useValidationState";
 import { RegistrationFormState } from "./useRegistrationFormState";
 export interface PortalRegistrationFormViewProps {
   states: {
@@ -7,7 +6,6 @@ export interface PortalRegistrationFormViewProps {
     loading: boolean;
     confirmPassword: boolean;
     hideInputs: boolean;
-    validationState?: FormState;
     registrationFormState?: RegistrationFormState;
     enablePasswordValidation?: boolean;
     loginPath: string;
@@ -25,7 +23,12 @@ export interface PortalRegistrationFormViewProps {
     passwordLabel?: string;
     submitLabel?: string;
     pageLabel?: string;
-    confirmPasswordLabel: string;
+    confirmPasswordLabel?: string;
+    networkErrorMessage?: string;
+    passwordMismatchErrorMessage?: string;
+    invalidEmailErrorMessage?: string;
+    formDisabledErrorMessage?: string;
+    requiredFieldErrorMessage?: string;
   };
   refs: {
     formRef: any;

package/dist/types/components/sqm-portal-registration-form/sqm-portal-registration-form.d.ts

@@ -7,15 +7,17 @@ import { PortalRegistrationFormViewProps } from "./sqm-portal-registration-form-
 export declare class PortalRegistrationForm {
   ignored: boolean;
   /**
-   * Page participants are navigated to after registration.
+   * Redirect participants to this page after they successfully register.
    *
-   * @uiName Registration Redirect Path
+   * @uiName Registration Redirect
+   * @uiWidget pageSelect
    */
   nextPage: string;
   /**
-   * The page that participants are redirected to from the verification email.
+   * Redirect participants to this page from their verification email
    *
-   * @uiName Email Redirection Path
+   * @uiName Email Verification Redirect
+   * @uiWidget pageSelect
    */
   redirectPath: string;
   /**
@@ -35,23 +37,21 @@ export declare class PortalRegistrationForm {
    */
   loginLabel: string;
   /**
-   * @uiName Confirm Password Label
+   * @uiName Confirm Password Field Label
    */
   confirmPasswordLabel: string;
   /**
-   * Show or hide the confirm password input.
-   *
    * @uiName Show Confirm Password Field
    */
   confirmPassword: boolean;
   /**
-   * @uiName Enable Password Validation
+   * @uiName Disable Password Validation
    */
-  enablePasswordValidation: boolean;
+  disablePasswordValidation: boolean;
   /**
-   * Hide default input fields to use custom fields.
+   * Hides the email and password fields. Note: If you hide default inputs, you must add additional input fields. They must have the input name attributes "email" and "password" for this form to succeed.
    *
-   * @uiName Hide Default Inputs
+   * @uiName Hide Default Fields
    */
   hideInputs: boolean;
   /**
@@ -59,15 +59,52 @@ export declare class PortalRegistrationForm {
    */
   pageLabel: string;
   /**
-   * Login button redirection path.
+   * Redirect participants to this page after clicking the login button.
    *
-   * @uiName Login Redirect Path
+   * @uiName Login Redirect
+   * @uiWidget pageSelect
    */
   loginPath: string;
   /**
-   * Microsite Registration Form Key
+   * The message to be displayed when a required field is not filled.
+   *
+   * @uiName Required Field Message
+   * @uiWidget textArea
+   */
+  requiredFieldErrorMessage: string;
+  /**
+   * The message to be displayed when a the form submission fails unexpectedly.
+   *
+   * @uiName Network Error Message
+   * @uiWidget textArea
+   */
+  networkErrorMessage: string;
+  /**
+   * The message to be displayed when password inputs do not match.
+   *
+   * @uiName Password Mismatch Message
+   * @uiWidget textArea
+   */
+  passwordMismatchErrorMessage: string;
+  /**
+   * The message to be displayed when the email used is invalid or blocked.
+   *
+   * @uiName Invalid Email Message
+   * @uiWidget textArea
+   */
+  invalidEmailErrorMessage: string;
+  /**
+   * The message to be displayed when the registration form is disabled.
+   *
+   * @uiName Form Disabled Message
+   * @uiWidget textArea
+   */
+  formDisabledErrorMessage: string;
+  /**
+   * The key of the registration form used for this microsite.
    *
    * @uiName Form Key
+   * @required
    */
   formKey: string;
   /**

package/dist/types/components/sqm-portal-registration-form/usePortalRegistrationForm.d.ts

@@ -9,11 +9,11 @@ export declare function usePortalRegistrationForm(props: PortalRegistrationForm)
   states: {
     loading: boolean;
     error: string;
-    validationState: import("../sqm-portal-register/useValidationState").FormState;
     registrationFormState: RegistrationFormState;
     confirmPassword: boolean;
     hideInputs: boolean;
     loginPath: string;
+    enablePasswordValidation: boolean;
   };
   callbacks: {
     submit: (event: any) => Promise<void>;

package/dist/types/components/sqm-portal-registration-form/useRegistrationFormState.d.ts

@@ -1,5 +1,7 @@
 export declare const REGISTRATION_FORM_STATE_CONTEXT = "sq:registration-form-state";
 export declare type RegistrationFormState = {
+  error?: string;
+  validationErrors?: ValidationErrors;
   loading?: boolean;
   disabled?: boolean;
   disabledMessage?: string;