@nmtjs/json-format 0.14.4 → 0.15.0-beta.1

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Denis Ilchyshyn
+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:
 

package/README.md

@@ -6,4 +6,4 @@
 - binary data streaming and event subscriptions
 - contract-based API
 - end-to-end type safety
-- CPU-intensive task execution on separate workers
+- CPU-intensive task execution on separate workers

package/package.json

@@ -2,33 +2,27 @@
   "name": "@nmtjs/json-format",
   "type": "module",
   "exports": {
-    "./client": {
-      "types": "./dist/client.d.ts",
-      "import": "./dist/client.js",
-      "module-sync": "./dist/client.js"
-    },
-    "./server": {
-      "types": "./dist/server.d.ts",
-      "import": "./dist/server.js",
-      "module-sync": "./dist/server.js"
-    }
+    "./client": "./dist/client.js",
+    "./server": "./dist/server.js"
   },
   "dependencies": {
-    "@nmtjs/common": "0.14.4",
-    "@nmtjs/protocol": "0.14.4"
+    "@nmtjs/common": "0.15.0-beta.1",
+    "@nmtjs/protocol": "0.15.0-beta.1"
   },
   "peerDependencies": {
-    "@nmtjs/common": "0.14.4",
-    "@nmtjs/protocol": "0.14.4"
+    "@nmtjs/common": "0.15.0-beta.1",
+    "@nmtjs/protocol": "0.15.0-beta.1"
   },
   "files": [
     "dist",
     "LICENSE.md",
     "README.md"
   ],
-  "version": "0.14.4",
+  "version": "0.15.0-beta.1",
   "scripts": {
+    "clean-build": "rm -rf ./dist",
     "build": "tsc",
+    "dev": "tsc --watch",
     "type-check": "tsc --noEmit"
   }
 }

package/dist/client.d.ts

@@ -1,50 +0,0 @@
-import type { DecodeRPCContext, EncodeRPCContext, ProtocolRPC } from '@nmtjs/protocol';
-import type { ProtocolClientBlobStream, ProtocolServerBlobStream } from '@nmtjs/protocol/client';
-import { BaseClientFormat } from '@nmtjs/protocol/client';
-import type { StreamsMetadata } from './common.ts';
-/**
- * Custom JSON encoding format with support for Neemata streams.
- */
-export declare class JsonFormat extends BaseClientFormat {
-    contentType: string;
-    encode(data: any): ArrayBuffer;
-    encodeRPC(rpc: ProtocolRPC, context: EncodeRPCContext): {
-        buffer: ArrayBuffer;
-        streams: Record<number, ProtocolClientBlobStream>;
-    };
-    decode(data: ArrayBuffer): any;
-    decodeRPC(buffer: ArrayBuffer, context: DecodeRPCContext): {
-        callId: number;
-        error: import("@nmtjs/protocol").BaseProtocolError;
-        result?: undefined;
-        streams?: undefined;
-    } | {
-        callId: number;
-        result: any;
-        streams: Record<number, ProtocolServerBlobStream>;
-        error?: undefined;
-    };
-}
-/**
- * Standard JSON encoding format with no Neemata streams support.
- */
-export declare class StandardJsonFormat extends BaseClientFormat {
-    contentType: string;
-    encode(data: any): ArrayBuffer;
-    encodeRPC(rpc: ProtocolRPC): {
-        buffer: ArrayBuffer;
-        streams: Record<number, ProtocolClientBlobStream>;
-    };
-    decode(data: ArrayBuffer): any;
-    decodeRPC(buffer: ArrayBuffer): {
-        callId: number;
-        error: import("@nmtjs/protocol").BaseProtocolError;
-        result?: undefined;
-        streams?: undefined;
-    } | {
-        callId: number;
-        result: StreamsMetadata;
-        streams: Record<number, ProtocolServerBlobStream>;
-        error?: undefined;
-    };
-}

package/dist/client.js

