@blackcode_sa/metaestetics-api 1.15.16 → 1.15.17-staging.0

package/src/types/resource/index.ts

@@ -0,0 +1,199 @@
+import { Timestamp, FieldValue } from "firebase/firestore";
+import type { CalendarEventTime, CalendarEventStatus } from "../calendar";
+import { CalendarEventType } from "../calendar";
+
+/**
+ * Firestore collection/subcollection names for the resource system
+ */
+export const RESOURCES_COLLECTION = "resources";
+export const RESOURCE_INSTANCES_SUBCOLLECTION = "instances";
+export const RESOURCE_CALENDAR_SUBCOLLECTION = "calendar";
+
+/**
+ * Category of a clinic resource
+ */
+export enum ResourceCategory {
+  MEDICAL_DEVICE = "medical_device",
+  ROOM = "room",
+  SURGERY_SUITE = "surgery_suite",
+  EQUIPMENT = "equipment",
+  OTHER = "other",
+}
+
+/**
+ * Status of a resource or resource instance
+ */
+export enum ResourceStatus {
+  ACTIVE = "active",
+  INACTIVE = "inactive",
+  MAINTENANCE = "maintenance",
+}
+
+/**
+ * A resource definition owned by a clinic branch.
+ * Stored at: clinics/{clinicId}/resources/{resourceId}
+ */
+export interface Resource {
+  /** Unique identifier */
+  id: string;
+  /** Clinic branch this resource belongs to */
+  clinicBranchId: string;
+  /** Display name of the resource */
+  name: string;
+  /** Lowercase name for case-insensitive search */
+  nameLower: string;
+  /** Category of the resource */
+  category: ResourceCategory;
+  /** Optional description */
+  description?: string;
+  /** Number of physical instances (e.g., 3 surgery rooms) */
+  quantity: number;
+  /** Current status */
+  status: ResourceStatus;
+  /** IDs of procedures that require this resource (denormalized for quick lookup) */
+  linkedProcedureIds: string[];
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+}
+
+/**
+ * A single physical instance of a resource (e.g., "Surgery Room #2").
+ * Each instance has its own calendar for tracking bookings.
+ * Stored at: clinics/{clinicId}/resources/{resourceId}/instances/{instanceId}
+ */
+export interface ResourceInstance {
+  /** Unique identifier */
+  id: string;
+  /** Parent resource ID */
+  resourceId: string;
+  /** Clinic branch this instance belongs to */
+  clinicBranchId: string;
+  /** Display label, auto-generated: "{Resource.name} #{index}" */
+  label: string;
+  /** 1-based index among instances of the same resource */
+  index: number;
+  /** Current status */
+  status: ResourceStatus;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+}
+
+/**
+ * Calendar event on a resource instance.
+ * Can be either a booking event (created during appointment creation) or a blocking event (created manually by admin).
+ * Stored at: clinics/{clinicId}/resources/{resourceId}/instances/{instanceId}/calendar/{eventId}
+ */
+export interface ResourceCalendarEvent {
+  /** Unique identifier */
+  id: string;
+  /** Parent resource ID */
+  resourceId: string;
+  /** Instance this event is on */
+  resourceInstanceId: string;
+  /** Clinic branch */
+  clinicBranchId: string;
+  /** Type of event — RESOURCE_BOOKING for appointment bookings, BLOCKING for manual blocks */
+  eventType: CalendarEventType;
+  /** Appointment that booked this resource (only for RESOURCE_BOOKING events) */
+  appointmentId?: string;
+  /** Procedure requiring this resource (only for RESOURCE_BOOKING events) */
+  procedureId?: string;
+  /** Practitioner performing the procedure (only for RESOURCE_BOOKING events) */
+  practitionerId?: string;
+  /** Patient for the appointment (only for RESOURCE_BOOKING events) */
+  patientId?: string;
+  /** Time range of the event */
+  eventTime: CalendarEventTime;
+  /** Event status — CONFIRMED for blocking events, mirrors appointment status for bookings */
+  status: CalendarEventStatus;
+  /** Display name for the event */
+  eventName: string;
+  /** Optional description (primarily for blocking events, e.g., reason for maintenance) */
+  description?: string;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+}
+
+/**
+ * Lightweight reference stored on procedures to indicate which resources are required.
+ * Denormalized snapshot of resource info at the time of linking.
+ */
+export interface ResourceRequirement {
+  /** ID of the required resource */
+  resourceId: string;
+  /** Name of the resource (snapshot) */
+  resourceName: string;
+  /** Category of the resource (snapshot) */
+  resourceCategory: ResourceCategory;
+}
+
+/**
+ * Info about a specific resource instance booking, stored on the appointment
+ * after a resource has been allocated during appointment creation.
+ */
+export interface ResourceBookingInfo {
+  /** ID of the booked resource */
+  resourceId: string;
+  /** Name of the resource (snapshot) */
+  resourceName: string;
+  /** ID of the specific instance that was allocated */
+  resourceInstanceId: string;
+  /** Label of the instance (e.g., "Surgery Room #2") */
+  resourceInstanceLabel: string;
+  /** ID of the calendar event created on the instance */
+  calendarEventId: string;
+}
+
+/**
+ * Data required to create a new resource
+ */
+export interface CreateResourceData {
+  clinicBranchId: string;
+  name: string;
+  category: ResourceCategory;
+  description?: string;
+  quantity: number;
+}
+
+/**
+ * Data allowed for updating an existing resource
+ */
+export interface UpdateResourceData {
+  name?: string;
+  category?: ResourceCategory;
+  description?: string;
+  /** Changing quantity: increase creates new instances, decrease is blocked if instances have future bookings */
+  quantity?: number;
+  status?: ResourceStatus;
+}
+
+/**
+ * Parameters for creating a blocking event on a resource instance.
+ * Used to mark an instance as unavailable for a time period (maintenance, out of order, etc.).
+ */
+export interface CreateResourceBlockingEventParams {
+  clinicBranchId: string;
+  resourceId: string;
+  resourceInstanceId: string;
+  /** Display name for the blocking event (e.g., "Maintenance", "Out of Order") */
+  eventName: string;
+  /** Time range during which the instance is blocked */
+  eventTime: CalendarEventTime;
+  /** Optional reason/description for the block */
+  description?: string;
+}
+
+/**
+ * Parameters for updating an existing blocking event on a resource instance.
+ * Only provided fields are updated.
+ */
+export interface UpdateResourceBlockingEventParams {
+  clinicBranchId: string;
+  resourceId: string;
+  resourceInstanceId: string;
+  /** ID of the blocking event to update */
+  eventId: string;
+  eventName?: string;
+  eventTime?: CalendarEventTime;
+  description?: string;
+}

