@anfenn/zync 0.3.2 → 0.3.4

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://img.shields.io/npm/v/@anfenn/zync.svg)](https://www.npmjs.com/package/@anfenn/zync)
 
-Simple, bullet-proof, offline-first sync middleware for Zustand.
+Simple, unopinionated, bullet-proof, offline-first sync middleware for Zustand.
 
 **_STATUS_**: Actively developed in alpha stage while requirements are being understood. Api may change, requests are welcome.
 
@@ -28,10 +28,13 @@ Simple, bullet-proof, offline-first sync middleware for Zustand.
 
 - Client records will have a `_localId` field which is stable and never sent to the server. It is ideal for use as a key in JSX. The provided helper function `nextLocalId()` returns a UUID, but you could use any unique value
 - Server records must have:
+
     - `id`: Any datatype, can be a server OR client assigned value
     - `updated_at`: Server assigned **_millisecond_** timestamp (db trigger or api layer). The client will never send this as the client clock is unlikely to be in sync with the server, so is never used for change detection. If it has a higher precision than millisecond, like PostgreSQL's microsecond timestampz, updates could be ignored.
     - `deleted`: Boolean, used for soft deletes, to allow other clients to download deleted records to keep their local records in sync
 
+    **_TIP: If your endpoint doesn't have the same names as the 3 fields above, you can map them in your `api.ts` file e.g. `deleted` -> `isDeleted`_**
+
 ## Quickstart
 
 ```bash
@@ -201,8 +204,8 @@ async function add(item: any): Promise<any | undefined> {
         throw new Error(error.message);
     }
 
-    if (data && data.length > 0) {
-        // Must return server id, and any other fields you want merged in
+    if (data?.length > 0) {
+        // Return server id if not using client assigned id's, and any other fields you want merged in
         return { id: data[0].id };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anfenn/zync",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "private": false,
   "description": "Sync middleware for Zustand",
   "keywords": [],