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

package/docs/interfaces/ExtensionDefinition.md

@@ -34,6 +34,8 @@
 
 • **appName**: `string`
 
+The module/app that defines the component
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.md#appname)
@@ -48,6 +50,8 @@ ___
 
 • `Optional` **id**: `string`
 
+**`deprecated`** A confusing way to specify the name of the extension
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:135](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L135)
@@ -58,6 +62,8 @@ ___
 
 • `Optional` **meta**: `Record`<`string`, `any`\>
 
+The meta data used for reflection by other components
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L131)
@@ -68,6 +74,8 @@ ___
 
 • **name**: `string`
 
+The name of the extension being registered
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L125)
@@ -78,6 +86,8 @@ ___
 
 • `Optional` **offline**: `boolean` \| `object`
 
+Defines the offline support / properties of the component.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.md#offline)
@@ -92,6 +102,8 @@ ___
 
 • `Optional` **online**: `boolean` \| `object`
 
+Defines the online support / properties of the component.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.md#online)
@@ -106,6 +118,8 @@ ___
 
 • `Optional` **order**: `number`
 
+Specifies the relative order in which the extension renders in a slot
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L133)
@@ -116,6 +130,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.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[privilege](ComponentDefinition.md#privilege)
@@ -130,6 +147,8 @@ ___
 
 • `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
 
+Defines resources that are loaded when the component should mount.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.md#resources)
@@ -144,6 +163,8 @@ ___
 
 • `Optional` **slot**: `string`
 
+A slot to attach to
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L127)
@@ -154,6 +175,8 @@ ___
 
 • `Optional` **slots**: `string`[]
 
+Slots to attach to
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L129)
@@ -164,6 +187,8 @@ ___
 
 ▸ **load**(): `Promise`<`any`\>
 
+Defines a function to use for actually loading the component's lifecycle.
+
 #### Returns
 
 `Promise`<`any`\>

package/docs/interfaces/ExtensionSlotBaseProps.md

@@ -20,6 +20,8 @@
 
 • `Optional` **extensionSlotName**: `string`
 
+**`deprecated`** Use `name`
+
 #### Defined in
 
 [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L10)

package/docs/interfaces/ExtensionSlotConfigObject.md

@@ -16,6 +16,8 @@
 
 • `Optional` **add**: `string`[]
 
+Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
+
 #### Defined in
 
 [packages/framework/esm-config/src/types.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L58)
@@ -26,6 +28,8 @@ ___
 
 • `Optional` **order**: `string`[]
 
+Overrides the default ordering of extensions.
+
 #### Defined in
 
 [packages/framework/esm-config/src/types.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L62)
@@ -36,6 +40,8 @@ ___
 
 • `Optional` **remove**: `string`[]
 
+Extension IDs which were `attach`ed to the slot but which should not be assigned.
+
 #### Defined in
 
 [packages/framework/esm-config/src/types.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L60)

package/docs/interfaces/FHIRRequestObj.md

@@ -2,6 +2,8 @@
 
 # Interface: FHIRRequestObj
 
+**`deprecated`**
+
 ## Table of contents
 
 ### API Properties

package/docs/interfaces/FHIRRequestOptions.md

@@ -2,6 +2,8 @@
 
 # Interface: FHIRRequestOptions
 
+**`deprecated`**
+
 ## Table of contents
 
 ### API Properties

package/docs/interfaces/OfflinePatientArgs.md

@@ -2,6 +2,8 @@
 
 # Interface: OfflinePatientArgs
 
+**`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
+
 ## Table of contents
 
 ### Offline Properties

package/docs/interfaces/OfflinePatientDataSyncHandler.md

@@ -2,6 +2,8 @@
 
 # Interface: OfflinePatientDataSyncHandler
 
+**`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
+
 ## Table of contents
 
 ### Offline Properties

package/docs/interfaces/OfflinePatientDataSyncState.md

@@ -2,6 +2,8 @@
 
 # Interface: OfflinePatientDataSyncState
 
+**`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
+
 ## Table of contents
 
 ### Offline Properties

package/docs/interfaces/OfflinePatientDataSyncStore.md

@@ -2,6 +2,8 @@
 
 # Interface: OfflinePatientDataSyncStore
 
+**`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
+
 ## Table of contents
 
 ### Offline Properties

package/docs/interfaces/OldExtensionSlotBaseProps.md

@@ -20,6 +20,8 @@
 
 • **extensionSlotName**: `string`
 
+**`deprecated`** Use `name`
+
 #### Defined in
 
 [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L18)

package/docs/interfaces/PageDefinition.md

@@ -30,6 +30,8 @@
 
 • **appName**: `string`
 
+The module/app that defines the component
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.md#appname)
@@ -44,6 +46,8 @@ ___
 
 • `Optional` **offline**: `boolean` \| `object`
 
+Defines the offline support / properties of the component.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.md#offline)
@@ -58,6 +62,8 @@ ___
 
 • `Optional` **online**: `boolean` \| `object`
 
+Defines the online support / properties of the component.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.md#online)
@@ -72,6 +78,8 @@ ___
 
 • **order**: `number`
 
+The order in which to load the page. This determines DOM order.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:146](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L146)
@@ -82,6 +90,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.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[privilege](ComponentDefinition.md#privilege)
@@ -96,6 +107,8 @@ ___
 
 • `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
 
+Defines resources that are loaded when the component should mount.
+
 #### Inherited from
 
 [ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.md#resources)
@@ -110,6 +123,8 @@ ___
 
 • **route**: `string`
 
+The route of the page.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L142)
@@ -120,6 +135,8 @@ ___
 
 ▸ **load**(): `Promise`<`any`\>
 
+Defines a function to use for actually loading the component's lifecycle.
+
 #### Returns
 
 `Promise`<`any`\>

package/docs/interfaces/QueueItemDescriptor.md

@@ -2,6 +2,11 @@
 
 # Interface: QueueItemDescriptor
 
+Contains information about the sync item which has been provided externally by the caller
+who added the item to the queue.
+This information is all optional, but, when provided while enqueuing the item, can be used in other
+locations to better represent the sync item, e.g. in the UI.
+
 ## Table of contents
 
 ### Offline Properties

package/docs/interfaces/RetryOptions.md

@@ -2,6 +2,8 @@
 
 # Interface: RetryOptions
 
+Options for configuring the behavior of the [retry](../API.md#retry) function.
+
 ## Table of contents
 
 ### Methods
@@ -16,11 +18,14 @@
 
 ▸ `Optional` **getDelay**(`attempt`): `number`
 
+Calculates the next delay (in milliseconds) before a retry attempt.
+Returning a value for the inital attempt (`0`) delays the initial function invocation.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `attempt` | `number` |  |
+| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
 
 #### Returns
 
@@ -36,12 +41,15 @@ ___
 
 ▸ `Optional` **onError**(`e`, `attempt`): `void`
 
+Called when invoking the function resulted in an error.
+Allows running side-effects on errors, e.g. logging.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `e` | `any` |  |
-| `attempt` | `number` |  |
+| `e` | `any` | The error thrown by the function. |
+| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
 
 #### Returns
 
@@ -57,11 +65,14 @@ ___
 
 ▸ `Optional` **shouldRetry**(`attempt`): `any`
 
+Determines whether the retry function should retry executing the function after it failed
+with an error on the current attempt.
+
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `attempt` | `number` |  |
+| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
 
 #### Returns
 

package/docs/interfaces/SpaConfig.md

@@ -18,6 +18,8 @@
 
 • **apiUrl**: `string`
 
+The base path or URL for the OpenMRS API / endpoints.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L70)
@@ -28,6 +30,8 @@ ___
 
 • `Optional` **configUrls**: `string`[]
 
+URLs of configurations to load in the system.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L83)
@@ -38,6 +42,10 @@ ___
 
 • `Optional` **env**: [`SpaEnvironment`](../API.md#spaenvironment)
 
+The environment to use.
+
+**`default`** production
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L79)
@@ -48,6 +56,10 @@ ___
 
 • `Optional` **offline**: `boolean`
 
