data-modelling-core 2.4.0

Core SDK library for model operations across platforms
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Export functionality
//!
//! Provides exporters for various formats:
//! - SQL
//! - JSON Schema
//! - AVRO
//! - Protobuf
//! - ODCS (Open Data Contract Standard) v3.1.0
//! - PNG
//! - PDF (with branding support)
//! - Decision (MADR-compliant decision records)
//! - Knowledge (Knowledge Base articles)
//! - Markdown (for GitHub readability)

pub mod avro;
#[cfg(feature = "bpmn")]
pub mod bpmn;
pub mod cads;
pub mod dbmv;
pub mod decision;
#[cfg(feature = "dmn")]
pub mod dmn;
pub mod json_schema;
pub mod knowledge;
pub mod markdown;
pub mod odcl;
pub mod odcs;
pub mod odps;
#[cfg(feature = "openapi")]
pub mod openapi;
pub mod pdf;
#[cfg(feature = "png-export")]
pub mod png;
pub mod protobuf;
pub mod sketch;
pub mod sql;

// anyhow::Result not currently used in this module

/// Result of an export operation.
///
/// Contains the exported content and format identifier.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
#[must_use = "export results contain the exported content and should be used"]
pub struct ExportResult {
    /// Exported content (as string - binary formats will be base64 encoded)
    pub content: String,
    /// Format identifier
    pub format: String,
}

/// Error during export
#[derive(Debug, thiserror::Error, serde::Serialize, serde::Deserialize)]
pub enum ExportError {
    #[error("Serialization error: {0}")]
    SerializationError(String),
    #[error("Validation error: {0}")]
    ValidationError(String),
    #[error("Invalid argument: {0}")]
    InvalidArgument(String),
    #[error("IO error: {0}")]
    IoError(String),
    #[error("Export error: {0}")]
    ExportError(String),
    #[error("BPMN export error: {0}")]
    BPMNExportError(String),
    #[error("DMN export error: {0}")]
    DMNExportError(String),
    #[error("OpenAPI export error: {0}")]
    OpenAPIExportError(String),
    #[error("Model not found: {0}")]
    ModelNotFound(String),
}

impl From<Box<dyn std::error::Error>> for ExportError {
    fn from(err: Box<dyn std::error::Error>) -> Self {
        ExportError::ExportError(err.to_string())
    }
}

// Re-export for convenience
pub use avro::AvroExporter;
#[cfg(feature = "bpmn")]
pub use bpmn::BPMNExporter;
pub use cads::CADSExporter;
pub use dbmv::DBMVExporter;
pub use decision::DecisionExporter;
#[cfg(feature = "dmn")]
pub use dmn::DMNExporter;
pub use json_schema::JSONSchemaExporter;
pub use knowledge::KnowledgeExporter;
pub use markdown::{BrandedMarkdownExporter, MarkdownBrandingConfig, MarkdownExporter};
pub use odcl::ODCLExporter;
pub use odcs::ODCSExporter;
pub use odps::ODPSExporter;
#[cfg(feature = "openapi")]
pub use openapi::OpenAPIExporter;
pub use pdf::{BrandingConfig, PageSize, PdfExportResult, PdfExporter};
#[cfg(feature = "png-export")]
pub use png::PNGExporter;
pub use protobuf::ProtobufExporter;
pub use sketch::SketchExporter;
pub use sql::SQLExporter;