package/src/types/reviews/index.ts

@@ -1,132 +1,132 @@
-/**
- * Review system type definitions
- */
-
-/**
- * Base review interface with common properties
- */
-interface BaseReview {
-  id: string;
-  fullReviewId: string;
-  patientId: string;
-  createdAt: Date;
-  updatedAt: Date;
-  comment: string;
-  isVerified: boolean;
-  isPublished: boolean;
-}
-
-/**
- * Clinic review interface
- * @description Full review for a clinic
- */
-export interface ClinicReview extends BaseReview {
-  clinicId: string;
-  clinicName?: string; // Enhanced field: clinic name from appointment
-  cleanliness: number; // 1-5 stars
-  facilities: number; // 1-5 stars
-  staffFriendliness: number; // 1-5 stars
-  waitingTime: number; // 1-5 stars
-  accessibility: number; // 1-5 stars
-  overallRating: number; // Average of all ratings
-  wouldRecommend: boolean;
-}
-
-/**
- * Practitioner review interface
- * @description Full review for a healthcare practitioner
- */
-export interface PractitionerReview extends BaseReview {
-  practitionerId: string;
-  practitionerName?: string; // Enhanced field: practitioner name from appointment
-  knowledgeAndExpertise: number; // 1-5 stars
-  communicationSkills: number; // 1-5 stars
-  bedSideManner: number; // 1-5 stars
-  thoroughness: number; // 1-5 stars
-  trustworthiness: number; // 1-5 stars
-  overallRating: number; // Average of all ratings
-  wouldRecommend: boolean;
-}
-
-/**
- * Procedure review interface
- * @description Full review for a medical procedure
- * Used for both main and extended procedures
- */
-export interface ProcedureReview extends BaseReview {
-  procedureId: string;
-  procedureName?: string; // Enhanced field: procedure name from appointment
-  effectivenessOfTreatment: number; // 1-5 stars
-  outcomeExplanation: number; // 1-5 stars
-  painManagement: number; // 1-5 stars
-  followUpCare: number; // 1-5 stars
-  valueForMoney: number; // 1-5 stars
-  overallRating: number; // Average of all ratings
-  wouldRecommend: boolean;
-}
-
-/**
- * Condensed clinic review information
- * @description Used for aggregated data attached to clinic documents
- */
-export interface ClinicReviewInfo {
-  totalReviews: number;
-  averageRating: number;
-  cleanliness: number;
-  facilities: number;
-  staffFriendliness: number;
-  waitingTime: number;
-  accessibility: number;
-  recommendationPercentage: number;
-}
-
-/**
- * Condensed practitioner review information
- * @description Used for aggregated data attached to practitioner documents
- */
-export interface PractitionerReviewInfo {
-  totalReviews: number;
-  averageRating: number;
-  knowledgeAndExpertise: number;
-  communicationSkills: number;
-  bedSideManner: number;
-  thoroughness: number;
-  trustworthiness: number;
-  recommendationPercentage: number;
-}
-
-/**
- * Condensed procedure review information
- * @description Used for aggregated data attached to procedure documents
- */
-export interface ProcedureReviewInfo {
-  totalReviews: number;
-  averageRating: number;
-  effectivenessOfTreatment: number;
-  outcomeExplanation: number;
-  painManagement: number;
-  followUpCare: number;
-  valueForMoney: number;
-  recommendationPercentage: number;
-}
-
-/**
- * Crown review object
- * @description Combined review data for clinic, practitioner, and procedure
- */
-export interface Review {
-  id: string;
-  appointmentId: string;
-  patientId: string;
-  patientName?: string; // Enhanced field: patient name from appointment
-  createdAt: Date;
-  updatedAt: Date;
-  clinicReview?: ClinicReview;
-  practitionerReview?: PractitionerReview;
-  procedureReview?: ProcedureReview; // Review for the main/default procedure
-  extendedProcedureReviews?: ProcedureReview[]; // Reviews for extended procedures (same structure as main)
-  overallComment: string;
-  overallRating: number; // Average of all available ratings
-}
-
-export const REVIEWS_COLLECTION = 'reviews';
+/**
+ * Review system type definitions
+ */
+
+/**
+ * Base review interface with common properties
+ */
+interface BaseReview {
+  id: string;
+  fullReviewId: string;
+  patientId: string;
+  createdAt: Date;
+  updatedAt: Date;
+  comment: string;
+  isVerified: boolean;
+  isPublished: boolean;
+}
+
+/**
+ * Clinic review interface
+ * @description Full review for a clinic
+ */
+export interface ClinicReview extends BaseReview {
+  clinicId: string;
+  clinicName?: string; // Enhanced field: clinic name from appointment
+  cleanliness: number; // 1-5 stars
+  facilities: number; // 1-5 stars
+  staffFriendliness: number; // 1-5 stars
+  waitingTime: number; // 1-5 stars
+  accessibility: number; // 1-5 stars
+  overallRating: number; // Average of all ratings
+  wouldRecommend: boolean;
+}
+
+/**
+ * Practitioner review interface
+ * @description Full review for a healthcare practitioner
+ */
+export interface PractitionerReview extends BaseReview {
+  practitionerId: string;
+  practitionerName?: string; // Enhanced field: practitioner name from appointment
+  knowledgeAndExpertise: number; // 1-5 stars
+  communicationSkills: number; // 1-5 stars
+  bedSideManner: number; // 1-5 stars
+  thoroughness: number; // 1-5 stars
+  trustworthiness: number; // 1-5 stars
+  overallRating: number; // Average of all ratings
+  wouldRecommend: boolean;
+}
+
+/**
+ * Procedure review interface
+ * @description Full review for a medical procedure
+ * Used for both main and extended procedures
+ */
+export interface ProcedureReview extends BaseReview {
+  procedureId: string;
+  procedureName?: string; // Enhanced field: procedure name from appointment
+  effectivenessOfTreatment: number; // 1-5 stars
+  outcomeExplanation: number; // 1-5 stars
+  painManagement: number; // 1-5 stars
+  followUpCare: number; // 1-5 stars
+  valueForMoney: number; // 1-5 stars
+  overallRating: number; // Average of all ratings
+  wouldRecommend: boolean;
+}
+
+/**
+ * Condensed clinic review information
+ * @description Used for aggregated data attached to clinic documents
+ */
+export interface ClinicReviewInfo {
+  totalReviews: number;
+  averageRating: number;
+  cleanliness: number;
+  facilities: number;
+  staffFriendliness: number;
+  waitingTime: number;
+  accessibility: number;
+  recommendationPercentage: number;
+}
+
+/**
+ * Condensed practitioner review information
+ * @description Used for aggregated data attached to practitioner documents
+ */
+export interface PractitionerReviewInfo {
+  totalReviews: number;
+  averageRating: number;
+  knowledgeAndExpertise: number;
+  communicationSkills: number;
+  bedSideManner: number;
+  thoroughness: number;
+  trustworthiness: number;
+  recommendationPercentage: number;
+}
+
+/**
+ * Condensed procedure review information
+ * @description Used for aggregated data attached to procedure documents
+ */
+export interface ProcedureReviewInfo {
+  totalReviews: number;
+  averageRating: number;
+  effectivenessOfTreatment: number;
+  outcomeExplanation: number;
+  painManagement: number;
+  followUpCare: number;
+  valueForMoney: number;
+  recommendationPercentage: number;
+}
+
+/**
+ * Crown review object
+ * @description Combined review data for clinic, practitioner, and procedure
+ */
+export interface Review {
+  id: string;
+  appointmentId: string;
+  patientId: string;
+  patientName?: string; // Enhanced field: patient name from appointment
+  createdAt: Date;
+  updatedAt: Date;
+  clinicReview?: ClinicReview;
+  practitionerReview?: PractitionerReview;
+  procedureReview?: ProcedureReview; // Review for the main/default procedure
+  extendedProcedureReviews?: ProcedureReview[]; // Reviews for extended procedures (same structure as main)
+  overallComment: string;
+  overallRating: number; // Average of all available ratings
+}
+
+export const REVIEWS_COLLECTION = 'reviews';