@@ -1,93 +0,0 @@
-import { decodeText, encodeText, ProtocolBlob } from '@nmtjs/protocol';
-import { BaseClientFormat } from '@nmtjs/protocol/client';
-import { deserializeStreamId, isStreamId, serializeStreamId } from "./common.js";
-/**
- * Custom JSON encoding format with support for Neemata streams.
- */
-export class JsonFormat extends BaseClientFormat {
-    contentType = 'application/x-neemata-json';
-    encode(data) {
-        return encodeText(JSON.stringify(data));
-    }
-    encodeRPC(rpc, context) {
-        const { callId, procedure } = rpc;
-        const streamsMetadata = {};
-        const streams = {};
-        const replacer = (_key, value) => {
-            if (value instanceof ProtocolBlob) {
-                const stream = context.addStream(value);
-                streamsMetadata[stream.id] = stream.metadata;
-                streams[stream.id] = stream;
-                return serializeStreamId(stream.id);
-            }
-            return value;
-        };
-        const payload = typeof rpc.payload === 'undefined'
-            ? undefined
-            : JSON.stringify(rpc.payload, replacer);
-        const buffer = typeof payload === 'undefined'
-            ? this.encode([
-                callId,
-                procedure,
-                streamsMetadata,
-            ])
-            : this.encode([
-                callId,
-                procedure,
-                streamsMetadata,
-                payload,
-            ]);
-        return { buffer, streams };
-    }
-    decode(data) {
-        return JSON.parse(decodeText(data));
-    }
-    decodeRPC(buffer, context) {
-        const streams = {};
-        const [callId, error, streamsMetadata, payload] = this.decode(buffer);
-        if (error)
-            return { callId, error };
-        else {
-            const replacer = (_key, value) => {
-                if (typeof value === 'string' && isStreamId(value)) {
-                    const id = deserializeStreamId(value);
-                    const metadata = streamsMetadata[id];
-                    const stream = context.addStream(id, callId, metadata);
-                    streams[id] = stream;
-                    return stream;
-                }
-                return value;
-            };
-            const result = typeof payload === 'undefined'
-                ? undefined
-                : JSON.parse(payload, replacer);
-            return { callId, result, streams };
-        }
-    }
-}
-/**
- * Standard JSON encoding format with no Neemata streams support.
- */
-export class StandardJsonFormat extends BaseClientFormat {
-    contentType = 'application/json';
-    encode(data) {
-        return encodeText(JSON.stringify(data));
-    }
-    encodeRPC(rpc) {
-        const { callId, procedure, payload } = rpc;
-        const streams = {};
-        const buffer = this.encode([callId, procedure, payload]);
-        return { buffer, streams };
-    }
-    decode(data) {
-        return JSON.parse(decodeText(data));
-    }
-    decodeRPC(buffer) {
-        const streams = {};
-        const [callId, error, result] = this.decode(buffer);
-        if (error)
-            return { callId, error };
-        else
-            return { callId, result, streams };
-    }
-}

package/dist/common.d.ts

@@ -1,12 +0,0 @@
-import type { BaseProtocolError, ProtocolBlobMetadata } from '@nmtjs/protocol';
-export declare const serializeStreamId: (id: number) => string;
-export declare const deserializeStreamId: (value: string) => number;
-export declare const isStreamId: (value: any) => boolean | 0;
-export type StreamsMetadata = Record<number, ProtocolBlobMetadata>;
-export type ClientEncodedRPC = [
-    callId: number,
-    procedure: string,
-    streams: StreamsMetadata,
-    payload?: any
-];
-export type ServerEncodedRPC = [callId: number, error: BaseProtocolError] | [callId: number, error: null, streams: StreamsMetadata, payload?: any];

package/dist/common.js

@@ -1,14 +0,0 @@
-// TODO: is this a good way to serialize streams within json?
-const STREAM_SERIALIZE_KEY = '%neemata:stream:%\f';
-export const serializeStreamId = (id) => {
-    return `${STREAM_SERIALIZE_KEY}${id}`;
-};
-export const deserializeStreamId = (value) => {
-    const streamId = value.slice(STREAM_SERIALIZE_KEY.length);
-    return Number.parseInt(streamId);
-};
-export const isStreamId = (value) => {
-    return (typeof value === 'string' &&
-        value.length &&
-        value.startsWith(STREAM_SERIALIZE_KEY));
-};

