@openmrs/esm-framework 6.3.1-pre.3099 → 6.3.1-pre.3105

package/docs/functions/PatientPhoto.md

@@ -0,0 +1,19 @@
+[O3 Framework](../API.md) / PatientPhoto
+
+# Function: PatientPhoto()
+
+> **PatientPhoto**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/patient-photo/patient-photo.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/patient-photo/patient-photo.component.tsx#L19)
+
+A component which displays the patient photo https://zeroheight.com/23a080e38/p/6663f3-patient-header. If there is no photo, it will display a generated avatar. The default size is 56px.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`PatientPhotoProps`](../interfaces/PatientPhotoProps.md)
+
+## Returns
+
+`Element`

package/docs/functions/WorkspaceContainer.md

@@ -0,0 +1,55 @@
+[O3 Framework](../API.md) / WorkspaceContainer
+
+# Function: WorkspaceContainer()
+
+> **WorkspaceContainer**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/container/workspace-container.component.tsx#L68)
+
+Use this component to render the [workspace window](https://zeroheight.com/23a080e38/p/483a22-workspace)
+in an app such as the patient chart, or a workspace overlay in an app such as the clinic dashboard.
+This allows workspaces to be opened on the page where this component is mounted. This component
+must not be mounted multiple times on the same page. If there are multiple apps on a page, only
+one of those apps should use this component—it "hosts" the workspaces.
+
+Workspaces may be opened with the [[launchWorkspace]] function from `@openmrs/esm-framework`
+(among other options).
+
+The `overlay` prop determines whether the workspace is rendered as an overlay or a window.
+When a workspace window is opened, the other content on the screen will be pushed to the left.
+When an overlay is opened, it will cover other content on the screen.
+
+The context key is a string that appears in the URL, which defines the pages on which workspaces
+are valid. If the URL changes in a way such that it no longer contains the context key, then
+all workspaces will be closed. This ensures that, for example, workspaces on the home page do
+not stay open when the user transitions to the patient dashboard; and also that workspaces do
+not stay open when the user navigates to a different patient. The context key must be a valid
+sub-path of the URL, with no initial or trailing slash. So if the URL is
+`https://example.com/patient/123/foo`, then `patient` and `patient/123` and `123/foo` are valid
+context keys, but `patient/12` and `pati` are not.
+
+An extension slot is provided in the workspace header. Its name is derived from the `featureName` of
+the top-level component in which it is defined (feature names are generally provided in the lifecycle
+functions in an app's `index.ts` file). The slot is named `workspace-header-${featureName}-slot`.
+For the patient chart, this is `workspace-header-patient-chart-slot`.
+
+This component also provides the [Siderail and Bottom Nav](https://zeroheight.com/23a080e38/p/948cf1-siderail-and-bottom-nav/b/86907e).
+To use this, pass the `showSiderailAndBottomNav` prop. The Siderail is rendered on the right side of the screen
+on desktop, and the Bottom Nav is rendered at the bottom of the screen on tablet or mobile. The sidebar/bottom-nav
+menu provides an extension slot, to which buttons are attached as extensions. The slot
+derives its name from the `featureName` of the top-level component in which this `WorkspaceContainer`
+appears (feature names are generally provided in the lifecycle functions in an app's `index.ts` file).
+The slot is named `action-menu-${featureName}-items-slot`. For the patient chart, this is
+`action-menu-patient-chart-items-slot`.
+
+This component also provides everything needed for workspace notifications to be rendered.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`WorkspaceContainerProps`](../interfaces/WorkspaceContainerProps.md)
+
+## Returns
+
+`Element`

package/docs/functions/age.md

@@ -0,0 +1,32 @@
+[O3 Framework](../API.md) / age
+
+# Function: age()
+
+> **age**(`birthDate`, `currentDate?`): `null` \| `string`
+
+Defined in: packages/framework/esm-utils/dist/age-helpers.d.ts:12
+
+Gets a human readable and locale supported representation of a person's age, given their birthDate,
+The representation logic follows the guideline here:
+https://webarchive.nationalarchives.gov.uk/ukgwa/20160921162509mp_/http://systems.digital.nhs.uk/data/cui/uig/patben.pdf
+(See Tables 7 and 8)
+
+## Parameters
+
+### birthDate
+
+The birthDate. If birthDate is null, returns null.
+
+`undefined` | `null` | `string` | `number` | `Date` | `Dayjs`
+
+### currentDate?
+
+Optional. If provided, calculates the age of the person at the provided currentDate (instead of now).
+
+`null` | `string` | `number` | `Date` | `Dayjs`
+
+## Returns
+
+`null` \| `string`
+
+A human-readable string version of the age.

package/docs/functions/attach.md

@@ -0,0 +1,40 @@
+[O3 Framework](../API.md) / attach
+
+# Function: attach()
+
+> **attach**(`slotName`, `extensionId`): `void`
+
+Defined in: [packages/framework/esm-extensions/src/extensions.ts:215](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/extensions.ts#L215)
+
+Attach an extension to an extension slot.
+
+This will cause the extension to be rendered into the specified
+extension slot, unless it is removed by configuration. Using
+`attach` is an alternative to specifying the `slot` or `slots`
+in the extension declaration.
+
+It is particularly useful when creating a slot into which
+you want to render an existing extension. This enables you
+to do so without modifying the extension's declaration, which
+may be impractical or inappropriate, for example if you are
+writing a module for a specific implementation.
+
+## Parameters
+
+### slotName
+
+`string`
+
+a name uniquely identifying the slot
+
+### extensionId
+
+`string`
+
+an extension name, with an optional #-suffix
+   to distinguish it from other instances of the same extension
+   attached to the same slot.
+
+## Returns
+
+`void`

package/docs/functions/beginEditSynchronizationItem.md

@@ -0,0 +1,22 @@
+[O3 Framework](../API.md) / beginEditSynchronizationItem
+
+# Function: beginEditSynchronizationItem()
+
+> **beginEditSynchronizationItem**(`id`): `Promise`\<`void`\>
+
+Defined in: [packages/framework/esm-offline/src/sync.ts:330](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L330)
+
+Triggers an edit flow for the given synchronization item.
+If this is not possible, throws an error.
+
+## Parameters
+
+### id
+
+`number`
+
+The ID of the synchronization item to be edited.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/functions/canAccessStorage.md

@@ -0,0 +1,25 @@
+[O3 Framework](../API.md) / canAccessStorage
+
+# Function: canAccessStorage()
+
+> **canAccessStorage**(`storage?`): `boolean`
+
+Defined in: packages/framework/esm-utils/dist/storage.d.ts:10
+
+Simple utility function to determine if an object implementing the WebStorage API
+is actually available. Useful for testing the availability of `localStorage` or
+`sessionStorage`.
+
+## Parameters
+
+### storage?
+
+`Storage`
+
+The WebStorage API object to check. Defaults to `localStorage`.
+
+## Returns
+
+`boolean`
+
+True if the WebStorage API object is able to be accessed, false otherwise

package/docs/functions/canBeginEditSynchronizationItemsOfType.md

@@ -0,0 +1,22 @@
+[O3 Framework](../API.md) / canBeginEditSynchronizationItemsOfType
+
+# Function: canBeginEditSynchronizationItemsOfType()
+
+> **canBeginEditSynchronizationItemsOfType**(`type`): `boolean`
+
+Defined in: [packages/framework/esm-offline/src/sync.ts:320](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L320)
+
+Returns whether editing synchronization items of the given type is supported by the currently
+registered synchronization handlers.
+
+## Parameters
+
+### type
+
+`string`
+
+The identifying type of the synchronization item which should be edited.
+
+## Returns
+
+`boolean`

package/docs/functions/clearCurrentUser.md

@@ -0,0 +1,11 @@
+[O3 Framework](../API.md) / clearCurrentUser
+
+# Function: clearCurrentUser()
+
+> **clearCurrentUser**(): `void`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L177)
+
+## Returns
+
+`void`

package/docs/functions/closeWorkspace.md

@@ -0,0 +1,27 @@
+[O3 Framework](../API.md) / closeWorkspace
+
+# Function: closeWorkspace()
+
+> **closeWorkspace**(`name`, `options`): `boolean`
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:432](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L432)
+
+Function to close an opened workspace
+
+## Parameters
+
+### name
+
+`string`
+
+Workspace registration name
+
+### options
+
+[`CloseWorkspaceOptions`](../interfaces/CloseWorkspaceOptions.md) = `{}`
+
+Options to close workspace
+
+## Returns
+
+`boolean`

package/docs/functions/compile.md

@@ -0,0 +1,30 @@
+[O3 Framework](../API.md) / compile
+
+# Function: compile()
+
+> **compile**(`expression`): `Expression`
+
+Defined in: [packages/framework/esm-expression-evaluator/src/evaluator.ts:323](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-expression-evaluator/src/evaluator.ts#L323)
+
+`compile()` is a companion function for use with [()](evaluate.md) and the various `evaluateAs*()` functions.
+It processes an expression string into the resulting AST that is executed by those functions. This is useful if
+you have an expression that will need to be evaluated mulitple times, potentially with different values, as the
+lexing and parsing steps can be skipped by using the AST object returned from this.
+
+The returned AST is intended to be opaque to client applications, but, of course, it is possible to manipulate
+the AST before passing it back to [()](evaluate.md), if desired. This might be useful if, for example, certain
+values are known to be constant.
+
+## Parameters
+
+### expression
+
+`string`
+
+The expression to be parsed
+
+## Returns
+
+`Expression`
+
+An executable AST representation of the expression

package/docs/functions/convertToLocaleCalendar.md

@@ -0,0 +1,25 @@
+[O3 Framework](../API.md) / convertToLocaleCalendar
+
+# Function: convertToLocaleCalendar()
+
+> **convertToLocaleCalendar**(`date`, `locale`): `CalendarDate` \| `CalendarDateTime` \| `ZonedDateTime`
+
+Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:144
+
+Converts a calendar date to the equivalent locale calendar date.
+
+## Parameters
+
+### date
+
+`CalendarDate` | `CalendarDateTime` | `ZonedDateTime`
+
+### locale
+
+`string` | `Locale`
+
+## Returns
+
+`CalendarDate` \| `CalendarDateTime` \| `ZonedDateTime`
+
+CalendarDate

package/docs/functions/createAttachment.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / createAttachment
+
+# Function: createAttachment()
+
+> **createAttachment**(`patientUuid`, `fileToUpload`): `Promise`\<`FetchResponse`\<`any`\>\>
+
+Defined in: [packages/framework/esm-emr-api/src/attachments.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/attachments.ts#L19)
+
+## Parameters
+
+### patientUuid
+
+`string`
+
+### fileToUpload
+
+[`UploadedFile`](../interfaces/UploadedFile.md)
+
+## Returns
+
+`Promise`\<`FetchResponse`\<`any`\>\>

package/docs/functions/createErrorHandler.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / createErrorHandler
+
+# Function: createErrorHandler()
+
+> **createErrorHandler**(): (`incomingErr`) => `void`
+
+Defined in: packages/framework/esm-error-handling/dist/index.d.ts:2
+
+## Returns
+
+> (`incomingErr`): `void`
+
+### Parameters
+
+#### incomingErr
+
+`unknown`
+
+### Returns
+
+`void`

package/docs/functions/createGlobalStore.md

@@ -0,0 +1,36 @@
+[O3 Framework](../API.md) / createGlobalStore
+
+# Function: createGlobalStore()
+
+> **createGlobalStore**\<`T`\>(`name`, `initialState`): `StoreApi`\<`T`\>
+
+Defined in: [packages/framework/esm-state/src/state.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-state/src/state.ts#L30)
+
+Creates a Zustand store.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### name
+
+`string`
+
+A name by which the store can be looked up later.
+   Must be unique across the entire application.
+
+### initialState
+
+`T`
+
+An object which will be the initial state of the store.
+
+## Returns
+
+`StoreApi`\<`T`\>
+
+The newly created store.

package/docs/functions/createUseStore.md

@@ -0,0 +1,66 @@
+[O3 Framework](../API.md) / createUseStore
+
+# Function: createUseStore()
+
+> **createUseStore**\<`T`\>(`store`): \{(): `T`; \<`A`\>(`actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>; \<`A`\>(`actions?`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>; \}
+
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L95)
+
+Whenever possible, use `useStore(yourStore)` instead. This function is for creating a
+custom hook for a specific store.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### store
+
+`StoreApi`\<`T`\>
+
+## Returns
+
+> (): `T`
+
+### Returns
+
+`T`
+
+> \<`A`\>(`actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
+
+### Type Parameters
+
+#### A
+
+`A` *extends* [`Actions`](../type-aliases/Actions.md)\<`T`\>
+
+### Parameters
+
+#### actions
+
+`A`
+
+### Returns
+
+`T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
+
+> \<`A`\>(`actions?`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
+
+### Type Parameters
+
+#### A
+
+`A` *extends* [`Actions`](../type-aliases/Actions.md)\<`T`\>
+
+### Parameters
+
+#### actions?
+
+`A`
+
+### Returns
+
+`T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>

package/docs/functions/defineConfigSchema.md

@@ -0,0 +1,33 @@
+[O3 Framework](../API.md) / defineConfigSchema
+
+# Function: defineConfigSchema()
+
+> **defineConfigSchema**(`moduleName`, `schema`): `void`
+
+Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:168](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/module-config/module-config.ts#L168)
+
+This defines a configuration schema for a module. The schema tells the
+configuration system how the module can be configured. It specifies
+what makes configuration valid or invalid.
+
+See [Configuration System](https://o3-docs.openmrs.org/docs/configuration-system)
+for more information about defining a config schema.
+
+## Parameters
+
+### moduleName
+
+`string`
+
+Name of the module the schema is being defined for. Generally
+  should be the one in which the `defineConfigSchema` call takes place.
+
+### schema
+
+[`ConfigSchema`](../interfaces/ConfigSchema.md)
+
+The config schema for the module
+
+## Returns
+
+`void`

package/docs/functions/defineExtensionConfigSchema.md

@@ -0,0 +1,38 @@
+[O3 Framework](../API.md) / defineExtensionConfigSchema
+
+# Function: defineExtensionConfigSchema()
+
+> **defineExtensionConfigSchema**(`extensionName`, `schema`): `void`
+
+Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/module-config/module-config.ts#L244)
+
+This defines a configuration schema for an extension. When a schema is defined
+for an extension, that extension will receive the configuration corresponding
+to that schema, rather than the configuration corresponding to the module
+in which it is defined.
+
+The schema tells the configuration system how the module can be configured.
+It specifies what makes configuration valid or invalid.
+
+See [Configuration System](https://o3-docs.openmrs.org/docs/configuration-system)
+for more information about defining a config schema.
+
+## Parameters
+
+### extensionName
+
+`string`
+
+Name of the extension the schema is being defined for.
+  Should match the `name` of one of the `extensions` entries being returned
+  by `setupOpenMRS`.
+
+### schema
+
+[`ConfigSchema`](../interfaces/ConfigSchema.md)
+
+The config schema for the extension
+
+## Returns
+
+`void`

package/docs/functions/deleteAttachmentPermanently.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / deleteAttachmentPermanently
+
+# Function: deleteAttachmentPermanently()
+
+> **deleteAttachmentPermanently**(`attachmentUuid`, `abortController`): `Promise`\<`FetchResponse`\<`any`\>\>
+
+Defined in: [packages/framework/esm-emr-api/src/attachments.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/attachments.ts#L38)
+
+## Parameters
+
+### attachmentUuid
+
+`string`
+
+### abortController
+
+`AbortController`
+
+## Returns
+
+`Promise`\<`FetchResponse`\<`any`\>\>

package/docs/functions/deleteSynchronizationItem.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / deleteSynchronizationItem
+
+# Function: deleteSynchronizationItem()
+
+> **deleteSynchronizationItem**(`id`): `Promise`\<`void`\>
+
+Defined in: [packages/framework/esm-offline/src/sync.ts:350](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L350)
+
+Deletes a queued up sync item with the given ID.
+
+## Parameters
+
+### id
+
+`number`
+
+The ID of the synchronization item to be deleted.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/functions/detach.md

@@ -0,0 +1,25 @@
+[O3 Framework](../API.md) / detach
+
+# Function: ~~detach()~~
+
+> **detach**(`extensionSlotName`, `extensionId`): `void`
+
+Defined in: [packages/framework/esm-extensions/src/extensions.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/extensions.ts#L248)
+
+## Parameters
+
+### extensionSlotName
+
+`string`
+
+### extensionId
+
+`string`
+
+## Returns
+
+`void`
+
+## Deprecated
+
+Avoid using this. Extension attachments should be considered declarative.

package/docs/functions/detachAll.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / detachAll
+
+# Function: ~~detachAll()~~
+
+> **detachAll**(`extensionSlotName`): `void`
+
+Defined in: [packages/framework/esm-extensions/src/extensions.ts:272](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/extensions.ts#L272)
+
+## Parameters
+
+### extensionSlotName
+
+`string`
+
+## Returns
+
+`void`
+
+## Deprecated
+
+Avoid using this. Extension attachments should be considered declarative.

package/docs/functions/dispatchNotificationShown.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / dispatchNotificationShown
+
+# Function: dispatchNotificationShown()
+
+> **dispatchNotificationShown**(`data`): `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:50
+
+## Parameters
+
+### data
+
+[`ShowNotificationEvent`](../interfaces/ShowNotificationEvent.md)
+
+## Returns
+
+`void`

package/docs/functions/dispatchPrecacheStaticDependencies.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / dispatchPrecacheStaticDependencies
+
+# Function: dispatchPrecacheStaticDependencies()
+
+> **dispatchPrecacheStaticDependencies**(`data?`): `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:12
+
+## Parameters
+
+### data?
+
+[`PrecacheStaticDependenciesEvent`](../interfaces/PrecacheStaticDependenciesEvent.md)
+
+## Returns
+
+`void`