@zlink-systems/stream-wire 0.22.0 → 0.23.0

package/dist/esm/index.d.ts

@@ -19,12 +19,14 @@ export interface ZLinkStreamWireHeader {
     readonly correlationId?: string;
     readonly flowId?: string;
     readonly flowOrigin?: number;
+    readonly actorSlot?: number;
 }
 export interface ZLinkStreamWireHeaderFlags {
     readonly hasRequestSeq: number;
     readonly hasMetadata: number;
     readonly hasCorrelationId: number;
     readonly hasFlowId: number;
+    readonly hasActorSlot: number;
 }
 export declare const ZLINK_STREAM_FORMAT_MARKER = 242;
 export declare function encodeStreamWireFrame(header: Uint8Array, payload: Uint8Array): Uint8Array;

package/dist/esm/index.mjs

@@ -120,7 +120,8 @@ var defaultHeaderFlags = {
   hasRequestSeq: 1,
   hasMetadata: 2,
   hasCorrelationId: 8,
-  hasFlowId: 16
+  hasFlowId: 16,
+  hasActorSlot: 32
 };
 var ZLINK_STREAM_FORMAT_MARKER = 242;
 var ZLINK_STREAM_RESPONSE_KIND = 3;
@@ -181,6 +182,7 @@ function encodeStreamWireHeader(header, flagOverrides) {
   }
   const hasCorrelation = correlationBytes !== void 0;
   const hasFlow = header.flowId !== void 0 || header.flowOrigin !== void 0;
+  const hasActorSlot = header.actorSlot !== void 0;
   if (hasFlow && (header.flowId === void 0 || header.flowOrigin === void 0)) {
     throw new Error("Stream flow id and origin must be provided together.");
   }
@@ -188,13 +190,17 @@ function encodeStreamWireHeader(header, flagOverrides) {
   if (header.flowOrigin !== void 0 && ![1, 2, 3, 4].includes(header.flowOrigin)) {
     throw new Error("Stream flow origin is invalid.");
   }
+  if (header.actorSlot !== void 0 && (!Number.isInteger(header.actorSlot) || header.actorSlot < 1 || header.actorSlot > 65535)) {
+    throw new Error("Stream actor slot is invalid.");
+  }
   let headerFlags = header.flags;
   headerFlags = hasRequestSeq ? headerFlags | flags.hasRequestSeq : headerFlags & ~flags.hasRequestSeq;
   headerFlags = hasMetadata ? headerFlags | flags.hasMetadata : headerFlags & ~flags.hasMetadata;
   headerFlags = hasCorrelation ? headerFlags | flags.hasCorrelationId : headerFlags & ~flags.hasCorrelationId;
   headerFlags = hasFlow ? headerFlags | flags.hasFlowId : headerFlags & ~flags.hasFlowId;
+  headerFlags = hasActorSlot ? headerFlags | flags.hasActorSlot : headerFlags & ~flags.hasActorSlot;
   const metadataBytes = hasMetadata ? encodeStreamWireMetadata(header.metadata) : new Uint8Array();
-  const size = 4 + (hasRequestSeq ? 8 : 0) + 1 + nameBytes.length + (hasMetadata ? 2 + metadataBytes.length : 0) + (hasCorrelation ? 1 + correlationBytes.length : 0) + (hasFlow ? 37 : 0);
+  const size = 4 + (hasRequestSeq ? 8 : 0) + 1 + nameBytes.length + (hasMetadata ? 2 + metadataBytes.length : 0) + (hasCorrelation ? 1 + correlationBytes.length : 0) + (hasFlow ? 37 : 0) + (hasActorSlot ? 2 : 0);
   const buffer = new Uint8Array(size);
   let offset = 0;
   buffer[offset++] = ZLINK_STREAM_FORMAT_MARKER;
@@ -227,6 +233,9 @@ function encodeStreamWireHeader(header, flagOverrides) {
     offset += 36;
     buffer[offset++] = header.flowOrigin;
   }
+  if (hasActorSlot) {
+    writeUInt16BE(buffer, offset, header.actorSlot);
+  }
   return buffer;
 }
 function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
@@ -245,7 +254,8 @@ function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
   const hasMetadata = (headerFlags & flags.hasMetadata) !== 0;
   const hasCorrelation = (headerFlags & flags.hasCorrelationId) !== 0;
   const hasFlow = (headerFlags & flags.hasFlowId) !== 0;
-  if ((headerFlags & ~31) !== 0) {
+  const hasActorSlot = (headerFlags & flags.hasActorSlot) !== 0;
+  if ((headerFlags & ~63) !== 0) {
     throw new Error("Unknown mandatory stream header flag.");
   }
   let requestSeq;
@@ -300,6 +310,17 @@ function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
     }
     flowOrigin = includeFlow ? decodedFlowOrigin : void 0;
   }
+  let actorSlot;
+  if (hasActorSlot) {
+    if (header.length - offset < 2) {
+      throw new Error("Stream actor slot is incomplete.");
+    }
+    actorSlot = readUInt16BE(header, offset);
+    if (actorSlot === 0) {
+      throw new Error("Stream actor slot must not be zero.");
+    }
+    offset += 2;
+  }
   if (offset !== header.length) {
     throw new Error("Stream header has trailing bytes.");
   }
@@ -312,7 +333,8 @@ function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
     metadata: decodedMetadata.metadata,
     correlationId,
     flowId,
