xberg 1.3.0

High-performance document intelligence library for Rust. Extract text, metadata, and structured data from PDFs, Office documents, images, and 107 formats and 371 programming languages via tree-sitter code intelligence with async/sync APIs.
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
use super::*;

const FEATURE_COLLECTION: &[u8] = br#"{
    "type": "FeatureCollection",
    "name": "cities",
    "features": [
        {
            "type": "Feature",
            "properties": {"name": "Berlin", "population": 3645000},
            "geometry": {"type": "Point", "coordinates": [13.405, 52.52]}
        },
        {
            "type": "Feature",
            "properties": {"name": "Paris", "capital": true},
            "geometry": {
                "type": "LineString",
                "coordinates": [[2.20, 48.80], [2.35, 48.86], [2.45, 48.90]]
            }
        }
    ]
}"#;

#[test]
fn test_json_array_objects_render_as_nested_markdown() {
    let value = serde_json::json!({
        "people": [
            {
                "name": "Ada",
                "details": {
                    "role": "Engineer",
                    "active": true
                }
            },
            {
                "name": "Grace",
                "skills": ["compilers", "mathematics"]
            }
        ]
    });
    let mut builder = InternalDocumentBuilder::new("json");
    let mut budget = SecurityBudget::from_config(&ExtractionConfig::default());

    build_json_internal_structure(&value, &mut builder, 1, &mut budget).unwrap();
    let markdown = crate::rendering::render_markdown(&builder.build());

    assert!(markdown.contains("# people"), "missing array heading: {markdown}");
    assert!(markdown.contains("## Item 1"), "missing first item heading: {markdown}");
    assert!(markdown.contains("name: Ada"), "missing first nested value: {markdown}");
    assert!(
        markdown.contains("### details"),
        "missing nested object heading: {markdown}"
    );
    assert!(
        markdown.contains("role: Engineer"),
        "missing deeply nested value: {markdown}"
    );
    assert!(markdown.contains("active: true"), "missing boolean value: {markdown}");
    assert!(
        markdown.contains("## Item 2"),
        "missing second item heading: {markdown}"
    );
    assert!(
        markdown.contains("name: Grace"),
        "missing second nested value: {markdown}"
    );
    assert!(
        markdown.contains("- compilers"),
        "missing nested array value: {markdown}"
    );
    assert!(
        markdown.contains("- mathematics"),
        "missing nested array value: {markdown}"
    );
    assert!(
        !markdown.contains(r#"{\"name\":\"Ada\""#),
        "object remained compact JSON: {markdown}"
    );
}

#[test]
fn test_structured_extractor_plugin_interface() {
    let extractor = StructuredExtractor::new();
    assert_eq!(extractor.name(), "structured-extractor");
    assert!(extractor.initialize().is_ok());
    assert!(extractor.shutdown().is_ok());
}

#[test]
fn test_structured_extractor_supported_mime_types() {
    let extractor = StructuredExtractor::new();
    let mime_types = extractor.supported_mime_types();
    assert_eq!(mime_types.len(), 14);
    assert!(mime_types.contains(&"application/json"));
    assert!(mime_types.contains(&"application/x-ndjson"));
    assert!(mime_types.contains(&"application/jsonl"));
    assert!(mime_types.contains(&"application/x-jsonlines"));
    assert!(mime_types.contains(&"application/x-yaml"));
    assert!(mime_types.contains(&"application/toml"));
    assert!(mime_types.contains(&"application/csl+json"));
    assert!(mime_types.contains(&GEOJSON_MIME_TYPE));
}

#[tokio::test]
async fn geojson_uses_json_extraction_and_preserves_its_mime_type() {
    let extractor = StructuredExtractor::new();
    let content = br#"{"type":"Point","coordinates":[13.4,52.5]}"#;

    assert!(extractor.supported_mime_types().contains(&"application/geo+json"));
    let result = extractor
        .extract_content(content, "application/geo+json", &ExtractionConfig::default())
        .await
        .unwrap();

    assert_eq!(result.mime_type, "application/geo+json");
    assert_eq!(
        result.metadata.additional.get("data_format"),
        Some(&serde_json::json!("json"))
    );
    let rendered = crate::rendering::render_plain(&result);
    assert!(rendered.contains("type: Point"));
    assert!(rendered.contains("position_count: 1"));
    assert!(rendered.contains("bounds"));
    assert!(!rendered.contains("\ncoordinates\n"));
    assert_eq!(result.processing_warnings.len(), 1);
    assert_eq!(result.processing_warnings[0].source, "geojson");
    assert_eq!(
        result.metadata.additional.get("geojson_summarized"),
        Some(&serde_json::json!(true))
    );
}

#[tokio::test]
async fn geojson_summary_aggregates_features_properties_geometry_and_bounds() {
    let result = StructuredExtractor::new()
        .extract_content(FEATURE_COLLECTION, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
        .await
        .unwrap();
    let summary = result
        .metadata
        .additional
        .get("geojson_summary")
        .expect("summary metadata must be present");

    assert_eq!(summary["type"], "FeatureCollection");
    assert_eq!(summary["feature_count"], 2);
    assert_eq!(summary["position_count"], 4);
    assert_eq!(summary["bounds"], serde_json::json!([2.2, 48.8, 13.405, 52.52]));
    assert_eq!(summary["geometry_types"]["Point"], 1);
    assert_eq!(summary["geometry_types"]["LineString"], 1);
    assert_eq!(
        summary["property_keys"],
        serde_json::json!(["capital", "name", "population"])
    );
    assert!(!crate::rendering::render_plain(&result).contains("Berlin"));
}

#[tokio::test]
async fn geojson_full_coordinates_require_explicit_opt_in() {
    let config = ExtractionConfig {
        geojson: Some(crate::core::config::GeoJsonExtractionConfig {
            include_full_coordinates: true,
        }),
        ..ExtractionConfig::default()
    };
    let result = StructuredExtractor::new()
        .extract_content(FEATURE_COLLECTION, GEOJSON_MIME_TYPE, &config)
        .await
        .unwrap();
    let rendered = crate::rendering::render_plain(&result);

    assert!(rendered.contains("13.405"));
    assert!(rendered.contains("52.52"));
    assert!(result.processing_warnings.is_empty());
    assert!(result.metadata.additional.get("geojson_summary").is_none());
    assert_eq!(
        result.metadata.additional.get("geojson_summarized"),
        Some(&serde_json::json!(false))
    );
}

#[tokio::test]
async fn ordinary_json_keeps_full_coordinate_named_arrays() {
    let result = StructuredExtractor::new()
        .extract_content(
            br#"{"coordinates":[[1,2],[3,4]]}"#,
            "application/json",
            &ExtractionConfig::default(),
        )
        .await
        .unwrap();

    assert!(crate::rendering::render_plain(&result).contains("1\n2"));
    assert!(result.metadata.additional.get("geojson_summarized").is_none());
}

#[tokio::test]
async fn geojson_summary_output_stays_bounded_for_large_coordinate_arrays() {
    const POSITION_COUNT: usize = 10_000;
    const MAX_EXPECTED_SUMMARY_BYTES: usize = 2_000;
    let positions = (0..POSITION_COUNT)
        .map(|index| serde_json::json!([index, index + 1]))
        .collect::<Vec<_>>();
    let content = serde_json::to_vec(&serde_json::json!({
        "type": "LineString",
        "coordinates": positions,
    }))
    .unwrap();

    let result = StructuredExtractor::new()
        .extract_content(&content, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
        .await
        .unwrap();

    let rendered = crate::rendering::render_plain(&result);
    assert!(rendered.len() < MAX_EXPECTED_SUMMARY_BYTES, "summary was {rendered}");
    assert_eq!(
        result.metadata.additional["geojson_summary"]["position_count"],
        serde_json::json!(POSITION_COUNT)
    );
}

#[tokio::test]
async fn geojson_summary_bounds_names_property_keys_and_unknown_geometry_types() {
    const UNKNOWN_GEOMETRY_COUNT: usize = 1_000;
    const PROPERTY_COUNT: usize = 300;
    const MAX_SUMMARY_BYTES: usize = 8 * 1024;
    let geometries = (0..UNKNOWN_GEOMETRY_COUNT)
        .map(|index| serde_json::json!({"type": format!("FakeGeometry{index}")}))
        .collect::<Vec<_>>();
    let mut properties = (0..PROPERTY_COUNT)
        .map(|index| {
            (
                format!("property_{index:03}_{}", "x".repeat(80)),
                serde_json::json!(index),
            )
        })
        .collect::<serde_json::Map<_, _>>();
    properties.insert("k".repeat(10_000), serde_json::json!("oversized key"));
    let content = serde_json::to_vec(&serde_json::json!({
        "type": "FeatureCollection",
        "name": "n".repeat(10_000),
        "features": [{
            "type": "Feature",
            "properties": properties,
            "geometry": {"type": "GeometryCollection", "geometries": geometries}
        }]
    }))
    .unwrap();

    let result = StructuredExtractor::new()
        .extract_content(&content, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
        .await
        .unwrap();
    let summary = &result.metadata.additional["geojson_summary"];
    let encoded = serde_json::to_vec(summary).unwrap();

    assert!(encoded.len() < MAX_SUMMARY_BYTES, "summary was {} bytes", encoded.len());
    assert_eq!(summary["name"].as_str().unwrap().len(), MAX_GEOJSON_NAME_BYTES);
    assert_eq!(summary["name_truncated"], true);
    assert_eq!(summary["property_count"], PROPERTY_COUNT + 1);
    assert_eq!(summary["property_keys_truncated"], true);
    assert_eq!(summary["geometry_types"]["Unknown"], UNKNOWN_GEOMETRY_COUNT);
    assert!(!String::from_utf8(encoded).unwrap().contains("FakeGeometry999"));
    assert!(crate::rendering::render_plain(&result).len() < MAX_SUMMARY_BYTES);
}

#[tokio::test]
async fn geojson_summary_discloses_every_discarded_category() {
    let content = br#"{
        "type":"Feature",
        "id":"feature-1",
        "bbox":[1,2,3,4],
        "foreign":{"nested":[1,2,3]},
        "properties":{"name":"Berlin"},
        "geometry":{"type":"Point","coordinates":[13.4,52.5],"foreignGeometry":true}
    }"#;
    let result = StructuredExtractor::new()
        .extract_content(content, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
        .await
        .unwrap();
    let discarded = result.metadata.additional["geojson_summary"]["discarded_categories"]
        .as_array()
        .unwrap();

    for category in [
        "coordinate_arrays",
        "feature_property_values",
        "feature_ids",
        "declared_bounding_boxes",
        "foreign_members",
    ] {
        assert!(discarded.contains(&serde_json::json!(category)), "missing {category}");
    }
}

#[tokio::test]
async fn every_default_geojson_shape_is_explicitly_marked_as_summarized() {
    for content in [
        br#"null"#.as_slice(),
        br#"{}"#.as_slice(),
        br#"{"properties":{"name":"value"}}"#.as_slice(),
        br#"{"type":"Feature","properties":null,"geometry":null}"#.as_slice(),
        br#"{"type":"Point","coordinates":[]}"#.as_slice(),
        br#"{"type":"Point","coordinates":[1,"bad",3]}"#.as_slice(),
    ] {
        let result = StructuredExtractor::new()
            .extract_content(content, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
            .await
            .unwrap();
        assert_eq!(result.metadata.additional["geojson_summarized"], true);
        assert_eq!(result.processing_warnings.len(), 1);
    }
}

#[tokio::test]
async fn geojson_positions_require_two_or_more_numeric_ordinates() {
    let content = br#"{
        "type":"GeometryCollection",
        "geometries":[
            {"type":"Point","coordinates":[1,2,3]},
            {"type":"Point","coordinates":[4]},
            {"type":"Point","coordinates":[5,"bad"]},
            {"type":"Point","coordinates":[]}
        ]
    }"#;
    let result = StructuredExtractor::new()
        .extract_content(content, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
        .await
        .unwrap();
    let summary = &result.metadata.additional["geojson_summary"];

    assert_eq!(summary["position_count"], 1);
    assert_eq!(summary["bounds"], serde_json::json!([1.0, 2.0, 1.0, 2.0]));
    assert_eq!(summary["malformed_position_array_count"], 2);
    assert_eq!(summary["empty_coordinate_array_count"], 1);
}

#[tokio::test]
async fn geojson_summary_validates_coordinate_shape_for_each_geometry_type() {
    let content = br#"{
        "type":"GeometryCollection",
        "geometries":[
            {"type":"Point","coordinates":[[1,2],[3,4]]},
            {"type":"LineString","coordinates":[1,2]},
            {"type":"LineString","coordinates":[[10,11],[12,13]]},
            {"type":"Polygon","coordinates":[[[20,21],[22,23],[24,25],[20,21]]]},
            {"type":"Polygon","coordinates":[[[30,31],[32,33],[34,35],[36,37]]]},
            {"type":"MultiPoint","coordinates":[[40,41],[42,43,44]]},
            {"type":"MultiLineString","coordinates":[[[50,51],[52,53]]]},
            {"type":"MultiPolygon","coordinates":[[[[60,61],[62,63],[64,65],[60,61]]]]},
            {"type":"GeometryCollection","coordinates":[70,71],"geometries":[]}
        ]
    }"#;
    let result = StructuredExtractor::new()
        .extract_content(content, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
        .await
        .unwrap();
    let summary = &result.metadata.additional["geojson_summary"];

    assert_eq!(summary["invalid_geometry_count"], 4);
    assert_eq!(summary["position_count"], 14);
    assert_eq!(summary["bounds"], serde_json::json!([10.0, 11.0, 64.0, 65.0]));
}

#[tokio::test]
async fn geojson_discarded_categories_only_report_values_that_were_omitted() {
    for properties in [serde_json::Value::Null, serde_json::json!({})] {
        let content = serde_json::to_vec(&serde_json::json!({
            "type": "Feature",
            "properties": properties,
            "geometry": null,
        }))
        .unwrap();
        let result = StructuredExtractor::new()
            .extract_content(&content, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
            .await
            .unwrap();
        let discarded = result.metadata.additional["geojson_summary"]["discarded_categories"]
            .as_array()
            .unwrap();

        assert!(discarded.contains(&serde_json::json!("feature_structure")));
        assert!(!discarded.contains(&serde_json::json!("feature_property_values")));
    }
}

#[tokio::test]
async fn geojson_vendor_alias_has_identical_summary_and_rendering() {
    let extractor = StructuredExtractor::new();
    let canonical = extractor
        .extract_content(FEATURE_COLLECTION, GEOJSON_MIME_TYPE, &ExtractionConfig::default())
        .await
        .unwrap();
    let alias = extractor
        .extract_content(
            FEATURE_COLLECTION,
            "application/vnd.geo+json",
            &ExtractionConfig::default(),
        )
        .await
        .unwrap();

    assert_eq!(
        crate::rendering::render_plain(&canonical),
        crate::rendering::render_plain(&alias)
    );
    assert_eq!(
        canonical.metadata.additional["geojson_summary"],
        alias.metadata.additional["geojson_summary"]
    );
}

#[tokio::test]
async fn geojson_summary_validates_depth_inside_discarded_values() {
    let config = ExtractionConfig {
        security_limits: Some(SecurityLimits {
            max_nesting_depth: 3,
            max_xml_depth: 3,
            ..SecurityLimits::default()
        }),
        ..ExtractionConfig::default()
    };
    let content = br#"{"type":"Feature","properties":{"ignored":{"a":{"b":{"c":1}}}},"geometry":null}"#;

    let error = StructuredExtractor::new()
        .extract_content(content, GEOJSON_MIME_TYPE, &config)
        .await
        .expect_err("discarded property values must still consume the whole-input depth budget");
    assert!(matches!(error, crate::XbergError::Security { .. }));
}

#[tokio::test]
async fn geojson_summary_honors_iteration_security_limit() {
    let config = ExtractionConfig {
        security_limits: Some(SecurityLimits {
            max_iterations: 2,
            ..SecurityLimits::default()
        }),
        ..ExtractionConfig::default()
    };

    let error = StructuredExtractor::new()
        .extract_content(FEATURE_COLLECTION, GEOJSON_MIME_TYPE, &config)
        .await
        .expect_err("feature traversal must exhaust the configured iteration budget");
    assert!(matches!(error, crate::XbergError::Security { .. }));
}

#[tokio::test]
async fn geojson_summary_honors_input_size_security_limit() {
    let config = ExtractionConfig {
        security_limits: Some(SecurityLimits {
            max_content_size: 10,
            ..SecurityLimits::default()
        }),
        ..ExtractionConfig::default()
    };

    let error = StructuredExtractor::new()
        .extract_content(FEATURE_COLLECTION, GEOJSON_MIME_TYPE, &config)
        .await
        .expect_err("oversized GeoJSON must be rejected before parsing");
    assert!(matches!(error, crate::XbergError::Security { .. }));
}