@openmrs/esm-framework 4.0.1-pre.224 → 4.0.1-pre.232

package/docs/classes/OpenmrsFetchError.md

@@ -153,6 +153,8 @@ node_modules/@types/node/globals.d.ts:142
 
 ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
 
+Create .stack property on a target object
+
 #### Parameters
 
 | Name | Type |
@@ -178,6 +180,10 @@ ___
 
 ▸ `Static` `Optional` **prepareStackTrace**(`err`, `stackTraces`): `any`
 
+Optional override for formatting stack traces
+
+**`see`** https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces
+
 #### Parameters
 
 | Name | Type |

package/docs/enums/Type.md

@@ -20,7 +20,7 @@
 
 ### Array
 
-• **Array** = ``"Array"``
+• **Array**
 
 #### Defined in
 
@@ -30,7 +30,7 @@ ___
 
 ### Boolean
 
-• **Boolean** = ``"Boolean"``
+• **Boolean**
 
 #### Defined in
 
@@ -40,7 +40,7 @@ ___
 
 ### ConceptUuid
 
-• **ConceptUuid** = ``"ConceptUuid"``
+• **ConceptUuid**
 
 #### Defined in
 
@@ -50,7 +50,7 @@ ___
 
 ### Number
 
-• **Number** = ``"Number"``
+• **Number**
 
 #### Defined in
 
@@ -60,7 +60,7 @@ ___
 
 ### Object
 
-• **Object** = ``"Object"``
+• **Object**
 
 #### Defined in
 
@@ -70,7 +70,7 @@ ___
 
 ### PatientIdentifierTypeUuid
 
-• **PatientIdentifierTypeUuid** = ``"PatientIdentifierTypeUuid"``
+• **PatientIdentifierTypeUuid**
 
 #### Defined in
 
@@ -80,7 +80,7 @@ ___
 
 ### PersonAttributeTypeUuid
 
-• **PersonAttributeTypeUuid** = ``"PersonAttributeTypeUuid"``
+• **PersonAttributeTypeUuid**
 
 #### Defined in
 
@@ -90,7 +90,7 @@ ___
 
 ### String
 
-• **String** = ``"String"``
+• **String**
 
 #### Defined in
 
@@ -100,7 +100,7 @@ ___
 
 ### UUID
 
-• **UUID** = ``"UUID"``
+• **UUID**
 
 #### Defined in
 

package/docs/enums/VisitMode.md

@@ -14,7 +14,7 @@
 
 ### EDITVISIT
 
-• **EDITVISIT** = ``"editVisit"``
+• **EDITVISIT**
 
 #### Defined in
 
@@ -24,7 +24,7 @@ ___
 
 ### LOADING
 
-• **LOADING** = ``"loadingVisit"``
+• **LOADING**
 
 #### Defined in
 
@@ -34,7 +34,7 @@ ___
 
 ### NEWVISIT
 
-• **NEWVISIT** = ``"startVisit"``
+• **NEWVISIT**
 
 #### Defined in
 

package/docs/enums/VisitStatus.md

@@ -13,7 +13,7 @@
 
 ### NOTSTARTED
 
-• **NOTSTARTED** = ``"notStarted"``
+• **NOTSTARTED**
 
 #### Defined in
 
@@ -23,7 +23,7 @@ ___
 
 ### ONGOING
 
-• **ONGOING** = ``"ongoing"``
+• **ONGOING**
 
 #### Defined in
 

package/docs/interfaces/AssignedExtension.md

@@ -20,6 +20,8 @@
 
 • **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
 
+The extension's config. Note that this will be `null` until the slot is mounted.
+
 #### Defined in
 
 [packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L80)

package/docs/interfaces/BreadcrumbSettings.md

@@ -17,6 +17,13 @@
 
 • `Optional` **matcher**: `string` \| `RegExp`
 
+A string or RegEx that determines whether the breadcrumb should be displayed.
+It is tested against the current location's path.
+
+If `matcher` is a string, it can contain route parameters. e.g. `/foo/:bar`.
+
+Can be omitted; the value of `path` is used as the default value.
+
 #### Defined in
 
 [packages/framework/esm-breadcrumbs/src/types.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L16)
@@ -27,6 +34,13 @@ ___
 
 • `Optional` **parent**: `string`
 
+The breadcrumb's parent breadcrumb. Supply the path of the breadcrumb here, e.g.,
+if we are currently in "/foo/bar", you could provide "/foo" to get the breadcrumb
+associated with the path "/foo".
+
+If a path is missing for some reason, the closest matching one will be taken as
+parent.
+
 #### Defined in
 
 [packages/framework/esm-breadcrumbs/src/types.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L25)
@@ -37,6 +51,8 @@ ___
 
 • **path**: `string`
 
