Merge pull request #465 from solocommand/idx-enl-consent

IdentityX fixes, newsletter signup consent
parameter1 · Oct 27, 2022 · e1b8fa0 · e1b8fa0
2 parents c22c9f7 + e9fb865
commit e1b8fa0
Show file tree

Hide file tree

Showing 17 changed files with 98 additions and 42 deletions.
diff --git a/packages/marko-web-identity-x/browser/authenticate.vue b/packages/marko-web-identity-x/browser/authenticate.vue
@@ -16,7 +16,9 @@
       :default-country-code="defaultCountryCode"
       :boolean-questions-label="booleanQuestionsLabel"
       :consent-policy="consentPolicy"
+      :consent-policy-enabled="consentPolicyEnabled"
       :email-consent-request="emailConsentRequest"
+      :email-consent-request-enabled="emailConsentRequestEnabled"
       :regional-consent-policies="regionalConsentPolicies"
       :button-label="buttonLabel"
       :call-to-action="callToAction"
@@ -90,10 +92,18 @@ export default {
       type: String,
       default: null,
     },
+    consentPolicyEnabled: {
+      type: Boolean,
+      default: false,
+    },
     emailConsentRequest: {
       type: String,
       default: null,
     },
+    emailConsentRequestEnabled: {
+      type: Boolean,
+      default: false,
+    },
     regionalConsentPolicies: {
       type: Array,
       default: () => [],
@@ -207,6 +217,8 @@ export default {
           .some(({ hasAnswered, field }) => field.required && !hasAnswered);
 
         this.emit('authenticated', {
+          id: this.activeUser.id,
+          email: this.activeUser.email,
           mustReVerifyProfile: this.mustReVerifyProfile,
           isProfileComplete: this.isProfileComplete,
           requiresCustomFieldAnswers: this.requiresCustomFieldAnswers,

diff --git a/packages/marko-web-identity-x/browser/login.vue b/packages/marko-web-identity-x/browser/login.vue
@@ -36,9 +36,16 @@
         :disabled="loading"
         :label="loginEmailLabel"
       />
+
       <small
-        v-if="consentPolicy"
-        class="text-muted mb-3"
+        v-if="emailConsentRequestEnabled && emailConsentRequest"
+        class="text-muted mb-1 d-block"
+        v-html="emailConsentRequest"
+      />
+
+      <small
+        v-if="consentPolicyEnabled && consentPolicy"
+        class="text-muted mb-1 d-block"
         v-html="consentPolicy"
       />
       <button
@@ -106,6 +113,18 @@ export default {
       type: String,
       default: null,
     },
+    consentPolicyEnabled: {
+      type: Boolean,
+      default: false,
+    },
+    emailConsentRequest: {
+      type: String,
+      default: null,
+    },
+    emailConsentRequestEnabled: {
+      type: Boolean,
+      default: false,
+    },
     redirect: {
       type: String,
       default: null,
@@ -217,7 +236,7 @@ export default {
         const data = await res.json();
         if (!res.ok) throw new FormError(data.message, res.status);
         this.complete = true;
-        this.emit('login-link-sent', { data, source: this.source });
+        this.emit('login-link-sent', { data, email: this.email, source: this.source });
       } catch (e) {
         this.error = e;
         this.emit('login-errored', { message: e.message });

diff --git a/packages/marko-web-identity-x/browser/profile.vue b/packages/marko-web-identity-x/browser/profile.vue
@@ -176,8 +176,10 @@
       :endpoints="endpoints"
       :app-context-id="appContextId"
       :consent-policy="consentPolicy"
+      :consent-policy-enabled="consentPolicyEnabled"
+      :email-consent-request="emailConsentRequest"
+      :email-consent-request-enabled="emailConsentRequestEnabled"
       :regional-consent-policies="regionalConsentPolicies"
-      :required-fields="requiredLoginFields"
     />
   </div>
 </template>
@@ -271,6 +273,18 @@ export default {
       type: String,
       default: null,
     },
+    consentPolicyEnabled: {
+      type: Boolean,
+      default: false,
+    },
+    emailConsentRequest: {
+      type: String,
+      default: null,
+    },
+    emailConsentRequestEnabled: {
+      type: Boolean,
+      default: false,
+    },
     appContextId: {
       type: String,
       default: null,
@@ -279,10 +293,6 @@ export default {
       type: String,
       default: 'Submit',
     },
-    emailConsentRequest: {
-      type: String,
-      default: null,
-    },
     regionalConsentPolicies: {
       type: Array,
       default: () => [],

diff --git a/packages/marko-web-identity-x/components/form-login.marko b/packages/marko-web-identity-x/components/form-login.marko
@@ -17,6 +17,7 @@ $ const additionalEventData = defaultValue(input.additionalEventData, {});
       redirect: input.redirect,
       loginEmailPlaceholder: input.loginEmailPlaceholder,
       consentPolicy: get(application, "organization.consentPolicy"),
+      emailConsentRequest: get(application, "organization.emailConsentRequest"),
       regionalConsentPolicies: get(application, "organization.regionalConsentPolicies"),
       appContextId: identityX.config.get("appContextId"),
     };

diff --git a/packages/marko-web-identity-x/index.js b/packages/marko-web-identity-x/index.js
@@ -15,6 +15,16 @@ module.exports = (app, config, {
   config.endpointTypes.forEach((type) => {
     const endpoint = config.getEndpointFor(type);
     const template = templates[type];
-    if (template) app.get(endpoint, (_, res) => res.marko(template));
+    if (!template) return;
+
+    app.get(endpoint, (req, res) => {
+      const { token } = req.identityX;
+      // Redirect to profile if a user token is already present (refresh after link click)
+      if (type === 'authenticate' && token) {
+        const redirectTo = req.query.redirectTo || config.getEndpointFor('profile');
+        res.redirect(302, redirectTo);
+      }
+      res.marko(template);
+    });
   });
 };
diff --git a/packages/marko-web-identity-x/service.js b/packages/marko-web-identity-x/service.js
@@ -47,10 +47,7 @@ class IdentityX {
    *
    * @returns {Promise<object>}
    */
-  async loadActiveContext({ forceQuery = false, useIps = false } = {}) {
-    // Require a token/cookie to check active context. This disables team context from IP/CIDR.
-    if (!this.token && !useIps) return {};
-
+  async loadActiveContext({ forceQuery = false } = {}) {
     // Only run the active context query once
     if (!this.activeContextQuery || forceQuery) {
       this.activeContextQuery = this.client.query({ query: getActiveContext });

diff --git a/packages/marko-web-omeda-identity-x/add-integration-hooks.js b/packages/marko-web-omeda-identity-x/add-integration-hooks.js
@@ -8,7 +8,6 @@ const props = require('./validation/props');
 const {
   onAuthenticationSuccess,
   onLoginLinkSent,
-  onLogout,
   onUserProfileUpdate,
 } = require('./integration-hooks');
 
@@ -114,19 +113,5 @@ module.exports = (params = {}) => {
     }),
   });
 
-  idxConfig.addHook({
-    name: 'onLogout',
-    shouldAwait: true,
-    fn: async args => onLogout({
-      ...args,
-      ...appendDataFor('onLogout'),
-      behavior: buildBehaviorFor('onLogout', {
-        actionSource: get(args, 'actionSource'),
-        newsletterSignupType: get(args, 'newsletterSignupType'),
-        contentGateType: get(args, 'contentGateType'),
-      }),
-    }),
-  });
-
   return idxConfig;
 };
diff --git a/packages/marko-web-omeda-identity-x/integration-hooks/index.js b/packages/marko-web-omeda-identity-x/integration-hooks/index.js
@@ -1,11 +1,9 @@
 const onAuthenticationSuccess = require('./on-authentication-success');
 const onLoginLinkSent = require('./on-login-link-sent');
-const onLogout = require('./on-logout');
 const onUserProfileUpdate = require('./on-user-profile-update');
 
 module.exports = {
   onAuthenticationSuccess,
   onLoginLinkSent,
-  onLogout,
   onUserProfileUpdate,
 };
diff --git a/packages/marko-web-omeda-identity-x/integration-hooks/on-logout.js b/packages/marko-web-omeda-identity-x/integration-hooks/on-logout.js
diff --git a/packages/marko-web-theme-monorail/browser/idx-newsletter-form/inline.vue b/packages/marko-web-theme-monorail/browser/idx-newsletter-form/inline.vue
@@ -20,7 +20,10 @@
             :button-labels="buttonLabels"
             :redirect="redirect"
             :login-email-placeholder="loginEmailPlaceholder"
+            :consent-policy-enabled="true"
             :consent-policy="consentPolicy"
+            :email-consent-request-enabled="true"
+            :email-consent-request="emailConsentRequest"
             :regional-consent-policies="regionalConsentPolicies"
             :app-context-id="appContextId"
             :login-email-label="translateEmail"
@@ -112,6 +115,10 @@ export default {
       type: String,
       default: null,
     },
+    emailConsentRequest: {
+      type: String,
+      default: null,
+    },
     redirect: {
       type: String,
       default: null,

diff --git a/packages/marko-web-theme-monorail/browser/idx-newsletter-form/pushdown.vue b/packages/marko-web-theme-monorail/browser/idx-newsletter-form/pushdown.vue
@@ -25,7 +25,10 @@
             :button-labels="buttonLabels"
             :redirect="redirect"
             :login-email-placeholder="loginEmailPlaceholder"
+            :consent-policy-enabled="true"
             :consent-policy="consentPolicy"
+            :email-consent-request-enabled="true"
+            :email-consent-request="emailConsentRequest"
             :regional-consent-policies="regionalConsentPolicies"
             :app-context-id="appContextId"
             :action-text="actionText"
@@ -120,6 +123,10 @@ export default {
       type: String,
       default: null,
     },
+    emailConsentRequest: {
+      type: String,
+      default: null,
+    },
     redirect: {
       type: String,
       default: null,

diff --git a/packages/marko-web-theme-monorail/components/identity-x/newsletter-footer.marko b/packages/marko-web-theme-monorail/components/identity-x/newsletter-footer.marko
@@ -42,7 +42,8 @@ $ const lang = site.config.lang || "en";
           redirect: input.redirect,
           loginEmailPlaceholder,
           loginEmailLabel: input.loginEmailLabel,
-          consentPolicy: get(application, "organization.consentPolicy"),
+          consentPolicy: input.consentPolicy || get(application, "organization.consentPolicy"),
+          emailConsentRequest: get(application, "organization.emailConsentRequest"),
           regionalConsentPolicies: get(application, "organization.regionalConsentPolicies"),
           appContextId: identityX.config.get("appContextId"),
         }

diff --git a/packages/marko-web-theme-monorail/components/identity-x/newsletter-inline.marko b/packages/marko-web-theme-monorail/components/identity-x/newsletter-inline.marko
@@ -51,7 +51,8 @@ $ const imageSrcset = imageSrc ? `${imageSrc}&dpr=2 2x` : null;
           redirect: input.redirect,
           loginEmailPlaceholder,
           loginEmailLabel: input.loginEmailLabel,
-          consentPolicy: get(application, "organization.consentPolicy"),
+          consentPolicy: input.consentPolicy || get(application, "organization.consentPolicy"),
+          emailConsentRequest: get(application, "organization.emailConsentRequest"),
           regionalConsentPolicies: get(application, "organization.regionalConsentPolicies"),
           appContextId: identityX.config.get("appContextId"),
         }

diff --git a/packages/marko-web-theme-monorail/components/identity-x/newsletter-pushdown.marko b/packages/marko-web-theme-monorail/components/identity-x/newsletter-pushdown.marko
@@ -49,7 +49,8 @@ $ const imageSrcset = imageSrc ? `${imageSrc}&dpr=2 2x` : null;
           redirect: input.redirect,
           loginEmailPlaceholder,
           loginEmailLabel: input.loginEmailLabel,
-          consentPolicy: get(application, "organization.consentPolicy"),
+          consentPolicy: input.consentPolicy || get(application, "organization.consentPolicy"),
+          emailConsentRequest: get(application, "organization.emailConsentRequest"),
           regionalConsentPolicies: get(application, "organization.regionalConsentPolicies"),
           appContextId: identityX.config.get("appContextId"),
         }

diff --git a/services/example-website/server/components/document.marko b/services/example-website/server/components/document.marko
@@ -44,7 +44,15 @@ $ const { nativeX } = out.global;
   </@above-wrapper>
   <@above-container>
     <marko-web-identity-x-context|{ hasUser, isEnabled }|>
-      <theme-site-header has-user=hasUser reg-enabled=isEnabled show-search-icon=true menu-btn-position="right"/>
+      <theme-site-header
+        has-user=hasUser
+        reg-enabled=isEnabled
+        show-search-icon=true
+        menu-btn-position="right"
+        newsletter-menu-block-props={
+          consentPolicy: 'Custom consent policy - <strong>header</strong>'
+        }
+      />
       <theme-site-menu has-user=hasUser reg-enabled=isEnabled />
     </marko-web-identity-x-context>
     <marko-web-leaders-dropdown-portal />
@@ -53,11 +61,11 @@ $ const { nativeX } = out.global;
   </@above-container>
   <@below-container>
     <${input.belowContainer} />
-    <theme-site-footer>
-      <@newsletter-block>
-        <identity-x-newsletter-form-footer />
-      </@newsletter-block>
-    </theme-site-footer>
+    <theme-site-footer
+      newsletter-block-props={
+        consentPolicy: 'Custom consent policy - footer'
+      }
+    />
     <marko-web-deferred-script-loader-load />
   </@below-container>
 </marko-web-document>
diff --git a/services/example-website/server/templates/index.marko b/services/example-website/server/templates/index.marko
@@ -37,7 +37,7 @@
       <@section>
         <div class="row">
           <div class="col">
-            <identity-x-newsletter-form-inline />
+            <identity-x-newsletter-form-inline type="inlineSection" />
           </div>
         </div>
       </@section>

diff --git a/services/example-website/server/templates/section.marko b/services/example-website/server/templates/section.marko
@@ -36,7 +36,7 @@ $ const { recaptcha } = out.global;
       </div>
       <div class="row pt-1">
         <div class="col">
-          <identity-x-newsletter-form-inline type="inlineSection" />
+          <identity-x-newsletter-form-inline type="inlineSection" consent-policy="custom consent policy - section" />
         </div>
       </div>
     </marko-web-resolve-page>