@blackcode_sa/metaestetics-api 1.15.16 → 1.15.17-staging.0

package/src/types/procedure/index.ts

@@ -1,183 +1,189 @@
-import {
-  BlockingCondition,
-  CertificationRequirement,
-  ProcedureFamily,
-} from "../../backoffice/types";
-import {
-  ContraindicationDynamic,
-  TreatmentBenefitDynamic,
-} from "../../backoffice/types/admin-constants.types";
-import { Requirement } from "../../backoffice/types/requirement.types";
-import { Category } from "../../backoffice/types/category.types";
-import { Subcategory } from "../../backoffice/types/subcategory.types";
-import { Technology } from "../../backoffice/types/technology.types";
-import { Product } from "../../backoffice/types/product.types";
-import { ClinicInfo, DoctorInfo } from "../../types/";
-import { ProcedureReviewInfo } from "../reviews";
-import { TechnologyDocumentationTemplate } from "../../backoffice/types/technology.types";
-import {
-  PricingMeasure,
-  Currency,
-} from "../../backoffice/types/static/pricing.types";
-import { MediaResource } from "../../services/media/media.service";
-import type { ProcedureProduct } from "../../backoffice/types/procedure-product.types";
-
-/**
- * Procedure represents a specific medical procedure that can be performed by a practitioner in a clinic
- * It inherits properties from technology and adds clinic/practitioner specific details
- */
-export interface Procedure {
-  /** Unique identifier of the procedure */
-  id: string;
-  /** Name of the procedure */
-  name: string;
-  /** Lowercase version of the name for case-insensitive search */
-  nameLower: string;
-  /** Photos of the procedure */
-  photos?: MediaResource[];
-  /** Detailed description of the procedure */
-  description: string;
-  /** Family of procedures this belongs to (aesthetics/surgery) */
-  family: ProcedureFamily;
-  /** Category this procedure belongs to */
-  category: Category;
-  /** Subcategory this procedure belongs to */
-  subcategory: Subcategory;
-  /** Technology used in this procedure */
-  technology: Technology;
-  /** Default product used in this procedure (optional for consultations) */
-  product?: Product;
-  /** Default price of the procedure */
-  price: number;
-  /** Currency for the price */
-  currency: Currency;
-  /** How the price is measured (per ml, per zone, etc.) - for default product*/
-  pricingMeasure: PricingMeasure;
-  /** Duration of the procedure in minutes */
-  productsMetadata?: ProcedureProduct[];
-  duration: number;
-  /** Blocking conditions that prevent this procedure */
-  blockingConditions: BlockingCondition[];
-  /** Treatment benefits of this procedure */
-  treatmentBenefits: TreatmentBenefitDynamic[];
-  /** A list of just the string IDs of the treatment benefits, for efficient querying. */
-  treatmentBenefitIds: string[];
-  /** Contraindications of this procedure */
-  contraindications: ContraindicationDynamic[];
-  /** A list of just the string IDs of the contraindications, for efficient querying. */
-  contraindicationIds: string[];
-  /** Pre-procedure requirements */
-  preRequirements: Requirement[];
-  /** Post-procedure requirements */
-  postRequirements: Requirement[];
-  /** Certification requirements for performing this procedure */
-  certificationRequirement: CertificationRequirement;
-  /** Documentation templates required for this procedure */
-  documentationTemplates: TechnologyDocumentationTemplate[];
-  /** ID of the practitioner who performs this procedure */
-  practitionerId: string;
-  /** ID of the clinic branch where this procedure is performed */
-  clinicBranchId: string;
-  /** Aggregated clinic information */
-  clinicInfo: ClinicInfo;
-  /** Aggregated doctor information */
-  doctorInfo: DoctorInfo;
-  /** Aggregated review information for this procedure */
-  reviewInfo: ProcedureReviewInfo;
-  /** Whether this procedure is active */
-  isActive: boolean;
-  /** When this procedure was created */
-  createdAt: Date;
-  /** When this procedure was last updated */
-  updatedAt: Date;
-}
-
-/**
- * Data required to create a new procedure
- */
-export interface CreateProcedureData {
-  name: string;
-  /** Lowercase version of the name for case-insensitive search */
-  nameLower: string;
-  description: string;
-  family: ProcedureFamily;
-  categoryId: string;
-  subcategoryId: string;
-  technologyId: string;
-  productId?: string;
-  price: number;
-  productsMetadata?: {
-    productId: string;
-    price: number;
-    currency: Currency;
-    pricingMeasure: PricingMeasure;
-    isDefault?: boolean;
-  }[];
-  currency: Currency;
-  pricingMeasure: PricingMeasure;
-  duration: number;
-  practitionerId: string;
-  clinicBranchId: string;
-  photos?: MediaResource[];
-}
-
-/**
- * Data that can be updated for an existing procedure
- */
-export interface UpdateProcedureData {
-  name?: string;
-  /** Lowercase version of the name for case-insensitive search */
-  nameLower?: string;
-  description?: string;
-  price?: number;
-  currency?: Currency;
-  pricingMeasure?: PricingMeasure;
-  productsMetadata?: {
-    productId: string;
-    price: number;
-    currency: Currency;
-    pricingMeasure: PricingMeasure;
-    isDefault?: boolean;
-  }[];
-  duration?: number;
-  isActive?: boolean;
-  practitionerId?: string;
-  categoryId?: string;
-  subcategoryId?: string;
-  technologyId?: string;
-  productId?: string;
-  clinicBranchId?: string;
-  photos?: MediaResource[];
-}
-
-/**
- * Collection name for procedures in Firestore
- */
-export const PROCEDURES_COLLECTION = "procedures";
-
-/**
- * Aggregated summary information for a procedure.
- * Used in arrays within Clinic and Practitioner documents for quick display.
- */
-export interface ProcedureSummaryInfo {
-  id: string;
-  name: string;
-  description?: string;
-  photo?: string; // Still using empty string if no source found
-  family: ProcedureFamily;
-  categoryName: string; // Use names for aggregation
-  subcategoryName: string; // Use names for aggregation
-  technologyName: string; // Use names for aggregation
-  brandName?: string; // Added: Name of the brand used (if applicable)
-  productName?: string; // Added: Name of the product used (if applicable)
-  price: number;
-  priceMin?: number;
-  priceMax?: number;
-  pricingMeasure: PricingMeasure;
-  currency: Currency;
-  duration: number;
-  clinicId: string;
-  clinicName: string;
-  practitionerId: string;
-  practitionerName: string;
-}
+import {
+  BlockingCondition,
+  CertificationRequirement,
+  ProcedureFamily,
+} from "../../backoffice/types";
+import {
+  ContraindicationDynamic,
+  TreatmentBenefitDynamic,
+} from "../../backoffice/types/admin-constants.types";
+import { Requirement } from "../../backoffice/types/requirement.types";
+import { Category } from "../../backoffice/types/category.types";
+import { Subcategory } from "../../backoffice/types/subcategory.types";
+import { Technology } from "../../backoffice/types/technology.types";
+import { Product } from "../../backoffice/types/product.types";
+import { ClinicInfo, DoctorInfo } from "../../types/";
+import { ProcedureReviewInfo } from "../reviews";
+import { TechnologyDocumentationTemplate } from "../../backoffice/types/technology.types";
+import {
+  PricingMeasure,
+  Currency,
+} from "../../backoffice/types/static/pricing.types";
+import { MediaResource } from "../../services/media/media.service";
+import type { ProcedureProduct } from "../../backoffice/types/procedure-product.types";
+import type { ResourceRequirement } from "../resource";
+
+/**
+ * Procedure represents a specific medical procedure that can be performed by a practitioner in a clinic
+ * It inherits properties from technology and adds clinic/practitioner specific details
+ */
+export interface Procedure {
+  /** Unique identifier of the procedure */
+  id: string;
+  /** Name of the procedure */
+  name: string;
+  /** Lowercase version of the name for case-insensitive search */
+  nameLower: string;
+  /** Photos of the procedure */
+  photos?: MediaResource[];
+  /** Detailed description of the procedure */
+  description: string;
+  /** Family of procedures this belongs to (aesthetics/surgery) */
+  family: ProcedureFamily;
+  /** Category this procedure belongs to */
+  category: Category;
+  /** Subcategory this procedure belongs to */
+  subcategory: Subcategory;
+  /** Technology used in this procedure */
+  technology: Technology;
+  /** Default product used in this procedure (optional for consultations) */
+  product?: Product;
+  /** Default price of the procedure */
+  price: number;
+  /** Currency for the price */
+  currency: Currency;
+  /** How the price is measured (per ml, per zone, etc.) - for default product*/
+  pricingMeasure: PricingMeasure;
+  /** Duration of the procedure in minutes */
+  productsMetadata?: ProcedureProduct[];
+  duration: number;
+  /** Blocking conditions that prevent this procedure */
+  blockingConditions: BlockingCondition[];
+  /** Treatment benefits of this procedure */
+  treatmentBenefits: TreatmentBenefitDynamic[];
+  /** A list of just the string IDs of the treatment benefits, for efficient querying. */
+  treatmentBenefitIds: string[];
+  /** Contraindications of this procedure */
+  contraindications: ContraindicationDynamic[];
+  /** A list of just the string IDs of the contraindications, for efficient querying. */
+  contraindicationIds: string[];
+  /** Pre-procedure requirements */
+  preRequirements: Requirement[];
+  /** Post-procedure requirements */
+  postRequirements: Requirement[];
+  /** Certification requirements for performing this procedure */
+  certificationRequirement: CertificationRequirement;
+  /** Documentation templates required for this procedure */
+  documentationTemplates: TechnologyDocumentationTemplate[];
+  /** ID of the practitioner who performs this procedure */
+  practitionerId: string;
+  /** ID of the clinic branch where this procedure is performed */
+  clinicBranchId: string;
+  /** Aggregated clinic information */
+  clinicInfo: ClinicInfo;
+  /** Aggregated doctor information */
+  doctorInfo: DoctorInfo;
+  /** Aggregated review information for this procedure */
+  reviewInfo: ProcedureReviewInfo;
+  /** Optional resources required for this procedure (e.g., surgery room, device) */
+  resourceRequirements?: ResourceRequirement[];
+  /** Whether this procedure is active */
+  isActive: boolean;
+  /** When this procedure was created */
+  createdAt: Date;
+  /** When this procedure was last updated */
+  updatedAt: Date;
+}
+
+/**
+ * Data required to create a new procedure
+ */
+export interface CreateProcedureData {
+  name: string;
+  /** Lowercase version of the name for case-insensitive search */
+  nameLower: string;
+  description: string;
+  family: ProcedureFamily;
+  categoryId: string;
+  subcategoryId: string;
+  technologyId: string;
+  productId?: string;
+  price: number;
+  productsMetadata?: {
+    productId: string;
+    price: number;
+    currency: Currency;
+    pricingMeasure: PricingMeasure;
+    isDefault?: boolean;
+  }[];
+  currency: Currency;
+  pricingMeasure: PricingMeasure;
+  duration: number;
+  practitionerId: string;
+  clinicBranchId: string;
+  photos?: MediaResource[];
+  resourceRequirements?: ResourceRequirement[];
+}
+
+/**
+ * Data that can be updated for an existing procedure
+ */
+export interface UpdateProcedureData {
+  name?: string;
+  /** Lowercase version of the name for case-insensitive search */
+  nameLower?: string;
+  description?: string;
+  price?: number;
+  currency?: Currency;
+  pricingMeasure?: PricingMeasure;
+  productsMetadata?: {
+    productId: string;
+    price: number;
+    currency: Currency;
+    pricingMeasure: PricingMeasure;
+    isDefault?: boolean;
+  }[];
+  duration?: number;
+  isActive?: boolean;
+  practitionerId?: string;
+  categoryId?: string;
+  subcategoryId?: string;
+  technologyId?: string;
+  productId?: string;
+  clinicBranchId?: string;
+  photos?: MediaResource[];
+  resourceRequirements?: ResourceRequirement[];
+}
+
+/**
+ * Collection name for procedures in Firestore
+ */
+export const PROCEDURES_COLLECTION = "procedures";
+
+/**
+ * Aggregated summary information for a procedure.
+ * Used in arrays within Clinic and Practitioner documents for quick display.
+ */
+export interface ProcedureSummaryInfo {
+  id: string;
+  name: string;
+  description?: string;
+  photo?: string; // Still using empty string if no source found
+  family: ProcedureFamily;
+  categoryName: string; // Use names for aggregation
+  subcategoryName: string; // Use names for aggregation
+  technologyName: string; // Use names for aggregation
+  brandName?: string; // Added: Name of the brand used (if applicable)
+  productName?: string; // Added: Name of the product used (if applicable)
+  price: number;
+  priceMin?: number;
+  priceMax?: number;
+  pricingMeasure: PricingMeasure;
+  currency: Currency;
+  duration: number;
+  clinicId: string;
+  clinicName: string;
+  practitionerId: string;
+  practitionerName: string;
+  resourceRequirements?: ResourceRequirement[];
+}

