@blackcode_sa/metaestetics-api 1.7.11 → 1.7.13

package/dist/admin/index.d.mts

@@ -171,6 +171,27 @@ interface DocumentTemplate {
     version: number;
     isActive: boolean;
 }
+/**
+ * Interface for a filled document (completed form)
+ */
+interface FilledDocument {
+    id: string;
+    templateId: string;
+    templateVersion: number;
+    isUserForm: boolean;
+    isRequired: boolean;
+    procedureId: string;
+    appointmentId: string;
+    patientId: string;
+    practitionerId: string;
+    clinicId: string;
+    createdAt: number;
+    updatedAt: number;
+    values: {
+        [elementId: string]: any;
+    };
+    status: FilledDocumentStatus;
+}
 /**
  * Enum for filled document status
  */
@@ -219,6 +240,64 @@ interface CertificationRequirement {
     requiredSpecialties?: CertificationSpecialty[];
 }
 
+/**
+ * Review system type definitions
+ */
+/**
+ * Base review interface with common properties
+ */
+interface BaseReview {
+    id: string;
+    fullReviewId: string;
+    patientId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    comment: string;
+    isVerified: boolean;
+    isPublished: boolean;
+}
+/**
+ * Clinic review interface
+ * @description Full review for a clinic
+ */
+interface ClinicReview extends BaseReview {
+    clinicId: string;
+    cleanliness: number;
+    facilities: number;
+    staffFriendliness: number;
+    waitingTime: number;
+    accessibility: number;
+    overallRating: number;
+    wouldRecommend: boolean;
+}
+/**
+ * Practitioner review interface
+ * @description Full review for a healthcare practitioner
+ */
+interface PractitionerReview extends BaseReview {
+    practitionerId: string;
+    knowledgeAndExpertise: number;
+    communicationSkills: number;
+    bedSideManner: number;
+    thoroughness: number;
+    trustworthiness: number;
+    overallRating: number;
+    wouldRecommend: boolean;
+}
+/**
+ * Procedure review interface
+ * @description Full review for a medical procedure
+ */
+interface ProcedureReview extends BaseReview {
+    procedureId: string;
+    effectivenessOfTreatment: number;
+    outcomeExplanation: number;
+    painManagement: number;
+    followUpCare: number;
+    valueForMoney: number;
+    overallRating: number;
+    wouldRecommend: boolean;
+}
 /**
  * Condensed clinic review information
  * @description Used for aggregated data attached to clinic documents
@@ -261,6 +340,22 @@ interface ProcedureReviewInfo {
     valueForMoney: number;
     recommendationPercentage: number;
 }
+/**
+ * Crown review object
+ * @description Combined review data for clinic, practitioner, and procedure
+ */
+interface Review {
+    id: string;
+    appointmentId: string;
+    patientId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    clinicReview?: ClinicReview;
+    practitionerReview?: PractitionerReview;
+    procedureReview?: ProcedureReview;
+    overallComment: string;
+    overallRating: number;
+}
 
 /**
  * Familije procedura u sistemu
@@ -2028,6 +2123,110 @@ declare class AppointmentAggregationService {
     private fetchClinicInfo;
 }
 
+/**
+ * @class FilledFormsAggregationService
+ * @description Handles aggregation tasks related to filled forms data updates.
+ * Updates appointment documents with LinkedFormInfo when forms are created, updated, or deleted.
+ */
+declare class FilledFormsAggregationService {
+    private db;
+    /**
+     * Constructor for FilledFormsAggregationService.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(firestore?: admin.firestore.Firestore);
+    /**
+     * Handles side effects when a filled form is created or updated.
+     * This function would typically be called by a Firestore onCreate or onUpdate trigger.
+     * @param filledDocument The filled document that was created or updated.
+     * @returns {Promise<void>}
+     */
+    handleFilledFormCreateOrUpdate(filledDocument: FilledDocument): Promise<void>;
+    /**
+     * Handles side effects when a filled form is deleted.
+     * This function would typically be called by a Firestore onDelete trigger.
+     * @param filledDocument The filled document that was deleted.
+     * @returns {Promise<void>}
+     */
+    handleFilledFormDelete(filledDocument: FilledDocument): Promise<void>;
+    /**
+     * Updates the appointment's pendingUserFormsIds for a new required user form.
+     * This should be called when a required user form is first created.
+     * @param filledDocument The newly created filled document.
+     * @returns {Promise<void>}
+     */
+    handleRequiredUserFormCreate(filledDocument: FilledDocument): Promise<void>;
+}
+
+/**
+ * @class ReviewsAggregationService
+ * @description Handles aggregation tasks related to review data updates.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the reviews collection.
+ */
+declare class ReviewsAggregationService {
+    private db;
+    /**
+     * Constructor for ReviewsAggregationService.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(firestore?: admin.firestore.Firestore);
+    /**
+     * Process a newly created review and update all related entities
+     * @param review The newly created review
+     * @returns Promise resolving when all updates are complete
+     */
+    processNewReview(review: Review): Promise<void>;
+    /**
+     * Process a deleted review and update all related entities
+     * @param review The deleted review
+     * @returns Promise resolving when all updates are complete
+     */
+    processDeletedReview(review: Review): Promise<void>;
+    /**
+     * Updates the review info for a clinic
+     * @param clinicId The ID of the clinic to update
+     * @param removedReview Optional review being removed
+     * @param isRemoval Whether this update is for a review removal
+     * @returns The updated clinic review info
+     */
+    updateClinicReviewInfo(clinicId: string, removedReview?: ClinicReview, isRemoval?: boolean): Promise<ClinicReviewInfo>;
+    /**
+     * Updates the review info for a practitioner
+     * @param practitionerId The ID of the practitioner to update
+     * @param removedReview Optional review being removed
+     * @param isRemoval Whether this update is for a review removal
+     * @returns The updated practitioner review info
+     */
+    updatePractitionerReviewInfo(practitionerId: string, removedReview?: PractitionerReview, isRemoval?: boolean): Promise<PractitionerReviewInfo>;
+    /**
+     * Updates the review info for a procedure
+     * @param procedureId The ID of the procedure to update
+     * @param removedReview Optional review being removed
+     * @param isRemoval Whether this update is for a review removal
+     * @returns The updated procedure review info
+     */
+    updateProcedureReviewInfo(procedureId: string, removedReview?: ProcedureReview, isRemoval?: boolean): Promise<ProcedureReviewInfo>;
+    /**
+     * Updates doctorInfo rating in all procedures for a practitioner
+     * @param practitionerId The ID of the practitioner
+     * @param rating The new rating to set
+     */
+    private updateDoctorInfoInProcedures;
+    /**
+     * Verifies a review as checked by admin/staff
+     * @param reviewId The ID of the review to verify
+     */
+    verifyReview(reviewId: string): Promise<void>;
+    /**
+     * Calculate the average of all reviews for an entity
+     * @param entityId The entity ID
+     * @param entityType The type of entity ('clinic', 'practitioner', or 'procedure')
+     * @returns Promise that resolves to the calculated review info
+     */
+    calculateEntityReviewInfo(entityId: string, entityType: "clinic" | "practitioner" | "procedure"): Promise<ClinicReviewInfo | PractitionerReviewInfo | ProcedureReviewInfo>;
+}
+
 /**
  * Minimal interface for the new mailgun.js client's messages API
  * This helps avoid a direct dependency on mailgun.js in the API package if not desired,
@@ -2671,4 +2870,4 @@ declare class AppointmentMailingService extends BaseMailingService {
     sendReviewAddedEmail(data: ReviewAddedEmailData): Promise<any>;
 }
 
-export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type ReviewAddedEmailData, type ReviewRequestEmailData, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole };
+export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole };

package/dist/admin/index.d.ts

@@ -171,6 +171,27 @@ interface DocumentTemplate {
     version: number;
     isActive: boolean;
 }
+/**
+ * Interface for a filled document (completed form)
+ */
+interface FilledDocument {
+    id: string;
+    templateId: string;
+    templateVersion: number;
+    isUserForm: boolean;
+    isRequired: boolean;
+    procedureId: string;
+    appointmentId: string;
+    patientId: string;
+    practitionerId: string;
+    clinicId: string;
+    createdAt: number;
+    updatedAt: number;
+    values: {
+        [elementId: string]: any;
+    };
+    status: FilledDocumentStatus;
+}
 /**
  * Enum for filled document status
  */