+Gets the path of breadcrumb for navigation purposes.
+
 #### Defined in
 
 [packages/framework/esm-breadcrumbs/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L7)
@@ -47,6 +63,8 @@ ___
 
 • **title**: `string` \| (`params`: `any`) => `string` \| (`params`: `any`) => `Promise`<`string`\>
 
+The title of the breadcrumb.
+
 #### Defined in
 
 [packages/framework/esm-breadcrumbs/src/types.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/types.ts#L29)

package/docs/interfaces/ComponentDefinition.md

@@ -30,6 +30,8 @@
 
 • **appName**: `string`
 
+The module/app that defines the component
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L99)
@@ -40,6 +42,8 @@ ___
 
 • `Optional` **offline**: `boolean` \| `object`
 
+Defines the offline support / properties of the component.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L111)
@@ -50,6 +54,8 @@ ___
 
 • `Optional` **online**: `boolean` \| `object`
 
+Defines the online support / properties of the component.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L107)
@@ -60,6 +66,9 @@ ___
 
 • `Optional` **privilege**: `string` \| `string`[]
 
+Defines the access privilege(s) required for this component, if any.
+If more than one privilege is provided, the user must have all specified permissions.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L116)
@@ -70,6 +79,8 @@ ___
 
 • `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
 
+Defines resources that are loaded when the component should mount.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L120)
@@ -80,6 +91,8 @@ ___
 
 ▸ **load**(): `Promise`<`any`\>
 
+Defines a function to use for actually loading the component's lifecycle.
+
 #### Returns
 
 `Promise`<`any`\>

package/docs/interfaces/Config.md

@@ -33,6 +33,8 @@
 
 • **constructor**: `Function`
 
+The initial value of Object.prototype.constructor is the standard built-in Object constructor.
+
 #### Inherited from
 
 Object.constructor
@@ -47,11 +49,13 @@ node_modules/typescript/lib/lib.es5.d.ts:124
 
 ▸ **hasOwnProperty**(`v`): `boolean`
 
+Determines whether an object has a property with the specified name.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `v` | `PropertyKey` |  |
+| `v` | `PropertyKey` | A property name. |
 
 #### Returns
 
@@ -71,11 +75,13 @@ ___
 
 ▸ **isPrototypeOf**(`v`): `boolean`
 
+Determines whether an object exists in another object's prototype chain.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `v` | `Object` |  |
+| `v` | `Object` | Another object whose prototype chain is to be checked. |
 
 #### Returns
 
@@ -95,11 +101,13 @@ ___
 
 ▸ **propertyIsEnumerable**(`v`): `boolean`
 
+Determines whether a specified property is enumerable.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `v` | `PropertyKey` |  |
+| `v` | `PropertyKey` | A property name. |
 
 #### Returns
 
@@ -119,6 +127,8 @@ ___
 
 ▸ **toLocaleString**(): `string`
 
+Returns a date converted to a string using the current locale.
+
 #### Returns
 
 `string`
@@ -137,6 +147,8 @@ ___
 
 ▸ **toString**(): `string`
 
+Returns a string representation of an object.
+
 #### Returns
 
 `string`
@@ -155,6 +167,8 @@ ___
 
 ▸ **valueOf**(): `Object`
 
+Returns the primitive value of the specified object.
+
 #### Returns
 
 `Object`

package/docs/interfaces/ConfigObject.md

@@ -44,6 +44,8 @@ ___
 
 • **constructor**: `Function`
 
+The initial value of Object.prototype.constructor is the standard built-in Object constructor.
+
 #### Inherited from
 
 Object.constructor
@@ -58,11 +60,13 @@ node_modules/typescript/lib/lib.es5.d.ts:124
 
 ▸ **hasOwnProperty**(`v`): `boolean`
 
+Determines whether an object has a property with the specified name.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `v` | `PropertyKey` |  |
+| `v` | `PropertyKey` | A property name. |
 
 #### Returns
 
@@ -82,11 +86,13 @@ ___
 
 ▸ **isPrototypeOf**(`v`): `boolean`
 
+Determines whether an object exists in another object's prototype chain.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `v` | `Object` |  |
+| `v` | `Object` | Another object whose prototype chain is to be checked. |
 
 #### Returns
 
@@ -106,11 +112,13 @@ ___
 
 ▸ **propertyIsEnumerable**(`v`): `boolean`
 
+Determines whether a specified property is enumerable.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `v` | `PropertyKey` |  |
+| `v` | `PropertyKey` | A property name. |
 
 #### Returns
 
@@ -130,6 +138,8 @@ ___
 
 ▸ **toLocaleString**(): `string`
 
+Returns a date converted to a string using the current locale.
+
 #### Returns
 
 `string`
@@ -148,6 +158,8 @@ ___
 
 ▸ **toString**(): `string`
 
+Returns a string representation of an object.
+
 #### Returns
 
 `string`
@@ -166,6 +178,8 @@ ___
 
 ▸ **valueOf**(): `Object`
 
+Returns the primitive value of the specified object.
+
 #### Returns
 
 `Object`

package/docs/interfaces/ConnectedExtension.md

@@ -17,6 +17,8 @@
 
 • **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
 
+The extension's config. Note that this will be `null` until the slot is mounted.
+
 #### Defined in
 
 [packages/framework/esm-extensions/src/store.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L90)

package/docs/interfaces/DynamicOfflineData.md

@@ -2,6 +2,8 @@
 
 # Interface: DynamicOfflineData
 
+Represents the registration of a single dynamic offline data entry.
+
 ## Table of contents
 
 ### Offline Properties
@@ -18,6 +20,8 @@
 
 • `Optional` **id**: `number`
 
+The internal ID of the data entry, as assigned by the IndexedDB where it is stored.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L48)
@@ -28,6 +32,9 @@ ___
 
 • **identifier**: `string`
 
+The externally provided identifier of the data entry.
+This is typically the ID of the resource as assigned by a remote API.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L58)
@@ -38,6 +45,9 @@ ___
 
 • `Optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md)
 
