@blackcode_sa/metaestetics-api 1.13.5 → 1.13.6

package/src/backoffice/types/README.md

@@ -1,12 +1,12 @@
-# Backoffice Types
-
-This directory contains all the type definitions for the backoffice application.
-
-## Structure
-
-The types are organized into two main categories:
-
-- **Root-level types**: These are the primary types used across the application, such as `Brand`, `Category`, `Product`, etc.
-- **`static/`**: This subdirectory contains static types that are not expected to change often. See the `README.md` in that directory for more details.
-
-All types are exported from the `index.ts` file in this directory for easy importing.
+# Backoffice Types
+
+This directory contains all the type definitions for the backoffice application.
+
+## Structure
+
+The types are organized into two main categories:
+
+- **Root-level types**: These are the primary types used across the application, such as `Brand`, `Category`, `Product`, etc.
+- **`static/`**: This subdirectory contains static types that are not expected to change often. See the `README.md` in that directory for more details.
+
+All types are exported from the `index.ts` file in this directory for easy importing.

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

@@ -1,69 +1,69 @@
-/**
- * @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[];
-}
+/**
+ * @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[];
+}

package/src/backoffice/types/brand.types.ts

@@ -1,29 +1,29 @@
-/**
- * Brend proizvoda ili opreme
- * Predstavlja proizvođača ili dobavljača proizvoda i opreme koja se koristi u procedurama
- *
- * @property id - Jedinstveni identifikator brenda
- * @property name - Naziv brenda
- * @property manufacturer - Naziv proizvođača
- * @property description - Detaljan opis brenda i njegovih proizvoda
- * @property website - Web stranica brenda
- * @property isActive - Da li je brend aktivan u sistemu
- * @property createdAt - Datum kreiranja
- * @property updatedAt - Datum poslednjeg ažuriranja
- */
-export interface Brand {
-  id?: string;
-  name: string;
-  name_lowercase: string;
-  manufacturer: string;
-  createdAt: Date;
-  updatedAt: Date;
-  isActive: boolean;
-  website?: string;
-  description?: string;
-}
-
-/**
- * Kolekcija u Firestore bazi gde se čuvaju brendovi
- */
-export const BRANDS_COLLECTION = "brands";
+/**
+ * Brend proizvoda ili opreme
+ * Predstavlja proizvođača ili dobavljača proizvoda i opreme koja se koristi u procedurama
+ *
+ * @property id - Jedinstveni identifikator brenda
+ * @property name - Naziv brenda
+ * @property manufacturer - Naziv proizvođača
+ * @property description - Detaljan opis brenda i njegovih proizvoda
+ * @property website - Web stranica brenda
+ * @property isActive - Da li je brend aktivan u sistemu
+ * @property createdAt - Datum kreiranja
+ * @property updatedAt - Datum poslednjeg ažuriranja
+ */
+export interface Brand {
+  id?: string;
+  name: string;
+  name_lowercase: string;
+  manufacturer: string;
+  createdAt: Date;
+  updatedAt: Date;
+  isActive: boolean;
+  website?: string;
+  description?: string;
+}
+
+/**
+ * Kolekcija u Firestore bazi gde se čuvaju brendovi
+ */
+export const BRANDS_COLLECTION = "brands";

package/src/backoffice/types/category.types.ts

