@gonvex/protocol 0.1.18 → 0.1.20

package/README.md

@@ -29,6 +29,8 @@ The package includes:
 - JSON-safe value types
 - function manifest types
 - WebSocket client and server message unions
+- live-query result, progress, patch, and revision frames
+- durable sync open/batch-open, snapshot, delta, reset, ready, and cursor types
 - browser telemetry and message trace types
 
 ## Related Packages

package/dist/index.d.ts

@@ -77,11 +77,40 @@ export type BrowserTelemetryInfo = {
 export type QueryCacheDirective = {
     protocolVersion: 1;
     scope: string;
+    /**
+     * Visibility-only scope (project/tenant/user/permissions, no code epoch)
+     * under which sync collections are persisted and resumed. Unlike `scope`,
+     * it survives deploys; resume safety comes from the server's authoritative
+     * reconcile. Absent on runtimes that predate deploy-stable sync scopes.
+     */
+    syncScope?: string;
     epoch: string;
     maxAgeMs: number;
 };
 export type ServerCapabilities = {
+    /** WebSocket protocol generation implemented by this runtime. */
+    protocolVersion?: number;
+    /** Exact runtime build identifier, normally the deployed Git commit SHA. */
+    runtimeVersion?: string;
     syncBatch?: 1;
+    /** sync.ready frames always carry a collection integrity digest. */
+    syncIntegrity?: 1;
+    /** Server accepts `query.subscribeMany` batched subscription frames. */
+    queryBatch?: 1;
+    /** Server accepts `mutation.callMany` batched offline-queue flushes. */
+    mutationBatch?: 1;
+};
+export type QuerySubscribeRequest = {
+    id: string;
+    path: string;
+    args: JsonValue;
+    cacheRevision?: string;
+};
+export type MutationCallRequest = {
+    id: string;
+    path: string;
+    args: JsonValue;
+    trace?: MessageTrace;
 };
 export type SyncOpenRequest = {
     id: string;
@@ -89,12 +118,16 @@ export type SyncOpenRequest = {
     args: JsonValue;
     cursor?: SyncCursor;
     keys?: string[];
+    hashes?: Record<string, string>;
+    digest?: string;
+    fullIntegrity?: boolean;
 };
 export type SyncReady = {
     id: string;
     path?: string;
     cursor: SyncCursor;
     mode?: "eager" | "progressive";
+    digest?: string;
 };
 export type GonvexManifest = {
     project: string;
@@ -108,6 +141,7 @@ export type ClientMessage = {
     token?: string;
     project?: string;
     tenant?: string;
+    device?: BrowserTelemetryInfo;
 } | {
     type: "query.subscribe";
     id: string;
@@ -124,9 +158,15 @@ export type ClientMessage = {
     args: JsonValue;
     cursor?: SyncCursor;
     keys?: string[];
+    hashes?: Record<string, string>;
+    digest?: string;
+    fullIntegrity?: boolean;
 } | {
     type: "sync.openMany";
     opens: SyncOpenRequest[];
+} | {
+    type: "query.subscribeMany";
+    subscribes: QuerySubscribeRequest[];
 } | {
     type: "sync.close";
     id: string;
@@ -136,6 +176,9 @@ export type ClientMessage = {
     path: string;
     args: JsonValue;
     trace?: MessageTrace;
+} | {
+    type: "mutation.callMany";
+    calls: MutationCallRequest[];
 } | {
     type: "action.call";
     id: string;
@@ -216,6 +259,7 @@ export type ServerMessage = {
     mode?: "eager" | "progressive";
     maxRows?: number;
     maxBytes?: number;
+    hashes?: Record<string, string>;
 } | {
     type: "sync.delta";
     id: string;
@@ -224,16 +268,28 @@ export type ServerMessage = {
     upserts?: JsonValue[];
     deleted?: string[];
     mutationIds?: string[];
+    hashes?: Record<string, string>;
+    digest?: string;
 } | ({
     type: "sync.ready";
+    digest?: string;
 } & SyncReady) | {
     type: "sync.readyMany";
     ready: SyncReady[];
+} | {
+    type: "sync.needHashes";
+    id: string;
+    path?: string;
+} | {
+    type: "sync.syncing";
+    id: string;
+    path?: string;
+    reason: "disconnected" | "reconciling" | "listener-reconnecting" | "integrity-reconciling";
 } | {
     type: "sync.reset";
     id: string;
     path?: string;
-    reason: "cursor-expired" | "definition-changed" | "visibility-changed" | "recover";
+    reason: "cursor-expired" | "definition-changed" | "visibility-changed" | "integrity-mismatch" | "integrity-missing" | "recover";
 } | {
     type: "sync.error";
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gonvex/protocol",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "type": "module",
   "publishConfig": {
     "access": "public"