Skip to content

vCon 0.3.0 Specification Compliance

Choose a tag to compare

View all tags
@howethomas howethomas released this 19 Jul 15:01
· 38 commits to main since this release
v0.7.0
beb2384
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

[0.7.0] - 2025-07-19

🎉 Major Release: Complete vCon 0.3.0 Specification Compliance

This release implements full compliance with the IETF vCon 0.3.0 specification, adding comprehensive support for all new fields, validation, and features while maintaining complete backward compatibility.

✨ Added

vCon Object Level Features

  • Extensions Support:
    • extensions field for declaring extension capabilities
    • must_support field for specifying required extensions
    • Helper methods: add_extension(), remove_extension(), get_extensions()
    • Helper methods: add_must_support(), remove_must_support(), get_must_support()
    • Automatic duplicate prevention and validation

Enhanced Party Object Support

  • New Contact Methods:
    • sip field for SIP URI contact information
    • did field for Decentralized Identifier (blockchain-based identity)
    • jCard field for vCard format contact information (RFC 7095)
    • timezone field for party timezone information
  • Civic Address Support: Complete GEOPRIV specification compliance
    • All administrative areas (a1-a6)
    • Street and building information (sts, hno, hns, prd, flr)
    • Location and identification fields (country, pc, nam, lmk, loc, pod)

Enhanced Dialog Object Support

  • Session Management:
    • session_id field for session tracking
    • content_hash field for content integrity verification (replaces alg/signature)
    • application field for application identification
    • message_id field for email/text dialog identification
  • Content Integrity:
    • calculate_content_hash() method with SHA-256 support
    • verify_content_hash() method for integrity verification
    • Automatic content hash calculation for external files

Party History Event Tracking

  • New PartyHistory Class: Complete implementation of party history events
    • Support for all 6 specification event types: join, drop, hold, unhold, mute, unmute
    • Event validation with VALID_EVENTS list
    • ISO 8601 time serialization for all events
    • Proper error handling for invalid events

Enhanced Media Type Support

  • Specification-Compliant Media Types:
    • Added audio/x-mp3 and audio/x-mp4 (specification required)
    • Enhanced video format support (MP4, WebM, AVI, MKV, MOV, FLV, 3GP)
    • Complete audio format coverage (WAV, MP3, MP4, OGG, WebM, AAC)
    • Image and document support (JPEG, TIFF, PDF)

Disposition Values for Incomplete Dialogs

  • Complete Disposition Support: All 6 specification values implemented
    • no-answer: Call attempted but no answer
    • congestion: System load prevented completion
    • failed: Call/connection failed
    • busy: Party was busy
    • hung-up: Party hung up before conversation
    • voicemail-no-message: Voicemail answered but no message left
  • Validation: Automatic validation for incomplete dialog types

Transfer Dialog Enhancements

  • Updated Field Names: Consistent underscore naming convention
    • transfer-target → transfer_target
    • target-dialog → target_dialog
  • Enhanced Transfer Support: Complete transfer operation tracking

Comprehensive Documentation

  • Updated Class Documentation: Complete docstrings for all classes
    • Vcon class with vCon 0.3.0 feature documentation
    • Party class with new contact method documentation
    • Dialog class with session and content hash documentation
    • CivicAddress class with GEOPRIV compliance documentation
    • PartyHistory class with event tracking documentation
  • Enhanced README: Comprehensive usage examples and feature documentation
  • API Documentation: Complete API reference with examples

🔧 Changed

Property Handling

  • Updated Allowed Properties: All new fields added to property lists
    • _ALLOWED_VCON_PROPERTIES: Added extensions, must_support
    • _ALLOWED_PARTY_PROPERTIES: Added sip, did, jCard, timezone
    • _ALLOWED_DIALOG_PROPERTIES: Added session_id, content_hash, application, message_id
  • Enhanced Property Processing: Improved handling in all modes (default, strict, meta)

Validation Enhancements

  • Comprehensive Validation: Enhanced validation for all new fields
    • Party history event validation
    • Disposition value validation for incomplete dialogs
    • Media type validation with specification compliance
    • Civic address field validation
  • Backward Compatibility: All validation maintains backward compatibility

Serialization Improvements

  • ISO 8601 Compliance: All datetime fields properly serialized
  • Content Hash Integration: Automatic content hash calculation and verification
  • Extension Management: Proper serialization of extensions and must_support fields

🧪 Testing

Comprehensive Test Coverage

  • 149 Tests Passing: Complete test suite with 7 skipped (advanced features)
  • New Feature Tests: Extensive testing for all new vCon 0.3.0 features
    • Party history event validation tests
    • Disposition value validation tests
    • Media type validation tests
    • Extension management tests
    • Content hash calculation tests
  • Backward Compatibility Tests: Verification that existing functionality works unchanged
  • Validation Tests: Comprehensive validation testing for all new fields

📚 Documentation

Complete Documentation Update

  • Class Documentation: Updated all class docstrings with vCon 0.3.0 features
  • README Enhancement: Comprehensive usage examples and feature documentation
  • API Reference: Complete API documentation with examples
  • Workplan Documentation: Complete implementation tracking in IETF-123-WORKPLAN.md

🔄 Migration Support

Version Migration

  • Automatic Migration: Seamless migration from older vCon versions
  • Strict Mode Support: Optional strict version checking
  • Backward Compatibility: Full compatibility with existing vCon files

🔑 Security

Enhanced Security Features

  • Content Integrity: SHA-256 content hashing for external files
  • Digital Signatures: JWS support for vCon signing
  • Validation: Comprehensive validation for all security-related fields

📄 Sample Files

Updated Sample Files

  • Version 0.3.0 Compliance: All sample files updated to vCon 0.3.0
  • New Field Examples: Sample files demonstrating new features
  • Backward Compatibility: Existing sample files continue to work

🔧 Technical Details

Implementation Quality

  • 149 Tests Passing: Comprehensive test coverage
  • Zero Breaking Changes: Complete backward compatibility
  • Specification Compliance: Full vCon 0.3.0 specification implementation
  • Performance: Optimized implementation with minimal overhead
  • Error Handling: Comprehensive error handling and validation

Code Quality

  • Type Hints: Complete type annotation coverage
  • Documentation: Comprehensive docstrings and comments
  • Linting: Clean code with minimal linting issues
  • Modularity: Well-structured, maintainable code
Assets 2
Loading