@blackcode_sa/metaestetics-api 1.5.12 → 1.5.13

package/dist/index.d.mts

@@ -1562,23 +1562,23 @@ interface Category {
 }
 
 /**
- * Proizvod koji se koristi u procedurama
- * Može biti potrošni materijal, oprema ili bilo koji drugi proizvod potreban za izvođenje procedure
+ * Product used in procedures
+ * Can be consumables, equipment, or any other product needed for performing procedures
  *
- * @property id - Jedinstveni identifikator proizvoda
- * @property name - Naziv proizvoda
- * @property description - Detaljan opis proizvoda i njegove namene
- * @property brandId - ID brenda koji proizvodi ovaj proizvod
- * @property technologyId - ID tehnologije sa kojom se proizvod koristi
- * @property technicalDetails - Tehnički detalji i specifikacije proizvoda
- * @property warnings - Lista upozorenja vezanih za korišćenje proizvoda
- * @property dosage - Informacije o doziranju (ako je primenljivo)
- * @property composition - Sastav proizvoda
- * @property indications - Lista indikacija za korišćenje
- * @property contraindications - Lista kontraindikacija
- * @property isActive - Da li je proizvod aktivan 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 Product {
     id?: string;
@@ -1596,6 +1596,47 @@ interface Product {
     indications?: string[];
     contraindications?: string[];
 }
+/**
+ * Interface for the ProductService class
+ */
+interface IProductService {
+    /**
+     * Creates a new product
+     * @param technologyId - ID of the technology this product is used with
+     * @param brandId - ID of the brand that manufactures this product
+     * @param product - Product data
+     */
+    create(technologyId: string, brandId: string, product: Omit<Product, "id" | "createdAt" | "updatedAt" | "brandId" | "technologyId">): Promise<Product>;
+    /**
+     * Gets all products for a technology
+     * @param technologyId - ID of the technology
+     */
+    getAllByTechnology(technologyId: string): Promise<Product[]>;
+    /**
+     * Gets all products for a brand
+     * @param brandId - ID of the brand
+     */
+    getAllByBrand(brandId: string): Promise<Product[]>;
+    /**
+     * Updates a product
+     * @param technologyId - ID of the technology
+     * @param productId - ID of the product to update
+     * @param product - Updated product data
+     */
+    update(technologyId: string, productId: string, product: Partial<Omit<Product, "id" | "createdAt" | "brandId" | "technologyId">>): Promise<Product | null>;
+    /**
+     * Deletes a product (soft delete)
+     * @param technologyId - ID of the technology
+     * @param productId - ID of the product to delete
+     */
+    delete(technologyId: string, productId: string): Promise<void>;
+    /**
+     * Gets a product by ID
+     * @param technologyId - ID of the technology
+     * @param productId - ID of the product
+     */
+    getById(technologyId: string, productId: string): Promise<Product | null>;
+}
 
 /**
  * Jedinica mere za vremenski period
@@ -1705,40 +1746,24 @@ interface Subcategory {
  * @property updatedAt - Last update date
  */
 interface Technology {
-    /** Jedinstveni identifikator tehnologije (automatski generisan od strane Firestore) */
     id?: string;
-    /** Naziv tehnologije */
     name: string;
-    /** Detaljan opis tehnologije */
     description: string;
-    /** Familija procedura kojoj tehnologija pripada */
     family: ProcedureFamily;
-    /** ID kategorije kojoj tehnologija pripada */
     categoryId: string;
-    /** ID potkategorije kojoj tehnologija pripada */
     subcategoryId: string;
-    /** Tehnički detalji i specifikacije */
     technicalDetails?: string;
-    /** Zahtevi pre i posle tretmana */
     requirements: {
         pre: Requirement[];
         post: Requirement[];
     };
-    /** Apsolutne kontraindikacije koje sprečavaju tretman */
     blockingConditions: BlockingCondition[];
-    /** Relativne kontraindikacije koje zahtevaju posebnu pažnju */
     contraindications: Contraindication[];
-    /** Očekivane dobrobiti tretmana */
     benefits: TreatmentBenefit[];
-    /** Potrebna sertifikacija za korišćenje tehnologije */
     certificationRequirement: CertificationRequirement;
-    /** Dokumentacioni šabloni potrebni za ovu tehnologiju */
     documentationTemplates?: DocumentTemplate[];
-    /** Da li je tehnologija trenutno aktivna */
     isActive: boolean;
-    /** Datum kreiranja */
     createdAt: Date;
-    /** Datum poslednjeg ažuriranja */
     updatedAt: Date;
 }
 
