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

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