@blackcode_sa/metaestetics-api 1.11.3 → 1.12.1

package/dist/admin/index.d.ts

@@ -138,6 +138,52 @@ interface Review {
     overallRating: number;
 }
 
+/**
+ * @file Defines types for dynamically managed administrative constants,
+ * such as treatment benefits and contraindications. These are stored in
+ * the 'admin-constants' collection in Firestore.
+ */
+/**
+ * Represents a single dynamic treatment benefit.
+ * These are positive effects or results a patient can expect from a treatment.
+ */
+interface TreatmentBenefitDynamic {
+    /**
+     * A unique identifier for the benefit, typically in snake_case.
+     * @example "wrinkle_reduction"
+     */
+    id: string;
+    /**
+     * A human-readable name for the treatment benefit.
+     * @example "Wrinkle Reduction"
+     */
+    name: string;
+    /**
+     * A detailed description of the benefit.
+     */
+    description?: string;
+}
+/**
+ * Represents a single dynamic contraindication.
+ * These are conditions or factors that can affect a procedure and require special attention.
+ */
+interface ContraindicationDynamic {
+    /**
+     * A unique identifier for the contraindication, typically in snake_case.
+     * @example "sensitive_skin"
+     */
+    id: string;
+    /**
+     * A human-readable name for the contraindication.
+     * @example "Sensitive Skin"
+     */
+    name: string;
+    /**
+     * A detailed description of the contraindication.
+     */
+    description?: string;
+}
+
 /**
  * Familije procedura u sistemu
  * Predstavlja najviši nivo hijerarhije i deli procedure na estetske i hirurške
@@ -184,33 +230,256 @@ interface Category {
 }
 
 /**
- * Podkategorija procedura
- * Podkategorije su drugi nivo hijerarhije i pripadaju određenoj kategoriji
- * One grupišu slične tehnologije u okviru kategorije
+ * Enum for element types in documentation templates
+ */
+declare enum DocumentElementType {
+    HEADING = "heading",
+    PARAGRAPH = "paragraph",
+    LIST = "list",
+    DYNAMIC_TEXT = "dynamic_text",
+    BINARY_CHOICE = "binary_choice",
+    MULTIPLE_CHOICE = "multiple_choice",
+    SINGLE_CHOICE = "single_choice",
+    RATING_SCALE = "rating_scale",
+    TEXT_INPUT = "text_input",
+    DATE_PICKER = "date_picker",
+    SIGNATURE = "signature",
+    DITIGAL_SIGNATURE = "digital_signature",
+    FILE_UPLOAD = "file_upload"
+}
+/**
+ * Enum for list types
+ */
+declare enum ListType {
+    ORDERED = "ordered",
+    UNORDERED = "unordered"
+}
+/**
+ * Enum for heading levels
+ */
+declare enum HeadingLevel {
+    H1 = "h1",
+    H2 = "h2",
+    H3 = "h3",
+    H4 = "h4",
+    H5 = "h5",
+    H6 = "h6"
+}
+/**
+ * Base interface for all document elements
+ */
+interface BaseDocumentElement {
+    id: string;
+    type: DocumentElementType;
+    required?: boolean;
+}
+/**
+ * Interface for heading element
+ */
+interface HeadingElement extends BaseDocumentElement {
+    type: DocumentElementType.HEADING;
+    text: string;
+    level: HeadingLevel;
+}
+/**
+ * Interface for paragraph element
+ */
+interface ParagraphElement extends BaseDocumentElement {
+    type: DocumentElementType.PARAGRAPH;
+    text: string;
+}
+/**
+ * Interface for list element
+ */
+interface ListElement extends BaseDocumentElement {
+    type: DocumentElementType.LIST;
+    items: string[];
+    listType: ListType;
+}
+/**
+ * Interface for dynamic text element
+ */
+interface DynamicTextElement extends BaseDocumentElement {
+    type: DocumentElementType.DYNAMIC_TEXT;
+    text: string;
+}
+/**
+ * Interface for binary choice element (Yes/No)
+ */
+interface BinaryChoiceElement extends BaseDocumentElement {
+    type: DocumentElementType.BINARY_CHOICE;
+    question: string;
+    defaultValue?: boolean;
+}
+/**
+ * Interface for multiple choice element
+ */
+interface MultipleChoiceElement extends BaseDocumentElement {
+    type: DocumentElementType.MULTIPLE_CHOICE;
+    question: string;
+    options: string[];
+    defaultValues?: string[];
+}
+/**
+ * Interface for single choice element
+ */
+interface SingleChoiceElement extends BaseDocumentElement {
+    type: DocumentElementType.SINGLE_CHOICE;
+    question: string;
+    options: string[];
+    defaultValue?: string;
+}
+/**
+ * Interface for rating scale element
+ */
+interface RatingScaleElement extends BaseDocumentElement {
+    type: DocumentElementType.RATING_SCALE;
+    question: string;
+    min: number;
+    max: number;
+    labels?: {
+        [key: number]: string;
+    };
+    defaultValue?: number;
+}
+/**
+ * Interface for text input element
+ */
+interface TextInputElement extends BaseDocumentElement {
+    type: DocumentElementType.TEXT_INPUT;
+    label: string;
+    placeholder?: string;
+    multiline?: boolean;
+    defaultValue?: string;
+}
+/**
+ * Interface for date picker element
+ */
+interface DatePickerElement extends BaseDocumentElement {
+    type: DocumentElementType.DATE_PICKER;
+    label: string;
+    defaultValue?: string;
+}
+/**
+ * Interface for signature element
+ */
+interface SignatureElement extends BaseDocumentElement {
+    type: DocumentElementType.SIGNATURE;
+    label: string;
+}
+/**
+ * Interface for file upload element
+ */
+interface FileUploadElement extends BaseDocumentElement {
+    type: DocumentElementType.FILE_UPLOAD;
+    label: string;
+    allowedFileTypes?: string[];
+    maxFileSizeMB?: number;
+}
+/**
+ * Union type for all document elements
+ */
+type DocumentElement = HeadingElement | ParagraphElement | ListElement | DynamicTextElement | BinaryChoiceElement | MultipleChoiceElement | SingleChoiceElement | RatingScaleElement | TextInputElement | DatePickerElement | SignatureElement | FileUploadElement;
+/**
+ * Interface for document template
+ */
+interface DocumentTemplate {
+    id: string;
+    title: string;
+    description?: string;
+    createdAt: number;
+    updatedAt: number;
+    createdBy: string;
+    elements: DocumentElement[];
+    tags?: string[];
+    isUserForm?: boolean;
+    isRequired?: boolean;
+    sortingOrder?: number;
+    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 | FilledDocumentFileValue;
+    };
+    status: FilledDocumentStatus;
+}
+/**
+ * Enum for filled document status
+ */
+declare enum FilledDocumentStatus {
+    DRAFT = "draft",
+    SKIPPED = "skipped",
+    PENDING = "pending",
+    COMPLETED = "completed",// When doctor or patient completes the form
+    SIGNED = "signed",// Only used for user forms
+    REJECTED = "rejected"
+}
+/**
+ * Interface for file upload results to be stored in filled document values
+ */
+interface FilledDocumentFileValue {
+    mediaId: string;
+    url: string;
+    name: string;
+    contentType: string;
+    size: number;
+    uploadedAt: number;
+}
+
+/**
+ * Product used in procedures
+ * Can be consumables, equipment, or any other product needed for performing procedures
  *
- * @property id - Jedinstveni identifikator podkategorije
- * @property name - Naziv podkategorije
- * @property description - Detaljan opis podkategorije i njene namene
- * @property categoryId - ID kategorije kojoj podkategorija pripada
- * @property isActive - Da li je podkategorija aktivna u sistemu
- * @property createdAt - Datum kreiranja
- * @property updatedAt - Datum poslednjeg ažuriranja
+ * @property id - Unique identifier of the product
+ * @property name - Name of the product
+ * @property description - Detailed description of the product and its purpose
+ * @property brandId - ID of the brand that manufactures this product
+ * @property technologyId - ID of the technology this product is used with
+ * @property technicalDetails - Technical details and specifications
+ * @property warnings - List of warnings related to product use
+ * @property dosage - Dosage information (if applicable)
+ * @property composition - Product composition
+ * @property indications - List of indications for use
+ * @property contraindications - List of contraindications
+ * @property isActive - Whether the product is active in the system
+ * @property createdAt - Creation date
+ * @property updatedAt - Last update date
  */
