provenant/models/
package_type.rs

1// SPDX-FileCopyrightText: nexB Inc. and others
2// ScanCode is a trademark of nexB Inc.
3// SPDX-FileCopyrightText: Provenant contributors
4// SPDX-License-Identifier: Apache-2.0
5// Derived from ScanCode Toolkit (Apache-2.0); modified. See NOTICE.
6
7//! Package type identifiers for package parsers.
8//!
9//! Each variant uniquely identifies the package ecosystem/registry type.
10//! These are used in Package URL (purl) type fields and in the JSON output
11//! as the `"type"` field of package data.
12
13use serde::{Deserialize, Serialize};
14use std::fmt;
15use std::str::FromStr;
16
17/// Package ecosystem/registry type identifier.
18///
19/// Identifies the package manager or ecosystem a package belongs to
20/// (e.g., npm, PyPI, Maven, Cargo). Used as the `"type"` field in
21/// ScanCode Toolkit-compatible JSON output.
22///
23/// This enum includes both standard purl types and ScanCode-specific types
24/// for file format recognizers (e.g., `Jar`, `War`) and metadata sources
25/// (e.g., `About`, `Readme`). For the official list of standardized purl types, see:
26/// <https://github.com/package-url/purl-spec/blob/main/purl-types-index.json>
27///
28/// # Serialization
29///
30/// Variants serialize as PascalCase in the cache/spill format (e.g., `JbossService`).
31/// For JSON output, use `as_str()` / `Display` which returns lowercase/kebab-case
32/// strings matching the Python ScanCode Toolkit values (e.g., `jboss-service`).
33#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
34pub enum PackageType {
35    About,
36    Alpm,
37    Apk,
38    Android,
39    AndroidLib,
40    Autotools,
41    Axis2,
42    Bazel,
43    Bower,
44    Buck,
45    Cab,
46    Cargo,
47    Carthage,
48    Chef,
49    Chrome,
50    Cocoapods,
51    Composer,
52    Conan,
53    Conda,
54    Cpan,
55    Cran,
56    Deb,
57    Deno,
58    Docker,
59    Dmg,
60    Ear,
61    Freebsd,
62    Gem,
63    Generic,
64    Github,
65    Golang,
66    Hackage,
67    Haxe,
68    Helm,
69    Hex,
70    Huggingface,
71    Installshield,
72    Julia,
73    Ios,
74    Iso,
75    Ivy,
76    Jar,
77    JbossService,
78    LinuxDistro,
79    Maven,
80    Meson,
81    Meteor,
82    Nix,
83    Mozilla,
84    Npm,
85    Nsis,
86    Nuget,
87    Oci,
88    Opam,
89    Osgi,
90    PnpmLock,
91    Pub,
92    Pypi,
93    Pixi,
94    Publiccode,
95    Readme,
96    Rpm,
97    Shar,
98    Squashfs,
99    Swift,
100    Vcpkg,
101    War,
102    Winexe,
103    WindowsUpdate,
104    Yocto,
105}
106
107impl PackageType {
108    /// Returns the string representation of this package type.
109    ///
110    /// This matches the serialized form used in JSON output.
111    pub fn as_str(&self) -> &'static str {
112        match self {
113            Self::About => "about",
114            Self::Alpm => "alpm",
115            Self::Apk => "apk",
116            Self::Android => "android",
117            Self::AndroidLib => "android_lib",
118            Self::Autotools => "autotools",
119            Self::Axis2 => "axis2",
120            Self::Bazel => "bazel",
121            Self::Bower => "bower",
122            Self::Buck => "buck",
123            Self::Cab => "cab",
124            Self::Cargo => "cargo",
125            Self::Carthage => "carthage",
126            Self::Chef => "chef",
127            Self::Chrome => "chrome",
128            Self::Cocoapods => "cocoapods",
129            Self::Composer => "composer",
130            Self::Conan => "conan",
131            Self::Conda => "conda",
132            Self::Cpan => "cpan",
133            Self::Cran => "cran",
134            Self::Deb => "deb",
135            Self::Deno => "deno",
136            Self::Docker => "docker",
137            Self::Dmg => "dmg",
138            Self::Ear => "ear",
139            Self::Freebsd => "freebsd",
140            Self::Gem => "gem",
141            Self::Generic => "generic",
142            Self::Github => "github",
143            Self::Golang => "golang",
144            Self::Hackage => "hackage",
145            Self::Haxe => "haxe",
146            Self::Helm => "helm",
147            Self::Hex => "hex",
148            Self::Huggingface => "huggingface",
149            Self::Installshield => "installshield",
150            Self::Julia => "julia",
151            Self::Ios => "ios",
152            Self::Iso => "iso",
153            Self::Ivy => "ivy",
154            Self::Jar => "jar",
155            Self::JbossService => "jboss-service",
156            Self::LinuxDistro => "linux-distro",
157            Self::Maven => "maven",
158            Self::Meson => "meson",
159            Self::Meteor => "meteor",
160            Self::Nix => "nix",
161            Self::Mozilla => "mozilla",
162            Self::Npm => "npm",
163            Self::Nsis => "nsis",
164            Self::Nuget => "nuget",
165            Self::Oci => "oci",
166            Self::Opam => "opam",
167            Self::Osgi => "osgi",
168            Self::PnpmLock => "pnpm-lock",
169            Self::Pub => "pub",
170            Self::Pypi => "pypi",
171            Self::Pixi => "pixi",
172            Self::Publiccode => "publiccode",
173            Self::Readme => "readme",
174            Self::Rpm => "rpm",
175            Self::Shar => "shar",
176            Self::Squashfs => "squashfs",
177            Self::Swift => "swift",
178            Self::Vcpkg => "vcpkg",
179            Self::War => "war",
180            Self::Winexe => "winexe",
181            Self::WindowsUpdate => "windows-update",
182            Self::Yocto => "yocto",
183        }
184    }
185}
186
187impl AsRef<str> for PackageType {
188    fn as_ref(&self) -> &str {
189        self.as_str()
190    }
191}
192
193impl fmt::Display for PackageType {
194    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
195        f.write_str(self.as_str())
196    }
197}
198
199impl FromStr for PackageType {
200    type Err = String;
201
202    fn from_str(s: &str) -> Result<Self, Self::Err> {
203        match s {
204            "about" => Ok(Self::About),
205            "alpm" => Ok(Self::Alpm),
206            "apk" => Ok(Self::Apk),
207            "android" => Ok(Self::Android),
208            "android_lib" => Ok(Self::AndroidLib),
209            "autotools" => Ok(Self::Autotools),
210            "axis2" => Ok(Self::Axis2),
211            "bazel" => Ok(Self::Bazel),
212            "bower" => Ok(Self::Bower),
213            "buck" => Ok(Self::Buck),
214            "cab" => Ok(Self::Cab),
215            "cargo" => Ok(Self::Cargo),
216            "carthage" => Ok(Self::Carthage),
217            "chef" => Ok(Self::Chef),
218            "chrome" => Ok(Self::Chrome),
219            "cocoapods" => Ok(Self::Cocoapods),
220            "composer" => Ok(Self::Composer),
221            "conan" => Ok(Self::Conan),
222            "conda" => Ok(Self::Conda),
223            "cpan" => Ok(Self::Cpan),
224            "cran" => Ok(Self::Cran),
225            "deb" => Ok(Self::Deb),
226            "deno" => Ok(Self::Deno),
227            "docker" => Ok(Self::Docker),
228            "dmg" => Ok(Self::Dmg),
229            "ear" => Ok(Self::Ear),
230            "freebsd" => Ok(Self::Freebsd),
231            "gem" => Ok(Self::Gem),
232            "generic" => Ok(Self::Generic),
233            "github" => Ok(Self::Github),
234            "golang" => Ok(Self::Golang),
235            "hackage" => Ok(Self::Hackage),
236            "haxe" => Ok(Self::Haxe),
237            "helm" => Ok(Self::Helm),
238            "hex" => Ok(Self::Hex),
239            "huggingface" => Ok(Self::Huggingface),
240            "installshield" => Ok(Self::Installshield),
241            "julia" => Ok(Self::Julia),
242            "ios" => Ok(Self::Ios),
243            "iso" => Ok(Self::Iso),
244            "ivy" => Ok(Self::Ivy),
245            "jar" => Ok(Self::Jar),
246            "jboss-service" => Ok(Self::JbossService),
247            "linux-distro" => Ok(Self::LinuxDistro),
248            "maven" => Ok(Self::Maven),
249            "meson" => Ok(Self::Meson),
250            "meteor" => Ok(Self::Meteor),
251            "nix" => Ok(Self::Nix),
252            "mozilla" => Ok(Self::Mozilla),
253            "npm" => Ok(Self::Npm),
254            "nsis" => Ok(Self::Nsis),
255            "nuget" => Ok(Self::Nuget),
256            "oci" => Ok(Self::Oci),
257            "opam" => Ok(Self::Opam),
258            "osgi" => Ok(Self::Osgi),
259            "pnpm-lock" => Ok(Self::PnpmLock),
260            "pub" => Ok(Self::Pub),
261            "pypi" => Ok(Self::Pypi),
262            "pixi" => Ok(Self::Pixi),
263            "publiccode" => Ok(Self::Publiccode),
264            "readme" => Ok(Self::Readme),
265            "rpm" => Ok(Self::Rpm),
266            "shar" => Ok(Self::Shar),
267            "squashfs" => Ok(Self::Squashfs),
268            "swift" => Ok(Self::Swift),
269            "vcpkg" => Ok(Self::Vcpkg),
270            "war" => Ok(Self::War),
271            "winexe" => Ok(Self::Winexe),
272            "windows-update" => Ok(Self::WindowsUpdate),
273            "yocto" => Ok(Self::Yocto),
274            _ => Err(format!("unknown package type: {}", s)),
275        }
276    }
277}
278
279#[cfg(test)]
280mod tests {
281    use super::*;
282
283    #[test]
284    fn test_serialization() {
285        let pt = PackageType::Npm;
286        let json = serde_json::to_string(&pt).unwrap();
287        assert_eq!(json, r#""Npm""#);
288    }
289
290    #[test]
291    fn test_deserialization() {
292        let json = r#""Npm""#;
293        let pt: PackageType = serde_json::from_str(json).unwrap();
294        assert_eq!(pt, PackageType::Npm);
295    }
296
297    #[test]
298    fn test_as_str() {
299        assert_eq!(PackageType::Npm.as_str(), "npm");
300        assert_eq!(PackageType::Cargo.as_str(), "cargo");
301        assert_eq!(PackageType::Pypi.as_str(), "pypi");
302        assert_eq!(PackageType::Alpm.as_str(), "alpm");
303        assert_eq!(PackageType::Vcpkg.as_str(), "vcpkg");
304        assert_eq!(PackageType::Hackage.as_str(), "hackage");
305        assert_eq!(PackageType::Hex.as_str(), "hex");
306    }
307
308    #[test]
309    fn test_display() {
310        assert_eq!(PackageType::Npm.to_string(), "npm");
311    }
312
313    #[test]
314    fn test_as_ref() {
315        let pt = PackageType::Npm;
316        let s: &str = pt.as_ref();
317        assert_eq!(s, "npm");
318    }
319
320    #[test]
321    fn test_kebab_case_variants() {
322        assert_eq!(PackageType::JbossService.as_str(), "jboss-service");
323        assert_eq!(PackageType::LinuxDistro.as_str(), "linux-distro");
324        assert_eq!(PackageType::PnpmLock.as_str(), "pnpm-lock");
325        assert_eq!(PackageType::Winexe.as_str(), "winexe");
326        assert_eq!(PackageType::WindowsUpdate.as_str(), "windows-update");
327
328        let json = serde_json::to_string(&PackageType::JbossService).unwrap();
329        assert_eq!(json, r#""JbossService""#);
330
331        let json = serde_json::to_string(&PackageType::LinuxDistro).unwrap();
332        assert_eq!(json, r#""LinuxDistro""#);
333
334        let json = serde_json::to_string(&PackageType::PnpmLock).unwrap();
335        assert_eq!(json, r#""PnpmLock""#);
336
337        let json = serde_json::to_string(&PackageType::Winexe).unwrap();
338        assert_eq!(json, r#""Winexe""#);
339
340        let json = serde_json::to_string(&PackageType::WindowsUpdate).unwrap();
341        assert_eq!(json, r#""WindowsUpdate""#);
342    }
343
344    #[test]
345    fn test_snake_case_variant() {
346        assert_eq!(PackageType::AndroidLib.as_str(), "android_lib");
347
348        let json = serde_json::to_string(&PackageType::AndroidLib).unwrap();
349        assert_eq!(json, r#""AndroidLib""#);
350    }
351
352    #[test]
353    fn test_deserialization_kebab_case() {
354        let pt: PackageType = serde_json::from_str(r#""JbossService""#).unwrap();
355        assert_eq!(pt, PackageType::JbossService);
356
357        let pt: PackageType = serde_json::from_str(r#""LinuxDistro""#).unwrap();
358        assert_eq!(pt, PackageType::LinuxDistro);
359
360        let pt: PackageType = serde_json::from_str(r#""PnpmLock""#).unwrap();
361        assert_eq!(pt, PackageType::PnpmLock);
362
363        let pt: PackageType = serde_json::from_str(r#""Winexe""#).unwrap();
364        assert_eq!(pt, PackageType::Winexe);
365
366        let pt: PackageType = serde_json::from_str(r#""WindowsUpdate""#).unwrap();
367        assert_eq!(pt, PackageType::WindowsUpdate);
368    }
369}
provenant/models/package_type.rs

provenant/models/
package_type.rs
