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

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

@@ -0,0 +1,402 @@
+import { Component, h, Prop, State } from "@stencil/core";
+import { withHooks } from "@saasquatch/stencil-hooks";
+import { PortalProfileView, } from "./sqm-portal-profile-view";
+import { usePortalProfile } from "./usePortalProfile";
+import { getProps } from "../../utils/utils";
+import { isDemo } from "@saasquatch/component-boilerplate";
+import deepmerge from "deepmerge";
+/**
+ * @uiName Microsite Participant Profile
+ * @validParents ["sqm-portal-container","div","sqm-divided-layout","sqm-brand","template"]
+ */
+export class PortalProfile {
+  constructor() {
+    this.ignored = true;
+    /**
+     * @uiName First name label
+     */
+    this.firstnametext = "First Name";
+    /**
+     * @uiName Last name field label
+     */
+    this.lastnametext = "Last Name";
+    /**
+     * @uiName Email field label
+     */
+    this.emailtext = "Email";
+    /**
+     * @uiName Country field label
+     */
+    this.countrytext = "Country";
+    /**
+     * @uiName Edit profile header
+     */
+    this.editProfileHeader = "Edit your profile";
+    /**
+     * @uiName Edit profile sub header
+     */
+    this.editProfileSubHeader = "Personal Information";
+    /**
+     * @uiName Submit changes button text
+     */
+    this.submitChangeButtonText = "Submit Changes";
+    /**
+     * @uiName Hide country field
+     */
+    this.hideCountry = false;
+    /**
+     * @uiName Network request error message
+     * Displayed when the page fails to load due to a network error. The participant can try refreshing the page.
+     */
+    this.networkRequestMessage = "An error occurred while loading this page. Please refresh the page.";
+    /**
+     * @uiName Field empty text
+     */
+    this.fieldEmptyText = "Field is required";
+    /**
+     * @uiName Form error message
+     */
+    this.formErrorText = "Please correct the errors below to update your profile.";
+    /**
+     * @uiName Submission success text
+     */
+    this.submissionSuccessText = "Your profile has been successfully updated.";
+    withHooks(this);
+  }
+  disconnectedCallback() { }
+  render() {
+    const props = isDemo()
+      ? usePortalProfileDemo(getProps(this))
+      : usePortalProfile(getProps(this));
+    return h(PortalProfileView, Object.assign({}, props));
+  }
+  static get is() { return "sqm-portal-profile"; }
+  static get encapsulation() { return "shadow"; }
+  static get properties() { return {
+    "firstnametext": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "First name label",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "firstnametext",
+      "reflect": false,
+      "defaultValue": "\"First Name\""
+    },
+    "lastnametext": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Last name field label",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "lastnametext",
+      "reflect": false,
+      "defaultValue": "\"Last Name\""
+    },
+    "emailtext": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Email field label",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "emailtext",
+      "reflect": false,
+      "defaultValue": "\"Email\""
+    },
+    "countrytext": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Country field label",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "countrytext",
+      "reflect": false,
+      "defaultValue": "\"Country\""
+    },
+    "editProfileHeader": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Edit profile header",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "edit-profile-header",
+      "reflect": false,
+      "defaultValue": "\"Edit your profile\""
+    },
+    "editProfileSubHeader": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Edit profile sub header",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "edit-profile-sub-header",
+      "reflect": false,
+      "defaultValue": "\"Personal Information\""
+    },
+    "submitChangeButtonText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Submit changes button text",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "submit-change-button-text",
+      "reflect": false,
+      "defaultValue": "\"Submit Changes\""
+    },
+    "hideCountry": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Hide country field",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "hide-country",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "networkRequestMessage": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Network request error message\nDisplayed when the page fails to load due to a network error. The participant can try refreshing the page.",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "network-request-message",
+      "reflect": false,
+      "defaultValue": "\"An error occurred while loading this page. Please refresh the page.\""
+    },
+    "fieldEmptyText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Field empty text",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "field-empty-text",
+      "reflect": false,
+      "defaultValue": "\"Field is required\""
+    },
+    "formErrorText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Form error message",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "form-error-text",
+      "reflect": false,
+      "defaultValue": "\"Please correct the errors below to update your profile.\""
+    },
+    "submissionSuccessText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Submission success text",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "submission-success-text",
+      "reflect": false,
+      "defaultValue": "\"Your profile has been successfully updated.\""
+    },
+    "demoData": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "DemoData<PortalProfileViewProps>",
+        "resolved": "{ states?: { success: boolean; loading: boolean; submitDisabled: boolean; showCountry: boolean; formState: { country: string; firstName: string; lastName: string; errors: any; error: string; }; user: { id: string; accountId: string; firstName: string; lastName: string; email: string; countryCode: string; }; text: { firstnametext: string; lastnametext: string; emailtext: string; countrytext: string; editProfileHeader: string; editProfileSubHeader: string; submitChangeButtonText: string; submissionSuccessText?: string; fieldEmptyText?: string; }; }; }",
+        "references": {
+          "DemoData": {
+            "location": "import",
+            "path": "../../global/demo"
+          },
+          "PortalProfileViewProps": {
+            "location": "import",
+            "path": "./sqm-portal-profile-view"
+          }
+        }
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [{
+            "text": undefined,
+            "name": "undocumented"
+          }, {
+            "text": "object",
+            "name": "uiType"
+          }],
+        "text": ""
+      }
+    }
+  }; }
+  static get states() { return {
+    "ignored": {}
+  }; }
+}
+function usePortalProfileDemo(props) {
+  return deepmerge({
+    states: {
+      success: false,
+      loading: false,
+      submitDisabled: false,
+      showCountry: !props.hideCountry,
+      user: {
+        id: "01",
+        accountId: "111100000",
+        firstName: "Joe",
+        lastName: "Smith",
+        email: "jsmith@gmail.com",
+        countryCode: "CA",
+      },
+      text: {
+        firstnametext: props.firstnametext,
+        lastnametext: props.lastnametext,
+        emailtext: props.emailtext,
+        countrytext: props.countrytext,
+        editProfileHeader: props.editProfileHeader,
+        editProfileSubHeader: props.editProfileSubHeader,
+        submitChangeButtonText: props.submitChangeButtonText,
+        submissionSuccessText: props.submissionSuccessText,
+        fieldEmptyText: props.fieldEmptyText,
+      },
+      formState: {
+        country: "Canada",
+        firstName: "Joe",
+        lastName: "Smith",
+        errors: null,
+        error: "",
+      },
+    },
+    callbacks: {
+      onSubmit: (e) => console.log(e),
+      onChange: (e) => console.log(e),
+    },
+  }, props.demoData || {}, { arrayMerge: (_, a) => a });
+}

