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

package/docs/type-aliases/InlineNotificationType.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / InlineNotificationType
+
+# Type Alias: InlineNotificationType
+
+> **InlineNotificationType** = `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
+
+Defined in: [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L23)

package/docs/type-aliases/Key.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / Key
+
+# Type Alias: Key
+
+> **Key** = `string` \| [`ArgumentsTuple`](ArgumentsTuple.md) \| `undefined` \| `null`
+
+Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L9)

package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / KnownOmrsServiceWorkerMessages
+
+# Type Alias: KnownOmrsServiceWorkerMessages
+
+> **KnownOmrsServiceWorkerMessages** = [`OnImportMapChangedMessage`](../interfaces/OnImportMapChangedMessage.md) \| [`ClearDynamicRoutesMessage`](../interfaces/ClearDynamicRoutesMessage.md) \| [`RegisterDynamicRouteMessage`](../interfaces/RegisterDynamicRouteMessage.md)
+
+Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L42)

package/docs/type-aliases/LayoutType.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / LayoutType
+
+# Type Alias: LayoutType
+
+> **LayoutType** = `"phone"` \| `"tablet"` \| `"small-desktop"` \| `"large-desktop"`
+
+Defined in: [packages/framework/esm-react-utils/src/useLayoutType.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L4)

package/docs/type-aliases/LoadedSessionStore.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / LoadedSessionStore
+
+# Type Alias: LoadedSessionStore
+
+> **LoadedSessionStore** = `object`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L11)
+
+## Properties
+
+### loaded
+
+> **loaded**: `true`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L12)
+
+***
+
+### session
+
+> **session**: [`Session`](../interfaces/Session.md)
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L13)

package/docs/type-aliases/ModalDefinition.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / ModalDefinition
+
+# Type Alias: ModalDefinition
+
+> **ModalDefinition** = `object` & \{ `component`: `string`; \} \| \{ `component?`: `never`; \}
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:234
+
+A definition of a modal as extracted from an app's routes.json
+
+## Type declaration
+
+### name
+
+> **name**: `string`
+
+The name of this modal. This is used to launch the modal.

package/docs/type-aliases/NameUse.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / NameUse
+
+# Type Alias: NameUse
+
+> **NameUse** = `"usual"` \| `"official"` \| `"temp"` \| `"nickname"` \| `"anonymous"` \| `"old"` \| `"maiden"`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:392

package/docs/type-aliases/NullablePatient.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / NullablePatient
+
+# Type Alias: NullablePatient
+
+> **NullablePatient** = `fhir.Patient` \| `null`
+
+Defined in: [packages/framework/esm-react-utils/src/usePatient.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePatient.ts#L6)

package/docs/type-aliases/OfflineMode.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / OfflineMode
+
+# Type Alias: OfflineMode
+
+> **OfflineMode** = `"on"` \| `"off"` \| `"unavailable"`
+
+Defined in: [packages/framework/esm-offline/src/mode.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L34)

package/docs/type-aliases/OmrsOfflineCachingStrategy.md

@@ -0,0 +1,12 @@
+[O3 Framework](../API.md) / OmrsOfflineCachingStrategy
+
+# Type Alias: OmrsOfflineCachingStrategy
+
+> **OmrsOfflineCachingStrategy** = `"network-only-or-cache-only"` \| `"network-first"`
+
+Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L15)
+
+* `cache-or-network`: The default strategy, equal to the absence of this header.
+  The SW attempts to resolve the request via the network, but falls back to the cache if required.
+  The service worker decides the strategy to be used.
+* `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.

package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / OmrsOfflineHttpHeaderNames
+
+# Type Alias: OmrsOfflineHttpHeaderNames
+
+> **OmrsOfflineHttpHeaderNames** = keyof [`OmrsOfflineHttpHeaders`](OmrsOfflineHttpHeaders.md)
+
+Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L40)

package/docs/type-aliases/OmrsOfflineHttpHeaders.md

