@openmrs/esm-framework 3.4.1-pre.156 → 3.4.1-pre.163

package/docs/API.md

@@ -140,6 +140,10 @@
 - [syncOfflinePatientData](API.md#syncofflinepatientdata)
 - [useConnectivity](API.md#useconnectivity)
 
+### Other Functions
+
+- [ExtensionSlot](API.md#extensionslot)
+
 ### Store Functions
 
 - [createGlobalStore](API.md#createglobalstore)
@@ -388,11 +392,11 @@ ___
 
 ### ExtensionSlotProps
 
-Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\>
+Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\> & { `children?`: `React.ReactNode` \| (`extension`: [`ConnectedExtension`](interfaces/ConnectedExtension.md)) => `React.ReactNode`  }
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L58)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L23)
 
 ___
 
@@ -704,17 +708,7 @@ and *must* only be used once within that `<ExtensionSlot>`.
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/Extension.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L23)
-
-___
-
-### ExtensionSlot
-
-• **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L68)
+[packages/framework/esm-react-utils/src/Extension.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L31)
 
 ___
 
@@ -2307,7 +2301,7 @@ ___
 
 ### renderExtension
 
-▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): [`CancelLoading`](interfaces/CancelLoading.md)
+▸ **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
@@ -2326,7 +2320,7 @@ that registered an extension component for this slot.
 
 #### Returns
 
-[`CancelLoading`](interfaces/CancelLoading.md)
+`Parcel` \| ``null``
 
 #### Defined in
 
@@ -3428,6 +3422,57 @@ ___
 
 ___
 
+## Other Functions
+
+### ExtensionSlot
+
+▸ **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 |
+| :------ | :------ |
+| `__namedParameters` | [`ExtensionSlotProps`](API.md#extensionslotprops) |
+
+#### Returns
+
+`Element`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:85](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L85)
+
+___
+
 ## Store Functions
 
 ### createGlobalStore
