@blackcode_sa/metaestetics-api 1.4.18 → 1.5.0

package/src/services/calendar/utils/synced-calendar.utils.ts

@@ -0,0 +1,472 @@
+import {
+  Firestore,
+  collection,
+  doc,
+  getDoc,
+  getDocs,
+  setDoc,
+  updateDoc,
+  deleteDoc,
+  query,
+  where,
+  orderBy,
+  Timestamp,
+  serverTimestamp,
+} from "firebase/firestore";
+import {
+  SyncedCalendar,
+  SyncedCalendarProvider,
+  CreateSyncedCalendarData,
+  UpdateSyncedCalendarData,
+  SYNCED_CALENDARS_COLLECTION,
+} from "../../../types/calendar/synced-calendar.types";
+import {
+  getPractitionerSyncedCalendarDocRef,
+  getPatientSyncedCalendarDocRef,
+  getClinicSyncedCalendarDocRef,
+} from "./docs.utils";
+
+/**
+ * Creates a synced calendar for a practitioner
+ * @param db - Firestore instance
+ * @param practitionerId - ID of the practitioner
+ * @param calendarData - Synced calendar data
+ * @param generateId - Function to generate a unique ID
+ * @returns Created synced calendar
+ */
+export async function createPractitionerSyncedCalendarUtil(
+  db: Firestore,
+  practitionerId: string,
+  calendarData: Omit<
+    CreateSyncedCalendarData,
+    "id" | "createdAt" | "updatedAt"
+  >,
+  generateId: () => string
+): Promise<SyncedCalendar> {
+  const calendarId = generateId();
+  const calendarRef = getPractitionerSyncedCalendarDocRef(
+    db,
+    practitionerId,
+    calendarId
+  );
+
+  const newCalendar: CreateSyncedCalendarData = {
+    id: calendarId,
+    ...calendarData,
+    createdAt: serverTimestamp(),
+    updatedAt: serverTimestamp(),
+  };
+
+  await setDoc(calendarRef, newCalendar);
+
+  // Convert server timestamp to Timestamp for return value
+  return {
+    ...newCalendar,
+    createdAt: Timestamp.now(),
+    updatedAt: Timestamp.now(),
+  } as SyncedCalendar;
+}
+
+/**
+ * Creates a synced calendar for a patient
+ * @param db - Firestore instance
+ * @param patientId - ID of the patient
+ * @param calendarData - Synced calendar data
+ * @param generateId - Function to generate a unique ID
+ * @returns Created synced calendar
+ */
+export async function createPatientSyncedCalendarUtil(
+  db: Firestore,
+  patientId: string,
+  calendarData: Omit<
+    CreateSyncedCalendarData,
+    "id" | "createdAt" | "updatedAt"
+  >,
+  generateId: () => string
+): Promise<SyncedCalendar> {
+  const calendarId = generateId();
+  const calendarRef = getPatientSyncedCalendarDocRef(db, patientId, calendarId);
+
+  const newCalendar: CreateSyncedCalendarData = {
+    id: calendarId,
+    ...calendarData,
+    createdAt: serverTimestamp(),
+    updatedAt: serverTimestamp(),
+  };
+
+  await setDoc(calendarRef, newCalendar);
+
+  // Convert server timestamp to Timestamp for return value
+  return {
+    ...newCalendar,
+    createdAt: Timestamp.now(),
+    updatedAt: Timestamp.now(),
+  } as SyncedCalendar;
+}
+
+/**
+ * Creates a synced calendar for a clinic
+ * @param db - Firestore instance
+ * @param clinicId - ID of the clinic
+ * @param calendarData - Synced calendar data
+ * @param generateId - Function to generate a unique ID
+ * @returns Created synced calendar
+ */
+export async function createClinicSyncedCalendarUtil(
+  db: Firestore,
+  clinicId: string,
+  calendarData: Omit<
+    CreateSyncedCalendarData,
+    "id" | "createdAt" | "updatedAt"
+  >,
+  generateId: () => string
+): Promise<SyncedCalendar> {
+  const calendarId = generateId();
+  const calendarRef = getClinicSyncedCalendarDocRef(db, clinicId, calendarId);
+
+  const newCalendar: CreateSyncedCalendarData = {
+    id: calendarId,
+    ...calendarData,
+    createdAt: serverTimestamp(),
+    updatedAt: serverTimestamp(),
+  };
+
+  await setDoc(calendarRef, newCalendar);
+
+  // Convert server timestamp to Timestamp for return value
+  return {
+    ...newCalendar,
+    createdAt: Timestamp.now(),
+    updatedAt: Timestamp.now(),
+  } as SyncedCalendar;
+}
+
+/**
+ * Gets a synced calendar for a practitioner
+ * @param db - Firestore instance
+ * @param practitionerId - ID of the practitioner
+ * @param calendarId - ID of the synced calendar
+ * @returns Synced calendar or null if not found
+ */
+export async function getPractitionerSyncedCalendarUtil(
+  db: Firestore,
+  practitionerId: string,
+  calendarId: string
+): Promise<SyncedCalendar | null> {
+  const calendarRef = getPractitionerSyncedCalendarDocRef(
+    db,
+    practitionerId,
+    calendarId
+  );
+  const calendarDoc = await getDoc(calendarRef);
+
+  if (!calendarDoc.exists()) {
+    return null;
+  }
+
+  return calendarDoc.data() as SyncedCalendar;
+}
+
+/**
+ * Gets all synced calendars for a practitioner
+ * @param db - Firestore instance
+ * @param practitionerId - ID of the practitioner
+ * @returns Array of synced calendars
+ */
+export async function getPractitionerSyncedCalendarsUtil(
+  db: Firestore,
+  practitionerId: string
+): Promise<SyncedCalendar[]> {
+  const calendarsRef = collection(
+    db,
+    `practitioners/${practitionerId}/${SYNCED_CALENDARS_COLLECTION}`
+  );
+
+  const q = query(calendarsRef, orderBy("createdAt", "desc"));
+  const querySnapshot = await getDocs(q);
+
+  return querySnapshot.docs.map((doc) => doc.data() as SyncedCalendar);
+}
+
+/**
+ * Gets a synced calendar for a patient
+ * @param db - Firestore instance
+ * @param patientId - ID of the patient
+ * @param calendarId - ID of the synced calendar
+ * @returns Synced calendar or null if not found
+ */
+export async function getPatientSyncedCalendarUtil(
+  db: Firestore,
+  patientId: string,
+  calendarId: string
+): Promise<SyncedCalendar | null> {
+  const calendarRef = getPatientSyncedCalendarDocRef(db, patientId, calendarId);
+  const calendarDoc = await getDoc(calendarRef);
+
+  if (!calendarDoc.exists()) {
+    return null;
+  }
+
+  return calendarDoc.data() as SyncedCalendar;
+}
+
+/**
+ * Gets all synced calendars for a patient
+ * @param db - Firestore instance
+ * @param patientId - ID of the patient
+ * @returns Array of synced calendars
+ */
+export async function getPatientSyncedCalendarsUtil(
+  db: Firestore,
+  patientId: string
+): Promise<SyncedCalendar[]> {
+  const calendarsRef = collection(
+    db,
+    `patients/${patientId}/${SYNCED_CALENDARS_COLLECTION}`
+  );
+
+  const q = query(calendarsRef, orderBy("createdAt", "desc"));
+  const querySnapshot = await getDocs(q);
+
+  return querySnapshot.docs.map((doc) => doc.data() as SyncedCalendar);
+}
+
+/**
+ * Gets a synced calendar for a clinic
+ * @param db - Firestore instance
+ * @param clinicId - ID of the clinic
+ * @param calendarId - ID of the synced calendar
+ * @returns Synced calendar or null if not found
+ */
+export async function getClinicSyncedCalendarUtil(
+  db: Firestore,
+  clinicId: string,
+  calendarId: string
+): Promise<SyncedCalendar | null> {
+  const calendarRef = getClinicSyncedCalendarDocRef(db, clinicId, calendarId);
+  const calendarDoc = await getDoc(calendarRef);
+
+  if (!calendarDoc.exists()) {
+    return null;
+  }
+
+  return calendarDoc.data() as SyncedCalendar;
+}
+
+/**
+ * Gets all synced calendars for a clinic
+ * @param db - Firestore instance
+ * @param clinicId - ID of the clinic
+ * @returns Array of synced calendars
+ */
+export async function getClinicSyncedCalendarsUtil(
+  db: Firestore,
+  clinicId: string
+): Promise<SyncedCalendar[]> {
+  const calendarsRef = collection(
+    db,
+    `clinics/${clinicId}/${SYNCED_CALENDARS_COLLECTION}`
+  );
+
+  const q = query(calendarsRef, orderBy("createdAt", "desc"));
+  const querySnapshot = await getDocs(q);
+
+  return querySnapshot.docs.map((doc) => doc.data() as SyncedCalendar);
+}
+
+/**
+ * Updates a synced calendar for a practitioner
+ * @param db - Firestore instance
+ * @param practitionerId - ID of the practitioner
+ * @param calendarId - ID of the synced calendar
+ * @param updateData - Data to update
+ * @returns Updated synced calendar
+ */
+export async function updatePractitionerSyncedCalendarUtil(
+  db: Firestore,
+  practitionerId: string,
+  calendarId: string,
+  updateData: Omit<UpdateSyncedCalendarData, "updatedAt">
+): Promise<SyncedCalendar> {
+  const calendarRef = getPractitionerSyncedCalendarDocRef(
+    db,
+    practitionerId,
+    calendarId
+  );
+
+  const updates: UpdateSyncedCalendarData = {
+    ...updateData,
+    updatedAt: serverTimestamp(),
+  };
+
+  await updateDoc(calendarRef, updates as any);
+
+  // Get the updated document
+  const updatedDoc = await getDoc(calendarRef);
+
+  if (!updatedDoc.exists()) {
+    throw new Error("Synced calendar not found after update");
+  }
+
+  return updatedDoc.data() as SyncedCalendar;
+}
+
+/**
+ * Updates a synced calendar for a patient
+ * @param db - Firestore instance
+ * @param patientId - ID of the patient
+ * @param calendarId - ID of the synced calendar
+ * @param updateData - Data to update
+ * @returns Updated synced calendar
+ */
+export async function updatePatientSyncedCalendarUtil(
+  db: Firestore,
+  patientId: string,
+  calendarId: string,
+  updateData: Omit<UpdateSyncedCalendarData, "updatedAt">
+): Promise<SyncedCalendar> {
+  const calendarRef = getPatientSyncedCalendarDocRef(db, patientId, calendarId);
+
+  const updates: UpdateSyncedCalendarData = {
+    ...updateData,
+    updatedAt: serverTimestamp(),
+  };
+
+  await updateDoc(calendarRef, updates as any);
+
+  // Get the updated document
+  const updatedDoc = await getDoc(calendarRef);
+
+  if (!updatedDoc.exists()) {
+    throw new Error("Synced calendar not found after update");
+  }
+
+  return updatedDoc.data() as SyncedCalendar;
+}
+
+/**
+ * Updates a synced calendar for a clinic
+ * @param db - Firestore instance
+ * @param clinicId - ID of the clinic
+ * @param calendarId - ID of the synced calendar
+ * @param updateData - Data to update
+ * @returns Updated synced calendar
+ */
+export async function updateClinicSyncedCalendarUtil(
+  db: Firestore,
+  clinicId: string,
+  calendarId: string,
+  updateData: Omit<UpdateSyncedCalendarData, "updatedAt">
+): Promise<SyncedCalendar> {
+  const calendarRef = getClinicSyncedCalendarDocRef(db, clinicId, calendarId);
+
+  const updates: UpdateSyncedCalendarData = {
+    ...updateData,
+    updatedAt: serverTimestamp(),
+  };
+
+  await updateDoc(calendarRef, updates as any);
+
+  // Get the updated document
+  const updatedDoc = await getDoc(calendarRef);
+
+  if (!updatedDoc.exists()) {
+    throw new Error("Synced calendar not found after update");
+  }
+
+  return updatedDoc.data() as SyncedCalendar;
+}
+
+/**
+ * Deletes a synced calendar for a practitioner
+ * @param db - Firestore instance
+ * @param practitionerId - ID of the practitioner
+ * @param calendarId - ID of the synced calendar
+ */
+export async function deletePractitionerSyncedCalendarUtil(
+  db: Firestore,
+  practitionerId: string,
+  calendarId: string
+): Promise<void> {
+  const calendarRef = getPractitionerSyncedCalendarDocRef(
+    db,
+    practitionerId,
+    calendarId
+  );
+  await deleteDoc(calendarRef);
+}
+
+/**
+ * Deletes a synced calendar for a patient
+ * @param db - Firestore instance
+ * @param patientId - ID of the patient
+ * @param calendarId - ID of the synced calendar
+ */
+export async function deletePatientSyncedCalendarUtil(
+  db: Firestore,
+  patientId: string,
+  calendarId: string
+): Promise<void> {
+  const calendarRef = getPatientSyncedCalendarDocRef(db, patientId, calendarId);
+  await deleteDoc(calendarRef);
+}
+
+/**
+ * Deletes a synced calendar for a clinic
+ * @param db - Firestore instance
+ * @param clinicId - ID of the clinic
+ * @param calendarId - ID of the synced calendar
+ */
+export async function deleteClinicSyncedCalendarUtil(
+  db: Firestore,
+  clinicId: string,
+  calendarId: string
+): Promise<void> {
+  const calendarRef = getClinicSyncedCalendarDocRef(db, clinicId, calendarId);
+  await deleteDoc(calendarRef);
+}
+
+/**
+ * Updates the last synced timestamp for a synced calendar
+ * @param db - Firestore instance
+ * @param entityType - Type of entity (practitioner, patient, clinic)
+ * @param entityId - ID of the entity
+ * @param calendarId - ID of the synced calendar
+ * @returns Updated synced calendar
+ */
+export async function updateLastSyncedTimestampUtil(
+  db: Firestore,
+  entityType: "practitioner" | "patient" | "clinic",
+  entityId: string,
+  calendarId: string
+): Promise<SyncedCalendar> {
+  const updateData: Omit<UpdateSyncedCalendarData, "updatedAt"> = {
+    lastSyncedAt: Timestamp.now(),
+  };
+
+  switch (entityType) {
+    case "practitioner":
+      return updatePractitionerSyncedCalendarUtil(
+        db,
+        entityId,
+        calendarId,
+        updateData
+      );
+    case "patient":
+      return updatePatientSyncedCalendarUtil(
+        db,
+        entityId,
+        calendarId,
+        updateData
+      );
+    case "clinic":
+      return updateClinicSyncedCalendarUtil(
+        db,
+        entityId,
+        calendarId,
+        updateData
+      );
+    default:
+      throw new Error(`Invalid entity type: ${entityType}`);
+  }
+}

