@openmrs/esm-framework 10.0.1-pre.5396 → 10.0.1-pre.5426

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 (7) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/functions/useFhirPagination.md +17 -0
  3. package/docs/functions/useOpenmrsInfinite.md +1 -1
  4. package/docs/functions/useOpenmrsPagination.md +17 -0
  5. package/docs/interfaces/UseServerFetchAllOptions.md +3 -3
  6. package/docs/interfaces/UseServerInfiniteOptions.md +4 -4
  7. package/package.json +20 -20
package/.turbo/turbo-build.log CHANGED
@@ -1,3 +1,3 @@
1
- [0] Successfully compiled: 3 files with swc (115.08ms)
1
+ [0] Successfully compiled: 3 files with swc (168.7ms)
2
2
  [0] swc --strip-leading-paths src -d dist exited with code 0
3
3
  [1] tsc --project tsconfig.build.json exited with code 0
package/docs/functions/useFhirPagination.md CHANGED
@@ -59,6 +59,8 @@ The options object
59
59
 
60
60
  The error object thrown by the fetcher function.
61
61
 
62
+ `undefined` when there's no error or when a request is in progress.
63
+
62
64
  ### goTo()
63
65
 
64
66
  > **goTo**: (`page`) => `void`
@@ -93,14 +95,29 @@ The error object thrown by the fetcher function.
93
95
 
94
96
  > **isLoading**: `boolean`
95
97
 
98
+ Whether the request is in initial loading state.
99
+
100
+ `true` only during the initial load when there's no cached data.
101
+ Unlike `isValidating`, this becomes `false` once data is available.
102
+
96
103
  ### isValidating
97
104
 
98
105
  > **isValidating**: `boolean`
99
106
 
107
+ Whether the request is currently being validated (loading fresh data).
108
+
109
+ `true` during initial load, revalidation, or when mutate is called
110
+ with a promise or async function.
111
+
100
112
  ### mutate
101
113
 
102
114
  > **mutate**: `KeyedMutator`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`Bundle`\>\>
103
115
 
116
+ Function to mutate the cached data for this specific key.
117
+
118
+ This is a bound version of the global mutate function that automatically
119
+ uses the current key, providing type safety and convenience.
120
+
104
121
  ### paginated
105
122
 
106
123
  > **paginated**: `boolean`
package/docs/functions/useOpenmrsInfinite.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **useOpenmrsInfinite**\<`T`\>(`url`, `options`): `UseServerInfiniteReturnObject`\<`T`, `OpenMRSPaginatedResponse`\<`T`\>\>
6
6
 
7
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L102)
7
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L99)
8
8
 
9
9
  Most REST endpoints that return a list of objects, such as getAll or search, are server-side paginated.
10
10
  The server limits the max number of results being returned, and multiple requests are needed to get the full data set
package/docs/functions/useOpenmrsPagination.md CHANGED
@@ -70,6 +70,8 @@ The options object
70
70
 
71
71
  The error object thrown by the fetcher function.
72
72
 
73
+ `undefined` when there's no error or when a request is in progress.
74
+
73
75
  ### goTo()
74
76
 
75
77
  > **goTo**: (`page`) => `void`
@@ -104,14 +106,29 @@ The error object thrown by the fetcher function.
104
106
 
105
107
  > **isLoading**: `boolean`
106
108
 
109
+ Whether the request is in initial loading state.
110
+
111
+ `true` only during the initial load when there's no cached data.
112
+ Unlike `isValidating`, this becomes `false` once data is available.
113
+
107
114
  ### isValidating
108
115
 
109
116
  > **isValidating**: `boolean`
110
117
 
118
+ Whether the request is currently being validated (loading fresh data).
119
+
120
+ `true` during initial load, revalidation, or when mutate is called
121
+ with a promise or async function.
122
+
111
123
  ### mutate
112
124
 
113
125
  > **mutate**: `KeyedMutator`\<[`FetchResponse`](../interfaces/FetchResponse.md)\<`OpenMRSPaginatedResponse`\<`T`\>\>\>
114
126
 
127
+ Function to mutate the cached data for this specific key.
128
+
129
+ This is a bound version of the global mutate function that automatically
130
+ uses the current key, providing type safety and convenience.
131
+
115
132
  ### paginated
116
133
 
117
134
  > **paginated**: `boolean`
