provenant/models/
package_type.rs

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

provenant/models/
package_type.rs
