Struct DocumentBuilder 

pub struct DocumentBuilder { /* private fields */ }

Builder for constructing OasDocument instances.

Provides an ergonomic API for building OAS Identity Documents with proper defaults and validation.

Examples

use oas_document::builder::DocumentBuilder;
use oas_document::conformance::ConformanceLevel;
use oas_crypto::keypair::OasKeyPair;

let keypair = OasKeyPair::generate();
let doc = DocumentBuilder::new("did:oas:test:hmr:alice", "hmr")
    .controller("did:oas:test:hmr:alice")
    .conformance_level(ConformanceLevel::L1)
    .add_verification_method(&keypair)
    .name("Alice")
    .build_and_sign(&keypair, "2026-01-15T00:00:00Z")
    .unwrap();
assert_eq!(doc.kind, "hmr");
assert!(doc.proof.is_some());

Implementations

impl DocumentBuilder

pub fn new(id: &str, kind: &str) -> Self

Creates a new builder with the given DID and kind.

Arguments

• id - The did:oas identifier.
• kind - The entity kind string (e.g., "hmr", "agent").

pub fn controller(self, controller: &str) -> Self

Sets the controller DID.

pub fn add_verification_method(self, keypair: &OasKeyPair) -> Self

Adds a verification method from a keypair.

Automatically adds the key to authentication, assertionMethod, capabilityInvocation, and capabilityDelegation relationships.

pub fn conformance_level(self, level: ConformanceLevel) -> Self

Sets the conformance level.

pub fn name(self, name: &str) -> Self

Sets the human-readable name.

pub fn description(self, description: &str) -> Self

Sets the human-readable description.

pub fn lineage(self, lineage: LineageSection) -> Self

Sets the lineage section.

pub fn governance(self, governance: GovernanceSection) -> Self

Sets the governance section (ENR entities only).

pub fn lifecycle_status(self, status: LifecycleStatus) -> Self

Sets the lifecycle status.

pub fn sequence(self, seq: u64) -> Self

Sets the sequence number.

pub fn add_service(self, service: ServiceEndpoint) -> Self

Adds a service endpoint.

pub fn profile(self, profile: ProfileSection) -> Self

Sets the profile section (§5.8).

pub fn contact(self, contact: ContactSection) -> Self

Sets the contact directory (§5.9).

pub fn calendar(self, calendar: CalendarSection) -> Self

Sets the calendar & scheduling section (§5.10).

pub fn operational(self, operational: OperationalSection) -> Self

Sets the operational specification (§5.11).

pub fn pricing(self, pricing: PricingSection) -> Self

Sets the pricing & economics section (§5.12).

pub fn interoperability(self, interop: InteroperabilitySection) -> Self

Sets the interoperability section (§5.13).

pub fn reputation(self, reputation: ReputationSection) -> Self

Sets the reputation summary (§5.14).

pub fn compliance(self, compliance: ComplianceSection) -> Self

Sets the compliance & jurisdiction section (§5.15).

pub fn relationships(self, relationships: RelationshipsSection) -> Self

Sets the relationships & affiliations section (§5.16).

pub fn build_and_sign( self, signing_keypair: &OasKeyPair, created: &str, ) -> Result<OasDocument, DocumentError>

Builds the document and signs it.

Arguments

• signing_keypair - The keypair to sign the document with.
• created - ISO 8601 timestamp for both document creation and proof.

Returns

A complete, signed OasDocument.

Errors

Returns DocumentError if signing fails.