@ovok/core 0.4.49-dev.504 → 0.4.49-dev.513

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 (391) hide show
  1. package/dist/client/ai-fhir/methods/AIFhirResources.d.ts +3 -1
  2. package/dist/client/ai-fhir/methods/AIFhirResources.js +3 -1
  3. package/dist/client/ai-fhir/types/AIFhirPlan.d.ts +8 -0
  4. package/dist/client/ai-fhir/types/AIFhirPlanRequest.d.ts +8 -0
  5. package/dist/client/ai-fhir/types/AIFhirRequest.d.ts +5 -0
  6. package/dist/client/ai-fhir/types/AIFhirResponse.d.ts +6 -0
  7. package/dist/client/auth/errors.d.ts +15 -2
  8. package/dist/client/auth/errors.js +12 -2
  9. package/dist/client/auth/methods/appleLogin.d.ts +1 -0
  10. package/dist/client/auth/methods/appleLogin.js +1 -0
  11. package/dist/client/auth/methods/changePassword.d.ts +1 -0
  12. package/dist/client/auth/methods/changePassword.js +1 -0
  13. package/dist/client/auth/methods/googleLogin.d.ts +1 -0
  14. package/dist/client/auth/methods/googleLogin.js +1 -0
  15. package/dist/client/auth/methods/login.d.ts +6 -0
  16. package/dist/client/auth/methods/login.js +6 -0
  17. package/dist/client/auth/methods/register.d.ts +5 -0
  18. package/dist/client/auth/methods/register.js +5 -0
  19. package/dist/client/auth/methods/registerPractitioner.d.ts +5 -0
  20. package/dist/client/auth/methods/registerPractitioner.js +5 -0
  21. package/dist/client/auth/methods/reloadSession.d.ts +3 -0
  22. package/dist/client/auth/methods/requestDeleteUser.d.ts +4 -5
  23. package/dist/client/auth/methods/requestDeleteUser.js +4 -5
  24. package/dist/client/auth/methods/setPasswordFromReset.d.ts +1 -0
  25. package/dist/client/auth/methods/setPasswordFromReset.js +1 -0
  26. package/dist/client/auth/session-fetch.d.ts +11 -0
  27. package/dist/client/auth/types/Account.d.ts +8 -1
  28. package/dist/client/auth/types/AppleLoginBody.d.ts +16 -0
  29. package/dist/client/auth/types/AppleLoginBody.js +5 -0
  30. package/dist/client/auth/types/AuthResponse.d.ts +12 -0
  31. package/dist/client/auth/types/ChangePasswordBody.d.ts +7 -0
  32. package/dist/client/auth/types/ChangePasswordResponse.d.ts +5 -0
  33. package/dist/client/auth/types/CompletePasswordResetBody.d.ts +8 -0
  34. package/dist/client/auth/types/GoogleLoginBody.d.ts +5 -0
  35. package/dist/client/auth/types/LoginBody.d.ts +15 -1
  36. package/dist/client/auth/types/LoginError.d.ts +21 -2
  37. package/dist/client/auth/types/LoginError.js +8 -2
  38. package/dist/client/auth/types/LoginResponse.d.ts +8 -1
  39. package/dist/client/auth/types/RegisterBody.d.ts +12 -0
  40. package/dist/client/auth/types/RegisterPractitionerBody.d.ts +5 -0
  41. package/dist/client/auth/types/RegisterResponse.d.ts +7 -0
  42. package/dist/client/auth/types/RequestDeleteUserBody.d.ts +7 -7
  43. package/dist/client/auth/types/RequestDeleteUserResponse.d.ts +14 -0
  44. package/dist/client/auth/types/ResetPasswordBody.d.ts +5 -0
  45. package/dist/client/auth/types/Session.d.ts +14 -2
  46. package/dist/client/change-history/methods.d.ts +6 -0
  47. package/dist/client/change-history/methods.js +6 -0
  48. package/dist/client/change-history/types.d.ts +82 -0
  49. package/dist/client/chat/ai/methods/createAiSession.d.ts +6 -0
  50. package/dist/client/chat/ai/methods/createAiSession.js +6 -0
  51. package/dist/client/chat/ai/types/CreateAiSessionResponse.d.ts +17 -0
  52. package/dist/client/chat/ai/types/SessionMessagesResponse.d.ts +9 -0
  53. package/dist/client/cms/locale.d.ts +12 -2
  54. package/dist/client/cms/locale.js +9 -2
  55. package/dist/client/cms/methods.d.ts +6 -2
  56. package/dist/client/cms/methods.js +7 -3
  57. package/dist/client/cms/types.d.ts +44 -4
  58. package/dist/client/consent/methods.d.ts +16 -0
  59. package/dist/client/consent/methods.js +16 -0
  60. package/dist/client/consent/types.d.ts +53 -1
  61. package/dist/client/consent/types.js +10 -1
  62. package/dist/client/email/methods.d.ts +3 -0
  63. package/dist/client/email/methods.js +3 -0
  64. package/dist/client/email/types.d.ts +33 -0
  65. package/dist/client/errors/field-errors.d.ts +3 -0
  66. package/dist/client/errors/field-errors.js +3 -0
  67. package/dist/client/errors/ovok-error-utils.d.ts +6 -0
  68. package/dist/client/errors/ovok-error-utils.js +6 -0
  69. package/dist/client/errors/ovok-error.d.ts +36 -4
  70. package/dist/client/errors/ovok-error.js +15 -4
  71. package/dist/client/errors/rate-limit-error.d.ts +11 -2
  72. package/dist/client/errors/rate-limit-error.js +10 -2
  73. package/dist/client/errors/sign-in-required-error.d.ts +5 -2
  74. package/dist/client/errors/sign-in-required-error.js +5 -2
  75. package/dist/client/experience/methods.d.ts +38 -0
  76. package/dist/client/experience/methods.js +35 -0
  77. package/dist/client/experience/types.d.ts +316 -0
  78. package/dist/client/experience/types.js +1 -0
  79. package/dist/client/invites/methods.d.ts +27 -9
  80. package/dist/client/invites/methods.js +27 -9
  81. package/dist/client/invites/parse-accept-invite-link.d.ts +3 -1
  82. package/dist/client/invites/parse-accept-invite-link.js +3 -1
  83. package/dist/client/invites/types.d.ts +55 -0
  84. package/dist/client/invites/types.js +12 -0
  85. package/dist/client/notifications/methods.d.ts +15 -0
  86. package/dist/client/notifications/methods.js +15 -0
  87. package/dist/client/notifications/types.d.ts +249 -2
  88. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.d.ts +3 -0
  89. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.js +3 -0
  90. package/dist/client/observation/methods/getLatestObservationsByCodes.d.ts +3 -0
  91. package/dist/client/observation/methods/getLatestObservationsByCodes.js +3 -0
  92. package/dist/client/observation/methods/observationsToMeasurements.d.ts +23 -1
  93. package/dist/client/observation/methods/observationsToMeasurements.js +8 -1
  94. package/dist/client/observation/methods/saveMeasurement.d.ts +3 -1
  95. package/dist/client/observation/methods/saveMeasurement.js +3 -1
  96. package/dist/client/observation/observation-bundle-utils.d.ts +6 -0
  97. package/dist/client/observation/observation-bundle-utils.js +6 -0
  98. package/dist/client/observation/series.d.ts +25 -3
  99. package/dist/client/observation/series.js +6 -2
  100. package/dist/client/observation/services/creator.d.ts +5 -0
  101. package/dist/client/observation/services/creator.js +5 -0
  102. package/dist/client/observation/services/uric-acid-service.js +0 -1
  103. package/dist/client/observation/types/GetLatestObservationsByCodeParams.d.ts +10 -0
  104. package/dist/client/observation/types/MeasurementTypeKey.d.ts +26 -0
  105. package/dist/client/observation/types/MeasurementTypeKey.js +26 -0
  106. package/dist/client/observation/types/ObservationCode.d.ts +64 -1
  107. package/dist/client/observation/types/ObservationCode.js +64 -1
  108. package/dist/client/observation/types/UrineAnalytes.d.ts +14 -0
  109. package/dist/client/observation/types/UrineAnalytes.js +1 -0
  110. package/dist/client/observation/types/generate-measurement/Sample.d.ts +33 -0
  111. package/dist/client/observation/types/generate-observation-body/GenerateObservationBodyParams.d.ts +9 -0
  112. package/dist/client/observation/types/measurement/BabySleepMeasurement.d.ts +3 -0
  113. package/dist/client/observation/types/measurement/BloodGlucoseMeasurement.d.ts +7 -0
  114. package/dist/client/observation/types/measurement/BloodPressureMeasurement.d.ts +10 -0
  115. package/dist/client/observation/types/measurement/BloodPressureStates.d.ts +10 -0
  116. package/dist/client/observation/types/measurement/BloodPressureStates.js +10 -0
  117. package/dist/client/observation/types/measurement/BodyTemperatureMeasurement.d.ts +7 -0
  118. package/dist/client/observation/types/measurement/BodyWeightMeasurmement.d.ts +8 -0
  119. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.d.ts +18 -0
  120. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.js +18 -0
  121. package/dist/client/observation/types/measurement/EcgMeasurement.d.ts +9 -0
  122. package/dist/client/observation/types/measurement/HeartRateMeasurement.d.ts +7 -0
  123. package/dist/client/observation/types/measurement/HeartRateVariabilityMeasurement.d.ts +7 -0
  124. package/dist/client/observation/types/measurement/LipidPanelMeasurement.d.ts +12 -0
  125. package/dist/client/observation/types/measurement/Measurement.d.ts +9 -0
  126. package/dist/client/observation/types/measurement/MeasurementDevice.d.ts +10 -0
  127. package/dist/client/observation/types/measurement/MeasurementSeries.d.ts +2 -0
  128. package/dist/client/observation/types/measurement/PulseOximeterMeasurement.d.ts +10 -0
  129. package/dist/client/observation/types/measurement/RespiratoryRateMeasurement.d.ts +7 -0
  130. package/dist/client/observation/types/measurement/RespiratoryTherapyMeasurement.d.ts +3 -0
  131. package/dist/client/observation/types/measurement/RestingHeartRateMeasurement.d.ts +7 -0
  132. package/dist/client/observation/types/measurement/SpirometryMeasurement.d.ts +23 -0
  133. package/dist/client/observation/types/measurement/StepCountMeasurement.d.ts +9 -0
  134. package/dist/client/observation/types/measurement/UrineAnalyzeMeasurement.d.ts +29 -0
  135. package/dist/client/observation/types/measurement/Vo2MaxMeasurement.d.ts +7 -0
  136. package/dist/client/observation/types/measurement/WalkingHeartRateAverageMeasurement.d.ts +7 -0
  137. package/dist/client/observation/types/service/MeasurementField.d.ts +5 -1
  138. package/dist/client/observation/utils/getObservationValueDisplay.d.ts +2 -0
  139. package/dist/client/offline/offline-measurement-queue.d.ts +56 -1
  140. package/dist/client/offline/offline-measurement-queue.js +21 -0
  141. package/dist/client/offline/shared-measurement-queue.d.ts +16 -1
  142. package/dist/client/offline/shared-measurement-queue.js +3 -1
  143. package/dist/client/ovok-client.d.ts +27 -6
  144. package/dist/client/ovok-client.js +8 -5
  145. package/dist/client/patient/methods.d.ts +21 -0
  146. package/dist/client/patient/methods.js +21 -0
  147. package/dist/client/patient/types.d.ts +131 -0
  148. package/dist/client/patient-sharing/methods.d.ts +18 -0
  149. package/dist/client/patient-sharing/methods.js +18 -0
  150. package/dist/client/patient-sharing/types.d.ts +89 -1
  151. package/dist/client/platform/methods.d.ts +22 -0
  152. package/dist/client/platform/methods.js +20 -0
  153. package/dist/client/platform/types.d.ts +194 -1
  154. package/dist/client/platform/types.js +24 -0
  155. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.d.ts +3 -0
  156. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.js +3 -0
  157. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.d.ts +3 -0
  158. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.js +3 -0
  159. package/dist/client/questionnaire-response/methods/populateQuestionnaire.d.ts +3 -0
  160. package/dist/client/questionnaire-response/methods/populateQuestionnaire.js +3 -0
  161. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.d.ts +3 -0
  162. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.js +3 -0
  163. package/dist/client/questionnaire-response/types.d.ts +6 -0
  164. package/dist/client/signals/errors.d.ts +13 -2
  165. package/dist/client/signals/errors.js +9 -2
  166. package/dist/client/signals/methods.d.ts +9 -0
  167. package/dist/client/signals/methods.js +9 -0
  168. package/dist/client/signals/types.d.ts +31 -0
  169. package/dist/client/slim/methods.d.ts +268 -21
  170. package/dist/client/slim/methods.js +264 -21
  171. package/dist/client/slim/paging.d.ts +22 -2
  172. package/dist/client/slim/paging.js +6 -2
  173. package/dist/client/slim/types.d.ts +920 -1
  174. package/dist/client/storage.d.ts +15 -1
  175. package/dist/client/storage.js +7 -1
  176. package/dist/client/wearables/methods.d.ts +24 -0
  177. package/dist/client/wearables/methods.js +24 -0
  178. package/dist/client/wearables/types.d.ts +74 -0
  179. package/dist/conformance/api-requirements.d.ts +31 -5
  180. package/dist/conformance/api-requirements.js +47 -10
  181. package/dist/conformance/capability-requirements.d.ts +4 -26
  182. package/dist/conformance/capability-requirements.js +5 -27
  183. package/dist/conformance/capability.d.ts +9 -1
  184. package/dist/conformance/capability.js +3 -1
  185. package/dist/hooks/account-hooks.d.ts +35 -0
  186. package/dist/hooks/account-hooks.js +33 -0
  187. package/dist/hooks/api-hooks.d.ts +74 -4
  188. package/dist/hooks/api-hooks.js +56 -4
  189. package/dist/hooks/cms-hooks.d.ts +9 -3
  190. package/dist/hooks/cms-hooks.js +9 -3
  191. package/dist/hooks/email-hooks.d.ts +3 -0
  192. package/dist/hooks/email-hooks.js +3 -0
  193. package/dist/hooks/experience-hooks.d.ts +26 -0
  194. package/dist/hooks/experience-hooks.js +24 -0
  195. package/dist/hooks/index.d.ts +18 -0
  196. package/dist/hooks/index.js +18 -0
  197. package/dist/hooks/invites-hooks.d.ts +21 -2
  198. package/dist/hooks/invites-hooks.js +21 -2
  199. package/dist/hooks/notification-ack-hooks.d.ts +6 -2
  200. package/dist/hooks/notification-ack-hooks.js +6 -2
  201. package/dist/hooks/notification-hooks.d.ts +27 -3
  202. package/dist/hooks/notification-hooks.js +27 -3
  203. package/dist/hooks/notification-note-hooks.d.ts +41 -0
  204. package/dist/hooks/notification-note-hooks.js +33 -0
  205. package/dist/hooks/observation-hooks.d.ts +29 -0
  206. package/dist/hooks/observation-hooks.js +23 -1
  207. package/dist/hooks/patient-hooks.d.ts +53 -0
  208. package/dist/hooks/patient-hooks.js +48 -0
  209. package/dist/hooks/patient-sharing-hooks.d.ts +18 -0
  210. package/dist/hooks/patient-sharing-hooks.js +18 -0
  211. package/dist/hooks/platform-hooks.d.ts +32 -0
  212. package/dist/hooks/platform-hooks.js +23 -0
  213. package/dist/hooks/poll-hooks.d.ts +17 -1
  214. package/dist/hooks/poll-hooks.js +3 -1
  215. package/dist/hooks/signals-hooks.d.ts +3 -0
  216. package/dist/hooks/signals-hooks.js +3 -0
  217. package/dist/hooks/wearables-hooks.d.ts +23 -0
  218. package/dist/hooks/wearables-hooks.js +21 -0
  219. package/dist/next/auth/saved-accounts-store.d.ts +10 -0
  220. package/dist/next/auth/session.d.ts +17 -0
  221. package/dist/next/auth/user-session.d.ts +5 -0
  222. package/dist/next/config/ovok-config.d.ts +45 -0
  223. package/dist/next/errors/ovok-account-error.d.ts +14 -1
  224. package/dist/next/errors/ovok-account-error.js +8 -1
  225. package/dist/next/errors/ovok-errors.d.ts +88 -0
  226. package/dist/next/errors/ovok-errors.js +67 -0
  227. package/dist/next/http/http-client.d.ts +5 -0
  228. package/dist/next/http/transmit.d.ts +7 -0
  229. package/dist/next/http/url.d.ts +10 -0
  230. package/dist/next/ovok.d.ts +31 -1
  231. package/dist/next/ovok.js +5 -1
  232. package/dist/next/paging/page.d.ts +13 -1
  233. package/dist/next/react/context.d.ts +7 -0
  234. package/dist/next/react/context.js +7 -0
  235. package/dist/next/react/index.d.ts +24 -0
  236. package/dist/next/react/index.js +18 -0
  237. package/dist/next/react/query-hooks.d.ts +69 -0
  238. package/dist/next/react/query-hooks.js +31 -0
  239. package/dist/next/resources/accounts/accounts-resource.d.ts +6 -0
  240. package/dist/next/resources/accounts/accounts-resource.js +6 -0
  241. package/dist/next/resources/ai/ai-chat-resource.d.ts +7 -0
  242. package/dist/next/resources/ai/ai-chat-resource.js +5 -0
  243. package/dist/next/resources/ai/ai-resource.d.ts +13 -0
  244. package/dist/next/resources/ai/ai-resource.js +6 -0
  245. package/dist/next/resources/ai/chat-messages-resource.d.ts +7 -0
  246. package/dist/next/resources/ai/chat-messages-resource.js +7 -0
  247. package/dist/next/resources/ai/chat-sessions-resource.d.ts +14 -0
  248. package/dist/next/resources/ai/chat-sessions-resource.js +8 -0
  249. package/dist/next/resources/auth/auth-sessions-resource.d.ts +6 -1
  250. package/dist/next/resources/auth/auth-sessions-resource.js +6 -1
  251. package/dist/next/resources/auth/registration.d.ts +18 -1
  252. package/dist/next/resources/auth/social-login.d.ts +12 -0
  253. package/dist/next/resources/auth-resource.d.ts +54 -1
  254. package/dist/next/resources/auth-resource.js +23 -0
  255. package/dist/next/resources/bots/bots-resource.d.ts +15 -0
  256. package/dist/next/resources/bots/bots-resource.js +5 -0
  257. package/dist/next/resources/cms/cms-delivery.d.ts +14 -2
  258. package/dist/next/resources/cms/cms-documents-resource.d.ts +7 -1
  259. package/dist/next/resources/cms/cms-documents-resource.js +7 -1
  260. package/dist/next/resources/cms/cms-resource.d.ts +7 -0
  261. package/dist/next/resources/cms/cms-resource.js +5 -0
  262. package/dist/next/resources/cms/release-notes-resource.d.ts +6 -0
  263. package/dist/next/resources/cms/release-notes-resource.js +6 -0
  264. package/dist/next/resources/consent/consent-resource.d.ts +22 -0
  265. package/dist/next/resources/consent/consent-resource.js +20 -0
  266. package/dist/next/resources/content/content-resource.d.ts +18 -0
  267. package/dist/next/resources/content/content-resource.js +12 -0
  268. package/dist/next/resources/documents/documents-resource.d.ts +24 -0
  269. package/dist/next/resources/documents/documents-resource.js +10 -0
  270. package/dist/next/resources/email/email-resource.d.ts +6 -0
  271. package/dist/next/resources/email/email-resource.js +5 -0
  272. package/dist/next/resources/email/email-templates-resource.d.ts +6 -0
  273. package/dist/next/resources/email/email-templates-resource.js +6 -0
  274. package/dist/next/resources/fhir-resource.d.ts +36 -0
  275. package/dist/next/resources/fhir-resource.js +21 -0
  276. package/dist/next/resources/health-resource.d.ts +16 -0
  277. package/dist/next/resources/health-resource.js +5 -0
  278. package/dist/next/resources/invites/invite-flow-resource.d.ts +7 -1
  279. package/dist/next/resources/invites/invite-flow-resource.js +7 -1
  280. package/dist/next/resources/invites/invites-resource.d.ts +15 -0
  281. package/dist/next/resources/invites/invites-resource.js +5 -0
  282. package/dist/next/resources/localization/i18next-resource.d.ts +6 -0
  283. package/dist/next/resources/localization/i18next-resource.js +6 -0
  284. package/dist/next/resources/localization/locales-resource.d.ts +7 -0
  285. package/dist/next/resources/localization/locales-resource.js +7 -0
  286. package/dist/next/resources/localization/localizations-resource.d.ts +17 -0
  287. package/dist/next/resources/localization/localizations-resource.js +9 -0
  288. package/dist/next/resources/measurements/measurements-resource.d.ts +53 -1
  289. package/dist/next/resources/measurements/measurements-resource.js +14 -0
  290. package/dist/next/resources/measurements/observation-builder.d.ts +5 -0
  291. package/dist/next/resources/measurements/offline-measurement-queue-types.d.ts +32 -0
  292. package/dist/next/resources/patient/fhir-records.d.ts +19 -1
  293. package/dist/next/resources/patient/fhir-records.js +19 -1
  294. package/dist/next/resources/patient/patient-resource.d.ts +15 -0
  295. package/dist/next/resources/patient/patient-resource.js +6 -0
  296. package/dist/next/resources/projects/project-features-resource.d.ts +7 -0
  297. package/dist/next/resources/projects/project-features-resource.js +7 -0
  298. package/dist/next/resources/projects/project-members-resource.d.ts +19 -0
  299. package/dist/next/resources/projects/project-members-resource.js +9 -0
  300. package/dist/next/resources/projects/project-settings-resource.d.ts +8 -0
  301. package/dist/next/resources/projects/project-settings-resource.js +8 -0
  302. package/dist/next/resources/projects/projects-resource.d.ts +15 -0
  303. package/dist/next/resources/projects/projects-resource.js +5 -0
  304. package/dist/next/resources/questionnaires/questionnaires-resource.d.ts +13 -0
  305. package/dist/next/resources/questionnaires/questionnaires-resource.js +13 -0
  306. package/dist/next/resources/realtime/realtime-resource.d.ts +11 -0
  307. package/dist/next/resources/realtime/realtime-resource.js +11 -0
  308. package/dist/next/resources/realtime/realtime-types.d.ts +16 -0
  309. package/dist/next/resources/session/saved-accounts-resource.d.ts +16 -0
  310. package/dist/next/resources/session/saved-accounts-resource.js +16 -0
  311. package/dist/next/resources/session/session-resource.d.ts +8 -0
  312. package/dist/next/resources/session/session-resource.js +7 -0
  313. package/dist/next/resources/sharing/sharing-invites-resource.d.ts +7 -0
  314. package/dist/next/resources/sharing/sharing-invites-resource.js +7 -0
  315. package/dist/next/resources/sharing/sharing-resource.d.ts +8 -0
  316. package/dist/next/resources/sharing/sharing-resource.js +5 -0
  317. package/dist/next/resources/sharing/sharing-settings-resource.d.ts +7 -0
  318. package/dist/next/resources/sharing/sharing-settings-resource.js +7 -0
  319. package/dist/next/resources/sharing/sharing-shares-resource.d.ts +7 -0
  320. package/dist/next/resources/sharing/sharing-shares-resource.js +7 -0
  321. package/dist/next/resources/signals/signals-gateway-resource.d.ts +15 -0
  322. package/dist/next/resources/signals/signals-gateway-resource.js +6 -0
  323. package/dist/next/resources/signals/signals-resource.d.ts +7 -0
  324. package/dist/next/resources/signals/signals-resource.js +5 -0
  325. package/dist/next/resources/signals/undeliverable-resource.d.ts +35 -0
  326. package/dist/next/resources/signals/undeliverable-resource.js +6 -0
  327. package/dist/next/resources/slim/slim-alarms-resource.d.ts +7 -0
  328. package/dist/next/resources/slim/slim-alarms-resource.js +7 -0
  329. package/dist/next/resources/slim/slim-change-history-resource.d.ts +6 -0
  330. package/dist/next/resources/slim/slim-change-history-resource.js +6 -0
  331. package/dist/next/resources/slim/slim-child-projects-resource.d.ts +21 -0
  332. package/dist/next/resources/slim/slim-child-projects-resource.js +8 -0
  333. package/dist/next/resources/slim/slim-devices-resource.d.ts +31 -0
  334. package/dist/next/resources/slim/slim-devices-resource.js +16 -0
  335. package/dist/next/resources/slim/slim-exports-resource.d.ts +6 -0
  336. package/dist/next/resources/slim/slim-exports-resource.js +6 -0
  337. package/dist/next/resources/slim/slim-locations-resource.d.ts +9 -0
  338. package/dist/next/resources/slim/slim-locations-resource.js +9 -0
  339. package/dist/next/resources/slim/slim-medical-notifications-resource.d.ts +6 -0
  340. package/dist/next/resources/slim/slim-medical-notifications-resource.js +6 -0
  341. package/dist/next/resources/slim/slim-notification-notes-resource.d.ts +10 -0
  342. package/dist/next/resources/slim/slim-notification-notes-resource.js +10 -0
  343. package/dist/next/resources/slim/slim-notifications-resource.d.ts +10 -0
  344. package/dist/next/resources/slim/slim-notifications-resource.js +6 -0
  345. package/dist/next/resources/slim/slim-organizations-resource.d.ts +9 -0
  346. package/dist/next/resources/slim/slim-organizations-resource.js +9 -0
  347. package/dist/next/resources/slim/slim-out-of-bed-resource.d.ts +12 -0
  348. package/dist/next/resources/slim/slim-out-of-bed-resource.js +7 -0
  349. package/dist/next/resources/slim/slim-patient-thresholds-resource.d.ts +6 -0
  350. package/dist/next/resources/slim/slim-patient-thresholds-resource.js +6 -0
  351. package/dist/next/resources/slim/slim-patients-resource.d.ts +11 -0
  352. package/dist/next/resources/slim/slim-patients-resource.js +10 -0
  353. package/dist/next/resources/slim/slim-policies-resource.d.ts +10 -0
  354. package/dist/next/resources/slim/slim-policies-resource.js +10 -0
  355. package/dist/next/resources/slim/slim-practitioners-resource.d.ts +6 -0
  356. package/dist/next/resources/slim/slim-practitioners-resource.js +6 -0
  357. package/dist/next/resources/slim/slim-projects-resource.d.ts +12 -0
  358. package/dist/next/resources/slim/slim-projects-resource.js +11 -0
  359. package/dist/next/resources/slim/slim-queries.d.ts +51 -0
  360. package/dist/next/resources/slim/slim-resource.d.ts +21 -0
  361. package/dist/next/resources/slim/slim-resource.js +6 -0
  362. package/dist/next/resources/slim/slim-sleep-resource.d.ts +6 -0
  363. package/dist/next/resources/slim/slim-sleep-resource.js +6 -0
  364. package/dist/next/resources/slim/slim-thresholds-resource.d.ts +5 -0
  365. package/dist/next/resources/slim/slim-thresholds-resource.js +5 -0
  366. package/dist/next/resources/slim/slim-trends-resource.d.ts +6 -0
  367. package/dist/next/resources/slim/slim-trends-resource.js +6 -0
  368. package/dist/next/resources/slim/slim-users-resource.d.ts +12 -0
  369. package/dist/next/resources/slim/slim-users-resource.js +6 -0
  370. package/dist/next/resources/slim/slim-zones-resource.d.ts +8 -0
  371. package/dist/next/resources/slim/slim-zones-resource.js +8 -0
  372. package/dist/next/resources/video-calls/video-call-access-resource.d.ts +13 -0
  373. package/dist/next/resources/video-calls/video-call-access-resource.js +8 -0
  374. package/dist/next/resources/video-calls/video-call-appointments-resource.d.ts +8 -0
  375. package/dist/next/resources/video-calls/video-call-appointments-resource.js +8 -0
  376. package/dist/next/resources/video-calls/video-call-emails-resource.d.ts +8 -0
  377. package/dist/next/resources/video-calls/video-call-emails-resource.js +8 -0
  378. package/dist/next/resources/video-calls/video-calls-resource.d.ts +14 -0
  379. package/dist/next/resources/video-calls/video-calls-resource.js +6 -0
  380. package/dist/next/resources/wearables/wearable-connections-resource.d.ts +8 -0
  381. package/dist/next/resources/wearables/wearable-connections-resource.js +8 -0
  382. package/dist/next/resources/wearables/wearable-providers-resource.d.ts +10 -0
  383. package/dist/next/resources/wearables/wearable-providers-resource.js +10 -0
  384. package/dist/next/resources/wearables/wearables-resource.d.ts +7 -0
  385. package/dist/next/resources/wearables/wearables-resource.js +5 -0
  386. package/dist/next/storage/ovok-storage.d.ts +16 -0
  387. package/dist/next/storage/ovok-storage.js +8 -0
  388. package/dist/types/ValidationError.d.ts +9 -0
  389. package/dist/utils/patch/getPatchOperationType.d.ts +3 -0
  390. package/dist/utils/patch/getPatchOperationType.js +3 -0
  391. package/package.json +5 -2
