@openmrs/esm-framework 4.0.1-pre.220 → 4.0.1-pre.226

package/docs/API.md

@@ -30,7 +30,7 @@
 - [useSession](API.md#usesession)
 - [useVisit](API.md#usevisit)
 - [useVisitTypes](API.md#usevisittypes)
-- [userHasAccess](API.md#userhasaccess-1)
+- [userHasAccess](API.md#userhasaccess)
 
 ### Breadcrumb Functions
 
@@ -54,7 +54,7 @@
 - [isUrl](API.md#isurl)
 - [isUrlWithTemplateParameters](API.md#isurlwithtemplateparameters)
 - [oneOf](API.md#oneof)
-- [validator](API.md#validator-1)
+- [validator](API.md#validator)
 
 ### Date and Time Functions
 
@@ -284,10 +284,10 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `day` | `boolean` |  |
-| `mode` | [`FormatDateMode`](API.md#formatdatemode) |  |
-| `time` | `boolean` \| ``"for today"`` |  |
-| `year` | `boolean` |  |
+| `day` | `boolean` | Whether to include the day number |
+| `mode` | [`FormatDateMode`](API.md#formatdatemode) | - `standard`: "03 Feb 2022" - `wide`:     "03 — Feb — 2022" |
+| `time` | `boolean` \| ``"for today"`` | Whether the time should be included in the output always (`true`), never (`false`), or only when the input date is today (`for today`). |
+| `year` | `boolean` | Whether to include the year |
 
 #### Defined in
 
@@ -337,6 +337,11 @@ ___
 
 Ƭ **OmrsOfflineCachingStrategy**: ``"network-only-or-cache-only"`` \| ``"network-first"``
 
+* `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.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/service-worker-http-headers.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L18)
@@ -357,13 +362,16 @@ ___
 
 Ƭ **OmrsOfflineHttpHeaders**: `Object`
 
+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.
+
 #### Type declaration
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) |  |
-| `x-omrs-offline-response-body?` | `string` |  |
-| `x-omrs-offline-response-status?` | \`${number}\` |  |
+| `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) | Instructs the service worker to use a specific caching strategy for this request. |
+| `x-omrs-offline-response-body?` | `string` | 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?` | \`${number}\` | 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. |
 
 #### Defined in
 
@@ -570,6 +578,16 @@ ___
 
 • `Const` **fhir**: `Object`
 
+The `fhir` object is replicates the API from [fhir.js](https://github.com/FHIR/fhir.js)
+that can be used to call FHIR-compliant OpenMRS APIs. See
+[the docs for fhir.js](https://github.com/FHIR/fhir.js) for more info
+and example usage.
+
+This object should be considered deprecated and may be removed from a future version
+of the framework.
+
+**`deprecated`**
+
 #### Type declaration
 
 | Name | Type |
@@ -691,6 +709,14 @@ ___
 
 • `Const` **Extension**: `React.FC`<[`ExtensionProps`](API.md#extensionprops)\>
 
+Represents the position in the DOM where each extension within
+an extension slot is rendered.
+
+Renders once for each extension attached to that extension slot.
+
+Usage of this component *must* have an ancestor `<ExtensionSlot>`,
+and *must* only be used once within that `<ExtensionSlot>`.
+
 #### Defined in
 
 [packages/framework/esm-react-utils/src/Extension.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L36)
@@ -765,10 +791,41 @@ ___
 
 ▸ **getCurrentUser**(): `Observable`<[`Session`](interfaces/Session.md)\>
 
+The getCurrentUser function returns an observable that produces
+**zero or more values, over time**. It will produce zero values
+by default if the user is not logged in. And it will provide a
+first value when the logged in user is fetched from the server.
+Subsequent values will be produced whenever the user object is
+updated.
+
 #### Returns
 
 `Observable`<[`Session`](interfaces/Session.md)\>
 
+An Observable that produces zero or more values (as
+  described above). The values produced will be a user object (if
+  `includeAuthStatus` is set to `false`) or an object with a session
+  and authenticated property (if `includeAuthStatus` is set to `true`).
+
+#### Example
+
+```js
+import { getCurrentUser } from '@openmrs/esm-api'
+const subscription = getCurrentUser().subscribe(
+  user => console.log(user)
+)
+subscription.unsubscribe()
+getCurrentUser({includeAuthStatus: true}).subscribe(
+  data => console.log(data.authenticated)
+)
+```
+
+#### Be sure to unsubscribe when your component unmounts
+
+Otherwise your code will continue getting updates to the user object
+even after the UI component is gone from the screen. This is a memory
+leak and source of bugs.
+
 #### Defined in
 
 [packages/framework/esm-api/src/shared-api-objects/current-user.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L71)
@@ -905,6 +962,15 @@ ___
 
 ▸ **makeUrl**(`path`): `string`
 
+Append `path` to the OpenMRS SPA base.
+
+#### Example
+
+```ts
+makeUrl('/foo/bar');
+// => '/openmrs/foo/bar'
+```
+
 #### Parameters
 
 | Name | Type |
@@ -925,6 +991,11 @@ ___
 
 ▸ **openmrsFetch**<`T`\>(`path`, `fetchInit?`): `Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
 
+The openmrsFetch function is a wrapper around the
+[browser's built-in fetch function](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch),
+with extra handling for OpenMRS-specific API behaviors, such as
+request headers, authentication, authorization, and the API urls.
+
 #### Type parameters
 
 | Name | Type |
@@ -935,13 +1006,48 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `path` | `string` |  |
-| `fetchInit` | `FetchConfig` |  |
+| `path` | `string` | A string url to make the request to. Note that the   openmrs base url (by default `/openmrs`) will be automatically   prepended to the URL, so there is no need to include it. |
+| `fetchInit` | `FetchConfig` | A [fetch init object](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Syntax).   Note that the `body` property does not need to be `JSON.stringify()`ed   because openmrsFetch will do that for you. |
 
 #### Returns
 
 `Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
 
+A [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+  that resolves with a [Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response).
+  Note that the openmrs version of the Response object has already
+  downloaded the HTTP response body as json, and has an additional
+  `data` property with the HTTP response json as a javascript object.
+
+#### Example
+```js
+import { openmrsFetch } from '@openmrs/esm-api'
+const abortController = new AbortController();
+openmrsFetch('/ws/rest/v1/session', {signal: abortController.signal})
+  .then(response => {
+    console.log(response.data.authenticated)
+  })
+  .catch(err => {
+    console.error(err.status);
+  })
+abortController.abort();
+openmrsFetch('/ws/rest/v1/session', {
+  method: 'POST',
+  body: {
+    username: 'hi',
+    password: 'there',
+  }
+})
+```
+
+#### Cancellation
+
+To cancel a network request, use an
+[AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort).
+It is best practice to cancel your network requests when the user
+navigates away from a page while the request is pending request, to
+free up memory and network resources and to prevent race conditions.
+
 #### Defined in
 
 [packages/framework/esm-api/src/openmrs-fetch.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L72)
@@ -952,6 +1058,11 @@ ___
 
 ▸ **openmrsObservableFetch**<`T`\>(`url`, `fetchInit?`): `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
 
+The openmrsObservableFetch function is a wrapper around openmrsFetch
+that returns an [Observable](https://rxjs-dev.firebaseapp.com/guide/observable)
+instead of a promise. It exists in case using an Observable is
+preferred or more convenient than a promise.
+
 #### Type parameters
 
 | Name |
@@ -962,13 +1073,32 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `url` | `string` |  |
-| `fetchInit` | `FetchConfig` |  |
+| `url` | `string` | See [openmrsFetch](API.md#openmrsfetch) |
+| `fetchInit` | `FetchConfig` | See [openmrsFetch](API.md#openmrsfetch) |
 
 #### Returns
 
 `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
 
+An Observable that produces exactly one Response object.
+The response object is exactly the same as for [openmrsFetch](API.md#openmrsfetch).
+
+#### Example
+
+```js
+import { openmrsObservableFetch } from '@openmrs/esm-api'
+const subscription = openmrsObservableFetch('/ws/rest/v1/session').subscribe(
+  response => console.log(response.data),
+  err => {throw err},
+  () => console.log('finished')
+)
+subscription.unsubscribe()
+```
+
+#### Cancellation
+
+To cancel the network request, simply call `subscription.unsubscribe();`
+
 #### Defined in
 
 [packages/framework/esm-api/src/openmrs-fetch.ts:243](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L243)
@@ -979,10 +1109,22 @@ ___
 
 ▸ **refetchCurrentUser**(): `Promise`<`unknown`\>
 
+The `refetchCurrentUser` function causes a network request to redownload
+the user. All subscribers to the current user will be notified of the
+new users once the new version of the user object is downloaded.
+
 #### Returns
 
 `Promise`<`unknown`\>
 
+The same observable as returned by [getCurrentUser](API.md#getcurrentuser).
+
+#### Example
+```js
+import { refetchCurrentUser } from '@openmrs/esm-api'
+refetchCurrentUser()
+```
+
 #### Defined in
 
 [packages/framework/esm-api/src/shared-api-objects/current-user.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L163)
@@ -1097,6 +1239,11 @@ ___
 
 ▸ **useCurrentPatient**(`patientUuid?`): [`boolean`, `NullablePatient`, [`PatientUuid`](API.md#patientuuid), `Error` \| ``null``]
 
+This React hook returns the current patient, as specified by the current route. It returns
+all the information needed to render a loading state, error state, and normal/success state.
+
+**`deprecated`** Use [usePatient](API.md#usepatient) instead.
+
 #### Parameters
 
 | Name | Type |
@@ -1131,6 +1278,11 @@ ___
 
 ▸ **usePatient**(`patientUuid?`): `Object`
 
+This React hook returns a patient object. If the `patientUuid` is provided
+as a parameter, then the patient for that UUID is returned. If the parameter
+is not provided, the patient UUID is obtained from the current route, and
+a route listener is set up to update the patient whenever the route changes.
+
 #### Parameters
 
 | Name | Type |
@@ -1158,10 +1310,18 @@ ___
 
 ▸ **useSession**(): [`Session`](interfaces/Session.md)
 
+Gets the current user session information. Returns an object with
+property `authenticated` == `false` if the user is not logged in.
+
+Uses Suspense. This hook will always either return a Session object
+or throw for Suspense. It will never return `null`/`undefined`.
+
 #### Returns
 
 [`Session`](interfaces/Session.md)
 
+Current user session information
+
 #### Defined in
 
 [packages/framework/esm-react-utils/src/useSession.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useSession.tsx#L17)
@@ -1172,16 +1332,22 @@ ___
 
 ▸ **useVisit**(`patientUuid`): `VisitReturnType`
 
+This React hook returns a visit object. If the `patientUuid` is provided
+as a parameter, then the currentVisit, error and mutate function
+for that patient visit is returned.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `patientUuid` | `string` |  |
+| `patientUuid` | `string` | Unique patient identifier `string` |
 
 #### Returns
 
 `VisitReturnType`
 
+Object {`error` `isValidating`, `currentVisit`, `mutate`}
+
 #### Defined in
 
 [packages/framework/esm-react-utils/src/useVisit.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L29)
@@ -1328,12 +1494,19 @@ ___
 
 ▸ **defineConfigSchema**(`moduleName`, `schema`): `void`
 
+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](http://o3-dev.docs.openmrs.org/#/main/config)
+for more information about defining a config schema.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `moduleName` | `string` |  |
-| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) |  |
+| `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
 
@@ -1349,12 +1522,23 @@ ___
 
 ▸ **defineExtensionConfigSchema**(`extensionName`, `schema`): `void`
 
+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](http://o3-dev.docs.openmrs.org/#/main/config)
+for more information about defining a config schema.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `extensionName` | `string` |  |
-| `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) |  |
+| `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
 
@@ -1370,11 +1554,21 @@ ___
 
 ▸ **getConfig**(`moduleName`): `Promise`<[`Config`](interfaces/Config.md)\>
 
+A promise-based way to access the config as soon as it is fully loaded.
+If it is already loaded, resolves the config in its present state.
+
+In general you should use the Unistore-based API provided by
+`getConfigStore`, which allows creating a subscription so that you always
+have the latest config. If using React, just use `useConfig`.
+
+This is a useful function if you need to get the config in the course
+of the execution of a function.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `moduleName` | `string` |  |
+| `moduleName` | `string` | The name of the module for which to look up the config |
 
 #### Returns
 
@@ -1411,6 +1605,8 @@ ___
 
 ▸ **useConfig**(): `Object`
 
+Use this React Hook to obtain your module's configuration.
+
 #### Returns
 
 `Object`
@@ -1418,13 +1614,13 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `Display conditions?` | [`DisplayConditionsConfigObject`](interfaces/DisplayConditionsConfigObject.md) | - |
-| `constructor` | `Function` |  |
-| `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` |  |
-| `isPrototypeOf` | (`v`: `Object`) => `boolean` |  |
-| `propertyIsEnumerable` | (`v`: `PropertyKey`) => `boolean` |  |
-| `toLocaleString` | () => `string` |  |
-| `toString` | () => `string` |  |
-| `valueOf` | () => `Object` |  |
+| `constructor` | `Function` | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |
+| `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | Determines whether an object has a property with the specified name. |
+| `isPrototypeOf` | (`v`: `Object`) => `boolean` | Determines whether an object exists in another object's prototype chain. |
+| `propertyIsEnumerable` | (`v`: `PropertyKey`) => `boolean` | Determines whether a specified property is enumerable. |
+| `toLocaleString` | () => `string` | Returns a date converted to a string using the current locale. |
+| `toString` | () => `string` | Returns a string representation of an object. |
+| `valueOf` | () => `Object` | Returns the primitive value of the specified object. |
 
 #### Defined in
 
@@ -1438,12 +1634,14 @@ ___
 
 ▸ **inRange**(`min`, `max`): [`Validator`](API.md#validator)
 
+Verifies that the value is between the provided minimum and maximum
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `min` | `number` |  |
-| `max` | `number` |  |
+| `min` | `number` | Minimum acceptable value |
+| `max` | `number` | Maximum acceptable value |
 
 #### Returns
 
@@ -1459,6 +1657,10 @@ ___
 
 ▸ **isUrl**(`value`): `string` \| `void`
 
+Verifies that a string contains only the default URL template parameters.
+
+**`category`** Navigation
+
 #### Parameters
 
 | Name | Type |
@@ -1479,11 +1681,16 @@ ___
 
 ▸ **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](API.md#validator)
 
+Verifies that a string contains only the default URL template
+parameters, plus any specified in `allowedTemplateParameters`.
+
+**`category`** Navigation
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `allowedTemplateParameters` | `string`[] |  |
+| `allowedTemplateParameters` | `string`[] | To be added to `openmrsBase` and `openmrsSpaBase` |
 
 #### Returns
 
@@ -1499,11 +1706,13 @@ ___
 
 ▸ **oneOf**(`allowedValues`): [`Validator`](API.md#validator)
 
+Verifies that the value is one of the allowed options.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `allowedValues` | `any`[] |  |
+| `allowedValues` | `any`[] | The list of allowable values |
 
 #### Returns
 
@@ -1519,17 +1728,34 @@ ___
 
 ▸ **validator**(`validationFunction`, `message`): [`Validator`](API.md#validator)
 
+Constructs a custom validator.
+
+### Example
+
+```typescript
+{
+  foo: {
+    _default: 0,
+    _validators: [
+      validator(val => val >= 0, "Must not be negative.")
+    ]
+  }
+}
+```
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) |  |
-| `message` | `string` \| (`value`: `any`) => `string` |  |
+| `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) | Takes the configured value as input. Returns true    if it is valid, false otherwise. |
+| `message` | `string` \| (`value`: `any`) => `string` | A string message that explains why the value is invalid. Can    also be a function that takes the value as input and returns a string. |
 
 #### Returns
 
 [`Validator`](API.md#validator)
 
+A validator ready for use in a config schema
+
 #### Defined in
 
 [packages/framework/esm-config/src/validators/validator.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validator.ts#L25)
@@ -1542,6 +1768,23 @@ ___
 
 ▸ **formatDate**(`date`, `options?`): `string`
 
+Formats the input date according to the current locale and the
+given options.
+
+Default options:
+ - mode: "standard",
+ - time: "for today",
+ - day: true,
+ - year: true
+
+If the date is today then "Today" is produced (in the locale language).
+
+When time is included, it is appended with a comma and a space. This
+agrees with the output of `Date.prototype.toLocaleString` for *most*
+locales.
+
+TODO: Shouldn't throw on null input
+
 #### Parameters
 
 | Name | Type |
@@ -1563,6 +1806,14 @@ ___
 
 ▸ **formatDatetime**(`date`, `options?`): `string`
 
+Formats the input into a string showing the date and time, according
+to the current locale. The `mode` parameter is as described for
+`formatDate`.
+
+This is created by concatenating the results of `formatDate`
+and `formatTime` with a comma and space. This agrees with the
+output of `Date.prototype.toLocaleString` for *most* locales.
+
 #### Parameters
 
 | Name | Type |
@@ -1584,6 +1835,9 @@ ___
 
 ▸ **formatTime**(`date`): `string`
 
+Formats the input as a time, according to the current locale.
+12-hour or 24-hour clock depends on locale.
+
 #### Parameters
 
 | Name | Type |
@@ -1604,6 +1858,9 @@ ___
 
 ▸ **isOmrsDateStrict**(`omrsPayloadString`): `boolean`
 
+This function is STRICT on checking whether a date string is the openmrs format.
+The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
+
 #### Parameters
 
 | Name | Type |
@@ -1628,7 +1885,7 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) |  |
+| `date` | [`DateInput`](API.md#dateinput) | Checks if the provided date is today. |
 
 #### Returns
 
@@ -1644,6 +1901,9 @@ ___
 
 ▸ **parseDate**(`dateString`): `Date`
 
+Utility function to parse an arbitrary string into a date.
+Uses `dayjs(dateString)`.
+
 #### Parameters
 
 | Name | Type |
@@ -1664,6 +1924,8 @@ ___
 
 ▸ **toDateObjectStrict**(`omrsDateString`): `Date` \| ``null``
 
+Converts the object to a date object if it is a valid ISO date time string.
+
 #### Parameters
 
 | Name | Type |
@@ -1684,6 +1946,9 @@ ___
 
 ▸ **toOmrsDateFormat**(`date`, `format?`): `string`
 
+**`deprecated`** use `formatDate(date)`
+Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
+
 #### Parameters
 
 | Name | Type | Default value |
@@ -1705,6 +1970,9 @@ ___
 
 ▸ **toOmrsDayDateFormat**(`date`): `string`
 
+**`deprecated`** use `formatDate(date, "wide")`
+Formats the input as a date string using the format "DD - MMM - YYYY".
+
 #### Parameters
 
 | Name | Type |
@@ -1725,6 +1993,8 @@ ___
 
 ▸ **toOmrsIsoString**(`date`, `toUTC?`): `string`
 
+Formats the input as a date time string using the format "YYYY-MM-DDTHH:mm:ss.SSSZZ".
+
 #### Parameters
 
 | Name | Type | Default value |
@@ -1746,6 +2016,9 @@ ___
 
 ▸ **toOmrsTimeString**(`date`): `string`
 
+**`deprecated`** use `formatTime`
+Formats the input as a time string using the format "HH:mm A".
+
 #### Parameters
 
 | Name | Type |
@@ -1766,6 +2039,9 @@ ___
 
 ▸ **toOmrsTimeString24**(`date`): `string`
 
+**`deprecated`** use `formatTime`
+Formats the input as a time string using the format "HH:mm".
+
 #### Parameters
 
 | Name | Type |
@@ -1786,6 +2062,9 @@ ___
 
 ▸ **toOmrsYearlessDateFormat**(`date`): `string`
 
+**`deprecated`** use `formatDate(date, "no year")`
+Formats the input as a date string using the format "DD-MMM".
+
 #### Parameters
 
 | Name | Type |
@@ -1856,12 +2135,25 @@ ___
 
 ▸ **attach**(`slotName`, `extensionId`): `void`
 
+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
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `slotName` | `string` |  |
-| `extensionId` | `string` |  |
+| `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
 
@@ -1877,6 +2169,8 @@ ___
 
 ▸ **detach**(`extensionSlotName`, `extensionId`): `void`
 
+Avoid using this. Extension attachments should be considered declarative.
+
 #### Parameters
 
 | Name | Type |
@@ -1898,6 +2192,8 @@ ___
 
 ▸ **detachAll**(`extensionSlotName`): `void`
 
+Avoid using this. Extension attachments should be considered declarative.
+
 #### Parameters
 
 | Name | Type |
@@ -1918,16 +2214,20 @@ ___
 
 ▸ **getAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
 
+Gets the list of extensions assigned to a given slot
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `slotName` | `string` |  |
+| `slotName` | `string` | The slot to load the assigned extensions for |
 
 #### Returns
 
 [`AssignedExtension`](interfaces/AssignedExtension.md)[]
 
+An array of extensions assigned to the named slot
+
 #### Defined in
 
 [packages/framework/esm-extensions/src/extensions.ts:359](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L359)
@@ -1938,17 +2238,22 @@ ___
 
 ▸ **getConnectedExtensions**(`assignedExtensions`, `online?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
 
+Filters a list of extensions according to whether they support the
+current connectivity status.
+
 #### Parameters
 
 | Name | Type | Default value | Description |
 | :------ | :------ | :------ | :------ |
-| `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` |  |
-| `online` | ``null`` \| `boolean` | `null` |  |
+| `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | The list of extensions to filter. |
+| `online` | ``null`` \| `boolean` | `null` | Whether the app is currently online. If `null`, uses `navigator.onLine`. |
 
 #### Returns
 
 [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
 
+A list of extensions that should be rendered
+
 #### Defined in
 
 [packages/framework/esm-extensions/src/extensions.ts:287](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L287)
@@ -1959,6 +2264,18 @@ ___
 
 ▸ **getExtensionNameFromId**(`extensionId`): `string`
 
+Given an extension ID, which is a string uniquely identifying
+an instance of an extension within an extension slot, this
+returns the extension name.
+
+**`example`**
+```js
+getExtensionNameFromId("foo#bar")
+ --> "foo"
+getExtensionNameFromId("baz")
+ --> "baz"
+```
+
 #### Parameters
 
 | Name | Type |
@@ -1979,6 +2296,10 @@ ___
 
 ▸ **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
 
+This returns a [store](https://github.com/developit/unistore#store)
+that modules can use to get information about the state of the
+extension system.
+
 #### Returns
 
 `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
@@ -1993,6 +2314,10 @@ ___
 
 ▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): `Parcel` \| ``null``
 
+Mounts into a DOM node (representing an extension slot)
+a lazy-loaded component from *any* frontend module
+that registered an extension component for this slot.
+
 #### Parameters
 
 | Name | Type |
@@ -2018,11 +2343,16 @@ ___
 
 ▸ **useAssignedExtensionIds**(`slotName`): `string`[]
 
+Gets the assigned extension ids for a given extension slot name.
+Does not consider if offline or online.
+
+**`deprecated`** Use `useAssignedExtensions`
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `slotName` | `string` |  |
+| `slotName` | `string` | The name of the slot to get the assigned IDs for. |
 
 #### Returns
 
@@ -2038,11 +2368,14 @@ ___
 
 ▸ **useAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
 
+Gets the assigned extensions for a given extension slot name.
+Does not consider if offline or online.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `slotName` | `string` |  |
+| `slotName` | `string` | The name of the slot to get the assigned extensions for. |
 
 #### Returns
 
@@ -2058,11 +2391,14 @@ ___
 
 ▸ **useConnectedExtensions**(`slotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
 
+Gets the assigned extension for a given extension slot name.
+Considers if offline or online.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `slotName` | `string` |  |
+| `slotName` | `string` | The name of the slot to get the assigned extensions for. |
 
 #### Returns
 
@@ -2078,6 +2414,8 @@ ___
 
 ▸ **useExtensionSlotMeta**<`T`\>(`extensionSlotName`): `Object`
 
+Extract meta data from all extension for a given extension slot.
+
 #### Type parameters
 
 | Name | Type |
@@ -2086,9 +2424,9 @@ ___
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `extensionSlotName` | `string` |  |
+| Name | Type |
+| :------ | :------ |
+| `extensionSlotName` | `string` |
 
 #### Returns
 
@@ -2152,6 +2490,8 @@ ___
 
 ▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
 
+**`deprecated`** Use getAsyncLifecycle instead.
+
 #### Type parameters
 
 | Name |
@@ -2280,6 +2620,8 @@ ___
 
 ▸ **ConfigurableLink**(`__namedParameters`): `Element`
 
+A React link component which calls [navigate](API.md#navigate) when clicked
+
 #### Parameters
 
 | Name | Type |
@@ -2300,12 +2642,23 @@ ___
 
 ▸ **interpolateString**(`template`, `params`): `string`
 
+Interpolates values of `params` into the `template` string.
+
+Example usage:
+```js
+interpolateString("test ${one} ${two} 3", {
+   one: "1",
+   two: "2",
+}); // will return "test 1 2 3"
+interpolateString("test ok", { one: "1", two: "2" }) // will return "test ok"
+```
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `template` | `string` |  |
-| `params` | `Object` |  |
+| `template` | `string` | With optional params wrapped in `${ }` |
+| `params` | `Object` | Values to interpolate into the string template |
 
 #### Returns
 
@@ -2321,12 +2674,37 @@ ___
 
 ▸ **interpolateUrl**(`template`, `additionalParams?`): `string`
 
+Interpolates a string with openmrsBase and openmrsSpaBase.
+
+Useful for accepting `${openmrsBase}` or `${openmrsSpaBase}`plus additional template
+parameters in configurable URLs.
+
+Example usage:
+```js
+interpolateUrl("test ${openmrsBase} ${openmrsSpaBase} ok");
+   // will return "test /openmrs /openmrs/spa ok"
+
+interpolateUrl("${openmrsSpaBase}/patient/${patientUuid}", {
+   patientUuid: "4fcb7185-c6c9-450f-8828-ccae9436bd82",
+}); // will return "/openmrs/spa/patient/4fcb7185-c6c9-450f-8828-ccae9436bd82"
+```
+
+This can be used in conjunction with the `navigate` function like so
+```js
+navigate({
+ to: interpolateUrl(
+   "${openmrsSpaBase}/patient/${patientUuid}",
+   { patientUuid: patient.uuid }
+ )
+}); // will navigate to "/openmrs/spa/patient/4fcb7185-c6c9-450f-8828-ccae9436bd82"
+```
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `template` | `string` |  |
-| `additionalParams?` | `Object` |  |
+| `template` | `string` | A string to interpolate |
+| `additionalParams?` | `Object` | Additional values to interpolate into the string template |
 
 #### Returns
 
@@ -2342,11 +2720,28 @@ ___
 
 ▸ **navigate**(`to`): `void`
 
+Calls `location.assign` for non-SPA paths and [navigateToUrl](https://single-spa.js.org/docs/api/#navigatetourl) for SPA paths
+
+Example usage:
+```js
+const config = useConfig();
+const submitHandler = () => {
+  navigate({ to: config.links.submitSuccess });
+};
+```
+Example return values:
+navigate({ to: "/some/path" }); => window.location.assign("/some/path")
+navigate({ to: "https://single-spa.js.org/" }); => window.location.assign("https://single-spa.js.org/")
+navigate({ to: "${openmrsBase}/some/path" }); => window.location.assign("/openmrs/some/path")
+navigate({ to: "/openmrs/spa/foo/page" }); => navigateToUrl("/openmrs/spa/foo/page")
+navigate({ to: "${openmrsSpaBase}/bar/page" }); => navigateToUrl("/openmrs/spa/bar/page")
+navigate({ to: "/${openmrsSpaBase}/baz/page" }) => navigateToUrl("/openmrs/spa/baz/page")
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `to` | [`NavigateOptions`](interfaces/NavigateOptions.md) |  |
+| `to` | [`NavigateOptions`](interfaces/NavigateOptions.md) | The target path or URL. Supports templating with 'openmrsBase', 'openmrsSpaBase', and any additional template parameters defined in `templateParams`. For example, `${openmrsSpaBase}/home` will resolve to `/openmrs/spa/home` for implementations using the standard OpenMRS and SPA base paths. If `templateParams` contains `{ foo: "bar" }`, then the URL `${openmrsBase}/${foo}` will become `/openmrs/bar`. |
 
 #### Returns
 
@@ -2364,11 +2759,14 @@ ___
 
 ▸ **beginEditSynchronizationItem**(`id`): `Promise`<`void`\>
 
+Triggers an edit flow for the given synchronization item.
+If this is not possible, throws an error.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `id` | `number` |  |
+| `id` | `number` | The ID of the synchronization item to be edited. |
 
 #### Returns
 
@@ -2384,11 +2782,14 @@ ___
 
 ▸ **canBeginEditSynchronizationItemsOfType**(`type`): `boolean`
 
+Returns whether editing synchronization items of the given type is supported by the currently
+registered synchronization handlers.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` |  |
+| `type` | `string` | The identifying type of the synchronization item which should be edited. |
 
 #### Returns
 
@@ -2404,11 +2805,13 @@ ___
 
 ▸ **deleteSynchronizationItem**(`id`): `Promise`<`void`\>
 
+Deletes a queued up sync item with the given ID.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `id` | `number` |  |
+| `id` | `number` | The ID of the synchronization item to be deleted. |
 
 #### Returns
 
@@ -2424,6 +2827,8 @@ ___
 
 ▸ **generateOfflineUuid**(): `string`
 
+Generates a UUID-like string which is used for uniquely identifying objects while offline.
+
 #### Returns
 
 `string`
@@ -2452,11 +2857,14 @@ ___
 
 ▸ **getDynamicOfflineDataEntries**(`type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
 
+Returns all [DynamicOfflineData](interfaces/DynamicOfflineData.md) entries which registered for the currently logged in user.
+Optionally returns only entries of a given type.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type?` | `string` |  |
+| `type?` | `string` | The type of the entries to be returned. If `undefined`, returns all types. |
 
 #### Returns
 
@@ -2472,12 +2880,15 @@ ___
 
 ▸ **getDynamicOfflineDataEntriesFor**(`userId`, `type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
 
+Returns all [DynamicOfflineData](interfaces/DynamicOfflineData.md) entries which registered for the given user.
+Optionally returns only entries of a given type.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `userId` | `string` |  |
-| `type?` | `string` |  |
+| `userId` | `string` | The ID of the user whose entries are to be retrieved. |
+| `type?` | `string` | The type of the entries to be returned. If `undefined`, returns all types. |
 
 #### Returns
 
@@ -2493,6 +2904,8 @@ ___
 
 ▸ **getDynamicOfflineDataHandlers**(): [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md)[]
 
+Returns all handlers which have been setup using the [setupDynamicOfflineDataHandler](API.md#setupdynamicofflinedatahandler) function.
+
 #### Returns
 
 [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md)[]
@@ -2507,6 +2920,8 @@ ___
 
 ▸ **getFullSynchronizationItems**<`T`\>(`type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
 
+Returns all currently queued up sync items of the currently signed in user.
+
 #### Type parameters
 
 | Name |
@@ -2517,7 +2932,7 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type?` | `string` |  |
+| `type?` | `string` | The identifying type of the synchronization items to be returned. |
 
 #### Returns
 
@@ -2533,6 +2948,8 @@ ___
 
 ▸ **getFullSynchronizationItemsFor**<`T`\>(`userId`, `type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
 
+Returns all currently queued up sync items of a given user.
+
 #### Type parameters
 
 | Name |
@@ -2543,8 +2960,8 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `userId` | `string` |  |
-| `type?` | `string` |  |
+| `userId` | `string` | The ID of the user whose synchronization items should be returned. |
+| `type?` | `string` | The identifying type of the synchronization items to be returned.. |
 
 #### Returns
 
@@ -2560,6 +2977,8 @@ ___
 
 ▸ **getOfflinePatientDataStore**(): `Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
 
+**`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
+
 #### Returns
 
 `Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
@@ -2574,6 +2993,8 @@ ___
 
 ▸ **getSynchronizationItem**<`T`\>(`id`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\> \| `undefined`\>
 
+Returns a queued sync item with the given ID or `undefined` if no such item exists.
+
 #### Type parameters
 
 | Name | Type |
@@ -2584,7 +3005,7 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `id` | `number` |  |
+| `id` | `number` | The ID of the requested sync item. |
 
 #### Returns
 
@@ -2600,6 +3021,8 @@ ___
 
 ▸ **getSynchronizationItems**<`T`\>(`type?`): `Promise`<`T`[]\>
 
+Returns the content of all currently queued up sync items of the currently signed in user.
+
 #### Type parameters
 
 | Name |
@@ -2610,7 +3033,7 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type?` | `string` |  |
+| `type?` | `string` | The identifying type of the synchronization items to be returned. |
 
 #### Returns
 
@@ -2626,6 +3049,8 @@ ___
 
 ▸ **isOfflineUuid**(`uuid`): `boolean`
 
+Checks whether the given string has the format of an offline UUID generated by [generateOfflineUuid](API.md#generateofflineuuid)
+
 #### Parameters
 
 | Name | Type |
@@ -2646,16 +3071,20 @@ ___
 
 ▸ **messageOmrsServiceWorker**(`message`): `Promise`<[`MessageServiceWorkerResult`](interfaces/MessageServiceWorkerResult.md)<`any`\>\>
 
+Sends the specified message to the application's service worker.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `message` | [`KnownOmrsServiceWorkerMessages`](API.md#knownomrsserviceworkermessages) |  |
+| `message` | [`KnownOmrsServiceWorkerMessages`](API.md#knownomrsserviceworkermessages) | The message to be sent. |
 
 #### Returns
 
 `Promise`<[`MessageServiceWorkerResult`](interfaces/MessageServiceWorkerResult.md)<`any`\>\>
 
+A promise which completes when the message has been successfully processed by the Service Worker.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/service-worker-messaging.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L11)
@@ -2666,12 +3095,15 @@ ___
 
 ▸ **putDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
 
+Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
+should be made available offline for the currently logged in user.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` |  |
-| `identifier` | `string` |  |
+| `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
+| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
 
 #### Returns
 
@@ -2687,13 +3119,16 @@ ___
 
 ▸ **putDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
 
+Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
+should be made available offline for the user with the given ID.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `userId` | `string` |  |
-| `type` | `string` |  |
-| `identifier` | `string` |  |
+| `userId` | `string` | The ID of the user for whom the dynamic offline data should be made available. |
+| `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
+| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
 
 #### Returns
 
@@ -2709,6 +3144,8 @@ ___
 
 ▸ **queueSynchronizationItem**<`T`\>(`type`, `content`, `descriptor?`): `Promise`<`number`\>
 
+Enqueues a new item in the sync queue and associates the item with the currently signed in user.
+
 #### Type parameters
 
 | Name |
@@ -2719,9 +3156,9 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` |  |
-| `content` | `T` |  |
-| `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) |  |
+| `type` | `string` | The identifying type of the synchronization item. |
+| `content` | `T` | The actual data to be synchronized. |
+| `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) | An optional descriptor providing additional metadata about the sync item. |
 
 #### Returns
 
@@ -2737,6 +3174,8 @@ ___
 
 ▸ **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
 
+**`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
+
 #### Parameters
 
 | Name | Type |
@@ -2758,12 +3197,15 @@ ___
 
 ▸ **removeDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
 
+Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
+no longer needs to be available offline for the currently logged in user.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` |  |
-| `identifier` | `string` |  |
+| `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
+| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
 
 #### Returns
 
@@ -2779,13 +3221,16 @@ ___
 
 ▸ **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
 
+Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
+no longer needs to be available offline for the user with the given ID.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `userId` | `string` |  |
-| `type` | `string` |  |
-| `identifier` | `string` |  |
+| `userId` | `string` | The ID of the user who doesn't require the specified offline data. |
+| `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
+| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
 
 #### Returns
 
@@ -2801,11 +3246,14 @@ ___
 
 ▸ **setupDynamicOfflineDataHandler**(`handler`): `void`
 
+Sets up a handler for synchronizing dynamic offline data.
+See [DynamicOfflineDataHandler](interfaces/DynamicOfflineDataHandler.md) for details.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `handler` | [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md) |  |
+| `handler` | [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md) | The handler to be setup. |
 
 #### Returns
 
@@ -2821,6 +3269,8 @@ ___
 
 ▸ **setupOfflineSync**<`T`\>(`type`, `dependsOn`, `process`, `options?`): `void`
 
+Registers a new synchronization handler which is able to synchronize data of a specific type.
+
 #### Type parameters
 
 | Name |
@@ -2831,10 +3281,10 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` |  |
-| `dependsOn` | `string`[] |  |
-| `process` | `ProcessSyncItem`<`T`\> |  |
-| `options` | `SetupOfflineSyncOptions`<`T`\> |  |
+| `type` | `string` | The identifying type of the synchronization items which can be handled by this handler. |
+| `dependsOn` | `string`[] | An array of other sync item types which must be synchronized before this handler   can synchronize its own data. Items of these types are effectively dependencies of the data   synchronized by this handler. |
+| `process` | `ProcessSyncItem`<`T`\> | A function which, when invoked, performs the actual client-server synchronization of the given   `item` (which is the actual data to be synchronized). |
+| `options` | `SetupOfflineSyncOptions`<`T`\> | Additional options which can optionally be provided when setting up a synchronization callback   for a specific synchronization item type. |
 
 #### Returns
 
@@ -2928,12 +3378,14 @@ ___
 
 ▸ **syncAllDynamicOfflineData**(`type`, `abortSignal?`): `Promise`<`void`\>
 
+Synchronizes all offline data entries of the given [type](interfaces/FetchResponse.md#type) for the currently logged in user.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` |  |
-| `abortSignal?` | `AbortSignal` |  |
+| `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
+| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
 
 #### Returns
 
@@ -2949,13 +3401,15 @@ ___
 
 ▸ **syncDynamicOfflineData**(`type`, `identifier`, `abortSignal?`): `Promise`<`void`\>
 
+Synchronizes a single offline data entry of the given [type](interfaces/FetchResponse.md#type) for the currently logged in user.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` |  |
-| `identifier` | `string` |  |
-| `abortSignal?` | `AbortSignal` |  |
+| `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
+| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
+| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
 
 #### Returns
 
@@ -2971,6 +3425,8 @@ ___
 
 ▸ **syncOfflinePatientData**(`patientUuid`): `Promise`<`void`\>
 
+**`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
+
 #### Parameters
 
 | Name | Type |
@@ -3007,6 +3463,35 @@ ___
 
 ▸ **ExtensionSlot**(`__namedParameters`): `Element`
 
+An [extension slot](https://o3-dev.docs.openmrs.org/#/main/extensions).
+A place with a name. Extensions that get connected to that name
+will be rendered into this.
+
+**`example`**
+Passing a react node as children
+
+```tsx
+<ExtensionSlot name="Foo">
+  <div style={{ width: 10rem }}>
+    <Extension />
+  </div>
+</ExtensionSlot>
+```
+
+**`example`**
+Passing a function as children
+
+```tsx
+<ExtensionSlot name="Bar">
+  {(extension) => (
+    <h1>{extension.name}</h1>
+    <div style={{ color: extension.meta.color }}>
+      <Extension />
+    </div>
+  )}
+</ExtensionSlot>
+```
+
 #### Parameters
 
 | Name | Type |
@@ -3029,6 +3514,8 @@ ___
 
 ▸ **createGlobalStore**<`TState`\>(`name`, `initialState`): `Store`<`TState`\>
 
+Creates a Unistore [store](https://github.com/developit/unistore#store).
+
 #### Type parameters
 
 | Name |
@@ -3039,13 +3526,15 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `name` | `string` |  |
-| `initialState` | `TState` |  |
+| `name` | `string` | A name by which the store can be looked up later.    Must be unique across the entire application. |
+| `initialState` | `TState` | An object which will be the initial state of the store. |
 
 #### Returns
 
 `Store`<`TState`\>
 
+The newly created store.
+
 #### Defined in
 
 [packages/framework/esm-state/src/state.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L19)
@@ -3056,6 +3545,8 @@ ___
 
 ▸ **createUseStore**<`T`\>(`store`): () => `T`(`actions`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)(`actions?`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)
 
+Avoid this; generally prefer to have clients use `useStore(yourStore)`
+
 #### Type parameters
 
 | Name |
@@ -3116,6 +3607,8 @@ ___
 
 `Store`<[`AppState`](interfaces/AppState.md)\>
 
+The [store](https://github.com/developit/unistore#store) named `app`.
+
 #### Defined in
 
 [packages/framework/esm-state/src/state.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L86)
@@ -3126,6 +3619,9 @@ ___
 
 ▸ **getGlobalStore**<`TState`\>(`name`, `fallbackState?`): `Store`<`TState`\>
 
+Returns the existing [store](https://github.com/developit/unistore#store) named `name`,
+or creates a new store named `name` if none exists.
+
 #### Type parameters
 
 | Name | Type |
@@ -3136,13 +3632,15 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `name` | `string` |  |
-| `fallbackState?` | `TState` |  |
+| `name` | `string` | The name of the store to look up. |
+| `fallbackState?` | `TState` | The initial value of the new store if no store named `name` exists. |
 
 #### Returns
 
 `Store`<`TState`\>
 
+The found or newly created store.
+
 #### Defined in
 
 [packages/framework/esm-state/src/state.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L56)
@@ -3352,18 +3850,22 @@ ___
 
 ▸ **showModal**(`extensionId`, `props?`, `onClose?`): () => `void`
 
+Shows the provided extension component in a modal dialog.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `extensionId` | `string` |  |
-| `props` | `Record`<`string`, `any`\> |  |
-| `onClose` | () => `void` |  |
+| `extensionId` | `string` | The id of the extension to show. |
+| `props` | `Record`<`string`, `any`\> | The optional props to provide to the extension. |
+| `onClose` | () => `void` | The optional notification to receive when the modal is closed. |
 
 #### Returns
 
 `fn`
 
+The dispose function to force closing the modal dialog.
+
 ▸ (): `void`
 
 ##### Returns
@@ -3380,11 +3882,13 @@ ___
 
 ▸ **showNotification**(`notification`): `void`
 
+Displays an inline notification in the UI.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `notification` | [`NotificationDescriptor`](interfaces/NotificationDescriptor.md) |  |
+| `notification` | [`NotificationDescriptor`](interfaces/NotificationDescriptor.md) | The description of the notification to display. |
 
 #### Returns
 
@@ -3400,11 +3904,13 @@ ___
 
 ▸ **showToast**(`toast`): `void`
 
+Displays a toast notification in the UI.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `toast` | [`ToastDescriptor`](interfaces/ToastDescriptor.md) |  |
+| `toast` | [`ToastDescriptor`](interfaces/ToastDescriptor.md) | The description of the toast to display. |
 
 #### Returns
 
@@ -3594,16 +4100,20 @@ ___
 
 ▸ **age**(`dateString`): `string`
 
+Gets a human readable age represention of the provided date string.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `dateString` | `string` |  |
+| `dateString` | `string` | The stringified date. |
 
 #### Returns
 
 `string`
 
+A human-readable string version of the age.
+
 #### Defined in
 
 [packages/framework/esm-utils/src/age-helpers.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L39)
@@ -3614,16 +4124,20 @@ ___
 
 ▸ **daysIntoYear**(`date`): `number`
 
+Gets the number of days in the year of the given date.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `date` | `Date` |  |
+| `date` | `Date` | The date to compute the days within the year. |
 
 #### Returns
 
 `number`
 
+The number of days.
+
 #### Defined in
 
 [packages/framework/esm-utils/src/age-helpers.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L8)
@@ -3634,17 +4148,21 @@ ___
 
 ▸ **isSameDay**(`firstDate`, `secondDate`): `boolean`
 
+Checks if two dates are representing the same day.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `firstDate` | `Date` |  |
-| `secondDate` | `Date` |  |
+| `firstDate` | `Date` | The first date. |
+| `secondDate` | `Date` | The second date. |
 
 #### Returns
 
 `boolean`
 
+True if both are located on the same day.
+
 #### Defined in
 
 [packages/framework/esm-utils/src/age-helpers.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L25)
@@ -3676,6 +4194,15 @@ ___
 
 ▸ **retry**<`T`\>(`fn`, `options?`): `Promise`<`T`\>
 
+Executes the specified function and retries executing on failure with a custom backoff strategy
+defined by the options.
+
+If not configured otherwise, this function uses the following default options:
+* Retries 5 times beyond the initial attempt.
+* Uses an exponential backoff starting with an initial delay of 1000ms.
+
+**`throws`** Rethrows the final error of running `fn` when the function stops retrying.
+
 #### Type parameters
 
 | Name |
@@ -3686,13 +4213,15 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `fn` | () => `Promise`<`T`\> |  |
-| `options` | [`RetryOptions`](interfaces/RetryOptions.md) |  |
+| `fn` | () => `Promise`<`T`\> | The function to be executed and retried on failure. |
+| `options` | [`RetryOptions`](interfaces/RetryOptions.md) | Additional options which configure the retry behavior. |
 
 #### Returns
 
 `Promise`<`T`\>
 
+The result of successfully executing `fn`.
+
 #### Defined in
 
 [packages/framework/esm-utils/src/retry.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L40)