package/src/types/profile/index.ts

@@ -1,39 +1,39 @@
-import { Timestamp } from "firebase-admin/firestore";
-import { ClinicLocation, ClinicContactInfo } from "../clinic";
-import { PractitionerCertification } from "../practitioner";
-import { Gender } from "../patient";
-/**
- * Interface for clinic profile information
- */
-export interface ClinicInfo {
-  id: string;
-  featuredPhoto: string;
-  name: string;
-  description?: string | null;
-  location: ClinicLocation;
-  contactInfo: ClinicContactInfo;
-}
-
-/**
- * Interface for practitioner profile information
- */
-export interface PractitionerProfileInfo {
-  id: string;
-  practitionerPhoto: string | null;
-  name: string;
-  email: string;
-  phone: string | null;
-  certification: PractitionerCertification;
-}
-
-/**
- * Interface for patient profile information
- */
-export interface PatientProfileInfo {
-  id: string;
-  fullName: string;
-  email: string;
-  phone: string | null;
-  dateOfBirth: Timestamp;
-  gender: Gender;
-}
+import { Timestamp } from "firebase-admin/firestore";
+import { ClinicLocation, ClinicContactInfo } from "../clinic";
+import { PractitionerCertification } from "../practitioner";
+import { Gender } from "../patient";
+/**
+ * Interface for clinic profile information
+ */
+export interface ClinicInfo {
+  id: string;
+  featuredPhoto: string;
+  name: string;
+  description?: string | null;
+  location: ClinicLocation;
+  contactInfo: ClinicContactInfo;
+}
+
+/**
+ * Interface for practitioner profile information
+ */
+export interface PractitionerProfileInfo {
+  id: string;
+  practitionerPhoto: string | null;
+  name: string;
+  email: string;
+  phone: string | null;
+  certification: PractitionerCertification;
+}
+
+/**
+ * Interface for patient profile information
+ */
+export interface PatientProfileInfo {
+  id: string;
+  fullName: string;
+  email: string;
+  phone: string | null;
+  dateOfBirth: Timestamp;
+  gender: Gender;
+}

