@syncular/core 0.15.46 → 0.15.48

package/dist/constants.d.ts

@@ -1,5 +1,11 @@
 /** Protocol constants (SPEC.md §1.2, §9 are normative). */
-/** SSP2 envelope wire version this codec implements. */
-export declare const PROTOCOL_WIRE_VERSION = 1;
+/** Latest SSP2 envelope wire version emitted by current clients. */
+export declare const PROTOCOL_WIRE_VERSION = 2;
+/** Oldest SSP2 envelope wire version accepted during the epoch rollout. */
+export declare const MINIMUM_PROTOCOL_WIRE_VERSION = 1;
+/** Wire versions implemented by the reference codec, oldest first. */
+export declare const SUPPORTED_PROTOCOL_WIRE_VERSIONS: readonly number[];
+/** Whether the reference codec implements this exact wire version. */
+export declare function isSupportedProtocolWireVersion(wireVersion: number): boolean;
 /** Magic bytes opening every SSP2 sync envelope (SPEC.md §1.2). */
 export declare const SYNC_PACK_MAGIC = "SSP2";

package/dist/constants.js

@@ -1,5 +1,17 @@
 /** Protocol constants (SPEC.md §1.2, §9 are normative). */
-/** SSP2 envelope wire version this codec implements. */
-export const PROTOCOL_WIRE_VERSION = 1;
+/** Latest SSP2 envelope wire version emitted by current clients. */
+export const PROTOCOL_WIRE_VERSION = 2;
+/** Oldest SSP2 envelope wire version accepted during the epoch rollout. */
+export const MINIMUM_PROTOCOL_WIRE_VERSION = 1;
+/** Wire versions implemented by the reference codec, oldest first. */
+export const SUPPORTED_PROTOCOL_WIRE_VERSIONS = Object.freeze(Array.from({
+    length: PROTOCOL_WIRE_VERSION - MINIMUM_PROTOCOL_WIRE_VERSION + 1,
+}, (_, index) => MINIMUM_PROTOCOL_WIRE_VERSION + index));
+/** Whether the reference codec implements this exact wire version. */
+export function isSupportedProtocolWireVersion(wireVersion) {
+    return (Number.isInteger(wireVersion) &&
+        wireVersion >= MINIMUM_PROTOCOL_WIRE_VERSION &&
+        wireVersion <= PROTOCOL_WIRE_VERSION);
+}
 /** Magic bytes opening every SSP2 sync envelope (SPEC.md §1.2). */
 export const SYNC_PACK_MAGIC = 'SSP2';

package/dist/frames.d.ts

