@openmrs/esm-framework 3.2.1-pre.1144 → 3.2.1-pre.1155

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/.turbo/turbo-build.log +2 -2
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +66 -24
  5. package/mock.tsx +0 -2
  6. package/package.json +13 -13
package/docs/API.md CHANGED
@@ -26,7 +26,6 @@
26
26
  - [useLocations](API.md#uselocations)
27
27
  - [usePatient](API.md#usepatient)
28
28
  - [useSession](API.md#usesession)
29
- - [useSessionUser](API.md#usesessionuser)
30
29
  - [useVisit](API.md#usevisit)
31
30
  - [useVisitTypes](API.md#usevisittypes)
32
31
  - [userHasAccess](API.md#userhasaccess)
@@ -111,6 +110,8 @@
111
110
  - [deleteSynchronizationItem](API.md#deletesynchronizationitem)
112
111
  - [generateOfflineUuid](API.md#generateofflineuuid)
113
112
  - [getCurrentOfflineMode](API.md#getcurrentofflinemode)
113
+ - [getFullSynchronizationItems](API.md#getfullsynchronizationitems)
114
+ - [getFullSynchronizationItemsFor](API.md#getfullsynchronizationitemsfor)
114
115
  - [getOfflinePatientDataStore](API.md#getofflinepatientdatastore)
115
116
  - [getSynchronizationItem](API.md#getsynchronizationitem)
116
117
  - [getSynchronizationItems](API.md#getsynchronizationitems)
@@ -1195,22 +1196,6 @@ ___
1195
1196
 
1196
1197
  ___
1197
1198
 
1198
- ### useSessionUser
1199
-
1200
- ▸ `Const` **useSessionUser**(): ``null`` \| [`Session`](interfaces/Session.md)
1201
-
1202
- **`deprecated`**
1203
-
1204
- #### Returns
1205
-
1206
- ``null`` \| [`Session`](interfaces/Session.md)
1207
-
1208
- #### Defined in
1209
-
1210
- [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)
1211
-
1212
- ___
1213
-
1214
1199
  ### useVisit
1215
1200
 
1216
1201
  ▸ **useVisit**(`patientUuid`): `VisitReturnType`
@@ -2564,7 +2549,7 @@ If this is not possible, throws an error.
2564
2549
 
2565
2550
  #### Defined in
2566
2551
 
2567
- [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)
2552
+ [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)
2568
2553
 
2569
2554
  ___
2570
2555
 
@@ -2587,7 +2572,7 @@ registered synchronization handlers.
2587
2572
 
2588
2573
  #### Defined in
2589
2574
 
2590
- [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)
2575
+ [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)
2591
2576
 
2592
2577
  ___
2593
2578
 
@@ -2609,7 +2594,7 @@ Deletes a queued up sync item with the given ID.
2609
2594
 
2610
2595
  #### Defined in
2611
2596
 
2612
- [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)
2597
+ [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)
2613
2598
 
2614
2599
  ___
2615
2600
 
@@ -2643,6 +2628,63 @@ ___
2643
2628
 
2644
2629
  ___
2645
2630
 
2631
+ ### getFullSynchronizationItems
2632
+
2633
+ ▸ **getFullSynchronizationItems**<`T`\>(`type`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
2634
+
2635
+ Returns all currently queued up sync items of the currently signed in user.
2636
+
2637
+ #### Type parameters
2638
+
2639
+ | Name |
2640
+ | :------ |
2641
+ | `T` |
2642
+
2643
+ #### Parameters
2644
+
2645
+ | Name | Type | Description |
2646
+ | :------ | :------ | :------ |
2647
+ | `type` | `string` | The identifying type of the synchronization items to be returned. |
2648
+
2649
+ #### Returns
2650
+
2651
+ `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
2652
+
2653
+ #### Defined in
2654
+
2655
+ [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)
2656
+
2657
+ ___
2658
+
2659
+ ### getFullSynchronizationItemsFor
2660
+
2661
+ ▸ **getFullSynchronizationItemsFor**<`T`\>(`userId`, `type`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
2662
+
2663
+ Returns all currently queued up sync items of a given user.
2664
+
2665
+ #### Type parameters
2666
+
2667
+ | Name |
2668
+ | :------ |
2669
+ | `T` |
2670
+
2671
+ #### Parameters
2672
+
2673
+ | Name | Type | Description |
2674
+ | :------ | :------ | :------ |
2675
+ | `userId` | `string` | The ID of the user whose synchronization items should be returned. |
2676
+ | `type` | `string` | The identifying type of the synchronization items to be returned.. |
2677
+
2678
+ #### Returns
2679
+
2680
+ `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
2681
+
2682
+ #### Defined in
2683
+
2684
+ [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)
2685
+
2686
+ ___
2687
+
2646
2688
  ### getOfflinePatientDataStore
2647
2689
 
2648
2690
  ▸ **getOfflinePatientDataStore**(): `Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
@@ -2681,7 +2723,7 @@ Returns a queued sync item with the given ID or `undefined` if no such item exis
2681
2723
 
2682
2724
  #### Defined in
2683
2725
 
2684
- [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)
2726
+ [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)
2685
2727
 
2686
2728
  ___
2687
2729
 
@@ -2689,7 +2731,7 @@ ___
2689
2731
 
2690
2732
  ▸ **getSynchronizationItems**<`T`\>(`type`): `Promise`<`T`[]\>
2691
2733
 
2692
- Returns all currently queued up sync items of the currently signed in user.
2734
+ Returns the content of all currently queued up sync items of the currently signed in user.
2693
2735
 
2694
2736
  #### Type parameters
2695
2737
 
@@ -2709,7 +2751,7 @@ Returns all currently queued up sync items of the currently signed in user.
2709
2751
 
2710
2752
  #### Defined in
2711
2753
 
2712
- [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)
2754
+ [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)
2713
2755
 
2714
2756
  ___
2715
2757
 
@@ -2856,7 +2898,7 @@ Registers a new synchronization handler which is able to synchronize data of a s
2856
2898
 
2857
2899
  #### Defined in
2858
2900
 
2859
- [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)
2901
+ [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)
2860
2902
 
2861
2903
  ___
2862
2904
 
package/mock.tsx CHANGED
@@ -237,8 +237,6 @@ export const usePatient = jest.fn(() => ({
237
237
 
238
238
  export const useSession = jest.fn(() => null);
239
239
 
240
- export const useSessionUser = jest.fn(() => null);
241
-
242
240
  export const useLayoutType = jest.fn(() => "desktop");
243
241
 
244
242
  export const useExtensionSlot = jest.fn(() => ({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "3.2.1-pre.1144",
3
+ "version": "3.2.1-pre.1155",
4
4
  "license": "MPL-2.0",
5
5
  "browser": "dist/openmrs-esm-framework.js",
6
6
  "main": "src/index.ts",
@@ -35,18 +35,18 @@
35
35
  "access": "public"
36
36
  },
37
37
  "dependencies": {
38
- "@openmrs/esm-api": "^3.2.1-pre.1144",
39
- "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1144",
40
- "@openmrs/esm-config": "^3.2.1-pre.1144",
41
- "@openmrs/esm-error-handling": "^3.2.1-pre.1144",
42
- "@openmrs/esm-extensions": "^3.2.1-pre.1144",
43
- "@openmrs/esm-globals": "^3.2.1-pre.1144",
44
- "@openmrs/esm-offline": "^3.2.1-pre.1144",
45
- "@openmrs/esm-react-utils": "^3.2.1-pre.1144",
46
- "@openmrs/esm-state": "^3.2.1-pre.1144",
47
- "@openmrs/esm-styleguide": "^3.2.1-pre.1144",
48
- "@openmrs/esm-utils": "^3.2.1-pre.1144",
38
+ "@openmrs/esm-api": "^3.2.1-pre.1155",
39
+ "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1155",
40
+ "@openmrs/esm-config": "^3.2.1-pre.1155",
41
+ "@openmrs/esm-error-handling": "^3.2.1-pre.1155",
42
+ "@openmrs/esm-extensions": "^3.2.1-pre.1155",
43
+ "@openmrs/esm-globals": "^3.2.1-pre.1155",
44
+ "@openmrs/esm-offline": "^3.2.1-pre.1155",
45
+ "@openmrs/esm-react-utils": "^3.2.1-pre.1155",
46
+ "@openmrs/esm-state": "^3.2.1-pre.1155",
47
+ "@openmrs/esm-styleguide": "^3.2.1-pre.1155",
48
+ "@openmrs/esm-utils": "^3.2.1-pre.1155",
49
49
  "dayjs": "^1.10.7"
50
50
  },
51
- "gitHead": "09e5e2abf50a95762de690815ee43a4fd91705e5"
51
+ "gitHead": "3ce827210c8155360b2ac34b213f63f25a71b44b"
52
52
  }