okc 0.1.0

A local-first tool for AI agents to browse, parse, search, and reason over Open Knowledge Format (OKF) repositories
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

//! Document content structure types for the Open Knowledge Catalog.
//!
//! This module contains types representing the parsed structure of
//! markdown documents including headings, tables, code blocks, links,
//! and logical sections.

use serde::{Deserialize, Serialize};

/// A heading extracted from markdown content.
#[derive(Debug, Clone)]
pub struct Heading {
    /// Heading level (1-6).
    pub level: u32,
    /// Heading text.
    pub title: String,
    /// Optional anchor/slug for linking.
    pub anchor: Option<String>,
    /// Byte position in the document.
    pub position: usize,
}

/// A table extracted from markdown content.
#[derive(Debug, Clone)]
pub struct Table {
    /// Table headers.
    pub headers: Vec<String>,
    /// Table rows (each row is a vector of cell contents).
    pub rows: Vec<Vec<String>>,
    /// Column alignments (None, Left, Center, Right).
    pub alignments: Vec<TableAlignment>,
    /// Byte position in the document.
    pub position: usize,
}

/// Table column alignment.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TableAlignment {
    /// No explicit alignment.
    None,
    /// Left-aligned.
    Left,
    /// Center-aligned.
    Center,
    /// Right-aligned.
    Right,
}

/// A fenced code block extracted from markdown content.
#[derive(Debug, Clone)]
pub struct CodeBlock {
    /// Programming language (from fence info string).
    pub language: Option<String>,
    /// Optional filename (from fence info string, e.g., `rust:filename.rs`).
    pub filename: Option<String>,
    /// Code content.
    pub content: String,
    /// Byte position in the document.
    pub position: usize,
}

/// A link extracted from markdown content.
#[derive(Debug, Clone)]
pub struct Link {
    /// Original link text as written in markdown.
    pub raw: String,
    /// Resolved target path or URL.
    pub target: String,
    /// Optional anchor fragment.
    pub target_anchor: Option<String>,
    /// Whether this is an external link (http/https/mailto).
    pub is_external: bool,
    /// Whether the target exists in the repository (for internal links).
    pub exists_in_repository: bool,
}

/// Fully parsed document with all extracted structure.
#[derive(Debug, Clone)]
pub struct ParsedDocument {
    /// Document path.
    pub path: String,
    /// Parsed front-matter if present.
    pub front_matter: Option<crate::model::document::frontmatter::FrontMatter>,
    /// All headings in document order.
    pub headings: Vec<Heading>,
    /// All links in document order.
    pub links: Vec<Link>,
    /// Plain text body content.
    pub body_text: String,
    /// Logical sections (heading + content).
    pub sections: Vec<Section>,
    /// Overall parse status.
    pub parse_status: crate::model::document::frontmatter::ParseStatus,
    /// Any parse errors encountered.
    pub parse_errors: Vec<crate::model::document::frontmatter::ParseError>,
}

/// A logical section of a document (heading + content).
#[derive(Debug, Clone)]
pub struct Section {
    /// Section heading text.
    pub heading: String,
    /// Heading level.
    pub level: u32,
    /// Section content (markdown).
    pub content: String,
    /// Byte position of section start.
    pub start_position: usize,
    /// Tables found in this section.
    pub tables: Vec<Table>,
    /// Code blocks found in this section.
    pub code_blocks: Vec<CodeBlock>,
}

/// Heading information for API responses.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HeadingInfo {
    /// Heading level (1-6).
    pub level: u32,
    /// Heading text.
    pub title: String,
    /// Optional anchor.
    pub anchor: Option<String>,
}

/// Link information for API responses.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LinkInfo {
    /// Target path (for internal links).
    pub target_path: Option<String>,
    /// Target anchor fragment.
    pub target_anchor: Option<String>,
    /// External URL (for external links).
    pub external_url: Option<String>,
    /// Whether target exists in repository.
    pub exists_in_repository: bool,
}