package/src/types/tz-lookup.d.ts

@@ -1,4 +1,4 @@
-declare module 'tz-lookup' {
-  function tzlookup(lat: number, lng: number): string;
-  export default tzlookup;
-}
+declare module 'tz-lookup' {
+  function tzlookup(lat: number, lng: number): string;
+  export default tzlookup;
+}

package/src/types/user/index.ts

@@ -1,60 +1,60 @@
-import { User as FirebaseAuthUser } from "firebase/auth";
-import { Timestamp, FieldValue } from "firebase/firestore";
-
-// User tipovi
-export enum UserRole {
-  PATIENT = "patient",
-  PRACTITIONER = "practitioner",
-  APP_ADMIN = "app_admin",
-  CLINIC_ADMIN = "clinic_admin",
-}
-
-/**
- * Enum for acquisition source - how the user found out about the app
- */
-export enum AcquisitionSource {
-  FRIEND_FAMILY = "friend_family",
-  ONLINE_SEARCH = "online_search",
-  SOCIAL_MEDIA_AD = "social_media_ad",
-  TRADITIONAL_AD = "traditional_ad",
-  BLOG_ARTICLE = "blog_article",
-  HEALTHCARE_PROVIDER = "healthcare_provider",
-  OTHER = "other",
-}
-
-export interface User {
-  uid: string;
-  email: string | null;
-  roles: UserRole[];
-  isAnonymous: boolean;
-  createdAt: any;
-  updatedAt: any;
-  lastLoginAt: any;
-  patientProfile?: string;
-  practitionerProfile?: string;
-  adminProfile?: string;
-  /** How the user found out about the app (marketing attribution) */
-  acquisitionSource?: AcquisitionSource | null;
-  /** Custom text when acquisitionSource is 'other' */
-  acquisitionSourceOther?: string | null;
-  /** Timestamp when acquisition source was collected */
-  acquisitionSourceTimestamp?: Timestamp | null;
-}
-
-export interface CreateUserData {
-  uid: string;
-  email: string | null;
-  roles: UserRole[];
-  isAnonymous: boolean;
-  createdAt: FieldValue;
-  updatedAt: FieldValue;
-  lastLoginAt: FieldValue;
-  acquisitionSource?: AcquisitionSource | null;
-  acquisitionSourceOther?: string | null;
-  acquisitionSourceTimestamp?: FieldValue | Timestamp | null;
-}
-
-export const USERS_COLLECTION = "users";
-
-// Firebase tipovi
-export type FirebaseUser = FirebaseAuthUser;
+import { User as FirebaseAuthUser } from "firebase/auth";
+import { Timestamp, FieldValue } from "firebase/firestore";
+
+// User tipovi
+export enum UserRole {
+  PATIENT = "patient",
+  PRACTITIONER = "practitioner",
+  APP_ADMIN = "app_admin",
+  CLINIC_ADMIN = "clinic_admin",
+}
+
+/**
+ * Enum for acquisition source - how the user found out about the app
+ */
+export enum AcquisitionSource {
+  FRIEND_FAMILY = "friend_family",
+  ONLINE_SEARCH = "online_search",
+  SOCIAL_MEDIA_AD = "social_media_ad",
+  TRADITIONAL_AD = "traditional_ad",
+  BLOG_ARTICLE = "blog_article",
+  HEALTHCARE_PROVIDER = "healthcare_provider",
+  OTHER = "other",
+}
+
+export interface User {
+  uid: string;
+  email: string | null;
+  roles: UserRole[];
+  isAnonymous: boolean;
+  createdAt: any;
+  updatedAt: any;
+  lastLoginAt: any;
+  patientProfile?: string;
+  practitionerProfile?: string;
+  adminProfile?: string;
+  /** How the user found out about the app (marketing attribution) */
+  acquisitionSource?: AcquisitionSource | null;
+  /** Custom text when acquisitionSource is 'other' */
+  acquisitionSourceOther?: string | null;
+  /** Timestamp when acquisition source was collected */
+  acquisitionSourceTimestamp?: Timestamp | null;
+}
+
+export interface CreateUserData {
+  uid: string;
+  email: string | null;
+  roles: UserRole[];
+  isAnonymous: boolean;
+  createdAt: FieldValue;
+  updatedAt: FieldValue;
+  lastLoginAt: FieldValue;
+  acquisitionSource?: AcquisitionSource | null;
+  acquisitionSourceOther?: string | null;
+  acquisitionSourceTimestamp?: FieldValue | Timestamp | null;
+}
+
+export const USERS_COLLECTION = "users";
+
+// Firebase tipovi
+export type FirebaseUser = FirebaseAuthUser;