utpm 0.3.0

UTPM is a package manager for local and remote Typst packages. Quickly create and manage projects and templates on your system, and publish them directly to Typst Universe.
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
104
105

use std::collections::HashMap;

use fmt_derive::Display;
use serde::{Deserialize, Serialize};
use toml::to_string_pretty;
use tracing::instrument;

use crate::{build, utils::state::Result, utpm_log};

use super::GetArgs;

#[derive(Debug, Deserialize, Serialize, Clone, Display)]
#[display("{}", to_string_pretty(self).unwrap())]
pub struct RawPackage {
    pub name: String,
    pub version: String,
    pub entrypoint: String,
    pub authors: Vec<String>,
    pub license: String,
    pub description: String,
    pub homepage: Option<String>,
    pub repository: Option<String>,
    pub keywords: Option<Vec<String>>,
    pub categories: Option<Vec<String>>,
    pub disciplines: Option<Vec<String>>,
    pub compiler: Option<String>,
    pub exclude: Option<Vec<String>>,
    #[serde(rename = "updatedAt")]
    pub updated_at: i64,
}

/// Fetches all packages from the Typst Universe registry.
///
/// # Returns
/// A vector of all available packages from `packages.typst.org`.
///
/// # Errors
/// Returns an error if the HTTP request fails or the response cannot be parsed.
pub async fn get_all_packages() -> Result<Vec<RawPackage>> {
    let client = reqwest::Client::new();

    let packages: Vec<RawPackage> = client
        .get("https://packages.typst.org/preview/index.json")
        .header(
            reqwest::header::USER_AGENT,
            format!("utpm/{}", build::PKG_VERSION),
        )
        .send()
        .await?
        .json::<Vec<RawPackage>>()
        .await?;
    Ok(packages)
}

/// Fetches all packages and creates a hashmap for lookup by name or name:version.
///
/// # Returns
/// A hashmap where keys can be either:
/// - Package name (e.g., "mypackage") - returns the latest version
/// - Package name with version (e.g., "mypackage:1.0.0") - returns that specific version
///
/// # Errors
/// Returns an error if the HTTP request fails or the response cannot be parsed.
pub async fn get_packages_name_version() -> Result<HashMap<String, RawPackage>> {
    let packages: Vec<RawPackage> = get_all_packages().await?;
    let mut hashmap: HashMap<String, RawPackage> = HashMap::with_capacity(packages.len() * 2);

    for pkg in packages {
        // Insert by name (latest version)
        let name = pkg.name.clone();
        let version_key = format!("{}:{}", pkg.name, pkg.version);

        hashmap.insert(name, pkg.clone());
        hashmap.insert(version_key, pkg);
    }

    Ok(hashmap)
}

/// Retrieves and displays package information from the Typst Universe registry.
///
/// If specific packages are requested, displays only those packages.
/// Otherwise, displays all available packages.
#[instrument(skip(cmd))]
pub async fn run(cmd: &GetArgs) -> Result<bool> {
    utpm_log!(trace, "executing get command");
    if !cmd.packages.is_empty() {
        let packages: HashMap<String, RawPackage> = get_packages_name_version().await?;
        for e in &cmd.packages {
            if !packages.contains_key(e) {
                utpm_log!(warn, "Package not found", "input" => e);
                continue;
            }
            let package = packages.get(e).unwrap();
            utpm_log!(info, package);
        }
    } else {
        let packages: Vec<_> = get_all_packages().await?;
        for package in packages {
            utpm_log!(info, package);
        }
    }

    Ok(true)
}