@openmrs/esm-framework 6.3.1-pre.3104 → 6.3.1-pre.3106

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 (542) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/dist/openmrs-esm-framework.js +2 -2
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/.nojekyll +1 -0
  5. package/docs/API.md +8579 -310
  6. package/docs/classes/OpenmrsFetchError.md +117 -88
  7. package/docs/enums/Type.md +107 -0
  8. package/docs/enums/VisitMode.md +41 -0
  9. package/docs/enums/VisitStatus.md +30 -0
  10. package/docs/interfaces/ActionMenuButtonProps.md +57 -33
  11. package/docs/interfaces/ActionableNotificationDescriptor.md +67 -37
  12. package/docs/interfaces/AssignedExtension.md +57 -30
  13. package/docs/interfaces/Attachment.md +47 -23
  14. package/docs/interfaces/AttachmentResponse.md +41 -20
  15. package/docs/interfaces/AuditInfo.md +88 -49
  16. package/docs/interfaces/BreadcrumbRegistration.md +17 -8
  17. package/docs/interfaces/BreadcrumbSettings.md +33 -18
  18. package/docs/interfaces/CancelLoading.md +10 -6
  19. package/docs/interfaces/ClearDynamicRoutesMessage.md +17 -9
  20. package/docs/interfaces/CloseWorkspaceOptions.md +29 -18
  21. package/docs/interfaces/ComponentConfig.md +23 -11
  22. package/docs/interfaces/Concept.md +131 -83
  23. package/docs/interfaces/ConceptClass.md +67 -46
  24. package/docs/interfaces/ConceptDatatype.md +74 -50
  25. package/docs/interfaces/ConceptName.md +74 -50
  26. package/docs/interfaces/Config.md +2 -4
  27. package/docs/interfaces/ConfigObject.md +21 -12
  28. package/docs/interfaces/ConfigSchema.md +27 -15
  29. package/docs/interfaces/ConfigurableLinkProps.md +4314 -24
  30. package/docs/interfaces/ConnectedExtension.md +41 -25
  31. package/docs/interfaces/ConnectivityChangedEvent.md +10 -4
  32. package/docs/interfaces/CurrentPatientOptions.md +18 -9
  33. package/docs/interfaces/DashboardExtensionProps.md +28 -13
  34. package/docs/interfaces/DefaultWorkspaceProps.md +51 -44
  35. package/docs/interfaces/Diagnosis.md +104 -80
  36. package/docs/interfaces/DisplayConditionsConfigObject.md +33 -18
  37. package/docs/interfaces/DynamicOfflineData.md +41 -23
  38. package/docs/interfaces/DynamicOfflineDataHandler.md +54 -47
  39. package/docs/interfaces/DynamicOfflineDataSyncState.md +39 -29
  40. package/docs/interfaces/EmrApiConfigurationResponse.md +350 -243
  41. package/docs/interfaces/Encounter.md +110 -67
  42. package/docs/interfaces/EncounterProvider.md +61 -39
  43. package/docs/interfaces/EncounterRole.md +68 -43
  44. package/docs/interfaces/EncounterType.md +68 -43
  45. package/docs/interfaces/ErrorStateProps.md +16 -7
  46. package/docs/interfaces/ExtensionData.md +22 -10
  47. package/docs/interfaces/ExtensionMeta.md +2 -4
  48. package/docs/interfaces/ExtensionRegistration.md +69 -36
  49. package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
  50. package/docs/interfaces/ExtensionSlotConfig.md +32 -17
  51. package/docs/interfaces/ExtensionSlotConfigObject.md +26 -14
  52. package/docs/interfaces/ExtensionSlotConfigureValueObject.md +2 -4
  53. package/docs/interfaces/ExtensionSlotState.md +18 -9
  54. package/docs/interfaces/ExtensionStore.md +11 -5
  55. package/docs/interfaces/FHIRCode.md +23 -11
  56. package/docs/interfaces/FHIRLocationResource.md +18 -25
  57. package/docs/interfaces/FHIRResource.md +41 -105
  58. package/docs/interfaces/FeatureFlagDefinition.md +26 -14
  59. package/docs/interfaces/FetchConfig.md +117 -80
  60. package/docs/interfaces/FetchError.md +21 -8
  61. package/docs/interfaces/FetchHeaders.md +2 -4
  62. package/docs/interfaces/FetchResponse.md +130 -124
  63. package/docs/interfaces/FetchResponseJson.md +2 -4
  64. package/docs/interfaces/ImportMap.md +10 -4
  65. package/docs/interfaces/LeftNavStore.md +29 -14
  66. package/docs/interfaces/Link.md +23 -11
  67. package/docs/interfaces/Location.md +250 -147
  68. package/docs/interfaces/LoggedInUser.md +70 -68
  69. package/docs/interfaces/LoggedInUserFetchResponse.md +128 -120
  70. package/docs/interfaces/MessageServiceWorkerResult.md +29 -17
  71. package/docs/interfaces/NavigateOptions.md +18 -9
  72. package/docs/interfaces/NewVisitPayload.md +48 -32
  73. package/docs/interfaces/NotificationDescriptor.md +58 -31
  74. package/docs/interfaces/Obs.md +166 -99
  75. package/docs/interfaces/OfflineModeResult.md +23 -11
  76. package/docs/interfaces/OfflinePatientArgs.md +20 -13
  77. package/docs/interfaces/OfflinePatientDataSyncHandler.md +27 -17
  78. package/docs/interfaces/OfflinePatientDataSyncState.md +51 -29
  79. package/docs/interfaces/OfflinePatientDataSyncStore.md +20 -13
  80. package/docs/interfaces/OldExtensionSlotBaseProps.md +67 -0
  81. package/docs/interfaces/OmrsServiceWorkerMessage.md +23 -13
  82. package/docs/interfaces/OnImportMapChangedMessage.md +23 -12
  83. package/docs/interfaces/OnlyThePatient.md +17 -9
  84. package/docs/interfaces/OpenWorkspace.md +170 -116
  85. package/docs/interfaces/OpenmrsAppContextProps.md +23 -14
  86. package/docs/interfaces/OpenmrsAppRoutes.md +71 -41
  87. package/docs/interfaces/OpenmrsDatePickerProps.md +483 -346
  88. package/docs/interfaces/OpenmrsResource.md +57 -39
  89. package/docs/interfaces/OpenmrsResourceStrict.md +51 -27
  90. package/docs/interfaces/PageHeaderContentProps.md +24 -12
  91. package/docs/interfaces/PageHeaderWrapperProps.md +18 -9
  92. package/docs/interfaces/Patient.md +70 -41
  93. package/docs/interfaces/PatientBannerActionsMenuProps.md +30 -15
  94. package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +32 -17
  95. package/docs/interfaces/PatientIdentifier.md +84 -49
  96. package/docs/interfaces/PatientIdentifierType.md +112 -65
  97. package/docs/interfaces/PatientPhotoProps.md +17 -8
  98. package/docs/interfaces/PatientWithFullResponse.md +17 -9
  99. package/docs/interfaces/Person.md +160 -96
  100. package/docs/interfaces/PersonAddress.md +230 -136
  101. package/docs/interfaces/PersonAttribute.md +68 -43
  102. package/docs/interfaces/PersonName.md +118 -72
  103. package/docs/interfaces/PrecacheStaticDependenciesEvent.md +1 -3
  104. package/docs/interfaces/PrimaryIdentifier.md +11 -5
  105. package/docs/interfaces/Privilege.md +23 -11
  106. package/docs/interfaces/Prompt.md +41 -20
  107. package/docs/interfaces/QueueItemDescriptor.md +30 -23
  108. package/docs/interfaces/RegisterDynamicRouteMessage.md +38 -21
  109. package/docs/interfaces/ResourceLoader.md +14 -10
  110. package/docs/interfaces/ResponsiveWrapperProps.md +11 -5
  111. package/docs/interfaces/RetryOptions.md +37 -36
  112. package/docs/interfaces/Role.md +22 -10
  113. package/docs/interfaces/Session.md +54 -31
  114. package/docs/interfaces/SessionLocation.md +22 -10
  115. package/docs/interfaces/SetLeftNavParams.md +30 -15
  116. package/docs/interfaces/ShowActionableNotificationEvent.md +50 -26
  117. package/docs/interfaces/ShowNotificationEvent.md +38 -20
  118. package/docs/interfaces/ShowSnackbarEvent.md +64 -34
  119. package/docs/interfaces/ShowToastEvent.md +43 -22
  120. package/docs/interfaces/SnackbarDescriptor.md +76 -41
  121. package/docs/interfaces/SnackbarMeta.md +93 -55
  122. package/docs/interfaces/SpaConfig.md +40 -30
  123. package/docs/interfaces/StyleguideConfigObject.md +70 -39
  124. package/docs/interfaces/SyncItem.md +57 -34
  125. package/docs/interfaces/SyncProcessOptions.md +40 -22
  126. package/docs/interfaces/ToastDescriptor.md +55 -29
  127. package/docs/interfaces/ToastNotificationMeta.md +69 -40
  128. package/docs/interfaces/UploadedFile.md +49 -25
  129. package/docs/interfaces/UseConfigOptions.md +12 -6
  130. package/docs/interfaces/UsePatientPhotoResult.md +24 -12
  131. package/docs/interfaces/UseServerFetchAllOptions.md +61 -41
  132. package/docs/interfaces/UseServerInfiniteOptions.md +46 -29
  133. package/docs/interfaces/UseServerPaginationOptions.md +41 -26
  134. package/docs/interfaces/User.md +46 -34
  135. package/docs/interfaces/UserHasAccessProps.md +25 -13
  136. package/docs/interfaces/Visit.md +66 -36
  137. package/docs/interfaces/VisitItem.md +31 -16
  138. package/docs/interfaces/VisitReturnType.md +51 -24
  139. package/docs/interfaces/VisitStoreState.md +26 -14
  140. package/docs/interfaces/VisitType.md +23 -11
  141. package/docs/interfaces/WorkspaceContainerProps.md +38 -20
  142. package/docs/interfaces/WorkspaceGroupDefinition.md +19 -10
  143. package/docs/interfaces/WorkspaceRegistration.md +82 -43
  144. package/docs/interfaces/WorkspacesInfo.md +40 -26
  145. package/package.json +20 -24
  146. package/rspack.config.cjs +8 -1
  147. package/tsconfig.build.json +1 -2
  148. package/typedoc.json +4 -16
  149. package/docs/enumerations/Type.md +0 -77
  150. package/docs/enumerations/VisitMode.md +0 -29
  151. package/docs/enumerations/VisitStatus.md +0 -21
  152. package/docs/functions/ConfigurableLink.md +0 -19
  153. package/docs/functions/CustomOverflowMenu.md +0 -17
  154. package/docs/functions/DashboardExtension.md +0 -17
  155. package/docs/functions/ExtensionSlot.md +0 -46
  156. package/docs/functions/OpenmrsAppContext.md +0 -36
  157. package/docs/functions/PatientBannerActionsMenu.md +0 -17
  158. package/docs/functions/PatientBannerContactDetails.md +0 -17
  159. package/docs/functions/PatientBannerPatientIdentifiers.md +0 -17
  160. package/docs/functions/PatientBannerPatientInfo.md +0 -17
  161. package/docs/functions/PatientBannerToggleContactDetailsButton.md +0 -17
  162. package/docs/functions/PatientPhoto.md +0 -19
  163. package/docs/functions/WorkspaceContainer.md +0 -55
  164. package/docs/functions/age.md +0 -32
  165. package/docs/functions/attach.md +0 -40
  166. package/docs/functions/beginEditSynchronizationItem.md +0 -22
  167. package/docs/functions/canAccessStorage.md +0 -25
  168. package/docs/functions/canBeginEditSynchronizationItemsOfType.md +0 -22
  169. package/docs/functions/clearCurrentUser.md +0 -11
  170. package/docs/functions/closeWorkspace.md +0 -27
  171. package/docs/functions/compile.md +0 -30
  172. package/docs/functions/convertToLocaleCalendar.md +0 -25
  173. package/docs/functions/createAttachment.md +0 -21
  174. package/docs/functions/createErrorHandler.md +0 -21
  175. package/docs/functions/createGlobalStore.md +0 -36
  176. package/docs/functions/createUseStore.md +0 -66
  177. package/docs/functions/defineConfigSchema.md +0 -33
  178. package/docs/functions/defineExtensionConfigSchema.md +0 -38
  179. package/docs/functions/deleteAttachmentPermanently.md +0 -21
  180. package/docs/functions/deleteSynchronizationItem.md +0 -21
  181. package/docs/functions/detach.md +0 -25
  182. package/docs/functions/detachAll.md +0 -21
  183. package/docs/functions/dispatchNotificationShown.md +0 -17
  184. package/docs/functions/dispatchPrecacheStaticDependencies.md +0 -17
  185. package/docs/functions/displayName.md +0 -21
  186. package/docs/functions/evaluate.md +0 -84
  187. package/docs/functions/evaluateAsBoolean.md +0 -31
  188. package/docs/functions/evaluateAsBooleanAsync.md +0 -31
  189. package/docs/functions/evaluateAsNumber.md +0 -31
  190. package/docs/functions/evaluateAsNumberAsync.md +0 -31
  191. package/docs/functions/evaluateAsType.md +0 -46
  192. package/docs/functions/evaluateAsTypeAsync.md +0 -46
  193. package/docs/functions/evaluateAsync.md +0 -87
  194. package/docs/functions/extractVariableNames.md +0 -50
  195. package/docs/functions/fetchCurrentPatient.md +0 -25
  196. package/docs/functions/filterBreadcrumbs.md +0 -21
  197. package/docs/functions/formatDate.md +0 -39
  198. package/docs/functions/formatDatetime.md +0 -29
  199. package/docs/functions/formatPartialDate.md +0 -39
  200. package/docs/functions/formatPatientName.md +0 -23
  201. package/docs/functions/formatTime.md +0 -20
  202. package/docs/functions/formattedName.md +0 -21
  203. package/docs/functions/generateOfflineUuid.md +0 -13
  204. package/docs/functions/getAssignedExtensions.md +0 -23
  205. package/docs/functions/getAsyncLifecycle.md +0 -31
  206. package/docs/functions/getAttachmentByUuid.md +0 -21
  207. package/docs/functions/getAttachments.md +0 -25
  208. package/docs/functions/getBreadcrumbs.md +0 -11
  209. package/docs/functions/getBreadcrumbsFor.md +0 -17
  210. package/docs/functions/getConfig.md +0 -31
  211. package/docs/functions/getContext.md +0 -29
  212. package/docs/functions/getCoreTranslation.md +0 -35
  213. package/docs/functions/getCurrentOfflineMode.md +0 -11
  214. package/docs/functions/getCurrentUser.md +0 -154
  215. package/docs/functions/getDefaultCalendar.md +0 -21
  216. package/docs/functions/getDefaultsFromConfigSchema.md +0 -32
  217. package/docs/functions/getDynamicOfflineDataEntries.md +0 -28
  218. package/docs/functions/getDynamicOfflineDataEntriesFor.md +0 -34
  219. package/docs/functions/getDynamicOfflineDataHandlers.md +0 -13
  220. package/docs/functions/getExtensionNameFromId.md +0 -30
  221. package/docs/functions/getExtensionStore.md +0 -14
  222. package/docs/functions/getFeatureFlag.md +0 -21
  223. package/docs/functions/getFhirServerPaginationHandlers.md +0 -17
  224. package/docs/functions/getFullSynchronizationItems.md +0 -27
  225. package/docs/functions/getFullSynchronizationItemsFor.md +0 -33
  226. package/docs/functions/getGlobalStore.md +0 -36
  227. package/docs/functions/getHistory.md +0 -13
  228. package/docs/functions/getLifecycle.md +0 -27
  229. package/docs/functions/getLocale.md +0 -15
  230. package/docs/functions/getLocations.md +0 -21
  231. package/docs/functions/getLoggedInUser.md +0 -11
  232. package/docs/functions/getOfflinePatientDataStore.md +0 -15
  233. package/docs/functions/getPatientName.md +0 -26
  234. package/docs/functions/getSessionLocation.md +0 -11
  235. package/docs/functions/getSessionStore.md +0 -11
  236. package/docs/functions/getSyncLifecycle.md +0 -31
  237. package/docs/functions/getSynchronizationItem.md +0 -27
  238. package/docs/functions/getSynchronizationItems.md +0 -27
  239. package/docs/functions/getVisitStore.md +0 -11
  240. package/docs/functions/getVisitTypes.md +0 -11
  241. package/docs/functions/getVisitsForPatient.md +0 -29
  242. package/docs/functions/goBackInHistory.md +0 -25
  243. package/docs/functions/importDynamic.md +0 -58
  244. package/docs/functions/inRange.md +0 -27
  245. package/docs/functions/interpolateString.md +0 -34
  246. package/docs/functions/interpolateUrl.md +0 -48
  247. package/docs/functions/isDesktop.md +0 -17
  248. package/docs/functions/isDevEnabled.md +0 -11
  249. package/docs/functions/isOfflineUuid.md +0 -19
  250. package/docs/functions/isOmrsDateStrict.md +0 -20
  251. package/docs/functions/isOmrsDateToday.md +0 -19
  252. package/docs/functions/isOnline.md +0 -17
  253. package/docs/functions/isUrlWithTemplateParameters.md +0 -22
  254. package/docs/functions/isVersionSatisfied.md +0 -21
  255. package/docs/functions/launchWorkspace.md +0 -56
  256. package/docs/functions/launchWorkspaceGroup.md +0 -38
  257. package/docs/functions/makeUrl.md +0 -26
  258. package/docs/functions/messageOmrsServiceWorker.md +0 -23
  259. package/docs/functions/navigate.md +0 -48
  260. package/docs/functions/navigateAndLaunchWorkspace.md +0 -33
  261. package/docs/functions/oneOf.md +0 -21
  262. package/docs/functions/openmrsFetch.md +0 -75
  263. package/docs/functions/openmrsObservableFetch.md +0 -55
  264. package/docs/functions/parseDate.md +0 -20
  265. package/docs/functions/provide.md +0 -21
  266. package/docs/functions/putDynamicOfflineData.md +0 -28
  267. package/docs/functions/putDynamicOfflineDataFor.md +0 -34
  268. package/docs/functions/queueSynchronizationItem.md +0 -39
  269. package/docs/functions/refetchCurrentUser.md +0 -33
  270. package/docs/functions/registerBreadcrumb.md +0 -17
  271. package/docs/functions/registerBreadcrumbs.md +0 -17
  272. package/docs/functions/registerContext.md +0 -34
  273. package/docs/functions/registerDefaultCalendar.md +0 -33
  274. package/docs/functions/registerFeatureFlag.md +0 -36
  275. package/docs/functions/registerOfflinePatientHandler.md +0 -25
  276. package/docs/functions/removeDynamicOfflineData.md +0 -28
  277. package/docs/functions/removeDynamicOfflineDataFor.md +0 -34
  278. package/docs/functions/renderExtension.md +0 -41
  279. package/docs/functions/reportError.md +0 -17
  280. package/docs/functions/retry.md +0 -44
  281. package/docs/functions/saveVisit.md +0 -21
  282. package/docs/functions/selectPreferredName.md +0 -46
  283. package/docs/functions/setCurrentVisit.md +0 -21
  284. package/docs/functions/setLeftNav.md +0 -23
  285. package/docs/functions/setSessionLocation.md +0 -21
  286. package/docs/functions/setUserLanguage.md +0 -17
  287. package/docs/functions/setUserProperties.md +0 -23
  288. package/docs/functions/setupDynamicOfflineDataHandler.md +0 -22
  289. package/docs/functions/setupOfflineSync.md +0 -49
  290. package/docs/functions/shallowEqual.md +0 -32
  291. package/docs/functions/showActionableNotification.md +0 -21
  292. package/docs/functions/showModal.md +0 -44
  293. package/docs/functions/showNotification.md +0 -21
  294. package/docs/functions/showSnackbar.md +0 -21
  295. package/docs/functions/showToast.md +0 -21
  296. package/docs/functions/subscribeActionableNotificationShown.md +0 -21
  297. package/docs/functions/subscribeConnectivity.md +0 -21
  298. package/docs/functions/subscribeConnectivityChanged.md +0 -21
  299. package/docs/functions/subscribeNotificationShown.md +0 -21
  300. package/docs/functions/subscribePrecacheStaticDependencies.md +0 -21
  301. package/docs/functions/subscribeSnackbarShown.md +0 -21
  302. package/docs/functions/subscribeTo.md +0 -75
  303. package/docs/functions/subscribeToContext.md +0 -39
  304. package/docs/functions/subscribeToastShown.md +0 -21
  305. package/docs/functions/syncAllDynamicOfflineData.md +0 -27
  306. package/docs/functions/syncDynamicOfflineData.md +0 -33
  307. package/docs/functions/syncOfflinePatientData.md +0 -21
  308. package/docs/functions/toDateObjectStrict.md +0 -20
  309. package/docs/functions/toLocationObject.md +0 -17
  310. package/docs/functions/toOmrsIsoString.md +0 -23
  311. package/docs/functions/toVisitTypeObject.md +0 -17
  312. package/docs/functions/translateFrom.md +0 -55
  313. package/docs/functions/unregisterContext.md +0 -20
  314. package/docs/functions/unsetLeftNav.md +0 -23
  315. package/docs/functions/updateContext.md +0 -29
  316. package/docs/functions/updateVisit.md +0 -25
  317. package/docs/functions/useAbortController.md +0 -32
  318. package/docs/functions/useAppContext.md +0 -43
  319. package/docs/functions/useAssignedExtensionIds.md +0 -26
  320. package/docs/functions/useAssignedExtensions.md +0 -21
  321. package/docs/functions/useAttachments.md +0 -41
  322. package/docs/functions/useBodyScrollLock.md +0 -17
  323. package/docs/functions/useConfig.md +0 -27
  324. package/docs/functions/useConnectivity.md +0 -11
  325. package/docs/functions/useDebounce.md +0 -57
  326. package/docs/functions/useDefineAppContext.md +0 -70
  327. package/docs/functions/useEmrConfiguration.md +0 -35
  328. package/docs/functions/useExtensionSlotMeta.md +0 -25
  329. package/docs/functions/useExtensionSlotStore.md +0 -17
  330. package/docs/functions/useFeatureFlag.md +0 -30
  331. package/docs/functions/useFhirFetchAll.md +0 -44
  332. package/docs/functions/useFhirInfinite.md +0 -46
  333. package/docs/functions/useFhirPagination.md +0 -129
  334. package/docs/functions/useLayoutType.md +0 -11
  335. package/docs/functions/useLeftNav.md +0 -17
  336. package/docs/functions/useLeftNavStore.md +0 -11
  337. package/docs/functions/useLocations.md +0 -21
  338. package/docs/functions/useOnClickOutside.md +0 -27
  339. package/docs/functions/useOnVisible.md +0 -28
  340. package/docs/functions/useOpenmrsFetchAll.md +0 -46
  341. package/docs/functions/useOpenmrsInfinite.md +0 -54
  342. package/docs/functions/useOpenmrsPagination.md +0 -140
  343. package/docs/functions/useOpenmrsSWR.md +0 -71
  344. package/docs/functions/usePagination.md +0 -89
  345. package/docs/functions/usePatient.md +0 -38
  346. package/docs/functions/usePatientPhoto.md +0 -17
  347. package/docs/functions/usePrimaryIdentifierCode.md +0 -23
  348. package/docs/functions/useRenderableExtensions.md +0 -43
  349. package/docs/functions/useSession.md +0 -19
  350. package/docs/functions/useStore.md +0 -131
  351. package/docs/functions/useStoreWithActions.md +0 -33
  352. package/docs/functions/useVisit.md +0 -41
  353. package/docs/functions/useVisitContextStore.md +0 -23
  354. package/docs/functions/useVisitTypes.md +0 -11
  355. package/docs/functions/useWorkspaces.md +0 -11
  356. package/docs/functions/userHasAccess.md +0 -27
  357. package/docs/functions/validator.md +0 -44
  358. package/docs/interfaces/ExtensionSlotProps.md +0 -3520
  359. package/docs/type-aliases/ActionFunction.md +0 -27
  360. package/docs/type-aliases/ActionableNotificationType.md +0 -7
  361. package/docs/type-aliases/Actions.md +0 -13
  362. package/docs/type-aliases/ArgumentsTuple.md +0 -7
  363. package/docs/type-aliases/BoundActions.md +0 -17
  364. package/docs/type-aliases/ConfigValue.md +0 -7
  365. package/docs/type-aliases/ContextCallback.md +0 -23
  366. package/docs/type-aliases/CoreTranslationKey.md +0 -7
  367. package/docs/type-aliases/CurrentPatient.md +0 -7
  368. package/docs/type-aliases/DateInput.md +0 -7
  369. package/docs/type-aliases/DefaultEvaluateReturnType.md +0 -9
  370. package/docs/type-aliases/ExtensionDefinition.md +0 -69
  371. package/docs/type-aliases/ExtensionProps.md +0 -13
  372. package/docs/type-aliases/FormatDateMode.md +0 -7
  373. package/docs/type-aliases/FormatDateOptions.md +0 -102
  374. package/docs/type-aliases/IconProps.md +0 -31
  375. package/docs/type-aliases/InlineNotificationType.md +0 -7
  376. package/docs/type-aliases/Key.md +0 -7
  377. package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +0 -7
  378. package/docs/type-aliases/LayoutType.md +0 -7
  379. package/docs/type-aliases/LoadedSessionStore.md +0 -23
  380. package/docs/type-aliases/ModalDefinition.md +0 -17
  381. package/docs/type-aliases/NameUse.md +0 -7
  382. package/docs/type-aliases/NullablePatient.md +0 -7
  383. package/docs/type-aliases/OfflineMode.md +0 -7
  384. package/docs/type-aliases/OmrsOfflineCachingStrategy.md +0 -12
  385. package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +0 -7
  386. package/docs/type-aliases/OmrsOfflineHttpHeaders.md +0 -44
  387. package/docs/type-aliases/OpenmrsRoutes.md +0 -10
  388. package/docs/type-aliases/PageDefinition.md +0 -41
  389. package/docs/type-aliases/PageHeaderProps.md +0 -7
  390. package/docs/type-aliases/PatientUuid.md +0 -7
  391. package/docs/type-aliases/PictogramProps.md +0 -23
  392. package/docs/type-aliases/ProvidedConfig.md +0 -23
  393. package/docs/type-aliases/ResourceName.md +0 -7
  394. package/docs/type-aliases/SessionStore.md +0 -7
  395. package/docs/type-aliases/SnackbarType.md +0 -7
  396. package/docs/type-aliases/SpaEnvironment.md +0 -7
  397. package/docs/type-aliases/SvgIconProps.md +0 -23
  398. package/docs/type-aliases/SvgPictogramProps.md +0 -27
  399. package/docs/type-aliases/TemplateParams.md +0 -11
  400. package/docs/type-aliases/ToastType.md +0 -7
  401. package/docs/type-aliases/UnloadedSessionStore.md +0 -23
  402. package/docs/type-aliases/UpdateVisitPayload.md +0 -7
  403. package/docs/type-aliases/UseOpenmrsSWROptions.md +0 -39
  404. package/docs/type-aliases/Validator.md +0 -17
  405. package/docs/type-aliases/ValidatorFunction.md +0 -17
  406. package/docs/type-aliases/VariablesMap.md +0 -13
  407. package/docs/type-aliases/WorkspaceDefinition.md +0 -78
  408. package/docs/type-aliases/WorkspaceWindowState.md +0 -7
  409. package/docs/variables/ActionMenuButton.md +0 -7
  410. package/docs/variables/ActivityIcon.md +0 -7
  411. package/docs/variables/AddIcon.md +0 -7
  412. package/docs/variables/AllergiesIcon.md +0 -7
  413. package/docs/variables/AppointmentsPictogram.md +0 -7
  414. package/docs/variables/ArrowDownIcon.md +0 -7
  415. package/docs/variables/ArrowLeftIcon.md +0 -7
  416. package/docs/variables/ArrowRightIcon.md +0 -7
  417. package/docs/variables/ArrowUpIcon.md +0 -7
  418. package/docs/variables/AttachmentIcon.md +0 -7
  419. package/docs/variables/BabyIcon.md +0 -7
  420. package/docs/variables/CalendarHeatMapIcon.md +0 -7
  421. package/docs/variables/CalendarIcon.md +0 -7
  422. package/docs/variables/CaretDownIcon.md +0 -7
  423. package/docs/variables/CaretLeftIcon.md +0 -7
  424. package/docs/variables/CaretRightIcon.md +0 -7
  425. package/docs/variables/CaretUpIcon.md +0 -7
  426. package/docs/variables/ChartAverageIcon.md +0 -7
  427. package/docs/variables/CheckmarkFilledIcon.md +0 -7
  428. package/docs/variables/CheckmarkOutlineIcon.md +0 -7
  429. package/docs/variables/ChemistryIcon.md +0 -7
  430. package/docs/variables/ChevronDownIcon.md +0 -7
  431. package/docs/variables/ChevronLeftIcon.md +0 -7
  432. package/docs/variables/ChevronRightIcon.md +0 -7
  433. package/docs/variables/ChevronUpIcon.md +0 -7
  434. package/docs/variables/CloseFilledIcon.md +0 -7
  435. package/docs/variables/CloseIcon.md +0 -7
  436. package/docs/variables/CloseOutlineIcon.md +0 -7
  437. package/docs/variables/ConditionsIcon.md +0 -11
  438. package/docs/variables/DiagnosisTags.md +0 -11
  439. package/docs/variables/DocumentAttachmentIcon.md +0 -7
  440. package/docs/variables/DocumentIcon.md +0 -7
  441. package/docs/variables/DownloadIcon.md +0 -7
  442. package/docs/variables/DrugOrderIcon.md +0 -7
  443. package/docs/variables/EditIcon.md +0 -7
  444. package/docs/variables/ErrorState.md +0 -7
  445. package/docs/variables/EventScheduleIcon.md +0 -7
  446. package/docs/variables/EventsIcon.md +0 -7
  447. package/docs/variables/Extension.md +0 -15
  448. package/docs/variables/GenderFemaleIcon.md +0 -7
  449. package/docs/variables/GenderMaleIcon.md +0 -7
  450. package/docs/variables/GenderOtherIcon.md +0 -7
  451. package/docs/variables/GenderUnknownIcon.md +0 -7
  452. package/docs/variables/GenericOrderTypeIcon.md +0 -7
  453. package/docs/variables/GroupAccessIcon.md +0 -7
  454. package/docs/variables/GroupIcon.md +0 -7
  455. package/docs/variables/HomePictogram.md +0 -7
  456. package/docs/variables/HospitalBedIcon.md +0 -7
  457. package/docs/variables/Icon.md +0 -9
  458. package/docs/variables/ImageMedicalIcon.md +0 -7
  459. package/docs/variables/InPatientPictogram.md +0 -7
  460. package/docs/variables/InformationFilledIcon.md +0 -7
  461. package/docs/variables/InformationIcon.md +0 -7
  462. package/docs/variables/InformationSquareIcon.md +0 -7
  463. package/docs/variables/InventoryManagementIcon.md +0 -7
  464. package/docs/variables/LabOrderIcon.md +0 -7
  465. package/docs/variables/LaboratoryPictogram.md +0 -7
  466. package/docs/variables/LeftNavMenu.md +0 -13
  467. package/docs/variables/ListCheckedIcon.md +0 -7
  468. package/docs/variables/LocationIcon.md +0 -7
  469. package/docs/variables/LocationPicker.md +0 -7
  470. package/docs/variables/MaterialOrderIcon.md +0 -7
  471. package/docs/variables/MaximizeIcon.md +0 -7
  472. package/docs/variables/MaybeIcon.md +0 -16
  473. package/docs/variables/MaybePictogram.md +0 -16
  474. package/docs/variables/MedicationIcon.md +0 -7
  475. package/docs/variables/MessageQueueIcon.md +0 -7
  476. package/docs/variables/MicroscopeIcon.md +0 -7
  477. package/docs/variables/MoneyIcon.md +0 -9
  478. package/docs/variables/MotherIcon.md +0 -7
  479. package/docs/variables/MovementIcon.md +0 -7
  480. package/docs/variables/OpenmrsDatePicker.md +0 -9
  481. package/docs/variables/OverflowMenuHorizontalIcon.md +0 -7
  482. package/docs/variables/OverflowMenuVerticalIcon.md +0 -7
  483. package/docs/variables/PageHeader.md +0 -30
  484. package/docs/variables/PageHeaderContent.md +0 -21
  485. package/docs/variables/PasswordIcon.md +0 -7
  486. package/docs/variables/PatientListsPictogram.md +0 -7
  487. package/docs/variables/PedestrianFamilyIcon.md +0 -7
  488. package/docs/variables/PenIcon.md +0 -7
  489. package/docs/variables/PharmacyPictogram.md +0 -7
  490. package/docs/variables/Pictogram.md +0 -9
  491. package/docs/variables/PrinterIcon.md +0 -7
  492. package/docs/variables/ProcedureOrderIcon.md +0 -7
  493. package/docs/variables/ProgramsIcon.md +0 -7
  494. package/docs/variables/RadiologyIcon.md +0 -7
  495. package/docs/variables/ReferralOrderIcon.md +0 -7
  496. package/docs/variables/RegistrationPictogram.md +0 -7
  497. package/docs/variables/RenderIfValueIsTruthy.md +0 -21
  498. package/docs/variables/RenewIcon.md +0 -7
  499. package/docs/variables/ReportIcon.md +0 -7
  500. package/docs/variables/ResetIcon.md +0 -7
  501. package/docs/variables/ResponsiveWrapper.md +0 -11
  502. package/docs/variables/SaveIcon.md +0 -7
  503. package/docs/variables/SearchIcon.md +0 -7
  504. package/docs/variables/ServiceQueuesPictogram.md +0 -7
  505. package/docs/variables/ShoppingCartAddItemIcon.md +0 -11
  506. package/docs/variables/ShoppingCartArrowDownIcon.md +0 -9
  507. package/docs/variables/ShoppingCartIcon.md +0 -9
  508. package/docs/variables/StickyNoteAddIcon.md +0 -9
  509. package/docs/variables/StockManagementPictogram.md +0 -7
  510. package/docs/variables/SwitcherIcon.md +0 -7
  511. package/docs/variables/SyringeIcon.md +0 -7
  512. package/docs/variables/TableIcon.md +0 -7
  513. package/docs/variables/TableOfContentsIcon.md +0 -9
  514. package/docs/variables/TimeIcon.md +0 -9
  515. package/docs/variables/ToolsIcon.md +0 -7
  516. package/docs/variables/TranslateIcon.md +0 -7
  517. package/docs/variables/TrashCanIcon.md +0 -7
  518. package/docs/variables/TreeViewAltIcon.md +0 -7
  519. package/docs/variables/UserAvatarIcon.md +0 -9
  520. package/docs/variables/UserFollowIcon.md +0 -7
  521. package/docs/variables/UserHasAccess.md +0 -35
  522. package/docs/variables/UserIcon.md +0 -7
  523. package/docs/variables/UserXrayIcon.md +0 -11
  524. package/docs/variables/ViewIcon.md +0 -7
  525. package/docs/variables/ViewOffIcon.md +0 -7
  526. package/docs/variables/WarningIcon.md +0 -7
  527. package/docs/variables/attachmentUrl.md +0 -7
  528. package/docs/variables/backendDependencies.md +0 -17
  529. package/docs/variables/defaultVisitCustomRepresentation.md +0 -7
  530. package/docs/variables/fhirBaseUrl.md +0 -7
  531. package/docs/variables/getAsyncExtensionLifecycle.md +0 -35
  532. package/docs/variables/getStartedVisit.md +0 -9
  533. package/docs/variables/isUrl.md +0 -9
  534. package/docs/variables/offlineUuidPrefix.md +0 -7
  535. package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +0 -7
  536. package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +0 -7
  537. package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +0 -7
  538. package/docs/variables/restBaseUrl.md +0 -7
  539. package/docs/variables/sessionEndpoint.md +0 -7
  540. package/docs/variables/useConnectedExtensions.md +0 -25
  541. package/docs/variables/useExtensionStore.md +0 -55
  542. package/docs/variables/validators.md +0 -78
