@meetelise/chat 1.35.0 → 1.35.2

package/src/fetchBuildingWebchatView.ts

@@ -0,0 +1,176 @@
+import axios from "axios";
+
+export enum DesignConcepts {
+  EMOJI = "emoji",
+  PILLS = "pills",
+  MINIMIZED = "minimized", // this is also mobile
+}
+
+enum TourType {
+  UNKNOWN = "UNKNOWN",
+  SELF_GUIDED = "SELF_GUIDED",
+  VIRTUAL_SHOWING = "VIRTUAL_SHOWING",
+  WITH_AGENT = "WITH_AGENT",
+  MEDIA_TOUR = "MEDIA_TOUR",
+  OPEN_HOUSE_STUDIO = "OPEN_HOUSE_STUDIO",
+  OPEN_HOUSE_1BR = "OPEN_HOUSE_1BR",
+  OPEN_HOUSE_2BR = "OPEN_HOUSE_2BR",
+  OPEN_HOUSE_3BR = "OPEN_HOUSE_3BR",
+  OPEN_HOUSE_4BR = "OPEN_HOUSE_4BR",
+  OPEN_HOUSE_5BR = "OPEN_HOUSE_5BR",
+}
+
+enum TourAccessType {
+  LINK = "link",
+  CLIENT_SCHEDULED = "client_scheduled",
+  SCHEDULED_BY_ME_MANAGED_BY_ME = "scheduled_by_ME_managed_by_ME",
+  SCHEDULED_BY_ME_MANAGED_BY_CLIENT = "scheduled_by_ME_managed_by_client",
+  SCHEDULED_BY_ME_MANAGED_BY_CONCIERGE = "scheduled_by_ME_managed_by_concierge",
+}
+
+export const shouldOpenTourLink = (
+  tourType: string,
+  tourTypeOffered: string
+): boolean => {
+  if (tourType === "self") {
+    const shouldntOpenTourTypesOffered = [
+      "SCHEDULED_BY_ME_MANAGED_BY_ME",
+      "SCHEDULED_BY_ME_MANAGED_BY_CONCIERGE",
+    ];
+    return !shouldntOpenTourTypesOffered.includes(tourTypeOffered);
+  }
+
+  if (tourType === "virtual") {
+    const shouldntOpenTourTypesOffered = ["SCHEDULED_BY_ME_MANAGED_BY_CLIENT"];
+    return !shouldntOpenTourTypesOffered.includes(tourTypeOffered);
+  }
+
+  return true;
+};
+
+export interface LayoutOption {
+  value: number;
+  label: string;
+}
+
+interface TourTypeOption {
+  value: TourType;
+  label: string;
+}
+
+export interface BuildingWebchatView {
+  id: number;
+  orgId: number;
+  name: string;
+  userId: number | null;
+  active: number | null;
+  userFirstName: string;
+  userLastName: string | null;
+  primaryColor: string | null;
+  backgroundColor: string | null;
+  logoSrc: string | null;
+  welcomeMessage: string | null;
+  systemWelcomeMessage: string | null;
+  chatTitle: string | null;
+  chatSubtitle: string | null;
+  bannerColor: string | null;
+  bannerTextColor: string | null;
+  messageColor: string | null;
+  messageTextColor: string | null;
+  launchButtonColor: string | null;
+  launchButtonIconColor: string | null;
+  launchButtonSize: string | null;
+  avatarType: "image" | "initials" | null;
+  avatarSrc: string | null;
+  avatarInitials: string | null;
+  themeId: string;
+  chatCallUsHeader?: string;
+  googleMapsUrl: string | null;
+  chatWidgets?: string[] | null;
+  streetAddress: string | null;
+  postalCode: string | null;
+  state: string | null;
+  phoneNumber: string;
+  textWithUsPhoneNumber: string | null;
+  layoutOptions: LayoutOption[];
+  tourTypeOptions: TourTypeOption[];
+  conversationMaintenanceMode: boolean;
+  sgtUrl: string;
+  escortedToursLink: string;
+  virtualToursLink: string;
+  isVirtualTourEnabled: boolean;
+  isEscortedTourEnabled: boolean;
+  isSelfGuidedTourEnabled: boolean;
+  escortedToursTypeOffered: TourAccessType;
+  virtualToursTypeOffered: TourAccessType;
+  selfGuidedToursTypeOffered: TourAccessType;
+  usesDynamicScheduling: boolean;
+  numAvailableUnits: number;
+  isSchedulingDisabled: boolean;
+  shouldBuildingScheduleTours: boolean;
+  orgLegalName: string;
+  launchedDateTime: Date | null;
+  webchatScopeConfigured: boolean;
+  displayStyle: DesignConcepts;
+  secondaryColor: string | null;
+  foregroundColorOnPrimaryBackgroundColor: string | null;
+  foregroundColorOnSecondaryBackgroundColor: string | null;
+  shouldShowChatDesktop: boolean | null;
+  shouldShowChatMobile: boolean | null;
+  shouldShowTextDesktop: boolean | null;
+  shouldShowTextMobile: boolean | null;
+  shouldShowPhoneDesktop: boolean | null;
+  shouldShowPhoneMobile: boolean | null;
+  shouldShowEmailDesktop: boolean | null;
+  shouldShowEmailMobile: boolean | null;
+  shouldShowSstDesktop: boolean | null;
+  shouldShowSstMobile: boolean | null;
+  shouldShowApplyNowDesktop: boolean | null;
+  shouldShowApplyNowMobile: boolean | null;
+  shouldShowPricingCalculatorDesktop: boolean | null;
+  shouldShowPricingCalculatorMobile: boolean | null;
+  applicationLink: string | null;
+  isLiveOnCollect: boolean | null;
+  isLiveOnApplications: boolean | null;
+  requiresConsentForChat: boolean | null;
+  privacyPolicyUrlForChat: string | null;
+  collapseMobileFeatures: boolean | null;
+  autoOpenChat: boolean | null;
+  isInheritingFromOrg: boolean | null;
+  isGlobalDefault: boolean | null;
+}
+
+/**
+ * Load the publicly-available info for a building.
+ *
+ * @param orgSlug - The org slug, e.g. "big-prop-co"
+ * @param buildingSlug - The buidling slug, e.g. "gravity-falls"
+ * @returns The building's ID, name, theme, and agent.
+ */
+export default async function fetchBuildingWebchatView(
+  orgSlug: string,
+  buildingSlug: string
+): Promise<BuildingWebchatView> {
+  const host = "https://app.meetelise.com";
+  const buildingUrl = `${host}/api/pub/v1/organization/${orgSlug}/building/${buildingSlug}/v2`;
+
+  const buildingResponse = await axios.get(buildingUrl);
+
+  const buildingWebchatView: BuildingWebchatView = buildingResponse.data;
+
+  try {
+    buildingWebchatView.welcomeMessage = replaceName(
+      buildingWebchatView.welcomeMessage ?? "",
+      buildingWebchatView.userFirstName
+    );
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.error(e);
+  }
+  return buildingWebchatView;
+}
+
+const replaceName = (originalText: string, newName: string) => {
+  const regex = /elise/gi;
+  return originalText.replace(regex, newName);
+};