@@ -3,26 +3,54 @@ import { OvokClient, OvokFhirVersion } from "../client/ovok-client";
3
3
  import { OvokAdministeredProject, OvokPage, OvokProjectFeatures, OvokProjectSettings } from "../client/platform/types";
4
4
  import { SlimDeviceListItem, SlimDeviceListQuery, SlimDeviceTelemetry, SlimPage, SlimPatientListItem, SlimPatientListQuery } from "../client/slim/types";
5
5
  import { OvokPublicApiEndpoint } from "../conformance/capability";
6
+ /**
7
+ * State of a read hook.
8
+ */
6
9
  export type OvokRequestState<T> = {
10
+ /** Latest loaded value; `undefined` before the first load and after the request changes. */
7
11
  data: T | undefined;
12
+ /** Epoch milliseconds at which `data` was last set. */
8
13
  dataUpdatedAt: number | undefined;
14
+ /** `true` while a request is in flight. */
9
15
  loading: boolean;
16
+ /** `true` while a reload runs and `data` is already available. */
10
17
  isRefreshing: boolean;
18
+ /** `true` when `data` is available but a reload is running or has failed. */
11
19
  isStale: boolean;
20
+ /** Error of the last request, cleared when the next one starts. */
12
21
  error: Error | undefined;
22
+ /** Runs the request again. */
13
23
  reload: () => void;
14
24
  };