-interface Subcategory {
-    /** Jedinstveni identifikator podkategorije (automatski generisan od strane Firestore) */
+interface Product {
     id?: string;
-    /** Naziv podkategorije */
     name: string;
-    /** Detaljniji opis podkategorije */
-    description?: string;
-    /** ID kategorije kojoj podkategorija pripada */
+    brandId: string;
+    brandName: string;
+    technologyId: string;
+    technologyName: string;
     categoryId: string;
-    /** Flag koji označava da li je podkategorija aktivna */
-    isActive: boolean;
-    /** Datum kreiranja podkategorije */
+    subcategoryId: string;
     createdAt: Date;
-    /** Datum poslednjeg ažuriranja podkategorije */
     updatedAt: Date;
+    isActive: boolean;
+    description?: string;
+    technicalDetails?: string;
+    warnings?: string[];
+    dosage?: string;
+    composition?: string;
+    indications?: string[];
+    contraindications?: ContraindicationDynamic[];
 }
 
 /**
@@ -268,6 +537,36 @@ interface Requirement {
     updatedAt: Date;
 }
 
+/**
+ * Podkategorija procedura
+ * Podkategorije su drugi nivo hijerarhije i pripadaju određenoj kategoriji
+ * One grupišu slične tehnologije u okviru kategorije
+ *
+ * @property id - Jedinstveni identifikator podkategorije
+ * @property name - Naziv podkategorije
+ * @property description - Detaljan opis podkategorije i njene namene
+ * @property categoryId - ID kategorije kojoj podkategorija pripada
+ * @property isActive - Da li je podkategorija aktivna u sistemu
+ * @property createdAt - Datum kreiranja
+ * @property updatedAt - Datum poslednjeg ažuriranja
+ */
+interface Subcategory {
+    /** Jedinstveni identifikator podkategorije (automatski generisan od strane Firestore) */
+    id?: string;
+    /** Naziv podkategorije */
+    name: string;
+    /** Detaljniji opis podkategorije */
+    description?: string;
+    /** ID kategorije kojoj podkategorija pripada */
+    categoryId: string;
+    /** Flag koji označava da li je podkategorija aktivna */
+    isActive: boolean;
+    /** Datum kreiranja podkategorije */
+    createdAt: Date;
+    /** Datum poslednjeg ažuriranja podkategorije */
+    updatedAt: Date;
+}
+
 /**
  * Blokirajući uslovi koji mogu sprečiti proceduru
  * Ovi uslovi predstavljaju apsolutne kontraindikacije koje onemogućavaju izvođenje procedure
@@ -290,47 +589,6 @@ declare enum BlockingCondition {
     EPILEPSY = "epilepsy"
 }
 
-/**
- * Kontraindikacije koje mogu uticati na proceduru
- * Ovi uslovi predstavljaju relativne kontraindikacije koje zahtevaju posebnu pažnju
- */
-declare enum Contraindication {
-    SENSITIVE_SKIN = "sensitive_skin",
-    RECENT_TANNING = "recent_tanning",
-    RECENT_BOTOX = "recent_botox",
-    RECENT_FILLERS = "recent_fillers",
-    SKIN_ALLERGIES = "skin_allergies",
-    MEDICATIONS = "medications",
-    RECENT_CHEMICAL_PEEL = "recent_chemical_peel",
-    RECENT_LASER = "recent_laser",
-    SKIN_INFLAMMATION = "skin_inflammation",
-    OPEN_WOUNDS = "open_wounds",
-    HERPES_SIMPLEX = "herpes_simplex",
-    COLD_SORES = "cold_sores"
-}
-
-/**
- * Benefiti koji se mogu očekivati od procedure
- * Lista mogućih pozitivnih efekata i rezultata tretmana
- */
-declare enum TreatmentBenefit {
-    WRINKLE_REDUCTION = "wrinkle_reduction",
-    SKIN_TIGHTENING = "skin_tightening",
-    COLLAGEN_PRODUCTION = "collagen_production",
-    ACNE_REDUCTION = "acne_reduction",
-    SCAR_REDUCTION = "scar_reduction",
-    PIGMENTATION_IMPROVEMENT = "pigmentation_improvement",
-    HAIR_REMOVAL = "hair_removal",
-    MUSCLE_TONING = "muscle_toning",
-    FAT_REDUCTION = "fat_reduction",
-    CELLULITE_REDUCTION = "cellulite_reduction",
-    SKIN_REJUVENATION = "skin_rejuvenation",
-    PORE_REDUCTION = "pore_reduction",
-    TEXTURE_IMPROVEMENT = "texture_improvement",
-    HYDRATION_BOOST = "hydration_boost",
-    CIRCULATION_IMPROVEMENT = "circulation_improvement"
-}
-
 /**
  * Nivoi sertifikacije medicinskog osoblja, poređani od najnižeg do najvišeg
  */
@@ -405,61 +663,23 @@ interface TechnologyDocumentationTemplate {
 interface Technology {
     id?: string;
     name: string;
-    description: string;
-    family: ProcedureFamily;
-    categoryId: string;
-    subcategoryId: string;
-    technicalDetails?: string;
-    requirements: {
-        pre: Requirement[];
-        post: Requirement[];
-    };
-    blockingConditions: BlockingCondition[];
-    contraindications: Contraindication[];
-    benefits: TreatmentBenefit[];
-    certificationRequirement: CertificationRequirement;
-    documentationTemplates?: TechnologyDocumentationTemplate[];
-    isActive: boolean;
-    createdAt: Date;
-    updatedAt: Date;
-}
-
-/**
- * Product used in procedures
- * Can be consumables, equipment, or any other product needed for performing procedures
- *
- * @property id - Unique identifier of the product
- * @property name - Name of the product
- * @property description - Detailed description of the product and its purpose
- * @property brandId - ID of the brand that manufactures this product
- * @property technologyId - ID of the technology this product is used with
- * @property technicalDetails - Technical details and specifications
- * @property warnings - List of warnings related to product use
- * @property dosage - Dosage information (if applicable)
- * @property composition - Product composition
- * @property indications - List of indications for use
- * @property contraindications - List of contraindications
- * @property isActive - Whether the product is active in the system
- * @property createdAt - Creation date
- * @property updatedAt - Last update date
- */
-interface Product {
-    id?: string;
-    name: string;
-    brandId: string;
-    brandName: string;
-    technologyId: string;
-    technologyName: string;
+    description: string;
+    family: ProcedureFamily;
+    categoryId: string;
+    subcategoryId: string;
+    technicalDetails?: string;
+    requirements: {
+        pre: Requirement[];
+        post: Requirement[];
+    };
+    blockingConditions: BlockingCondition[];
+    contraindications: ContraindicationDynamic[];
+    benefits: TreatmentBenefitDynamic[];
+    certificationRequirement: CertificationRequirement;
+    documentationTemplates?: TechnologyDocumentationTemplate[];
+    isActive: boolean;
     createdAt: Date;
     updatedAt: Date;
-    isActive: boolean;
-    description?: string;
-    technicalDetails?: string;
-    warnings?: string[];
-    dosage?: string;
-    composition?: string;
-    indications?: string[];
-    contraindications?: string[];
 }
 
 declare enum PricingMeasure {
@@ -478,6 +698,38 @@ declare enum Currency {
     AUD = "AUD"
 }
 
+/**
+ * @fileoverview Defines the ProcedureProduct type, which represents a product associated with a procedure,
+ * including its pricing information. This is used to allow procedures to have multiple products with different prices.
+ * @packageDocumentation
+ */
+
+/**
+ * Represents a product associated with a procedure, including its specific pricing information.
+ */
+interface ProcedureProduct {
+    /**
+     * The product used in the procedure.
+     * @see {@link Product}
+     */
+    product: Product;
+    /**
+     * The price of the procedure when using this specific product.
+     */
+    price: number;
+    /**
+     * The currency for the price of this product.
+     * @see {@link Currency}
+     */
+    currency: Currency;
+    /**
+     * How the price is measured (e.g., per ml, per zone).
+     * @see {@link PricingMeasure}
+     */
+    pricingMeasure: PricingMeasure;
+    isDefault?: boolean;
+}
+
 /**
  * Type that allows a field to be either a URL string or a File object
  */
@@ -506,22 +758,27 @@ interface Procedure {
     subcategory: Subcategory;
     /** Technology used in this procedure */
     technology: Technology;
-    /** Product used in this procedure */
+    /** Default product used in this procedure */
     product: Product;
-    /** Price of the procedure */
+    /** Default price of the procedure */
     price: number;
     /** Currency for the price */
     currency: Currency;
-    /** How the price is measured (per ml, per zone, etc.) */
+    /** 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: TreatmentBenefit[];
+    treatmentBenefits: TreatmentBenefitDynamic[];
+    /** A list of just the string IDs of the treatment benefits, for efficient querying. */
+    treatmentBenefitIds: string[];
     /** Contraindications of this procedure */
-    contraindications: Contraindication[];
+    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 */
@@ -1012,7 +1269,7 @@ interface PatientMedicalInfo {
         notes?: string | null;
     }[];
     contraindications: {
-        condition: Contraindication;
+        condition: ContraindicationDynamic;
         lastOccurrence: Timestamp;
         frequency: "rare" | "occasional" | "frequent";
         isActive: boolean;
@@ -1202,219 +1459,6 @@ interface PatientProfileInfo {
     gender: Gender;
 }
 
-/**
- * Enum for element types in documentation templates
- */
-declare enum DocumentElementType {
-    HEADING = "heading",
-    PARAGRAPH = "paragraph",
-    LIST = "list",
-    DYNAMIC_TEXT = "dynamic_text",
-    BINARY_CHOICE = "binary_choice",
-    MULTIPLE_CHOICE = "multiple_choice",
-    SINGLE_CHOICE = "single_choice",
-    RATING_SCALE = "rating_scale",
-    TEXT_INPUT = "text_input",
-    DATE_PICKER = "date_picker",
-    SIGNATURE = "signature",
-    DITIGAL_SIGNATURE = "digital_signature",
-    FILE_UPLOAD = "file_upload"
-}
-/**
- * Enum for list types
- */
-declare enum ListType {
-    ORDERED = "ordered",
-    UNORDERED = "unordered"
-}
-/**
- * Enum for heading levels
- */
-declare enum HeadingLevel {
-    H1 = "h1",
-    H2 = "h2",
-    H3 = "h3",
-    H4 = "h4",
-    H5 = "h5",
-    H6 = "h6"
-}
-/**
- * Base interface for all document elements
- */
-interface BaseDocumentElement {
-    id: string;
-    type: DocumentElementType;
-    required?: boolean;
-}
-/**
- * Interface for heading element
- */
-interface HeadingElement extends BaseDocumentElement {
-    type: DocumentElementType.HEADING;
-    text: string;
-    level: HeadingLevel;
-}
-/**
- * Interface for paragraph element
- */
-interface ParagraphElement extends BaseDocumentElement {
-    type: DocumentElementType.PARAGRAPH;
-    text: string;
-}
-/**
- * Interface for list element
- */
-interface ListElement extends BaseDocumentElement {
-    type: DocumentElementType.LIST;
-    items: string[];
-    listType: ListType;
-}
-/**
- * Interface for dynamic text element
- */
-interface DynamicTextElement extends BaseDocumentElement {
-    type: DocumentElementType.DYNAMIC_TEXT;
-    text: string;
-}
-/**
- * Interface for binary choice element (Yes/No)
- */
-interface BinaryChoiceElement extends BaseDocumentElement {
-    type: DocumentElementType.BINARY_CHOICE;
-    question: string;
-    defaultValue?: boolean;
-}
-/**
- * Interface for multiple choice element
- */
-interface MultipleChoiceElement extends BaseDocumentElement {
-    type: DocumentElementType.MULTIPLE_CHOICE;
-    question: string;
-    options: string[];
-    defaultValues?: string[];
-}
-/**
- * Interface for single choice element
- */
-interface SingleChoiceElement extends BaseDocumentElement {
-    type: DocumentElementType.SINGLE_CHOICE;
-    question: string;
-    options: string[];
-    defaultValue?: string;
-}
-/**
- * Interface for rating scale element
- */
-interface RatingScaleElement extends BaseDocumentElement {
-    type: DocumentElementType.RATING_SCALE;
-    question: string;
-    min: number;
-    max: number;
-    labels?: {
-        [key: number]: string;
-    };
-    defaultValue?: number;
-}
-/**
- * Interface for text input element
- */
-interface TextInputElement extends BaseDocumentElement {
-    type: DocumentElementType.TEXT_INPUT;
-    label: string;
-    placeholder?: string;
-    multiline?: boolean;
-    defaultValue?: string;
-}
-/**
- * Interface for date picker element
- */
-interface DatePickerElement extends BaseDocumentElement {
-    type: DocumentElementType.DATE_PICKER;
-    label: string;
-    defaultValue?: string;
-}
-/**
- * Interface for signature element
- */
-interface SignatureElement extends BaseDocumentElement {
-    type: DocumentElementType.SIGNATURE;
-    label: string;
-}
-/**
- * Interface for file upload element
- */
-interface FileUploadElement extends BaseDocumentElement {
-    type: DocumentElementType.FILE_UPLOAD;
-    label: string;
-    allowedFileTypes?: string[];
-    maxFileSizeMB?: number;
-}
-/**
- * Union type for all document elements
- */
-type DocumentElement = HeadingElement | ParagraphElement | ListElement | DynamicTextElement | BinaryChoiceElement | MultipleChoiceElement | SingleChoiceElement | RatingScaleElement | TextInputElement | DatePickerElement | SignatureElement | FileUploadElement;
-/**
- * Interface for document template
- */
-interface DocumentTemplate {
-    id: string;
-    title: string;
-    description?: string;
-    createdAt: number;
-    updatedAt: number;
-    createdBy: string;
-    elements: DocumentElement[];
-    tags?: string[];
-    isUserForm?: boolean;
-    isRequired?: boolean;
-    sortingOrder?: number;
-    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 | FilledDocumentFileValue;
-    };
-    status: FilledDocumentStatus;
-}
-/**
- * Enum for filled document status
- */
-declare enum FilledDocumentStatus {
-    DRAFT = "draft",
-    SKIPPED = "skipped",
-    PENDING = "pending",
-    COMPLETED = "completed",// When doctor or patient completes the form
-    SIGNED = "signed",// Only used for user forms
-    REJECTED = "rejected"
-}
-/**
- * Interface for file upload results to be stored in filled document values
- */
-interface FilledDocumentFileValue {
-    mediaId: string;
-    url: string;
-    name: string;
-    contentType: string;
-    size: number;
-    uploadedAt: number;
-}
-
 /**
  * Enum defining the possible statuses of an appointment.
  */
@@ -1628,7 +1672,7 @@ interface Appointment {
     paymentTransactionId?: string | null;
     /** Procedure-related conditions and requirements */
     blockingConditions: BlockingCondition[];
-    contraindications: Contraindication[];
+    contraindications: ContraindicationDynamic[];
     preProcedureRequirements: Requirement[];
     postProcedureRequirements: Requirement[];
     /** Tracking information for requirements completion */