package/docs/interfaces/UseServerFetchAllOptions.md CHANGED
@@ -1,80 +1,100 @@
1
- [O3 Framework](../API.md) / UseServerFetchAllOptions
1
+ [@openmrs/esm-framework](../API.md) / UseServerFetchAllOptions
2
2
 
3
- # Interface: UseServerFetchAllOptions\<R\>
3
+ # Interface: UseServerFetchAllOptions<R\>
4
4
 
5
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts#L14)
5
+ ## Type parameters
6
6
 
7
- ## Extends
7
+ | Name |
8
+ | :------ |
9
+ | `R` |
8
10
 
9
- - [`UseServerInfiniteOptions`](UseServerInfiniteOptions.md)\<`R`\>
11
+ ## Hierarchy
10
12
 
11
- ## Type Parameters
13
+ - [`UseServerInfiniteOptions`](UseServerInfiniteOptions.md)<`R`\>
12
14
 
13
- ### R
15
+ ↳ **`UseServerFetchAllOptions`**
14
16
 
15
- `R`
17
+ ## Table of contents
16
18
 
17
- ## Properties
19
+ ### UI Properties
18
20
 
19
- ### fetcher()?
21
+ - [immutable](UseServerFetchAllOptions.md#immutable)
22
+ - [partialData](UseServerFetchAllOptions.md#partialdata)
23
+ - [swrInfiniteConfig](UseServerFetchAllOptions.md#swrinfiniteconfig)
20
24
 
21
- > `optional` **fetcher**: (`key`) => `Promise`\<`FetchResponse`\<`R`\>\>
25
+ ### UI Methods
22
26
 
23
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
27
+ - [fetcher](UseServerFetchAllOptions.md#fetcher)
24
28
 
25
- The fetcher to use. Defaults to openmrsFetch
29
+ ## UI Properties
26
30
 
27
- #### Parameters
31
+ ### immutable
28
32
 
29
- ##### key
33
+ • `Optional` **immutable**: `boolean`
30
34
 
31
- `string`
35
+ If true, sets these options in swrInfintieConfig to false:
36
+ revalidateIfStale, revalidateOnFocus, revalidateOnReconnect
37
+ This should be the counterpart of using useSWRImmutable` for `useSWRInfinite`
32
38
 
33
- #### Returns
39
+ #### Inherited from
34
40
 
35
- `Promise`\<`FetchResponse`\<`R`\>\>
41
+ [UseServerInfiniteOptions](UseServerInfiniteOptions.md).[immutable](UseServerInfiniteOptions.md#immutable)
36
42
 
37
- #### Inherited from
43
+ #### Defined in
38
44
 
39
- [`UseServerInfiniteOptions`](UseServerInfiniteOptions.md).[`fetcher`](UseServerInfiniteOptions.md#fetcher)
45
+ [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L25)
40
46
 
41
- ***
47
+ ___
42
48
 
43
- ### immutable?
49
+ ### partialData
44
50
 
45
- > `optional` **immutable**: `boolean`
51
+ • `Optional` **partialData**: `boolean`
46
52
 
47
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L25)
53
+ If true, the data of any page is returned as soon as they are fetched.
54
+ This is useful when you want to display data as soon as possible, even if not all pages are fetched.
55
+ If false, the returned data will be undefined until all pages are fetched. This is useful when you want to
56
+ display all data at once or reduce the number of re-renders (to avoid confusing users).
48
57
 
49
- If true, sets these options in swrInfintieConfig to false:
50
- revalidateIfStale, revalidateOnFocus, revalidateOnReconnect
51
- This should be the counterpart of using useSWRImmutable` for `useSWRInfinite`
58
+ #### Defined in
59
+
60
+ [packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts#L21)
61
+
62
+ ___
63
+
64
+ ### swrInfiniteConfig
65
+
66
+ • `Optional` **swrInfiniteConfig**: `SWRInfiniteConfiguration`<`any`, `any`, `BareFetcher`<`any`\>\>
52
67
 
53
68
  #### Inherited from
54
69
 
55
- [`UseServerInfiniteOptions`](UseServerInfiniteOptions.md).[`immutable`](UseServerInfiniteOptions.md#immutable)
70
+ [UseServerInfiniteOptions](UseServerInfiniteOptions.md).[swrInfiniteConfig](UseServerInfiniteOptions.md#swrinfiniteconfig)
56
71
 
57
- ***
72
+ #### Defined in
58
73
 
59
- ### partialData?
74
+ [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L27)
60
75
 
61
- > `optional` **partialData**: `boolean`
76
+ ## UI Methods
62
77
 
63
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts#L21)
78
+ ### fetcher
64
79
 
65
- If true, the data of any page is returned as soon as they are fetched.
66
- This is useful when you want to display data as soon as possible, even if not all pages are fetched.
67
- If false, the returned data will be undefined until all pages are fetched. This is useful when you want to
68
- display all data at once or reduce the number of re-renders (to avoid confusing users).
80
+ ▸ `Optional` **fetcher**(`key`): `Promise`<`FetchResponse`<`R`\>\>
69
81
 
70
- ***
82
+ The fetcher to use. Defaults to openmrsFetch
71
83
 
72
- ### swrInfiniteConfig?
84
+ #### Parameters
73
85
 
74
- > `optional` **swrInfiniteConfig**: `SWRInfiniteConfiguration`\<`any`, `any`, `BareFetcher`\<`any`\>\>
86
+ | Name | Type |
87
+ | :------ | :------ |
88
+ | `key` | `string` |
75
89
 
76
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L27)
90
+ #### Returns
91
+
92
+ `Promise`<`FetchResponse`<`R`\>\>
77
93
 
78
94
  #### Inherited from
79
95
 
80
- [`UseServerInfiniteOptions`](UseServerInfiniteOptions.md).[`swrInfiniteConfig`](UseServerInfiniteOptions.md#swrinfiniteconfig)
96
+ [UseServerInfiniteOptions](UseServerInfiniteOptions.md).[fetcher](UseServerInfiniteOptions.md#fetcher)
97
+
98
+ #### Defined in
99
+
100
+ [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
package/docs/interfaces/UseServerInfiniteOptions.md CHANGED
@@ -1,55 +1,72 @@
1
- [O3 Framework](../API.md) / UseServerInfiniteOptions
1
+ [@openmrs/esm-framework](../API.md) / UseServerInfiniteOptions
2
2
 
3
- # Interface: UseServerInfiniteOptions\<R\>
3
+ # Interface: UseServerInfiniteOptions<R\>
4
4
 
5
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L14)
5
+ ## Type parameters
6
6
 
7
- ## Extended by
7
+ | Name |
8
+ | :------ |
9
+ | `R` |
8
10
 
9
- - [`UseServerFetchAllOptions`](UseServerFetchAllOptions.md)
11
+ ## Hierarchy
10
12
 
11
- ## Type Parameters
13
+ - **`UseServerInfiniteOptions`**
12
14
 
13
- ### R
15
+ ↳ [`UseServerFetchAllOptions`](UseServerFetchAllOptions.md)
14
16
 
15
- `R`
17
+ ## Table of contents
16
18
 
17
- ## Properties
19
+ ### UI Properties
18
20
 
19
- ### fetcher()?
21
+ - [immutable](UseServerInfiniteOptions.md#immutable)
22
+ - [swrInfiniteConfig](UseServerInfiniteOptions.md#swrinfiniteconfig)
20
23
 
21
- > `optional` **fetcher**: (`key`) => `Promise`\<`FetchResponse`\<`R`\>\>
24
+ ### UI Methods
22
25
 
23
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
26
+ - [fetcher](UseServerInfiniteOptions.md#fetcher)
24
27
 
25
- The fetcher to use. Defaults to openmrsFetch
28
+ ## UI Properties
26
29
 
27
- #### Parameters
30
+ ### immutable
28
31
 
29
- ##### key
32
+ • `Optional` **immutable**: `boolean`
30
33
 
31
- `string`
34
+ If true, sets these options in swrInfintieConfig to false:
35
+ revalidateIfStale, revalidateOnFocus, revalidateOnReconnect
36
+ This should be the counterpart of using useSWRImmutable` for `useSWRInfinite`
32
37
 
33
- #### Returns
38
+ #### Defined in
34
39
 
35
- `Promise`\<`FetchResponse`\<`R`\>\>
40
+ [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L25)
36
41
 
37
- ***
42
+ ___
38
43
 
39
- ### immutable?
44
+ ### swrInfiniteConfig
40
45
 
41
- > `optional` **immutable**: `boolean`
46
+ • `Optional` **swrInfiniteConfig**: `SWRInfiniteConfiguration`<`any`, `any`, `BareFetcher`<`any`\>\>
42
47
 
43
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L25)
48
+ #### Defined in
44
49
 
45
- If true, sets these options in swrInfintieConfig to false:
46
- revalidateIfStale, revalidateOnFocus, revalidateOnReconnect
47
- This should be the counterpart of using useSWRImmutable` for `useSWRInfinite`
50
+ [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L27)
48
51
 
49
- ***
52
+ ## UI Methods
53
+
54
+ ### fetcher
55
+
56
+ ▸ `Optional` **fetcher**(`key`): `Promise`<`FetchResponse`<`R`\>\>
57
+
58
+ The fetcher to use. Defaults to openmrsFetch
59
+
60
+ #### Parameters
61
+
62
+ | Name | Type |
63
+ | :------ | :------ |
64
+ | `key` | `string` |
65
+
66
+ #### Returns
50
67
 
51
- ### swrInfiniteConfig?
68
+ `Promise`<`FetchResponse`<`R`\>\>
52
69
 
53
- > `optional` **swrInfiniteConfig**: `SWRInfiniteConfiguration`\<`any`, `any`, `BareFetcher`\<`any`\>\>
70
+ #### Defined in
54
71
 
55
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L27)
72
+ [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
package/docs/interfaces/UseServerPaginationOptions.md CHANGED
@@ -1,51 +1,66 @@
1
- [O3 Framework](../API.md) / UseServerPaginationOptions
1
+ [@openmrs/esm-framework](../API.md) / UseServerPaginationOptions
2
2
 
3
- # Interface: UseServerPaginationOptions\<R\>
3
+ # Interface: UseServerPaginationOptions<R\>
4
4
 
5
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L13)
5
+ ## Type parameters
6
6
 
7
- ## Type Parameters
7
+ | Name |
8
+ | :------ |
9
+ | `R` |
8
10
 
9
- ### R
11
+ ## Table of contents
10
12
 
11
- `R`
13
+ ### UI Properties
12
14
 
13
- ## Properties
15
+ - [immutable](UseServerPaginationOptions.md#immutable)
16
+ - [swrConfig](UseServerPaginationOptions.md#swrconfig)
14
17
 
15
- ### fetcher()?
18
+ ### UI Methods
16
19
 
17
- > `optional` **fetcher**: (`key`) => `Promise`\<`FetchResponse`\<`R`\>\>
20
+ - [fetcher](UseServerPaginationOptions.md#fetcher)
18
21
 
19
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L22)
22
+ ## UI Properties
20
23
 
21
- The fetcher to use. Defaults to openmrsFetch
24
+ ### immutable
22
25
 
23
- #### Parameters
26
+ • `Optional` **immutable**: `boolean`
24
27
 
25
- ##### key
28
+ Whether to use useSWR or useSWRInfinite to fetch data
26
29
 
27
- `string`
30
+ #### Defined in
28
31
 
29
- #### Returns
32
+ [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L17)
30
33
 
31
- `Promise`\<`FetchResponse`\<`R`\>\>
34
+ ___
32
35
 
33
- ***
36
+ ### swrConfig
34
37
 
35
- ### immutable?
38
+ • `Optional` **swrConfig**: `SWRConfiguration`<`any`, `any`, `BareFetcher`<`any`\>\>
36
39
 
37
- > `optional` **immutable**: `boolean`
40
+ The configuration object for useSWR or useSWRInfinite
38
41
 
39
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L17)
42
+ #### Defined in
40
43
 
41
- Whether to use useSWR or useSWRInfinite to fetch data
44
+ [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L27)
42
45
 
43
- ***
46
+ ## UI Methods
44
47
 
45
- ### swrConfig?
48
+ ### fetcher
46
49
 
47
- > `optional` **swrConfig**: `SWRConfiguration`
50
+ ▸ `Optional` **fetcher**(`key`): `Promise`<`FetchResponse`<`R`\>\>
48
51
 
49
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L27)
52
+ The fetcher to use. Defaults to openmrsFetch
50
53
 
51
- The configuration object for useSWR or useSWRInfinite
54
+ #### Parameters
55
+
56
+ | Name | Type |
57
+ | :------ | :------ |
58
+ | `key` | `string` |
59
+
60
+ #### Returns
61
+
62
+ `Promise`<`FetchResponse`<`R`\>\>
63
+
64
+ #### Defined in
65
+
66
+ [packages/framework/esm-react-utils/src/useOpenmrsPagination.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsPagination.ts#L22)
package/docs/interfaces/User.md CHANGED
@@ -1,77 +1,89 @@
1
- [O3 Framework](../API.md) / User
1
+ [@openmrs/esm-framework](../API.md) / User
2
2
 
3
3
  # Interface: User
4
4
 
5
- Defined in: [packages/framework/esm-api/src/types/user-resource.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L67)
5
+ ## Hierarchy
6
6
 
7
- Superclass for all Openmrs Resources, with strict typings.
8
- If the subclass does not have all attributes (including optional ones)
9
- accounted for, use OpenmrsResource instead.
7
+ - [`OpenmrsResource`](OpenmrsResource.md)
10
8
 
11
- ## Extends
9
+ ↳ **`User`**
12
10
 
13
- - [`OpenmrsResource`](OpenmrsResource.md)
11
+ ## Table of contents
14
12
 
15
- ## Indexable
13
+ ### Properties
16
14
 
17
- \[`anythingElse`: `string`\]: `any`
15
+ - [auditInfo](User.md#auditinfo)
16
+ - [display](User.md#display)
17
+ - [links](User.md#links)
18
+ - [resourceVersion](User.md#resourceversion)
19
+ - [uuid](User.md#uuid)
18
20
 
19
21
  ## Properties
20
22
 
21
- ### auditInfo?
22
-
23
- > `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
23
+ ### auditInfo
24
24
 
25
- Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
25
+ • `Optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
26
26
 
27
27
  #### Inherited from
28
28
 
29
- [`OpenmrsResource`](OpenmrsResource.md).[`auditInfo`](OpenmrsResource.md#auditinfo)
29
+ [OpenmrsResource](OpenmrsResource.md).[auditInfo](OpenmrsResource.md#auditinfo)
30
30
 
31
- ***
31
+ #### Defined in
32
32
 
33
- ### display?
33
+ [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
34
34
 
35
- > `optional` **display**: `string`
35
+ ___
36
36
 
37
- Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
37
+ ### display
38
+
39
+ • `Optional` **display**: `string`
38
40
 
39
41
  #### Inherited from
40
42
 
41
- [`OpenmrsResource`](OpenmrsResource.md).[`display`](OpenmrsResource.md#display)
43
+ [OpenmrsResource](OpenmrsResource.md).[display](OpenmrsResource.md#display)
44
+
45
+ #### Defined in
42
46
 
43
- ***
47
+ [packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
44
48
 
45
- ### links?
49
+ ___
46
50
 
47
- > `optional` **links**: [`Link`](Link.md)[]
51
+ ### links
48
52
 
49
- Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
53
+ • `Optional` **links**: [`Link`](Link.md)[]
50
54
 
51
55
  #### Inherited from
52
56
 
53
- [`OpenmrsResource`](OpenmrsResource.md).[`links`](OpenmrsResource.md#links)
57
+ [OpenmrsResource](OpenmrsResource.md).[links](OpenmrsResource.md#links)
58
+
59
+ #### Defined in
54
60
 
55
- ***
61
+ [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
56
62
 
57
- ### resourceVersion?
63
+ ___
58
64
 
59
- > `optional` **resourceVersion**: `string`
65
+ ### resourceVersion
60
66
 
61
- Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
67
+ • `Optional` **resourceVersion**: `string`
62
68
 
63
69
  #### Inherited from
64
70
 
65
- [`OpenmrsResource`](OpenmrsResource.md).[`resourceVersion`](OpenmrsResource.md#resourceversion)
71
+ [OpenmrsResource](OpenmrsResource.md).[resourceVersion](OpenmrsResource.md#resourceversion)
66
72
 
67
- ***
73
+ #### Defined in
68
74
 
69
- ### uuid
75
+ [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
76
+
77
+ ___
70
78
 
71
- > **uuid**: `string`
79
+ ### uuid
72
80
 
73
- Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
81
+ • **uuid**: `string`
74
82
 
75
83
  #### Inherited from
76
84
 
77
- [`OpenmrsResource`](OpenmrsResource.md).[`uuid`](OpenmrsResource.md#uuid)
85
+ [OpenmrsResource](OpenmrsResource.md).[uuid](OpenmrsResource.md#uuid)
86
+
87
+ #### Defined in
88
+
89
+ [packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
package/docs/interfaces/UserHasAccessProps.md CHANGED
@@ -1,29 +1,41 @@
1
- [O3 Framework](../API.md) / UserHasAccessProps
1
+ [@openmrs/esm-framework](../API.md) / UserHasAccessProps
2
2
 
3
3
  # Interface: UserHasAccessProps
4
4
 
5
- Defined in: [packages/framework/esm-react-utils/src/UserHasAccess.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L6)
5
+ ## Table of contents
6
6
 
7
- ## Properties
7
+ ### API Properties
8
8
 
9
- ### children?
9
+ - [children](UserHasAccessProps.md#children)
10
+ - [fallback](UserHasAccessProps.md#fallback)
11
+ - [privilege](UserHasAccessProps.md#privilege)
10
12
 
11
- > `optional` **children**: `ReactNode`
13
+ ## API Properties
12
14
 
13
- Defined in: [packages/framework/esm-react-utils/src/UserHasAccess.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L9)
15
+ ### children
14
16
 
15
- ***
17
+ • `Optional` **children**: `ReactNode`
16
18
 
17
- ### fallback?
19
+ #### Defined in
18
20
 
19
- > `optional` **fallback**: `ReactNode`
21
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L9)
20
22
 
21
- Defined in: [packages/framework/esm-react-utils/src/UserHasAccess.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L8)
23
+ ___
22
24
 
23
- ***
25
+ ### fallback
26
+
27
+ • `Optional` **fallback**: `ReactNode`
28
+
29
+ #### Defined in
30
+
31
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L8)
32
+
33
+ ___
24
34
 
25
35
  ### privilege
26
36
 
27
- > **privilege**: `string` \| `string`[]
37
+ • **privilege**: `string` \| `string`[]
38
+
39
+ #### Defined in
28
40
 
29
- Defined in: [packages/framework/esm-react-utils/src/UserHasAccess.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L7)
41
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L7)