@openmrs/esm-framework 3.1.13-pre.663 → 3.1.14-pre.676

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 (9) hide show
  1. package/dist/openmrs-esm-framework.js.map +1 -1
  2. package/docs/API.md +23 -13
  3. package/docs/interfaces/ClearDynamicRoutesMessage.md +1 -1
  4. package/docs/interfaces/MessageServiceWorkerResult.md +3 -3
  5. package/docs/interfaces/OmrsServiceWorkerMessage.md +1 -1
  6. package/docs/interfaces/OnImportMapChangedMessage.md +2 -2
  7. package/docs/interfaces/RegisterDynamicRouteMessage.md +14 -3
  8. package/package.json +13 -13
  9. package/tsconfig.json +1 -0
package/docs/API.md CHANGED
@@ -120,6 +120,7 @@
120
120
  - [LoggedInUserData](API.md#loggedinuserdata)
121
121
  - [MaybeAsync](API.md#maybeasync)
122
122
  - [NavigationContextType](API.md#navigationcontexttype)
123
+ - [OmrsOfflineCachingStrategy](API.md#omrsofflinecachingstrategy)
123
124
  - [OmrsOfflineHttpHeaderNames](API.md#omrsofflinehttpheadernames)
124
125
  - [OmrsOfflineHttpHeaders](API.md#omrsofflinehttpheaders)
125
126
  - [PatientUuid](API.md#patientuuid)
@@ -414,7 +415,7 @@ ___
414
415
 
415
416
  #### Defined in
416
417
 
417
- [packages/framework/esm-offline/src/service-worker-messaging.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L43)
418
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L45)
418
419
 
419
420
  ___
420
421
 
@@ -464,13 +465,28 @@ ___
464
465
 
465
466
  ___
466
467
 
468
+ ### OmrsOfflineCachingStrategy
469
+
470
+ Ƭ **OmrsOfflineCachingStrategy**: ``"network-only-or-cache-only"`` \| ``"network-first"``
471
+
472
+ * `cache-or-network`: The default strategy, equal to the absence of this header.
473
+ The SW attempts to resolve the request via the network, but falls back to the cache if required.
474
+ The service worker decides the strategy to be used.
475
+ * `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.
476
+
477
+ #### Defined in
478
+
479
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L16)
480
+
481
+ ___
482
+
467
483
  ### OmrsOfflineHttpHeaderNames
468
484
 
469
485
  Ƭ **OmrsOfflineHttpHeaderNames**: keyof [`OmrsOfflineHttpHeaders`](API.md#omrsofflinehttpheaders)
470
486
 
471
487
  #### Defined in
472
488
 
473
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L36)
489
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L43)
474
490
 
475
491
  ___
476
492
 
@@ -485,13 +501,13 @@ HTTP requests with these headers are handled in a special way by the SPA's servi
485
501
 
486
502
  | Name | Type | Description |
487
503
  | :------ | :------ | :------ |
488
- | `x-omrs-offline-caching-strategy?` | ``"default"`` \| ``"network-first"`` | Instructs the service worker to use a specific caching strategy for this request. The supported values are: * `default`: Equal to the absence of this header/an invalid value. The service worker decides the strategy to be used. * `network-first`: The service worker will make the request and cache its response. |
504
+ | `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) | Instructs the service worker to use a specific caching strategy for this request. |
489
505
  | `x-omrs-offline-response-body?` | `string` | If the client is offline and the request cannot be read from the cache (i.e. if there is no way to receive any kind of data for this request), the service worker will return a response with the body in this header. |
490
506
  | `x-omrs-offline-response-status?` | \`${number}\` | If the client is offline and the request cannot be read from the cache (i.e. if there is no way to receive any kind of data for this request), the service worker will return a response with the status code defined in this header. |
491
507
 
492
508
  #### Defined in
493
509
 
494
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L12)
510
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L24)
495
511
 
496
512
  ___
497
513
 
@@ -2529,7 +2545,7 @@ A promise which completes when the message has been successfully processed by th
2529
2545
 
2530
2546
  #### Defined in
2531
2547
 
2532
- [packages/framework/esm-offline/src/service-worker-messaging.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L9)
2548
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L10)
2533
2549
 
2534
2550
  ___
2535
2551
 
@@ -3705,19 +3721,13 @@ ___
3705
3721
 
3706
3722
  ### updateExtensionStore
3707
3723
 
3708
- ▸ **updateExtensionStore**<`U`\>(`updater`): `void`
3709
-
3710
- #### Type parameters
3711
-
3712
- | Name | Type |
3713
- | :------ | :------ |
3714
- | `U` | extends keyof [`ExtensionStore`](interfaces/ExtensionStore.md) |
3724
+ ▸ **updateExtensionStore**(`updater`): `void`
3715
3725
 
3716
3726
  #### Parameters
3717
3727
 
3718
3728
  | Name | Type |
3719
3729
  | :------ | :------ |
3720
- | `updater` | (`state`: [`ExtensionStore`](interfaces/ExtensionStore.md)) => [`MaybeAsync`](API.md#maybeasync)<`Pick`<[`ExtensionStore`](interfaces/ExtensionStore.md), `U`\>\> |
3730
+ | `updater` | (`state`: [`ExtensionStore`](interfaces/ExtensionStore.md)) => [`MaybeAsync`](API.md#maybeasync)<[`ExtensionStore`](interfaces/ExtensionStore.md)\> |
3721
3731
 
3722
3732
  #### Returns
3723
3733
 
package/docs/interfaces/ClearDynamicRoutesMessage.md CHANGED
@@ -26,4 +26,4 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
29
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)
package/docs/interfaces/MessageServiceWorkerResult.md CHANGED
@@ -24,7 +24,7 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/framework/esm-offline/src/service-worker-messaging.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L51)
27
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L53)
28
28
 
29
29
  ___
30
30
 
@@ -34,7 +34,7 @@ ___
34
34
 
35
35
  #### Defined in
36
36
 
37
- [packages/framework/esm-offline/src/service-worker-messaging.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L50)
37
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L52)
38
38
 
39
39
  ___
40
40
 
@@ -44,4 +44,4 @@ ___
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/framework/esm-offline/src/service-worker-messaging.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L49)
47
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L51)
package/docs/interfaces/OmrsServiceWorkerMessage.md CHANGED
@@ -32,4 +32,4 @@
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
35
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)
package/docs/interfaces/OnImportMapChangedMessage.md CHANGED
@@ -23,7 +23,7 @@
23
23
 
24
24
  #### Defined in
25
25
 
26
- [packages/framework/esm-offline/src/service-worker-messaging.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L31)
26
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L32)
27
27
 
28
28
  ___
29
29
 
@@ -37,4 +37,4 @@ ___
37
37
 
38
38
  #### Defined in
39
39
 
40
- [packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
40
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)
package/docs/interfaces/RegisterDynamicRouteMessage.md CHANGED
@@ -13,6 +13,7 @@
13
13
  ### Properties
14
14
 
15
15
  - [pattern](RegisterDynamicRouteMessage.md#pattern)
16
+ - [strategy](RegisterDynamicRouteMessage.md#strategy)
16
17
  - [type](RegisterDynamicRouteMessage.md#type)
17
18
  - [url](RegisterDynamicRouteMessage.md#url)
18
19
 
@@ -24,7 +25,17 @@
24
25
 
25
26
  #### Defined in
26
27
 
27
- [packages/framework/esm-offline/src/service-worker-messaging.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L39)
28
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L40)
29
+
30
+ ___
31
+
32
+ ### strategy
33
+
34
+ • `Optional` **strategy**: [`OmrsOfflineCachingStrategy`](../API.md#omrsofflinecachingstrategy)
35
+
36
+ #### Defined in
37
+
38
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L42)
28
39
 
29
40
  ___
30
41
 
@@ -38,7 +49,7 @@ ___
38
49
 
39
50
  #### Defined in
40
51
 
41
- [packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
52
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)
42
53
 
43
54
  ___
44
55
 
@@ -48,4 +59,4 @@ ___
48
59
 
49
60
  #### Defined in
50
61
 
51
- [packages/framework/esm-offline/src/service-worker-messaging.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L40)
62
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "3.1.13-pre.663",
3
+ "version": "3.1.14-pre.676",
4
4
  "license": "MPL-2.0",
5
5
  "browser": "dist/openmrs-esm-framework.js",
6
6
  "main": "src/index.ts",
@@ -35,17 +35,17 @@
35
35
  "access": "public"
36
36
  },
37
37
  "dependencies": {
38
- "@openmrs/esm-api": "^3.1.13-pre.663",
39
- "@openmrs/esm-breadcrumbs": "^3.1.13-pre.663",
40
- "@openmrs/esm-config": "^3.1.13-pre.663",
41
- "@openmrs/esm-error-handling": "^3.1.13-pre.663",
42
- "@openmrs/esm-extensions": "^3.1.13-pre.663",
43
- "@openmrs/esm-globals": "^3.1.13-pre.663",
44
- "@openmrs/esm-offline": "^3.1.13-pre.663",
45
- "@openmrs/esm-react-utils": "^3.1.13-pre.663",
46
- "@openmrs/esm-state": "^3.1.13-pre.663",
47
- "@openmrs/esm-styleguide": "^3.1.13-pre.663",
48
- "@openmrs/esm-utils": "^3.1.13-pre.663"
38
+ "@openmrs/esm-api": "^3.1.14-pre.676",
39
+ "@openmrs/esm-breadcrumbs": "^3.1.14-pre.676",
40
+ "@openmrs/esm-config": "^3.1.14-pre.676",
41
+ "@openmrs/esm-error-handling": "^3.1.14-pre.676",
42
+ "@openmrs/esm-extensions": "^3.1.14-pre.676",
43
+ "@openmrs/esm-globals": "^3.1.14-pre.676",
44
+ "@openmrs/esm-offline": "^3.1.14-pre.676",
45
+ "@openmrs/esm-react-utils": "^3.1.14-pre.676",
46
+ "@openmrs/esm-state": "^3.1.14-pre.676",
47
+ "@openmrs/esm-styleguide": "^3.1.14-pre.676",
48
+ "@openmrs/esm-utils": "^3.1.14-pre.676"
49
49
  },
50
- "gitHead": "34dd06f7c931df700cd215b06c22c7ae69542877"
50
+ "gitHead": "d5f12b153263e88e76a47509852df42abd4026ac"
51
51
  }
package/tsconfig.json CHANGED
@@ -2,6 +2,7 @@
2
2
  "compilerOptions": {
3
3
  "esModuleInterop": true,
4
4
  "module": "esnext",
5
+ "target": "es2015",
5
6
  "allowSyntheticDefaultImports": true,
6
7
  "jsx": "react",
7
8
  "strictNullChecks": true,