offline-registry 0.4.0

Registry of Offline Protocol packages, skills, workflows, and templates
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
//! Load the registry from the embedded copy or `OFFLINE_REGISTRY_DIR`.
//!
//! Manifests (`packages/`, `workflows/`, `skills/`, `template.json`,
//! `capabilities.json`) load at startup. Template file trees load on demand via [`Registry::template_files`].

use std::collections::BTreeMap;
use std::path::{Path, PathBuf};
use std::sync::OnceLock;

use include_dir::{include_dir, Dir};

use crate::model::{
    Capability, CapabilityTerms, PackageManifest, Skill, SkillFrontmatter, TemplateMeta, Workflow,
};
use crate::search_index::{self, SearchIndex};
use crate::RegistryError;

static EMBEDDED_REGISTRY: OnceLock<Registry> = OnceLock::new();

static EMBEDDED: Dir<'_> = include_dir!("$CARGO_MANIFEST_DIR/registry");

/// Environment variable that overrides the embedded registry content.
pub const REGISTRY_DIR_ENV: &str = "OFFLINE_REGISTRY_DIR";

#[derive(Debug, Clone)]
pub enum RegistrySource {
    Embedded,
    Dir(PathBuf),
}

#[derive(Clone)]
pub struct Registry {
    pub(crate) packages: BTreeMap<String, PackageManifest>,
    pub(crate) workflows: BTreeMap<String, Workflow>,
    pub(crate) skills: BTreeMap<String, Skill>,
    pub(crate) templates: BTreeMap<String, TemplateMeta>,
    /// Curated search keywords per capability name.
    pub(crate) capability_terms: BTreeMap<String, CapabilityTerms>,
    source: RegistrySource,
    pub(crate) search_index: SearchIndex,
    pub(crate) aggregated_capabilities: Vec<Capability>,
}

impl Registry {
    /// Load from `OFFLINE_REGISTRY_DIR` if set, otherwise the embedded copy.
    ///
    /// Embedded loads are cached for the process lifetime.
    pub fn load_default() -> Result<Self, RegistryError> {
        match std::env::var_os(REGISTRY_DIR_ENV) {
            Some(dir) => Self::load_from_dir(Path::new(&dir)),
            None => {
                if let Some(registry) = EMBEDDED_REGISTRY.get() {
                    return Ok(registry.clone());
                }
                let registry = Self::load_embedded()?;
                let _ = EMBEDDED_REGISTRY.set(registry.clone());
                Ok(registry)
            }
        }
    }

    pub fn load_embedded() -> Result<Self, RegistryError> {
        let mut packages = BTreeMap::new();
        let mut workflows = BTreeMap::new();
        let mut skills = BTreeMap::new();
        let mut templates = BTreeMap::new();
        let mut capability_terms = BTreeMap::new();
        ingest_metadata_embedded(&EMBEDDED, &mut |rel, data| {
            ingest_metadata_bytes(
                rel,
                data,
                &mut packages,
                &mut workflows,
                &mut skills,
                &mut templates,
                &mut capability_terms,
            )
        })?;
        let mut registry = Self {
            packages,
            workflows,
            skills,
            templates,
            capability_terms,
            source: RegistrySource::Embedded,
            search_index: SearchIndex::default(),
            aggregated_capabilities: Vec::new(),
        };
        registry.validate()?;
        registry.finalize_indexes();
        Ok(registry)
    }