25
+ /**
26
+ * State of a mutation hook.
27
+ */
15
28
  export type OvokMutationState<TParams, TData> = {
29
+ /** Result of the last successful `mutate` call. */
16
30
  data: TData | undefined;
31
+ /** `true` while `mutate` runs. */
17
32
  loading: boolean;
33
+ /** Error of the last `mutate` call, cleared when the next one starts. */
18
34
  error: Error | undefined;
35
+ /** Runs the mutation; resolves with its result and rejects with the error. */
19
36
  mutate: (params: TParams) => Promise<TData>;
37
+ /** Clears `data`, `error` and `loading`. */
20
38
  reset: () => void;
21
39
  };
22
40
  /**
23
- * Small request primitive for the typed Ovok hooks. It deliberately does not
24
- * add a cache or retry policy: MedplumClient already owns request caching and
25
- * the host app owns the retry policy appropriate to its screen.
41
+ * Runs `load` on mount and whenever `load` or `enabled` changes, and aborts it on unmount.
42
+ * Adds no cache or retry policy; the client caches requests and the app owns retries.
43
+ * While `enabled` is `false`, nothing runs and `loading` is `false`.
44
+ *
45
+ * @param load - Request to run; receives an abort signal.
46
+ * @param enabled - Set `false` to skip the request.
47
+ *
48
+ * @example
49
+ * ```tsx
50
+ * const client = useClient();
51
+ * const load = useCallback((signal?: AbortSignal) => client.getProjectSettings({ signal }), [client]);
52
+ * const { data, loading, error, reload } = useOvokRequest(load);
53
+ * ```
26
54
  */
