@salesforcedevs/dw-components 1.3.148-canary.0 → 1.3.148-canary.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dw-components",
-    "version": "1.3.148-canary.0",
+    "version": "1.3.148-canary.2",
     "description": "Lightning web components for https://developer.salesforce.com",
     "license": "MIT",
     "engines": {

package/src/modules/dw/j2sCardSequence/j2sCardSequence.html

@@ -35,6 +35,7 @@
                                 <dw-j2s-form
                                     id={stepDatum.formData.formId}
                                     countries={countries}
+                                    drm-recaptcha-site-key={drmRecaptchaSiteKey}
                                     form-metadata={stepDatum.formMetadata}
                                     incoming-user-info={formIncomingUserInfo}
                                     onformvaliditychange={handleFormValidityChange}
@@ -52,6 +53,7 @@
                         <dx-button
                             class="primary-action"
                             disabled={isJ2sFormInvalid}
+                            href={stepDatum.primaryAction.link}
                             icon-sprite={stepDatum.primaryAction.iconSprite}
                             icon-symbol={stepDatum.primaryAction.iconSymbol}
                             loading={isLoading}

package/src/modules/dw/j2sCardSequence/j2sCardSequence.ts

@@ -1,8 +1,8 @@
 import { api, LightningElement } from "lwc";
 import StepSequence from "dx/stepSequence";
 import { getListWithUuids } from "dxUtils/list";
+import { track } from "dxUtils/analytics";
 import { toJson } from "dxUtils/normalizers";
-import Button from "dx/button";
 
 export type StepDatum = {
     bodyHtml?: string;
@@ -25,23 +25,35 @@ export type StepDatum = {
         textColor?: string;
     };
     primaryAction: {
-        text: string;
-        variant?: string;
         iconSprite?: string;
         iconSymbol?: string;
+        link?: string;
+        text: string;
+        variant?: string;
     };
     secondaryActionHtml?: string;
     showStepNumber?: boolean;
     stepTitle: string;
 };
 
+function isNoAnimationCookieSet() {
+    return document.cookie
+        .split(";")
+        .some((ck) => ck.trim() === "no_j2s_animation=true");
+}
+
 export default class J2sCardSequence extends LightningElement {
+    _didRenderStaticInnerHtml = false;
     _isDrmLoading = false;
+    _isFormSubmitting = false;
     _isJ2sFormInvalid = false;
     _isTbidLoading = false;
     _stepsData: StepDatum[] = [];
     @api animateTransitions = false;
     @api drmDomain: string = "https://drm.my.salesforce-sites.com";
+    @api drmRecaptchaSiteKey: string = "";
+    @api formHandler: string =
+        "https://formhandlermule-1s9xrb.5sc6y6-4.usa-e2.cloudhub.io/form_handler";
     @api tbidApiBaseUrl: string | undefined;
     @api useHistory: boolean = false;
 
@@ -50,9 +62,9 @@ export default class J2sCardSequence extends LightningElement {
         return this._stepsData;
     }
     set stepsData(value) {
+        // normalize incoming value with uuid keys and non-required props (for cleaner HTML template), etc.
         this._stepsData = getListWithUuids<StepDatum>(toJson(value)).map(
             (stepDatum) => {
-                // small bit of normalization for cleaner HTML templates with non-required props, etc.
                 const normalizedStepDatum = {
                     ...stepDatum,
                     headerData: stepDatum.headerData || {},
@@ -83,7 +95,9 @@ export default class J2sCardSequence extends LightningElement {
     private tbidUserInfo: any; // TODO typings?
 
     private get isLoading() {
-        return this._isDrmLoading || this._isTbidLoading;
+        return (
+            this._isDrmLoading || this._isTbidLoading || this._isFormSubmitting
+        );
     }
 
     private get isLoggedIn() {
@@ -150,6 +164,10 @@ export default class J2sCardSequence extends LightningElement {
         // This has to be defined here since it depends on a variable that depends on sessionStorage.
         this.currentSequenceStep = this.initialStepIndex;
         this.resetCustomButtonColors();
+        if (isNoAnimationCookieSet()) {
+            /* eslint-disable-next-line @lwc/lwc/no-api-reassignments */
+            this.animateTransitions = false;
+        }
     }
 
     renderedCallback() {
@@ -157,24 +175,21 @@ export default class J2sCardSequence extends LightningElement {
             return;
         }
 
-        const { bodyHtml, secondaryActionHtml } =
-            this.stepsData[this.currentSequenceStep];
-        const bodyMarkupContainer =
-            this.template.querySelectorAll("span.body-markup")[
-                this.currentSequenceStep
-            ];
-        const secondaryActionMarkupContainer = this.template.querySelectorAll(
-            "span.secondary-action-markup"
-        )[this.currentSequenceStep];
-        if (bodyMarkupContainer) {
-            bodyMarkupContainer.innerHTML = bodyHtml || "";
-        }
-        if (secondaryActionMarkupContainer) {
-            secondaryActionMarkupContainer.innerHTML =
-                secondaryActionHtml || "";
+        if (!this._didRenderStaticInnerHtml) {
+            this.updateStaticInnerHtml();
+            this._didRenderStaticInnerHtml = true;
         }
     }
 
+    handleFormValidityChange({ detail }: CustomEvent) {
+        this.isJ2sFormInvalid = !detail.isValid;
+    }
+
+    handleStepSequenceChange({ detail }: CustomEvent) {
+        this.currentSequenceStep = detail.stepIndex;
+        this.resetCustomButtonColors();
+    }
+
     handleGetStarted(evt: Event) {
         // If the user is not yet logged in, we need to prevent moving immediately to the next
         // step, but set storage up so that they are on the second step when they return to the
@@ -182,32 +197,61 @@ export default class J2sCardSequence extends LightningElement {
         if (!this.isLoggedIn) {
             evt.preventDefault();
             this.initialStepIndex = 1;
+            this._isTbidLoading = true;
             // @ts-ignore: call out to the tbid-controller on DSC
             window.__startTbidLogin();
         }
     }
 
-    handleFormValidityChange({ detail }: CustomEvent) {
-        this.isJ2sFormInvalid = !detail.isValid;
-    }
+    handleFormSubmit(evt: Event) {
+        if (!this.formHandler || this.isJ2sFormInvalid) {
+            return;
+        }
 
-    handleStepSequenceChange({ detail }: CustomEvent) {
-        this.currentSequenceStep = detail.stepIndex;
-        this.resetCustomButtonColors();
+        evt.preventDefault(); // don't proceed automatically to next step
+        this._isFormSubmitting = true;
+
+        try {
+            const formData = (this.template.querySelector("dw-j2s-form") as any)
+                ?.formDataForDrm;
+            // For some countries, explicit approvals will be present; for others, it is implicitly assumed
+            if (typeof formData.Opt_In__c !== "boolean") {
+                formData.Opt_In__c = true;
+            }
+            if (typeof formData.Privacy_Statement__c !== "boolean") {
+                formData.Privacy_Statement__c = true;
+            }
+            console.log("would submit", JSON.stringify(formData, null, 2));
+            this.jumpToStepIndex(2);
+        } catch (ex) {
+            console.log(ex); // TODO
+        }
+
+        this._isFormSubmitting = false;
     }
 
     primaryActionHandler(evt: Event) {
-        if ((evt.target as Button)?.disabled) {
+        const target = evt.target as HTMLButtonElement;
+
+        if (!target || target.disabled) {
             evt.preventDefault();
             return;
         }
 
+        track(target, "custEv_ctaButtonClick", {
+            click_text: target.textContent,
+            element_title: this.stepsData[this.currentSequenceStep].stepTitle,
+            click_url:
+                this.stepsData[this.currentSequenceStep].primaryAction.link ||
+                "",
+            element_type: "button",
+            content_category: "cta"
+        });
+
         if (!this.currentSequenceStep) {
             this.handleGetStarted(evt);
-        } else if (this.currentSequenceStep === 2) {
-            // TODO: send data to DRM
-        } else if (this.currentSequenceStep === 3) {
-            // TODO: Join Slack
+        } else if (this.currentSequenceStep === 1) {
+            this.handleFormSubmit(evt);
         }
     }
 
@@ -237,6 +281,38 @@ export default class J2sCardSequence extends LightningElement {
         );
     }
 
+    private jumpToStepIndex(stepIndex: number) {
+        this.initialStepIndex = stepIndex; // update sessionStorage value
+        ((this.template.querySelector(
+            "dx-step-sequence"
+        ) as unknown) as StepSequence)?.jumpToStep(stepIndex);
+    }
+
+    // HTML is received via config from DSC and should be static after initial render.
+    private updateStaticInnerHtml() {
+        const bodyMarkupContainers = this.template.querySelectorAll(
+            "span.body-markup"
+        );
+        const secondaryActionMarkupContainers = this.template.querySelectorAll(
+            "span.secondary-action-markup"
+        );
+
+        this.stepsData.forEach((step, stepIndex) => {
+            const { bodyHtml, secondaryActionHtml } = step;
+            const bodyMarkupContainer = bodyMarkupContainers[stepIndex];
+            const secondaryActionMarkupContainer =
+                secondaryActionMarkupContainers[stepIndex];
+
+            if (bodyMarkupContainer) {
+                bodyMarkupContainer.innerHTML = bodyHtml || "";
+            }
+            if (secondaryActionMarkupContainer) {
+                secondaryActionMarkupContainer.innerHTML =
+                    secondaryActionHtml || "";
+            }
+        });
+    }
+
     private async getCountryList() {
         this._isDrmLoading = true;
 
@@ -252,6 +328,11 @@ export default class J2sCardSequence extends LightningElement {
             this.countries = JSON.stringify(data);
         } catch (error) {
             console.error(error);
+            if (this.initialStepIndex > 0) {
+                // Page loaded on a step higher than the first, but we can't get data for the form;
+                // send user back to the start for now.
+                this.jumpToStepIndex(0);
+            }
         }
 
         this._isDrmLoading = false;
@@ -272,12 +353,7 @@ export default class J2sCardSequence extends LightningElement {
         if (!this.tbidUserInfo && this.initialStepIndex > 0) {
             // login failed and the user was previously beyond the start step; need to send them
             // back to the start:
-            this.initialStepIndex = 0;
-            (
-                this.template.querySelector(
-                    "dx-step-sequence"
-                ) as unknown as StepSequence
-            )?.jumpToStep(0);
+            this.jumpToStepIndex(0);
         }
 
         this._isTbidLoading = false;

package/src/modules/dw/j2sForm/j2sForm.html

@@ -1,11 +1,12 @@
 <template>
+    <!-- For the names of the form fields, see: https://salesforce.quip.com/daInAFETbPGm -->
     <form class="j2s-form">
         <div class="form-row">
             <dx-input
                 class="first-name-field"
                 label="First Name"
                 missing-error-message="Enter your first name"
-                name="first_name"
+                name="FirstName"
                 placeholder="Your first name"
                 required
                 validity-on-blur
@@ -16,7 +17,7 @@
                 class="last-name-field"
                 label="Last Name"
                 missing-error-message="Enter your last name"
-                name="last_name"
+                name="LastName"
                 placeholder="Your last name"
                 required
                 validity-on-blur
@@ -29,7 +30,7 @@
                 class="company-name-field"
                 label="Company Name"
                 missing-error-message="Enter your company name"
-                name="company_name"
+                name="Company__c"
                 placeholder="Your company name"
                 required
                 validity-on-blur
@@ -41,7 +42,7 @@
                 class="job-role-field"
                 label="Job Role"
                 message-when-value-missing="Select your job role"
-                name="job_role"
+                name="DRM_Role__c"
                 options={jobRoles}
                 placeholder="Select Job Role"
                 value={state.jobRole}
@@ -51,7 +52,7 @@
                 class="job-role-field"
                 label="Job Role"
                 message-when-value-missing="Select your job role"
-                name="job_role"
+                name="DRM_Role__c"
                 options={jobRoles}
                 placeholder="Select Job Role"
                 required
@@ -61,7 +62,7 @@
         </div>
         <div class="form-row">
             <dx-input
-                name="email"
+                name="Email"
                 type="email"
                 placeholder="Your email address"
                 label="Email"
@@ -74,7 +75,7 @@
             <dx-select
                 label="Country/Region"
                 message-when-value-missing="Select your country/region"
-                name="country"
+                name="MailingCountry"
                 options={countries}
                 placeholder="Select Country/Region"
                 required
@@ -84,7 +85,7 @@
         </div>
         <div class="form-row" if:true={isCountryWithReferralInput}>
             <dx-input
-                name="referral_email"
+                name="Referral_Email__c"
                 class="referral-email-field full-width"
                 label="If anyone has referred you, please share their Email ID below, with their consent."
                 type="email"
@@ -102,7 +103,7 @@
             <div class="form-row" if:true={state.showMarketingText}>
                 <dx-checkbox
                     value="marketing-terms"
-                    name="marketing_terms"
+                    name="Opt_In__c"
                     required
                     class="terms"
                     onchange={handleRequiredFieldUpdate}
@@ -127,7 +128,7 @@
                 <dx-checkbox
                     if:true={state.showLegalCheckbox}
                     value="legal-terms"
-                    name="legal_terms"
+                    name="Privacy_Statement__c"
                     required
                     class="terms"
                     onchange={handleRequiredFieldUpdate}
@@ -153,6 +154,7 @@
                     class="legal-terms no-checkbox"
                 ></span>
             </div>
+            <div if:true={recaptcha} class="captcha" lwc:dom="manual"></div>
         </div>
     </form>
 </template>

package/src/modules/dw/j2sForm/j2sForm.ts

@@ -31,13 +31,17 @@ export type J2sFormState = {
 };
 
 export default class J2sForm extends LightningElementWithState<J2sFormState> {
-    private _didSetFormId = false;
-    private _isInitialRender = true;
-    private _incomingUserInfo: any = {}; // TODO typings
-    private _formMetadata: any = {}; // TODO typings
     private _countriesJson = "";
     private _countriesLookup: any = {}; // TODO typings
+    private _didRenderRecaptcha = false;
+    private _didSetFormId = false;
+    private _formMetadata: any = {}; // TODO typings
+    private _incomingUserInfo: any = {}; // TODO typings
+    private _isInitialRender = true;
+
+    @api drmRecaptchaSiteKey = "";
     @api id = "";
+    private recaptcha: any = null;
     @api referralText = "";
 
     @api
@@ -72,6 +76,22 @@ export default class J2sForm extends LightningElementWithState<J2sFormState> {
         this._formMetadata = toJson(value);
     }
 
+    @api
+    get formDataForDrm() {
+        // We should be able to just get the formData from the form automatically using `new FormData(theForm)`,
+        // but our custom form elements don't seem to implement what it is required for that currently. See:
+        // https://web.dev/more-capable-form-controls/#defining-a-form-associated-custom-element
+        const formData: any = {};
+        this.template.querySelectorAll("[name]").forEach((namedElement) => {
+            const typedElement = namedElement as HTMLInputElement;
+            formData[typedElement.name] =
+                typeof typedElement.checked === "boolean"
+                    ? typedElement.checked
+                    : typedElement.value;
+        });
+        return formData;
+    }
+
     private participatingCountryCodes = ["US", "CA", "IN"];
     private countriesWithReferralInput = ["IN"];
     private countriesWithRequiredJobRole = ["CA"];
@@ -118,6 +138,12 @@ export default class J2sForm extends LightningElementWithState<J2sFormState> {
         }
 
         this.state = initialState as J2sFormState;
+
+        if ((window as any).grecaptcha) {
+            this.setRecaptcha();
+        } else {
+            window.addEventListener("recaptchaloaded", this.setRecaptcha);
+        }
     }
 
     renderedCallback(): void {
@@ -141,7 +167,7 @@ export default class J2sForm extends LightningElementWithState<J2sFormState> {
             if (this.state.learnMore) {
                 this.updateInnerHtml(
                     "span.legal-terms-learn-more",
-                    this.state.learnMore
+                    `&nbsp;${this.state.learnMore}`
                 );
             } else {
                 this.updateInnerHtml("span.legal-terms-learn-more", "");
@@ -171,21 +197,33 @@ export default class J2sForm extends LightningElementWithState<J2sFormState> {
             this._didSetFormId = true;
             this.template.querySelector("form")?.setAttribute("id", this.id);
         }
-    }
 
-    private updateInnerHtml(selector: string, html: string): void {
-        const element = this.template.querySelector(selector);
-        if (element) {
-            element.innerHTML = html;
+        if (!this._didRenderRecaptcha && this.recaptcha) {
+            this._didRenderRecaptcha = true;
+            this.recaptcha.render(this.template.querySelector(".captcha"), {
+                sitekey: this.drmRecaptchaSiteKey,
+                callback: (recaptchaToken: string) => {
+                    console.log("got captcha", recaptchaToken);
+                },
+                "expired-callback": () => {},
+                "error-callback": (...args: any[]) => {
+                    console.log("RECAPTCHA ERROR");
+                    console.log(...args);
+                }
+            });
         }
     }
 
-    private isParticipatingCountry(country: string) {
-        return this.participatingCountryCodes.includes(country);
+    disconnectedCallback() {
+        window.removeEventListener("recaptchaloaded", this.setRecaptcha);
     }
 
+    setRecaptcha = () => {
+        this.recaptcha = (window as any).grecaptcha;
+    };
+
     handleRequiredFieldUpdate() {
-        const isFormNowValid = this.checkValidity(this.state.country);
+        const isFormNowValid = this.checkValidity();
         if (this.state.isFormValid !== isFormNowValid) {
             this.setState({
                 isFormValid: isFormNowValid
@@ -196,14 +234,22 @@ export default class J2sForm extends LightningElementWithState<J2sFormState> {
     handleCountryChange({ detail }: CustomEvent) {
         const { value } = detail;
         const countryData = this._countriesLookup[value];
+
         this.setState({
             country: value,
-            isFormValid: this.checkValidity(value),
             learnMore: countryData.learnMore,
             legalText: countryData.legalText,
             marketingText: countryData.marketingText,
             showLegalCheckbox: countryData.showLegalCheckbox
         });
+
+        // Because updating the country can update the required fields, we need to re-set form
+        // validity after render
+        requestAnimationFrame(() =>
+            this.setState({
+                isFormValid: this.checkValidity()
+            })
+        );
     }
 
     handleLearnMore() {
@@ -212,9 +258,20 @@ export default class J2sForm extends LightningElementWithState<J2sFormState> {
             ?.classList.toggle("hidden");
     }
 
-    private checkValidity(country: string) {
+    private updateInnerHtml(selector: string, html: string): void {
+        const element = this.template.querySelector(selector);
+        if (element) {
+            element.innerHTML = html;
+        }
+    }
+
+    private isParticipatingCountry(country: string) {
+        return this.participatingCountryCodes.includes(country);
+    }
+
+    private checkValidity() {
         return (
-            this.isParticipatingCountry(country) &&
+            this.isParticipatingCountry(this.state.country) &&
             this.requiredFormFields.every(
                 (requiredFormField) =>
                     // @ts-ignore