package/dist/collection/components/sqm-portal-profile/usePortalProfile.js

@@ -0,0 +1,150 @@
+import { useQuery, useMutation, useUserIdentity, } from "@saasquatch/component-boilerplate";
+import { gql } from "graphql-request";
+import { useEffect, useState } from "@saasquatch/universal-hooks";
+import { isEmpty } from "../../utilities";
+const GET_USER = gql `
+  query {
+    viewer {
+      ... on User {
+        id
+        accountId
+        firstName
+        lastName
+        email
+        countryCode
+      }
+    }
+  }
+`;
+const UPSERT_USER = gql `
+  mutation (
+    $id: String!
+    $accountId: String!
+    $firstName: String!
+    $lastName: String!
+  ) {
+    upsertUser(
+      userInput: {
+        id: $id
+        accountId: $accountId
+        firstName: $firstName
+        lastName: $lastName
+      }
+    ) {
+      firstName
+      lastName
+    }
+  }
+`;
+// view doesn't tolerate undefined, even when we're loading
+const defaultFormState = {
+  country: "",
+  email: "",
+  firstName: "",
+  lastName: "",
+  errors: {},
+  error: "",
+};
+export function usePortalProfile(props) {
+  const userIdent = useUserIdentity();
+  const [success, setSuccess] = useState(false);
+  const [userData, setUserData] = useState(undefined);
+  const [formState, setFormState] = useState(defaultFormState);
+  const userDataResponse = useQuery(GET_USER, {}, !(userIdent === null || userIdent === void 0 ? void 0 : userIdent.jwt));
+  const [upsertUser, upsertUserResponse] = useMutation(UPSERT_USER);
+  useEffect(() => {
+    if (upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.loading)
+      return;
+    if (upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.errors) {
+      setFormState((state) => {
+        var _a, _b, _c;
+        return ({
+          ...state,
+          error: (_c = (_b = (_a = upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.errors) === null || _a === void 0 ? void 0 : _a.response) === null || _b === void 0 ? void 0 : _b.errors) === null || _c === void 0 ? void 0 : _c[0].message,
+        });
+      });
+    }
+    else {
+      setUserData((state) => {
+        var _a;
+        return ({
+          ...state,
+          ...(_a = upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.data) === null || _a === void 0 ? void 0 : _a.upsertUser,
+        });
+      });
+      if (upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.data)
+        setSuccess(true);
+    }
+  }, [upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.loading]);
+  useEffect(() => {
+    var _a, _b;
+    setUserData((data) => { var _a; return ({ ...data, ...(_a = userDataResponse === null || userDataResponse === void 0 ? void 0 : userDataResponse.data) === null || _a === void 0 ? void 0 : _a.viewer }); });
+    setFormState({
+      ...defaultFormState,
+      ...(_a = userDataResponse.data) === null || _a === void 0 ? void 0 : _a.viewer,
+      ...(_b = upsertUserResponse.data) === null || _b === void 0 ? void 0 : _b.upsertUser,
+    });
+  }, [userDataResponse === null || userDataResponse === void 0 ? void 0 : userDataResponse.data]);
+  useEffect(() => {
+    var _a, _b;
+    if ((_a = upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.errors) === null || _a === void 0 ? void 0 : _a.message) {
+      setFormState({
+        ...(_b = userDataResponse.data) === null || _b === void 0 ? void 0 : _b.viewer,
+        error: props.networkRequestMessage,
+      });
+    }
+  }, [upsertUserResponse === null || upsertUserResponse === void 0 ? void 0 : upsertUserResponse.errors]);
+  const onSubmit = () => {
+    setSuccess(false);
+    if (formState.firstName && formState.lastName) {
+      upsertUser({
+        id: userIdent === null || userIdent === void 0 ? void 0 : userIdent.id,
+        accountId: userIdent === null || userIdent === void 0 ? void 0 : userIdent.accountId,
+        firstName: formState.firstName,
+        lastName: formState.lastName,
+      });
+      setFormState((s) => ({ ...s, errors: {}, error: "" }));
+      return;
+    }
+    const errors = {};
+    if (!formState.firstName) {
+      errors["firstName"] = { message: props.fieldEmptyText };
+    }
+    if (!formState.lastName) {
+      errors["lastName"] = { message: props.fieldEmptyText };
+    }
+    if (!isEmpty(errors)) {
+      setFormState((e) => ({
+        ...e,
+        error: props.formErrorText,
+      }));
+    }
+    setFormState((e) => ({ ...e, errors }));
+  };
+  return {
+    states: {
+      success,
+      loading: (userDataResponse === null || userDataResponse === void 0 ? void 0 : userDataResponse.loading) || upsertUserResponse.loading,
+      submitDisabled: false,
+      showCountry: !props.hideCountry,
+      formState,
+      user: userData,
+      text: {
+        firstnametext: props.firstnametext,
+        lastnametext: props.lastnametext,
+        countrytext: props.countrytext,
+        emailtext: props.emailtext,
+        editProfileHeader: props.editProfileHeader,
+        editProfileSubHeader: props.editProfileSubHeader,
+        submitChangeButtonText: props.submitChangeButtonText,
+      },
+    },
+    callbacks: {
+      onSubmit,
+      onChange: (e) => {
+        const { name, value } = e.target;
+        setFormState((data) => ({ ...data, [name]: value }));
+      },
+    },
+  };
+}

