You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-8Lines changed: 23 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# offline-persistence-toolkit 1.5.1 #
1
+
# offline-persistence-toolkit 1.5.2 #
2
2
3
3
offline-persistence-toolkit is a client-side JavaScript library that provides caching and offline support at the HTTP request layer. This support is transparent to the user and is done through the Fetch API and an XHR adapter. HTTP requests made while the client device is offline are captured for replay when connection to the server is restored. Additional capabilities include a persistent storage layer, synchronization manager, binary data support and various configuration APIs for customizing the default behavior. This framework can be used in both ServiceWorker and non-ServiceWorker contexts within web and hybrid mobile apps.
4
4
@@ -58,16 +58,16 @@ If your app uses [RequireJS](http://www.requirejs.org/ "RequireJS"), update the
58
58
```javascript
59
59
requirejs.config({
60
60
paths: {
61
-
'persist':'js/libs/persist/v1.5.1/min'
61
+
'persist':'js/libs/persist/v1.5.2/min'
62
62
63
63
// Other path mappings here
64
64
}
65
65
```
66
-
For Oracle JET apps, also open `appDir/src/js/main-release-paths.json` and add the `'persist':'js/libs/persist/v1.5.1/min'` entry to the list of paths.
66
+
For Oracle JET apps, also open `appDir/src/js/main-release-paths.json` and add the `'persist':'js/libs/persist/v1.5.2/min'` entry to the list of paths.
67
67
68
68
You can choose the name of the paths prefix. That is, you can use a different value to the ‘persist’ value shown in the examples.
69
69
70
-
It is recommended to add the version number as a convention in your application build step such as `'persist':'js/libs/persist/v1.5.1/min'`.
70
+
It is recommended to add the version number as a convention in your application build step such as `'persist':'js/libs/persist/v1.5.2/min'`.
71
71
72
72
Versions of the toolkit are also available on CDN under the latest JET release. e.g.
73
73
@@ -91,7 +91,7 @@ And again, if you are using RequireJS, you will need to map paths for these pack
91
91
paths: {
92
92
'pouchdb':'js/libs/pouchdb-7.0.0',
93
93
'pouchfind':'js/libs/pouchdb.find',
94
-
'persist':'js/libs/persist/v1.5.1/min'
94
+
'persist':'js/libs/persist/v1.5.2/min'
95
95
96
96
// Other path mappings here
97
97
}
@@ -304,9 +304,24 @@ The simpleJsonShredding implementation assumes that the response payload is eith
304
304
305
305
As the structure of response payloads can vary from endpoint to endpoint, applications can also implement their own custom shredders and unshredders to meet their own needs.
306
306
307
-
308
-
309
-
307
+
If the backend resource exposed through a collection endpoint allows delete, there are always race conditions where
308
+
rows are deleted behind the scenes. If the resource is cached and shredded on the client, it is possible that even
309
+
though a row is deleted at the backend, it can still exist on the client. If queryHandler is configured to support
310
+
querying the shredded client data, that row that does not exist on server will be served from client cache. Application
311
+
needs to accept that staleness is a possibility. There is one scenario that Offline Persistence Toolkit can help dealing
312
+
with staleness is when a returned collection from server is known to be complete. A complete collection response contains
313
+
all rows of the resources, thus any client side rows that are not in the list will be removed from the shredded store.
314
+
A complete collection response is a collection response that is either one of the following:
315
+
316
+
1. It is a response that is served to a request which does not contain any query parameters
317
+
2. It is a response that is served to a request which only contains offset or limit query parameters where offset is 0
318
+
and the response contains less rows than the specified limit when limit is bigger than 0.
319
+
320
+
In order for Offline Persistence Toolkit to figure our the offset and limit of the request, queryHandler can
321
+
have an optional method normalizeQueryParameter which takes a url and returns a structure as defined in
0 commit comments