Class SealedResponse

A sealed response that combines a Response with sender information and state continuations for secure communication.

Example

import { SealedResponse, ARID } from '@bcts/gstp';
import { XIDDocument } from '@bcts/xid';

// Create sender XID document
const sender = XIDDocument.new();
const requestId = ARID.new();

// Create a successful sealed response
const response = SealedResponse.newSuccess(requestId, sender)
  .withResult("Operation completed")
  .withState("next-page-state");

// Convert to sealed envelope
const envelope = response.toEnvelope(
  new Date(Date.now() + 60000), // Valid for 60 seconds
  senderPrivateKey,
  recipientXIDDocument
);

Implements

SealedResponseBehavior

Methods

`Static`newSuccess

newSuccess(id: ARID, sender: XIDDocument): SealedResponse
Creates a new successful sealed response.
Parameters
- id: ARID
  The request ID this response is for
- sender: XIDDocument
  The sender's XID document
Returns SealedResponse
- Defined in sealed-response.ts:109

`Static`newFailure

newFailure(id: ARID, sender: XIDDocument): SealedResponse
Creates a new failure sealed response.
Parameters
- id: ARID
  The request ID this response is for
- sender: XIDDocument
  The sender's XID document
Returns SealedResponse
- Defined in sealed-response.ts:119

`Static`newEarlyFailure

newEarlyFailure(sender: XIDDocument): SealedResponse
Creates a new early failure sealed response.

An early failure takes place before the message has been decrypted, and therefore the ID and sender public key are not known.
Parameters
- sender: XIDDocument
  The sender's XID document
Returns SealedResponse
- Defined in sealed-response.ts:131

withState

withState(state: EnvelopeEncodableValue): SealedResponse
Adds state to the response that the peer may return at some future time.
Parameters
- state: EnvelopeEncodableValue
Returns SealedResponse
Throws
Error if called on a failed response
Implementation of SealedResponseBehavior.withState
- Defined in sealed-response.ts:144

withOptionalState

withOptionalState(state: EnvelopeEncodableValue): SealedResponse
Adds optional state to the response.
Parameters
- state: EnvelopeEncodableValue
Returns SealedResponse
Implementation of SealedResponseBehavior.withOptionalState
- Defined in sealed-response.ts:155

withPeerContinuation

withPeerContinuation(peerContinuation: Envelope$1 | undefined): SealedResponse
Adds a continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1 | undefined
Returns SealedResponse
Implementation of SealedResponseBehavior.withPeerContinuation
- Defined in sealed-response.ts:166

sender

sender(): XIDDocument
Returns the sender of the response.

Returns XIDDocument
Implementation of SealedResponseBehavior.sender
- Defined in sealed-response.ts:174

state

state(): Envelope$1 | undefined
Returns the state to be sent to the peer.

Returns Envelope$1 | undefined
Implementation of SealedResponseBehavior.state
- Defined in sealed-response.ts:181

peerContinuation

peerContinuation(): Envelope$1 | undefined
Returns the continuation received from the peer.

Returns Envelope$1 | undefined
Implementation of SealedResponseBehavior.peerContinuation
- Defined in sealed-response.ts:188

withResult

withResult(result: EnvelopeEncodableValue): SealedResponse
Sets the result value for a successful response.
Parameters
- result: EnvelopeEncodableValue
Returns SealedResponse
- Defined in sealed-response.ts:199

withOptionalResult

withOptionalResult(result: EnvelopeEncodableValue): SealedResponse
Sets an optional result value for a successful response. If the result is undefined, the value of the response will be the null envelope.
Parameters
- result: EnvelopeEncodableValue
Returns SealedResponse
- Defined in sealed-response.ts:208

withError

withError(error: EnvelopeEncodableValue): SealedResponse
Sets the error value for a failure response.
Parameters
- error: EnvelopeEncodableValue
Returns SealedResponse
- Defined in sealed-response.ts:216

withOptionalError

withOptionalError(error: EnvelopeEncodableValue): SealedResponse
Sets an optional error value for a failure response. If the error is undefined, the value of the response will be the unknown value.
Parameters
- error: EnvelopeEncodableValue
Returns SealedResponse
- Defined in sealed-response.ts:225

isOk

isOk(): boolean
Returns true if this is a successful response.

Returns boolean
- Defined in sealed-response.ts:233

isErr

isErr(): boolean
Returns true if this is a failure response.

Returns boolean
- Defined in sealed-response.ts:240

id

id(): ARID | undefined
Returns the ID of the request this response is for, if known.

Returns ARID | undefined
- Defined in sealed-response.ts:247