@@ -3774,7 +3819,7 @@ The dispose function to force closing the modal dialog.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/modals/index.tsx:164](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/modals/index.tsx#L164)
+[packages/framework/esm-styleguide/src/modals/index.tsx:165](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/modals/index.tsx#L165)
 
 ___
 

package/docs/interfaces/DynamicOfflineData.md

@@ -0,0 +1,78 @@
+[@openmrs/esm-framework](../API.md) / DynamicOfflineData
+
+# Interface: DynamicOfflineData
+
+Represents the registration of a single dynamic offline data entry.
+
+## Table of contents
+
+### Offline Properties
+
+- [id](DynamicOfflineData.md#id)
+- [identifier](DynamicOfflineData.md#identifier)
+- [syncState](DynamicOfflineData.md#syncstate)
+- [type](DynamicOfflineData.md#type)
+- [users](DynamicOfflineData.md#users)
+
+## Offline Properties
+
+### id
+
+• `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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L48)
+
+___
+
+### identifier
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L58)
+
+___
+
+### syncState
+
+• `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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L67)
+
+___
+
+### type
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L53)
+
+___
+
+### users
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L62)

package/docs/interfaces/DynamicOfflineDataHandler.md

@@ -0,0 +1,105 @@
+[@openmrs/esm-framework](../API.md) / DynamicOfflineDataHandler
+
+# 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
+
+- [displayName](DynamicOfflineDataHandler.md#displayname)
+- [id](DynamicOfflineDataHandler.md#id)
+- [type](DynamicOfflineDataHandler.md#type)
+
+### Methods
+
+- [isSynced](DynamicOfflineDataHandler.md#issynced)
+- [sync](DynamicOfflineDataHandler.md#sync)
+
+## Offline Properties
+
+### displayName
+
+• `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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L24)
+
+___
+
+### id
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L14)
+
+___
+
+### type
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L19)
+
+## Methods
+
+### isSynced
+
+▸ **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` | 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
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L32)
+
+___
+
+### sync
+
+▸ **sync**(`identifier`, `abortSignal?`): `Promise`<`void`\>
+
+Synchronizes the given offline data.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `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
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/framework/esm-offline/src/dynamic-offline-data.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L38)

package/docs/interfaces/DynamicOfflineDataSyncState.md

@@ -0,0 +1,75 @@
+[@openmrs/esm-framework](../API.md) / DynamicOfflineDataSyncState
+
+# Interface: DynamicOfflineDataSyncState
+
+Represents the result of syncing a given [DynamicOfflineData](DynamicOfflineData.md) entry.
+
+## Table of contents
+
+### Offline Properties
+
+- [erroredHandlers](DynamicOfflineDataSyncState.md#erroredhandlers)
+- [errors](DynamicOfflineDataSyncState.md#errors)
+- [succeededHandlers](DynamicOfflineDataSyncState.md#succeededhandlers)
+- [syncedBy](DynamicOfflineDataSyncState.md#syncedby)
+- [syncedOn](DynamicOfflineDataSyncState.md#syncedon)
+
+## Offline Properties
+
+### erroredHandlers
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L89)
+
+___
+
+### errors
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L93)
+
+___
+
+### succeededHandlers
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L85)
+
+___
+
+### syncedBy
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L81)
+
+___
+
+### syncedOn
+
+• **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/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L77)

package/docs/interfaces/ExtensionProps.md

@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/Extension.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L7)
+[packages/framework/esm-react-utils/src/Extension.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L14)
 
 ## Methods
 
@@ -28,6 +28,8 @@
 
 ▸ `Optional` **wrap**(`slot`, `extension`): ``null`` \| `ReactElement`<`any`, `any`\>
 
+**`deprecated`** Pass a function as the child of `ExtensionSlot` instead.
+
 #### Parameters
 
 | Name | Type |
@@ -41,4 +43,4 @@
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/Extension.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L8)
+[packages/framework/esm-react-utils/src/Extension.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L16)

package/docs/interfaces/ExtensionSlotBaseProps.md

@@ -24,7 +24,7 @@
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L45)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L10)
 
 ___
 
@@ -34,7 +34,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L43)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L8)
 
 ___
 
@@ -44,7 +44,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L47)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L12)
 
 ## Methods
 
@@ -64,4 +64,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L46)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L11)

package/docs/interfaces/OldExtensionSlotBaseProps.md

@@ -24,7 +24,7 @@
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L53)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L18)
 
 ___
 
@@ -34,7 +34,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L51)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L16)
 
 ___
 
@@ -44,7 +44,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L55)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L20)
 
 ## Methods
 
@@ -64,4 +64,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L54)
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L19)

package/mock.tsx

@@ -249,12 +249,6 @@ export const useSession = jest.fn(() => ({
 
 export const useLayoutType = jest.fn(() => "desktop");
 
-export const useExtensionSlot = jest.fn(() => ({
-  extensionSlotModuleName: "",
-  attachedExtensionSlotName: "",
-  extensionIdsToRender: [],
-}));
-
 export const useExtensionSlotMeta = jest.fn(() => ({}));
 
 export const UserHasAccess = jest.fn().mockImplementation((props: any) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.4.1-pre.156",
+  "version": "3.4.1-pre.163",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -35,18 +35,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^3.4.1-pre.156",
-    "@openmrs/esm-breadcrumbs": "^3.4.1-pre.156",
-    "@openmrs/esm-config": "^3.4.1-pre.156",
-    "@openmrs/esm-error-handling": "^3.4.1-pre.156",
-    "@openmrs/esm-extensions": "^3.4.1-pre.156",
-    "@openmrs/esm-globals": "^3.4.1-pre.156",
-    "@openmrs/esm-offline": "^3.4.1-pre.156",
-    "@openmrs/esm-react-utils": "^3.4.1-pre.156",
-    "@openmrs/esm-state": "^3.4.1-pre.156",
-    "@openmrs/esm-styleguide": "^3.4.1-pre.156",
-    "@openmrs/esm-utils": "^3.4.1-pre.156",
+    "@openmrs/esm-api": "^3.4.1-pre.163",
+    "@openmrs/esm-breadcrumbs": "^3.4.1-pre.163",
+    "@openmrs/esm-config": "^3.4.1-pre.163",
+    "@openmrs/esm-error-handling": "^3.4.1-pre.163",
+    "@openmrs/esm-extensions": "^3.4.1-pre.163",
+    "@openmrs/esm-globals": "^3.4.1-pre.163",
+    "@openmrs/esm-offline": "^3.4.1-pre.163",
+    "@openmrs/esm-react-utils": "^3.4.1-pre.163",
+    "@openmrs/esm-state": "^3.4.1-pre.163",
+    "@openmrs/esm-styleguide": "^3.4.1-pre.163",
+    "@openmrs/esm-utils": "^3.4.1-pre.163",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "643ddd2b2faf12c13f29caa2f22b9b125040b7fc"
+  "gitHead": "60f1da32b4611bb9045a78b307cd331070e24151"
 }