@openmrs/esm-offline 3.1.13-pre.656 → 3.1.13-pre.667

package/docs/API.md

@@ -26,6 +26,7 @@
 
 - [KnownOmrsServiceWorkerEvents](API.md#knownomrsserviceworkerevents)
 - [KnownOmrsServiceWorkerMessages](API.md#knownomrsserviceworkermessages)
+- [OmrsOfflineCachingStrategy](API.md#omrsofflinecachingstrategy)
 - [OmrsOfflineHttpHeaderNames](API.md#omrsofflinehttpheadernames)
 - [OmrsOfflineHttpHeaders](API.md#omrsofflinehttpheaders)
 - [ProcessSyncItem](API.md#processsyncitem)
@@ -78,7 +79,22 @@ ___
 
 #### Defined in
 
-[service-worker-messaging.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L43)
+[service-worker-messaging.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L45)
+
+___
+
+### OmrsOfflineCachingStrategy
+
+Ƭ **OmrsOfflineCachingStrategy**: ``"network-only-or-cache-only"`` \| ``"network-first"``
+
+* `cache-or-network`: The default strategy, equal to the absence of this header.
+  The SW attempts to resolve the request via the network, but falls back to the cache if required.
+  The service worker decides the strategy to be used.
+* `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.
+
+#### Defined in
+
+[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)
 
 ___
 
@@ -88,7 +104,7 @@ ___
 
 #### Defined in
 
-[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)
+[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)
 
 ___
 
@@ -103,13 +119,13 @@ HTTP requests with these headers are handled in a special way by the SPA's servi
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `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. |
+| `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) | Instructs the service worker to use a specific caching strategy for this request. |
 | `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. |
 | `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. |
 
 #### Defined in
 
-[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)
+[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)
 
 ___
 
@@ -399,7 +415,7 @@ A promise which completes when the message has been successfully processed by th
 
 #### Defined in
 
-[service-worker-messaging.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L9)
+[service-worker-messaging.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L10)
 
 ___
 

package/docs/interfaces/ClearDynamicRoutesMessage.md

@@ -26,4 +26,4 @@
 
 #### Defined in
 
-[service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
+[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

@@ -24,7 +24,7 @@
 
 #### Defined in
 
-[service-worker-messaging.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L51)
+[service-worker-messaging.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L53)
 
 ___
 
@@ -34,7 +34,7 @@ ___
 
 #### Defined in
 
-[service-worker-messaging.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L50)
+[service-worker-messaging.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L52)
 
 ___
 
@@ -44,4 +44,4 @@ ___
 
 #### Defined in
 
-[service-worker-messaging.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L49)
+[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

@@ -32,4 +32,4 @@
 
 #### Defined in
 
-[service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
+[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

@@ -23,7 +23,7 @@
 
 #### Defined in
 
-[service-worker-messaging.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L31)
+[service-worker-messaging.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L32)
 
 ___
 
@@ -37,4 +37,4 @@ ___
 
 #### Defined in
 
-[service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
+[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

@@ -13,6 +13,7 @@
 ### Properties
 
 - [pattern](RegisterDynamicRouteMessage.md#pattern)
+- [strategy](RegisterDynamicRouteMessage.md#strategy)
 - [type](RegisterDynamicRouteMessage.md#type)
 - [url](RegisterDynamicRouteMessage.md#url)
 
@@ -24,7 +25,17 @@
 
 #### Defined in
 
-[service-worker-messaging.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L39)
+[service-worker-messaging.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L40)
+
+___
+
+### strategy
+
+• `Optional` **strategy**: [`OmrsOfflineCachingStrategy`](../API.md#omrsofflinecachingstrategy)
+
+#### Defined in
+
+[service-worker-messaging.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L42)
 
 ___
 
@@ -38,7 +49,7 @@ ___
 
 #### Defined in
 
-[service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
+[service-worker-messaging.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L27)
 
 ___
 
@@ -48,4 +59,4 @@ ___
 
 #### Defined in
 
-[service-worker-messaging.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L40)
+[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

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-offline",
-  "version": "3.1.13-pre.656",
+  "version": "3.1.13-pre.667",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "browser": "dist/openmrs-esm-offline.js",
@@ -37,10 +37,10 @@
     "access": "public"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "^3.1.13-pre.656",
-    "@openmrs/esm-globals": "^3.1.13-pre.656",
-    "@openmrs/esm-state": "^3.1.13-pre.656",
-    "@openmrs/esm-styleguide": "^3.1.13-pre.656",
+    "@openmrs/esm-api": "^3.1.13-pre.667",
+    "@openmrs/esm-globals": "^3.1.13-pre.667",
+    "@openmrs/esm-state": "^3.1.13-pre.667",
+    "@openmrs/esm-styleguide": "^3.1.13-pre.667",
     "@types/uuid": "^8.3.0",
     "rxjs": "^6.5.3"
   },
@@ -57,5 +57,5 @@
     "uuid": "^8.3.2",
     "workbox-window": "^6.1.5"
   },
-  "gitHead": "f3906e0c4e4f5fdc868941b10c8f8570eeecbc0e"
+  "gitHead": "edbf3e89aa3a326e713f94ff89b8228b70e8af36"
 }

package/src/service-worker-http-headers.ts

@@ -5,6 +5,18 @@ export const omrsOfflineResponseStatusHttpHeaderName =
 export const omrsOfflineCachingStrategyHttpHeaderName =
   "x-omrs-offline-caching-strategy";
 
+/**
+ *
+ *
+ * * `cache-or-network`: The default strategy, equal to the absence of this header.
+ *   The SW attempts to resolve the request via the network, but falls back to the cache if required.
+ *   The service worker decides the strategy to be used.
+ * * `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.
+ */
+export type OmrsOfflineCachingStrategy =
+  | "network-only-or-cache-only"
+  | "network-first";
+
 /**
  * Defines the keys of the custom headers which can be appended to an HTTP request.
  * HTTP requests with these headers are handled in a special way by the SPA's service worker.
@@ -24,13 +36,8 @@ export type OmrsOfflineHttpHeaders = {
   [omrsOfflineResponseStatusHttpHeaderName]?: `${number}`;
   /**
    * 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.
    */
-  [omrsOfflineCachingStrategyHttpHeaderName]?: "default" | "network-first";
+  [omrsOfflineCachingStrategyHttpHeaderName]?: OmrsOfflineCachingStrategy;
 };
 
 export type OmrsOfflineHttpHeaderNames = keyof OmrsOfflineHttpHeaders;

package/src/service-worker-messaging.ts

@@ -1,4 +1,5 @@
 import type { ImportMap } from "@openmrs/esm-globals";
+import { OmrsOfflineCachingStrategy } from "./service-worker-http-headers";
 import { getOmrsServiceWorker } from "./service-worker";
 
 /**
@@ -38,6 +39,7 @@ export interface RegisterDynamicRouteMessage
   extends OmrsServiceWorkerMessage<"registerDynamicRoute"> {
   pattern?: string;
   url?: string;
+  strategy?: OmrsOfflineCachingStrategy;
 }
 
 export type KnownOmrsServiceWorkerMessages =