@@ -0,0 +1,44 @@
+[O3 Framework](../API.md) / OmrsOfflineHttpHeaders
+
+# Type Alias: OmrsOfflineHttpHeaders
+
+> **OmrsOfflineHttpHeaders** = `object`
+
+Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L21)
+
+Defines the keys of the custom headers which can be appended to an HTTP request.
+HTTP requests with these headers are handled in a special way by the SPA's service worker.
+
+## Properties
+
+### x-omrs-offline-caching-strategy?
+
+> `optional` **x-omrs-offline-caching-strategy**: [`OmrsOfflineCachingStrategy`](OmrsOfflineCachingStrategy.md)
+
+Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L37)
+
+Instructs the service worker to use a specific caching strategy for this request.
+
+***
+
+### x-omrs-offline-response-body?
+
+> `optional` **x-omrs-offline-response-body**: `string`
+
+Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L27)
+
+If the client is offline and the request cannot be read from the cache (i.e. if there is no way
+to receive any kind of data for this request), the service worker will return a response with
+the body in this header.
+
+***
+
+### x-omrs-offline-response-status?
+
+> `optional` **x-omrs-offline-response-status**: `` `${number}` ``
+
+Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L33)
+
+If the client is offline and the request cannot be read from the cache (i.e. if there is no way
+to receive any kind of data for this request), the service worker will return a response with
+the status code defined in this header.

package/docs/type-aliases/OpenmrsRoutes.md

@@ -0,0 +1,10 @@
+[O3 Framework](../API.md) / OpenmrsRoutes
+
+# Type Alias: OpenmrsRoutes
+
+> **OpenmrsRoutes** = `Record`\<`string`, [`OpenmrsAppRoutes`](../interfaces/OpenmrsAppRoutes.md)\>
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:388
+
+This interfaces describes the format of the overall rotues.json loaded by the app shell.
+Basically, this is the same as the app routes, with each routes definition keyed by the app's name

package/docs/type-aliases/PageDefinition.md

@@ -0,0 +1,41 @@
+[O3 Framework](../API.md) / PageDefinition
+
+# Type Alias: PageDefinition
+
+> **PageDefinition** = `object` & \{ `route`: `string` \| `boolean`; `routeRegex?`: `never`; \} \| \{ `route?`: `never`; `routeRegex`: `string`; \}
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:113
+
+A definition of a page extracted from an app's routes.json
+
+## Type declaration
+
+### component
+
+> **component**: `string`
+
+The name of the component exported by this frontend module.
+
+### featureFlag?
+
+> `optional` **featureFlag**: `string`
+
+If supplied, the page will only be rendered when this feature flag is enabled.
+
+### offline?
+
+> `optional` **offline**: `boolean`
+
+Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
+
+### online?
+
+> `optional` **online**: `boolean`
+
+Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
+
+### order?
+
+> `optional` **order**: `number`
+
+Determines the order in which this page is rendered in the app-shell, which is useful for situations where DOM ordering matters.

package/docs/type-aliases/PageHeaderProps.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PageHeaderProps
+
+# Type Alias: PageHeaderProps
+
+> **PageHeaderProps** = `XOR`\<[`PageHeaderWrapperProps`](../interfaces/PageHeaderWrapperProps.md), [`PageHeaderContentProps`](../interfaces/PageHeaderContentProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/page-header/page-header.component.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/page-header/page-header.component.tsx#L30)

package/docs/type-aliases/PatientUuid.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / PatientUuid
+
+# Type Alias: PatientUuid
+
+> **PatientUuid** = `string` \| `null`
+
+Defined in: [packages/framework/esm-emr-api/src/current-patient.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L19)

package/docs/type-aliases/PictogramProps.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / PictogramProps
+
+# Type Alias: PictogramProps
+
+> **PictogramProps** = `object`
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L7)
+
+## Properties
+
+### className?
+
+> `optional` **className**: `Argument`
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L8)
+
+***
+
+### size?
+
+> `optional` **size**: `number`
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L9)

