@meetelise/chat 1.58.1 → 1.59.0

package/src/MyPubnub.ts

@@ -1,3 +1,4 @@
+import { getTrackingParams } from "./trackingParams";
 import { AxiosError } from "axios";
 import Pubnub, { ListenerParameters, MessageEvent } from "pubnub";
 
@@ -792,6 +793,7 @@ class MyPubnub {
               buildingSlug: this.buildingSlug,
               userId: this.buildingWebchatView?.userId, // this userid is actually the AI user!
               leadSource: this.leadSource,
+              trackingParams: getTrackingParams(this.orgSlug),
               widgetType: this.widgetType,
               isDevState: shouldCreateAsDevState(location.href),
               // Read by the backend only for orgs in the org-level webchat rollout.

package/src/WebComponent/Scheduler/tour-scheduler.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
+import { getTrackingParams } from "../../trackingParams";
 import { html, LitElement, PropertyValueMap, TemplateResult } from "lit";
 import { customElement, property, query, state } from "lit/decorators.js";
 import "../actions/international-phone-input";
@@ -872,6 +873,7 @@ export class TourScheduler extends LitElement {
       email_address: this.email,
       phone_number: phoneNumber,
       building_id: this.buildingId,
+      tracking_params: getTrackingParams(this.orgSlug),
       first_name: this.firstNameInput?.value ?? this.firstNameInputValue,
       last_name: this.lastNameInput?.value ?? this.lastNameInputValue,
       tour_type: tourTypeForSubmission[this.tourType],

package/src/WebComponent/actions/call-us-window.ts

@@ -1,3 +1,4 @@
+import { getTrackingParams } from "../../trackingParams";
 import axios from "axios";
 import { css, html, LitElement, TemplateResult } from "lit";
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -512,6 +513,7 @@ const createTextWithUs = async (
     // @ts-ignore
     query_params: Object.fromEntries(queryParams.entries()),
     conversation_tracking_id: chatId,
+    tracking_params: getTrackingParams(orgSlug),
     lead_sources_with_timestamps: (leadSourcesWithTimestamps ?? []).map(
       (source) => snakify({ ...source })
     ),

package/src/WebComponent/actions/email-us-window.ts

@@ -1,3 +1,4 @@
+import { getTrackingParams } from "../../trackingParams";
 import { css, html, LitElement, TemplateResult } from "lit";
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import { customElement, property, query, state } from "lit/decorators.js";
@@ -865,6 +866,7 @@ const createEmail = async (
     // @ts-ignore
     query_params: Object.fromEntries(queryParams.entries()),
     conversation_tracking_id: chatId,
+    tracking_params: getTrackingParams(orgSlug),
     lead_sources_with_timestamps: (leadSourcesWithTimestamps ?? []).map(
       (source) => snakify({ ...source })
     ),

package/src/WebComponent/me-chat.ts

@@ -1,3 +1,4 @@
+import { getTrackingParams } from "../trackingParams";
 import { css, html, LitElement, TemplateResult } from "lit";
 import { customElement, property, state } from "lit/decorators.js";
 import { classMap } from "lit/directives/class-map.js";
@@ -1519,6 +1520,7 @@ const overrideContactUsForm = async (
       first_message: formValues.message,
       building_id: buildingWebchatView.id,
       is_external_form: true,
+      tracking_params: getTrackingParams(orgSlug),
       lead_sources: [
         ...new Set(
           leadSource

package/src/trackingParams.test.ts

@@ -0,0 +1,32 @@
+import { expect } from "@esm-bundle/chai";
+import { getTrackingParams } from "./trackingParams";
+
+const originalUrl = window.location.href;
+
+afterEach(() => {
+  localStorage.removeItem("xdtid");
+  window.history.replaceState(null, "", originalUrl);
+});
+
+it("reads Greystar's xdtid from localStorage", () => {
+  localStorage.setItem("xdtid", "from-storage");
+  window.history.replaceState(null, "", "?xdtid=from-url");
+
+  expect(getTrackingParams("greystar")).to.deep.equal({
+    xdtid: "from-storage",
+  });
+});
+
+it("falls back to the xdtid URL param", () => {
+  window.history.replaceState(null, "", "?xdtid=from-url");
+
+  expect(getTrackingParams("greystar")).to.deep.equal({ xdtid: "from-url" });
+});
+
+it("returns null when nothing is found or the org has no config", () => {
+  expect(getTrackingParams("greystar")).to.equal(null);
+
+  localStorage.setItem("xdtid", "from-storage");
+  expect(getTrackingParams("avb")).to.equal(null);
+  expect(getTrackingParams(null)).to.equal(null);
+});

package/src/trackingParams.ts

@@ -0,0 +1,42 @@
+interface TrackingParamSource {
+  key: string;
+  localStorageKey?: string;
+  queryParam?: string;
+}
+
+// Client-specific values sent with each new lead and passed to the client's PMS. Add a client here.
+const TRACKING_PARAMS_BY_ORG_SLUG: Record<string, TrackingParamSource[]> = {
+  // Greystar's cross-domain tracking id, set by their GTM; localStorage outlives the landing URL.
+  greystar: [{ key: "xdtid", localStorageKey: "xdtid", queryParam: "xdtid" }],
+};
+
+const readLocalStorage = (key: string): string | null => {
+  try {
+    return localStorage.getItem(key);
+  } catch (_) {
+    return null;
+  }
+};
+
+const readQueryParam = (key: string): string | null => {
+  try {
+    return new URLSearchParams(window.location.search).get(key);
+  } catch (_) {
+    return null;
+  }
+};
+
+export const getTrackingParams = (
+  orgSlug: string | null | undefined
+): Record<string, string> | null => {
+  const sources = orgSlug ? TRACKING_PARAMS_BY_ORG_SLUG[orgSlug] : undefined;
+  if (!sources) return null;
+  const params: Record<string, string> = {};
+  for (const source of sources) {
+    const value =
+      (source.localStorageKey && readLocalStorage(source.localStorageKey)) ||
+      (source.queryParam && readQueryParam(source.queryParam));
+    if (value) params[source.key] = value;
+  }
+  return Object.keys(params).length ? params : null;
+};