@@ -219,6 +240,64 @@ interface CertificationRequirement {
     requiredSpecialties?: CertificationSpecialty[];
 }
 
+/**
+ * Review system type definitions
+ */
+/**
+ * Base review interface with common properties
+ */
+interface BaseReview {
+    id: string;
+    fullReviewId: string;
+    patientId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    comment: string;
+    isVerified: boolean;
+    isPublished: boolean;
+}
+/**
+ * Clinic review interface
+ * @description Full review for a clinic
+ */
+interface ClinicReview extends BaseReview {
+    clinicId: string;
+    cleanliness: number;
+    facilities: number;
+    staffFriendliness: number;
+    waitingTime: number;
+    accessibility: number;
+    overallRating: number;
+    wouldRecommend: boolean;
+}
+/**
+ * Practitioner review interface
+ * @description Full review for a healthcare practitioner
+ */
+interface PractitionerReview extends BaseReview {
+    practitionerId: string;
+    knowledgeAndExpertise: number;
+    communicationSkills: number;
+    bedSideManner: number;
+    thoroughness: number;
+    trustworthiness: number;
+    overallRating: number;
+    wouldRecommend: boolean;
+}
+/**
+ * Procedure review interface
+ * @description Full review for a medical procedure
+ */
+interface ProcedureReview extends BaseReview {
+    procedureId: string;
+    effectivenessOfTreatment: number;
+    outcomeExplanation: number;
+    painManagement: number;
+    followUpCare: number;
+    valueForMoney: number;
+    overallRating: number;
+    wouldRecommend: boolean;
+}
 /**
  * Condensed clinic review information
  * @description Used for aggregated data attached to clinic documents
@@ -261,6 +340,22 @@ interface ProcedureReviewInfo {
     valueForMoney: number;
     recommendationPercentage: number;
 }
+/**
+ * Crown review object
+ * @description Combined review data for clinic, practitioner, and procedure
+ */
+interface Review {
+    id: string;
+    appointmentId: string;
+    patientId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    clinicReview?: ClinicReview;
+    practitionerReview?: PractitionerReview;
+    procedureReview?: ProcedureReview;
+    overallComment: string;
+    overallRating: number;
+}
 
 /**
  * Familije procedura u sistemu
@@ -2028,6 +2123,110 @@ declare class AppointmentAggregationService {
     private fetchClinicInfo;
 }
 
+/**
+ * @class FilledFormsAggregationService
+ * @description Handles aggregation tasks related to filled forms data updates.
+ * Updates appointment documents with LinkedFormInfo when forms are created, updated, or deleted.
+ */
+declare class FilledFormsAggregationService {
+    private db;
+    /**
+     * Constructor for FilledFormsAggregationService.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(firestore?: admin.firestore.Firestore);
+    /**
+     * Handles side effects when a filled form is created or updated.
+     * This function would typically be called by a Firestore onCreate or onUpdate trigger.
+     * @param filledDocument The filled document that was created or updated.
+     * @returns {Promise<void>}
+     */
+    handleFilledFormCreateOrUpdate(filledDocument: FilledDocument): Promise<void>;
+    /**
+     * Handles side effects when a filled form is deleted.
+     * This function would typically be called by a Firestore onDelete trigger.
+     * @param filledDocument The filled document that was deleted.
+     * @returns {Promise<void>}
+     */
+    handleFilledFormDelete(filledDocument: FilledDocument): Promise<void>;
+    /**
+     * Updates the appointment's pendingUserFormsIds for a new required user form.
+     * This should be called when a required user form is first created.
+     * @param filledDocument The newly created filled document.
+     * @returns {Promise<void>}
+     */
+    handleRequiredUserFormCreate(filledDocument: FilledDocument): Promise<void>;
+}
+
+/**
+ * @class ReviewsAggregationService
+ * @description Handles aggregation tasks related to review data updates.
+ * This service is intended to be used primarily by background functions (e.g., Cloud Functions)
+ * triggered by changes in the reviews collection.
+ */
+declare class ReviewsAggregationService {
+    private db;
+    /**
+     * Constructor for ReviewsAggregationService.
+     * @param firestore Optional Firestore instance. If not provided, it uses the default admin SDK instance.
+     */
+    constructor(firestore?: admin.firestore.Firestore);
+    /**
+     * Process a newly created review and update all related entities
+     * @param review The newly created review
+     * @returns Promise resolving when all updates are complete
+     */
+    processNewReview(review: Review): Promise<void>;
+    /**
+     * Process a deleted review and update all related entities
+     * @param review The deleted review
+     * @returns Promise resolving when all updates are complete
+     */
+    processDeletedReview(review: Review): Promise<void>;
+    /**
+     * Updates the review info for a clinic
+     * @param clinicId The ID of the clinic to update
+     * @param removedReview Optional review being removed
+     * @param isRemoval Whether this update is for a review removal
+     * @returns The updated clinic review info
+     */
+    updateClinicReviewInfo(clinicId: string, removedReview?: ClinicReview, isRemoval?: boolean): Promise<ClinicReviewInfo>;
+    /**
+     * Updates the review info for a practitioner
+     * @param practitionerId The ID of the practitioner to update
+     * @param removedReview Optional review being removed
+     * @param isRemoval Whether this update is for a review removal
+     * @returns The updated practitioner review info
+     */
+    updatePractitionerReviewInfo(practitionerId: string, removedReview?: PractitionerReview, isRemoval?: boolean): Promise<PractitionerReviewInfo>;
+    /**
+     * Updates the review info for a procedure
+     * @param procedureId The ID of the procedure to update
+     * @param removedReview Optional review being removed
+     * @param isRemoval Whether this update is for a review removal
+     * @returns The updated procedure review info
+     */
+    updateProcedureReviewInfo(procedureId: string, removedReview?: ProcedureReview, isRemoval?: boolean): Promise<ProcedureReviewInfo>;
+    /**
+     * Updates doctorInfo rating in all procedures for a practitioner
+     * @param practitionerId The ID of the practitioner
+     * @param rating The new rating to set
+     */
+    private updateDoctorInfoInProcedures;
+    /**
+     * Verifies a review as checked by admin/staff
+     * @param reviewId The ID of the review to verify
+     */
+    verifyReview(reviewId: string): Promise<void>;
+    /**
+     * Calculate the average of all reviews for an entity
+     * @param entityId The entity ID
+     * @param entityType The type of entity ('clinic', 'practitioner', or 'procedure')
+     * @returns Promise that resolves to the calculated review info
+     */
+    calculateEntityReviewInfo(entityId: string, entityType: "clinic" | "practitioner" | "procedure"): Promise<ClinicReviewInfo | PractitionerReviewInfo | ProcedureReviewInfo>;
+}
+
 /**
  * Minimal interface for the new mailgun.js client's messages API
  * This helps avoid a direct dependency on mailgun.js in the API package if not desired,
@@ -2671,4 +2870,4 @@ declare class AppointmentMailingService extends BaseMailingService {
     sendReviewAddedEmail(data: ReviewAddedEmailData): Promise<any>;
 }
 
-export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type ReviewAddedEmailData, type ReviewRequestEmailData, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole };
+export { APPOINTMENTS_COLLECTION, type Appointment, AppointmentAggregationService, type AppointmentCancellationEmailData, type AppointmentConfirmationEmailData, type AppointmentEmailDataBase, AppointmentMailingService, type AppointmentMediaItem, type AppointmentReminderNotification, type AppointmentRequestedEmailData, type AppointmentRescheduledProposalEmailData, AppointmentStatus, type AvailableSlot, BaseMailingService, type BaseNotification, BookingAdmin, BookingAvailabilityCalculator, type BookingAvailabilityRequest, type BookingAvailabilityResponse, CalendarAdminService, type Clinic, ClinicAggregationService, type ClinicInfo, type ClinicLocation, type CreateAppointmentData, type CreateAppointmentHttpData, type DoctorInfo, DocumentManagerAdminService, type FilledDocument, FilledFormsAggregationService, type InitializeAppointmentFormsResult, type LinkedFormInfo, Logger, MediaType, NOTIFICATIONS_COLLECTION, type Notification, NotificationStatus, NotificationType, NotificationsAdmin, type OrchestrateAppointmentCreationData, PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME, type PatientProfile as Patient, PatientAggregationService, PatientInstructionStatus, type PatientRequirementInstance, type PatientRequirementInstruction, PatientRequirementOverallStatus, PatientRequirementsAdminService, type PatientReviewInfo, PaymentStatus, type PostRequirementNotification, type Practitioner, PractitionerAggregationService, PractitionerInviteMailingService, type PractitionerToken, PractitionerTokenStatus, type PreRequirementNotification, type Procedure, ProcedureAggregationService, type ProcedureExtendedInfo, type ProcedureSummaryInfo, type Review, type ReviewAddedEmailData, type ReviewRequestEmailData, ReviewsAggregationService, type SearchAppointmentsParams, type TimeInterval, type UpdateAppointmentData, UserRole };