package/docs/type-aliases/ProvidedConfig.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / ProvidedConfig
+
+# Type Alias: ProvidedConfig
+
+> **ProvidedConfig** = `object`
+
+Defined in: [packages/framework/esm-config/src/types.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L68)
+
+## Properties
+
+### config
+
+> **config**: [`Config`](../interfaces/Config.md)
+
+Defined in: [packages/framework/esm-config/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L70)
+
+***
+
+### source
+
+> **source**: `string`
+
+Defined in: [packages/framework/esm-config/src/types.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L69)

package/docs/type-aliases/ResourceName.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ResourceName
+
+# Type Alias: ResourceName
+
+> **ResourceName** = `"DomainResource"` \| `"Organization"` \| `"Location"` \| `"HealthcareService"` \| `"Practitioner"` \| `"Patient"` \| `"RelatedPerson"` \| `"Device"` \| `"Account"` \| `"AllergyIntolerance"` \| `"Schedule"` \| `"Slot"` \| `"Appointment"` \| `"AppointmentResponse"` \| `"AuditEvent"` \| `"Basic"` \| `"BodySite"` \| `"Substance"` \| `"Medication"` \| `"Group"` \| `"Specimen"` \| `"DeviceComponent"` \| `"DeviceMetric"` \| `"ValueSet"` \| `"Questionnaire"` \| `"QuestionnaireResponse"` \| `"Observation"` \| `"FamilyMemberHistory"` \| `"DocumentReference"` \| `"DiagnosticOrder"` \| `"ProcedureRequest"` \| `"ReferralRequest"` \| `"Procedure"` \| `"ImagingStudy"` \| `"ImagingObjectSelection"` \| `"Media"` \| `"DiagnosticReport"` \| `"CommunicationRequest"` \| `"DeviceUseRequest"` \| `"MedicationOrder"` \| `"NutritionOrder"` \| `"Order"` \| `"ProcessRequest"` \| `"SupplyRequest"` \| `"VisionPrescription"` \| `"ClinicalImpression"` \| `"Condition"` \| `"EpisodeOfCare"` \| `"Encounter"` \| `"MedicationStatement"` \| `"RiskAssessment"` \| `"Goal"` \| `"CarePlan"` \| `"Composition"` \| `"Contract"` \| `"Coverage"` \| `"ClaimResponse"` \| `"Claim"` \| `"Communication"` \| `"StructureDefinition"` \| `"ConceptMap"` \| `"OperationDefinition"` \| `"Conformance"` \| `"DataElement"` \| `"DetectedIssue"` \| `"DeviceUseStatement"` \| `"DocumentManifest"` \| `"EligibilityRequest"` \| `"EligibilityResponse"` \| `"EnrollmentRequest"` \| `"EnrollmentResponse"` \| `"ExplanationOfBenefit"` \| `"Flag"` \| `"Immunization"` \| `"ImmunizationRecommendation"` \| `"ImplementationGuide"` \| `"List"` \| `"MedicationAdministration"` \| `"MedicationDispense"` \| `"OperationOutcome"` \| `"MessageHeader"` \| `"NamingSystem"` \| `"OrderResponse"` \| `"PaymentNotice"` \| `"PaymentReconciliation"` \| `"Person"` \| `"ProcessResponse"` \| `"Provenance"` \| `"SearchParameter"` \| `"Subscription"` \| `"SupplyDelivery"` \| `"TestScript"` \| `"Binary"` \| `"Bundle"` \| `"Parameters"`
+
+Defined in: [packages/framework/esm-emr-api/src/types/fhir.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/fhir.ts#L7)

package/docs/type-aliases/SessionStore.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / SessionStore
+
+# Type Alias: SessionStore
+
+> **SessionStore** = [`LoadedSessionStore`](LoadedSessionStore.md) \| [`UnloadedSessionStore`](UnloadedSessionStore.md)
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L9)