27
55
  export declare function useOvokRequest<T>(load: (signal?: AbortSignal) => Promise<T>, enabled?: boolean): OvokRequestState<T>;
28
56
  /** Internal variant for list hooks that reconcile server-confirmed changes in mounted data. */
@@ -36,16 +64,58 @@ export declare function useOvokRequestWithUpdater<T>(load: (signal?: AbortSignal
36
64
  export declare function useOvokClientRequest<T>(request: (client: OvokClient, signal?: AbortSignal) => Promise<T>, inputs?: unknown, enabled?: boolean): OvokRequestState<T>;
37
65
  /** Reads by id: waits while `id` is undefined and rejects an empty id with "<name> is required". */
38
66
  export declare function useOvokClientRequestFor<T>(name: string, id: string | undefined, request: (client: OvokClient, id: string, signal?: AbortSignal) => Promise<T>): OvokRequestState<T>;
39
- /** Generic mutation hook for any typed OvokClient method. */
67
+ /**
68
+ * Wraps any `OvokClient` call in mutation state; nothing runs until `mutate` is called.
69
+ *
70
+ * @param mutateRequest - Call to run with the client and the `mutate` params.
71
+ *
72
+ * @example
73
+ * ```tsx
74
+ * const { mutate, loading, error } = useOvokMutation(
75
+ * (client, accepted: boolean) => client.setLegalConsent(accepted),
76
+ * );
77
+ * await mutate(true);
78
+ * ```
79
+ */
40
80
  export declare function useOvokMutation<TParams, TData>(mutateRequest: (client: OvokClient, params: TParams) => Promise<TData>): OvokMutationState<TParams, TData>;
81
+ /**
82
+ * Loads the server's capability statement for a FHIR version via `client.getCapabilityStatement`.
83
+ *
84
+ * @param version - FHIR version; defaults to `R4`.
85
+ */
41
86
  export declare const useCapabilityStatement: (version?: OvokFhirVersion) => OvokRequestState<CapabilityStatement>;
87
+ /**
88
+ * Loads the public API routes listed in the capability statement via `client.getPublicApiEndpoints`.
89
+ *
90
+ * @param version - FHIR version; defaults to `R4`.
91
+ */
42
92
  export declare const usePublicApiEndpoints: (version?: OvokFhirVersion) => OvokRequestState<OvokPublicApiEndpoint[]>;
93
+ /**
94
+ * Loads the projects the user administers via `client.listAdministeredProjects`.
95
+ *
96
+ * @param params - Page number and page size.
97
+ */
43
98
  export declare const useAdministeredProjects: (params?: {
44
99
  page?: number;
45
100
  count?: number;
46
101
  }) => OvokRequestState<OvokPage<OvokAdministeredProject>>;
102
+ /**
103
+ * Loads the project's settings via `client.getProjectSettings`.
104
+ */
47
105
  export declare const useProjectSettings: () => OvokRequestState<OvokProjectSettings>;
106
+ /**
107
+ * Loads the project's feature flags via `client.getProjectFeatures`.
108
+ */
48
109
  export declare const useProjectFeatures: () => OvokRequestState<OvokProjectFeatures>;
110
+ /**
111
+ * Loads a page of Slim patients via `client.listSlimPatients`, reloading when `params` change.
112
+ */
49
113
  export declare const useSlimPatients: (params?: SlimPatientListQuery) => OvokRequestState<SlimPage<SlimPatientListItem>>;
114
+ /**
115
+ * Loads a page of Slim devices via `client.listSlimDevices`, reloading when `params` change.
116
+ */
50
117
  export declare const useSlimDevices: (params?: SlimDeviceListQuery) => OvokRequestState<SlimPage<SlimDeviceListItem>>;
118
+ /**
119
+ * Loads a Slim device's telemetry via `client.getSlimDeviceTelemetry`; skips while `deviceId` is undefined and fails with "deviceId is required" when it is empty.
120
+ */
51
121
  export declare const useSlimDeviceTelemetry: (deviceId?: string) => OvokRequestState<SlimDeviceTelemetry>;
@@ -44,9 +44,19 @@ const React = __importStar(require("react"));
44
44
  const ovok_error_utils_1 = require("../client/errors/ovok-error-utils");
45
45
  const index_1 = require("./index");
46
46
  /**
47
- * Small request primitive for the typed Ovok hooks. It deliberately does not
48
- * add a cache or retry policy: MedplumClient already owns request caching and
49
- * the host app owns the retry policy appropriate to its screen.
47
+ * Runs `load` on mount and whenever `load` or `enabled` changes, and aborts it on unmount.
48
+ * Adds no cache or retry policy; the client caches requests and the app owns retries.
49
+ * While `enabled` is `false`, nothing runs and `loading` is `false`.
50
+ *
51
+ * @param load - Request to run; receives an abort signal.
52
+ * @param enabled - Set `false` to skip the request.
53
+ *
54
+ * @example
55
+ * ```tsx
56
+ * const client = useClient();
57
+ * const load = useCallback((signal?: AbortSignal) => client.getProjectSettings({ signal }), [client]);
58
+ * const { data, loading, error, reload } = useOvokRequest(load);
59
+ * ```
50
60
  */
51
61
  function useOvokRequest(load, enabled = true) {
52
62
  const { data, dataUpdatedAt, loading, isRefreshing, isStale, error, reload, } = useOvokRequestWithUpdater(load, enabled);
@@ -128,7 +138,19 @@ function useOvokClientRequest(request, inputs, enabled = true) {
128
138
  function useOvokClientRequestFor(name, id, request) {
129
139
  return useOvokClientRequest((client, signal) => (id ? request(client, id, signal) : Promise.reject(new Error(`${name} is required`))), id, id !== undefined);
130
140
  }
131
- /** Generic mutation hook for any typed OvokClient method. */
141
+ /**
142
+ * Wraps any `OvokClient` call in mutation state; nothing runs until `mutate` is called.
143
+ *
144
+ * @param mutateRequest - Call to run with the client and the `mutate` params.
145
+ *
146
+ * @example
147
+ * ```tsx
148
+ * const { mutate, loading, error } = useOvokMutation(
149
+ * (client, accepted: boolean) => client.setLegalConsent(accepted),
150
+ * );
151
+ * await mutate(true);
152
+ * ```
153
+ */
132
154
  function useOvokMutation(mutateRequest) {
133
155
  const client = (0, index_1.useClient)();
134
156
  const [data, setData] = React.useState();
@@ -158,19 +180,49 @@ function useOvokMutation(mutateRequest) {
158
180
  }, []);
159
181
  return { data, loading, error, mutate, reset };
160
182
  }
183
+ /**
184
+ * Loads the server's capability statement for a FHIR version via `client.getCapabilityStatement`.
185
+ *
186
+ * @param version - FHIR version; defaults to `R4`.
187
+ */
161
188
  const useCapabilityStatement = (version = "R4") => useOvokClientRequest((client, signal) => client.getCapabilityStatement(version, { signal }), version);
162
189
  exports.useCapabilityStatement = useCapabilityStatement;
190
+ /**
191
+ * Loads the public API routes listed in the capability statement via `client.getPublicApiEndpoints`.
192
+ *
193
+ * @param version - FHIR version; defaults to `R4`.
194
+ */
163
195
  const usePublicApiEndpoints = (version = "R4") => useOvokClientRequest((client, signal) => client.getPublicApiEndpoints(version, { signal }), version);
164
196
  exports.usePublicApiEndpoints = usePublicApiEndpoints;
197
+ /**
198
+ * Loads the projects the user administers via `client.listAdministeredProjects`.
199
+ *
200
+ * @param params - Page number and page size.
201
+ */
165
202
  const useAdministeredProjects = (params = {}) => useOvokClientRequest((client, signal) => client.listAdministeredProjects(params, { signal }), params);
166
203
  exports.useAdministeredProjects = useAdministeredProjects;
204
+ /**
205
+ * Loads the project's settings via `client.getProjectSettings`.
206
+ */
167
207
  const useProjectSettings = () => useOvokClientRequest((client, signal) => client.getProjectSettings({ signal }));
168
208
  exports.useProjectSettings = useProjectSettings;
209
+ /**
210
+ * Loads the project's feature flags via `client.getProjectFeatures`.
211
+ */
169
212
  const useProjectFeatures = () => useOvokClientRequest((client, signal) => client.getProjectFeatures({ signal }));
170
213
  exports.useProjectFeatures = useProjectFeatures;
214
+ /**
215
+ * Loads a page of Slim patients via `client.listSlimPatients`, reloading when `params` change.
216
+ */
171
217
  const useSlimPatients = (params = {}) => useOvokClientRequest((client, signal) => client.listSlimPatients(params, { signal }), params);
172
218
  exports.useSlimPatients = useSlimPatients;
219
+ /**
220
+ * Loads a page of Slim devices via `client.listSlimDevices`, reloading when `params` change.
221
+ */
173
222
  const useSlimDevices = (params = {}) => useOvokClientRequest((client, signal) => client.listSlimDevices(params, { signal }), params);
174
223
  exports.useSlimDevices = useSlimDevices;
224
+ /**
225
+ * Loads a Slim device's telemetry via `client.getSlimDeviceTelemetry`; skips while `deviceId` is undefined and fails with "deviceId is required" when it is empty.
226
+ */
175
227
  const useSlimDeviceTelemetry = (deviceId) => useOvokClientRequestFor("deviceId", deviceId, (client, id, signal) => client.getSlimDeviceTelemetry(id, { signal }));
176
228
  exports.useSlimDeviceTelemetry = useSlimDeviceTelemetry;
@@ -5,11 +5,17 @@ import { OvokRequestState } from "./api-hooks";
5
5
  * language. Waits while `slug` is empty; a new CMS locale reads it again.
6
6
  */
7
7
  export declare const useCmsDocument: <T extends object = OvokCmsDocument>(collection: string, slug: string | undefined, options?: OvokCmsOptions) => OvokRequestState<T>;
8
- /** A page of a CMS collection, in `options.locale` or else the runtime's language. */
8
+ /**
9
+ * A page of a CMS collection, in `options.locale` or else the runtime's language.
10
+ */
9
11
  export declare const useCmsDocuments: <T extends object = OvokCmsDocument>(collection: string, options?: OvokCmsListOptions) => OvokRequestState<OvokCmsPage<T>>;
10
- /** A legal page by slug; with `tenantCode`, readable before sign-in. */
12
+ /**
13
+ * A legal page by slug; with `tenantCode`, readable before sign-in.
14
+ */
11
15
  export declare const useLegalPage: (slug: string | undefined, options?: OvokCmsOptions) => OvokRequestState<OvokCmsDocument>;
12
- /** Release notes, newest first unless `sort` says otherwise. Needs a session. */
16
+ /**
17
+ * Release notes, newest first unless `sort` says otherwise. Needs a session.
18
+ */
13
19
  export declare const useReleaseNotes: (options?: OvokCmsListOptions) => OvokRequestState<OvokCmsPage>;
14
20
  /**
15
21
  * The `translations` collection as one tree, in `options.locale` or else the
@@ -50,17 +50,23 @@ const useCmsDocument = (collection, slug, options = {}) => {
50
50
  return (0, api_hooks_1.useOvokClientRequest)((client, signal) => client.getCmsDocument(collection, slug, { locale, tenantCode, environment, allowSignedOut }, { signal }), [collection, slug, locale, tenantCode, environment, allowSignedOut], Boolean(slug));
51
51
  };
52
52
  exports.useCmsDocument = useCmsDocument;
53
- /** A page of a CMS collection, in `options.locale` or else the runtime's language. */
53
+ /**
54
+ * A page of a CMS collection, in `options.locale` or else the runtime's language.
55
+ */
54
56
  const useCmsDocuments = (collection, options = {}) => {
55
57
  const { tenantCode, environment, allowSignedOut, page, limit, sort } = options;
56
58
  const locale = useCmsLocale(options.locale);
57
59
  return (0, api_hooks_1.useOvokClientRequest)((client, signal) => client.listCmsDocuments(collection, { locale, tenantCode, environment, allowSignedOut, page, limit, sort }, { signal }), [collection, locale, tenantCode, environment, allowSignedOut, page, limit, sort]);
58
60
  };
59
61
  exports.useCmsDocuments = useCmsDocuments;
60
- /** A legal page by slug; with `tenantCode`, readable before sign-in. */
62
+ /**
63
+ * A legal page by slug; with `tenantCode`, readable before sign-in.
64
+ */
61
65
  const useLegalPage = (slug, options = {}) => { var _a; return (0, exports.useCmsDocument)("legal-pages", slug, { ...options, allowSignedOut: (_a = options.allowSignedOut) !== null && _a !== void 0 ? _a : true }); };
62
66
  exports.useLegalPage = useLegalPage;
63
- /** Release notes, newest first unless `sort` says otherwise. Needs a session. */
67
+ /**
68
+ * Release notes, newest first unless `sort` says otherwise. Needs a session.
69
+ */
64
70
  const useReleaseNotes = (options = {}) => { var _a; return (0, exports.useCmsDocuments)("release-notes", { ...options, sort: (_a = options.sort) !== null && _a !== void 0 ? _a : "-publishedAt" }); };
65
71
  exports.useReleaseNotes = useReleaseNotes;
66
72
  /**
@@ -1,3 +1,6 @@
1
1
  import { OvokEmailTemplates } from "../client/email";
2
2
  import { OvokRequestState } from "./api-hooks";
3
+ /**
4
+ * Loads the project's email templates via `client.getEmailTemplates`.
5
+ */
3
6
  export declare const useEmailTemplates: () => OvokRequestState<OvokEmailTemplates>;
@@ -3,5 +3,8 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.useEmailTemplates = void 0;
5
5
  const api_hooks_1 = require("./api-hooks");
6
+ /**
7
+ * Loads the project's email templates via `client.getEmailTemplates`.
8
+ */
6
9
  const useEmailTemplates = () => (0, api_hooks_1.useOvokClientRequest)((client, signal) => client.getEmailTemplates({ signal }));
7
10
  exports.useEmailTemplates = useEmailTemplates;
@@ -1,13 +1,39 @@
1
1
  import { OvokConsentSignatureResponse, OvokContentQuery, OvokContentSearchResponse, OvokDocumentSearchQuery, OvokDocumentSearchResponse, OvokVideoCallAccess, OvokVideoCallAppointment, OvokVideoCallAppointmentInput, OvokVideoCallAppointmentQuery } from "../client/experience/types";
2
2
  import { OvokMutationState, OvokRequestState } from "./api-hooks";
3
+ /**
4
+ * Mutation that requests a consent's signed PDF via `client.requestConsentSignature`.
5
+ */
3
6
  export declare const useConsentSignature: () => OvokMutationState<{
7
+ /** Id of the Consent resource to sign. */
4
8
  consentId: string;
5
9
  }, OvokConsentSignatureResponse>;
10
+ /**
11
+ * Searches documents via `client.listDocuments`, reloading when `params` change.
12
+ */
6
13
  export declare const useDocuments: (params?: OvokDocumentSearchQuery) => OvokRequestState<OvokDocumentSearchResponse>;
14
+ /**
15
+ * Searches CMS content via `client.searchContent`; skips while `type` or `language` is empty.
16
+ *
17
+ * @param type - Content type.
18
+ * @param language - Language code.
19
+ */
7
20
  export declare const useContent: (type: string, language: string, params?: OvokContentQuery) => OvokRequestState<OvokContentSearchResponse>;
21
+ /**
22
+ * Lists video-call appointments via `client.listVideoCallAppointments`, reloading when `params` change.
23
+ */
8
24
  export declare const useVideoCallAppointments: (params?: OvokVideoCallAppointmentQuery) => OvokRequestState<OvokVideoCallAppointment[]>;
25
+ /**
26
+ * Checks the user's permission to join a video call via `client.getVideoCallAccessPermission`; skips while `appointmentId` is undefined and fails with "appointmentId is required" when it is empty.
27
+ */
9
28
  export declare const useVideoCallAccess: (appointmentId?: string) => OvokRequestState<Record<string, unknown>>;
29
+ /**
30
+ * Mutation that creates a video-call appointment via `client.createVideoCallAppointment`.
31
+ */
10
32
  export declare const useCreateVideoCallAppointment: () => OvokMutationState<OvokVideoCallAppointmentInput, OvokVideoCallAppointment>;
33
+ /**
34
+ * Mutation that creates the signed-in user's access to a video call via `client.createVideoCallUserAccess`.
35
+ */
11
36
  export declare const useCreateVideoCallUserAccess: () => OvokMutationState<{
37
+ /** Id of the appointment to join. */
12
38
  appointmentId: string;
13
39
  }, OvokVideoCallAccess>;
@@ -3,17 +3,41 @@
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.useCreateVideoCallUserAccess = exports.useCreateVideoCallAppointment = exports.useVideoCallAccess = exports.useVideoCallAppointments = exports.useContent = exports.useDocuments = exports.useConsentSignature = void 0;
5
5
  const api_hooks_1 = require("./api-hooks");
6
+ /**
7
+ * Mutation that requests a consent's signed PDF via `client.requestConsentSignature`.
8
+ */
6
9
  const useConsentSignature = () => (0, api_hooks_1.useOvokMutation)((client, params) => client.requestConsentSignature(params.consentId));
7
10
  exports.useConsentSignature = useConsentSignature;
11
+ /**
12
+ * Searches documents via `client.listDocuments`, reloading when `params` change.
13
+ */
8
14
  const useDocuments = (params = {}) => (0, api_hooks_1.useOvokClientRequest)((client, signal) => client.listDocuments(params, { signal }), params);
9
15
  exports.useDocuments = useDocuments;
16
+ /**
17
+ * Searches CMS content via `client.searchContent`; skips while `type` or `language` is empty.
18
+ *
19
+ * @param type - Content type.
20
+ * @param language - Language code.
21
+ */
10
22
  const useContent = (type, language, params = {}) => (0, api_hooks_1.useOvokClientRequest)((client, signal) => client.searchContent(type, language, params, { signal }), [language, params, type], type.length > 0 && language.length > 0);
11
23
  exports.useContent = useContent;
24
+ /**
25
+ * Lists video-call appointments via `client.listVideoCallAppointments`, reloading when `params` change.
26
+ */
12
27
  const useVideoCallAppointments = (params = {}) => (0, api_hooks_1.useOvokClientRequest)((client, signal) => client.listVideoCallAppointments(params, { signal }), params);
13
28
  exports.useVideoCallAppointments = useVideoCallAppointments;
29
+ /**
30
+ * Checks the user's permission to join a video call via `client.getVideoCallAccessPermission`; skips while `appointmentId` is undefined and fails with "appointmentId is required" when it is empty.
31
+ */
14
32
  const useVideoCallAccess = (appointmentId) => (0, api_hooks_1.useOvokClientRequestFor)("appointmentId", appointmentId, (client, id, signal) => client.getVideoCallAccessPermission(id, { signal }));
15
33
  exports.useVideoCallAccess = useVideoCallAccess;
34
+ /**
35
+ * Mutation that creates a video-call appointment via `client.createVideoCallAppointment`.
36
+ */
16
37
  const useCreateVideoCallAppointment = () => (0, api_hooks_1.useOvokMutation)((client, params) => client.createVideoCallAppointment(params));
17
38
  exports.useCreateVideoCallAppointment = useCreateVideoCallAppointment;
39
+ /**
40
+ * Mutation that creates the signed-in user's access to a video call via `client.createVideoCallUserAccess`.
41
+ */
18
42
  const useCreateVideoCallUserAccess = () => (0, api_hooks_1.useOvokMutation)((client, params) => client.createVideoCallUserAccess(params.appointmentId));
19
43
  exports.useCreateVideoCallUserAccess = useCreateVideoCallUserAccess;
@@ -1,7 +1,25 @@
1
1
  import * as React from "react";
2
2
  import { OvokClient } from "../client/ovok-client";
3
3
  export { useMedplumContext, useMedplumNavigate, useMedplumProfile, usePrevious, useResource, useSearch, useSearchOne, useSearchResources, useSubscription, reactContext, useCachedBinaryUrl, } from "@medplum/react-hooks";
4
+ /**
5
+ * Returns the `OvokClient` of the nearest `OvokProvider`.
6
+ *
7
+ * @example
8
+ * ```tsx
9
+ * const client = useClient();
10
+ * await client.logout();
11
+ * ```
12
+ */
4
13
  export declare const useClient: () => OvokClient;
14
+ /**
15
+ * Makes an `OvokClient` available to the hooks below it.
16
+ *
17
+ * @example
18
+ * ```tsx
19
+ * const client = new OvokClient({ baseUrl: "https://api.ovok.com/" });
20
+ * <OvokProvider client={client}><App /></OvokProvider>
21
+ * ```
22
+ */
5
23
  export declare const OvokProvider: (props: React.PropsWithChildren<{
6
24
  client: OvokClient;
7
25
  }>) => React.JSX.Element;
@@ -64,10 +64,28 @@ Object.defineProperty(exports, "useSearchResources", { enumerable: true, get: fu
64
64
  Object.defineProperty(exports, "useSubscription", { enumerable: true, get: function () { return react_hooks_2.useSubscription; } });
65
65
  Object.defineProperty(exports, "reactContext", { enumerable: true, get: function () { return react_hooks_2.reactContext; } });
66
66
  Object.defineProperty(exports, "useCachedBinaryUrl", { enumerable: true, get: function () { return react_hooks_2.useCachedBinaryUrl; } });
67
+ /**
68
+ * Returns the `OvokClient` of the nearest `OvokProvider`.
69
+ *
70
+ * @example
71
+ * ```tsx
72
+ * const client = useClient();
73
+ * await client.logout();
74
+ * ```
75
+ */
67
76
  const useClient = () => {
68
77
  return (0, react_hooks_1.useMedplum)();
69
78
  };
70
79
  exports.useClient = useClient;
80
+ /**
81
+ * Makes an `OvokClient` available to the hooks below it.
82
+ *
83
+ * @example
84
+ * ```tsx
85
+ * const client = new OvokClient({ baseUrl: "https://api.ovok.com/" });
86
+ * <OvokProvider client={client}><App /></OvokProvider>
87
+ * ```
88
+ */
71
89
  const OvokProvider = (props) => {
72
90
  return (React.createElement(react_hooks_1.MedplumProvider, { medplum: props.client }, props.children));
73
91
  };
@@ -1,11 +1,30 @@
1
1
  import { AcceptInviteBody, AcceptInviteResult, AcceptRecordShareBody, InviteBody, InviteSent, RecordShareAccepted, RecordShareBody } from "../client/invites";
2
2
  import { OvokMutationState } from "./api-hooks";
3
+ /**
4
+ * Mutation that shares the patient's record with a practitioner or carer via `client.shareRecord`.
5
+ */
3
6
  export declare const useShareRecord: () => OvokMutationState<RecordShareBody, InviteSent>;
7
+ /**
8
+ * Mutation that lets a practitioner invite a patient into their care via `client.inviteToCare`.
9
+ */
4
10
  export declare const useInviteToCare: () => OvokMutationState<InviteBody, InviteSent>;
11
+ /**
12
+ * Mutation that accepts a record share via `client.acceptRecordShare`, then notifies patient-sharing listeners.
13
+ */
5
14
  export declare const useAcceptRecordShare: () => OvokMutationState<AcceptRecordShareBody, RecordShareAccepted>;
15
+ /**
16
+ * Mutation that lets the signed-in patient accept a care invite via `client.acceptCareInvite`, then notifies patient-sharing listeners.
17
+ */
6
18
  export declare const useAcceptCareInvite: () => OvokMutationState<AcceptInviteBody, AcceptInviteResult>;
7
- /** @deprecated Use useShareRecord with `recipient: "practitioner"`; the route sunsets on 2026-12-01. */
19
+ /**
20
+ * @deprecated Use useShareRecord with `recipient: "practitioner"`; the route sunsets on 2026-12-01.
21
+ */
8
22
  export declare const useInvitePractitioner: () => OvokMutationState<InviteBody, InviteSent>;
9
- /** @deprecated Use useInviteToCare; the route sunsets on 2026-12-01. */
23
+ /**
24
+ * @deprecated Use useInviteToCare; the route sunsets on 2026-12-01.
25
+ */
10
26
  export declare const useInvitePatient: () => OvokMutationState<InviteBody, InviteSent>;
27
+ /**
28
+ * Mutation that accepts a record share or care invite as the signed-in user via `client.acceptInvite`, then notifies patient-sharing listeners.
29
+ */
11
30
  export declare const useAcceptInvite: () => OvokMutationState<AcceptInviteBody, AcceptInviteResult>;
@@ -4,28 +4,47 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.useAcceptInvite = exports.useInvitePatient = exports.useInvitePractitioner = exports.useAcceptCareInvite = exports.useAcceptRecordShare = exports.useInviteToCare = exports.useShareRecord = void 0;
5
5
  const api_hooks_1 = require("./api-hooks");
6
6
  const notification_invalidation_1 = require("./notification-invalidation");
7
+ /**
8
+ * Mutation that shares the patient's record with a practitioner or carer via `client.shareRecord`.
9
+ */
7
10
  const useShareRecord = () => (0, api_hooks_1.useOvokMutation)((client, body) => client.shareRecord(body));
8
11
  exports.useShareRecord = useShareRecord;
12
+ /**
13
+ * Mutation that lets a practitioner invite a patient into their care via `client.inviteToCare`.
14
+ */
9
15
  const useInviteToCare = () => (0, api_hooks_1.useOvokMutation)((client, body) => client.inviteToCare(body));
10
16
  exports.useInviteToCare = useInviteToCare;
17
+ /**
18
+ * Mutation that accepts a record share via `client.acceptRecordShare`, then notifies patient-sharing listeners.
19
+ */
11
20
  const useAcceptRecordShare = () => (0, api_hooks_1.useOvokMutation)(async (client, body) => {
12
21
  const result = await client.acceptRecordShare(body);
13
22
  (0, notification_invalidation_1.notifyNotificationChanges)(client, { type: "patient-sharing" });
14
23
  return result;
15
24
  });
16
25
  exports.useAcceptRecordShare = useAcceptRecordShare;
26
+ /**
27
+ * Mutation that lets the signed-in patient accept a care invite via `client.acceptCareInvite`, then notifies patient-sharing listeners.
28
+ */
17
29
  const useAcceptCareInvite = () => (0, api_hooks_1.useOvokMutation)(async (client, body) => {
18
30
  const result = await client.acceptCareInvite(body);
19
31
  (0, notification_invalidation_1.notifyNotificationChanges)(client, { type: "patient-sharing" });
20
32
  return result;
21
33
  });
22
34
  exports.useAcceptCareInvite = useAcceptCareInvite;
23
- /** @deprecated Use useShareRecord with `recipient: "practitioner"`; the route sunsets on 2026-12-01. */
35
+ /**
36
+ * @deprecated Use useShareRecord with `recipient: "practitioner"`; the route sunsets on 2026-12-01.
37
+ */
24
38
  const useInvitePractitioner = () => (0, api_hooks_1.useOvokMutation)((client, body) => client.invitePractitioner(body));
25
39
  exports.useInvitePractitioner = useInvitePractitioner;
26
- /** @deprecated Use useInviteToCare; the route sunsets on 2026-12-01. */
40
+ /**
41
+ * @deprecated Use useInviteToCare; the route sunsets on 2026-12-01.
42
+ */
27
43
  const useInvitePatient = () => (0, api_hooks_1.useOvokMutation)((client, body) => client.invitePatient(body));
28
44
  exports.useInvitePatient = useInvitePatient;
45
+ /**
46
+ * Mutation that accepts a record share or care invite as the signed-in user via `client.acceptInvite`, then notifies patient-sharing listeners.
47
+ */
29
48
  const useAcceptInvite = () => (0, api_hooks_1.useOvokMutation)(async (client, body) => {
30
49
  const result = await client.acceptInvite(body);
31
50
  (0, notification_invalidation_1.notifyNotificationChanges)(client, { type: "patient-sharing" });
@@ -1,7 +1,11 @@
1
1
  import { SlimMedicalNotificationRow } from "../client/notifications/types";
2
2
  import { SlimNotification } from "../client/slim/types";
3
3
  import { OvokMutationState } from "./api-hooks";
4
- /** Acknowledges one Slim alarm and updates matching mounted rows using the same client. */
4
+ /**
5
+ * Acknowledges one Slim alarm and updates matching mounted rows using the same client.
6
+ */
5
7
  export declare const useAcknowledgeSlimAlarm: () => OvokMutationState<string, SlimNotification>;
6
- /** Acknowledges one medical notification and updates matching mounted rows using the same client. */
8
+ /**
9
+ * Acknowledges one medical notification and updates matching mounted rows using the same client.
10
+ */
7
11
  export declare const useAcknowledgeSlimMedicalNotification: () => OvokMutationState<string, SlimMedicalNotificationRow>;
@@ -4,14 +4,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.useAcknowledgeSlimMedicalNotification = exports.useAcknowledgeSlimAlarm = void 0;
5
5
  const api_hooks_1 = require("./api-hooks");
6
6
  const notification_invalidation_1 = require("./notification-invalidation");
7
- /** Acknowledges one Slim alarm and updates matching mounted rows using the same client. */
7
+ /**
8
+ * Acknowledges one Slim alarm and updates matching mounted rows using the same client.
9
+ */
8
10
  const useAcknowledgeSlimAlarm = () => (0, api_hooks_1.useOvokMutation)(async (client, notificationId) => {
9
11
  const result = await client.acknowledgeSlimAlarm(notificationId);
10
12
  (0, notification_invalidation_1.notifyNotificationChanges)(client, { type: "slim", notification: result });
11
13
  return result;
12
14
  });
13
15
  exports.useAcknowledgeSlimAlarm = useAcknowledgeSlimAlarm;
14
- /** Acknowledges one medical notification and updates matching mounted rows using the same client. */
16
+ /**
17
+ * Acknowledges one medical notification and updates matching mounted rows using the same client.
18
+ */
15
19
  const useAcknowledgeSlimMedicalNotification = () => (0, api_hooks_1.useOvokMutation)(async (client, episodeId) => {
16
20
  const result = await client.acknowledgeSlimMedicalNotification(episodeId);
17
21
  (0, notification_invalidation_1.notifyNotificationChanges)(client, { type: "slim", notification: result });
@@ -1,15 +1,39 @@
1
1
  import { SlimAlarmQuery, SlimAlarmsPage, SlimMedicalNotificationsQuery, SlimMedicalNotificationsCollection, SlimRecentAlarms, SlimRecentOutOfBed } from "../client/notifications";
2
2
  import { SlimNotificationsQuery, SlimNotificationsResponse, SlimRecentNotificationsResponse } from "../client/slim/types";
3
3
  import { OvokRequestState } from "./api-hooks";
4
- /** @deprecated Use useSlimOutOfBedNotifications, useSlimAlarms, or useSlimMedicalNotifications. */
4
+ /**
5
+ * @deprecated Use useSlimOutOfBedNotifications, useSlimAlarms, or useSlimMedicalNotifications.
6
+ */
5
7
  export declare const useSlimNotifications: (params?: SlimNotificationsQuery) => OvokRequestState<SlimNotificationsResponse>;
8
+ /**
9
+ * Loads the latest Slim notifications via `client.getRecentSlimNotifications`, kept current by notification changes.
10
+ *
11
+ * @param count - Number of notifications to load; the server's default when omitted.
12
+ */
6
13
  export declare const useRecentSlimNotifications: (count?: number) => OvokRequestState<SlimRecentNotificationsResponse>;
14
+ /**
15
+ * Loads a page of Slim alarms via `client.listSlimAlarms`, kept current by notification changes.
16
+ */
7
17
  export declare const useSlimAlarms: (params?: SlimAlarmQuery) => OvokRequestState<SlimAlarmsPage>;
18
+ /**
19
+ * Loads the latest alarms via `client.getRecentAlarms`, kept current by notification changes.
20
+ *
21
+ * @param count - Number of alarms to load; the server's default when omitted.
22
+ */
8
23
  export declare const useRecentAlarms: (count?: number) => OvokRequestState<SlimRecentAlarms>;
24
+ /**
25
+ * Loads the latest out-of-bed notifications via `client.getRecentOutOfBed`, kept current by notification changes.
26
+ *
27
+ * @param count - Number of notifications to load; the server's default when omitted.
28
+ */
9
29
  export declare const useRecentOutOfBed: (count?: number) => OvokRequestState<SlimRecentOutOfBed>;
10
- /** Without status, loads new and reviewed rows together; active is new, completed reviewed, and revoked hand-closed. */
30
+ /**
31
+ * Without status, loads new and reviewed rows together; active is new, completed reviewed, and revoked hand-closed.
32
+ */
11
33
  export declare const useSlimOutOfBedNotifications: (params?: Omit<SlimNotificationsQuery, "type">) => OvokRequestState<SlimNotificationsResponse>;
12
- /** Fetches every cursor page; a short page is not treated as the end of the feed. */
34
+ /**
35
+ * Fetches every cursor page; a short page is not treated as the end of the feed.
36
+ */
13
37
  export declare const useSlimMedicalNotifications: (params?: Omit<SlimMedicalNotificationsQuery, "cursor">, options?: {
14
38
  maxPages?: number;
15
39
  }) => OvokRequestState<SlimMedicalNotificationsCollection>;
@@ -53,11 +53,21 @@ function useSlimNotificationFeed(request, inputs, field) {
53
53
  (0, notification_invalidation_1.useSlimNotificationSync)(client, state.reload, updateData, field);
54
54
  return state;
55
55
  }
56
- /** @deprecated Use useSlimOutOfBedNotifications, useSlimAlarms, or useSlimMedicalNotifications. */
56
+ /**
57
+ * @deprecated Use useSlimOutOfBedNotifications, useSlimAlarms, or useSlimMedicalNotifications.
58
+ */
57
59
  const useSlimNotifications = (params = {}) => useSlimNotificationFeed((client, signal) => client.listSlimNotifications(params, { signal }), params, "resources");
58
60
  exports.useSlimNotifications = useSlimNotifications;
61
+ /**
62
+ * Loads the latest Slim notifications via `client.getRecentSlimNotifications`, kept current by notification changes.
63
+ *
64
+ * @param count - Number of notifications to load; the server's default when omitted.
65
+ */
59
66
  const useRecentSlimNotifications = (count) => useSlimNotificationFeed((client, signal) => client.getRecentSlimNotifications(count, { signal }), count, "recent");
60
67
  exports.useRecentSlimNotifications = useRecentSlimNotifications;
68
+ /**
69
+ * Loads a page of Slim alarms via `client.listSlimAlarms`, kept current by notification changes.
70
+ */
61
71
  const useSlimAlarms = (params = {}) => {
62
72
  const client = (0, index_1.useClient)();
63
73
  const serialized = JSON.stringify(params);
@@ -69,14 +79,28 @@ const useSlimAlarms = (params = {}) => {
69
79
  return { ...state, reload };
70
80
  };
71
81
  exports.useSlimAlarms = useSlimAlarms;
82
+ /**
83
+ * Loads the latest alarms via `client.getRecentAlarms`, kept current by notification changes.
84
+ *
85
+ * @param count - Number of alarms to load; the server's default when omitted.
86
+ */
72
87
  const useRecentAlarms = (count) => useSlimNotificationFeed((client, signal) => client.getRecentAlarms(count, { signal }), count, "recent");
73
88
  exports.useRecentAlarms = useRecentAlarms;
89
+ /**
90
+ * Loads the latest out-of-bed notifications via `client.getRecentOutOfBed`, kept current by notification changes.
91
+ *
92
+ * @param count - Number of notifications to load; the server's default when omitted.
93
+ */
74
94
  const useRecentOutOfBed = (count) => useSlimNotificationFeed((client, signal) => client.getRecentOutOfBed(count, { signal }), count, "recent");
75
95
  exports.useRecentOutOfBed = useRecentOutOfBed;
76
- /** Without status, loads new and reviewed rows together; active is new, completed reviewed, and revoked hand-closed. */
96
+ /**
97
+ * Without status, loads new and reviewed rows together; active is new, completed reviewed, and revoked hand-closed.
98
+ */
77
99
  const useSlimOutOfBedNotifications = (params = {}) => useSlimNotificationFeed((client, signal) => client.listSlimOutOfBedNotifications(params, { signal }), params, "resources");
78
100
  exports.useSlimOutOfBedNotifications = useSlimOutOfBedNotifications;
79
- /** Fetches every cursor page; a short page is not treated as the end of the feed. */
101
+ /**
102
+ * Fetches every cursor page; a short page is not treated as the end of the feed.
103
+ */
80
104
  const useSlimMedicalNotifications = (params = {}, options = {}) => useSlimNotificationFeed(async (client, signal) => {
81
105
  const result = await (0, paging_1.iterateCursor)((cursor) => client.listSlimMedicalNotifications({ ...params, cursor }, { signal }), options);
82
106
  return { items: result.rows, nextCursor: null, total: result.total, truncated: result.truncated };