pubky-app-specs

Rust types, sanitization, and validation for Pubky.app data models. Use this crate to build JSON that matches what Pubky indexers expect.

⚠️ Warning: Rapid Development Phase
This specification is in an early development phase and is evolving quickly. Expect frequent changes and updates as the system matures. Consider this a v0 draft.

When we reach the first stable, long-term support version of the schemas, paths will adopt the format: pubky.app/v1/ to indicate compatibility and stability

Installation

Rust (crates.io):

cargo add pubky-app-specs

JavaScript / TypeScript (npm): see pkg/README.md.

Rust quick start

use pubky_app_specs::{
    traits::{HasPath, Validatable},
    PubkyAppUser,
};
use serde_json::to_vec;

// Create a user profile
let user = PubkyAppUser::new("Alice".into(), None, None, None, None);
let path = PubkyAppUser::create_path(); // /pub/pubky.app/profile.json
let json = to_vec(&user).unwrap();

// Parse and validate JSON from storage
let profile = PubkyAppUser::try_from(&json, "").unwrap();

For a full homeserver flow, see examples/create_user.rs.

Why use this crate

• Validation consistency — same sanitization and validation rules as Pubky indexers.
• Auto IDs and paths — generates IDs, paths, and URLs according to Pubky standards.
• Single source of truth — Rust models drive native apps, WASM bindings, and this spec.

Features

pubky-app-specs = { version = "0.6", features = ["openapi"] }

• MSRV: 1.89 (see rust-version in Cargo.toml)
• API docs: docs.rs/pubky-app-specs

Models

Specification

See the full data model specification for URI layout, examples, and validation rules.

License

MIT