@nmtjs/msgpack-format 0.15.0-beta.24

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Denys Ilchyshyn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# NeemataJS - RPC application server for real-time applications (proof of concept)
+
+### Built with following in mind:
+- transport-agnostic (like WebSockets, WebTransport, .etc)
+- format-agnostic (like JSON, MessagePack, BSON, .etc)
+- binary data streaming and event subscriptions
+- contract-based API
+- end-to-end type safety
+- CPU-intensive task execution on separate workers

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@nmtjs/msgpack-format",
+  "type": "module",
+  "exports": {
+    "./client": "./dist/client.js",
+    "./server": "./dist/server.js"
+  },
+  "dependencies": {
+    "@msgpack/msgpack": "^3.1.3",
+    "@nmtjs/common": "0.15.0-beta.24",
+    "@nmtjs/protocol": "0.15.0-beta.24"
+  },
+  "peerDependencies": {
+    "@nmtjs/protocol": "0.15.0-beta.24",
+    "@nmtjs/common": "0.15.0-beta.24"
+  },
+  "files": [
+    "dist",
+    "src",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "version": "0.15.0-beta.24",
+  "scripts": {
+    "clean-build": "rm -rf ./dist"
+  }
+}

package/src/client.ts

@@ -0,0 +1,72 @@
+import type { DecodeRPCContext } from '@nmtjs/protocol'
+import type {
+  EncodeRPCContext,
+  ProtocolClientBlobStream,
+  ProtocolServerBlobStream,
+} from '@nmtjs/protocol/client'
+import { decode, encode } from '@msgpack/msgpack'
+import { ProtocolBlob } from '@nmtjs/protocol'
+import { BaseClientFormat } from '@nmtjs/protocol/client'
+
+import { decodeStreamExt, encodeStreamExt, extensionCodec } from './common.ts'
+
+/**
+ * MessagePack encoding format with support for Neemata streams.
+ * Uses extension types to embed stream ID + metadata directly,
+ * eliminating the need for separate stream metadata chunks.
+ */
+export class MsgpackFormat extends BaseClientFormat {
+  contentType = 'application/msgpack'
+
+  encode(data: any): Uint8Array {
+    return encode(data, { ignoreUndefined: true })
+  }
+
+  encodeRPC(
+    data: unknown,
+    context: EncodeRPCContext<ProtocolClientBlobStream>,
+  ) {
+    if (typeof data === 'undefined') {
+      return new Uint8Array(0)
+    }
+
+    return encode(data, {
+      extensionCodec,
+      ignoreUndefined: true,
+      context: {
+        encodeStream: (object: unknown): Uint8Array | null => {
+          if (object instanceof ProtocolBlob) {
+            const stream = context.addStream(object)
+            return encodeStreamExt(stream.id, stream.metadata)
+          }
+          return null
+        },
+      },
+    })
+  }
+
+  decode(data: ArrayBufferView): any {
+    return decode(data)
+  }
+
+  decodeRPC(
+    buffer: ArrayBufferView,
+    context: DecodeRPCContext<
+      (options?: { signal?: AbortSignal }) => ProtocolServerBlobStream
+    >,
+  ) {
+    if (buffer.byteLength === 0) {
+      return undefined
+    }
+
+    return decode(buffer, {
+      extensionCodec,
+      context: {
+        decodeStream: (data: Uint8Array) => {
+          const { id, metadata } = decodeStreamExt(data)
+          return context.addStream(id, metadata)
+        },
+      },
+    })
+  }
+}

package/src/common.ts

