@meetelise/chat 1.15.1 → 1.17.0

package/src/getAvailabilities.ts

@@ -10,31 +10,49 @@ import {
   TourAvailabilityResponseRankOrderedSupportedTourTypesEnum,
 } from "@meetelise/rest-sdk";
 import groupBy from "lodash/groupBy";
+import { TourType } from "./WebComponent/Scheduler/tour-scheduler";
 
 const availabilitiesCache: {
-  [buildingId: number]: TourAvailabilityResponse;
-} = {};
+  buildingId?: number | null;
+  availabilities: { [buildingId: number]: TourAvailabilityResponse };
+} = { buildingId: null, availabilities: {} };
 
+/**
+ * Returns the raw availabilities.
+ *
+ * If no `buildingId` is provided, it will use a cached buildingId from the previous call.
+ * If there is none cached, it will throw an error.
+ */
 export const getRawAvailabilities = async (
-  buildingId: number
+  buildingId?: number
 ): Promise<TourAvailabilityResponse> => {
-  if (availabilitiesCache[buildingId]) {
-    return availabilitiesCache[buildingId];
+  if (buildingId) {
+    availabilitiesCache.buildingId = buildingId;
+  }
+  const buildingIdToUse = availabilitiesCache.buildingId;
+  if (!buildingIdToUse) {
+    throw new Error(
+      "No buildingId was provided to getRawAvailabilities and there is no buildingId cached."
+    );
+  }
+  const availabilities = availabilitiesCache.availabilities;
+  if (availabilities[buildingIdToUse]) {
+    return availabilities[buildingIdToUse];
   }
   const startTime = startOfToday();
   const endTime = formatISO(endOfDay(addDays(startTime, 30)));
-  const url = `https://app.meetelise.com/api/pub/v1/buildings/${buildingId}/tour/availabilities?startTime=${formatISO(
+  const url = `https://app.meetelise.com/api/pub/v1/buildings/${buildingIdToUse}/tour/availabilities?startTime=${formatISO(
     startTime
   )}&endTime=${endTime}`;
   const result = await axios.get<TourAvailabilityResponse>(url);
-  availabilitiesCache[buildingId] = result.data;
+  availabilitiesCache.availabilities[buildingIdToUse] = result.data;
   // The endpoint INCORRECTLY states that these are returned as dates. They are, in fact, strings.
   return result.data;
 };
 
 export const getAvailabilitiesForTourType = async (
-  buildingId: number,
-  tourType: TourAvailabilityResponseRankOrderedSupportedTourTypesEnum
+  tourType: TourAvailabilityResponseRankOrderedSupportedTourTypesEnum,
+  buildingId?: number
 ): Promise<{
   /**
    *
@@ -68,13 +86,46 @@ export interface DateWithTimeZoneOffset {
   offset: string;
 }
 
+/**
+ * Returns an object that reveals whether each tour type supported by
+ * `tour-scheduler` has availabilities (time slots available for scheduling) in
+ * the time window of interest.
+ *
+ * Note that the existence of current availabilities is distinct from the
+ * question of whether the community supports the tour type at all. The first
+ * implies the second but not vice versa.
+ */
+export const getExistenceOfAvailabilitiesByTourType = async (): Promise<{
+  [TourType.Guided]: boolean;
+  [TourType.Self]: boolean;
+  [TourType.Virtual]: boolean;
+}> => {
+  return {
+    [TourType.Guided]: !!(
+      await getAvailabilitiesForTourType(
+        TourAvailabilityResponseRankOrderedSupportedTourTypesEnum.WithAgent
+      )
+    )?.availableTourStartTimes?.length,
+    [TourType.Self]: !!(
+      await getAvailabilitiesForTourType(
+        TourAvailabilityResponseRankOrderedSupportedTourTypesEnum.SelfGuided
+      )
+    )?.availableTourStartTimes?.length,
+    [TourType.Virtual]: !!(
+      await getAvailabilitiesForTourType(
+        TourAvailabilityResponseRankOrderedSupportedTourTypesEnum.VirtualShowing
+      )
+    )?.availableTourStartTimes?.length,
+  };
+};
+
 export const getAvailabilitiesGroupedByDay = async (
-  buildingId: number,
-  tourType: TourAvailabilityResponseRankOrderedSupportedTourTypesEnum
+  tourType: TourAvailabilityResponseRankOrderedSupportedTourTypesEnum,
+  buildingId?: number
 ): Promise<{ [day: string]: DateWithTimeZoneOffset[] }> => {
   const availabilitiesForTourTypeRaw = await getAvailabilitiesForTourType(
-    buildingId,
-    tourType
+    tourType,
+    buildingId
   );
   if (!availabilitiesForTourTypeRaw) {
     return {};
@@ -97,16 +148,6 @@ export const getAvailabilitiesGroupedByDay = async (
   );
 };
 
-// TODO: if cache is empty, observe it and wait for it to be filled in.
-// TODO: alternative to this: cache the building id when getRawAvailabilities is called. Then I can call the normal methods.
-export const getAvailabilitiesGroupedByDayCached = async (
-  tourType: TourAvailabilityResponseRankOrderedSupportedTourTypesEnum
-): Promise<{ [day: string]: DateWithTimeZoneOffset[] }> =>
-  getAvailabilitiesGroupedByDay(
-    Object.keys(availabilitiesCache).map(Number)[0],
-    tourType
-  );
-
 /**
  * Takes an ISO 8601 date string with time zone offset and returns
  * an object of our custom type DateWithTimeZoneOffset.