Skip to main content

provenant/output_schema/
package.rs

1use serde::{Deserialize, Serialize};
2use std::collections::HashMap;
3
4use super::license_detection::OutputLicenseDetection;
5use super::party::OutputParty;
6use super::serde_helpers::serialize_optional_map_as_object;
7
8#[derive(Serialize, Deserialize, Debug, Clone)]
9pub struct OutputPackage {
10    #[serde(rename = "type")]
11    pub package_type: Option<crate::models::PackageType>,
12    pub namespace: Option<String>,
13    pub name: Option<String>,
14    pub version: Option<String>,
15    #[serde(default, serialize_with = "serialize_optional_map_as_object")]
16    pub qualifiers: Option<HashMap<String, String>>,
17    pub subpath: Option<String>,
18    pub primary_language: Option<String>,
19    pub description: Option<String>,
20    pub release_date: Option<String>,
21    #[serde(default)]
22    pub parties: Vec<OutputParty>,
23    #[serde(default)]
24    pub keywords: Vec<String>,
25    pub homepage_url: Option<String>,
26    pub download_url: Option<String>,
27    pub size: Option<u64>,
28    pub sha1: Option<String>,
29    pub md5: Option<String>,
30    pub sha256: Option<String>,
31    pub sha512: Option<String>,
32    pub bug_tracking_url: Option<String>,
33    pub code_view_url: Option<String>,
34    pub vcs_url: Option<String>,
35    pub copyright: Option<String>,
36    pub holder: Option<String>,
37    pub declared_license_expression: Option<String>,
38    pub declared_license_expression_spdx: Option<String>,
39    #[serde(default)]
40    pub license_detections: Vec<OutputLicenseDetection>,
41    pub other_license_expression: Option<String>,
42    pub other_license_expression_spdx: Option<String>,
43    #[serde(default)]
44    pub other_license_detections: Vec<OutputLicenseDetection>,
45    pub extracted_license_statement: Option<String>,
46    pub notice_text: Option<String>,
47    #[serde(default)]
48    pub source_packages: Vec<String>,
49    #[serde(default)]
50    pub is_private: bool,
51    #[serde(default)]
52    pub is_virtual: bool,
53    #[serde(default, serialize_with = "serialize_optional_map_as_object")]
54    pub extra_data: Option<HashMap<String, serde_json::Value>>,
55    pub repository_homepage_url: Option<String>,
56    pub repository_download_url: Option<String>,
57    pub api_data_url: Option<String>,
58    pub purl: Option<String>,
59    pub package_uid: String,
60    pub datafile_paths: Vec<String>,
61    pub datasource_ids: Vec<crate::models::DatasourceId>,
62}
63
64impl From<&crate::models::Package> for OutputPackage {
65    fn from(value: &crate::models::Package) -> Self {
66        Self {
67            package_type: value.package_type,
68            namespace: value.namespace.clone(),
69            name: value.name.clone(),
70            version: value.version.clone(),
71            qualifiers: value.qualifiers.clone(),
72            subpath: value.subpath.clone(),
73            primary_language: value.primary_language.clone(),
74            description: value.description.clone(),
75            release_date: value.release_date.clone(),
76            parties: value.parties.iter().map(OutputParty::from).collect(),
77            keywords: value.keywords.clone(),
78            homepage_url: value.homepage_url.clone(),
79            download_url: value.download_url.clone(),
80            size: value.size,
81            sha1: value.sha1.as_ref().map(|d| d.as_hex()),
82            md5: value.md5.as_ref().map(|d| d.as_hex()),
83            sha256: value.sha256.as_ref().map(|d| d.as_hex()),
84            sha512: value.sha512.as_ref().map(|d| d.as_hex()),
85            bug_tracking_url: value.bug_tracking_url.clone(),
86            code_view_url: value.code_view_url.clone(),
87            vcs_url: value.vcs_url.clone(),
88            copyright: value.copyright.clone(),
89            holder: value.holder.clone(),
90            declared_license_expression: value.declared_license_expression.clone(),
91            declared_license_expression_spdx: value.declared_license_expression_spdx.clone(),
92            license_detections: value
93                .license_detections
94                .iter()
95                .map(OutputLicenseDetection::from)
96                .collect(),
97            other_license_expression: value.other_license_expression.clone(),
98            other_license_expression_spdx: value.other_license_expression_spdx.clone(),
99            other_license_detections: value
100                .other_license_detections
101                .iter()
102                .map(OutputLicenseDetection::from)
103                .collect(),
104            extracted_license_statement: value.extracted_license_statement.clone(),
105            notice_text: value.notice_text.clone(),
106            source_packages: value.source_packages.clone(),
107            is_private: value.is_private,
108            is_virtual: value.is_virtual,
109            extra_data: value.extra_data.clone(),
110            repository_homepage_url: value.repository_homepage_url.clone(),
111            repository_download_url: value.repository_download_url.clone(),
112            api_data_url: value.api_data_url.clone(),
113            purl: value.purl.clone(),
114            package_uid: value.package_uid.to_string(),
115            datafile_paths: value.datafile_paths.clone(),
116            datasource_ids: value.datasource_ids.clone(),
117        }
118    }
119}
120
121impl TryFrom<&OutputPackage> for crate::models::Package {
122    type Error = String;
123    fn try_from(value: &OutputPackage) -> Result<Self, Self::Error> {
124        let mut parties = Vec::with_capacity(value.parties.len());
125        for p in &value.parties {
126            parties.push(crate::models::Party::try_from(p)?);
127        }
128        let mut license_detections = Vec::with_capacity(value.license_detections.len());
129        for d in &value.license_detections {
130            license_detections.push(crate::models::LicenseDetection::try_from(d)?);
131        }
132        let mut other_license_detections = Vec::with_capacity(value.other_license_detections.len());
133        for d in &value.other_license_detections {
134            other_license_detections.push(crate::models::LicenseDetection::try_from(d)?);
135        }
136        Ok(Self {
137            package_type: value.package_type,
138            namespace: value.namespace.clone(),
139            name: value.name.clone(),
140            version: value.version.clone(),
141            qualifiers: value.qualifiers.clone(),
142            subpath: value.subpath.clone(),
143            primary_language: value.primary_language.clone(),
144            description: value.description.clone(),
145            release_date: value.release_date.clone(),
146            parties,
147            keywords: value.keywords.clone(),
148            homepage_url: value.homepage_url.clone(),
149            download_url: value.download_url.clone(),
150            size: value.size,
151            sha1: value
152                .sha1
153                .as_ref()
154                .map(|s| crate::models::Sha1Digest::from_hex(s))
155                .transpose()
156                .map_err(|e| format!("invalid sha1: {}", e))?,
157            md5: value
158                .md5
159                .as_ref()
160                .map(|s| crate::models::Md5Digest::from_hex(s))
161                .transpose()
162                .map_err(|e| format!("invalid md5: {}", e))?,
163            sha256: value
164                .sha256
165                .as_ref()
166                .map(|s| crate::models::Sha256Digest::from_hex(s))
167                .transpose()
168                .map_err(|e| format!("invalid sha256: {}", e))?,
169            sha512: value
170                .sha512
171                .as_ref()
172                .map(|s| crate::models::Sha512Digest::from_hex(s))
173                .transpose()
174                .map_err(|e| format!("invalid sha512: {}", e))?,
175            bug_tracking_url: value.bug_tracking_url.clone(),
176            code_view_url: value.code_view_url.clone(),
177            vcs_url: value.vcs_url.clone(),
178            copyright: value.copyright.clone(),
179            holder: value.holder.clone(),
180            declared_license_expression: value.declared_license_expression.clone(),
181            declared_license_expression_spdx: value.declared_license_expression_spdx.clone(),
182            license_detections,
183            other_license_expression: value.other_license_expression.clone(),
184            other_license_expression_spdx: value.other_license_expression_spdx.clone(),
185            other_license_detections,
186            extracted_license_statement: value.extracted_license_statement.clone(),
187            notice_text: value.notice_text.clone(),
188            source_packages: value.source_packages.clone(),
189            is_private: value.is_private,
190            is_virtual: value.is_virtual,
191            extra_data: value.extra_data.clone(),
192            repository_homepage_url: value.repository_homepage_url.clone(),
193            repository_download_url: value.repository_download_url.clone(),
194            api_data_url: value.api_data_url.clone(),
195            purl: value.purl.clone(),
196            package_uid: crate::models::PackageUid::from_raw(value.package_uid.clone()),
197            datafile_paths: value.datafile_paths.clone(),
198            datasource_ids: value.datasource_ids.clone(),
199        })
200    }
201}