@openmrs/esm-framework 3.4.1-pre.161 → 3.4.1-pre.163
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.
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[33m@openmrs/esm-framework:build: [0mcache hit, replaying output [
|
|
1
|
+
[33m@openmrs/esm-framework:build: [0mcache hit, replaying output [2m4813e7030bdc6561[0m
|
|
2
2
|
[33m@openmrs/esm-framework:build: [0m$ webpack --mode=production
|
|
3
3
|
[33m@openmrs/esm-framework:build: [0masset [1m[33mopenmrs-esm-framework.js[39m[22m [1m[33m848 KiB[39m[22m [1m[32m[emitted][39m[22m [1m[32m[minimized][39m[22m [1m[33m[big][39m[22m (name: main) 2 related assets
|
|
4
4
|
[33m@openmrs/esm-framework:build: [0morphan modules 11.3 MiB [1m[33m[orphan][39m[22m 1161 modules
|
|
@@ -183,4 +183,4 @@
|
|
|
183
183
|
[33m@openmrs/esm-framework:build: [0mYou can limit the size of your bundles by using import() or require.ensure to lazy load some parts of your application.
|
|
184
184
|
[33m@openmrs/esm-framework:build: [0mFor more info visit https://webpack.js.org/guides/code-splitting/[39m[22m
|
|
185
185
|
[33m@openmrs/esm-framework:build: [0m
|
|
186
|
-
[33m@openmrs/esm-framework:build: [0mwebpack 5.70.0 compiled with [1m[33m27 warnings[39m[22m in
|
|
186
|
+
[33m@openmrs/esm-framework:build: [0mwebpack 5.70.0 compiled with [1m[33m27 warnings[39m[22m in 31157 ms
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / DynamicOfflineData
|
|
2
|
+
|
|
3
|
+
# Interface: DynamicOfflineData
|
|
4
|
+
|
|
5
|
+
Represents the registration of a single dynamic offline data entry.
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Offline Properties
|
|
10
|
+
|
|
11
|
+
- [id](DynamicOfflineData.md#id)
|
|
12
|
+
- [identifier](DynamicOfflineData.md#identifier)
|
|
13
|
+
- [syncState](DynamicOfflineData.md#syncstate)
|
|
14
|
+
- [type](DynamicOfflineData.md#type)
|
|
15
|
+
- [users](DynamicOfflineData.md#users)
|
|
16
|
+
|
|
17
|
+
## Offline Properties
|
|
18
|
+
|
|
19
|
+
### id
|
|
20
|
+
|
|
21
|
+
• `Optional` **id**: `number`
|
|
22
|
+
|
|
23
|
+
The internal ID of the data entry, as assigned by the IndexedDB where it is stored.
|
|
24
|
+
|
|
25
|
+
#### Defined in
|
|
26
|
+
|
|
27
|
+
[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)
|
|
28
|
+
|
|
29
|
+
___
|
|
30
|
+
|
|
31
|
+
### identifier
|
|
32
|
+
|
|
33
|
+
• **identifier**: `string`
|
|
34
|
+
|
|
35
|
+
The externally provided identifier of the data entry.
|
|
36
|
+
This is typically the ID of the resource as assigned by a remote API.
|
|
37
|
+
|
|
38
|
+
#### Defined in
|
|
39
|
+
|
|
40
|
+
[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)
|
|
41
|
+
|
|
42
|
+
___
|
|
43
|
+
|
|
44
|
+
### syncState
|
|
45
|
+
|
|
46
|
+
• `Optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md)
|
|
47
|
+
|
|
48
|
+
If this entry has already been synced, returns the result of that last sync attempt.
|
|
49
|
+
Otherwise this is `undefined`.
|
|
50
|
+
|
|
51
|
+
#### Defined in
|
|
52
|
+
|
|
53
|
+
[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)
|
|
54
|
+
|
|
55
|
+
___
|
|
56
|
+
|
|
57
|
+
### type
|
|
58
|
+
|
|
59
|
+
• **type**: `string`
|
|
60
|
+
|
|
61
|
+
The underlying type used for categorizing the data entry.
|
|
62
|
+
Examples could be `"patient"` or `"form"`.
|
|
63
|
+
|
|
64
|
+
#### Defined in
|
|
65
|
+
|
|
66
|
+
[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)
|
|
67
|
+
|
|
68
|
+
___
|
|
69
|
+
|
|
70
|
+
### users
|
|
71
|
+
|
|
72
|
+
• **users**: `string`[]
|
|
73
|
+
|
|
74
|
+
The UUIDs of the users who need this data entry available offline.
|
|
75
|
+
|
|
76
|
+
#### Defined in
|
|
77
|
+
|
|
78
|
+
[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)
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / DynamicOfflineDataHandler
|
|
2
|
+
|
|
3
|
+
# Interface: DynamicOfflineDataHandler
|
|
4
|
+
|
|
5
|
+
A handler for synchronizing dynamically declared offline data.
|
|
6
|
+
Can be setup using the [setupDynamicOfflineDataHandler](../API.md#setupdynamicofflinedatahandler) function.
|
|
7
|
+
|
|
8
|
+
## Table of contents
|
|
9
|
+
|
|
10
|
+
### Offline Properties
|
|
11
|
+
|
|
12
|
+
- [displayName](DynamicOfflineDataHandler.md#displayname)
|
|
13
|
+
- [id](DynamicOfflineDataHandler.md#id)
|
|
14
|
+
- [type](DynamicOfflineDataHandler.md#type)
|
|
15
|
+
|
|
16
|
+
### Methods
|
|
17
|
+
|
|
18
|
+
- [isSynced](DynamicOfflineDataHandler.md#issynced)
|
|
19
|
+
- [sync](DynamicOfflineDataHandler.md#sync)
|
|
20
|
+
|
|
21
|
+
## Offline Properties
|
|
22
|
+
|
|
23
|
+
### displayName
|
|
24
|
+
|
|
25
|
+
• `Optional` **displayName**: `string`
|
|
26
|
+
|
|
27
|
+
A human-readable string representing the handler.
|
|
28
|
+
If provided, the handler can be rendered in the UI using that string.
|
|
29
|
+
|
|
30
|
+
#### Defined in
|
|
31
|
+
|
|
32
|
+
[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)
|
|
33
|
+
|
|
34
|
+
___
|
|
35
|
+
|
|
36
|
+
### id
|
|
37
|
+
|
|
38
|
+
• **id**: `string`
|
|
39
|
+
|
|
40
|
+
A string uniquely identifying the handler.
|
|
41
|
+
|
|
42
|
+
#### Defined in
|
|
43
|
+
|
|
44
|
+
[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)
|
|
45
|
+
|
|
46
|
+
___
|
|
47
|
+
|
|
48
|
+
### type
|
|
49
|
+
|
|
50
|
+
• **type**: `string`
|
|
51
|
+
|
|
52
|
+
The type of offline data handled by this handler.
|
|
53
|
+
See [DynamicOfflineData.type](DynamicOfflineData.md#type) for details.
|
|
54
|
+
|
|
55
|
+
#### Defined in
|
|
56
|
+
|
|
57
|
+
[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)
|
|
58
|
+
|
|
59
|
+
## Methods
|
|
60
|
+
|
|
61
|
+
### isSynced
|
|
62
|
+
|
|
63
|
+
▸ **isSynced**(`identifier`, `abortSignal?`): `Promise`<`boolean`\>
|
|
64
|
+
|
|
65
|
+
Evaluates whether the given offline data is correctly synced at this point in time from the perspective
|
|
66
|
+
of this single handler.
|
|
67
|
+
If `false`, the handler would have to (re-)sync the data in order for offline mode to properly work.
|
|
68
|
+
|
|
69
|
+
#### Parameters
|
|
70
|
+
|
|
71
|
+
| Name | Type | Description |
|
|
72
|
+
| :------ | :------ | :------ |
|
|
73
|
+
| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details. |
|
|
74
|
+
| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
|
|
75
|
+
|
|
76
|
+
#### Returns
|
|
77
|
+
|
|
78
|
+
`Promise`<`boolean`\>
|
|
79
|
+
|
|
80
|
+
#### Defined in
|
|
81
|
+
|
|
82
|
+
[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)
|
|
83
|
+
|
|
84
|
+
___
|
|
85
|
+
|
|
86
|
+
### sync
|
|
87
|
+
|
|
88
|
+
▸ **sync**(`identifier`, `abortSignal?`): `Promise`<`void`\>
|
|
89
|
+
|
|
90
|
+
Synchronizes the given offline data.
|
|
91
|
+
|
|
92
|
+
#### Parameters
|
|
93
|
+
|
|
94
|
+
| Name | Type | Description |
|
|
95
|
+
| :------ | :------ | :------ |
|
|
96
|
+
| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details. |
|
|
97
|
+
| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
|
|
98
|
+
|
|
99
|
+
#### Returns
|
|
100
|
+
|
|
101
|
+
`Promise`<`void`\>
|
|
102
|
+
|
|
103
|
+
#### Defined in
|
|
104
|
+
|
|
105
|
+
[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)
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
[@openmrs/esm-framework](../API.md) / DynamicOfflineDataSyncState
|
|
2
|
+
|
|
3
|
+
# Interface: DynamicOfflineDataSyncState
|
|
4
|
+
|
|
5
|
+
Represents the result of syncing a given [DynamicOfflineData](DynamicOfflineData.md) entry.
|
|
6
|
+
|
|
7
|
+
## Table of contents
|
|
8
|
+
|
|
9
|
+
### Offline Properties
|
|
10
|
+
|
|
11
|
+
- [erroredHandlers](DynamicOfflineDataSyncState.md#erroredhandlers)
|
|
12
|
+
- [errors](DynamicOfflineDataSyncState.md#errors)
|
|
13
|
+
- [succeededHandlers](DynamicOfflineDataSyncState.md#succeededhandlers)
|
|
14
|
+
- [syncedBy](DynamicOfflineDataSyncState.md#syncedby)
|
|
15
|
+
- [syncedOn](DynamicOfflineDataSyncState.md#syncedon)
|
|
16
|
+
|
|
17
|
+
## Offline Properties
|
|
18
|
+
|
|
19
|
+
### erroredHandlers
|
|
20
|
+
|
|
21
|
+
• **erroredHandlers**: `string`[]
|
|
22
|
+
|
|
23
|
+
The IDs of the handlers which failed to synchronize their data.
|
|
24
|
+
|
|
25
|
+
#### Defined in
|
|
26
|
+
|
|
27
|
+
[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)
|
|
28
|
+
|
|
29
|
+
___
|
|
30
|
+
|
|
31
|
+
### errors
|
|
32
|
+
|
|
33
|
+
• **errors**: { `handlerId`: `string` ; `message`: `string` }[]
|
|
34
|
+
|
|
35
|
+
A collection of the errors caught while synchronizing, per handler.
|
|
36
|
+
|
|
37
|
+
#### Defined in
|
|
38
|
+
|
|
39
|
+
[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)
|
|
40
|
+
|
|
41
|
+
___
|
|
42
|
+
|
|
43
|
+
### succeededHandlers
|
|
44
|
+
|
|
45
|
+
• **succeededHandlers**: `string`[]
|
|
46
|
+
|
|
47
|
+
The IDs of the handlers which successfully synchronized their data.
|
|
48
|
+
|
|
49
|
+
#### Defined in
|
|
50
|
+
|
|
51
|
+
[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)
|
|
52
|
+
|
|
53
|
+
___
|
|
54
|
+
|
|
55
|
+
### syncedBy
|
|
56
|
+
|
|
57
|
+
• **syncedBy**: `string`
|
|
58
|
+
|
|
59
|
+
The ID of the user who has triggered the data synchronization.
|
|
60
|
+
|
|
61
|
+
#### Defined in
|
|
62
|
+
|
|
63
|
+
[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)
|
|
64
|
+
|
|
65
|
+
___
|
|
66
|
+
|
|
67
|
+
### syncedOn
|
|
68
|
+
|
|
69
|
+
• **syncedOn**: `Date`
|
|
70
|
+
|
|
71
|
+
The time when the entry has been synced the last time.
|
|
72
|
+
|
|
73
|
+
#### Defined in
|
|
74
|
+
|
|
75
|
+
[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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "3.4.1-pre.
|
|
3
|
+
"version": "3.4.1-pre.163",
|
|
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.4.1-pre.
|
|
39
|
-
"@openmrs/esm-breadcrumbs": "^3.4.1-pre.
|
|
40
|
-
"@openmrs/esm-config": "^3.4.1-pre.
|
|
41
|
-
"@openmrs/esm-error-handling": "^3.4.1-pre.
|
|
42
|
-
"@openmrs/esm-extensions": "^3.4.1-pre.
|
|
43
|
-
"@openmrs/esm-globals": "^3.4.1-pre.
|
|
44
|
-
"@openmrs/esm-offline": "^3.4.1-pre.
|
|
45
|
-
"@openmrs/esm-react-utils": "^3.4.1-pre.
|
|
46
|
-
"@openmrs/esm-state": "^3.4.1-pre.
|
|
47
|
-
"@openmrs/esm-styleguide": "^3.4.1-pre.
|
|
48
|
-
"@openmrs/esm-utils": "^3.4.1-pre.
|
|
38
|
+
"@openmrs/esm-api": "^3.4.1-pre.163",
|
|
39
|
+
"@openmrs/esm-breadcrumbs": "^3.4.1-pre.163",
|
|
40
|
+
"@openmrs/esm-config": "^3.4.1-pre.163",
|
|
41
|
+
"@openmrs/esm-error-handling": "^3.4.1-pre.163",
|
|
42
|
+
"@openmrs/esm-extensions": "^3.4.1-pre.163",
|
|
43
|
+
"@openmrs/esm-globals": "^3.4.1-pre.163",
|
|
44
|
+
"@openmrs/esm-offline": "^3.4.1-pre.163",
|
|
45
|
+
"@openmrs/esm-react-utils": "^3.4.1-pre.163",
|
|
46
|
+
"@openmrs/esm-state": "^3.4.1-pre.163",
|
|
47
|
+
"@openmrs/esm-styleguide": "^3.4.1-pre.163",
|
|
48
|
+
"@openmrs/esm-utils": "^3.4.1-pre.163",
|
|
49
49
|
"dayjs": "^1.10.7"
|
|
50
50
|
},
|
|
51
|
-
"gitHead": "
|
|
51
|
+
"gitHead": "60f1da32b4611bb9045a78b307cd331070e24151"
|
|
52
52
|
}
|