@@ -3257,6 +3282,7 @@ declare const documentTemplateSchema: z.ZodObject<{
     id: string;
     isActive: boolean;
     updatedAt: number;
+    createdAt: number;
     title: string;
     elements: ({
         type: DocumentElementType.HEADING;
@@ -3336,7 +3362,6 @@ declare const documentTemplateSchema: z.ZodObject<{
         allowedFileTypes?: string[] | undefined;
         maxFileSizeMB?: number | undefined;
     })[];
-    createdAt: number;
     createdBy: string;
     version: number;
     description?: string | undefined;
@@ -3345,6 +3370,7 @@ declare const documentTemplateSchema: z.ZodObject<{
     id: string;
     isActive: boolean;
     updatedAt: number;
+    createdAt: number;
     title: string;
     elements: ({
         type: DocumentElementType.HEADING;
@@ -3424,7 +3450,6 @@ declare const documentTemplateSchema: z.ZodObject<{
         allowedFileTypes?: string[] | undefined;
         maxFileSizeMB?: number | undefined;
     })[];
-    createdAt: number;
     createdBy: string;
     version: number;
     description?: string | undefined;
@@ -3821,7 +3846,13 @@ declare class TechnologyService extends BaseService {
 }
 
 declare class BrandService extends BaseService {
-    private get brandsRef();
+    /**
+     * Gets reference to brands collection
+     */
+    private getBrandsRef;
+    /**
+     * Creates a new brand
+     */
     create(brand: Omit<Brand, "id" | "createdAt" | "updatedAt">): Promise<{
         isActive: boolean;
         updatedAt: Date;
@@ -3832,36 +3863,55 @@ declare class BrandService extends BaseService {
         website?: string | undefined;
         id: string;
     }>;
+    /**
+     * Gets all active brands
+     */
     getAll(): Promise<Brand[]>;
-    update(id: string, brand: Partial<Omit<Brand, "id" | "createdAt">>): Promise<Brand | null>;
-    delete(id: string): Promise<void>;
-    getById(id: string): Promise<Brand | null>;
+    /**
+     * Updates a brand
+     */
+    update(brandId: string, brand: Partial<Omit<Brand, "id" | "createdAt">>): Promise<Brand | null>;
+    /**
+     * Soft deletes a brand
+     */
+    delete(brandId: string): Promise<void>;
+    /**
+     * Gets a brand by ID
+     */
+    getById(brandId: string): Promise<Brand | null>;
 }
 
-declare class ProductService extends BaseService {
-    private getProductsRefByTechnology;
-    private getProductsRefByBrand;
-    create(categoryId: string, subcategoryId: string, technologyId: string, brandId: string, product: Omit<Product, "id" | "createdAt" | "updatedAt" | "brandId" | "technologyId">): Promise<{
-        isActive: boolean;
-        updatedAt: Date;
-        contraindications?: string[] | undefined;
-        name: string;
-        dosage?: string | undefined;
-        description?: string | undefined;
-        createdAt: Date;
-        technicalDetails?: string | undefined;
-        brandId: string;
-        technologyId: string;
-        warnings?: string[] | undefined;
-        composition?: string | undefined;
-        indications?: string[] | undefined;
-        id: string;
-    }>;
-    getAllByTechnology(categoryId: string, subcategoryId: string, technologyId: string): Promise<Product[]>;
+declare class ProductService extends BaseService implements IProductService {
+    /**
+     * Gets reference to products collection under a technology
+     * @param technologyId - ID of the technology
+     * @returns Firestore collection reference
+     */
+    private getProductsRef;
+    /**
+     * Creates a new product under technology
+     */
+    create(technologyId: string, brandId: string, product: Omit<Product, "id" | "createdAt" | "updatedAt" | "brandId" | "technologyId">): Promise<Product>;
+    /**
+     * Gets all products for a technology
+     */
+    getAllByTechnology(technologyId: string): Promise<Product[]>;
+    /**
+     * Gets all products for a brand by filtering through all technologies
+     */
     getAllByBrand(brandId: string): Promise<Product[]>;
-    update(categoryId: string, subcategoryId: string, technologyId: string, productId: string, product: Partial<Omit<Product, "id" | "createdAt" | "brandId" | "technologyId">>): Promise<Product | null>;
-    delete(categoryId: string, subcategoryId: string, technologyId: string, productId: string): Promise<void>;
-    getById(categoryId: string, subcategoryId: string, technologyId: string, productId: string): Promise<Product | null>;
+    /**
+     * Updates a product
+     */
+    update(technologyId: string, productId: string, product: Partial<Omit<Product, "id" | "createdAt" | "brandId" | "technologyId">>): Promise<Product | null>;
+    /**
+     * Soft deletes a product
+     */
+    delete(technologyId: string, productId: string): Promise<void>;
+    /**
+     * Gets a product by ID
+     */
+    getById(technologyId: string, productId: string): Promise<Product | null>;
 }
 
 /**

package/dist/index.d.ts

@@ -1562,23 +1562,23 @@ interface Category {
 }
 
 /**
- * Proizvod koji se koristi u procedurama
- * Može biti potrošni materijal, oprema ili bilo koji drugi proizvod potreban za izvođenje procedure
+ * Product used in procedures
+ * Can be consumables, equipment, or any other product needed for performing procedures
  *
- * @property id - Jedinstveni identifikator proizvoda
- * @property name - Naziv proizvoda
- * @property description - Detaljan opis proizvoda i njegove namene
- * @property brandId - ID brenda koji proizvodi ovaj proizvod
- * @property technologyId - ID tehnologije sa kojom se proizvod koristi
- * @property technicalDetails - Tehnički detalji i specifikacije proizvoda
- * @property warnings - Lista upozorenja vezanih za korišćenje proizvoda
- * @property dosage - Informacije o doziranju (ako je primenljivo)
- * @property composition - Sastav proizvoda
- * @property indications - Lista indikacija za korišćenje
- * @property contraindications - Lista kontraindikacija
- * @property isActive - Da li je proizvod aktivan 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 Product {
     id?: string;
@@ -1596,6 +1596,47 @@ interface Product {
     indications?: string[];
     contraindications?: string[];
 }
+/**
+ * Interface for the ProductService class
+ */
+interface IProductService {
+    /**
+     * Creates a new product
+     * @param technologyId - ID of the technology this product is used with
+     * @param brandId - ID of the brand that manufactures this product
+     * @param product - Product data
+     */
+    create(technologyId: string, brandId: string, product: Omit<Product, "id" | "createdAt" | "updatedAt" | "brandId" | "technologyId">): Promise<Product>;
+    /**
+     * Gets all products for a technology
+     * @param technologyId - ID of the technology
+     */
+    getAllByTechnology(technologyId: string): Promise<Product[]>;
+    /**
+     * Gets all products for a brand
+     * @param brandId - ID of the brand
+     */
+    getAllByBrand(brandId: string): Promise<Product[]>;
+    /**
+     * Updates a product
+     * @param technologyId - ID of the technology
+     * @param productId - ID of the product to update
+     * @param product - Updated product data
+     */
+    update(technologyId: string, productId: string, product: Partial<Omit<Product, "id" | "createdAt" | "brandId" | "technologyId">>): Promise<Product | null>;
+    /**
+     * Deletes a product (soft delete)
+     * @param technologyId - ID of the technology
+     * @param productId - ID of the product to delete
+     */
+    delete(technologyId: string, productId: string): Promise<void>;
+    /**
+     * Gets a product by ID
+     * @param technologyId - ID of the technology
+     * @param productId - ID of the product
+     */
+    getById(technologyId: string, productId: string): Promise<Product | null>;
+}
 
 /**
  * Jedinica mere za vremenski period
@@ -1705,40 +1746,24 @@ interface Subcategory {
  * @property updatedAt - Last update date
  */
 interface Technology {
-    /** Jedinstveni identifikator tehnologije (automatski generisan od strane Firestore) */
     id?: string;
-    /** Naziv tehnologije */
     name: string;
-    /** Detaljan opis tehnologije */
     description: string;
-    /** Familija procedura kojoj tehnologija pripada */
     family: ProcedureFamily;
-    /** ID kategorije kojoj tehnologija pripada */
     categoryId: string;
-    /** ID potkategorije kojoj tehnologija pripada */
     subcategoryId: string;
-    /** Tehnički detalji i specifikacije */
     technicalDetails?: string;
-    /** Zahtevi pre i posle tretmana */
     requirements: {
         pre: Requirement[];
         post: Requirement[];
     };
-    /** Apsolutne kontraindikacije koje sprečavaju tretman */
     blockingConditions: BlockingCondition[];
-    /** Relativne kontraindikacije koje zahtevaju posebnu pažnju */
     contraindications: Contraindication[];
-    /** Očekivane dobrobiti tretmana */
     benefits: TreatmentBenefit[];
-    /** Potrebna sertifikacija za korišćenje tehnologije */
     certificationRequirement: CertificationRequirement;
-    /** Dokumentacioni šabloni potrebni za ovu tehnologiju */
     documentationTemplates?: DocumentTemplate[];
-    /** Da li je tehnologija trenutno aktivna */
     isActive: boolean;
-    /** Datum kreiranja */
     createdAt: Date;
-    /** Datum poslednjeg ažuriranja */
     updatedAt: Date;
 }
 
@@ -3257,6 +3282,7 @@ declare const documentTemplateSchema: z.ZodObject<{
     id: string;
     isActive: boolean;
     updatedAt: number;
+    createdAt: number;
     title: string;
     elements: ({
         type: DocumentElementType.HEADING;
@@ -3336,7 +3362,6 @@ declare const documentTemplateSchema: z.ZodObject<{
         allowedFileTypes?: string[] | undefined;
         maxFileSizeMB?: number | undefined;
     })[];
-    createdAt: number;
     createdBy: string;
     version: number;
     description?: string | undefined;
@@ -3345,6 +3370,7 @@ declare const documentTemplateSchema: z.ZodObject<{
     id: string;
     isActive: boolean;
     updatedAt: number;
+    createdAt: number;
     title: string;
     elements: ({
         type: DocumentElementType.HEADING;
@@ -3424,7 +3450,6 @@ declare const documentTemplateSchema: z.ZodObject<{
         allowedFileTypes?: string[] | undefined;
         maxFileSizeMB?: number | undefined;
     })[];
-    createdAt: number;
     createdBy: string;
     version: number;
     description?: string | undefined;
@@ -3821,7 +3846,13 @@ declare class TechnologyService extends BaseService {
 }
 
 declare class BrandService extends BaseService {
-    private get brandsRef();
+    /**
+     * Gets reference to brands collection
+     */
+    private getBrandsRef;
+    /**
+     * Creates a new brand
+     */
     create(brand: Omit<Brand, "id" | "createdAt" | "updatedAt">): Promise<{
         isActive: boolean;
         updatedAt: Date;
@@ -3832,36 +3863,55 @@ declare class BrandService extends BaseService {
         website?: string | undefined;
         id: string;
     }>;
+    /**
+     * Gets all active brands
+     */
     getAll(): Promise<Brand[]>;
-    update(id: string, brand: Partial<Omit<Brand, "id" | "createdAt">>): Promise<Brand | null>;
-    delete(id: string): Promise<void>;
-    getById(id: string): Promise<Brand | null>;
+    /**
+     * Updates a brand
+     */
+    update(brandId: string, brand: Partial<Omit<Brand, "id" | "createdAt">>): Promise<Brand | null>;
+    /**
+     * Soft deletes a brand
+     */
+    delete(brandId: string): Promise<void>;
+    /**
+     * Gets a brand by ID
+     */
+    getById(brandId: string): Promise<Brand | null>;
 }
 
-declare class ProductService extends BaseService {
-    private getProductsRefByTechnology;
-    private getProductsRefByBrand;
-    create(categoryId: string, subcategoryId: string, technologyId: string, brandId: string, product: Omit<Product, "id" | "createdAt" | "updatedAt" | "brandId" | "technologyId">): Promise<{
-        isActive: boolean;
-        updatedAt: Date;
-        contraindications?: string[] | undefined;
-        name: string;
-        dosage?: string | undefined;
-        description?: string | undefined;
-        createdAt: Date;
-        technicalDetails?: string | undefined;
-        brandId: string;
-        technologyId: string;
-        warnings?: string[] | undefined;
-        composition?: string | undefined;
-        indications?: string[] | undefined;
-        id: string;
-    }>;
-    getAllByTechnology(categoryId: string, subcategoryId: string, technologyId: string): Promise<Product[]>;
+declare class ProductService extends BaseService implements IProductService {
+    /**
+     * Gets reference to products collection under a technology
+     * @param technologyId - ID of the technology
+     * @returns Firestore collection reference
+     */
+    private getProductsRef;
+    /**
+     * Creates a new product under technology
+     */
+    create(technologyId: string, brandId: string, product: Omit<Product, "id" | "createdAt" | "updatedAt" | "brandId" | "technologyId">): Promise<Product>;
+    /**
+     * Gets all products for a technology
+     */
+    getAllByTechnology(technologyId: string): Promise<Product[]>;
+    /**
+     * Gets all products for a brand by filtering through all technologies
+     */
     getAllByBrand(brandId: string): Promise<Product[]>;
-    update(categoryId: string, subcategoryId: string, technologyId: string, productId: string, product: Partial<Omit<Product, "id" | "createdAt" | "brandId" | "technologyId">>): Promise<Product | null>;
-    delete(categoryId: string, subcategoryId: string, technologyId: string, productId: string): Promise<void>;
-    getById(categoryId: string, subcategoryId: string, technologyId: string, productId: string): Promise<Product | null>;
+    /**
+     * Updates a product
+     */
+    update(technologyId: string, productId: string, product: Partial<Omit<Product, "id" | "createdAt" | "brandId" | "technologyId">>): Promise<Product | null>;
+    /**
+     * Soft deletes a product
+     */
+    delete(technologyId: string, productId: string): Promise<void>;
+    /**
+     * Gets a product by ID
+     */
+    getById(technologyId: string, productId: string): Promise<Product | null>;
 }
 
 /**