package/dist/server.d.ts

@@ -1,33 +0,0 @@
-import type { DecodeRPCContext, EncodeRPCContext, ProtocolRPCResponse } from '@nmtjs/protocol';
-import { BaseServerFormat } from '@nmtjs/protocol/server';
-import type { StreamsMetadata } from './common.ts';
-/**
- * Custom JSON encoding format with Neemata streams support.
- */
-export declare class JsonFormat extends BaseServerFormat {
-    contentType: string;
-    accept: string[];
-    encode(data: any): ArrayBuffer;
-    encodeRPC(rpc: ProtocolRPCResponse, context: EncodeRPCContext): ArrayBuffer;
-    decode(data: ArrayBuffer): any;
-    decodeRPC(buffer: ArrayBuffer, context: DecodeRPCContext): {
-        callId: number;
-        procedure: string;
-        payload: any;
-    };
-}
-/**
- * Standard JSON encoding format with no Neemata streams support.
- */
-export declare class StandardJsonFormat extends BaseServerFormat {
-    contentType: string;
-    accept: string[];
-    encode(data: any): ArrayBuffer;
-    encodeRPC(rpc: ProtocolRPCResponse): ArrayBuffer;
-    decode(buffer: ArrayBuffer): any;
-    decodeRPC(buffer: ArrayBuffer): {
-        callId: number;
-        procedure: string;
-        payload: StreamsMetadata;
-    };
-}

package/dist/server.js

@@ -1,77 +0,0 @@
-import { decodeText, encodeText, ProtocolBlob } from '@nmtjs/protocol';
-import { BaseServerFormat } from '@nmtjs/protocol/server';
-import { deserializeStreamId, isStreamId, serializeStreamId } from "./common.js";
-/**
- * Custom JSON encoding format with Neemata streams support.
- */
-export class JsonFormat extends BaseServerFormat {
-    contentType = 'application/x-neemata-json';
-    accept = ['application/x-neemata-json'];
-    encode(data) {
-        return encodeText(JSON.stringify(data));
-    }
-    encodeRPC(rpc, context) {
-        const { callId, error } = rpc;
-        if (error)
-            return this.encode([callId, error]);
-        else {
-            const streams = {};
-            const replacer = (_key, value) => {
-                if (value instanceof ProtocolBlob) {
-                    const stream = context.addStream(value);
-                    streams[stream.id] = stream.metadata;
-                    return serializeStreamId(stream.id);
-                }
-                return value;
-            };
-            const isUndefined = typeof rpc.result === 'undefined';
-            const payload = JSON.stringify(rpc.result, replacer);
-            return this.encode(isUndefined
-                ? [callId, null, streams]
-                : [callId, null, streams, payload]);
-        }
-    }
-    decode(data) {
-        return JSON.parse(decodeText(data));
-    }
-    decodeRPC(buffer, context) {
-        const [callId, procedure, streams, formatPayload] = this.decode(buffer);
-        const replacer = (_key, value) => {
-            if (typeof value === 'string' && isStreamId(value)) {
-                const id = deserializeStreamId(value);
-                const metadata = streams[id];
-                return context.addStream(id, callId, metadata);
-            }
-            return value;
-        };
-        const payload = typeof formatPayload === 'undefined'
-            ? undefined
-            : JSON.parse(formatPayload, replacer);
-        return { callId, procedure, payload };
-    }
-}
-/**
- * Standard JSON encoding format with no Neemata streams support.
- */
-export class StandardJsonFormat extends BaseServerFormat {
-    contentType = 'application/json';
-    accept = ['application/json', 'application/vnd.api+json'];
-    encode(data) {
-        return encodeText(JSON.stringify(data));
-    }
-    encodeRPC(rpc) {
-        const { callId, error } = rpc;
-        if (error)
-            return this.encode([callId, error, null]);
-        else {
-            return this.encode([callId, null, rpc.result]);
-        }
-    }
-    decode(buffer) {
-        return JSON.parse(decodeText(buffer));
-    }
-    decodeRPC(buffer) {
-        const [callId, procedure, payload] = this.decode(buffer);
-        return { callId, procedure, payload };
-    }
-}