@blackcode_sa/metaestetics-api 1.7.47 → 1.8.0

package/src/index.ts

@@ -1,406 +1,5 @@
-import { UserRole } from "./types";
-import { Category } from "./backoffice/types/category.types";
-import {
-  createAppointmentSchema as appointmentCreateSchema,
-  updateAppointmentSchema as appointmentUpdateSchema,
-  searchAppointmentsSchema,
-} from "./validations/appointment.schema";
-
-// Firebase
-export {
-  initializeFirebase,
-  getFirebaseInstance,
-  getFirebaseAuth,
-  getFirebaseDB,
-  getFirebaseApp,
-} from "./config/firebase";
-
-// Services
-export { AuthService } from "./services/auth.service";
-export { UserService } from "./services/user.service";
-export { NotificationService } from "./services/notifications/notification.service";
-export { PatientService } from "./services/patient/patient.service";
-export { PractitionerService } from "./services/practitioner/practitioner.service";
-export { ProcedureService } from "./services/procedure/procedure.service";
-export { ClinicService } from "./services/clinic/clinic.service";
-export { ClinicAdminService } from "./services/clinic/clinic-admin.service";
-export { ClinicGroupService } from "./services/clinic/clinic-group.service";
-export { PractitionerInviteService } from "./services/clinic/practitioner-invite.service";
-export {
-  DocumentationTemplateService,
-  FilledDocumentService,
-} from "./services/documentation-templates";
-export { CalendarServiceV2 } from "./services/calendar/calendar-refactored.service";
-export { CalendarServiceV3 } from "./services/calendar/calendar.v3.service";
-export { SyncedCalendarsService } from "./services/calendar/synced-calendars.service";
-export { ReviewService } from "./services/reviews/reviews.service";
-export { AppointmentService } from "./services/appointment/appointment.service";
-export { PatientRequirementsService } from "./services/patient/patientRequirements.service";
-export { MediaService } from "./services/media/media.service";
-
-// Backoffice services
-export { BrandService } from "./backoffice/services/brand.service";
-export { CategoryService } from "./backoffice/services/category.service";
-export { SubcategoryService } from "./backoffice/services/subcategory.service";
-export { TechnologyService } from "./backoffice/services/technology.service";
-export { ProductService } from "./backoffice/services/product.service";
-
-// Types
-export type { User, UserRole, CreateUserData, FirebaseUser } from "./types";
-export { AUTH_ERRORS } from "./errors/auth.errors";
-export { USER_ERRORS } from "./errors/user.errors";
-export type { AuthError } from "./errors/auth.errors";
-export * from "./validations/schemas";
-export * from "./validations/notification.schema";
-export * from "./validations/patient.schema";
-export * from "./validations/practitioner.schema";
-export * from "./validations/clinic.schema";
-export * from "./validations/patient/medical-info.schema";
-export * from "./validations/documentation-templates.schema";
-export * from "./validations/calendar.schema";
-export {
-  practitionerProfileInfoSchema,
-  patientProfileInfoSchema,
-} from "./validations/profile-info.schema";
-export { FirebaseErrorCode } from "./errors/firebase.errors";
-
-// Appointment schemas
-export {
-  appointmentCreateSchema as createAppointmentSchema,
-  appointmentUpdateSchema as updateAppointmentSchema,
-  searchAppointmentsSchema,
-};
-
-// Notification types
-export type {
-  Notification,
-  BaseNotification,
-  PreRequirementNotification,
-  PostRequirementNotification,
-  AppointmentReminderNotification,
-} from "./types/notifications";
-export { NotificationType, NotificationStatus } from "./types/notifications";
-
-// Patient types
-export type {
-  PatientProfile,
-  CreatePatientProfileData,
-  UpdatePatientProfileData,
-  PatientLocationInfo,
-  CreatePatientLocationInfoData,
-  UpdatePatientLocationInfoData,
-  AddressData,
-  LocationData,
-  GamificationInfo,
-  EmergencyContact,
-  PatientDoctor,
-  PatientSensitiveInfo,
-  CreatePatientSensitiveInfoData,
-  UpdatePatientSensitiveInfoData,
-  PatientClinic,
-  PatientMedicalInfo,
-  CreatePatientMedicalInfoData,
-  UpdatePatientMedicalInfoData,
-  VitalStats,
-  UpdateVitalStatsData,
-  AddAllergyData,
-  UpdateAllergyData,
-  AddBlockingConditionData,
-  UpdateBlockingConditionData,
-  AddContraindicationData,
-  UpdateContraindicationData,
-  AddMedicationData,
-  UpdateMedicationData,
-  Allergy,
-  PatientProfileComplete,
-  SearchPatientsParams,
-  RequesterInfo,
-  PatientProfileForDoctor,
-} from "./types/patient";
-export {
-  Gender,
-  PATIENTS_COLLECTION,
-  PATIENT_MEDICAL_INFO_COLLECTION,
-  PATIENT_SENSITIVE_INFO_COLLECTION,
-  PATIENT_LOCATION_INFO_COLLECTION,
-  PATIENT_MEDICAL_HISTORY_COLLECTION,
-  PATIENT_APPOINTMENTS_COLLECTION,
-} from "./types/patient";
-
-// Appointment types
-export type {
-  Appointment,
-  CreateAppointmentData,
-  CreateAppointmentHttpData,
-  UpdateAppointmentData,
-  SearchAppointmentsParams,
-  AppointmentMetadata,
-  BeforeAfterPerZone,
-  BillingPerZone,
-  FinalBilling,
-} from "./types/appointment";
-export {
-  AppointmentStatus,
-  PaymentStatus,
-  APPOINTMENTS_COLLECTION,
-} from "./types/appointment";
-
-// Allergy tipovi
-export type {
-  AllergyTypeWithSubtype,
-  AllergySubtype,
-} from "./types/patient/allergies";
-
-export {
-  AllergyType,
-  MedicationAllergySubtype,
-  FoodAllergySubtype,
-  EnvironmentalAllergySubtype,
-  CosmeticAllergySubtype,
-} from "./types/patient/allergies";
-
-// Practitioner types
-export type {
-  Practitioner,
-  PractitionerBasicInfo,
-  PractitionerCertification,
-  CreatePractitionerData,
-  UpdatePractitionerData,
-  PractitionerClinicProcedures,
-  PractitionerWorkingHours,
-  PractitionerClinicWorkingHours,
-  CreateDraftPractitionerData,
-  PractitionerToken,
-  CreatePractitionerTokenData,
-} from "./types/practitioner";
-export {
-  PRACTITIONERS_COLLECTION,
-  REGISTER_TOKENS_COLLECTION,
-  PractitionerStatus,
-  PractitionerTokenStatus,
-} from "./types/practitioner";
-
-// Clinic types
-export type {
-  Clinic,
-  ClinicGroup,
-  ClinicAdmin,
-  CreateClinicData,
-  UpdateClinicData,
-  CreateClinicGroupData,
-  UpdateClinicGroupData,
-  CreateClinicAdminData,
-  UpdateClinicAdminData,
-  ClinicLocation,
-  ClinicContactInfo,
-  WorkingHours,
-  ClinicTags,
-  ClinicAdminSignupData,
-  ContactPerson,
-  AdminToken,
-  AdminInfo,
-  CreateAdminTokenData,
-  DoctorInfo,
-  CreateDefaultClinicGroupData,
-  ClinicGroupSetupData,
-  ClinicBranchSetupData,
-  PractitionerInvite,
-  CreatePractitionerInviteData,
-  UpdatePractitionerInviteData,
-  PractitionerInviteFilters,
-  ProposedWorkingHours,
-} from "./types/clinic";
-export {
-  CLINICS_COLLECTION,
-  CLINIC_GROUPS_COLLECTION,
-  CLINIC_ADMINS_COLLECTION,
-  PRACTITIONER_INVITES_COLLECTION,
-  PracticeType,
-  Language,
-  ClinicTag,
-  ClinicPhotoTag,
-  AdminTokenStatus,
-  SubscriptionModel,
-  PractitionerInviteStatus,
-} from "./types/clinic";
-
-// Profile info types
-export type {
-  ClinicInfo,
-  PractitionerProfileInfo,
-  PatientProfileInfo,
-} from "./types/profile";
-
-// Calendar types
-export type {
-  CalendarEvent,
-  CalendarEventTime,
-  CreateCalendarEventData,
-  UpdateCalendarEventData,
-  TimeSlot,
-  ProcedureInfo,
-  ProcedureCategorization,
-  SyncedCalendarEvent,
-  CreateAppointmentParams,
-  UpdateAppointmentParams,
-  CreateBlockingEventParams,
-  UpdateBlockingEventParams,
-} from "./types/calendar";
-
-export {
-  CalendarEventStatus,
-  CalendarEventType,
-  CalendarSyncStatus,
-  SearchLocationEnum,
-  DateRange,
-  SearchCalendarEventsParams,
-  CALENDAR_COLLECTION,
-} from "./types/calendar";
-
-// Synced calendar types
-export type {
-  SyncedCalendar,
-  CreateSyncedCalendarData,
-  UpdateSyncedCalendarData,
-} from "./types/calendar/synced-calendar.types";
-
-export {
-  SyncedCalendarProvider,
-  SYNCED_CALENDARS_COLLECTION,
-} from "./types/calendar/synced-calendar.types";
-
-// Certification types
-
-// Brand types
-export type { Brand } from "./backoffice/types/brand.types";
-
-// Category types
-export type { Category } from "./backoffice/types/category.types";
-
-// Product types
-export type { Product } from "./backoffice/types/product.types";
-
-// Requirement types
-export type { Requirement } from "./backoffice/types/requirement.types";
-
-// Subcategory types
-export type { Subcategory } from "./backoffice/types/subcategory.types";
-
-// Technology types
-export type {
-  Technology,
-  TechnologyDocumentationTemplate,
-} from "./backoffice/types/technology.types";
-
-// Pricing enums
-export {
-  PricingMeasure,
-  Currency,
-} from "./backoffice/types/static/pricing.types";
-
-// Static types
-export { BlockingCondition } from "./backoffice/types/static/blocking-condition.types";
-export {
-  CertificationSpecialty,
-  CertificationLevel,
-} from "./backoffice/types/static/certification.types";
-export { Contraindication } from "./backoffice/types/static/contraindication.types";
-export { ProcedureFamily } from "./backoffice/types/static/procedure-family.types";
-export { TreatmentBenefit } from "./backoffice/types/static/treatment-benefit.types";
-export {
-  RequirementType,
-  TimeUnit,
-} from "./backoffice/types/requirement.types";
-
-// Media types
-export type {
-  MediaMetadata,
-  MediaResource,
-} from "./services/media/media.service";
-export { MEDIA_METADATA_COLLECTION } from "./services/media/media.service";
-export { MediaAccessLevel } from "./services/media/media.service";
-// Documentation Templates types
-export type {
-  DocumentTemplate,
-  CreateDocumentTemplateData,
-  UpdateDocumentTemplateData,
-  DocumentElement,
-  FilledDocument,
-  BaseDocumentElement,
-  HeadingElement,
-  ParagraphElement,
-  ListElement,
-  DynamicTextElement,
-  BinaryChoiceElement,
-  MultipleChoiceElement,
-  SingleChoiceElement,
-  RatingScaleElement,
-  TextInputElement,
-  DatePickerElement,
-  SignatureElement,
-  DigitalSignatureElement,
-  FileUploadElement,
-} from "./types/documentation-templates";
-export {
-  DocumentElementType,
-  HeadingLevel,
-  ListType,
-  DynamicVariable,
-  FilledDocumentStatus,
-  FilledDocumentFileValue,
-  DOCUMENTATION_TEMPLATES_COLLECTION,
-  FILLED_DOCUMENTS_COLLECTION,
-  USER_FORMS_SUBCOLLECTION,
-  DOCTOR_FORMS_SUBCOLLECTION,
-} from "./types/documentation-templates";
-
-// Procedure types
-export type {
-  Procedure,
-  CreateProcedureData,
-  UpdateProcedureData,
-} from "./types/procedure";
-export { PROCEDURES_COLLECTION } from "./types/procedure";
-
-// Review types
-export type {
-  ClinicReview,
-  PractitionerReview,
-  ProcedureReview,
-  ClinicReviewInfo,
-  PractitionerReviewInfo,
-  ProcedureReviewInfo,
-  Review,
-} from "./types/reviews";
-
-export { REVIEWS_COLLECTION } from "./types/reviews/index";
-
-// Review schemas
-export {
-  clinicReviewSchema,
-  createClinicReviewSchema,
-  practitionerReviewSchema,
-  createPractitionerReviewSchema,
-  procedureReviewSchema,
-  createProcedureReviewSchema,
-  clinicReviewInfoSchema,
-  practitionerReviewInfoSchema,
-  procedureReviewInfoSchema,
-  reviewSchema,
-  createReviewSchema,
-} from "./validations/reviews.schema";
-
-// Patient Requirement Types
-export type {
-  PatientRequirementInstance,
-  PatientRequirementInstruction,
-} from "./types/patient/patient-requirements";
-export {
-  PatientInstructionStatus,
-  PatientRequirementOverallStatus,
-  PATIENT_REQUIREMENTS_SUBCOLLECTION_NAME,
-} from "./types/patient/patient-requirements";
-
-// Patient Requirement Validation Schemas (if they exist and are for client use)
-// Assuming the path, add if it exists and is needed:
-// export * from "./validations/patient/patient-requirements.schema";
+export * from "./services";
+export * from "./types";
+export * from "./validations";
+export * from "./utils";
+export * from "./config/firebase";