    pub fn load_from_dir(root: &Path) -> Result<Self, RegistryError> {
        if !root.is_dir() {
            return Err(RegistryError::SourceNotFound(root.display().to_string()));
        }
        let mut packages = BTreeMap::new();
        let mut workflows = BTreeMap::new();
        let mut skills = BTreeMap::new();
        let mut templates = BTreeMap::new();
        let mut capability_terms = BTreeMap::new();

        for rel in metadata_paths_under(root)? {
            let abs = root.join(&rel);
            let data =
                std::fs::read(&abs).map_err(|e| RegistryError::Io(abs.display().to_string(), e))?;
            ingest_metadata_bytes(
                &rel.to_string_lossy().replace('\\', "/"),
                &data,
                &mut packages,
                &mut workflows,
                &mut skills,
                &mut templates,
                &mut capability_terms,
            )?;
        }

        let mut registry = Self {
            packages,
            workflows,
            skills,
            templates,
            capability_terms,
            source: RegistrySource::Dir(root.to_path_buf()),
            search_index: SearchIndex::default(),
            aggregated_capabilities: Vec::new(),
        };
        registry.validate()?;
        registry.finalize_indexes();
        Ok(registry)
    }

    fn finalize_indexes(&mut self) {
        self.aggregated_capabilities = search_index::build_capabilities(self);
        self.search_index = SearchIndex::build(self, &self.aggregated_capabilities);
    }

    /// Reject dangling package/workflow/skill references.
    fn validate(&self) -> Result<(), RegistryError> {
        for wf in self.workflows.values() {
            for pkgs in wf.packages.values() {
                for p in pkgs {
                    if !self.packages.contains_key(p) {
                        return Err(RegistryError::Validation(format!(
                            "workflow `{}` references unknown package `{p}`",
                            wf.name
                        )));
                    }
                }
            }
            for skill in &wf.skills {
                if !self.skills.contains_key(skill) {
                    return Err(RegistryError::Validation(format!(
                        "workflow `{}` references unknown skill `{skill}`",
                        wf.name
                    )));
                }
            }
            for tpl in wf.templates.values() {
                if !self.templates.contains_key(tpl) {
                    return Err(RegistryError::Validation(format!(
                        "workflow `{}` references unknown template `{tpl}`",
                        wf.name
                    )));
                }
            }
        }
        for pkg in self.packages.values() {
            if !KNOWN_PACKAGE_REGISTRIES.contains(&pkg.registry.as_str()) {
                return Err(RegistryError::Validation(format!(
                    "package `{}` ships on unknown registry `{}` (expected one of: {})",
                    pkg.name,
                    pkg.registry,
                    KNOWN_PACKAGE_REGISTRIES.join(", ")
                )));
            }
            match &pkg.install {
                None if matches!(
                    pkg.registry.as_str(),
                    "swiftpm" | "maven" | "github-release" | "source" | "rubygems"
                ) =>
                {
                    return Err(RegistryError::Validation(format!(
                        "package `{}` on `{}` needs an `install` instruction",
                        pkg.name, pkg.registry
                    )));
                }
                // The instruction is copied verbatim, so a version bump that
                // forgets it would install the old release.
                Some(install) if !install.contains(&pkg.version) => {
                    return Err(RegistryError::Validation(format!(
                        "package `{}` install instruction does not name version {}",
                        pkg.name, pkg.version
                    )));
                }
                _ => {}
            }
            for platform in &pkg.platforms {
                if !KNOWN_PLATFORMS.contains(&platform.as_str()) {
                    return Err(RegistryError::Validation(format!(
                        "package `{}` lists unknown platform `{platform}`",
                        pkg.name
                    )));
                }
            }
            for req in &pkg.requires {
                if !self.packages.contains_key(req) {
                    return Err(RegistryError::Validation(format!(
                        "package `{}` requires unknown package `{req}`",
                        pkg.name
                    )));
                }
            }
            for skill in &pkg.skills {
                if !self.skills.contains_key(skill) {
                    return Err(RegistryError::Validation(format!(
                        "package `{}` references unknown skill `{skill}`",
                        pkg.name
                    )));
                }
            }
        }
        let known: std::collections::BTreeSet<&str> = self
            .packages
            .values()
            .flat_map(|p| p.capabilities.iter())
            .chain(self.workflows.values().flat_map(|w| w.capabilities.iter()))
            .map(String::as_str)
            .collect();
        for (name, terms) in &self.capability_terms {
            if !known.contains(name.as_str()) {
                return Err(RegistryError::Validation(format!(
                    "capabilities.json lists `{name}`, which no package or workflow provides"
                )));
            }
            for skill in &terms.skills {
                if !self.skills.contains_key(skill) {
                    return Err(RegistryError::Validation(format!(
                        "capabilities.json maps `{name}` to unknown skill `{skill}`"
                    )));
                }
            }
        }
        Ok(())
    }