package/src/fetchFeatureFlag.ts

@@ -0,0 +1,250 @@
+import axios from "axios";
+
+// V1 reads from the launch darkly flag
+// Note, in launch darkly we can define the building_id as the user filter and just need to pass
+// the building_slug to the endpoint - we map in the backend
+const featureFlagEndpointV1 = (buildingSlug: string): string => {
+  const host = "https://app.meetelise.com";
+  return `${host}/platformApi/webchat/${buildingSlug}/chat-ui-feature-flag`;
+};
+
+// V2 reads from conversation flag table (preferred)
+const featureFlagEndpointV2 = (buildingSlug: string): string => {
+  const host = "https://app.meetelise.com";
+  return `${host}/platformApi/webchat/${buildingSlug}/v2/chat-ui-feature-flag`;
+};
+
+export enum FeatureFlagsShowDropdown {
+  onAttributionFailure = "on-attribution-failure",
+  never = "never", // note, the dropdown will NOT show up if there are also no lead sources (list)!
+  always = "always",
+}
+
+export async function fetchFeatureFlagMaintenanceMode(
+  buildingSlug: string
+): Promise<boolean> {
+  if (!buildingSlug) {
+    return false;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "bool",
+          feature_flag: "webchat-leasing-in-maintenance-mode",
+          default_str: null,
+          default_bool: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}
+
+export async function fetchFeatureFlagShowMarketingSourceDropdown(
+  buildingSlug: string
+): Promise<FeatureFlagsShowDropdown> {
+  if (!buildingSlug) {
+    return FeatureFlagsShowDropdown.always;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "string",
+          feature_flag: "webchat-marketing-source-dropdown-configuration",
+          default_str: "always",
+          default_bool: true,
+        },
+      }
+    );
+    if (featureFlagResponse.data === "on-attribution-failure") {
+      return FeatureFlagsShowDropdown.onAttributionFailure;
+    }
+    if (featureFlagResponse.data === "never") {
+      return FeatureFlagsShowDropdown.never;
+    }
+    return FeatureFlagsShowDropdown.always;
+  } catch (_) {
+    return FeatureFlagsShowDropdown.always;
+  }
+}
+
+export async function fetchFeatureFlagUsePhoneNumberBySource(
+  buildingSlug: string
+): Promise<boolean> {
+  if (!buildingSlug) {
+    return false;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "bool",
+          feature_flag: "webchat-use-dni-phone-number-by-source",
+          default_str: null,
+          default_bool: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}
+
+export async function fetchFeatureFlagUseOverrideContactUsForm(
+  buildingSlug: string
+): Promise<boolean> {
+  if (!buildingSlug) {
+    return false;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "bool",
+          feature_flag: "webchat-use-override-contact-us-form",
+          default_str: null,
+          default_bool: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}
+export async function fetchFeatureFlagUsePubnub(
+  buildingSlug?: string
+): Promise<boolean> {
+  if (!buildingSlug) {
+    return false;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "bool",
+          feature_flag: "use-pubnub-chat-provider",
+          default_str: null,
+          default_bool: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}
+
+export async function fetchFeatureFlagInsertDNIWebsite(
+  buildingSlug?: string
+): Promise<boolean> {
+  if (!buildingSlug) {
+    return false;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV2(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          feature_flag_name: "insert_dni_into_website",
+          default_value: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}
+
+export async function fetchFeatureFlagShowUtilities(
+  orgSlug: string
+): Promise<boolean> {
+  if (!orgSlug) {
+    return false;
+  }
+  const buildingSlug = "e2e-test-yardi-building";
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "bool",
+          feature_flag: "enable-show-utilities-webchat",
+          default_str: null,
+          default_bool: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}
+
+export async function fetchFeatureFlagReplaceScheduleTourCtaWebsite(
+  buildingSlug: string
+): Promise<boolean> {
+  if (!buildingSlug) {
+    return false;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "bool",
+          feature_flag: "webchat-replace-any-schedule-tour-cta-website",
+          default_str: null,
+          default_bool: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}
+
+export async function fetchFeatureFlagUseApplicationsLinkReplacement(
+  buildingSlug: string
+): Promise<boolean> {
+  if (!buildingSlug) {
+    return false;
+  }
+  try {
+    const featureFlagResponse = await axios.get(
+      featureFlagEndpointV1(buildingSlug),
+      {
+        params: {
+          building_slug: buildingSlug,
+          flag_type: "bool",
+          feature_flag: "webchat-use-applications-link-replacement",
+          default_str: null,
+          default_bool: false,
+        },
+      }
+    );
+    return featureFlagResponse.data;
+  } catch (_) {
+    return false;
+  }
+}

package/src/fetchLeadSources.ts

@@ -0,0 +1,98 @@
+import axios from "axios";
+export interface BuildingABType {
+  abTestType: string;
+}
+export default async function fetchLeadSources(
+  orgSlug: string,
+  buildingSlug: string
+): Promise<string[]> {
+  const host = "https://app.meetelise.com";
+  try {
+    const leadSourcesResponse = await axios.get(
+      `${host}/platformApi/webchat/${buildingSlug}/lead-sources`
+    );
+    if (leadSourcesResponse.data) {
+      if (orgSlug === "7e352741-1120-4ccf-9929-5dc99193a908") {
+        const onlyIncludeSources = [
+          "Zillow",
+          "Apartments.com",
+          "Google PPC",
+          "Google Maps",
+          "Apple Maps",
+          "Social Media",
+          "Print Marketing",
+        ];
+        return leadSourcesResponse.data.filter((source: string) =>
+          onlyIncludeSources.includes(source)
+        );
+      }
+      return filterOutBuildingSpecificLeadSources(
+        leadSourcesResponse.data,
+        buildingSlug
+      );
+    }
+    return [];
+  } catch (_) {
+    return [];
+  }
+}
+
+const filterOutBuildingSpecificLeadSources = (
+  leadSources: string[],
+  buildingSlug: string
+): string[] => {
+  // Dinerstien asked to filter out some sources based on their buildings
+  let removeLeadSources: string[] = [];
+  switch (buildingSlug) {
+    case "d41619ec-0f79-11ee-8439-93855926ad58": // Infinity Lofts in the Gulch
+      removeLeadSources = [
+        "Forthea - PPC",
+        "HotPads",
+        "Forthea",
+        "Locator",
+        "Website-apartmentguide.com",
+        "Forthea - organic search",
+        "Tdc employee",
+        "University newspaper",
+        "Nashville apartment locators",
+        "Forthea - paid social",
+        "Apartment list",
+        "Off campus partners",
+        "Waze ads",
+        "Athletic event",
+        "Website-apartment guide",
+      ];
+      break;
+    case "d4160560-0f79-11ee-8438-fba837bf3a46": // Sawyer on Lincoln
+      removeLeadSources = [
+        "Forthea - PPC",
+        "Rentgrata",
+        "Website-ApartmentFinder.com",
+        "Word of Mouth",
+        "Texas A&M A-Frame on Campus",
+        "Rent.com",
+        "Website-craigslist",
+        "Apartment List",
+        "Website-apartments.com",
+        "Forthea - paid social",
+        "Forthea - organic search",
+        "Website-apartmentguide.com",
+        "Forthea",
+        "Uhomes",
+        "Phone book",
+        "Property - website",
+      ];
+      break;
+    default:
+      removeLeadSources = [];
+  }
+  leadSources.sort();
+  return leadSources.filter((leadSource) => {
+    const lowerCaseLeadSource = leadSource.toLowerCase();
+    const lowerCaseRemoveLeadSources = removeLeadSources.map((source) =>
+      source.toLowerCase()
+    );
+
+    return !lowerCaseRemoveLeadSources.includes(lowerCaseLeadSource);
+  });
+};

package/src/fetchPhoneNumberFromSource.ts

@@ -0,0 +1,31 @@
+import axios from "axios";
+import { formatPhoneNumber } from "./WebComponent/actions/formatPhoneNumber";
+
+export interface NumberForSelectedSource {
+  number: string;
+  isMatch: boolean;
+  isPropertyWebsiteCatchall: boolean;
+}
+
+export default async function fetchPhoneNumberFromSource(
+  buildingSlug: string,
+  source: string | null
+): Promise<NumberForSelectedSource | null> {
+  const host = "https://app.meetelise.com";
+  try {
+    const phoneNumberResponse = await axios.get(
+      `${host}/platformApi/webchat/${buildingSlug}/phone-number-by-source?source=${source}`
+    );
+    if (phoneNumberResponse.data) {
+      return {
+        number: formatPhoneNumber(phoneNumberResponse.data.number),
+        isMatch: phoneNumberResponse.data.match,
+        isPropertyWebsiteCatchall:
+          phoneNumberResponse.data.isPropertyWebsiteCatchall,
+      };
+    }
+    return null;
+  } catch (_) {
+    return null;
+  }
+}

package/src/fetchWebchatPreferences.ts

@@ -0,0 +1,54 @@
+import axios from "axios";
+import { camelize } from "./utils";
+
+/**
+ * @deprecated Use BuildingWebchatView instead.
+ */
+export interface WebchatSettings {
+  config: WebchatConfigurationPreferences;
+  isInheriting: boolean;
+  isGlobalDefault: boolean;
+}
+/**
+ * @deprecated Use BuildingWebchatView instead.
+ */
+export interface WebchatConfigurationPreferences {
+  autoOpenChat: boolean;
+  shouldShowChat: boolean;
+  shouldShowChatDesktop: boolean;
+  shouldShowChatMobile: boolean;
+  shouldShowTextDesktop: boolean;
+  shouldShowTextMobile: boolean;
+  shouldShowPhoneDesktop: boolean;
+  shouldShowPhoneMobile: boolean;
+  shouldShowEmailDesktop: boolean;
+  shouldShowEmailMobile: boolean;
+  shouldShowSstDesktop: boolean;
+  shouldShowSstMobile: boolean;
+  requiresConsentForChat: boolean;
+  privacyPolicyUrlForChat: string | null;
+  collapseMobileFeatures: boolean;
+  isInheritingFromOrg: boolean;
+  isGlobalDefault: boolean;
+}
+
+/**
+ * @deprecated Use BuildingWebchatView instead.
+ */
+export default async function fetchWebchatPreferences(
+  buildingId: number
+): Promise<WebchatSettings | null> {
+  const host = "https://app.meetelise.com";
+  try {
+    const webchatPreferencesResponse = await axios.get(
+      `${host}/eliseCrmApi/webchat/config/v2/building/${buildingId}`
+    );
+
+    if (webchatPreferencesResponse.data) {
+      return camelize<WebchatSettings>(webchatPreferencesResponse.data);
+    }
+  } catch (_) {
+    return null;
+  }
+  return null;
+}