@blackcode_sa/metaestetics-api 1.13.4 → 1.13.5

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

@@ -1,308 +1,308 @@
-/**
- * Types for the Medical Documentation Templating System
- */
-
-/**
- * Kolekcija u Firestore bazi gde se čuvaju dokumentacijske šablone
- */
-export const DOCUMENTATION_TEMPLATES_COLLECTION = "documentation-templates";
-export const FILLED_DOCUMENTS_COLLECTION = "filled-documents";
-export const USER_FORMS_SUBCOLLECTION = "user-forms";
-export const DOCTOR_FORMS_SUBCOLLECTION = "doctor-forms";
-/**
- * Enum for element types in documentation templates
- */
-export enum DocumentElementType {
-  // Static Elements
-  HEADING = "heading",
-  PARAGRAPH = "paragraph",
-  LIST = "list",
-
-  // Dynamic Elements
-  DYNAMIC_TEXT = "dynamic_text",
-
-  // Interactive Form Elements
-  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
- */
-export enum ListType {
-  ORDERED = "ordered",
-  UNORDERED = "unordered",
-}
-
-/**
- * Enum for heading levels
- */
-export enum HeadingLevel {
-  H1 = "h1",
-  H2 = "h2",
-  H3 = "h3",
-  H4 = "h4",
-  H5 = "h5",
-  H6 = "h6",
-}
-
-/**
- * Enum for dynamic variable placeholders
- */
-export enum DynamicVariable {
-  PATIENT_NAME = "$[PATIENT_NAME]",
-  DOCTOR_NAME = "$[DOCTOR_NAME]",
-  CLINIC_NAME = "$[CLINIC_NAME]",
-  PATIENT_BIRTHDAY = "$[PATIENT_BIRTHDAY]",
-  APPOINTMENT_DATE = "$[APPOINTMENT_DATE]",
-  CURRENT_DATE = "$[CURRENT_DATE]",
-  PROCEDURE_NAME = "$[PROCEDURE_NAME]",
-  PROCEDURE_DESCRIPTION = "$[PROCEDURE_DESCRIPTION]",
-  PROCEDURE_COST = "$[PROCEDURE_COST]",
-  PROCEDURE_DURATION = "$[PROCEDURE_DURATION]",
-  PROCEDURE_RISK = "$[PROCEDURE_RISK]",
-}
-
-/**
- * Base interface for all document elements
- */
-export interface BaseDocumentElement {
-  id: string;
-  type: DocumentElementType;
-  required?: boolean;
-}
-
-/**
- * Interface for heading element
- */
-export interface HeadingElement extends BaseDocumentElement {
-  type: DocumentElementType.HEADING;
-  text: string;
-  level: HeadingLevel;
-}
-
-/**
- * Interface for paragraph element
- */
-export interface ParagraphElement extends BaseDocumentElement {
-  type: DocumentElementType.PARAGRAPH;
-  text: string;
-}
-
-/**
- * Interface for list element
- */
-export interface ListElement extends BaseDocumentElement {
-  type: DocumentElementType.LIST;
-  items: string[];
-  listType: ListType;
-}
-
-/**
- * Interface for dynamic text element
- */
-export interface DynamicTextElement extends BaseDocumentElement {
-  type: DocumentElementType.DYNAMIC_TEXT;
-  text: string; // Text with placeholders like "I, [PATIENT_NAME], consent to..."
-}
-
-/**
- * Interface for binary choice element (Yes/No)
- */
-export interface BinaryChoiceElement extends BaseDocumentElement {
-  type: DocumentElementType.BINARY_CHOICE;
-  question: string;
-  defaultValue?: boolean;
-}
-
-/**
- * Interface for multiple choice element
- */
-export interface MultipleChoiceElement extends BaseDocumentElement {
-  type: DocumentElementType.MULTIPLE_CHOICE;
-  question: string;
-  options: string[];
-  defaultValues?: string[];
-}
-
-/**
- * Interface for single choice element
- */
-export interface SingleChoiceElement extends BaseDocumentElement {
-  type: DocumentElementType.SINGLE_CHOICE;
-  question: string;
-  options: string[];
-  defaultValue?: string;
-}
-
-/**
- * Interface for rating scale element
- */
-export interface RatingScaleElement extends BaseDocumentElement {
-  type: DocumentElementType.RATING_SCALE;
-  question: string;
-  min: number;
-  max: number;
-  labels?: { [key: number]: string }; // Optional labels for scale points
-  defaultValue?: number;
-}
-
-/**
- * Interface for text input element
- */
-export interface TextInputElement extends BaseDocumentElement {
-  type: DocumentElementType.TEXT_INPUT;
-  label: string;
-  placeholder?: string;
-  multiline?: boolean;
-  defaultValue?: string;
-}
-
-/**
- * Interface for date picker element
- */
-export interface DatePickerElement extends BaseDocumentElement {
-  type: DocumentElementType.DATE_PICKER;
-  label: string;
-  defaultValue?: string; // ISO date string
-}
-
-/**
- * Interface for signature element
- */
-export interface SignatureElement extends BaseDocumentElement {
-  type: DocumentElementType.SIGNATURE;
-  label: string;
-}
-
-/**
- * Interface for digital signature element
- */
-export interface DigitalSignatureElement extends BaseDocumentElement {
-  type: DocumentElementType.DITIGAL_SIGNATURE;
-  label: string;
-}
-
-/**
- * Interface for file upload element
- */
-export interface FileUploadElement extends BaseDocumentElement {
-  type: DocumentElementType.FILE_UPLOAD;
-  label: string;
-  allowedFileTypes?: string[]; // e.g., ['image/jpeg', 'application/pdf']
-  maxFileSizeMB?: number;
-}
-
-/**
- * Union type for all document elements
- */
-export type DocumentElement =
-  | HeadingElement
-  | ParagraphElement
-  | ListElement
-  | DynamicTextElement
-  | BinaryChoiceElement
-  | MultipleChoiceElement
-  | SingleChoiceElement
-  | RatingScaleElement
-  | TextInputElement
-  | DatePickerElement
-  | SignatureElement
-  | FileUploadElement;
-
-/**
- * Interface for document template
- */
-export interface DocumentTemplate {
-  id: string;
-  title: string;
-  description?: string;
-  createdAt: number; // Timestamp
-  updatedAt: number; // Timestamp
-  createdBy: string; // User ID
-  elements: DocumentElement[];
-  tags?: string[]; // For categorization
-  isUserForm?: boolean; // Default is false, and that means it's a doctor form
-  isRequired?: boolean; // Default is false, and that means it's an optional form, this is mostly used for user forms
-  sortingOrder?: number; // For sorting the forms in the UI, default is 0
-  version: number; // For versioning
-  isActive: boolean; // Whether the template is active
-}
-
-/**
- * Interface for creating a new document template
- */
-export interface CreateDocumentTemplateData {
-  title: string;
-  description?: string;
-  elements: Omit<DocumentElement, "id">[];
-  tags?: string[];
-  isUserForm?: boolean; // Default is false, and that means it's a doctor form
-  isRequired?: boolean; // Default is false, and that means it's an optional form, this is mostly used for user forms
-  sortingOrder?: number; // For sorting the forms in the UI, default is 0
-}
-
-/**
- * Interface for updating an existing document template
- */
-export interface UpdateDocumentTemplateData {
-  title?: string;
-  description?: string;
-  elements?: Omit<DocumentElement, "id">[];
-  tags?: string[];
-  isActive?: boolean;
-  isUserForm?: boolean; // Default is false, and that means it's a doctor form
-  isRequired?: boolean; // Default is false, and that means it's an optional form, this is mostly used for user forms
-  sortingOrder?: number; // For sorting the forms in the UI, default is 0
-}
-
-/**
- * Interface for a filled document (completed form)
- */
-export 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 }; // Values for each element
-  status: FilledDocumentStatus;
-}
-
-/**
- * Enum for filled document status
- */
-export 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", // Only used for user forms
-}
-
-/**
- * Interface for file upload results to be stored in filled document values
- */
-export interface FilledDocumentFileValue {
-  mediaId: string;
-  url: string;
-  name: string;
-  contentType: string;
-  size: number;
-  uploadedAt: number;
-}
+/**
+ * Types for the Medical Documentation Templating System
+ */
+
+/**
+ * Kolekcija u Firestore bazi gde se čuvaju dokumentacijske šablone
+ */
+export const DOCUMENTATION_TEMPLATES_COLLECTION = "documentation-templates";
+export const FILLED_DOCUMENTS_COLLECTION = "filled-documents";
+export const USER_FORMS_SUBCOLLECTION = "user-forms";
+export const DOCTOR_FORMS_SUBCOLLECTION = "doctor-forms";
+/**
+ * Enum for element types in documentation templates
+ */
+export enum DocumentElementType {
+  // Static Elements
+  HEADING = "heading",
+  PARAGRAPH = "paragraph",
+  LIST = "list",
+
+  // Dynamic Elements
+  DYNAMIC_TEXT = "dynamic_text",
+
+  // Interactive Form Elements
+  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
+ */
+export enum ListType {
+  ORDERED = "ordered",
+  UNORDERED = "unordered",
+}
+
+/**
+ * Enum for heading levels
+ */
+export enum HeadingLevel {
+  H1 = "h1",
+  H2 = "h2",
+  H3 = "h3",
+  H4 = "h4",
+  H5 = "h5",
+  H6 = "h6",
+}
+
+/**
+ * Enum for dynamic variable placeholders
+ */
+export enum DynamicVariable {
+  PATIENT_NAME = "$[PATIENT_NAME]",
+  DOCTOR_NAME = "$[DOCTOR_NAME]",
+  CLINIC_NAME = "$[CLINIC_NAME]",
+  PATIENT_BIRTHDAY = "$[PATIENT_BIRTHDAY]",
+  APPOINTMENT_DATE = "$[APPOINTMENT_DATE]",
+  CURRENT_DATE = "$[CURRENT_DATE]",
+  PROCEDURE_NAME = "$[PROCEDURE_NAME]",
+  PROCEDURE_DESCRIPTION = "$[PROCEDURE_DESCRIPTION]",
+  PROCEDURE_COST = "$[PROCEDURE_COST]",
+  PROCEDURE_DURATION = "$[PROCEDURE_DURATION]",
+  PROCEDURE_RISK = "$[PROCEDURE_RISK]",
+}
+
+/**
+ * Base interface for all document elements
+ */
+export interface BaseDocumentElement {
+  id: string;
+  type: DocumentElementType;
+  required?: boolean;
+}
+
+/**
+ * Interface for heading element
+ */
+export interface HeadingElement extends BaseDocumentElement {
+  type: DocumentElementType.HEADING;
+  text: string;
+  level: HeadingLevel;
+}
+
+/**
+ * Interface for paragraph element
+ */
+export interface ParagraphElement extends BaseDocumentElement {
+  type: DocumentElementType.PARAGRAPH;
+  text: string;
+}
+
+/**
+ * Interface for list element
+ */
+export interface ListElement extends BaseDocumentElement {
+  type: DocumentElementType.LIST;
+  items: string[];
+  listType: ListType;
+}
+
+/**
+ * Interface for dynamic text element
+ */
+export interface DynamicTextElement extends BaseDocumentElement {
+  type: DocumentElementType.DYNAMIC_TEXT;
+  text: string; // Text with placeholders like "I, [PATIENT_NAME], consent to..."
+}
+
+/**
+ * Interface for binary choice element (Yes/No)
+ */
+export interface BinaryChoiceElement extends BaseDocumentElement {
+  type: DocumentElementType.BINARY_CHOICE;
+  question: string;
+  defaultValue?: boolean;
+}
+
+/**
+ * Interface for multiple choice element
+ */
+export interface MultipleChoiceElement extends BaseDocumentElement {
+  type: DocumentElementType.MULTIPLE_CHOICE;
+  question: string;
+  options: string[];
+  defaultValues?: string[];
+}
+
+/**
+ * Interface for single choice element
+ */
+export interface SingleChoiceElement extends BaseDocumentElement {
+  type: DocumentElementType.SINGLE_CHOICE;
+  question: string;
+  options: string[];
+  defaultValue?: string;
+}
+
+/**
+ * Interface for rating scale element
+ */
+export interface RatingScaleElement extends BaseDocumentElement {
+  type: DocumentElementType.RATING_SCALE;
+  question: string;
+  min: number;
+  max: number;
+  labels?: { [key: number]: string }; // Optional labels for scale points
+  defaultValue?: number;
+}
+
+/**
+ * Interface for text input element
+ */
+export interface TextInputElement extends BaseDocumentElement {
+  type: DocumentElementType.TEXT_INPUT;
+  label: string;
+  placeholder?: string;
+  multiline?: boolean;
+  defaultValue?: string;
+}
+
+/**
+ * Interface for date picker element
+ */
+export interface DatePickerElement extends BaseDocumentElement {
+  type: DocumentElementType.DATE_PICKER;
+  label: string;
+  defaultValue?: string; // ISO date string
+}
+
+/**
+ * Interface for signature element
+ */
+export interface SignatureElement extends BaseDocumentElement {
+  type: DocumentElementType.SIGNATURE;
+  label: string;
+}
+
+/**
+ * Interface for digital signature element
+ */
+export interface DigitalSignatureElement extends BaseDocumentElement {
+  type: DocumentElementType.DITIGAL_SIGNATURE;
+  label: string;
+}
+
+/**
+ * Interface for file upload element
+ */
+export interface FileUploadElement extends BaseDocumentElement {
+  type: DocumentElementType.FILE_UPLOAD;
+  label: string;
+  allowedFileTypes?: string[]; // e.g., ['image/jpeg', 'application/pdf']
+  maxFileSizeMB?: number;
+}
+
+/**
+ * Union type for all document elements
+ */
+export type DocumentElement =
+  | HeadingElement
+  | ParagraphElement
+  | ListElement
+  | DynamicTextElement
+  | BinaryChoiceElement
+  | MultipleChoiceElement
+  | SingleChoiceElement
+  | RatingScaleElement
+  | TextInputElement
+  | DatePickerElement
+  | SignatureElement
+  | FileUploadElement;
+
+/**
+ * Interface for document template
+ */
+export interface DocumentTemplate {
+  id: string;
+  title: string;
+  description?: string;
+  createdAt: number; // Timestamp
+  updatedAt: number; // Timestamp
+  createdBy: string; // User ID
+  elements: DocumentElement[];
+  tags?: string[]; // For categorization
+  isUserForm?: boolean; // Default is false, and that means it's a doctor form
+  isRequired?: boolean; // Default is false, and that means it's an optional form, this is mostly used for user forms
+  sortingOrder?: number; // For sorting the forms in the UI, default is 0
+  version: number; // For versioning
+  isActive: boolean; // Whether the template is active
+}
+
+/**
+ * Interface for creating a new document template
+ */
+export interface CreateDocumentTemplateData {
+  title: string;
+  description?: string;
+  elements: Omit<DocumentElement, "id">[];
+  tags?: string[];
+  isUserForm?: boolean; // Default is false, and that means it's a doctor form
+  isRequired?: boolean; // Default is false, and that means it's an optional form, this is mostly used for user forms
+  sortingOrder?: number; // For sorting the forms in the UI, default is 0
+}
+
+/**
+ * Interface for updating an existing document template
+ */
+export interface UpdateDocumentTemplateData {
+  title?: string;
+  description?: string;
+  elements?: Omit<DocumentElement, "id">[];
+  tags?: string[];
+  isActive?: boolean;
+  isUserForm?: boolean; // Default is false, and that means it's a doctor form
+  isRequired?: boolean; // Default is false, and that means it's an optional form, this is mostly used for user forms
+  sortingOrder?: number; // For sorting the forms in the UI, default is 0
+}
+
+/**
+ * Interface for a filled document (completed form)
+ */
+export 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 }; // Values for each element
+  status: FilledDocumentStatus;
+}
+
+/**
+ * Enum for filled document status
+ */
+export 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", // Only used for user forms
+}
+
+/**
+ * Interface for file upload results to be stored in filled document values
+ */
+export interface FilledDocumentFileValue {
+  mediaId: string;
+  url: string;
+  name: string;
+  contentType: string;
+  size: number;
+  uploadedAt: number;
+}