@blackcode_sa/metaestetics-api 1.11.1 → 1.11.2

package/src/backoffice/services/constants.service.ts

@@ -1,268 +0,0 @@
-import {
-  arrayRemove,
-  arrayUnion,
-  collection,
-  doc,
-  getDoc,
-  setDoc,
-  updateDoc,
-} from "firebase/firestore";
-import { BaseService } from "../../services/base.service";
-import {
-  ContraindicationDynamic,
-  ContraindicationsDocument,
-  TreatmentBenefitDynamic,
-  TreatmentBenefitsDocument,
-} from "../types/admin-constants.types";
-
-const ADMIN_CONSTANTS_COLLECTION = "admin-constants";
-const TREATMENT_BENEFITS_DOC = "treatment-benefits";
-const CONTRAINDICATIONS_DOC = "contraindications";
-
-/**
- * @class ConstantsService
- * @description Service for managing administrative constants, such as treatment benefits and contraindications.
- * These constants are stored in a single Firestore collection 'admin-constants',
- * with each type of constant in its own document ('treatment-benefits', 'contraindications').
- * The constants themselves are stored in an array within these documents.
- * @extends {BaseService}
- */
-export class ConstantsService extends BaseService {
-  /**
-   * @description Gets the reference to the document holding treatment benefits.
-   * @private
-   * @type {DocumentReference}
-   */
-  private get treatmentBenefitsDocRef() {
-    return doc(this.db, ADMIN_CONSTANTS_COLLECTION, TREATMENT_BENEFITS_DOC);
-  }
-
-  /**
-   * @description Gets the reference to the document holding contraindications.
-   * @private
-   * @type {DocumentReference}
-   */
-  private get contraindicationsDocRef() {
-    return doc(this.db, ADMIN_CONSTANTS_COLLECTION, CONTRAINDICATIONS_DOC);
-  }
-
-  // =================================================================
-  // Treatment Benefits
-  // =================================================================
-
-  /**
-   * @description Retrieves all treatment benefits.
-   * @returns {Promise<TreatmentBenefitDynamic[]>} An array of all treatment benefits.
-   */
-  async getAllBenefits(): Promise<TreatmentBenefitDynamic[]> {
-    const docSnap = await getDoc(this.treatmentBenefitsDocRef);
-    if (!docSnap.exists()) {
-      return [];
-    }
-    return (docSnap.data() as TreatmentBenefitsDocument).benefits;
-  }
-
-  /**
-   * @description Adds a new treatment benefit.
-   * @param {Omit<TreatmentBenefitDynamic, "id">} benefit - The treatment benefit to add, without an ID.
-   * @returns {Promise<TreatmentBenefitDynamic>} The newly created treatment benefit with its generated ID.
-   */
-  async addTreatmentBenefit(
-    benefit: Omit<TreatmentBenefitDynamic, "id">
-  ): Promise<TreatmentBenefitDynamic> {
-    const newBenefit: TreatmentBenefitDynamic = {
-      id: this.generateId(),
-      ...benefit,
-    };
-
-    const docSnap = await getDoc(this.treatmentBenefitsDocRef);
-    if (!docSnap.exists()) {
-      await setDoc(this.treatmentBenefitsDocRef, { benefits: [newBenefit] });
-    } else {
-      await updateDoc(this.treatmentBenefitsDocRef, {
-        benefits: arrayUnion(newBenefit),
-      });
-    }
-
-    return newBenefit;
-  }
-
-  /**
-   * @description Retrieves a single treatment benefit by its ID.
-   * @param {string} benefitId - The ID of the treatment benefit to retrieve.
-   * @returns {Promise<TreatmentBenefitDynamic | undefined>} The found treatment benefit or undefined.
-   */
-  async getBenefitById(
-    benefitId: string
-  ): Promise<TreatmentBenefitDynamic | undefined> {
-    const benefits = await this.getAllBenefits();
-    return benefits.find((b) => b.id === benefitId);
-  }
-
-  /**
-   * @description Searches for treatment benefits by name (case-insensitive).
-   * @param {string} searchTerm - The term to search for in the benefit names.
-   * @returns {Promise<TreatmentBenefitDynamic[]>} An array of matching treatment benefits.
-   */
-  async searchBenefitsByName(
-    searchTerm: string
-  ): Promise<TreatmentBenefitDynamic[]> {
-    const benefits = await this.getAllBenefits();
-    const normalizedSearchTerm = searchTerm.toLowerCase();
-    return benefits.filter((b) =>
-      b.name.toLowerCase().includes(normalizedSearchTerm)
-    );
-  }
-
-  /**
-   * @description Updates an existing treatment benefit.
-   * @param {TreatmentBenefitDynamic} benefit - The treatment benefit with updated data. Its ID must match an existing benefit.
-   * @returns {Promise<TreatmentBenefitDynamic>} The updated treatment benefit.
-   * @throws {Error} If the treatment benefit is not found.
-   */
-  async updateTreatmentBenefit(
-    benefit: TreatmentBenefitDynamic
-  ): Promise<TreatmentBenefitDynamic> {
-    const benefits = await this.getAllBenefits();
-    const benefitIndex = benefits.findIndex((b) => b.id === benefit.id);
-
-    if (benefitIndex === -1) {
-      throw new Error("Treatment benefit not found.");
-    }
-
-    benefits[benefitIndex] = benefit;
-
-    await updateDoc(this.treatmentBenefitsDocRef, { benefits });
-    return benefit;
-  }
-
-  /**
-   * @description Deletes a treatment benefit by its ID.
-   * @param {string} benefitId - The ID of the treatment benefit to delete.
-   * @returns {Promise<void>}
-   */
-  async deleteTreatmentBenefit(benefitId: string): Promise<void> {
-    const benefits = await this.getAllBenefits();
-    const benefitToRemove = benefits.find((b) => b.id === benefitId);
-
-    if (!benefitToRemove) {
-      return;
-    }
-
-    await updateDoc(this.treatmentBenefitsDocRef, {
-      benefits: arrayRemove(benefitToRemove),
-    });
-  }
-
-  // =================================================================
-  // Contraindications
-  // =================================================================
-
-  /**
-   * @description Retrieves all contraindications.
-   * @returns {Promise<ContraindicationDynamic[]>} An array of all contraindications.
-   */
-  async getAllContraindications(): Promise<ContraindicationDynamic[]> {
-    const docSnap = await getDoc(this.contraindicationsDocRef);
-    if (!docSnap.exists()) {
-      return [];
-    }
-    return (docSnap.data() as ContraindicationsDocument).contraindications;
-  }
-
-  /**
-   * @description Adds a new contraindication.
-   * @param {Omit<ContraindicationDynamic, "id">} contraindication - The contraindication to add, without an ID.
-   * @returns {Promise<ContraindicationDynamic>} The newly created contraindication with its generated ID.
-   */
-  async addContraindication(
-    contraindication: Omit<ContraindicationDynamic, "id">
-  ): Promise<ContraindicationDynamic> {
-    const newContraindication: ContraindicationDynamic = {
-      id: this.generateId(),
-      ...contraindication,
-    };
-
-    const docSnap = await getDoc(this.contraindicationsDocRef);
-    if (!docSnap.exists()) {
-      await setDoc(this.contraindicationsDocRef, {
-        contraindications: [newContraindication],
-      });
-    } else {
-      await updateDoc(this.contraindicationsDocRef, {
-        contraindications: arrayUnion(newContraindication),
-      });
-    }
-
-    return newContraindication;
-  }
-
-  /**
-   * @description Retrieves a single contraindication by its ID.
-   * @param {string} contraindicationId - The ID of the contraindication to retrieve.
-   * @returns {Promise<ContraindicationDynamic | undefined>} The found contraindication or undefined.
-   */
-  async getContraindicationById(
-    contraindicationId: string
-  ): Promise<ContraindicationDynamic | undefined> {
-    const contraindications = await this.getAllContraindications();
-    return contraindications.find((c) => c.id === contraindicationId);
-  }
-
-  /**
-   * @description Searches for contraindications by name (case-insensitive).
-   * @param {string} searchTerm - The term to search for in the contraindication names.
-   * @returns {Promise<ContraindicationDynamic[]>} An array of matching contraindications.
-   */
-  async searchContraindicationsByName(
-    searchTerm: string
-  ): Promise<ContraindicationDynamic[]> {
-    const contraindications = await this.getAllContraindications();
-    const normalizedSearchTerm = searchTerm.toLowerCase();
-    return contraindications.filter((c) =>
-      c.name.toLowerCase().includes(normalizedSearchTerm)
-    );
-  }
-
-  /**
-   * @description Updates an existing contraindication.
-   * @param {ContraindicationDynamic} contraindication - The contraindication with updated data. Its ID must match an existing one.
-   * @returns {Promise<ContraindicationDynamic>} The updated contraindication.
-   * @throws {Error} If the contraindication is not found.
-   */
-  async updateContraindication(
-    contraindication: ContraindicationDynamic
-  ): Promise<ContraindicationDynamic> {
-    const contraindications = await this.getAllContraindications();
-    const index = contraindications.findIndex(
-      (c) => c.id === contraindication.id
-    );
-
-    if (index === -1) {
-      throw new Error("Contraindication not found.");
-    }
-
-    contraindications[index] = contraindication;
-
-    await updateDoc(this.contraindicationsDocRef, { contraindications });
-    return contraindication;
-  }
-
-  /**
-   * @description Deletes a contraindication by its ID.
-   * @param {string} contraindicationId - The ID of the contraindication to delete.
-   * @returns {Promise<void>}
-   */
-  async deleteContraindication(contraindicationId: string): Promise<void> {
-    const contraindications = await this.getAllContraindications();
-    const toRemove = contraindications.find((c) => c.id === contraindicationId);
-
-    if (!toRemove) {
-      return;
-    }
-
-    await updateDoc(this.contraindicationsDocRef, {
-      contraindications: arrayRemove(toRemove),
-    });
-  }
-}

package/src/backoffice/types/admin-constants.types.ts

@@ -1,69 +0,0 @@
-/**
- * @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.
- */
-export 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;
-}
-
-/**
- * Defines the structure of the document storing all treatment benefits
- * in the 'admin-constants' collection.
- * The document ID for this type should be 'treatment-benefits'.
- */
-export interface TreatmentBenefitsDocument {
-  benefits: TreatmentBenefitDynamic[];
-}
-
-/**
- * Represents a single dynamic contraindication.
- * These are conditions or factors that can affect a procedure and require special attention.
- */
-export 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;
-}
-
-/**
- * Defines the structure of the document storing all contraindications
- * in the 'admin-constants' collection.
- * The document ID for this type should be 'contraindications'.
- */
-export interface ContraindicationsDocument {
-  contraindications: ContraindicationDynamic[];
-}