    pub fn source(&self) -> &RegistrySource {
        &self.source
    }

    pub fn packages(&self) -> impl Iterator<Item = &PackageManifest> {
        self.packages.values()
    }

    pub fn package(&self, name: &str) -> Option<&PackageManifest> {
        self.packages.get(name)
    }

    pub fn workflows(&self) -> impl Iterator<Item = &Workflow> {
        self.workflows.values()
    }

    pub fn workflow(&self, name: &str) -> Option<&Workflow> {
        self.workflows.get(name)
    }

    pub fn skills(&self) -> impl Iterator<Item = &Skill> {
        self.skills.values()
    }

    pub fn skill(&self, name: &str) -> Option<&Skill> {
        self.skills.get(name)
    }

    pub fn templates(&self) -> impl Iterator<Item = &TemplateMeta> {
        self.templates.values()
    }

    pub fn template(&self, name: &str) -> Option<&TemplateMeta> {
        self.templates.get(name)
    }

    /// Return a template's file tree as `(relative_path, bytes)` pairs.
    /// Paths are relative to the template's `files/` directory.
    pub fn template_files(&self, name: &str) -> Result<Vec<(PathBuf, Vec<u8>)>, RegistryError> {
        if !self.templates.contains_key(name) {
            return Err(RegistryError::NotFound(format!("template `{name}`")));
        }
        let prefix = format!("templates/{name}/files");
        match &self.source {
            RegistrySource::Embedded => {
                let dir = EMBEDDED.get_dir(&prefix).ok_or_else(|| {
                    RegistryError::NotFound(format!("template files for `{name}`"))
                })?;
                let mut out = Vec::new();
                collect_embedded(dir, &mut out);
                // Paths are registry-rooted; strip the template prefix.
                let out = out
                    .into_iter()
                    .map(|(p, d)| {
                        let rel = p
                            .strip_prefix(&prefix)
                            .expect("embedded template paths start with prefix")
                            .to_path_buf();
                        (rel, d)
                    })
                    .collect();
                Ok(out)
            }
            RegistrySource::Dir(root) => {
                let base = root.join(&prefix);
                if !base.is_dir() {
                    return Err(RegistryError::NotFound(format!(
                        "template files for `{name}` at {}",
                        base.display()
                    )));
                }
                let mut out = Vec::new();
                for entry in walkdir::WalkDir::new(&base)
                    .into_iter()
                    .filter_map(Result::ok)
                    .filter(|e| e.file_type().is_file())
                {
                    let rel = entry
                        .path()
                        .strip_prefix(&base)
                        .expect("walkdir yields paths under base")
                        .to_path_buf();
                    let data = std::fs::read(entry.path())
                        .map_err(|e| RegistryError::Io(entry.path().display().to_string(), e))?;
                    out.push((rel, data));
                }
                Ok(out)
            }
        }
    }
}

/// File-name key for a package: scope stripped (`@offline-protocol/mesh-sdk`
/// -> `mesh-sdk`).
pub(crate) fn man_key(package_name: &str) -> String {
    package_name
        .rsplit('/')
        .next()
        .unwrap_or(package_name)
        .to_string()
}

/// Where a package can ship (see [`PackageManifest::registry`]).
const KNOWN_PACKAGE_REGISTRIES: &[&str] = &[
    "npm",
    "crates",
    "pypi",
    "swiftpm",
    "maven",
    "github-release",
    "source",
    "rubygems",
];

/// Platform values a package may list: the starter platforms, `rust`, and
/// the package-only platforms.
const KNOWN_PLATFORMS: &[&str] = &[
    "react-native",
    "nextjs",
    "react-vite",
    "web",
    "rust",
    "python",
    "ios-native",
    "android-native",
    "embedded",
    "flutter",
    "java",
    "c",
    "ruby",
    "csharp",
];

