Class SealedEvent<T>

A sealed event that combines an Event with sender information and state continuations for secure communication.

Example

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

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

// Create a sealed event
const event = SealedEvent.new("System notification", eventId, sender)
  .withNote("Status update")
  .withDate(new Date());

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

Type Parameters

T extends EnvelopeEncodableValue
The type of content this event carries

Implements

SealedEventBehavior<T>

Methods

`Static`new

new<T extends EnvelopeEncodableValue>(
    content: T,
    id: ARID,
    sender: XIDDocument,
): SealedEvent<T>
Creates a new sealed event with the given content, ID, and sender.
Type Parameters
- T extends EnvelopeEncodableValue
Parameters
- content: T
  The content of the event
- id: ARID
  The event ID
- sender: XIDDocument
  The sender's XID document
Returns SealedEvent<T>
- Defined in sealed-event.ts:122

withNote

withNote(note: string): SealedEvent<T>
Adds a note to the event.
Parameters
- note: string
Returns SealedEvent<T>
- Defined in sealed-event.ts:137

withDate

withDate(date: Date): SealedEvent<T>
Adds a date to the event.
Parameters
- date: Date
Returns SealedEvent<T>
- Defined in sealed-event.ts:145

content

content(): T
Returns the content of the event.

Returns T
- Defined in sealed-event.ts:153

id

id(): ARID
Returns the ID of the event.

Returns ARID
- Defined in sealed-event.ts:160

note

note(): string
Returns the note of the event.

Returns string
- Defined in sealed-event.ts:167

date

date(): Date | undefined
Returns the date of the event.

Returns Date | undefined
- Defined in sealed-event.ts:174

withState

withState(state: EnvelopeEncodableValue): SealedEvent<T>
Adds state to the event that the receiver must return in the response.
Parameters
- state: EnvelopeEncodableValue
Returns SealedEvent<T>
Implementation of SealedEventBehavior.withState
- Defined in sealed-event.ts:185

withOptionalState

withOptionalState(state: EnvelopeEncodableValue): SealedEvent<T>
Adds optional state to the event.
Parameters
- state: EnvelopeEncodableValue
Returns SealedEvent<T>
Implementation of SealedEventBehavior.withOptionalState
- Defined in sealed-event.ts:193

withPeerContinuation

withPeerContinuation(peerContinuation: Envelope$1): SealedEvent<T>
Adds a continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1
Returns SealedEvent<T>
Implementation of SealedEventBehavior.withPeerContinuation
- Defined in sealed-event.ts:204

withOptionalPeerContinuation

withOptionalPeerContinuation(
peerContinuation: Envelope$1 | undefined,
): SealedEvent<T>
Adds an optional continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1 | undefined
Returns SealedEvent<T>
Implementation of SealedEventBehavior.withOptionalPeerContinuation
- Defined in sealed-event.ts:212

event

event(): Event<T>
Returns the underlying event.

Returns Event<T>
Implementation of SealedEventBehavior.event
- Defined in sealed-event.ts:220

sender

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

Returns XIDDocument
Implementation of SealedEventBehavior.sender
- Defined in sealed-event.ts:227

state

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

Returns Envelope$1 | undefined
Implementation of SealedEventBehavior.state
- Defined in sealed-event.ts:234

peerContinuation

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

Returns Envelope$1 | undefined
Implementation of SealedEventBehavior.peerContinuation
- Defined in sealed-event.ts:241

toEvent

toEvent(): Event<T>
Converts the sealed event to an Event.

Returns Event<T>
- Defined in sealed-event.ts:252

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 event as an envelope
- Defined in sealed-event.ts:268

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 event as an envelope
- Defined in sealed-event.ts:281

`Static`tryFromEnvelope

tryFromEnvelope<T extends EnvelopeEncodableValue>(
    encryptedEnvelope: Envelope$1,
    expectedId: ARID | undefined,
    now: Date | undefined,
    recipientPrivateKey: PrivateKeys,
    contentExtractor?: (env: Envelope$1) => T,
): SealedEvent<T>
Parses a sealed event from an encrypted envelope.
Type Parameters
- T extends EnvelopeEncodableValue
Parameters
- encryptedEnvelope: Envelope$1
  The encrypted envelope to parse
- expectedId: ARID | undefined
  Optional expected event ID for validation
- now: Date | undefined
  Optional current time for continuation validation
- recipientPrivateKey: PrivateKeys
  The recipient's private keys for decryption
- OptionalcontentExtractor: (env: Envelope$1) => T
  Function to extract content from envelope
Returns SealedEvent<T>
The parsed sealed event
- Defined in sealed-event.ts:352

toString

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

Returns string
- Defined in sealed-event.ts:441

equals

equals(other: SealedEvent<T>): boolean
Checks equality with another sealed event.
Parameters
- other: SealedEvent<T>
Returns boolean
- Defined in sealed-event.ts:450

Class SealedEvent<T>

Example

Type Parameters

Implements

Index

Methods

Methods

Staticnew

Type Parameters

Parameters

Returns SealedEvent<T>

withNote

Parameters

Returns SealedEvent<T>

withDate

Parameters

Returns SealedEvent<T>

content

Returns T

id

Returns ARID

note

Returns string

date

Returns Date | undefined

withState

Parameters

Returns SealedEvent<T>

withOptionalState

Parameters

Returns SealedEvent<T>

withPeerContinuation

Parameters

Returns SealedEvent<T>

withOptionalPeerContinuation

Parameters

Returns SealedEvent<T>

event

Returns Event<T>

sender

Returns XIDDocument

state

Returns Envelope$1 | undefined

peerContinuation

Returns Envelope$1 | undefined

toEvent

Returns Event<T>

toEnvelope

Parameters

Returns Envelope$1

toEnvelopeForRecipients

Parameters

Returns Envelope$1

StatictryFromEnvelope

Type Parameters

Parameters

Returns SealedEvent<T>

toString

Returns string

equals

Parameters

Returns boolean

Settings

On This Page

`Static`new

`Static`tryFromEnvelope