package/src/services/PATIENTAUTH.MD

@@ -0,0 +1,197 @@
+# Patient Authentication and Profile Claiming Flow
+
+This document outlines the different methods for patient authentication, including standard sign-up, anonymous user conversion, and the process for claiming a pre-existing patient profile created by a clinic administrator.
+
+---
+
+## 1. Standard Patient Sign-Up
+
+A new user can register directly as a patient. This flow creates a new `User` record in Firebase Authentication and Firestore, along with a corresponding `PatientProfile`.
+
+### Flow:
+
+1.  The client application calls the `AuthService.signUp` method with the user's email and password.
+2.  The system creates a new Firebase user.
+3.  A new `User` document and a `PatientProfile` document are created and linked together.
+
+### Example:
+
+```typescript
+// In your client-side code
+import { authService } from "./services"; // Assuming you have an initialized authService
+
+async function registerPatient(email, password) {
+  try {
+    const user = await authService.signUp(email, password, UserRole.PATIENT);
+    console.log("Patient registered successfully:", user);
+  } catch (error) {
+    console.error("Registration failed:", error);
+  }
+}
+```
+
+A similar flow exists for social providers like Google using `signInWithGoogle`.
+
+---
+
+## 2. Standard Patient Sign-In
+
+Existing users can sign in using their credentials.
+
+### Flow:
+
+1.  The client application calls `AuthService.signIn` with the user's email and password.
+2.  Firebase authenticates the user.
+3.  The application receives the user's profile data.
+
+### Example:
+
+```typescript
+// In your client-side code
+async function loginPatient(email, password) {
+  try {
+    const user = await authService.signIn(email, password);
+    console.log("Patient signed in successfully:", user);
+  } catch (error) {
+    console.error("Sign-in failed:", error);
+  }
+}
+```
+
+---
+
+## 3. Anonymous User Flow
+
+Users can start using the application without creating a full account. They are assigned an anonymous user profile which can be converted to a permanent account later.
+
+### Flow:
+
+1.  **Initial Anonymous Sign-In:** The client calls `AuthService.signInAnonymously()`. This creates an anonymous Firebase user and a corresponding `User` and `PatientProfile` in Firestore.
+2.  **Upgrading the Account:** When the user decides to create a permanent account, the client calls one of the upgrade methods, such as `AuthService.upgradeAnonymousUser(email, password)`.
+3.  The anonymous account is linked to the new credentials (e.g., email/password). The `isAnonymous` flag on the `User` document is set to `false`. The existing `PatientProfile` is retained.
+
+---
+
+## 4. Claiming a Manually Created Profile
+
+This flow is for patients whose profiles are created in advance by a clinic administrator. This allows clinics to manage patient records before the patient has registered on the platform.
+
+### Step 1: Admin Creates Profile and Invite Token
+
+1.  **Create Manual Patient:** A clinic admin uses `PatientService.createManualPatient()` to create a patient profile. This profile is not linked to any user (`userRef` is empty) and is marked with `isManual: true`.
+2.  **Create Invite Token:** The admin then calls `PatientService.createPatientToken()` for the newly created patient. This generates a unique, short-lived token and stores it in the `inviteTokens` subcollection of the patient's profile.
+3.  **Send Invitation:** The token is sent to the patient (e.g., via email). This is typically handled by a Cloud Function that triggers when a new token is created.
+
+### Example (Admin Action):
+
+```typescript
+// In an admin panel or backend service
+import { patientService } from "./services";
+
+async function invitePatient(patientData, adminId) {
+  // 1. Create the manual patient profile
+  const manualProfile = await patientService.createManualPatient(patientData, {
+    id: adminId,
+    role: "clinic_admin",
+    associatedClinicId: patientData.clinicId,
+  });
+
+  // 2. Create an invitation token for the new profile
+  const tokenData = {
+    patientId: manualProfile.id,
+    clinicId: patientData.clinicId,
+    email: patientData.email,
+  };
+  const inviteToken = await patientService.createPatientToken(
+    tokenData,
+    adminId
+  );
+
+  console.log(`Invite token created: ${inviteToken.token}`);
+  // (An automated process would now email this token to the patient)
+}
+```
+
+### Step 2: Patient Signs Up with the Invite Token
+
+The patient uses the standard sign-up flow but includes the invitation token.
+
+1.  **Sign-Up with Token:** The patient goes to the registration page and signs up using email/password (`AuthService.signUp`) or a social provider (`AuthService.signInWithGoogle`). They provide the `patientInviteToken` they received.
+2.  **Profile Claiming:**
+    - The system validates the token.
+    - If valid, it finds the corresponding `PatientProfile` that was manually created.
+    - It links the new `User` account to this existing `PatientProfile` by setting the `userRef`.
+    - It updates the profile's `isManual` flag to `false`.
+    - The invitation token is marked as `USED`.
+
+### Example (Patient Action):
+
+```typescript
+// In your client-side code during registration
+import { authService } from "./services";
+
+async function registerAndClaimProfile(email, password, inviteToken) {
+  try {
+    const user = await authService.signUp(email, password, UserRole.PATIENT, {
+      patientInviteToken: inviteToken,
+    });
+    console.log("Successfully registered and claimed profile:", user);
+  } catch (error) {
+    console.error("Claiming profile failed:", error);
+  }
+}
+```
+
+---
+
+## 5. Retrieving Invite Tokens (For Admins)
+
+Clinic administrators can retrieve a list of all active, unexpired invitation tokens for their clinic. This is useful for assisting patients in person who may not have access to their email.
+
+### Flow:
+
+1.  An authenticated clinic administrator makes a request to an endpoint that calls `PatientService.getActiveInviteTokensByClinic(clinicId)`.
+2.  The service performs a secure query to find all tokens associated with the admin's clinic that are currently active.
+3.  The list of tokens is returned to the admin.
+
+### Example (Admin Action):
+
+```typescript
+// In a secure admin-only part of the application
+import { patientService } from "./services";
+
+async function fetchActiveTokens(clinicId) {
+  try {
+    // The backend must verify that the user is an admin for this clinicId
+    const tokens = await patientService.getActiveInviteTokensByClinic(clinicId);
+    console.log("Active tokens for the clinic:", tokens);
+    // The admin can now read the token to the patient
+  } catch (error) {
+    console.error("Failed to fetch tokens:", error);
+  }
+}
+```
+
+Admins can also retrieve tokens for a specific patient.
+
+### Example (Admin Action for a specific patient):
+
+```typescript
+// In a secure admin-only part of the application
+import { patientService } from "./services";
+
+async function fetchTokensForPatient(patientId) {
+  try {
+    // The backend must verify that the user is an admin and has
+    // permission to view this patient's details.
+    const tokens = await patientService.getActiveInviteTokensByPatient(
+      patientId
+    );
+    console.log(`Active tokens for patient ${patientId}:`, tokens);
+  } catch (error) {
+    console.error("Failed to fetch tokens for patient:", error);
+  }
+}
+```
+
+This ensures a seamless experience where the patient's pre-existing data is automatically linked to their new account.

