@blackcode_sa/metaestetics-api 1.12.62 → 1.12.63

package/src/types/calendar/index.ts

@@ -1,258 +1,258 @@
-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
-  NO_SHOW = "no_show", // When event is no-show by the patient
-}
-
-/**
- * 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";
-
-/**
- * Enum for specifying the primary search location for calendar events
- */
-export enum SearchLocationEnum {
-  PRACTITIONER = "practitioner",
-  PATIENT = "patient",
-  CLINIC = "clinic", // Represents searching events associated with a clinic
-}
-
-/**
- * Interface for defining a date range
- */
-export interface DateRange {
-  start: Timestamp;
-  end: Timestamp;
-}
-
-/**
- * Interface for general calendar event search parameters
- */
-export interface SearchCalendarEventsParams {
-  /** The primary location to search within (practitioner, patient, or clinic calendar). */
-  searchLocation: SearchLocationEnum;
-  /** The ID of the entity (practitioner, patient, or clinic) whose calendar/events are being searched. */
-  entityId: string;
-  /** Optional filter for clinic ID. If searchLocation is CLINIC, this is implicitly applied using entityId. */
-  clinicId?: string;
-  /** Optional filter for practitioner ID. */
-  practitionerId?: string;
-  /** Optional filter for patient ID. */
-  patientId?: string;
-  /** Optional filter for procedure ID. */
-  procedureId?: string;
-  /** Optional filter for a specific date range (based on event start time). */
-  dateRange?: DateRange;
-  /** Optional filter for event status. */
-  eventStatus?: CalendarEventStatus;
-  /** Optional filter for event type. */
-  eventType?: CalendarEventType;
-}
-
-/**
- * Interface for creating blocking events
- */
-export interface CreateBlockingEventParams {
-  entityType: "practitioner" | "clinic";
-  entityId: string; // Profile ID of clinic or practitioner, not userRef
-  eventName: string;
-  eventTime: CalendarEventTime;
-  eventType:
-    | CalendarEventType.BLOCKING // Let's only use this enum for doctor's app, then handle more information through description (eg  "Holiday", "Break", "Free Day", "Other")
-    | CalendarEventType.BREAK
-    | CalendarEventType.FREE_DAY
-    | CalendarEventType.OTHER;
-  description?: string;
-}
-
-/**
- * Interface for updating blocking events
- */
-export interface UpdateBlockingEventParams {
-  entityType: "practitioner" | "clinic";
-  entityId: string;
-  eventId: string;
-  eventName?: string;
-  eventTime?: CalendarEventTime;
-  description?: string;
-  status?: CalendarEventStatus;
-}
+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
+  NO_SHOW = "no_show", // When event is no-show by the patient
+}
+
+/**
+ * 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";
+
+/**
+ * Enum for specifying the primary search location for calendar events
+ */
+export enum SearchLocationEnum {
+  PRACTITIONER = "practitioner",
+  PATIENT = "patient",
+  CLINIC = "clinic", // Represents searching events associated with a clinic
+}
+
+/**
+ * Interface for defining a date range
+ */
+export interface DateRange {
+  start: Timestamp;
+  end: Timestamp;
+}
+
+/**
+ * Interface for general calendar event search parameters
+ */
+export interface SearchCalendarEventsParams {
+  /** The primary location to search within (practitioner, patient, or clinic calendar). */
+  searchLocation: SearchLocationEnum;
+  /** The ID of the entity (practitioner, patient, or clinic) whose calendar/events are being searched. */
+  entityId: string;
+  /** Optional filter for clinic ID. If searchLocation is CLINIC, this is implicitly applied using entityId. */
+  clinicId?: string;
+  /** Optional filter for practitioner ID. */
+  practitionerId?: string;
+  /** Optional filter for patient ID. */
+  patientId?: string;
+  /** Optional filter for procedure ID. */
+  procedureId?: string;
+  /** Optional filter for a specific date range (based on event start time). */
+  dateRange?: DateRange;
+  /** Optional filter for event status. */
+  eventStatus?: CalendarEventStatus;
+  /** Optional filter for event type. */
+  eventType?: CalendarEventType;
+}
+
+/**
+ * Interface for creating blocking events
+ */
+export interface CreateBlockingEventParams {
+  entityType: "practitioner" | "clinic";
+  entityId: string; // Profile ID of clinic or practitioner, not userRef
+  eventName: string;
+  eventTime: CalendarEventTime;
+  eventType:
+    | CalendarEventType.BLOCKING // Let's only use this enum for doctor's app, then handle more information through description (eg  "Holiday", "Break", "Free Day", "Other")
+    | CalendarEventType.BREAK
+    | CalendarEventType.FREE_DAY
+    | CalendarEventType.OTHER;
+  description?: string;
+}
+
+/**
+ * Interface for updating blocking events
+ */
+export interface UpdateBlockingEventParams {
+  entityType: "practitioner" | "clinic";
+  entityId: string;
+  eventId: string;
+  eventName?: string;
+  eventTime?: CalendarEventTime;
+  description?: string;
+  status?: CalendarEventStatus;
+}

