@blackcode_sa/metaestetics-api 1.13.5 → 1.13.8

package/src/types/notifications/index.ts

@@ -1,286 +1,286 @@
-import { Timestamp } from "firebase/firestore";
-import { UserRole } from "../";
-/**
- * Enumeracija koja definiše sve moguće tipove notifikacija
- */
-export enum NotificationType {
-  // --- Appointment Lifecycle & Reminders ---
-  APPOINTMENT_REMINDER = "appointmentReminder", // For upcoming appointments
-  APPOINTMENT_STATUS_CHANGE = "appointmentStatusChange", // Generic for status changes like confirmed, checked-in etc.
-  APPOINTMENT_RESCHEDULED_PROPOSAL = "appointmentRescheduledProposal", // When clinic proposes a new time
-  APPOINTMENT_CANCELLED = "appointmentCancelled", // When an appointment is cancelled
-
-  // --- Requirement-Driven Instructions ---
-  PRE_REQUIREMENT_INSTRUCTION_DUE = "preRequirementInstructionDue",
-  POST_REQUIREMENT_INSTRUCTION_DUE = "postRequirementInstructionDue",
-  REQUIREMENT_INSTRUCTION_DUE = "requirementInstructionDue", // For specific pre/post care instructions
-
-  // --- Form Related ---
-  FORM_REMINDER = "formReminder", // Reminds user to fill a specific form
-  FORM_SUBMISSION_CONFIRMATION = "formSubmissionConfirmation", // Confirms form was submitted
-
-  // --- Patient Engagement ---
-  REVIEW_REQUEST = "reviewRequest", // Request for patient review post-appointment
-  PROCEDURE_RECOMMENDATION = "procedureRecommendation", // Doctor recommended a procedure for follow-up
-
-  // --- Payment Related (Examples) ---
-  PAYMENT_DUE = "paymentDue",
-  PAYMENT_CONFIRMATION = "paymentConfirmation",
-  PAYMENT_FAILED = "paymentFailed",
-
-  // --- General & Administrative ---
-  GENERAL_MESSAGE = "generalMessage", // For general announcements or direct messages
-  ACCOUNT_NOTIFICATION = "accountNotification", // e.g., password change, security alert
-}
-
-export const NOTIFICATIONS_COLLECTION = "notifications";
-
-/**
- * Bazni interfejs za sve notifikacije
- */
-export interface BaseNotification {
-  /** Jedinstveni identifikator notifikacije */
-  id: string;
-
-  /** ID korisnika kome je namenjena notifikacija */
-  userId: string;
-
-  /** Vreme kada notifikacija treba da bude poslata */
-  notificationTime: Timestamp;
-
-  /** Tip notifikacije */
-  notificationType: NotificationType;
-
-  /** Tokeni uređaja na koje treba poslati notifikaciju */
-  notificationTokens: string[];
-
-  /** Status notifikacije */
-  status: NotificationStatus;
-
-  /** Vreme kreiranja */
-  createdAt: Timestamp;
-
-  /** Vreme poslednjeg ažuriranja */
-  updatedAt: Timestamp;
-
-  /** Vreme kada je notifikacija poslata */
-  sentAt?: Timestamp;
-
-  /** Detalji o grešci ako postoje */
-  error?: string;
-
-  /** Naslov notifikacije */
-  title: string;
-
-  /** Tekst notifikacije */
-  body: string;
-
-  /** Da li je notifikacija pročitana */
-  isRead: boolean;
-
-  /** Uloga korisnika kome je namenjena notifikacija */
-  userRole: UserRole;
-
-  // --- Optional Linking IDs ---
-  // These help in managing notifications and for deep-linking in the app.
-  appointmentId?: string; // Associated appointment
-  patientRequirementInstanceId?: string; // Link to PatientRequirementInstance in patient's subcollection
-  instructionId?: string; // Specific instruction ID within a PatientRequirementInstance
-  formId?: string; // Associated form (FilledDocument ID)
-  originalRequirementId?: string; // ID of the base Requirement template
-  transactionId?: string; // Associated payment transaction
-  // Add other relevant linking IDs as needed, e.g., clinicId, practitionerId if notification is for them
-}
-
-/**
- * Status notifikacije
- */
-export enum NotificationStatus {
-  PENDING = "pending",
-  PROCESSING = "processing",
-  SENT = "sent",
-  FAILED = "failed",
-  DELIVERED = "delivered",
-  CANCELLED = "cancelled",
-  PARTIAL_SUCCESS = "partialSuccess",
-}
-
-/**
- * Notifikacija za pre-requirement
- */
-export interface PreRequirementNotification extends BaseNotification {
-  notificationType: NotificationType.PRE_REQUIREMENT_INSTRUCTION_DUE;
-  /** ID tretmana za koji je vezan pre-requirement */
-  treatmentId: string;
-  /** Lista pre-requirements koji treba da se ispune */
-  requirements: string[];
-  /** Rok za ispunjavanje requirements-a */
-  deadline: Timestamp;
-}
-
-/**
- * Notifikacija za post-requirement
- */
-export interface PostRequirementNotification extends BaseNotification {
-  notificationType: NotificationType.POST_REQUIREMENT_INSTRUCTION_DUE;
-  /** ID tretmana za koji je vezan post-requirement */
-  treatmentId: string;
-  /** Lista post-requirements koji treba da se ispune */
-  requirements: string[];
-  /** Rok za ispunjavanje requirements-a */
-  deadline: Timestamp;
-}
-
-/**
- * Notification for a specific instruction from a PatientRequirementInstance.
- * Example: "Do not eat 2 hours before your [Procedure Name] appointment."
- */
-export interface RequirementInstructionDueNotification
-  extends BaseNotification {
-  notificationType: NotificationType.REQUIREMENT_INSTRUCTION_DUE;
-  appointmentId: string; // Mandatory
-  patientRequirementInstanceId: string; // Mandatory
-  instructionId: string; // Mandatory
-  // The 'body' will contain the specific instruction text.
-  // 'title' could be "Upcoming: [Requirement Name]" or similar.
-}
-
-/**
- * Notification reminding about an upcoming appointment.
- * Example: "Reminder: Your appointment for [Procedure Name] is at [Time] today."
- */
-export interface AppointmentReminderNotification extends BaseNotification {
-  notificationType: NotificationType.APPOINTMENT_REMINDER;
-  appointmentId: string; // Mandatory
-  appointmentTime: Timestamp; // For easy access to construct message body
-  procedureName?: string;
-  practitionerName?: string;
-  clinicName?: string;
-}
-
-/**
- * Notification about a change in appointment status (e.g., confirmed, checked-in).
- * Excludes cancellations and reschedule proposals, which have their own types.
- * Example: "Your appointment for [Procedure Name] has been Confirmed."
- */
-export interface AppointmentStatusChangeNotification extends BaseNotification {
-  notificationType: NotificationType.APPOINTMENT_STATUS_CHANGE;
-  appointmentId: string; // Mandatory
-  newStatus: string; // The new AppointmentStatus (e.g., "CONFIRMED", "CHECKED_IN")
-  previousStatus?: string;
-  procedureName?: string;
-}
-
-/**
- * Notification informing the patient that the clinic has proposed a new time for their appointment.
- * Example: "Action Required: [Clinic Name] has proposed a new time for your [Procedure Name] appointment."
- */
-export interface AppointmentRescheduledProposalNotification
-  extends BaseNotification {
-  notificationType: NotificationType.APPOINTMENT_RESCHEDULED_PROPOSAL;
-  appointmentId: string; // Mandatory
-  newProposedStartTime: Timestamp;
-  newProposedEndTime: Timestamp;
-  procedureName?: string;
-  // May include a deep link to confirm/reject reschedule.
-}
-
-/**
- * Notification informing about a cancelled appointment.
- * Example: "Your appointment for [Procedure Name] on [Date] has been cancelled."
- */
-export interface AppointmentCancelledNotification extends BaseNotification {
-  notificationType: NotificationType.APPOINTMENT_CANCELLED;
-  appointmentId: string; // Mandatory
-  reason?: string; // Reason for cancellation
-  cancelledByRole?: UserRole; // Who initiated the cancellation (PATIENT, CLINIC_ADMIN, etc.)
-  procedureName?: string;
-}
-
-/**
- * Notification reminding a user to fill a specific form.
- * Example: "Reminder: Please complete the '[Form Name]' form for your upcoming appointment."
- */
-export interface FormReminderNotification extends BaseNotification {
-  notificationType: NotificationType.FORM_REMINDER;
-  appointmentId: string; // Associated appointment for which the form is required
-  formId: string; // The ID of the FilledDocument instance
-  formName: string; // Display name of the form
-  formDeadline?: Timestamp; // Optional: When the form is due
-}
-
-/**
- * Notification confirming a form submission.
- * Example: "Thank you! Your '[Form Name]' form has been submitted successfully."
- */
-export interface FormSubmissionConfirmationNotification
-  extends BaseNotification {
-  notificationType: NotificationType.FORM_SUBMISSION_CONFIRMATION;
-  appointmentId?: string; // Optional, if form is tied to an appointment
-  formId: string;
-  formName: string;
-}
-
-/**
- * Notification requesting a patient to leave a review after an appointment.
- * Example: "Hope you had a great experience! Would you like to share your feedback for your visit on [Date]?"
- */
-export interface ReviewRequestNotification extends BaseNotification {
-  notificationType: NotificationType.REVIEW_REQUEST;
-  appointmentId: string; // The completed appointment for which review is requested
-  practitionerName?: string;
-  procedureName?: string;
-}
-
-/**
- * Notification for when a doctor recommends a procedure for follow-up.
- * Example: "Dr. Smith recommended [Procedure Name] for you. Suggested timeframe: in 2 weeks"
- */
-export interface ProcedureRecommendationNotification extends BaseNotification {
-  notificationType: NotificationType.PROCEDURE_RECOMMENDATION;
-  appointmentId: string; // The appointment where recommendation was made
-  recommendationId: string; // Format: `${appointmentId}:${index}`
-  procedureId: string;
-  procedureName: string;
-  practitionerName: string;
-  clinicName: string;
-  note?: string; // Doctor's note about the recommendation
-  timeframe: {
-    value: number;
-    unit: 'day' | 'week' | 'month' | 'year';
-  };
-}
-
-/**
- * Generic notification for direct messages or announcements.
- */
-export interface GeneralMessageNotification extends BaseNotification {
-  notificationType: NotificationType.GENERAL_MESSAGE;
-  // Could have senderId, conversationId etc. if it's for a chat-like feature
-}
-
-// Example Payment Notification (can be expanded)
-export interface PaymentConfirmationNotification extends BaseNotification {
-  notificationType: NotificationType.PAYMENT_CONFIRMATION;
-  transactionId: string;
-  appointmentId?: string;
-  amount: string; // e.g., "€50.00"
-}
-
-/**
- * Unija svih tipova notifikacija
- */
-export type Notification =
-  | PreRequirementNotification
-  | PostRequirementNotification
-  | RequirementInstructionDueNotification
-  | AppointmentReminderNotification
-  | AppointmentStatusChangeNotification
-  | AppointmentRescheduledProposalNotification
-  | AppointmentCancelledNotification
-  | FormReminderNotification
-  | FormSubmissionConfirmationNotification
-  | ReviewRequestNotification
-  | ProcedureRecommendationNotification
-  | GeneralMessageNotification
-  | PaymentConfirmationNotification;
+import { Timestamp } from "firebase/firestore";
+import { UserRole } from "../";
+/**
+ * Enumeracija koja definiše sve moguće tipove notifikacija
+ */
+export enum NotificationType {
+  // --- Appointment Lifecycle & Reminders ---
+  APPOINTMENT_REMINDER = "appointmentReminder", // For upcoming appointments
+  APPOINTMENT_STATUS_CHANGE = "appointmentStatusChange", // Generic for status changes like confirmed, checked-in etc.
+  APPOINTMENT_RESCHEDULED_PROPOSAL = "appointmentRescheduledProposal", // When clinic proposes a new time
+  APPOINTMENT_CANCELLED = "appointmentCancelled", // When an appointment is cancelled
+
+  // --- Requirement-Driven Instructions ---
+  PRE_REQUIREMENT_INSTRUCTION_DUE = "preRequirementInstructionDue",
+  POST_REQUIREMENT_INSTRUCTION_DUE = "postRequirementInstructionDue",
+  REQUIREMENT_INSTRUCTION_DUE = "requirementInstructionDue", // For specific pre/post care instructions
+
+  // --- Form Related ---
+  FORM_REMINDER = "formReminder", // Reminds user to fill a specific form
+  FORM_SUBMISSION_CONFIRMATION = "formSubmissionConfirmation", // Confirms form was submitted
+
+  // --- Patient Engagement ---
+  REVIEW_REQUEST = "reviewRequest", // Request for patient review post-appointment
+  PROCEDURE_RECOMMENDATION = "procedureRecommendation", // Doctor recommended a procedure for follow-up
+
+  // --- Payment Related (Examples) ---
+  PAYMENT_DUE = "paymentDue",
+  PAYMENT_CONFIRMATION = "paymentConfirmation",
+  PAYMENT_FAILED = "paymentFailed",
+
+  // --- General & Administrative ---
+  GENERAL_MESSAGE = "generalMessage", // For general announcements or direct messages
+  ACCOUNT_NOTIFICATION = "accountNotification", // e.g., password change, security alert
+}
+
+export const NOTIFICATIONS_COLLECTION = "notifications";
+
+/**
+ * Bazni interfejs za sve notifikacije
+ */
+export interface BaseNotification {
+  /** Jedinstveni identifikator notifikacije */
+  id: string;
+
+  /** ID korisnika kome je namenjena notifikacija */
+  userId: string;
+
+  /** Vreme kada notifikacija treba da bude poslata */
+  notificationTime: Timestamp;
+
+  /** Tip notifikacije */
+  notificationType: NotificationType;
+
+  /** Tokeni uređaja na koje treba poslati notifikaciju */
+  notificationTokens: string[];
+
+  /** Status notifikacije */
+  status: NotificationStatus;
+
+  /** Vreme kreiranja */
+  createdAt: Timestamp;
+
+  /** Vreme poslednjeg ažuriranja */
+  updatedAt: Timestamp;
+
+  /** Vreme kada je notifikacija poslata */
+  sentAt?: Timestamp;
+
+  /** Detalji o grešci ako postoje */
+  error?: string;
+
+  /** Naslov notifikacije */
+  title: string;
+
+  /** Tekst notifikacije */
+  body: string;
+
+  /** Da li je notifikacija pročitana */
+  isRead: boolean;
+
+  /** Uloga korisnika kome je namenjena notifikacija */
+  userRole: UserRole;
+
+  // --- Optional Linking IDs ---
+  // These help in managing notifications and for deep-linking in the app.
+  appointmentId?: string; // Associated appointment
+  patientRequirementInstanceId?: string; // Link to PatientRequirementInstance in patient's subcollection
+  instructionId?: string; // Specific instruction ID within a PatientRequirementInstance
+  formId?: string; // Associated form (FilledDocument ID)
+  originalRequirementId?: string; // ID of the base Requirement template
+  transactionId?: string; // Associated payment transaction
+  // Add other relevant linking IDs as needed, e.g., clinicId, practitionerId if notification is for them
+}
+
+/**
+ * Status notifikacije
+ */
+export enum NotificationStatus {
+  PENDING = "pending",
+  PROCESSING = "processing",
+  SENT = "sent",
+  FAILED = "failed",
+  DELIVERED = "delivered",
+  CANCELLED = "cancelled",
+  PARTIAL_SUCCESS = "partialSuccess",
+}
+
+/**
+ * Notifikacija za pre-requirement
+ */
+export interface PreRequirementNotification extends BaseNotification {
+  notificationType: NotificationType.PRE_REQUIREMENT_INSTRUCTION_DUE;
+  /** ID tretmana za koji je vezan pre-requirement */
+  treatmentId: string;
+  /** Lista pre-requirements koji treba da se ispune */
+  requirements: string[];
+  /** Rok za ispunjavanje requirements-a */
+  deadline: Timestamp;
+}
+
+/**
+ * Notifikacija za post-requirement
+ */
+export interface PostRequirementNotification extends BaseNotification {
+  notificationType: NotificationType.POST_REQUIREMENT_INSTRUCTION_DUE;
+  /** ID tretmana za koji je vezan post-requirement */
+  treatmentId: string;
+  /** Lista post-requirements koji treba da se ispune */
+  requirements: string[];
+  /** Rok za ispunjavanje requirements-a */
+  deadline: Timestamp;
+}
+
+/**
+ * Notification for a specific instruction from a PatientRequirementInstance.
+ * Example: "Do not eat 2 hours before your [Procedure Name] appointment."
+ */
+export interface RequirementInstructionDueNotification
+  extends BaseNotification {
+  notificationType: NotificationType.REQUIREMENT_INSTRUCTION_DUE;
+  appointmentId: string; // Mandatory
+  patientRequirementInstanceId: string; // Mandatory
+  instructionId: string; // Mandatory
+  // The 'body' will contain the specific instruction text.
+  // 'title' could be "Upcoming: [Requirement Name]" or similar.
+}
+
+/**
+ * Notification reminding about an upcoming appointment.
+ * Example: "Reminder: Your appointment for [Procedure Name] is at [Time] today."
+ */
+export interface AppointmentReminderNotification extends BaseNotification {
+  notificationType: NotificationType.APPOINTMENT_REMINDER;
+  appointmentId: string; // Mandatory
+  appointmentTime: Timestamp; // For easy access to construct message body
+  procedureName?: string;
+  practitionerName?: string;
+  clinicName?: string;
+}
+
+/**
+ * Notification about a change in appointment status (e.g., confirmed, checked-in).
+ * Excludes cancellations and reschedule proposals, which have their own types.
+ * Example: "Your appointment for [Procedure Name] has been Confirmed."
+ */
+export interface AppointmentStatusChangeNotification extends BaseNotification {
+  notificationType: NotificationType.APPOINTMENT_STATUS_CHANGE;
+  appointmentId: string; // Mandatory
+  newStatus: string; // The new AppointmentStatus (e.g., "CONFIRMED", "CHECKED_IN")
+  previousStatus?: string;
+  procedureName?: string;
+}
+
+/**
+ * Notification informing the patient that the clinic has proposed a new time for their appointment.
+ * Example: "Action Required: [Clinic Name] has proposed a new time for your [Procedure Name] appointment."
+ */
+export interface AppointmentRescheduledProposalNotification
+  extends BaseNotification {
+  notificationType: NotificationType.APPOINTMENT_RESCHEDULED_PROPOSAL;
+  appointmentId: string; // Mandatory
+  newProposedStartTime: Timestamp;
+  newProposedEndTime: Timestamp;
+  procedureName?: string;
+  // May include a deep link to confirm/reject reschedule.
+}
+
+/**
+ * Notification informing about a cancelled appointment.
+ * Example: "Your appointment for [Procedure Name] on [Date] has been cancelled."
+ */
+export interface AppointmentCancelledNotification extends BaseNotification {
+  notificationType: NotificationType.APPOINTMENT_CANCELLED;
+  appointmentId: string; // Mandatory
+  reason?: string; // Reason for cancellation
+  cancelledByRole?: UserRole; // Who initiated the cancellation (PATIENT, CLINIC_ADMIN, etc.)
+  procedureName?: string;
+}
+
+/**
+ * Notification reminding a user to fill a specific form.
+ * Example: "Reminder: Please complete the '[Form Name]' form for your upcoming appointment."
+ */
+export interface FormReminderNotification extends BaseNotification {
+  notificationType: NotificationType.FORM_REMINDER;
+  appointmentId: string; // Associated appointment for which the form is required
+  formId: string; // The ID of the FilledDocument instance
+  formName: string; // Display name of the form
+  formDeadline?: Timestamp; // Optional: When the form is due
+}
+
+/**
+ * Notification confirming a form submission.
+ * Example: "Thank you! Your '[Form Name]' form has been submitted successfully."
+ */
+export interface FormSubmissionConfirmationNotification
+  extends BaseNotification {
+  notificationType: NotificationType.FORM_SUBMISSION_CONFIRMATION;
+  appointmentId?: string; // Optional, if form is tied to an appointment
+  formId: string;
+  formName: string;
+}
+
+/**
+ * Notification requesting a patient to leave a review after an appointment.
+ * Example: "Hope you had a great experience! Would you like to share your feedback for your visit on [Date]?"
+ */
+export interface ReviewRequestNotification extends BaseNotification {
+  notificationType: NotificationType.REVIEW_REQUEST;
+  appointmentId: string; // The completed appointment for which review is requested
+  practitionerName?: string;
+  procedureName?: string;
+}
+
+/**
+ * Notification for when a doctor recommends a procedure for follow-up.
+ * Example: "Dr. Smith recommended [Procedure Name] for you. Suggested timeframe: in 2 weeks"
+ */
+export interface ProcedureRecommendationNotification extends BaseNotification {
+  notificationType: NotificationType.PROCEDURE_RECOMMENDATION;
+  appointmentId: string; // The appointment where recommendation was made
+  recommendationId: string; // Format: `${appointmentId}:${index}`
+  procedureId: string;
+  procedureName: string;
+  practitionerName: string;
+  clinicName: string;
+  note?: string; // Doctor's note about the recommendation
+  timeframe: {
+    value: number;
+    unit: 'day' | 'week' | 'month' | 'year';
+  };
+}
+
+/**
+ * Generic notification for direct messages or announcements.
+ */
+export interface GeneralMessageNotification extends BaseNotification {
+  notificationType: NotificationType.GENERAL_MESSAGE;
+  // Could have senderId, conversationId etc. if it's for a chat-like feature
+}
+
+// Example Payment Notification (can be expanded)
+export interface PaymentConfirmationNotification extends BaseNotification {
+  notificationType: NotificationType.PAYMENT_CONFIRMATION;
+  transactionId: string;
+  appointmentId?: string;
+  amount: string; // e.g., "€50.00"
+}
+
+/**
+ * Unija svih tipova notifikacija
+ */
+export type Notification =
+  | PreRequirementNotification
+  | PostRequirementNotification
+  | RequirementInstructionDueNotification
+  | AppointmentReminderNotification
+  | AppointmentStatusChangeNotification
+  | AppointmentRescheduledProposalNotification
+  | AppointmentCancelledNotification
+  | FormReminderNotification
+  | FormSubmissionConfirmationNotification
+  | ReviewRequestNotification
+  | ProcedureRecommendationNotification
+  | GeneralMessageNotification
+  | PaymentConfirmationNotification;