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

package/docs/functions/interpolateUrl.md

@@ -1,48 +0,0 @@
-[O3 Framework](../API.md) / interpolateUrl
-
-# Function: interpolateUrl()
-
-> **interpolateUrl**(`template`, `additionalParams?`): `string`
-
-Defined in: [packages/framework/esm-navigation/src/navigation/interpolate-string.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-navigation/src/navigation/interpolate-string.ts#L36)
-
-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
-
-### template
-
-`string`
-
-A string to interpolate
-
-### additionalParams?
-
-Additional values to interpolate into the string template
-
-## Returns
-
-`string`

package/docs/functions/isDesktop.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / isDesktop
-
-# Function: isDesktop()
-
-> **isDesktop**(`layout`): layout is "small-desktop" \| "large-desktop"
-
-Defined in: [packages/framework/esm-react-utils/src/useLayoutType.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useLayoutType.ts#L40)
-
-## Parameters
-
-### layout
-
-[`LayoutType`](../type-aliases/LayoutType.md)
-
-## Returns
-
-layout is "small-desktop" \| "large-desktop"

package/docs/functions/isDevEnabled.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / isDevEnabled
-
-# Function: isDevEnabled()
-
-> **isDevEnabled**(): `boolean`
-
-Defined in: [packages/framework/esm-api/src/environment.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/environment.ts#L3)
-
-## Returns
-
-`boolean`

package/docs/functions/isOfflineUuid.md

@@ -1,19 +0,0 @@
-[O3 Framework](../API.md) / isOfflineUuid
-
-# Function: isOfflineUuid()
-
-> **isOfflineUuid**(`uuid`): `boolean`
-
-Defined in: [packages/framework/esm-offline/src/uuid-support.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/uuid-support.ts#L12)
-
-Checks whether the given string has the format of an offline UUID generated by [generateOfflineUuid](generateOfflineUuid.md)
-
-## Parameters
-
-### uuid
-
-`string`
-
-## Returns
-
-`boolean`

package/docs/functions/isOmrsDateStrict.md

@@ -1,20 +0,0 @@
-[O3 Framework](../API.md) / isOmrsDateStrict
-
-# Function: isOmrsDateStrict()
-
-> **isOmrsDateStrict**(`omrsPayloadString`): `boolean`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:11
-
-This function checks whether a date string is the OpenMRS ISO format.
-The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
-
-## Parameters
-
-### omrsPayloadString
-
-`string`
-
-## Returns
-
-`boolean`

package/docs/functions/isOmrsDateToday.md

@@ -1,19 +0,0 @@
-[O3 Framework](../API.md) / isOmrsDateToday
-
-# Function: isOmrsDateToday()
-
-> **isOmrsDateToday**(`date`): `boolean`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:16
-
-## Parameters
-
-### date
-
-[`DateInput`](../type-aliases/DateInput.md)
-
-Checks if the provided date is today.
-
-## Returns
-
-`boolean`

package/docs/functions/isOnline.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / isOnline
-
-# Function: isOnline()
-
-> **isOnline**(`online?`): `boolean`
-
-Defined in: packages/framework/esm-utils/dist/is-online.d.ts:1
-
-## Parameters
-
-### online?
-
-`boolean`
-
-## Returns
-
-`boolean`

package/docs/functions/isUrlWithTemplateParameters.md

@@ -1,22 +0,0 @@
-[O3 Framework](../API.md) / isUrlWithTemplateParameters
-
-# Function: isUrlWithTemplateParameters()
-
-> **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](../type-aliases/Validator.md)
-
-Defined in: [packages/framework/esm-config/src/validators/validators.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/validators/validators.ts#L21)
-
-Verifies that a string contains only the default URL template
-parameters, plus any specified in `allowedTemplateParameters`.
-
-## Parameters
-
-### allowedTemplateParameters
-
-To be added to `openmrsBase` and `openmrsSpaBase`
-
-`string`[] | readonly `string`[]
-
-## Returns
-
-[`Validator`](../type-aliases/Validator.md)

package/docs/functions/isVersionSatisfied.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / isVersionSatisfied
-
-# Function: isVersionSatisfied()
-
-> **isVersionSatisfied**(`requiredVersion`, `installedVersion`): `boolean`
-
-Defined in: packages/framework/esm-utils/dist/version.d.ts:1
-
-## Parameters
-
-### requiredVersion
-
-`string`
-
-### installedVersion
-
-`string`
-
-## Returns
-
-`boolean`

package/docs/functions/launchWorkspace.md

@@ -1,56 +0,0 @@
-[O3 Framework](../API.md) / launchWorkspace
-
-# Function: launchWorkspace()
-
-> **launchWorkspace**\<`T`\>(`name`, `additionalProps?`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L296)
-
-This launches a workspace by its name. The workspace must have been registered.
-Workspaces should be registered in the `routes.json` file.
-
-For the workspace to appear, there must be either a `<WorkspaceOverlay />` or
-a `<WorkspaceWindow />` component rendered.
-
-The behavior of this function is as follows:
-
-- If no workspaces are open, or if no other workspaces with the same type are open,
-  it will be opened and focused.
-- If a workspace with the same name is already open, it will be displayed/focused,
-  if it was not already.
-- If a workspace is launched and a workspace which cannot be hidden is already open,
- a confirmation modal will pop up warning about closing the currently open workspace.
-- If another workspace with the same type is open, the workspace will be brought to
-  the front and then a confirmation modal will pop up warning about closing the opened
-  workspace
-
-Note that this function just manipulates the workspace store. The UI logic is handled
-by the components that display workspaces.
-
-Additional props can be passed to the workspace component being launched. Passing a
-prop named `workspaceTitle` will override the title of the workspace.
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object` \| [`DefaultWorkspaceProps`](../interfaces/DefaultWorkspaceProps.md) = [`DefaultWorkspaceProps`](../interfaces/DefaultWorkspaceProps.md) & `object`
-
-## Parameters
-
-### name
-
-`string`
-
-The name of the workspace to launch
-
-### additionalProps?
-
-`Omit`\<`T`, keyof [`DefaultWorkspaceProps`](../interfaces/DefaultWorkspaceProps.md)\> & `object`
-
-Props to pass to the workspace component being launched. Passing
-         a prop named `workspaceTitle` will override the title of the workspace.
-
-## Returns
-
-`void`

package/docs/functions/launchWorkspaceGroup.md

@@ -1,38 +0,0 @@
-[O3 Framework](../API.md) / launchWorkspaceGroup
-
-# Function: launchWorkspaceGroup()
-
-> **launchWorkspaceGroup**(`groupName`, `args`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:210](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L210)
-
-Launches a workspace group with the specified name and configuration.
-If there are any open workspaces, it will first close them before launching the new workspace group.
-
-## Parameters
-
-### groupName
-
-`string`
-
-The name of the workspace group to launch
-
-### args
-
-`LaunchWorkspaceGroupArg`
-
-Configuration object for launching the workspace group
-
-## Returns
-
-`void`
-
-## Example
-
-```ts
-launchWorkspaceGroup("myGroup", {
-  state: initialState,
-  onWorkspaceGroupLaunch: () => console.log("Workspace group launched"),
-  workspaceGroupCleanup: () => console.log("Cleaning up workspace group")
-});
-```

package/docs/functions/makeUrl.md

@@ -1,26 +0,0 @@
-[O3 Framework](../API.md) / makeUrl
-
-# Function: makeUrl()
-
-> **makeUrl**(`path`): `string`
-
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L22)
-
-Append `path` to the OpenMRS SPA base.
-
-#### Example
-
-```ts
-makeUrl('/foo/bar');
-// => '/openmrs/foo/bar'
-```
-
-## Parameters
-
-### path
-
-`string`
-
-## Returns
-
-`string`

package/docs/functions/messageOmrsServiceWorker.md

@@ -1,23 +0,0 @@
-[O3 Framework](../API.md) / messageOmrsServiceWorker
-
-# Function: messageOmrsServiceWorker()
-
-> **messageOmrsServiceWorker**(`message`): `Promise`\<[`MessageServiceWorkerResult`](../interfaces/MessageServiceWorkerResult.md)\<`any`\>\>
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/service-worker-messaging.ts#L11)
-
-Sends the specified message to the application's service worker.
-
-## Parameters
-
-### message
-
-[`KnownOmrsServiceWorkerMessages`](../type-aliases/KnownOmrsServiceWorkerMessages.md)
-
-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.

package/docs/functions/navigate.md

@@ -1,48 +0,0 @@
-[O3 Framework](../API.md) / navigate
-
-# Function: navigate()
-
-> **navigate**(`to`): `void`
-
-Defined in: [packages/framework/esm-navigation/src/navigation/navigate.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-navigation/src/navigation/navigate.ts#L49)
-
-Calls `location.assign` for non-SPA paths and [navigateToUrl](https://single-spa.js.org/docs/api/#navigatetourl) for SPA paths
-
-#### Example usage:
-```js
-@example
-const config = useConfig();
-const submitHandler = () => {
-  navigate({ to: config.links.submitSuccess });
-};
-```
-
-#### Example behavior::
-```js
-@example
-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")
-navigate({ to: "https://o3.openmrs.org/${openmrsSpaBase}/qux/page" }); // => navigateToUrl("/openmrs/spa/qux/page")
-  if `window.location.origin` == "https://o3.openmrs.org", else will use window.location.assign
-```
-
-## Parameters
-
-### 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
-
-`void`

package/docs/functions/navigateAndLaunchWorkspace.md

@@ -1,33 +0,0 @@
-[O3 Framework](../API.md) / navigateAndLaunchWorkspace
-
-# Function: navigateAndLaunchWorkspace()
-
-> **navigateAndLaunchWorkspace**(`__namedParameters`): `void`
-
-Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L389)
-
-Use this function to navigate to a new page and launch a workspace on that page.
-
-## Parameters
-
-### \_\_namedParameters
-
-#### additionalProps?
-
-`object`
-
-#### contextKey
-
-`string`
-
-#### targetUrl
-
-`string`
-
-#### workspaceName
-
-`string`
-
-## Returns
-
-`void`

package/docs/functions/oneOf.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / oneOf
-
-# Function: oneOf()
-
-> **oneOf**(`allowedValues`): [`Validator`](../type-aliases/Validator.md)
-
-Defined in: [packages/framework/esm-config/src/validators/validators.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/validators/validators.ts#L58)
-
-Verifies that the value is one of the allowed options.
-
-## Parameters
-
-### allowedValues
-
-The list of allowable values
-
-`any`[] | readonly `any`[]
-
-## Returns
-
-[`Validator`](../type-aliases/Validator.md)

package/docs/functions/openmrsFetch.md

@@ -1,75 +0,0 @@
-[O3 Framework](../API.md) / openmrsFetch
-
-# Function: openmrsFetch()
-
-> **openmrsFetch**\<`T`\>(`path`, `fetchInit`): `Promise`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`T`\>\>
-
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L82)
-
-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
-
-### T
-
-`T` = `any`
-
-## Parameters
-
-### 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`](../interfaces/FetchConfig.md) = `{}`
-
-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(`${restBaseUrl}/session', {signal: abortController.signal})
-  .then(response => {
-    console.log(response.data.authenticated)
-  })
-  .catch(err => {
-    console.error(err.status);
-  })
-abortController.abort();
-openmrsFetch(`${restBaseUrl}/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.

package/docs/functions/openmrsObservableFetch.md

@@ -1,55 +0,0 @@
-[O3 Framework](../API.md) / openmrsObservableFetch
-
-# Function: openmrsObservableFetch()
-
-> **openmrsObservableFetch**\<`T`\>(`url`, `fetchInit`): `Observable`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`T`\>\>
-
-Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:269](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L269)
-
-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
-
-### T
-
-`T`
-
-## Parameters
-
-### url
-
-`string`
-
-See [[openmrsFetch]]
-
-### fetchInit
-
-[`FetchConfig`](../interfaces/FetchConfig.md) = `{}`
-
-See [[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]].
-
-#### Example
-
-```js
-import { openmrsObservableFetch } from '@openmrs/esm-api'
-const subscription = openmrsObservableFetch(`${restBaseUrl}/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();`

package/docs/functions/parseDate.md

@@ -1,20 +0,0 @@
-[O3 Framework](../API.md) / parseDate
-
-# Function: parseDate()
-
-> **parseDate**(`dateString`): `Date`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:30
-
-Utility function to parse an arbitrary string into a date.
-Uses `dayjs(dateString)`.
-
-## Parameters
-
-### dateString
-
-`string`
-
-## Returns
-
-`Date`

package/docs/functions/provide.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / provide
-
-# Function: provide()
-
-> **provide**(`config`, `sourceName`): `void`
-
-Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/module-config/module-config.ts#L261)
-
-## Parameters
-
-### config
-
-[`Config`](../interfaces/Config.md)
-
-### sourceName
-
-`string` = `'provided'`
-
-## Returns
-
-`void`

package/docs/functions/putDynamicOfflineData.md

@@ -1,28 +0,0 @@
-[O3 Framework](../API.md) / putDynamicOfflineData
-
-# Function: putDynamicOfflineData()
-
-> **putDynamicOfflineData**(`type`, `identifier`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L157)
-
-Declares that dynamic offline data of the given [type](#putdynamicofflinedata) with the given [identifier](#putdynamicofflinedata)
-should be made available offline for the currently logged in user.
-
-## Parameters
-
-### 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
-
-`Promise`\<`void`\>