@procedures/collections 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @procedures/collections
 
+## 0.8.0
+
+### Patch Changes
+
+- aa6e3aa: `ApiStorage` has `getIds()`. A full pull through it does not read each entry for the ids.
+  
+  - The collections have the procedure `collections.<name>.ids`. It gives the ids in the order of the entries, without the values. Its effects read the collection and write nothing. A storage without `getIds()` gives the ids of its entries.
+  - The `CollectionStorage` of the core has the optional method `getIds()`, as the `CollectionStorage` of `@procedures/collections` has.
+  - `ApiStorage.getIds()` uses the procedure `ids`. An older server without it answers `NOT_FOUND`. Then the storage reads the ids from the entries, and it does not ask for `ids` again.
+  - `ApiStorageOptions.operations` takes `ids`, the name of the operation. The default is `ids`.
+
 ## 0.7.0
 
 ### Minor Changes

package/README.md

@@ -147,7 +147,7 @@ describeCollectionStorageContract(
 |---|---|---|
 | `InMemoryStorage` | `@procedures/collections` | It copies with `structuredClone`. The run with `copies: false` skips only the case of the copies. |
 | `SqliteStorage` (each engine, in memory and in a file) | `@procedures/sqlite` | It keeps JSON text, so it gives copies. |
-| `ApiStorage` | `@procedures/store` | It reads `{ found, value }` from the procedure `get`, so a stored `null` stays `null`. It has no `getIds`. |
+| `ApiStorage` | `@procedures/store` | It reads `{ found, value }` from the procedure `get`, so a stored `null` stays `null`. Its `getIds` uses the procedure `ids`. |
 | `HybridStorage` (each mode, and a queue in IndexedDB) | `@procedures/store` | It has no `getChangesSince`. |
 
 ## Storage Backends
@@ -169,40 +169,22 @@ const user = await storage.get("user-1");
 - `getIds()` gives the ids without a copy of the values.
 - `close()` drops the items. After it, each operation rejects, and the methods of the `Map` interface (`keys()`, `values()`, `entries()`, `forEach()`) throw.
 
-### ApiStorage
+### ApiStorage and HybridStorage
 
-Remote storage via RPC client:
+These two storages need a `Client`, so they are in [`@procedures/store`](../client-store/README.md), not in this package.
 
-```typescript
-import { ApiStorage } from "@procedures/collections";
-import { Client } from "@procedures/client";
-
-const client = new Client({ transport });
-const storage = new ApiStorage<User>(client, {
-  collection: "users",
-  endpoints: {
-    get: { service: "users", operation: "get" },
-    set: { service: "users", operation: "set" },
-    // ... other endpoints
-  }
-});
-```
-
-### HybridStorage
-
-Local cache with remote synchronization:
+- `ApiStorage` sends each operation to the collection procedures of a server: `collections.<collection>.<operation>`. The server registers them with `createCollectionProcedures(collection)`.
+- `HybridStorage` keeps a local copy of a remote storage. It has four modes: `local-only`, `write-through`, `write-back` and `remote-only`. `setMode()` changes the mode while the storage operates.
 
 ```typescript
-import { HybridStorage, MemoryStorage, ApiStorage } from "@procedures/collections";
+import { ApiStorage, HybridStorage } from "@procedures/store";
 
-const hybrid = new HybridStorage<User>({
-  local: new MemoryStorage<User>(),
-  remote: apiStorage,
-  syncStrategy: "write-through", // or "write-behind"
-  conflictResolver: (local, remote) => remote.updatedAt > local.updatedAt ? remote : local
-});
+const remote = new ApiStorage<User>(client, { collection: "users" });
+const users = new HybridStorage<User>(remote, { mode: "write-through", conflictResolution: "remote" });
 ```
 
+The README of `@procedures/store` gives the options, the queue of `write-back`, the conflict rules and the contract of the two storages.
+
 ## Collection Implementations
 
 ### Lists

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@procedures/collections",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Collections for TypeScript: ArrayList, LinkedList, ArrayDeque, HashMap, LinkedHashMap, TreeMap (red-black), PriorityQueue, LRU and TTL maps, async queues, channels and collectors, tested with fast-check.",
   "keywords": [
     "collections",