@openmrs/esm-framework 6.3.1-pre.3105 → 6.3.1-pre.3119
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.
- package/.turbo/turbo-build.log +1 -1
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/classes/OpenmrsFetchError.md +4 -4
- package/docs/enumerations/Type.md +10 -10
- package/docs/enumerations/VisitMode.md +4 -4
- package/docs/enumerations/VisitStatus.md +3 -3
- package/docs/functions/ConfigurableLink.md +1 -1
- package/docs/functions/CustomOverflowMenu.md +1 -1
- package/docs/functions/DashboardExtension.md +1 -1
- package/docs/functions/ExtensionSlot.md +1 -1
- package/docs/functions/OpenmrsAppContext.md +2 -2
- package/docs/functions/PatientBannerActionsMenu.md +1 -1
- package/docs/functions/PatientBannerContactDetails.md +1 -1
- package/docs/functions/PatientBannerPatientIdentifiers.md +1 -1
- package/docs/functions/PatientBannerPatientInfo.md +1 -1
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +1 -1
- package/docs/functions/PatientPhoto.md +1 -1
- package/docs/functions/WorkspaceContainer.md +1 -1
- package/docs/functions/attach.md +1 -1
- package/docs/functions/beginEditSynchronizationItem.md +1 -1
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +1 -1
- package/docs/functions/clearCurrentUser.md +1 -1
- package/docs/functions/closeWorkspace.md +1 -1
- package/docs/functions/compile.md +1 -1
- package/docs/functions/createAttachment.md +1 -1
- package/docs/functions/createGlobalStore.md +1 -1
- package/docs/functions/createUseStore.md +1 -1
- package/docs/functions/defineConfigSchema.md +1 -1
- package/docs/functions/defineExtensionConfigSchema.md +1 -1
- package/docs/functions/deleteAttachmentPermanently.md +1 -1
- package/docs/functions/deleteSynchronizationItem.md +1 -1
- package/docs/functions/detach.md +1 -1
- package/docs/functions/detachAll.md +1 -1
- package/docs/functions/evaluate.md +1 -1
- package/docs/functions/evaluateAsBoolean.md +3 -3
- package/docs/functions/evaluateAsBooleanAsync.md +3 -3
- package/docs/functions/evaluateAsNumber.md +1 -1
- package/docs/functions/evaluateAsNumberAsync.md +1 -1
- package/docs/functions/evaluateAsType.md +1 -1
- package/docs/functions/evaluateAsTypeAsync.md +1 -1
- package/docs/functions/evaluateAsync.md +1 -1
- package/docs/functions/extractVariableNames.md +1 -1
- package/docs/functions/fetchCurrentPatient.md +1 -1
- package/docs/functions/filterBreadcrumbs.md +1 -1
- package/docs/functions/generateOfflineUuid.md +1 -1
- package/docs/functions/getAssignedExtensions.md +1 -1
- package/docs/functions/getAsyncLifecycle.md +1 -1
- package/docs/functions/getAttachmentByUuid.md +1 -1
- package/docs/functions/getAttachments.md +1 -1
- package/docs/functions/getBreadcrumbs.md +1 -1
- package/docs/functions/getBreadcrumbsFor.md +1 -1
- package/docs/functions/getConfig.md +1 -1
- package/docs/functions/getContext.md +2 -2
- package/docs/functions/getCoreTranslation.md +1 -1
- package/docs/functions/getCurrentOfflineMode.md +1 -1
- package/docs/functions/getCurrentUser.md +3 -3
- package/docs/functions/getDynamicOfflineDataEntries.md +1 -1
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +1 -1
- package/docs/functions/getDynamicOfflineDataHandlers.md +1 -1
- package/docs/functions/getExtensionNameFromId.md +1 -1
- package/docs/functions/getExtensionStore.md +1 -1
- package/docs/functions/getFeatureFlag.md +1 -1
- package/docs/functions/getFhirServerPaginationHandlers.md +1 -1
- package/docs/functions/getFullSynchronizationItems.md +1 -1
- package/docs/functions/getFullSynchronizationItemsFor.md +1 -1
- package/docs/functions/getGlobalStore.md +1 -1
- package/docs/functions/getHistory.md +1 -1
- package/docs/functions/getLifecycle.md +1 -1
- package/docs/functions/getLocations.md +1 -1
- package/docs/functions/getLoggedInUser.md +1 -1
- package/docs/functions/getOfflinePatientDataStore.md +1 -1
- package/docs/functions/getSessionLocation.md +1 -1
- package/docs/functions/getSessionStore.md +1 -1
- package/docs/functions/getSyncLifecycle.md +1 -1
- package/docs/functions/getSynchronizationItem.md +1 -1
- package/docs/functions/getSynchronizationItems.md +1 -1
- package/docs/functions/getVisitStore.md +1 -1
- package/docs/functions/getVisitTypes.md +1 -1
- package/docs/functions/getVisitsForPatient.md +1 -1
- package/docs/functions/goBackInHistory.md +1 -1
- package/docs/functions/importDynamic.md +1 -1
- package/docs/functions/inRange.md +1 -1
- package/docs/functions/interpolateString.md +1 -1
- package/docs/functions/interpolateUrl.md +1 -1
- package/docs/functions/isDesktop.md +1 -1
- package/docs/functions/isDevEnabled.md +1 -1
- package/docs/functions/isOfflineUuid.md +1 -1
- package/docs/functions/isUrlWithTemplateParameters.md +1 -1
- package/docs/functions/launchWorkspace.md +1 -1
- package/docs/functions/launchWorkspaceGroup.md +1 -1
- package/docs/functions/makeUrl.md +1 -1
- package/docs/functions/messageOmrsServiceWorker.md +1 -1
- package/docs/functions/navigate.md +1 -1
- package/docs/functions/navigateAndLaunchWorkspace.md +1 -1
- package/docs/functions/oneOf.md +1 -1
- package/docs/functions/openmrsFetch.md +1 -1
- package/docs/functions/openmrsObservableFetch.md +1 -1
- package/docs/functions/provide.md +1 -1
- package/docs/functions/putDynamicOfflineData.md +1 -1
- package/docs/functions/putDynamicOfflineDataFor.md +1 -1
- package/docs/functions/queueSynchronizationItem.md +1 -1
- package/docs/functions/refetchCurrentUser.md +1 -1
- package/docs/functions/registerBreadcrumb.md +1 -1
- package/docs/functions/registerBreadcrumbs.md +1 -1
- package/docs/functions/registerContext.md +2 -2
- package/docs/functions/registerFeatureFlag.md +1 -1
- package/docs/functions/registerOfflinePatientHandler.md +1 -1
- package/docs/functions/removeDynamicOfflineData.md +1 -1
- package/docs/functions/removeDynamicOfflineDataFor.md +1 -1
- package/docs/functions/renderExtension.md +1 -1
- package/docs/functions/saveVisit.md +1 -1
- package/docs/functions/setCurrentVisit.md +1 -1
- package/docs/functions/setLeftNav.md +1 -1
- package/docs/functions/setSessionLocation.md +1 -1
- package/docs/functions/setUserLanguage.md +1 -1
- package/docs/functions/setUserProperties.md +1 -1
- package/docs/functions/setupDynamicOfflineDataHandler.md +1 -1
- package/docs/functions/setupOfflineSync.md +1 -1
- package/docs/functions/showActionableNotification.md +1 -1
- package/docs/functions/showModal.md +1 -1
- package/docs/functions/showNotification.md +1 -1
- package/docs/functions/showSnackbar.md +1 -1
- package/docs/functions/showToast.md +1 -1
- package/docs/functions/subscribeTo.md +2 -2
- package/docs/functions/subscribeToContext.md +2 -2
- package/docs/functions/syncAllDynamicOfflineData.md +1 -1
- package/docs/functions/syncDynamicOfflineData.md +1 -1
- package/docs/functions/syncOfflinePatientData.md +1 -1
- package/docs/functions/toLocationObject.md +1 -1
- package/docs/functions/toVisitTypeObject.md +1 -1
- package/docs/functions/translateFrom.md +1 -1
- package/docs/functions/unregisterContext.md +1 -1
- package/docs/functions/unsetLeftNav.md +1 -1
- package/docs/functions/updateContext.md +2 -2
- package/docs/functions/updateVisit.md +1 -1
- package/docs/functions/useAbortController.md +1 -1
- package/docs/functions/useAppContext.md +2 -2
- package/docs/functions/useAssignedExtensionIds.md +1 -1
- package/docs/functions/useAssignedExtensions.md +1 -1
- package/docs/functions/useAttachments.md +1 -1
- package/docs/functions/useBodyScrollLock.md +1 -1
- package/docs/functions/useConfig.md +1 -1
- package/docs/functions/useConnectivity.md +1 -1
- package/docs/functions/useDebounce.md +1 -1
- package/docs/functions/useDefineAppContext.md +2 -2
- package/docs/functions/useEmrConfiguration.md +1 -1
- package/docs/functions/useExtensionSlotMeta.md +1 -1
- package/docs/functions/useExtensionSlotStore.md +1 -1
- package/docs/functions/useFeatureFlag.md +1 -1
- package/docs/functions/useFhirFetchAll.md +1 -1
- package/docs/functions/useFhirInfinite.md +1 -1
- package/docs/functions/useFhirPagination.md +1 -1
- package/docs/functions/useLayoutType.md +1 -1
- package/docs/functions/useLeftNav.md +1 -1
- package/docs/functions/useLeftNavStore.md +1 -1
- package/docs/functions/useLocations.md +1 -1
- package/docs/functions/useOnClickOutside.md +1 -1
- package/docs/functions/useOnVisible.md +1 -1
- package/docs/functions/useOpenmrsFetchAll.md +1 -1
- package/docs/functions/useOpenmrsInfinite.md +1 -1
- package/docs/functions/useOpenmrsPagination.md +1 -1
- package/docs/functions/useOpenmrsSWR.md +1 -1
- package/docs/functions/usePagination.md +1 -1
- package/docs/functions/usePatient.md +1 -1
- package/docs/functions/usePatientPhoto.md +1 -1
- package/docs/functions/usePrimaryIdentifierCode.md +1 -1
- package/docs/functions/useRenderableExtensions.md +1 -1
- package/docs/functions/useSession.md +1 -1
- package/docs/functions/useStore.md +4 -4
- package/docs/functions/useStoreWithActions.md +1 -1
- package/docs/functions/useVisit.md +1 -1
- package/docs/functions/useVisitContextStore.md +1 -1
- package/docs/functions/useVisitTypes.md +1 -1
- package/docs/functions/useWorkspaces.md +1 -1
- package/docs/functions/userHasAccess.md +1 -1
- package/docs/functions/validator.md +1 -1
- package/docs/interfaces/ActionMenuButtonProps.md +7 -7
- package/docs/interfaces/ActionableNotificationDescriptor.md +27 -27
- package/docs/interfaces/AssignedExtension.md +9 -9
- package/docs/interfaces/Attachment.md +8 -8
- package/docs/interfaces/AttachmentResponse.md +7 -7
- package/docs/interfaces/AuditInfo.md +13 -13
- package/docs/interfaces/BreadcrumbRegistration.md +3 -3
- package/docs/interfaces/BreadcrumbSettings.md +5 -5
- package/docs/interfaces/CancelLoading.md +2 -2
- package/docs/interfaces/ClearDynamicRoutesMessage.md +2 -2
- package/docs/interfaces/CloseWorkspaceOptions.md +4 -4
- package/docs/interfaces/ComponentConfig.md +4 -4
- package/docs/interfaces/Concept.md +18 -18
- package/docs/interfaces/ConceptClass.md +9 -9
- package/docs/interfaces/ConceptDatatype.md +10 -10
- package/docs/interfaces/ConceptName.md +10 -10
- package/docs/interfaces/Config.md +1 -1
- package/docs/interfaces/ConfigObject.md +3 -3
- package/docs/interfaces/ConfigSchema.md +4 -4
- package/docs/interfaces/ConfigurableLinkProps.md +4 -4
- package/docs/interfaces/ConnectedExtension.md +6 -6
- package/docs/interfaces/CurrentPatientOptions.md +2 -2
- package/docs/interfaces/DashboardExtensionProps.md +5 -5
- package/docs/interfaces/DefaultWorkspaceProps.md +5 -5
- package/docs/interfaces/Diagnosis.md +9 -9
- package/docs/interfaces/DisplayConditionsConfigObject.md +5 -5
- package/docs/interfaces/DynamicOfflineData.md +6 -6
- package/docs/interfaces/DynamicOfflineDataHandler.md +6 -6
- package/docs/interfaces/DynamicOfflineDataSyncState.md +6 -6
- package/docs/interfaces/EmrApiConfigurationResponse.md +53 -53
- package/docs/interfaces/Encounter.md +10 -10
- package/docs/interfaces/EncounterProvider.md +3 -3
- package/docs/interfaces/EncounterRole.md +4 -4
- package/docs/interfaces/EncounterType.md +4 -4
- package/docs/interfaces/ErrorStateProps.md +3 -3
- package/docs/interfaces/ExtensionData.md +4 -4
- package/docs/interfaces/ExtensionMeta.md +1 -1
- package/docs/interfaces/ExtensionRegistration.md +10 -10
- package/docs/interfaces/ExtensionSlotBaseProps.md +5 -5
- package/docs/interfaces/ExtensionSlotConfig.md +5 -5
- package/docs/interfaces/ExtensionSlotConfigObject.md +4 -4
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +1 -1
- package/docs/interfaces/ExtensionSlotProps.md +6 -6
- package/docs/interfaces/ExtensionSlotState.md +3 -3
- package/docs/interfaces/ExtensionStore.md +2 -2
- package/docs/interfaces/FHIRCode.md +4 -4
- package/docs/interfaces/FHIRLocationResource.md +2 -2
- package/docs/interfaces/FHIRResource.md +2 -2
- package/docs/interfaces/FetchConfig.md +3 -3
- package/docs/interfaces/FetchError.md +3 -3
- package/docs/interfaces/FetchHeaders.md +1 -1
- package/docs/interfaces/FetchResponse.md +2 -2
- package/docs/interfaces/FetchResponseJson.md +1 -1
- package/docs/interfaces/LeftNavStore.md +5 -5
- package/docs/interfaces/Link.md +4 -4
- package/docs/interfaces/Location.md +30 -30
- package/docs/interfaces/LoggedInUser.md +12 -12
- package/docs/interfaces/LoggedInUserFetchResponse.md +2 -2
- package/docs/interfaces/MessageServiceWorkerResult.md +4 -4
- package/docs/interfaces/NavigateOptions.md +3 -3
- package/docs/interfaces/NewVisitPayload.md +8 -8
- package/docs/interfaces/NotificationDescriptor.md +8 -8
- package/docs/interfaces/Obs.md +18 -18
- package/docs/interfaces/OfflineModeResult.md +4 -4
- package/docs/interfaces/OfflinePatientArgs.md +3 -3
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +3 -3
- package/docs/interfaces/OfflinePatientDataSyncState.md +7 -7
- package/docs/interfaces/OfflinePatientDataSyncStore.md +3 -3
- package/docs/interfaces/OmrsServiceWorkerMessage.md +2 -2
- package/docs/interfaces/OnImportMapChangedMessage.md +3 -3
- package/docs/interfaces/OnlyThePatient.md +2 -2
- package/docs/interfaces/OpenWorkspace.md +7 -7
- package/docs/interfaces/OpenmrsAppContextProps.md +4 -4
- package/docs/interfaces/OpenmrsDatePickerProps.md +15 -15
- package/docs/interfaces/OpenmrsResource.md +6 -6
- package/docs/interfaces/OpenmrsResourceStrict.md +6 -6
- package/docs/interfaces/PageHeaderContentProps.md +4 -4
- package/docs/interfaces/PageHeaderWrapperProps.md +3 -3
- package/docs/interfaces/Patient.md +4 -4
- package/docs/interfaces/PatientBannerActionsMenuProps.md +5 -5
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +4 -4
- package/docs/interfaces/PatientIdentifier.md +6 -6
- package/docs/interfaces/PatientIdentifierType.md +10 -10
- package/docs/interfaces/PatientPhotoProps.md +3 -3
- package/docs/interfaces/PatientWithFullResponse.md +2 -2
- package/docs/interfaces/Person.md +22 -22
- package/docs/interfaces/PersonAddress.md +32 -32
- package/docs/interfaces/PersonAttribute.md +9 -9
- package/docs/interfaces/PersonName.md +16 -16
- package/docs/interfaces/PrimaryIdentifier.md +2 -2
- package/docs/interfaces/Privilege.md +4 -4
- package/docs/interfaces/Prompt.md +6 -6
- package/docs/interfaces/QueueItemDescriptor.md +5 -5
- package/docs/interfaces/RegisterDynamicRouteMessage.md +5 -5
- package/docs/interfaces/ResponsiveWrapperProps.md +2 -2
- package/docs/interfaces/Role.md +4 -4
- package/docs/interfaces/Session.md +8 -8
- package/docs/interfaces/SessionLocation.md +4 -4
- package/docs/interfaces/SetLeftNavParams.md +5 -5
- package/docs/interfaces/SnackbarDescriptor.md +10 -10
- package/docs/interfaces/SnackbarMeta.md +11 -11
- package/docs/interfaces/StyleguideConfigObject.md +10 -10
- package/docs/interfaces/SyncItem.md +8 -8
- package/docs/interfaces/SyncProcessOptions.md +6 -6
- package/docs/interfaces/ToastDescriptor.md +7 -7
- package/docs/interfaces/ToastNotificationMeta.md +8 -8
- package/docs/interfaces/UploadedFile.md +8 -8
- package/docs/interfaces/UseConfigOptions.md +2 -2
- package/docs/interfaces/UsePatientPhotoResult.md +4 -4
- package/docs/interfaces/UseServerFetchAllOptions.md +5 -5
- package/docs/interfaces/UseServerInfiniteOptions.md +4 -4
- package/docs/interfaces/UseServerPaginationOptions.md +4 -4
- package/docs/interfaces/User.md +6 -6
- package/docs/interfaces/UserHasAccessProps.md +4 -4
- package/docs/interfaces/Visit.md +10 -10
- package/docs/interfaces/VisitItem.md +5 -5
- package/docs/interfaces/VisitReturnType.md +8 -8
- package/docs/interfaces/VisitStoreState.md +4 -4
- package/docs/interfaces/VisitType.md +4 -4
- package/docs/interfaces/WorkspaceContainerProps.md +6 -6
- package/docs/interfaces/WorkspaceRegistration.md +12 -12
- package/docs/interfaces/WorkspacesInfo.md +12 -8
- package/docs/type-aliases/ActionFunction.md +1 -1
- package/docs/type-aliases/ActionableNotificationType.md +1 -1
- package/docs/type-aliases/Actions.md +1 -1
- package/docs/type-aliases/ArgumentsTuple.md +1 -1
- package/docs/type-aliases/BoundActions.md +1 -1
- package/docs/type-aliases/ConfigValue.md +1 -1
- package/docs/type-aliases/ContextCallback.md +2 -2
- package/docs/type-aliases/CoreTranslationKey.md +1 -1
- package/docs/type-aliases/CurrentPatient.md +1 -1
- package/docs/type-aliases/DefaultEvaluateReturnType.md +1 -1
- package/docs/type-aliases/ExtensionProps.md +1 -1
- package/docs/type-aliases/IconProps.md +4 -4
- package/docs/type-aliases/InlineNotificationType.md +1 -1
- package/docs/type-aliases/Key.md +1 -1
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +1 -1
- package/docs/type-aliases/LayoutType.md +1 -1
- package/docs/type-aliases/LoadedSessionStore.md +3 -3
- package/docs/type-aliases/NullablePatient.md +1 -1
- package/docs/type-aliases/OfflineMode.md +1 -1
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +1 -1
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +1 -1
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +4 -4
- package/docs/type-aliases/PageHeaderProps.md +1 -1
- package/docs/type-aliases/PatientUuid.md +1 -1
- package/docs/type-aliases/PictogramProps.md +3 -3
- package/docs/type-aliases/ProvidedConfig.md +3 -3
- package/docs/type-aliases/ResourceName.md +1 -1
- package/docs/type-aliases/SessionStore.md +1 -1
- package/docs/type-aliases/SnackbarType.md +1 -1
- package/docs/type-aliases/SvgIconProps.md +3 -3
- package/docs/type-aliases/SvgPictogramProps.md +3 -3
- package/docs/type-aliases/TemplateParams.md +1 -1
- package/docs/type-aliases/ToastType.md +1 -1
- package/docs/type-aliases/UnloadedSessionStore.md +3 -3
- package/docs/type-aliases/UpdateVisitPayload.md +1 -1
- package/docs/type-aliases/UseOpenmrsSWROptions.md +5 -5
- package/docs/type-aliases/Validator.md +1 -1
- package/docs/type-aliases/ValidatorFunction.md +1 -1
- package/docs/type-aliases/VariablesMap.md +1 -1
- package/docs/variables/ActionMenuButton.md +1 -1
- package/docs/variables/ActivityIcon.md +1 -1
- package/docs/variables/AddIcon.md +1 -1
- package/docs/variables/AllergiesIcon.md +1 -1
- package/docs/variables/AppointmentsPictogram.md +1 -1
- package/docs/variables/ArrowDownIcon.md +1 -1
- package/docs/variables/ArrowLeftIcon.md +1 -1
- package/docs/variables/ArrowRightIcon.md +1 -1
- package/docs/variables/ArrowUpIcon.md +1 -1
- package/docs/variables/AttachmentIcon.md +1 -1
- package/docs/variables/BabyIcon.md +1 -1
- package/docs/variables/CalendarHeatMapIcon.md +1 -1
- package/docs/variables/CalendarIcon.md +1 -1
- package/docs/variables/CaretDownIcon.md +1 -1
- package/docs/variables/CaretLeftIcon.md +1 -1
- package/docs/variables/CaretRightIcon.md +1 -1
- package/docs/variables/CaretUpIcon.md +1 -1
- package/docs/variables/ChartAverageIcon.md +1 -1
- package/docs/variables/CheckmarkFilledIcon.md +1 -1
- package/docs/variables/CheckmarkOutlineIcon.md +1 -1
- package/docs/variables/ChemistryIcon.md +1 -1
- package/docs/variables/ChevronDownIcon.md +1 -1
- package/docs/variables/ChevronLeftIcon.md +1 -1
- package/docs/variables/ChevronRightIcon.md +1 -1
- package/docs/variables/ChevronUpIcon.md +1 -1
- package/docs/variables/CloseFilledIcon.md +1 -1
- package/docs/variables/CloseIcon.md +1 -1
- package/docs/variables/CloseOutlineIcon.md +1 -1
- package/docs/variables/ConditionsIcon.md +1 -1
- package/docs/variables/DiagnosisTags.md +1 -1
- package/docs/variables/DocumentAttachmentIcon.md +1 -1
- package/docs/variables/DocumentIcon.md +1 -1
- package/docs/variables/DownloadIcon.md +1 -1
- package/docs/variables/DrugOrderIcon.md +1 -1
- package/docs/variables/EditIcon.md +1 -1
- package/docs/variables/ErrorState.md +1 -1
- package/docs/variables/EventScheduleIcon.md +1 -1
- package/docs/variables/EventsIcon.md +1 -1
- package/docs/variables/Extension.md +1 -1
- package/docs/variables/GenderFemaleIcon.md +1 -1
- package/docs/variables/GenderMaleIcon.md +1 -1
- package/docs/variables/GenderOtherIcon.md +1 -1
- package/docs/variables/GenderUnknownIcon.md +1 -1
- package/docs/variables/GenericOrderTypeIcon.md +1 -1
- package/docs/variables/GroupAccessIcon.md +1 -1
- package/docs/variables/GroupIcon.md +1 -1
- package/docs/variables/HomePictogram.md +1 -1
- package/docs/variables/HospitalBedIcon.md +1 -1
- package/docs/variables/Icon.md +1 -1
- package/docs/variables/ImageMedicalIcon.md +1 -1
- package/docs/variables/InPatientPictogram.md +1 -1
- package/docs/variables/InformationFilledIcon.md +1 -1
- package/docs/variables/InformationIcon.md +1 -1
- package/docs/variables/InformationSquareIcon.md +1 -1
- package/docs/variables/InventoryManagementIcon.md +1 -1
- package/docs/variables/LabOrderIcon.md +1 -1
- package/docs/variables/LaboratoryPictogram.md +1 -1
- package/docs/variables/LeftNavMenu.md +1 -1
- package/docs/variables/ListCheckedIcon.md +1 -1
- package/docs/variables/LocationIcon.md +1 -1
- package/docs/variables/LocationPicker.md +1 -1
- package/docs/variables/MaterialOrderIcon.md +1 -1
- package/docs/variables/MaximizeIcon.md +1 -1
- package/docs/variables/MaybeIcon.md +1 -1
- package/docs/variables/MaybePictogram.md +1 -1
- package/docs/variables/MedicationIcon.md +1 -1
- package/docs/variables/MessageQueueIcon.md +1 -1
- package/docs/variables/MicroscopeIcon.md +1 -1
- package/docs/variables/MoneyIcon.md +1 -1
- package/docs/variables/MotherIcon.md +1 -1
- package/docs/variables/MovementIcon.md +1 -1
- package/docs/variables/OpenmrsDatePicker.md +1 -1
- package/docs/variables/OverflowMenuHorizontalIcon.md +1 -1
- package/docs/variables/OverflowMenuVerticalIcon.md +1 -1
- package/docs/variables/PageHeader.md +1 -1
- package/docs/variables/PageHeaderContent.md +1 -1
- package/docs/variables/PasswordIcon.md +1 -1
- package/docs/variables/PatientListsPictogram.md +1 -1
- package/docs/variables/PedestrianFamilyIcon.md +1 -1
- package/docs/variables/PenIcon.md +1 -1
- package/docs/variables/PharmacyPictogram.md +1 -1
- package/docs/variables/Pictogram.md +1 -1
- package/docs/variables/PrinterIcon.md +1 -1
- package/docs/variables/ProcedureOrderIcon.md +1 -1
- package/docs/variables/ProgramsIcon.md +1 -1
- package/docs/variables/RadiologyIcon.md +1 -1
- package/docs/variables/ReferralOrderIcon.md +1 -1
- package/docs/variables/RegistrationPictogram.md +1 -1
- package/docs/variables/RenderIfValueIsTruthy.md +1 -1
- package/docs/variables/RenewIcon.md +1 -1
- package/docs/variables/ReportIcon.md +1 -1
- package/docs/variables/ResetIcon.md +1 -1
- package/docs/variables/ResponsiveWrapper.md +1 -1
- package/docs/variables/SaveIcon.md +1 -1
- package/docs/variables/SearchIcon.md +1 -1
- package/docs/variables/ServiceQueuesPictogram.md +1 -1
- package/docs/variables/ShoppingCartAddItemIcon.md +1 -1
- package/docs/variables/ShoppingCartArrowDownIcon.md +1 -1
- package/docs/variables/ShoppingCartIcon.md +1 -1
- package/docs/variables/StickyNoteAddIcon.md +1 -1
- package/docs/variables/StockManagementPictogram.md +1 -1
- package/docs/variables/SwitcherIcon.md +1 -1
- package/docs/variables/SyringeIcon.md +1 -1
- package/docs/variables/TableIcon.md +1 -1
- package/docs/variables/TableOfContentsIcon.md +1 -1
- package/docs/variables/TimeIcon.md +1 -1
- package/docs/variables/ToolsIcon.md +1 -1
- package/docs/variables/TranslateIcon.md +1 -1
- package/docs/variables/TrashCanIcon.md +1 -1
- package/docs/variables/TreeViewAltIcon.md +1 -1
- package/docs/variables/UserAvatarIcon.md +1 -1
- package/docs/variables/UserFollowIcon.md +1 -1
- package/docs/variables/UserHasAccess.md +1 -1
- package/docs/variables/UserIcon.md +1 -1
- package/docs/variables/UserXrayIcon.md +1 -1
- package/docs/variables/ViewIcon.md +1 -1
- package/docs/variables/ViewOffIcon.md +1 -1
- package/docs/variables/WarningIcon.md +1 -1
- package/docs/variables/attachmentUrl.md +1 -1
- package/docs/variables/backendDependencies.md +1 -1
- package/docs/variables/defaultVisitCustomRepresentation.md +1 -1
- package/docs/variables/fhirBaseUrl.md +1 -1
- package/docs/variables/getAsyncExtensionLifecycle.md +1 -1
- package/docs/variables/getStartedVisit.md +1 -1
- package/docs/variables/isUrl.md +1 -1
- package/docs/variables/offlineUuidPrefix.md +1 -1
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +1 -1
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +1 -1
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +1 -1
- package/docs/variables/restBaseUrl.md +1 -1
- package/docs/variables/sessionEndpoint.md +1 -1
- package/docs/variables/useConnectedExtensions.md +1 -1
- package/docs/variables/useExtensionStore.md +1 -1
- package/docs/variables/validators.md +1 -1
- package/package.json +21 -21
- package/typedoc.json +1 -0
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **filterBreadcrumbs**(`list`, `path`): [`BreadcrumbRegistration`](../interfaces/BreadcrumbRegistration.md)[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/filter.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/filter.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/breadcrumbs/filter.ts#L34)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **generateOfflineUuid**(): `string`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/uuid-support.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/uuid-support.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid-support.ts#L7)
|
8
8
|
|
9
9
|
Generates a UUID-like string which is used for uniquely identifying objects while offline.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getAssignedExtensions**(`slotName`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/extensions.ts:399](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/extensions.ts:399](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L399)
|
8
8
|
|
9
9
|
Gets the list of extensions assigned to a given slot
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getAsyncLifecycle**\<`T`\>(`lazy`, `options`): () => `Promise`\<`ReactAppOrParcel`\<`T`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L18)
|
8
8
|
|
9
9
|
## Type Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getAttachmentByUuid**(`attachmentUuid`, `abortController`): `Promise`\<`FetchResponse`\<`any`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/attachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/attachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L7)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getAttachments**(`patientUuid`, `includeEncounterless`, `abortController`): `Promise`\<`FetchResponse`\<`any`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/attachments.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/attachments.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L13)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getBreadcrumbs**(): [`BreadcrumbRegistration`](../interfaces/BreadcrumbRegistration.md)[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/breadcrumbs/db.ts#L32)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getBreadcrumbsFor**(`path`): [`BreadcrumbRegistration`](../interfaces/BreadcrumbRegistration.md)[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/filter.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/breadcrumbs/filter.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/breadcrumbs/filter.ts#L54)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getConfig**\<`T`\>(`moduleName`): `Promise`\<`T`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:277](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:277](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L277)
|
8
8
|
|
9
9
|
A promise-based way to access the config as soon as it is fully loaded.
|
10
10
|
If it is already loaded, resolves the config in its present state.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getContext**\<`T`\>(`namespace`): `null` \| `Readonly`\<`T`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-context/src/context.ts:
|
7
|
+
Defined in: [packages/framework/esm-context/src/context.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L62)
|
8
8
|
|
9
9
|
Returns an _immutable_ version of the state of the namespace as it is currently
|
10
10
|
|
@@ -12,7 +12,7 @@ Returns an _immutable_ version of the state of the namespace as it is currently
|
|
12
12
|
|
13
13
|
### T
|
14
14
|
|
15
|
-
`T` *extends* `
|
15
|
+
`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
|
16
16
|
|
17
17
|
The type of the value stored in the namespace
|
18
18
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getCoreTranslation**(`key`, `defaultText?`, `options?`): `string`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-translations/src/index.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-translations/src/index.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-translations/src/index.ts#L66)
|
8
8
|
|
9
9
|
Use this function to obtain a translation from the core translations. This is a way to avoid having
|
10
10
|
to define common translations in your app, and to ensure that translations are consistent across
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getCurrentOfflineMode**(): [`OfflineModeResult`](../interfaces/OfflineModeResult.md)
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/mode.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/mode.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L45)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
> **getCurrentUser**(): `Observable`\<[`Session`](../interfaces/Session.md)\>
|
8
8
|
|
9
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/
|
9
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L66)
|
10
10
|
|
11
11
|
The getCurrentUser function returns an observable that produces
|
12
12
|
**zero or more values, over time**. It will produce zero values
|
@@ -47,7 +47,7 @@ leak and source of bugs.
|
|
47
47
|
|
48
48
|
> **getCurrentUser**(`opts`): `Observable`\<[`Session`](../interfaces/Session.md)\>
|
49
49
|
|
50
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/
|
50
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L67)
|
51
51
|
|
52
52
|
The getCurrentUser function returns an observable that produces
|
53
53
|
**zero or more values, over time**. It will produce zero values
|
@@ -102,7 +102,7 @@ leak and source of bugs.
|
|
102
102
|
|
103
103
|
> **getCurrentUser**(`opts`): `Observable`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>
|
104
104
|
|
105
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/
|
105
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L68)
|
106
106
|
|
107
107
|
The getCurrentUser function returns an observable that produces
|
108
108
|
**zero or more values, over time**. It will produce zero values
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getDynamicOfflineDataEntries**\<`T`\>(`type?`): `Promise`\<`T`[]\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L128)
|
8
8
|
|
9
9
|
Returns all [DynamicOfflineData](../interfaces/DynamicOfflineData.md) entries which registered for the currently logged in user.
|
10
10
|
Optionally returns only entries of a given type.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getDynamicOfflineDataEntriesFor**\<`T`\>(`userId`, `type?`): `Promise`\<`T`[]\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:139](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:139](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L139)
|
8
8
|
|
9
9
|
Returns all [DynamicOfflineData](../interfaces/DynamicOfflineData.md) entries which registered for the given user.
|
10
10
|
Optionally returns only entries of a given type.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getDynamicOfflineDataHandlers**(): [`DynamicOfflineDataHandler`](../interfaces/DynamicOfflineDataHandler.md)[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L104)
|
8
8
|
|
9
9
|
Returns all handlers which have been setup using the [setupDynamicOfflineDataHandler](setupDynamicOfflineDataHandler.md) function.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getExtensionNameFromId**(`extensionId`): `string`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/extensions.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/extensions.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L163)
|
8
8
|
|
9
9
|
Given an extension ID, which is a string uniquely identifying
|
10
10
|
an instance of an extension within an extension slot, this
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getExtensionStore**(): `StoreApi`\<[`ExtensionStore`](../interfaces/ExtensionStore.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-extensions/src/store.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-extensions/src/store.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L125)
|
8
8
|
|
9
9
|
This returns a store that modules can use to get information about the
|
10
10
|
state of the extension system.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getFeatureFlag**(`flagName`): `boolean`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-feature-flags/src/feature-flags.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-feature-flags/src/feature-flags.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L87)
|
8
8
|
|
9
9
|
Use this function to access the current value of the feature flag
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getFhirServerPaginationHandlers**\<`T`\>(): `FhirServerPaginationHandlers`\<`T`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useFhirPagination.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useFhirPagination.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useFhirPagination.ts#L36)
|
8
8
|
|
9
9
|
## Type Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getFullSynchronizationItems**\<`T`\>(`type?`): `Promise`\<[`SyncItem`](../interfaces/SyncItem.md)\<`T`\>[]\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/sync.ts:302](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/sync.ts:302](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L302)
|
8
8
|
|
9
9
|
Returns all currently queued up sync items of the currently signed in user.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getFullSynchronizationItemsFor**\<`T`\>(`userId`, `type?`): `Promise`\<[`SyncItem`](../interfaces/SyncItem.md)\<`T`\>[]\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/sync.ts:281](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/sync.ts:281](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L281)
|
8
8
|
|
9
9
|
Returns all currently queued up sync items of a given user.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getGlobalStore**\<`T`\>(`name`, `fallbackState?`): `StoreApi`\<`T`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-state/src/state.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-state/src/state.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L92)
|
8
8
|
|
9
9
|
Returns the existing store named `name`,
|
10
10
|
or creates a new store named `name` if none exists.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getHistory**(): `string`[]
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/history/history.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/history/history.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/history/history.ts#L47)
|
8
8
|
|
9
9
|
Returns a list of URLs representing the history of the current window session.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getLifecycle**\<`T`\>(`Component`, `options`): `ReactAppOrParcel`\<`T`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L10)
|
8
8
|
|
9
9
|
## Type Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getLocations**(`tagUuidOrName`, `query`): `Observable`\<[`Location`](../interfaces/Location.md)[]\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/location.ts#L14)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getLoggedInUser**(): `Promise`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L201)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getOfflinePatientDataStore**(): `StoreApi`\<[`OfflinePatientDataSyncStore`](../interfaces/OfflinePatientDataSyncStore.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L39)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getSessionLocation**(): `Promise`\<`undefined` \| [`SessionLocation`](../interfaces/SessionLocation.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L222)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getSessionStore**(): `StoreApi`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/current-user.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/current-user.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L93)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getSyncLifecycle**\<`T`\>(`Component`, `options`): () => `Promise`\<`ReactAppOrParcel`\<`T`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L25)
|
8
8
|
|
9
9
|
## Type Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getSynchronizationItem**\<`T`\>(`id`): `Promise`\<`undefined` \| [`SyncItem`](../interfaces/SyncItem.md)\<`T`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/sync.ts:311](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/sync.ts:311](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L311)
|
8
8
|
|
9
9
|
Returns a queued sync item with the given ID or `undefined` if no such item exists.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getSynchronizationItems**\<`T`\>(`type?`): `Promise`\<`T`[]\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/sync.ts:293](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/sync.ts:293](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L293)
|
8
8
|
|
9
9
|
Returns the content of all currently queued up sync items of the currently signed in user.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getVisitStore**(): `StoreApi`\<[`VisitStoreState`](../interfaces/VisitStoreState.md)\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L57)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getVisitTypes**(): `Observable`\<[`VisitType`](../interfaces/VisitType.md)[]\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-type.ts#L15)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`\<`FetchResponse`\<\{ `results`: [`Visit`](../interfaces/Visit.md)[]; \}\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L110)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **goBackInHistory**(`toUrl:`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/history/history.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/history/history.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/history/history.ts#L58)
|
8
8
|
|
9
9
|
Rolls back the history to the specified point and navigates to that URL.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **importDynamic**\<`T`\>(`jsPackage`, `share`, `options?`): `Promise`\<`T`\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-dynamic-loading/src/dynamic-loading.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-dynamic-loading/src/dynamic-loading.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-dynamic-loading/src/dynamic-loading.ts#L37)
|
8
8
|
|
9
9
|
Loads the named export from a named package. This might be used like:
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **inRange**(`min`, `max`): [`Validator`](../type-aliases/Validator.md)
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/validators/validators.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-config/src/validators/validators.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L10)
|
8
8
|
|
9
9
|
Verifies that the value is between the provided minimum and maximum
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **interpolateString**(`template`, `params`): `string`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/navigation/interpolate-string.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/navigation/interpolate-string.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/navigation/interpolate-string.ts#L60)
|
8
8
|
|
9
9
|
Interpolates values of `params` into the `template` string.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **interpolateUrl**(`template`, `additionalParams?`): `string`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/navigation/interpolate-string.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/navigation/interpolate-string.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/navigation/interpolate-string.ts#L36)
|
8
8
|
|
9
9
|
Interpolates a string with openmrsBase and openmrsSpaBase.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **isDesktop**(`layout`): layout is "small-desktop" \| "large-desktop"
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-react-utils/src/useLayoutType.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useLayoutType.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L40)
|
8
8
|
|
9
9
|
## Parameters
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **isDevEnabled**(): `boolean`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/environment.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/environment.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/environment.ts#L3)
|
8
8
|
|
9
9
|
## Returns
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **isOfflineUuid**(`uuid`): `boolean`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/uuid-support.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/uuid-support.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid-support.ts#L12)
|
8
8
|
|
9
9
|
Checks whether the given string has the format of an offline UUID generated by [generateOfflineUuid](generateOfflineUuid.md)
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](../type-aliases/Validator.md)
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/validators/validators.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-config/src/validators/validators.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L21)
|
8
8
|
|
9
9
|
Verifies that a string contains only the default URL template
|
10
10
|
parameters, plus any specified in `allowedTemplateParameters`.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **launchWorkspace**\<`T`\>(`name`, `additionalProps?`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L296)
|
8
8
|
|
9
9
|
This launches a workspace by its name. The workspace must have been registered.
|
10
10
|
Workspaces should be registered in the `routes.json` file.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **launchWorkspaceGroup**(`groupName`, `args`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:210](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:210](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L210)
|
8
8
|
|
9
9
|
Launches a workspace group with the specified name and configuration.
|
10
10
|
If there are any open workspaces, it will first close them before launching the new workspace group.
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **makeUrl**(`path`): `string`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L22)
|
8
8
|
|
9
9
|
Append `path` to the OpenMRS SPA base.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **messageOmrsServiceWorker**(`message`): `Promise`\<[`MessageServiceWorkerResult`](../interfaces/MessageServiceWorkerResult.md)\<`any`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L11)
|
8
8
|
|
9
9
|
Sends the specified message to the application's service worker.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **navigate**(`to`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-navigation/src/navigation/navigate.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-navigation/src/navigation/navigate.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/navigation/navigate.ts#L49)
|
8
8
|
|
9
9
|
Calls `location.assign` for non-SPA paths and [navigateToUrl](https://single-spa.js.org/docs/api/#navigatetourl) for SPA paths
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **navigateAndLaunchWorkspace**(`__namedParameters`): `void`
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L389)
|
8
8
|
|
9
9
|
Use this function to navigate to a new page and launch a workspace on that page.
|
10
10
|
|
package/docs/functions/oneOf.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **oneOf**(`allowedValues`): [`Validator`](../type-aliases/Validator.md)
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-config/src/validators/validators.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-config/src/validators/validators.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L58)
|
8
8
|
|
9
9
|
Verifies that the value is one of the allowed options.
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **openmrsFetch**\<`T`\>(`path`, `fetchInit`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`T`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L82)
|
8
8
|
|
9
9
|
The openmrsFetch function is a wrapper around the
|
10
10
|
[browser's built-in fetch function](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch),
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
> **openmrsObservableFetch**\<`T`\>(`url`, `fetchInit`): `Observable`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`T`\>\>
|
6
6
|
|
7
|
-
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:269](https://github.com/openmrs/openmrs-esm-core/blob/
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:269](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L269)
|
8
8
|
|
9
9
|
The openmrsObservableFetch function is a wrapper around openmrsFetch
|
10
10
|
that returns an [Observable](https://rxjs-dev.firebaseapp.com/guide/observable)
|