/// Registry-root file holding curated capability search keywords.
const CAPABILITIES_FILE: &str = "capabilities.json";

/// True for registry paths that must be parsed at load time.
fn is_metadata_path(rel: &str) -> bool {
    let rel = rel.replace('\\', "/");
    if rel == CAPABILITIES_FILE {
        return true;
    }
    if let Some(rest) = rel.strip_prefix("packages/") {
        return rest.ends_with(".json") && !rest.contains('/');
    }
    if let Some(rest) = rel.strip_prefix("workflows/") {
        return rest.ends_with(".json") && !rest.contains('/');
    }
    if let Some(rest) = rel.strip_prefix("skills/") {
        return rest.ends_with(".md") && !rest.contains('/');
    }
    if let Some(rest) = rel.strip_prefix("templates/") {
        // Only `templates/<name>/template.json`.
        let parts: Vec<&str> = rest.split('/').collect();
        return parts.len() == 2 && parts[1] == "template.json";
    }
    false
}

fn metadata_paths_under(root: &Path) -> Result<Vec<PathBuf>, RegistryError> {
    let mut out = Vec::new();

    if root.join(CAPABILITIES_FILE).is_file() {
        out.push(PathBuf::from(CAPABILITIES_FILE));
    }

    for (subdir, suffix) in [
        ("packages", ".json"),
        ("workflows", ".json"),
        ("skills", ".md"),
    ] {
        let dir = root.join(subdir);
        if !dir.is_dir() {
            continue;
        }
        for entry in
            std::fs::read_dir(&dir).map_err(|e| RegistryError::Io(dir.display().to_string(), e))?
        {
            let entry = entry.map_err(|e| RegistryError::Io(dir.display().to_string(), e))?;
            let path = entry.path();
            if !path.is_file() {
                continue;
            }
            let name = entry.file_name();
            let name = name.to_string_lossy();
            if name.ends_with(suffix) {
                out.push(PathBuf::from(subdir).join(name.as_ref()));
            }
        }
    }

    let templates_dir = root.join("templates");
    if templates_dir.is_dir() {
        for entry in std::fs::read_dir(&templates_dir)
            .map_err(|e| RegistryError::Io(templates_dir.display().to_string(), e))?
        {
            let entry =
                entry.map_err(|e| RegistryError::Io(templates_dir.display().to_string(), e))?;
            if !entry.path().is_dir() {
                continue;
            }
            let name = entry.file_name();
            let meta = entry.path().join("template.json");
            if meta.is_file() {
                out.push(PathBuf::from("templates").join(name).join("template.json"));
            }
        }
    }

    Ok(out)
}

type MetadataVisitor<'a> = dyn FnMut(&str, &[u8]) -> Result<(), RegistryError> + 'a;

fn ingest_metadata_embedded(
    dir: &Dir<'_>,
    visit: &mut MetadataVisitor<'_>,
) -> Result<(), RegistryError> {
    for file in dir.files() {
        let rel_str = file.path().to_string_lossy().replace('\\', "/");
        if is_metadata_path(&rel_str) {
            visit(&rel_str, file.contents())?;
        }
    }
    for sub in dir.dirs() {
        ingest_metadata_embedded(sub, visit)?;
    }
    Ok(())
}

