@blackcode_sa/metaestetics-api 1.13.4 → 1.13.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/dist/admin/index.d.mts +15 -28
  2. package/dist/admin/index.d.ts +15 -28
  3. package/dist/index.d.mts +16 -29
  4. package/dist/index.d.ts +16 -29
  5. package/dist/index.js +1 -0
  6. package/dist/index.mjs +1 -0
  7. package/package.json +121 -119
  8. package/src/__mocks__/firstore.ts +10 -10
  9. package/src/admin/aggregation/README.md +79 -79
  10. package/src/admin/aggregation/appointment/README.md +128 -128
  11. package/src/admin/aggregation/appointment/appointment.aggregation.service.ts +1984 -1984
  12. package/src/admin/aggregation/appointment/index.ts +1 -1
  13. package/src/admin/aggregation/clinic/README.md +52 -52
  14. package/src/admin/aggregation/clinic/clinic.aggregation.service.ts +703 -703
  15. package/src/admin/aggregation/clinic/index.ts +1 -1
  16. package/src/admin/aggregation/forms/README.md +13 -13
  17. package/src/admin/aggregation/forms/filled-forms.aggregation.service.ts +322 -322
  18. package/src/admin/aggregation/forms/index.ts +1 -1
  19. package/src/admin/aggregation/index.ts +8 -8
  20. package/src/admin/aggregation/patient/README.md +27 -27
  21. package/src/admin/aggregation/patient/index.ts +1 -1
  22. package/src/admin/aggregation/patient/patient.aggregation.service.ts +141 -141
  23. package/src/admin/aggregation/practitioner/README.md +42 -42
  24. package/src/admin/aggregation/practitioner/index.ts +1 -1
  25. package/src/admin/aggregation/practitioner/practitioner.aggregation.service.ts +433 -433
  26. package/src/admin/aggregation/practitioner-invite/index.ts +1 -1
  27. package/src/admin/aggregation/practitioner-invite/practitioner-invite.aggregation.service.ts +961 -961
  28. package/src/admin/aggregation/procedure/README.md +43 -43
  29. package/src/admin/aggregation/procedure/index.ts +1 -1
  30. package/src/admin/aggregation/procedure/procedure.aggregation.service.ts +702 -702
  31. package/src/admin/aggregation/reviews/index.ts +1 -1
  32. package/src/admin/aggregation/reviews/reviews.aggregation.service.ts +689 -689
  33. package/src/admin/analytics/analytics.admin.service.ts +278 -278
  34. package/src/admin/analytics/index.ts +2 -2
  35. package/src/admin/booking/README.md +125 -125
  36. package/src/admin/booking/booking.admin.ts +1037 -1037
  37. package/src/admin/booking/booking.calculator.ts +712 -712
  38. package/src/admin/booking/booking.types.ts +59 -59
  39. package/src/admin/booking/index.ts +3 -3
  40. package/src/admin/booking/timezones-problem.md +185 -185
  41. package/src/admin/calendar/README.md +7 -7
  42. package/src/admin/calendar/calendar.admin.service.ts +345 -345
  43. package/src/admin/calendar/index.ts +1 -1
  44. package/src/admin/documentation-templates/document-manager.admin.ts +260 -260
  45. package/src/admin/documentation-templates/index.ts +1 -1
  46. package/src/admin/free-consultation/free-consultation-utils.admin.ts +148 -148
  47. package/src/admin/free-consultation/index.ts +1 -1
  48. package/src/admin/index.ts +81 -81
  49. package/src/admin/logger/index.ts +78 -78
  50. package/src/admin/mailing/README.md +95 -95
  51. package/src/admin/mailing/appointment/appointment.mailing.service.ts +732 -732
  52. package/src/admin/mailing/appointment/index.ts +1 -1
  53. package/src/admin/mailing/appointment/templates/patient/appointment-confirmed.html +40 -40
  54. package/src/admin/mailing/base.mailing.service.ts +208 -208
  55. package/src/admin/mailing/index.ts +3 -3
  56. package/src/admin/mailing/practitionerInvite/existing-practitioner-invite.mailing.ts +611 -611
  57. package/src/admin/mailing/practitionerInvite/index.ts +2 -2
  58. package/src/admin/mailing/practitionerInvite/practitionerInvite.mailing.ts +395 -395
  59. package/src/admin/mailing/practitionerInvite/templates/existing-practitioner-invitation.template.ts +155 -155
  60. package/src/admin/mailing/practitionerInvite/templates/invitation.template.ts +101 -101
  61. package/src/admin/mailing/practitionerInvite/templates/invite-accepted-notification.template.ts +228 -228
  62. package/src/admin/mailing/practitionerInvite/templates/invite-rejected-notification.template.ts +242 -242
  63. package/src/admin/notifications/index.ts +1 -1
  64. package/src/admin/notifications/notifications.admin.ts +710 -710
  65. package/src/admin/requirements/README.md +128 -128
  66. package/src/admin/requirements/index.ts +1 -1
  67. package/src/admin/requirements/patient-requirements.admin.service.ts +475 -475
  68. package/src/admin/users/index.ts +1 -1
  69. package/src/admin/users/user-profile.admin.ts +405 -405
  70. package/src/backoffice/constants/certification.constants.ts +13 -13
  71. package/src/backoffice/constants/index.ts +1 -1
  72. package/src/backoffice/errors/backoffice.errors.ts +181 -181
  73. package/src/backoffice/errors/index.ts +1 -1
  74. package/src/backoffice/expo-safe/README.md +26 -26
  75. package/src/backoffice/expo-safe/index.ts +41 -41
  76. package/src/backoffice/index.ts +5 -5
  77. package/src/backoffice/services/FIXES_README.md +102 -102
  78. package/src/backoffice/services/README.md +57 -57
  79. package/src/backoffice/services/analytics.service.proposal.md +863 -863
  80. package/src/backoffice/services/analytics.service.summary.md +143 -143
  81. package/src/backoffice/services/brand.service.ts +256 -256
  82. package/src/backoffice/services/category.service.ts +384 -384
  83. package/src/backoffice/services/constants.service.ts +385 -385
  84. package/src/backoffice/services/documentation-template.service.ts +202 -202
  85. package/src/backoffice/services/index.ts +10 -10
  86. package/src/backoffice/services/migrate-products.ts +116 -116
  87. package/src/backoffice/services/product.service.ts +553 -553
  88. package/src/backoffice/services/requirement.service.ts +235 -235
  89. package/src/backoffice/services/subcategory.service.ts +461 -461
  90. package/src/backoffice/services/technology.service.ts +1151 -1151
  91. package/src/backoffice/types/README.md +12 -12
  92. package/src/backoffice/types/admin-constants.types.ts +69 -69
  93. package/src/backoffice/types/brand.types.ts +29 -29
  94. package/src/backoffice/types/category.types.ts +67 -67
  95. package/src/backoffice/types/documentation-templates.types.ts +28 -28
  96. package/src/backoffice/types/index.ts +10 -10
  97. package/src/backoffice/types/procedure-product.types.ts +38 -38
  98. package/src/backoffice/types/product.types.ts +240 -240
  99. package/src/backoffice/types/requirement.types.ts +63 -63
  100. package/src/backoffice/types/static/README.md +18 -18
  101. package/src/backoffice/types/static/blocking-condition.types.ts +21 -21
  102. package/src/backoffice/types/static/certification.types.ts +37 -37
  103. package/src/backoffice/types/static/contraindication.types.ts +19 -19
  104. package/src/backoffice/types/static/index.ts +6 -6
  105. package/src/backoffice/types/static/pricing.types.ts +16 -16
  106. package/src/backoffice/types/static/procedure-family.types.ts +14 -14
  107. package/src/backoffice/types/static/treatment-benefit.types.ts +22 -22
  108. package/src/backoffice/types/subcategory.types.ts +34 -34
  109. package/src/backoffice/types/technology.types.ts +168 -168
  110. package/src/backoffice/validations/index.ts +1 -1
  111. package/src/backoffice/validations/schemas.ts +164 -164
  112. package/src/config/__mocks__/firebase.ts +99 -99
  113. package/src/config/firebase.ts +78 -78
  114. package/src/config/index.ts +9 -9
  115. package/src/errors/auth.error.ts +6 -6
  116. package/src/errors/auth.errors.ts +200 -200
  117. package/src/errors/clinic.errors.ts +32 -32
  118. package/src/errors/firebase.errors.ts +47 -47
  119. package/src/errors/user.errors.ts +99 -99
  120. package/src/index.backup.ts +407 -407
  121. package/src/index.ts +6 -6
  122. package/src/locales/en.ts +31 -31
  123. package/src/recommender/admin/index.ts +1 -1
  124. package/src/recommender/admin/services/recommender.service.admin.ts +5 -5
  125. package/src/recommender/front/index.ts +1 -1
  126. package/src/recommender/front/services/onboarding.service.ts +5 -5
  127. package/src/recommender/front/services/recommender.service.ts +3 -3
  128. package/src/recommender/index.ts +1 -1
  129. package/src/services/PATIENTAUTH.MD +197 -197
  130. package/src/services/README.md +106 -106
  131. package/src/services/__tests__/auth/auth.mock.test.ts +17 -17
  132. package/src/services/__tests__/auth/auth.setup.ts +293 -293
  133. package/src/services/__tests__/auth.service.test.ts +346 -346
  134. package/src/services/__tests__/base.service.test.ts +77 -77
  135. package/src/services/__tests__/user.service.test.ts +528 -528
  136. package/src/services/analytics/ARCHITECTURE.md +199 -199
  137. package/src/services/analytics/CLOUD_FUNCTIONS.md +225 -225
  138. package/src/services/analytics/GROUPED_ANALYTICS.md +501 -501
  139. package/src/services/analytics/QUICK_START.md +393 -393
  140. package/src/services/analytics/README.md +304 -304
  141. package/src/services/analytics/SUMMARY.md +141 -141
  142. package/src/services/analytics/TRENDS.md +380 -380
  143. package/src/services/analytics/USAGE_GUIDE.md +518 -518
  144. package/src/services/analytics/analytics-cloud.service.ts +222 -222
  145. package/src/services/analytics/analytics.service.ts +2142 -2142
  146. package/src/services/analytics/index.ts +4 -4
  147. package/src/services/analytics/review-analytics.service.ts +941 -941
  148. package/src/services/analytics/utils/appointment-filtering.utils.ts +138 -138
  149. package/src/services/analytics/utils/cost-calculation.utils.ts +182 -182
  150. package/src/services/analytics/utils/grouping.utils.ts +434 -434
  151. package/src/services/analytics/utils/stored-analytics.utils.ts +347 -347
  152. package/src/services/analytics/utils/time-calculation.utils.ts +186 -186
  153. package/src/services/analytics/utils/trend-calculation.utils.ts +200 -200
  154. package/src/services/appointment/README.md +17 -17
  155. package/src/services/appointment/appointment.service.ts +2558 -2558
  156. package/src/services/appointment/index.ts +1 -1
  157. package/src/services/appointment/utils/appointment.utils.ts +552 -552
  158. package/src/services/appointment/utils/extended-procedure.utils.ts +314 -314
  159. package/src/services/appointment/utils/form-initialization.utils.ts +225 -225
  160. package/src/services/appointment/utils/recommended-procedure.utils.ts +195 -195
  161. package/src/services/appointment/utils/zone-management.utils.ts +353 -353
  162. package/src/services/appointment/utils/zone-photo.utils.ts +152 -152
  163. package/src/services/auth/auth.service.ts +989 -989
  164. package/src/services/auth/auth.v2.service.ts +961 -961
  165. package/src/services/auth/index.ts +7 -7
  166. package/src/services/auth/utils/error.utils.ts +90 -90
  167. package/src/services/auth/utils/firebase.utils.ts +49 -49
  168. package/src/services/auth/utils/index.ts +21 -21
  169. package/src/services/auth/utils/practitioner.utils.ts +125 -125
  170. package/src/services/base.service.ts +41 -41
  171. package/src/services/calendar/calendar.service.ts +1077 -1077
  172. package/src/services/calendar/calendar.v2.service.ts +1683 -1683
  173. package/src/services/calendar/calendar.v3.service.ts +313 -313
  174. package/src/services/calendar/externalCalendar.service.ts +178 -178
  175. package/src/services/calendar/index.ts +5 -5
  176. package/src/services/calendar/synced-calendars.service.ts +743 -743
  177. package/src/services/calendar/utils/appointment.utils.ts +265 -265
  178. package/src/services/calendar/utils/calendar-event.utils.ts +646 -646
  179. package/src/services/calendar/utils/clinic.utils.ts +237 -237
  180. package/src/services/calendar/utils/docs.utils.ts +157 -157
  181. package/src/services/calendar/utils/google-calendar.utils.ts +697 -697
  182. package/src/services/calendar/utils/index.ts +8 -8
  183. package/src/services/calendar/utils/patient.utils.ts +198 -198
  184. package/src/services/calendar/utils/practitioner.utils.ts +221 -221
  185. package/src/services/calendar/utils/synced-calendar.utils.ts +472 -472
  186. package/src/services/clinic/README.md +204 -204
  187. package/src/services/clinic/__tests__/clinic-admin.service.test.ts +287 -287
  188. package/src/services/clinic/__tests__/clinic-group.service.test.ts +352 -352
  189. package/src/services/clinic/__tests__/clinic.service.test.ts +354 -354
  190. package/src/services/clinic/billing-transactions.service.ts +217 -217
  191. package/src/services/clinic/clinic-admin.service.ts +202 -202
  192. package/src/services/clinic/clinic-group.service.ts +310 -310
  193. package/src/services/clinic/clinic.service.ts +708 -708
  194. package/src/services/clinic/index.ts +5 -5
  195. package/src/services/clinic/practitioner-invite.service.ts +519 -519
  196. package/src/services/clinic/utils/admin.utils.ts +551 -551
  197. package/src/services/clinic/utils/clinic-group.utils.ts +646 -646
  198. package/src/services/clinic/utils/clinic.utils.ts +949 -949
  199. package/src/services/clinic/utils/filter.utils.d.ts +23 -23
  200. package/src/services/clinic/utils/filter.utils.ts +446 -446
  201. package/src/services/clinic/utils/index.ts +11 -11
  202. package/src/services/clinic/utils/photos.utils.ts +188 -188
  203. package/src/services/clinic/utils/search.utils.ts +84 -84
  204. package/src/services/clinic/utils/tag.utils.ts +124 -124
  205. package/src/services/documentation-templates/documentation-template.service.ts +537 -537
  206. package/src/services/documentation-templates/filled-document.service.ts +587 -587
  207. package/src/services/documentation-templates/index.ts +2 -2
  208. package/src/services/index.ts +14 -14
  209. package/src/services/media/index.ts +1 -1
  210. package/src/services/media/media.service.ts +418 -418
  211. package/src/services/notifications/__tests__/notification.service.test.ts +242 -242
  212. package/src/services/notifications/index.ts +1 -1
  213. package/src/services/notifications/notification.service.ts +215 -215
  214. package/src/services/patient/README.md +48 -48
  215. package/src/services/patient/To-Do.md +43 -43
  216. package/src/services/patient/__tests__/patient.service.test.ts +294 -294
  217. package/src/services/patient/index.ts +2 -2
  218. package/src/services/patient/patient.service.ts +883 -883
  219. package/src/services/patient/patientRequirements.service.ts +285 -285
  220. package/src/services/patient/utils/aesthetic-analysis.utils.ts +176 -176
  221. package/src/services/patient/utils/clinic.utils.ts +80 -80
  222. package/src/services/patient/utils/docs.utils.ts +142 -142
  223. package/src/services/patient/utils/index.ts +9 -9
  224. package/src/services/patient/utils/location.utils.ts +126 -126
  225. package/src/services/patient/utils/medical-stuff.utils.ts +143 -143
  226. package/src/services/patient/utils/medical.utils.ts +458 -458
  227. package/src/services/patient/utils/practitioner.utils.ts +260 -260
  228. package/src/services/patient/utils/profile.utils.ts +510 -510
  229. package/src/services/patient/utils/sensitive.utils.ts +260 -260
  230. package/src/services/patient/utils/token.utils.ts +211 -211
  231. package/src/services/practitioner/README.md +145 -145
  232. package/src/services/practitioner/index.ts +1 -1
  233. package/src/services/practitioner/practitioner.service.ts +1742 -1742
  234. package/src/services/procedure/README.md +163 -163
  235. package/src/services/procedure/index.ts +1 -1
  236. package/src/services/procedure/procedure.service.ts +2200 -2200
  237. package/src/services/reviews/index.ts +1 -1
  238. package/src/services/reviews/reviews.service.ts +734 -734
  239. package/src/services/user/index.ts +1 -1
  240. package/src/services/user/user.service.ts +489 -489
  241. package/src/services/user/user.v2.service.ts +466 -466
  242. package/src/types/analytics/analytics.types.ts +597 -597
  243. package/src/types/analytics/grouped-analytics.types.ts +173 -173
  244. package/src/types/analytics/index.ts +4 -4
  245. package/src/types/analytics/stored-analytics.types.ts +137 -137
  246. package/src/types/appointment/index.ts +480 -480
  247. package/src/types/calendar/index.ts +258 -258
  248. package/src/types/calendar/synced-calendar.types.ts +66 -66
  249. package/src/types/clinic/index.ts +498 -489
  250. package/src/types/clinic/practitioner-invite.types.ts +91 -91
  251. package/src/types/clinic/preferences.types.ts +159 -159
  252. package/src/types/clinic/to-do +3 -3
  253. package/src/types/documentation-templates/index.ts +308 -308
  254. package/src/types/index.ts +47 -47
  255. package/src/types/notifications/README.md +77 -77
  256. package/src/types/notifications/index.ts +286 -286
  257. package/src/types/patient/aesthetic-analysis.types.ts +66 -66
  258. package/src/types/patient/allergies.ts +58 -58
  259. package/src/types/patient/index.ts +275 -275
  260. package/src/types/patient/medical-info.types.ts +152 -152
  261. package/src/types/patient/patient-requirements.ts +92 -92
  262. package/src/types/patient/token.types.ts +61 -61
  263. package/src/types/practitioner/index.ts +206 -206
  264. package/src/types/procedure/index.ts +181 -181
  265. package/src/types/profile/index.ts +39 -39
  266. package/src/types/reviews/index.ts +132 -132
  267. package/src/types/tz-lookup.d.ts +4 -4
  268. package/src/types/user/index.ts +38 -38
  269. package/src/utils/TIMESTAMPS.md +176 -176
  270. package/src/utils/TimestampUtils.ts +241 -241
  271. package/src/utils/index.ts +1 -1
  272. package/src/validations/appointment.schema.ts +574 -574
  273. package/src/validations/calendar.schema.ts +225 -225
  274. package/src/validations/clinic.schema.ts +494 -493
  275. package/src/validations/common.schema.ts +25 -25
  276. package/src/validations/documentation-templates/index.ts +1 -1
  277. package/src/validations/documentation-templates/template.schema.ts +220 -220
  278. package/src/validations/documentation-templates.schema.ts +10 -10
  279. package/src/validations/index.ts +20 -20
  280. package/src/validations/media.schema.ts +10 -10
  281. package/src/validations/notification.schema.ts +90 -90
  282. package/src/validations/patient/aesthetic-analysis.schema.ts +55 -55
  283. package/src/validations/patient/medical-info.schema.ts +125 -125
  284. package/src/validations/patient/patient-requirements.schema.ts +84 -84
  285. package/src/validations/patient/token.schema.ts +29 -29
  286. package/src/validations/patient.schema.ts +217 -217
  287. package/src/validations/practitioner.schema.ts +222 -222
  288. package/src/validations/procedure-product.schema.ts +41 -41
  289. package/src/validations/procedure.schema.ts +124 -124
  290. package/src/validations/profile-info.schema.ts +41 -41
  291. package/src/validations/reviews.schema.ts +195 -195
  292. package/src/validations/schemas.ts +104 -104
  293. package/src/validations/shared.schema.ts +78 -78
