Challenge.serialize

Serializes a Challenge to the WWW-Authenticate header format.

Usage

import { Challenge } from 'mppx'
 
const challenge = Challenge.from({
  id: 'abc123',
  intent: 'charge',
  method: 'tempo',
  realm: 'mpp.dev',
  request: { amount: '1000000', currency: '0x...', recipient: '0x...' },
})
 
const header = Challenge.serialize(challenge)
'Payment id="abc123", realm="mpp.dev", method="tempo", intent="charge", request="eyJhbW91bnQiOi..."'

Return type

type ReturnType = string

A string suitable for the WWW-Authenticate header value.

The serialized string includes optional fields when present: description, digest, expires, header, and opaque (server-defined correlation data set via meta in Challenge.from). header="Authorization" is omitted because Authorization is the protocol default. In HTTP headers, request and opaque are emitted as base64url-encoded JCS JSON strings.

Characters above Latin-1 in auth-param values are escaped as \uXXXX, so descriptions containing smart quotes, em dashes, emoji, or other Unicode remain valid Fetch API header values. Challenge.deserialize restores the original text.

Parameters

challenge

• Type: Challenge

The Challenge to serialize.