@openmrs/esm-framework 6.3.1-pre.3106 → 6.3.1-pre.3124
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 +2 -2
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +310 -8579
- package/docs/classes/OpenmrsFetchError.md +88 -117
- package/docs/enumerations/Type.md +77 -0
- package/docs/enumerations/VisitMode.md +29 -0
- package/docs/enumerations/VisitStatus.md +21 -0
- package/docs/functions/ConfigurableLink.md +19 -0
- package/docs/functions/CustomOverflowMenu.md +17 -0
- package/docs/functions/DashboardExtension.md +17 -0
- package/docs/functions/ExtensionSlot.md +46 -0
- package/docs/functions/OpenmrsAppContext.md +36 -0
- package/docs/functions/PatientBannerActionsMenu.md +17 -0
- package/docs/functions/PatientBannerContactDetails.md +17 -0
- package/docs/functions/PatientBannerPatientIdentifiers.md +17 -0
- package/docs/functions/PatientBannerPatientInfo.md +17 -0
- package/docs/functions/PatientBannerToggleContactDetailsButton.md +17 -0
- package/docs/functions/PatientPhoto.md +19 -0
- package/docs/functions/WorkspaceContainer.md +55 -0
- package/docs/functions/age.md +32 -0
- package/docs/functions/attach.md +40 -0
- package/docs/functions/beginEditSynchronizationItem.md +22 -0
- package/docs/functions/canAccessStorage.md +25 -0
- package/docs/functions/canBeginEditSynchronizationItemsOfType.md +22 -0
- package/docs/functions/clearCurrentUser.md +11 -0
- package/docs/functions/closeWorkspace.md +27 -0
- package/docs/functions/compile.md +30 -0
- package/docs/functions/convertToLocaleCalendar.md +25 -0
- package/docs/functions/createAttachment.md +21 -0
- package/docs/functions/createErrorHandler.md +21 -0
- package/docs/functions/createGlobalStore.md +36 -0
- package/docs/functions/createUseStore.md +66 -0
- package/docs/functions/defineConfigSchema.md +33 -0
- package/docs/functions/defineExtensionConfigSchema.md +38 -0
- package/docs/functions/deleteAttachmentPermanently.md +21 -0
- package/docs/functions/deleteSynchronizationItem.md +21 -0
- package/docs/functions/detach.md +25 -0
- package/docs/functions/detachAll.md +21 -0
- package/docs/functions/dispatchNotificationShown.md +17 -0
- package/docs/functions/dispatchPrecacheStaticDependencies.md +17 -0
- package/docs/functions/displayName.md +21 -0
- package/docs/functions/evaluate.md +84 -0
- package/docs/functions/evaluateAsBoolean.md +31 -0
- package/docs/functions/evaluateAsBooleanAsync.md +31 -0
- package/docs/functions/evaluateAsNumber.md +31 -0
- package/docs/functions/evaluateAsNumberAsync.md +31 -0
- package/docs/functions/evaluateAsType.md +46 -0
- package/docs/functions/evaluateAsTypeAsync.md +46 -0
- package/docs/functions/evaluateAsync.md +87 -0
- package/docs/functions/extractVariableNames.md +50 -0
- package/docs/functions/fetchCurrentPatient.md +25 -0
- package/docs/functions/filterBreadcrumbs.md +21 -0
- package/docs/functions/formatDate.md +39 -0
- package/docs/functions/formatDatetime.md +29 -0
- package/docs/functions/formatPartialDate.md +39 -0
- package/docs/functions/formatPatientName.md +23 -0
- package/docs/functions/formatTime.md +20 -0
- package/docs/functions/formattedName.md +21 -0
- package/docs/functions/generateOfflineUuid.md +13 -0
- package/docs/functions/getAssignedExtensions.md +23 -0
- package/docs/functions/getAsyncLifecycle.md +31 -0
- package/docs/functions/getAttachmentByUuid.md +21 -0
- package/docs/functions/getAttachments.md +25 -0
- package/docs/functions/getBreadcrumbs.md +11 -0
- package/docs/functions/getBreadcrumbsFor.md +17 -0
- package/docs/functions/getConfig.md +31 -0
- package/docs/functions/getContext.md +29 -0
- package/docs/functions/getCoreTranslation.md +35 -0
- package/docs/functions/getCurrentOfflineMode.md +11 -0
- package/docs/functions/getCurrentUser.md +154 -0
- package/docs/functions/getDefaultCalendar.md +21 -0
- package/docs/functions/getDefaultsFromConfigSchema.md +32 -0
- package/docs/functions/getDynamicOfflineDataEntries.md +28 -0
- package/docs/functions/getDynamicOfflineDataEntriesFor.md +34 -0
- package/docs/functions/getDynamicOfflineDataHandlers.md +13 -0
- package/docs/functions/getExtensionNameFromId.md +30 -0
- package/docs/functions/getExtensionStore.md +14 -0
- package/docs/functions/getFeatureFlag.md +21 -0
- package/docs/functions/getFhirServerPaginationHandlers.md +17 -0
- package/docs/functions/getFullSynchronizationItems.md +27 -0
- package/docs/functions/getFullSynchronizationItemsFor.md +33 -0
- package/docs/functions/getGlobalStore.md +36 -0
- package/docs/functions/getHistory.md +13 -0
- package/docs/functions/getLifecycle.md +27 -0
- package/docs/functions/getLocale.md +15 -0
- package/docs/functions/getLocations.md +21 -0
- package/docs/functions/getLoggedInUser.md +11 -0
- package/docs/functions/getOfflinePatientDataStore.md +15 -0
- package/docs/functions/getPatientName.md +26 -0
- package/docs/functions/getSessionLocation.md +11 -0
- package/docs/functions/getSessionStore.md +11 -0
- package/docs/functions/getSyncLifecycle.md +31 -0
- package/docs/functions/getSynchronizationItem.md +27 -0
- package/docs/functions/getSynchronizationItems.md +27 -0
- package/docs/functions/getVisitStore.md +11 -0
- package/docs/functions/getVisitTypes.md +11 -0
- package/docs/functions/getVisitsForPatient.md +29 -0
- package/docs/functions/goBackInHistory.md +25 -0
- package/docs/functions/importDynamic.md +58 -0
- package/docs/functions/inRange.md +27 -0
- package/docs/functions/interpolateString.md +34 -0
- package/docs/functions/interpolateUrl.md +48 -0
- package/docs/functions/isDesktop.md +17 -0
- package/docs/functions/isDevEnabled.md +11 -0
- package/docs/functions/isOfflineUuid.md +19 -0
- package/docs/functions/isOmrsDateStrict.md +20 -0
- package/docs/functions/isOmrsDateToday.md +19 -0
- package/docs/functions/isOnline.md +17 -0
- package/docs/functions/isUrlWithTemplateParameters.md +22 -0
- package/docs/functions/isVersionSatisfied.md +21 -0
- package/docs/functions/launchWorkspace.md +56 -0
- package/docs/functions/launchWorkspaceGroup.md +38 -0
- package/docs/functions/makeUrl.md +26 -0
- package/docs/functions/messageOmrsServiceWorker.md +23 -0
- package/docs/functions/navigate.md +48 -0
- package/docs/functions/navigateAndLaunchWorkspace.md +33 -0
- package/docs/functions/oneOf.md +21 -0
- package/docs/functions/openmrsFetch.md +75 -0
- package/docs/functions/openmrsObservableFetch.md +55 -0
- package/docs/functions/parseDate.md +20 -0
- package/docs/functions/provide.md +21 -0
- package/docs/functions/putDynamicOfflineData.md +28 -0
- package/docs/functions/putDynamicOfflineDataFor.md +34 -0
- package/docs/functions/queueSynchronizationItem.md +39 -0
- package/docs/functions/refetchCurrentUser.md +33 -0
- package/docs/functions/registerBreadcrumb.md +17 -0
- package/docs/functions/registerBreadcrumbs.md +17 -0
- package/docs/functions/registerContext.md +34 -0
- package/docs/functions/registerDefaultCalendar.md +33 -0
- package/docs/functions/registerFeatureFlag.md +36 -0
- package/docs/functions/registerOfflinePatientHandler.md +25 -0
- package/docs/functions/removeDynamicOfflineData.md +28 -0
- package/docs/functions/removeDynamicOfflineDataFor.md +34 -0
- package/docs/functions/renderExtension.md +41 -0
- package/docs/functions/reportError.md +17 -0
- package/docs/functions/retry.md +44 -0
- package/docs/functions/saveVisit.md +21 -0
- package/docs/functions/selectPreferredName.md +46 -0
- package/docs/functions/setCurrentVisit.md +21 -0
- package/docs/functions/setLeftNav.md +23 -0
- package/docs/functions/setSessionLocation.md +21 -0
- package/docs/functions/setUserLanguage.md +17 -0
- package/docs/functions/setUserProperties.md +23 -0
- package/docs/functions/setupDynamicOfflineDataHandler.md +22 -0
- package/docs/functions/setupOfflineSync.md +49 -0
- package/docs/functions/shallowEqual.md +32 -0
- package/docs/functions/showActionableNotification.md +21 -0
- package/docs/functions/showModal.md +44 -0
- package/docs/functions/showNotification.md +21 -0
- package/docs/functions/showSnackbar.md +21 -0
- package/docs/functions/showToast.md +21 -0
- package/docs/functions/subscribeActionableNotificationShown.md +21 -0
- package/docs/functions/subscribeConnectivity.md +21 -0
- package/docs/functions/subscribeConnectivityChanged.md +21 -0
- package/docs/functions/subscribeNotificationShown.md +21 -0
- package/docs/functions/subscribePrecacheStaticDependencies.md +21 -0
- package/docs/functions/subscribeSnackbarShown.md +21 -0
- package/docs/functions/subscribeTo.md +75 -0
- package/docs/functions/subscribeToContext.md +39 -0
- package/docs/functions/subscribeToastShown.md +21 -0
- package/docs/functions/syncAllDynamicOfflineData.md +27 -0
- package/docs/functions/syncDynamicOfflineData.md +33 -0
- package/docs/functions/syncOfflinePatientData.md +21 -0
- package/docs/functions/toDateObjectStrict.md +20 -0
- package/docs/functions/toLocationObject.md +17 -0
- package/docs/functions/toOmrsIsoString.md +23 -0
- package/docs/functions/toVisitTypeObject.md +17 -0
- package/docs/functions/translateFrom.md +55 -0
- package/docs/functions/unregisterContext.md +20 -0
- package/docs/functions/unsetLeftNav.md +23 -0
- package/docs/functions/updateContext.md +29 -0
- package/docs/functions/updateVisit.md +25 -0
- package/docs/functions/useAbortController.md +32 -0
- package/docs/functions/useAppContext.md +43 -0
- package/docs/functions/useAssignedExtensionIds.md +26 -0
- package/docs/functions/useAssignedExtensions.md +21 -0
- package/docs/functions/useAttachments.md +41 -0
- package/docs/functions/useBodyScrollLock.md +17 -0
- package/docs/functions/useConfig.md +27 -0
- package/docs/functions/useConnectivity.md +11 -0
- package/docs/functions/useDebounce.md +57 -0
- package/docs/functions/useDefineAppContext.md +70 -0
- package/docs/functions/useEmrConfiguration.md +35 -0
- package/docs/functions/useExtensionSlotMeta.md +25 -0
- package/docs/functions/useExtensionSlotStore.md +17 -0
- package/docs/functions/useFeatureFlag.md +30 -0
- package/docs/functions/useFhirFetchAll.md +44 -0
- package/docs/functions/useFhirInfinite.md +46 -0
- package/docs/functions/useFhirPagination.md +129 -0
- package/docs/functions/useLayoutType.md +11 -0
- package/docs/functions/useLeftNav.md +17 -0
- package/docs/functions/useLeftNavStore.md +11 -0
- package/docs/functions/useLocations.md +21 -0
- package/docs/functions/useOnClickOutside.md +27 -0
- package/docs/functions/useOnVisible.md +28 -0
- package/docs/functions/useOpenmrsFetchAll.md +46 -0
- package/docs/functions/useOpenmrsInfinite.md +54 -0
- package/docs/functions/useOpenmrsPagination.md +140 -0
- package/docs/functions/useOpenmrsSWR.md +71 -0
- package/docs/functions/usePagination.md +89 -0
- package/docs/functions/usePatient.md +38 -0
- package/docs/functions/usePatientPhoto.md +17 -0
- package/docs/functions/usePrimaryIdentifierCode.md +23 -0
- package/docs/functions/useRenderableExtensions.md +43 -0
- package/docs/functions/useSession.md +19 -0
- package/docs/functions/useStore.md +131 -0
- package/docs/functions/useStoreWithActions.md +33 -0
- package/docs/functions/useVisit.md +41 -0
- package/docs/functions/useVisitContextStore.md +23 -0
- package/docs/functions/useVisitTypes.md +11 -0
- package/docs/functions/useWorkspaces.md +11 -0
- package/docs/functions/userHasAccess.md +27 -0
- package/docs/functions/validator.md +44 -0
- package/docs/interfaces/ActionMenuButtonProps.md +33 -57
- package/docs/interfaces/ActionableNotificationDescriptor.md +32 -62
- package/docs/interfaces/AssignedExtension.md +30 -57
- package/docs/interfaces/Attachment.md +23 -47
- package/docs/interfaces/AttachmentResponse.md +20 -41
- package/docs/interfaces/AuditInfo.md +49 -88
- package/docs/interfaces/BreadcrumbRegistration.md +8 -17
- package/docs/interfaces/BreadcrumbSettings.md +18 -33
- package/docs/interfaces/CancelLoading.md +6 -10
- package/docs/interfaces/ClearDynamicRoutesMessage.md +9 -17
- package/docs/interfaces/CloseWorkspaceOptions.md +18 -29
- package/docs/interfaces/ComponentConfig.md +11 -23
- package/docs/interfaces/Concept.md +83 -131
- package/docs/interfaces/ConceptClass.md +46 -67
- package/docs/interfaces/ConceptDatatype.md +50 -74
- package/docs/interfaces/ConceptName.md +50 -74
- package/docs/interfaces/Config.md +4 -2
- package/docs/interfaces/ConfigObject.md +12 -21
- package/docs/interfaces/ConfigSchema.md +15 -27
- package/docs/interfaces/ConfigurableLinkProps.md +24 -4314
- package/docs/interfaces/ConnectedExtension.md +25 -41
- package/docs/interfaces/ConnectivityChangedEvent.md +4 -10
- package/docs/interfaces/CurrentPatientOptions.md +9 -18
- package/docs/interfaces/DashboardExtensionProps.md +13 -28
- package/docs/interfaces/DefaultWorkspaceProps.md +44 -51
- package/docs/interfaces/Diagnosis.md +80 -104
- package/docs/interfaces/DisplayConditionsConfigObject.md +18 -33
- package/docs/interfaces/DynamicOfflineData.md +23 -41
- package/docs/interfaces/DynamicOfflineDataHandler.md +47 -54
- package/docs/interfaces/DynamicOfflineDataSyncState.md +29 -39
- package/docs/interfaces/EmrApiConfigurationResponse.md +243 -350
- package/docs/interfaces/Encounter.md +67 -110
- package/docs/interfaces/EncounterProvider.md +39 -61
- package/docs/interfaces/EncounterRole.md +43 -68
- package/docs/interfaces/EncounterType.md +43 -68
- package/docs/interfaces/ErrorStateProps.md +7 -16
- package/docs/interfaces/ExtensionData.md +10 -22
- package/docs/interfaces/ExtensionMeta.md +4 -2
- package/docs/interfaces/ExtensionRegistration.md +36 -69
- package/docs/interfaces/ExtensionSlotBaseProps.md +35 -35
- package/docs/interfaces/ExtensionSlotConfig.md +20 -29
- package/docs/interfaces/ExtensionSlotConfigureValueObject.md +4 -2
- package/docs/interfaces/ExtensionSlotProps.md +3520 -0
- package/docs/interfaces/ExtensionSlotState.md +9 -18
- package/docs/interfaces/ExtensionStore.md +5 -11
- package/docs/interfaces/FHIRCode.md +11 -23
- package/docs/interfaces/FHIRLocationResource.md +25 -18
- package/docs/interfaces/FHIRResource.md +105 -41
- package/docs/interfaces/FeatureFlagDefinition.md +14 -26
- package/docs/interfaces/FetchConfig.md +80 -117
- package/docs/interfaces/FetchError.md +8 -21
- package/docs/interfaces/FetchHeaders.md +4 -2
- package/docs/interfaces/FetchResponse.md +124 -130
- package/docs/interfaces/FetchResponseJson.md +4 -2
- package/docs/interfaces/ImportMap.md +4 -10
- package/docs/interfaces/LeftNavStore.md +14 -29
- package/docs/interfaces/Link.md +11 -23
- package/docs/interfaces/Location.md +147 -250
- package/docs/interfaces/LoggedInUser.md +68 -70
- package/docs/interfaces/LoggedInUserFetchResponse.md +120 -128
- package/docs/interfaces/MessageServiceWorkerResult.md +17 -29
- package/docs/interfaces/NavigateOptions.md +9 -18
- package/docs/interfaces/NewVisitPayload.md +32 -48
- package/docs/interfaces/NotificationDescriptor.md +31 -58
- package/docs/interfaces/Obs.md +99 -166
- package/docs/interfaces/OfflineModeResult.md +11 -23
- package/docs/interfaces/OfflinePatientArgs.md +13 -20
- package/docs/interfaces/OfflinePatientDataSyncHandler.md +17 -27
- package/docs/interfaces/OfflinePatientDataSyncState.md +29 -51
- package/docs/interfaces/OfflinePatientDataSyncStore.md +13 -20
- package/docs/interfaces/OmrsServiceWorkerMessage.md +13 -23
- package/docs/interfaces/OnImportMapChangedMessage.md +12 -23
- package/docs/interfaces/OnlyThePatient.md +9 -17
- package/docs/interfaces/OpenWorkspace.md +116 -170
- package/docs/interfaces/OpenmrsAppContextProps.md +14 -23
- package/docs/interfaces/OpenmrsAppRoutes.md +41 -71
- package/docs/interfaces/OpenmrsDatePickerProps.md +346 -483
- package/docs/interfaces/OpenmrsResource.md +39 -57
- package/docs/interfaces/OpenmrsResourceStrict.md +27 -51
- package/docs/interfaces/PageHeaderContentProps.md +12 -24
- package/docs/interfaces/PageHeaderWrapperProps.md +9 -18
- package/docs/interfaces/Patient.md +41 -70
- package/docs/interfaces/PatientBannerActionsMenuProps.md +15 -30
- package/docs/interfaces/PatientBannerToggleContactDetailsButtonProps.md +17 -32
- package/docs/interfaces/PatientIdentifier.md +49 -84
- package/docs/interfaces/PatientIdentifierType.md +65 -112
- package/docs/interfaces/PatientPhotoProps.md +8 -17
- package/docs/interfaces/PatientWithFullResponse.md +9 -17
- package/docs/interfaces/Person.md +96 -160
- package/docs/interfaces/PersonAddress.md +136 -230
- package/docs/interfaces/PersonAttribute.md +43 -68
- package/docs/interfaces/PersonName.md +72 -118
- package/docs/interfaces/PrecacheStaticDependenciesEvent.md +3 -1
- package/docs/interfaces/PrimaryIdentifier.md +5 -11
- package/docs/interfaces/Privilege.md +11 -23
- package/docs/interfaces/Prompt.md +20 -41
- package/docs/interfaces/QueueItemDescriptor.md +23 -30
- package/docs/interfaces/RegisterDynamicRouteMessage.md +21 -38
- package/docs/interfaces/ResourceLoader.md +10 -14
- package/docs/interfaces/ResponsiveWrapperProps.md +5 -11
- package/docs/interfaces/RetryOptions.md +36 -37
- package/docs/interfaces/Role.md +10 -22
- package/docs/interfaces/Session.md +31 -54
- package/docs/interfaces/SessionLocation.md +10 -22
- package/docs/interfaces/SetLeftNavParams.md +15 -30
- package/docs/interfaces/ShowActionableNotificationEvent.md +26 -50
- package/docs/interfaces/ShowNotificationEvent.md +20 -38
- package/docs/interfaces/ShowSnackbarEvent.md +34 -64
- package/docs/interfaces/ShowToastEvent.md +22 -43
- package/docs/interfaces/SnackbarDescriptor.md +41 -76
- package/docs/interfaces/SnackbarMeta.md +55 -93
- package/docs/interfaces/SpaConfig.md +30 -40
- package/docs/interfaces/StyleguideConfigObject.md +39 -70
- package/docs/interfaces/SyncItem.md +34 -57
- package/docs/interfaces/SyncProcessOptions.md +22 -40
- package/docs/interfaces/ToastDescriptor.md +29 -55
- package/docs/interfaces/ToastNotificationMeta.md +40 -69
- package/docs/interfaces/UploadedFile.md +25 -49
- package/docs/interfaces/UseConfigOptions.md +6 -12
- package/docs/interfaces/UsePatientPhotoResult.md +12 -24
- package/docs/interfaces/UseServerFetchAllOptions.md +41 -61
- package/docs/interfaces/UseServerInfiniteOptions.md +29 -46
- package/docs/interfaces/UseServerPaginationOptions.md +26 -41
- package/docs/interfaces/User.md +34 -46
- package/docs/interfaces/UserHasAccessProps.md +13 -25
- package/docs/interfaces/Visit.md +36 -66
- package/docs/interfaces/VisitItem.md +16 -31
- package/docs/interfaces/VisitReturnType.md +24 -51
- package/docs/interfaces/VisitStoreState.md +14 -26
- package/docs/interfaces/VisitType.md +11 -23
- package/docs/interfaces/WorkspaceContainerProps.md +20 -38
- package/docs/interfaces/WorkspaceGroupDefinition.md +10 -19
- package/docs/interfaces/WorkspaceRegistration.md +43 -82
- package/docs/interfaces/WorkspacesInfo.md +30 -40
- package/docs/type-aliases/ActionFunction.md +27 -0
- package/docs/type-aliases/ActionableNotificationType.md +7 -0
- package/docs/type-aliases/Actions.md +13 -0
- package/docs/type-aliases/ArgumentsTuple.md +7 -0
- package/docs/type-aliases/BoundActions.md +17 -0
- package/docs/type-aliases/ConfigValue.md +7 -0
- package/docs/type-aliases/ContextCallback.md +23 -0
- package/docs/type-aliases/CoreTranslationKey.md +7 -0
- package/docs/type-aliases/CurrentPatient.md +7 -0
- package/docs/type-aliases/DateInput.md +7 -0
- package/docs/type-aliases/DefaultEvaluateReturnType.md +9 -0
- package/docs/type-aliases/ExtensionDefinition.md +69 -0
- package/docs/type-aliases/ExtensionProps.md +13 -0
- package/docs/type-aliases/FormatDateMode.md +7 -0
- package/docs/type-aliases/FormatDateOptions.md +102 -0
- package/docs/type-aliases/IconProps.md +31 -0
- package/docs/type-aliases/InlineNotificationType.md +7 -0
- package/docs/type-aliases/Key.md +7 -0
- package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md +7 -0
- package/docs/type-aliases/LayoutType.md +7 -0
- package/docs/type-aliases/LoadedSessionStore.md +23 -0
- package/docs/type-aliases/ModalDefinition.md +17 -0
- package/docs/type-aliases/NameUse.md +7 -0
- package/docs/type-aliases/NullablePatient.md +7 -0
- package/docs/type-aliases/OfflineMode.md +7 -0
- package/docs/type-aliases/OmrsOfflineCachingStrategy.md +12 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md +7 -0
- package/docs/type-aliases/OmrsOfflineHttpHeaders.md +44 -0
- package/docs/type-aliases/OpenmrsRoutes.md +10 -0
- package/docs/type-aliases/PageDefinition.md +41 -0
- package/docs/type-aliases/PageHeaderProps.md +7 -0
- package/docs/type-aliases/PatientUuid.md +7 -0
- package/docs/type-aliases/PictogramProps.md +23 -0
- package/docs/type-aliases/ProvidedConfig.md +23 -0
- package/docs/type-aliases/ResourceName.md +7 -0
- package/docs/type-aliases/SessionStore.md +7 -0
- package/docs/type-aliases/SnackbarType.md +7 -0
- package/docs/type-aliases/SpaEnvironment.md +7 -0
- package/docs/type-aliases/SvgIconProps.md +23 -0
- package/docs/type-aliases/SvgPictogramProps.md +27 -0
- package/docs/type-aliases/TemplateParams.md +11 -0
- package/docs/type-aliases/ToastType.md +7 -0
- package/docs/type-aliases/UnloadedSessionStore.md +23 -0
- package/docs/type-aliases/UpdateVisitPayload.md +7 -0
- package/docs/type-aliases/UseOpenmrsSWROptions.md +39 -0
- package/docs/type-aliases/Validator.md +17 -0
- package/docs/type-aliases/ValidatorFunction.md +17 -0
- package/docs/type-aliases/VariablesMap.md +13 -0
- package/docs/type-aliases/WorkspaceDefinition.md +78 -0
- package/docs/type-aliases/WorkspaceWindowState.md +7 -0
- package/docs/variables/ActionMenuButton.md +7 -0
- package/docs/variables/ActivityIcon.md +7 -0
- package/docs/variables/AddIcon.md +7 -0
- package/docs/variables/AllergiesIcon.md +7 -0
- package/docs/variables/AppointmentsPictogram.md +7 -0
- package/docs/variables/ArrowDownIcon.md +7 -0
- package/docs/variables/ArrowLeftIcon.md +7 -0
- package/docs/variables/ArrowRightIcon.md +7 -0
- package/docs/variables/ArrowUpIcon.md +7 -0
- package/docs/variables/AttachmentIcon.md +7 -0
- package/docs/variables/BabyIcon.md +7 -0
- package/docs/variables/CalendarHeatMapIcon.md +7 -0
- package/docs/variables/CalendarIcon.md +7 -0
- package/docs/variables/CaretDownIcon.md +7 -0
- package/docs/variables/CaretLeftIcon.md +7 -0
- package/docs/variables/CaretRightIcon.md +7 -0
- package/docs/variables/CaretUpIcon.md +7 -0
- package/docs/variables/ChartAverageIcon.md +7 -0
- package/docs/variables/CheckmarkFilledIcon.md +7 -0
- package/docs/variables/CheckmarkOutlineIcon.md +7 -0
- package/docs/variables/ChemistryIcon.md +7 -0
- package/docs/variables/ChevronDownIcon.md +7 -0
- package/docs/variables/ChevronLeftIcon.md +7 -0
- package/docs/variables/ChevronRightIcon.md +7 -0
- package/docs/variables/ChevronUpIcon.md +7 -0
- package/docs/variables/CloseFilledIcon.md +7 -0
- package/docs/variables/CloseIcon.md +7 -0
- package/docs/variables/CloseOutlineIcon.md +7 -0
- package/docs/variables/ConditionsIcon.md +11 -0
- package/docs/variables/DiagnosisTags.md +11 -0
- package/docs/variables/DocumentAttachmentIcon.md +7 -0
- package/docs/variables/DocumentIcon.md +7 -0
- package/docs/variables/DownloadIcon.md +7 -0
- package/docs/variables/DrugOrderIcon.md +7 -0
- package/docs/variables/EditIcon.md +7 -0
- package/docs/variables/ErrorState.md +7 -0
- package/docs/variables/EventScheduleIcon.md +7 -0
- package/docs/variables/EventsIcon.md +7 -0
- package/docs/variables/Extension.md +15 -0
- package/docs/variables/GenderFemaleIcon.md +7 -0
- package/docs/variables/GenderMaleIcon.md +7 -0
- package/docs/variables/GenderOtherIcon.md +7 -0
- package/docs/variables/GenderUnknownIcon.md +7 -0
- package/docs/variables/GenericOrderTypeIcon.md +7 -0
- package/docs/variables/GroupAccessIcon.md +7 -0
- package/docs/variables/GroupIcon.md +7 -0
- package/docs/variables/HomePictogram.md +7 -0
- package/docs/variables/HospitalBedIcon.md +7 -0
- package/docs/variables/Icon.md +9 -0
- package/docs/variables/ImageMedicalIcon.md +7 -0
- package/docs/variables/InPatientPictogram.md +7 -0
- package/docs/variables/InformationFilledIcon.md +7 -0
- package/docs/variables/InformationIcon.md +7 -0
- package/docs/variables/InformationSquareIcon.md +7 -0
- package/docs/variables/InventoryManagementIcon.md +7 -0
- package/docs/variables/LabOrderIcon.md +7 -0
- package/docs/variables/LaboratoryPictogram.md +7 -0
- package/docs/variables/LeftNavMenu.md +13 -0
- package/docs/variables/ListCheckedIcon.md +7 -0
- package/docs/variables/LocationIcon.md +7 -0
- package/docs/variables/LocationPicker.md +7 -0
- package/docs/variables/MaterialOrderIcon.md +7 -0
- package/docs/variables/MaximizeIcon.md +7 -0
- package/docs/variables/MaybeIcon.md +16 -0
- package/docs/variables/MaybePictogram.md +16 -0
- package/docs/variables/MedicationIcon.md +7 -0
- package/docs/variables/MessageQueueIcon.md +7 -0
- package/docs/variables/MicroscopeIcon.md +7 -0
- package/docs/variables/MoneyIcon.md +9 -0
- package/docs/variables/MotherIcon.md +7 -0
- package/docs/variables/MovementIcon.md +7 -0
- package/docs/variables/OpenmrsDatePicker.md +9 -0
- package/docs/variables/OverflowMenuHorizontalIcon.md +7 -0
- package/docs/variables/OverflowMenuVerticalIcon.md +7 -0
- package/docs/variables/PageHeader.md +30 -0
- package/docs/variables/PageHeaderContent.md +21 -0
- package/docs/variables/PasswordIcon.md +7 -0
- package/docs/variables/PatientListsPictogram.md +7 -0
- package/docs/variables/PedestrianFamilyIcon.md +7 -0
- package/docs/variables/PenIcon.md +7 -0
- package/docs/variables/PharmacyPictogram.md +7 -0
- package/docs/variables/Pictogram.md +9 -0
- package/docs/variables/PrinterIcon.md +7 -0
- package/docs/variables/ProcedureOrderIcon.md +7 -0
- package/docs/variables/ProgramsIcon.md +7 -0
- package/docs/variables/RadiologyIcon.md +7 -0
- package/docs/variables/ReferralOrderIcon.md +7 -0
- package/docs/variables/RegistrationPictogram.md +7 -0
- package/docs/variables/RenderIfValueIsTruthy.md +21 -0
- package/docs/variables/RenewIcon.md +7 -0
- package/docs/variables/ReportIcon.md +7 -0
- package/docs/variables/ResetIcon.md +7 -0
- package/docs/variables/ResponsiveWrapper.md +11 -0
- package/docs/variables/SaveIcon.md +7 -0
- package/docs/variables/SearchIcon.md +7 -0
- package/docs/variables/ServiceQueuesPictogram.md +7 -0
- package/docs/variables/ShoppingCartAddItemIcon.md +11 -0
- package/docs/variables/ShoppingCartArrowDownIcon.md +9 -0
- package/docs/variables/ShoppingCartIcon.md +9 -0
- package/docs/variables/StickyNoteAddIcon.md +9 -0
- package/docs/variables/StockManagementPictogram.md +7 -0
- package/docs/variables/SwitcherIcon.md +7 -0
- package/docs/variables/SyringeIcon.md +7 -0
- package/docs/variables/TableIcon.md +7 -0
- package/docs/variables/TableOfContentsIcon.md +9 -0
- package/docs/variables/TimeIcon.md +9 -0
- package/docs/variables/ToolsIcon.md +7 -0
- package/docs/variables/TranslateIcon.md +7 -0
- package/docs/variables/TrashCanIcon.md +7 -0
- package/docs/variables/TreeViewAltIcon.md +7 -0
- package/docs/variables/UserAvatarIcon.md +9 -0
- package/docs/variables/UserFollowIcon.md +7 -0
- package/docs/variables/UserHasAccess.md +35 -0
- package/docs/variables/UserIcon.md +7 -0
- package/docs/variables/UserXrayIcon.md +11 -0
- package/docs/variables/ViewIcon.md +7 -0
- package/docs/variables/ViewOffIcon.md +7 -0
- package/docs/variables/WarningIcon.md +7 -0
- package/docs/variables/attachmentUrl.md +7 -0
- package/docs/variables/backendDependencies.md +17 -0
- package/docs/variables/defaultVisitCustomRepresentation.md +7 -0
- package/docs/variables/fhirBaseUrl.md +7 -0
- package/docs/variables/getAsyncExtensionLifecycle.md +35 -0
- package/docs/variables/getStartedVisit.md +9 -0
- package/docs/variables/isUrl.md +9 -0
- package/docs/variables/offlineUuidPrefix.md +7 -0
- package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md +7 -0
- package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md +7 -0
- package/docs/variables/restBaseUrl.md +7 -0
- package/docs/variables/sessionEndpoint.md +7 -0
- package/docs/variables/useConnectedExtensions.md +25 -0
- package/docs/variables/useExtensionStore.md +55 -0
- package/docs/variables/validators.md +78 -0
- package/package.json +24 -20
- package/rspack.config.cjs +1 -8
- package/tsconfig.build.json +2 -1
- package/typedoc.json +16 -3
- package/docs/.nojekyll +0 -1
- package/docs/enums/Type.md +0 -107
- package/docs/enums/VisitMode.md +0 -41
- package/docs/enums/VisitStatus.md +0 -30
- package/docs/interfaces/ExtensionSlotConfigObject.md +0 -47
- package/docs/interfaces/OldExtensionSlotBaseProps.md +0 -67
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / attachmentUrl
|
2
|
+
|
3
|
+
# Variable: attachmentUrl
|
4
|
+
|
5
|
+
> `const` **attachmentUrl**: `"/ws/rest/v1/attachment"`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/attachments.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L5)
|
@@ -0,0 +1,17 @@
|
|
1
|
+
[O3 Framework](../API.md) / backendDependencies
|
2
|
+
|
3
|
+
# Variable: backendDependencies
|
4
|
+
|
5
|
+
> `const` **backendDependencies**: `object`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-backend-dependencies.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-backend-dependencies.ts#L1)
|
8
|
+
|
9
|
+
## Type declaration
|
10
|
+
|
11
|
+
### fhir2
|
12
|
+
|
13
|
+
> **fhir2**: `string` = `'1.0.0-SNAPSHOT'`
|
14
|
+
|
15
|
+
#### webservices.rest
|
16
|
+
|
17
|
+
> **rest**: `string` = `'2.24.0'`
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / defaultVisitCustomRepresentation
|
2
|
+
|
3
|
+
# Variable: defaultVisitCustomRepresentation
|
4
|
+
|
5
|
+
> `const` **defaultVisitCustomRepresentation**: `string`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L39)
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / fhirBaseUrl
|
2
|
+
|
3
|
+
# Variable: fhirBaseUrl
|
4
|
+
|
5
|
+
> `const` **fhirBaseUrl**: `"/ws/fhir2/R4"` = `'/ws/fhir2/R4'`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L9)
|
@@ -0,0 +1,35 @@
|
|
1
|
+
[O3 Framework](../API.md) / getAsyncExtensionLifecycle
|
2
|
+
|
3
|
+
# Variable: ~~getAsyncExtensionLifecycle()~~
|
4
|
+
|
5
|
+
> `const` **getAsyncExtensionLifecycle**: \<`T`\>(`lazy`, `options`) => () => `Promise`\<`ReactAppOrParcel`\<`T`\>\> = `getAsyncLifecycle`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L32)
|
8
|
+
|
9
|
+
## Type Parameters
|
10
|
+
|
11
|
+
### T
|
12
|
+
|
13
|
+
`T`
|
14
|
+
|
15
|
+
## Parameters
|
16
|
+
|
17
|
+
### lazy
|
18
|
+
|
19
|
+
() => `Promise`\<\{ `default`: `ComponentType`\<`T`\>; \}\>
|
20
|
+
|
21
|
+
### options
|
22
|
+
|
23
|
+
`ComponentDecoratorOptions`
|
24
|
+
|
25
|
+
## Returns
|
26
|
+
|
27
|
+
> (): `Promise`\<`ReactAppOrParcel`\<`T`\>\>
|
28
|
+
|
29
|
+
### Returns
|
30
|
+
|
31
|
+
`Promise`\<`ReactAppOrParcel`\<`T`\>\>
|
32
|
+
|
33
|
+
## Deprecated
|
34
|
+
|
35
|
+
Use getAsyncLifecycle instead.
|
@@ -0,0 +1,9 @@
|
|
1
|
+
[O3 Framework](../API.md) / getStartedVisit
|
2
|
+
|
3
|
+
# Variable: ~~getStartedVisit~~
|
4
|
+
|
5
|
+
> `const` **getStartedVisit**: `BehaviorSubject`\<`null` \| [`VisitItem`](../interfaces/VisitItem.md)\>
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L127)
|
8
|
+
|
9
|
+
## Deprecated
|
@@ -0,0 +1,9 @@
|
|
1
|
+
[O3 Framework](../API.md) / isUrl
|
2
|
+
|
3
|
+
# Variable: isUrl
|
4
|
+
|
5
|
+
> `const` **isUrl**: [`Validator`](../type-aliases/Validator.md)
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-config/src/validators/validators.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L52)
|
8
|
+
|
9
|
+
Verifies that a string contains only the default URL template parameters.
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / offlineUuidPrefix
|
2
|
+
|
3
|
+
# Variable: offlineUuidPrefix
|
4
|
+
|
5
|
+
> `const` **offlineUuidPrefix**: `"OFFLINE+"` = `'OFFLINE+'`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-offline/src/uuid-support.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid-support.ts#L4)
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / omrsOfflineCachingStrategyHttpHeaderName
|
2
|
+
|
3
|
+
# Variable: omrsOfflineCachingStrategyHttpHeaderName
|
4
|
+
|
5
|
+
> `const` **omrsOfflineCachingStrategyHttpHeaderName**: `"x-omrs-offline-caching-strategy"` = `'x-omrs-offline-caching-strategy'`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L5)
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / omrsOfflineResponseBodyHttpHeaderName
|
2
|
+
|
3
|
+
# Variable: omrsOfflineResponseBodyHttpHeaderName
|
4
|
+
|
5
|
+
> `const` **omrsOfflineResponseBodyHttpHeaderName**: `"x-omrs-offline-response-body"` = `'x-omrs-offline-response-body'`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L3)
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / omrsOfflineResponseStatusHttpHeaderName
|
2
|
+
|
3
|
+
# Variable: omrsOfflineResponseStatusHttpHeaderName
|
4
|
+
|
5
|
+
> `const` **omrsOfflineResponseStatusHttpHeaderName**: `"x-omrs-offline-response-status"` = `'x-omrs-offline-response-status'`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L4)
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / restBaseUrl
|
2
|
+
|
3
|
+
# Variable: restBaseUrl
|
4
|
+
|
5
|
+
> `const` **restBaseUrl**: `"/ws/rest/v1"` = `'/ws/rest/v1'`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L8)
|
@@ -0,0 +1,7 @@
|
|
1
|
+
[O3 Framework](../API.md) / sessionEndpoint
|
2
|
+
|
3
|
+
# Variable: sessionEndpoint
|
4
|
+
|
5
|
+
> `const` **sessionEndpoint**: `"/ws/rest/v1/session"`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L10)
|
@@ -0,0 +1,25 @@
|
|
1
|
+
[O3 Framework](../API.md) / useConnectedExtensions
|
2
|
+
|
3
|
+
# Variable: ~~useConnectedExtensions()~~
|
4
|
+
|
5
|
+
> `const` **useConnectedExtensions**: (`slotName`) => `ConnectedExtension`[]
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useConnectedExtensions.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L10)
|
8
|
+
|
9
|
+
Gets the assigned extension for a given extension slot name.
|
10
|
+
|
11
|
+
## Parameters
|
12
|
+
|
13
|
+
### slotName
|
14
|
+
|
15
|
+
`string`
|
16
|
+
|
17
|
+
The name of the slot to get the assigned extensions for.
|
18
|
+
|
19
|
+
## Returns
|
20
|
+
|
21
|
+
`ConnectedExtension`[]
|
22
|
+
|
23
|
+
## Deprecated
|
24
|
+
|
25
|
+
Use useAssignedExtensions instead
|
@@ -0,0 +1,55 @@
|
|
1
|
+
[O3 Framework](../API.md) / useExtensionStore
|
2
|
+
|
3
|
+
# Variable: useExtensionStore()
|
4
|
+
|
5
|
+
> `const` **useExtensionStore**: \{(): `ExtensionStore`; \<`A`\>(`actions`): `ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)\<`ExtensionStore`, `A`\>; \<`A`\>(`actions?`): `ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)\<`ExtensionStore`, `A`\>; \}
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
|
8
|
+
|
9
|
+
## Call Signature
|
10
|
+
|
11
|
+
> (): `ExtensionStore`
|
12
|
+
|
13
|
+
### Returns
|
14
|
+
|
15
|
+
`ExtensionStore`
|
16
|
+
|
17
|
+
## Call Signature
|
18
|
+
|
19
|
+
> \<`A`\>(`actions`): `ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)\<`ExtensionStore`, `A`\>
|
20
|
+
|
21
|
+
### Type Parameters
|
22
|
+
|
23
|
+
#### A
|
24
|
+
|
25
|
+
`A` *extends* [`Actions`](../type-aliases/Actions.md)\<`ExtensionStore`\>
|
26
|
+
|
27
|
+
### Parameters
|
28
|
+
|
29
|
+
#### actions
|
30
|
+
|
31
|
+
`A`
|
32
|
+
|
33
|
+
### Returns
|
34
|
+
|
35
|
+
`ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)\<`ExtensionStore`, `A`\>
|
36
|
+
|
37
|
+
## Call Signature
|
38
|
+
|
39
|
+
> \<`A`\>(`actions?`): `ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)\<`ExtensionStore`, `A`\>
|
40
|
+
|
41
|
+
### Type Parameters
|
42
|
+
|
43
|
+
#### A
|
44
|
+
|
45
|
+
`A` *extends* [`Actions`](../type-aliases/Actions.md)\<`ExtensionStore`\>
|
46
|
+
|
47
|
+
### Parameters
|
48
|
+
|
49
|
+
#### actions?
|
50
|
+
|
51
|
+
`A`
|
52
|
+
|
53
|
+
### Returns
|
54
|
+
|
55
|
+
`ExtensionStore` & [`BoundActions`](../type-aliases/BoundActions.md)\<`ExtensionStore`, `A`\>
|
@@ -0,0 +1,78 @@
|
|
1
|
+
[O3 Framework](../API.md) / validators
|
2
|
+
|
3
|
+
# Variable: validators
|
4
|
+
|
5
|
+
> `const` **validators**: `object`
|
6
|
+
|
7
|
+
Defined in: [packages/framework/esm-config/src/validators/validators.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L65)
|
8
|
+
|
9
|
+
## Type declaration
|
10
|
+
|
11
|
+
## Navigation
|
12
|
+
|
13
|
+
#### isUrlWithTemplateParameters()
|
14
|
+
|
15
|
+
> **isUrlWithTemplateParameters**: (`allowedTemplateParameters`) => [`Validator`](../type-aliases/Validator.md)
|
16
|
+
|
17
|
+
Verifies that a string contains only the default URL template
|
18
|
+
parameters, plus any specified in `allowedTemplateParameters`.
|
19
|
+
|
20
|
+
##### Parameters
|
21
|
+
|
22
|
+
###### allowedTemplateParameters
|
23
|
+
|
24
|
+
To be added to `openmrsBase` and `openmrsSpaBase`
|
25
|
+
|
26
|
+
`string`[] | readonly `string`[]
|
27
|
+
|
28
|
+
##### Returns
|
29
|
+
|
30
|
+
[`Validator`](../type-aliases/Validator.md)
|
31
|
+
|
32
|
+
## Other
|
33
|
+
|
34
|
+
#### inRange()
|
35
|
+
|
36
|
+
> **inRange**: (`min`, `max`) => [`Validator`](../type-aliases/Validator.md)
|
37
|
+
|
38
|
+
Verifies that the value is between the provided minimum and maximum
|
39
|
+
|
40
|
+
##### Parameters
|
41
|
+
|
42
|
+
###### min
|
43
|
+
|
44
|
+
`number`
|
45
|
+
|
46
|
+
Minimum acceptable value
|
47
|
+
|
48
|
+
###### max
|
49
|
+
|
50
|
+
`number`
|
51
|
+
|
52
|
+
Maximum acceptable value
|
53
|
+
|
54
|
+
##### Returns
|
55
|
+
|
56
|
+
[`Validator`](../type-aliases/Validator.md)
|
57
|
+
|
58
|
+
#### isUrl
|
59
|
+
|
60
|
+
> **isUrl**: [`Validator`](../type-aliases/Validator.md)
|
61
|
+
|
62
|
+
#### oneOf()
|
63
|
+
|
64
|
+
> **oneOf**: (`allowedValues`) => [`Validator`](../type-aliases/Validator.md)
|
65
|
+
|
66
|
+
Verifies that the value is one of the allowed options.
|
67
|
+
|
68
|
+
##### Parameters
|
69
|
+
|
70
|
+
###### allowedValues
|
71
|
+
|
72
|
+
The list of allowable values
|
73
|
+
|
74
|
+
`any`[] | readonly `any`[]
|
75
|
+
|
76
|
+
##### Returns
|
77
|
+
|
78
|
+
[`Validator`](../type-aliases/Validator.md)
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@openmrs/esm-framework",
|
3
|
-
"version": "6.3.1-pre.
|
3
|
+
"version": "6.3.1-pre.3124",
|
4
4
|
"license": "MPL-2.0",
|
5
5
|
"type": "module",
|
6
6
|
"module": "dist/openmrs-esm-framework.js",
|
@@ -59,24 +59,24 @@
|
|
59
59
|
"access": "public"
|
60
60
|
},
|
61
61
|
"dependencies": {
|
62
|
-
"@openmrs/esm-api": "6.3.1-pre.
|
63
|
-
"@openmrs/esm-config": "6.3.1-pre.
|
64
|
-
"@openmrs/esm-context": "6.3.1-pre.
|
65
|
-
"@openmrs/esm-dynamic-loading": "6.3.1-pre.
|
66
|
-
"@openmrs/esm-emr-api": "6.3.1-pre.
|
67
|
-
"@openmrs/esm-error-handling": "6.3.1-pre.
|
68
|
-
"@openmrs/esm-expression-evaluator": "6.3.1-pre.
|
69
|
-
"@openmrs/esm-extensions": "6.3.1-pre.
|
70
|
-
"@openmrs/esm-feature-flags": "6.3.1-pre.
|
71
|
-
"@openmrs/esm-globals": "6.3.1-pre.
|
72
|
-
"@openmrs/esm-navigation": "6.3.1-pre.
|
73
|
-
"@openmrs/esm-offline": "6.3.1-pre.
|
74
|
-
"@openmrs/esm-react-utils": "6.3.1-pre.
|
75
|
-
"@openmrs/esm-routes": "6.3.1-pre.
|
76
|
-
"@openmrs/esm-state": "6.3.1-pre.
|
77
|
-
"@openmrs/esm-styleguide": "6.3.1-pre.
|
78
|
-
"@openmrs/esm-translations": "6.3.1-pre.
|
79
|
-
"@openmrs/esm-utils": "6.3.1-pre.
|
62
|
+
"@openmrs/esm-api": "6.3.1-pre.3124",
|
63
|
+
"@openmrs/esm-config": "6.3.1-pre.3124",
|
64
|
+
"@openmrs/esm-context": "6.3.1-pre.3124",
|
65
|
+
"@openmrs/esm-dynamic-loading": "6.3.1-pre.3124",
|
66
|
+
"@openmrs/esm-emr-api": "6.3.1-pre.3124",
|
67
|
+
"@openmrs/esm-error-handling": "6.3.1-pre.3124",
|
68
|
+
"@openmrs/esm-expression-evaluator": "6.3.1-pre.3124",
|
69
|
+
"@openmrs/esm-extensions": "6.3.1-pre.3124",
|
70
|
+
"@openmrs/esm-feature-flags": "6.3.1-pre.3124",
|
71
|
+
"@openmrs/esm-globals": "6.3.1-pre.3124",
|
72
|
+
"@openmrs/esm-navigation": "6.3.1-pre.3124",
|
73
|
+
"@openmrs/esm-offline": "6.3.1-pre.3124",
|
74
|
+
"@openmrs/esm-react-utils": "6.3.1-pre.3124",
|
75
|
+
"@openmrs/esm-routes": "6.3.1-pre.3124",
|
76
|
+
"@openmrs/esm-state": "6.3.1-pre.3124",
|
77
|
+
"@openmrs/esm-styleguide": "6.3.1-pre.3124",
|
78
|
+
"@openmrs/esm-translations": "6.3.1-pre.3124",
|
79
|
+
"@openmrs/esm-utils": "6.3.1-pre.3124"
|
80
80
|
},
|
81
81
|
"peerDependencies": {
|
82
82
|
"dayjs": "1.x",
|
@@ -97,7 +97,11 @@
|
|
97
97
|
"happy-dom": "^17.4.7",
|
98
98
|
"sass-embedded": "^1.89.0",
|
99
99
|
"svgo-loader": "^4.0.0",
|
100
|
-
"
|
100
|
+
"typedoc": "^0.28.5",
|
101
|
+
"typedoc-plugin-file-categories": "6.3.1-pre.3124",
|
102
|
+
"typedoc-plugin-markdown": "^4.6.3",
|
103
|
+
"typedoc-plugin-no-inherit": "^1.6.1",
|
104
|
+
"typescript": "^5.8.3",
|
101
105
|
"vitest": "^3.1.4"
|
102
106
|
},
|
103
107
|
"stableVersion": "6.3.0"
|
package/rspack.config.cjs
CHANGED
@@ -72,14 +72,7 @@ module.exports = (env, argv = {}) => ({
|
|
72
72
|
},
|
73
73
|
watch: false,
|
74
74
|
externalsType: 'module',
|
75
|
-
externals:
|
76
|
-
...Object.keys(peerDependencies || {}),
|
77
|
-
'swr/immutable',
|
78
|
-
'swr/infinite',
|
79
|
-
'swr/mutation',
|
80
|
-
'swr/subscription',
|
81
|
-
'swr/_internal',
|
82
|
-
],
|
75
|
+
externals: Object.keys(peerDependencies || {}),
|
83
76
|
resolve: {
|
84
77
|
extensions: ['.js', '.jsx', '.json', '.ts', '.tsx'],
|
85
78
|
},
|
package/tsconfig.build.json
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
"compilerOptions": {
|
4
4
|
"declarationDir": "dist",
|
5
5
|
"emitDeclarationOnly": true,
|
6
|
-
"skipLibCheck": true
|
6
|
+
"skipLibCheck": true,
|
7
|
+
"stripInternal": true
|
7
8
|
},
|
8
9
|
"extends": "./tsconfig.json",
|
9
10
|
"exclude": ["**/*.test.*", "**/setup-tests.ts", "**/__mocks__/*", "**/mock.tsx"]
|
package/typedoc.json
CHANGED
@@ -1,9 +1,22 @@
|
|
1
1
|
{
|
2
2
|
"$schema": "https://typedoc.org/schema.json",
|
3
|
-
"
|
3
|
+
"name": "O3 Framework",
|
4
|
+
"entryPoints": ["./src/index.ts"],
|
5
|
+
"outputs": [
|
6
|
+
{
|
7
|
+
"name": "markdown",
|
8
|
+
"path": "./docs"
|
9
|
+
}
|
10
|
+
],
|
11
|
+
"plugin": [
|
12
|
+
"typedoc-plugin-file-categories",
|
13
|
+
"typedoc-plugin-markdown",
|
14
|
+
"typedoc-plugin-no-inherit"
|
15
|
+
],
|
4
16
|
"readme": "none",
|
5
17
|
"excludeInternal": true,
|
18
|
+
"entryFileName": "API.md",
|
6
19
|
"gitRevision": "main",
|
7
|
-
"
|
8
|
-
"
|
20
|
+
"hidePageHeader": true,
|
21
|
+
"sort": ["alphabetical"]
|
9
22
|
}
|
package/docs/.nojekyll
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
package/docs/enums/Type.md
DELETED
@@ -1,107 +0,0 @@
|
|
1
|
-
[@openmrs/esm-framework](../API.md) / Type
|
2
|
-
|
3
|
-
# Enumeration: Type
|
4
|
-
|
5
|
-
## Table of contents
|
6
|
-
|
7
|
-
### Enumeration Members
|
8
|
-
|
9
|
-
- [Array](Type.md#array)
|
10
|
-
- [Boolean](Type.md#boolean)
|
11
|
-
- [ConceptUuid](Type.md#conceptuuid)
|
12
|
-
- [Number](Type.md#number)
|
13
|
-
- [Object](Type.md#object)
|
14
|
-
- [PatientIdentifierTypeUuid](Type.md#patientidentifiertypeuuid)
|
15
|
-
- [PersonAttributeTypeUuid](Type.md#personattributetypeuuid)
|
16
|
-
- [String](Type.md#string)
|
17
|
-
- [UUID](Type.md#uuid)
|
18
|
-
|
19
|
-
## Enumeration Members
|
20
|
-
|
21
|
-
### Array
|
22
|
-
|
23
|
-
• **Array**
|
24
|
-
|
25
|
-
#### Defined in
|
26
|
-
|
27
|
-
[packages/framework/esm-config/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L2)
|
28
|
-
|
29
|
-
___
|
30
|
-
|
31
|
-
### Boolean
|
32
|
-
|
33
|
-
• **Boolean**
|
34
|
-
|
35
|
-
#### Defined in
|
36
|
-
|
37
|
-
[packages/framework/esm-config/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L3)
|
38
|
-
|
39
|
-
___
|
40
|
-
|
41
|
-
### ConceptUuid
|
42
|
-
|
43
|
-
• **ConceptUuid**
|
44
|
-
|
45
|
-
#### Defined in
|
46
|
-
|
47
|
-
[packages/framework/esm-config/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L4)
|
48
|
-
|
49
|
-
___
|
50
|
-
|
51
|
-
### Number
|
52
|
-
|
53
|
-
• **Number**
|
54
|
-
|
55
|
-
#### Defined in
|
56
|
-
|
57
|
-
[packages/framework/esm-config/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L5)
|
58
|
-
|
59
|
-
___
|
60
|
-
|
61
|
-
### Object
|
62
|
-
|
63
|
-
• **Object**
|
64
|
-
|
65
|
-
#### Defined in
|
66
|
-
|
67
|
-
[packages/framework/esm-config/src/types.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L6)
|
68
|
-
|
69
|
-
___
|
70
|
-
|
71
|
-
### PatientIdentifierTypeUuid
|
72
|
-
|
73
|
-
• **PatientIdentifierTypeUuid**
|
74
|
-
|
75
|
-
#### Defined in
|
76
|
-
|
77
|
-
[packages/framework/esm-config/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L10)
|
78
|
-
|
79
|
-
___
|
80
|
-
|
81
|
-
### PersonAttributeTypeUuid
|
82
|
-
|
83
|
-
• **PersonAttributeTypeUuid**
|
84
|
-
|
85
|
-
#### Defined in
|
86
|
-
|
87
|
-
[packages/framework/esm-config/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L9)
|
88
|
-
|
89
|
-
___
|
90
|
-
|
91
|
-
### String
|
92
|
-
|
93
|
-
• **String**
|
94
|
-
|
95
|
-
#### Defined in
|
96
|
-
|
97
|
-
[packages/framework/esm-config/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L7)
|
98
|
-
|
99
|
-
___
|
100
|
-
|
101
|
-
### UUID
|
102
|
-
|
103
|
-
• **UUID**
|
104
|
-
|
105
|
-
#### Defined in
|
106
|
-
|
107
|
-
[packages/framework/esm-config/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L8)
|
package/docs/enums/VisitMode.md
DELETED
@@ -1,41 +0,0 @@
|
|
1
|
-
[@openmrs/esm-framework](../API.md) / VisitMode
|
2
|
-
|
3
|
-
# Enumeration: VisitMode
|
4
|
-
|
5
|
-
## Table of contents
|
6
|
-
|
7
|
-
### API Enumeration Members
|
8
|
-
|
9
|
-
- [EDITVISIT](VisitMode.md#editvisit)
|
10
|
-
- [LOADING](VisitMode.md#loading)
|
11
|
-
- [NEWVISIT](VisitMode.md#newvisit)
|
12
|
-
|
13
|
-
## API Enumeration Members
|
14
|
-
|
15
|
-
### EDITVISIT
|
16
|
-
|
17
|
-
• **EDITVISIT**
|
18
|
-
|
19
|
-
#### Defined in
|
20
|
-
|
21
|
-
[packages/framework/esm-emr-api/src/visit-utils.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L16)
|
22
|
-
|
23
|
-
___
|
24
|
-
|
25
|
-
### LOADING
|
26
|
-
|
27
|
-
• **LOADING**
|
28
|
-
|
29
|
-
#### Defined in
|
30
|
-
|
31
|
-
[packages/framework/esm-emr-api/src/visit-utils.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L17)
|
32
|
-
|
33
|
-
___
|
34
|
-
|
35
|
-
### NEWVISIT
|
36
|
-
|
37
|
-
• **NEWVISIT**
|
38
|
-
|
39
|
-
#### Defined in
|
40
|
-
|
41
|
-
[packages/framework/esm-emr-api/src/visit-utils.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L15)
|
@@ -1,30 +0,0 @@
|
|
1
|
-
[@openmrs/esm-framework](../API.md) / VisitStatus
|
2
|
-
|
3
|
-
# Enumeration: VisitStatus
|
4
|
-
|
5
|
-
## Table of contents
|
6
|
-
|
7
|
-
### API Enumeration Members
|
8
|
-
|
9
|
-
- [NOTSTARTED](VisitStatus.md#notstarted)
|
10
|
-
- [ONGOING](VisitStatus.md#ongoing)
|
11
|
-
|
12
|
-
## API Enumeration Members
|
13
|
-
|
14
|
-
### NOTSTARTED
|
15
|
-
|
16
|
-
• **NOTSTARTED**
|
17
|
-
|
18
|
-
#### Defined in
|
19
|
-
|
20
|
-
[packages/framework/esm-emr-api/src/visit-utils.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L21)
|
21
|
-
|
22
|
-
___
|
23
|
-
|
24
|
-
### ONGOING
|
25
|
-
|
26
|
-
• **ONGOING**
|
27
|
-
|
28
|
-
#### Defined in
|
29
|
-
|
30
|
-
[packages/framework/esm-emr-api/src/visit-utils.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L22)
|
@@ -1,47 +0,0 @@
|
|
1
|
-
[@openmrs/esm-framework](../API.md) / ExtensionSlotConfigObject
|
2
|
-
|
3
|
-
# Interface: ExtensionSlotConfigObject
|
4
|
-
|
5
|
-
## Table of contents
|
6
|
-
|
7
|
-
### Properties
|
8
|
-
|
9
|
-
- [add](ExtensionSlotConfigObject.md#add)
|
10
|
-
- [order](ExtensionSlotConfigObject.md#order)
|
11
|
-
- [remove](ExtensionSlotConfigObject.md#remove)
|
12
|
-
|
13
|
-
## Properties
|
14
|
-
|
15
|
-
### add
|
16
|
-
|
17
|
-
• `Optional` **add**: `string`[]
|
18
|
-
|
19
|
-
Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
|
20
|
-
|
21
|
-
#### Defined in
|
22
|
-
|
23
|
-
[packages/framework/esm-config/src/types.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L61)
|
24
|
-
|
25
|
-
___
|
26
|
-
|
27
|
-
### order
|
28
|
-
|
29
|
-
• `Optional` **order**: `string`[]
|
30
|
-
|
31
|
-
Overrides the default ordering of extensions.
|
32
|
-
|
33
|
-
#### Defined in
|
34
|
-
|
35
|
-
[packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L65)
|
36
|
-
|
37
|
-
___
|
38
|
-
|
39
|
-
### remove
|
40
|
-
|
41
|
-
• `Optional` **remove**: `string`[]
|
42
|
-
|
43
|
-
Extension IDs which were `attach`ed to the slot but which should not be assigned.
|
44
|
-
|
45
|
-
#### Defined in
|
46
|
-
|
47
|
-
[packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L63)
|