@zlink-systems/stream-wire 0.26.0 → 0.28.0

package/dist/esm/index.d.ts

@@ -1,3 +1,4 @@
+export { defaultMaxDecompressedPayloadSize } from './lz4-pickle';
 export interface ZLinkStreamWireFrame {
     readonly header: Uint8Array;
     readonly payload: Uint8Array;
@@ -9,6 +10,69 @@ export declare enum ZlinkStreamCodec {
     MessagePack = 2,
     Protobuf = 3
 }
+export declare enum ZlinkStreamMessageKind {
+    Send = 1,
+    Request = 2,
+    Response = 3,
+    Error = 4,
+    Control = 5
+}
+export declare enum ZlinkStreamHeaderFlags {
+    None = 0,
+    HasRequestSeq = 1,
+    HasMetadata = 2,
+    PayloadCompressed = 4,
+    HasCorrelationId = 8,
+    HasFlowId = 16,
+    HasActorSlot = 32
+}
+export declare enum ZlinkStreamCloseReasonCode {
+    ClientClose = 1,
+    IdleTimeout = 2,
+    HeartbeatTimeout = 3,
+    ServerDrain = 4,
+    ProtocolError = 5,
+    TransportError = 6
+}
+export type ZlinkStreamCloseReason = keyof typeof ZlinkStreamCloseReasonCode;
+export declare function isStreamWireMessageKind(value: number): boolean;
+export declare function isStreamWireCodec(value: number): boolean;
+export declare const UINT64_BYTES = 8;
+export declare const UINT64_MAX = 18446744073709551615n;
+export declare const UINT32_MAX = 4294967295;
+export declare const ZLINK_STREAM_FRAME_PREFIX_BYTES: number;
+export declare const ZLINK_STREAM_MAX_PACKET_NAME_BYTES = 255;
+export declare const ZLINK_STREAM_MAX_METADATA_BYTES = 1024;
+export declare function encodeStreamWireActorBoundPayload(actorSlot: number, actorId: string): Uint8Array;
+export declare function decodeStreamWireActorBoundPayload(payload: Uint8Array): {
+    readonly slot: number;
+    readonly actorId: string;
+};
+export declare function encodeStreamWireActorUnboundPayload(actorSlot: number): Uint8Array;
+export declare function decodeStreamWireActorUnboundPayload(payload: Uint8Array): number;
+export declare function encodeStreamWireSessionClosingPayload(reasonCode: number, diagnostic?: string): Uint8Array;
+export declare function decodeStreamWireSessionClosing(payload: Uint8Array): {
+    readonly closeReason: ZlinkStreamCloseReason;
+    readonly diagnostic?: string;
+};
+export declare function splitStreamWireFrames(chunk: Uint8Array): readonly Uint8Array[];
+/** @internal Reserved packet name prefix owned by the stream protocol. */
+export declare const ZLINK_STREAM_RESERVED_PACKET_NAME_PREFIX = "$zlink.";
+export declare const ZlinkStreamControlPacket: Readonly<{
+    readonly HeartbeatPing: "$zlink.heartbeat.ping";
+    readonly HeartbeatPong: "$zlink.heartbeat.pong";
+    readonly ActorBound: "$zlink.actor.bound";
+    readonly ActorUnbound: "$zlink.actor.unbound";
+    readonly SessionClosing: "session-closing";
+}>;
+export declare const ZlinkStreamContentType: Readonly<{
+    readonly Raw: "application/octet-stream";
+    readonly Json: "application/json";
+    readonly MessagePack: "application/x-msgpack";
+    readonly Protobuf: "application/x-protobuf";
+}>;
+export declare function streamCodecContentType(codec: ZlinkStreamCodec): string;
+export declare function streamCodecForContentType(contentType: string): ZlinkStreamCodec;
 export interface ZLinkStreamWireHeader {
     readonly kind: number;
     readonly codec: number;
@@ -34,6 +98,8 @@ export declare function decodeStreamWireFrame(frame: Uint8Array): ZLinkStreamWir
 export declare function tryDecodeStreamWireFrame(frame: Uint8Array): ZLinkStreamWireFrame | undefined;
 export declare function encodeStreamWireHeader(header: ZLinkStreamWireHeader, flagOverrides?: ZLinkStreamWireHeaderFlags): Uint8Array;
 export declare function decodeStreamWireHeader(header: Uint8Array, flagOverrides?: ZLinkStreamWireHeaderFlags, includeFlow?: boolean): ZLinkStreamWireHeader;
+/** Standalone metadata includes its count byte even when the map is empty. */
+export declare function streamWireMetadataSize(metadata: ReadonlyMap<string, string>): number;
 export declare function encodeStreamWireMetadata(metadata: ReadonlyMap<string, string>): Uint8Array;
 export declare function decodeStreamWireMetadata(metadata: Uint8Array): Map<string, string>;
 export declare function lz4PickleUncompressed(payload: Uint8Array): Uint8Array;
@@ -41,3 +107,5 @@ export declare function lz4PickledLength(payload: Uint8Array): number;
 export declare function lz4UnpicklePayload(payload: Uint8Array, maxDecompressedSize?: number): Uint8Array;
 export declare function utf8Encode(value: string): Uint8Array;
 export declare function utf8Decode(value: Uint8Array): string;
+/** @internal Shared packet name structure validation for the connector. */
+export declare function validateStreamWirePacketName(name: string): Uint8Array;