package/src/services/practitioner/practitioner.service.ts

@@ -92,6 +92,7 @@ export class PractitionerService extends BaseService {
         basicInfo: validatedData.basicInfo,
         certification: validatedData.certification,
         clinics: validatedData.clinics || [],
+        clinicWorkingHours: validatedData.clinicWorkingHours || [],
         isActive: validatedData.isActive,
         isVerified: validatedData.isVerified,
         createdAt: serverTimestamp(),

package/src/types/calendar/index.ts

@@ -0,0 +1,187 @@
+import { Timestamp, FieldValue } from "firebase/firestore";
+import type { ClinicLocation } from "../clinic";
+import type {
+  Category,
+  ProcedureFamily,
+  Product,
+  Subcategory,
+  Technology,
+} from "../../backoffice";
+import type { SyncedCalendarProvider } from "./synced-calendar.types";
+import type { Gender } from "../patient";
+import type { PractitionerCertification } from "../practitioner";
+import type { Currency } from "../../backoffice/types/static/pricing.types";
+import type {
+  ClinicInfo,
+  PractitionerProfileInfo,
+  PatientProfileInfo,
+} from "../profile";
+
+/**
+ * Enum for calendar event status
+ */
+export enum CalendarEventStatus {
+  PENDING = "pending", // When event is created, but not confirmed
+  CONFIRMED = "confirmed", // When event is confirmed and ready to be used
+  REJECTED = "rejected", // When event is rejected by the clinic administrator or patient
+  CANCELED = "canceled", // When event is canceled by the patient
+  RESCHEDULED = "rescheduled", // When event is rescheduled by the clinic administrator
+  COMPLETED = "completed", // When event is completed
+}
+
+/**
+ * Enum for calendar event sync status
+ */
+export enum CalendarSyncStatus {
+  INTERNAL = "internal",
+  EXTERNAL = "external",
+}
+
+/**
+ * Enum for calendar event types
+ */
+export enum CalendarEventType {
+  APPOINTMENT = "appointment",
+  BLOCKING = "blocking",
+  BREAK = "break",
+  FREE_DAY = "free_day",
+  OTHER = "other",
+}
+
+/**
+ * Interface for calendar event time
+ */
+export interface CalendarEventTime {
+  start: Timestamp;
+  end: Timestamp;
+}
+
+export interface ProcedureInfo {
+  // TO-DO: Create detailed procedure info when procedures are integrated
+  name: string;
+  description: string;
+  duration: number;
+  price: number;
+  currency: Currency;
+}
+
+export interface ProcedureCategorization {
+  procedureFamily: ProcedureFamily;
+  procedureCategory: Category;
+  procedureSubcategory: Subcategory;
+  procedureTechnology: Technology;
+  procedureProduct: Product;
+}
+
+export interface SyncedCalendarEvent {
+  eventId: string;
+  syncedCalendarProvider: SyncedCalendarProvider;
+  syncedAt: Timestamp; // Timestamp when the event was last synced with the external calendar
+}
+
+/**
+ * Interface for calendar event
+ */
+export interface CalendarEvent {
+  id: string;
+  clinicBranchId?: string | null;
+  clinicBranchInfo?: ClinicInfo | null;
+  practitionerProfileId?: string | null;
+  practitionerProfileInfo?: PractitionerProfileInfo | null;
+  patientProfileId?: string | null;
+  patientProfileInfo?: PatientProfileInfo | null;
+  procedureId?: string | null;
+  procedureInfo?: ProcedureInfo | null;
+  procedureCategorization?: ProcedureCategorization | null;
+  appointmentId?: string | null; // Created when calendar event is confirmed and it's type is APPOINTMENT
+  syncedCalendarEventId?: SyncedCalendarEvent[] | null;
+  eventName: string;
+  eventLocation?: ClinicLocation;
+  eventTime: CalendarEventTime;
+  description?: string;
+  status: CalendarEventStatus;
+  syncStatus: CalendarSyncStatus;
+  eventType: CalendarEventType;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+}
+
+/**
+ * Interface for creating a calendar event
+ */
+export interface CreateCalendarEventData {
+  id: string;
+  clinicBranchId?: string | null;
+  clinicBranchInfo?: ClinicInfo | null;
+  practitionerProfileId?: string | null;
+  practitionerProfileInfo?: PractitionerProfileInfo | null;
+  patientProfileId?: string | null;
+  patientProfileInfo?: PatientProfileInfo | null;
+  procedureId?: string | null;
+  appointmentId?: string | null; // Not needed if event type is not APPOINTMENT, or if there is no automatic appointment confirmation
+  syncedCalendarEventId?: SyncedCalendarEvent[] | null;
+  eventName: string;
+  eventLocation?: ClinicLocation;
+  eventTime: CalendarEventTime;
+  description?: string;
+  status: CalendarEventStatus;
+  syncStatus: CalendarSyncStatus;
+  eventType: CalendarEventType;
+  createdAt: FieldValue;
+  updatedAt: FieldValue;
+}
+
+/**
+ * Interface for updating a calendar event
+ */
+export interface UpdateCalendarEventData {
+  syncedCalendarEventId?: SyncedCalendarEvent[] | null;
+  appointmentId?: string | null; // Updated when calendar event is confirmed and it's type is APPOINTMENT, plus Appointment is created
+  eventName?: string;
+  eventTime?: CalendarEventTime;
+  description?: string;
+  status?: CalendarEventStatus;
+  syncStatus?: CalendarSyncStatus;
+  eventType?: CalendarEventType;
+  updatedAt: FieldValue;
+}
+
+/**
+ * Interface for available time slot
+ */
+export interface TimeSlot {
+  start: Date;
+  end: Date;
+  isAvailable: boolean;
+}
+
+/**
+ * Interface for appointment creation parameters
+ */
+export interface CreateAppointmentParams {
+  clinicId: string;
+  doctorId: string;
+  patientId: string;
+  procedureId: string;
+  eventLocation: ClinicLocation;
+  eventTime: CalendarEventTime;
+  description?: string;
+}
+
+/**
+ * Interface for appointment update parameters
+ */
+export interface UpdateAppointmentParams {
+  appointmentId: string;
+  clinicId: string;
+  doctorId: string;
+  patientId: string;
+  eventTime?: CalendarEventTime;
+  description?: string;
+  status?: CalendarEventStatus;
+}
+
+/**
+ * Collection names for calendar
+ */
+export const CALENDAR_COLLECTION = "calendar";