package/docs/interfaces/UseServerFetchAllOptions.md CHANGED
@@ -20,7 +20,7 @@ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsFetchAll.ts:14](ht
20
20
 
21
21
  > `optional` **fetcher**: (`key`) => `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
22
22
 
23
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
23
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L15)
24
24
 
25
25
  The fetcher to use. Defaults to openmrsFetch
26
26
 
@@ -44,7 +44,7 @@ The fetcher to use. Defaults to openmrsFetch
44
44
 
45
45
  > `optional` **immutable**: `boolean`
46
46
 
47
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L25)
47
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L22)
48
48
 
49
49
  If true, sets these options in swrInfintieConfig to false:
50
50
  revalidateIfStale, revalidateOnFocus, revalidateOnReconnect
@@ -73,7 +73,7 @@ display all data at once or reduce the number of re-renders (to avoid confusing
73
73
 
74
74
  > `optional` **swrInfiniteConfig**: `SWRInfiniteConfiguration`\<`any`, `any`, `BareFetcher`\<`any`\>\>
75
75
 
76
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L27)
76
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L24)
77
77
 
78
78
  #### Inherited from
79
79
 
package/docs/interfaces/UseServerInfiniteOptions.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: UseServerInfiniteOptions\<R\>
4
4
 
5
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L14)
5
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L11)
6
6
 
7
7
  ## Extended by
8
8
 
@@ -20,7 +20,7 @@ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:14](ht
20
20
 
21
21
  > `optional` **fetcher**: (`key`) => `Promise`\<[`FetchResponse`](FetchResponse.md)\<`R`\>\>
22
22
 
23
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L18)
23
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L15)
24
24
 
25
25
  The fetcher to use. Defaults to openmrsFetch
26
26
 
@@ -40,7 +40,7 @@ The fetcher to use. Defaults to openmrsFetch
40
40
 
41
41
  > `optional` **immutable**: `boolean`
42
42
 
43
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L25)
43
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L22)
44
44
 
45
45
  If true, sets these options in swrInfintieConfig to false:
46
46
  revalidateIfStale, revalidateOnFocus, revalidateOnReconnect
@@ -52,4 +52,4 @@ This should be the counterpart of using useSWRImmutable` for `useSWRInfinite`
52
52
 
53
53
  > `optional` **swrInfiniteConfig**: `SWRInfiniteConfiguration`\<`any`, `any`, `BareFetcher`\<`any`\>\>
54
54
 
55
- Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L27)
55
+ Defined in: [packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L24)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "10.0.1-pre.5396",
3
+ "version": "10.0.1-pre.5426",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/index.js",
@@ -60,24 +60,24 @@
60
60
  "access": "public"
61
61
  },
62
62
  "dependencies": {
63
- "@openmrs/esm-api": "10.0.1-pre.5396",
64
- "@openmrs/esm-config": "10.0.1-pre.5396",
65
- "@openmrs/esm-context": "10.0.1-pre.5396",
66
- "@openmrs/esm-dynamic-loading": "10.0.1-pre.5396",
67
- "@openmrs/esm-emr-api": "10.0.1-pre.5396",
68
- "@openmrs/esm-error-handling": "10.0.1-pre.5396",
69
- "@openmrs/esm-expression-evaluator": "10.0.1-pre.5396",
70
- "@openmrs/esm-extensions": "10.0.1-pre.5396",
71
- "@openmrs/esm-feature-flags": "10.0.1-pre.5396",
72
- "@openmrs/esm-globals": "10.0.1-pre.5396",
73
- "@openmrs/esm-navigation": "10.0.1-pre.5396",
74
- "@openmrs/esm-offline": "10.0.1-pre.5396",
75
- "@openmrs/esm-react-utils": "10.0.1-pre.5396",
76
- "@openmrs/esm-routes": "10.0.1-pre.5396",
77
- "@openmrs/esm-state": "10.0.1-pre.5396",
78
- "@openmrs/esm-styleguide": "10.0.1-pre.5396",
79
- "@openmrs/esm-translations": "10.0.1-pre.5396",
80
- "@openmrs/esm-utils": "10.0.1-pre.5396"
63
+ "@openmrs/esm-api": "10.0.1-pre.5426",
64
+ "@openmrs/esm-config": "10.0.1-pre.5426",
65
+ "@openmrs/esm-context": "10.0.1-pre.5426",
66
+ "@openmrs/esm-dynamic-loading": "10.0.1-pre.5426",
67
+ "@openmrs/esm-emr-api": "10.0.1-pre.5426",
68
+ "@openmrs/esm-error-handling": "10.0.1-pre.5426",
69
+ "@openmrs/esm-expression-evaluator": "10.0.1-pre.5426",
70
+ "@openmrs/esm-extensions": "10.0.1-pre.5426",
71
+ "@openmrs/esm-feature-flags": "10.0.1-pre.5426",
72
+ "@openmrs/esm-globals": "10.0.1-pre.5426",
73
+ "@openmrs/esm-navigation": "10.0.1-pre.5426",
74
+ "@openmrs/esm-offline": "10.0.1-pre.5426",
75
+ "@openmrs/esm-react-utils": "10.0.1-pre.5426",
76
+ "@openmrs/esm-routes": "10.0.1-pre.5426",
77
+ "@openmrs/esm-state": "10.0.1-pre.5426",
78
+ "@openmrs/esm-styleguide": "10.0.1-pre.5426",
79
+ "@openmrs/esm-translations": "10.0.1-pre.5426",
80
+ "@openmrs/esm-utils": "10.0.1-pre.5426"
81
81
  },
82
82
  "peerDependencies": {
83
83
  "dayjs": "1.x",
@@ -90,7 +90,7 @@
90
90
  "swr": "2.x"
91
91
  },
92
92
  "devDependencies": {
93
- "@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.5396",
93
+ "@openmrs/typedoc-plugin-file-categories": "10.0.1-pre.5426",
94
94
  "@swc/cli": "0.8.1",
95
95
  "@swc/core": "1.15.21",
96
96
  "@vitest/coverage-v8": "^4.1.2",