package/dist/collection/components/sqm-portal-protected-route/sqm-portal-protected-route.js

@@ -0,0 +1,112 @@
+import { isDemo } from "@saasquatch/component-boilerplate";
+import { withHooks } from "@saasquatch/stencil-hooks";
+import { h, Component, Prop, State, Host } from "@stencil/core";
+import { usePortalProtectedRoute } from "./usePortalProtectedRoute";
+/**
+ * @uiName Microsite Protected Route
+ * @validParents ["sqm-portal-container","div","sqm-divided-layout","sqm-brand","template", "sqb-program-section", "sqb-conditional-section"]
+ * @slots [{"name":"","title":"Route Content"}]
+ */
+export class PortalProtectedRoute {
+  constructor() {
+    this.ignored = true;
+    /**
+     * Redirect participants to this page they are not logged in.
+     *
+     * @uiName Unauthenticated participant redirect
+     */
+    this.redirectTo = "/";
+    /**
+     * @uiName Require email verification
+     */
+    this.requireEmailVerification = false;
+    /**
+     * Redirect participants to this page when email verification is required but they have not verified their email.
+     *
+     * @uiName Unverified participant redirect
+     */
+    this.redirectToUnverified = "/emailVerification";
+    withHooks(this);
+  }
+  disconnectedCallback() { }
+  render() {
+    const hasUser = isDemo()
+      ? usePortalProtectedRouteDemo(this)
+      : usePortalProtectedRoute(this);
+    return (h(Host, { style: { display: hasUser ? "contents" : "none" } },
+      h("slot", null)));
+  }
+  static get is() { return "sqm-portal-protected-route"; }
+  static get encapsulation() { return "shadow"; }
+  static get properties() { return {
+    "redirectTo": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Unauthenticated participant redirect",
+            "name": "uiName"
+          }],
+        "text": "Redirect participants to this page they are not logged in."
+      },
+      "attribute": "redirect-to",
+      "reflect": false,
+      "defaultValue": "\"/\""
+    },
+    "requireEmailVerification": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Require email verification",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "require-email-verification",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "redirectToUnverified": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Unverified participant redirect",
+            "name": "uiName"
+          }],
+        "text": "Redirect participants to this page when email verification is required but they have not verified their email."
+      },
+      "attribute": "redirect-to-unverified",
+      "reflect": false,
+      "defaultValue": "\"/emailVerification\""
+    }
+  }; }
+  static get states() { return {
+    "ignored": {}
+  }; }
+}
+function usePortalProtectedRouteDemo({}) {
+  return true;
+}

