@procedures/store 0.47.2 → 0.48.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @procedures/store
 
+## 0.48.1
+
+### Patch Changes
+
+- Updated dependencies [2d7edae]
+  - @procedures/client@0.48.1
+  - @procedures/collections@0.48.1
+
+## 0.48.0
+
+### Patch Changes
+
+- 17a18ec: The source now uses only syntax that a type stripper erases, so the setting `erasableSyntaxOnly` of `@mark1russell7/cue` 2.1.1 stays on. Each enum is now a constant object with a type of the same name. Each parameter property is now a field and an assignment in the constructor.
+  
+  **Breaking.** MINOR before 1.0.0: `ErrorCategory`, `ErrorSeverity` and `WebSocketState` are now constant objects. Their names and values stay the same, and each member stays usable as a type. A member is no longer a constant expression: `enum E { A = ErrorSeverity.WARNING }` gives TS18033, and a `const enum` gives TS2474. Also, a string with the value of a member now fits the type of the set.
+  
+  **Migration.** In an enum initializer, write the value in place of the member, for example `"warning"`, or use a constant object. Other uses need no change. The site and the known apps need no change.
+- c529a36: `HybridStorage` has a new mode `read-only`. It refuses each write with `ReadOnlyError` at once, with no change of the local copy, the queue or the remote. Reads, pulls and the feed work as in `write-through`. `HybridMode` has a new value, so an exhaustive `switch` on it needs a new case.
+- Updated dependencies [17a18ec]
+- Updated dependencies [06088f9]
+- Updated dependencies [71f9c6e]
+- Updated dependencies [c839add]
+  - @procedures/client@0.48.0
+  - @procedures/collections@0.48.0
+
 ## 0.47.2
 
 ### Patch Changes

package/README.md

@@ -205,7 +205,7 @@ const users = new HybridStorage(new ApiStorage(client, { collection: "users" }),
 
 ## The modes of `HybridStorage`
 
-`HybridStorage` keeps a local copy of a remote collection storage. It has four modes, and `setMode()` changes the mode while the storage operates.
+`HybridStorage` keeps a local copy of a remote collection storage. It has five modes, and `setMode()` changes the mode while the storage operates.
 
 | Mode | Reads | Writes | Remote calls |
 |---|---|---|---|
@@ -213,6 +213,7 @@ const users = new HybridStorage(new ApiStorage(client, { collection: "users" }),
 | `write-through` | The local copy, and the remote on a miss | The local copy, then the remote | Yes |
 | `write-back` | The local copy, and the remote on a miss | The local copy and the queue. A timer sends the queue. | Yes |
 | `remote-only` | The remote | The remote | Yes. The storage keeps no local copy. |
+| `read-only` | The local copy, and the remote on a miss | Refused with `ReadOnlyError` | Reads and pulls only |
 
 ```ts
 import { minutes } from "@procedures/client";
@@ -245,6 +246,8 @@ await users.setMode("write-through"); // The switch sends the queue, then syncs
 - In the modes `local-only` and `write-back`, each write goes in the queue.
 - In the mode `write-through`, a write that the remote cannot take goes in the queue, and the write throws `PendingWriteError`.
 - By default, a write that the remote cannot take is an error with `retryable: true`, an error without a `code`, or a `TIMEOUT`. The option `isUnavailable` changes it.
+- The mode `read-only` refuses each write with `ReadOnlyError` at once. The local copy, the queue and the remote do not change.
+- A switch to `read-only` sends the queue first, and a failed send keeps the old mode. A queue that a store loads or that `capture` adds in this mode waits for a mode that writes.
 - A full queue refuses the next write with `QueueFullError`. The limit is `maxOfflineOps`, 1000 by default.
 - A push keeps a write that the remote cannot take at this time (`isUnavailable` gives true). This write and the later writes stay in the queue.
 - A queued write that the remote refuses leaves the queue, and the push goes on with the next write.
@@ -293,7 +296,7 @@ const users = new HybridStorage(new ApiStorage(client, { collection: "users" }),
 - A pull reads a local item only when the result depends on it. A pull does not read the item of a queued write that wins.
 - With versions, the storage knows the version of each local item that it wrote or read. Then a pull reads a local item only for a conflict, or when the version is not known.
 - Without versions, a pull reads each local item without a queued write. It compares the JSON of the local item and the remote item.
-- The option `pullInterval` starts a periodic pull in the modes `write-through` and `write-back`. `close()` stops it.
+- The option `pullInterval` starts a periodic pull in the modes `write-through`, `write-back` and `read-only`. `close()` stops it.
 
 ### The base versions on the server
 
@@ -356,7 +359,7 @@ const stop = users.onStatus((status) => {
 - The option `syncState` keeps the cursor and the base versions. A new storage with the same store asks only for the changes since the cursor.
 - `MemorySyncStateStore` keeps the state in memory. `IndexedDbSyncStateStore` of `@procedures/store/indexeddb` keeps it in a browser.
 - The storage uses a loaded cursor only with the option `local` and a local copy that has items. Give the state store with a durable local copy.
-- The option `feed` takes a push feed of the remote changes, for example `EventsChangeFeed`. The storage subscribes in the modes `write-through` and `write-back`.
+- The option `feed` takes a push feed of the remote changes, for example `EventsChangeFeed`. The storage subscribes in the modes `write-through`, `read-only` and `write-back`.
 - A delta whose `since` is the cursor of the storage applies without a read of the remote.
 - A gap, a lost event, a new subscription or another delta makes the storage pull the changes since its cursor.
 - A delta that comes during a pull applies after the pull. Thus a pull does not erase a change that came during it.