asc-hap 0.1.1

HarmonyOS package metadata for asc-rs: module.json, pack.info, pkgContextInfo.json and resources.index.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225

//! `pack.info`: the packing tool's digest of a HAP (one module) or of an
//! `.app` bundle (every module), written at the archive root.

use serde_json::Value;

use crate::HapError;
use crate::value::{self, Findings, Line, Note, Obj};

/// A parsed `pack.info`.
#[derive(Debug, Clone, PartialEq)]
pub struct PackInfo {
    /// `summary.app`.
    pub app: PackApp,
    /// `summary.modules`.
    pub modules: Vec<PackModule>,
    /// `packages`: the HAP/HSP files of the bundle.
    pub packages: Vec<PackPackage>,
    /// Fields that were present but wrongly typed, and so skipped.
    pub notes: Vec<Note>,
    /// JSON paths of fields this model has no place for.
    pub unmodelled: Vec<String>,
    raw: Value,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PackApp {
    pub bundle_name: Option<String>,
    pub bundle_type: Option<String>,
    /// `version.code`.
    pub version_code: Option<i64>,
    /// `version.name`.
    pub version_name: Option<String>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PackModule {
    /// `distro.moduleName`.
    pub name: Option<String>,
    /// `distro.moduleType`.
    pub kind: Option<String>,
    pub installation_free: Option<bool>,
    pub delivery_with_install: Option<bool>,
    pub main_ability: Option<String>,
    pub device_types: Vec<String>,
    /// `apiVersion.compatible`: the minimum API level.
    pub api_compatible: Option<i64>,
    /// `apiVersion.target`.
    pub api_target: Option<i64>,
    /// `apiVersion.releaseType`.
    pub api_release_type: Option<String>,
    pub abilities: Vec<PackAbility>,
    pub extension_abilities: Vec<PackExtension>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PackAbility {
    pub name: Option<String>,
    pub label: Option<String>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PackExtension {
    pub name: Option<String>,
    /// Service widgets (cards) a form extension offers.
    pub forms: Vec<PackForm>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PackForm {
    pub name: Option<String>,
    /// `type`: `JS` or `eTS`.
    pub kind: Option<String>,
    pub update_enabled: Option<bool>,
    pub update_duration: Option<i64>,
    /// `scheduledUpdateTime`: the time of day of the daily update, `10:30`.
    pub scheduled_update_time: Option<String>,
    pub default_dimension: Option<String>,
    pub support_dimensions: Vec<String>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct PackPackage {
    /// File stem of the package inside the bundle (`entry-default`).
    pub name: Option<String>,
    pub module_type: Option<String>,
    pub device_types: Vec<String>,
    pub delivery_with_install: Option<bool>,
}

impl PackInfo {
    /// Read a `pack.info`.
    ///
    /// # Errors
    ///
    /// Only when `bytes` is not JSON or its root is not an object.
    pub fn parse(bytes: &[u8]) -> Result<Self, HapError> {
        let map = value::parse_object(bytes)?;
        let mut findings = Findings::default();
        let mut root = Obj::root(&map, &mut findings);
        let summary = root.object("summary", |s| (s.object("app", read_app).unwrap_or_default(), s.objects("modules", read_module)));
        let (app, modules) = summary.unwrap_or_default();
        let packages = root.objects("packages", |p| PackPackage {
            name: p.str("name"),
            module_type: p.str("moduleType"),
            device_types: p.strings("deviceType"),
            delivery_with_install: p.bool("deliveryWithInstall"),
        });
        root.finish();
        Ok(PackInfo { app, modules, packages, notes: findings.notes, unmodelled: findings.unmodelled, raw: Value::Object(map) })
    }

    /// The whole document as parsed.
    pub fn raw(&self) -> &Value {
        &self.raw
    }

    /// The document pretty-printed.
    pub fn pretty(&self) -> String {
        value::pretty(&self.raw)
    }

    /// One fact per line: `pack-app`, then per module `pack-module`,
    /// `pack-ability`, `pack-extension` and `pack-form` (each carrying the
    /// module name), then `pack-package`, `unmodelled` and `note`.
    pub fn summary_lines(&self) -> Vec<String> {
        let mut out = vec![
            Line::new("pack-app")
                .word(self.app.bundle_name.as_deref().unwrap_or("-"))
                .opt("bundleType", self.app.bundle_type.as_deref())
                .num("versionCode", self.app.version_code)
                .opt("versionName", self.app.version_name.as_deref())
                .end(),
        ];
        for module in &self.modules {
            let name = module.name.as_deref().unwrap_or("-");
            out.push(
                Line::new("pack-module")
                    .word(name)
                    .opt("type", module.kind.as_deref())
                    .opt("mainAbility", module.main_ability.as_deref())
                    .list("deviceTypes", &module.device_types)
                    .flag("installationFree", module.installation_free)
                    .flag("deliveryWithInstall", module.delivery_with_install)
                    .num("apiCompatible", module.api_compatible)
                    .num("apiTarget", module.api_target)
                    .opt("apiReleaseType", module.api_release_type.as_deref())
                    .end(),
            );
            out.extend(module.abilities.iter().map(|a| {
                Line::new("pack-ability").word(name).word(a.name.as_deref().unwrap_or("-")).opt("label", a.label.as_deref()).end()
            }));
            for extension in &module.extension_abilities {
                let extension_name = extension.name.as_deref().unwrap_or("-");
                out.push(Line::new("pack-extension").word(name).word(extension_name).raw("forms", extension.forms.len()).end());
                out.extend(extension.forms.iter().map(|f| {
                    Line::new("pack-form")
                        .word(name)
                        .word(extension_name)
                        .word(f.name.as_deref().unwrap_or("-"))
                        .opt("type", f.kind.as_deref())
                        .flag("updateEnabled", f.update_enabled)
                        .num("updateDuration", f.update_duration)
                        .opt_present("scheduledUpdateTime", f.scheduled_update_time.as_deref())
                        .opt("defaultDimension", f.default_dimension.as_deref())
                        .list("supportDimensions", &f.support_dimensions)
                        .end()
                }));
            }
        }
        out.extend(self.packages.iter().map(|p| {
            Line::new("pack-package")
                .word(p.name.as_deref().unwrap_or("-"))
                .opt("moduleType", p.module_type.as_deref())
                .list("deviceTypes", &p.device_types)
                .flag("deliveryWithInstall", p.delivery_with_install)
                .end()
        }));
        out.extend(self.unmodelled.iter().map(|path| Line::new("unmodelled").word(path).end()));
        out.extend(self.notes.iter().map(|note| format!("note {note}")));
        out
    }

    /// [`PackInfo::summary_lines`] joined, each line newline-terminated.
    pub fn summary(&self) -> String {
        crate::join_lines(&self.summary_lines())
    }
}

fn read_app(o: &mut Obj<'_, '_>) -> PackApp {
    let version = o.object("version", |v| (v.int("code"), v.str("name")));
    let (version_code, version_name) = version.unwrap_or_default();
    PackApp { bundle_name: o.str("bundleName"), bundle_type: o.str("bundleType"), version_code, version_name }
}

fn read_module(o: &mut Obj<'_, '_>) -> PackModule {
    let distro =
        o.object("distro", |d| (d.str("moduleName"), d.str("moduleType"), d.bool("installationFree"), d.bool("deliveryWithInstall")));
    let (name, kind, installation_free, delivery_with_install) = distro.unwrap_or_default();
    let api = o.object("apiVersion", |a| (a.int("compatible"), a.int("target"), a.str("releaseType")));
    let (api_compatible, api_target, api_release_type) = api.unwrap_or_default();
    PackModule {
        name,
        kind,
        installation_free,
        delivery_with_install,
        main_ability: o.str("mainAbility"),
        device_types: o.strings("deviceType"),
        api_compatible,
        api_target,
        api_release_type,
        abilities: o.objects("abilities", |a| PackAbility { name: a.str("name"), label: a.str("label") }),
        extension_abilities: o.objects("extensionAbilities", |e| PackExtension {
            name: e.str("name"),
            forms: e.objects("forms", |f| PackForm {
                name: f.str("name"),
                kind: f.str("type"),
                update_enabled: f.bool("updateEnabled"),
                update_duration: f.int("updateDuration"),
                scheduled_update_time: f.str("scheduledUpdateTime"),
                default_dimension: f.str("defaultDimension"),
                support_dimensions: f.strings("supportDimensions"),
            }),
        }),
    }
}