package/docs/type-aliases/SnackbarType.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / SnackbarType
+
+# Type Alias: SnackbarType
+
+> **SnackbarType** = `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
+
+Defined in: [packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/snackbars/snackbar.component.tsx#L29)

package/docs/type-aliases/SpaEnvironment.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / SpaEnvironment
+
+# Type Alias: SpaEnvironment
+
+> **SpaEnvironment** = `"production"` \| `"development"` \| `"test"`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:73

package/docs/type-aliases/SvgIconProps.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / SvgIconProps
+
+# Type Alias: SvgIconProps
+
+> **SvgIconProps** = `object`
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:795](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L795)
+
+## Properties
+
+### icon
+
+> **icon**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:796](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L796)
+
+***
+
+### iconProps
+
+> **iconProps**: [`IconProps`](IconProps.md)
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:797](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L797)

package/docs/type-aliases/SvgPictogramProps.md

@@ -0,0 +1,27 @@
+[O3 Framework](../API.md) / SvgPictogramProps
+
+# Type Alias: SvgPictogramProps
+
+> **SvgPictogramProps** = `object`
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:108](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L108)
+
+## Properties
+
+### pictogram
+
+> **pictogram**: `string`
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:110](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L110)
+
+the id of the pictogram
+
+***
+
+### pictogramProps
+
+> **pictogramProps**: [`PictogramProps`](PictogramProps.md)
+
+Defined in: [packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:112](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L112)
+
+properties when using the pictogram

package/docs/type-aliases/TemplateParams.md

@@ -0,0 +1,11 @@
+[O3 Framework](../API.md) / TemplateParams
+
+# Type Alias: TemplateParams
+
+> **TemplateParams** = `object`
+
+Defined in: [packages/framework/esm-navigation/src/navigation/navigate.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/navigation/navigate.ts#L10)
+
+## Index Signature
+
+\[`key`: `string`\]: `string`

package/docs/type-aliases/ToastType.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ToastType
+
+# Type Alias: ToastType
+
+> **ToastType** = `"error"` \| `"info"` \| `"info-square"` \| `"success"` \| `"warning"` \| `"warning-alt"`
+
+Defined in: [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L23)

package/docs/type-aliases/UnloadedSessionStore.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / UnloadedSessionStore
+
+# Type Alias: UnloadedSessionStore
+
+> **UnloadedSessionStore** = `object`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L16)
+
+## Properties
+
+### loaded
+
+> **loaded**: `false`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L17)
+
+***
+
+### session
+
+> **session**: `null`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L18)

package/docs/type-aliases/UpdateVisitPayload.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / UpdateVisitPayload
+
+# Type Alias: UpdateVisitPayload
+
+> **UpdateVisitPayload** = `Partial`\<[`NewVisitPayload`](../interfaces/NewVisitPayload.md)\> & `object`
+
+Defined in: [packages/framework/esm-emr-api/src/types/visit-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/visit-resource.ts#L18)

package/docs/type-aliases/UseOpenmrsSWROptions.md

@@ -0,0 +1,39 @@
+[O3 Framework](../API.md) / UseOpenmrsSWROptions
+
+# Type Alias: UseOpenmrsSWROptions
+
+> **UseOpenmrsSWROptions** = `object`
+
+Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L10)
+
+## Properties
+
+### abortController?
+
+> `optional` **abortController**: `AbortController`
+
+Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L11)
+
+***
+
+### fetchInit?
+
+> `optional` **fetchInit**: `FetchConfig`
+
+Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L12)
+
+***
+
+### swrConfig?
+
+> `optional` **swrConfig**: `SWRConfiguration`
+
+Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L14)
+
+***
+
+### url?
+
+> `optional` **url**: `string` \| (`key`) => `string`
+
+Defined in: [packages/framework/esm-react-utils/src/useOpenmrsSWR.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsSWR.ts#L13)

package/docs/type-aliases/Validator.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / Validator
+
+# Type Alias: Validator()
+
+> **Validator** = (`value`) => `void` \| `string`
+
+Defined in: [packages/framework/esm-config/src/types.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L75)
+
+## Parameters
+
+### value
+
+`any`
+
+## Returns
+
+`void` \| `string`

package/docs/type-aliases/ValidatorFunction.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / ValidatorFunction
+
+# Type Alias: ValidatorFunction()
+
+> **ValidatorFunction** = (`value`) => `boolean`
+
+Defined in: [packages/framework/esm-config/src/types.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L73)
+
+## Parameters
+
+### value
+
+`any`
+
+## Returns
+
+`boolean`

package/docs/type-aliases/VariablesMap.md

@@ -0,0 +1,13 @@
+[O3 Framework](../API.md) / VariablesMap
+
+# Type Alias: VariablesMap
+
+> **VariablesMap** = `object`
+
+Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-expression-evaluator/src/evaluator.ts#L26)
+
+An object containing the variable to use when evaluating this expression
+
+## Index Signature
+
+\[`key`: `string`\]: `null` \| `string` \| `number` \| `boolean` \| `object` \| `Function` \| `RegExp` \| `VariablesMap` \| `VariablesMap`[]

package/docs/type-aliases/WorkspaceDefinition.md

@@ -0,0 +1,78 @@
+[O3 Framework](../API.md) / WorkspaceDefinition
+
+# Type Alias: WorkspaceDefinition
+
+> **WorkspaceDefinition** = `object` & \{ `component`: `string`; \} \| \{ `component?`: `never`; \}
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:264
+
+A definition of a workspace as extracted from an app's routes.json
+
+## Type declaration
+
+### canHide?
+
+> `optional` **canHide**: `boolean`
+
+### canMaximize?
+
+> `optional` **canMaximize**: `boolean`
+
+### groups
+
+> **groups**: `string`[]
+
+Workspaces can open either independently or as part of a "workspace group". A
+"workspace group" groups related workspaces together, so that only one is visible
+at a time. For example,
+
+#### Example
+
+```ts
+{
+     *  name: 'order-basket',
+     *  type: 'order',
+     *  groups: ['ward-patient']
+     * }
+
+This means that the 'order-basket' workspace can be opened independently, or only
+in the 'ward-patient'.
+If a workspace group is already open and a new workspace is launched, and the
+groups in the newly launched workspace do not include the currently open group’s
+name, the entire workspace group will close, and the new workspace will launch independently.
+```
+
+### name
+
+> **name**: `string`
+
+The name of this workspace. This is used to launch the workspace.
+
+### preferredWindowSize?
+
+> `optional` **preferredWindowSize**: [`WorkspaceWindowState`](WorkspaceWindowState.md)
+
+Launches the workspace in the preferred size, it defaults to the 'narrow' width
+
+### title
+
+> **title**: `string`
+
+The title of the workspace. This will be looked up as a key in the translations of the module
+defining the workspace.
+
+### type
+
+> **type**: `string`
+
+The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
+time. The default is "form". If the right sidebar is in use, then the type determines which
+right sidebar icon corresponds to the workspace.
+
+### width?
+
+> `optional` **width**: `"narrow"` \| `"wider"` \| `"extra-wide"`
+
+Controls the width of the workspace. The default is "narrow" and this should only be
+changed to "wider" if the workspace itself has internal navigation, like the form editor.
+The width "extra-wide" is for workspaces that contain their own sidebar.

package/docs/type-aliases/WorkspaceWindowState.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / WorkspaceWindowState
+
+# Type Alias: WorkspaceWindowState
+
+> **WorkspaceWindowState** = `"maximized"` \| `"hidden"` \| `"normal"`
+
+Defined in: packages/framework/esm-globals/dist/types.d.ts:260

package/docs/variables/ActionMenuButton.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ActionMenuButton
+
+# Variable: ActionMenuButton
+
+> `const` **ActionMenuButton**: `React.FC`\<[`ActionMenuButtonProps`](../interfaces/ActionMenuButtonProps.md)\>
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L38)

package/docs/variables/ActivityIcon.md

@@ -0,0 +1,7 @@
+[O3 Framework](../API.md) / ActivityIcon
+
+# Variable: ActivityIcon
+
+> `const` **ActivityIcon**: `MemoExoticComponent`\<`ForwardRefExoticComponent`\<[`IconProps`](../type-aliases/IconProps.md) & `RefAttributes`\<`SVGSVGElement`\>\>\>
+
+Defined in: [packages/framework/esm-styleguide/src/icons/icons.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/icons/icons.tsx#L15)