zerodrift 1.0.0 → 1.0.2

package/NOTICE

@@ -0,0 +1,26 @@
+zerodrift
+Copyright (c) 2026 selasijean
+
+This product is licensed under the MIT License. See the LICENSE file.
+
+Inspiration and attribution
+---------------------------
+
+zerodrift was shaped by public writing and talks about local-first sync engine
+design, especially:
+
+  - Wenzhao Hu, "Reverse Engineering Linear's Sync Engine: A Detailed
+    Study" (https://github.com/wzhudev/reverse-linear-sync-engine)
+  - Tuomas Artman's React Helsinki talk on Linear's realtime sync
+    (https://www.youtube.com/watch?v=WxK11RsLqp4)
+
+Wenzhao Hu's writeup is © 2025 Wenzhao Hu and licensed under the Creative
+Commons Attribution 4.0 International License:
+https://creativecommons.org/licenses/by/4.0/
+
+zerodrift is an independent TypeScript implementation. It defines its own small
+three-endpoint sync protocol and ships its own client/server reference code. It
+contains no Linear or other third-party source code.
+
+Linear is a trademark of its respective owner. zerodrift is not affiliated
+with, endorsed by, or sponsored by Linear.

package/README.md

@@ -1,5 +1,7 @@
 # zerodrift
 
+[![npm](https://img.shields.io/npm/v/zerodrift.svg)](https://www.npmjs.com/package/zerodrift)
+
 A TypeScript local-first sync engine. Reads are synchronous from an in-memory pool, writes are optimistic, state stays current across tabs and clients via SSE, and everything persists locally so the app survives reloads and works offline. The same engine runs in Node so agents and background workers can hold a live model just like a browser tab.
 
 You bring the backend. The client speaks a small three-endpoint protocol that can be implemented in any language. A reference Go backend and Next.js demo live in this repo so you can run the whole loop locally.
@@ -27,7 +29,7 @@ npm install zod         # for entityFromZod(...) schema authoring
 npm install eventsource # for Node/headless SSE clients
 ```
 
-If you use the decorator authoring path, enable `experimentalDecorators` in your `tsconfig.json` (or the SWC/Babel equivalent). `reflect-metadata` is **not** required — the engine never reads `design:type` metadata.
+Decorator path: enable `experimentalDecorators` in your `tsconfig.json` (or the SWC/Babel equivalent). Unlike most decorator libraries, `reflect-metadata` is **not** needed.
 
 ## Import paths
 
@@ -35,7 +37,7 @@ If you use the decorator authoring path, enable `experimentalDecorators` in your
 |---|---|
 | `zerodrift` | `StoreManager`, `BaseModel`, decorators, `MemoryAdapter`, relation field types (`RefCollection`/`BackRef`/`OwnedRefs`), and the config / error / sync types. The curated, stable surface. |
 | `zerodrift/schema` | `defineSchema`, `entityFromZod`, field builders, links, extensions, and typed `store.<entity>.*` APIs. |
-| `zerodrift/react` | `<SyncProvider>` and React hooks: `useRecord`, `useRecords`, `useRecordsByIndex`, `useRelation`, `useBatch`, `useUndoRedo`. |
+| `zerodrift/react` | `<SyncProvider>` and React hooks: `useRecord`, `useRecords`, `useRecordsByIndex`, `useRelation`, `useBatch`, `useUndoRedo`, `useBootstrapStatus`. |
 | `zerodrift/internal` | Engine machinery (`ObjectPool`, `TransactionQueue`, `SyncConnection`, `ModelRegistry`, …) for tooling/tests. **No stability promise** — may change between releases. |
 
 ## Define your models
@@ -160,8 +162,9 @@ export default function Providers({ children }) {
         workspaceId: "workspace-123",
         transport: {
           bootstrapFetcher: async (type, options) => {
-            const since = options?.sinceSyncId ?? 0;
-            const res = await fetch(`/api/bootstrap?type=${type}&since=${since}`);
+            const res = await fetch(
+              `/api/bootstrap?type=${type}&lastSyncId=${options?.sinceSyncId ?? 0}`,
+            );
             return res.json();
           },
           transactionSender: async (batch) => {
@@ -295,9 +298,9 @@ SSE messages are delta packets:
 
 ```json
 {
+  "syncId": 5206,
   "syncActions": [
     {
-      "id": 5206,
       "modelName": "Issue",
       "modelId": "uuid",
       "action": "U",
@@ -309,7 +312,7 @@ SSE messages are delta packets:
 }
 ```
 
-The client reconnects with `?since=<lastSyncId>` so the server can replay missed events. See [agent-docs/07-realtime-sync.md](agent-docs/07-realtime-sync.md) for SSE details and [agent-docs/05-sync-groups.md](agent-docs/05-sync-groups.md) for scoped event delivery.
+The client reconnects with `?lastSyncId=<id>` so the server can replay missed events. See [agent-docs/07-realtime-sync.md](agent-docs/07-realtime-sync.md) for SSE details and [agent-docs/05-sync-groups.md](agent-docs/05-sync-groups.md) for scoped event delivery.
 
 ## Run the demo
 
@@ -341,7 +344,7 @@ Deeper material lives in [agent-docs/](agent-docs/):
 ## Project structure
 
 ```text
-.                      # the publishable zerodrift package (src/, __tests__/)
+.                      # the publishable zerodrift package
 |-- src/
 |-- agent-docs/         # architecture and API notes
 `-- examples/           # self-contained runnable demo (own Makefile + compose)
@@ -356,3 +359,20 @@ Deeper material lives in [agent-docs/](agent-docs/):
 - **Client**: TypeScript, MobX, IndexedDB, EventSource (SSE)
 - **Reference server**: Go, Gin, Bun ORM, Postgres (LISTEN/NOTIFY), pgx
 - **Protocol**: append-only changelog, monotonic sync id, sync group filtering
+
+## Acknowledgments
+
+zerodrift was informed by public writing and talks on local-first sync
+engines. Two especially helpful references were Wenzhao Hu's "Reverse
+Engineering Linear's Sync Engine: A Detailed Study"
+([wzhudev/reverse-linear-sync-engine](https://github.com/wzhudev/reverse-linear-sync-engine))
+and Tuomas Artman's React Helsinki talk on
+[Linear's realtime sync](https://www.youtube.com/watch?v=WxK11RsLqp4).
+
+This project is an independent TypeScript implementation and is not affiliated
+with Linear.
+
+## License
+
+MIT — see [LICENSE](LICENSE). The MIT grant covers zerodrift's own code.
+See [NOTICE](NOTICE) for inspiration and attribution notes.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zerodrift",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "private": false,
   "description": "A TypeScript local-first sync engine: synchronous in-memory reads, optimistic writes, realtime SSE sync, offline IndexedDB persistence. Runs in the browser and in Node.",
   "license": "MIT",
@@ -49,7 +49,8 @@
     "./package.json": "./package.json"
   },
   "files": [
-    "dist"
+    "dist",
+    "NOTICE"
   ],
   "engines": {
     "node": ">=18"