package/src/services/__tests__/auth/auth.setup.ts

@@ -1,5 +1,5 @@
 import { User, UserRole } from "../../../types";
-import { AuthService } from "../../auth.service";
+import { AuthService } from "../../auth/auth.service";
 import {
   FacebookAuthProvider,
   OAuthProvider,
@@ -9,7 +9,7 @@ import { FirebaseApp } from "firebase/app";
 import { Firestore } from "firebase/firestore";
 import { Auth } from "firebase/auth";
 import { Analytics } from "firebase/analytics";
-import { UserService } from "../../user.service";
+import { UserService } from "../../user/user.service";
 import { initializeFirebase } from "../../../config/firebase";
 import { z } from "zod";
 import { AUTH_ERRORS } from "../../../errors/auth.errors";

package/src/services/__tests__/auth.service.test.ts

@@ -119,7 +119,7 @@ jest.mock("../../config/firebase", () => ({
   }),
 }));
 
-import { AuthService } from "../auth.service";
+import { AuthService } from "../auth/auth.service";
 import { User as FirebaseUser } from "firebase/auth";
 import { UserRole } from "../../types";
 

package/src/services/__tests__/user.service.test.ts

@@ -1,4 +1,4 @@
-import { UserService } from "../user.service";
+import { UserService } from "../user/user.service";
 import { User, UserRole, USERS_COLLECTION } from "../../types";
 import { USER_ERRORS } from "../../errors/user.errors";
 import { AUTH_ERRORS } from "../../errors/auth.errors";

package/src/services/appointment/index.ts

@@ -1,2 +1 @@
-export { AppointmentService } from "./appointment.service";
-export * from "../../types/appointment";
+export * from "./appointment.service";