+Defines if offline should be supported by installing a service worker.
+
+**`default`** true
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L88)
@@ -58,6 +70,8 @@ ___
 
 • **spaPath**: `string`
 
+The base path for the SPA root path.
+
 #### Defined in
 
 [packages/framework/esm-globals/src/types.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L74)

package/docs/interfaces/SyncItem.md

@@ -2,6 +2,10 @@
 
 # Interface: SyncItem<T\>
 
+Defines an item queued up in the offline synchronization queue.
+A `SyncItem` contains both meta information about the item in the sync queue, as well as the
+actual data to be synchronized (i.e. the item's `content`).
+
 ## Type parameters
 
 | Name | Type |

package/docs/interfaces/SyncProcessOptions.md

@@ -2,6 +2,8 @@
 
 # Interface: SyncProcessOptions<T\>
 
+Additional data which can be used for synchronizing data in a {@link ProcessSyncItem} function.
+
 ## Type parameters
 
 | Name |

package/mock.tsx

@@ -53,10 +53,13 @@ export function getCurrentUser() {
   return of({ authenticated: false });
 }
 
-export const mockSessionStore = createGlobalStore<SessionStore>("mock-session-store", {
-  loaded: false,
-  session: null,
-});
+export const mockSessionStore = createGlobalStore<SessionStore>(
+  "mock-session-store",
+  {
+    loaded: false,
+    session: null,
+  }
+);
 
 export const getSessionStore = jest.fn(() => mockSessionStore);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "4.0.1-pre.224",
+  "version": "4.0.1-pre.232",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -35,18 +35,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^4.0.1-pre.224",
-    "@openmrs/esm-breadcrumbs": "^4.0.1-pre.224",
-    "@openmrs/esm-config": "^4.0.1-pre.224",
-    "@openmrs/esm-error-handling": "^4.0.1-pre.224",
-    "@openmrs/esm-extensions": "^4.0.1-pre.224",
-    "@openmrs/esm-globals": "^4.0.1-pre.224",
-    "@openmrs/esm-offline": "^4.0.1-pre.224",
-    "@openmrs/esm-react-utils": "^4.0.1-pre.224",
-    "@openmrs/esm-state": "^4.0.1-pre.224",
-    "@openmrs/esm-styleguide": "^4.0.1-pre.224",
-    "@openmrs/esm-utils": "^4.0.1-pre.224",
+    "@openmrs/esm-api": "^4.0.1-pre.232",
+    "@openmrs/esm-breadcrumbs": "^4.0.1-pre.232",
+    "@openmrs/esm-config": "^4.0.1-pre.232",
+    "@openmrs/esm-error-handling": "^4.0.1-pre.232",
+    "@openmrs/esm-extensions": "^4.0.1-pre.232",
+    "@openmrs/esm-globals": "^4.0.1-pre.232",
+    "@openmrs/esm-offline": "^4.0.1-pre.232",
+    "@openmrs/esm-react-utils": "^4.0.1-pre.232",
+    "@openmrs/esm-state": "^4.0.1-pre.232",
+    "@openmrs/esm-styleguide": "^4.0.1-pre.232",
+    "@openmrs/esm-utils": "^4.0.1-pre.232",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "7550cc37d76a576c84b553a1eac0400afe06eac9"
+  "gitHead": "e88075df046134996990f4bb06fb3e26f37a9d04"
 }