@@ -1,67 +1,67 @@
-import { ProcedureFamily } from './static/procedure-family.types';
-
-/**
- * Kategorija procedura
- * Kategorije su prvi nivo hijerarhije nakon procedure family
- * One grupišu slične podkategorije u okviru familije procedura
- *
- * @property id - Jedinstveni identifikator kategorije
- * @property name - Naziv kategorije
- * @property description - Detaljan opis kategorije i njene namene
- * @property family - Familija procedura kojoj kategorija pripada (aesthetics/surgery)
- * @property isActive - Da li je kategorija aktivna u sistemu
- * @property createdAt - Datum kreiranja
- * @property updatedAt - Datum poslednjeg ažuriranja
- */
-export interface Category {
-  /** Jedinstveni identifikator kategorije (automatski generisan od strane Firestore) */
-  id?: string;
-  /** Naziv kategorije */
-  name: string;
-  /** Detaljan opis kategorije i njene namene */
-  description: string;
-  /** Tip procedure kojoj kategorija pripada */
-  family: ProcedureFamily;
-  /** Datum kreiranja kategorije */
-  createdAt: Date;
-  /** Datum poslednjeg ažuriranja kategorije */
-  updatedAt: Date;
-  /** Flag koji označava da li je kategorija aktivna */
-  isActive: boolean;
-}
-
-/**
- * Kolekcija u Firestore bazi gde se čuvaju kategorije
- */
-export const CATEGORIES_COLLECTION = 'backoffice_categories';
-
-/**
- * Interface for the CategoryService class
- */
-export interface ICategoryService {
-  create(category: Omit<Category, 'id' | 'createdAt' | 'updatedAt'>): Promise<Category>;
-  getCategoryCounts(active?: boolean): Promise<Record<string, number>>;
-  getAllForFilter(): Promise<Category[]>;
-  getAllForFilterByFamily(family: ProcedureFamily): Promise<Category[]>;
-  getAll(options?: {
-    active?: boolean;
-    limit?: number;
-    lastVisible?: any;
-  }): Promise<{ categories: Category[]; lastVisible: any }>;
-  getAllByFamily(
-    family: ProcedureFamily,
-    options?: { active?: boolean; limit?: number; lastVisible?: any },
-  ): Promise<{ categories: Category[]; lastVisible: any }>;
-  update(
-    id: string,
-    category: Partial<Omit<Category, 'id' | 'createdAt'>>,
-  ): Promise<Category | null>;
-  delete(id: string): Promise<void>;
-  reactivate(id: string): Promise<void>;
-  getById(id: string): Promise<Category | null>;
-  findByNameAndFamily(name: string, family: ProcedureFamily): Promise<Category | null>;
-  exportToCsv(options?: {
-    includeInactive?: boolean;
-    includeBom?: boolean;
-  }): Promise<string>;
-}
+import { ProcedureFamily } from './static/procedure-family.types';
+
+/**
+ * Kategorija procedura
+ * Kategorije su prvi nivo hijerarhije nakon procedure family
+ * One grupišu slične podkategorije u okviru familije procedura
+ *
+ * @property id - Jedinstveni identifikator kategorije
+ * @property name - Naziv kategorije
+ * @property description - Detaljan opis kategorije i njene namene
+ * @property family - Familija procedura kojoj kategorija pripada (aesthetics/surgery)
+ * @property isActive - Da li je kategorija aktivna u sistemu
+ * @property createdAt - Datum kreiranja
+ * @property updatedAt - Datum poslednjeg ažuriranja
+ */
+export interface Category {
+  /** Jedinstveni identifikator kategorije (automatski generisan od strane Firestore) */
+  id?: string;
+  /** Naziv kategorije */
+  name: string;
+  /** Detaljan opis kategorije i njene namene */
+  description: string;
+  /** Tip procedure kojoj kategorija pripada */
+  family: ProcedureFamily;
+  /** Datum kreiranja kategorije */
+  createdAt: Date;
+  /** Datum poslednjeg ažuriranja kategorije */
+  updatedAt: Date;
+  /** Flag koji označava da li je kategorija aktivna */
+  isActive: boolean;
+}
+
+/**
+ * Kolekcija u Firestore bazi gde se čuvaju kategorije
+ */
+export const CATEGORIES_COLLECTION = 'backoffice_categories';
+
+/**
+ * Interface for the CategoryService class
+ */
+export interface ICategoryService {
+  create(category: Omit<Category, 'id' | 'createdAt' | 'updatedAt'>): Promise<Category>;
+  getCategoryCounts(active?: boolean): Promise<Record<string, number>>;
+  getAllForFilter(): Promise<Category[]>;
+  getAllForFilterByFamily(family: ProcedureFamily): Promise<Category[]>;
+  getAll(options?: {
+    active?: boolean;
+    limit?: number;
+    lastVisible?: any;
+  }): Promise<{ categories: Category[]; lastVisible: any }>;
+  getAllByFamily(
+    family: ProcedureFamily,
+    options?: { active?: boolean; limit?: number; lastVisible?: any },
+  ): Promise<{ categories: Category[]; lastVisible: any }>;
+  update(
+    id: string,
+    category: Partial<Omit<Category, 'id' | 'createdAt'>>,
+  ): Promise<Category | null>;
+  delete(id: string): Promise<void>;
+  reactivate(id: string): Promise<void>;
+  getById(id: string): Promise<Category | null>;
+  findByNameAndFamily(name: string, family: ProcedureFamily): Promise<Category | null>;
+  exportToCsv(options?: {
+    includeInactive?: boolean;
+    includeBom?: boolean;
+  }): Promise<string>;
+}