fn ingest_metadata_bytes(
    rel_str: &str,
    data: &[u8],
    packages: &mut BTreeMap<String, PackageManifest>,
    workflows: &mut BTreeMap<String, Workflow>,
    skills: &mut BTreeMap<String, Skill>,
    templates: &mut BTreeMap<String, TemplateMeta>,
    capability_terms: &mut BTreeMap<String, CapabilityTerms>,
) -> Result<(), RegistryError> {
    if rel_str == CAPABILITIES_FILE {
        *capability_terms = serde_json::from_slice(data)
            .map_err(|e| RegistryError::Parse(rel_str.to_string(), e.to_string()))?;
    } else if let Some(name) = rel_str
        .strip_prefix("packages/")
        .and_then(|f| f.strip_suffix(".json"))
    {
        let manifest: PackageManifest = serde_json::from_slice(data)
            .map_err(|e| RegistryError::Parse(rel_str.to_string(), e.to_string()))?;
        if man_key(&manifest.name) != name {
            return Err(RegistryError::Validation(format!(
                "package file `{rel_str}` declares name `{}`; expected file name `{}.json`",
                manifest.name,
                man_key(&manifest.name)
            )));
        }
        packages.insert(manifest.name.clone(), manifest);
    } else if let Some(name) = rel_str
        .strip_prefix("workflows/")
        .and_then(|f| f.strip_suffix(".json"))
    {
        let wf: Workflow = serde_json::from_slice(data)
            .map_err(|e| RegistryError::Parse(rel_str.to_string(), e.to_string()))?;
        if wf.name != name {
            return Err(RegistryError::Validation(format!(
                "workflow file `{rel_str}` declares name `{}`",
                wf.name
            )));
        }
        workflows.insert(wf.name.clone(), wf);
    } else if let Some(name) = rel_str
        .strip_prefix("skills/")
        .and_then(|f| f.strip_suffix(".md"))
    {
        let text = std::str::from_utf8(data)
            .map_err(|e| RegistryError::Parse(rel_str.to_string(), e.to_string()))?;
        let skill = parse_skill(text).map_err(|e| RegistryError::Parse(rel_str.to_string(), e))?;
        if skill.name != name {
            return Err(RegistryError::Validation(format!(
                "skill file `{rel_str}` declares name `{}`",
                skill.name
            )));
        }
        skills.insert(skill.name.clone(), skill);
    } else if rel_str.starts_with("templates/") && rel_str.ends_with("/template.json") {
        let meta: TemplateMeta = serde_json::from_slice(data)
            .map_err(|e| RegistryError::Parse(rel_str.to_string(), e.to_string()))?;
        templates.insert(meta.name.clone(), meta);
    }
    Ok(())
}

fn collect_embedded(dir: &Dir<'_>, out: &mut Vec<(PathBuf, Vec<u8>)>) {
    for file in dir.files() {
        out.push((file.path().to_path_buf(), file.contents().to_vec()));
    }
    for sub in dir.dirs() {
        collect_embedded(sub, out);
    }
}

/// Parse a skill markdown document with YAML frontmatter delimited by `---`.
fn parse_skill(text: &str) -> Result<Skill, String> {
    let rest = text
        .strip_prefix("---")
        .ok_or("skill must start with `---` frontmatter")?;
    let end = rest
        .find("\n---")
        .ok_or("unterminated frontmatter (missing closing `---`)")?;
    let frontmatter = &rest[..end];
    let body = rest[end + 4..].trim_start_matches('\n').to_string();
    let fm: SkillFrontmatter =
        serde_saphyr::from_str(frontmatter).map_err(|e| format!("invalid frontmatter: {e}"))?;
    Ok(Skill {
        name: fm.name,
        title: fm.title,
        description: fm.description,
        use_when: fm.use_when,
        packages: fm.packages,
        platforms: fm.platforms,
        body,
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn is_metadata_path_selects_manifests_only() {
        assert!(is_metadata_path("packages/mesh-sdk.json"));
        assert!(is_metadata_path("workflows/offline-social-network.json"));
        assert!(is_metadata_path("skills/mesh-chat.md"));
        assert!(is_metadata_path(
            "templates/react-native-mesh/template.json"
        ));
        assert!(!is_metadata_path(
            "templates/react-native-mesh/files/App.tsx"
        ));
        assert!(!is_metadata_path(
            "templates/react-native-mesh/files/package.json"
        ));
        assert!(is_metadata_path("capabilities.json"));
        assert!(!is_metadata_path("README.md"));
        assert!(!is_metadata_path("packages/nested/extra.json"));
    }
}