@@ -1,4 +1,4 @@
-/** Frame type registry for wire version 1 (SPEC.md §1.2). */
+/** Frame type registry for wire versions 1 and 2 (SPEC.md §1.2). */
 export declare const FrameType: {
     readonly END: 0;
     readonly REQ_HEADER: 1;
@@ -21,5 +21,5 @@ export type FrameTypeName = keyof typeof FrameType;
 export declare const REQUEST_FRAME_TYPES: ReadonlySet<number>;
 /** Known response frame types (excluding END). */
 export declare const RESPONSE_FRAME_TYPES: ReadonlySet<number>;
-/** Every frame type with a defined layout in wire version 1. */
+/** Every frame type with a defined layout in wire versions 1 and 2. */
 export declare const KNOWN_FRAME_TYPES: ReadonlySet<number>;

package/dist/frames.js

@@ -1,4 +1,4 @@
-/** Frame type registry for wire version 1 (SPEC.md §1.2). */
+/** Frame type registry for wire versions 1 and 2 (SPEC.md §1.2). */
 export const FrameType = {
     END: 0x00,
     REQ_HEADER: 0x01,
@@ -36,7 +36,7 @@ export const RESPONSE_FRAME_TYPES = new Set([
     FrameType.PUSH_RESULT_DETAILS,
     FrameType.ERROR,
 ]);
-/** Every frame type with a defined layout in wire version 1. */
+/** Every frame type with a defined layout in wire versions 1 and 2. */
 export const KNOWN_FRAME_TYPES = new Set([
     FrameType.END,
     ...REQUEST_FRAME_TYPES,

package/dist/message.d.ts

@@ -4,6 +4,8 @@ export interface ReqHeaderFrame {
     type: 'REQ_HEADER';
     clientId: string;
     schemaVersion: number;
+    /** Wire v2 partition log identity; absent requests epoch acquisition. */
+    logEpoch?: string;
 }
 export interface PushOperation {
     table: string;
@@ -48,6 +50,10 @@ export interface RespHeaderFrame {
     type: 'RESP_HEADER';
     requiredSchemaVersion?: number;
     latestSchemaVersion?: number;
+    /** Required and non-empty on wire v2. */
+    logEpoch?: string;
+    /** Required on wire v2. True produces a header-only reset response. */
+    resetRequired?: boolean;
 }
 /** §7.3.2: a server-issued auth lease delivered to the client (opaque). */
 export interface LeaseFrame {

package/dist/message.js

@@ -12,7 +12,7 @@
  * grammar, retained so canonical re-encoding stays byte-exact).
  */
 import { ByteReader, ByteWriter, readStringListMap, readStringMap, utf8Encode, writeStringListMap, writeStringMap, } from './bytes.js';
-import { PROTOCOL_WIRE_VERSION, SYNC_PACK_MAGIC } from './constants.js';
+import { isSupportedProtocolWireVersion, SYNC_PACK_MAGIC } from './constants.js';
 import { DecodeError } from './errors.js';
 import { FrameType, KNOWN_FRAME_TYPES, REQUEST_FRAME_TYPES, RESPONSE_FRAME_TYPES, } from './frames.js';
 import { normalizeRejectionDetails, } from './rejection-details.js';
@@ -33,14 +33,27 @@ function requireJsonDocument(raw, what) {
 // ---------------------------------------------------------------------------
 // Frame payload decoders (each consumes exactly the frame payload)
 // ---------------------------------------------------------------------------
-function decodeReqHeader(r) {
+function decodeReqHeader(r, wireVersion) {
     const clientId = r.str();
     if (clientId.length === 0)
         invalid('REQ_HEADER.clientId must be non-empty');
     const schemaVersion = r.i32();
     if (schemaVersion < 1)
         invalid('REQ_HEADER.schemaVersion must be >= 1');
-    return { type: 'REQ_HEADER', clientId, schemaVersion };
+    const logEpoch = wireVersion >= 2
+        ? r.opt(() => {
+            const value = r.str();
+            if (value.length === 0)
+                invalid('REQ_HEADER.logEpoch must be non-empty');
+            return value;
+        })
+        : undefined;
+    return {
+        type: 'REQ_HEADER',
+        clientId,
+        schemaVersion,
+        ...(logEpoch !== undefined ? { logEpoch } : {}),
+    };
 }
 function decodePushCommit(r) {
     const clientCommitId = r.str();
@@ -114,13 +127,20 @@ function decodeSubscription(r) {
         ...(bootstrapState !== undefined ? { bootstrapState } : {}),
     };
 }
-function decodeRespHeader(r) {
+function decodeRespHeader(r, wireVersion) {
     const requiredSchemaVersion = r.opt(() => r.i32());
     const latestSchemaVersion = r.opt(() => r.i32());
+    const logEpoch = wireVersion >= 2 ? r.str() : undefined;
+    if (logEpoch !== undefined && logEpoch.length === 0) {
+        invalid('RESP_HEADER.logEpoch must be non-empty');
+    }
+    const resetRequired = wireVersion >= 2 ? r.bool() : undefined;
     return {
         type: 'RESP_HEADER',
         ...(requiredSchemaVersion !== undefined ? { requiredSchemaVersion } : {}),
         ...(latestSchemaVersion !== undefined ? { latestSchemaVersion } : {}),
+        ...(logEpoch !== undefined ? { logEpoch } : {}),
+        ...(resetRequired !== undefined ? { resetRequired } : {}),
     };
 }
 function decodeLease(r) {
@@ -353,12 +373,12 @@ function decodeErrorFrame(r) {
         ...(details !== undefined ? { details } : {}),
     };
 }
-function decodeRequestFrame(frameType, payload) {
+function decodeRequestFrame(frameType, payload, wireVersion) {
     const r = new ByteReader(payload);
     let frame;
     switch (frameType) {
         case FrameType.REQ_HEADER:
-            frame = decodeReqHeader(r);
+            frame = decodeReqHeader(r, wireVersion);
             break;
         case FrameType.PUSH_COMMIT:
             frame = decodePushCommit(r);
@@ -378,12 +398,12 @@ function decodeRequestFrame(frameType, payload) {
     r.expectFullyConsumed(`${frame.type} frame payload`);
     return frame;
 }
-function decodeResponseFrame(frameType, payload) {
+function decodeResponseFrame(frameType, payload, wireVersion) {
     const r = new ByteReader(payload);
     let frame;
     switch (frameType) {
         case FrameType.RESP_HEADER:
-            frame = decodeRespHeader(r);
+            frame = decodeRespHeader(r, wireVersion);
             break;
         case FrameType.LEASE:
             frame = decodeLease(r);
@@ -574,7 +594,7 @@ const OP_BYTES = { upsert: 1, delete: 2 };
 const PUSH_STATUS_BYTES = { applied: 1, cached: 2, rejected: 3 };
 const SUB_STATUS_BYTES = { active: 1, revoked: 2, reset: 3 };
 const MEDIA_TYPE_BYTES = { rows: 1, sqlite: 2 };
-function encodeFrame(frame) {
+function encodeFrame(frame, wireVersion) {
     const w = new ByteWriter();
     switch (frame.type) {
         case 'REQ_HEADER': {
@@ -586,6 +606,15 @@ function encodeFrame(frame) {
             }
             w.str(frame.clientId);
             w.i32(frame.schemaVersion);
+            if (wireVersion >= 2) {
+                if (frame.logEpoch === '') {
+                    throw new Error('REQ_HEADER.logEpoch must be non-empty');
+                }
+                w.opt(frame.logEpoch, (v) => w.str(v));
+            }
+            else if (frame.logEpoch !== undefined) {
+                throw new Error('REQ_HEADER.logEpoch requires wireVersion 2');
+            }
             return { frameType: FrameType.REQ_HEADER, payload: w.finish() };
         }
         case 'PUSH_COMMIT': {
@@ -634,6 +663,20 @@ function encodeFrame(frame) {
         case 'RESP_HEADER': {
             w.opt(frame.requiredSchemaVersion, (v) => w.i32(v));
             w.opt(frame.latestSchemaVersion, (v) => w.i32(v));
+            if (wireVersion >= 2) {
+                if (frame.logEpoch === undefined || frame.logEpoch.length === 0) {
+                    throw new Error('RESP_HEADER.logEpoch is required and non-empty');
+                }
+                if (frame.resetRequired === undefined) {
+                    throw new Error('RESP_HEADER.resetRequired is required');
+                }
+                w.str(frame.logEpoch);
+                w.bool(frame.resetRequired);
+            }
+            else if (frame.logEpoch !== undefined ||
+                frame.resetRequired !== undefined) {
+                throw new Error('RESP_HEADER epoch fields require wireVersion 2');
+            }
             return { frameType: FrameType.RESP_HEADER, payload: w.finish() };
         }
         case 'LEASE': {
@@ -788,7 +831,7 @@ function encodeFrame(frame) {
 // Envelope
 // ---------------------------------------------------------------------------
 export function encodeMessage(message) {
-    if (message.wireVersion !== PROTOCOL_WIRE_VERSION) {
+    if (!isSupportedProtocolWireVersion(message.wireVersion)) {
         throw new Error(`unsupported wireVersion ${message.wireVersion}`);
     }
     validateFrameSequence(message);
@@ -798,7 +841,7 @@ export function encodeMessage(message) {
     w.u8(message.msgKind === 'request' ? 0x01 : 0x02);
     w.u8(0x00);
     for (const frame of message.frames) {
-        const { frameType, payload } = encodeFrame(frame);
+        const { frameType, payload } = encodeFrame(frame, message.wireVersion);
         w.u8(frameType);
         w.u32(payload.length);
         w.raw(payload);
@@ -840,7 +883,7 @@ export function decodeMessage(bytes) {
         invalid('bad envelope magic');
     }
     const wireVersion = r.u16();
-    if (wireVersion !== PROTOCOL_WIRE_VERSION) {
+    if (!isSupportedProtocolWireVersion(wireVersion)) {
         invalid(`unsupported wireVersion ${wireVersion}`);
     }
     const kindByte = r.u8();
@@ -854,7 +897,7 @@ export function decodeMessage(bytes) {
         const message = {
             wireVersion,
             msgKind: 'request',
-            frames: readFrames(r, decodeRequestFrame),
+            frames: readFrames(r, (frameType, payload) => decodeRequestFrame(frameType, payload, wireVersion)),
         };
         validateRequestSequence(message.frames);
         return message;
@@ -862,7 +905,7 @@ export function decodeMessage(bytes) {
     const message = {
         wireVersion,
         msgKind: 'response',
-        frames: readFrames(r, decodeResponseFrame),
+        frames: readFrames(r, (frameType, payload) => decodeResponseFrame(frameType, payload, wireVersion)),
     };
     validateResponseSequence(message.frames);
     return message;

package/dist/render.js

@@ -96,6 +96,7 @@ function renderFrame(frame) {
                 type: 'REQ_HEADER',
                 clientId: frame.clientId,
                 schemaVersion: frame.schemaVersion,
+                ...(frame.logEpoch !== undefined ? { logEpoch: frame.logEpoch } : {}),
             };
         case 'PUSH_COMMIT':
             return {
@@ -134,6 +135,10 @@ function renderFrame(frame) {
                 ...(frame.latestSchemaVersion !== undefined
                     ? { latestSchemaVersion: frame.latestSchemaVersion }
                     : {}),
+                ...(frame.logEpoch !== undefined ? { logEpoch: frame.logEpoch } : {}),
+                ...(frame.resetRequired !== undefined
+                    ? { resetRequired: frame.resetRequired }
+                    : {}),
             };
         case 'LEASE':
             return {

package/dist/stream.js

@@ -15,7 +15,7 @@
  * `decodeMessage`.
  */
 import { utf8Encode } from './bytes.js';
-import { PROTOCOL_WIRE_VERSION, SYNC_PACK_MAGIC } from './constants.js';
+import { isSupportedProtocolWireVersion, SYNC_PACK_MAGIC } from './constants.js';
 import { DecodeError } from './errors.js';
 const MAGIC = utf8Encode(SYNC_PACK_MAGIC);
 /** `END` frame type byte (§1.2). */
@@ -89,7 +89,7 @@ export class MessageStreamScanner {
             throw new DecodeError('sync.invalid_request', 'bad envelope magic');
         }
         const wireVersion = b[4] | (b[5] << 8);
-        if (wireVersion !== PROTOCOL_WIRE_VERSION) {
+        if (!isSupportedProtocolWireVersion(wireVersion)) {
             throw new DecodeError('sync.invalid_request', `unsupported wireVersion ${wireVersion}`);
         }
         if (b[6] !== 0x01 && b[6] !== 0x02) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncular/core",
-  "version": "0.15.46",
+  "version": "0.15.48",
   "description": "Core protocol types and shared utilities for the Syncular sync framework",
   "license": "Apache-2.0",
   "author": "Benjamin Kniffler",

package/src/constants.ts

@@ -1,7 +1,30 @@
 /** Protocol constants (SPEC.md §1.2, §9 are normative). */
 
-/** SSP2 envelope wire version this codec implements. */
-export const PROTOCOL_WIRE_VERSION = 1;
+/** Latest SSP2 envelope wire version emitted by current clients. */
+export const PROTOCOL_WIRE_VERSION = 2;
+
+/** Oldest SSP2 envelope wire version accepted during the epoch rollout. */
+export const MINIMUM_PROTOCOL_WIRE_VERSION = 1;
+
+/** Wire versions implemented by the reference codec, oldest first. */
+export const SUPPORTED_PROTOCOL_WIRE_VERSIONS: readonly number[] =
+  Object.freeze(
+    Array.from(
+      {
+        length: PROTOCOL_WIRE_VERSION - MINIMUM_PROTOCOL_WIRE_VERSION + 1,
+      },
+      (_, index) => MINIMUM_PROTOCOL_WIRE_VERSION + index,
+    ),
+  );
+
+/** Whether the reference codec implements this exact wire version. */
+export function isSupportedProtocolWireVersion(wireVersion: number): boolean {
+  return (
+    Number.isInteger(wireVersion) &&
+    wireVersion >= MINIMUM_PROTOCOL_WIRE_VERSION &&
+    wireVersion <= PROTOCOL_WIRE_VERSION
+  );
+}
 
 /** Magic bytes opening every SSP2 sync envelope (SPEC.md §1.2). */
 export const SYNC_PACK_MAGIC = 'SSP2';

package/src/frames.ts

@@ -1,4 +1,4 @@
-/** Frame type registry for wire version 1 (SPEC.md §1.2). */
+/** Frame type registry for wire versions 1 and 2 (SPEC.md §1.2). */
 export const FrameType = {
   END: 0x00,
   REQ_HEADER: 0x01,
@@ -41,7 +41,7 @@ export const RESPONSE_FRAME_TYPES: ReadonlySet<number> = new Set([
   FrameType.ERROR,
 ]);
 
-/** Every frame type with a defined layout in wire version 1. */
+/** Every frame type with a defined layout in wire versions 1 and 2. */
 export const KNOWN_FRAME_TYPES: ReadonlySet<number> = new Set([
   FrameType.END,
   ...REQUEST_FRAME_TYPES,

package/src/message.ts

@@ -20,7 +20,7 @@ import {
   writeStringListMap,
   writeStringMap,
 } from './bytes';
-import { PROTOCOL_WIRE_VERSION, SYNC_PACK_MAGIC } from './constants';
+import { isSupportedProtocolWireVersion, SYNC_PACK_MAGIC } from './constants';
 import { DecodeError } from './errors';
 import {
   FrameType,
@@ -42,6 +42,8 @@ export interface ReqHeaderFrame {
   type: 'REQ_HEADER';
   clientId: string;
   schemaVersion: number;
+  /** Wire v2 partition log identity; absent requests epoch acquisition. */
+  logEpoch?: string;
 }
 
 export interface PushOperation {
@@ -98,6 +100,10 @@ export interface RespHeaderFrame {
   type: 'RESP_HEADER';
   requiredSchemaVersion?: number;
   latestSchemaVersion?: number;
+  /** Required and non-empty on wire v2. */
+  logEpoch?: string;
+  /** Required on wire v2. True produces a header-only reset response. */
+  resetRequired?: boolean;
 }
 
 /** §7.3.2: a server-issued auth lease delivered to the client (opaque). */
@@ -261,12 +267,26 @@ function requireJsonDocument(raw: string, what: string): string {
 // Frame payload decoders (each consumes exactly the frame payload)
 // ---------------------------------------------------------------------------
 
-function decodeReqHeader(r: ByteReader): ReqHeaderFrame {
+function decodeReqHeader(r: ByteReader, wireVersion: number): ReqHeaderFrame {
   const clientId = r.str();
   if (clientId.length === 0) invalid('REQ_HEADER.clientId must be non-empty');
   const schemaVersion = r.i32();
   if (schemaVersion < 1) invalid('REQ_HEADER.schemaVersion must be >= 1');
-  return { type: 'REQ_HEADER', clientId, schemaVersion };
+  const logEpoch =
+    wireVersion >= 2
+      ? r.opt(() => {
+          const value = r.str();
+          if (value.length === 0)
+            invalid('REQ_HEADER.logEpoch must be non-empty');
+          return value;
+        })
+      : undefined;
+  return {
+    type: 'REQ_HEADER',
+    clientId,
+    schemaVersion,
+    ...(logEpoch !== undefined ? { logEpoch } : {}),
+  };
 }
 
 function decodePushCommit(r: ByteReader): PushCommitFrame {
@@ -348,13 +368,20 @@ function decodeSubscription(r: ByteReader): SubscriptionFrame {
   };
 }
 
-function decodeRespHeader(r: ByteReader): RespHeaderFrame {
+function decodeRespHeader(r: ByteReader, wireVersion: number): RespHeaderFrame {
   const requiredSchemaVersion = r.opt(() => r.i32());
   const latestSchemaVersion = r.opt(() => r.i32());
+  const logEpoch = wireVersion >= 2 ? r.str() : undefined;
+  if (logEpoch !== undefined && logEpoch.length === 0) {
+    invalid('RESP_HEADER.logEpoch must be non-empty');
+  }
+  const resetRequired = wireVersion >= 2 ? r.bool() : undefined;
   return {
     type: 'RESP_HEADER',
     ...(requiredSchemaVersion !== undefined ? { requiredSchemaVersion } : {}),
     ...(latestSchemaVersion !== undefined ? { latestSchemaVersion } : {}),
+    ...(logEpoch !== undefined ? { logEpoch } : {}),
+    ...(resetRequired !== undefined ? { resetRequired } : {}),
   };
 }
 
@@ -587,12 +614,13 @@ function decodeErrorFrame(r: ByteReader): ErrorFrame {
 function decodeRequestFrame(
   frameType: number,
   payload: Uint8Array,
+  wireVersion: number,
 ): RequestFrame {
   const r = new ByteReader(payload);
   let frame: RequestFrame;
   switch (frameType) {
     case FrameType.REQ_HEADER:
-      frame = decodeReqHeader(r);
+      frame = decodeReqHeader(r, wireVersion);
       break;
     case FrameType.PUSH_COMMIT:
       frame = decodePushCommit(r);
@@ -618,12 +646,13 @@ function decodeRequestFrame(
 function decodeResponseFrame(
   frameType: number,
   payload: Uint8Array,
+  wireVersion: number,
 ): ResponseFrame {
   const r = new ByteReader(payload);
   let frame: ResponseFrame;
   switch (frameType) {
     case FrameType.RESP_HEADER:
-      frame = decodeRespHeader(r);
+      frame = decodeRespHeader(r, wireVersion);
       break;
     case FrameType.LEASE:
       frame = decodeLease(r);
@@ -822,7 +851,10 @@ const PUSH_STATUS_BYTES = { applied: 1, cached: 2, rejected: 3 } as const;
 const SUB_STATUS_BYTES = { active: 1, revoked: 2, reset: 3 } as const;
 const MEDIA_TYPE_BYTES = { rows: 1, sqlite: 2 } as const;
 
-function encodeFrame(frame: RequestFrame | ResponseFrame): {
+function encodeFrame(
+  frame: RequestFrame | ResponseFrame,
+  wireVersion: number,
+): {
   frameType: number;
   payload: Uint8Array;
 } {
@@ -837,6 +869,14 @@ function encodeFrame(frame: RequestFrame | ResponseFrame): {
       }
       w.str(frame.clientId);
       w.i32(frame.schemaVersion);
+      if (wireVersion >= 2) {
+        if (frame.logEpoch === '') {
+          throw new Error('REQ_HEADER.logEpoch must be non-empty');
+        }
+        w.opt(frame.logEpoch, (v) => w.str(v));
+      } else if (frame.logEpoch !== undefined) {
+        throw new Error('REQ_HEADER.logEpoch requires wireVersion 2');
+      }
       return { frameType: FrameType.REQ_HEADER, payload: w.finish() };
     }
     case 'PUSH_COMMIT': {
@@ -885,6 +925,21 @@ function encodeFrame(frame: RequestFrame | ResponseFrame): {
     case 'RESP_HEADER': {
       w.opt(frame.requiredSchemaVersion, (v) => w.i32(v));
       w.opt(frame.latestSchemaVersion, (v) => w.i32(v));
+      if (wireVersion >= 2) {
+        if (frame.logEpoch === undefined || frame.logEpoch.length === 0) {
+          throw new Error('RESP_HEADER.logEpoch is required and non-empty');
+        }
+        if (frame.resetRequired === undefined) {
+          throw new Error('RESP_HEADER.resetRequired is required');
+        }
+        w.str(frame.logEpoch);
+        w.bool(frame.resetRequired);
+      } else if (
+        frame.logEpoch !== undefined ||
+        frame.resetRequired !== undefined
+      ) {
+        throw new Error('RESP_HEADER epoch fields require wireVersion 2');
+      }
       return { frameType: FrameType.RESP_HEADER, payload: w.finish() };
     }
     case 'LEASE': {
@@ -1050,7 +1105,7 @@ function encodeFrame(frame: RequestFrame | ResponseFrame): {
 // ---------------------------------------------------------------------------
 
 export function encodeMessage(message: SyncMessage): Uint8Array {
-  if (message.wireVersion !== PROTOCOL_WIRE_VERSION) {
+  if (!isSupportedProtocolWireVersion(message.wireVersion)) {
     throw new Error(`unsupported wireVersion ${message.wireVersion}`);
   }
   validateFrameSequence(message);
@@ -1060,7 +1115,7 @@ export function encodeMessage(message: SyncMessage): Uint8Array {
   w.u8(message.msgKind === 'request' ? 0x01 : 0x02);
   w.u8(0x00);
   for (const frame of message.frames) {
-    const { frameType, payload } = encodeFrame(frame);
+    const { frameType, payload } = encodeFrame(frame, message.wireVersion);
     w.u8(frameType);
     w.u32(payload.length);
     w.raw(payload);
@@ -1109,7 +1164,7 @@ export function decodeMessage(bytes: Uint8Array): SyncMessage {
     invalid('bad envelope magic');
   }
   const wireVersion = r.u16();
-  if (wireVersion !== PROTOCOL_WIRE_VERSION) {
+  if (!isSupportedProtocolWireVersion(wireVersion)) {
     invalid(`unsupported wireVersion ${wireVersion}`);
   }
   const kindByte = r.u8();
@@ -1122,7 +1177,9 @@ export function decodeMessage(bytes: Uint8Array): SyncMessage {
     const message: RequestMessage = {
       wireVersion,
       msgKind: 'request',
-      frames: readFrames(r, decodeRequestFrame),
+      frames: readFrames(r, (frameType, payload) =>
+        decodeRequestFrame(frameType, payload, wireVersion),
+      ),
     };
     validateRequestSequence(message.frames);
     return message;
@@ -1130,7 +1187,9 @@ export function decodeMessage(bytes: Uint8Array): SyncMessage {
   const message: ResponseMessage = {
     wireVersion,
     msgKind: 'response',
-    frames: readFrames(r, decodeResponseFrame),
+    frames: readFrames(r, (frameType, payload) =>
+      decodeResponseFrame(frameType, payload, wireVersion),
+    ),
   };
   validateResponseSequence(message.frames);
   return message;

package/src/render.ts

@@ -137,6 +137,7 @@ function renderFrame(frame: RequestFrame | ResponseFrame): JsonValue {
         type: 'REQ_HEADER',
         clientId: frame.clientId,
         schemaVersion: frame.schemaVersion,
+        ...(frame.logEpoch !== undefined ? { logEpoch: frame.logEpoch } : {}),
       };
     case 'PUSH_COMMIT':
       return {
@@ -175,6 +176,10 @@ function renderFrame(frame: RequestFrame | ResponseFrame): JsonValue {
         ...(frame.latestSchemaVersion !== undefined
           ? { latestSchemaVersion: frame.latestSchemaVersion }
           : {}),
+        ...(frame.logEpoch !== undefined ? { logEpoch: frame.logEpoch } : {}),
+        ...(frame.resetRequired !== undefined
+          ? { resetRequired: frame.resetRequired }
+          : {}),
       };
     case 'LEASE':
       return {

package/src/stream.ts

@@ -15,7 +15,7 @@
  * `decodeMessage`.
  */
 import { utf8Encode } from './bytes';
-import { PROTOCOL_WIRE_VERSION, SYNC_PACK_MAGIC } from './constants';
+import { isSupportedProtocolWireVersion, SYNC_PACK_MAGIC } from './constants';
 import { DecodeError } from './errors';
 
 const MAGIC = utf8Encode(SYNC_PACK_MAGIC);
@@ -106,7 +106,7 @@ export class MessageStreamScanner {
       throw new DecodeError('sync.invalid_request', 'bad envelope magic');
     }
     const wireVersion = (b[4] as number) | ((b[5] as number) << 8);
-    if (wireVersion !== PROTOCOL_WIRE_VERSION) {
+    if (!isSupportedProtocolWireVersion(wireVersion)) {
       throw new DecodeError(
         'sync.invalid_request',
         `unsupported wireVersion ${wireVersion}`,