@furystack/entity-sync 0.1.1 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## [1.0.1] - 2026-02-22
+
+### ⬆️ Dependencies
+
+- Updated `@furystack/core` dependency
+
+## [1.0.0] - 2026-02-22
+
+### 💥 Breaking Changes
+
+### Added `collection-snapshot` variant to `ServerSyncMessage`
+
+A new `collection-snapshot` variant has been added to the `ServerSyncMessage` union type. The server now sends a full snapshot (entries + count) whenever a collection changes, instead of individual diff messages. This ensures entries and count are always delivered together as a consistent unit.
+
+Consumers that exhaustively match on `ServerSyncMessage.type` (without a `default`) must add a `collection-snapshot` case.
+
+**Examples:**
+
+```typescript
+// ✅ Handle the new collection-snapshot message
+switch (message.type) {
+  case 'collection-snapshot':
+    console.log(message.data, message.totalCount)
+    break
+  // ... other cases
+}
+```
+
+**Impact:** Consumers that exhaustively match on `ServerSyncMessage.type` (without a `default`) will get a compile error until the new case is handled.
+
+### ✨ Features
+
+### Total count support for collection sync messages
+
+- Added optional `totalCount` field to `snapshot` and `delta` server messages, reporting the total number of matching entities (ignoring `top`/`skip` pagination)
+- Added `collection-snapshot` message type that delivers a full re-sync (entries + count) when a collection changes
+
 ## [0.1.1] - 2026-02-19
 
 ### ⬆️ Dependencies

package/esm/server-sync-message.d.ts

@@ -12,6 +12,8 @@ export type ServerSyncMessage = {
     primaryKey?: string;
     mode: 'snapshot';
     data: unknown;
+    /** Total count of matching entities (ignoring top/skip). Included for collection subscriptions. */
+    totalCount?: number;
     version: SyncVersion;
 } | {
     type: 'subscribed';
@@ -22,6 +24,8 @@ export type ServerSyncMessage = {
     primaryKey?: string;
     mode: 'delta';
     changes: SyncChangeEntry[];
+    /** Total count of matching entities (ignoring top/skip). Included for collection subscriptions. */
+    totalCount?: number;
     version: SyncVersion;
 } | {
     type: 'entity-added';
@@ -39,6 +43,12 @@ export type ServerSyncMessage = {
     subscriptionId: string;
     id: unknown;
     version: SyncVersion;
+} | {
+    type: 'collection-snapshot';
+    subscriptionId: string;
+    data: unknown[];
+    totalCount: number;
+    version: SyncVersion;
 } | {
     type: 'subscription-error';
     requestId: string;

package/esm/server-sync-message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server-sync-message.d.ts","sourceRoot":"","sources":["../src/server-sync-message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAEpD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,EAAE,eAAe,EAAE,CAAA;IAC1B,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,cAAc,CAAA;IACpB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,EAAE,EAAE,OAAO,CAAA;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,EAAE,EAAE,OAAO,CAAA;IACX,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,oBAAoB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA"}
+{"version":3,"file":"server-sync-message.d.ts","sourceRoot":"","sources":["../src/server-sync-message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAEpD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,mGAAmG;IACnG,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,EAAE,eAAe,EAAE,CAAA;IAC1B,mGAAmG;IACnG,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,cAAc,CAAA;IACpB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,EAAE,EAAE,OAAO,CAAA;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,EAAE,EAAE,OAAO,CAAA;IACX,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,qBAAqB,CAAA;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,OAAO,EAAE,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,WAAW,CAAA;CACrB,GACD;IACE,IAAI,EAAE,oBAAoB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furystack/entity-sync",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "description": "Shared protocol types for FuryStack entity synchronization",
   "type": "module",
   "scripts": {
@@ -37,7 +37,7 @@
   },
   "homepage": "https://github.com/furystack/furystack",
   "dependencies": {
-    "@furystack/core": "^15.1.0"
+    "@furystack/core": "^15.2.0"
   },
   "devDependencies": {
     "typescript": "^5.9.3"

package/src/server-sync-message.ts

@@ -14,6 +14,8 @@ export type ServerSyncMessage =
       primaryKey?: string
       mode: 'snapshot'
       data: unknown
+      /** Total count of matching entities (ignoring top/skip). Included for collection subscriptions. */
+      totalCount?: number
       version: SyncVersion
     }
   | {
@@ -25,6 +27,8 @@ export type ServerSyncMessage =
       primaryKey?: string
       mode: 'delta'
       changes: SyncChangeEntry[]
+      /** Total count of matching entities (ignoring top/skip). Included for collection subscriptions. */
+      totalCount?: number
       version: SyncVersion
     }
   | {
@@ -46,6 +50,13 @@ export type ServerSyncMessage =
       id: unknown
       version: SyncVersion
     }
+  | {
+      type: 'collection-snapshot'
+      subscriptionId: string
+      data: unknown[]
+      totalCount: number
+      version: SyncVersion
+    }
   | {
       type: 'subscription-error'
       requestId: string