package/src/types/resource/README.md

@@ -0,0 +1,153 @@
+# Resource Types (`Api/src/types/resource/`)
+
+Type definitions for the Clinic Resources system. These types are used across the API package, Cloud Functions, and the ClinicApp frontend (via the `@blackcode_sa/metaestetics-api` package).
+
+## File: `index.ts`
+
+### Collection Constants
+
+| Constant | Value | Description |
+|----------|-------|-------------|
+| `RESOURCES_COLLECTION` | `"resources"` | Subcollection under clinics |
+| `RESOURCE_INSTANCES_SUBCOLLECTION` | `"instances"` | Subcollection under resources |
+| `RESOURCE_CALENDAR_SUBCOLLECTION` | `"calendar"` | Subcollection under instances |
+
+### Firestore Path
+
+```
+clinics/{clinicId}/resources/{resourceId}
+clinics/{clinicId}/resources/{resourceId}/instances/{instanceId}
+clinics/{clinicId}/resources/{resourceId}/instances/{instanceId}/calendar/{eventId}
+```
+
+### Enums
+
+#### `ResourceCategory`
+Categorizes the type of physical resource.
+
+| Value | Description |
+|-------|-------------|
+| `MEDICAL_DEVICE` | Medical equipment (e.g., laser machine) |
+| `ROOM` | General room (e.g., consultation room) |
+| `SURGERY_SUITE` | Operating/surgery room |
+| `EQUIPMENT` | General equipment |
+| `OTHER` | Uncategorized |
+
+#### `ResourceStatus`
+Tracks the operational state of a resource or instance.
+
+| Value | Description |
+|-------|-------------|
+| `ACTIVE` | Available for booking |
+| `INACTIVE` | Soft-deleted or disabled |
+| `MAINTENANCE` | Temporarily unavailable |
+
+### Interfaces
+
+#### `Resource`
+The main resource definition owned by a clinic branch.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `string` | Unique identifier |
+| `clinicBranchId` | `string` | Owning clinic branch |
+| `name` | `string` | Display name |
+| `nameLower` | `string` | Lowercase for case-insensitive search |
+| `category` | `ResourceCategory` | Type of resource |
+| `description` | `string?` | Optional description |
+| `quantity` | `number` | Number of physical instances |
+| `status` | `ResourceStatus` | Current status |
+| `linkedProcedureIds` | `string[]` | Procedures requiring this resource |
+| `createdAt` | `Timestamp` | Creation timestamp |
+| `updatedAt` | `Timestamp` | Last update timestamp |
+
+#### `ResourceInstance`
+A single physical unit of a resource. Each instance has its own calendar.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `string` | Unique identifier |
+| `resourceId` | `string` | Parent resource ID |
+| `clinicBranchId` | `string` | Owning clinic branch |
+| `label` | `string` | Auto-generated: `"{Resource.name} #{index}"` |
+| `index` | `number` | 1-based index |
+| `status` | `ResourceStatus` | Current status |
+| `createdAt` / `updatedAt` | `Timestamp` | Timestamps |
+
+#### `ResourceCalendarEvent`
+A calendar event on a resource instance. Can be a booking event (auto-created during appointment creation) or a blocking event (manually created by admin for maintenance/downtime).
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `string` | Unique identifier |
+| `resourceId` | `string` | Parent resource |
+| `resourceInstanceId` | `string` | Specific instance |
+| `clinicBranchId` | `string` | Clinic branch |
+| `eventType` | `CalendarEventType` | `RESOURCE_BOOKING` for bookings, `BLOCKING` for manual blocks |
+| `appointmentId` | `string?` | Linked appointment (only for booking events) |
+| `procedureId` | `string?` | Procedure requiring this resource (only for booking events) |
+| `practitionerId` | `string?` | Practitioner performing procedure (only for booking events) |
+| `patientId` | `string?` | Patient for the appointment (only for booking events) |
+| `eventTime` | `CalendarEventTime` | Start and end times |
+| `status` | `CalendarEventStatus` | `CONFIRMED` for blocking events, mirrors appointment status for bookings |
+| `eventName` | `string` | Display name |
+| `description` | `string?` | Optional description (primarily for blocking events) |
+| `createdAt` / `updatedAt` | `Timestamp` | Timestamps |
+
+#### `ResourceRequirement`
+Lightweight reference stored on procedures.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `resourceId` | `string` | ID of the required resource |
+| `resourceName` | `string` | Snapshot of resource name |
+| `resourceCategory` | `ResourceCategory` | Snapshot of category |
+
+#### `ResourceBookingInfo`
+Stored on the appointment after resource allocation.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `resourceId` | `string` | Booked resource |
+| `resourceName` | `string` | Resource name snapshot |
+| `resourceInstanceId` | `string` | Allocated instance |
+| `resourceInstanceLabel` | `string` | Instance label (e.g., "Room #2") |
+| `calendarEventId` | `string` | Calendar event on instance |
+
+#### `CreateResourceData` / `UpdateResourceData`
+Input types for resource CRUD operations. See source for field details.
+
+#### `CreateResourceBlockingEventParams`
+Parameters for creating a blocking event on a resource instance.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `clinicBranchId` | `string` | Clinic branch |
+| `resourceId` | `string` | Parent resource |
+| `resourceInstanceId` | `string` | Target instance |
+| `eventName` | `string` | Display name (e.g., "Maintenance") |
+| `eventTime` | `CalendarEventTime` | Block start and end times |
+| `description` | `string?` | Optional reason for the block |
+
+#### `UpdateResourceBlockingEventParams`
+Parameters for updating an existing blocking event. Only provided fields are updated.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `clinicBranchId` | `string` | Clinic branch |
+| `resourceId` | `string` | Parent resource |
+| `resourceInstanceId` | `string` | Target instance |
+| `eventId` | `string` | ID of the event to update |
+| `eventName` | `string?` | New display name |
+| `eventTime` | `CalendarEventTime?` | New time range |
+| `description` | `string?` | New description |
+
+### Related Type Extensions
+
+This system also extends existing types:
+
+- **`Procedure`** (`types/procedure/index.ts`): Added optional `resourceRequirements?: ResourceRequirement[]`
+- **`Appointment`** (`types/appointment/index.ts`): Added optional `resourceBookings?: ResourceBookingInfo[]`
+- **`CalendarEventType`** (`types/calendar/index.ts`): Added `RESOURCE_BOOKING = "resource_booking"`
+
+See [main Resource System README](../../../docs/RESOURCE_SYSTEM.md) for the full system overview.