expectId

expectId(): ARID
Returns the ID of the request this response is for.

Returns ARID
Throws
Error if the ID is not known
- Defined in sealed-response.ts:255

result

result(): Envelope$1
Returns the result envelope if this is a successful response.

Returns Envelope$1
Throws
Error if this is a failure response
- Defined in sealed-response.ts:263

extractResult

extractResult<T>(decoder: (cbor: unknown) => T): T
Extracts the result as a specific type.
Type Parameters
- T
Parameters
- decoder: (cbor: unknown) => T
Returns T
- Defined in sealed-response.ts:270

error

error(): Envelope$1
Returns the error envelope if this is a failure response.

Returns Envelope$1
Throws
Error if this is a successful response
- Defined in sealed-response.ts:278

extractError

extractError<T>(decoder: (cbor: unknown) => T): T
Extracts the error as a specific type.
Type Parameters
- T
Parameters
- decoder: (cbor: unknown) => T
Returns T
- Defined in sealed-response.ts:285

toEnvelope

toEnvelope(
    validUntil?: Date,
    signer?: Signer,
    recipient?: XIDDocument,
): Envelope$1
Creates an envelope that can be decrypted by zero or one recipient.
Parameters
- OptionalvalidUntil: Date
  Optional expiration date for the continuation
- Optionalsigner: Signer
  Optional signer for the envelope
- Optionalrecipient: XIDDocument
  Optional recipient XID document for encryption
Returns Envelope$1
The sealed response as an envelope
- Defined in sealed-response.ts:301

toEnvelopeForRecipients

toEnvelopeForRecipients(
    validUntil?: Date,
    signer?: Signer,
    recipients?: XIDDocument[],
): Envelope$1
Creates an envelope that can be decrypted by zero or more recipients.
Parameters
- OptionalvalidUntil: Date
  Optional expiration date for the continuation
- Optionalsigner: Signer
  Optional signer for the envelope
- Optionalrecipients: XIDDocument[]
  Array of recipient XID documents for encryption
Returns Envelope$1
The sealed response as an envelope
- Defined in sealed-response.ts:314

`Static`tryFromEncryptedEnvelope

tryFromEncryptedEnvelope(
    encryptedEnvelope: Envelope$1,
    expectedId: ARID | undefined,
    now: Date | undefined,
    recipientPrivateKey: PrivateKeys,
): SealedResponse
Parses a sealed response from an encrypted envelope.
Parameters
- encryptedEnvelope: Envelope$1
  The encrypted envelope to parse
- expectedId: ARID | undefined
  Optional expected request ID for validation
- now: Date | undefined
  Optional current time for continuation validation
- recipientPrivateKey: PrivateKeys
  The recipient's private keys for decryption
Returns SealedResponse
The parsed sealed response
- Defined in sealed-response.ts:380

toString

toString(): string
Returns a string representation of the sealed response.

Returns string
- Defined in sealed-response.ts:469

equals

equals(other: SealedResponse): boolean
Checks equality with another sealed response.
Parameters
- other: SealedResponse
Returns boolean
- Defined in sealed-response.ts:478

Class SealedResponse

Example

Implements

Index

Methods

Methods

StaticnewSuccess

Parameters

Returns SealedResponse

StaticnewFailure

Parameters

Returns SealedResponse

StaticnewEarlyFailure

Parameters

Returns SealedResponse

withState

Parameters

Returns SealedResponse

Throws

withOptionalState

Parameters

Returns SealedResponse

withPeerContinuation

Parameters

Returns SealedResponse

sender

Returns XIDDocument

state

Returns Envelope$1 | undefined

peerContinuation

Returns Envelope$1 | undefined

withResult

Parameters

Returns SealedResponse

withOptionalResult

Parameters

Returns SealedResponse

withError

Parameters

Returns SealedResponse

withOptionalError

Parameters

Returns SealedResponse

isOk

Returns boolean

isErr

Returns boolean

id

Returns ARID | undefined

expectId

Returns ARID

Throws

result

Returns Envelope$1

Throws

extractResult

Type Parameters

Parameters

Returns T

error

Returns Envelope$1

Throws

extractError

Type Parameters

Parameters

Returns T

toEnvelope

Parameters

Returns Envelope$1

toEnvelopeForRecipients

Parameters

Returns Envelope$1

StatictryFromEncryptedEnvelope

Parameters

Returns SealedResponse

toString

Returns string

equals

Parameters

Returns boolean

`Static`newSuccess

`Static`newFailure

`Static`newEarlyFailure

`Static`tryFromEncryptedEnvelope