package/src/backoffice/types/documentation-templates.types.ts

@@ -1,28 +1,28 @@
-import {
-  DocumentTemplate,
-  CreateDocumentTemplateData,
-  UpdateDocumentTemplateData,
-  DocumentElement,
-  DocumentElementType,
-  HeadingLevel,
-  ListType,
-  DynamicVariable,
-  DOCUMENTATION_TEMPLATES_COLLECTION,
-  FILLED_DOCUMENTS_COLLECTION,
-} from "../../types/documentation-templates";
-
-/**
- * Re-export the documentation templates types for backoffice use
- */
-export {
-  DocumentTemplate,
-  CreateDocumentTemplateData,
-  UpdateDocumentTemplateData,
-  DocumentElement,
-  DocumentElementType,
-  HeadingLevel,
-  ListType,
-  DynamicVariable,
-};
-
-export { DOCUMENTATION_TEMPLATES_COLLECTION, FILLED_DOCUMENTS_COLLECTION };
+import {
+  DocumentTemplate,
+  CreateDocumentTemplateData,
+  UpdateDocumentTemplateData,
+  DocumentElement,
+  DocumentElementType,
+  HeadingLevel,
+  ListType,
+  DynamicVariable,
+  DOCUMENTATION_TEMPLATES_COLLECTION,
+  FILLED_DOCUMENTS_COLLECTION,
+} from "../../types/documentation-templates";
+
+/**
+ * Re-export the documentation templates types for backoffice use
+ */
+export {
+  DocumentTemplate,
+  CreateDocumentTemplateData,
+  UpdateDocumentTemplateData,
+  DocumentElement,
+  DocumentElementType,
+  HeadingLevel,
+  ListType,
+  DynamicVariable,
+};
+
+export { DOCUMENTATION_TEMPLATES_COLLECTION, FILLED_DOCUMENTS_COLLECTION };

package/src/backoffice/types/index.ts

@@ -1,10 +1,10 @@
-export * from "./admin-constants.types";
-export * from "./brand.types";
-export * from "./category.types";
-export * from "./documentation-templates.types";
-export * from "./product.types";
-export * from "./requirement.types";
-export * from "./subcategory.types";
-export * from "./technology.types";
-export * from "./static";
-export * from "./procedure-product.types";
+export * from "./admin-constants.types";
+export * from "./brand.types";
+export * from "./category.types";
+export * from "./documentation-templates.types";
+export * from "./product.types";
+export * from "./requirement.types";
+export * from "./subcategory.types";
+export * from "./technology.types";
+export * from "./static";
+export * from "./procedure-product.types";

package/src/backoffice/types/procedure-product.types.ts

@@ -1,38 +1,38 @@
-/**
- * @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
- */
-import { Product } from "./product.types";
-import { Currency, PricingMeasure } from "./static/pricing.types";
-
-/**
- * Represents a product associated with a procedure, including its specific pricing information.
- */
-export 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;
-
-  // Default product
-  isDefault?: boolean;
-}
+/**
+ * @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
+ */
+import { Product } from "./product.types";
+import { Currency, PricingMeasure } from "./static/pricing.types";
+
+/**
+ * Represents a product associated with a procedure, including its specific pricing information.
+ */
+export 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;
+
+  // Default product
+  isDefault?: boolean;
+}