package/dist/collection/components/sqm-portal-protected-route/usePortalProtectedRoute.js

@@ -0,0 +1,26 @@
+import { useUserIdentity, navigation, useCurrentPage, } from "@saasquatch/component-boilerplate";
+import { useEffect } from "@saasquatch/universal-hooks";
+export function usePortalProtectedRoute({ requireEmailVerification, redirectTo, redirectToUnverified, }) {
+  var _a;
+  const userIdent = useUserIdentity();
+  const authenticated = !!(userIdent === null || userIdent === void 0 ? void 0 : userIdent.jwt);
+  const emailVerified = (_a = userIdent === null || userIdent === void 0 ? void 0 : userIdent.managedIdentity) === null || _a === void 0 ? void 0 : _a.emailVerified;
+  const { pathname, search } = useCurrentPage();
+  const nextPageParam = new URLSearchParams();
+  nextPageParam.append("nextPage", `${pathname}${search}`);
+  useEffect(() => {
+    if (!authenticated) {
+      return navigation.push({
+        pathname: redirectTo,
+        search: "?" + nextPageParam.toString(),
+      });
+    }
+    if (requireEmailVerification && !emailVerified) {
+      return navigation.push({
+        pathname: redirectToUnverified || redirectTo,
+        search: "?" + nextPageParam.toString(),
+      });
+    }
+  }, []);
+  return !!userIdent;
+}