@blackcode_sa/metaestetics-api 1.5.29 → 1.5.30

package/src/services/procedure/README.md

@@ -0,0 +1,88 @@
+# Procedure Service
+
+This service manages medical/aesthetic procedure data within the Firestore database. It handles the creation, retrieval, updating, and deletion of procedures linked to practitioners and clinics.
+
+**Note:** Data aggregation into related entities (Practitioners, Clinics) is handled by Cloud Functions triggered by Firestore events.
+
+## `ProcedureService` Class
+
+Extends `BaseService`.
+
+### Constructor
+
+```typescript
+constructor(
+  db: Firestore,
+  auth: Auth,
+  app: FirebaseApp,
+  categoryService: CategoryService,
+  subcategoryService: SubcategoryService,
+  technologyService: TechnologyService,
+  productService: ProductService
+)
+```
+
+Initializes the service with Firestore, Auth, App instances, and required dependency services for fetching related category, subcategory, technology, and product details.
+
+### Core Methods
+
+- **`createProcedure(data: CreateProcedureData): Promise<Procedure>`**
+
+  - Creates a new procedure document in Firestore.
+  - Validates input data using `createProcedureSchema`.
+  - Fetches full Category, Subcategory, Technology, and Product documents using injected services.
+  - Retrieves associated Clinic and Practitioner documents to embed `clinicInfo` and `doctorInfo`.
+  - Embeds treatment details from the technology (blocking conditions, benefits, requirements).
+  - Initializes default `reviewInfo` with zero values.
+  - Sets `isActive` to `true` by default.
+  - **Aggregation Note:** Adding procedure info to associated Practitioner and Clinic documents is handled by Cloud Functions.
+
+- **`getProcedure(id: string): Promise<Procedure | null>`**
+
+  - Retrieves a single procedure document by its ID.
+  - Returns null if not found.
+
+- **`getProceduresByClinicBranch(clinicBranchId: string): Promise<Procedure[]>`**
+
+  - Retrieves all active procedures associated with a specific clinic branch.
+  - Uses a Firestore query with `where("clinicBranchId", "==", clinicBranchId)` and `where("isActive", "==", true)`.
+
+- **`getProceduresByPractitioner(practitionerId: string): Promise<Procedure[]>`**
+
+  - Retrieves all active procedures associated with a specific practitioner.
+  - Uses a Firestore query with `where("practitionerId", "==", practitionerId)` and `where("isActive", "==", true)`.
+
+- **`updateProcedure(id: string, data: UpdateProcedureData): Promise<Procedure>`**
+
+  - Updates an existing procedure document with partial data.
+  - Validates input data using `updateProcedureSchema`.
+  - Handles complex updates of related entities:
+    - If practitioner changes: Fetches new practitioner data and updates embedded `doctorInfo`.
+    - If clinic changes: Fetches new clinic data and updates embedded `clinicInfo`.
+    - If category/subcategory changes: Fetches and updates embedded objects.
+    - If technology/product changes: Fetches and updates embedded objects plus derived fields.
+  - Updates the `updatedAt` timestamp.
+  - **Aggregation Note:** Updating aggregated data in related entities is handled by Cloud Functions.
+
+- **`deactivateProcedure(id: string): Promise<void>`**
+
+  - Sets the `isActive` flag of a procedure to `false`.
+  - Updates the `updatedAt` timestamp.
+  - **Aggregation Note:** Removing from active lists in related entities is handled by Cloud Functions.
+
+- **`deleteProcedure(id: string): Promise<boolean>`**
+
+  - Permanently deletes a procedure document from Firestore.
+  - Returns `true` if successful, `false` if the document didn't exist.
+  - **Aggregation Note:** Removing from related entities is handled by Cloud Functions.
+
+- **`getAllowedTechnologies(practitioner: Practitioner): Promise<{ technologies: Technology[]; families: ProcedureFamily[]; categories: string[]; subcategories: string[]; }>`**
+
+  - Delegates to the `TechnologyService.getAllowedTechnologies` method.
+  - Determines which technologies a practitioner is certified to perform based on their certification level.
+  - Returns an object containing arrays of allowed technologies, families, categories, and subcategories.
+
+- **`getAllProcedures(pagination?: number, lastDoc?: any): Promise<{ procedures: Procedure[]; lastDoc: any }>`**
+  - Retrieves all procedures, ordered by name.
+  - Supports optional pagination with `limit` and `startAfter`.
+  - Returns both the procedures array and the last document for cursor-based pagination.