@@ -0,0 +1,49 @@
+import type { ProtocolBlobMetadata } from '@nmtjs/protocol'
+import { decode, ExtensionCodec, encode } from '@msgpack/msgpack'
+
+// Extension type code for blob streams
+export const STREAM_EXT_TYPE = 0x01
+
+// Encodes stream ID + metadata into extension type payload
+export const encodeStreamExt = (
+  id: number,
+  metadata: ProtocolBlobMetadata,
+): Uint8Array => {
+  // Format: [id: u32 BE][metadata: msgpack]
+  const metadataBuffer = encode(metadata)
+  const buffer = new Uint8Array(4 + metadataBuffer.byteLength)
+  const view = new DataView(buffer.buffer)
+  view.setUint32(0, id, false) // big-endian
+  buffer.set(metadataBuffer, 4)
+  return buffer
+}
+
+// Decodes stream ID + metadata from extension type payload
+export const decodeStreamExt = (
+  data: Uint8Array,
+): { id: number; metadata: ProtocolBlobMetadata } => {
+  const view = new DataView(data.buffer, data.byteOffset, data.byteLength)
+  const id = view.getUint32(0, false)
+  const metadata = decode(data.subarray(4)) as ProtocolBlobMetadata
+  return { id, metadata }
+}
+
+// Context type for encode/decode operations
+export type MsgpackContext = {
+  encodeStream?: (object: unknown) => Uint8Array | null
+  decodeStream?: (data: Uint8Array) => unknown
+}
+
+// Shared extension codec - reused across all encode/decode operations
+// Uses msgpack's context feature to pass dynamic encode/decode handlers
+export const extensionCodec = new ExtensionCodec<MsgpackContext>()
+
+extensionCodec.register({
+  type: STREAM_EXT_TYPE,
+  encode: (object: unknown, context: MsgpackContext): Uint8Array | null => {
+    return context.encodeStream!(object) ?? null
+  },
+  decode: (data: Uint8Array, _extType: number, context: MsgpackContext) => {
+    return context.decodeStream!(data)
+  },
+})

package/src/server.ts

@@ -0,0 +1,84 @@
+import type { DecodeRPCContext, EncodeRPCStreams } from '@nmtjs/protocol'
+import type { ProtocolClientStream } from '@nmtjs/protocol/server'
+import { decode, encode } from '@msgpack/msgpack'
+import { ProtocolBlob } from '@nmtjs/protocol'
+import { BaseServerFormat } from '@nmtjs/protocol/server'
+
+import { decodeStreamExt, encodeStreamExt, extensionCodec } from './common.ts'
+
+// Marker class for stream IDs (used internally for msgpack extension encoding)
+class StreamIdMarker {
+  constructor(
+    public readonly streamId: number,
+    public readonly metadata: {
+      type: string
+      size?: number
+      filename?: string
+    },
+  ) {}
+}
+
+export class MsgpackFormat extends BaseServerFormat {
+  contentType = 'application/msgpack'
+  accept = ['application/msgpack']
+
+  encode(data: any) {
+    return typeof data !== 'undefined'
+      ? Buffer.from(encode(data, { ignoreUndefined: true }))
+      : Buffer.alloc(0)
+  }
+
+  encodeBlob(streamId: number, metadata: EncodeRPCStreams[number]) {
+    return new StreamIdMarker(streamId, metadata)
+  }
+
+  encodeRPC(data: unknown, _streams: EncodeRPCStreams) {
+    if (typeof data === 'undefined') {
+      return Buffer.alloc(0)
+    }
+
+    return Buffer.from(
+      encode(data, {
+        extensionCodec,
+        ignoreUndefined: true,
+        context: {
+          encodeStream: (object: unknown): Uint8Array | null => {
+            if (object instanceof StreamIdMarker) {
+              return encodeStreamExt(object.streamId, object.metadata)
+            }
+            if (object instanceof ProtocolBlob && object.encode) {
+              const marker = object.encode(object.metadata) as StreamIdMarker
+              if (marker instanceof StreamIdMarker) {
+                return encodeStreamExt(marker.streamId, marker.metadata)
+              }
+            }
+            return null
+          },
+        },
+      }),
+    )
+  }
+
+  decode(data: Buffer) {
+    return decode(data)
+  }
+
+  decodeRPC(
+    buffer: Buffer,
+    context: DecodeRPCContext<() => ProtocolClientStream>,
+  ) {
+    if (buffer.byteLength === 0) {
+      return undefined
+    }
+
+    return decode(buffer, {
+      extensionCodec,
+      context: {
+        decodeStream: (data: Uint8Array) => {
+          const { id, metadata } = decodeStreamExt(data)
+          return context.addStream(id, metadata)
+        },
+      },
+    })
+  }
+}