Add generated schema, validation, and clearer Luna branding

Author: CodeDoctorDE

Cargo.lock

@@ -4,7 +4,7 @@
 
 # Luna
 
-> WIP: Library for Universal Networking Assets
+> WIP: Lightweight Universal Networked Assets
 
 [![Latest release)](https://img.shields.io/github/v/release/LinwoodDev/Luna?color=1CC637&style=for-the-badge&logo=github&logoColor=1CC637)](https://github.com/LinwoodDev/Luna/releases)
 [![GitHub License badge](https://img.shields.io/github/license/LinwoodDev/Luna?color=1CC637&style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIiBmaWxsPSIjZWJiNzMzIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiI%2BPHJlY3Qgd2lkdGg9IjI1NiIgaGVpZ2h0PSIyNTYiIGZpbGw9Im5vbmUiPjwvcmVjdD48cmVjdCB4PSIzMiIgeT0iNDgiIHdpZHRoPSIxOTIiIGhlaWdodD0iMTYwIiByeD0iOCIgc3Ryb2tlLXdpZHRoPSIxNiIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGZpbGw9Im5vbmUiPjwvcmVjdD48bGluZSB4MT0iNzYiIHkxPSI5NiIgeDI9IjE4MCIgeTI9Ijk2IiBmaWxsPSJub25lIiBzdHJva2U9IiNlYmI3MzMiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgc3Ryb2tlLXdpZHRoPSIxNiI%2BPC9saW5lPjxsaW5lIHgxPSI3NiIgeTE9IjEyOCIgeDI9IjE4MCIgeTI9IjEyOCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZWJiNzMzIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMTYiPjwvbGluZT48bGluZSB4MT0iNzYiIHkxPSIxNjAiIHgyPSIxODAiIHkyPSIxNjAiIGZpbGw9Im5vbmUiIHN0cm9rZT0iI2ViYjczMyIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBzdHJva2Utd2lkdGg9IjE2Ij48L2xpbmU%2BPC9zdmc%2B)](https://github.com/LinwoodDev/Luna/blob/main/LICENSE)
@@ -28,8 +28,9 @@
 
 **This project is still in development and not ready for production use. Please join the matrix or discord server for updates!**
 
-Luna is a build system to enable hosting a static library system for assets.
-It is designed to be flexible with a universal API to allow any app to use it.
+Luna stands for **Lightweight Universal Networked Assets**.
+
+It is a static asset registry generator: you store asset metadata in TOML, Luna builds a versioned JSON index and an optional browsable documentation website. Apps can consume the index without a backend, login system, or custom server.
 Read more in the [documentation](https://luna.linwood.dev/docs/v1/intro).
 
 ## Official Apps
@@ -48,6 +49,8 @@ The API is not yet stable, but the CLI is usable.
 
 Current todos:
 
+- [x] Repository validation (`luna check` / `luna validate`)
+- [x] JSON Schema output (`luna schema`)
 - [x] Implement a bundling system to host assets in the docs
   - [x] Avatars
   - [x] Asset items
@@ -69,13 +72,15 @@ You can use Luna in your GitHub Actions workflow to generate your site.
 ```yaml
 steps:
   - uses: actions/checkout@v6
-  - uses: LinwoodDev/Luna@develop
+  - uses: LinwoodDev/Luna@v0.1.0
     with:
       command: 'build'
       path: 'output/docs'
       index_path: 'output/index.json'
 ```
 
+During development you can pin `@main` or `@develop`, but release tags are the recommended input for reproducible builds.
+
 If you only want to generate the index or docs separately, you can use the `generate` or `docs` commands.
 
 ### Custom docs templates and public files

README.md

@@ -6,7 +6,7 @@ branding:
   color: 'green'
 inputs:
   command:
-    description: 'Command to run (generate, docs, build, index, get)'
+    description: 'Command to run (generate, docs, build, check, schema, index, get)'
     required: false
     default: 'generate'
   path:
@@ -18,6 +18,12 @@ inputs:
   page_size:
     description: 'Page size (only for docs command)'
     required: false
+  bundle:
+    description: 'Bundling strategy for docs/build (none, images, all)'
+    required: false
+  custom_root:
+    description: 'Custom docs root containing templates, components, layouts, and public files'
+    required: false
   args:
     description: 'Raw arguments to pass to the CLI (overrides other inputs)'
     required: false

action.yml

@@ -8,4 +8,5 @@ edition = "2024"
 [dependencies]
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
+schemars = { version = "1", features = ["derive"] }
 toml = "1"

api/Cargo.toml

@@ -1,9 +1,10 @@
 use crate::models::Named;
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use toml::value::Datetime;
 
 // Path: content/{author}/{name}/asset.toml
-#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone, Default)]
 pub struct Asset {
     pub author: String,
     pub name: String,
@@ -21,18 +22,19 @@ pub struct Asset {
     pub categories: Vec<String>,
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone, Default)]
 pub struct Version {
     pub name: String,
     pub changes: String,
+    #[schemars(with = "Option<String>")]
     pub published: Option<Datetime>,
     pub download_url: String,
     pub sha256: String,
     pub blake3: Option<String>,
 }
 
 // Path: content/{author}/author.toml
-#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone, Default)]
 pub struct Author {
     pub name: String,
     pub display_name: Option<String>,

api/src/models/asset.rs

@@ -1,8 +1,11 @@
 pub mod asset;
+pub mod schema;
+pub mod validation;
 
 use std::collections::HashMap;
 
 use asset::*;
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 const FILE_VERSION: u8 = 1;
@@ -11,7 +14,7 @@ pub trait Named {
     fn name(&self) -> &str;
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone)]
+#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone)]
 pub struct RepositoryData {
     pub assets: Vec<Asset>,
     pub authors: Vec<Author>,
@@ -37,7 +40,7 @@ impl Named for RepositoryData {
     }
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone, Default)]
 pub struct RepositoryInfo {
     pub name: String,
     pub summary: Option<String>,
@@ -71,4 +74,8 @@ impl RepositoryData {
     pub fn to_index(&self) -> serde_json::Result<String> {
         serde_json::to_string(&self)
     }
+
+    pub fn validate(&self) -> Result<(), validation::ValidationErrors> {
+        validation::validate_repository(self)
+    }
 }

api/src/models/mod.rs

@@ -0,0 +1,24 @@
+use serde_json::{Value, json};
+
+use super::RepositoryData;
+
+pub const INDEX_SCHEMA_URL: &str = "https://luna.linwood.dev/schemas/index-v1.schema.json";
+
+pub fn index_schema() -> Value {
+    let mut schema = json!(schemars::schema_for!(RepositoryData));
+    if let Some(object) = schema.as_object_mut() {
+        object.insert("$id".to_string(), json!(INDEX_SCHEMA_URL));
+        object.insert("title".to_string(), json!("Luna index v1"));
+    }
+    if let Some(file_version) = schema
+        .pointer_mut("/properties/file_version")
+        .and_then(Value::as_object_mut)
+    {
+        file_version.insert("const".to_string(), json!(1));
+    }
+    schema
+}
+
+pub fn index_schema_pretty() -> serde_json::Result<String> {
+    serde_json::to_string_pretty(&index_schema())
+}