JSON-RPC message builders, type guards, and converters.
Used by the SAES runtime (ActionEvent, ActionDispatcher, transports) and the RPC endpoint dispatcher. Complements http/jsonrpc.ts (schemas) and http/jsonrpc_errors.ts (error infrastructure).
15 declarations
http/jsonrpc_helpers.ts view source
(id: string | number | null, error: { [x: string]: unknown; code: -32700 | -32600 | -32601 | -32602 | -32603 | (number & $brand<"JsonrpcServerErrorCode">); message: string; data?: unknown; }): { ...; } import {create_jsonrpc_error_response} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Creates a JSON-RPC error response message.
idstring | number | nullerrorhttp/jsonrpc_helpers.ts view source
(id: string | number | null, error: unknown): { [x: string]: unknown; jsonrpc: "2.0"; id: string | number | null; error: { [x: string]: unknown; code: -32700 | -32600 | -32601 | -32602 | -32603 | (number & $brand<...>); message: string; data?: unknown; }; } import {create_jsonrpc_error_response_from_thrown} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Creates a JSON-RPC error response from any error.
Handles ThrownJsonrpcError (preserves code/message/data) and
regular Error objects (maps to internal_error, includes stack in DEV).
idstring | number | nullerrorunknownhttp/jsonrpc_helpers.ts view source
(method: string, params: { [x: string]: unknown; } | undefined): { [x: string]: unknown; jsonrpc: "2.0"; method: string; params?: { [x: string]: unknown; } | undefined; } import {create_jsonrpc_notification} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Creates a JSON-RPC notification message (no id, no response expected).
methodstringparamsJsonrpcNotificationParams | undefinedhttp/jsonrpc_helpers.ts view source
(method: string, params: { [x: string]: unknown; } | undefined, id: string | number): { [x: string]: unknown; jsonrpc: "2.0"; id: string | number; method: string; params?: { [x: string]: unknown; } | undefined; } import {create_jsonrpc_request} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Creates a JSON-RPC request message.
methodstringparamsJsonrpcRequestParams | undefinedidhttp/jsonrpc_helpers.ts view source
(id: string | number, result: JSONType): { [x: string]: unknown; jsonrpc: "2.0"; id: string | number; result: JSONType; } import {create_jsonrpc_response} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Creates a JSON-RPC success response message.
idresultJSONTypehttp/jsonrpc_helpers.ts view source
(message: unknown): message is { [x: string]: unknown; jsonrpc: "2.0"; id: string | number | null; error: { [x: string]: unknown; code: -32700 | -32600 | -32601 | -32602 | -32603 | (number & $brand<"JsonrpcServerErrorCode">); message: string; data?: unknown; }; } import {is_jsonrpc_error_response} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Checks if a value is a JSON-RPC error response (has error + id).
messageunknownboolean http/jsonrpc_helpers.ts view source
(message: unknown): message is { [x: string]: unknown; jsonrpc: "2.0"; id: string | number; method: string; params?: { [x: string]: unknown; } | undefined; } | { [x: string]: unknown; jsonrpc: "2.0"; id: string | number; result: JSONType; } | { ...; } | { ...; } | ({ ...; } | ... 2 more ... | { ...; })[] import {is_jsonrpc_message} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Checks if a value is any valid JSON-RPC message or batch array.
messageunknownboolean http/jsonrpc_helpers.ts view source
(message: unknown): message is { [x: string]: unknown; jsonrpc: "2.0"; method: string; params?: { [x: string]: unknown; } | undefined; } import {is_jsonrpc_notification} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Checks if a value is a JSON-RPC notification (has method, no id).
messageunknownboolean http/jsonrpc_helpers.ts view source
(message: unknown): message is { jsonrpc: "2.0"; } import {is_jsonrpc_object} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Checks if a value is a JSON-RPC object (has jsonrpc: '2.0').
messageunknownboolean http/jsonrpc_helpers.ts view source
(message: unknown): message is { [x: string]: unknown; jsonrpc: "2.0"; id: string | number; method: string; params?: { [x: string]: unknown; } | undefined; } import {is_jsonrpc_request} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Checks if a value is a JSON-RPC request (has method + id).
messageunknownboolean http/jsonrpc_helpers.ts view source
(id: unknown): id is string | number import {is_jsonrpc_request_id} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Checks if a value is a valid JSON-RPC request id (string or finite number).
idunknownboolean http/jsonrpc_helpers.ts view source
(message: unknown): message is { [x: string]: unknown; jsonrpc: "2.0"; id: string | number; result: JSONType; } import {is_jsonrpc_response} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Checks if a value is a JSON-RPC success response (has result + id).
messageunknownboolean http/jsonrpc_helpers.ts view source
(frame: unknown): string | number | null import {to_jsonrpc_envelope_id} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; The id an error response to a rejected envelope can echo: the frame's
id when the frame is an object carrying a valid one, else null.
Unlike to_jsonrpc_message_id, a scalar frame (5, "x") is never read
as its own id — a non-object body has no id to echo, which is the Rust
twin's classify answer too. Both transports use this for the
invalid_request reply.
framethe parsed body, of any shape
unknownstring | number | null
the echoable id, or null
http/jsonrpc_helpers.ts view source
(message_or_id: unknown): string | number | null import {to_jsonrpc_message_id} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Extracts a JSON-RPC request id from a message or raw value.
Returns null if no valid id can be extracted.
message_or_idunknownstring | number | null
http/jsonrpc_helpers.ts view source
(input: unknown): Record<string, any> | undefined import {to_jsonrpc_params} from '@fuzdev/fuz_app/http/jsonrpc_helpers.js'; Normalizes input to JSON-RPC params format.
Returns undefined for null/undefined, wraps primitives in {value}.
inputunknownRecord<string, any> | undefined