#Mooncakes Protocol (MoonBit)

#Features

• Type Definitions: Complete type definitions for mooncakes.io data structures
• HTTP Client: Async HTTP client for fetching data from mooncakes.io
• Utility Functions: Helper functions for traversing module index, searching, and type conversion

#Installation

moon add moonbitlang/mooncakes_protocol

#Usage

#Getting Statistics

///|
async fn main {
  let client = @mooncakes_protocol.MooncakesClient::new()
  try {
    let stats = client.get_statistics()
    println("Total modules: \{stats.total_modules}")
    println("Total packages: \{stats.total_packages}")
    println("Total lines: \{stats.total_lines}")
  } catch {
    e => println("Error: \{e}")
  }
}

#Getting Module Index

///|
async fn example() -> Unit {
  let client = @mooncakes_protocol.MooncakesClient::new()
  let index = client.get_module_index("moonbitlang/core")

  // Get all package paths
  let paths = @mooncakes_protocol.get_all_package_paths(index)
  for path in paths {
    println(path)
  }
}

#Getting Package Data

///|
async fn example() -> Unit {
  let client = @mooncakes_protocol.MooncakesClient::new()
  let pkg = client.get_package_data("moonbitlang/core/array")

  // List all types
  for t in pkg.types {
    println("Type: \{t.name}")
  }
}

#Searching

///|
fn example() {
  // Build search entries from package data
  let entries = @mooncakes_protocol.build_search_entries(
    pkg, "moonbitlang/core/array",
  )

  // Fuzzy search
  let results = @mooncakes_protocol.fuzzy_search(entries, "push", 10)
  for entry in results {
    println("\{entry.name} (\{entry.kind})")
  }
}

#API Reference

#Client

• MooncakesClient::new() - Create a new client with default URLs
• MooncakesClient::with_urls(base_url~, api_url~) - Create a client with custom URLs
• client.get_statistics() - Get registry statistics
• client.get_recent_modules() - Get list of recent modules
• client.get_user(username) - Get user info
• client.get_resource(path) - Get resource for a module/package
• client.get_package_data(path) - Get package documentation data
• client.get_module_index(path) - Get module index tree
• client.get_full_module_data(path) - Get full module data including all packages

#Utilities

• traverse_module_index(index, f) - Traverse all nodes in module index
• get_package_nodes(index) - Get all package nodes with their paths
• get_all_package_paths(index) - Get all package paths
• find_node_by_path(index, path) - Find a node by path
• get_descendant_packages(node) - Get all descendant packages
• get_child_packages(node) - Get direct child packages
• build_node_map(index) - Build a map of nodes by path
• type_path_to_string(tp) - Convert TypePath to string
• stype_to_string(stype) - Convert Stype to string
• build_search_entries(pkg, path) - Build search entries from package data
• fuzzy_search(entries, query, limit) - Simple fuzzy search
• strip_html_tags(s) - Strip HTML tags from string
• format_docstring(docstring) - Format docstring

#Types

#Core Types

• Loc - Source code location
• TypePath - Fully qualified type name
• Stype - Semantic type (Constr, Arrow, Param, Path)
• MetaInfo - Module/package metadata

#Resource Types

• Resource - Resource info with README content
• ResourceKind - Module, Package, or ModuleAndPackage

#Documentation Types

• TypeDoc - Type documentation
• TraitDoc - Trait documentation
• ValueDoc - Value/function documentation
• ImplDoc - Implementation documentation
• TypeAliasDoc - Type alias documentation
• ErrorDoc - Error type documentation
• MiscDoc - Miscellaneous documentation

#Index Types

• PackageIndex - Package index info
• IndexNode - Index tree node (ModuleIndex)
• TypeIndex, TraitIndex, ImplIndex, MiscIndex - Index entries

#API Types

• ModuleSummary - Module summary for list display
• Statistics - Registry statistics
• UserInfo - User info
• UserModule - User module info
• FullModuleData - Full module data with all packages

#License