-    flowOrigin
+    flowOrigin,
+    actorSlot
   };
 }
 function validateFlowId(flowId) {

package/dist/index.d.ts

@@ -19,12 +19,14 @@ export interface ZLinkStreamWireHeader {
     readonly correlationId?: string;
     readonly flowId?: string;
     readonly flowOrigin?: number;
+    readonly actorSlot?: number;
 }
 export interface ZLinkStreamWireHeaderFlags {
     readonly hasRequestSeq: number;
     readonly hasMetadata: number;
     readonly hasCorrelationId: number;
     readonly hasFlowId: number;
+    readonly hasActorSlot: number;
 }
 export declare const ZLINK_STREAM_FORMAT_MARKER = 242;
 export declare function encodeStreamWireFrame(header: Uint8Array, payload: Uint8Array): Uint8Array;

package/dist/index.js

@@ -30,7 +30,8 @@ const defaultHeaderFlags = {
     hasRequestSeq: 0x01,
     hasMetadata: 0x02,
     hasCorrelationId: 0x08,
-    hasFlowId: 0x10
+    hasFlowId: 0x10,
+    hasActorSlot: 0x20
 };
 exports.ZLINK_STREAM_FORMAT_MARKER = 0xf2;
 const ZLINK_STREAM_RESPONSE_KIND = 3;
@@ -94,6 +95,7 @@ function encodeStreamWireHeader(header, flagOverrides) {
     }
     const hasCorrelation = correlationBytes !== undefined;
     const hasFlow = header.flowId !== undefined || header.flowOrigin !== undefined;
+    const hasActorSlot = header.actorSlot !== undefined;
     if (hasFlow && (header.flowId === undefined || header.flowOrigin === undefined)) {
         throw new Error('Stream flow id and origin must be provided together.');
     }
@@ -102,6 +104,10 @@ function encodeStreamWireHeader(header, flagOverrides) {
     if (header.flowOrigin !== undefined && ![1, 2, 3, 4].includes(header.flowOrigin)) {
         throw new Error('Stream flow origin is invalid.');
     }
+    if (header.actorSlot !== undefined &&
+        (!Number.isInteger(header.actorSlot) || header.actorSlot < 1 || header.actorSlot > 0xffff)) {
+        throw new Error('Stream actor slot is invalid.');
+    }
     let headerFlags = header.flags;
     headerFlags = hasRequestSeq
         ? headerFlags | flags.hasRequestSeq
@@ -111,6 +117,7 @@ function encodeStreamWireHeader(header, flagOverrides) {
         ? headerFlags | flags.hasCorrelationId
         : headerFlags & ~flags.hasCorrelationId;
     headerFlags = hasFlow ? headerFlags | flags.hasFlowId : headerFlags & ~flags.hasFlowId;
+    headerFlags = hasActorSlot ? headerFlags | flags.hasActorSlot : headerFlags & ~flags.hasActorSlot;
     const metadataBytes = hasMetadata ? encodeStreamWireMetadata(header.metadata) : new Uint8Array();
     const size = 4 +
         (hasRequestSeq ? 8 : 0) +
@@ -118,7 +125,8 @@ function encodeStreamWireHeader(header, flagOverrides) {
         nameBytes.length +
         (hasMetadata ? 2 + metadataBytes.length : 0) +
         (hasCorrelation ? 1 + correlationBytes.length : 0) +
-        (hasFlow ? 37 : 0);
+        (hasFlow ? 37 : 0) +
+        (hasActorSlot ? 2 : 0);
     const buffer = new Uint8Array(size);
     let offset = 0;
     buffer[offset++] = exports.ZLINK_STREAM_FORMAT_MARKER;
@@ -151,6 +159,9 @@ function encodeStreamWireHeader(header, flagOverrides) {
         offset += 36;
         buffer[offset++] = header.flowOrigin;
     }
+    if (hasActorSlot) {
+        writeUInt16BE(buffer, offset, header.actorSlot);
+    }
     return buffer;
 }
 function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
@@ -169,7 +180,8 @@ function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
     const hasMetadata = (headerFlags & flags.hasMetadata) !== 0;
     const hasCorrelation = (headerFlags & flags.hasCorrelationId) !== 0;
     const hasFlow = (headerFlags & flags.hasFlowId) !== 0;
-    if ((headerFlags & ~0x1f) !== 0) {
+    const hasActorSlot = (headerFlags & flags.hasActorSlot) !== 0;
+    if ((headerFlags & ~0x3f) !== 0) {
         throw new Error('Unknown mandatory stream header flag.');
     }
     let requestSeq;
@@ -226,6 +238,17 @@ function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
         }
         flowOrigin = includeFlow ? decodedFlowOrigin : undefined;
     }
+    let actorSlot;
+    if (hasActorSlot) {
+        if (header.length - offset < 2) {
+            throw new Error('Stream actor slot is incomplete.');
+        }
+        actorSlot = readUInt16BE(header, offset);
+        if (actorSlot === 0) {
+            throw new Error('Stream actor slot must not be zero.');
+        }
+        offset += 2;
+    }
     if (offset !== header.length) {
         throw new Error('Stream header has trailing bytes.');
     }
@@ -238,7 +261,8 @@ function decodeStreamWireHeader(header, flagOverrides, includeFlow = true) {
         metadata: decodedMetadata.metadata,
         correlationId,
         flowId,
-        flowOrigin
+        flowOrigin,
+        actorSlot
     };
 }
 function validateFlowId(flowId) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zlink-systems/stream-wire",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {
     "type": "git",