@openmrs/esm-framework 3.2.1-pre.1149 → 3.2.1-pre.1160

package/docs/API.md

@@ -26,7 +26,6 @@
 - [useLocations](API.md#uselocations)
 - [usePatient](API.md#usepatient)
 - [useSession](API.md#usesession)
-- [useSessionUser](API.md#usesessionuser)
 - [useVisit](API.md#usevisit)
 - [useVisitTypes](API.md#usevisittypes)
 - [userHasAccess](API.md#userhasaccess)
@@ -111,6 +110,8 @@
 - [deleteSynchronizationItem](API.md#deletesynchronizationitem)
 - [generateOfflineUuid](API.md#generateofflineuuid)
 - [getCurrentOfflineMode](API.md#getcurrentofflinemode)
+- [getFullSynchronizationItems](API.md#getfullsynchronizationitems)
+- [getFullSynchronizationItemsFor](API.md#getfullsynchronizationitemsfor)
 - [getOfflinePatientDataStore](API.md#getofflinepatientdatastore)
 - [getSynchronizationItem](API.md#getsynchronizationitem)
 - [getSynchronizationItems](API.md#getsynchronizationitems)
@@ -138,11 +139,13 @@
 
 ### UI Functions
 
+- [setLeftNav](API.md#setleftnav)
 - [showModal](API.md#showmodal)
 - [showNotification](API.md#shownotification)
 - [showToast](API.md#showtoast)
 - [subscribeNotificationShown](API.md#subscribenotificationshown)
 - [subscribeToastShown](API.md#subscribetoastshown)
+- [unsetLeftNav](API.md#unsetleftnav)
 - [useBodyScrollLock](API.md#usebodyscrolllock)
 - [useLayoutType](API.md#uselayouttype)
 - [useOnClickOutside](API.md#useonclickoutside)
@@ -655,6 +658,18 @@ ___
 
 [packages/framework/esm-api/src/openmrs-backend-dependencies.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-backend-dependencies.ts#L1)
 
+___
+
+## UI Variables
+
+### LeftNavMenu
+
+• **LeftNavMenu**: `ForwardRefExoticComponent`<`SideNavProps` & `RefAttributes`<`HTMLElement`\>\>
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/left-nav/index.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/left-nav/index.tsx#L30)
+
 ## API Functions
 
 ### fetchCurrentPatient
@@ -1195,22 +1210,6 @@ ___
 
 ___
 
-### useSessionUser
-
-▸ `Const` **useSessionUser**(): ``null`` \| [`Session`](interfaces/Session.md)
-
-**`deprecated`**
-
-#### Returns
-
-``null`` \| [`Session`](interfaces/Session.md)
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/useSessionUser.tsx:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useSessionUser.tsx#L21)
-
-___
-
 ### useVisit
 
 ▸ **useVisit**(`patientUuid`): `VisitReturnType`
@@ -2564,7 +2563,7 @@ If this is not possible, throws an error.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:355](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L355)
+[packages/framework/esm-offline/src/sync.ts:377](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L377)
 
 ___
 
@@ -2587,7 +2586,7 @@ registered synchronization handlers.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:345](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L345)
+[packages/framework/esm-offline/src/sync.ts:367](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L367)
 
 ___
 
@@ -2609,7 +2608,7 @@ Deletes a queued up sync item with the given ID.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:375](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L375)
+[packages/framework/esm-offline/src/sync.ts:397](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L397)
 
 ___
 
@@ -2643,6 +2642,63 @@ ___
 
 ___
 
+### getFullSynchronizationItems
+
+▸ **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 |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `type` | `string` | The identifying type of the synchronization items to be returned. |
+
+#### Returns
+
+`Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L347)
+
+___
+
+### getFullSynchronizationItemsFor
+
+▸ **getFullSynchronizationItemsFor**<`T`\>(`userId`, `type`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
+
+Returns all currently queued up sync items of a given user.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `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
+
+`Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:320](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L320)
+
+___
+
 ### getOfflinePatientDataStore
 
 ▸ **getOfflinePatientDataStore**(): `Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
@@ -2681,7 +2737,7 @@ Returns a queued sync item with the given ID or `undefined` if no such item exis
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L334)
+[packages/framework/esm-offline/src/sync.ts:356](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L356)
 
 ___
 
@@ -2689,7 +2745,7 @@ ___
 
 ▸ **getSynchronizationItems**<`T`\>(`type`): `Promise`<`T`[]\>
 
-Returns all currently queued up sync items of the currently signed in user.
+Returns the content of all currently queued up sync items of the currently signed in user.
 
 #### Type parameters
 
@@ -2709,7 +2765,7 @@ Returns all currently queued up sync items of the currently signed in user.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:325](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L325)
+[packages/framework/esm-offline/src/sync.ts:338](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L338)
 
 ___
 
@@ -2856,7 +2912,7 @@ Registers a new synchronization handler which is able to synchronize data of a s
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:390](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L390)
+[packages/framework/esm-offline/src/sync.ts:412](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L412)
 
 ___
 
@@ -3274,6 +3330,26 @@ ___
 
 ## UI Functions
 
+### setLeftNav
+
+▸ **setLeftNav**(`__namedParameters`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | `Object` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/left-nav/index.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/left-nav/index.tsx#L18)
+
+___
+
 ### showModal
 
 ▸ **showModal**(`extensionId`, `props?`, `onClose?`): () => `void`
@@ -3402,6 +3478,26 @@ ___
 
 ___
 
+### unsetLeftNav
+
+▸ **unsetLeftNav**(`name`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `any` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/left-nav/index.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/left-nav/index.tsx#L22)
+
+___
+
 ### useBodyScrollLock
 
 ▸ **useBodyScrollLock**(`active`): `void`

package/mock.tsx

@@ -237,8 +237,6 @@ export const usePatient = jest.fn(() => ({
 
 export const useSession = jest.fn(() => null);
 
-export const useSessionUser = jest.fn(() => null);
-
 export const useLayoutType = jest.fn(() => "desktop");
 
 export const useExtensionSlot = jest.fn(() => ({
@@ -299,3 +297,7 @@ export const useVisitTypes = jest.fn(() => []);
 export const showNotification = jest.fn();
 export const showToast = jest.fn();
 export const showModal = jest.fn();
+
+export const LeftNavMenu = jest.fn();
+export const setLeftNav = jest.fn();
+export const unsetLeftNav = jest.fn();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.2.1-pre.1149",
+  "version": "3.2.1-pre.1160",
   "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.2.1-pre.1149",
-    "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1149",
-    "@openmrs/esm-config": "^3.2.1-pre.1149",
-    "@openmrs/esm-error-handling": "^3.2.1-pre.1149",
-    "@openmrs/esm-extensions": "^3.2.1-pre.1149",
-    "@openmrs/esm-globals": "^3.2.1-pre.1149",
-    "@openmrs/esm-offline": "^3.2.1-pre.1149",
-    "@openmrs/esm-react-utils": "^3.2.1-pre.1149",
-    "@openmrs/esm-state": "^3.2.1-pre.1149",
-    "@openmrs/esm-styleguide": "^3.2.1-pre.1149",
-    "@openmrs/esm-utils": "^3.2.1-pre.1149",
+    "@openmrs/esm-api": "^3.2.1-pre.1160",
+    "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1160",
+    "@openmrs/esm-config": "^3.2.1-pre.1160",
+    "@openmrs/esm-error-handling": "^3.2.1-pre.1160",
+    "@openmrs/esm-extensions": "^3.2.1-pre.1160",
+    "@openmrs/esm-globals": "^3.2.1-pre.1160",
+    "@openmrs/esm-offline": "^3.2.1-pre.1160",
+    "@openmrs/esm-react-utils": "^3.2.1-pre.1160",
+    "@openmrs/esm-state": "^3.2.1-pre.1160",
+    "@openmrs/esm-styleguide": "^3.2.1-pre.1160",
+    "@openmrs/esm-utils": "^3.2.1-pre.1160",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "be5284bb64d1a9d85f4b1c2c349127533e9fcc6e"
+  "gitHead": "a34508fb8c153ebfbf13c97b9f386907f44d3b1e"
 }

package/webpack.config.js

@@ -19,10 +19,18 @@ module.exports = (env) => ({
         exclude: /(node_modules|bower_components)/,
         use: "swc-loader",
       },
+      {
+        test: /\.s?css$/,
+        use: [
+          { loader: require.resolve("style-loader") },
+          { loader: require.resolve("css-loader") },
+          { loader: require.resolve("sass-loader") },
+        ],
+      },
     ],
   },
   resolve: {
-    extensions: [".ts", ".js", ".tsx", ".jsx"],
+    extensions: [".ts", ".js", ".tsx", ".jsx", ".scss"],
   },
   plugins: [
     new SystemJSPublicPathWebpackPlugin(),