+If this entry has already been synced, returns the result of that last sync attempt.
+Otherwise this is `undefined`.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L67)
@@ -48,6 +58,9 @@ ___
 
 • **type**: `string`
 
+The underlying type used for categorizing the data entry.
+Examples could be `"patient"` or `"form"`.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L53)
@@ -58,6 +71,8 @@ ___
 
 • **users**: `string`[]
 
+The UUIDs of the users who need this data entry available offline.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L62)

package/docs/interfaces/DynamicOfflineDataHandler.md

@@ -2,6 +2,9 @@
 
 # Interface: DynamicOfflineDataHandler
 
+A handler for synchronizing dynamically declared offline data.
+Can be setup using the [setupDynamicOfflineDataHandler](../API.md#setupdynamicofflinedatahandler) function.
+
 ## Table of contents
 
 ### Offline Properties
@@ -21,6 +24,9 @@
 
 • `Optional` **displayName**: `string`
 
+A human-readable string representing the handler.
+If provided, the handler can be rendered in the UI using that string.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L24)
@@ -31,6 +37,8 @@ ___
 
 • **id**: `string`
 
+A string uniquely identifying the handler.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L14)
@@ -41,6 +49,9 @@ ___
 
 • **type**: `string`
 
+The type of offline data handled by this handler.
+See [DynamicOfflineData.type](DynamicOfflineData.md#type) for details.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L19)
@@ -51,12 +62,16 @@ ___
 
 ▸ **isSynced**(`identifier`, `abortSignal?`): `Promise`<`boolean`\>
 
+Evaluates whether the given offline data is correctly synced at this point in time from the perspective
+of this single handler.
+If `false`, the handler would have to (re-)sync the data in order for offline mode to properly work.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `identifier` | `string` |  |
-| `abortSignal?` | `AbortSignal` |  |
+| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details. |
+| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
 
 #### Returns
 
@@ -72,12 +87,14 @@ ___
 
 ▸ **sync**(`identifier`, `abortSignal?`): `Promise`<`void`\>
 
+Synchronizes the given offline data.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `identifier` | `string` |  |
-| `abortSignal?` | `AbortSignal` |  |
+| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details. |
+| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
 
 #### Returns
 

package/docs/interfaces/DynamicOfflineDataSyncState.md

@@ -2,6 +2,8 @@
 
 # Interface: DynamicOfflineDataSyncState
 
+Represents the result of syncing a given [DynamicOfflineData](DynamicOfflineData.md) entry.
+
 ## Table of contents
 
 ### Offline Properties
@@ -18,6 +20,8 @@
 
 • **erroredHandlers**: `string`[]
 
+The IDs of the handlers which failed to synchronize their data.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L89)
@@ -28,6 +32,8 @@ ___
 
 • **errors**: { `handlerId`: `string` ; `message`: `string`  }[]
 
+A collection of the errors caught while synchronizing, per handler.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L93)
@@ -38,6 +44,8 @@ ___
 
 • **succeededHandlers**: `string`[]
 
+The IDs of the handlers which successfully synchronized their data.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L85)
@@ -48,6 +56,8 @@ ___
 
 • **syncedBy**: `string`
 
+The ID of the user who has triggered the data synchronization.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L81)
@@ -58,6 +68,8 @@ ___
 
 • **syncedOn**: `Date`
 
+The time when the entry has been synced the last time.
+
 #### Defined in
 
 [packages/framework/esm-offline/src/dynamic-offline-data.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L77)