package/src/types/calendar/synced-calendar.types.ts

@@ -1,66 +1,66 @@
-import { Timestamp, FieldValue } from "firebase/firestore";
-
-/**
- * Enum for synced calendar provider
- */
-export enum SyncedCalendarProvider {
-  GOOGLE = "google",
-  OUTLOOK = "outlook",
-  APPLE = "apple",
-}
-
-/**
- * Interface for synced calendar
- */
-export interface SyncedCalendar {
-  id: string;
-  provider: SyncedCalendarProvider;
-  name: string;
-  description?: string;
-  accessToken: string;
-  refreshToken: string;
-  tokenExpiry: Timestamp;
-  calendarId: string;
-  isActive: boolean;
-  lastSyncedAt?: Timestamp;
-  createdAt: Timestamp;
-  updatedAt: Timestamp;
-}
-
-/**
- * Interface for creating a synced calendar
- */
-export interface CreateSyncedCalendarData {
-  id: string;
-  provider: SyncedCalendarProvider;
-  name: string;
-  description?: string;
-  accessToken: string;
-  refreshToken: string;
-  tokenExpiry: Timestamp;
-  calendarId: string;
-  isActive: boolean;
-  lastSyncedAt?: Timestamp;
-  createdAt: FieldValue;
-  updatedAt: FieldValue;
-}
-
-/**
- * Interface for updating a synced calendar
- */
-export interface UpdateSyncedCalendarData {
-  name?: string;
-  description?: string;
-  accessToken?: string;
-  refreshToken?: string;
-  tokenExpiry?: Timestamp;
-  calendarId?: string;
-  isActive?: boolean;
-  lastSyncedAt?: Timestamp;
-  updatedAt: FieldValue;
-}
-
-/**
- * Collection name for synced calendars
- */
-export const SYNCED_CALENDARS_COLLECTION = "syncedCalendars";
+import { Timestamp, FieldValue } from "firebase/firestore";
+
+/**
+ * Enum for synced calendar provider
+ */
+export enum SyncedCalendarProvider {
+  GOOGLE = "google",
+  OUTLOOK = "outlook",
+  APPLE = "apple",
+}
+
+/**
+ * Interface for synced calendar
+ */
+export interface SyncedCalendar {
+  id: string;
+  provider: SyncedCalendarProvider;
+  name: string;
+  description?: string;
+  accessToken: string;
+  refreshToken: string;
+  tokenExpiry: Timestamp;
+  calendarId: string;
+  isActive: boolean;
+  lastSyncedAt?: Timestamp;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+}
+
+/**
+ * Interface for creating a synced calendar
+ */
+export interface CreateSyncedCalendarData {
+  id: string;
+  provider: SyncedCalendarProvider;
+  name: string;
+  description?: string;
+  accessToken: string;
+  refreshToken: string;
+  tokenExpiry: Timestamp;
+  calendarId: string;
+  isActive: boolean;
+  lastSyncedAt?: Timestamp;
+  createdAt: FieldValue;
+  updatedAt: FieldValue;
+}
+
+/**
+ * Interface for updating a synced calendar
+ */
+export interface UpdateSyncedCalendarData {
+  name?: string;
+  description?: string;
+  accessToken?: string;
+  refreshToken?: string;
+  tokenExpiry?: Timestamp;
+  calendarId?: string;
+  isActive?: boolean;
+  lastSyncedAt?: Timestamp;
+  updatedAt: FieldValue;
+}
+
+/**
+ * Collection name for synced calendars
+ */
+export const SYNCED_CALENDARS_COLLECTION = "syncedCalendars";