@@ -1,59 +1,59 @@
1
- import { Timestamp } from "firebase/firestore";
2
- import { Clinic } from "../../types/clinic";
3
- import { Practitioner } from "../../types/practitioner";
4
- import { Procedure } from "../../types/procedure";
5
- import { CalendarEvent } from "../../types/calendar";
6
-
7
- /**
8
- * Request parameters for calculating available booking slots
9
- */
10
- export interface BookingAvailabilityRequest {
11
- /** The clinic for which to calculate booking slots */
12
- clinic: Clinic;
13
-
14
- /** The practitioner for which to calculate booking slots */
15
- practitioner: Practitioner;
16
-
17
- /** The procedure for which to calculate booking slots */
18
- procedure: Procedure;
19
-
20
- /** The timeframe for which to calculate booking slots */
21
- timeframe: {
22
- start: Timestamp;
23
- end: Timestamp;
24
- };
25
-
26
- /** Calendar events for the clinic during the specified timeframe */
27
- clinicCalendarEvents: CalendarEvent[];
28
-
29
- /** Calendar events for the practitioner during the specified timeframe */
30
- practitionerCalendarEvents: CalendarEvent[];
31
-
32
- /** IANA timezone of the clinic */
33
- tz: string;
34
- }
35
-
36
- /**
37
- * Represents a single available booking slot
38
- */
39
- export interface AvailableSlot {
40
- /** Start time of the available booking slot */
41
- start: Timestamp;
42
- }
43
-
44
- /**
45
- * Response with available booking slots
46
- */
47
- export interface BookingAvailabilityResponse {
48
- /** Array of available booking slots */
49
- availableSlots: AvailableSlot[];
50
- }
51
-
52
- /**
53
- * Represents a time interval with start and end times
54
- * Used internally for availability calculations
55
- */
56
- export interface TimeInterval {
57
- start: Timestamp;
58
- end: Timestamp;
59
- }
1
+ import { Timestamp } from "firebase/firestore";
2
+ import { Clinic } from "../../types/clinic";
3
+ import { Practitioner } from "../../types/practitioner";
4
+ import { Procedure } from "../../types/procedure";
5
+ import { CalendarEvent } from "../../types/calendar";
6
+
7
+ /**
8
+ * Request parameters for calculating available booking slots
9
+ */
10
+ export interface BookingAvailabilityRequest {
11
+ /** The clinic for which to calculate booking slots */
12
+ clinic: Clinic;
13
+
14
+ /** The practitioner for which to calculate booking slots */
15
+ practitioner: Practitioner;
16
+
17
+ /** The procedure for which to calculate booking slots */
18
+ procedure: Procedure;
19
+
20
+ /** The timeframe for which to calculate booking slots */
21
+ timeframe: {
22
+ start: Timestamp;
23
+ end: Timestamp;
24
+ };
25
+
26
+ /** Calendar events for the clinic during the specified timeframe */
27
+ clinicCalendarEvents: CalendarEvent[];
28
+
29
+ /** Calendar events for the practitioner during the specified timeframe */
30
+ practitionerCalendarEvents: CalendarEvent[];
31
+
32
+ /** IANA timezone of the clinic */
33
+ tz: string;
34
+ }
35
+
36
+ /**
37
+ * Represents a single available booking slot
38
+ */
39
+ export interface AvailableSlot {
40
+ /** Start time of the available booking slot */
41
+ start: Timestamp;
42
+ }
43
+
44
+ /**
45
+ * Response with available booking slots
46
+ */
47
+ export interface BookingAvailabilityResponse {
48
+ /** Array of available booking slots */
49
+ availableSlots: AvailableSlot[];
50
+ }
51
+
52
+ /**
53
+ * Represents a time interval with start and end times
54
+ * Used internally for availability calculations
55
+ */
56
+ export interface TimeInterval {
57
+ start: Timestamp;
58
+ end: Timestamp;
59
+ }
@@ -1,3 +1,3 @@
1
- export * from "./booking.types";
2
- export * from "./booking.calculator";
3
- export * from "./booking.admin";
1
+ export * from "./booking.types";
2
+ export * from "./booking.calculator";
3
+ export * from "./booking.admin";
@@ -1,185 +1,185 @@
1
- ## Booking timezones and time types: current state, issues, and alignment plan
2
-
3
- ### Scope and goal
4
- This document explains how booking availability is computed across the admin layer and calculator, how time types and timezones are used today, where mismatches occur, and what to align to make results consistent in every environment and across DST.
5
-
6
- Applies to:
7
- - `Api/src/admin/booking/booking.admin.ts`
8
- - `Api/src/admin/booking/booking.calculator.ts`
9
- - `Api/src/admin/booking/booking.types.ts`
10
-
11
- ### High-level flow (availability)
12
- 1) `BookingAdmin.getAvailableBookingSlots`
13
- - Accepts timeframe as `Date` or `admin.firestore.Timestamp` and normalizes to admin Timestamp.
14
- - Loads `clinic`, `practitioner`, `procedure`.
15
- - Fetches calendar events for clinic and practitioner within the timeframe using admin Timestamps.
16
- - Converts all timestamps (timeframe and events) to client `firebase/firestore` `Timestamp` for the calculator via `TimestampUtils.adminToClient`.
17
- - Passes clinic timezone `tz = clinic.location.tz` to the calculator.
18
- - Calls `BookingAvailabilityCalculator.calculateSlots`.
19
- - Converts resulting client `Timestamp`s back to admin Timestamp in the response.
20
-
21
- 2) `BookingAvailabilityCalculator.calculateSlots`
22
- - Uses client `Timestamp` + Luxon `DateTime`.
23
- - Steps: apply clinic working hours → subtract clinic blocking events → apply practitioner working hours for the target clinic → subtract practitioner busy times → generate slots on a fixed interval grid.
24
-
25
- 3) Types (`BookingAvailabilityRequest`)
26
- - Requires that all time values be client `Timestamp` (from `firebase/firestore`).
27
- - Admin layer converts before calling the calculator and converts back afterwards.
28
-
29
- ### Time representations in play
30
- - Admin/server: `admin.firestore.Timestamp` (backend)
31
- - Client/runtime in calculator: `firebase/firestore` `Timestamp`
32
- - Luxon `DateTime` for tz-aware computations
33
- - String wall-clock specs in working hours, e.g. "HH:mm" for open/close/breaks
34
- - JavaScript `Date` only used transiently at boundaries
35
-
36
- ### Where timezone handling is correct
37
- - Building per-day working-hour intervals (clinic and practitioner) uses:
38
- - `DateTime.fromMillis(value, { zone: tz })` (avoids local-time reinterpretation)
39
- - Explicit `tz` carried from `clinic.location.tz`
40
-
41
- ### Where timezone context is dropped (root cause of shifts)
42
- - Slot generation rounds and iterates using system-local timezone instead of clinic `tz`.
43
- - Slot containment checks compare times constructed without explicit `tz`.
44
- - Effects:
45
- - Servers not in the clinic’s zone (e.g., UTC) will produce slots offset or misaligned to the expected clinic grid.
46
- - DST boundaries can produce off-by-60-min effects and incorrect inclusion/exclusion of slots.
47
-
48
- Problematic patterns to replace:
49
- ```ts
50
- // Uses system-local timezone implicitly
51
- let slotStart = DateTime.fromJSDate(intervalStart);
52
-
53
- // Also builds DateTimes without { zone: tz }
54
- const intervalStart = DateTime.fromMillis(interval.start.toMillis());
55
- const intervalEnd = DateTime.fromMillis(interval.end.toMillis());
56
- ```
57
-
58
- Target pattern:
59
- ```ts
60
- // Always specify the clinic timezone
61
- let slotStart = DateTime.fromMillis(intervalStartMillis, { zone: tz });
62
- const intervalStart = DateTime.fromMillis(interval.start.toMillis(), { zone: tz });
63
- const intervalEnd = DateTime.fromMillis(interval.end.toMillis(), { zone: tz });
64
- ```
65
-
66
- ### Event retrieval misses overlapping events
67
- - Current queries fetch events with `eventTime.start` within `[timeframe.start, timeframe.end]` only.
68
- - Events that start before the window but overlap into it (or extend beyond it) are omitted, so busy time subtraction can miss conflicts.
69
-
70
- Correct overlapping logic should include events where:
71
- - `eventTime.start < timeframe.end` AND `eventTime.end > timeframe.start`
72
-
73
- Firestore considerations:
74
- - Firestore cannot do range filters on two different fields in a single query without workarounds. Practical options:
75
- - Run two queries and union results, or
76
- - Add a single-field index (e.g., duplicated fields like `startAt` and `endAt`) and leverage composite queries appropriately, or
77
- - Query the broader of the two constraints and post-filter in memory. De-duplicate by `id`.
78
-
79
- ### Appointment creation normalization
80
- - `orchestrateAppointmentCreation` writes calendar events with `eventTime` taken directly from input admin Timestamps.
81
- - If the client produced those Timestamps by converting wall-clock times in a different timezone than the clinic, users will observe unexpected local renderings relative to clinic working hours.
82
-
83
- Alignment expectation:
84
- - UI should interpret user-picked wall-clock times in the clinic’s `tz`, convert once to UTC epoch, and send as Timestamp.
85
- - Backend stores the UTC epoch as-is; all display/logic that needs wall-clock context must apply the clinic `tz` explicitly.
86
-
87
- ### Alignment decisions (non-code policy)
88
- 1) Single invariant for the calculator
89
- - Inputs are client `Timestamp`s (UTC epoch) plus explicit `tz`.
90
- - Every Luxon `DateTime` must be created with `{ zone: tz }`.
91
- - Prefer `DateTime.fromMillis(...)` over `fromJSDate(...)`.
92
-
93
- 2) Slot generation/containment
94
- - `generateAvailableSlots` uses `tz` when rounding to interval grid and when iterating.
95
- - `isSlotFullyAvailable` constructs interval boundaries with `{ zone: tz }`.
96
-
97
- 3) Event retrieval strategy
98
- - For timeframe `[S, E]`, include events where `start < E` and `end > S`.
99
- - Implement via union of queries or data model support; post-filter and de-dup in memory if needed.
100
-
101
- 4) Conversion boundaries
102
- - Admin layer converts admin → client Timestamps only at the calculator boundary and client → admin at the response boundary.
103
- - Do not mix admin/client Timestamp types in a single object passed to the calculator.
104
-
105
- 5) UI and API contract
106
- - UI times are wall-clock in clinic `tz`, converted once to UTC Timestamp before sending.
107
- - Backend accepts/returns admin Timestamps on API, but calculator-only paths use client Timestamps internally.
108
-
109
- ### Testing matrix (must pass)
110
- - Timezone variance:
111
- - Clinics in multiple IANA zones; server in UTC and in a non-UTC zone.
112
- - DST boundaries:
113
- - Days that enter/exit DST in clinic `tz`.
114
- - Timeframe edges:
115
- - Windows that straddle midnight in clinic `tz`.
116
- - Very short windows (e.g., ≤ duration) and long windows (multi-day).
117
- - Event overlap cases:
118
- - Events starting before S and ending between S..E.
119
- - Events starting between S..E and ending after E.
120
- - Long events fully covering S..E.
121
- - Grid checks:
122
- - Interval sizes that don’t divide 60 (e.g., 20 min), and variable procedure durations.
123
-
124
- ### Actionable checklist
125
- - ✅ Make all DateTime constructions in slot generation and containment checks use `{ zone: tz }`.
126
- - ✅ Replace `fromJSDate` with `fromMillis` in calculator paths.
127
- - ✅ Update event fetching to include overlaps with the timeframe; union queries or adjust model.
128
- - ⏳ Re-assert the type contract: calculator receives only client `Timestamp` + `tz`.
129
- - ⏳ Document UI responsibility to convert wall-clock (clinic `tz`) → UTC Timestamp exactly once.
130
-
131
- ### PHASE 1 COMPLETED: Backend Calculator Fixes ✅
132
-
133
- **Date Completed:** October 1, 2025
134
-
135
- **Changes Made:**
136
-
137
- 1. **booking.calculator.ts - generateAvailableSlots()**
138
- - Added `tz: string` parameter
139
- - Changed `DateTime.fromJSDate(intervalStart)` → `DateTime.fromMillis(intervalStart.getTime(), { zone: tz })`
140
- - Now explicitly creates DateTime in clinic timezone for all slot calculations
141
-
142
- 2. **booking.calculator.ts - isSlotFullyAvailable()**
143
- - Added `tz: string` parameter
144
- - Changed `DateTime.fromMillis(interval.start.toMillis())` → `DateTime.fromMillis(interval.start.toMillis(), { zone: tz })`
145
- - Interval boundary checks now use clinic timezone context
146
-
147
- 3. **booking.calculator.ts - calculateSlots()**
148
- - Updated call to `generateAvailableSlots()` to pass `tz` parameter
149
- - Updated call to `isSlotFullyAvailable()` to pass `tz` parameter
150
-
151
- 4. **booking.admin.ts - getClinicCalendarEvents()**
152
- - Fixed event overlap logic with bounded query
153
- - Added lower bound: `queryStart = start - 24 hours` to prevent querying all historical events
154
- - Query: `eventTime.start >= queryStart AND eventTime.start < end`
155
- - Added post-filter: `eventTime.end > start` to catch all overlapping events
156
- - Prevents missing events that start before window but overlap into it
157
- - Performance optimized: only queries ~24-48 hours of events instead of entire history
158
-
159
- 5. **booking.admin.ts - getPractitionerCalendarEvents()**
160
- - Applied same overlap fix with 24-hour lookback window
161
- - Ensures busy time subtraction includes all conflicting events
162
- - Efficient: assumes no appointments longer than 24 hours
163
-
164
- **Impact:**
165
- - Slot generation now correctly happens in clinic timezone
166
- - Slots are properly converted to UTC for storage/transmission
167
- - Event blocking now catches all overlapping events, not just those starting within window
168
- - Fixes timezone display issues for users in different timezones
169
-
170
- **Next Steps:**
171
- - Phase 2: Mobile app fixes (use original UTC timestamp from slots)
172
- - Phase 3: ClinicApp fixes (same as Mobile)
173
- - Phase 4: Testing across multiple timezones and DST boundaries
174
-
175
- ### Known risks
176
- - DST transitions can produce days with 23/25 hours; rounding/iteration must not assume 24h.
177
- - Post-filtering events after union queries can be memory-intensive for very large windows; constrain timeframe appropriately.
178
-
179
- ### Quick glossary
180
- - Admin Timestamp: `admin.firestore.Timestamp` (backend SDK)
181
- - Client Timestamp: `firebase/firestore` `Timestamp` (web SDK)
182
- - `tz`: Clinic’s IANA timezone string, e.g., `Europe/Belgrade`
183
- - Luxon `DateTime`: tz-aware date-time object used for calendar math
184
-
185
-
1
+ ## Booking timezones and time types: current state, issues, and alignment plan
2
+
3
+ ### Scope and goal
4
+ This document explains how booking availability is computed across the admin layer and calculator, how time types and timezones are used today, where mismatches occur, and what to align to make results consistent in every environment and across DST.
5
+
6
+ Applies to:
7
+ - `Api/src/admin/booking/booking.admin.ts`
8
+ - `Api/src/admin/booking/booking.calculator.ts`
9
+ - `Api/src/admin/booking/booking.types.ts`
10
+
11
+ ### High-level flow (availability)
12
+ 1) `BookingAdmin.getAvailableBookingSlots`
13
+ - Accepts timeframe as `Date` or `admin.firestore.Timestamp` and normalizes to admin Timestamp.
14
+ - Loads `clinic`, `practitioner`, `procedure`.
15
+ - Fetches calendar events for clinic and practitioner within the timeframe using admin Timestamps.
16
+ - Converts all timestamps (timeframe and events) to client `firebase/firestore` `Timestamp` for the calculator via `TimestampUtils.adminToClient`.
17
+ - Passes clinic timezone `tz = clinic.location.tz` to the calculator.
18
+ - Calls `BookingAvailabilityCalculator.calculateSlots`.
19
+ - Converts resulting client `Timestamp`s back to admin Timestamp in the response.
20
+
21
+ 2) `BookingAvailabilityCalculator.calculateSlots`
22
+ - Uses client `Timestamp` + Luxon `DateTime`.
23
+ - Steps: apply clinic working hours → subtract clinic blocking events → apply practitioner working hours for the target clinic → subtract practitioner busy times → generate slots on a fixed interval grid.
24
+
25
+ 3) Types (`BookingAvailabilityRequest`)
26
+ - Requires that all time values be client `Timestamp` (from `firebase/firestore`).
27
+ - Admin layer converts before calling the calculator and converts back afterwards.
28
+
29
+ ### Time representations in play
30
+ - Admin/server: `admin.firestore.Timestamp` (backend)
31
+ - Client/runtime in calculator: `firebase/firestore` `Timestamp`
32
+ - Luxon `DateTime` for tz-aware computations
33
+ - String wall-clock specs in working hours, e.g. "HH:mm" for open/close/breaks
34
+ - JavaScript `Date` only used transiently at boundaries
35
+
36
+ ### Where timezone handling is correct
37
+ - Building per-day working-hour intervals (clinic and practitioner) uses:
38
+ - `DateTime.fromMillis(value, { zone: tz })` (avoids local-time reinterpretation)
39
+ - Explicit `tz` carried from `clinic.location.tz`
40
+
41
+ ### Where timezone context is dropped (root cause of shifts)
42
+ - Slot generation rounds and iterates using system-local timezone instead of clinic `tz`.
43
+ - Slot containment checks compare times constructed without explicit `tz`.
44
+ - Effects:
45
+ - Servers not in the clinic’s zone (e.g., UTC) will produce slots offset or misaligned to the expected clinic grid.
46
+ - DST boundaries can produce off-by-60-min effects and incorrect inclusion/exclusion of slots.
47
+
48
+ Problematic patterns to replace:
49
+ ```ts
50
+ // Uses system-local timezone implicitly
51
+ let slotStart = DateTime.fromJSDate(intervalStart);
52
+
53
+ // Also builds DateTimes without { zone: tz }
54
+ const intervalStart = DateTime.fromMillis(interval.start.toMillis());
55
+ const intervalEnd = DateTime.fromMillis(interval.end.toMillis());
56
+ ```
57
+
58
+ Target pattern:
59
+ ```ts
60
+ // Always specify the clinic timezone
61
+ let slotStart = DateTime.fromMillis(intervalStartMillis, { zone: tz });
62
+ const intervalStart = DateTime.fromMillis(interval.start.toMillis(), { zone: tz });
63
+ const intervalEnd = DateTime.fromMillis(interval.end.toMillis(), { zone: tz });
64
+ ```
65
+
66
+ ### Event retrieval misses overlapping events
67
+ - Current queries fetch events with `eventTime.start` within `[timeframe.start, timeframe.end]` only.
68
+ - Events that start before the window but overlap into it (or extend beyond it) are omitted, so busy time subtraction can miss conflicts.
69
+
70
+ Correct overlapping logic should include events where:
71
+ - `eventTime.start < timeframe.end` AND `eventTime.end > timeframe.start`
72
+
73
+ Firestore considerations:
74
+ - Firestore cannot do range filters on two different fields in a single query without workarounds. Practical options:
75
+ - Run two queries and union results, or
76
+ - Add a single-field index (e.g., duplicated fields like `startAt` and `endAt`) and leverage composite queries appropriately, or
77
+ - Query the broader of the two constraints and post-filter in memory. De-duplicate by `id`.
78
+
79
+ ### Appointment creation normalization
80
+ - `orchestrateAppointmentCreation` writes calendar events with `eventTime` taken directly from input admin Timestamps.
81
+ - If the client produced those Timestamps by converting wall-clock times in a different timezone than the clinic, users will observe unexpected local renderings relative to clinic working hours.
82
+
83
+ Alignment expectation:
84
+ - UI should interpret user-picked wall-clock times in the clinic’s `tz`, convert once to UTC epoch, and send as Timestamp.
85
+ - Backend stores the UTC epoch as-is; all display/logic that needs wall-clock context must apply the clinic `tz` explicitly.
86
+
87
+ ### Alignment decisions (non-code policy)
88
+ 1) Single invariant for the calculator
89
+ - Inputs are client `Timestamp`s (UTC epoch) plus explicit `tz`.
90
+ - Every Luxon `DateTime` must be created with `{ zone: tz }`.
91
+ - Prefer `DateTime.fromMillis(...)` over `fromJSDate(...)`.
92
+
93
+ 2) Slot generation/containment
94
+ - `generateAvailableSlots` uses `tz` when rounding to interval grid and when iterating.
95
+ - `isSlotFullyAvailable` constructs interval boundaries with `{ zone: tz }`.
96
+
97
+ 3) Event retrieval strategy
98
+ - For timeframe `[S, E]`, include events where `start < E` and `end > S`.
99
+ - Implement via union of queries or data model support; post-filter and de-dup in memory if needed.
100
+
101
+ 4) Conversion boundaries
102
+ - Admin layer converts admin → client Timestamps only at the calculator boundary and client → admin at the response boundary.
103
+ - Do not mix admin/client Timestamp types in a single object passed to the calculator.
104
+
105
+ 5) UI and API contract
106
+ - UI times are wall-clock in clinic `tz`, converted once to UTC Timestamp before sending.
107
+ - Backend accepts/returns admin Timestamps on API, but calculator-only paths use client Timestamps internally.
108
+
109
+ ### Testing matrix (must pass)
110
+ - Timezone variance:
111
+ - Clinics in multiple IANA zones; server in UTC and in a non-UTC zone.
112
+ - DST boundaries:
113
+ - Days that enter/exit DST in clinic `tz`.
114
+ - Timeframe edges:
115
+ - Windows that straddle midnight in clinic `tz`.
116
+ - Very short windows (e.g., ≤ duration) and long windows (multi-day).
117
+ - Event overlap cases:
118
+ - Events starting before S and ending between S..E.
119
+ - Events starting between S..E and ending after E.
120
+ - Long events fully covering S..E.
121
+ - Grid checks:
122
+ - Interval sizes that don’t divide 60 (e.g., 20 min), and variable procedure durations.
123
+
124
+ ### Actionable checklist
125
+ - ✅ Make all DateTime constructions in slot generation and containment checks use `{ zone: tz }`.
126
+ - ✅ Replace `fromJSDate` with `fromMillis` in calculator paths.
127
+ - ✅ Update event fetching to include overlaps with the timeframe; union queries or adjust model.
128
+ - ⏳ Re-assert the type contract: calculator receives only client `Timestamp` + `tz`.
129
+ - ⏳ Document UI responsibility to convert wall-clock (clinic `tz`) → UTC Timestamp exactly once.
130
+
131
+ ### PHASE 1 COMPLETED: Backend Calculator Fixes ✅
132
+
133
+ **Date Completed:** October 1, 2025
134
+
135
+ **Changes Made:**
136
+
137
+ 1. **booking.calculator.ts - generateAvailableSlots()**
138
+ - Added `tz: string` parameter
139
+ - Changed `DateTime.fromJSDate(intervalStart)` → `DateTime.fromMillis(intervalStart.getTime(), { zone: tz })`
140
+ - Now explicitly creates DateTime in clinic timezone for all slot calculations
141
+
142
+ 2. **booking.calculator.ts - isSlotFullyAvailable()**
143
+ - Added `tz: string` parameter
144
+ - Changed `DateTime.fromMillis(interval.start.toMillis())` → `DateTime.fromMillis(interval.start.toMillis(), { zone: tz })`
145
+ - Interval boundary checks now use clinic timezone context
146
+
147
+ 3. **booking.calculator.ts - calculateSlots()**
148
+ - Updated call to `generateAvailableSlots()` to pass `tz` parameter
149
+ - Updated call to `isSlotFullyAvailable()` to pass `tz` parameter
150
+
151
+ 4. **booking.admin.ts - getClinicCalendarEvents()**
152
+ - Fixed event overlap logic with bounded query
153
+ - Added lower bound: `queryStart = start - 24 hours` to prevent querying all historical events
154
+ - Query: `eventTime.start >= queryStart AND eventTime.start < end`
155
+ - Added post-filter: `eventTime.end > start` to catch all overlapping events
156
+ - Prevents missing events that start before window but overlap into it
157
+ - Performance optimized: only queries ~24-48 hours of events instead of entire history
158
+
159
+ 5. **booking.admin.ts - getPractitionerCalendarEvents()**
160
+ - Applied same overlap fix with 24-hour lookback window
161
+ - Ensures busy time subtraction includes all conflicting events
162
+ - Efficient: assumes no appointments longer than 24 hours
163
+
164
+ **Impact:**
165
+ - Slot generation now correctly happens in clinic timezone
166
+ - Slots are properly converted to UTC for storage/transmission
167
+ - Event blocking now catches all overlapping events, not just those starting within window
168
+ - Fixes timezone display issues for users in different timezones
169
+
170
+ **Next Steps:**
171
+ - Phase 2: Mobile app fixes (use original UTC timestamp from slots)
172
+ - Phase 3: ClinicApp fixes (same as Mobile)
173
+ - Phase 4: Testing across multiple timezones and DST boundaries
174
+
175
+ ### Known risks
176
+ - DST transitions can produce days with 23/25 hours; rounding/iteration must not assume 24h.
177
+ - Post-filtering events after union queries can be memory-intensive for very large windows; constrain timeframe appropriately.
178
+
179
+ ### Quick glossary
180
+ - Admin Timestamp: `admin.firestore.Timestamp` (backend SDK)
181
+ - Client Timestamp: `firebase/firestore` `Timestamp` (web SDK)
182
+ - `tz`: Clinic’s IANA timezone string, e.g., `Europe/Belgrade`
183
+ - Luxon `DateTime`: tz-aware date-time object used for calendar math
184
+
185
+
@@ -1,7 +1,7 @@
1
- # Calendar Admin Services
2
-
3
- This directory contains services related to calendar functionality that are intended to be used exclusively in a server-side (admin) environment. These services may contain sensitive logic, such as OAuth handling and direct API interactions with external providers like Google Calendar.
4
-
5
- ## Services
6
-
7
- - `synced-calendars.service.ts`: Manages the synchronization of calendars with external providers. It should not be used on the client side.
1
+ # Calendar Admin Services
2
+
3
+ This directory contains services related to calendar functionality that are intended to be used exclusively in a server-side (admin) environment. These services may contain sensitive logic, such as OAuth handling and direct API interactions with external providers like Google Calendar.
4
+
5
+ ## Services
6
+
7
+ - `synced-calendars.service.ts`: Manages the synchronization of calendars with external providers. It should not be used on the client side.